Skip to main content

Truncated

alice_physics::pair_potential

Struct Truncated 

Source 
pub struct Truncated<P> { /* private fields */ }
Expand description

A pair potential cut at r_c: zero for r ≥ r_c, shifted inside by ShiftMode.

Implementations§

Source§

impl<P: PairPotential> Truncated<P>

Source

pub fn new( potential: P, cutoff: Fix128, mode: ShiftMode, ) -> Result<Self, PairPotentialError>

Cut potential at cutoff > 0 with mode.

§Errors

PairPotentialError::NonPositiveCutoff, or the error of evaluating the potential at the cutoff.

Source

pub const fn cutoff(&self) -> Fix128

Cutoff radius r_c.

Source

pub const fn mode(&self) -> ShiftMode

Shift mode.

Source

pub const fn inner(&self) -> &P

The uncut potential.

Trait Implementations§

Source§

impl<P: Clone> Clone for Truncated<P>

Source§

fn clone(&self) -> Self

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<P: Copy> Copy for Truncated<P>

Source§

impl<P: Debug> Debug for Truncated<P>

Source§

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

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

impl<P: Eq> Eq for Truncated<P>

Source§

impl<P: PairPotential> PairPotential for Truncated<P>

Source§

fn energy(&self, r: Fix128) -> Result<Fix128, PairPotentialError>

Potential energy U(r) at distance r > 0.
Source§

fn force(&self, r: Fix128) -> Result<Fix128, PairPotentialError>

Radial force F(r) = −dU/dr at r > 0 (positive = repulsive).
Source§

fn force_on_first(&self, d: Vec3Fix) -> Result<Vec3Fix, PairPotentialError>

Force on the first particle of a pair separated by d = x_i − x_j: F(|d|) d / |d|. The second particle receives the negative.
Source§

impl<P: PartialEq> PartialEq for Truncated<P>

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<P: PartialEq> StructuralPartialEq for Truncated<P>

Auto Trait Implementations§

§

impl<P> Freeze for Truncated<P>
where P: Freeze,

§

impl<P> RefUnwindSafe for Truncated<P>
where P: RefUnwindSafe,

§

impl<P> Send for Truncated<P>
where P: Send,

§

impl<P> Sync for Truncated<P>
where P: Sync,

§

impl<P> Unpin for Truncated<P>
where P: Unpin,

§

impl<P> UnsafeUnpin for Truncated<P>
where P: UnsafeUnpin,

§

impl<P> UnwindSafe for Truncated<P>
where P: 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.