MatBodyForceTempl< is_ad, Parent > Class Template Reference

This kernel creates a body force that is modified by a mask defined as a material. More...

#include <MatBodyForce.h>

Inheritance diagram for MatBodyForceTempl< is_ad, Parent >:

Public Member Functions
	MatBodyForceTempl (const InputParameters &parameters)

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual GenericReal< is_ad >	computeQpResidual () override

Protected Attributes
const GenericMaterialProperty< Real, is_ad > &	_property
	usingGenericKernelMembers

Detailed Description

template<bool is_ad, class Parent>
class MatBodyForceTempl< is_ad, Parent >

This kernel creates a body force that is modified by a mask defined as a material.

Common uses of this would be to turn off or change the body force in certain regions of the mesh.

Definition at line 22 of file MatBodyForce.h.

Constructor & Destructor Documentation

MatBodyForceTempl()

template<bool is_ad, class Parent >

MatBodyForceTempl< is_ad, Parent >::MatBodyForceTempl

(

const InputParameters &

parameters

)

Definition at line 27 of file MatBodyForce.C.

  : Parent(parameters),
    _property(this->template getGenericMaterialProperty<Real, is_ad>("material_property"))
{
}

Member Function Documentation

computeQpResidual()

template<bool is_ad, class Parent >

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

overrideprotectedvirtual

Definition at line 35 of file MatBodyForce.C.

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

validParams()

template<bool is_ad, class Parent >

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

static

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

_property

template<bool is_ad, class Parent >

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

protected

Definition at line 32 of file MatBodyForce.h.

usingGenericKernelMembers

template<bool is_ad, class Parent >

MatBodyForceTempl< is_ad, Parent >::usingGenericKernelMembers

protected

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