#include <ACGBPoly.h>

Inheritance diagram for ACGBPoly:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	ACGBPoly (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
const VariableValue &	_c

unsigned int	_c_var

const MaterialProperty< Real > &	_mu

const MaterialProperty< Real > &	_gamma

Real	_en_ratio

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

Definition at line 16 of file ACGBPoly.h.

Member Enumeration Documentation

◆ PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 37 of file ACBulk.h.

  {
    Jacobian,
    Residual
  };

Constructor & Destructor Documentation

◆ ACGBPoly()

ACGBPoly::ACGBPoly ( const InputParameters & parameters )

Definition at line 25 of file ACGBPoly.C.

  : ACBulk<Real>(parameters),
    _c(coupledValue("c")),
    _c_var(coupled("c")),
    _mu(getMaterialProperty<Real>("mu")),
    _gamma(getMaterialProperty<Real>("gamma_asymm")),
    _en_ratio(getParam<Real>("en_ratio"))
{
}

Member Function Documentation

◆ computeDFDOP() [1/2]

Real ACGBPoly::computeDFDOP ( PFFunctionType type )

protectedvirtual

Definition at line 36 of file ACGBPoly.C.

{
  Real mult = 2.0 * _en_ratio * _mu[_qp] * _gamma[_qp];
 
  Real c = _c[_qp];
  if (c < 1.0e-8)
    c = 0.0;
  if (c > 1.0)
    c = 1.0;
 
  switch (type)
  {
    case Residual:
      return mult * _u[_qp] * c * c;
 
    case Jacobian:
      return mult * _phi[_j][_qp] * c * c;
  }
 
  mooseError("Invalid type passed in");
}

◆ computeDFDOP() [2/2]

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

protectedpure virtualinherited

◆ computeQpOffDiagJacobian()

Real ACGBPoly::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Reimplemented from ACBulk< Real >.

Definition at line 59 of file ACGBPoly.C.

{
  Real c = _c[_qp];
  if (c < 1.0e-8)
    c = 0.0;
  if (c > 1.0)
    c = 1.0;
 
  if (jvar == _c_var)
  {
    Real mult = 2.0 * _en_ratio * _mu[_qp] * _gamma[_qp];
    Real dDFDOP = 2.0 * mult * _u[_qp] * c * _phi[_j][_qp];
 
    return _L[_qp] * _test[_i][_qp] * dDFDOP;
  }
 
  return 0.0;
}

◆ initialSetup()

void ACBulk< Real >::initialSetup ( )

virtualinherited

Reimplemented in AllenCahn, CoupledAllenCahn, KKSACBulkBase, and KKSMultiACBulkBase.

Definition at line 30 of file ACBulk.h.

{
  validateNonlinearCoupling<Real>("mob_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 ACGBPoly::validParams ( )

static

Definition at line 16 of file ACGBPoly.C.

{
  InputParameters params = ACBulk<Real>::validParams();
  params.addClassDescription("Grain-Boundary model concentration dependent residual");
  params.addRequiredCoupledVar("c", "Other species concentration");
  params.addParam<Real>("en_ratio", 1.0, "Ratio of surface energy to GB energy");
  return params;
}

Member Data Documentation

◆ _c

const VariableValue& ACGBPoly::_c

protected

Definition at line 27 of file ACGBPoly.h.

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

◆ _c_var

unsigned int ACGBPoly::_c_var

protected

Definition at line 28 of file ACGBPoly.h.

Referenced by computeQpOffDiagJacobian().

◆ _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.

◆ _en_ratio

Real ACGBPoly::_en_ratio

protected

Definition at line 33 of file ACGBPoly.h.

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

◆ _gamma

const MaterialProperty<Real>& ACGBPoly::_gamma

protected

Definition at line 31 of file ACGBPoly.h.

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

◆ _L

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

protectedinherited

Mobility.

Definition at line 46 of file ACBulk.h.

◆ _mu

const MaterialProperty<Real>& ACGBPoly::_mu

protected

Definition at line 30 of file ACGBPoly.h.

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

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

phase_field/include/kernels/ACGBPoly.h
phase_field/src/kernels/ACGBPoly.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

◆ ACGBPoly()

Member Function Documentation

◆ computeDFDOP() [1/2]

◆ computeDFDOP() [2/2]

◆ computeQpOffDiagJacobian()

◆ initialSetup()

◆ precomputeQpJacobian()

◆ precomputeQpResidual()

◆ validParams()

Member Data Documentation

◆ _c

◆ _c_var

◆ _dLdarg

◆ _dLdop

◆ _en_ratio

◆ _gamma

◆ _L

◆ _mu