MemoryUtils.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "Moose.h"
#include "MooseEnum.h"

namespace MemoryUtils
{

std::string getMPIProcessorName();

struct Stats
{
  std::size_t _physical_memory;
  std::size_t _virtual_memory;
  std::size_t _page_faults;
};

enum class MemUnits
{
  Bytes,
  Kibibytes,
  Mebibytes,
  Gibibytes = 3,
  Kilobytes,
  Megabytes,
  Gigabytes = 6,
};

MooseEnum getMemUnitsEnum();

std::size_t getTotalRAM();

bool getMemoryStats(Stats & stats);

std::size_t convertBytes(std::size_t bytes, MemUnits unit);

} // namespace MemoryUtils