CHParsed uses the Free Energy function and derivatives provided by a DerivativeParsedMaterial. More...

#include <SplitCHParsed.h>

Inheritance diagram for SplitCHParsed:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	SplitCHParsed (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 Member Functions
virtual Real	computeDFDC (PFFunctionType type)

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

Private Attributes
const MaterialProperty< Real > &	_dFdc

const MaterialProperty< Real > &	_d2Fdc2

std::vector< const MaterialProperty< Real > * >	_d2Fdcdarg

Detailed Description

CHParsed uses the Free Energy function and derivatives provided by a DerivativeParsedMaterial.

This is the split operator variant.

See also: CHParsed

Definition at line 24 of file SplitCHParsed.h.

Constructor & Destructor Documentation

◆ SplitCHParsed()

SplitCHParsed::SplitCHParsed ( const InputParameters & parameters )

Definition at line 28 of file SplitCHParsed.C.

   : DerivativeMaterialInterface<JvarMapKernelInterface<SplitCHCRes>>(parameters),
     _dFdc(getMaterialPropertyDerivative<Real>("f_name", _var.name())),
     _d2Fdc2(getMaterialPropertyDerivative<Real>("f_name", _var.name(), _var.name())),
     _d2Fdcdarg(_n_args)
 {
   // Iterate over all coupled variables
   for (unsigned int i = 0; i < _n_args; ++i)
     _d2Fdcdarg[i] = &getMaterialPropertyDerivative<Real>("f_name", _var.name(), i);
 }

Member Function Documentation

◆ computeDFDC()

Real SplitCHParsed::computeDFDC ( PFFunctionType type )

protectedvirtual

Definition at line 52 of file SplitCHParsed.C.

 {
   switch (type)
   {
     case Residual:
       return _dFdc[_qp];
 
     case Jacobian:
       return _d2Fdc2[_qp] * _phi[_j][_qp];
   }
 
   mooseError("Internal error");
 }

◆ computeQpOffDiagJacobian()

Real SplitCHParsed::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Definition at line 67 of file SplitCHParsed.C.

 {
   if (jvar == _w_var)
     return SplitCHCRes::computeQpOffDiagJacobian(jvar);
 
   // get the coupled variable jvar is referring to
   const unsigned int cvar = mapJvarToCvar(jvar);
 
   return (*_d2Fdcdarg[cvar])[_qp] * _phi[_j][_qp] * _test[_i][_qp];
 }

◆ initialSetup()

void SplitCHParsed::initialSetup ( )

virtual

We are only interested if the necessary non-linear variables are coupled, as those are thge ones used in constructing the Jacobian. The AuxVariables do not have Jacobian entries.

Definition at line 40 of file SplitCHParsed.C.

 {
   validateNonlinearCoupling<Real>("f_name", _var.name());
   validateDerivativeMaterialPropertyBase<Real>("f_name");
 }

◆ validParams()

InputParameters SplitCHParsed::validParams ( )

static

Definition at line 15 of file SplitCHParsed.C.

 {
   InputParameters params = SplitCHCRes::validParams();
   params.addClassDescription(
       "Split formulation Cahn-Hilliard Kernel that uses a DerivativeMaterial Free Energy");
   params.addRequiredParam<MaterialPropertyName>(
       "f_name", "Base name of the free energy function F defined in a DerivativeParsedMaterial");
   params.addCoupledVar("args", "Vector of additional variable arguments to F");
   params.deprecateCoupledVar("args", "coupled_variables", "02/27/2024");
 
   return params;
 }

Member Data Documentation

◆ _d2Fdc2

const MaterialProperty<Real>& SplitCHParsed::_d2Fdc2

private

Definition at line 39 of file SplitCHParsed.h.

Referenced by computeDFDC().

◆ _d2Fdcdarg

std::vector<const MaterialProperty<Real> *> SplitCHParsed::_d2Fdcdarg

private

Definition at line 40 of file SplitCHParsed.h.

Referenced by computeQpOffDiagJacobian(), and SplitCHParsed().

◆ _dFdc

const MaterialProperty<Real>& SplitCHParsed::_dFdc

private

Definition at line 38 of file SplitCHParsed.h.

Referenced by computeDFDC().

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

phase_field/include/kernels/SplitCHParsed.h
phase_field/src/kernels/SplitCHParsed.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SplitCHParsed()

Member Function Documentation

◆ computeDFDC()

◆ computeQpOffDiagJacobian()

◆ initialSetup()

◆ validParams()

Member Data Documentation

◆ _d2Fdc2

◆ _d2Fdcdarg

◆ _dFdc