amrex::FabInfo Struct Reference

Construction hints passed to FabFactory::create. More...

#include <AMReX_FabFactory.H>

Public Member Functions
FabInfo &	SetAlloc (bool a) noexcept
	Set the alloc flag; returns *this for chaining.
FabInfo &	SetShared (bool s) noexcept
	Set the shared flag; returns *this for chaining.
FabInfo &	SetArena (Arena *ar) noexcept
	Set the arena pointer; returns *this for chaining.

Public Attributes
bool	alloc = true
	Whether the factory should allocate FAB storage.
bool	shared = false
	Whether storage is managed as team-shared memory.
Arena *	arena = nullptr
	Arena for storage allocation; null selects the default.

Detailed Description

Construction hints passed to FabFactory::create.

Member Function Documentation

SetAlloc()

FabInfo & amrex::FabInfo::SetAlloc ( bool  a )

inlinenoexcept

Set the alloc flag; returns *this for chaining.

SetArena()

FabInfo & amrex::FabInfo::SetArena ( Arena *  ar )

inlinenoexcept

Set the arena pointer; returns *this for chaining.

SetShared()

FabInfo & amrex::FabInfo::SetShared ( bool  s )

inlinenoexcept

Set the shared flag; returns *this for chaining.

Member Data Documentation

alloc

bool amrex::FabInfo::alloc = true

Whether the factory should allocate FAB storage.

arena

Arena* amrex::FabInfo::arena = nullptr

Arena for storage allocation; null selects the default.

shared

bool amrex::FabInfo::shared = false

Whether storage is managed as team-shared memory.

---

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

• /home/runner/work/amrex/amrex/Src/Base/AMReX_FabFactory.H