sundials-rs 0.1.1

Safe Rust bindings to the SUNDIALS ODE/DAE solver library (CVODE, CVODES, IDA, IDAS)
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

use thiserror::Error;

#[derive(Debug, Error)]
pub enum SundialsError {
    #[error("memory allocation failed in {0}")]
    Memory(&'static str),

    #[error("{solver} returned error code {code} in {function}")]
    ReturnCode {
        solver: &'static str,
        function: &'static str,
        code: i32,
    },

    #[error("right-hand side function returned non-zero flag {0}")]
    RhsError(i32),

    #[error("N_Vector creation failed")]
    NVectorCreate,

    #[error("SUNMatrix creation failed")]
    MatrixCreate,

    #[error("SUNLinearSolver creation failed")]
    LinearSolverCreate,

    #[error("step size became too small")]
    TooMuchWork,

    #[error("solution appears to diverge")]
    Diverge,
}

/// Map a SUNDIALS integer flag to `Ok(())` or an appropriate `Err`.
pub(crate) fn check_flag(
    flag: std::os::raw::c_int,
    solver: &'static str,
    function: &'static str,
) -> Result<(), SundialsError> {
    // Flag values are defined per-solver in their respective headers.
    // 0 is CV_SUCCESS / IDA_SUCCESS for all solvers.
    if flag >= 0 {
        Ok(())
    } else {
        Err(SundialsError::ReturnCode { solver, function, code: flag })
    }
}