SAMRAI::hier::BasePatchLevel< DIM > Class Template Reference

#include <source/hierarchy/patches/BasePatchLevel.h>

Inheritance diagram for SAMRAI::hier::BasePatchLevel< DIM >:

[legend]List of all members.

Public Member Functions
	BasePatchLevel ()
virtual	~BasePatchLevel ()
virtual int	getLevelNumber () const=0
virtual void	allocatePatchData (const int id, const double timestamp=0.0, tbox::Pointer< tbox::Arena > pool=NULL)=0
virtual void	allocatePatchData (const hier::ComponentSelector &components, const double timestamp=0.0, tbox::Pointer< tbox::Arena > pool=NULL)=0
virtual void	deallocatePatchData (const int id)=0
virtual void	deallocatePatchData (const hier::ComponentSelector &components)=0
virtual void	setTime (const double timestamp, const int id)=0
virtual void	setTime (const double timestamp, const hier::ComponentSelector &components)=0
virtual void	setTime (const double timestamp)=0
virtual const hier::IntVector< DIM > &	getRatio () const=0

---

Detailed Description

template<int DIM>
class SAMRAI::hier::BasePatchLevel< DIM >

Class BasePatchLevel in a virtual base class that provides an abstract interface for a patch level. This allows higher-level classes in SAMRAI and in applications that use SAMRAI to interface with a level in an abstract manner without knowing whether it is a PatchLevel representing a level on a rectangular domain or if it is a level that exists, for example, in a multiblock domain.

See also:

hier::BasePatchHierarchy

hier::PatchLevel

hier::Patch

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::hier::BasePatchLevel< DIM >::BasePatchLevel

(

)

Default constructor. BasePatchLevel must be initialized before it can be used.

template<int DIM>

SAMRAI::hier::BasePatchLevel< DIM >::~BasePatchLevel

(

)

[virtual]

The virtual destructor for patch level deallocates all patches.

---

Member Function Documentation

template<int DIM>

virtual int SAMRAI::hier::BasePatchLevel< DIM >::getLevelNumber

(

)

const [pure virtual]

Return the number of this level in a hierarchy, or the number of a hierarchy level matching the index space of this level. If this level does not align with the index space of a level in the hierarchy, then this value is -1. When the level is in a hierarchy, the return value os the number of the level in the hierarchy. See member function inHierarchy() below.

Implemented in SAMRAI::hier::MultiblockPatchLevel< DIM >, and SAMRAI::hier::PatchLevel< DIM >.

template<int DIM>

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

Allocate the specified component on all patches. If no memory arena is specified, then the standard memory arena will be used.

Implemented in SAMRAI::hier::MultiblockPatchLevel< DIM >, and SAMRAI::hier::PatchLevel< DIM >.

template<int DIM>

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

Allocate the specified components on all patches. If no memory arena is specified, then the standard memory arena will be used.

Implemented in SAMRAI::hier::MultiblockPatchLevel< DIM >, and SAMRAI::hier::PatchLevel< DIM >.

template<int DIM>

virtual void SAMRAI::hier::BasePatchLevel< DIM >::deallocatePatchData

(

const int

id

)

[pure virtual]

Deallocate the specified component on all patches. This component will need to be reallocated before its next use.

Implemented in SAMRAI::hier::MultiblockPatchLevel< DIM >, and SAMRAI::hier::PatchLevel< DIM >.

template<int DIM>

virtual void SAMRAI::hier::BasePatchLevel< DIM >::deallocatePatchData

(

const hier::ComponentSelector &

components

)

[pure virtual]

Deallocate the specified components on all patches. These components will need to be reallocated before their next use.

Implemented in SAMRAI::hier::MultiblockPatchLevel< DIM >, and SAMRAI::hier::PatchLevel< DIM >.

template<int DIM>

virtual void SAMRAI::hier::BasePatchLevel< DIM >::setTime	(	const double	timestamp,
		const int	id
	)			[pure virtual]

Set the simulation time for the specified patch component.

Implemented in SAMRAI::hier::MultiblockPatchLevel< DIM >, and SAMRAI::hier::PatchLevel< DIM >.

template<int DIM>

virtual void SAMRAI::hier::BasePatchLevel< DIM >::setTime	(	const double	timestamp,
		const hier::ComponentSelector &	components
	)			[pure virtual]

Set the simulation time for the specified patch components.

Implemented in SAMRAI::hier::MultiblockPatchLevel< DIM >, and SAMRAI::hier::PatchLevel< DIM >.

template<int DIM>

virtual void SAMRAI::hier::BasePatchLevel< DIM >::setTime

(

const double

timestamp

)

[pure virtual]

Set the simulation time for all allocated patch components.

Implemented in SAMRAI::hier::MultiblockPatchLevel< DIM >, and SAMRAI::hier::PatchLevel< DIM >.

template<int DIM>

virtual const hier::IntVector<DIM>& SAMRAI::hier::BasePatchLevel< DIM >::getRatio

(

)

const [pure virtual]

Return a const reference to the vector ratio between the index space of this patch level and that of a reference level in AMR hierarchy (typically, level zero). Specifically, this is the ratio passed to the constructor.

Implemented in SAMRAI::hier::MultiblockPatchLevel< DIM >, and SAMRAI::hier::PatchLevel< DIM >.

---

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

• source/hierarchy/patches/BasePatchLevel.h
• source/hierarchy/patches/BasePatchLevel.C

---