Block-Structured AMR Software Framework
amrex::Mask Class Referencefinal

#include <AMReX_Mask.H>

Inheritance diagram for amrex::Mask:
amrex::BaseFab< int > amrex::DataAllocator

Public Member Functions

 Mask () noexcept=default
 
 Mask (Arena *ar) noexcept
 
 Mask (const Box &bx, int nc, Arena *ar)
 
 Mask (const Box &bx, int nc=1, bool alloc=true, bool shared=false, Arena *ar=nullptr)
 
 Mask (std::istream &is)
 construct from input stream More...
 
 Mask (Array4< int > const &a) noexcept
 
 Mask (Array4< int > const &a, IndexType t) noexcept
 
 Mask (Array4< int const > const &a) noexcept
 
 Mask (Array4< int const > const &a, IndexType t) noexcept
 
 ~Mask () noexcept override=default
 
 Mask (Mask &&rhs) noexcept=default
 
 Mask (Mask const &rhs, MakeType make_type, int scomp, int ncomp)
 
 Mask (const Mask &)=delete
 
Maskoperator= (const Mask &)=delete
 
Maskoperator= (Mask &&)=delete
 
void readFrom (std::istream &)
 initialize from stream, FAB-style More...
 
void writeOn (std::ostream &) const
 output to stream, FAB-style More...
 
template<RunOn run_on>
Maskoperator&= (const Mask &src) noexcept
 in-place And operator More...
 
template<RunOn run_on>
MaskAnd (const Mask &src) noexcept
 in-place And More...
 
template<RunOn run_on>
MaskAnd (const Mask &src, int srccomp, int destcomp, int numcomp=1) noexcept
 as above, but specify source/destination/number of components More...
 
template<RunOn run_on>
MaskAnd (const Mask &src, const Box &subbox, int srccomp, int destcomp, int numcomp=1) noexcept
 as above, and specify subregion More...
 
template<RunOn run_on>
MaskAnd (const Mask &src, const Box &srcbox, const Box &destbox, int srccomp, int destcomp, int numcomp=1) noexcept
 in-pace And, over source components to destination components, and on intersection of source and destination boxes More...
 
template<RunOn run_on>
Maskoperator|= (const Mask &src) noexcept
 in-place Or operator More...
 
template<RunOn run_on>
MaskOr (const Mask &src) noexcept
 in-place Or More...
 
template<RunOn run_on>
MaskOr (const Mask &src, int srccomp, int destcomp, int numcomp=1) noexcept
 as above, but specify source/destination/number of components More...
 
template<RunOn run_on>
MaskOr (const Mask &src, const Box &subbox, int srccomp, int destcomp, int numcomp=1) noexcept
 as above, and specify subregion More...
 
template<RunOn run_on>
MaskOr (const Mask &src, const Box &srcbox, const Box &destbox, int srccomp, int destcomp, int numcomp=1) noexcept
 in-pace Or, over source components to destination components, and on intersection of source and destination boxes More...
 
- Public Member Functions inherited from amrex::BaseFab< int >
 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< int > &rhs, MakeType make_type, int scomp, int ncomp)
 
 BaseFab (const Box &bx, int ncomp, int *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, int const *p)
 
 BaseFab (Array4< int > const &a) noexcept
 
 BaseFab (Array4< int > const &a, IndexType t) noexcept
 
 BaseFab (Array4< int const > const &a) noexcept
 
 BaseFab (Array4< int const > const &a, IndexType t) noexcept
 
 BaseFab (const BaseFab< int > &rhs)=delete
 
 BaseFab (BaseFab< int > &&rhs) noexcept
 
virtual ~BaseFab () noexcept
 The destructor deletes the array memory. More...
 
BaseFab< int > & operator= (const BaseFab< int > &rhs)=delete
 
BaseFab< int > & operator= (BaseFab< int > &&rhs) noexcept
 
BaseFaboperator= (int const &) noexcept
 
