Compute the Allen-Cahn interface term with the weak form residual \( \left( \kappa_i \nabla\eta_i, \nabla (L_i \psi) \right) \). More...

#include <ACInterface.h>

Inheritance diagram for ACInterface:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	ACInterface (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	computeQpResidual ()

virtual Real	computeQpJacobian ()

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

RealGradient	gradL ()

RealGradient	gradKappa ()

RealGradient	nablaLPsi ()
	the \( \nabla(L\psi) \) term

RealGradient	kappaNablaLPsi ()
	the \( \kappa\nabla(L\psi) \) term

Protected Attributes
const MaterialProperty< Real > &	_L
	Mobility.

const MaterialProperty< Real > &	_kappa
	Interfacial parameter.

const bool	_variable_L
	flag set if L is a function of non-linear variables in args

const MaterialProperty< Real > &	_dkappadop
	kappa derivative w.r.t. order parameter

std::vector< const MaterialProperty< Real > * >	_dkappadarg
	kappa derivative w.r.t. other coupled variables

std::vector< const VariableGradient * >	_gradarg
	Gradients for all coupled variables.


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

const MaterialProperty< Real > &	_d2Ldop2


std::vector< const MaterialProperty< Real > * >	_dLdarg
	Mobility derivative w.r.t. other coupled variables.

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

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

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

Compute the Allen-Cahn interface term with the weak form residual \( \left( \kappa_i \nabla\eta_i, \nabla (L_i \psi) \right) \).

Definition at line 20 of file ACInterface.h.

Constructor & Destructor Documentation

◆ ACInterface()

ACInterface::ACInterface ( const InputParameters & parameters )

Definition at line 29 of file ACInterface.C.

  : DerivativeMaterialInterface<JvarMapKernelInterface<Kernel>>(parameters),
    _L(getMaterialProperty<Real>("mob_name")),
    _kappa(getMaterialProperty<Real>("kappa_name")),
    _variable_L(getParam<bool>("variable_L")),
    _dLdop(getMaterialPropertyDerivative<Real>("mob_name", _var.name())),
    _d2Ldop2(getMaterialPropertyDerivative<Real>("mob_name", _var.name(), _var.name())),
    _dkappadop(getMaterialPropertyDerivative<Real>("kappa_name", _var.name())),
    _dLdarg(_n_args),
    _d2Ldargdop(_n_args),
    _d2Ldarg2(_n_args),
    _dkappadarg(_n_args),
    _gradarg(_n_args)
{
  // Get mobility and kappa derivatives and coupled variable gradients
  for (unsigned int i = 0; i < _n_args; ++i)
  {
    MooseVariable * ivar = _coupled_standard_moose_vars[i];
    const VariableName iname = ivar->name();
    if (iname == _var.name())
      paramError("coupled_variables",
                 "The kernel variable should not be specified in the coupled `coupled_variables` "
                 "parameter.");
 
    _dLdarg[i] = &getMaterialPropertyDerivative<Real>("mob_name", i);
    _dkappadarg[i] = &getMaterialPropertyDerivative<Real>("kappa_name", i);
    _d2Ldargdop[i] = &getMaterialPropertyDerivative<Real>("mob_name", iname, _var.name());
 
    _gradarg[i] = &(ivar->gradSln());
 
    _d2Ldarg2[i].resize(_n_args);
    for (unsigned int j = 0; j < _n_args; ++j)
      _d2Ldarg2[i][j] = &getMaterialPropertyDerivative<Real>("mob_name", i, j);
  }
}

Member Function Documentation

◆ computeQpJacobian()

Real ACInterface::computeQpJacobian ( )

protectedvirtual

Reimplemented in ACInterface2DMultiPhase1, ACInterface2DMultiPhase2, ACInterfaceChangedVariable, and ACInterfaceCleavageFracture.

Definition at line 106 of file ACInterface.C.

{
  // dsum is the derivative \f$ \frac\partial{\partial \eta} \left( \nabla (L\psi) \right) \f$
  RealGradient dsum =
      (_dkappadop[_qp] * _L[_qp] + _kappa[_qp] * _dLdop[_qp]) * _phi[_j][_qp] * _grad_test[_i][_qp];
 
  // compute the derivative of the gradient of the mobility
  if (_variable_L)
  {
    RealGradient dgradL =
        _grad_phi[_j][_qp] * _dLdop[_qp] + _grad_u[_qp] * _phi[_j][_qp] * _d2Ldop2[_qp];
 
    for (unsigned int i = 0; i < _n_args; ++i)
      dgradL += (*_gradarg[i])[_qp] * _phi[_j][_qp] * (*_d2Ldargdop[i])[_qp];
 
    dsum += (_kappa[_qp] * dgradL + _dkappadop[_qp] * _phi[_j][_qp] * gradL()) * _test[_i][_qp];
  }
 
  return _grad_phi[_j][_qp] * kappaNablaLPsi() + _grad_u[_qp] * dsum;
}

Referenced by ACInterfaceChangedVariable::computeQpJacobian().

◆ computeQpOffDiagJacobian()

Real ACInterface::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Reimplemented in ACInterface2DMultiPhase1, and ACInterface2DMultiPhase2.

Definition at line 128 of file ACInterface.C.

{
  // get the coupled variable jvar is referring to
  const unsigned int cvar = mapJvarToCvar(jvar);
 
  // dsum is the derivative \f$ \frac\partial{\partial \eta} \left( \nabla (L\psi) \right) \f$
  RealGradient dsum = ((*_dkappadarg[cvar])[_qp] * _L[_qp] + _kappa[_qp] * (*_dLdarg[cvar])[_qp]) *
                      _phi[_j][_qp] * _grad_test[_i][_qp];
 
  // compute the derivative of the gradient of the mobility
  if (_variable_L)
  {
    RealGradient dgradL = _grad_phi[_j][_qp] * (*_dLdarg[cvar])[_qp] +
                          _grad_u[_qp] * _phi[_j][_qp] * (*_d2Ldargdop[cvar])[_qp];
 
    for (unsigned int i = 0; i < _n_args; ++i)
      dgradL += (*_gradarg[i])[_qp] * _phi[_j][_qp] * (*_d2Ldarg2[cvar][i])[_qp];
 
    dsum += (_kappa[_qp] * dgradL + _dkappadop[_qp] * _phi[_j][_qp] * gradL()) * _test[_i][_qp];
  }
 
  return _grad_u[_qp] * dsum;
}

◆ computeQpResidual()

Real ACInterface::computeQpResidual ( )

protectedvirtual

Reimplemented in ACInterface2DMultiPhase1, ACInterfaceChangedVariable, and ACInterfaceCleavageFracture.

Definition at line 100 of file ACInterface.C.

{
  return _grad_u[_qp] * kappaNablaLPsi();
}

Referenced by ACInterfaceChangedVariable::computeQpJacobian(), and ACInterfaceChangedVariable::computeQpResidual().

◆ gradKappa()

RealGradient ACInterface::gradKappa ( )

protected

◆ gradL()

RealGradient ACInterface::gradL ( )

protected

Definition at line 73 of file ACInterface.C.

{
  RealGradient g = _grad_u[_qp] * _dLdop[_qp];
  for (unsigned int i = 0; i < _n_args; ++i)
    g += (*_gradarg[i])[_qp] * (*_dLdarg[i])[_qp];
  return g;
}

Referenced by computeQpJacobian(), ACInterfaceCleavageFracture::computeQpJacobian(), computeQpOffDiagJacobian(), and nablaLPsi().

◆ initialSetup()

void ACInterface::initialSetup ( )

virtual

Reimplemented in ACInterfaceChangedVariable.

Definition at line 66 of file ACInterface.C.

{
  validateCoupling<Real>("mob_name");
  validateCoupling<Real>("kappa_name");
}

◆ kappaNablaLPsi()

RealGradient ACInterface::kappaNablaLPsi ( )

protected

the \( \kappa\nabla(L\psi) \) term

Definition at line 94 of file ACInterface.C.

{
  return _kappa[_qp] * nablaLPsi();
}

Referenced by computeQpJacobian(), ACInterfaceCleavageFracture::computeQpJacobian(), computeQpResidual(), and ACInterfaceCleavageFracture::computeQpResidual().

◆ nablaLPsi()

RealGradient ACInterface::nablaLPsi ( )

protected

the \( \nabla(L\psi) \) term

Definition at line 82 of file ACInterface.C.

{
  // sum is the product rule gradient \f$ \nabla (L\psi) \f$
  RealGradient sum = _L[_qp] * _grad_test[_i][_qp];
 
  if (_variable_L)
    sum += gradL() * _test[_i][_qp];
 
  return sum;
}

Referenced by ACInterface2DMultiPhase1::computeQpJacobian(), ACInterface2DMultiPhase2::computeQpJacobian(), ACInterface2DMultiPhase1::computeQpOffDiagJacobian(), ACInterface2DMultiPhase2::computeQpOffDiagJacobian(), ACInterface2DMultiPhase1::computeQpResidual(), and kappaNablaLPsi().

◆ validParams()

InputParameters ACInterface::validParams ( )

static

Definition at line 15 of file ACInterface.C.

{
  InputParameters params = JvarMapKernelInterface<Kernel>::validParams();
  params.addClassDescription("Gradient energy Allen-Cahn Kernel");
  params.addParam<MaterialPropertyName>("mob_name", "L", "The mobility used with the kernel");
  params.addParam<MaterialPropertyName>("kappa_name", "kappa_op", "The kappa used with the kernel");
  params.addParam<bool>("variable_L",
                        true,
                        "The mobility is a function of any MOOSE variable (if "
                        "this is set to false L must be constant over the "
                        "entire domain!)");
  return params;
}

Referenced by ACInterface2DMultiPhase1::validParams(), ACInterface2DMultiPhase2::validParams(), ACInterfaceChangedVariable::validParams(), and ACInterfaceCleavageFracture::validParams().

Member Data Documentation

◆ _d2Ldarg2

std::vector<std::vector<const MaterialProperty<Real> *> > ACInterface::_d2Ldarg2

protected

Definition at line 61 of file ACInterface.h.

Referenced by ACInterface(), computeQpOffDiagJacobian(), ACInterface2DMultiPhase1::computeQpOffDiagJacobian(), and ACInterface2DMultiPhase2::computeQpOffDiagJacobian().

◆ _d2Ldargdop

std::vector<const MaterialProperty<Real> *> ACInterface::_d2Ldargdop

protected

Definition at line 60 of file ACInterface.h.

Referenced by ACInterface(), computeQpJacobian(), ACInterface2DMultiPhase1::computeQpJacobian(), ACInterface2DMultiPhase2::computeQpJacobian(), ACInterfaceCleavageFracture::computeQpJacobian(), computeQpOffDiagJacobian(), ACInterface2DMultiPhase1::computeQpOffDiagJacobian(), and ACInterface2DMultiPhase2::computeQpOffDiagJacobian().

◆ _d2Ldop2

const MaterialProperty<Real>& ACInterface::_d2Ldop2

protected

Definition at line 52 of file ACInterface.h.

Referenced by computeQpJacobian(), ACInterface2DMultiPhase1::computeQpJacobian(), ACInterface2DMultiPhase2::computeQpJacobian(), and ACInterfaceCleavageFracture::computeQpJacobian().

◆ _dkappadarg

std::vector<const MaterialProperty<Real> *> ACInterface::_dkappadarg

protected

kappa derivative w.r.t. other coupled variables

Definition at line 65 of file ACInterface.h.

Referenced by ACInterface(), and computeQpOffDiagJacobian().

◆ _dkappadop

const MaterialProperty<Real>& ACInterface::_dkappadop

protected

kappa derivative w.r.t. order parameter

Definition at line 56 of file ACInterface.h.

Referenced by computeQpJacobian(), ACInterfaceCleavageFracture::computeQpJacobian(), and computeQpOffDiagJacobian().

◆ _dLdarg

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

protected

Mobility derivative w.r.t. other coupled variables.

Definition at line 59 of file ACInterface.h.

Referenced by ACInterface(), computeQpOffDiagJacobian(), ACInterface2DMultiPhase1::computeQpOffDiagJacobian(), ACInterface2DMultiPhase2::computeQpOffDiagJacobian(), and gradL().

◆ _dLdop

const MaterialProperty<Real>& ACInterface::_dLdop

protected

Mobility derivatives w.r.t. order parameter.

Definition at line 51 of file ACInterface.h.

Referenced by computeQpJacobian(), ACInterface2DMultiPhase1::computeQpJacobian(), ACInterface2DMultiPhase2::computeQpJacobian(), ACInterfaceCleavageFracture::computeQpJacobian(), and gradL().

◆ _gradarg

std::vector<const VariableGradient *> ACInterface::_gradarg

protected

Gradients for all coupled variables.

Definition at line 68 of file ACInterface.h.

Referenced by ACInterface(), computeQpJacobian(), ACInterface2DMultiPhase1::computeQpJacobian(), ACInterface2DMultiPhase2::computeQpJacobian(), ACInterfaceCleavageFracture::computeQpJacobian(), computeQpOffDiagJacobian(), ACInterface2DMultiPhase1::computeQpOffDiagJacobian(), ACInterface2DMultiPhase2::computeQpOffDiagJacobian(), and gradL().

◆ _kappa

const MaterialProperty<Real>& ACInterface::_kappa

protected

Interfacial parameter.

Definition at line 45 of file ACInterface.h.

Referenced by ACInterfaceCleavageFracture::betaNablaPsi(), computeQpJacobian(), ACInterface2DMultiPhase2::computeQpJacobian(), ACInterfaceCleavageFracture::computeQpJacobian(), computeQpOffDiagJacobian(), ACInterface2DMultiPhase2::computeQpOffDiagJacobian(), and kappaNablaLPsi().

◆ _L

const MaterialProperty<Real>& ACInterface::_L

protected

Mobility.

Definition at line 43 of file ACInterface.h.

Referenced by ACInterfaceCleavageFracture::betaNablaPsi(), computeQpJacobian(), ACInterfaceCleavageFracture::computeQpJacobian(), computeQpOffDiagJacobian(), and nablaLPsi().

◆ _variable_L

const bool ACInterface::_variable_L

protected

flag set if L is a function of non-linear variables in args

Definition at line 48 of file ACInterface.h.

Referenced by computeQpJacobian(), ACInterface2DMultiPhase1::computeQpJacobian(), ACInterface2DMultiPhase2::computeQpJacobian(), ACInterfaceCleavageFracture::computeQpJacobian(), computeQpOffDiagJacobian(), ACInterface2DMultiPhase1::computeQpOffDiagJacobian(), ACInterface2DMultiPhase2::computeQpOffDiagJacobian(), and nablaLPsi().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ACInterface()

Member Function Documentation

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ gradKappa()

◆ gradL()

◆ initialSetup()

◆ kappaNablaLPsi()

◆ nablaLPsi()

◆ validParams()

Member Data Documentation

◆ _d2Ldarg2

◆ _d2Ldargdop

◆ _d2Ldop2

◆ _dkappadarg

◆ _dkappadop

◆ _dLdarg

◆ _dLdop

◆ _gradarg

◆ _kappa

◆ _L

◆ _variable_L