diffsol-c 0.4.4

A diffsol wrapper featuring runtime scalar/matrix/solver types and a C API
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

use std::{
    any::Any,
    sync::{Arc, Mutex, MutexGuard},
};

use diffsol::{CheckpointingPath, DefaultSolver, DiffSl, DiffsolError, OdeEquationsImplicit};

use crate::{
    error::DiffsolRtError, linear_solver_type::LinearSolverType,
    ode_solver_tag::OdeSolverMethodTag, ode_solver_type::OdeSolverType, scalar_type::Scalar,
};

pub(crate) trait AdjointCheckpoint: Any + Send {
    fn as_any(&self) -> &dyn Any;
    fn method(&self) -> OdeSolverType;
    fn linear_solver(&self) -> LinearSolverType;
    fn params(&self) -> &[f64];
}

impl dyn AdjointCheckpoint + '_ {
    pub(crate) fn data<M, CG, Tag>(
        &self,
    ) -> Result<&AdjointCheckpointData<M, CG, Tag>, DiffsolError>
    where
        M: diffsol::Matrix<T: Scalar> + DefaultSolver + 'static,
        CG: diffsol::CodegenModule + 'static,
        DiffSl<M, CG>: OdeEquationsImplicit<V = M::V> + 'static,
        Tag: OdeSolverMethodTag<M, CG> + 'static,
    {
        self.as_any()
            .downcast_ref::<AdjointCheckpointData<M, CG, Tag>>()
            .ok_or_else(|| {
                DiffsolError::Other(
                    "Adjoint checkpoint is incompatible with this ODE solver".to_string(),
                )
            })
    }
}

pub(crate) struct AdjointCheckpointData<M, CG, Tag>
where
    M: diffsol::Matrix<T: Scalar> + DefaultSolver,
    CG: diffsol::CodegenModule,
    DiffSl<M, CG>: OdeEquationsImplicit<V = M::V>,
    Tag: OdeSolverMethodTag<M, CG>,
{
    pub(crate) checkpointing: CheckpointingPath<DiffSl<M, CG>, Tag::State>,
    params: Vec<f64>,
    method: OdeSolverType,
    linear_solver: LinearSolverType,
}

impl<M, CG, Tag> AdjointCheckpointData<M, CG, Tag>
where
    M: diffsol::Matrix<T: Scalar> + DefaultSolver,
    CG: diffsol::CodegenModule,
    DiffSl<M, CG>: OdeEquationsImplicit<V = M::V>,
    Tag: OdeSolverMethodTag<M, CG>,
{
    pub(crate) fn new(
        checkpointing: CheckpointingPath<DiffSl<M, CG>, Tag::State>,
        params: Vec<f64>,
        method: OdeSolverType,
        linear_solver: LinearSolverType,
    ) -> Self {
        Self {
            checkpointing,
            params,
            method,
            linear_solver,
        }
    }
}

impl<M, CG, Tag> AdjointCheckpoint for AdjointCheckpointData<M, CG, Tag>
where
    M: diffsol::Matrix<T: Scalar> + DefaultSolver + 'static,
    CG: diffsol::CodegenModule + 'static,
    DiffSl<M, CG>: OdeEquationsImplicit<V = M::V> + 'static,
    Tag: OdeSolverMethodTag<M, CG> + 'static,
{
    fn as_any(&self) -> &dyn Any {
        self
    }

    fn method(&self) -> OdeSolverType {
        self.method
    }

    fn linear_solver(&self) -> LinearSolverType {
        self.linear_solver
    }

    fn params(&self) -> &[f64] {
        &self.params
    }
}

/// Wrapper for an adjoint checkpoint that allows it to be shared across threads and mutated safely.    
///
/// Mutex is required because Checkpointing uses interior mutability when interpolating checkpoints
#[derive(Clone)]
pub struct AdjointCheckpointWrapper(Arc<Mutex<Box<dyn AdjointCheckpoint>>>);

impl AdjointCheckpointWrapper {
    pub(crate) fn new(checkpoint: Box<dyn AdjointCheckpoint>) -> Self {
        Self(Arc::new(Mutex::new(checkpoint)))
    }

    pub(crate) fn guard(
        &self,
    ) -> Result<MutexGuard<'_, Box<dyn AdjointCheckpoint>>, DiffsolRtError> {
        self.0.lock().map_err(|_| {
            DiffsolError::Other("Adjoint checkpoint mutex poisoned".to_string()).into()
        })
    }
}