CompositionMethod

Struct CompositionMethod 

Source
pub struct CompositionMethod<F: IntegrateFloat, S: SymplecticIntegrator<F>> { /* private fields */ }
Expand description

A symplectic integrator constructed by composition of a base method

Implementations§

Source§

impl<F: IntegrateFloat, S: SymplecticIntegrator<F>> CompositionMethod<F, S>

Source

pub fn new(_basemethod: S, coefficients: Vec<F>) -> Self

Create a new composition method from a base integrator and coefficients

§Arguments
  • base_method - The base symplectic integrator
  • coefficients - Coefficients for the composition steps
§Returns

A new composition method

Source

pub fn fourth_order(_basemethod: S) -> Self

Create a 4th-order composition from a 2nd-order base method

This uses the standard 3-stage composition with coefficients: c₁ = c₃ = 1/(2-2^(1/3)), c₂ = -2^(1/3)/(2-2^(1/3))

§Arguments
  • base_method - A second-order symplectic integrator
§Returns

A fourth-order symplectic integrator

Source

pub fn sixth_order(_basemethod: S) -> Self

Create a 6th-order composition from a 2nd-order base method

This uses the standard 7-stage composition with optimized coefficients

§Arguments
  • base_method - A second-order symplectic integrator
§Returns

A sixth-order symplectic integrator

Source

pub fn eighth_order(_basemethod: S) -> Self

Create an 8th-order composition method from a 2nd-order base method

Uses a 15-stage composition with optimized coefficients

§Arguments
  • base_method - A second-order symplectic integrator
§Returns

An eighth-order symplectic integrator

Trait Implementations§

Source§

impl<F: Clone + IntegrateFloat, S: Clone + SymplecticIntegrator<F>> Clone for CompositionMethod<F, S>

Source§

fn clone(&self) -> CompositionMethod<F, S>

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<F: Debug + IntegrateFloat, S: Debug + SymplecticIntegrator<F>> Debug for CompositionMethod<F, S>

Source§

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

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

impl<F: IntegrateFloat, S: SymplecticIntegrator<F>> SymplecticIntegrator<F> for CompositionMethod<F, S>

Source§

fn step( &self, system: &dyn HamiltonianFn<F>, t: F, q: &Array1<F>, p: &Array1<F>, dt: F, ) -> IntegrateResult<(Array1<F>, Array1<F>)>

Perform a single integration step Read more
Source§

fn integrate( &self, system: &dyn HamiltonianFn<F>, t0: F, tf: F, dt: F, q0: Array1<F>, p0: Array1<F>, ) -> IntegrateResult<SymplecticResult<F>>

Integrate the system over a time interval Read more

Auto Trait Implementations§

§

impl<F, S> Freeze for CompositionMethod<F, S>
where S: Freeze,

§

impl<F, S> RefUnwindSafe for CompositionMethod<F, S>

§

impl<F, S> Send for CompositionMethod<F, S>
where S: Send, F: Send,

§

impl<F, S> Sync for CompositionMethod<F, S>
where S: Sync, F: Sync,

§

impl<F, S> Unpin for CompositionMethod<F, S>
where S: Unpin, F: Unpin,

§

impl<F, S> UnwindSafe for CompositionMethod<F, S>
where S: UnwindSafe, F: 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> 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.
Source§

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

Source§

fn vzip(self) -> V