twine-solve 0.4.2

Numerical solvers for the Twine framework.
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

use twine_core::model::Snapshot;

/// Defines an equation (root-finding) problem to be solved.
pub trait EquationProblem<const N: usize> {
    type Input;
    type Output;
    type InputError: std::error::Error + Send + Sync + 'static;
    type ResidualError: std::error::Error + Send + Sync + 'static;

    /// Maps solver variables (`x`) into a model input.
    ///
    /// # Errors
    ///
    /// Returns an error if the input cannot be constructed from `x`.
    fn input(&self, x: &[f64; N]) -> Result<Self::Input, Self::InputError>;

    /// Computes residuals from model input/output.
    ///
    /// # Errors
    ///
    /// Returns an error if residuals cannot be computed.
    fn residuals(
        &self,
        input: &Self::Input,
        output: &Self::Output,
    ) -> Result<[f64; N], Self::ResidualError>;

    /// Computes residuals directly from a snapshot.
    ///
    /// # Errors
    ///
    /// Returns an error if residuals cannot be computed.
    fn residuals_from_snapshot(
        &self,
        snap: &Snapshot<Self::Input, Self::Output>,
    ) -> Result<[f64; N], Self::ResidualError> {
        self.residuals(&snap.input, &snap.output)
    }
}