Class MultiblockPatchLevel<DIM> contains an array of hier::PatchLevel<DIM> that contains all of the patch levels that have the same level of refinement in a multiblock domain. More...
#include <MultiblockPatchLevel.h>
Inheritance diagram for SAMRAI::hier::MultiblockPatchLevel< DIM >:
Public Member Functions | |
| MultiblockPatchLevel (tbox::Array< tbox::Pointer< hier::PatchLevel< DIM > > > &levels) | |
| Constructor takes an array of pointers to patch levels. More... | |
| ~MultiblockPatchLevel () | |
| tbox::Pointer< hier::PatchLevel< DIM > > | getPatchLevelForBlock (const int id) const |
| Return a pointer to the hier::PatchLevel<DIM> associated with the id number. More... | |
| void | allocatePatchData (const int id, const double timestamp=0.0, tbox::Pointer< tbox::Arena > pool=NULL) |
| Allocate the specified component on all patches. If no memory arena is specified, then the standard memory arena will be used. More... | |
| void | allocatePatchData (const hier::ComponentSelector &components, const double timestamp=0.0, tbox::Pointer< tbox::Arena > pool=NULL) |
| Allocate the specified components on all patches. If no memory arena is specified, then the standard memory arena will be used. More... | |
| void | deallocatePatchData (const int id) |
| Deallocate the specified component on all patches. More... | |
| void | deallocatePatchData (const hier::ComponentSelector &components) |
| Deallocate the specified components on all patches. More... | |
| void | setTime (const double timestamp, const int id) |
| Set the simulation time for the specified patch component. More... | |
| void | setTime (const double timestamp, const hier::ComponentSelector &components) |
| Set the simulation time for the specified patch components. More... | |
| void | setTime (const double timestamp) |
| Set the simulation time for all allocated patch components. More... | |
| int | getNumberOfBlocks () const |
| Get the number of blocks in the multiblock domain. More... | |
| int | getLevelNumber () const |
| Get the level number of this level. More... | |
| const hier::IntVector< DIM > & | getRatio () const |
| Get the ratio to level zero of this level. More... | |
Private Attributes | |
| tbox::Array< tbox::Pointer< hier::PatchLevel< DIM > > > | d_levels |
| int | d_number_blocks |
Detailed Description
template<int DIM>
class SAMRAI::hier::MultiblockPatchLevel< DIM >
Constructor & Destructor Documentation
◆ MultiblockPatchLevel()
template<int DIM>
| SAMRAI::hier::MultiblockPatchLevel< DIM >::MultiblockPatchLevel | ( | tbox::Array< tbox::Pointer< hier::PatchLevel< DIM > > > & | levels | ) |
- Parameters
-
levels Array of pointers to hier::PatchLevel<DIM>. The array indices correspond to block numbers. Pointers in the array may be null. A null pointer indicates that the MultiblockPatchLevel does not represent any space in the block associated with its array index.
◆ ~MultiblockPatchLevel()
template<int DIM>
| SAMRAI::hier::MultiblockPatchLevel< DIM >::~MultiblockPatchLevel | ( | ) |
Destructor is uninteresting
Member Function Documentation
◆ getPatchLevelForBlock()
template<int DIM>
| tbox::Pointer< hier::PatchLevel<DIM> > SAMRAI::hier::MultiblockPatchLevel< DIM >::getPatchLevelForBlock | ( | const int | id | ) | const |
- Parameters
-
id corresponds to the indexing of the array passed into the constructor.
◆ allocatePatchData() [1/2]
template<int DIM>
|
virtual |
- Parameters
-
id A patch data id timestamp Simulation time pool A memory arena
Implements SAMRAI::hier::BasePatchLevel< DIM >.
◆ allocatePatchData() [2/2]
template<int DIM>
|
virtual |
- Parameters
-
components A component selector defining a set of patch data id's timestamp Simulation time pool A memory arena
Implements SAMRAI::hier::BasePatchLevel< DIM >.
◆ deallocatePatchData() [1/2]
template<int DIM>
|
virtual |
- Parameters
-
id Patch data id of data to be deallocated
Implements SAMRAI::hier::BasePatchLevel< DIM >.
◆ deallocatePatchData() [2/2]
template<int DIM>
|
virtual |
- Parameters
-
components A component selector defining a set of patch data id's which indicate the data to be deallocated
Implements SAMRAI::hier::BasePatchLevel< DIM >.
◆ setTime() [1/3]
template<int DIM>
|
virtual |
- Parameters
-
timestamp Simulation time id A patch data id
Implements SAMRAI::hier::BasePatchLevel< DIM >.
◆ setTime() [2/3]
template<int DIM>
|
virtual |
- Parameters
-
timestamp Simulation time components A component selector defining a set of patch data id's
Implements SAMRAI::hier::BasePatchLevel< DIM >.
◆ setTime() [3/3]
template<int DIM>
|
virtual |
- Parameters
-
timestamp Simulation time
Implements SAMRAI::hier::BasePatchLevel< DIM >.
◆ getNumberOfBlocks()
template<int DIM>
| int SAMRAI::hier::MultiblockPatchLevel< DIM >::getNumberOfBlocks | ( | ) | const |
◆ getLevelNumber()
template<int DIM>
|
virtual |
Implements SAMRAI::hier::BasePatchLevel< DIM >.
◆ getRatio()
template<int DIM>
|
virtual |
Implements SAMRAI::hier::BasePatchLevel< DIM >.
Member Data Documentation
◆ d_levels
template<int DIM>
|
private |
◆ d_number_blocks
template<int DIM>
|
private |
The documentation for this class was generated from the following file:
- /samrai/include/MultiblockPatchLevel.h
