ACGrGrPolyLinearizedInterface Class Reference

This kernel calculates the residual for grain growth for a single phase, polycrystal system using the linearized interface grain growth model. More...

#include <ACGrGrPolyLinearizedInterface.h>

Inheritance diagram for ACGrGrPolyLinearizedInterface:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	ACGrGrPolyLinearizedInterface (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	computeDFDOP (PFFunctionType type)=0
virtual Real	precomputeQpResidual ()
virtual Real	precomputeQpJacobian ()

Protected Attributes
const std::vector< MaterialPropertyName >	_other_op_names
const unsigned int	_num_ops
const MaterialProperty< Real > &	_gamma
const MaterialProperty< Real > &	_op
const MaterialProperty< Real > &	_dopdphi
std::vector< const MaterialProperty< Real > * >	_opj
std::vector< const MaterialProperty< Real > * >	_dopjdarg
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. More...
const MaterialProperty< Real > &	_dLdop
	Mobility derivative w.r.t. order parameter. More...
std::vector< const MaterialProperty< Real > *>	_dLdarg
	Mobility derivative w.r.t coupled variables. More...

Detailed Description

This kernel calculates the residual for grain growth for a single phase, polycrystal system using the linearized interface grain growth model.

Definition at line 20 of file ACGrGrPolyLinearizedInterface.h.

Member Enumeration Documentation

PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 37 of file ACBulk.h.

  {
    Jacobian,
    Residual
  };

Constructor & Destructor Documentation

ACGrGrPolyLinearizedInterface()

ACGrGrPolyLinearizedInterface::ACGrGrPolyLinearizedInterface

(

const InputParameters &

parameters

)

Definition at line 29 of file ACGrGrPolyLinearizedInterface.C.

  : ACGrGrPoly(parameters),
    _other_op_names(getParam<std::vector<MaterialPropertyName>>("other_ops")),
    _num_ops(_other_op_names.size()),
    _gamma(getMaterialProperty<Real>("gamma_asymm")),
    _op(getMaterialProperty<Real>("this_op")),
    _dopdphi(getMaterialPropertyDerivative<Real>("this_op", _var.name())),
    _opj(_num_ops),
    _dopjdarg(_num_ops)
{
  if (_num_ops != _op_num)
    mooseError(
        "In ACGrGrPolyLinearizedInterface, number of coupled variables in v must match number of "
        "coupled materials in other_ops");

  // Iterate over all coupled order parameters
  for (unsigned int i = 0; i < _op_num; ++i)
  {
    _opj[i] = &getMaterialPropertyByName<Real>(_other_op_names[i]);
    _dopjdarg[i] = &getMaterialPropertyDerivative<Real>(_other_op_names[i], i);
  }
}

Member Function Documentation

assignOtherOps()

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

protectedvirtual

Reimplemented from ACGrGrPoly.

Definition at line 59 of file ACGrGrPolyLinearizedInterface.C.

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

  return other_ops;
}

assignThisOp()

Real ACGrGrPolyLinearizedInterface::assignThisOp ( )

protectedvirtual

Reimplemented from ACGrGrPoly.

Definition at line 53 of file ACGrGrPolyLinearizedInterface.C.

{
  return _op[_qp];
}

computeDFDOP() [1/2]

Real ACGrGrPolyLinearizedInterface::computeDFDOP ( PFFunctionType  type )

protectedvirtual

Reimplemented from ACGrGrPoly.

Definition at line 69 of file ACGrGrPolyLinearizedInterface.C.

{
  switch (type)
  {
    case Residual:
      return ACGrGrPoly::computeDFDOP(type);

    case Jacobian:
      return ACGrGrPoly::computeDFDOP(type) * _dopdphi[_qp];

    default:
      mooseError("Invalid type passed in");
  }
}

computeDFDOP() [2/2]

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

protectedpure virtualinherited

computeQpOffDiagJacobian()

Real ACGrGrPolyLinearizedInterface::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Reimplemented from ACGrGrPoly.

Definition at line 85 of file ACGrGrPolyLinearizedInterface.C.

{

  for (unsigned int i = 0; i < _op_num; ++i)
    if (jvar == _vals_var[i])
      return ACGrGrPoly::computeQpOffDiagJacobian(jvar) * (*_dopjdarg[i])[_qp];

  return 0.0;
}

initialSetup()

void ACBulk< Real >::initialSetup ( )

virtualinherited

Reimplemented in KKSMultiACBulkBase, KKSACBulkBase, CoupledAllenCahn, and AllenCahn.

