geos::MemoryInfos Class Reference

Class to fetch and store memory information for different resource types. More...

#include <MemoryInfos.hpp>

Public Member Functions
	MemoryInfos (umpire::MemoryResourceTraits::resource_type resourceType)
	Constructor for MemoryInfos. More...
size_t	getTotalMemory () const
	Get the total memory available for the resource type. More...
size_t	getAvailableMemory () const
	Get the available memory for the resource type. More...
bool	isPhysicalMemoryHandled () const
	Check if physical memory is handled. More...

Detailed Description

Class to fetch and store memory information for different resource types.

Definition at line 36 of file MemoryInfos.hpp.

Constructor & Destructor Documentation

MemoryInfos()

geos::MemoryInfos::MemoryInfos

(

umpire::MemoryResourceTraits::resource_type

resourceType

)

Constructor for MemoryInfos.

Parameters

resourceType

The type of memory resource.

Member Function Documentation

getAvailableMemory()

size_t geos::MemoryInfos::getAvailableMemory

(

)

const

Get the available memory for the resource type.

Returns

Available memory in bytes.

getTotalMemory()

size_t geos::MemoryInfos::getTotalMemory

(

)

const

Get the total memory available for the resource type.

Returns

Total memory in bytes.

isPhysicalMemoryHandled()

bool geos::MemoryInfos::isPhysicalMemoryHandled

(

)

const

Check if physical memory is handled.

Returns

True if physical memory is handled, false otherwise.

---

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

• coreComponents/common/MemoryInfos.hpp