www.mooseframework.org
Functions
CoupledForce.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< CoupledForce > ()
 

Function Documentation

Definition at line 19 of file CoupledForce.C.

20 {
22 
23  params.addClassDescription("Implements a source term proportional to the value of a coupled "
24  "variable. Weak form: $(\\psi_i, -\\sigma v)$.");
25  params.addRequiredCoupledVar("v", "The coupled variable which provides the force");
26  params.addParam<Real>(
27  "coef", 1.0, "Coefficent ($\\sigma$) multiplier for the coupled force term.");
28 
29  return params;
30 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
This method adds a coupled variable name pair.
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...