scirs2_integrate::geometric::volume_preserving

Struct DiscreteGradientIntegrator

pub struct DiscreteGradientIntegrator { /* private fields */ }

Expand description

Discrete gradient method for preserving multiple invariants

Implementations§

Source §

impl DiscreteGradientIntegrator

Source

pub fn new(dt: f64) -> Self

Create a new discrete gradient integrator

Source

pub fn add_invariant(&mut self, invariant: I) -> &mut Self
where I: Fn(&ArrayView1<'_, f64>) -> f64 + 'static,

Add an invariant function to preserve

Source

pub fn discrete_gradient( &self, x0: &ArrayView1<'_, f64>, x1: &ArrayView1<'_, f64>, invariantidx: usize, ) -> Array1<f64>

Compute discrete gradient

Auto Trait Implementations§

§

impl !UnwindSafe for DiscreteGradientIntegrator

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 §