#include <source/hierarchy/variables/BoxGeometry.h>
Inheritance diagram for SAMRAI::hier::BoxGeometry< DIM >:
Public Member Functions | |
| BoxGeometry () | |
| virtual | ~BoxGeometry () |
| tbox::Pointer< BoxOverlap< DIM > > | calculateOverlap (const BoxGeometry< DIM > &src_geometry, const Box< DIM > &src_mask, const bool overwrite_interior, const IntVector< DIM > &src_offset) const |
| virtual tbox::Pointer< BoxOverlap< DIM > > | calculateOverlap (const BoxGeometry< DIM > &dst_geometry, const BoxGeometry< DIM > &src_geometry, const Box< DIM > &src_mask, const bool overwrite_interior, const IntVector< DIM > &src_offset, const bool retry) const =0 |
Box geometry objects are created by the patch data factories since patch data objects may not be available for patches that are distributed across processor memories (patch data factories are always replicated).
The concept of ``overlap'' or data dependency is more complex for generic box geometry objects than for just cell-centered box indices in the abstract AMR index space. Problems arise in cases where data lies on the outside corners, faces, or edges of a box. For these data types, it is likely that there will exist duplicate data values on different patches.
The solution implemented here introduces the concept of ``priority'' between patches. Data of patches with higher priority can overwrite the interiors (face, node, or edge values associated with cells that constitute the interior of the patch) of patches with lower priorities, but lower priority patches can never overwrite the interiors of higher priority patches. This scheme introduces a total ordering of data and therefore eliminates the duplicate information problem.
In practice, this protocol means two things: (1) the communication routines must always process copies from low priority sources to high priority sources, and (2) patches must be given special permission to overwrite their interior values during a write. All destinations are therefore represented by three quantities: (1) the box geometry of the destination (which encodes the box, ghost cells, and geometry), (2) the box geometry of the source, and (3) a flag indicating whether the source has a higher priority than the destination (that is, whether the source can overwrite the interior of the destination). If the overwrite flag is set, then data will be copied over the specified box domain and may write into the interior of the destination. If the overwrite flag is not set, then data will be copied only into the ghost cell values and not the interior values of the patch.
| SAMRAI::hier::BoxGeometry< DIM >::BoxGeometry | ( | ) | [inline] |
The default constructor for BoxGeometry<DIM> does nothing interesting.
| SAMRAI::hier::BoxGeometry< DIM >::~BoxGeometry | ( | ) | [virtual] |
The virtual destructor does nothing interesting.
| tbox::Pointer< BoxOverlap< DIM > > SAMRAI::hier::BoxGeometry< DIM >::calculateOverlap | ( | const BoxGeometry< DIM > & | src_geometry, | |
| const Box< DIM > & | src_mask, | |||
| const bool | overwrite_interior, | |||
| const IntVector< DIM > & | src_offset | |||
| ) | const [inline] |
Calculate the overlap between two box geometry objects given the source and destination (given by this) geometries, a source mask, the priority overwrite flag, and an offset between source and destination index spaces. The box overlap description returned by this function will be used in later copy and pack/unpack calls on the patch data object. The offset is from the source space into the destination index space. That is, if p is in the source index space, then p + sourceOffset is the corresponding point in the destination index space. The overwrite flag is used to represent priority between patches. If it is set, then the copy is allowed to modify the interior of the destination region. Note that the source and destination box geometries encode the geometry of the box that they represent; thus, it is possible to calculate intersections between different geometries. This will be necessary when copying data from flux sum counters into a face centered array in the AMR flux synchronization algorithm.
| virtual tbox::Pointer< BoxOverlap<DIM> > SAMRAI::hier::BoxGeometry< DIM >::calculateOverlap | ( | const BoxGeometry< DIM > & | dst_geometry, | |
| const BoxGeometry< DIM > & | src_geometry, | |||
| const Box< DIM > & | src_mask, | |||
| const bool | overwrite_interior, | |||
| const IntVector< DIM > & | src_offset, | |||
| const bool | retry | |||
| ) | const [pure virtual] |
Calculate the overlap between two box geometry objects given the source and destination geometries. This form calculateOverlap() is redefined by the subclasses of BoxGeometry<DIM> for the appropriate intersection algorithms. If calculateOverlap() cannot compute the intersection between the two given geometries and retry is true, then calculateOverlap() is called on the destination geometry object with retry set to false (to avoid infinite recursion). This protocol makes it possible to add new box geometry types and still calculate intersections with existing box geometry types.
Implemented in SAMRAI::pdat::CellGeometry< DIM >, SAMRAI::pdat::EdgeGeometry< DIM >, SAMRAI::pdat::FaceGeometry< DIM >, SAMRAI::pdat::NodeGeometry< DIM >, SAMRAI::pdat::OuteredgeGeometry< DIM >, SAMRAI::pdat::OuterfaceGeometry< DIM >, SAMRAI::pdat::OuternodeGeometry< DIM >, SAMRAI::pdat::OutersideGeometry< DIM >, and SAMRAI::pdat::SideGeometry< DIM >.
1.5.1