Scaled

Struct Scaled 

Source
pub struct Scaled<P, T> { /* private fields */ }
Expand description

Linearly scaled potential.

§Type Parameters

  • P: The underlying potential type
  • T: The vector type

Implementations§

Source§

impl<P, T: Vector> Scaled<P, T>

Source

pub fn new(inner: P, scale: f64) -> Self

Creates a new scaled potential.

§Arguments
  • inner: The potential to scale
  • scale: Scale factor (1.0 = no change, 0.0 = disabled)
§Example
use potentials::{pair::Lj, meta::Scaled};

let lj = Lj::<f64>::new(1.0, 3.4);
let lj_half: Scaled<_, f64> = Scaled::new(lj, 0.5);
Source

pub fn set_scale(&mut self, scale: f64)

Updates the scale factor.

Trait Implementations§

Source§

impl<P: Clone, T: Clone> Clone for Scaled<P, T>

Source§

fn clone(&self) -> Scaled<P, 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<P: Debug, T: Debug> Debug for Scaled<P, T>

Source§

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

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

impl<P: Potential2<T>, T: Vector> Potential2<T> for Scaled<P, T>

Source§

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

Computes the potential energy. Read more
Source§

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

Computes the force factor. Read more
Source§

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

Computes both energy and force factor simultaneously. Read more
Source§

impl<P: Copy, T: Copy> Copy for Scaled<P, T>

Auto Trait Implementations§

§

impl<P, T> Freeze for Scaled<P, T>
where P: Freeze, T: Freeze,

§

impl<P, T> RefUnwindSafe for Scaled<P, T>

§

impl<P, T> Send for Scaled<P, T>
where P: Send, T: Send,

§

impl<P, T> Sync for Scaled<P, T>
where P: Sync, T: Sync,

§

impl<P, T> Unpin for Scaled<P, T>
where P: Unpin, T: Unpin,

§

impl<P, T> UnwindSafe for Scaled<P, T>
where P: UnwindSafe, 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.