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

#include <source/hierarchy/boxes/BoxIOUtility.h>

List of all members.

Public Types
enum	IOTYPE { READ = 0, WRITE = 1 }
Public Member Functions
	BoxIOUtility (const string &dirname, const IOTYPE iotype)
virtual	~BoxIOUtility ()
void	getLevelBoxes (BoxArray< DIM > &level_boxes, const int level_number, const int entry_number)
void	putLevelBoxes (const BoxArray< DIM > &level_boxes, const int level_number, const int entry_number)
int	getNumberOfLevels ()
int	getNumberOfEntries (const int level_number)
void	writeLevelBoxesDatabase ()
void	printBoxes (ostream &os)

---

Detailed Description

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

Class BoxIOUtility<DIM> supports writing and reading box information to an HDF file.

---

Member Enumeration Documentation

template<int DIM> enum SAMRAI::hier::BoxIOUtility::IOTYPE

Enumerated type for specification of whether to read or write data. READ { read from HDF database} WRITE { write to HDF database}; Enumeration values: READ  WRITE

---

Constructor & Destructor Documentation

template<int DIM> SAMRAI::hier::BoxIOUtility< DIM >::BoxIOUtility (  const string &  dirname, const IOTYPE  iotype )

The constructor requires the name of the HDF database to write or read to, and the IOTYPE.

template<int DIM> SAMRAI::hier::BoxIOUtility< DIM >::~BoxIOUtility (   )  [virtual]

Virtual destructor.

---

Member Function Documentation

template<int DIM> void SAMRAI::hier::BoxIOUtility< DIM >::getLevelBoxes (  BoxArray< DIM > &  level_boxes, const int  level_number, const int  entry_number )

Pulls refinement boxes corresponding to the provided level and entry number from storage array - returns a boxlist with the corresponding refine boxes.

template<int DIM> void SAMRAI::hier::BoxIOUtility< DIM >::putLevelBoxes (  const BoxArray< DIM > &  level_boxes, const int  level_number, const int  entry_number )

Puts new refinement boxes corresponding to the provided level and entry number into storage arrays.

template<int DIM> int SAMRAI::hier::BoxIOUtility< DIM >::getNumberOfLevels (   )

Returns the number of levels in the database.

template<int DIM> int SAMRAI::hier::BoxIOUtility< DIM >::getNumberOfEntries (  const int  level_number  )

Returns the number of entries in the database for the specified level.

template<int DIM> void SAMRAI::hier::BoxIOUtility< DIM >::writeLevelBoxesDatabase (   )

Opens and writes to an HDF database directory with the prescribed name a set of refinement boxes used during the run.

template<int DIM> void SAMRAI::hier::BoxIOUtility< DIM >::printBoxes (  ostream &  os  )

Print the boxes stored in the database to the specified IO stream.

---

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

• source/hierarchy/boxes/BoxIOUtility.h
• source/hierarchy/boxes/BoxIOUtility.C

---