LibGeoDecomp::SerialBOVWriter< CELL_TYPE > Class Template Reference

writes simulation snapshots compatible with VisIt's Brick of Values (BOV) format using one file per partition. More...

#include <serialbovwriter.h>

Inherits Clonable< Writer< CELL_TYPE >, SerialBOVWriter< CELL_TYPE > >.

Collaboration diagram for LibGeoDecomp::SerialBOVWriter< CELL_TYPE >:

List of all members.

Public Types
typedef APITraits::SelectTopology < CELL_TYPE >::Value	Topology
typedef Writer< CELL_TYPE > ::GridType	GridType
Public Member Functions
	SerialBOVWriter (const Selector< CELL_TYPE > &selector=Selector< CELL_TYPE >(), const std::string &prefix="serial_bov_writer_output", const unsigned period=1, const Coord< 3 > &brickletDim=Coord< 3 >())
template<typename MEMBER >
	SerialBOVWriter (MEMBER CELL_TYPE::*member, const std::string &prefix, const unsigned period, const Coord< 3 > &brickletDim=Coord< 3 >())
void	stepFinished (const GridType &grid, unsigned step, WriterEvent event)
	is called back from sim after each simulation step.
Static Public Attributes
static const int	DIM = Topology::DIM
Private Member Functions
std::string	filename (unsigned step, const std::string &suffix) const
void	writeHeader (unsigned step, const Coord< DIM > &dimensions)
template<typename GRID_TYPE >
void	writeRegion (unsigned step, const GRID_TYPE &grid)
Private Attributes
Selector< CELL_TYPE >	selector
Coord< 3 >	brickletDim
Friends
class	Serialization

---

Detailed Description

template<typename CELL_TYPE>
class LibGeoDecomp::SerialBOVWriter< CELL_TYPE >

writes simulation snapshots compatible with VisIt's Brick of Values (BOV) format using one file per partition.

Uses a selector which maps a cell to a primitive data type so that it can be fed into VisIt.

---

Member Typedef Documentation

template<typename CELL_TYPE>

typedef Writer<CELL_TYPE>::GridType LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::GridType

Reimplemented from LibGeoDecomp::Writer< CELL_TYPE >.

template<typename CELL_TYPE>

typedef APITraits::SelectTopology<CELL_TYPE>::Value LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::Topology

Reimplemented from LibGeoDecomp::Writer< CELL_TYPE >.

---

Constructor & Destructor Documentation

template<typename CELL_TYPE>

LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::SerialBOVWriter	(	const Selector< CELL_TYPE > &	selector = Selector<CELL_TYPE>(),
		const std::string &	prefix = "serial_bov_writer_output",
		const unsigned	period = 1,
		const Coord< 3 > &	brickletDim = Coord<3>()
	)			[inline, explicit]

template<typename CELL_TYPE>

template<typename MEMBER >

LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::SerialBOVWriter	(	MEMBER CELL_TYPE::*	member,
		const std::string &	prefix,
		const unsigned	period,
		const Coord< 3 > &	brickletDim = Coord<3>()
	)			[inline]

---

Member Function Documentation

template<typename CELL_TYPE>

std::string LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::filename	(	unsigned	step,
		const std::string &	suffix
	)			const [inline, private]

Referenced by LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::writeHeader(), and LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::writeRegion().

template<typename CELL_TYPE>

void LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::stepFinished	(	const GridType &	grid,
		unsigned	step,
		WriterEvent	event
	)			[inline, virtual]

is called back from sim after each simulation step.

event specifies the phase in which the simulation is currently in. This may be used for instance to open/close files at the beginning/end of the simulation.

Implements LibGeoDecomp::Writer< CELL_TYPE >.

References LibGeoDecomp::GridBase< CELL, DIMENSIONS >::dimensions(), LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::writeHeader(), LibGeoDecomp::WRITER_STEP_FINISHED, and LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::writeRegion().

template<typename CELL_TYPE>

void LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::writeHeader	(	unsigned	step,
		const Coord< DIM > &	dimensions
	)			[inline, private]

References LibGeoDecomp::Selector< CELL >::arity(), LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::brickletDim, LibGeoDecomp::Coord< 3 >::diagonal(), LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::DIM, LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::filename(), LibGeoDecomp::Selector< CELL >::name(), LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::selector, LibGeoDecomp::Selector< CELL >::typeName(), LibGeoDecomp::Coord< 3 >::x(), LibGeoDecomp::Coord< 3 >::y(), and LibGeoDecomp::Coord< 3 >::z().

Referenced by LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::stepFinished().

template<typename CELL_TYPE>

template<typename GRID_TYPE >

void LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::writeRegion	(	unsigned	step,
		const GRID_TYPE &	grid
	)			[inline, private]

References LibGeoDecomp::CoordBox< DIM >::beginStreak(), LibGeoDecomp::CoordBox< DIM >::endStreak(), LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::filename(), LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::selector, and LibGeoDecomp::Selector< CELL >::sizeOfExternal().

Referenced by LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::stepFinished().

---

Friends And Related Function Documentation

template<typename CELL_TYPE>

friend class Serialization [friend]

Reimplemented from LibGeoDecomp::Clonable< Writer< CELL_TYPE >, SerialBOVWriter< CELL_TYPE > >.

---

Member Data Documentation

template<typename CELL_TYPE>

Coord<3> LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::brickletDim [private]

Referenced by LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::writeHeader().

template<typename CELL_TYPE>

const int LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::DIM = Topology::DIM [static]

Reimplemented from LibGeoDecomp::Writer< CELL_TYPE >.

Referenced by LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::writeHeader().

template<typename CELL_TYPE>

Selector<CELL_TYPE> LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::selector [private]

Referenced by LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::writeHeader(), and LibGeoDecomp::SerialBOVWriter< CELL_TYPE >::writeRegion().

---

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

• io/serialbovwriter.h