MemoryUsageReporter Class Reference

Mix-in class for querying memory metrics used by MemoryUsage and VectorMemoryUsage. More...

#include <MemoryUsageReporter.h>

Inheritance diagram for MemoryUsageReporter:

Public Member Functions
	MemoryUsageReporter (const MooseObject *moose_object)

Protected Attributes
const Parallel::Communicator &	_mur_communicator
	communicator for this object
processor_id_type	_my_rank
	this objects rank
processor_id_type	_nrank
	number of ranks in the object's communicator
const std::vector< unsigned int > &	_hardware_id
	hardware IDs for each MPI rank (valid on rank zero only)
unsigned long long	_memory_total
	total RAM installed in the local node
std::vector< unsigned long long >	_hardware_memory_total
	total RAM for each hardware ID (node) (valid on rank zero only)

Private Member Functions
void	sharedMemoryRanksBySplitCommunicator ()
	Use a share memory type communicator split (MPI3)
void	sharedMemoryRanksByProcessorname ()
	Identify hardware by MPI processor name.

Detailed Description

Mix-in class for querying memory metrics used by MemoryUsage and VectorMemoryUsage.

Definition at line 19 of file MemoryUsageReporter.h.

Constructor & Destructor Documentation

MemoryUsageReporter()

MemoryUsageReporter::MemoryUsageReporter

(

const MooseObject *

moose_object

)

Definition at line 14 of file MemoryUsageReporter.C.

  : _mur_communicator(moose_object->comm()),
    _my_rank(_mur_communicator.rank()),
    _nrank(_mur_communicator.size()),
    _hardware_id(moose_object->getMooseApp().rankMap().rankHardwareIds())
{
  // get total available ram
  _memory_total = MemoryUtils::getTotalRAM();
  if (!_memory_total)
    mooseWarning("Unable to query hardware memory size in ", moose_object->name());
 
  // gather all per node memory to processor zero
  std::vector<unsigned long long> memory_totals(_nrank);
  _mur_communicator.gather(0, _memory_total, memory_totals);
 
  // validate and store per node memory
  if (_my_rank == 0)
  {
    for (std::size_t i = 0; i < _nrank; ++i)
    {
      auto id = _hardware_id[i];
      if (id == _hardware_memory_total.size())
      {
        _hardware_memory_total.resize(id + 1);
        _hardware_memory_total[id] = memory_totals[i];
      }
      else if (_hardware_memory_total[id] != memory_totals[i])
        mooseWarning("Inconsistent total memory reported by ranks on the same hardware node in ",
                     moose_object->name());
    }
  }
}

Member Function Documentation

sharedMemoryRanksByProcessorname()

void MemoryUsageReporter::sharedMemoryRanksByProcessorname ( )

private

Identify hardware by MPI processor name.

sharedMemoryRanksBySplitCommunicator()

void MemoryUsageReporter::sharedMemoryRanksBySplitCommunicator ( )

private

Use a share memory type communicator split (MPI3)

Member Data Documentation

_hardware_id

const std::vector<unsigned int>& MemoryUsageReporter::_hardware_id

protected

hardware IDs for each MPI rank (valid on rank zero only)

Definition at line 35 of file MemoryUsageReporter.h.

Referenced by VectorMemoryUsage::finalize(), MemoryUsageReporter(), and VectorMemoryUsage::VectorMemoryUsage().

_hardware_memory_total

std::vector<unsigned long long> MemoryUsageReporter::_hardware_memory_total

protected

total RAM for each hardware ID (node) (valid on rank zero only)

Definition at line 41 of file MemoryUsageReporter.h.

Referenced by VectorMemoryUsage::finalize(), MemoryUsageReporter(), and VectorMemoryUsage::VectorMemoryUsage().

_memory_total

unsigned long long MemoryUsageReporter::_memory_total

protected

total RAM installed in the local node

Definition at line 38 of file MemoryUsageReporter.h.

Referenced by MemoryUsageReporter().

_mur_communicator

const Parallel::Communicator& MemoryUsageReporter::_mur_communicator

protected

communicator for this object

Definition at line 26 of file MemoryUsageReporter.h.

Referenced by MemoryUsageReporter().

_my_rank

processor_id_type MemoryUsageReporter::_my_rank

protected

this objects rank

Definition at line 29 of file MemoryUsageReporter.h.

Referenced by VectorMemoryUsage::execute(), VectorMemoryUsage::finalize(), MemoryUsageReporter(), and VectorMemoryUsage::VectorMemoryUsage().

_nrank

processor_id_type MemoryUsageReporter::_nrank

protected

number of ranks in the object's communicator

Definition at line 32 of file MemoryUsageReporter.h.

Referenced by VectorMemoryUsage::finalize(), MemoryUsageReporter(), and VectorMemoryUsage::VectorMemoryUsage().

---

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

• include/postprocessors/MemoryUsageReporter.h
• src/postprocessors/MemoryUsageReporter.C