SimulationTime Class Reference

#include <SimulationTime.hpp>

Inheritance diagram for SimulationTime:

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	IsEndTimeAndNumberOfTimeStepsSetUp () const
bool	IsFinished () const
void	SetStartTime (double startTime)
Public Member Functions inherited from SerializableSingleton< SimulationTime >
SerializableSingleton< SimulationTime > *	GetSerializationWrapper () const

Static Public Member Functions
static SimulationTime *	Instance ()
static void	Destroy ()

Protected Member Functions
	SimulationTime ()

Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)

Private Attributes
double	mStartTime

Static Private Attributes
static SimulationTime *	mpInstance = nullptr
static boost::shared_ptr< TimeStepper >	mpTimeStepper

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 55 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 57 of file SimulationTime.cpp.

References mpInstance.

Referenced by Instance().

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 65 of file SimulationTime.cpp.

References mpInstance.

Referenced by Instance(), and AbstractCellBasedTestSuite::tearDown().

double SimulationTime::GetTime

(

)

const

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

Returns

simulation time

Definition at line 92 of file SimulationTime.cpp.

References DOUBLE_UNSET, mpTimeStepper, and mStartTime.

Referenced by AbstractCellBasedSimulation< ELEMENT_DIM, SPACE_DIM >::DoCellBirth(), AbstractCellCycleModel::GetAge(), Cell::GetTimeUntilDeath(), AbstractOdeBasedCellCycleModel::ReadyToDivide(), AbstractCellCycleModel::ResetForDivision(), CellBasedSimulationArchiver< ELEMENT_DIM, SIM, SPACE_DIM >::Save(), SimpleOxygenBasedCellCycleModel::SimpleOxygenBasedCellCycleModel(), NullSrnModel::SimulateToCurrentTime(), AbstractOdeSrnModel::SimulateToCurrentTime(), AbstractCellBasedSimulation< ELEMENT_DIM, SPACE_DIM >::Solve(), Cell::StartApoptosis(), AbstractPdeModifier< DIM >::UpdateAtEndOfOutputTimeStep(), ContactInhibitionCellCycleModel::UpdateCellCyclePhase(), AbstractOdeBasedPhaseBasedCellCycleModel::UpdateCellCyclePhase(), SimpleOxygenBasedCellCycleModel::UpdateHypoxicDuration(), SimpleTargetAreaModifier< DIM >::UpdateTargetAreaOfCell(), TargetAreaLinearGrowthModifier< DIM >::UpdateTargetAreaOfCell(), DiscreteSystemForceCalculator::WriteResultsToFile(), and AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::WriteTimeStamp().

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 74 of file SimulationTime.cpp.

References mpTimeStepper.

Referenced by DiffusionForce< DIM >::AddForceContribution(), CryptProjectionForce::CalculateForceBetweenNodes(), GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::CalculateForceBetweenNodes(), CellCycleModelOdeHandler::GetDt(), BernoulliTrialCellCycleModel::ReadyToDivide(), ContactInhibitionCellCycleModel::UpdateCellCyclePhase(), SimpleOxygenBasedCellCycleModel::UpdateCellCyclePhase(), and NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM >::Visit().

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 86 of file SimulationTime.cpp.

References mpTimeStepper.

Referenced by AbstractCellBasedSimulation< ELEMENT_DIM, SPACE_DIM >::Solve(), AbstractPdeModifier< DIM >::UpdateAtEndOfOutputTimeStep(), OnLatticeSimulation< DIM >::UpdateCellPopulation(), VertexBasedCellPopulation< DIM >::WriteVtkResultsToFile(), CaBasedCellPopulation< DIM >::WriteVtkResultsToFile(), PottsBasedCellPopulation< DIM >::WriteVtkResultsToFile(), NodeBasedCellPopulationWithParticles< DIM >::WriteVtkResultsToFile(), NodeBasedCellPopulation< DIM >::WriteVtkResultsToFile(), MeshBasedCellPopulationWithGhostNodes< DIM >::WriteVtkResultsToFile(), and MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::WriteVtkResultsToFile().

void SimulationTime::IncrementTimeOneStep

(

)

Increment the simulation time by one time step.

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

Definition at line 80 of file SimulationTime.cpp.

References mpTimeStepper.

Referenced by AbstractCellBasedSimulation< ELEMENT_DIM, SPACE_DIM >::Solve().

SimulationTime * SimulationTime::Instance ( )

static

Returns

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

Definition at line 46 of file SimulationTime.cpp.

References Destroy(), mpInstance, mpTimeStepper, and SimulationTime().

Referenced by DiffusionForce< DIM >::AddForceContribution(), CryptProjectionForce::CalculateForceBetweenNodes(), GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >::CalculateForceBetweenNodes(), Cell::Cell(), RandomCellKiller< DIM >::CheckAndLabelSingleCellForApoptosis(), AbstractCellBasedSimulation< ELEMENT_DIM, SPACE_DIM >::DoCellBirth(), AbstractCellCycleModel::GetAge(), VertexBasedCellPopulation< DIM >::GetDampingConstant(), CellCycleModelOdeHandler::GetDt(), Cell::GetTimeUntilDeath(), Cell::IsDead(), BernoulliTrialCellCycleModel::ReadyToDivide(), AbstractOdeBasedCellCycleModel::ReadyToDivide(), AbstractSrnModel::ResetForDivision(), AbstractCellCycleModel::ResetForDivision(), CellBasedSimulationArchiver< ELEMENT_DIM, SIM, SPACE_DIM >::Save(), AbstractSrnModel::serialize(), AbstractCellCycleModel::serialize(), AbstractCellBasedSimulation< DIM >::serialize(), AbstractCellBasedTestSuite::setUp(), SimpleOxygenBasedCellCycleModel::SimpleOxygenBasedCellCycleModel(), NullSrnModel::SimulateToCurrentTime(), AbstractOdeSrnModel::SimulateToCurrentTime(), AbstractCellBasedSimulation< ELEMENT_DIM, SPACE_DIM >::Solve(), Cell::StartApoptosis(), NodeBasedCellPopulation< DIM >::Update(), AbstractPdeModifier< DIM >::UpdateAtEndOfOutputTimeStep(), ParabolicGrowingDomainPdeModifier< DIM >::UpdateAtEndOfTimeStep(), ParabolicBoxDomainPdeModifier< DIM >::UpdateAtEndOfTimeStep(), AbstractWntOdeBasedCellCycleModel::UpdateCellCyclePhase(), ContactInhibitionCellCycleModel::UpdateCellCyclePhase(), AbstractOdeBasedPhaseBasedCellCycleModel::UpdateCellCyclePhase(), SimpleOxygenBasedCellCycleModel::UpdateCellCyclePhase(), SingleOdeWntCellCycleModel::UpdateCellCyclePhase(), OnLatticeSimulation< DIM >::UpdateCellPopulation(), SimpleOxygenBasedCellCycleModel::UpdateHypoxicDuration(), SimpleTargetAreaModifier< DIM >::UpdateTargetAreaOfCell(), TargetAreaLinearGrowthModifier< DIM >::UpdateTargetAreaOfCell(), PottsBasedCellPopulation< DIM >::Validate(), VertexBasedCellPopulation< DIM >::Validate(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::Validate(), NodeBasedCellPopulation< DIM >::Validate(), NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM >::Visit(), DiscreteSystemForceCalculator::WriteResultsToFile(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::WriteResultsToFiles(), AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::WriteTimeStamp(), VertexBasedCellPopulation< DIM >::WriteVtkResultsToFile(), CaBasedCellPopulation< DIM >::WriteVtkResultsToFile(), PottsBasedCellPopulation< DIM >::WriteVtkResultsToFile(), NodeBasedCellPopulationWithParticles< DIM >::WriteVtkResultsToFile(), NodeBasedCellPopulation< DIM >::WriteVtkResultsToFile(), MeshBasedCellPopulationWithGhostNodes< DIM >::WriteVtkResultsToFile(), and MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::WriteVtkResultsToFile().

bool SimulationTime::IsEndTimeAndNumberOfTimeStepsSetUp

(

)

const

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

Returns

whether the end time of the simulation and the number of timesteps has been set.

Definition at line 141 of file SimulationTime.cpp.

References mpTimeStepper.

Referenced by AbstractCellBasedSimulation< ELEMENT_DIM, SPACE_DIM >::Solve().

bool SimulationTime::IsFinished

(

)

const

Returns

whether the simulation has finished.

Definition at line 153 of file SimulationTime.cpp.

References mpTimeStepper.

Referenced by AbstractCellBasedSimulation< ELEMENT_DIM, SPACE_DIM >::Solve().

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 136 of file SimulationTime.cpp.

References DOUBLE_UNSET, and mStartTime.

Referenced by CellBasedSimulationArchiver< ELEMENT_DIM, SIM, SPACE_DIM >::Save().

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 122 of file SimulationTime.cpp.

References DOUBLE_UNSET, mpTimeStepper, and mStartTime.

Referenced by AbstractCellBasedSimulation< ELEMENT_DIM, SPACE_DIM >::Solve().

template<class Archive >

void SimulationTime::serialize ( Archive &  archive, const unsigned int  version  )

inlineprivate

Serialization of a SimulationTime object must be done with care. Do not serialize this singleton directly. Instead, serialize the object returned by GetSerializationWrapper.

Parameters

archive	the archive
version	the current version of this class

Definition at line 187 of file SimulationTime.hpp.

References mpTimeStepper, and mStartTime.

void SimulationTime::SetEndTimeAndNumberOfTimeSteps	(	double	endTime,
		unsigned	totalTimeStepsInSimulation
	)

Sets the end time and the number of time steps. This must be called after SetStartTime() but before using any other methods.

Parameters

endTime	time at which to end this run of the simulation
totalTimeStepsInSimulation	the number of time steps into which the above will be divided

Definition at line 111 of file SimulationTime.cpp.

References DOUBLE_UNSET, mpTimeStepper, and mStartTime.

Referenced by AbstractCellBasedSimulation< ELEMENT_DIM, SPACE_DIM >::Solve().

void SimulationTime::SetStartTime

(

double

startTime

)

Set the start time of the simulation

Parameters

startTime

the time at which the simulation begins (usually 0.0 hours)

Definition at line 105 of file SimulationTime.cpp.

References DOUBLE_UNSET, and mStartTime.

Referenced by AbstractCellBasedTestSuite::setUp().

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 176 of file SimulationTime.hpp.

Member Data Documentation

SimulationTime * SimulationTime::mpInstance = nullptr

staticprivate

A pointer to the singleton instance of this class.

Pointer to the single instance

Definition at line 163 of file SimulationTime.hpp.

Referenced by Destroy(), Instance(), and SimulationTime().

boost::shared_ptr< TimeStepper > SimulationTime::mpTimeStepper

staticprivate

Delegate all time stepping to a TimeStepper class

Shared pointer to the delegated class

Definition at line 168 of file SimulationTime.hpp.

Referenced by GetTime(), GetTimeStep(), GetTimeStepsElapsed(), IncrementTimeOneStep(), Instance(), IsEndTimeAndNumberOfTimeStepsSetUp(), IsFinished(), ResetEndTimeAndNumberOfTimeSteps(), serialize(), and SetEndTimeAndNumberOfTimeSteps().

double SimulationTime::mStartTime

private

Stores the time at which the simulation started

Definition at line 173 of file SimulationTime.hpp.

Referenced by GetTime(), IsStartTimeSetUp(), ResetEndTimeAndNumberOfTimeSteps(), serialize(), SetEndTimeAndNumberOfTimeSteps(), and SetStartTime().

---

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

• cell_based/src/common/SimulationTime.hpp
• cell_based/src/common/SimulationTime.cpp