AllenCahn Class Reference

AllenCahn uses the Free Energy function and derivatives provided by a DerivativeParsedMaterial to computer the residual for the bulk part of the Allen-Cahn equation. More...

#include <AllenCahn.h>

Inheritance diagram for AllenCahn:

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

Static Public Member Functions
static InputParameters	validParams ()

Protected Types
enum	PFFunctionType

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

Protected Attributes
const unsigned int	_nvar
const MaterialProperty< Real > &	_dFdEta
const MaterialProperty< Real > &	_d2FdEta2
std::vector< const MaterialProperty< Real > * >	_d2FdEtadarg
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

AllenCahn uses the Free Energy function and derivatives provided by a DerivativeParsedMaterial to computer the residual for the bulk part of the Allen-Cahn equation.

Definition at line 25 of file AllenCahn.h.

Member Enumeration Documentation

PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 37 of file ACBulk.h.

  {
    Jacobian,
    Residual
  };

Constructor & Destructor Documentation

AllenCahn()

AllenCahn::AllenCahn

(

const InputParameters &

parameters

)

Definition at line 25 of file AllenCahn.C.

  : ACBulk<Real>(parameters),
    _nvar(_coupled_moose_vars.size()),
    _dFdEta(getMaterialPropertyDerivative<Real>("f_name", _var.name())),
    _d2FdEta2(getMaterialPropertyDerivative<Real>("f_name", _var.name(), _var.name())),
    _d2FdEtadarg(_nvar)
{
  // Iterate over all coupled variables
  for (unsigned int i = 0; i < _nvar; ++i)
    _d2FdEtadarg[i] =
        &getMaterialPropertyDerivative<Real>("f_name", _var.name(), _coupled_moose_vars[i]->name());
}

Member Function Documentation

computeDFDOP() [1/2]

Real AllenCahn::computeDFDOP ( PFFunctionType  type )

protectedvirtual

Definition at line 47 of file AllenCahn.C.

{
  switch (type)
  {
    case Residual:
      return _dFdEta[_qp];
 
    case Jacobian:
      return _d2FdEta2[_qp] * _phi[_j][_qp];
  }
 
  mooseError("Internal error");
}

computeDFDOP() [2/2]

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

protectedpure virtualinherited

computeQpOffDiagJacobian()

Real AllenCahn::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Reimplemented from ACBulk< Real >.

Definition at line 62 of file AllenCahn.C.

{
  // get the coupled variable jvar is referring to
  const unsigned int cvar = mapJvarToCvar(jvar);
 
  return ACBulk<Real>::computeQpOffDiagJacobian(jvar) +
         _L[_qp] * (*_d2FdEtadarg[cvar])[_qp] * _phi[_j][_qp] * _test[_i][_qp];
}

initialSetup()

void AllenCahn::initialSetup ( )

virtual

Reimplemented from ACBulk< Real >.

Definition at line 39 of file AllenCahn.C.

{
  ACBulk<Real>::initialSetup();
  validateNonlinearCoupling<Real>("f_name");
  validateDerivativeMaterialPropertyBase<Real>("f_name");
}

precomputeQpJacobian()

Real ACBulk< Real >::precomputeQpJacobian ( )

protectedvirtualinherited

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()

Real ACBulk< Real >::precomputeQpResidual ( )

protectedvirtualinherited

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()

InputParameters ACBulk< Real >::validParams ( )

staticinherited

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;
}

Member Data Documentation

_d2FdEta2

const MaterialProperty<Real>& AllenCahn::_d2FdEta2

protected

Definition at line 38 of file AllenCahn.h.

Referenced by computeDFDOP().

_d2FdEtadarg

std::vector<const MaterialProperty<Real> *> AllenCahn::_d2FdEtadarg

protected

Definition at line 40 of file AllenCahn.h.

Referenced by AllenCahn(), and computeQpOffDiagJacobian().

_dFdEta

const MaterialProperty<Real>& AllenCahn::_dFdEta

protected

Definition at line 37 of file AllenCahn.h.

Referenced by computeDFDOP().

_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.

_L

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

protectedinherited

Mobility.

Definition at line 46 of file ACBulk.h.

_nvar

const unsigned int AllenCahn::_nvar

protected

Definition at line 36 of file AllenCahn.h.

Referenced by AllenCahn().

---

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

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