This convenience class implements some straightforward functions of Initializer. More...
#include <simpleinitializer.h>
Inherits Initializer< CELL_TYPE >.
Public Types | |
| typedef Initializer< CELL_TYPE > ::Topology | Topology |
Public Member Functions | |
| SimpleInitializer () | |
| SimpleInitializer (const Coord< DIM > &dimensions, const unsigned steps=300) | |
| Coord< DIM > | gridDimensions () 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< DIM > | dimensions |
| 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
| typedef Initializer<CELL_TYPE>::Topology LibGeoDecomp::SimpleInitializer< CELL_TYPE >::Topology |
Reimplemented from LibGeoDecomp::Initializer< CELL_TYPE >.
Constructor & Destructor Documentation
| LibGeoDecomp::SimpleInitializer< CELL_TYPE >::SimpleInitializer | ( | ) | [inline] |
| LibGeoDecomp::SimpleInitializer< CELL_TYPE >::SimpleInitializer | ( | const Coord< DIM > & | dimensions, | |
| const unsigned | steps = 300 | |||
| ) | [inline, explicit] |
Member Function Documentation
| Coord<DIM> LibGeoDecomp::SimpleInitializer< CELL_TYPE >::gridDimensions | ( | ) | const [inline, virtual] |
returns the size of the gridBox().
Implements LibGeoDecomp::Initializer< 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 >.
| 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
friend class Serialization [friend] |
Reimplemented from LibGeoDecomp::Initializer< CELL_TYPE >.
Member Data Documentation
const int LibGeoDecomp::SimpleInitializer< CELL_TYPE >::DIM = Topology::DIM [static] |
Reimplemented from LibGeoDecomp::Initializer< CELL_TYPE >.
Coord<DIM> LibGeoDecomp::SimpleInitializer< CELL_TYPE >::dimensions [protected] |
unsigned LibGeoDecomp::SimpleInitializer< CELL_TYPE >::steps [protected] |
The documentation for this class was generated from the following file:
