https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
CHBulkPFCTrad Class Referenceabstract

#include <CHBulkPFCTrad.h>

Inheritance diagram for CHBulkPFCTrad:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

 CHBulkPFCTrad (const InputParameters &parameters)
 
virtual void initialSetup ()
 
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 Types

enum  PFFunctionType
 

Protected Member Functions

virtual RealGradient computeGradDFDCons (PFFunctionType type)
 
virtual RealGradient precomputeQpResidual ()
 
virtual RealGradient precomputeQpJacobian ()
 
virtual Real computeQpOffDiagJacobian (unsigned int jvar)
 
virtual RealGradient computeGradDFDCons (PFFunctionType type)=0
 

Protected Attributes

const MaterialProperty< Real > & _M
 Mobility.
 
const MaterialProperty< Real > & _dMdc
 Mobility derivative w.r.t. concentration.
 
std::vector< const MaterialProperty< Real > * > _dMdarg
 Mobility derivative w.r.t coupled variables.
 

Private Member Functions

bool haveMaterialProperty (const std::string &prop_name)
 
std::vector< VariableName > buildVariableVector (const VariableName &c1, const VariableName &c2, const VariableName &c3)
 
void validateCouplingHelper (const MaterialPropertyName &base, const std::vector< VariableName > &c, const System &system, std::vector< VariableName > &missing)
 
bool isNotObjectVariable (const VariableName &name)
 

Private Attributes

const MaterialProperty< Real > & _C0
 
const MaterialProperty< Real > & _a
 
const MaterialProperty< Real > & _b
 
FEProblemBase & _dmi_fe_problem
 

Detailed Description

Definition at line 14 of file CHBulkPFCTrad.h.

Member Enumeration Documentation

◆ PFFunctionType

enum CHBulk::PFFunctionType
protectedinherited

Definition at line 38 of file CHBulk.h.

39 {
40 Jacobian,
41 Residual
42 };

Constructor & Destructor Documentation

◆ CHBulkPFCTrad()

CHBulkPFCTrad::CHBulkPFCTrad ( const InputParameters &  parameters)

Definition at line 23 of file CHBulkPFCTrad.C.

24 : CHBulk<Real>(parameters),
25 _C0(getMaterialProperty<Real>("C0")),
26 _a(getMaterialProperty<Real>("a")),
27 _b(getMaterialProperty<Real>("b"))
28{
29}
CHBulkPFCTrad::_C0
const MaterialProperty< Real > & _C0
Definition CHBulkPFCTrad.h:25
CHBulkPFCTrad::_a
const MaterialProperty< Real > & _a
Definition CHBulkPFCTrad.h:26
CHBulkPFCTrad::_b
const MaterialProperty< Real > & _b
Definition CHBulkPFCTrad.h:27
CHBulk
This is the Cahn-Hilliard equation base class that implements the bulk or local energy term of the eq...
Definition CHBulk.h:26

Member Function Documentation

◆ computeGradDFDCons() [1/2]

RealGradient CHBulkPFCTrad::computeGradDFDCons ( PFFunctionType  type)
protectedvirtual

Definition at line 32 of file CHBulkPFCTrad.C.

33{
34 Real d2fdc2 = 1.0 - _C0[_qp] - _a[_qp] * _u[_qp] + _b[_qp] * _u[_qp] * _u[_qp];
35
36 switch (type)
37 {
38 case Residual:
39 return d2fdc2 * _grad_u[_qp];
40
41 case Jacobian:
42 {
43 Real d3fdc3 = -_a[_qp] + 2.0 * _b[_qp] * _u[_qp];
44 return d2fdc2 * _grad_phi[_j][_qp] + d3fdc3 * _grad_u[_qp] * _phi[_j][_qp];
45 }
46 }
47
48 mooseError("Invalid type passed in");
49}
mooseError
void mooseError(Args &&... args)
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ computeGradDFDCons() [2/2]

virtual RealGradient CHBulk< Real >::computeGradDFDCons ( PFFunctionType  type)
protectedpure virtualinherited

