Classes | Functions
FileOutput.h File Reference

Go to the source code of this file.


class  FileOutput
 An outputter with filename support. More...


InputParameters validParams< FileOutput > ()

Function Documentation

Definition at line 28 of file FileOutput.C.

Referenced by validParams< AdvancedOutput >(), validParams< Checkpoint >(), validParams< DOFMapOutput >(), and validParams< SolutionHistory >().

29 {
30  // Create InputParameters object for this stand-alone object
32  params.addParam<std::string>("file_base",
33  "The desired solution output name without an extension");
34  params.addParam<bool>(
35  "append_date", false, "When true the date and time are appended to the output filename.");
36  params.addParam<std::string>("append_date_format",
37  "The format of the date/time to append, if not given UTC format "
38  "used (see http://www.cplusplus.com/reference/ctime/strftime).");
39  // Add the padding option and list it as 'Advanced'
40  params.addParam<unsigned int>(
41  "padding", 4, "The number of for extension suffix (e.g., out.e-s002)");
42  params.addParam<std::vector<std::string>>("output_if_base_contains",
43  std::vector<std::string>(),
44  "If this is supplied then output will only be done in "
45  "the case that the output base contains one of these "
46  "strings. This is helpful in outputting only a subset "
47  "of outputs when using MultiApps.");
48  params.addParamNamesToGroup("padding output_if_base_contains", "Advanced");
50  return params;
51 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< PetscOutput >()
Definition: PetscOutput.C:25
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...