ACBarrierFunctionTempl< is_ad > Class Template Reference

#include <ACBarrierFunction.h>

Inheritance diagram for ACBarrierFunctionTempl< is_ad >:

Public Member Functions
	ACBarrierFunctionTempl (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const NonlinearVariableName	_uname
const MaterialPropertyName	_gamma_name
const GenericMaterialProperty< Real, is_ad > &	_gamma
const GenericMaterialProperty< Real, is_ad > &	_dmudvar

Detailed Description

template<bool is_ad>
class ACBarrierFunctionTempl< is_ad >

Definition at line 24 of file ACBarrierFunction.h.

Constructor & Destructor Documentation

ACBarrierFunctionTempl()

template<bool is_ad>

ACBarrierFunctionTempl< is_ad >::ACBarrierFunctionTempl

(

const InputParameters &

parameters

)

Definition at line 28 of file ACBarrierFunction.C.

  : ACBarrierFunctionBase<is_ad>(parameters),
    _uname(this->template getParam<NonlinearVariableName>("variable")),
    _gamma_name(this->template getParam<MaterialPropertyName>("gamma")),
    _gamma(this->template getGenericMaterialProperty<Real, is_ad>(_gamma_name)),
    _dmudvar(this->template getGenericMaterialProperty<Real, is_ad>(
        this->derivativePropertyNameFirst("mu", _uname)))
{
}

Member Function Documentation

validParams()

template<bool is_ad>

InputParameters ACBarrierFunctionTempl< is_ad >::validParams ( )

static

Definition at line 18 of file ACBarrierFunction.C.

{
  InputParameters params = ACBarrierFunctionBase<is_ad>::validParams();
  params.addRequiredParam<MaterialPropertyName>(
      "gamma", "The interface profile coefficient to use with the kernel");
  params.addClassDescription("Allen-Cahn kernel used when 'mu' is a function of variables");
  return params;
}

Member Data Documentation

_dmudvar

template<bool is_ad>

const GenericMaterialProperty<Real, is_ad>& ACBarrierFunctionTempl< is_ad >::_dmudvar

protected

Definition at line 35 of file ACBarrierFunction.h.

_gamma

template<bool is_ad>

const GenericMaterialProperty<Real, is_ad>& ACBarrierFunctionTempl< is_ad >::_gamma

protected

Definition at line 34 of file ACBarrierFunction.h.

_gamma_name

template<bool is_ad>

const MaterialPropertyName ACBarrierFunctionTempl< is_ad >::_gamma_name

protected

Definition at line 33 of file ACBarrierFunction.h.

_uname

template<bool is_ad>

const NonlinearVariableName ACBarrierFunctionTempl< is_ad >::_uname

protected

Definition at line 32 of file ACBarrierFunction.h.

---

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

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