ACGrGrBase Class Reference

This is the base class for kernels that calculate the residual for grain growth. More...

#include <ACGrGrBase.h>

Inheritance diagram for ACGrGrBase:

Public Member Functions
	ACGrGrBase (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
const unsigned int	_op_num
std::vector< const VariableValue * >	_vals
std::vector< unsigned int >	_vals_var
const MaterialProperty< Real > &	_mu
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

This is the base class for kernels that calculate the residual for grain growth.

It calculates the residual of the ith order parameter, and the values of all other order parameters are coupled variables and are stored in vals.

Definition at line 25 of file ACGrGrBase.h.

Member Enumeration Documentation

PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 37 of file ACBulk.h.

  {
    Jacobian,
    Residual
  };

Constructor & Destructor Documentation

ACGrGrBase()

ACGrGrBase::ACGrGrBase

(

const InputParameters &

parameters

)

Definition at line 22 of file ACGrGrBase.C.

  : ACBulk<Real>(parameters),
    _op_num(coupledComponents("v")),
    _vals(_op_num),
    _vals_var(_op_num),
    _mu(getMaterialProperty<Real>("mu"))
{
  // Loop through grains and load coupled variables into the arrays
  for (unsigned int i = 0; i < _op_num; ++i)
  {
    _vals[i] = &coupledValue("v", i);
    _vals_var[i] = coupled("v", i);
  }
}

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

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

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

_mu

const MaterialProperty<Real>& ACGrGrBase::_mu

protected

Definition at line 36 of file ACGrGrBase.h.

Referenced by ACGrGrMulti::computeDFDOP(), ACGrGrPoly::computeDFDOP(), ACGrGrPoly::computeQpOffDiagJacobian(), and ACGrGrMulti::computeQpOffDiagJacobian().

_op_num

const unsigned int ACGrGrBase::_op_num

protected

Definition at line 31 of file ACGrGrBase.h.

Referenced by ACGrGrBase(), ACGrGrMulti::computedF0du(), ACGrGrMulti::computeDFDOP(), ACGrGrPoly::computeDFDOP(), ACGrGrPoly::computeQpOffDiagJacobian(), and ACGrGrMulti::computeQpOffDiagJacobian().

_vals

std::vector<const VariableValue *> ACGrGrBase::_vals

protected

Definition at line 33 of file ACGrGrBase.h.

Referenced by ACGrGrBase(), ACBarrierFunction::calculateF0(), ACGrGrMulti::computedF0du(), ACBarrierFunction::computeDFDOP(), ACGrGrPoly::computeDFDOP(), ACGrGrMulti::computeDFDOP(), ACBarrierFunction::computeQpOffDiagJacobian(), ACGrGrPoly::computeQpOffDiagJacobian(), and ACGrGrMulti::computeQpOffDiagJacobian().

_vals_var

std::vector<unsigned int> ACGrGrBase::_vals_var

protected

Definition at line 34 of file ACGrGrBase.h.

Referenced by ACGrGrBase(), ACGrGrMulti::computeQpOffDiagJacobian(), and ACGrGrPoly::computeQpOffDiagJacobian().

---

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

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