SinNeumannBC.C File Reference

Go to the source code of this file.


InputParameters validParams< SinNeumannBC > ()

Function Documentation

Definition at line 19 of file SinNeumannBC.C.

20 {
22  params.addParam<Real>("initial", 0.0, "The initial value of the gradient on the boundary");
23  params.addParam<Real>("final", 0.0, "The final value of the gradient on the boundary");
24  params.addParam<Real>("duration", 0.0, "The duration of the ramp");
25  params.addClassDescription("Imposes a time-varying flux boundary condition $\\frac{\\partial "
26  "u}{\\partial n}=g(t)$, where $g(t)$ "
27  "varies from an given initial value at time $t=0$ to a given final "
28  "value over a specified duration.");
29  return params;
30 }
InputParameters validParams< IntegratedBC >()
Definition: IntegratedBC.C:28
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
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...