#include <BaseFab.H>
Inheritance diagram for BaseFab< T >:
Public Member Functions | |
| BaseFab () | |
| { constructors, destructor and defines} | |
| BaseFab (const Box &bx, int n, T *alias=NULL) | |
| BaseFab (const Interval &a_comps, BaseFab< T > &a_original) | |
| virtual | ~BaseFab () |
| void | resize (const Box &b, int N=1, T *alias=NULL) |
| virtual void | define (const Box &box, int comps, T *alias=NULL) |
| virtual void | define (const Interval &a_comps, BaseFab< T > &a_original) |
| void | clear () |
| int | nComp () const |
| { accessors} | |
| const Box & | box () const |
| const int * | size () const |
| const IntVect & | smallEnd () const |
| const IntVect & | bigEnd () const |
| Interval | interval () const |
| T & | operator() (const IntVect &p, int N) |
| T & | operator() (const IntVect &p) |
| const T & | operator() (const IntVect &p, int N) const |
| const T & | operator() (const IntVect &p) const |
| void | getVal (T *data, const IntVect &pos, int N, int numcomp) const |
| void | getVal (T *data, const IntVect &pos) const |
| const int * | loVect () const |
| { Fortran interface functions} | |
| const int * | hiVect () const |
| const int * | nCompPtr () const |
| T * | dataPtr (int N=0) |
| const T * | dataPtr (int N=0) const |
| bool | contains (const BaseFab< T > &fab) const |
| { comparison functions} | |
| bool | contains (const Box &bx) const |
| void | setVal (T x, const Box &bx, int nstart, int ncomp) |
| { data modification functions} | |
| void | setVal (T x, const Box &bx, int N) |
| void | setVal (T x, int N) |
| void | setVal (T x) |
| BaseFab< T > & | copy (const BaseFab< T > &src, const Box &srcbox, int srccomp, const Box &destbox, int destcomp, int numcomp) |
| BaseFab< T > & | copy (const BaseFab< T > &src, int srccomp, int destcomp, int numcomp=1) |
| BaseFab< T > & | copy (const BaseFab< T > &src, const Box &destbox) |
| BaseFab< T > & | copy (const BaseFab< T > &src) |
| void | copy (const Box &RegionFrom, const Interval &Cdest, const Box &RegionTo, const BaseFab< T > &src, const Interval &Csrc) |
| BaseFab< T > & | shift (const IntVect &v) |
| { domain modification functions} | |
| BaseFab< T > & | shift (int idir, int n_cell) |
| BaseFab< T > & | shiftHalf (int dir, int num_halfs) |
| BaseFab< T > & | shiftHalf (const IntVect &num_halfs) |
| virtual int | size (const Box &b, const Interval &comps) const |
| { linearization functions} | |
| virtual void | linearOut (void *buf, const Box &R, const Interval &comps) const |
| virtual void | linearIn (void *buf, const Box &R, const Interval &comps) |
Static Public Member Functions | |
| int | preAllocatable () |
Protected Member Functions | |
| void | define () |
| void | undefine () |
| virtual void | performCopy (const BaseFab< T > &src, const Box &srcbox, int srccomp, const Box &destbox, int destcomp, int numcomp) |
| void | performSetVal (T x, const Box &bx, int nstart, int numcomp) |
Static Protected Member Functions | |
| std::string | name () |
Protected Attributes | |
| Box | domain |
| int | nvar |
| long | numpts |
| long | truesize |
| T * | dptr |
| bool | aliased |
Static Protected Attributes | |
| Arena * | s_Arena = NULL |
BaseFab emulates the Fortran array concept. Useful operations can be performed upon BaseFab's in C++, and they provide a convenient interface to Fortran when it is necessary to retreat into that language.
`BaseFab' is a template class. Through use of the template, a `BaseFab' may be based upon any class. So far at least, most applications have been based upon simple types like `integer's, `real's, or `doubleprecision's. Most applications do not use BaseFab's directly, but utilize specialized classes derived from BaseFab.
It will be easier to use a `BaseFab' if you understand the following concepts. `BaseFab' objects depend on the dimensionality of space (indirectly through the DOMAIN `Box' member). It is typical to define the macro `CH_SPACEDIM' to be 1, 2, or 3 to indicate the dimension of space. See the discussion of class `Box' for more information. A `BaseFab' contains a `Box' DOMAIN, which indicates the integer indexing space over which the array is defined. A `BaseFab' also has NVAR components. By components, we mean that for each point in the rectangular indexing space, there are NVAR values associated with that point. A Fortran array corresponding to a `BaseFab' would have (CH_SPACEDIM+1) dimensions.
By design, the array layout in a `BaseFab' mirrors that of a Fortran array. The first index (x direction for example) varies most rapidly, the next index (y direction), if any, varies next fastest. The component index varies last, after all the spatial indices.
It is sometimes convenient to be able to treat a sub-array within an existing `BaseFab' as a `BaseFab' in its own right. This is often referred to as 'aliasing' the `BaseFab'. Note that when aliasing is used, the BaseFab's domain will not, in general, be the same as the parent BaseFab's domain, nor will the number of components. BaseFab is a dimension dependent class, so CH_SPACEDIM must be defined as either 1, 2, or 3 when compiling.
This is NOT a polymorphic class.
It does NOT provide a copy constructor or assignment operator.
T MUST have a default constructor and an assignment operator.
|
|||||||||
|
{ constructors, destructor and defines} : Constructs an invalid `BaseFab'. The domain is invalid, the number of components is zero, and no actual array memory is allocated. An invalid `BaseFab' must be resize()d (see `BaseFab::resize') before use. |
|
||||||||||||||||||||
|
Constructs a BaseFab with desired domain and number of components. |
|
||||||||||||||||
|
Constructs an 'aliased' BaseFab of the requested interval of the argument BaseFab. This BaseFab does not allocate any memory, but sets its data pointer into the memory pointed to by the argument BaseFab. It is the users responsiblity to ensure this aliased BaseFab is not used after the original BaseFab has deleted its data ptr (resize, define(..) called, or destruction, etc.). This aliased BaseFab will also generate side effects (modifying the values of data in one will modify the other's data). This aliased BaseFab will have a_comps.size() components, starting at zero. |
|
|||||||||
|
The destructor deletes the array memory. Unless this was an aliased BaseFab. |
|
|||||||||
|
: Returns the upper corner of the domain. See class `Box' for analogue. |
|
|||||||||
|
Returns the domain (box) where the array is defined. |
|
|||||||||
|
: The function returns the `BaseFab' to the invalid state. (See comments for constructors above.) The memory is freed. Reimplemented in BinFab< T >. |
|
||||||||||
|
: Returns true if bx is totally contained within the domain of this `BaseFab'. |
|
||||||||||
|
{ comparison functions} : Returns true if the domain of fab is totally contained within the domain of this `BaseFab'. |
|
||||||||||||||||||||||||||||
|
Copy from a subsection of one box into another. Assumes the boxes are both in the same index space, and that box R is completely contained in both the source and destination boxes. |
|
||||||||||
|
: Modifies this BaseFab by coping the contents of the argument BaseFab into it. A copy within the intersecting region of the domains of the two BaseFabs is performed. All components are copied. |
|
||||||||||||||||
|
: Modifies this BaseFab by coping the contents of the argument BaseFab into it. A copy within the intersecting region of the domains of the two BaseFabs and the specified Box destbox is performed. All components are copied. |
|
||||||||||||||||||||||||
|
: Modifies this BaseFab by copying the contents of the argument BaseFab into it. A copy within the intersecting region of the domains of the two BaseFabs is performed. The user specifies how many components are copied, starting at component srccomp in src and stored starting at component destcomp. |
|
||||||||||||||||||||||||||||||||
|
: Modifies this BaseFab by copying the contents of the argument BaseFab into it. 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 BaseFabs are the same and the srcbox and destbox overlap. |
|
||||||||||
|
: Returns a constant 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. It should not be used in any other context!!! 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. |
|
||||||||||
|
: 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. It should not be used in any other context!!! 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. |
|
|||||||||
|
|
|
||||||||||||||||
|
alias define. no memory allocated. this BaseFab sets its data ptr directly in the a_original BaseFab data. |
|
||||||||||||||||||||
|
: Make BaseFab with desired domain and number of components. existing data is lost. Data is in uninialized state. Reimplemented in FArrayBox. |
|
||||||||||||||||
|
: This function puts all component values, starting at component 0, from position pos in the domain into array data, that must be allocated by the user. |
|
||||||||||||||||||||||||
|
: 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. |
|
|||||||||
|
: Returns the upper corner of the domain. Instead of returning them in the form of IntVects, as in smallEnd and bigEnd, it returns the values as a pointer to an array of constant integers. This is useful when interfacing to Fortran subroutines. It should not be used in any other context!!! |
|
|||||||||
|
Returns an Interval for the entire range on components. |
|
||||||||||||||||||||
|
Reimplemented in BinFab< T >. |
|
||||||||||||||||||||
|
Write a linear representation of the internal data. Assumes that sufficient memory for the buffer has already been allocated by the caller. Reimplemented in BinFab< T >. |
|
|||||||||
|
{ Fortran interface functions} : Returns the lower corner of the domain. Instead of returning them in the form of IntVects, as in smallEnd and bigEnd, it returns the values as a pointer to an array of constant integers. This is useful when interfacing to Fortran subroutines. It should not be used in any other context!!! |
|
|||||||||
|
|
|
|||||||||
|
{ accessors} Returns the number of components. |
|
|||||||||
|
: Returns a pointer to an integer that contains the number of components in the BaseFab. This is useful when interfacing to Fortran subroutines. It should not be used in any other context!!! |
|
||||||||||
|
|
|
||||||||||||||||
|
: Returns a conatant 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. |
|
||||||||||
|
|
|
||||||||||||||||
|
: Returns a modifiable lvalue 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. |
|
||||||||||||||||||||||||||||||||
|
Reimplemented in FArrayBox. |
|
||||||||||||||||||||||||
|
|
|
|||||||||
|
Reimplemented in BinFab< T >. |
|
||||||||||||||||||||
|
This function resizes a `BaseFab' so it covers the `Box' B with N components. The default action is that under resize()ing, the memory allocated for the `BaseFab' only grows and never shrinks. This function is particularly useful when a `BaseFab' is used as a temporary space which must be a different size whenever it is used. Resize()ing a temp will often be faster than re-allocating a `BaseFab' because memory allocation can often be avoided. |
|
||||||||||
|
Modifies this BaseFab so that all values of all components are set to the given value x. |
|
||||||||||||||||
|
Modifies this BaseFab so that all values of component N are set to the given value x. |
|
||||||||||||||||||||
|
Modifies this BaseFab so that all values of component N in the specified Box bx are set to the given value x. |
|
||||||||||||||||||||||||
|
{ data modification functions} : The setVal functions set subregions 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. |
|
||||||||||||||||
|
Modifies the domain of this BaseFab by shifting it n_cells indexing positions in coordinate direction idir. Directions are zero-based. It is an error if not 0 <= idir < SpaceDim.There is no effect upon the array memory. |
|
||||||||||
|
{ domain modification functions} Modifies the domain of this BaseFab by shifting. Equivalent to fab.shift(0,iv[0]).shift(1,iv[1]) .... There is no effect upon the array memory. |
|
||||||||||
|
Modifies the domain of this BaseFab by shifting by half indices. Equivalent to fab.shiftHalf(0,iv[0]).shiftHalf(1,iv[1]) ... There is no effect upon the array memory. |
|
||||||||||||||||
|
Modifies the domain of this BaseFab by shifting by "half" indices, thereby converting the Box from type CELL to NODE or vice-versa. fab.shiftHalf(0,1) shifts the domain to the right by 1/2 cells. fab.shiftHalf(1,-3) shifts the domain in the -j direction by 3/2 cells. NOTE: If num is EVEN the shift is num/2 full zones and hence will not change the type. This is: fab.shifthalf(4) == fab.shift(2). Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. There is no effect upon the array memory. |
|
||||||||||||||||
|
{ linearization functions} Returns the size, in number of bytes, of a flat linear representation of the data in this object in the area defined by the input Box R and the component Interval comps. The size does not include the size of R and comps. Reimplemented in BinFab< T >. |
|
|||||||||
|
: Returns a pointer to an array of SpaceDim integers giving the length of the domain in each direction. |
|
|||||||||
|
: Returns the lower corner of the domain. See class `Box' for analogue. |
|
|||||||||
|
|
|
|||||
|
|
|
|||||
|
|
|
|||||
|
|
|
|||||
|
|
|
|||||
|
|
|
|||||
|
|
|
|||||
|
|
1.3.2