#include <source/patchdata/edge/EdgeDataFactory.h>
Inheritance diagram for SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >:
pdat::PatchDataFactory
| SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >::EdgeDataFactory | ( | int | depth, | |
| const hier::IntVector< DIM > & | ghosts, | |||
| bool | fine_boundary_represents_var | |||
| ) |
The constructor for the edge data factory class. The ghost cell width, depth (number of components), and fine boundary representation arguments give the defaults for all edge data objects created with this factory. See the EdgeVariable<DIM> class header file for more information.
| SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >::~EdgeDataFactory | ( | ) | [virtual] |
Virtual destructor for the edge data factory class.
| tbox::Pointer< hier::PatchDataFactory< DIM > > SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >::cloneFactory | ( | const hier::IntVector< DIM > & | ghosts | ) | [virtual] |
Abstract virtual function to clone a patch data factory.
This will return a new instantiation of the abstract factory with the same properties. The properties of the cloned factory can then be changed without modifying the original.
| ghosts | default ghost cell width for concrete classes created from the factory. |
Implements SAMRAI::hier::PatchDataFactory< DIM >.
| tbox::Pointer< hier::PatchData< DIM > > SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >::allocate | ( | const hier::Box< DIM > & | box, | |
| tbox::Pointer< tbox::Arena > | pool = tbox::Pointer< tbox::Arena >((0)) | |||
| ) | const [virtual] |
Virtual factory function to allocate a concrete edge data object. The default information about the object (e.g., ghost cell width) is taken from the factory. If no memory pool is provided, then the allocation routine assumes some default memory pool.
Implements SAMRAI::hier::PatchDataFactory< DIM >.
| tbox::Pointer< hier::PatchData< DIM > > SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >::allocate | ( | const hier::Patch< DIM > & | patch, | |
| tbox::Pointer< tbox::Arena > | pool = tbox::Pointer< tbox::Arena >((0)) | |||
| ) | const [virtual] |
Virtual factory function to allocate a concrete cell data object. Same as above function, except passes in a patch instead of a box.
Implements SAMRAI::hier::PatchDataFactory< DIM >.
| tbox::Pointer< hier::BoxGeometry< DIM > > SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >::getBoxGeometry | ( | const hier::Box< DIM > & | box | ) | const [virtual] |
Allocate the box geometry object associated with the patch data. This information will be used in the computation of intersections and data dependencies between objects.
Implements SAMRAI::hier::PatchDataFactory< DIM >.
| int SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >::getDefaultDepth | ( | ) | const [inline] |
Get the default depth (number of components). This is the default depth that will be used in the instantiation of edge data objects.
| void SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >::setDefaultDepth | ( | const int | depth | ) | [inline] |
Set the default depth (number of components). This is the default depth that will be used in the instantiation of edge data objects.
| size_t SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >::getSizeOfMemory | ( | const hier::Box< DIM > & | box | ) | const [virtual] |
Calculate the amount of memory needed to store the edge data object, including object data and dynamically allocated data.
Implements SAMRAI::hier::PatchDataFactory< DIM >.
| bool SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >::fineBoundaryRepresentsVariable | ( | ) | const [inline, virtual] |
Return a boolean value indicating how data for the edge quantity will be treated on coarse-fine interfaces. This value is passed into the constructor. See the EdgeVariable<DIM> class header file for more information.
Implements SAMRAI::hier::PatchDataFactory< DIM >.
| bool SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >::dataLivesOnPatchBorder | ( | ) | const [inline, virtual] |
Return true since the edge data index space extends beyond the interior of patches. That is, edge data lives on patch borders.
Implements SAMRAI::hier::PatchDataFactory< DIM >.
| bool SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >::validCopyTo | ( | const tbox::Pointer< hier::PatchDataFactory< DIM > > & | dst_pdf | ) | const [virtual] |
Return whether it is valid to copy this EdgeDataFactory to the supplied destination patch data factory. It will return true if dst_pdf is EdgeDataFactory or OuteredgeDataFactory, false otherwise.
Implements SAMRAI::hier::PatchDataFactory< DIM >.
| hier::MultiblockDataTranslator< DIM > * SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >::getMultiblockDataTranslator | ( | ) | [inline, virtual] |
Return pointer to a multiblock data translator
Reimplemented from SAMRAI::hier::PatchDataFactory< DIM >.
1.5.1