Public Types | Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | Friends

LibGeoDecomp::TracingWriter< CELL_TYPE > Class Template Reference

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 >:
Collaboration graph
[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
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]
template<typename CELL_TYPE>
void LibGeoDecomp::TracingWriter< CELL_TYPE >::normalStepFinished ( unsigned  step,
const Coord< DIM > &  globalDimensions 
) [inline, private]
template<typename CELL_TYPE>
void LibGeoDecomp::TracingWriter< CELL_TYPE >::printTime (  )  const [inline, private]
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]
template<typename CELL_TYPE>
void LibGeoDecomp::TracingWriter< CELL_TYPE >::stepFinished ( unsigned  step,
const Coord< DIM > &  globalDimensions,
WriterEvent  event 
) [inline, private]
template<typename CELL_TYPE>
virtual void LibGeoDecomp::TracingWriter< CELL_TYPE >::stepFinished ( const WriterGridType grid,
unsigned  step,
WriterEvent  event 
) [inline, virtual]

Friends And Related Function Documentation

template<typename CELL_TYPE>
friend class boost::serialization::access [friend]
template<typename CELL_TYPE>
friend class Serialization [friend]

Member Data Documentation

template<typename CELL_TYPE>
const int LibGeoDecomp::TracingWriter< CELL_TYPE >::DIM = Topology::DIM [static]
template<typename CELL_TYPE>
unsigned LibGeoDecomp::TracingWriter< CELL_TYPE >::lastStep [private]
template<typename CELL_TYPE>
unsigned LibGeoDecomp::TracingWriter< CELL_TYPE >::maxSteps [private]
template<typename CELL_TYPE>
const int LibGeoDecomp::TracingWriter< CELL_TYPE >::OUTPUT_ON_ALL_RANKS = -1 [static]
template<typename CELL_TYPE>
int LibGeoDecomp::TracingWriter< CELL_TYPE >::outputRank [private]
template<typename CELL_TYPE>
Time LibGeoDecomp::TracingWriter< CELL_TYPE >::startTime [private]
template<typename CELL_TYPE>
std::ostream& LibGeoDecomp::TracingWriter< CELL_TYPE >::stream [private]

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