Harmonic

Struct Harmonic 

Source
pub struct Harmonic;
Expand description

Harmonic potential implementation for 1-2 bond stretching.

§Physics

Models the bond stretching as a harmonic oscillator.

  • Formula: $$ E = \frac{1}{2} K (R - R_0)^2 $$
  • Derivative Factor (diff): $$ D = -\frac{K (R - R_0)}{R} $$

§Parameters

  • k_half: Half force constant $K_{half} = K/2$.
  • r0: Equilibrium distance $R_0$.

§Inputs

  • r_sq: Squared distance $r^2$ between two atoms.

§Implementation Notes

  • Requires square root to obtain $R$.
  • All intermediate calculations are shared between energy and force computations.
  • Branchless and panic-free.

Trait Implementations§

Source§

impl Clone for Harmonic

Source§

fn clone(&self) -> Harmonic

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 Harmonic

Source§

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

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

impl Default for Harmonic

Source§

fn default() -> Harmonic

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

impl<T: Real> PairKernel<T> for Harmonic

Source§

fn energy(r_sq: T, (k_half, r0): Self::Params) -> T

Computes only the potential energy.

§Formula

$$ E = K_{half} (R - R_0)^2 $$

Source§

fn diff(r_sq: T, (k_half, r0): Self::Params) -> T

Computes only the force pre-factor $D$.

§Formula

$$ D = -\frac{2 K_{half} (R - R_0)}{R} $$

This factor is defined such that the force vector can be computed by a single vector multiplication: $\vec{F} = -D \cdot \vec{r}$.

Source§

fn compute(r_sq: T, (k_half, r0): Self::Params) -> EnergyDiff<T>

Computes both energy and force pre-factor efficiently.

This method reuses intermediate calculations to minimize operations.

Source§

type Params = (T, T)

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

impl Copy for Harmonic

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.