- 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
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
Description:Aggregation method to apply to the requested memory metric.
- mem_typevirtual_memoryMemory metric to report.
Default:virtual_memory
C++ Type:MooseEnum
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
Description:If the postprocessor is executed more than one during a time step, report the aggregated peak value.
MemoryUsage
Memory usage statistics for the running simulation.
This postprocessor collects various memory usage metrics:
* physical memory (most relevant) * virtual memory * 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
Physical memory statistics are available on Mac and Linux, virtual memory and page fault data is Linux only.
This postporcessor can be executed multiple times per timestep and by default aggregates the per-process peak value of the chosen metric, which then cam be output on TIMESTEP_END.
Input Parameters
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
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
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
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
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
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
Description:Forces the GeneralUserObject to be executed in PREAUX