doxygen/html/CD__MemoryReport_8H_source.html

 /* chombo-discharge

  * Copyright © 2021 SINTEF Energy Research.

  * Please refer to Copyright.txt and LICENSE in the chombo-discharge root directory.

  */


 #ifndef CD_MemoryReport_H

 #define CD_MemoryReport_H


 // Chombo includes

 #include <REAL.H>

 #include <Vector.H>


 // Our includes

 #include <CD_NamespaceHeader.H>


 namespace MemoryReport {


   void

   getMaxMinMemoryUsage();


   void

   getMaxMinMemoryUsage(Real& a_maxPeak, Real& a_minPeak, Real& a_maxUnfreed, Real& a_minUnfreed);


   void

   getMemoryUsage(Vector<Real>& a_peak, Vector<Real>& a_unfreed);

 } // namespace MemoryReport


 #include <CD_NamespaceFooter.H>


 #endif

MemoryReport
Namespace containing utility functions for reporting memory usage in various formats.
Definition: CD_MemoryReport.H:25

MemoryReport::getMemoryUsage
void getMemoryUsage(Vector< Real > &a_peak, Vector< Real > &a_unfreed)
Get peak and unfreed memory usage per rank.
Definition: CD_MemoryReport.cpp:83

MemoryReport::getMaxMinMemoryUsage
void getMaxMinMemoryUsage()
Print the global maximum and minimum memory usage. This includes peak memory and unfreed memory.
Definition: CD_MemoryReport.cpp:23