www.mooseframework.org
Functions
Predictor.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< Predictor > ()
 

Function Documentation

Definition at line 24 of file Predictor.C.

Referenced by validParams< AdamsPredictor >(), and validParams< SimplePredictor >().

25 {
27  params.addRequiredParam<Real>("scale",
28  "The scale factor for the predictor (can range from 0 to 1)");
29  params.addParam<std::vector<Real>>(
30  "skip_times", "Skip the predictor if the current solution time is in this list of times");
31  params.addParam<std::vector<Real>>(
32  "skip_times_old",
33  "Skip the predictor if the previous solution time is in this list of times");
34 
35  params.registerBase("Predictor");
36 
37  return params;
38 }
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...
void registerBase(const std::string &value)
This method must be called from every base "Moose System" to create linkage with the Action System...
InputParameters validParams< MooseObject >()
Definition: MooseObject.C:22
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...