◆ computeQpOffDiagJacobian()

Real CHBulk< Real >::computeQpOffDiagJacobian ( unsigned int  jvar)
protectedvirtualinherited

Reimplemented in KKSCHBulk.

Definition at line 36 of file CHBulk.h.

111{
112 // get the coupled variable jvar is referring to
113 const unsigned int cvar = mapJvarToCvar(jvar);
114
115 return (*_dMdarg[cvar])[_qp] * _phi[_j][_qp] * computeGradDFDCons(Residual) * _grad_test[_i][_qp];
116}
CHBulk< Real >::_dMdarg
std::vector< const MaterialProperty< Real > * > _dMdarg
Mobility derivative w.r.t coupled variables.
Definition CHBulk.h:53
CHBulk< Real >::computeGradDFDCons
virtual RealGradient computeGradDFDCons(PFFunctionType type)=0

◆ initialSetup()

void CHBulk< Real >::initialSetup ( )
virtualinherited

Definition at line 31 of file CHBulk.h.

87{
88 validateNonlinearCoupling<Real>("mob_name");
89}

◆ precomputeQpJacobian()

RealGradient CHBulk< Real >::precomputeQpJacobian ( )
protectedvirtualinherited

Definition at line 35 of file CHBulk.h.

101{
102 RealGradient grad_value = _M[_qp] * computeGradDFDCons(Jacobian) +
103 _dMdc[_qp] * _phi[_j][_qp] * computeGradDFDCons(Residual);
104
105 return grad_value;
106}
CHBulk< Real >::_M
const MaterialProperty< Real > & _M
Mobility.
Definition CHBulk.h:47
CHBulk< Real >::_dMdc
const MaterialProperty< Real > & _dMdc
Mobility derivative w.r.t. concentration.
Definition CHBulk.h:50
libMesh::RealGradient
RealVectorValue RealGradient
Definition ElasticityTensorTools.h:18

◆ precomputeQpResidual()

RealGradient CHBulk< Real >::precomputeQpResidual ( )
protectedvirtualinherited

Definition at line 34 of file CHBulk.h.

94{
95 return _M[_qp] * computeGradDFDCons(Residual);
96}

◆ validParams()

InputParameters CHBulkPFCTrad::validParams ( )
static

Definition at line 15 of file CHBulkPFCTrad.C.

16{
17 InputParameters params = CHBulk<Real>::validParams();
18 params.addClassDescription(
19 "Cahn-Hilliard kernel for a polynomial phase field crystal free energy.");
20 return params;
21}
CHBulk::validParams
static InputParameters validParams()
Definition CHBulk.h:75
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _a

const MaterialProperty<Real>& CHBulkPFCTrad::_a
private

Definition at line 26 of file CHBulkPFCTrad.h.

Referenced by computeGradDFDCons().

◆ _b

const MaterialProperty<Real>& CHBulkPFCTrad::_b
private

Definition at line 27 of file CHBulkPFCTrad.h.

Referenced by computeGradDFDCons().

◆ _C0

const MaterialProperty<Real>& CHBulkPFCTrad::_C0
private

Definition at line 25 of file CHBulkPFCTrad.h.

Referenced by computeGradDFDCons().

◆ _dMdarg

std::vector<const MaterialProperty<Real > *> CHBulk< Real >::_dMdarg
protectedinherited

Mobility derivative w.r.t coupled variables.

Definition at line 53 of file CHBulk.h.

◆ _dMdc

const MaterialProperty<Real >& CHBulk< Real >::_dMdc
protectedinherited

Mobility derivative w.r.t. concentration.

Definition at line 50 of file CHBulk.h.

◆ _M

const MaterialProperty<Real >& CHBulk< Real >::_M
protectedinherited

Mobility.

Definition at line 47 of file CHBulk.h.

The documentation for this class was generated from the following files:
Generated on Fri Aug 21 2026 13:42:24 for https://mooseframework.inl.gov by doxygen 1.9.8