ode_solvers 0.6.1

Numerical methods to solve ordinary differential equations (ODEs) in Rust.
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

//! Adaptive step size control.
use crate::dop_shared::FloatNumber;

/// Used for adaptive step size control
pub struct Controller<T> {
    alpha: T,
    beta: T,
    facc1: T,
    facc2: T,
    fac_old: T,
    h_max: T,
    reject: bool,
    safety_factor: T,
    posneg: T,
}

impl<T: FloatNumber> Controller<T> {
    /// Creates a controller responsible for adaptive step size control.
    ///
    /// # Arguments
    ///
    /// * `alpha`   - &#945; coefficient of the PI controller
    /// * `beta`    - &#946; coefficient of the PI controller
    /// * `fac_max` - Maximum factor between two successive steps
    /// * `fac_min` - Minimum factor between two successive steps
    /// * `h_max`   - Maximum step size
    /// * `safety_factor`   - Safety factor of the PI controller
    ///
    pub fn new(
        alpha: T,
        beta: T,
        fac_max: T,
        fac_min: T,
        h_max: T,
        safety_factor: T,
        posneg: T,
    ) -> Controller<T> {
        Controller {
            alpha,
            beta,
            facc1: T::one() / fac_min,
            facc2: T::from(1.0).unwrap() / fac_max,
            fac_old: T::from(1.0E-4).unwrap(),
            h_max: h_max.abs(),
            reject: false,
            safety_factor,
            posneg,
        }
    }

    /// Determines if the step must be accepted or rejected and adapts the step size accordingly.
    pub fn accept(&mut self, err: T, h: T, h_new: &mut T) -> bool {
        let fac11 = err.powf(self.alpha);
        let mut fac = fac11 * self.fac_old.powf(-self.beta);
        fac = (self.facc2).max((self.facc1).min(fac / self.safety_factor));
        *h_new = h / fac;

        if err <= T::from(1.0).unwrap() {
            // Accept step
            self.fac_old = err.max(T::from(1.0E-4).unwrap());

            if h_new.abs() > self.h_max {
                *h_new = self.posneg * self.h_max;
            }
            if self.reject {
                *h_new = self.posneg * h_new.abs().min(h.abs());
            }

            self.reject = false;
            true
        } else {
            // Reject step
            *h_new = h / ((self.facc1).min(fac11 / self.safety_factor));
            self.reject = true;
            false
        }
    }

    /// Returns the maximum step size allowed.
    pub fn h_max(&self) -> T {
        self.h_max
    }
}