diffsol 0.12.2

A library for solving 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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

use crate::{OdeSolverOptions, Scalar};

pub trait OdeSolverConfig<T> {
    fn as_base_ref(&self) -> OdeSolverConfigRef<'_, T>;
    fn as_base_mut(&mut self) -> OdeSolverConfigMut<'_, T>;
}
pub struct OdeSolverConfigRef<'a, T> {
    pub minimum_timestep: &'a T,
    pub maximum_error_test_failures: &'a usize,
    pub maximum_timestep_growth: &'a T,
    pub minimum_timestep_shrink: &'a T,
}

pub struct OdeSolverConfigMut<'a, T> {
    pub minimum_timestep: &'a mut T,
    pub maximum_error_test_failures: &'a mut usize,
    pub maximum_timestep_growth: &'a mut T,
    pub minimum_timestep_shrink: &'a mut T,
}

#[derive(Debug, Clone)]
pub struct BdfConfig<T> {
    pub minimum_timestep: T,
    pub maximum_error_test_failures: usize,
    pub maximum_newton_fails: usize,
    pub maximum_timestep_growth: T,
    pub minimum_timestep_growth: T,
    pub maximum_timestep_shrink: T,
    pub minimum_timestep_shrink: T,
    pub maximum_newton_iterations: usize,
}

impl<T: Scalar> OdeSolverConfig<T> for BdfConfig<T> {
    fn as_base_ref(&self) -> OdeSolverConfigRef<'_, T> {
        OdeSolverConfigRef {
            minimum_timestep: &self.minimum_timestep,
            maximum_error_test_failures: &self.maximum_error_test_failures,
            maximum_timestep_growth: &self.maximum_timestep_growth,
            minimum_timestep_shrink: &self.minimum_timestep_shrink,
        }
    }

    fn as_base_mut(&mut self) -> OdeSolverConfigMut<'_, T> {
        OdeSolverConfigMut {
            minimum_timestep: &mut self.minimum_timestep,
            maximum_error_test_failures: &mut self.maximum_error_test_failures,
            maximum_timestep_growth: &mut self.maximum_timestep_growth,
            minimum_timestep_shrink: &mut self.minimum_timestep_shrink,
        }
    }
}

impl<T: Scalar> BdfConfig<T> {
    pub fn new(ode_options: &OdeSolverOptions<T>) -> Self {
        Self {
            minimum_timestep: ode_options.min_timestep,
            maximum_error_test_failures: ode_options.max_error_test_failures,
            maximum_newton_fails: ode_options.max_nonlinear_solver_failures,
            maximum_timestep_growth: ode_options
                .max_timestep_growth
                .unwrap_or_else(|| T::from_f64(2.0).unwrap()),
            minimum_timestep_growth: ode_options
                .min_timestep_growth
                .unwrap_or_else(|| T::from_f64(2.0).unwrap()),
            maximum_timestep_shrink: ode_options
                .max_timestep_shrink
                .unwrap_or_else(|| T::from_f64(0.9).unwrap()),
            minimum_timestep_shrink: ode_options
                .min_timestep_shrink
                .unwrap_or_else(|| T::from_f64(0.5).unwrap()),
            maximum_newton_iterations: ode_options.max_nonlinear_solver_iterations,
        }
    }
}

#[derive(Debug, Clone)]
pub struct SdirkConfig<T> {
    pub minimum_timestep: T,
    pub maximum_error_test_failures: usize,
    pub maximum_timestep_growth: T,
    pub minimum_timestep_growth: T,
    pub minimum_timestep_shrink: T,
    pub maximum_timestep_shrink: T,
    pub maximum_newton_iterations: usize,
    pub maximum_newton_fails: usize,
}

