Tecplot.C File Reference

Go to the source code of this file.


InputParameters validParams< Tecplot > ()

Function Documentation

InputParameters validParams< Tecplot > ( )

Definition at line 25 of file Tecplot.C.

26 {
27  // Get the base class parameters
30  // Add binary toggle
31  params.addParam<bool>("binary", false, "Set Tecplot files to output in binary format");
32  params.addParamNamesToGroup("binary", "Advanced");
34  // Add optional parameter to turn on appending to ASCII files
35  params.addParam<bool>(
36  "ascii_append",
37  false,
38  "If true, append to an existing ASCII file rather than creating a new file each time");
40  // Add description for the Tecplot class
41  params.addClassDescription("Object for outputting data in the Tecplot format");
43  // Return the InputParameters
44  return params;
45 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< OversampleOutput >()
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...
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...