Chaste  Release::3.4
SimulationTime.hpp
1 /*
2 
3 Copyright (c) 2005-2016, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef SIMULATIONTIME_HPP_
37 #define SIMULATIONTIME_HPP_
38 
39 #include <boost/shared_ptr.hpp>
40 #include "ChasteSerialization.hpp"
41 #include <boost/serialization/shared_ptr.hpp>
42 #include "SerializableSingleton.hpp"
43 #include "TimeStepper.hpp"
44 
55 class SimulationTime : public SerializableSingleton<SimulationTime>
56 {
57 public:
58 
63  static SimulationTime* Instance();
64 
72  void SetEndTimeAndNumberOfTimeSteps(double endTime, unsigned totalTimeStepsInSimulation);
73 
82  void ResetEndTimeAndNumberOfTimeSteps(const double& rEndTime, const unsigned& rNumberOfTimeStepsInThisRun);
83 
91  double GetTimeStep() const;
92 
98  void IncrementTimeOneStep();
99 
105  unsigned GetTimeStepsElapsed() const;
106 
112  double GetTime() const;
113 
122  static void Destroy();
123 
129  bool IsStartTimeSetUp() const;
130 
137 
141  bool IsFinished() const;
142 
148  void SetStartTime(double startTime);
149 
150 protected:
157  SimulationTime();
158 
159 private:
164 
168  static boost::shared_ptr<TimeStepper> mpTimeStepper;
169 
173  double mStartTime;
174 
177 
186  template<class Archive>
187  void serialize(Archive & archive, const unsigned int version)
188  {
189  archive & mStartTime;
190  archive & mpTimeStepper;
191  }
192 };
193 
194 #endif /*SIMULATIONTIME_HPP_*/
bool IsEndTimeAndNumberOfTimeStepsSetUp() const
static SimulationTime * Instance()
bool IsFinished() const
unsigned GetTimeStepsElapsed() const
double GetTimeStep() const
static void Destroy()
void SetStartTime(double startTime)
void SetEndTimeAndNumberOfTimeSteps(double endTime, unsigned totalTimeStepsInSimulation)
double GetTime() const
static SimulationTime * mpInstance
bool IsStartTimeSetUp() const
friend class boost::serialization::access
void IncrementTimeOneStep()
void serialize(Archive &archive, const unsigned int version)
void ResetEndTimeAndNumberOfTimeSteps(const double &rEndTime, const unsigned &rNumberOfTimeStepsInThisRun)
static boost::shared_ptr< TimeStepper > mpTimeStepper