This kernel calculates the residual for grain growth for a single phase, poly-crystal system. More...

#include <ACGrGrPoly.h>

Inheritance diagram for ACGrGrPoly:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	ACGrGrPoly (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	assignThisOp ()

virtual std::vector< Real >	assignOtherOps ()

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 MaterialProperty< Real > &	_gamma

const unsigned int	_op_num

const std::vector< const VariableValue * >	_vals

const std::vector< unsigned int >	_vals_var

const MaterialProperty< Real > &	_mu

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

This kernel calculates the residual for grain growth for a single phase, poly-crystal system.

A single material property gamma_asymm is used for the prefactor of the cross-terms between order parameters.

Definition at line 21 of file ACGrGrPoly.h.

Member Enumeration Documentation

◆ PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 37 of file ACBulk.h.

  {
    Jacobian,
    Residual
  };

Constructor & Destructor Documentation

◆ ACGrGrPoly()

ACGrGrPoly::ACGrGrPoly ( const InputParameters & parameters )

Definition at line 22 of file ACGrGrPoly.C.

  : ACGrGrBase(parameters), _gamma(getMaterialProperty<Real>("gamma_asymm"))
{
}

Member Function Documentation

◆ assignOtherOps()

std::vector< Real > ACGrGrPoly::assignOtherOps ( )

protectedvirtual

Reimplemented in ACGrGrPolyLinearizedInterface.

Definition at line 34 of file ACGrGrPoly.C.

{
  std::vector<Real> other_ops(_op_num);
  for (unsigned int i = 0; i < _op_num; ++i)
    other_ops[i] = (*_vals[i])[_qp];
 
  return other_ops;
}

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

◆ assignThisOp()

Real ACGrGrPoly::assignThisOp ( )

protectedvirtual

Reimplemented in ACGrGrPolyLinearizedInterface.

Definition at line 28 of file ACGrGrPoly.C.

{
  return _u[_qp];
}

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

◆ computeDFDOP() [1/2]

Real ACGrGrPoly::computeDFDOP ( PFFunctionType type )

protectedvirtual

Reimplemented in ACGrGrPolyLinearizedInterface.

Definition at line 44 of file ACGrGrPoly.C.

{
  // assign op and other_ops
  Real op = assignThisOp();
  std::vector<Real> other_ops(_op_num);
  other_ops = assignOtherOps();
 
  // Sum all other order parameters
  Real SumOPj = 0.0;
  for (unsigned int i = 0; i < _op_num; ++i)
    SumOPj += other_ops[i] * other_ops[i];
 
  // Calculate either the residual or Jacobian of the grain growth free energy
  switch (type)
  {
    case Residual:
    {
      return _mu[_qp] * (op * op * op - op + 2.0 * _gamma[_qp] * op * SumOPj);
    }
 
    case Jacobian:
    {
      return _mu[_qp] * (_phi[_j][_qp] * (3.0 * op * op - 1.0 + 2.0 * _gamma[_qp] * SumOPj));
    }
 
    default:
      mooseError("Invalid type passed in");
  }
}

Referenced by ACGrGrPolyLinearizedInterface::computeDFDOP().

◆ computeDFDOP() [2/2]

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

protectedpure virtualinherited

◆ computeQpOffDiagJacobian()

Real ACGrGrPoly::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Reimplemented from ACBulk< Real >.

Reimplemented in ACGrGrPolyLinearizedInterface.

Definition at line 75 of file ACGrGrPoly.C.

{
  // assign op and other_ops
  Real op = assignThisOp();
  std::vector<Real> other_ops(_op_num);
  other_ops = assignOtherOps();
 
  for (unsigned int i = 0; i < _op_num; ++i)
    if (jvar == _vals_var[i])
    {
      // Derivative of Sumopj
      const Real dSumOPj = 2.0 * other_ops[i] * _phi[_j][_qp];
      const Real dDFDOP = _mu[_qp] * 2.0 * _gamma[_qp] * op * dSumOPj;
 
      return _L[_qp] * _test[_i][_qp] * dDFDOP;
    }
 
  return 0.0;
}

Referenced by ACGrGrPolyLinearizedInterface::computeQpOffDiagJacobian().

◆ 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 ACGrGrPoly::validParams ( )

static

Definition at line 15 of file ACGrGrPoly.C.

{
  InputParameters params = ACGrGrBase::validParams();
  params.addClassDescription("Grain-Boundary model poly-crystalline interface Allen-Cahn Kernel");
  return params;
}

Referenced by ACGrGrPolyLinearizedInterface::validParams().

Member Data Documentation

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

◆ _gamma

const MaterialProperty<Real>& ACGrGrPoly::_gamma

protected

Definition at line 34 of file ACGrGrPoly.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>& ACGrGrBase::_mu

protectedinherited

Definition at line 34 of file ACGrGrBase.h.

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

◆ _op_num

const unsigned int ACGrGrBase::_op_num

protectedinherited

Definition at line 29 of file ACGrGrBase.h.

Referenced by ACGrGrPolyLinearizedInterface::ACGrGrPolyLinearizedInterface(), assignOtherOps(), ACGrGrPolyLinearizedInterface::assignOtherOps(), computeDFDOP(), computeQpOffDiagJacobian(), and ACGrGrPolyLinearizedInterface::computeQpOffDiagJacobian().

◆ _vals

const std::vector<const VariableValue *> ACGrGrBase::_vals

protectedinherited

Definition at line 31 of file ACGrGrBase.h.

Referenced by assignOtherOps().

◆ _vals_var

const std::vector<unsigned int> ACGrGrBase::_vals_var

protectedinherited

Definition at line 32 of file ACGrGrBase.h.

Referenced by computeQpOffDiagJacobian(), and ACGrGrPolyLinearizedInterface::computeQpOffDiagJacobian().

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

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

◆ ACGrGrPoly()

Member Function Documentation

◆ assignOtherOps()

◆ assignThisOp()

◆ computeDFDOP() [1/2]

◆ computeDFDOP() [2/2]

◆ computeQpOffDiagJacobian()

◆ initialSetup()

◆ precomputeQpJacobian()

◆ precomputeQpResidual()

◆ validParams()

Member Data Documentation

◆ _dLdarg

◆ _dLdop

◆ _gamma

◆ _L

◆ _mu

◆ _op_num

◆ _vals

◆ _vals_var