Struct bacon_sci::ivp::Euler

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

Euler solver for an IVP.

Solves an initial value problem using Euler's method.

Examples

use nalgebra::DVector;
use bacon_sci::ivp::{Euler, IVPSolver};
fn derivative(_t: f64, state: &[f64], _p: &mut ()) -> Result<DVector<f64>, String> {
    Ok(DVector::from_column_slice(state))
}

fn example() -> Result<(), String> {
    let solver = Euler::new()
        .with_dt_max(0.001)?
        .with_initial_conditions(&[1.0])?
        .with_start(0.0)?
        .with_end(1.0)?
        .build();
    let path = solver.solve_ivp(derivative, &mut ())?;

    for (time, state) in &path {
        assert!((time.exp() - state.column(0)[0]).abs() <= 0.001);
    }
    Ok(())
}

Implementations

impl<N: ComplexField> Euler<N>

pub fn new() -> Self

Trait Implementations

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

pub fn clone(&self) -> Euler<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 Euler<N> where
    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: Default + ComplexField> Default for Euler<N> where
    N::RealField: Default,
    N::RealField: Default,
    N::RealField: Default, 

pub fn default() -> Euler<N>

Returns the "default value" for a type.

impl<N: ComplexField> IVPSolver<N> for Euler<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