A Fortran Array of ints. More...

#include <AMReX_IArrayBox.H>

Inheritance diagram for amrex::IArrayBox:

Public Member Functions
	IArrayBox () noexcept=default
	Construct an invalid FAB with no memory.
	IArrayBox (Arena *ar) noexcept
	IArrayBox (const Box &b, int ncomp, Arena *ar)
	IArrayBox (const Box &b, int ncomp=1, bool alloc=true, bool shared=false, Arena *ar=nullptr)
	Construct an initial FAB with the data space allocated but not initialized. ncomp is the number of components (variables) at each data point in the Box.
	IArrayBox (const IArrayBox &rhs, MakeType make_type, int scomp, int ncomp)
	IArrayBox (Array4< int > const &a) noexcept
	IArrayBox (Array4< int > const &a, IndexType t) noexcept
	IArrayBox (Array4< int const > const &a) noexcept
	IArrayBox (Array4< int const > const &a, IndexType t) noexcept
	~IArrayBox () noexcept override=default
	The destructor.
	IArrayBox (IArrayBox &&rhs) noexcept=default
IArrayBox &	operator= (IArrayBox &&)=default
	IArrayBox (const IArrayBox &)=delete
IArrayBox &	operator= (const IArrayBox &)=delete
template<RunOn run_on>
IArrayBox &	operator= (int v) noexcept
	Set the fab to the value r.
void	resize (const Box &b, int N=1, Arena *ar=nullptr)
	For debugging purposes we hide BaseFab version and do some extra work.
void	readFrom (std::istream &is)
Public Member Functions inherited from amrex::BaseFab< int >
BaseFab< int > &	operator= (int const &t) noexcept
virtual	~BaseFab () noexcept
	The destructor deletes the array memory.
void	resize (const Box &b, int N=1, Arena *ar=nullptr)
	This function resizes a BaseFab so it covers the Box b with N components.
Elixir	elixir () noexcept
	Transfer owned storage to an Elixir when running in a GPU launch region.
void	clear ()
	The function returns the BaseFab to the invalid state. The memory is freed.
std::unique_ptr< int, DataDeleter >	release () noexcept
	Release ownership of memory.
std::size_t	nBytes () const noexcept
	Returns how many bytes used.
std::size_t	nBytesOwned () const noexcept
int	nComp () const noexcept
	Returns the number of components.
const int *	nCompPtr () const noexcept
	for calls to fortran.
Long	numPts () const noexcept
	Returns the number of points.
Long	size () const noexcept
	Returns the total number of points of all components.
const Box &	box () const noexcept
	Returns the domain (box) where the array is defined.
IntVect	length () const noexcept
	Returns a pointer to an array of SPACEDIM integers giving the length of the domain in each direction.
const IntVect &	smallEnd () const noexcept
	Returns the lower corner of the domain See class Box for analogue.
const IntVect &	bigEnd () const noexcept
	Returns the upper corner of the domain. See class Box for analogue.
const int *	loVect () const noexcept
	Returns the lower corner of the domain.
const int *	hiVect () const noexcept
	Returns the upper corner of the domain.
bool	contains (const BaseFab< int > &fab) const noexcept
	Returns true if the domain of fab is totally contained within the domain of this BaseFab.
int *	dataPtr (int n=0) noexcept
	Returns a pointer to an object of type T that is the value of the Nth component associated with the cell at the low end of the domain. This is commonly used to get a pointer to data in the array which is then handed off to a Fortran subroutine. Remember that data is stored in Fortran array order, with the component index coming last. In other words, dataPtr returns a pointer to all the Nth components.
void	setPtr (int *p, Long sz) noexcept
	Attach externally allocated storage without taking ownership.
void	prefetchToHost () const noexcept
	Advise the runtime to migrate storage to the host.
void	prefetchToDevice () const noexcept
	Advise the runtime to migrate storage to the active device.
Array4< int const >	array () const noexcept
	Create an Array4 view over all components.
