Enum wafer::config::PotentialType

pub enum PotentialType {
    NoPotential,
    Cube,
    QuadWell,
    Periodic,
    Coulomb,
    ComplexCoulomb,
    ElipticalCoulomb,
    SimpleCornell,
    FullCornell,
    Harmonic,
    ComplexHarmonic,
    Dodecahedron,
    FromFile,
    FromScript,
}

Type of potential the user wishes to invoke. There are many potentials built in, or the user can opt for two (three) external possibilities:

1. Input a pre-calculated potential: FromFile
2. Use a python script called from potential_generator.py: FromScript
3. Submit an issue or pull request for a potential you deem worthy of inclusion to the built in selection.

Variants

NoPotential

V = 0, no potential at all.

Cube

A 3D square (i.e. cubic) well.

QuadWell

Quad well, with short side along the z-axis.

Periodic

Periodic (sin squared).

Coulomb

Standard Coulomb.

ComplexCoulomb

Complex Coulomb.

ElipticalCoulomb

Elliptical Coulomb.

SimpleCornell

Cornell with no corrections.

FullCornell

Fully anisotropic screened Cornell + spin correction.

Harmonic

Harmonic oscillator.

ComplexHarmonic

Complex harmonic oscillator.

Dodecahedron

Dodecahedron, because this totally exists in nature.

FromFile

Pull data from file. Good to save a little startup time on restart runs, or a more complex potential generated from an external tool.

FromScript

Calls a python script the user can implement.

Methods

impl PotentialType

pub fn variable_pot_sub(&self) -> bool

Returns true if potential_sub has a non-constant response function

Trait Implementations

impl PartialEq for PotentialType

fn eq(&self, other: &PotentialType) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for PotentialType

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for PotentialType

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.