Quart

Struct Quart 

Source
pub struct Quart<T> { /* private fields */ }
Expand description

Quartic bond potential.

§Parameters

  • k2: Quadratic force constant (energy/length^2 units)
  • k3: Cubic correction (energy/length^3 units)
  • k4: Quartic correction (energy/length^4 units)
  • r0: Equilibrium distance (length units)

Implementations§

Source§

impl<T: Vector> Quart<T>

Source

pub fn new(k2: f64, k3: f64, k4: f64, r0: f64) -> Self

Creates a new quartic bond potential.

§Arguments
  • k2: Quadratic force constant
  • k3: Cubic correction
  • k4: Quartic correction
  • r0: Equilibrium bond length
§Example
use potentials::bond::Quart;

// Class II force field parameters
let bond = Quart::<f64>::new(300.0, -50.0, 10.0, 1.54);
Source

pub fn symmetric(k2: f64, k4: f64, r0: f64) -> Self

Creates a quartic potential with only quadratic and quartic terms.

This is symmetric about the equilibrium.

Source

pub fn k2(&self) -> T

Returns the quadratic coefficient.

Source

pub fn k3(&self) -> T

Returns the cubic coefficient.

Source

pub fn k4(&self) -> T

Returns the quartic coefficient.

Source

pub fn r0(&self) -> T

Returns the equilibrium distance.

Trait Implementations§

Source§

impl<T: Clone> Clone for Quart<T>

Source§

fn clone(&self) -> Quart<T>

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<T: Debug> Debug for Quart<T>

Source§

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

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

impl<T: PartialEq> PartialEq for Quart<T>

Source§

fn eq(&self, other: &Quart<T>) -> 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<T: Vector> Potential2<T> for Quart<T>

Source§

fn energy(&self, r_sq: T) -> T

Computes the potential energy.

V(r) = k2*(r-r0)^2 + k3*(r-r0)^3 + k4*(r-r0)^4
Source§

fn force_factor(&self, r_sq: T) -> T

Computes the force factor.

dV/dr = 2*k2*(r-r0) + 3*k3*(r-r0)^2 + 4*k4*(r-r0)^3
S = -(dV/dr)/r
Source§

fn energy_force(&self, r_sq: T) -> (T, T)

Computes energy and force factor together (optimized).

Shares the computation of r, r_inv, dr, and dr_sq.

Source§

impl<T: Copy> Copy for Quart<T>

Source§

impl<T> StructuralPartialEq for Quart<T>

Auto Trait Implementations§

§

impl<T> Freeze for Quart<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Quart<T>
where T: RefUnwindSafe,

§

impl<T> Send for Quart<T>
where T: Send,

§

impl<T> Sync for Quart<T>
where T: Sync,

§

impl<T> Unpin for Quart<T>
where T: Unpin,

§

impl<T> UnwindSafe for Quart<T>
where T: UnwindSafe,

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> 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.