geos::MemoryLogging Class Reference

Singleton class keeping the application memory logging settings & features. More...

#include <MemoryInfos.hpp>

Public Member Functions
bool	isUmpireStatsLogOutputEnabled () const
bool	isUmpireStatsCsvOutputEnabled () const
integer	getCurrentCycle () const
void	enableUmpireStatsLogReport (bool enable)
void	enableUmpireStatsCsvReport (bool enable, string_view filename="")
void	setCurrentCycle (integer currentCycle)
	Set the Current Cycle, to identify each CSV entry. More...
void	setCurrentTime (real64 currentTime)
	Set the Current Time, to identify each CSV entry. More...
void	memoryStatsReport () const
	Output the umpire statistics according to settings set by enableUmpireStatsLogReport() and enableUmpireStatsCsvReport(). The statistics are the Umpire total high water mark across all ranks for each umpire allocator.

Static Public Member Functions
static MemoryLogging &	getInstance ()

Detailed Description

Singleton class keeping the application memory logging settings & features.

Todo:

Manage the activation / deactivation of debug LvArray memory logging.

Definition at line 77 of file MemoryInfos.hpp.

Member Function Documentation

enableUmpireStatsCsvReport()

void geos::MemoryLogging::enableUmpireStatsCsvReport	(	bool	enable,
		string_view	filename = ""
	)

Parameters

enable	enable or disable the text log level.
filename	the relative file path to the csv output, including the extention. Can be empty if !enable.

Note

when enabled, start a new csv immediately from zero, filling its header.

See also

memoryStatsReport() for more documentation.

enableUmpireStatsLogReport()

void geos::MemoryLogging::enableUmpireStatsLogReport ( bool  enable )

inline

Parameters

enable

enable or disable the umpire statistics text logging.

See also

memoryStatsReport() for more documentation.

Definition at line 109 of file MemoryInfos.hpp.

getCurrentCycle()

integer geos::MemoryLogging::getCurrentCycle ( ) const

inline

Returns

the current cycle for the next report to output.

Definition at line 102 of file MemoryInfos.hpp.

getInstance()

static MemoryLogging& geos::MemoryLogging::getInstance ( )

static

Returns

the instance reference.

isUmpireStatsCsvOutputEnabled()

bool geos::MemoryLogging::isUmpireStatsCsvOutputEnabled ( ) const

inline

Returns

true if the CSV output is enabled. Refer to X "writeCSV" wrapper documentation for more documentation.

Definition at line 96 of file MemoryInfos.hpp.

isUmpireStatsLogOutputEnabled()

bool geos::MemoryLogging::isUmpireStatsLogOutputEnabled ( ) const

inline

Returns

the text log level.

Definition at line 89 of file MemoryInfos.hpp.

setCurrentCycle()

void geos::MemoryLogging::setCurrentCycle ( integer  currentCycle )

inline

Set the Current Cycle, to identify each CSV entry.

Parameters

currentCycle

The current cycle id. Must be initialized before first memoryStatsReport() to valid values. The entry after the end of the simulation must be 'last_cycle + 1'.

Definition at line 125 of file MemoryInfos.hpp.

setCurrentTime()

void geos::MemoryLogging::setCurrentTime ( real64  currentTime )

inline

Set the Current Time, to identify each CSV entry.

Parameters

currentTime

The current simulated time. Must be initialized before first memoryStatsReport() to valid values.

Definition at line 132 of file MemoryInfos.hpp.

---

The documentation for this class was generated from the following file:

• coreComponents/common/MemoryInfos.hpp