CoupledAllenCahn uses the Free Energy function and derivatives provided by a DerivativeParsedMaterial to compute the residual for the bulk part of the Allen-Cahn equation, where the variational free energy derivative is taken w.r.t. More...

#include <CoupledAllenCahn.h>

Inheritance diagram for CoupledAllenCahn:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	CoupledAllenCahn (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 Real	computeDFDOP (PFFunctionType type)

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

virtual Real	precomputeQpResidual ()

virtual Real	precomputeQpJacobian ()

virtual Real	computeDFDOP (PFFunctionType type)=0

Protected Attributes
VariableName	_v_name

const MaterialProperty< Real > &	_dFdV

const MaterialProperty< Real > &	_d2FdVdEta

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

const MaterialProperty< Real > &	_L
	Mobility.

const MaterialProperty< Real > &	_dLdop
	Mobility derivative w.r.t. order parameter.

std::vector< const MaterialProperty< Real > * >	_dLdarg
	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
FEProblemBase &	_dmi_fe_problem

Detailed Description

CoupledAllenCahn uses the Free Energy function and derivatives provided by a DerivativeParsedMaterial to compute the residual for the bulk part of the Allen-Cahn equation, where the variational free energy derivative is taken w.r.t.

a coupled variable.

Definition at line 20 of file CoupledAllenCahn.h.

Member Enumeration Documentation

◆ PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 37 of file ACBulk.h.

  {
    Jacobian,
    Residual
  };

Constructor & Destructor Documentation

◆ CoupledAllenCahn()

CoupledAllenCahn::CoupledAllenCahn ( const InputParameters & parameters )

Definition at line 26 of file CoupledAllenCahn.C.

  : ACBulk<Real>(parameters),
    _v_name(coupledName("v", 0)),
    _dFdV(getMaterialPropertyDerivative<Real>("f_name", _v_name)),
    _d2FdVdEta(getMaterialPropertyDerivative<Real>("f_name", _v_name, _var.name())),
    _d2FdVdarg(_n_args)
{
  // Iterate over all coupled variables
  for (unsigned int i = 0; i < _n_args; ++i)
    _d2FdVdarg[i] = &getMaterialPropertyDerivative<Real>("f_name", _v_name, i);
}

Member Function Documentation

◆ computeDFDOP() [1/2]

Real CoupledAllenCahn::computeDFDOP ( PFFunctionType type )

protectedvirtual

Definition at line 46 of file CoupledAllenCahn.C.

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

◆ computeDFDOP() [2/2]

virtual Real ACBulk< Real >::computeDFDOP ( PFFunctionType type )

protectedpure virtualinherited

◆ computeQpOffDiagJacobian()

Real CoupledAllenCahn::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Reimplemented from ACBulk< Real >.

Definition at line 61 of file CoupledAllenCahn.C.

{
  // get the coupled variable jvar is referring to
  const unsigned int cvar = mapJvarToCvar(jvar);
 
  return ACBulk<Real>::computeQpOffDiagJacobian(jvar) +
         _L[_qp] * (*_d2FdVdarg[cvar])[_qp] * _phi[_j][_qp] * _test[_i][_qp];
}

◆ initialSetup()

void CoupledAllenCahn::initialSetup ( )

virtual

Reimplemented from ACBulk< Real >.

Definition at line 39 of file CoupledAllenCahn.C.

{
  ACBulk<Real>::initialSetup();
  validateNonlinearCoupling<Real>("f_name");
}

◆ precomputeQpJacobian()

Real ACBulk< Real >::precomputeQpJacobian ( )

protectedvirtualinherited

Definition at line 34 of file ACBulk.h.

{
  // Get free energy derivative and Jacobian
  Real dFdop = computeDFDOP(Residual);
 
  Real JdFdop = computeDFDOP(Jacobian);
 
  // Set Jacobian value using product rule
  return _L[_qp] * JdFdop + _dLdop[_qp] * _phi[_j][_qp] * dFdop;
}

◆ precomputeQpResidual()

Real ACBulk< Real >::precomputeQpResidual ( )

protectedvirtualinherited

Definition at line 33 of file ACBulk.h.

{
  // Get free energy derivative from function
  Real dFdop = computeDFDOP(Residual);
 
  // Set residual
  return _L[_qp] * dFdop;
}

◆ validParams()

InputParameters CoupledAllenCahn::validParams ( )

static

Definition at line 15 of file CoupledAllenCahn.C.

{
  InputParameters params = ACBulk<Real>::validParams();
  params.addClassDescription(
      "Coupled Allen-Cahn Kernel that uses a DerivativeMaterial Free Energy");
  params.addRequiredCoupledVar("v", "Coupled variable");
  params.addRequiredParam<MaterialPropertyName>(
      "f_name", "Base name of the free energy function F defined in a DerivativeParsedMaterial");
  return params;
}

Member Data Documentation

◆ _d2FdVdarg

std::vector<const MaterialProperty<Real> *> CoupledAllenCahn::_d2FdVdarg

protected

Definition at line 39 of file CoupledAllenCahn.h.

Referenced by computeQpOffDiagJacobian(), and CoupledAllenCahn().

◆ _d2FdVdEta

const MaterialProperty<Real>& CoupledAllenCahn::_d2FdVdEta

protected

Definition at line 37 of file CoupledAllenCahn.h.

Referenced by computeDFDOP().

◆ _dFdV

const MaterialProperty<Real>& CoupledAllenCahn::_dFdV

protected

Definition at line 36 of file CoupledAllenCahn.h.

Referenced by computeDFDOP().

◆ _dLdarg

std::vector<const MaterialProperty<Real > *> ACBulk< Real >::_dLdarg

protectedinherited

Mobility derivative w.r.t coupled variables.

Definition at line 52 of file ACBulk.h.

◆ _dLdop

const MaterialProperty<Real >& ACBulk< Real >::_dLdop

protectedinherited

Mobility derivative w.r.t. order parameter.

Definition at line 49 of file ACBulk.h.

◆ _L

const MaterialProperty<Real >& ACBulk< Real >::_L

protectedinherited

Mobility.

Definition at line 46 of file ACBulk.h.

◆ _v_name

VariableName CoupledAllenCahn::_v_name

protected

Definition at line 34 of file CoupledAllenCahn.h.

Referenced by CoupledAllenCahn().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ PFFunctionType

Constructor & Destructor Documentation

◆ CoupledAllenCahn()

Member Function Documentation

◆ computeDFDOP() [1/2]

◆ computeDFDOP() [2/2]

◆ computeQpOffDiagJacobian()

◆ initialSetup()

◆ precomputeQpJacobian()

◆ precomputeQpResidual()

◆ validParams()

Member Data Documentation

◆ _d2FdVdarg

◆ _d2FdVdEta

◆ _dFdV

◆ _dLdarg

◆ _dLdop

◆ _L

◆ _v_name