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

LibGeoDecomp::SimpleInitializer< CELL_TYPE > Class Template Reference

This convenience class implements some straightforward functions of Initializer. More...

#include <simpleinitializer.h>

Inherits Initializer< CELL_TYPE >.

Collaboration diagram for LibGeoDecomp::SimpleInitializer< CELL_TYPE >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef Initializer< CELL_TYPE >
::Topology 
Topology

Public Member Functions

 SimpleInitializer ()
 SimpleInitializer (const Coord< DIM > &dimensions, const unsigned steps=300)
Coord< DIMgridDimensions () const
 returns the size of the gridBox().
unsigned maxSteps () const
 gives the time step at which the simulation should terminate.
unsigned startStep () const
 yields the logical time step at which the simulation should start

Static Public Attributes

static const int DIM = Topology::DIM

Protected Attributes

Coord< DIMdimensions
unsigned steps

Friends

class Serialization

Detailed Description

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

This convenience class implements some straightforward functions of Initializer.

Generally users will only need to implement grid().


Member Typedef Documentation

template<typename CELL_TYPE>
typedef Initializer<CELL_TYPE>::Topology LibGeoDecomp::SimpleInitializer< CELL_TYPE >::Topology

Constructor & Destructor Documentation

template<typename CELL_TYPE>
LibGeoDecomp::SimpleInitializer< CELL_TYPE >::SimpleInitializer (  )  [inline]
template<typename CELL_TYPE>
LibGeoDecomp::SimpleInitializer< CELL_TYPE >::SimpleInitializer ( const Coord< DIM > &  dimensions,
const unsigned  steps = 300 
) [inline, explicit]

Member Function Documentation

template<typename CELL_TYPE>
Coord<DIM> LibGeoDecomp::SimpleInitializer< CELL_TYPE >::gridDimensions (  )  const [inline, virtual]

returns the size of the gridBox().

Implements LibGeoDecomp::Initializer< CELL_TYPE >.

template<typename CELL_TYPE>
unsigned LibGeoDecomp::SimpleInitializer< CELL_TYPE >::maxSteps (  )  const [inline, virtual]

gives the time step at which the simulation should terminate.

Example: if startStep is 0 and maxSteps is 10, then the Simulator should start at t=0, update to t=1, update to t=2, ... until it has updated to t=10.

If startStep is 5 and maxSteps is 8, then the Simulator is expected to init at t=5, update to t=6, update to t=7, and finally update to t=8.

Implements LibGeoDecomp::Initializer< CELL_TYPE >.

template<typename CELL_TYPE>
unsigned LibGeoDecomp::SimpleInitializer< CELL_TYPE >::startStep (  )  const [inline, virtual]

yields the logical time step at which the simulation should start

Implements LibGeoDecomp::Initializer< CELL_TYPE >.


Friends And Related Function Documentation

template<typename CELL_TYPE>
friend class Serialization [friend]

Member Data Documentation

template<typename CELL_TYPE>
const int LibGeoDecomp::SimpleInitializer< CELL_TYPE >::DIM = Topology::DIM [static]
template<typename CELL_TYPE>
Coord<DIM> LibGeoDecomp::SimpleInitializer< CELL_TYPE >::dimensions [protected]
template<typename CELL_TYPE>
unsigned LibGeoDecomp::SimpleInitializer< CELL_TYPE >::steps [protected]

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