AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
axom::Allocator Struct Reference

Wrapper type representing an Umpire allocator ID. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/core/memory_management.hpp>

Public Member Functions

 Allocator (int alloc_id=axom::getDefaultAllocatorID())
 
int getID () const
 Returns the allocator ID. More...
 
MemorySpace getSpace () const
 Returns the MemorySpace type for the given allocator. More...
 

Detailed Description

Wrapper type representing an Umpire allocator ID.

This type is intended for use in function and constructor arguments, in order to avoid ambiguities in overload resolution.

Constructor & Destructor Documentation

◆ Allocator()

axom::Allocator::Allocator ( int  alloc_id = axom::getDefaultAllocatorID())
inlineexplicit

Member Function Documentation

◆ getID()

int axom::Allocator::getID ( ) const
inline

Returns the allocator ID.

◆ getSpace()

MemorySpace axom::Allocator::getSpace ( ) const
inline

Returns the MemorySpace type for the given allocator.

References axom::detail::getAllocatorSpace().


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