Block-Structured AMR Software Framework
Loading...
Searching...
No Matches

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::BaseFab< T >
 A FortranArrayBox(FAB)-like object. 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.
 

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.
 

Detailed Description

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

Central types include:

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.

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
aArray4
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
aArray4
Returns
Lengths

◆ 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
osOutput stream.
aArrayND 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
aArray4
Returns
Inclusive upper bounds.