Skip to main content

Cos

Struct Cos 

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

Harmonic cosine angle potential.

§Parameters

  • k: Force constant (energy units)
  • cos0: Equilibrium angle cosine

Implementations§

Source§

impl<T: Vector> Cos<T>

Source

pub fn new(k: f64, cos0: f64) -> Self

Creates a new cosine angle potential.

§Arguments
  • k: Force constant (energy units)
  • cos0: Cosine of equilibrium angle
§Example
use potentials::angle::Cos;

// Tetrahedral angle: 109.5 degrees
let cos0 = (109.5_f64 * std::f64::consts::PI / 180.0).cos();
let angle = Cos::<f64>::new(100.0, cos0);
Source

pub fn from_theta(k: f64, theta0: f64) -> Self

Creates from equilibrium angle in radians.

Source

pub fn from_degrees(k: f64, theta0_deg: f64) -> Self

Creates from equilibrium angle in degrees.

Source

pub fn k(&self) -> T

Returns the force constant.

Source

pub fn cos0(&self) -> T

Returns the equilibrium cosine.

Trait Implementations§

Source§

impl<T: Clone> Clone for Cos<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Copy> Copy for Cos<T>

Source§

impl<T: Debug> Debug for Cos<T>

Source§

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

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

impl<T: PartialEq> PartialEq for Cos<T>

Source§

fn eq(&self, other: &Cos<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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> Potential3<T> for Cos<T>

Source§

fn energy(&self, _r_ij_sq: T, _r_jk_sq: T, cos_theta: T) -> T

Computes the potential energy.

V = k * (cos(theta) - cos0)^2

No acos required!

Source§

fn derivative(&self, _r_ij_sq: T, _r_jk_sq: T, cos_theta: T) -> T

Computes dV/d(cos_theta).

dV/d(cos_theta) = 2 * k * (cos_theta - cos0)
Source§

fn energy_derivative(&self, _r_ij_sq: T, _r_jk_sq: T, cos_theta: T) -> (T, T)

Computes energy and derivative together (optimized).

Shares the computation of delta.

Source§

impl<T: PartialEq> StructuralPartialEq for Cos<T>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<T> UnsafeUnpin for Cos<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Cos<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.