Struct Dopri5

pub struct Dopri5<T, V, F>
where
    T: FloatNumber,
    F: System<T, V>,
{ /* private fields */ }

Structure containing the parameters for the numerical integration.

Implementations

impl<T, D: Dim, F> Dopri5<T, OVector<T, D>, F>

where f64: From<T>, T: FloatNumber, F: System<T, OVector<T, D>>, OVector<T, D>: Mul<T, Output = OVector<T, D>>, DefaultAllocator: Allocator<D>,

pub fn new( f: F, x: T, x_end: T, dx: T, y: OVector<T, D>, rtol: T, atol: T, ) -> Self

Default initializer for the structure

Arguments

• f - Structure implementing the System trait
• x - Initial value of the independent variable (usually time)
• x_end - Final value of the independent variable
• dx - Increment in the dense output. This argument has no effect if the output type is Sparse
• y - Initial value of the dependent variable(s)
• rtol - Relative tolerance used in the computation of the adaptive step size
• atol - Absolute tolerance used in the computation of the adaptive step size

pub fn from_param( f: F, x: T, x_end: T, dx: T, y: OVector<T, D>, rtol: T, atol: T, safety_factor: T, beta: T, fac_min: T, fac_max: T, h_max: T, h: T, n_max: u32, n_stiff: u32, out_type: OutputType, ) -> Self

Advanced initializer for the structure.

Arguments

• f - Structure implementing the System trait
• x - Initial value of the independent variable (usually time)
• x_end - Final value of the independent variable
• dx - Increment in the dense output. This argument has no effect if the output type is Sparse
• y - Initial value of the dependent variable(s)
• rtol - Relative tolerance used in the computation of the adaptive step size
• atol - Absolute tolerance used in the computation of the adaptive step size
• safety_factor - Safety factor used in the computation of the adaptive step size
• beta - Value of the beta coefficient of the PI controller. Default is 0.04
• fac_min - Minimum factor between two successive steps. Default is 0.2
• fac_max - Maximum factor between two successive steps. Default is 10.0
• h_max - Maximum step size. Default is x_end-x
• h - Initial value of the step size. If h = 0.0, the initial value of h is computed automatically
• n_max - Maximum number of iterations. Default is 100000
• n_stiff - Stiffness is tested when the number of iterations is a multiple of n_stiff. Default is 1000
• out_type - Type of the output. Must be a variant of the OutputType enum. Default is Dense

pub fn integrate_with_continuous_output_model( &mut self, continuous_output: &mut ContinuousOutputModel<T, OVector<T, D>>, ) -> Result<Stats, IntegrationError>

Integrates the system and builds a continuous output model.

pub fn integrate(&mut self) -> Result<Stats, IntegrationError>

Integrates the system.

pub fn x_out(&self) -> &Vec<T>

Getter for the independent variable’s output.

pub fn y_out(&self) -> &Vec<OVector<T, D>>

Getter for the dependent variables’ output.

pub fn results(&self) -> &SolverResult<T, OVector<T, D>>

Getter for the results type, a pair of independent and dependent variables

Trait Implementations

impl<T, D: Dim, F> From<Dopri5<T, Matrix<T, D, Const<1>, <DefaultAllocator as Allocator<D>>::Buffer<T>>, F>> for SolverResult<T, OVector<T, D>>

where T: FloatNumber, F: System<T, OVector<T, D>>, DefaultAllocator: Allocator<D>,

fn from(val: Dopri5<T, OVector<T, D>, F>) -> Self

Converts to this type from the input type.