#include <source/patchdata/side/SideDataFactory.h>
Inheritance diagram for SAMRAI::pdat::SideDataFactory< DIM, TYPE >:
Note that it is possible to create a side data factory to allocate and manage data for cell sides associated with a single coordinate direction only. See the constructor for more information.
pdat::PatchDataFactory
| SAMRAI::pdat::SideDataFactory< DIM, TYPE >::SideDataFactory | ( | int | depth, | |
| const hier::IntVector< DIM > & | ghosts, | |||
| bool | fine_boundary_represents_var, | |||
| const hier::IntVector< DIM > & | directions = hier::IntVector< DIM >(1) | |||
| ) |
The default constructor for the side 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. Also, the default data allocation scheme is to generate storage for sides in all coordinate directions (default integer vector of all 1's). To use this factory to manage side data objects for sides associated with a single direction only, provide the directions vector argument. A zero entry indicates that data for that direction is not wanted. Otherwise, data will be created for that direction. See the SideVariable<DIM> class header file for more information.
| SAMRAI::pdat::SideDataFactory< DIM, TYPE >::~SideDataFactory | ( | ) | [virtual] |
Virtual destructor for the side data factory class.
| tbox::Pointer< hier::PatchDataFactory< DIM > > SAMRAI::pdat::SideDataFactory< 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::SideDataFactory< 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 side 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::SideDataFactory< 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::SideDataFactory< 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::SideDataFactory< 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 side data objects.
| void SAMRAI::pdat::SideDataFactory< 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 side data objects.
| const hier::IntVector< DIM > & SAMRAI::pdat::SideDataFactory< DIM, TYPE >::getDirectionVector | ( | ) | const [inline] |
Return constant reference to vector describing which coordinate directions have data associated with this side data object. A vector entry of zero indicates that there is no data array allocated for the corresponding coordinate direction. A non-zero value indicates that a valid data array is maintained for that coordinate direction.
| size_t SAMRAI::pdat::SideDataFactory< DIM, TYPE >::getSizeOfMemory | ( | const hier::Box< DIM > & | box | ) | const [virtual] |
Calculate the amount of memory needed to store the side data object, including object data and dynamically allocated data.
Implements SAMRAI::hier::PatchDataFactory< DIM >.
| bool SAMRAI::pdat::SideDataFactory< DIM, TYPE >::fineBoundaryRepresentsVariable | ( | ) | const [inline, virtual] |
Return a boolean value indicating how data for the side quantity will be treated on coarse-fine interfaces. This value is passed into the constructor. See the FaceVariable<DIM> class header file for more information.
Implements SAMRAI::hier::PatchDataFactory< DIM >.
| bool SAMRAI::pdat::SideDataFactory< DIM, TYPE >::dataLivesOnPatchBorder | ( | ) | const [inline, virtual] |
Return true since the side data index space extends beyond the interior of patches. That is, side data lives on patch borders.
Implements SAMRAI::hier::PatchDataFactory< DIM >.
| bool SAMRAI::pdat::SideDataFactory< DIM, TYPE >::validCopyTo | ( | const tbox::Pointer< hier::PatchDataFactory< DIM > > & | dst_pdf | ) | const [virtual] |
Return whether it is valid to copy this SideDataFactory to the supplied destination patch data factory. It will return true if dst_pdf is SideDataFactory or OutersideDataFactory, false otherwise.
Implements SAMRAI::hier::PatchDataFactory< DIM >.
| hier::MultiblockDataTranslator< DIM > * SAMRAI::pdat::SideDataFactory< DIM, TYPE >::getMultiblockDataTranslator | ( | ) | [inline, virtual] |
Return pointer to a multiblock data translator
Reimplemented from SAMRAI::hier::PatchDataFactory< DIM >.
1.5.1