ADACInterface< compute_stage > Class Template 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 <ADACInterface.h>

Inheritance diagram for ADACInterface< compute_stage >:

Public Member Functions
	ADACInterface (const InputParameters &parameters)

Protected Member Functions
virtual ADReal	computeQpResidual ()
const	ADMaterialProperty (Real) &_prop_L
	Mobility. More...
const	ADMaterialProperty (Real) &_kappa
	Interfacial parameter. More...
const	ADMaterialProperty (Real) *_dLdop
	Mobility derivative w.r.t. order parameter. More...

Protected Attributes
const MaterialPropertyName &	_name_L
	Mobility property name. More...
const bool	_variable_L
	flag set if L is a function of non-linear variables in args More...
const unsigned int	_nvar
	number of coupled variables More...
std::vector< const ADMaterialProperty(Real) * >	_dLdarg
	Mobility derivative w.r.t. other coupled variables. More...
std::vector< const ADVariableGradient * >	_gradarg
	Gradients for all coupled variables. More...
	usingKernelMembers

Detailed Description

template<ComputeStage compute_stage>
class ADACInterface< compute_stage >

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 27 of file ADACInterface.h.

Constructor & Destructor Documentation

ADACInterface()

template<ComputeStage compute_stage>

ADACInterface< compute_stage >::ADACInterface

(

const InputParameters &

parameters

)

Definition at line 28 of file ADACInterface.C.

  : ADKernel<compute_stage>(parameters),
    _prop_L(getADMaterialProperty<Real>("mob_name")),
    _name_L(getParam<MaterialPropertyName>("mob_name")),
    _kappa(getADMaterialProperty<Real>("kappa_name")),
    _variable_L(getParam<bool>("variable_L")),
    _dLdop(_variable_L
               ? &getADMaterialProperty<Real>(derivativePropertyNameFirst(_name_L, _var.name()))
               : nullptr),
    _nvar(Coupleable::_coupled_standard_moose_vars.size()),
    _dLdarg(_nvar),
    _gradarg(_nvar)
{
  // Get mobility and kappa derivatives and coupled variable gradients
  if (_variable_L)
    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] = &getADMaterialProperty<Real>(derivativePropertyNameFirst(_name_L, iname));
      _gradarg[i] = &(ivar->adGradSln<compute_stage>());
    }
}

Member Function Documentation

ADMaterialProperty() [1/3]

template<ComputeStage compute_stage>

const ADACInterface< compute_stage >::ADMaterialProperty ( Real  ) &

protected

Interfacial parameter.

ADMaterialProperty() [2/3]

template<ComputeStage compute_stage>

const ADACInterface< compute_stage >::ADMaterialProperty ( Real  ) &

protected

Mobility.

ADMaterialProperty() [3/3]

template<ComputeStage compute_stage>

const ADACInterface< compute_stage >::ADMaterialProperty ( Real  )

protected

Mobility derivative w.r.t. order parameter.

computeQpResidual()

template<ComputeStage compute_stage>

ADReal ADACInterface< compute_stage >::computeQpResidual ( )

protectedvirtual

Definition at line 58 of file ADACInterface.C.

{
  // nabla_Lpsi is the product rule gradient \f$ \nabla (L\psi) \f$
  ADRealVectorValue nabla_Lpsi = _prop_L[_qp] * _grad_test[_i][_qp];
 
  if (_variable_L)
  {
    ADRealVectorValue grad_L = _grad_u[_qp] * (*_dLdop)[_qp];
    for (unsigned int i = 0; i < _nvar; ++i)
      grad_L += (*_gradarg[i])[_qp] * (*_dLdarg[i])[_qp];
 
    nabla_Lpsi += grad_L * _test[_i][_qp];
  }
 
  return _grad_u[_qp] * _kappa[_qp] * nabla_Lpsi;
}

Member Data Documentation

_dLdarg

template<ComputeStage compute_stage>

std::vector<const ADMaterialProperty(Real) *> ADACInterface< compute_stage >::_dLdarg

protected

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

Definition at line 62 of file ADACInterface.h.

Referenced by ADACInterface< compute_stage >::ADACInterface().

_gradarg

template<ComputeStage compute_stage>

std::vector<const ADVariableGradient *> ADACInterface< compute_stage >::_gradarg

protected

Gradients for all coupled variables.

Definition at line 65 of file ADACInterface.h.

Referenced by ADACInterface< compute_stage >::ADACInterface().

_name_L

template<ComputeStage compute_stage>

const MaterialPropertyName& ADACInterface< compute_stage >::_name_L

protected

Mobility property name.

Definition at line 47 of file ADACInterface.h.

Referenced by ADACInterface< compute_stage >::ADACInterface().

_nvar

template<ComputeStage compute_stage>

const unsigned int ADACInterface< compute_stage >::_nvar

protected

number of coupled variables

Definition at line 59 of file ADACInterface.h.

Referenced by ADACInterface< compute_stage >::ADACInterface().

_variable_L

template<ComputeStage compute_stage>

const bool ADACInterface< compute_stage >::_variable_L

protected

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

Definition at line 53 of file ADACInterface.h.

Referenced by ADACInterface< compute_stage >::ADACInterface().

usingKernelMembers

template<ComputeStage compute_stage>

ADACInterface< compute_stage >::usingKernelMembers

protected

Definition at line 67 of file ADACInterface.h.

---

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

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