ACInterface Class Reference

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:

Public Member Functions
	ACInterface (const InputParameters &parameters)
virtual void	initialSetup ()

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 More...
RealGradient	kappaNablaLPsi ()
	the \( \kappa\nabla(L\psi) \) term More...

Protected Attributes
const MaterialProperty< Real > &	_L
	Mobility. More...
const MaterialProperty< Real > &	_kappa
	Interfacial parameter. More...
const bool	_variable_L
	flag set if L is a function of non-linear variables in args More...
const MaterialProperty< Real > &	_dkappadop
	kappa derivative w.r.t. order parameter More...
const unsigned int	_nvar
	number of coupled variables More...
std::vector< const MaterialProperty< Real > * >	_dkappadarg
	kappa derivative w.r.t. other coupled variables More...
std::vector< const VariableGradient * >	_gradarg
	Gradients for all coupled variables. More...
const MaterialProperty< Real > &	_dLdop
	Mobility derivatives w.r.t. order parameter. More...
const MaterialProperty< Real > &	_d2Ldop2
std::vector< const MaterialProperty< Real > * >	_dLdarg
	Mobility derivative w.r.t. other coupled variables. More...
std::vector< const MaterialProperty< Real > * >	_d2Ldargdop
std::vector< std::vector< const MaterialProperty< Real > * > >	_d2Ldarg2

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 25 of file ACInterface.h.

Constructor & Destructor Documentation

ACInterface()

ACInterface::ACInterface

(

const InputParameters &

parameters

)

Definition at line 31 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())),
    _nvar(_coupled_moose_vars.size()),
    _dLdarg(_nvar),
    _d2Ldargdop(_nvar),
    _d2Ldarg2(_nvar),
    _dkappadarg(_nvar),
    _gradarg(_nvar)
{
  // Get mobility and kappa derivatives and coupled variable gradients
  for (unsigned int i = 0; i < _nvar; ++i)
  {
    MooseVariable * ivar = _coupled_standard_moose_vars[i];
    const VariableName iname = ivar->name();
    if (iname == _var.name())
      paramError("args",
                 "The kernel variable should not be specified in the coupled `args` parameter.");
 
    _dLdarg[i] = &getMaterialPropertyDerivative<Real>("mob_name", iname);
    _dkappadarg[i] = &getMaterialPropertyDerivative<Real>("kappa_name", iname);
 
    _d2Ldargdop[i] = &getMaterialPropertyDerivative<Real>("mob_name", iname, _var.name());
 
    _gradarg[i] = &(ivar->gradSln());
 
    _d2Ldarg2[i].resize(_nvar);
    for (unsigned int j = 0; j < _nvar; ++j)
      _d2Ldarg2[i][j] =
          &getMaterialPropertyDerivative<Real>("mob_name", iname, _coupled_moose_vars[j]->name());
  }
}

Member Function Documentation

computeQpJacobian()

Real ACInterface::computeQpJacobian ( )

protectedvirtual

Reimplemented in ACInterface2DMultiPhase1, and ACInterface2DMultiPhase2.

Definition at line 110 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 < _nvar; ++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;
}

computeQpOffDiagJacobian()

Real ACInterface::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Reimplemented in ACInterface2DMultiPhase1, and ACInterface2DMultiPhase2.

Definition at line 132 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 < _nvar; ++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.

Definition at line 104 of file ACInterface.C.

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

gradKappa()

RealGradient ACInterface::gradKappa ( )

protected

gradL()

RealGradient ACInterface::gradL ( )

protected

Definition at line 77 of file ACInterface.C.

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

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

initialSetup()

void ACInterface::initialSetup ( )

virtual

Definition at line 70 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 98 of file ACInterface.C.

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

Referenced by computeQpJacobian(), and computeQpResidual().

nablaLPsi()

RealGradient ACInterface::nablaLPsi ( )

protected

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

Definition at line 86 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().

Member Data Documentation

_d2Ldarg2

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

protected

Definition at line 67 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 66 of file ACInterface.h.

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

_d2Ldop2

const MaterialProperty<Real>& ACInterface::_d2Ldop2

protected

Definition at line 55 of file ACInterface.h.

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

_dkappadarg

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

protected

kappa derivative w.r.t. other coupled variables

Definition at line 71 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 59 of file ACInterface.h.

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

_dLdarg

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

protected

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

Definition at line 65 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 54 of file ACInterface.h.

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

_gradarg

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

protected

Gradients for all coupled variables.

Definition at line 74 of file ACInterface.h.

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

_kappa

const MaterialProperty<Real>& ACInterface::_kappa

protected

Interfacial parameter.

Definition at line 48 of file ACInterface.h.

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

_L

const MaterialProperty<Real>& ACInterface::_L

protected

Mobility.

Definition at line 46 of file ACInterface.h.

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

_nvar

const unsigned int ACInterface::_nvar

protected

number of coupled variables

Definition at line 62 of file ACInterface.h.

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

_variable_L

const bool ACInterface::_variable_L

protected

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

Definition at line 51 of file ACInterface.h.

Referenced by computeQpJacobian(), ACInterface2DMultiPhase1::computeQpJacobian(), ACInterface2DMultiPhase2::computeQpJacobian(), computeQpOffDiagJacobian(), ACInterface2DMultiPhase2::computeQpOffDiagJacobian(), ACInterface2DMultiPhase1::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