KKSACBulkBase Class Reference

ACBulk child class that takes all the necessary data from a KKSBaseMaterial and sets up the Allen-Cahn bulk term. More...

#include <KKSACBulkBase.h>

Inheritance diagram for KKSACBulkBase:

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

Static Public Member Functions
static InputParameters	validParams ()

Protected Types
enum	PFFunctionType

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

Protected Attributes
unsigned int	_nvar
	Number of coupled variables. More...
VariableName	_eta_name
	name of the order parameter (needed to retrieve the derivative material properties) More...
std::vector< const MaterialProperty< Real > * >	_derivatives_Fa
	Derivatives of \( F_a \) with respect to all coupled variables. More...
std::vector< const MaterialProperty< Real > * >	_derivatives_Fb
	Derivatives of \( F_b \) with respect to all coupled variables. More...
const MaterialProperty< Real > &	_prop_Fa
	Value of the free energy function \( F_a \). More...
const MaterialProperty< Real > &	_prop_Fb
	Value of the free energy function \( F_b \). More...
const MaterialProperty< Real > &	_prop_dFa
	Derivative of the free energy function \( \frac d{d\eta} F_a \). More...
const MaterialProperty< Real > &	_prop_dFb
	Derivative of the free energy function \( \frac d{d\eta} F_b \). More...
const MaterialProperty< Real > &	_prop_dh
	Derivative of the switching function \( \frac d{d\eta} h(\eta) \). More...
const MaterialProperty< Real > &	_prop_d2h
	Second derivative of the switching function \( \frac {d^2}{d\eta^2} h(\eta) \). More...
std::vector< const VariableGradient * >	_grad_args
	Gradients for all coupled variables. More...
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

ACBulk child class that takes all the necessary data from a KKSBaseMaterial and sets up the Allen-Cahn bulk term.

The non-linear variable for this Kernel is the order parameter 'eta'.

Definition at line 27 of file KKSACBulkBase.h.

Member Enumeration Documentation

PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 38 of file ACBulk.h.

  {
    Jacobian,
    Residual
  };

Constructor & Destructor Documentation

KKSACBulkBase()

KKSACBulkBase::KKSACBulkBase

(

const InputParameters &

parameters

)

Definition at line 30 of file KKSACBulkBase.C.

  : ACBulk<Real>(parameters),
    // number of coupled variables (ca, args_a[])
    _nvar(_coupled_moose_vars.size()),
    _eta_name(_var.name()),
    _prop_Fa(getMaterialProperty<Real>("fa_name")),
    _prop_Fb(getMaterialProperty<Real>("fb_name")),
    _prop_dFa(getMaterialPropertyDerivative<Real>("fa_name", _eta_name)),
    _prop_dFb(getMaterialPropertyDerivative<Real>("fb_name", _eta_name)),
    _prop_dh(getMaterialPropertyDerivative<Real>("h_name", _eta_name)),
    _prop_d2h(getMaterialPropertyDerivative<Real>("h_name", _eta_name, _eta_name))
{
  // reserve space for derivatives
  _derivatives_Fa.resize(_nvar);
  _derivatives_Fb.resize(_nvar);
  _grad_args.resize(_nvar);

  // Iterate over all coupled variables
  for (unsigned int i = 0; i < _nvar; ++i)
  {
    MooseVariable * cvar = _coupled_standard_moose_vars[i];

    // get the first derivatives of Fa and Fb material property
    _derivatives_Fa[i] = &getMaterialPropertyDerivative<Real>("fa_name", cvar->name());
    _derivatives_Fb[i] = &getMaterialPropertyDerivative<Real>("fb_name", cvar->name());

    // get the gradient
    _grad_args[i] = &(cvar->gradSln());
  }
}

Member Function Documentation

computeDFDOP()

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

protectedpure virtualinherited

computeQpOffDiagJacobian()

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

protectedvirtualinherited

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

Definition at line 117 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];
}

initialSetup()

void KKSACBulkBase::initialSetup ( )

virtual

Reimplemented from ACBulk< Real >.

Definition at line 62 of file KKSACBulkBase.C.

{
  ACBulk<Real>::initialSetup();
  validateNonlinearCoupling<Real>("fa_name");
  validateNonlinearCoupling<Real>("fb_name");
}

precomputeQpJacobian()

