www.mooseframework.org
Classes | Functions
FunctionDT.h File Reference

Go to the source code of this file.

Classes

class  FunctionDT
 

Functions

template<>
InputParameters validParams< FunctionDT > ()
 

Function Documentation

Definition at line 22 of file FunctionDT.C.

23 {
25  params.addRequiredParam<std::vector<Real>>("time_t", "The values of t");
26  params.addRequiredParam<std::vector<Real>>("time_dt", "The values of dt");
27  params.addParam<Real>("growth_factor",
28  std::numeric_limits<Real>::max(),
29  "Maximum ratio of new to previous timestep sizes following a step that "
30  "required the time step to be cut due to a failed solve.");
31  params.addParam<Real>("min_dt", 0, "The minimal dt to take.");
32  params.addParam<bool>("interpolate",
33  true,
34  "Whether or not to interpolate DT between times. "
35  "This is true by default for historical reasons.");
36  params.addClassDescription(
37  "Timestepper whose steps vary over time according to a user-defined fuction");
38 
39  return params;
40 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
InputParameters validParams< TimeStepper >()
Definition: TimeStepper.C:22
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...