Struct bacon_sci::ivp::Adams2

pub struct Adams2<N, const S: usize>where
    N: ComplexField + FromPrimitive + Copy,
    <N as ComplexField>::RealField: FromPrimitive + Copy,{ /* private fields */ }

3rd order Adams predictor-corrector method for solving an IVP.

Defines the predictor and corrector coefficients, as well as the error coefficient. Uses AdamsInfo for the actual solving.

Examples

use nalgebra::SVector;
use bacon_sci::ivp::{Adams2, AdamsSolver};
fn derivatives(_t: f64, state: &[f64], _p: &mut ()) -> Result<SVector<f64, 1>, String> {
    Ok(SVector::<f64, 1>::from_column_slice(state))
}


fn example() -> Result<(), String> {
    let adams = Adams2::new()
        .with_dt_max(0.1)?
        .with_dt_min(0.00001)?
        .with_tolerance(0.00001)?
        .with_start(0.0)?
        .with_end(1.0)?
        .with_initial_conditions(&[1.0])?
        .build();
    let path = adams.solve_ivp(derivatives, &mut ())?;
    for (time, state) in &path {
        assert!((time.exp() - state.column(0)[0]).abs() < 0.001);
    }
    Ok(())
}

Implementations

impl<N, const S: usize> Adams2<N, S>where N: ComplexField + FromPrimitive + Copy, <N as ComplexField>::RealField: FromPrimitive + Copy,

pub fn new() -> Self

Trait Implementations

impl<N, const S: usize> AdamsSolver<N, S, 3> for Adams2<N, S>where N: ComplexField + FromPrimitive + Copy, <N as ComplexField>::RealField: FromPrimitive + Copy,

fn predictor_coefficients() -> SVector<N::RealField, 3>

The polynomial interpolation coefficients for the predictor. Should start with the coefficient for n - 1

fn corrector_coefficients() -> SVector<N::RealField, 3>

The polynomial interpolation coefficients for the corrector. Must be the same length as predictor_coefficients. Should start with the implicit coefficient.

fn error_coefficient() -> N::RealField

Coefficient for multiplying error by.

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>

Use AdamsInfo to solve an initial value problem

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.

impl<N, const S: usize> Clone for Adams2<N, S>where N: ComplexField + FromPrimitive + Copy + Clone, <N as ComplexField>::RealField: FromPrimitive + Copy,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N, const S: usize> Debug for Adams2<N, S>where N: ComplexField + FromPrimitive + Copy + Debug, <N as ComplexField>::RealField: FromPrimitive + Copy,

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

Formats the value using the given formatter.

impl<N, const S: usize> Default for Adams2<N, S>where N: ComplexField + FromPrimitive + Copy, <N as ComplexField>::RealField: FromPrimitive + Copy,

fn default() -> Self

Returns the “default value” for a type.

impl<N, const S: usize> From<Adams2<N, S>> for AdamsInfo<N, S, 3>where N: ComplexField + FromPrimitive + Copy, <N as ComplexField>::RealField: FromPrimitive + Copy,

fn from(adams: Adams2<N, S>) -> AdamsInfo<N, S, 3>

Converts to this type from the input type.