Array4< int const >	const_array () const noexcept
	Return a const-qualified Array4 view over all components.
bool	isAllocated () const noexcept
	Returns true if the data for the FAB has been allocated.
int &	operator() (const IntVect &p, int N) noexcept
	Returns a reference to the Nth component value defined at position p in the domain. This operator may be inefficient if the C++ compiler is unable to optimize the C++ code.
void	getVal (int *data, const IntVect &pos, int N, int numcomp) const noexcept
	This function puts numcomp component values, starting at component N, from position pos in the domain into array data, that must be allocated by the user.
void	fill_snan () noexcept
void	setVal (int const &x, const Box &bx, int dcomp, int ncomp) noexcept
	The setVal functions set sub-regions in the BaseFab to a constant value. This most general form specifies the sub-box, the starting component number, and the number of components to be set.
void	setValIfNot (int const &val, const Box &bx, const BaseFab< int > &mask, int nstart, int num) noexcept
void	setComplement (int const &x, const Box &b, int ns, int num) noexcept
	This function is analogous to the fourth form of setVal above, except that instead of setting values on the Box b, values are set on the complement of b in the domain.
BaseFab< int > &	copy (const BaseFab< int > &src, const Box &srcbox, int srccomp, const Box &destbox, int destcomp, int numcomp) noexcept
	The copy functions copy the contents of one BaseFab into another. The destination BaseFab is always the object which invokes the function. This, the most general form of copy, specifies the contents of any sub-box srcbox in BaseFab src may be copied into a (possibly different) destbox in the destination BaseFab. Note that although the srcbox and the destbox may be disjoint, they must be the same size and shape. If the sizes differ, the copy is undefined and a runtime error results. This copy function is the only one of the copy functions to allow a copy between differing boxes. The user also specifies how many components are copied, starting at component srccomp in src and stored starting at component destcomp. The results are UNDEFINED if the src and dest are the same and the srcbox and destbox overlap.
std::size_t	copyToMem (const Box &srcbox, int srccomp, int numcomp, void *dst) const noexcept
	Copy from the srcbox of this Fab to raw memory and return the number of bytes copied.
std::size_t	copyFromMem (const Box &dstbox, int dstcomp, int numcomp, const void *src) noexcept
	Copy from raw memory to the dstbox of this Fab and return the number of bytes copied.
std::size_t	addFromMem (const Box &dstbox, int dstcomp, int numcomp, const void *src) noexcept
	Add from raw memory to the dstbox of this Fab and return the number of bytes copied.
BaseFab< int > &	shift (const IntVect &v) noexcept
	Perform shifts upon the domain of the BaseFab. They are completely analogous to the corresponding Box functions. There is no effect upon the array memory.
BaseFab< int > &	shiftHalf (int dir, int n_cell) noexcept
	Perform shifts upon the domain of the BaseFab. They are completely analogous to the corresponding Box functions. There is no effect upon the array memory.
Real	norminfmask (const Box &subbox, const BaseFab< int > &mask, int scomp=0, int ncomp=1) const noexcept
Real	norm (int p, int scomp=0, int numcomp=1) const
	Compute the Lp-norm of this FAB using components (scomp : scomp+ncomp-1). p < 0 -> ERROR p = 0 -> infinity norm (max norm) p = 1 -> sum of ABS(FAB).
void	abs () noexcept
	Compute absolute value for all components of this FAB.
int	min (int comp=0) const noexcept
int	max (int comp=0) const noexcept
std::pair< int, int >	minmax (int comp=0) const noexcept
int	maxabs (int comp=0) const noexcept
IntVect	indexFromValue (const Box &subbox, int comp, int const &value) const noexcept
IntVect	minIndex (int comp=0) const noexcept
IntVect	maxIndex (int comp=0) const noexcept
int	maskLT (BaseFab< int > &mask, int const &val, int comp=0) const noexcept
	Compute mask array with value of 1 in cells where BaseFab has value less than val, 0 otherwise. mask is resized by this function. The number of cells marked with 1 returned.
