![]() |
Lethe Open-Source Library version 1.2.0
Developer Guide
|
#include <mobility_cahn_hilliard_model.h>
Public Member Functions | |
| MobilityCahnHilliardModelQuartic (const double p_mobility_cahn_hilliard_constant) | |
| ~MobilityCahnHilliardModelQuartic () override=default | |
| double | get_mobility_constant () override |
| double | value (const std::map< field, double > &fields_value) override |
| void | vector_value (const std::map< field, std::vector< double > > &field_vectors, std::vector< double > &property_vector) override |
| double | jacobian (const std::map< field, double > &fields_value, field id) override |
| void | vector_jacobian (const std::map< field, std::vector< double > > &fields_vectors, const field id, std::vector< double > &jacobian_vector) override |
| Public Member Functions inherited from MobilityCahnHilliardModel | |
| ~MobilityCahnHilliardModel () override=default | |
| Public Member Functions inherited from InterfacePropertyModel | |
| InterfacePropertyModel () | |
| virtual | ~InterfacePropertyModel ()=default |
| bool | depends_on (const field &id) |
| double | numerical_jacobian (const std::map< field, double > &field_values, const field id) |
| void | vector_numerical_jacobian (const std::map< field, std::vector< double > > &field_vectors, const field id, std::vector< double > &jacobian_vector) |
Private Attributes | |
| const double | mobility_cahn_hilliard_constant |
Additional Inherited Members | |
| Static Public Member Functions inherited from MobilityCahnHilliardModel | |
| static std::shared_ptr< MobilityCahnHilliardModel > | model_cast (const Parameters::MaterialInteractions &material_interaction_parameters) |
| Protected Attributes inherited from InterfacePropertyModel | |
| std::map< field, bool > | model_depends_on |
Quartic mobility model.
The mobility function is the following : \(M(\phi) = D(1-\phi^2)^2 \) where D is the mobility constant.
Definition at line 148 of file mobility_cahn_hilliard_model.h.
|
inline |
Default constructor.
| [in] | p_mobility_cahn_hilliard_constant | the user defined mobility constant. |
Definition at line 157 of file mobility_cahn_hilliard_model.h.
References mobility_cahn_hilliard_constant, InterfacePropertyModel::model_depends_on, and phase_order_cahn_hilliard.
|
overridedefault |
Destructor of derived class.
|
inlineoverridevirtual |
Return the mobility constant.
Implements MobilityCahnHilliardModel.
Definition at line 174 of file mobility_cahn_hilliard_model.h.
References mobility_cahn_hilliard_constant.
|
inlineoverridevirtual |
Calculate the jacobian (the partial derivative) of the mobility with respect to a field.
| [in] | fields_value | Value of the various fields on which the mobility may depend. |
| [in] | id | Indicator of the field with respect to which the Jacobian should be calculated. |
Implements InterfacePropertyModel.
Definition at line 241 of file mobility_cahn_hilliard_model.h.
References mobility_cahn_hilliard_constant, and phase_order_cahn_hilliard.
|
inlineoverridevirtual |
Calculate the mobility.
| [in] | fields_value | Value of the various fields on which the mobility may depend. |
Implements InterfacePropertyModel.
Definition at line 186 of file mobility_cahn_hilliard_model.h.
References mobility_cahn_hilliard_constant, and phase_order_cahn_hilliard.
|
inlineoverridevirtual |
Calculate the derivative of the mobility with respect to a field.
| [in] | fields_vectors | Vector for the values of the fields used to evaluate the mobility. |
| [in] | id | Identifier of the field with respect to which a derivative should be calculated. |
| [out] | jacobian_vector | Vector of the values of the derivatives of the mobility with respect to the field id. |
Implements InterfacePropertyModel.
Definition at line 270 of file mobility_cahn_hilliard_model.h.
References mobility_cahn_hilliard_constant, and phase_order_cahn_hilliard.
|
inlineoverridevirtual |
Calculate the vector of mobility.
| [in] | field_vectors | Vectors of the fields on which the mobility may depend. |
| [out] | property_vector | Vector of the mobility values. |
Implements InterfacePropertyModel.
Definition at line 210 of file mobility_cahn_hilliard_model.h.
References mobility_cahn_hilliard_constant, and phase_order_cahn_hilliard.
|
private |
Definition at line 291 of file mobility_cahn_hilliard_model.h.