Tagged cells in a Box. More...

#include <AMReX_TagBox.H>

Inheritance diagram for amrex::TagBox:

Public Types
enum	TagVal { CLEAR =0 , BUF , SET }
	Possible values for each cell. More...

using	TagType = char
	The type of each tag. More...

Public Types inherited from amrex::BaseFab< char >
using	value_type = char

Public Member Functions
	TagBox () noexcept=default

	TagBox (Arena *ar) noexcept

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

	TagBox (const Box &bx, int n=1, bool alloc=true, bool shared=false, Arena *ar=nullptr)

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

	~TagBox () noexcept override=default

	TagBox (TagBox &&rhs) noexcept=default

	TagBox (const TagBox &rhs)=delete

TagBox &	operator= (const TagBox &rhs)=delete

TagBox &	operator= (TagBox &&rhs)=delete

void	coarsen (const IntVect &ratio, const Box &cbox) noexcept
	Construct and return a new tagbox in which the coarsened cell is tagged of any of the corresponding fine cells are tagged. More...

void	buffer (const IntVect &a_nbuff, const IntVect &nwid) noexcept
	Mark neighbors of every tagged cell a distance nbuff away only search interior for initial tagged points where nwid is given as the width of the bndry region. More...

Vector< int >	tags () const noexcept
	Returns Vector<int> of size domain.numPts() suitable for calling Fortran, with positions set to same value as in the TagBox dataPtr(). More...

void	get_itags (Vector< int > &ar, const Box &tilebx) const noexcept
	Since a TagBox is a BaseFab<char>, we can use this utility function to allocate an integer array to have the same number of elements as cells in tilebx. More...

void	tags (const Vector< int > &ar) noexcept
	Set values as specified by the array – this only tags. It's an error if ar.length() != domain.numPts(). More...

void	tags_and_untags (const Vector< int > &ar) noexcept
	Set values as specified by the array – this tags and untags. It's an error if ar.length() != domain.numPts(). More...

void	tags (const Vector< int > &ar, const Box &tilebx) noexcept
	Set values as specified by the array – this only tags. only changes values in the tilebx region. More...

void	tags_and_untags (const Vector< int > &ar, const Box &tilebx) noexcept
	Set values as specified by the array – this tags and untags. only changes values in the tilebx region. More...

Public Member Functions inherited from amrex::BaseFab< char >
	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< char > &rhs, MakeType make_type, int scomp, int ncomp)

	BaseFab (const Box &bx, int ncomp, char *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, char const *p)

	BaseFab (Array4< char > const &a) noexcept

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

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

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

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

	BaseFab (BaseFab< char > &&rhs) noexcept

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

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

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

BaseFab &	operator= (char const &) noexcept

