www.mooseframework.org
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)
 

Protected Member Functions

virtual Real computeQpResidual ()
 

Protected Attributes

const MaterialProperty< Real > & _mask
 

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

Constructor & Destructor Documentation

MaskedBodyForce::MaskedBodyForce ( const InputParameters &  parameters)

Definition at line 20 of file MaskedBodyForce.C.

21  : BodyForce(parameters), _mask(getMaterialProperty<Real>("mask"))
22 {
23 }
const MaterialProperty< Real > & _mask

Member Function Documentation

Real MaskedBodyForce::computeQpResidual ( )
protectedvirtual

Definition at line 26 of file MaskedBodyForce.C.

27 {
28  return BodyForce::computeQpResidual() * _mask[_qp];
29 }
const MaterialProperty< Real > & _mask

Member Data Documentation

const MaterialProperty<Real>& MaskedBodyForce::_mask
protected

Definition at line 33 of file MaskedBodyForce.h.

Referenced by computeQpResidual().


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