MatBodyForce Class Reference

#include <MatBodyForce.h>

Inheritance diagram for MatBodyForce:

Public Member Functions
	MatBodyForce (const InputParameters &parameters)
virtual void	initialSetup () override

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual Real	computeQpJacobian () override
virtual Real	computeQpOffDiagJacobian (unsigned int jvar) override
virtual GenericReal< is_ad >	computeQpResidual () override

Protected Attributes
const MaterialProperty< Real > &	_dpropertydv
	derivative of the property wrt the kernel's nonlinear variable
std::vector< const MaterialProperty< Real > * >	_dpropertydarg
	Reaction rate derivatives w.r.t. other coupled variables.
const GenericMaterialProperty< Real, is_ad > &	_property
	usingGenericKernelMembers

Detailed Description

Definition at line 40 of file MatBodyForce.h.

Constructor & Destructor Documentation

MatBodyForce()

MatBodyForce::MatBodyForce

(

const InputParameters &

parameters

)

Definition at line 40 of file MatBodyForce.C.

  : MatBodyForceParent(parameters),
    _dpropertydv(getMaterialPropertyDerivative<Real>("material_property", _var.name())),
    _dpropertydarg(_n_args)
{
  // Get derivatives of property wrt coupled variables
  for (unsigned int i = 0; i < _n_args; ++i)
    _dpropertydarg[i] = &getMaterialPropertyDerivative<Real>("material_property", i);
}

Member Function Documentation

computeQpJacobian()

Real MatBodyForce::computeQpJacobian ( )

overrideprotectedvirtual

Definition at line 57 of file MatBodyForce.C.

{
  return _dpropertydv[_qp] * BodyForce::computeQpResidual() * _phi[_j][_qp];
}

computeQpOffDiagJacobian()

Real MatBodyForce::computeQpOffDiagJacobian ( unsigned int  jvar )

overrideprotectedvirtual

Definition at line 63 of file MatBodyForce.C.

{
  const unsigned int cvar = mapJvarToCvar(jvar);
  return (*_dpropertydarg[cvar])[_qp] * BodyForce::computeQpResidual() * _phi[_j][_qp];
}

computeQpResidual()

template<bool is_ad, class Parent >

GenericReal< is_ad > MatBodyForceTempl< is_ad, Parent >::computeQpResidual ( )

overrideprotectedvirtualinherited

Definition at line 35 of file MatBodyForce.C.

{
  return Parent::computeQpResidual() * _property[_qp];
}

initialSetup()

void MatBodyForce::initialSetup ( )

overridevirtual

Definition at line 51 of file MatBodyForce.C.

{
  validateNonlinearCoupling<Real>("material_property");
}

validParams()

template<bool is_ad, class Parent >

InputParameters MatBodyForceTempl< is_ad, Parent >::validParams ( )

staticinherited

Definition at line 17 of file MatBodyForce.C.

{
  InputParameters params = Parent::validParams();
  params.addClassDescription("Kernel that defines a body force modified by a material property");
  params.addRequiredParam<MaterialPropertyName>("material_property",
                                                "Material property defining the body force");
  return params;
}

Member Data Documentation

_dpropertydarg

std::vector<const MaterialProperty<Real> *> MatBodyForce::_dpropertydarg

protected

Reaction rate derivatives w.r.t. other coupled variables.

Definition at line 54 of file MatBodyForce.h.

Referenced by computeQpOffDiagJacobian(), and MatBodyForce().

_dpropertydv

const MaterialProperty<Real>& MatBodyForce::_dpropertydv

protected

derivative of the property wrt the kernel's nonlinear variable

Definition at line 51 of file MatBodyForce.h.

Referenced by computeQpJacobian().

_property

template<bool is_ad, class Parent >

const GenericMaterialProperty<Real, is_ad>& MatBodyForceTempl< is_ad, Parent >::_property

protectedinherited

Definition at line 32 of file MatBodyForce.h.

usingGenericKernelMembers

template<bool is_ad, class Parent >

MatBodyForceTempl< is_ad, Parent >::usingGenericKernelMembers

protectedinherited

Definition at line 34 of file MatBodyForce.h.

---

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

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