Block-Structured AMR Software Framework
Loading...
Searching...
No Matches
amrex::MFInfo Struct Reference

FabArray memory allocation information. More...

#include <AMReX_FabArray.H>

Public Member Functions

MFInfo & SetAlloc (bool a) noexcept
 Control whether FAB storage is allocated when the FabArray is defined.
MFInfo & SetAllocSingleChunk (bool a) noexcept
 Control whether eligible FABs use one contiguous allocation.
MFInfo & SetArena (Arena *ar) noexcept
 Select the Arena used for FAB storage.
MFInfo & SetTag () noexcept
 Terminate a variadic SetTag() call.
MFInfo & SetTag (const char *t) noexcept
 Append memory-usage tag t.
MFInfo & SetTag (const std::string &t) noexcept
 Append memory-usage tag t.
template<typename T, typename... Ts>
MFInfo & SetTag (T &&t, Ts &&... ts) noexcept
 Append one or more memory-usage tags.

Public Attributes

bool alloc = true
bool alloc_single_chunk = FabArrayBase::getAllocSingleChunk()
Arena * arena = nullptr
Vector< std::string > tags

Detailed Description

FabArray memory allocation information.

Member Function Documentation

◆ SetAlloc()

MFInfo & amrex::MFInfo::SetAlloc ( bool a)
inlinenoexcept

Control whether FAB storage is allocated when the FabArray is defined.

◆ SetAllocSingleChunk()

MFInfo & amrex::MFInfo::SetAllocSingleChunk ( bool a)
inlinenoexcept

Control whether eligible FABs use one contiguous allocation.

◆ SetArena()

MFInfo & amrex::MFInfo::SetArena ( Arena * ar)
inlinenoexcept

Select the Arena used for FAB storage.

◆ SetTag() [1/4]

MFInfo & amrex::MFInfo::SetTag ( )
inlinenoexcept

Terminate a variadic SetTag() call.

◆ SetTag() [2/4]

MFInfo & amrex::MFInfo::SetTag ( const char * t)
inlinenoexcept

Append memory-usage tag t.

◆ SetTag() [3/4]

MFInfo & amrex::MFInfo::SetTag ( const std::string & t)
inlinenoexcept

Append memory-usage tag t.

◆ SetTag() [4/4]

template<typename T, typename... Ts>
MFInfo & amrex::MFInfo::SetTag ( T && t,
Ts &&... ts )
inlinenoexcept

Append one or more memory-usage tags.

Member Data Documentation

◆ alloc

bool amrex::MFInfo::alloc = true

◆ alloc_single_chunk

bool amrex::MFInfo::alloc_single_chunk = FabArrayBase::getAllocSingleChunk()

◆ arena

Arena* amrex::MFInfo::arena = nullptr

◆ tags

Vector<std::string> amrex::MFInfo::tags

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