ida 0.1.1

A pure Rust port of the Implicit Differential-Algebraic solver from the Sundials suite.
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

use ndarray::prelude::*;

#[cfg(feature = "data_trace")]
use serde::Serialize;

pub trait TolControl<Scalar> {
    fn ewt_set<S1, S2>(&self, ycur: ArrayBase<S1, Ix1>, ewt: ArrayBase<S2, Ix1>)
    where
        S1: ndarray::Data<Elem = Scalar>,
        S2: ndarray::DataMut<Elem = Scalar>;
}

/// specifies scalar relative and absolute tolerances.
#[derive(Clone, Debug)]
#[cfg_attr(feature = "data_trace", derive(Serialize))]
pub struct TolControlSS<Scalar> {
    /// relative tolerance
    ida_rtol: Scalar,
    /// scalar absolute tolerance
    ida_atol: Scalar,
}

impl<Scalar> TolControlSS<Scalar> {
    pub fn new(rtol: Scalar, atol: Scalar) -> Self {
        Self {
            ida_rtol: rtol,
            ida_atol: atol,
        }
    }
}

impl<Scalar> TolControl<Scalar> for TolControlSS<Scalar>
where
    Scalar: num_traits::Float,
{
    fn ewt_set<S1, S2>(&self, ycur: ArrayBase<S1, Ix1>, mut ewt: ArrayBase<S2, Ix1>)
    where
        S1: ndarray::Data<Elem = Scalar>,
        S2: ndarray::DataMut<Elem = Scalar>,
    {
        ndarray::Zip::from(&mut ewt).and(&ycur).apply(|ewt, ycur| {
            *ewt = (self.ida_rtol * ycur.abs() + self.ida_atol).recip();
        });
    }
}

/// specifies scalar relative tolerance and a vector absolute tolerance (a potentially different
/// absolute tolerance for each vector component).
#[derive(Clone, Debug)]
#[cfg_attr(feature = "data_trace", derive(Serialize))]
pub struct TolControlSV<Scalar> {
    /// relative tolerance
    ida_rtol: Scalar,
    /// vector absolute tolerance
    ida_atol: Array1<Scalar>,
}

impl<Scalar> TolControlSV<Scalar> {
    pub fn new(rtol: Scalar, atol: Array1<Scalar>) -> Self {
        Self {
            ida_rtol: rtol,
            ida_atol: atol,
        }
    }
}

impl<Scalar> TolControl<Scalar> for TolControlSV<Scalar>
where
    Scalar: num_traits::Float,
{
    fn ewt_set<S1, S2>(&self, ycur: ArrayBase<S1, Ix1>, mut ewt: ArrayBase<S2, Ix1>)
    where
        S1: ndarray::Data<Elem = Scalar>,
        S2: ndarray::DataMut<Elem = Scalar>,
    {
        ndarray::Zip::from(&mut ewt)
            .and(&ycur)
            .and(&self.ida_atol)
            .apply(|ewt, ycur, atol| {
                *ewt = (self.ida_rtol * ycur.abs() + *atol).recip();
            });
    }
}