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

Go to the source code of this file.

Classes

class  OutputInterface
 A class to provide an common interface to objects requiring "outputs" option. More...
 

Functions

template<typename T >
InputParameters validParams ()
 
template<>
InputParameters validParams< OutputInterface > ()
 

Function Documentation

template<typename T >
InputParameters validParams ( )

Definition at line 24 of file OutputInterface.C.

Referenced by validParams< AddAuxVariableAction >(), validParams< AddVariableAction >(), validParams< Indicator >(), validParams< Marker >(), validParams< Material >(), validParams< Postprocessor >(), and validParams< VectorPostprocessor >().

25 {
27  params.addParam<std::vector<OutputName>>("outputs",
28  "Vector of output names were you would like "
29  "to restrict the output of variables(s) "
30  "associated with this object");
31 
32  params.addParamNamesToGroup("outputs", "Advanced");
33  std::set<std::string> reserved = {"all", "none"};
34  params.setReservedValues("outputs", reserved);
35 
36  return params;
37 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters emptyInputParameters()
void setReservedValues(const std::string &name, const std::set< std::string > &reserved)
Provide a set of reserved values for a parameter.
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...
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)
This method takes a space delimited list of parameter names and adds them to the specified group name...