ACGrGrMultiTempl< is_ad > Class Template Reference

#include <ACGrGrMulti.h>

Inheritance diagram for ACGrGrMultiTempl< is_ad >:

Public Member Functions
	ACGrGrMultiTempl (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
GenericReal< is_ad >	computedF0du ()

Protected Attributes
std::vector< MaterialPropertyName >	_gamma_names
	Names of gammas for each order parameter.
unsigned int	_num_j
std::vector< const GenericMaterialProperty< Real, is_ad > * >	_prop_gammas
	Values of gammas for each order parameter.

Detailed Description

template<bool is_ad>
class ACGrGrMultiTempl< is_ad >

Definition at line 25 of file ACGrGrMulti.h.

Constructor & Destructor Documentation

ACGrGrMultiTempl()

template<bool is_ad>

ACGrGrMultiTempl< is_ad >::ACGrGrMultiTempl

(

const InputParameters &

parameters

)

Definition at line 29 of file ACGrGrMulti.C.

  : ACGrGrMultiBase<is_ad>(parameters),
    _gamma_names(this->template getParam<std::vector<MaterialPropertyName>>("gamma_names")),
    _num_j(_gamma_names.size()),
    _prop_gammas(_num_j)
{
  // check passed in parameter vectors
  if (_num_j != this->coupledComponents("v"))
    this->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] = &this->template getGenericMaterialProperty<Real, is_ad>(_gamma_names[n]);
}

Member Function Documentation

computedF0du()

template<bool is_ad>

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

protected

Definition at line 113 of file ACGrGrMulti.C.

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

validParams()

template<bool is_ad>

InputParameters ACGrGrMultiTempl< is_ad >::validParams ( )

static

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

_gamma_names

template<bool is_ad>

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

protected

Names of gammas for each order parameter.

Definition at line 34 of file ACGrGrMulti.h.

_num_j

template<bool is_ad>

unsigned int ACGrGrMultiTempl< is_ad >::_num_j

protected

Definition at line 35 of file ACGrGrMulti.h.

_prop_gammas

template<bool is_ad>

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

protected

Values of gammas for each order parameter.

Definition at line 38 of file ACGrGrMulti.h.

---

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

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