impl<T: Scalar> SdirkConfig<T> {
    pub fn new(ode_options: &OdeSolverOptions<T>) -> Self {
        Self {
            minimum_timestep: ode_options.min_timestep,
            maximum_error_test_failures: ode_options.max_error_test_failures,
            maximum_timestep_growth: ode_options
                .max_timestep_growth
                .unwrap_or_else(|| T::from_f64(2.0).unwrap()),
            minimum_timestep_growth: ode_options
                .min_timestep_growth
                .unwrap_or_else(|| T::from_f64(2.0).unwrap()),
            maximum_timestep_shrink: ode_options
                .max_timestep_shrink
                .unwrap_or_else(|| T::from_f64(0.9).unwrap()),
            minimum_timestep_shrink: ode_options
                .min_timestep_shrink
                .unwrap_or_else(|| T::from_f64(0.5).unwrap()),
            maximum_newton_iterations: ode_options.max_nonlinear_solver_iterations,
            maximum_newton_fails: ode_options.max_nonlinear_solver_failures,
        }
    }
}

impl<T: Scalar> OdeSolverConfig<T> for SdirkConfig<T> {
    fn as_base_ref(&self) -> OdeSolverConfigRef<'_, T> {
        OdeSolverConfigRef {
            minimum_timestep: &self.minimum_timestep,
            maximum_error_test_failures: &self.maximum_error_test_failures,
            maximum_timestep_growth: &self.maximum_timestep_growth,
            minimum_timestep_shrink: &self.minimum_timestep_shrink,
        }
    }

    fn as_base_mut(&mut self) -> OdeSolverConfigMut<'_, T> {
        OdeSolverConfigMut {
            minimum_timestep: &mut self.minimum_timestep,
            maximum_error_test_failures: &mut self.maximum_error_test_failures,
            maximum_timestep_growth: &mut self.maximum_timestep_growth,
            minimum_timestep_shrink: &mut self.minimum_timestep_shrink,
        }
    }
}

#[derive(Debug, Clone)]
pub struct ExplicitRkConfig<T> {
    pub minimum_timestep: T,
    pub maximum_error_test_failures: usize,
    pub maximum_timestep_growth: T,
    pub minimum_timestep_growth: T,
    pub minimum_timestep_shrink: T,
    pub maximum_timestep_shrink: T,
}

impl<T: Scalar> ExplicitRkConfig<T> {
    pub fn new(ode_options: &OdeSolverOptions<T>) -> Self {
        Self {
            minimum_timestep: ode_options.min_timestep,
            maximum_error_test_failures: ode_options.max_error_test_failures,
            maximum_timestep_growth: ode_options
                .max_timestep_growth
                .unwrap_or_else(|| T::from_f64(2.0).unwrap()),
            minimum_timestep_growth: ode_options
                .min_timestep_growth
                .unwrap_or_else(|| T::from_f64(1.0).unwrap()),
            maximum_timestep_shrink: ode_options
                .max_timestep_shrink
                .unwrap_or_else(|| T::from_f64(1.0).unwrap()),
            minimum_timestep_shrink: ode_options
                .min_timestep_shrink
                .unwrap_or_else(|| T::from_f64(0.5).unwrap()),
        }
    }
}

impl<T: Scalar> OdeSolverConfig<T> for ExplicitRkConfig<T> {
    fn as_base_ref(&self) -> OdeSolverConfigRef<'_, T> {
        OdeSolverConfigRef {
            minimum_timestep: &self.minimum_timestep,
            maximum_error_test_failures: &self.maximum_error_test_failures,
            maximum_timestep_growth: &self.maximum_timestep_growth,
            minimum_timestep_shrink: &self.minimum_timestep_shrink,
        }
    }

    fn as_base_mut(&mut self) -> OdeSolverConfigMut<'_, T> {
        OdeSolverConfigMut {
            minimum_timestep: &mut self.minimum_timestep,
            maximum_error_test_failures: &mut self.maximum_error_test_failures,
            maximum_timestep_growth: &mut self.maximum_timestep_growth,
            minimum_timestep_shrink: &mut self.minimum_timestep_shrink,
        }
    }
}