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

//! RAII wrapper for `SUNContext` — required by all SUNDIALS 6.x+ creation calls.

use std::ptr::NonNull;
use sundials_rs_sys as sys;
use crate::error::SundialsError;

/// Owns a `SUNContext` and frees it on drop.
///
/// Every solver and vector creation function in SUNDIALS >= 6.0 requires a
/// context.  Create one per solver instance and pass `raw()` wherever needed.
pub struct SunContext {
    ptr: NonNull<sys::SUNContext_>,
}

impl SunContext {
    pub fn new() -> Result<Self, SundialsError> {
        let mut ctx: sys::SUNContext = std::ptr::null_mut();
        // SUN_COMM_NULL == 0 (int) on non-MPI builds, MPI_COMM_NULL on MPI builds.
        // Cast 0 to whatever SUNComm resolves to in the generated bindings.
        let comm: sys::SUNComm = 0;
        let flag = unsafe { sys::SUNContext_Create(comm, &mut ctx) };
        if flag != 0 || ctx.is_null() {
            return Err(SundialsError::Memory("SUNContext_Create"));
        }
        Ok(Self {
            ptr: unsafe { NonNull::new_unchecked(ctx) },
        })
    }

    /// Raw pointer — pass this to SUNDIALS creation functions.
    pub fn raw(&self) -> sys::SUNContext {
        self.ptr.as_ptr()
    }
}

impl Drop for SunContext {
    fn drop(&mut self) {
        let mut ptr = self.ptr.as_ptr();
        unsafe { sys::SUNContext_Free(&mut ptr) };
    }
}

unsafe impl Send for SunContext {}