ACGBPoly Class Reference

#include <ACGBPoly.h>

Inheritance diagram for ACGBPoly:

Public Member Functions
	ACGBPoly (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 VariableValue &	_c
unsigned int	_c_var
const MaterialProperty< Real > &	_mu
const MaterialProperty< Real > &	_gamma
Real	_en_ratio
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

Definition at line 20 of file ACGBPoly.h.

Member Enumeration Documentation

PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 37 of file ACBulk.h.

  {
    Jacobian,
    Residual
  };

Constructor & Destructor Documentation

ACGBPoly()

ACGBPoly::ACGBPoly

(

const InputParameters &

parameters

)

Definition at line 26 of file ACGBPoly.C.

  : ACBulk<Real>(parameters),
    _c(coupledValue("c")),
    _c_var(coupled("c")),
    _mu(getMaterialProperty<Real>("mu")),
    _gamma(getMaterialProperty<Real>("gamma_asymm")),
    _en_ratio(getParam<Real>("en_ratio"))
{
}

Member Function Documentation

computeDFDOP() [1/2]

Real ACGBPoly::computeDFDOP ( PFFunctionType  type )

protectedvirtual

Definition at line 37 of file ACGBPoly.C.

{
  Real mult = 2.0 * _en_ratio * _mu[_qp] * _gamma[_qp];
 
  Real c = _c[_qp];
  if (c < 1.0e-8)
    c = 0.0;
  if (c > 1.0)
    c = 1.0;
 
  switch (type)
  {
    case Residual:
      return mult * _u[_qp] * c * c;
 
    case Jacobian:
      return mult * _phi[_j][_qp] * c * c;
  }
 
  mooseError("Invalid type passed in");
}

computeDFDOP() [2/2]

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

protectedpure virtualinherited

computeQpOffDiagJacobian()

Real ACGBPoly::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Reimplemented from ACBulk< Real >.

Definition at line 60 of file ACGBPoly.C.

{
  Real c = _c[_qp];
  if (c < 1.0e-8)
    c = 0.0;
  if (c > 1.0)
    c = 1.0;
 
  if (jvar == _c_var)
  {
    Real mult = 2.0 * _en_ratio * _mu[_qp] * _gamma[_qp];
    Real dDFDOP = 2.0 * mult * _u[_qp] * c * _phi[_j][_qp];
 
    return _L[_qp] * _test[_i][_qp] * dDFDOP;
  }
 
  return 0.0;
}

initialSetup()

void ACBulk< Real >::initialSetup ( )

virtualinherited

Reimplemented in KKSMultiACBulkBase, CoupledAllenCahn, KKSACBulkBase, and AllenCahn.

Definition at line 85 of file ACBulk.h.

{
  validateNonlinearCoupling<Real>("mob_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

_c

const VariableValue& ACGBPoly::_c

protected

Definition at line 29 of file ACGBPoly.h.

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

_c_var

unsigned int ACGBPoly::_c_var

protected

Definition at line 30 of file ACGBPoly.h.

Referenced by computeQpOffDiagJacobian().

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

_en_ratio

Real ACGBPoly::_en_ratio

protected

Definition at line 35 of file ACGBPoly.h.

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

_gamma

const MaterialProperty<Real>& ACGBPoly::_gamma

protected

Definition at line 33 of file ACGBPoly.h.

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

_L

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

protectedinherited

Mobility.

Definition at line 46 of file ACBulk.h.

_mu

const MaterialProperty<Real>& ACGBPoly::_mu

protected

Definition at line 32 of file ACGBPoly.h.

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

---

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

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