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

Go to the source code of this file.

Classes

class  MemoryUsage
 Output maximum, average, or total process memory usage. More...
 

Functions

template<>
InputParameters validParams< MemoryUsage > ()
 

Function Documentation

Definition at line 29 of file MemoryUsage.C.

30 {
32  params.addClassDescription("Memory usage statistics for the running simulation.");
33  MooseEnum mem_type("virtual_memory physical_memory page_faults", "virtual_memory");
34  params.addParam<MooseEnum>("mem_type", mem_type, "Memory metric to report.");
35  MooseEnum value_type("total average max_process min_processs", "total");
36  params.addParam<MooseEnum>(
37  "value_type", value_type, "Aggregation method to apply to the requested memory metric.");
38  params.addParam<bool>("report_peak_value",
39  true,
40  "If the postprocessor is executed more than one "
41  "during a time step, report the aggregated peak "
42  "value.");
43  return params;
44 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< GeneralPostprocessor >()
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...