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

Cosine harmonic potential.

$$ V(x) = \frac{1}{2} k \left[\cos(x) - \cos(x_0) \right]^2 $$

where $x_0$ is the equilibrium value, and $k$ the elastic constant.

# Examples

let potential = CosineHarmonic::new(/*k*/ 100.0, /*x0*/ 2.0); assert_eq!(potential.energy(2.0), 0.0); assert_eq!(potential.energy(3.0), 16.464942078100552); assert_eq!(potential.force(2.0), 0.0);

## Methods

`impl CosineHarmonic`

`pub fn new(k: f64, x0: f64) -> CosineHarmonic`

Create a new `CosineHarmonic`

potentials, with elastic constant of `k`

and equilibrium value of `x0`

## Trait Implementations

`impl DihedralPotential for CosineHarmonic`

`impl Copy for CosineHarmonic`

`impl AnglePotential for CosineHarmonic`

`impl Clone for CosineHarmonic`

`fn clone(&self) -> CosineHarmonic`

`fn clone_from(&mut self, source: &Self)`

1.0.0[src]

Performs copy-assignment from `source`

. Read more

`impl Potential for CosineHarmonic`

`impl FromToml for CosineHarmonic`

## Auto Trait Implementations

`impl Send for CosineHarmonic`

`impl Sync for CosineHarmonic`

## Blanket Implementations

`impl<T> From for T`

[src]

`impl<T, U> Into for T where`

U: From<T>,

[src]

U: From<T>,

`impl<T> ToOwned for T where`

T: Clone,

[src]

T: Clone,

`impl<T, U> TryFrom for T where`

T: From<U>,

[src]

T: From<U>,

`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]

`impl<T> Borrow for T where`

T: ?Sized,

[src]

T: ?Sized,

`impl<T> BorrowMut for T where`

T: ?Sized,

[src]

T: ?Sized,

`fn borrow_mut(&mut self) -> &mut T`

[src]

`impl<T, U> TryInto for T where`

U: TryFrom<T>,

[src]

U: TryFrom<T>,

`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]

`impl<T> Any for T where`

T: 'static + ?Sized,

[src]

T: 'static + ?Sized,

`fn get_type_id(&self) -> TypeId`

[src]

`impl<P> Potential for P where`

P: 'static + Computation + Clone,

P: 'static + Computation + Clone,