The purpose of the TracingWriter is out output performance data which allows the user to gauge execution time (current, remaining, estimated time of arrival (ETA)) and performance (GLUPS, memory bandwidth). More...

#include <tracingwriter.h>

Inherits Clonable< Writer< CELL_TYPE >, TracingWriter< CELL_TYPE > >, and Clonable< ParallelWriter< CELL_TYPE >, TracingWriter< CELL_TYPE > >.

Collaboration diagram for LibGeoDecomp::TracingWriter< CELL_TYPE >:

[legend]

List of all members.

Public Types
typedef boost::posix_time::ptime	Time
typedef boost::posix_time::time_duration	Duration
typedef Writer< CELL_TYPE > ::GridType	WriterGridType
typedef ParallelWriter < CELL_TYPE >::GridType	ParallelWriterGridType
typedef ParallelWriter < CELL_TYPE >::Topology	Topology
Public Member Functions
	TracingWriter (const unsigned period=1, const unsigned maxSteps=1, int outputRank=OUTPUT_ON_ALL_RANKS, std::ostream &stream=std::cerr)
virtual void	stepFinished (const WriterGridType &grid, unsigned step, WriterEvent event)
virtual void	stepFinished (const ParallelWriterGridType &grid, const Region< DIM > &validRegion, const Coord< DIM > &globalDimensions, unsigned step, WriterEvent event, std::size_t rank, bool lastCall)
Static Public Attributes
static const int	DIM = Topology::DIM
static const int	OUTPUT_ON_ALL_RANKS = -1
Private Member Functions
void	stepFinished (unsigned step, const Coord< DIM > &globalDimensions, WriterEvent event)
void	normalStepFinished (unsigned step, const Coord< DIM > &globalDimensions)
void	printTime () const
Time	currentTime () const
Private Attributes
int	outputRank
std::ostream &	stream
Time	startTime
unsigned	lastStep
unsigned	maxSteps
Friends
class	Serialization
class	boost::serialization::access

Detailed Description

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

The purpose of the TracingWriter is out output performance data which allows the user to gauge execution time (current, remaining, estimated time of arrival (ETA)) and performance (GLUPS, memory bandwidth).

Member Typedef Documentation

template<typename CELL_TYPE>

typedef boost::posix_time::time_duration LibGeoDecomp::TracingWriter< CELL_TYPE >::Duration

template<typename CELL_TYPE>

typedef ParallelWriter<CELL_TYPE>::GridType LibGeoDecomp::TracingWriter< CELL_TYPE >::ParallelWriterGridType

template<typename CELL_TYPE>

typedef boost::posix_time::ptime LibGeoDecomp::TracingWriter< CELL_TYPE >::Time

template<typename CELL_TYPE>

typedef ParallelWriter<CELL_TYPE>::Topology LibGeoDecomp::TracingWriter< CELL_TYPE >::Topology

Reimplemented from LibGeoDecomp::ParallelWriter< CELL_TYPE >.

template<typename CELL_TYPE>

typedef Writer<CELL_TYPE>::GridType LibGeoDecomp::TracingWriter< CELL_TYPE >::WriterGridType

Constructor & Destructor Documentation

template<typename CELL_TYPE>

LibGeoDecomp::TracingWriter< CELL_TYPE >::TracingWriter	(	const unsigned	period = `1`,
		const unsigned	maxSteps = `1`,
		int	outputRank = `OUTPUT_ON_ALL_RANKS`,
		std::ostream &	stream = `std::cerr`
	)			`[inline, explicit]`

Member Function Documentation

template<typename CELL_TYPE>

Time LibGeoDecomp::TracingWriter< CELL_TYPE >::currentTime ( ) const [inline, private]

Referenced by LibGeoDecomp::TracingWriter< CELL_TYPE >::normalStepFinished(), LibGeoDecomp::TracingWriter< CELL_TYPE >::printTime(), and LibGeoDecomp::TracingWriter< CELL_TYPE >::stepFinished().

template<typename CELL_TYPE>

void LibGeoDecomp::TracingWriter< CELL_TYPE >::normalStepFinished	(	unsigned	step,
		const Coord< DIM > &	globalDimensions
	)			`[inline, private]`

References LibGeoDecomp::TracingWriter< CELL_TYPE >::currentTime(), LibGeoDecomp::TracingWriter< CELL_TYPE >::maxSteps, LibGeoDecomp::Writer< CELL_TYPE >::NANO_STEPS, LibGeoDecomp::TracingWriter< CELL_TYPE >::printTime(), LibGeoDecomp::TracingWriter< CELL_TYPE >::startTime, and LibGeoDecomp::TracingWriter< CELL_TYPE >::stream.

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

template<typename CELL_TYPE>

void LibGeoDecomp::TracingWriter< CELL_TYPE >::printTime ( ) const [inline, private]

References LibGeoDecomp::TracingWriter< CELL_TYPE >::currentTime(), and LibGeoDecomp::TracingWriter< CELL_TYPE >::stream.

Referenced by LibGeoDecomp::TracingWriter< CELL_TYPE >::normalStepFinished(), and LibGeoDecomp::TracingWriter< CELL_TYPE >::stepFinished().

template<typename CELL_TYPE>

virtual void LibGeoDecomp::TracingWriter< CELL_TYPE >::stepFinished	(	const ParallelWriterGridType &	grid,
		const Region< DIM > &	validRegion,
		const Coord< DIM > &	globalDimensions,
		unsigned	step,
		WriterEvent	event,
		std::size_t	rank,
		bool	lastCall
	)			`[inline, virtual]`

References LibGeoDecomp::TracingWriter< CELL_TYPE >::OUTPUT_ON_ALL_RANKS, LibGeoDecomp::TracingWriter< CELL_TYPE >::outputRank, and LibGeoDecomp::TracingWriter< CELL_TYPE >::stepFinished().

template<typename CELL_TYPE>

void LibGeoDecomp::TracingWriter< CELL_TYPE >::stepFinished	(	unsigned	step,
		const Coord< DIM > &	globalDimensions,
		WriterEvent	event
	)			`[inline, private]`

References LibGeoDecomp::TracingWriter< CELL_TYPE >::currentTime(), LibGeoDecomp::TracingWriter< CELL_TYPE >::lastStep, LibGeoDecomp::TracingWriter< CELL_TYPE >::normalStepFinished(), LibGeoDecomp::TracingWriter< CELL_TYPE >::printTime(), LibGeoDecomp::TracingWriter< CELL_TYPE >::startTime, LibGeoDecomp::TracingWriter< CELL_TYPE >::stream, LibGeoDecomp::WRITER_ALL_DONE, LibGeoDecomp::WRITER_INITIALIZED, and LibGeoDecomp::WRITER_STEP_FINISHED.

template<typename CELL_TYPE>

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