Namespace containing utility functions for reporting memory usage in various formats. More...

Functions
void	getMaxMinMemoryUsage ()
	Print the global maximum and minimum memory usage. This includes peak memory and unfreed memory.

void	getMaxMinMemoryUsage (Real &a_maxPeak, Real &a_minPeak, Real &a_maxUnfreed, Real &a_minUnfreed)
	Print the global maximum and minimum memory usage. This includes peak memory and unfreed memory. More...

void	getMemoryUsage (Vector< Real > &a_peak, Vector< Real > &a_unfreed)
	Get peak and unfreed memory usage per rank. More...

Detailed Description

Namespace containing utility functions for reporting memory usage in various formats.

Function Documentation

void MemoryReport::getMaxMinMemoryUsage	(	Real &	a_maxPeak,
		Real &	a_minPeak,
		Real &	a_maxUnfreed,
		Real &	a_minUnfreed
	)

Print the global maximum and minimum memory usage. This includes peak memory and unfreed memory.

Parameters

[out]	a_maxPeak	Maximum peak memory (maximized over ranks)
[out]	a_minPeak	Minimum peak memory (minimuzed over ranks)
[out]	a_maxUnfreed	Maximum unfreed memory (maximized over ranks)
[out]	a_minUnfreed	Minimum unfreed memory (minimized over ranks)

void MemoryReport::getMemoryUsage	(	Vector< Real > &	a_peak,
		Vector< Real > &	a_unfreed
	)

Get peak and unfreed memory usage per rank.

If using MPI, this will do an Allgather so that every rank can see usage.

Parameters

[out]	a_peak	Peak memory usage
[in]	a_unfreed	Unfreed memory usage