SAMRAI::mblk::MultiblockPatchLevel< DIM > Class Template Reference

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 <source/multiblock/MultiblockPatchLevel.h>

Inheritance diagram for SAMRAI::mblk::MultiblockPatchLevel< DIM >:

[legend]List of all members.

Public Member Functions
	MultiblockPatchLevel (tbox::Array< tbox::Pointer< hier::PatchLevel< DIM > > > &levels)
	Constructor takes an array of pointers to patch levels.
	~MultiblockPatchLevel ()
tbox::Pointer< hier::PatchLevel< DIM > >	getPatchLevelForBlock (const int id) const
	Return a pointer to the hier::PatchLevel<DIM> associated with the id number.
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.
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.
void	deallocatePatchData (const int id)
	Deallocate the specified component on all patches.
void	deallocatePatchData (const hier::ComponentSelector &components)
	Deallocate the specified components on all patches.
void	setTime (const double timestamp, const int id)
	Set the simulation time for the specified patch component.
void	setTime (const double timestamp, const hier::ComponentSelector &components)
	Set the simulation time for the specified patch components.
void	setTime (const double timestamp)
	Set the simulation time for all allocated patch components.
int	getNumberBlocks () const
	Get the number of blocks in the multiblock domain.
int	getLevelNumber () const
	Get the level number of this level.
const hier::IntVector< DIM > &	getRatio () const
	Get the ratio to level zero of this level.

---

Detailed Description

template<int DIM>
class SAMRAI::mblk::MultiblockPatchLevel< DIM >

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.

See also:

hier::PatchLevel

mblk::MultiblockPatchHierarchy

---

Constructor & Destructor Documentation

template<int DIM> SAMRAI::mblk::MultiblockPatchLevel< DIM >::MultiblockPatchLevel (  tbox::Array< tbox::Pointer< hier::PatchLevel< DIM > > > &  levels  )

Constructor takes an array of pointers to patch 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.

template<int DIM> SAMRAI::mblk::MultiblockPatchLevel< DIM >::~MultiblockPatchLevel (   )

Destructor is uninteresting

---

Member Function Documentation

template<int DIM> tbox::Pointer< hier::PatchLevel< DIM > > SAMRAI::mblk::MultiblockPatchLevel< DIM >::getPatchLevelForBlock (  const int  id  )  const

Return a pointer to the hier::PatchLevel<DIM> associated with the id number. Parameters: id  corresponds to the indexing of the array passed into the constructor.

template<int DIM> void SAMRAI::mblk::MultiblockPatchLevel< DIM >::allocatePatchData (  const int  id, const double  timestamp = 0.0, tbox::Pointer< tbox::Arena >  pool = NULL )  [virtual]

Allocate the specified component on all patches. If no memory arena is specified, then the standard memory arena will be used. Parameters: id  A patch data id timestamp  Simulation time pool  A memory arena Implements SAMRAI::hier::BasePatchLevel< DIM >.

template<int DIM> void SAMRAI::mblk::MultiblockPatchLevel< DIM >::allocatePatchData (  const hier::ComponentSelector &  components, const double  timestamp = 0.0, tbox::Pointer< tbox::Arena >  pool = NULL )  [virtual]

Allocate the specified components on all patches. If no memory arena is specified, then the standard memory arena will be used. 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 >.

template<int DIM> void SAMRAI::mblk::MultiblockPatchLevel< DIM >::deallocatePatchData (  const int  id  )  [virtual]

Deallocate the specified component on all patches. Parameters: id  Patch data id of data to be deallocated Implements SAMRAI::hier::BasePatchLevel< DIM >.

template<int DIM> void SAMRAI::mblk::MultiblockPatchLevel< DIM >::deallocatePatchData (  const hier::ComponentSelector &  components  )  [virtual]

Deallocate the specified components on all patches. 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 >.

template<int DIM> void SAMRAI::mblk::MultiblockPatchLevel< DIM >::setTime (  const double  timestamp, const int  id )  [virtual]

Set the simulation time for the specified patch component. Parameters: timestamp  Simulation time id  A patch data id Implements SAMRAI::hier::BasePatchLevel< DIM >.

template<int DIM> void SAMRAI::mblk::MultiblockPatchLevel< DIM >::setTime (  const double  timestamp, const hier::ComponentSelector &  components )  [virtual]

Set the simulation time for the specified patch components. Parameters: timestamp  Simulation time components  A component selector defining a set of patch data id's Implements SAMRAI::hier::BasePatchLevel< DIM >.

template<int DIM> void SAMRAI::mblk::MultiblockPatchLevel< DIM >::setTime (  const double  timestamp  )  [virtual]

Set the simulation time for all allocated patch components. Parameters: timestamp  Simulation time Implements SAMRAI::hier::BasePatchLevel< DIM >.

template<int DIM> int SAMRAI::mblk::MultiblockPatchLevel< DIM >::getNumberBlocks (   )  const

Get the number of blocks in the multiblock domain.

template<int DIM> int SAMRAI::mblk::MultiblockPatchLevel< DIM >::getLevelNumber (   )  const [virtual]

Get the level number of this level. Implements SAMRAI::hier::BasePatchLevel< DIM >.

template<int DIM> const hier::IntVector< DIM > & SAMRAI::mblk::MultiblockPatchLevel< DIM >::getRatio (   )  const [virtual]

Get the ratio to level zero of this level. Implements SAMRAI::hier::BasePatchLevel< DIM >.

---

The documentation for this class was generated from the following files:

• source/multiblock/MultiblockPatchLevel.h
• source/multiblock/MultiblockPatchLevel.C

---