Block-Structured AMR Software Framework
amrex::BArena Class Reference

A Concrete Class for Dynamic Memory Management This is the simplest dynamic memory management class derived from Arena. Makes calls to std::malloc and std::free. More...

#include <AMReX_BArena.H>

Inheritance diagram for amrex::BArena:
amrex::Arena

Public Member Functions

void * alloc (std::size_t sz) final
 Allocates a dynamic memory arena of size sz. Returns a pointer to this memory. More...
 
void free (void *pt) final
 Deletes the arena pointed to by pt. More...
 
bool isDeviceAccessible () const final
 
bool isHostAccessible () const final
 
bool isManaged () const final
 
bool isDevice () const final
 
bool isPinned () const final
 
- Public Member Functions inherited from amrex::Arena
virtual ~Arena ()=default
 
 Arena () noexcept=default
 
 Arena (const Arena &rhs)=delete
 
 Arena (Arena &&rhs)=delete
 
Arenaoperator= (const Arena &rhs)=delete
 
Arenaoperator= (Arena &&rhs)=delete
 
virtual std::pair< void *, std::size_t > alloc_in_place (void *, std::size_t, std::size_t szmax)
 
virtual void * shrink_in_place (void *, std::size_t sz)
 
virtual std::size_t freeUnused ()
 Free unused memory back to the system. Return value is the amount memory freed. More...
 
virtual bool hasFreeDeviceMemory (std::size_t sz)
 Does the device have enough free memory for allocating this much memory? For CPU builds, this always return true. This is not a const function because it may attempt to release memory back to the system. More...
 
void registerForProfiling (const std::string &memory_name)
 Add this Arena to the list of Arenas that are profiled by TinyProfiler. More...
 
void deregisterFromProfiling ()
 Remove this Arena from the list of Arenas that are profiled by TinyProfiler. This is equivalent to destructing and re-constructing the Arena. More...
 
virtual bool isStreamOrderedArena () const
 Is this GPU stream ordered memory allocator? More...
 
const ArenaInfoarenaInfo () const
 Return the ArenaInfo object for querying. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from amrex::Arena
static std::size_t align (std::size_t sz)
 Given a minimum required arena size of sz bytes, this returns the next largest arena size that will align to align_size bytes. More...
 
static void Initialize ()
 
static void PrintUsage ()
 
static void PrintUsageToFiles (std::string const &filename, std::string const &message)
 
static void Finalize ()
 
- Static Public Attributes inherited from amrex::Arena
static const std::size_t align_size = 16
 
- Protected Member Functions inherited from amrex::Arena
virtual std::size_t freeUnused_protected ()
 
void * allocate_system (std::size_t nbytes)
 
void deallocate_system (void *p, std::size_t nbytes)
 
- Protected Attributes inherited from amrex::Arena
ArenaInfo arena_info
 
struct amrex::Arena::ArenaProfiler m_profiler
 

Detailed Description

A Concrete Class for Dynamic Memory Management This is the simplest dynamic memory management class derived from Arena. Makes calls to std::malloc and std::free.

Member Function Documentation

◆ alloc()

void * amrex::BArena::alloc ( std::size_t  sz)
finalvirtual

Allocates a dynamic memory arena of size sz. Returns a pointer to this memory.

Implements amrex::Arena.

◆ free()

void amrex::BArena::free ( void *  pt)
finalvirtual

Deletes the arena pointed to by pt.

Implements amrex::Arena.

◆ isDevice()

bool amrex::BArena::isDevice ( ) const
finalvirtual

Reimplemented from amrex::Arena.

◆ isDeviceAccessible()

bool amrex::BArena::isDeviceAccessible ( ) const
finalvirtual

Reimplemented from amrex::Arena.

◆ isHostAccessible()

bool amrex::BArena::isHostAccessible ( ) const
finalvirtual

Reimplemented from amrex::Arena.

◆ isManaged()

bool amrex::BArena::isManaged ( ) const
finalvirtual

Reimplemented from amrex::Arena.

◆ isPinned()

bool amrex::BArena::isPinned ( ) const
finalvirtual

Reimplemented from amrex::Arena.


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