conspire 0.7.7

The Rust interface to conspire.
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

//! Constitutive models.

#[cfg(test)]
pub mod test;

pub mod cohesive;
pub mod fluid;
pub mod hybrid;
pub mod multiphysics;
pub mod solid;
pub mod thermal;

use crate::math::{Scalar, Style, StyledError, assert::AssertionError, styled_error};
use std::fmt::{Debug, Display};

/// Required methods for constitutive models.
pub trait Constitutive
where
    Self: Clone + Debug,
{
}

/// Possible errors encountered in constitutive models.
#[derive(PartialEq)]
pub enum ConstitutiveError {
    Custom(String, String),
    InvalidJacobian(Scalar, String),
    Upstream(String, String),
}

impl ConstitutiveError {
    pub fn custom(message: impl Display, context: &(impl Debug + ?Sized)) -> Self {
        Self::Custom(format!("{message}"), format!("{context:?}"))
    }
    pub fn invalid_jacobian(jacobian: Scalar, context: &(impl Debug + ?Sized)) -> Self {
        Self::InvalidJacobian(jacobian, format!("{context:?}"))
    }
    pub fn upstream(error: impl Display, context: &(impl Debug + ?Sized)) -> Self {
        Self::Upstream(format!("{error}"), format!("{context:?}"))
    }
}

impl From<ConstitutiveError> for AssertionError {
    fn from(error: ConstitutiveError) -> Self {
        Self {
            message: error.to_string(),
        }
    }
}

impl From<ConstitutiveError> for String {
    fn from(error: ConstitutiveError) -> Self {
        error.message(&Style::detect())
    }
}

impl StyledError for ConstitutiveError {
    fn message(&self, style: &Style) -> String {
        let (h, c) = (style.headline, style.frame);
        match self {
            Self::Custom(message, constitutive_model) => format!(
                "{h}{message}{c}\n\
                In constitutive model: {constitutive_model}."
            ),
            Self::InvalidJacobian(jacobian, constitutive_model) => format!(
                "{h}Invalid Jacobian: {jacobian:.6e}.{c}\n\
                In constitutive model: {constitutive_model}."
            ),
            Self::Upstream(error, constitutive_model) => format!(
                "{error}{c}\n\
                In constitutive model: {constitutive_model}."
            ),
        }
    }
}

styled_error!(ConstitutiveError);