BaseFab< int > & operator= (int 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< int, DataDeleterrelease () 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 Boxbox () 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 IntVectsmallEnd () const noexcept
 Returns the lower corner of the domain See class Box for analogue. More...
 
const IntVectbigEnd () 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< int > &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...
 
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. More...
 
const int * dataPtr (int n=0) const noexcept
 Same as above except works on const FABs. More...
 
int * dataPtr (const IntVect &p, int n=0) noexcept
 
const int * dataPtr (const IntVect &p, int n=0) const noexcept
 
void setPtr (int *p, Long sz) noexcept
 
void prefetchToHost () const noexcept
 
void prefetchToDevice () const noexcept
 
AMREX_FORCE_INLINE Array4< int const > array () const noexcept
 
AMREX_FORCE_INLINE Array4< int const > array (int start_comp) const noexcept
 
AMREX_FORCE_INLINE Array4< int const > array (int start_comp, int num_comps) const noexcept
 
AMREX_FORCE_INLINE Array4< int > array () noexcept
 
AMREX_FORCE_INLINE Array4< int > array (int start_comp) noexcept
 
AMREX_FORCE_INLINE Array4< int > array (int start_comp, int num_comps) noexcept
 
AMREX_FORCE_INLINE Array4< int const > const_array () const noexcept
 
AMREX_FORCE_INLINE Array4< int const > const_array (int start_comp) const noexcept
 
AMREX_FORCE_INLINE Array4< int 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...
 
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. More...
 
int & operator() (const IntVect &p) noexcept
 Same as above, except returns component 0. More...
 
const int & operator() (const IntVect &p, int N) const noexcept
 Same as above except works on const FABs. More...
 
const int & operator() (const IntVect &p) const noexcept
 Same as above, except returns component 0. More...
 
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. More...
 
void getVal (int *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 (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. More...
 
void setVal (int 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 (int const &x, int N) noexcept
 Same as above, except the sub-box defaults to the entire domain. More...
 
void setVal (int const &val) noexcept
 Set value on the whole domain and all components. More...
 
void setVal (int const &x, Box const &bx, DestComp dcomp, NumComps ncomp) noexcept
 Do nothing if bx is empty. More...
 
void setValIfNot (int const &val, const Box &bx, const BaseFab< int > &mask, int nstart, int num) noexcept
 
void setValIfNot (int const &val, const BaseFab< int > &mask) noexcept
 
void setValIfNot (int const &val, Box const &bx, const BaseFab< int > &mask, DestComp dcomp, NumComps ncomp) noexcept
 Do nothing if bx is empty. More...
 
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. More...
 
void setComplement (int const &x, Box const &bx, DestComp dcomp, NumComps ncomp) noexcept
 setVal on the complement of bx in the fab's domain More...
 
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. More...
 
BaseFab< int > & copy (const BaseFab< int > &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< int > & copy (const BaseFab< int > &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< int > & copy (const BaseFab< int > &src) noexcept
 
BaseFab< int > & copy (const BaseFab< int > &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< 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. More...
 
BaseFab< int > & 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< 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. More...
 
BaseFab< int > & 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...
 
int min (int comp=0) const noexcept
 
int min (const Box &subbox, int comp=0) const noexcept
 
int max (int comp=0) const noexcept
 
int max (const Box &subbox, int comp=0) const noexcept
 
std::pair< int, int > minmax (int comp=0) const noexcept
 
std::pair< int, int > minmax (const Box &subbox, int comp=0) const noexcept
 
int maxabs (int comp=0) const noexcept
 
int maxabs (const Box &subbox, 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 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, 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. More...
 
int maskLE (BaseFab< int > &mask, int 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, int const &val, int comp=0) const noexcept
 Same as above except mark cells with value equal to val. More...
 
int maskGT (BaseFab< int > &mask, int const &val, int comp=0) const noexcept
 Same as above except mark cells with value greater than val. More...
 
int maskGE (BaseFab< int > &mask, int const &val, int comp=0) const noexcept
 Same as above except mark cells with value greater than or equal to val. More...
 
int sum (int comp, int numcomp=1) const noexcept
 Returns sum of given component of FAB state vector. More...
 
int sum (const Box &subbox, int comp, int numcomp=1) const noexcept
 Compute sum of given component of FAB state vector in given subbox. More...
 
int sum (const Box &bx, DestComp dcomp, NumComps ncomp) const noexcept
 Sum. More...
 
BaseFab< int > & invert (int const &r, const Box &b, int comp=0, int numcomp=1) noexcept
 Most general version, specify subbox and which components. More...
 
BaseFab< int > & invert (int const &r, int comp, int numcomp=1) noexcept
 As above except on entire domain. More...
 
BaseFab< int > & invert (int const &r) noexcept
 Fab <- Fab/r on the whole domain and all components. More...
 
BaseFab< int > & invert (int const &r, const Box &bx, DestComp dcomp, NumComps ncomp) noexcept
 
BaseFab< int > & negate (const Box &b, int comp=0, int numcomp=1) noexcept
 Negate BaseFab, most general. More...
 
BaseFab< int > & negate (int comp, int numcomp=1) noexcept
 As above, except on entire domain. More...
 
BaseFab< int > & negate () noexcept
 on the whole domain and all components More...
 
BaseFab< int > & negate (const Box &bx, DestComp dcomp, NumComps ncomp) noexcept
 
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. More...
 
BaseFab< int > & plus (int const &r, int comp, int numcomp=1) noexcept
 As above, except on entire domain. More...
 
BaseFab< int > & plus (const BaseFab< int > &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< int > & plus (const BaseFab< int > &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< int > & plus (const BaseFab< int > &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< int > & plus (int const &val) noexcept
 Scalar addition on the whole domain and all components. More...
 
BaseFab< int > & plus (int const &val, Box const &bx, DestComp dcomp, NumComps ncomp) noexcept
 Do nothing if bx is empty. More...
 
BaseFab< int > & plus (const BaseFab< int > &src) noexcept
 
BaseFab< int > & plus (const BaseFab< int > &src, Box bx, SrcComp scomp, DestComp dcomp, NumComps ncomp) noexcept
 Do nothing if bx does not intersect with src fab. More...
 
BaseFab< int > & atomicAdd (const BaseFab< int > &x) noexcept
 Atomic FAB addition (a[i] <- a[i] + b[i]). More...
 
BaseFab< int > & atomicAdd (const BaseFab< int > &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< int > & atomicAdd (const BaseFab< int > &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< int > & atomicAdd (const BaseFab< int > &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< 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. More...
 
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. More...
 
BaseFab< int > & saxpy (int a, const BaseFab< int > &x) noexcept
 FAB SAXPY (y[i] <- y[i] + a * x[i]), in place. All components. More...
 
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]) More...
 
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]) More...
 
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. More...
 
BaseFab< int > & minus (const BaseFab< int > &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< int > & minus (const BaseFab< int > &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< int > & minus (int const &val) noexcept
 Scalar subtraction on the whole domain and all components. More...
 
BaseFab< int > & minus (int const &val, Box const &bx, DestComp dcomp, NumComps ncomp) noexcept
 Do nothing if bx is empty. More...
 
BaseFab< int > & minus (const BaseFab< int > &src) noexcept
 
BaseFab< int > & minus (const BaseFab< int > &src, Box bx, SrcComp scomp, DestComp dcomp, NumComps ncomp) noexcept
 Do nothing if bx does not intersect with src fab. More...
 
BaseFab< int > & mult (int const &r, int comp, int numcomp=1) noexcept
 Scalar multiplication, except control which components are multiplied. More...
 
BaseFab< int > & mult (int const &r, const Box &b, int comp=0, int numcomp=1) noexcept
 As above, except specify sub-box. More...
 
BaseFab< int > & mult (const BaseFab< int > &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< int > & mult (const BaseFab< int > &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< int > & mult (const BaseFab< int > &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< int > & mult (int const &val) noexcept
 Scalar multiplication on the whole domain and all components. More...
 
BaseFab< int > & mult (int const &val, Box const &bx, DestComp dcomp, NumComps ncomp) noexcept
 Do nothing if bx is empty. More...
 
BaseFab< int > & mult (const BaseFab< int > &src) noexcept
 
BaseFab< int > & mult (const BaseFab< int > &src, Box bx, SrcComp scomp, DestComp dcomp, NumComps ncomp) noexcept
 Do nothing if bx does not intersect with src fab. More...
 
BaseFab< int > & divide (int const &r, int comp, int numcomp=1) noexcept
 As above except specify which components. More...
 
BaseFab< int > & divide (int const &r, const Box &b, int comp=0, int numcomp=1) noexcept
 As above except specify sub-box. More...
 
BaseFab< int > & divide (const BaseFab< int > &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< int > & divide (const BaseFab< int > &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< int > & divide (const BaseFab< int > &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< int > & divide (int const &val) noexcept
 Scalar division on the whole domain and all components. More...
 
BaseFab< int > & divide (int const &val, Box const &bx, DestComp dcomp, NumComps ncomp) noexcept
 Do nothing if bx is empty. More...
 
BaseFab< int > & divide (const BaseFab< int > &src) noexcept
 
BaseFab< int > & divide (const BaseFab< int > &src, Box bx, SrcComp scomp, DestComp dcomp, NumComps ncomp) noexcept
 Do nothing if bx does not intersect with src fab. More...
 
BaseFab< int > & protected_divide (const BaseFab< int > &src) noexcept
 Divide wherever "src" is "true" or "non-zero". More...
 
BaseFab< int > & protected_divide (const BaseFab< int > &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< int > & protected_divide (const BaseFab< int > &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< int > & protected_divide (const BaseFab< int > &src, const Box &srcbox, const Box &destbox, int srccomp, int destcomp, int numcomp=1) noexcept
 
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. More...
 
BaseFab< int > & linInterp (const BaseFab< int > &f1, int comp1, const BaseFab< int > &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< 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 alpha*f1 + beta*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...
 
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. More...
 
int dot (const BaseFab< int > &src, const Box &bx, SrcComp scomp, DestComp dcomp, NumComps ncomp) const noexcept
 Dot product of two Fabs. More...
 
int dot (const Box &bx, int destcomp, int numcomp) const noexcept
 Int wrapper for dot. More...
 
int dot (const Box &bx, DestComp dcomp, NumComps ncomp) const noexcept
 Dot product. More...
 
int dotmask (const BaseFab< int > &mask, const Box &xbx, int xcomp, const BaseFab< int > &y, const Box &ybx, int ycomp, int numcomp) const noexcept
 
int dotmask (const BaseFab< int > &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 (int const &val, const BaseFab< int > &mask) noexcept
 
void setValIf (int const &val, Box const &bx, const BaseFab< int > &mask, DestComp dcomp, NumComps ncomp) noexcept
 Do nothing if bx is empty. More...
 
BaseFab< int > & operator+= (int const &val) noexcept
 
BaseFab< int > & operator+= (const BaseFab< int > &src) noexcept
 
BaseFab< int > & operator-= (int const &val) noexcept
 
BaseFab< int > & operator-= (const BaseFab< int > &src) noexcept
 
BaseFab< int > & operator*= (int const &val) noexcept
 
BaseFab< int > & operator*= (const BaseFab< int > &src) noexcept
 
BaseFab< int > & operator/= (int const &val) noexcept
 
BaseFab< int > & operator/= (const BaseFab< int > &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
 
Arenaarena () const noexcept
 

Friends

std::istream & operator>> (std::istream &, Mask &)
 Initialize from stream. More...
 
std::ostream & operator<< (std::ostream &, const Mask &)
 output to stream More...
 

Additional Inherited Members

- Public Types inherited from amrex::BaseFab< int >
using value_type = int
 
- Static Public Member Functions inherited from amrex::BaseFab< int >
static void Initialize ()
 
static void Finalize ()
 
- Public Attributes inherited from amrex::DataAllocator
Arenam_arena = nullptr
 
- Protected Member Functions inherited from amrex::BaseFab< int >
void define ()
 Allocates memory for the BaseFab<T>. More...
 
- Protected Attributes inherited from amrex::BaseFab< int >
int * 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

A Mask is a derived Fab class whose elements maintain a logical "TRUE" or "FALSE" state. A Mask can perform several elementary logical operations on its data members.

Implement a logical class Mask to maintain the TRUE or FALSE state of elements in a box. A Mask can perform element-wise logical operations, but is otherwise very similar to an FArrayBox object. A Mask object can set its components based on comparing (a subregion of a) real-valued FArrayBox element magnitudes to a scalar value, or by "and", "or" operations with (the a subregion of) other Masks.

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

Constructor & Destructor Documentation

◆ Mask() [1/12]

amrex::Mask::Mask ( )
defaultnoexcept

◆ Mask() [2/12]

amrex::Mask::Mask ( Arena ar)
explicitnoexcept

◆ Mask() [3/12]

amrex::Mask::Mask ( const Box bx,
int  nc,
Arena ar 
)

◆ Mask() [4/12]

amrex::Mask::Mask ( const Box bx,
int  nc = 1,
bool  alloc = true,
bool  shared = false,
Arena ar = nullptr 
)
explicit

◆ Mask() [5/12]

amrex::Mask::Mask ( std::istream &  is)
explicit

construct from input stream

◆ Mask() [6/12]

amrex::Mask::Mask ( Array4< int > const &  a)
inlineexplicitnoexcept

◆ Mask() [7/12]

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

◆ Mask() [8/12]

amrex::Mask::Mask ( Array4< int const > const &  a)
inlineexplicitnoexcept

◆ Mask() [9/12]

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

◆ ~Mask()

amrex::Mask::~Mask ( )
overridedefaultnoexcept

◆ Mask() [10/12]

amrex::Mask::Mask ( Mask &&  rhs)
defaultnoexcept

◆ Mask() [11/12]

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

◆ Mask() [12/12]

amrex::Mask::Mask ( const Mask )
delete

Member Function Documentation

◆ And() [1/4]

template<RunOn run_on>
Mask & amrex::Mask::And ( const Mask src)
noexcept

in-place And

Parameters
src

◆ And() [2/4]

template<RunOn run_on>
Mask & amrex::Mask::And ( const Mask src,
const Box srcbox,
const Box destbox,
int  srccomp,
int  destcomp,
int  numcomp = 1 
)
noexcept

in-pace And, over source components to destination components, and on intersection of source and destination boxes

Parameters
src
srcbox
destbox
srccomp
destcomp
numcomp

◆ And() [3/4]

template<RunOn run_on>
Mask & amrex::Mask::And ( const Mask src,
const Box subbox,
int  srccomp,
int  destcomp,
int  numcomp = 1 
)
noexcept

as above, and specify subregion

Parameters
src
subbox
srccomp
destcomp
numcomp

◆ And() [4/4]

template<RunOn run_on>
Mask & amrex::Mask::And ( const Mask src,
int  srccomp,
int  destcomp,
int  numcomp = 1 
)
noexcept

as above, but specify source/destination/number of components

Parameters
src
srccomp
destcomp
numcomp

◆ operator&=()

template<RunOn run_on>
Mask& amrex::Mask::operator&= ( const Mask src)
inlinenoexcept

in-place And operator

◆ operator=() [1/2]

Mask& amrex::Mask::operator= ( const Mask )
delete

◆ operator=() [2/2]

Mask& amrex::Mask::operator= ( Mask &&  )
delete

◆ operator|=()

template<RunOn run_on>
Mask& amrex::Mask::operator|= ( const Mask src)
inlinenoexcept

in-place Or operator

◆ Or() [1/4]

template<RunOn run_on>
Mask & amrex::Mask::Or ( const Mask src)
noexcept

in-place Or

Parameters
src

◆ Or() [2/4]

template<RunOn run_on>
Mask & amrex::Mask::Or ( const Mask src,
const Box srcbox,
const Box destbox,
int  srccomp,
int  destcomp,
int  numcomp = 1 
)
noexcept

in-pace Or, over source components to destination components, and on intersection of source and destination boxes

Parameters
src
srcbox
destbox
srccomp
destcomp
numcomp

◆ Or() [3/4]

template<RunOn run_on>
Mask & amrex::Mask::Or ( const Mask src,
const Box subbox,
int  srccomp,
int  destcomp,
int  numcomp = 1 
)
noexcept

as above, and specify subregion

Parameters
src
subbox
srccomp
destcomp
numcomp

◆ Or() [4/4]

template<RunOn run_on>
Mask & amrex::Mask::Or ( const Mask src,
int  srccomp,
int  destcomp,
int  numcomp = 1 
)
noexcept

as above, but specify source/destination/number of components

Parameters
src
srccomp
destcomp
numcomp

◆ readFrom()

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

initialize from stream, FAB-style

◆ writeOn()

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

output to stream, FAB-style

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const Mask m 
)
friend

output to stream

◆ operator>>

std::istream& operator>> ( std::istream &  is,
Mask m 
)
friend

Initialize from stream.


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