Skip to main content

RK4Integrator

Struct RK4Integrator 

Source
pub struct RK4Integrator {
    pub atol: f64,
    pub rtol: f64,
}
Expand description

Classic 4th-order Runge-Kutta integrator with optional adaptive step size.

In fixed-step mode each call to RK4Integrator::step advances the state by exactly dt. The adaptive driver RK4Integrator::integrate_adaptive doubles or halves the step based on an embedded 2nd-order (midpoint) error estimate.

Fields§

§atol: f64

Absolute tolerance used by the adaptive driver.

§rtol: f64

Relative tolerance used by the adaptive driver.

Implementations§

Source§

impl RK4Integrator

Source

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

Construct an integrator with the given tolerances.

Source

pub fn default_tolerances() -> Self

Construct with default tolerances (1e-6 absolute, 1e-6 relative).

Source

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

Perform one fixed RK4 step from state s using step size dt.

f(t, y) is the right-hand side of dy/dt = f(t, y).

Source

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

Integrate from s0 to time t_end using a fixed step dt.

Returns all intermediate states including the initial state.

Source

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

Integrate from s0 to t_end with adaptive step size.

Uses an embedded RK2 error estimate to control the step. The step is accepted when the RMS error is below atol + rtol * ||y||.

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.