int	maskLE (BaseFab< int > &mask, int const &val, int comp=0) const noexcept
	Mark cells with value `<=` `val`.
int	maskEQ (BaseFab< int > &mask, int const &val, int comp=0) const noexcept
	Mark cells with value equal to `val`.
int	maskGT (BaseFab< int > &mask, int const &val, int comp=0) const noexcept
	Mark cells with value greater than `val`.
int	maskGE (BaseFab< int > &mask, int const &val, int comp=0) const noexcept
	Mark cells with value greater than or equal to `val`.
int	sum (int comp, int numcomp=1) const noexcept
	Returns sum of given component of FAB state vector.
BaseFab< int > &	invert (int const &r, const Box &b, int comp=0, int numcomp=1) noexcept
	Most general version, specify subbox and which components.
BaseFab< int > &	negate (const Box &b, int comp=0, int numcomp=1) noexcept
	Negate BaseFab, most general.
BaseFab< int > &	plus (int const &r, const Box &b, int comp=0, int numcomp=1) noexcept
	Scalar addition (a[i] <- a[i] + r), most general.
BaseFab< int > &	atomicAdd (const BaseFab< int > &x) noexcept
	Atomic FAB addition (a[i] <- a[i] + b[i]).
BaseFab< int > &	lockAdd (const BaseFab< int > &src, const Box &srcbox, const Box &destbox, int srccomp, int destcomp, int numcomp) noexcept
	Atomically add srcbox region of src FAB to destbox region of this FAB. The srcbox and destbox must be same size. When OMP is on, this uses OMP locks in the implementation and it's usually faster than atomicAdd.
BaseFab< int > &	saxpy (int a, const BaseFab< int > &x, const Box &srcbox, const Box &destbox, int srccomp, int destcomp, int numcomp=1) noexcept
	FAB SAXPY (y[i] <- y[i] + a * x[i]), in place.
BaseFab< int > &	xpay (int a, const BaseFab< int > &x, const Box &srcbox, const Box &destbox, int srccomp, int destcomp, int numcomp=1) noexcept
	FAB XPAY (y[i] <- x[i] + a * y[i]).
BaseFab< int > &	addproduct (const Box &destbox, int destcomp, int numcomp, const BaseFab< int > &src1, int comp1, const BaseFab< int > &src2, int comp2) noexcept
	y[i] <- y[i] + x1[i] * x2[i])
BaseFab< int > &	minus (const BaseFab< int > &src, int srccomp, int destcomp, int numcomp=1) noexcept
	Subtract src components (srccomp:srccomp+numcomp-1) to this FABs components (destcomp:destcomp+numcomp-1) where the two FABs intersect.
BaseFab< int > &	mult (int const &r, int comp, int numcomp=1) noexcept
	Scalar multiplication applied to selected components over the entire domain.
BaseFab< int > &	divide (int const &r, int comp, int numcomp=1) noexcept
	Divide selected components by a scalar across the entire domain.
BaseFab< int > &	protected_divide (const BaseFab< int > &src) noexcept
	Divide wherever "src" is "true" or "non-zero".
BaseFab< int > &	linInterp (const BaseFab< int > &f1, const Box &b1, int comp1, const BaseFab< int > &f2, const Box &b2, int comp2, Real t1, Real t2, Real t, const Box &b, int comp, int numcomp=1) noexcept
	Linear interpolation / extrapolation. Result is (t2-t)/(t2-t1)f1 + (t-t1)/(t2-t1)f2 Data is taken from b1 region of f1, b2 region of f2 and stored in b region of this FAB. Boxes b, b1 and b2 must be the same size. Data is taken from component comp1 of f1, comp2 of f2, and stored in component comp of this FAB. This FAB is returned as a reference for chaining.
