Struct RungeKutta

pub struct RungeKutta<'a, N, D, const O: usize, T, F, R>
where
    D: Dimension,
    N: ComplexField + Copy,
    T: Clone,
    F: Derivative<N, D, T> + 'a,
    R: RungeKuttaCoefficients<O, RealField = N::RealField>,
    DefaultAllocator: Allocator<N, D> + Allocator<N, Const<O>>,
{ /* private fields */ }

The nuts and bolts Runge-Kutta solver Users won’t use this directly if they aren’t defining their own Runge-Kutta solver Used as a common struct for the specific implementations

Trait Implementations

impl<'a, N, D, const O: usize, T, F, R> IVPSolver<'a, D> for RungeKutta<'a, N, D, O, T, F, R>

where D: Dimension, N: ComplexField + Copy, T: Clone, F: Derivative<N, D, T> + 'a, R: RungeKuttaCoefficients<O, RealField = N::RealField>, DefaultAllocator: Allocator<N, D> + Allocator<N, Const<O>> + Allocator<N, D, Const<O>>,

fn with_maximum_dt(self, max: Self::RealField) -> Result<Self, Self::Error>

Will overwrite any previously set value If the provided maximum is less than a previously set minimum, then the minimum is set to this value as well.

fn with_minimum_dt(self, min: Self::RealField) -> Result<Self, Self::Error>

Will overwrite any previously set value If the provided minimum is greatear than a previously set maximum, then the maximum is set to this value as well.

type Error = IVPError

Error type. IVPError must be able to convert to the error type.

type Field = N

The field, complex or real, that the solver is operating on.

type RealField = <N as ComplexField>::RealField

The real field associated with the solver’s Field.

type Derivative = F

The type signature of the derivative function to use

type UserData = T

Arbitrary data provided by the user for the derivative function

type Solver = RungeKuttaSolver<'a, N, D, O, T, F>

The type that actually does the solving.

fn new() -> Result<Self, IVPError>

Create the solver. Will fail for dynamically sized solvers

fn new_dyn(size: usize) -> Result<Self, IVPError>

Create the solver with a run-time dimension. Will fail for statically sized solvers

fn dim(&self) -> D

Gets the dimension of the solver

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

Set the error tolerance for any condition needing needing a float epsilon

fn with_initial_time( self, initial: Self::RealField, ) -> Result<Self, Self::Error>

fn with_ending_time(self, ending: Self::RealField) -> Result<Self, Self::Error>

fn with_initial_conditions( self, start: BVector<Self::Field, D>, ) -> Result<Self, Self::Error>

The initial conditions of the problem, in a BVector. Should reset any previous values.

fn with_derivative(self, derivative: Self::Derivative) -> Self

Sets the derivative function to use during the solve

fn solve( self, data: Self::UserData, ) -> Result<IVPIterator<D, Self::Solver>, Self::Error>

Turns the solver into an iterator over the solution, using IVPStep::step

fn with_initial_conditions_slice( self, start: &[Self::Field], ) -> Result<Self, Self::Error>

The initial conditions of the problem, should reset any previous values.