Struct ODEProblem

pub struct ODEProblem<Sys> { /* private fields */ }

An ODE problem ready to be solved.

An ODE problem comprises an ODE system plus the extra information needed to solve the system, namely the initial values and the time span.

Implementations

impl<Sys> ODEProblem<Sys>

pub fn new(system: Sys, initial_values: DVector<f32>) -> Self

Creates a new ODE problem.

pub fn start_time(self, t: f32) -> Self

Sets the start time for the problem.

pub fn end_time(self, t: f32) -> Self

Sets the end time for the problem.

pub fn time_span(self, tspan: (f32, f32)) -> Self

Sets the time span (start and end time) for the problem.

impl<Sys> ODEProblem<Sys>

where Sys: ODESystem,

pub fn solve_rk4( &self, step_size: f32, ) -> Result<SolverResult<f32, DVector<f32>>, IntegrationError>

Solves the ODE system using the Runge-Kutta method.

Returns the solver results if successful and an integration error otherwise.

pub fn solve_dopri5( &self, output_step_size: f32, ) -> Result<SolverResult<f32, DVector<f32>>, IntegrationError>

Solves the ODE system using the Dormand-Prince method.

A variant of Runge-Kutta with adaptive step size control and automatic selection of initial step size.

Trait Implementations

impl<Sys: Clone> Clone for ODEProblem<Sys>

fn clone(&self) -> ODEProblem<Sys>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Sys: Debug> Debug for ODEProblem<Sys>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Sys: PartialEq> PartialEq for ODEProblem<Sys>

fn eq(&self, other: &ODEProblem<Sys>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Sys> System<f32, Matrix<f32, Dyn, Const<1>, VecStorage<f32, Dyn, Const<1>>>> for &ODEProblem<Sys>

where Sys: ODESystem,

fn system(&self, x: f32, y: &DVector<f32>, dy: &mut DVector<f32>)

System of ordinary differential equations.

fn solout(&mut self, _x: T, _y: &V, _dy: &V) -> bool

Stop function called at every successful integration step. The integration is stopped when this function returns true.

impl<Sys> StructuralPartialEq for ODEProblem<Sys>