BaseFab< char > &	operator= (char 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< char, 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< char > &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...

char *	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 char *	dataPtr (int n=0) const noexcept
	Same as above except works on const FABs. More...

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

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

void	setPtr (char *p, Long sz) noexcept

void	prefetchToHost () const noexcept

void	prefetchToDevice () const noexcept

AMREX_FORCE_INLINE Array4< char const >	array () const noexcept

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

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

AMREX_FORCE_INLINE Array4< char >	array () noexcept

AMREX_FORCE_INLINE Array4< char >	array (int start_comp) noexcept

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

AMREX_FORCE_INLINE Array4< char const >	const_array () const noexcept

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

AMREX_FORCE_INLINE Array4< char 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...

char &	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...

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

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

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

void	getVal (char *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 (char *data, const IntVect &pos) const noexcept
	Same as above, except that starts at component 0 and copies all comps. More...

void	fill_snan () noexcept

void	setVal (char 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 (char 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 (char const &x, int N) noexcept
	Same as above, except the sub-box defaults to the entire domain. More...

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

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

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

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

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

void	setComplement (char 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 (char const &x, Box const &bx, DestComp dcomp, NumComps ncomp) noexcept
	setVal on the complement of bx in the fab's domain More...

BaseFab< char > &	copy (const BaseFab< char > &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< char > &	copy (const BaseFab< char > &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< char > &	copy (const BaseFab< char > &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< char > &	copy (const BaseFab< char > &src) noexcept

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

char	min (int comp=0) const noexcept

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

char	max (int comp=0) const noexcept

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

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

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

char	maxabs (int comp=0) const noexcept

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

IntVect	indexFromValue (const Box &subbox, int comp, char 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, char 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, char 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, char const &val, int comp=0) const noexcept
	Same as above except mark cells with value equal to val. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

BaseFab< char > &	plus (const BaseFab< char > &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< char > &	plus (const BaseFab< char > &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< char > &	plus (const BaseFab< char > &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< char > &	plus (char const &val) noexcept
	Scalar addition on the whole domain and all components. More...

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

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

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

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

BaseFab< char > &	atomicAdd (const BaseFab< char > &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< char > &	atomicAdd (const BaseFab< char > &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< char > &	atomicAdd (const BaseFab< char > &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< char > &	lockAdd (const BaseFab< char > &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< char > &	saxpy (char a, const BaseFab< char > &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< char > &	saxpy (char a, const BaseFab< char > &x) noexcept
	FAB SAXPY (y[i] <- y[i] + a * x[i]), in place. All components. More...

BaseFab< char > &	xpay (char a, const BaseFab< char > &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< char > &	addproduct (const Box &destbox, int destcomp, int numcomp, const BaseFab< char > &src1, int comp1, const BaseFab< char > &src2, int comp2) noexcept
	y[i] <- y[i] + x1[i] * x2[i]) More...

BaseFab< char > &	minus (const BaseFab< char > &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< char > &	minus (const BaseFab< char > &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< char > &	minus (const BaseFab< char > &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< char > &	minus (char const &val) noexcept
	Scalar subtraction on the whole domain and all components. More...

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

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

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

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

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

BaseFab< char > &	mult (const BaseFab< char > &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< char > &	mult (const BaseFab< char > &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< char > &	mult (const BaseFab< char > &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< char > &	mult (char const &val) noexcept
	Scalar multiplication on the whole domain and all components. More...

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

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

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

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

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

BaseFab< char > &	divide (const BaseFab< char > &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< char > &	divide (const BaseFab< char > &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< char > &	divide (const BaseFab< char > &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< char > &	divide (char const &val) noexcept
	Scalar division on the whole domain and all components. More...

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

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

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

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

BaseFab< char > &	protected_divide (const BaseFab< char > &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< char > &	protected_divide (const BaseFab< char > &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< char > &	protected_divide (const BaseFab< char > &src, const Box &srcbox, const Box &destbox, int srccomp, int destcomp, int numcomp=1) noexcept

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

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

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

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

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

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

char	dotmask (const BaseFab< char > &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 (char const &val, const BaseFab< int > &mask) noexcept

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

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

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

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

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

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

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

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

BaseFab< char > &	operator/= (const BaseFab< char > &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

Additional Inherited Members
Static Public Member Functions inherited from amrex::BaseFab< char >
static void	Initialize ()

static void	Finalize ()

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

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

Protected Attributes inherited from amrex::BaseFab< char >
char *	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

Detailed Description

Tagged cells in a Box.

This class is used to tag cells in a Box that need addition refinement.

Member Typedef Documentation

◆ TagType

using amrex::TagBox::TagType = char

The type of each tag.

Member Enumeration Documentation

◆ TagVal

enum amrex::TagBox::TagVal

Possible values for each cell.

Enumerator
CLEAR
BUF
SET

Constructor & Destructor Documentation

◆ TagBox() [1/7]

amrex::TagBox::TagBox ( )

defaultnoexcept

◆ TagBox() [2/7]

amrex::TagBox::TagBox ( Arena * ar )

explicitnoexcept

◆ TagBox() [3/7]

amrex::TagBox::TagBox	(	const Box &	bx,
		int	n,
		Arena *	ar
	)

◆ TagBox() [4/7]

amrex::TagBox::TagBox	(	const Box &	bx,
		int	n = `1`,
		bool	alloc = `true`,
		bool	shared = `false`,
		Arena *	ar = `nullptr`
	)

explicit

◆ TagBox() [5/7]

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

◆ ~TagBox()

amrex::TagBox::~TagBox ( )

overridedefaultnoexcept

◆ TagBox() [6/7]

amrex::TagBox::TagBox ( TagBox && rhs )

defaultnoexcept

◆ TagBox() [7/7]

amrex::TagBox::TagBox ( const TagBox & rhs )

delete

Member Function Documentation

◆ buffer()

void amrex::TagBox::buffer	(	const IntVect &	a_nbuff,
		const IntVect &	nwid
	)

noexcept

Mark neighbors of every tagged cell a distance nbuff away only search interior for initial tagged points where nwid is given as the width of the bndry region.

Parameters

nbuff
nwid

◆ coarsen()

void amrex::TagBox::coarsen	(	const IntVect &	ratio,
		const Box &	cbox
	)

noexcept

Construct and return a new tagbox in which the coarsened cell is tagged of any of the corresponding fine cells are tagged.

◆ get_itags()

void amrex::TagBox::get_itags	(	Vector< int > &	ar,
		const Box &	tilebx
	)		const

noexcept

Since a TagBox is a BaseFab<char>, we can use this utility function to allocate an integer array to have the same number of elements as cells in tilebx.

Parameters

ar
tilebx

◆ operator=() [1/2]

TagBox& amrex::TagBox::operator= ( const TagBox & rhs )

delete

◆ operator=() [2/2]

TagBox& amrex::TagBox::operator= ( TagBox && rhs )

delete

◆ tags() [1/3]

Vector< int > amrex::TagBox::tags ( ) const

noexcept

Returns Vector<int> of size domain.numPts() suitable for calling Fortran, with positions set to same value as in the TagBox dataPtr().

◆ tags() [2/3]

void amrex::TagBox::tags ( const Vector< int > & ar )

noexcept

Set values as specified by the array – this only tags. It's an error if ar.length() != domain.numPts().

Parameters

ar

◆ tags() [3/3]

void amrex::TagBox::tags	(	const Vector< int > &	ar,
		const Box &	tilebx
	)

noexcept

Set values as specified by the array – this only tags. only changes values in the tilebx region.

Parameters

ar
tilebx

◆ tags_and_untags() [1/2]

void amrex::TagBox::tags_and_untags ( const Vector< int > & ar )

noexcept

Set values as specified by the array – this tags and untags. It's an error if ar.length() != domain.numPts().

Parameters

ar

◆ tags_and_untags() [2/2]

void amrex::TagBox::tags_and_untags	(	const Vector< int > &	ar,
		const Box &	tilebx
	)

noexcept

Set values as specified by the array – this tags and untags. only changes values in the tilebx region.

Parameters

ar
tilebx

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

/home/runner/work/amrex/amrex/Src/AmrCore/AMReX_TagBox.H
/home/runner/work/amrex/amrex/Src/AmrCore/AMReX_TagBox.cpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TagType

Member Enumeration Documentation

◆ TagVal

Constructor & Destructor Documentation

◆ TagBox() [1/7]

◆ TagBox() [2/7]

◆ TagBox() [3/7]

◆ TagBox() [4/7]

◆ TagBox() [5/7]

◆ ~TagBox()

◆ TagBox() [6/7]

◆ TagBox() [7/7]

Member Function Documentation

◆ buffer()

◆ coarsen()

◆ get_itags()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ tags() [1/3]

◆ tags() [2/3]

◆ tags() [3/3]

◆ tags_and_untags() [1/2]

◆ tags_and_untags() [2/2]