Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
MobilityCahnHilliardModel Class Referenceabstract

#include <mobility_cahn_hilliard_model.h>

Inheritance diagram for MobilityCahnHilliardModel:
[legend]

Public Member Functions

virtual double get_mobility_constant ()=0
 ~MobilityCahnHilliardModel () override=default
Public Member Functions inherited from InterfacePropertyModel
 InterfacePropertyModel ()
virtual ~InterfacePropertyModel ()=default
bool depends_on (const field &id)
virtual double value (const std::map< field, double > &fields_value)=0
virtual void vector_value (const std::map< field, std::vector< double > > &field_vectors, std::vector< double > &property_vector)=0
virtual double jacobian (const std::map< field, double > &field_values, const field id)=0
virtual void vector_jacobian (const std::map< field, std::vector< double > > &field_vectors, const field id, std::vector< double > &jacobian_vector)=0
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)

Static Public Member Functions

static std::shared_ptr< MobilityCahnHilliardModel > model_cast (const Parameters::MaterialInteractions &material_interaction_parameters)

Additional Inherited Members

Protected Attributes inherited from InterfacePropertyModel
std::map< field, bool > model_depends_on

Detailed Description

Implementation of the computation of the mobility for Cahn-Hilliard equations.

Definition at line 13 of file mobility_cahn_hilliard_model.h.

Constructor & Destructor Documentation

◆ ~MobilityCahnHilliardModel()

MobilityCahnHilliardModel::~MobilityCahnHilliardModel ( )
overridedefault

Definition of a virtual destructor for the class.

Member Function Documentation

◆ get_mobility_constant()

virtual double MobilityCahnHilliardModel::get_mobility_constant ( )
pure virtual

Pure virtual method to access the mobility constant.

Returns
Value of the mobility constant.

Implemented in MobilityCahnHilliardModelConstant, and MobilityCahnHilliardModelQuartic.

◆ model_cast()

std::shared_ptr< MobilityCahnHilliardModel > MobilityCahnHilliardModel::model_cast ( const Parameters::MaterialInteractions & material_interaction_parameters)
static

Instantiate and return a pointer to a MobilityCahnHilliardModel object by casting it to the proper child class.

Parameters
[in]material_interaction_parametersParameters for the mobility calculation.

Definition at line 7 of file mobility_cahn_hilliard_model.cc.

References Parameters::MobilityCahnHilliardParameters::mobility_cahn_hilliard_constant, Parameters::MaterialInteractions::mobility_cahn_hilliard_model, Parameters::MaterialInteractions::mobility_cahn_hilliard_parameters, and Parameters::MaterialInteractions::quartic.


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