Struct bacon_sci::ivp::rk::RKInfo

pub struct RKInfo<N: ComplexField> { /* fields omitted */ }

Provides an IVPSolver implementation for RungeKuttaSolver, based entirely on the Butch Tableaux coefficients. It is up to the RungeKuttaSolver to set up RKInfo. See RK45 for an example.

Trait Implementations

impl<N: Clone + ComplexField> Clone for RKInfo<N> where
    N::RealField: Clone,
    N::RealField: Clone,
    N::RealField: Clone,
    N::RealField: Clone,
    N::RealField: Clone,
    N::RealField: Clone,
    N::RealField: Clone,
    N::RealField: Clone,
    N::RealField: Clone,
    N::RealField: Clone, 

pub fn clone(&self) -> RKInfo<N>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<N: Debug + ComplexField> Debug for RKInfo<N> where
    N::RealField: Debug,
    N::RealField: Debug,
    N::RealField: Debug,
    N::RealField: Debug,
    N::RealField: Debug,
    N::RealField: Debug,
    N::RealField: Debug,
    N::RealField: Debug,
    N::RealField: Debug,
    N::RealField: Debug, 

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

Formats the value using the given formatter.

impl<N: ComplexField> Default for RKInfo<N>

pub fn default() -> Self

Returns the "default value" for a type.

impl<N: ComplexField> From<RK45<N>> for RKInfo<N>

pub fn from(rk: RK45<N>) -> RKInfo<N>

Performs the conversion.

impl<N: ComplexField> IVPSolver<N> for RKInfo<N>

pub fn step<T: Clone>(
    &mut self,
    f: fn(_: N::RealField, _: &[N], _: &mut T) -> Result<DVector<N>, String>,
    params: &mut T
) -> Result<IVPStatus<N>, String>

Step forward in the solver. Returns if the solver is finished, produced an acceptable state, or needs to be redone.

pub fn with_tolerance(self, tol: N::RealField) -> Result<Self, String>

Set the error tolerance for this solver.

pub fn with_dt_max(self, max: N::RealField) -> Result<Self, String>

Set the maximum time step for this solver.

pub fn with_dt_min(self, min: N::RealField) -> Result<Self, String>

Set the minimum time step for this solver.

pub fn with_start(self, t_initial: N::RealField) -> Result<Self, String>

Set the initial time for this solver.

pub fn with_end(self, t_final: N::RealField) -> Result<Self, String>

Set the end time for this solver.

pub fn with_initial_conditions(self, start: &[N]) -> Result<Self, String>

Set the initial conditions for this solver.

pub fn build(self) -> Self

Build this solver.

pub fn get_initial_conditions(&self) -> Option<DVector<N>>

Return the initial conditions. Called once at the very start of solving.

pub fn get_time(&self) -> Option<N::RealField>

Get the current time of the solver.

pub fn check_start(&self) -> Result<(), String>

Make sure that every value that needs to be set is set before the solver starts

pub fn solve_ivp<T: Clone>(
    self,
    f: fn(_: N::RealField, _: &[N], _: &mut T) -> Result<DVector<N>, String>,
    params: &mut T
) -> Result<Vec<(N::RealField, DVector<N>)>, String>

Solve an initial value problem, consuming the solver