Skip to main content

DormandPrince45

Struct DormandPrince45 

Source
pub struct DormandPrince45 {
    pub atol: f64,
    pub rtol: f64,
    pub dt_min: f64,
    pub dt_max: f64,
}
Expand description

Dormand-Prince RK45 adaptive integrator with FSAL (First Same As Last).

This is the method underlying MATLAB’s ode45 and SciPy’s RK45. The 5th-order solution is used to advance the state; the 4th-order solution is used only for error estimation. The FSAL property means only 5 new function evaluations per accepted step (the last stage of step n equals the first stage of step n+1).

Fields§

§atol: f64

Absolute error tolerance.

§rtol: f64

Relative error tolerance.

§dt_min: f64

Minimum allowed step size.

§dt_max: f64

Maximum allowed step size.

Implementations§

Source§

impl DormandPrince45

Source

pub fn new(atol: f64, rtol: f64, dt_min: f64, dt_max: f64) -> Self

Construct with specified tolerances and step bounds.

Source

pub fn default_tolerances() -> Self

Construct with default tolerances (1e-6 / 1e-6).

Source

pub fn step<F>( &self, s: &OdeState, h: f64, f: &F, k1_in: Option<&Vec<f64>>, ) -> (OdeState, f64, Vec<f64>)
where F: Fn(f64, &[f64]) -> Vec<f64>,

Perform one FSAL Dormand-Prince step from state s with step h.

Returns (new_state, error_rms, k7) where k7 is the last stage (reusable as the first stage of the next step via FSAL).

Source

pub fn integrate<F>( &self, s0: &OdeState, t_end: f64, dt_init: f64, f: &F, ) -> OdeSolution
where F: Fn(f64, &[f64]) -> Vec<f64>,

Integrate from s0 to t_end with adaptive step control.

Returns an OdeSolution containing all accepted states.

Auto Trait Implementations§

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<U> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.