ACGrGrPoly Class Reference

This kernel calculates the residual for grain growth for a single phase, poly-crystal system. More...

#include <ACGrGrPoly.h>

Inheritance diagram for ACGrGrPoly:

Public Member Functions
	ACGrGrPoly (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 MaterialProperty< Real > &	_gamma
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 kernel calculates the residual for grain growth for a single phase, poly-crystal system.

A single material property gamma_asymm is used for the prefactor of the cross-terms between order parameters.

Definition at line 25 of file ACGrGrPoly.h.

Member Enumeration Documentation

PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 37 of file ACBulk.h.

  {
    Jacobian,
    Residual
  };

Constructor & Destructor Documentation

ACGrGrPoly()

ACGrGrPoly::ACGrGrPoly

(

const InputParameters &

parameters

)

Definition at line 23 of file ACGrGrPoly.C.

  : ACGrGrBase(parameters), _gamma(getMaterialProperty<Real>("gamma_asymm"))
{
}

Member Function Documentation

computeDFDOP() [1/2]

Real ACGrGrPoly::computeDFDOP ( PFFunctionType  type )

protectedvirtual

Definition at line 29 of file ACGrGrPoly.C.

{
  // Sum all other order parameters
  Real SumEtaj = 0.0;
  for (unsigned int i = 0; i < _op_num; ++i)
    SumEtaj += (*_vals[i])[_qp] * (*_vals[i])[_qp];
 
  // Calculate either the residual or Jacobian of the grain growth free energy
  switch (type)
  {
    case Residual:
    {
      return _mu[_qp] *
             (_u[_qp] * _u[_qp] * _u[_qp] - _u[_qp] + 2.0 * _gamma[_qp] * _u[_qp] * SumEtaj);
    }
 
    case Jacobian:
    {
      return _mu[_qp] *
             (_phi[_j][_qp] * (3.0 * _u[_qp] * _u[_qp] - 1.0 + 2.0 * _gamma[_qp] * SumEtaj));
    }
 
    default:
      mooseError("Invalid type passed in");
  }
}

computeDFDOP() [2/2]

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

protectedpure virtualinherited

computeQpOffDiagJacobian()

Real ACGrGrPoly::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Reimplemented from ACBulk< Real >.

Definition at line 57 of file ACGrGrPoly.C.

{
  for (unsigned int i = 0; i < _op_num; ++i)
    if (jvar == _vals_var[i])
    {
      // Derivative of SumEtaj
      const Real dSumEtaj = 2.0 * (*_vals[i])[_qp] * _phi[_j][_qp];
      const Real dDFDOP = _mu[_qp] * 2.0 * _gamma[_qp] * _u[_qp] * dSumEtaj;
 
      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

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

_gamma

const MaterialProperty<Real>& ACGrGrPoly::_gamma

protected

Definition at line 34 of file ACGrGrPoly.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>& ACGrGrBase::_mu

protectedinherited

Definition at line 36 of file ACGrGrBase.h.

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

_op_num

const unsigned int ACGrGrBase::_op_num

protectedinherited

Definition at line 31 of file ACGrGrBase.h.

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

_vals

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

protectedinherited

Definition at line 33 of file ACGrGrBase.h.

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

_vals_var

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

protectedinherited

Definition at line 34 of file ACGrGrBase.h.

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

---

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

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