Struct bacon_sci::ivp::BDFInfo

pub struct BDFInfo<N, const S: usize, const O: usize>where
    N: ComplexField + FromPrimitive,
    <N as ComplexField>::RealField: FromPrimitive,
    Const<S>: DimMin<Const<S>, Output = Const<S>>,{ /* private fields */ }

Provides an IVPSolver implementation for BDFSolver, based on the higher and lower order coefficients. It is up to the BDFSolver to correctly implement the coefficients.

Implementations

impl<N, const S: usize, const O: usize> BDFInfo<N, S, O>where N: ComplexField + FromPrimitive, <N as ComplexField>::RealField: FromPrimitive, Const<S>: DimMin<Const<S>, Output = Const<S>>,

pub fn new() -> Self

Trait Implementations

impl<N, const S: usize, const O: usize> Clone for BDFInfo<N, S, O>where N: ComplexField + FromPrimitive + Clone, <N as ComplexField>::RealField: FromPrimitive, Const<S>: DimMin<Const<S>, Output = Const<S>>, N::RealField: Clone,

fn clone(&self) -> BDFInfo<N, S, O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N, const S: usize, const O: usize> Debug for BDFInfo<N, S, O>where N: ComplexField + FromPrimitive + Debug, <N as ComplexField>::RealField: FromPrimitive, Const<S>: DimMin<Const<S>, Output = Const<S>>, N::RealField: Debug,

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

Formats the value using the given formatter.

impl<N, const S: usize, const O: usize> Default for BDFInfo<N, S, O>where N: ComplexField + FromPrimitive, <N as ComplexField>::RealField: FromPrimitive, Const<S>: DimMin<Const<S>, Output = Const<S>>,

fn default() -> Self

Returns the “default value” for a type.

impl<N, const S: usize> From<BDF2<N, S>> for BDFInfo<N, S, 3>where N: ComplexField + FromPrimitive, <N as ComplexField>::RealField: FromPrimitive, Const<S>: DimMin<Const<S>, Output = Const<S>>,

fn from(bdf: BDF2<N, S>) -> BDFInfo<N, S, 3>

Converts to this type from the input type.

impl<N, const S: usize> From<BDF6<N, S>> for BDFInfo<N, S, 7>where N: ComplexField + FromPrimitive + Copy, <N as ComplexField>::RealField: FromPrimitive + Copy, Const<S>: DimMin<Const<S>, Output = Const<S>>,

fn from(bdf: BDF6<N, S>) -> Self

Converts to this type from the input type.

impl<N, const S: usize, const O: usize> IVPSolver<N, S> for BDFInfo<N, S, O>where N: ComplexField + FromPrimitive + Copy, <N as ComplexField>::RealField: FromPrimitive + Copy, Const<S>: DimMin<Const<S>, Output = Const<S>>,

fn step<T, F>( &mut self, f: F, params: &mut T ) -> Result<IVPStatus<N, S>, String>where T: Clone, F: FnMut(N::RealField, &[N], &mut T) -> Result<SVector<N, S>, String>,

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

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

Set the error tolerance for this solver.

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

Set the maximum time step for this solver.

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

Set the minimum time step for this solver.

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

Set the initial time for this solver.

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

Set the end time for this solver.

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

Set the initial conditions for this solver.

fn build(self) -> Self

Build this solver.

fn get_initial_conditions(&self) -> Option<SVector<N, S>>

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

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

Get the current time of the solver.

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

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

fn solve_ivp<T: Clone, F: FnMut(N::RealField, &[N], &mut T) -> Result<SVector<N, S>, String>>( self, f: F, params: &mut T ) -> Result<Vec<(N::RealField, SVector<N, S>)>, String>

Solve an initial value problem, consuming the solver