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

LibGeoDecomp::TestInitializer< TEST_CELL > Class Template Reference

#include <testinitializer.h>

Inherits Initializer< TEST_CELL >.

Collaboration diagram for LibGeoDecomp::TestInitializer< TEST_CELL >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef Initializer< TEST_CELL >
::Topology 
Topology

Public Member Functions

 TestInitializer (const Coord< DIM > &dim=TestInitializerHelper< DIM >::getDimensions(), const unsigned &maxSteps=TestInitializerHelper< DIM >::maxSteps, const unsigned &startStep=0)
virtual void grid (GridBase< TEST_CELL, DIM > *ret)
 initializes all cells of the grid at target
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
std::string dump ()

Static Public Attributes

static const int DIM = TEST_CELL::DIMENSIONS

Private Attributes

Coord< DIMdimensions
unsigned maximumSteps
unsigned step1

template<class TEST_CELL>
class LibGeoDecomp::TestInitializer< TEST_CELL >


Member Typedef Documentation

template<class TEST_CELL>
typedef Initializer<TEST_CELL>::Topology LibGeoDecomp::TestInitializer< TEST_CELL >::Topology

Constructor & Destructor Documentation

template<class TEST_CELL>
LibGeoDecomp::TestInitializer< TEST_CELL >::TestInitializer ( const Coord< DIM > &  dim = TestInitializerHelper<DIM>::getDimensions(),
const unsigned maxSteps = TestInitializerHelper<DIM>::maxSteps,
const unsigned startStep = 0 
) [inline, explicit]

Member Function Documentation

template<class TEST_CELL>
std::string LibGeoDecomp::TestInitializer< TEST_CELL >::dump (  )  [inline]
template<class TEST_CELL>
virtual void LibGeoDecomp::TestInitializer< TEST_CELL >::grid ( GridBase< TEST_CELL, DIM > *  target  )  [inline, virtual]
template<class TEST_CELL>
Coord<DIM> LibGeoDecomp::TestInitializer< TEST_CELL >::gridDimensions (  )  const [inline, virtual]

returns the size of the gridBox().

Implements LibGeoDecomp::Initializer< TEST_CELL >.

template<class TEST_CELL>
unsigned LibGeoDecomp::TestInitializer< TEST_CELL >::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< TEST_CELL >.

template<class TEST_CELL>
unsigned LibGeoDecomp::TestInitializer< TEST_CELL >::startStep (  )  const [inline, virtual]

Member Data Documentation

template<class TEST_CELL>
const int LibGeoDecomp::TestInitializer< TEST_CELL >::DIM = TEST_CELL::DIMENSIONS [static]
template<class TEST_CELL>
Coord<DIM> LibGeoDecomp::TestInitializer< TEST_CELL >::dimensions [private]
template<class TEST_CELL>
unsigned LibGeoDecomp::TestInitializer< TEST_CELL >::maximumSteps [private]
template<class TEST_CELL>
unsigned LibGeoDecomp::TestInitializer< TEST_CELL >::step1 [private]

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