https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CHSplitConcentration Class Reference

Solves Cahn-Hilliard equation using chemical potential as non-linear variable. More...

#include <CHSplitConcentration.h>

Inheritance diagram for CHSplitConcentration:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

 CHSplitConcentration (const InputParameters &parameters)
 
const GenericMaterialProperty< U, is_ad > & getDefaultMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< U, is_ad > & getDefaultMaterialPropertyByName (const std::string &name)
 
void validateDerivativeMaterialPropertyBase (const std::string &base)
 
const MaterialPropertyName derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
 
const MaterialPropertyName derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const MaterialPropertyName derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
 
const MaterialPropertyName derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
GenericMaterialProperty< U, is_ad > & declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
 
const GenericMaterialProperty< U, is_ad > & getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
 
void validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)
 
void validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
void validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)
 
void validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
void validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
void validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
 
const MaterialPropertyName propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
 
const MaterialPropertyName propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
 
const MaterialPropertyName propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const MaterialPropertyName propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const MaterialPropertyName propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
 
const MaterialPropertyName propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
 
const MaterialPropertyName propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
 
const MaterialPropertyName propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Member Functions

virtual Real computeQpResidual ()
 
virtual Real computeQpJacobian ()
 
virtual Real computeQpOffDiagJacobian (unsigned int)
 

Protected Attributes

MaterialPropertyName _mobility_name
 Mobility property name. More...
 
const MaterialProperty< RealTensorValue > & _mobility
 
const MaterialProperty< RealTensorValue > & _dmobility_dc
 
const unsigned int _mu_var
 Chemical potential variable. More...
 
const VariableGradient_grad_mu
 

Detailed Description

Solves Cahn-Hilliard equation using chemical potential as non-linear variable.

Definition at line 19 of file CHSplitConcentration.h.

Constructor & Destructor Documentation

◆ CHSplitConcentration()

CHSplitConcentration::CHSplitConcentration ( const InputParameters parameters)

Definition at line 25 of file CHSplitConcentration.C.

27  _mobility_name(getParam<MaterialPropertyName>("mobility")),
28  _mobility(getMaterialProperty<RealTensorValue>(_mobility_name)),
29  _dmobility_dc(getMaterialPropertyDerivative<RealTensorValue>(_mobility_name, name())),
30  _mu_var(coupled("chemical_potential_var")),
31  _grad_mu(coupledGradient("chemical_potential_var"))
32 {
33 }
const MaterialProperty< RealTensorValue > & _mobility
const MaterialProperty< RealTensorValue > & _dmobility_dc
const VariableGradient & _grad_mu
const std::string name
Definition: Setup.h:20
const unsigned int _mu_var
Chemical potential variable.
MaterialPropertyName _mobility_name
Mobility property name.

Member Function Documentation

◆ computeQpJacobian()

Real CHSplitConcentration::computeQpJacobian ( )
protectedvirtual

Definition at line 43 of file CHSplitConcentration.C.

44 {
45  const RealVectorValue a = _dmobility_dc[_qp] * _grad_mu[_qp];
46  return _grad_test[_i][_qp] * a * _phi[_j][_qp];
47 }
const MaterialProperty< RealTensorValue > & _dmobility_dc
const VariableGradient & _grad_mu

◆ computeQpOffDiagJacobian()

Real CHSplitConcentration::computeQpOffDiagJacobian ( unsigned int  jvar)
protectedvirtual

Definition at line 50 of file CHSplitConcentration.C.

51 {
52  if (jvar == _mu_var)
53  {
54  const RealVectorValue a = _mobility[_qp] * _grad_phi[_j][_qp];
55  return _grad_test[_i][_qp] * a;
56  }
57  else
58  return 0.0;
59 }
const MaterialProperty< RealTensorValue > & _mobility
const unsigned int _mu_var
Chemical potential variable.

◆ computeQpResidual()

Real CHSplitConcentration::computeQpResidual ( )
protectedvirtual

Definition at line 36 of file CHSplitConcentration.C.

37 {
38  const RealVectorValue a = _mobility[_qp] * _grad_mu[_qp];
39  return _grad_test[_i][_qp] * a;
40 }
const MaterialProperty< RealTensorValue > & _mobility
const VariableGradient & _grad_mu

◆ validParams()

InputParameters CHSplitConcentration::validParams ( )
static

Definition at line 15 of file CHSplitConcentration.C.

16 {
18  params.addClassDescription(
19  "Concentration kernel in Split Cahn-Hilliard that solves chemical potential in a weak form");
20  params.addRequiredParam<MaterialPropertyName>("mobility", "Mobility property name");
21  params.addRequiredCoupledVar("chemical_potential_var", "Chemical potential variable");
22  return params;
23 }
static InputParameters validParams()
void addRequiredParam(const std::string &name, const std::string &doc_string)
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _dmobility_dc

const MaterialProperty<RealTensorValue>& CHSplitConcentration::_dmobility_dc
protected

Definition at line 35 of file CHSplitConcentration.h.

Referenced by computeQpJacobian().

◆ _grad_mu

const VariableGradient& CHSplitConcentration::_grad_mu
protected

Definition at line 39 of file CHSplitConcentration.h.

Referenced by computeQpJacobian(), and computeQpResidual().

◆ _mobility

const MaterialProperty<RealTensorValue>& CHSplitConcentration::_mobility
protected

Definition at line 34 of file CHSplitConcentration.h.

Referenced by computeQpOffDiagJacobian(), and computeQpResidual().

◆ _mobility_name

MaterialPropertyName CHSplitConcentration::_mobility_name
protected

Mobility property name.

Definition at line 32 of file CHSplitConcentration.h.

◆ _mu_var

const unsigned int CHSplitConcentration::_mu_var
protected

Chemical potential variable.

Definition at line 38 of file CHSplitConcentration.h.

Referenced by computeQpOffDiagJacobian().


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