Classes | Functions
BodyForce.h File Reference

Go to the source code of this file.


class  BodyForce
 This kernel implements a generic functional body force term: $ - c f $. More...


InputParameters validParams< BodyForce > ()

Function Documentation

Definition at line 22 of file BodyForce.C.

Referenced by validParams< UserForcingFunction >().

23 {
25  params.addClassDescription("Demonstrates the multiple ways that scalar values can be introduced "
26  "into kernels, e.g. (controllable) constants, functions, and "
27  "postprocessors. Implements the weak form $(\\psi_i, -f)$.");
28  params.addParam<Real>("value", 1.0, "Coefficent to multiply by the body force term");
29  params.addParam<FunctionName>("function", "1", "A function that describes the body force");
30  params.addParam<PostprocessorName>(
31  "postprocessor", 1, "A postprocessor whose value is multiplied by the body force");
32  params.declareControllable("value");
33  return params;
34 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void declareControllable(const std::string &name)
Declare the given parameters as controllable.
InputParameters validParams< Kernel >()
Definition: Kernel.C:30
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...