CoupledAllenCahn Class Reference

CoupledAllenCahn uses the Free Energy function and derivatives provided by a DerivativeParsedMaterial to compute the residual for the bulk part of the Allen-Cahn equation, where the variational free energy derivative is taken w.r.t. More...

#include <CoupledAllenCahn.h>

Inheritance diagram for CoupledAllenCahn:

Public Member Functions
	CoupledAllenCahn (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
VariableName	_v_name
const unsigned int	_nvar
const MaterialProperty< Real > &	_dFdV
const MaterialProperty< Real > &	_d2FdVdEta
std::vector< const MaterialProperty< Real > * >	_d2FdVdarg
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

CoupledAllenCahn uses the Free Energy function and derivatives provided by a DerivativeParsedMaterial to compute the residual for the bulk part of the Allen-Cahn equation, where the variational free energy derivative is taken w.r.t.

a coupled variable.

Definition at line 26 of file CoupledAllenCahn.h.

Member Enumeration Documentation

PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 37 of file ACBulk.h.

  {
    Jacobian,
    Residual
  };

Constructor & Destructor Documentation

CoupledAllenCahn()

CoupledAllenCahn::CoupledAllenCahn

(

const InputParameters &

parameters

)

Definition at line 27 of file CoupledAllenCahn.C.

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

Member Function Documentation

computeDFDOP() [1/2]

Real CoupledAllenCahn::computeDFDOP ( PFFunctionType  type )

protectedvirtual

Definition at line 49 of file CoupledAllenCahn.C.

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

computeDFDOP() [2/2]

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

protectedpure virtualinherited

computeQpOffDiagJacobian()

Real CoupledAllenCahn::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Reimplemented from ACBulk< Real >.

Definition at line 64 of file CoupledAllenCahn.C.

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

initialSetup()

void CoupledAllenCahn::initialSetup ( )

virtual

Reimplemented from ACBulk< Real >.

Definition at line 42 of file CoupledAllenCahn.C.

{
  ACBulk<Real>::initialSetup();
  validateNonlinearCoupling<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

_d2FdVdarg

std::vector<const MaterialProperty<Real> *> CoupledAllenCahn::_d2FdVdarg

protected

Definition at line 44 of file CoupledAllenCahn.h.

Referenced by computeQpOffDiagJacobian(), and CoupledAllenCahn().

_d2FdVdEta

const MaterialProperty<Real>& CoupledAllenCahn::_d2FdVdEta

protected

Definition at line 42 of file CoupledAllenCahn.h.

Referenced by computeDFDOP().

_dFdV

const MaterialProperty<Real>& CoupledAllenCahn::_dFdV

protected

Definition at line 41 of file CoupledAllenCahn.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 CoupledAllenCahn::_nvar

protected

Definition at line 40 of file CoupledAllenCahn.h.

Referenced by CoupledAllenCahn().

_v_name

VariableName CoupledAllenCahn::_v_name

protected

Definition at line 38 of file CoupledAllenCahn.h.

Referenced by CoupledAllenCahn().

---

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

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