BaseFab< int > &	linComb (const BaseFab< int > &f1, const Box &b1, int comp1, const BaseFab< int > &f2, const Box &b2, int comp2, Real alpha, Real beta, const Box &b, int comp, int numcomp=1) noexcept
	Linear combination. Result is alphaf1 + betaf2. Data is taken from b1 region of f1, b2 region of f2 and stored in b region of this FAB. Boxes b, b1 and b2 must be the same size. Data is taken from component comp1 of f1, comp2 of f2, and stored in component comp of this FAB. This FAB is returned as a reference for chaining.
int	dot (const Box &xbx, int xcomp, const BaseFab< int > &y, const Box &ybx, int ycomp, int numcomp=1) const noexcept
	Dot product of x (i.e.,this) and y.
int	dotmask (const BaseFab< int > &mask, const Box &xbx, int xcomp, const BaseFab< int > &y, const Box &ybx, int ycomp, int numcomp) const noexcept
void	SetBoxType (const IndexType &typ) noexcept
	Change the Box type without change the length.
void	setValIf (int const &val, const BaseFab< int > &mask) noexcept
BaseFab< int > &	operator+= (int const &val) noexcept
BaseFab< int > &	operator-= (int const &val) noexcept
BaseFab< int > &	operator*= (int const &val) noexcept
BaseFab< int > &	operator/= (int const &val) noexcept
Public Member Functions inherited from amrex::DataAllocator
	DataAllocator () noexcept=default
	Default-construct; alloc/free will use The_Arena().
	DataAllocator (Arena *ar) noexcept
	Construct with an explicit arena `ar`.
void *	alloc (std::size_t sz) const
	Allocate `sz` bytes from the arena. Throws OutOfMemoryError on failure.
void	free (void *pt) const noexcept
	Return the allocation at `pt` to the arena.
Arena *	arena () const noexcept
	Return the stored arena, or The_Arena() if none was set.

Static Public Member Functions
static void	Initialize ()
static void	Finalize ()
static std::unique_ptr< IntDescriptor >	getDataDescriptor ()
static IFABio const &	getFABio ()
static std::string	getClassName ()
Static Public Member Functions inherited from amrex::BaseFab< int >
static void	Initialize ()
	Initialize static tracking/profiling metadata used by all BaseFabs.
static void	Finalize ()
	Release static tracking/profiling metadata allocated by Initialize().

Friends
class	IFABio

Additional Inherited Members
Public Types inherited from amrex::BaseFab< int >
using	value_type
Public Attributes inherited from amrex::DataAllocator
Arena *	m_arena = nullptr
	Stored arena pointer (may be null).
Protected Member Functions inherited from amrex::BaseFab< int >
void	define ()
	Allocates memory for the BaseFab<T>.
Protected Attributes inherited from amrex::BaseFab< int >
int *	dptr
	The data pointer.
Box	domain
	My index space.
int	nvar
	Number components.
Long	truesize
	nvar*numpts that was allocated on heap.
bool	ptr_owner
	Owner of T*?
bool	shared_memory
	Is the memory allocated in shared memory?
gpuStream_t	alloc_stream

Detailed Description

A Fortran Array of ints.

iFortran Array Box's (generally called iFAB's) are objects constructed to emulate the FORTRAN array. Useful operations can be performed upon FAB's in C++, and they provide a convenient interface to FORTRAN when it is necessary to retreat into that language.

IArrayBox is derived from BaseFab<int>. IArrayBox adds additional useful capabilities which make sense for int types, such as L**p norms.

The C pre-processor macro AMREX_SPACEDIM must be defined to use this class. The internal precision of FARRAYBOX objects is set by defining either BL_USE_FLOAT or BL_USE_DOUBLE

This is NOT a polymorphic class.

This class does NOT provide a copy constructor or assignment operator.

Constructor & Destructor Documentation

◆ IArrayBox() [1/11]

amrex::IArrayBox::IArrayBox ( )

defaultnoexcept

Construct an invalid FAB with no memory.

◆ IArrayBox() [2/11]

amrex::IArrayBox::IArrayBox ( Arena * ar )

