russell_ode 1.15.0

Solvers for ordinary differential equations and differential algebraic equations
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

use crate::StrError;
use crate::{Params, Workspace};
use russell_lab::Vector;

/// Defines the numerical solver
pub(crate) trait OdeSolverTrait<A>: Send {
    /// Enables dense output
    fn enable_dense_output(&mut self) -> Result<(), StrError>;

    /// Calculates the quantities required to update x and y
    fn step(&mut self, work: &mut Workspace, x: f64, y: &Vector, h: f64, args: &mut A) -> Result<(), StrError>;

    /// Updates x and y and computes the next stepsize
    fn accept(
        &mut self,
        work: &mut Workspace,
        x: &mut f64,
        y: &mut Vector,
        h: f64,
        args: &mut A,
    ) -> Result<(), StrError>;

    /// Rejects the update
    fn reject(&mut self, work: &mut Workspace, h: f64);

    /// Computes the dense output with x-h ≤ x_out ≤ x
    fn dense_output(&self, y_out: &mut Vector, x_out: f64, x: f64, y: &Vector, h: f64);

    /// Update the parameters (e.g., for sensitive analyses)
    fn update_params(&mut self, params: Params);
}