ACGrGrMulti Class Reference

#include <ACGrGrMulti.h>

Inheritance diagram for ACGrGrMulti:

Public Member Functions
	ACGrGrMulti (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual Real	computeDFDOP (PFFunctionType type) override
virtual Real	computeQpOffDiagJacobian (unsigned int jvar) override
GenericReal< is_ad >	computedF0du ()

Protected Attributes
const NonlinearVariableName	_uname
const MaterialProperty< Real > &	_dmudu
const std::vector< VariableName >	_vname
std::vector< const MaterialProperty< Real > * >	_dmudEtaj
std::vector< MaterialPropertyName >	_gamma_names
	Names of gammas for each order parameter. More...
unsigned int	_num_j
std::vector< const GenericMaterialProperty< Real, is_ad > *>	_prop_gammas
	Values of gammas for each order parameter. More...

Detailed Description

Definition at line 49 of file ACGrGrMulti.h.

Constructor & Destructor Documentation

ACGrGrMulti()

ACGrGrMulti::ACGrGrMulti

(

const InputParameters &

parameters

)

Definition at line 45 of file ACGrGrMulti.C.

  : ACGrGrMultiTempl<false>(parameters),
    _uname(this->template getParam<NonlinearVariableName>("variable")),
    _dmudu(this->template getMaterialPropertyDerivative<Real>("mu", _uname)),
    _vname(this->template getParam<std::vector<VariableName>>("v")),
    _dmudEtaj(_num_j)
{
  for (unsigned int n = 0; n < _num_j; ++n)
    _dmudEtaj[n] = &this->template getMaterialPropertyDerivative<Real>("mu", _vname[n]);
}

Member Function Documentation

computedF0du()

GenericReal< is_ad > ACGrGrMultiTempl< is_ad >::computedF0du ( )

protectedinherited

Definition at line 113 of file ACGrGrMulti.C.

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

{
  GenericReal<is_ad> SumGammaEtaj = 0.0;
  for (const auto i : make_range(_op_num))
    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()

Real ACGrGrMulti::computeDFDOP ( PFFunctionType  type )

overrideprotectedvirtual

Definition at line 57 of file ACGrGrMulti.C.

{
  // Sum all other order parameters
  Real SumGammaEtaj = 0.0;
  for (const auto i : make_range(_op_num))
    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");
  }
}

computeQpOffDiagJacobian()

Real ACGrGrMulti::computeQpOffDiagJacobian ( unsigned int  jvar )

overrideprotectedvirtual

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

validParams()

InputParameters ACGrGrMultiTempl< is_ad >::validParams ( )

staticinherited

Definition at line 17 of file ACGrGrMulti.C.

{
  InputParameters params = ACGrGrMultiBase<is_ad>::validParams();
  params.addClassDescription("Multi-phase poly-crystalline Allen-Cahn Kernel");
  params.addRequiredParam<std::vector<MaterialPropertyName>>(
      "gamma_names",
      "List of gamma material property names for each other order parameter. Place "
      "in same order as order parameters (v)!");
  return params;
}

Member Data Documentation

_dmudEtaj

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

protected

Definition at line 61 of file ACGrGrMulti.h.

Referenced by ACGrGrMulti(), and computeQpOffDiagJacobian().

_dmudu

const MaterialProperty<Real>& ACGrGrMulti::_dmudu

protected

Definition at line 59 of file ACGrGrMulti.h.

Referenced by computeDFDOP().

_gamma_names

std::vector<MaterialPropertyName> ACGrGrMultiTempl< is_ad >::_gamma_names

protectedinherited

Names of gammas for each order parameter.

Definition at line 34 of file ACGrGrMulti.h.

_num_j

unsigned int ACGrGrMultiTempl< is_ad >::_num_j

protectedinherited

Definition at line 35 of file ACGrGrMulti.h.

Referenced by ACGrGrMulti().

_prop_gammas

std::vector<const GenericMaterialProperty<Real, is_ad> *> ACGrGrMultiTempl< is_ad >::_prop_gammas

protectedinherited

Values of gammas for each order parameter.

Definition at line 38 of file ACGrGrMulti.h.

Referenced by computeDFDOP(), and computeQpOffDiagJacobian().

_uname

const NonlinearVariableName ACGrGrMulti::_uname

protected

Definition at line 58 of file ACGrGrMulti.h.

_vname

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

protected

Definition at line 60 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