# [−]Struct lumol::energy::Gaussian

pub struct Gaussian { /* fields omitted */ }

Gaussian potential.

$$V(x) = -a \exp(-b x^2)$$

where $a$ is the potential depth and $b$ is the potential width.

# Restrictions

$b$ has to be positive

# Examples

let potential = Gaussian::new(8.0, 0.5);
assert_eq!(potential.energy(0.0), -8.0);
assert_eq!(potential.force(0.0), 0.0);

## Methods

### impl Gaussian

#### pub fn new(a: f64, b: f64) -> Gaussian

Create a new Gaussian potential with a depth of a and a width of b

## Trait Implementations

### impl PairPotential for Gaussian

#### fn tail_energy(&self, rc: f64) -> f64

Compute the tail correction to the energy for the given cutoff. Read more

#### fn tail_virial(&self, rc: f64) -> f64

Compute the tail correction to the virial for the given cutoff. Read more

#### fn virial(&self, r: &Vector3D) -> Matrix3

Compute the virial contribution corresponding to the distance r between the particles. Read more

### impl Potential for Gaussian

#### fn energy(&self, r: f64) -> f64

Get the energy corresponding to the variable x

#### fn force(&self, r: f64) -> f64

Get the force norm corresponding to the variable x

### impl Clone for Gaussian

#### fn clone(&self) -> Gaussian

Returns a copy of the value. Read more

#### fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

### impl FromToml for Gaussian

#### fn from_toml(table: &BTreeMap<String, Value>) -> Result<Gaussian, Error>

Do the conversion from table to Self.

## Blanket Implementations

### impl<T> ToOwned for T where    T: Clone, [src]

#### fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

#### fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

### impl<T> From for T[src]

#### fn from(t: T) -> T[src]

Performs the conversion.

### impl<T, U> Into for T where    U: From<T>, [src]

#### fn into(self) -> U[src]

Performs the conversion.

### impl<T, U> TryFrom for T where    T: From<U>, [src]

#### type Error = !

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

### impl<T> Borrow for T where    T: ?Sized, [src]

#### ⓘImportant traits for &'a mut R### Important traits for &'a mut R impl<'a, R> Read for &'a mut R where    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

### impl<T, U> TryInto for T where    U: TryFrom<T>, [src]

#### type Error = <U as TryFrom<T>>::Error

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

### impl<T> BorrowMut for T where    T: ?Sized, [src]

#### ⓘImportant traits for &'a mut R### Important traits for &'a mut R impl<'a, R> Read for &'a mut R where    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

### impl<T> Any for T where    T: 'static + ?Sized, [src]

#### fn get_type_id(&self) -> TypeId[src]

🔬 This is a nightly-only experimental API. (get_type_id)

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

### impl<P> Potential for P where    P: 'static + Computation + Clone,

#### fn energy(&self, r: f64) -> f64

Get the energy corresponding to the variable x

#### fn force(&self, r: f64) -> f64

Get the force norm corresponding to the variable x