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
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

//! Hyperelastic solid constitutive models.
//!
//! ---
//!
#![doc = include_str!("doc.md")]

#[cfg(feature = "doc")]
pub mod doc;

#[cfg(test)]
pub mod test;

pub mod internal_variables;

mod arruda_boyce;
mod blatz_ko;
mod carroll;
mod eight_chain;
mod fung;
mod gent;
mod hencky;
mod isihara;
mod mooney_rivlin;
mod neo_hookean;
mod ogden;
mod saint_venant_kirchhoff;
mod yeoh;

pub use self::{
    arruda_boyce::ArrudaBoyce, blatz_ko::BlatzKo, carroll::Carroll, eight_chain::EightChain,
    fung::Fung, gent::Gent, hencky::Hencky, isihara::Isihara, mooney_rivlin::MooneyRivlin,
    neo_hookean::NeoHookean, ogden::Ogden, saint_venant_kirchhoff::SaintVenantKirchhoff,
    yeoh::Yeoh,
};
use super::{
    elastic::{AppliedLoad, Elastic, bcs},
    *,
};
use crate::{
    math::{
        Quantity,
        optimize::{EqualityConstraint, FirstOrderOptimization, SecondOrderOptimization},
    },
    units::EnergyDensity,
};

/// Required methods for hyperelastic solid constitutive models.
pub trait Hyperelastic
where
    Self: Elastic,
{
    /// Calculates and returns the Helmholtz free energy density.
    ///
    /// ```math
    /// a = a(\mathbf{F})
    /// ```
    fn helmholtz_free_energy_density(
        &self,
        deformation_gradient: &DeformationGradient,
    ) -> Result<Quantity<EnergyDensity>, ConstitutiveError>;
}

/// First-order minimization methods for elastic solid constitutive models.
pub trait FirstOrderMinimize {
    /// Solve for the unknown components of the deformation gradient under an applied load.
    ///
    /// ```math
    /// \Pi(\mathbf{F},\boldsymbol{\lambda}) = a(\mathbf{F}) - \boldsymbol{\lambda}:(\mathbf{F} - \mathbf{F}_0) - \mathbf{P}_0:\mathbf{F}
    /// ```
    fn minimize(
        &self,
        applied_load: AppliedLoad,
        solver: impl FirstOrderOptimization<
            Quantity<EnergyDensity>,
            FirstPiolaKirchhoffStress,
            DeformationGradient,
        >,
    ) -> Result<DeformationGradient, ConstitutiveError>;
}

/// Second-order minimization methods for elastic solid constitutive models.
pub trait SecondOrderMinimize {
    /// Solve for the unknown components of the deformation gradient under an applied load.
    ///
    /// ```math
    /// \Pi(\mathbf{F},\boldsymbol{\lambda}) = a(\mathbf{F}) - \boldsymbol{\lambda}:(\mathbf{F} - \mathbf{F}_0) - \mathbf{P}_0:\mathbf{F}
    /// ```
    fn minimize(
        &self,
        applied_load: AppliedLoad,
        solver: impl SecondOrderOptimization<
            Quantity<EnergyDensity>,
            FirstPiolaKirchhoffStress,
            FirstPiolaKirchhoffTangentStiffness,
            DeformationGradient,
        >,
    ) -> Result<DeformationGradient, ConstitutiveError>;
}

impl<T> FirstOrderMinimize for T
where
    T: Hyperelastic,
{
    fn minimize(
        &self,
        applied_load: AppliedLoad,
        solver: impl FirstOrderOptimization<
            Quantity<EnergyDensity>,
            FirstPiolaKirchhoffStress,
            DeformationGradient,
        >,
    ) -> Result<DeformationGradient, ConstitutiveError> {
        let (matrix, vector) = bcs(applied_load);
        solver
            .minimize(
                |deformation_gradient: &DeformationGradient| {
                    Ok(self.helmholtz_free_energy_density(deformation_gradient)?)
                },
                |deformation_gradient: &DeformationGradient| {
                    Ok(self.first_piola_kirchhoff_stress(deformation_gradient)?)
                },
                DeformationGradient::identity(),
                EqualityConstraint::Linear(matrix, vector),
            )
            .map_err(|error| ConstitutiveError::upstream(error, self))
    }
}

impl<T> SecondOrderMinimize for T
where
    T: Hyperelastic,
{
    fn minimize(
        &self,
        applied_load: AppliedLoad,
        solver: impl SecondOrderOptimization<
            Quantity<EnergyDensity>,
            FirstPiolaKirchhoffStress,
            FirstPiolaKirchhoffTangentStiffness,
            DeformationGradient,
        >,
    ) -> Result<DeformationGradient, ConstitutiveError> {
        let (matrix, vector) = bcs(applied_load);
        solver
            .minimize(
                |deformation_gradient: &DeformationGradient| {
                    Ok(self.helmholtz_free_energy_density(deformation_gradient)?)
                },
                |deformation_gradient: &DeformationGradient| {
                    Ok(self.first_piola_kirchhoff_stress(deformation_gradient)?)
                },
                |deformation_gradient: &DeformationGradient| {
                    Ok(self.first_piola_kirchhoff_tangent_stiffness(deformation_gradient)?)
                },
                DeformationGradient::identity(),
                EqualityConstraint::Linear(matrix, vector),
                None,
            )
            .map_err(|error| ConstitutiveError::upstream(error, self))
    }
}