Struct HamiltonianSystem

Source

pub struct HamiltonianSystem<F: IntegrateFloat> { /* private fields */ }

Expand description

A general non-separable Hamiltonian system

This represents Hamiltonian systems where the equations of motion are specified directly without assuming a separable structure.

Implementations§

Source §

impl<F: IntegrateFloat> HamiltonianSystem<F>

Source

pub fn new<DQ, DP>(_dq_dt_fn: DQ, dp_dtfn: DP) -> Self
where DQ: Fn(F, &Array1<F>, &Array1<F>) -> Array1<F> + 'static + Send + Sync, DP: Fn(F, &Array1<F>, &Array1<F>) -> Array1<F> + 'static + Send + Sync,

Create a new general Hamiltonian system

§Arguments

dq_dt_fn - Function computing dq/dt = ∂H/∂p
dp_dt_fn - Function computing dp/dt = -∂H/∂q

§Returns

A new Hamiltonian system

Source

pub fn with_hamiltonian<H>(self, hamiltonianfn: H) -> Self
where H: Fn(F, &Array1<F>, &Array1<F>) -> F + 'static + Send + Sync,

Add Hamiltonian function for energy tracking

§Arguments

hamiltonian_fn - Function computing H(q, p)

§Returns

Self with Hamiltonian function configured

Trait Implementations§

Source §

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

Source §

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

Computes the time derivative of position coordinates: dq/dt = ∂H/∂p Read more

Source §

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

Computes the time derivative of momentum coordinates: dp/dt = -∂H/∂q Read more

Source §

fn hamiltonian( &self, ) -> Option<Box<dyn Fn(F, &Array1<F>, &Array1<F>) -> IntegrateResult<F> + '_>>

Optional: Computes the Hamiltonian function H(q, p) Read more

Auto Trait Implementations§

§

impl<F> !UnwindSafe for HamiltonianSystem<F>

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 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 §