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

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

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

[legend]List of all members.

Public Member Functions
	BasePatchHierarchy ()
virtual	~BasePatchHierarchy ()
virtual tbox::Pointer< hier::BasePatchLevel< DIM > >	getPatchLevel (const int l) const =0
virtual bool	finerLevelExists (const int l) const =0
virtual int	getFinestLevelNumber () const=0
virtual int	getNumberOfLevels () const=0
virtual void	getFromRestart (const int max_levels)=0
virtual void	putToDatabase (tbox::Pointer< tbox::Database > database)=0
virtual void	putToDatabase (tbox::Pointer< tbox::Database > database, const ComponentSelector &patchdata_write_table)=0

---

Detailed Description

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

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

See also:

hier::PatchHierarchy

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::hier::BasePatchHierarchy< DIM >::BasePatchHierarchy

(

)

Default constructor

template<int DIM>

SAMRAI::hier::BasePatchHierarchy< DIM >::~BasePatchHierarchy

(

)

[virtual]

Destructor for base patch hierarchy objects.

---

Member Function Documentation

template<int DIM>

virtual tbox::Pointer<hier::BasePatchLevel<DIM> > SAMRAI::hier::BasePatchHierarchy< DIM >::getPatchLevel

(

const int

l

)

const [pure virtual]

Return a pointer to the specified patch level.

Implemented in SAMRAI::hier::MultiblockPatchHierarchy< DIM >, and SAMRAI::hier::PatchHierarchy< DIM >.

template<int DIM>

virtual bool SAMRAI::hier::BasePatchHierarchy< DIM >::finerLevelExists

(

const int

l

)

const [pure virtual]

Returns true if the array of patch levels contains a patch level finer than the specified patch level. Otherwise, false is returned.

Implemented in SAMRAI::hier::MultiblockPatchHierarchy< DIM >, and SAMRAI::hier::PatchHierarchy< DIM >.

template<int DIM>

virtual int SAMRAI::hier::BasePatchHierarchy< DIM >::getFinestLevelNumber

(

)

const [pure virtual]

Return the level number of the finest resolution patch level residing in the hierarchy.

Implemented in SAMRAI::hier::MultiblockPatchHierarchy< DIM >, and SAMRAI::hier::PatchHierarchy< DIM >.

template<int DIM>

virtual int SAMRAI::hier::BasePatchHierarchy< DIM >::getNumberOfLevels

(

)

const [pure virtual]

Return the number of levels that currently exist in the hierarchy.

Implemented in SAMRAI::hier::MultiblockPatchHierarchy< DIM >, and SAMRAI::hier::PatchHierarchy< DIM >.

template<int DIM>

virtual void SAMRAI::hier::BasePatchHierarchy< DIM >::getFromRestart

(

const int

max_levels

)

[pure virtual]

Read in the entire hierarchy from the restart file.

Implemented in SAMRAI::hier::MultiblockPatchHierarchy< DIM >, and SAMRAI::hier::PatchHierarchy< DIM >.

template<int DIM>

virtual void SAMRAI::hier::BasePatchHierarchy< DIM >::putToDatabase

(

tbox::Pointer< tbox::Database >

database

)

[pure virtual]

Writes the state of the BasePatchHierarchy object and the PatchLevels it contains to the database.

Implements SAMRAI::tbox::Serializable.

Implemented in SAMRAI::hier::MultiblockPatchHierarchy< DIM >, and SAMRAI::hier::PatchHierarchy< DIM >.

template<int DIM>

virtual void SAMRAI::hier::BasePatchHierarchy< DIM >::putToDatabase	(	tbox::Pointer< tbox::Database >	database,
		const ComponentSelector &	patchdata_write_table
	)			[pure virtual]

Writes the state of the BasePatchHierarchy object and the PatchLevels it contains to the database. Only those patchdata corresponding to the set bits in the ComponentSelector are written to the specified database.

Implemented in SAMRAI::hier::MultiblockPatchHierarchy< DIM >, and SAMRAI::hier::PatchHierarchy< DIM >.

---

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

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

---