explicitnoexcept

◆ IArrayBox() [3/11]

amrex::IArrayBox::IArrayBox	(	const Box &	b,
		int	ncomp,
		Arena *	ar )

◆ IArrayBox() [4/11]

amrex::IArrayBox::IArrayBox	(	const Box &	b,
		int	ncomp = 1,
		bool	alloc = true,
		bool	shared = false,
		Arena *	ar = nullptr )

explicit

Construct an initial FAB with the data space allocated but not initialized. ncomp is the number of components (variables) at each data point in the Box.

◆ IArrayBox() [5/11]

amrex::IArrayBox::IArrayBox	(	const IArrayBox &	rhs,
		MakeType	make_type,
		int	scomp,
		int	ncomp )

◆ IArrayBox() [6/11]

amrex::IArrayBox::IArrayBox ( Array4< int > const & a )

inlineexplicitnoexcept

◆ IArrayBox() [7/11]

amrex::IArrayBox::IArrayBox	(	Array4< int > const &	a,
		IndexType	t )

inlineexplicitnoexcept

◆ IArrayBox() [8/11]

amrex::IArrayBox::IArrayBox ( Array4< int const > const & a )

inlineexplicitnoexcept

◆ IArrayBox() [9/11]

amrex::IArrayBox::IArrayBox	(	Array4< int const > const &	a,
		IndexType	t )

inlineexplicitnoexcept

◆ ~IArrayBox()

amrex::IArrayBox::~IArrayBox ( )

overridedefaultnoexcept

The destructor.

◆ IArrayBox() [10/11]

amrex::IArrayBox::IArrayBox ( IArrayBox && rhs )

defaultnoexcept

◆ IArrayBox() [11/11]

amrex::IArrayBox::IArrayBox ( const IArrayBox & )

delete

Member Function Documentation

◆ Finalize()

void amrex::IArrayBox::Finalize ( )

static

◆ getClassName()

std::string amrex::IArrayBox::getClassName ( )

static

◆ getDataDescriptor()

std::unique_ptr< IntDescriptor > amrex::IArrayBox::getDataDescriptor ( )

static

◆ getFABio()

IFABio const & amrex::IArrayBox::getFABio ( )

static

◆ Initialize()

void amrex::IArrayBox::Initialize ( )

static

◆ operator=() [1/3]

IArrayBox & amrex::IArrayBox::operator= ( const IArrayBox & )

delete

◆ operator=() [2/3]

IArrayBox & amrex::IArrayBox::operator= ( IArrayBox && )

default

◆ operator=() [3/3]

template<RunOn run_on>

IArrayBox & amrex::IArrayBox::operator= ( int v )

noexcept

Set the fab to the value r.

◆ readFrom()

void amrex::IArrayBox::readFrom ( std::istream & is )

◆ resize()

void amrex::IArrayBox::resize	(	const Box &	b,
		int	N = 1,
		Arena *	ar = nullptr )

For debugging purposes we hide BaseFab version and do some extra work.

◆ IFABio

friend class IFABio

friend

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

/home/runner/work/amrex/amrex/Src/Base/AMReX_IArrayBox.H
/home/runner/work/amrex/amrex/Src/Base/AMReX_IArrayBox.cpp

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IArrayBox() [1/11]

◆ IArrayBox() [2/11]

◆ IArrayBox() [3/11]

◆ IArrayBox() [4/11]

◆ IArrayBox() [5/11]

◆ IArrayBox() [6/11]

◆ IArrayBox() [7/11]

◆ IArrayBox() [8/11]

◆ IArrayBox() [9/11]

◆ ~IArrayBox()

◆ IArrayBox() [10/11]

◆ IArrayBox() [11/11]

Member Function Documentation

◆ Finalize()

◆ getClassName()

◆ getDataDescriptor()

◆ getFABio()

◆ Initialize()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ readFrom()

◆ resize()

Friends And Related Symbol Documentation

◆ IFABio