MaskedBodyForce Class Reference

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

#include <MaskedBodyForce.h>

Inheritance diagram for MaskedBodyForce:

Public Member Functions
	MaskedBodyForce (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
std::vector< const MaterialProperty< Real > * >	_dpropertydarg
const GenericMaterialProperty< Real, is_ad > &	_property
	usingGenericKernelMembers

Detailed Description

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 19 of file MaskedBodyForce.h.

Constructor & Destructor Documentation

MaskedBodyForce()

MaskedBodyForce::MaskedBodyForce ( const InputParameters &  parameters )

inline

Definition at line 23 of file MaskedBodyForce.h.

: MatBodyForce(parameters) {}

Member Function Documentation

validParams()

InputParameters MaskedBodyForce::validParams ( )

static

Definition at line 15 of file MaskedBodyForce.C.

{
  InputParameters params = MatBodyForce::validParams();
  params.addClassDescription("Customization of MatBodForce which uses a material property, scalar, "
                             "and/or postprocessor to provide a source term PDE contribution.");
  params.renameParam("material_property", "mask", "Material property defining the mask.");
  return params;
}

---

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

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