SeparableHamiltonian

Struct SeparableHamiltonian 

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

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

This represents systems where the Hamiltonian can be split into kinetic energy T(p) depending only on momenta and potential energy V(q) depending only on positions.

Examples include:

  • Simple harmonic oscillator: H = p²/2 + q²/2
  • Pendulum: H = p²/2 - cos(q)
  • Kepler problem: H = |p|²/2 - 1/|q|

Implementations§

Source§

impl<F: IntegrateFloat> SeparableHamiltonian<F>

Source

pub fn new<K, V>(_kinetic_energy: K, potentialenergy: V) -> Self
where K: Fn(F, &Array1<F>) -> F + 'static + Send + Sync, V: Fn(F, &Array1<F>) -> F + 'static + Send + Sync,

Create a new separable Hamiltonian system

§Arguments
  • kinetic_energy - Function computing T(p)
  • potential_energy - Function computing V(q)
§Returns

A new separable Hamiltonian system

Source

pub fn with_gradients<KG, VG>( self, kinetic_gradient: KG, potentialgradient: VG, ) -> Self
where KG: Fn(F, &Array1<F>) -> Array1<F> + 'static + Send + Sync, VG: Fn(F, &Array1<F>) -> Array1<F> + 'static + Send + Sync,

Add analytical gradient functions for improved performance

§Arguments
  • kinetic_gradient - Function computing ∇T(p)
  • potential_gradient - Function computing ∇V(q)
§Returns

Self with gradients configured

Source

pub fn harmonic_oscillator() -> Self

Create a simple harmonic oscillator system

H(q, p) = p²/2 + q²/2

§Returns

A harmonic oscillator Hamiltonian

Source

pub fn pendulum() -> Self

Create a pendulum system

H(q, p) = p²/2 - cos(q)

§Returns

A pendulum Hamiltonian

Source

pub fn kepler_problem() -> Self

Create a 2D Kepler problem (planetary orbit)

H(q, p) = |p|²/2 - 1/|q|

§Returns

A Kepler problem Hamiltonian

Trait Implementations§

Source§

impl<F: IntegrateFloat> Debug for SeparableHamiltonian<F>

Source§

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

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

impl<F: IntegrateFloat> HamiltonianFn<F> for SeparableHamiltonian<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§

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