Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
MobilityCahnHilliardModelConstant Class Reference

#include <mobility_cahn_hilliard_model.h>

Inheritance diagram for MobilityCahnHilliardModelConstant:
[legend]

Public Member Functions

 MobilityCahnHilliardModelConstant (const double p_mobility_cahn_hilliard_constant)
 ~MobilityCahnHilliardModelConstant () 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 > &field_values, field id) override
void vector_jacobian (const std::map< field, std::vector< double > > &field_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

Detailed Description

Constant mobility model.

The mobility function is the following : \(M(\phi) = D \) where D is the mobility constant.

Definition at line 46 of file mobility_cahn_hilliard_model.h.

Constructor & Destructor Documentation

◆ MobilityCahnHilliardModelConstant()

MobilityCahnHilliardModelConstant::MobilityCahnHilliardModelConstant ( const double p_mobility_cahn_hilliard_constant)
inline

Default constructor.

Parameters
[in]p_mobility_cahn_hilliard_constantthe user defined mobility constant.

Definition at line 55 of file mobility_cahn_hilliard_model.h.

References mobility_cahn_hilliard_constant.

◆ ~MobilityCahnHilliardModelConstant()

MobilityCahnHilliardModelConstant::~MobilityCahnHilliardModelConstant ( )
overridedefault

Destructor of derived class.

Member Function Documentation

◆ get_mobility_constant()

double MobilityCahnHilliardModelConstant::get_mobility_constant ( )
inlineoverridevirtual

Return the mobility constant, though it returns the same value as the value method, it is implemented here for generality.

Returns
Value of the mobility constant.

Implements MobilityCahnHilliardModel.

Definition at line 72 of file mobility_cahn_hilliard_model.h.

References mobility_cahn_hilliard_constant.

◆ jacobian()

double MobilityCahnHilliardModelConstant::jacobian ( const std::map< field, double > & field_values,
field id )
inlineoverridevirtual

Calculate the jacobian (the partial derivative) of the mobility with respect to a field.

Parameters
[in]field_valuesValue of the various fields on which the mobility may depend.
[in]idIndicator of the field with respect to which the jacobian should be calculated.
Returns
Value of the partial derivative of the mobility with respect to the field.

Implements InterfacePropertyModel.

Definition at line 114 of file mobility_cahn_hilliard_model.h.

◆ value()

double MobilityCahnHilliardModelConstant::value ( const std::map< field, double > & fields_value)
inlineoverridevirtual

Compute the mobility.

Parameters
[in]fields_valueValue of the various field on which the mobility may depend.
Returns
Value of the mobility.

Implements InterfacePropertyModel.

Definition at line 84 of file mobility_cahn_hilliard_model.h.

References mobility_cahn_hilliard_constant.

◆ vector_jacobian()

void MobilityCahnHilliardModelConstant::vector_jacobian ( const std::map< field, std::vector< double > > & field_vectors,
const field id,
std::vector< double > & jacobian_vector )
inlineoverridevirtual

Calculate the derivative of the mobility with respect to a field.

Parameters
[in]field_vectorsVector for the values of the fields used to evaluate the mobility.
[in]idIdentifier of the field with respect to which a derivative should be calculated.
[out]jacobian_vectorVector of the value of the derivative of the mobility with respect to the field id.

Implements InterfacePropertyModel.

Definition at line 130 of file mobility_cahn_hilliard_model.h.

◆ vector_value()

void MobilityCahnHilliardModelConstant::vector_value ( const std::map< field, std::vector< double > > & field_vectors,
std::vector< double > & property_vector )
inlineoverridevirtual

Calculate the vector of mobility_cahn_hilliard.

Parameters
[in]field_vectorsVectors of the fields on which the mobility may depend.
[out]property_vectorVectors of the mobility values

Implements InterfacePropertyModel.

Definition at line 96 of file mobility_cahn_hilliard_model.h.

References mobility_cahn_hilliard_constant.

Member Data Documentation

◆ mobility_cahn_hilliard_constant

const double MobilityCahnHilliardModelConstant::mobility_cahn_hilliard_constant
private

Definition at line 139 of file mobility_cahn_hilliard_model.h.


The documentation for this class was generated from the following file: