SimulationTime Class Reference

#include <SimulationTime.hpp>

Collaboration diagram for SimulationTime:

Public Member Functions
void	SetEndTimeAndNumberOfTimeSteps (double endTime, unsigned totalTimeStepsInSimulation)
void	ResetEndTimeAndNumberOfTimeSteps (const double &rEndTime, const unsigned &rNumberOfTimeStepsInThisRun)
double	GetTimeStep () const
void	IncrementTimeOneStep ()
unsigned	GetTimeStepsElapsed () const
double	GetTime () const
bool	IsStartTimeSetUp () const
bool	IsFinished () const
unsigned	GetTotalNumberOfTimeSteps () const
void	SetStartTime (double startTime)
Static Public Member Functions
static SimulationTime *	Instance ()
static void	Destroy ()
Protected Member Functions
	SimulationTime ()
	SimulationTime (const SimulationTime &)
SimulationTime &	operator= (const SimulationTime &)
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Private Attributes
double	mDurationOfSimulation
unsigned	mTotalTimeStepsInSimulation
unsigned	mTimeStepsElapsed
bool	mEndTimeAndNumberOfTimeStepsSet
double	mCurrentTime
double	mEndTime
double	mStartTime
bool	mStartTimeSet
Static Private Attributes
static SimulationTime *	mpInstance = NULL
Friends
class	boost::serialization::access

Detailed Description

Simulation time object stores the simulation time. It uses the singleton pattern to provide a globally consistent time.

Note that the start time, end time and number of time steps must be set before time can be incremented and returned.

You should generally use the calls IncrementTimeOneStep() and GetTime() when using this class.

Definition at line 45 of file SimulationTime.hpp.

Constructor & Destructor Documentation

SimulationTime::SimulationTime ( ) [protected]

Default simulation time constructor

Sets up time, you must set the start time, end time and number of time steps before using the object.

Definition at line 46 of file SimulationTime.cpp.

References mpInstance.

SimulationTime::SimulationTime ( const SimulationTime & ) [protected]

Copy constructor.

Member Function Documentation

void SimulationTime::Destroy ( ) [static]

Destroy the current SimulationTime instance. The next call to Instance will create a new instance, on which SetEndTimeAndNumberOfTimeSteps must be called again to reset time.

This method *must* be called before program exit, to avoid a memory leak.

Definition at line 58 of file SimulationTime.cpp.

References mpInstance.

Referenced by AbstractCellBasedTestSuite::tearDown().

double SimulationTime::GetTime ( ) const

Get the simulation time (in hours), should not have rounding errors.

Returns:: simulation time

Definition at line 103 of file SimulationTime.cpp.

References mCurrentTime, and mStartTimeSet.

Referenced by AbstractCellCycleModel::GetAge(), TissueCell::GetTimeUntilDeath(), CryptSimulation2d::PostSolve(), AbstractSimpleCellCycleModel::ResetForDivision(), TissueSimulationArchiver< DIM, SIM >::Save(), CryptSimulation2d::SetupSolve(), TissueSimulation< DIM >::Solve(), TissueCell::StartApoptosis(), SingleOdeWntCellCycleModel::UpdateBetaCateninLevel(), AbstractOdeBasedCellCycleModel::UpdateCellCyclePhase(), TissueSimulation< DIM >::UpdateNodePositions(), MeshBasedTissue< DIM >::WriteCellAreaResultsToFile(), AbstractTissue< DIM >::WriteCellIdDataToFile(), MeshBasedTissue< DIM >::WriteResultsToFiles(), AbstractTissue< DIM >::WriteResultsToFiles(), AbstractTissue< DIM >::WriteTimeAndNodeResultsToFiles(), MeshBasedTissue< DIM >::WriteTissueAreaResultsToFile(), and MeshBasedTissue< DIM >::WriteVoronoiResultsToFile().

double SimulationTime::GetTimeStep ( ) const

Get the simulation time step, set in earlier calls.

Warning: Use of this method may result in round errors; generally use GetTime() instead.

Returns:: time step for this run of the simulation

Definition at line 77 of file SimulationTime.cpp.

References mDurationOfSimulation, mEndTimeAndNumberOfTimeStepsSet, mStartTimeSet, and mTotalTimeStepsInSimulation.

Referenced by GeneralisedLinearSpringForce< DIM >::CalculateForceBetweenNodes(), CryptSimulation2d::PostSolve(), WntCellCycleModel::SolveOdeToTime(), AbstractVanLeeuwen2009WntSwatCellCycleModel::SolveOdeToTime(), and SingleOdeWntCellCycleModel::UpdateBetaCateninLevel().

unsigned SimulationTime::GetTimeStepsElapsed ( ) const

Get the number of time steps that have elapsed.

Returns:: number of time steps which have been taken

Definition at line 96 of file SimulationTime.cpp.

References mEndTimeAndNumberOfTimeStepsSet, and mTimeStepsElapsed.

Referenced by CryptSimulation2d::PostSolve(), and TissueSimulation< DIM >::Solve().

unsigned SimulationTime::GetTotalNumberOfTimeSteps ( ) const

Returns:: the total number of time steps to be taken in this run.

Definition at line 163 of file SimulationTime.cpp.

References mTotalTimeStepsInSimulation.

void SimulationTime::IncrementTimeOneStep ( )

Increment the simulation time by one time step.

GetTime() will return an updated current time after this call.

Definition at line 85 of file SimulationTime.cpp.

References mCurrentTime, mDurationOfSimulation, mEndTimeAndNumberOfTimeStepsSet, mStartTime, mStartTimeSet, mTimeStepsElapsed, and mTotalTimeStepsInSimulation.

Referenced by TissueSimulation< DIM >::Solve().

SimulationTime * SimulationTime::Instance ( ) [static]

Return a pointer to the simulation time object. The first time this is called the simulation time object is created.

Definition at line 36 of file SimulationTime.cpp.

References mpInstance.

Referenced by GeneralisedLinearSpringForce< DIM >::CalculateForceBetweenNodes(), AbstractCellCycleModel::GetAge(), TissueCell::GetTimeUntilDeath(), TissueCell::IsDead(), TissueSimulationArchiver< DIM, SIM >::Load(), CryptSimulation2d::PostSolve(), AbstractSimpleCellCycleModel::ResetForDivision(), TissueSimulationArchiver< DIM, SIM >::Save(), AbstractCellCycleModel::serialize(), AbstractCellBasedTestSuite::setUp(), CryptSimulation2d::SetupSolve(), TissueSimulation< DIM >::Solve(), WntCellCycleModel::SolveOdeToTime(), AbstractVanLeeuwen2009WntSwatCellCycleModel::SolveOdeToTime(), TissueCell::StartApoptosis(), RandomCellKiller< DIM >::TestAndLabelSingleCellForApoptosis(), TissueCell::TissueCell(), SingleOdeWntCellCycleModel::UpdateBetaCateninLevel(), AbstractOdeBasedCellCycleModel::UpdateCellCyclePhase(), SingleOdeWntCellCycleModel::UpdateCellCyclePhase(), AbstractWntOdeBasedCellCycleModel::UpdateCellProliferativeType(), TissueSimulation< DIM >::UpdateNodePositions(), MeshBasedTissue< DIM >::WriteCellAreaResultsToFile(), AbstractTissue< DIM >::WriteCellIdDataToFile(), MeshBasedTissue< DIM >::WriteResultsToFiles(), AbstractTissue< DIM >::WriteResultsToFiles(), AbstractTissue< DIM >::WriteTimeAndNodeResultsToFiles(), MeshBasedTissue< DIM >::WriteTissueAreaResultsToFile(), and MeshBasedTissue< DIM >::WriteVoronoiResultsToFile().

bool SimulationTime::IsFinished ( ) const

Returns:: whether the simulation has finished.

Definition at line 157 of file SimulationTime.cpp.

References mCurrentTime, and mEndTime.

bool SimulationTime::IsStartTimeSetUp ( ) const

Allows lower classes to check whether the simulation time class has been set up before using it

Returns:: whether the start time of the simulation has been set.

Definition at line 151 of file SimulationTime.cpp.

References mStartTimeSet.

Referenced by TissueSimulationArchiver< DIM, SIM >::Load(), and TissueSimulationArchiver< DIM, SIM >::Save().

SimulationTime& SimulationTime::operator= ( const SimulationTime & ) [protected]

Overloaded assignment operator.

void SimulationTime::ResetEndTimeAndNumberOfTimeSteps	(	const double &	rEndTime,
		const unsigned &	rNumberOfTimeStepsInThisRun
	)

Reset method for the end time and the number of time steps, to run the simulation further after a first initial run.

Parameters:

	rEndTime	the new end time for this simulation (the simulation will run from the current time to this new end time, NOT from 0 to this end time)
	rNumberOfTimeStepsInThisRun	the number of time steps into which the next run is split

Definition at line 131 of file SimulationTime.cpp.

References mCurrentTime, mDurationOfSimulation, mEndTime, mEndTimeAndNumberOfTimeStepsSet, mStartTime, mStartTimeSet, mTimeStepsElapsed, and mTotalTimeStepsInSimulation.

Referenced by TissueSimulation< DIM >::Solve().

template<class Archive >

void SimulationTime::serialize	(	Archive &	archive,
		const unsigned int	version
	)			`[inline, private]`

Serialization of a SimulationTime object must be done with care. Before the object is serialized via a pointer, it *MUST* be serialized directly, or an assertion will trip when a second instance of the class is created on de-serialization.

Parameters: