Skip to main content

SeparableSystem

Struct SeparableSystem 

Source
pub struct SeparableSystem<F: IntegrateFloat> { /* private fields */ }
Expand description

A separable Hamiltonian H(q, p) = T(p) + V(q).

For separable systems the equations of motion are: dq/dt = dT/dp dp/dt = -dV/dq

Implementations§

Source§

impl<F: IntegrateFloat> SeparableSystem<F>

Source

pub fn new<KG, VG>(ndof: usize, kinetic_grad: KG, potential_grad: VG) -> Self
where KG: Fn(F, &Array1<F>) -> Array1<F> + Send + Sync + 'static, VG: Fn(F, &Array1<F>) -> Array1<F> + Send + Sync + 'static,

Create a separable system from gradient functions.

§Arguments
  • ndof - number of degrees of freedom
  • kinetic_grad - computes dT/dp
  • potential_grad - computes dV/dq
Source

pub fn with_energy<KE, VE>( self, kinetic_energy: KE, potential_energy: VE, ) -> Self
where KE: Fn(F, &Array1<F>) -> F + Send + Sync + 'static, VE: Fn(F, &Array1<F>) -> F + Send + Sync + 'static,

Attach energy functions for monitoring.

Trait Implementations§

Source§

impl<F: IntegrateFloat> HamiltonianSystem<F> for SeparableSystem<F>

Source§

fn ndof(&self) -> usize

Number of degrees of freedom (dimension of q or p).
Source§

fn dq_dt( &self, t: F, _q: &Array1<F>, p: &Array1<F>, ) -> IntegrateResult<Array1<F>>

Compute dq/dt = dH/dp evaluated at (t, q, p).
Source§

fn dp_dt( &self, t: F, q: &Array1<F>, _p: &Array1<F>, ) -> IntegrateResult<Array1<F>>

Compute dp/dt = -dH/dq evaluated at (t, q, p).
Source§

fn hamiltonian(&self, t: F, q: &Array1<F>, p: &Array1<F>) -> Option<F>

Optionally compute the Hamiltonian H(t, q, p) for energy monitoring. Returns None if no closed-form Hamiltonian is available.

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> 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, 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V