A Fortran Array of REALs. More...

#include <AMReX_FArrayBox.H>

Inheritance diagram for amrex::FArrayBox:

Public Member Functions
	FArrayBox () noexcept=default
	Construct an invalid FAB with no memory. More...

	FArrayBox (Arena *ar) noexcept

	FArrayBox (const Box &b, int ncomp, Arena *ar)

	FArrayBox (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. More...

	FArrayBox (const FArrayBox &rhs, MakeType make_type, int scomp, int ncomp)

	FArrayBox (const Box &b, int ncomp, Real const *p) noexcept

	FArrayBox (const Box &b, int ncomp, Real *p) noexcept

	FArrayBox (Array4< Real > const &a) noexcept

	FArrayBox (Array4< Real > const &a, IndexType t) noexcept

	FArrayBox (Array4< Real const > const &a) noexcept

	FArrayBox (Array4< Real const > const &a, IndexType t) noexcept

	~FArrayBox () noexcept override=default
	The destructor. More...

	FArrayBox (FArrayBox &&rhs) noexcept=default

FArrayBox &	operator= (FArrayBox &&) noexcept=default

	FArrayBox (const FArrayBox &)=delete

FArrayBox &	operator= (const FArrayBox &)=delete

template<RunOn run_on>
FArrayBox &	operator= (Real v) noexcept
	Set the fab to the value r. More...

template<RunOn run_on>
bool	contains_nan () const noexcept
	Are there any NaNs in the FAB? This may return false, even if the FAB contains NaNs, if the machine doesn't support the appropriate NaN testing functions. More...

template<RunOn run_on>
bool	contains_nan (const Box &bx, int scomp, int ncomp) const noexcept

template<RunOn run_on>
bool	contains_nan (IntVect &where) const noexcept
	These versions return the cell index (though not the component) of the first location of a NaN if there is one. More...

template<RunOn run_on>
bool	contains_nan (const Box &bx, int scomp, int ncomp, IntVect &where) const noexcept

template<RunOn run_on>
bool	contains_inf () const noexcept
	Are there any Infs in the FAB? This may return false, even if the FAB contains Infs, if the machine doesn't support the appropriate Inf testing functions. More...

template<RunOn run_on>
bool	contains_inf (const Box &bx, int scomp, int ncomp) const noexcept

template<RunOn run_on>
bool	contains_inf (IntVect &where) const noexcept
	These versions return the cell index (though not the component) of the first location of an Inf if there is one. More...

template<RunOn run_on>
bool	contains_inf (const Box &bx, int scomp, int ncomp, IntVect &where) const noexcept

void	resize (const Box &b, int N=1, Arena *ar=nullptr)
	For debugging purposes we hide BaseFab version and do some extra work. More...

FabType	getType () const noexcept

void	initVal () noexcept

void	writeOn (std::ostream &os) const
	Writes out the FAB in whatever format you've set. The default format is NATIVE. More...

void	writeOn (std::ostream &os, int comp, int num_comp=1) const
	Write only selected range of components. comp specifies from which component (starting at 0) to write at each point in space. num_comp specifies how many data points to write out at each point is space – it defaults to 1. It must be the case the comp >= 0 && num_comp >= 1 && (comp+num_comp) <= nComp(). The FAB is written out in whatever format you've set, with the default format being NATIVE. The FAB that is written to disk will be an num_comp component FAB. More...

void	readFrom (std::istream &is)
	Read FAB from istream. Format is as it was written out. More...

int	readFrom (std::istream &is, int compIndex)
	Read FAB from istream. Format is as it was written out. This creates a single component FAB with data from compIndex of the FAB from the istream. Returns the number of components available in the fab. More...

Public Member Functions inherited from amrex::BaseFab< Real >
	BaseFab () noexcept=default
	Construct an empty BaseFab, which must be resized (see BaseFab::resize) before use. More...

	BaseFab (Arena *ar) noexcept

	BaseFab (const Box &bx, int n, Arena *ar)

	BaseFab (const Box &bx, int n=1, bool alloc=true, bool shared=false, Arena *ar=nullptr)
	Make BaseFab with desired domain (box) and number of components. More...

	BaseFab (const BaseFab< Real > &rhs, MakeType make_type, int scomp, int ncomp)

	BaseFab (const Box &bx, int ncomp, Real *p)
	Create an NON-OWNING BaseFab. Thus BaseFab is not responsible for memory management. And it's caller's responsibility that p points to a chunk of memory large enough. More...

	BaseFab (const Box &bx, int ncomp, Real const *p)

	BaseFab (Array4< Real > const &a) noexcept

	BaseFab (Array4< Real > const &a, IndexType t) noexcept

	BaseFab (Array4< Real const > const &a) noexcept

	BaseFab (Array4< Real const > const &a, IndexType t) noexcept

	BaseFab (const BaseFab< Real > &rhs)=delete

	BaseFab (BaseFab< Real > &&rhs) noexcept

virtual	~BaseFab () noexcept
	The destructor deletes the array memory. More...

BaseFab< Real > &	operator= (const BaseFab< Real > &rhs)=delete

BaseFab< Real > &	operator= (BaseFab< Real > &&rhs) noexcept

BaseFab &	operator= (Real const &) noexcept

BaseFab< Real > &	operator= (Real const &t) noexcept

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. More...

Elixir	elixir () noexcept

void	clear () noexcept
	The function returns the BaseFab to the invalid state. The memory is freed. More...

std::unique_ptr< Real, DataDeleter >	release () noexcept
	Release ownership of memory. More...

std::size_t	nBytes () const noexcept
	Returns how many bytes used. More...

std::size_t	nBytes (const Box &bx, int ncomps) const noexcept
	Returns bytes used in the Box for those components. More...

std::size_t	nBytesOwned () const noexcept

int	nComp () const noexcept
	Returns the number of components. More...

const int *	nCompPtr () const noexcept
	for calls to fortran. More...

Long	numPts () const noexcept
	Returns the number of points. More...

Long	size () const noexcept
	Returns the total number of points of all components. More...

const Box &	box () const noexcept
	Returns the domain (box) where the array is defined. More...

IntVect	length () const noexcept
	Returns a pointer to an array of SPACEDIM integers giving the length of the domain in each direction. More...

const IntVect &	smallEnd () const noexcept
	Returns the lower corner of the domain See class Box for analogue. More...

const IntVect &	bigEnd () const noexcept
	Returns the upper corner of the domain. See class Box for analogue. More...

const int *	loVect () const noexcept
	Returns the lower corner of the domain. More...

const int *	hiVect () const noexcept
	Returns the upper corner of the domain. More...

bool	contains (const BaseFab< Real > &fab) const noexcept
	Returns true if the domain of fab is totally contained within the domain of this BaseFab. More...

bool	contains (const Box &bx) const noexcept
	Returns true if bx is totally contained within the domain of this BaseFab. More...

Real *	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. More...

const Real *	dataPtr (int n=0) const noexcept
	Same as above except works on const FABs. More...

Real *	dataPtr (const IntVect &p, int n=0) noexcept

const Real *	dataPtr (const IntVect &p, int n=0) const noexcept

void	setPtr (Real *p, Long sz) noexcept

void	prefetchToHost () const noexcept

void	prefetchToDevice () const noexcept

AMREX_FORCE_INLINE Array4< Real const >	array () const noexcept

AMREX_FORCE_INLINE Array4< Real const >	array (int start_comp) const noexcept

AMREX_FORCE_INLINE Array4< Real const >	array (int start_comp, int num_comps) const noexcept

AMREX_FORCE_INLINE Array4< Real >	array () noexcept

AMREX_FORCE_INLINE Array4< Real >	array (int start_comp) noexcept

AMREX_FORCE_INLINE Array4< Real >	array (int start_comp, int num_comps) noexcept

AMREX_FORCE_INLINE Array4< Real const >	const_array () const noexcept

AMREX_FORCE_INLINE Array4< Real const >	const_array (int start_comp) const noexcept

AMREX_FORCE_INLINE Array4< Real const >	const_array (int start_comp, int num_comps) const noexcept

bool	isAllocated () const noexcept
	Returns true if the data for the FAB has been allocated. More...

Real &	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. More...

Real &	operator() (const IntVect &p) noexcept
	Same as above, except returns component 0. More...

const Real &	operator() (const IntVect &p, int N) const noexcept
	Same as above except works on const FABs. More...

const Real &	operator() (const IntVect &p) const noexcept
	Same as above, except returns component 0. More...

void	getVal (Real *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. More...

void	getVal (Real *data, const IntVect &pos) const noexcept
	Same as above, except that starts at component 0 and copies all comps. More...

void	setVal (Real 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. More...

void	setVal (Real const &x, const Box &bx, int N=0) noexcept
	Same as above, except the number of modified components is one. N is the component to be modified. More...

void	setVal (Real const &x, int N) noexcept
	Same as above, except the sub-box defaults to the entire domain. More...

void	setVal (Real const &val) noexcept
	Set value on the whole domain and all components. More...

void	setVal (Real const &x, Box const &bx, DestComp dcomp, NumComps ncomp) noexcept
	Do nothing if bx is empty. More...

void	setValIfNot (Real const &val, const Box &bx, const BaseFab< int > &mask, int nstart, int num) noexcept

void	setValIfNot (Real const &val, const BaseFab< int > &mask) noexcept

void	setValIfNot (Real const &val, Box const &bx, const BaseFab< int > &mask, DestComp dcomp, NumComps ncomp) noexcept
	Do nothing if bx is empty. More...

void	setComplement (Real 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. More...

void	setComplement (Real const &x, Box const &bx, DestComp dcomp, NumComps ncomp) noexcept
	setVal on the complement of bx in the fab's domain More...

BaseFab< Real > &	copy (const BaseFab< Real > &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. More...

BaseFab< Real > &	copy (const BaseFab< Real > &src, int srccomp, int destcomp, int numcomp=1) noexcept
	As above, except the destination Box and the source Box are taken to be the entire domain of the destination. A copy of the intersecting region is performed. class. More...

BaseFab< Real > &	copy (const BaseFab< Real > &src, const Box &destbox) noexcept
	As above, except that the destination Box is specified, but the source Box is taken to the equal to the destination Box, and all components of the destination BaseFab are copied. More...

BaseFab< Real > &	copy (const BaseFab< Real > &src) noexcept

BaseFab< Real > &	copy (const BaseFab< Real > &src, Box bx, SrcComp scomp, DestComp dcomp, NumComps ncomp) noexcept
	Do nothing if bx does not intersect with src fab. More...

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. More...

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. More...

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. More...

BaseFab< Real > &	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. More...

BaseFab< Real > &	shift (int idir, 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. More...

BaseFab< Real > &	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. More...

BaseFab< Real > &	shiftHalf (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. More...

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 noexcept
	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) More...

Real	norm (const Box &subbox, int p, int scomp=0, int numcomp=1) const noexcept
	Same as above except only on given subbox. More...

void	abs () noexcept
	Compute absolute value for all components of this FAB. More...

void	abs (int comp, int numcomp=1) noexcept
	Same as above except only for components (comp: comp+numcomp-1) More...

void	abs (const Box &subbox, int comp=0, int numcomp=1) noexcept
	Calculate abs() on subbox for given component range. More...

Real	min (int comp=0) const noexcept

Real	min (const Box &subbox, int comp=0) const noexcept

Real	max (int comp=0) const noexcept

Real	max (const Box &subbox, int comp=0) const noexcept

std::pair< Real, Real >	minmax (int comp=0) const noexcept

std::pair< Real, Real >	minmax (const Box &subbox, int comp=0) const noexcept

Real	maxabs (int comp=0) const noexcept

Real	maxabs (const Box &subbox, int comp=0) const noexcept

IntVect	indexFromValue (const Box &subbox, int comp, Real const &value) const noexcept

IntVect	minIndex (int comp=0) const noexcept

IntVect	minIndex (const Box &subbox, int comp=0) const noexcept

void	minIndex (const Box &subbox, Real &min_val, IntVect &min_idx, int comp=0) const noexcept

IntVect	maxIndex (int comp=0) const noexcept

IntVect	maxIndex (const Box &subbox, int comp=0) const noexcept

void	maxIndex (const Box &subbox, Real &max_value, IntVect &max_idx, int comp=0) const noexcept

int	maskLT (BaseFab< int > &mask, Real 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. More...

int	maskLE (BaseFab< int > &mask, Real const &val, int comp=0) const noexcept
	Same as above except mark cells with value less than or equal to val. More...

int	maskEQ (BaseFab< int > &mask, Real const &val, int comp=0) const noexcept
	Same as above except mark cells with value equal to val. More...

int	maskGT (BaseFab< int > &mask, Real const &val, int comp=0) const noexcept
	Same as above except mark cells with value greater than val. More...

int	maskGE (BaseFab< int > &mask, Real const &val, int comp=0) const noexcept
	Same as above except mark cells with value greater than or equal to val. More...

Real	sum (int comp, int numcomp=1) const noexcept
	Returns sum of given component of FAB state vector. More...

Real	sum (const Box &subbox, int comp, int numcomp=1) const noexcept
	Compute sum of given component of FAB state vector in given subbox. More...

Real	sum (const Box &bx, DestComp dcomp, NumComps ncomp) const noexcept
	Sum. More...

BaseFab< Real > &	invert (Real const &r, const Box &b, int comp=0, int numcomp=1) noexcept
	Most general version, specify subbox and which components. More...

BaseFab< Real > &	invert (Real const &r, int comp, int numcomp=1) noexcept
	As above except on entire domain. More...

BaseFab< Real > &	invert (Real const &r) noexcept
	Fab <- Fab/r on the whole domain and all components. More...

BaseFab< Real > &	invert (Real const &r, const Box &bx, DestComp dcomp, NumComps ncomp) noexcept

BaseFab< Real > &	negate (const Box &b, int comp=0, int numcomp=1) noexcept
	Negate BaseFab, most general. More...

BaseFab< Real > &	negate (int comp, int numcomp=1) noexcept
	As above, except on entire domain. More...

BaseFab< Real > &	negate () noexcept
	on the whole domain and all components More...

BaseFab< Real > &	negate (const Box &bx, DestComp dcomp, NumComps ncomp) noexcept

BaseFab< Real > &	plus (Real const &r, const Box &b, int comp=0, int numcomp=1) noexcept
	Scalar addition (a[i] <- a[i] + r), most general. More...

BaseFab< Real > &	plus (Real const &r, int comp, int numcomp=1) noexcept
	As above, except on entire domain. More...

BaseFab< Real > &	plus (const BaseFab< Real > &src, int srccomp, int destcomp, int numcomp=1) noexcept
	Add src components (srccomp:srccomp+numcomp-1) to this FABs components (destcomp:destcomp+numcomp-1) where the two FABs intersect. More...

BaseFab< Real > &	plus (const BaseFab< Real > &src, const Box &subbox, int srccomp, int destcomp, int numcomp=1) noexcept
	Same as above except addition is restricted to intersection of subbox and src FAB. NOTE: subbox must be contained in this FAB. More...

BaseFab< Real > &	plus (const BaseFab< Real > &src, const Box &srcbox, const Box &destbox, int srccomp, int destcomp, int numcomp=1) noexcept
	Add srcbox region of src FAB to destbox region of this FAB. The srcbox and destbox must be same size. More...

BaseFab< Real > &	plus (Real const &val) noexcept
	Scalar addition on the whole domain and all components. More...

BaseFab< Real > &	plus (Real const &val, Box const &bx, DestComp dcomp, NumComps ncomp) noexcept
	Do nothing if bx is empty. More...

BaseFab< Real > &	plus (const BaseFab< Real > &src) noexcept

BaseFab< Real > &	plus (const BaseFab< Real > &src, Box bx, SrcComp scomp, DestComp dcomp, NumComps ncomp) noexcept
	Do nothing if bx does not intersect with src fab. More...

BaseFab< Real > &	atomicAdd (const BaseFab< Real > &x) noexcept
	Atomic FAB addition (a[i] <- a[i] + b[i]). More...

BaseFab< Real > &	atomicAdd (const BaseFab< Real > &src, int srccomp, int destcomp, int numcomp=1) noexcept
	Atomically add src components (srccomp:srccomp+numcomp-1) to this FABs components (destcomp:destcomp+numcomp-1) where the two FABs intersect. More...

BaseFab< Real > &	atomicAdd (const BaseFab< Real > &src, const Box &subbox, int srccomp, int destcomp, int numcomp=1) noexcept
	Same as above except addition is restricted to intersection of subbox and src FAB. NOTE: subbox must be contained in this FAB. More...

BaseFab< Real > &	atomicAdd (const BaseFab< Real > &src, const Box &srcbox, const Box &destbox, int srccomp, int destcomp, int numcomp=1) noexcept
	Atomically add srcbox region of src FAB to destbox region of this FAB. The srcbox and destbox must be same size. More...

BaseFab< Real > &	lockAdd (const BaseFab< Real > &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. More...

BaseFab< Real > &	saxpy (Real a, const BaseFab< Real > &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. More...

BaseFab< Real > &	saxpy (Real a, const BaseFab< Real > &x) noexcept
	FAB SAXPY (y[i] <- y[i] + a * x[i]), in place. All components. More...

BaseFab< Real > &	xpay (Real a, const BaseFab< Real > &x, const Box &srcbox, const Box &destbox, int srccomp, int destcomp, int numcomp=1) noexcept
	FAB XPAY (y[i] <- x[i] + a * y[i]) More...

BaseFab< Real > &	addproduct (const Box &destbox, int destcomp, int numcomp, const BaseFab< Real > &src1, int comp1, const BaseFab< Real > &src2, int comp2) noexcept
	y[i] <- y[i] + x1[i] * x2[i]) More...

BaseFab< Real > &	minus (const BaseFab< Real > &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. More...

BaseFab< Real > &	minus (const BaseFab< Real > &src, const Box &subbox, int srccomp, int destcomp, int numcomp=1) noexcept
	Same as above except subtraction is restricted to intersection of subbox and src FAB. NOTE: subbox must be contained in this FAB. More...

BaseFab< Real > &	minus (const BaseFab< Real > &src, const Box &srcbox, const Box &destbox, int srccomp, int destcomp, int numcomp=1) noexcept
	Subtract srcbox region of src FAB from destbox region of this FAB. srcbox and destbox must be same size. More...

BaseFab< Real > &	minus (Real const &val) noexcept
	Scalar subtraction on the whole domain and all components. More...

BaseFab< Real > &	minus (Real const &val, Box const &bx, DestComp dcomp, NumComps ncomp) noexcept
	Do nothing if bx is empty. More...

BaseFab< Real > &	minus (const BaseFab< Real > &src) noexcept

BaseFab< Real > &	minus (const BaseFab< Real > &src, Box bx, SrcComp scomp, DestComp dcomp, NumComps ncomp) noexcept
	Do nothing if bx does not intersect with src fab. More...

BaseFab< Real > &	mult (Real const &r, int comp, int numcomp=1) noexcept
	Scalar multiplication, except control which components are multiplied. More...

BaseFab< Real > &	mult (Real const &r, const Box &b, int comp=0, int numcomp=1) noexcept
	As above, except specify sub-box. More...

BaseFab< Real > &	mult (const BaseFab< Real > &src, int srccomp, int destcomp, int numcomp=1) noexcept
	Multiply src components (srccomp:srccomp+numcomp-1) with this FABs components (destcomp:destcomp+numcomp-1) where the two FABs intersect. More...

BaseFab< Real > &	mult (const BaseFab< Real > &src, const Box &subbox, int srccomp, int destcomp, int numcomp=1) noexcept
	Same as above except multiplication is restricted to intersection of subbox and src FAB. NOTE: subbox must be contained in this FAB. More...

BaseFab< Real > &	mult (const BaseFab< Real > &src, const Box &srcbox, const Box &destbox, int srccomp, int destcomp, int numcomp=1) noexcept
	Multiply srcbox region of src FAB with destbox region of this FAB. The srcbox and destbox must be same size. More...

BaseFab< Real > &	mult (Real const &val) noexcept
	Scalar multiplication on the whole domain and all components. More...

BaseFab< Real > &	mult (Real const &val, Box const &bx, DestComp dcomp, NumComps ncomp) noexcept
	Do nothing if bx is empty. More...

BaseFab< Real > &	mult (const BaseFab< Real > &src) noexcept

BaseFab< Real > &	mult (const BaseFab< Real > &src, Box bx, SrcComp scomp, DestComp dcomp, NumComps ncomp) noexcept
	Do nothing if bx does not intersect with src fab. More...

BaseFab< Real > &	divide (Real const &r, int comp, int numcomp=1) noexcept
	As above except specify which components. More...

BaseFab< Real > &	divide (Real const &r, const Box &b, int comp=0, int numcomp=1) noexcept
	As above except specify sub-box. More...

BaseFab< Real > &	divide (const BaseFab< Real > &src, int srccomp, int destcomp, int numcomp=1) noexcept
	This FAB is numerator, src FAB is denominator divide src components (srccomp:srccomp+numcomp-1) into this FABs components (destcomp:destcomp+numcomp-1) where the two FABs intersect. More...

BaseFab< Real > &	divide (const BaseFab< Real > &src, const Box &subbox, int srccomp, int destcomp, int numcomp=1) noexcept
	Same as above except division is restricted to intersection of subbox and src FAB. NOTE: subbox must be contained in this FAB. More...

BaseFab< Real > &	divide (const BaseFab< Real > &src, const Box &srcbox, const Box &destbox, int srccomp, int destcomp, int numcomp=1) noexcept
	destbox region of this FAB is numerator. srcbox regions of src FAB is denominator. srcbox and destbox must be same size. More...

BaseFab< Real > &	divide (Real const &val) noexcept
	Scalar division on the whole domain and all components. More...

BaseFab< Real > &	divide (Real const &val, Box const &bx, DestComp dcomp, NumComps ncomp) noexcept
	Do nothing if bx is empty. More...

BaseFab< Real > &	divide (const BaseFab< Real > &src) noexcept

BaseFab< Real > &	divide (const BaseFab< Real > &src, Box bx, SrcComp scomp, DestComp dcomp, NumComps ncomp) noexcept
	Do nothing if bx does not intersect with src fab. More...

BaseFab< Real > &	protected_divide (const BaseFab< Real > &src) noexcept
	Divide wherever "src" is "true" or "non-zero". More...

BaseFab< Real > &	protected_divide (const BaseFab< Real > &src, int srccomp, int destcomp, int numcomp=1) noexcept
	Divide wherever "src" is "true" or "non-zero". This FAB is numerator, src FAB is denominator divide src components (srccomp:srccomp+numcomp-1) into this FABs components (destcomp:destcomp+numcomp-1) where the two FABs intersect. More...

BaseFab< Real > &	protected_divide (const BaseFab< Real > &src, const Box &subbox, int srccomp, int destcomp, int numcomp=1) noexcept
	Divide wherever "src" is "true" or "non-zero". Same as above except division is restricted to intersection of subbox and src FAB. NOTE: subbox must be contained in this FAB. More...

BaseFab< Real > &	protected_divide (const BaseFab< Real > &src, const Box &srcbox, const Box &destbox, int srccomp, int destcomp, int numcomp=1) noexcept

BaseFab< Real > &	linInterp (const BaseFab< Real > &f1, const Box &b1, int comp1, const BaseFab< Real > &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. More...

BaseFab< Real > &	linInterp (const BaseFab< Real > &f1, int comp1, const BaseFab< Real > &f2, int comp2, Real t1, Real t2, Real t, const Box &b, int comp, int numcomp=1) noexcept
	Version of linInterp() in which b, b1, & b2 are the same. More...

BaseFab< Real > &	linComb (const BaseFab< Real > &f1, const Box &b1, int comp1, const BaseFab< Real > &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. More...

Real	dot (const Box &xbx, int xcomp, const BaseFab< Real > &y, const Box &ybx, int ycomp, int numcomp=1) const noexcept
	Dot product of x (i.e.,this) and y. More...

Real	dot (const BaseFab< Real > &src, const Box &bx, SrcComp scomp, DestComp dcomp, NumComps ncomp) const noexcept
	Dot product of two Fabs. More...

Real	dot (const Box &bx, int destcomp, int numcomp) const noexcept
	Int wrapper for dot. More...

Real	dot (const Box &bx, DestComp dcomp, NumComps ncomp) const noexcept
	Dot product. More...

Real	dotmask (const BaseFab< int > &mask, const Box &xbx, int xcomp, const BaseFab< Real > &y, const Box &ybx, int ycomp, int numcomp) const noexcept

Real	dotmask (const BaseFab< Real > &src, const Box &bx, const BaseFab< int > &mask, SrcComp scomp, DestComp dcomp, NumComps ncomp) const noexcept
	Dot product of two Fabs with mask. More...

void	SetBoxType (const IndexType &typ) noexcept
	Change the Box type without change the length. More...

void	setValIf (Real const &val, const BaseFab< int > &mask) noexcept

void	setValIf (Real const &val, Box const &bx, const BaseFab< int > &mask, DestComp dcomp, NumComps ncomp) noexcept
	Do nothing if bx is empty. More...

BaseFab< Real > &	operator+= (Real const &val) noexcept

BaseFab< Real > &	operator+= (const BaseFab< Real > &src) noexcept

BaseFab< Real > &	operator-= (Real const &val) noexcept

BaseFab< Real > &	operator-= (const BaseFab< Real > &src) noexcept

BaseFab< Real > &	operator*= (Real const &val) noexcept

BaseFab< Real > &	operator*= (const BaseFab< Real > &src) noexcept

BaseFab< Real > &	operator/= (Real const &val) noexcept

BaseFab< Real > &	operator/= (const BaseFab< Real > &src) noexcept

Public Member Functions inherited from amrex::DataAllocator
	DataAllocator () noexcept=default

	DataAllocator (Arena *ar) noexcept

void *	alloc (std::size_t sz) const noexcept

void	free (void *pt) const noexcept

Arena *	arena () const noexcept

Static Public Member Functions
static Box	skipFAB (std::istream &is, int &num_comp)
	Skip over the next FAB from the input stream. Return the Box defining the domain of the FAB and the number of components. More...

static void	skipFAB (std::istream &is)
	Skip over the next FAB from the input stream. More...

static void	setFormat (FABio::Format fmt)
	Set the FABio::Format in the program. This is the preferred way to set the output format in "new" FABs. When designing new programs, this should be the only function that needs to be called in order to set the format. More...

static FABio::Format	getFormat ()
	Gets the FABio::Format set in the program. More...

static void	setOrdering (FABio::Ordering ordering)
	Set the FABio::Ordering for reading old FABs. It does NOT set the ordering for output. This is deprecated. It exists only to facilitate reading old FABs. When you're reading in an "old" FAB, you must set the Ordering, before attempting to read it in. This is because FABs written out in the "old" format weren't self-describing; i.e. information such as the Ordering was lost when the "old" FAB was written out. More...

static FABio::Ordering	getOrdering ()
	Gets the FABio::Ordering set in the program. This is deprecated. It does NOT do the right thing with the new FAB I/O format. More...

static void	setPrecision (FABio::Precision precision)
	Set the FABio::Precision. This is deprecated. It is not useful with the "new" FAB I/O format. More...

static FABio::Precision	getPrecision ()
	Returns the FABio::Precision. This is deprecated. It is not useful with the "new" FAB I/O format. Always returns FABio::Float. More...

static const FABio &	getFABio ()
	Returns reference to the FABio object used by the program. More...

static void	setFABio (FABio *rd)
	Sets the FABio object used by the program. It is an error if the passed pointer rd is the null pointer. More...

static std::unique_ptr< RealDescriptor >	getDataDescriptor ()

static std::string	getClassName ()

static bool	set_do_initval (bool tf)

static bool	get_do_initval ()

static Real	set_initval (Real iv)

static Real	get_initval ()

static void	Initialize ()
	Initialize from ParmParse with "fab" prefix. More...

static void	Finalize ()

Static Public Member Functions inherited from amrex::BaseFab< Real >
static void	Initialize ()

static void	Finalize ()

Static Public Attributes
static bool	initialized = false

Protected Attributes
FabType	m_type = FabType::regular

Protected Attributes inherited from amrex::BaseFab< Real >
Real *	dptr
	The data pointer. More...

Box	domain
	My index space. More...

int	nvar
	Number components. More...

Long	truesize
	nvar*numpts that was allocated on heap. More...

bool	ptr_owner
	Owner of T*? More...

bool	shared_memory
	Is the memory allocated in shared memory? More...

gpuStream_t	alloc_stream

Static Protected Attributes
static FABio::Format	format
	Format and ordering for all FAB output. This stuff exists solely to support reading old FABs. More...

static FABio::Ordering	ordering = FABio::FAB_NORMAL_ORDER

static FABio *	fabio = nullptr
	The FABio pointer describing our output format. More...

static bool	do_initval = false
	initial value More...

static Real	initval

static bool	init_snan = false

Friends
class	FABio
	FABio is a friend of ours. More...

std::ostream &	operator<< (std::ostream &os, const FArrayBox &fb)
	Write FABs in ASCII form. More...

std::istream &	operator>> (std::istream &is, FArrayBox &fb)
	Read FABs in ASCII form. More...

Additional Inherited Members
Public Types inherited from amrex::BaseFab< Real >
using	value_type = Real

Public Attributes inherited from amrex::DataAllocator
Arena *	m_arena = nullptr

Protected Member Functions inherited from amrex::BaseFab< Real >
void	define ()
	Allocates memory for the BaseFab<T>. More...

Detailed Description

A Fortran Array of REALs.

Fortran Array Box's (generally called FAB'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.

FArrayBox is derived from BaseFab<Real>. FArrayBox adds additional useful capabilities which make sense for Real types, such as I/O and L**p norms.

FArrayBox's may be output in various formats (see FABio above).

The format and precision may be set in a file read by the ParmParse class by the "fab.format" variable. Allowed values are: ASCII 8BIT NATIVE NATIVE_32 IEEE32

FABs written using operator<< are always written in ASCII. FABS written using writOn use the FABio::Format specified with setFormat or the FABio::Format specified in the ParmParse file read by init. If the FABio::Format is not set explicitly by either of these two methods, then it defaults to NATIVE.

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 class does NOT provide a copy constructor or assignment operator, but it has a move constructor.

Constructor & Destructor Documentation

◆ FArrayBox() [1/13]

amrex::FArrayBox::FArrayBox ( )

defaultnoexcept

Construct an invalid FAB with no memory.

◆ FArrayBox() [2/13]

amrex::FArrayBox::FArrayBox ( Arena * ar )

explicitnoexcept

◆ FArrayBox() [3/13]

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

◆ FArrayBox() [4/13]

amrex::FArrayBox::FArrayBox	(	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.

◆ FArrayBox() [5/13]

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

◆ FArrayBox() [6/13]

amrex::FArrayBox::FArrayBox	(	const Box &	b,
		int	ncomp,
		Real const *	p
	)

noexcept

◆ FArrayBox() [7/13]

amrex::FArrayBox::FArrayBox	(	const Box &	b,
		int	ncomp,
		Real *	p
	)

noexcept

◆ FArrayBox() [8/13]

amrex::FArrayBox::FArrayBox ( Array4< Real > const & a )

inlineexplicitnoexcept

◆ FArrayBox() [9/13]

amrex::FArrayBox::FArrayBox	(	Array4< Real > const &	a,
		IndexType	t
	)

inlinenoexcept

◆ FArrayBox() [10/13]

amrex::FArrayBox::FArrayBox ( Array4< Real const > const & a )

inlineexplicitnoexcept

◆ FArrayBox() [11/13]

amrex::FArrayBox::FArrayBox	(	Array4< Real const > const &	a,
		IndexType	t
	)

inlineexplicitnoexcept

◆ ~FArrayBox()

amrex::FArrayBox::~FArrayBox ( )

overridedefaultnoexcept

The destructor.

◆ FArrayBox() [12/13]

amrex::FArrayBox::FArrayBox ( FArrayBox && rhs )

defaultnoexcept

◆ FArrayBox() [13/13]

amrex::FArrayBox::FArrayBox ( const FArrayBox & )

delete

Member Function Documentation

◆ contains_inf() [1/4]

template<RunOn run_on>

bool amrex::FArrayBox::contains_inf

noexcept

Are there any Infs in the FAB? This may return false, even if the FAB contains Infs, if the machine doesn't support the appropriate Inf testing functions.

◆ contains_inf() [2/4]

template<RunOn run_on>

bool amrex::FArrayBox::contains_inf	(	const Box &	bx,
		int	scomp,
		int	ncomp
	)		const

noexcept

◆ contains_inf() [3/4]

template<RunOn run_on>

bool amrex::FArrayBox::contains_inf	(	const Box &	bx,
		int	scomp,
		int	ncomp,
		IntVect &	where
	)		const

noexcept

◆ contains_inf() [4/4]

template<RunOn run_on>

bool amrex::FArrayBox::contains_inf ( IntVect & where ) const

noexcept

These versions return the cell index (though not the component) of the first location of an Inf if there is one.

◆ contains_nan() [1/4]

template<RunOn run_on>

bool amrex::FArrayBox::contains_nan

noexcept

Are there any NaNs in the FAB? This may return false, even if the FAB contains NaNs, if the machine doesn't support the appropriate NaN testing functions.

◆ contains_nan() [2/4]

template<RunOn run_on>

bool amrex::FArrayBox::contains_nan	(	const Box &	bx,
		int	scomp,
		int	ncomp
	)		const

noexcept

◆ contains_nan() [3/4]

template<RunOn run_on>

bool amrex::FArrayBox::contains_nan	(	const Box &	bx,
		int	scomp,
		int	ncomp,
		IntVect &	where
	)		const

noexcept

◆ contains_nan() [4/4]

template<RunOn run_on>

bool amrex::FArrayBox::contains_nan ( IntVect & where ) const

noexcept

These versions return the cell index (though not the component) of the first location of a NaN if there is one.

◆ Finalize()

void amrex::FArrayBox::Finalize ( )

static

◆ get_do_initval()

bool amrex::FArrayBox::get_do_initval ( )

static

◆ get_initval()

Real amrex::FArrayBox::get_initval ( )

static

◆ getClassName()

std::string amrex::FArrayBox::getClassName ( )

static

◆ getDataDescriptor()

std::unique_ptr< RealDescriptor > amrex::FArrayBox::getDataDescriptor ( )

static

◆ getFABio()

const FABio & amrex::FArrayBox::getFABio ( )

static

Returns reference to the FABio object used by the program.

◆ getFormat()

FABio::Format amrex::FArrayBox::getFormat ( )

static

Gets the FABio::Format set in the program.

◆ getOrdering()

FABio::Ordering amrex::FArrayBox::getOrdering ( )

static

Gets the FABio::Ordering set in the program. This is deprecated. It does NOT do the right thing with the new FAB I/O format.

◆ getPrecision()

FABio::Precision amrex::FArrayBox::getPrecision ( )

static

Returns the FABio::Precision. This is deprecated. It is not useful with the "new" FAB I/O format. Always returns FABio::Float.

◆ getType()

FabType amrex::FArrayBox::getType ( ) const

inlinenoexcept

◆ Initialize()

void amrex::FArrayBox::Initialize ( )

static

Initialize from ParmParse with "fab" prefix.

◆ initVal()

void amrex::FArrayBox::initVal ( )

noexcept

◆ operator=() [1/3]

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

delete

◆ operator=() [2/3]

FArrayBox& amrex::FArrayBox::operator= ( FArrayBox && )

defaultnoexcept

◆ operator=() [3/3]

template<RunOn run_on>

FArrayBox & amrex::FArrayBox::operator= ( Real v )

noexcept

Set the fab to the value r.

◆ readFrom() [1/2]

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

Read FAB from istream. Format is as it was written out.

◆ readFrom() [2/2]

int amrex::FArrayBox::readFrom	(	std::istream &	is,
		int	compIndex
	)

Read FAB from istream. Format is as it was written out. This creates a single component FAB with data from compIndex of the FAB from the istream. Returns the number of components available in the fab.

◆ resize()

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

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

◆ set_do_initval()

bool amrex::FArrayBox::set_do_initval ( bool tf )

static

◆ set_initval()

Real amrex::FArrayBox::set_initval ( Real iv )

static

◆ setFABio()

void amrex::FArrayBox::setFABio ( FABio * rd )

static

Sets the FABio object used by the program. It is an error if the passed pointer rd is the null pointer.

◆ setFormat()

void amrex::FArrayBox::setFormat ( FABio::Format fmt )

static

Set the FABio::Format in the program. This is the preferred way to set the output format in "new" FABs. When designing new programs, this should be the only function that needs to be called in order to set the format.

◆ setOrdering()

void amrex::FArrayBox::setOrdering ( FABio::Ordering ordering )

static

Set the FABio::Ordering for reading old FABs. It does NOT set the ordering for output. This is deprecated. It exists only to facilitate reading old FABs. When you're reading in an "old" FAB, you must set the Ordering, before attempting to read it in. This is because FABs written out in the "old" format weren't self-describing; i.e. information such as the Ordering was lost when the "old" FAB was written out.

◆ setPrecision()

void amrex::FArrayBox::setPrecision ( FABio::Precision precision )

static

Set the FABio::Precision. This is deprecated. It is not useful with the "new" FAB I/O format.

◆ skipFAB() [1/2]

void amrex::FArrayBox::skipFAB ( std::istream & is )

static

Skip over the next FAB from the input stream.

◆ skipFAB() [2/2]

Box amrex::FArrayBox::skipFAB	(	std::istream &	is,
		int &	num_comp
	)

static

Skip over the next FAB from the input stream. Return the Box defining the domain of the FAB and the number of components.

◆ writeOn() [1/2]

void amrex::FArrayBox::writeOn ( std::ostream & os ) const

Writes out the FAB in whatever format you've set. The default format is NATIVE.

◆ writeOn() [2/2]

void amrex::FArrayBox::writeOn	(	std::ostream &	os,
		int	comp,
		int	num_comp = `1`
	)		const

Write only selected range of components. comp specifies from which component (starting at 0) to write at each point in space. num_comp specifies how many data points to write out at each point is space – it defaults to 1. It must be the case the comp >= 0 && num_comp >= 1 && (comp+num_comp) <= nComp(). The FAB is written out in whatever format you've set, with the default format being NATIVE. The FAB that is written to disk will be an num_comp component FAB.

Friends And Related Function Documentation

◆ FABio

friend class FABio

friend

FABio is a friend of ours.

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const FArrayBox &	fb
	)

friend

Write FABs in ASCII form.

◆ operator>>

std::istream& operator>>	(	std::istream &	is,
		FArrayBox &	fb
	)

friend

Read FABs in ASCII form.

Member Data Documentation

◆ do_initval

bool amrex::FArrayBox::do_initval = false

staticprotected

initial value

◆ fabio

FABio * amrex::FArrayBox::fabio = nullptr

staticprotected

The FABio pointer describing our output format.

◆ format

FABio::Format amrex::FArrayBox::format

staticprotected

Format and ordering for all FAB output. This stuff exists solely to support reading old FABs.

◆ init_snan

bool amrex::FArrayBox::init_snan = false

staticprotected

◆ initialized

bool amrex::FArrayBox::initialized = false

static

◆ initval

Real amrex::FArrayBox::initval

staticprotected

◆ m_type

FabType amrex::FArrayBox::m_type = FabType::regular

protected

◆ ordering

FABio::Ordering amrex::FArrayBox::ordering = FABio::FAB_NORMAL_ORDER

staticprotected

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Static Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FArrayBox() [1/13]

◆ FArrayBox() [2/13]

◆ FArrayBox() [3/13]

◆ FArrayBox() [4/13]

◆ FArrayBox() [5/13]

◆ FArrayBox() [6/13]

◆ FArrayBox() [7/13]

◆ FArrayBox() [8/13]

◆ FArrayBox() [9/13]

◆ FArrayBox() [10/13]

◆ FArrayBox() [11/13]

◆ ~FArrayBox()

◆ FArrayBox() [12/13]

◆ FArrayBox() [13/13]

Member Function Documentation

◆ contains_inf() [1/4]

◆ contains_inf() [2/4]

◆ contains_inf() [3/4]

◆ contains_inf() [4/4]

◆ contains_nan() [1/4]

◆ contains_nan() [2/4]

◆ contains_nan() [3/4]

◆ contains_nan() [4/4]

◆ Finalize()

◆ get_do_initval()

◆ get_initval()

◆ getClassName()

◆ getDataDescriptor()

◆ getFABio()

◆ getFormat()

◆ getOrdering()

◆ getPrecision()

◆ getType()

◆ Initialize()

◆ initVal()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ readFrom() [1/2]

◆ readFrom() [2/2]

◆ resize()

◆ set_do_initval()

◆ set_initval()

◆ setFABio()

◆ setFormat()

◆ setOrdering()

◆ setPrecision()

◆ skipFAB() [1/2]

◆ skipFAB() [2/2]

◆ writeOn() [1/2]

◆ writeOn() [2/2]

Friends And Related Function Documentation

◆ FABio

◆ operator<<

◆ operator>>

Member Data Documentation

◆ do_initval

◆ fabio

◆ format

◆ init_snan

◆ initialized

◆ initval

◆ m_type

◆ ordering