LennardJones

Struct LennardJones 

Source
pub struct LennardJones<const N: i32 = 12, const M: i32 = 6> {
    pub epsilon: f64,
    pub sigma: f64,
}
Expand description

Potential with a steep repulsive core and an attractive well.

U(r) = 4 \varepsilon \left[ \left( \frac{\sigma}{r} \right)^{N} - \left( \frac{\sigma}{r} \right)^{M} \right]

Compute the Lennard-Jones (LJ) potential and force as a function of r.

§Examples

In basic usage, the exponents N and M default to 12 and 6, respectively:

use approxim::{assert_abs_diff_eq, assert_relative_eq};
use hoomd_interaction::univariate::{
    LennardJones, UnivariateEnergy, UnivariateForce,
};

let epsilon = 1.5;
let sigma = 2.5;

let lennard_jones: LennardJones = LennardJones { epsilon, sigma };
assert_abs_diff_eq!(lennard_jones.energy(sigma), 0.0);
assert_relative_eq!(
    lennard_jones.energy(2.0_f64.powf(1.0 / 6.0) * sigma),
    -epsilon
);
assert_abs_diff_eq!(
    lennard_jones.force(2.0_f64.powf(1.0 / 6.0) * sigma),
    0.0,
    epsilon = 1e-12
);

You can choose any values for N and M at compile time:

use approxim::{assert_abs_diff_eq, assert_relative_eq};
use hoomd_interaction::univariate::{
    LennardJones, UnivariateEnergy, UnivariateForce,
};

let epsilon = 1.5;
let sigma = 2.5;

let lennard_jones: LennardJones<8, 4> = LennardJones { epsilon, sigma };
assert_abs_diff_eq!(lennard_jones.energy(sigma), 0.0);
assert_relative_eq!(
    lennard_jones.energy(2.0_f64.powf(1.0 / 4.0) * sigma),
    -epsilon,
    epsilon = 1e-12
);
assert_abs_diff_eq!(
    lennard_jones.force(2.0_f64.powf(1.0 / 4.0) * sigma),
    0.0,
    epsilon = 1e-12
);

The parameters are public fields and may be accessed directly:

use hoomd_interaction::univariate::LennardJones;

let mut lennard_jones: LennardJones = LennardJones::default();
lennard_jones.epsilon = 1.5;
lennard_jones.sigma = 3.0;

Fields§

§epsilon: f64

Energy scale ([energy]).

§sigma: f64

Interaction width ([length]).

Trait Implementations§

Source§

impl<const N: i32, const M: i32> Clone for LennardJones<N, M>

Source§

fn clone(&self) -> LennardJones<N, M>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<const N: i32, const M: i32> Debug for LennardJones<N, M>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<const N: i32, const M: i32> Default for LennardJones<N, M>

Source§

fn default() -> Self

Construct a LennardJones with default parameters (epsilon=1.0, sigma=1.0)

§Example
use hoomd_interaction::univariate::LennardJones;

let lennard_jones: LennardJones = LennardJones::default();
Source§

impl<'de, const N: i32, const M: i32> Deserialize<'de> for LennardJones<N, M>

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<const N: i32, const M: i32> PartialEq for LennardJones<N, M>

Source§

fn eq(&self, other: &LennardJones<N, M>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<const N: i32, const M: i32> Serialize for LennardJones<N, M>

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<const N: i32, const M: i32> UnivariateEnergy for LennardJones<N, M>

Source§

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

Compute the energy as a function of one variable. Read more
Source§

impl<const N: i32, const M: i32> UnivariateForce for LennardJones<N, M>

Source§

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

Compute force as a function of one variable. Read more
Source§

impl<const N: i32, const M: i32> StructuralPartialEq for LennardJones<N, M>

Auto Trait Implementations§

§

impl<const N: i32, const M: i32> Freeze for LennardJones<N, M>

§

impl<const N: i32, const M: i32> RefUnwindSafe for LennardJones<N, M>

§

impl<const N: i32, const M: i32> Send for LennardJones<N, M>

§

impl<const N: i32, const M: i32> Sync for LennardJones<N, M>

§

impl<const N: i32, const M: i32> Unpin for LennardJones<N, M>

§

impl<const N: i32, const M: i32> UnwindSafe for LennardJones<N, M>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,