OpenPFC  0.1.4
Phase Field Crystal simulation framework
Loading...
Searching...
No Matches
pfc::utils::MemoryUsage Struct Reference

Memory usage statistics for a single MPI rank. More...

#include <memory_reporter.hpp>

Public Member Functions

size_t total_bytes () const noexcept
 Calculate total memory usage.
 

Public Attributes

size_t m_application_bytes = 0
 Memory allocated by user application (bytes)
 
size_t m_fft_bytes = 0
 Memory allocated by FFT library (bytes)
 

Detailed Description

Memory usage statistics for a single MPI rank.

Holds memory allocation data separated into:

  • Application memory: User-defined fields, operators, auxiliary arrays
  • FFT memory: Workspace allocated by HeFFTe for transform operations
Examples
/home/runner/work/OpenPFC/OpenPFC/include/openpfc/utils/memory_reporter.hpp.

Member Function Documentation

◆ total_bytes()

size_t pfc::utils::MemoryUsage::total_bytes ( ) const
inlinenoexcept

Calculate total memory usage.

Returns
Sum of application and FFT memory in bytes
Examples
/home/runner/work/OpenPFC/OpenPFC/include/openpfc/utils/memory_reporter.hpp.

The documentation for this struct was generated from the following file: