#include <source/patchdata/outerface/OuterfaceData.h>
Inheritance diagram for SAMRAI::pdat::OuterfaceData< DIM, TYPE >:
Public Member Functions | |
| OuterfaceData (const hier::Box< DIM > &box, const int depth, tbox::Pointer< tbox::Arena > pool=tbox::Pointer< tbox::Arena >(NULL)) | |
| virtual | ~OuterfaceData () |
| virtual void | copy (const hier::PatchData< DIM > &src) |
| virtual void | copy2 (hier::PatchData< DIM > &dst) const |
| virtual void | copy (const hier::PatchData< DIM > &src, const hier::BoxOverlap< DIM > &overlap) |
| virtual void | copy2 (hier::PatchData< DIM > &dst, const hier::BoxOverlap< DIM > &overlap) const |
| void | copyDepth (int dst_depth, const FaceData< DIM, TYPE > &src, int src_depth) |
| Fast copy between the source and destination at the specified depths. | |
| virtual bool | canEstimateStreamSizeFromBox () const |
| virtual int | getDataStreamSize (const hier::BoxOverlap< DIM > &overlap) const |
| virtual void | packStream (tbox::AbstractStream &stream, const hier::BoxOverlap< DIM > &overlap) const |
| virtual void | unpackStream (tbox::AbstractStream &stream, const hier::BoxOverlap< DIM > &overlap) |
| int | getDepth () const |
| TYPE * | getPointer (const int axis, const int face, const int d=0) |
| const TYPE * | getPointer (const int axis, const int face, const int d=0) const |
| ArrayData< DIM, TYPE > & | getArrayData (const int axis, const int face) |
| const ArrayData< DIM, TYPE > & | getArrayData (const int axis, const int face) const |
| TYPE & | operator() (const FaceIndex< DIM > &i, const int face, const int d=0) |
| const TYPE & | operator() (const FaceIndex< DIM > &i, const int face, const int d=0) const |
| void | fill (const TYPE &t, const int d=0) |
| void | fill (const TYPE &t, const hier::Box< DIM > &box, const int d=0) |
| void | fillAll (const TYPE &t) |
| void | fillAll (const TYPE &t, const hier::Box< DIM > &box) |
| void | print (const hier::Box< DIM > &box, ostream &os=tbox::plog, int prec=-1) const |
| void | print (const hier::Box< DIM > &box, const int d, ostream &os=tbox::plog, int prec=-1) const |
| void | printAxisFace (const int axis, const int face, const hier::Box< DIM > &box, ostream &os=tbox::plog, int prec=-1) const |
| void | printAxisFace (const int axis, const int face, const hier::Box< DIM > &box, const int d, ostream &os=tbox::plog, int prec=-1) const |
| virtual void | getSpecializedFromDatabase (tbox::Pointer< tbox::Database > database) |
| virtual void | putSpecializedToDatabase (tbox::Pointer< tbox::Database > database) |
Static Public Member Functions | |
| static size_t | getSizeOfData (const hier::Box< DIM > &box, const int depth) |
Outerface data is stored in 2*DIM arrays, containing the data for the patch boundary faces with each of the possible outward pointing normal directions. In each of these arrays, memory allocation is in column-major ordering (e.g., Fortran style) so that the leftmost index runs fastest in memory. In addition, the indices are permuted to match the face data storage. For example, a three-dimensional outerface data object instantiated with a box [l0:u0,l1:u1,l2:u2] allocates six data (i.e., three pairs) arrays dimensioned as:
[ l1 : u1 ,
l2 : u2 , d ] ,
[ l2 : u2 ,
l0 : u0 , d ] ,
[ l0 : u0 ,
l1 : u1 , d ] ,
* IMPORTANT: The OutersideData class provides the same storage as this outerface data class, except that the individual arrays are not permuted in the outerside data type. Also, outerface and outerside data classes are intended to interact with their face-centered and side-centered data counterparts, respectively. Mixing types, while allowed, is discouraged to prevent undesirable behavior.
The data type TYPE must define a default constructor (that takes no arguments) and also the assignment operator.
pdat::OuterfaceIndex
pdat::OuterfaceIterator
|
||||||||||||||||||||
|
The constructor for an outerface data object. The box describes the interior of the index space and the depth gives the number of components for each spatial location in the array. If the memory arena is not given, then the standard arena is used. Note that the ghost cell width is currently fixed at zero. |
|
|||||||||
|
The virtual destructor for a outerface data object. |
|
||||||||||
|
A fast copy between the source and destination (i.e., this) patch data objects. Data is copied where there is overlap in the underlying index space. The copy is performed on the interior plus the ghost cell width (for both the source and destination). Currently, source data must be FaceData. |
|
||||||||||
|
A fast copy between the source and destination. Member function copy2() is similar to copy() except that the location of source and destination are reversed and copy2() throws an exception (aka dumps core) if it does not understand the type of the argument. Currently, the destination data must be FaceData. |
|
||||||||||||||||
|
Not yet implemented! Copy data from the source into the destination using the designated overlap descriptor. The overlap description will have been computed using the appropriate box geometry objects. Currently, this function does nothing since copying to Outerface from Outerface is not defined on all box overlap configurations. |
|
||||||||||||||||
|
Copy data from the source into the destination using the designated overlap descriptor. Member function copy2() is similar to the copy() member function except that the location of source and destination are reversed and copy2() throws an exception (aka dumps core) if it does not understand the type of the argument. Currently, the destination data must be FaceData. |
|
||||||||||||||||||||
|
Fast copy between the source and destination at the specified depths. Data is copied from the source into the destination where there is overlap in the underlying index space. The copy is performed on the interior plus the ghost cell width (for both the source and destination). |
|
|||||||||
|
Determines whether the patch data subclass can estinate the necessary stream size using only index space information. This routine is defined for the standard built-in types (bool, char, double, float, and int). Implements SAMRAI::hier::PatchData< DIM >. |
|
||||||||||
|
Calculate the number of bytes needed to stream the data lying in the specified box domain. This routine is defined for the standard built-in types (bool, char, double, float, and int). |
|
||||||||||||||||
|
Pack data lying on the specified index set into the output stream. |
|
||||||||||||||||
|
Unpack data from the message stream into the specified index set. |
|
|||||||||
|
Return the depth (e.g., the number of components in each spatial location) of the array. |
|
||||||||||||||||||||
|
Get a pointer to the beginning of a particular component of the outerface centered array. The axis gives the X=0, Y=1, or Z=2 axis and the face gives the lower=0 or upper=1 face. |
|
||||||||||||||||||||
|
Get a const pointer to the beginning of a particular component of the outerface centered array. The axis gives the X=0, Y=1, or Z=2 axis and the face gives the lower=0 or upper=1 face. |
|
||||||||||||||||
|
Get a pointer to the array data object of a particular component of the outerface centered array. The axis gives the X=0, Y=1, or Z=2 axis and the face gives the lower=0 or upper=1 face. |
|
||||||||||||||||
|
Get a const pointer to the array data object of a particular component of the outerface centered array. The axis gives the X=0, Y=1, or Z=2 axis and the face gives the lower=0 or upper=1 face. |
|
||||||||||||||||||||
|
hier::Index into the outerface data array using a face index. |
|
||||||||||||||||||||
|
hier::Index into the outerface data array (via a const reference) using a face index. |
|
||||||||||||||||
|
Fill all values of component d with the value t. |
|
||||||||||||||||||||
|
Fill all values of component d within the box with the value t. |
|
||||||||||
|
Fill all components with value t. |
|
||||||||||||||||
|
Fill all components within the box with value t. |
|
||||||||||||||||
|
Calculate the amount of memory needed to represent the data in an outerface centered grid. This function assumes that the amount of memory needed for TYPE is sizeof(TYPE). If this is not the case, then a specialized function must be defined. |
|
||||||||||||||||||||
|
Print all face centered data residing in the specified box. If the depth of the array is greater than one, all components are printed. Precision of floating point numbers (i.e., TYPE = float, double, or dcomplex) can be specified using the provided argument. The default is 12 decimal places for double and complex floating point numbers, and the default is 6 decimal places floats. For other types, this is ignored. |
|
||||||||||||||||||||||||
|
Print the specified component of the face centered data residing in the specified box. Precision of floating point numbers (i.e., TYPE = float, double, or dcomplex) can be specified using the provided argument. The default is 12 decimal places for double and complex floating point numbers, and the default is 6 decimal places floats. For other types, this is ignored. |
|
||||||||||||||||||||||||||||
|
Print all outerface centered data for specified axis index residing in the specified box, axis, and face. If the depth of the data is greater than one, then all components are printed. Precision of floating point numbers (i.e., TYPE = float, double, or dcomplex) can be specified using the provided argument. The default is 12 decimal places for double and complex floating point numbers, and the default is 6 decimal places floats. For other types, this is ignored. |
|
||||||||||||||||||||||||||||||||
|
Print specified component for all outerface centered data for the specified axis index, face index, and spatial component residing in the specified box. Precision of floating point numbers (i.e., TYPE = float, double, or dcomplex) can be specified using the provided argument. The default is 12 decimal places for double and complex floating point numbers, and the default is 6 decimal places floats. For other types, this is ignored. |
|
||||||||||
|
Check that class version and restart file version are equal. If so, read data members from the database. Assertions: database must be a non-null pointer. Implements SAMRAI::hier::PatchData< DIM >. |
|
||||||||||
|
Write out the class version number and other data members to the database. Assertions: database must be a non-null pointer. Implements SAMRAI::hier::PatchData< DIM >. |
1.4.2