MemoryUsage

Memory usage statistics for the running simulation.

This postprocessor collects various memory usage metrics:

  • physical memory (most relevant, tied to hardware RAM limitation)

  • virtual memory

  • major page faults (how often disk swap is accessed)

The data can be reduced in parallel as

  • maximum out of all MPI ranks

  • minimum out of all MPI ranks

  • average over all MPI ranks

  • total sum over all MPI ranks (default)

Physical memory statistics are available on Mac and Linux, virtual memory and page fault data is Linux only.

This postprocessor can be executed multiple times per timestep and by default aggregates the per-process peak value of the chosen metric, which then can be output on TIMESTEP_END.

note

Until October 2018 this Postprocessor defaulted to reporting virtual memory. This was changed to the more relavant physical memory to avoid misleading benchmark results to be generated.

Implementation

The /proc/self/status files is checked first. This file only exists on Linux systems and contains several columns with process specific statistics. On mac systems a conditionally compiled code (#ifdef __APPLE__) block uses a mach kernel API function task_info to obtain the memory sizes of the current process.

Input Parameters

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

  • value_typetotalAggregation method to apply to the requested memory metric.

    Default:total

    C++ Type:MooseEnum

    Options:total average max_process min_process

    Description:Aggregation method to apply to the requested memory metric.

  • mem_typevirtual_memoryMemory metric to report.

    Default:virtual_memory

    C++ Type:MooseEnum

    Options:virtual_memory physical_memory page_faults

    Description:Memory metric to report.

  • report_peak_valueTrueIf the postprocessor is executed more than one during a time step, report the aggregated peak value.

    Default:True

    C++ Type:bool

    Options:

    Description:If the postprocessor is executed more than one during a time step, report the aggregated peak value.

Optional Parameters

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Options:

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

  • outputsVector of output names were you would like to restrict the output of variables(s) associated with this object

    C++ Type:std::vector

    Options:

    Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Options:

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • force_preauxFalseForces the GeneralUserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Options:

    Description:Forces the GeneralUserObject to be executed in PREAUX

Advanced Parameters

Input Files