PlanarInversion

Struct PlanarInversion 

Source
pub struct PlanarInversion;
Expand description

Planar inversion potential for sp² centers.

§Physics

Models planarity for sp² hybridized atoms (e.g., aromatic carbons, carbonyl groups). The central atom $I$ is bonded to three neighbors $J, K, L$, and the potential penalizes any out-of-plane displacement.

  • Formula: $$ E = \frac{1}{2} C \cos^2\psi $$
  • Derivative Factor (diff): $$ \Gamma = \frac{dE}{d(\cos\psi)} = C \cos\psi $$

§Parameters

  • c_half: Half force constant $C_{half} = C/2$.

§Inputs

  • cos_psi: Cosine of the out-of-plane angle $\psi$.

§Implementation Notes

  • Optimized for $\cos\psi_0 = 0$: avoids one subtraction per evaluation.
  • Pure polynomial evaluation; no trigonometric functions required.
  • All intermediate calculations are shared between energy and force computations.
  • Branchless and panic-free.
  • DREIDING convention: force constant $C = K_{inv}/3$ (split among three permutations).

Trait Implementations§

Source§

impl<T: Real> AngleKernel<T> for PlanarInversion

Source§

fn energy(cos_psi: T, c_half: Self::Params) -> T

Computes only the potential energy.

§Formula

$$ E = C_{half} \cos^2\psi $$

Source§

fn diff(cos_psi: T, c_half: Self::Params) -> T

Computes only the derivative factor $\Gamma$.

§Formula

$$ \Gamma = 2 C_{half} \cos\psi $$

This factor allows computing forces via the chain rule: $$ \vec{F} = -\Gamma \cdot \nabla (\cos\psi) $$

Source§

fn compute(cos_psi: T, c_half: Self::Params) -> EnergyDiff<T>

Computes both energy and derivative factor efficiently.

This method reuses intermediate calculations to minimize operations.

Source§

type Params = T

Associated constants/parameters required by the potential (e.g., $k, \theta_0$).
Source§

impl Clone for PlanarInversion

Source§

fn clone(&self) -> PlanarInversion

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 PlanarInversion

Source§

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

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

impl Default for PlanarInversion

Source§

fn default() -> PlanarInversion

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

impl Copy for PlanarInversion

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.