MaterialPropertyValueTempl< is_ad > Class Template Reference

#include <MaterialPropertyValue.h>

Inheritance diagram for MaterialPropertyValueTempl< is_ad >:

Public Member Functions
	MaterialPropertyValueTempl (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual GenericReal< is_ad >	precomputeQpResidual ()
virtual Real	precomputeQpJacobian ()
template<>
Real	precomputeQpResidual ()
template<>
ADReal	precomputeQpResidual ()
template<>
Real	precomputeQpJacobian ()
template<>
Real	precomputeQpJacobian ()

Protected Attributes
const Real	_kernel_sign
const GenericMaterialProperty< Real, is_ad > &	_prop

Detailed Description

template<bool is_ad>
class MaterialPropertyValueTempl< is_ad >

Definition at line 20 of file MaterialPropertyValue.h.

Constructor & Destructor Documentation

MaterialPropertyValueTempl()

template<bool is_ad>

MaterialPropertyValueTempl< is_ad >::MaterialPropertyValueTempl

(

const InputParameters &

parameters

)

Definition at line 30 of file MaterialPropertyValue.C.

  : KernelValueParent<is_ad>(parameters),
    _kernel_sign(this->template getParam<bool>("positive") ? 1.0 : -1.0),
    _prop(this->template getGenericMaterialProperty<Real, is_ad>("prop_name"))
{
}

Member Function Documentation

precomputeQpJacobian() [1/3]

template<bool is_ad>

virtual Real MaterialPropertyValueTempl< is_ad >::precomputeQpJacobian ( )

protectedvirtual

precomputeQpJacobian() [2/3]

template<>

Real MaterialPropertyValueTempl< false >::precomputeQpJacobian ( )

protected

Definition at line 53 of file MaterialPropertyValue.C.

{
  return -_kernel_sign * _phi[_j][_qp];
}

precomputeQpJacobian() [3/3]

template<>

Real MaterialPropertyValueTempl< true >::precomputeQpJacobian ( )

protected

Definition at line 60 of file MaterialPropertyValue.C.

{
  mooseError("This should never get called");
}

precomputeQpResidual() [1/3]

template<bool is_ad>

virtual GenericReal<is_ad> MaterialPropertyValueTempl< is_ad >::precomputeQpResidual ( )

protectedvirtual

precomputeQpResidual() [2/3]

template<>

Real MaterialPropertyValueTempl< false >::precomputeQpResidual ( )

protected

Definition at line 39 of file MaterialPropertyValue.C.

{
  return _kernel_sign * (_prop[_qp] - _u[_qp]);
}

precomputeQpResidual() [3/3]

template<>

ADReal MaterialPropertyValueTempl< true >::precomputeQpResidual ( )

protected

Definition at line 46 of file MaterialPropertyValue.C.

{
  return _kernel_sign * (_prop[_qp] - _u[_qp]);
}

validParams()

template<bool is_ad>

InputParameters MaterialPropertyValueTempl< is_ad >::validParams ( )

static

Definition at line 17 of file MaterialPropertyValue.C.

{
  InputParameters params = KernelValueParent<is_ad>::validParams();
  params.addClassDescription(
      "Residual term (u - prop) to set variable u equal to a given material property prop");
  params.addRequiredParam<MaterialPropertyName>(
      "prop_name", "Name of material property to be used in the kernel");
  params.addParam<bool>(
      "positive", true, "If the kernel is positive, this is true, if negative, it is false");
  return params;
}

Member Data Documentation

_kernel_sign

template<bool is_ad>

const Real MaterialPropertyValueTempl< is_ad >::_kernel_sign

protected

Definition at line 31 of file MaterialPropertyValue.h.

_prop

template<bool is_ad>

const GenericMaterialProperty<Real, is_ad>& MaterialPropertyValueTempl< is_ad >::_prop

protected

Definition at line 32 of file MaterialPropertyValue.h.

---

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

• include/kernels/MaterialPropertyValue.h
• src/kernels/MaterialPropertyValue.C