www.mooseframework.org
Functions
TimeExtremeValue.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< TimeExtremeValue > ()
 

Function Documentation

Definition at line 22 of file TimeExtremeValue.C.

23 {
24  // Define the min/max enumeration
25  MooseEnum type_options("max=0 min=1 abs_max=2 abs_min=3", "max");
26 
27  // Define the parameters
29  params.addParam<MooseEnum>("value_type",
30  type_options,
31  "Type of extreme value to return."
32  "'max' returns the maximum value."
33  "'min' returns the minimum value."
34  "'abs_max' returns the maximum absolute value."
35  "'abs_min' returns the minimum absolute value.");
36  params.addRequiredParam<PostprocessorName>(
37  "postprocessor", "The name of the postprocessor used for reporting time extreme values");
38  params.addClassDescription(
39  "A postprocessor for reporting the extreme value of another postprocessor over time.");
40 
41  return params;
42 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< GeneralPostprocessor >()
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...
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:37
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...