Definition at line 79 of file ACBulk.h.

{
  validateNonlinearCoupling<Real>("mob_name");
}

precomputeQpJacobian()

Real ACBulk< Real >::precomputeQpJacobian ( )

protectedvirtualinherited

Definition at line 97 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 86 of file ACBulk.h.

{
  // Get free energy derivative from function
  Real dFdop = computeDFDOP(Residual);

  // Set residual
  return _L[_qp] * dFdop;
}

validParams()

InputParameters ACGrGrPolyLinearizedInterface::validParams ( )

static

Definition at line 17 of file ACGrGrPolyLinearizedInterface.C.

{
  InputParameters params = ACGrGrPoly::validParams();
  params.addClassDescription(
      "Grain growth model Allen-Cahn Kernel with linearized interface variable transformation");
  params.addRequiredParam<MaterialPropertyName>(
      "this_op", "The material property defining the order parameter for this variable");
  params.addRequiredParam<std::vector<MaterialPropertyName>>(
      "other_ops", "List of properties defining the order parameters for the variables in v");
  return params;
}

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.

_dopdphi

const MaterialProperty<Real>& ACGrGrPolyLinearizedInterface::_dopdphi

protected

Definition at line 37 of file ACGrGrPolyLinearizedInterface.h.

Referenced by computeDFDOP().

_dopjdarg

std::vector<const MaterialProperty<Real> *> ACGrGrPolyLinearizedInterface::_dopjdarg

protected

Definition at line 40 of file ACGrGrPolyLinearizedInterface.h.

Referenced by ACGrGrPolyLinearizedInterface(), and computeQpOffDiagJacobian().

_gamma

const MaterialProperty<Real>& ACGrGrPolyLinearizedInterface::_gamma

protected

Definition at line 35 of file ACGrGrPolyLinearizedInterface.h.

_L

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

protectedinherited

Mobility.

Definition at line 46 of file ACBulk.h.

Referenced by ACGBPoly::computeQpOffDiagJacobian(), NestedKKSACBulkC::computeQpOffDiagJacobian(), NestedKKSACBulkF::computeQpOffDiagJacobian(), NestedKKSMultiACBulkC::computeQpOffDiagJacobian(), AllenCahn::computeQpOffDiagJacobian(), NestedKKSMultiACBulkF::computeQpOffDiagJacobian(), CoupledAllenCahn::computeQpOffDiagJacobian(), ACGrGrPoly::computeQpOffDiagJacobian(), KKSACBulkC::computeQpOffDiagJacobian(), KKSMultiACBulkC::computeQpOffDiagJacobian(), KKSMultiACBulkF::computeQpOffDiagJacobian(), and KKSACBulkF::computeQpOffDiagJacobian().

_mu

const MaterialProperty<Real>& ACGrGrBase::_mu

protectedinherited

Definition at line 34 of file ACGrGrBase.h.

Referenced by ACGrGrPoly::computeDFDOP(), and ACGrGrPoly::computeQpOffDiagJacobian().

_num_ops

const unsigned int ACGrGrPolyLinearizedInterface::_num_ops

protected

Definition at line 34 of file ACGrGrPolyLinearizedInterface.h.

Referenced by ACGrGrPolyLinearizedInterface().

_op

const MaterialProperty<Real>& ACGrGrPolyLinearizedInterface::_op

protected

Definition at line 36 of file ACGrGrPolyLinearizedInterface.h.

Referenced by assignThisOp().

_op_num

const unsigned int ACGrGrBase::_op_num

protectedinherited

Definition at line 29 of file ACGrGrBase.h.

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

_opj

std::vector<const MaterialProperty<Real> *> ACGrGrPolyLinearizedInterface::_opj

protected

Definition at line 39 of file ACGrGrPolyLinearizedInterface.h.

Referenced by ACGrGrPolyLinearizedInterface(), and assignOtherOps().

_other_op_names

const std::vector<MaterialPropertyName> ACGrGrPolyLinearizedInterface::_other_op_names

protected

Definition at line 33 of file ACGrGrPolyLinearizedInterface.h.

Referenced by ACGrGrPolyLinearizedInterface().

_vals

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

protectedinherited

Definition at line 31 of file ACGrGrBase.h.

Referenced by ACGrGrPoly::assignOtherOps().

_vals_var

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

protectedinherited

Definition at line 32 of file ACGrGrBase.h.

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

---

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

• phase_field/include/kernels/ACGrGrPolyLinearizedInterface.h
• phase_field/src/kernels/ACGrGrPolyLinearizedInterface.C