https://mooseframework.inl.gov
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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:
[legend]

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.

23 : MatBodyForce(parameters) {}
MatBodyForce(const InputParameters &parameters)

Member Function Documentation

◆ validParams()

InputParameters MaskedBodyForce::validParams ( )
static

Definition at line 15 of file MaskedBodyForce.C.

16 {
18  params.addClassDescription("Customization of MatBodForce which uses a material property, scalar, "
19  "and/or postprocessor to provide a source term PDE contribution.");
20  params.renameParam("material_property", "mask", "Material property defining the mask.");
21  return params;
22 }
void renameParam(const std::string &old_name, const std::string &new_name, const std::string &new_docstring)
static InputParameters validParams()
void addClassDescription(const std::string &doc_string)

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