ACGrGrMulti Class Reference

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

#include <ACGrGrMulti.h>

Inheritance diagram for ACGrGrMulti:

Public Member Functions
	ACGrGrMulti (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
std::vector< MaterialPropertyName >	_gamma_names
	Names of gammas for each order parameter. More...
unsigned int	_num_j
std::vector< const MaterialProperty< Real > * >	_prop_gammas
	Values of gammas for each order parameter. More...
const NonlinearVariableName	_uname
const MaterialProperty< Real > &	_dmudu
const std::vector< VariableName >	_vname
std::vector< const MaterialProperty< Real > * >	_dmudEtaj
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...

Private Member Functions
Real	computedF0du ()

Detailed Description

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

A list of material properties needs to be supplied for the gammas (prefactors of the cross-terms between order parameters).

Definition at line 26 of file ACGrGrMulti.h.

Member Enumeration Documentation

PFFunctionType

enum ACBulk::PFFunctionType

protectedinherited

Definition at line 38 of file ACBulk.h.

  {
    Jacobian,
    Residual
  };

Constructor & Destructor Documentation

ACGrGrMulti()

ACGrGrMulti::ACGrGrMulti

(

const InputParameters &

parameters

)

Definition at line 27 of file ACGrGrMulti.C.

  : ACGrGrBase(parameters),
    _gamma_names(getParam<std::vector<MaterialPropertyName>>("gamma_names")),
    _num_j(_gamma_names.size()),
    _prop_gammas(_num_j),
    _uname(getParam<NonlinearVariableName>("variable")),
    _dmudu(getMaterialPropertyDerivative<Real>("mu", _uname)),
    _vname(getParam<std::vector<VariableName>>("v")),
    _dmudEtaj(_num_j)
{
  // check passed in parameter vectors
  if (_num_j != coupledComponents("v"))
    paramError("gamma_names",
               "Need to pass in as many gamma_names as coupled variables in v in ACGrGrMulti");

  for (unsigned int n = 0; n < _num_j; ++n)
  {
    _prop_gammas[n] = &getMaterialPropertyByName<Real>(_gamma_names[n]);
    _dmudEtaj[n] = &getMaterialPropertyDerivative<Real>("mu", _vname[n]);
  }
}

Member Function Documentation

computedF0du()

Real ACGrGrMulti::computedF0du ( )

private

Definition at line 94 of file ACGrGrMulti.C.

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

{
  Real SumGammaEtaj = 0.0;
  for (unsigned int i = 0; i < _op_num; ++i)
    SumGammaEtaj += (*_prop_gammas[i])[_qp] * (*_vals[i])[_qp] * (*_vals[i])[_qp];

  return _u[_qp] * _u[_qp] * _u[_qp] - _u[_qp] + 2.0 * _u[_qp] * SumGammaEtaj;
}

computeDFDOP() [1/2]

Real ACGrGrMulti::computeDFDOP ( PFFunctionType  type )

protectedvirtual

Definition at line 50 of file ACGrGrMulti.C.

{
  // Sum all other order parameters
  Real SumGammaEtaj = 0.0;
  for (unsigned int i = 0; i < _op_num; ++i)
    SumGammaEtaj += (*_prop_gammas[i])[_qp] * (*_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] * computedF0du();
    }

    case Jacobian:
    {
      Real d2f0du2 = 3.0 * _u[_qp] * _u[_qp] - 1.0 + 2.0 * SumGammaEtaj;
      return _phi[_j][_qp] * (_mu[_qp] * d2f0du2 + _dmudu[_qp] * computedF0du());
    }

    default:
      mooseError("Invalid type passed in");
  }
}

computeDFDOP() [2/2]

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

protectedpure virtualinherited

computeQpOffDiagJacobian()

Real ACGrGrMulti::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Reimplemented from ACBulk< Real >.

Definition at line 77 of file ACGrGrMulti.C.

{
  for (unsigned int i = 0; i < _op_num; ++i)
    if (jvar == _vals_var[i])
    {
      // Derivative of SumGammaEtaj
      const Real dSumGammaEtaj = 2.0 * (*_prop_gammas[i])[_qp] * (*_vals[i])[_qp];
      const Real dDFDOP = _mu[_qp] * 2.0 * _u[_qp] * dSumGammaEtaj;

      return _L[_qp] * _test[_i][_qp] * _phi[_j][_qp] *
             (dDFDOP + (*_dmudEtaj[i])[_qp] * computedF0du());
    }

  return 0.0;
}

initialSetup()

void ACBulk< Real >::initialSetup ( )

virtualinherited

Reimplemented in KKSMultiACBulkBase, CoupledAllenCahn, KKSACBulkBase, and AllenCahn.

Definition at line 86 of file ACBulk.h.

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

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

_dmudEtaj

std::vector<const MaterialProperty<Real> *> ACGrGrMulti::_dmudEtaj

protected

Definition at line 45 of file ACGrGrMulti.h.

Referenced by ACGrGrMulti(), and computeQpOffDiagJacobian().

_dmudu

const MaterialProperty<Real>& ACGrGrMulti::_dmudu

protected

Definition at line 43 of file ACGrGrMulti.h.

Referenced by computeDFDOP().

_gamma_names

std::vector<MaterialPropertyName> ACGrGrMulti::_gamma_names

protected

Names of gammas for each order parameter.

Definition at line 36 of file ACGrGrMulti.h.

Referenced by ACGrGrMulti().

_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(), computeQpOffDiagJacobian(), KKSACBulkC::computeQpOffDiagJacobian(), KKSMultiACBulkC::computeQpOffDiagJacobian(), AllenCahn::computeQpOffDiagJacobian(), KKSMultiACBulkF::computeQpOffDiagJacobian(), KKSACBulkF::computeQpOffDiagJacobian(), and CoupledAllenCahn::computeQpOffDiagJacobian().

_mu

const MaterialProperty<Real>& ACGrGrBase::_mu

protectedinherited

Definition at line 37 of file ACGrGrBase.h.

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

_num_j

unsigned int ACGrGrMulti::_num_j

protected

Definition at line 37 of file ACGrGrMulti.h.

Referenced by ACGrGrMulti().

_op_num

const unsigned int ACGrGrBase::_op_num

protectedinherited

Definition at line 32 of file ACGrGrBase.h.

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

_prop_gammas

std::vector<const MaterialProperty<Real> *> ACGrGrMulti::_prop_gammas

protected

Values of gammas for each order parameter.

Definition at line 40 of file ACGrGrMulti.h.

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

_uname

const NonlinearVariableName ACGrGrMulti::_uname

protected

Definition at line 42 of file ACGrGrMulti.h.

_vals

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

protectedinherited

Definition at line 34 of file ACGrGrBase.h.

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

_vals_var

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

protectedinherited

Definition at line 35 of file ACGrGrBase.h.

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

_vname

const std::vector<VariableName> ACGrGrMulti::_vname

protected

Definition at line 44 of file ACGrGrMulti.h.

Referenced by ACGrGrMulti().

---

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

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