Torsion

Struct Torsion 

Source
pub struct Torsion;
Expand description

Periodic torsion potential for dihedral angles.

§Physics

Models the rotational barrier around a bond axis using a periodic cosine function.

  • Formula: $$ E = \frac{1}{2} V [1 - \cos(n(\phi - \phi_0))] $$
  • Derivative (diff): $$ T = \frac{dE}{d\phi} = \frac{1}{2} V \cdot n \cdot \sin(n(\phi - \phi_0)) $$

§Parameters

  • v_half: Half barrier height $V_{half} = V/2$.
  • n: Periodicity/multiplicity.
  • cos_n_phi0: $\cos(n\phi_0)$, pre-computed phase cosine.
  • sin_n_phi0: $\sin(n\phi_0)$, pre-computed phase sine.

§Inputs

  • cos_phi: Cosine of the dihedral angle $\cos\phi$.
  • sin_phi: Sine of the dihedral angle $\sin\phi$.

§Implementation Notes

  • Uses optimized closed-form formulas for common periodicities ($n = 1, 2, 3$).
  • Falls back to Chebyshev recurrence for higher periodicities.
  • All intermediate calculations are shared between energy and torque computations.
  • Branchless and panic-free.

Trait Implementations§

Source§

impl Clone for Torsion

Source§

fn clone(&self) -> Torsion

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 Debug for Torsion

Source§

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

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

impl Default for Torsion

Source§

fn default() -> Torsion

Returns the “default value” for a type. Read more
Source§

impl<T: Real> TorsionKernel<T> for Torsion

Source§

fn energy( cos_phi: T, sin_phi: T, (v_half, n, cos_n_phi0, sin_n_phi0): Self::Params, ) -> T

Computes only the potential energy.

§Formula

$$ E = V_{half} [1 - \cos(n(\phi - \phi_0))] $$

Source§

fn diff( cos_phi: T, sin_phi: T, (v_half, n, cos_n_phi0, sin_n_phi0): Self::Params, ) -> T

Computes only the torque $T$.

§Formula

$$ T = V_{half} \cdot n \cdot \sin(n(\phi - \phi_0)) $$

This factor allows computing forces via the chain rule: $$ \vec{F} = -T \cdot \nabla \phi $$

Source§

fn compute( cos_phi: T, sin_phi: T, (v_half, n, cos_n_phi0, sin_n_phi0): Self::Params, ) -> EnergyDiff<T>

Computes both energy and torque efficiently.

This method reuses intermediate calculations to minimize operations.

Source§

type Params = (T, u8, T, T)

Associated constants/parameters required by the potential (e.g., $V, n$).
Source§

impl Copy for Torsion

Auto Trait Implementations§

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.