#include <source/patchdata/outernode/OuternodeDataFactory.h>
Inheritance diagram for SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >:
Public Member Functions | |
| OuternodeDataFactory (int depth) | |
| The default constructor for the outernode data factory class. | |
| virtual | ~OuternodeDataFactory () |
| Virtual destructor for the outernode data factory class. | |
| virtual tbox::Pointer< hier::PatchDataFactory< DIM > > | cloneFactory (const hier::IntVector< DIM > &ghosts) |
| Abstract virtual function to clone a patch data factory. | |
| virtual tbox::Pointer< hier::PatchData< DIM > > | allocate (const hier::Box< DIM > &box, tbox::Pointer< tbox::Arena > pool=tbox::Pointer< tbox::Arena >((0))) const |
| Virtual factory function to allocate a concrete outernode data object. | |
| virtual tbox::Pointer< hier::PatchData< DIM > > | allocate (const hier::Patch< DIM > &patch, tbox::Pointer< tbox::Arena > pool=tbox::Pointer< tbox::Arena >((0))) const |
| virtual tbox::Pointer< hier::BoxGeometry< DIM > > | getBoxGeometry (const hier::Box< DIM > &box) const |
| Allocate the box geometry object associated with the patch data. | |
| int | getDefaultDepth () const |
| Get the default depth (number of components). | |
| void | setDefaultDepth (const int depth) |
| Set the default depth (number of components). | |
| virtual size_t | getSizeOfMemory (const hier::Box< DIM > &box) const |
| Calculate the amount of memory needed to store the outernode data object, including object data and dynamically allocated data. | |
| bool | fineBoundaryRepresentsVariable () const |
| bool | dataLivesOnPatchBorder () const |
| bool | validCopyTo (const tbox::Pointer< hier::PatchDataFactory< DIM > > &dst_pdf) const |
pdat::PatchDataFactory
| SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::OuternodeDataFactory | ( | int | depth | ) |
The default constructor for the outernode data factory class.
The depth (number of components) gives the default for all of the outernode data objects created with this factory.
| SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::~OuternodeDataFactory | ( | ) | [virtual] |
Virtual destructor for the outernode data factory class.
| tbox::Pointer< hier::PatchDataFactory< DIM > > SAMRAI::pdat::OuternodeDataFactory< 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::OuternodeDataFactory< 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 outernode data object.
The default information about the object (e.g., depth) 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::OuternodeDataFactory< 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::OuternodeDataFactory< 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::OuternodeDataFactory< 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 outernode data objects.
| void SAMRAI::pdat::OuternodeDataFactory< 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 outernode data objects.
| size_t SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::getSizeOfMemory | ( | const hier::Box< DIM > & | box | ) | const [virtual] |
Calculate the amount of memory needed to store the outernode data object, including object data and dynamically allocated data.
Implements SAMRAI::hier::PatchDataFactory< DIM >.
| bool SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::fineBoundaryRepresentsVariable | ( | ) | const [inline, virtual] |
Return a boolean true value indicating that fine data for the outernode quantity will take precedence on coarse-fine interfaces. See the OuternodeVariable class header file for more information.
Implements SAMRAI::hier::PatchDataFactory< DIM >.
| bool SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::dataLivesOnPatchBorder | ( | ) | const [inline, virtual] |
Return true since the outernode data index space extends beyond the interior of patches. That is, outernode data lives on patch borders.
Implements SAMRAI::hier::PatchDataFactory< DIM >.
| bool SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::validCopyTo | ( | const tbox::Pointer< hier::PatchDataFactory< DIM > > & | dst_pdf | ) | const [virtual] |
Return whether it is valid to copy this OuternodeDataFactory to the supplied destination patch data factory. It will return true if dst_pdf is NodeDataFactory or OuternodeDataFactory, false otherwise.
Implements SAMRAI::hier::PatchDataFactory< DIM >.
1.5.1