VectorMemoryUsage

Get memory stats for all ranks in the simulation

This vector postprocessor generates multiple output columns with one row per MPI rank

Column nameDescription
hardware_idRanks with a common hardware ID share common RAM (i.e. are located on the same compute node)
total_ramTotal available RAM on the compute node the respective MPI rank is located on.
physical_memPhysical memory the current rank uses.
virtual_memVirtual memory the current rank uses (the amount returned strongly depends on the operating system and does not reflect the physical RAM used by the simualtion).
page_faultsNumber of hard page faults encountered by the MPI rank. This number is only available on Linux systems and indicates the amount of swap activity (indicating low performance due to insufficient available RAM)
node_utilizationIndicates which fraction of the total RAM available on the compute node is occupied by MOOSE processes of the current simulation.

For a Postprocessor that provides min/max/average memory statistics see MemoryUsage.

Example visializations

This VectorPostprocessor can be visualized using the VectorPostprocessorVisualizationAux AuxKernel.

Refined grid

Processor id (using ProcessorIDAux)

Hardware id (i.e. compute node)

Physical memory used by rank

Fraction of RAM used by the current simulation on the compute node

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.

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

    Default:True

    C++ Type:bool

    Options:

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

  • contains_complete_historyFalseSet this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation

    Default:False

    C++ Type:bool

    Options:

    Description:Set this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation

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

References