ACBulk< T > Class Template Reference

This is the Allen-Cahn equation base class that implements the bulk or local energy term of the equation. More...

#include <ACBulk.h>

Inheritance diagram for ACBulk< T >:

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

Static Public Member Functions
static InputParameters	validParams ()

Protected Types
enum	PFFunctionType { Jacobian, Residual }

Protected Member Functions
virtual Real	precomputeQpResidual ()
virtual Real	precomputeQpJacobian ()
virtual Real	computeQpOffDiagJacobian (unsigned int jvar)
virtual Real	computeDFDOP (PFFunctionType type)=0

Protected Attributes
const MaterialProperty< T > &	_L
	Mobility. More...
const MaterialProperty< T > &	_dLdop
	Mobility derivative w.r.t. order parameter. More...
std::vector< const MaterialProperty< T > * >	_dLdarg
	Mobility derivative w.r.t coupled variables. More...

Detailed Description

template<typename T>
class ACBulk< T >

This is the Allen-Cahn equation base class that implements the bulk or local energy term of the equation.

It is templated on the type of the mobility, which can be either a number (Real) or a tensor (RealValueTensor). Note that the function computeDFDOP MUST be overridden in any kernel that inherits from ACBulk.

Definition at line 24 of file ACBulk.h.

Member Enumeration Documentation

PFFunctionType

template<typename T>

enum ACBulk::PFFunctionType

protected

Enumerator
Jacobian
Residual

Definition at line 37 of file ACBulk.h.

  {
    Jacobian,
    Residual
  };

Constructor & Destructor Documentation

ACBulk()

template<typename T >

ACBulk< T >::ACBulk

(

const InputParameters &

parameters

)

Definition at line 56 of file ACBulk.h.

  : DerivativeMaterialInterface<JvarMapKernelInterface<KernelValue>>(parameters),
    _L(getMaterialProperty<T>("mob_name")),
    _dLdop(getMaterialPropertyDerivative<T>("mob_name", _var.name()))
{
  // Get number of coupled variables
  unsigned int nvar = _coupled_moose_vars.size();
 
  // reserve space for derivatives
  _dLdarg.resize(nvar);
 
  // Iterate over all coupled variables
  for (unsigned int i = 0; i < nvar; ++i)
    _dLdarg[i] = &getMaterialPropertyDerivative<T>("mob_name", _coupled_moose_vars[i]->name());
}

Member Function Documentation

computeDFDOP()

template<typename T>

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

protectedpure virtual

computeQpOffDiagJacobian()

template<typename T >

Real ACBulk< T >::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Reimplemented in CoupledAllenCahn, AllenCahn, KKSACBulkC, KKSACBulkF, KKSMultiACBulkC, KKSMultiACBulkF, ACGrGrMulti, ACGrGrPoly, ACBarrierFunction, and ACGBPoly.

Definition at line 116 of file ACBulk.h.

{
  // Get the coupled variable jvar is referring to
  const unsigned int cvar = mapJvarToCvar(jvar);
 
  // Set off-diagonal Jacobian term from mobility derivatives
  return (*_dLdarg[cvar])[_qp] * _phi[_j][_qp] * computeDFDOP(Residual) * _test[_i][_qp];
}

Referenced by AllenCahn::computeQpOffDiagJacobian(), KKSMultiACBulkF::computeQpOffDiagJacobian(), KKSMultiACBulkC::computeQpOffDiagJacobian(), KKSACBulkF::computeQpOffDiagJacobian(), KKSACBulkC::computeQpOffDiagJacobian(), and CoupledAllenCahn::computeQpOffDiagJacobian().

initialSetup()

template<typename T >

void ACBulk< T >::initialSetup ( )

virtual

Reimplemented in KKSMultiACBulkBase, CoupledAllenCahn, KKSACBulkBase, and AllenCahn.

Definition at line 85 of file ACBulk.h.

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

Referenced by AllenCahn::initialSetup(), CoupledAllenCahn::initialSetup(), KKSACBulkBase::initialSetup(), and KKSMultiACBulkBase::initialSetup().

precomputeQpJacobian()

template<typename T >

Real ACBulk< T >::precomputeQpJacobian ( )

protectedvirtual

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

template<typename T >

Real ACBulk< T >::precomputeQpResidual ( )

protectedvirtual

Definition at line 92 of file ACBulk.h.

{
  // Get free energy derivative from function
  Real dFdop = computeDFDOP(Residual);
 
  // Set residual
  return _L[_qp] * dFdop;
}

validParams()

template<typename T >

InputParameters ACBulk< T >::validParams ( )

static

Definition at line 74 of file ACBulk.h.

{
  InputParameters params = ::validParams<KernelValue>();
  params.addClassDescription("Allen-Cahn base Kernel");
  params.addParam<MaterialPropertyName>("mob_name", "L", "The mobility used with the kernel");
  params.addCoupledVar("args", "Vector of arguments of the mobility");
  return params;
}

Referenced by validParams< ACGBPoly >(), validParams< ACGrGrBase >(), validParams< ACGrGrElasticDrivingForce >(), validParams< ACSEDGPoly >(), validParams< ACSwitching >(), validParams< AllenCahn >(), validParams< CoupledAllenCahn >(), validParams< KKSACBulkBase >(), and validParams< KKSMultiACBulkBase >().

Member Data Documentation

_dLdarg

template<typename T>

std::vector<const MaterialProperty<T> *> ACBulk< T >::_dLdarg

protected

Mobility derivative w.r.t coupled variables.

Definition at line 52 of file ACBulk.h.

Referenced by ACBulk< Real >::ACBulk().

_dLdop

template<typename T>

const MaterialProperty<T>& ACBulk< T >::_dLdop

protected

Mobility derivative w.r.t. order parameter.

Definition at line 49 of file ACBulk.h.

_L

template<typename T>

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

protected

Mobility.

Definition at line 46 of file ACBulk.h.

---

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

• phase_field/include/kernels/ACBulk.h