Fab Data

Box-based data containers representing values on a single amrex::Box. More...

Classes
class	amrex::CellData< T >
	Lightweight accessor for data associated with a single cell. More...
class	amrex::ArrayND< T, N, last_dim_component >
	A multidimensional array accessor. More...
class	amrex::PolymorphicArray4< T >
	Array4 subclass that provides uniform (i,j,k,n) access for both AoS and SoA data. More...
class	amrex::BaseFab< T >
	A FortranArrayBox(FAB)-like object. More...
struct	amrex::FabInfo
	Construction hints passed to FabFactory::create. More...
class	amrex::FabFactory< FAB >
	Abstract factory interface for creating, aliasing, and destroying FAB objects. More...
class	amrex::DefaultFabFactory< FAB >
	Default FabFactory that calls new / delete on the FAB type directly. More...
class	amrex::FArrayBox
	A Fortran Array of REALs. More...
class	amrex::IArrayBox
	A Fortran Array of ints. More...

Typedefs
template<typename T >
using	amrex::Array4 = ArrayND< T, 4, true >
	Convenient alias for a 4D ArrayND with three spatial dimensions plus a component dimension.

Enumerations
enum class	amrex::FabType : int {   amrex::FabType::covered = -1 , amrex::FabType::regular = 0 , amrex::FabType::singlevalued = 1 , amrex::FabType::multivalued = 2 ,   amrex::FabType::undefined = 100 }
	Aggregate classification of a FAB or subregion used by embedded-boundary data. More...

Functions
template<class T >
__host__ __device__ Dim3	amrex::lbound (Array4< T > const &a) noexcept
	Return the inclusive lower bounds of an Array4 in Dim3 form.
template<class T >
__host__ __device__ Dim3	amrex::ubound (Array4< T > const &a) noexcept
	Return the inclusive upper bounds of an Array4 in Dim3 form.
template<class T >
__host__ __device__ Dim3	amrex::length (Array4< T > const &a) noexcept
	Return the spatial extents of an Array4 in Dim3 form.
template<typename T , int N, bool C>
std::ostream &	amrex::operator<< (std::ostream &os, const ArrayND< T, N, C > &a)
	Stream an ArrayND as its index bounds.
template<typename T >
PolymorphicArray4< T >	amrex::makePolymorphic (Array4< T > const &a)

Detailed Description

Box-based data containers representing values on a single amrex::Box.

Central types include:

• amrex::Array4 and amrex::ArrayND
• amrex::BaseFab
• amrex::FArrayBox
• amrex::IArrayBox

Typedef Documentation

Array4

template<typename T >

using amrex::Array4 = typedef ArrayND<T,4, true>

Convenient alias for a 4D ArrayND with three spatial dimensions plus a component dimension.

Enumeration Type Documentation

FabType

enum class amrex::FabType : int

strong

Aggregate classification of a FAB or subregion used by embedded-boundary data.

Enumerator
covered	Every cell in the region is covered.
regular	Every cell in the region is regular.
singlevalued	No multivalued cells; not entirely regular or covered.
multivalued	The region contains at least one multivalued cell.
undefined	The classification has not been determined.

Function Documentation

lbound()

template<class T >

__host__ __device__ Dim3 amrex::lbound ( Array4< T > const &  a )

inlinenoexcept

Return the inclusive lower bounds of an Array4 in Dim3 form.

Parameters

a

Array4

Returns

Inclusive lower bounds.

length()

template<class T >

__host__ __device__ Dim3 amrex::length ( Array4< T > const &  a )

inlinenoexcept

Return the spatial extents of an Array4 in Dim3 form.

Parameters

a

Array4

Returns

Lengths

makePolymorphic()

template<typename T >

PolymorphicArray4< T > amrex::makePolymorphic

(

Array4< T > const &

a

)

Wrap an Array4 in a PolymorphicArray4 for uniform AoS/SoA (i,j,k,n) access.

operator<<()

template<typename T , int N, bool C>

std::ostream & amrex::operator<<	(	std::ostream &	os,
		const ArrayND< T, N, C > &	a
	)

Stream an ArrayND as its index bounds.

Prints a compact representation of the index bounds, e.g. ((lo...), (hi...)) with hi reported as inclusive (i.e., end-1).

Parameters

os	Output stream.
a	ArrayND to print.

Returns

os.

ubound()

template<class T >

__host__ __device__ Dim3 amrex::ubound ( Array4< T > const &  a )

inlinenoexcept

Return the inclusive upper bounds of an Array4 in Dim3 form.

Parameters

a

Array4

Returns

Inclusive upper bounds.