Real ACBulk< Real >::precomputeQpJacobian ( )

protectedvirtualinherited

Definition at line 104 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 93 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 75 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

_derivatives_Fa

std::vector<const MaterialProperty<Real> *> KKSACBulkBase::_derivatives_Fa

protected

Derivatives of \( F_a \) with respect to all coupled variables.

Definition at line 42 of file KKSACBulkBase.h.

Referenced by KKSACBulkF::computeQpOffDiagJacobian(), and KKSACBulkBase().

_derivatives_Fb

std::vector<const MaterialProperty<Real> *> KKSACBulkBase::_derivatives_Fb

protected

Derivatives of \( F_b \) with respect to all coupled variables.

Definition at line 45 of file KKSACBulkBase.h.

Referenced by KKSACBulkF::computeQpOffDiagJacobian(), and KKSACBulkBase().

_dLdarg

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

protectedinherited

Mobility derivative w.r.t coupled variables.

Definition at line 53 of file ACBulk.h.

_dLdop

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

protectedinherited

Mobility derivative w.r.t. order parameter.

Definition at line 50 of file ACBulk.h.

_eta_name

VariableName KKSACBulkBase::_eta_name

protected

name of the order parameter (needed to retrieve the derivative material properties)

Definition at line 39 of file KKSACBulkBase.h.

_grad_args

std::vector<const VariableGradient *> KKSACBulkBase::_grad_args

protected

Gradients for all coupled variables.

Definition at line 66 of file KKSACBulkBase.h.

Referenced by KKSACBulkBase().

_L

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

protectedinherited

Mobility.

Definition at line 47 of file ACBulk.h.

Referenced by ACGBPoly::computeQpOffDiagJacobian(), ACBarrierFunction::computeQpOffDiagJacobian(), ACGrGrPoly::computeQpOffDiagJacobian(), ACGrGrMulti::computeQpOffDiagJacobian(), KKSACBulkC::computeQpOffDiagJacobian(), KKSMultiACBulkC::computeQpOffDiagJacobian(), AllenCahn::computeQpOffDiagJacobian(), KKSMultiACBulkF::computeQpOffDiagJacobian(), KKSACBulkF::computeQpOffDiagJacobian(), and CoupledAllenCahn::computeQpOffDiagJacobian().

_nvar

unsigned int KKSACBulkBase::_nvar

protected

Number of coupled variables.

Definition at line 36 of file KKSACBulkBase.h.

Referenced by KKSACBulkBase(), and KKSACBulkC::KKSACBulkC().

_prop_d2h

const MaterialProperty<Real>& KKSACBulkBase::_prop_d2h

protected

Second derivative of the switching function \( \frac {d^2}{d\eta^2} h(\eta) \).

Definition at line 63 of file KKSACBulkBase.h.

Referenced by KKSACBulkC::computeDFDOP(), and KKSACBulkF::computeDFDOP().

_prop_dFa

const MaterialProperty<Real>& KKSACBulkBase::_prop_dFa

protected

Derivative of the free energy function \( \frac d{d\eta} F_a \).

Definition at line 54 of file KKSACBulkBase.h.

_prop_dFb

const MaterialProperty<Real>& KKSACBulkBase::_prop_dFb

protected

Derivative of the free energy function \( \frac d{d\eta} F_b \).

Definition at line 57 of file KKSACBulkBase.h.

_prop_dh

const MaterialProperty<Real>& KKSACBulkBase::_prop_dh

protected

Derivative of the switching function \( \frac d{d\eta} h(\eta) \).

Definition at line 60 of file KKSACBulkBase.h.

Referenced by KKSACBulkC::computeDFDOP(), KKSACBulkF::computeDFDOP(), KKSACBulkF::computeQpOffDiagJacobian(), and KKSACBulkC::computeQpOffDiagJacobian().

_prop_Fa

const MaterialProperty<Real>& KKSACBulkBase::_prop_Fa

protected

Value of the free energy function \( F_a \).

Definition at line 48 of file KKSACBulkBase.h.

Referenced by KKSACBulkF::computeDFDOP().

_prop_Fb

const MaterialProperty<Real>& KKSACBulkBase::_prop_Fb

protected

Value of the free energy function \( F_b \).

Definition at line 51 of file KKSACBulkBase.h.

Referenced by KKSACBulkF::computeDFDOP().

---

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

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