CD_MemoryReport.H

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#ifndef CD_MEMORYREPORT_H
#define CD_MEMORYREPORT_H
 
// Std includes
#include <iosfwd>
#include <string>
 
// Chombo includes
#include <REAL.H>
#include <Vector.H>
 
// Our includes
#include <CD_ParticleMemory.H>
#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);
 
void
getResidentSetSize(Real& a_currentRSS, Real& a_peakRSS);
 
void
getMaxMinResidentSetSize(Real& a_maxCurrent, Real& a_minCurrent, Real& a_maxPeak, Real& a_minPeak);
 
std::string
bytesAsMB(const long long a_bytes);
 
std::string
bytesAsMB(const Real a_bytes);
 
void
printMemoryTable(std::ostream& a_out, const std::string& a_indent);
} // namespace MemoryReport
 
#include <CD_NamespaceFooter.H>
 
#endif