SimulationTime.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2009
00004 
00005 University of Oxford means the Chancellor, Masters and Scholars of the
00006 University of Oxford, having an administrative office at Wellington
00007 Square, Oxford OX1 2JD, UK.
00008 
00009 This file is part of Chaste.
00010 
00011 Chaste is free software: you can redistribute it and/or modify it
00012 under the terms of the GNU Lesser General Public License as published
00013 by the Free Software Foundation, either version 2.1 of the License, or
00014 (at your option) any later version.
00015 
00016 Chaste is distributed in the hope that it will be useful, but WITHOUT
00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
00019 License for more details. The offer of Chaste under the terms of the
00020 License is subject to the License being interpreted in accordance with
00021 English Law and subject to any action against the University of Oxford
00022 being under the jurisdiction of the English Courts.
00023 
00024 You should have received a copy of the GNU Lesser General Public License
00025 along with Chaste. If not, see <http://www.gnu.org/licenses/>.
00026 
00027 */
00028 #ifndef SIMULATIONTIME_HPP_
00029 #define SIMULATIONTIME_HPP_
00030 
00031 #include <boost/serialization/access.hpp>
00032 
00033 #include "Exception.hpp"
00034 
00045 class SimulationTime
00046 {
00047 public:
00048 
00053     static SimulationTime* Instance();
00054 
00062     void SetEndTimeAndNumberOfTimeSteps(double endTime, unsigned totalTimeStepsInSimulation);
00063 
00072     void ResetEndTimeAndNumberOfTimeSteps(const double& rEndTime, const unsigned& rNumberOfTimeStepsInThisRun);
00073 
00081     double GetTimeStep() const;
00082 
00088     void IncrementTimeOneStep();
00089 
00095     unsigned GetTimeStepsElapsed() const;
00096 
00102     double GetTime() const;
00103 
00112     static void Destroy();
00113 
00119     bool IsStartTimeSetUp() const;
00120 
00124     bool IsFinished() const;
00125 
00129     unsigned GetTotalNumberOfTimeSteps() const;
00130 
00136     void SetStartTime(double startTime);
00137 
00138 protected:
00139 
00146     SimulationTime();
00147 
00151     SimulationTime(const SimulationTime&);
00152 
00156     SimulationTime& operator= (const SimulationTime&);
00157 
00158 private:
00159 
00163     static SimulationTime *mpInstance;
00164 
00168     double mDurationOfSimulation;
00169 
00173     unsigned mTotalTimeStepsInSimulation;
00174 
00178     unsigned mTimeStepsElapsed;
00179 
00184     bool mEndTimeAndNumberOfTimeStepsSet;
00185 
00189     double mCurrentTime;
00190 
00194     double mEndTime;
00195 
00199     double mStartTime;
00200 
00205     bool mStartTimeSet;
00206 
00208     friend class boost::serialization::access;
00218     template<class Archive>
00219     void serialize(Archive & archive, const unsigned int version)
00220     {
00221         // If Archive is an output archive, then '&' resolves to '<<'
00222         // If Archive is an input archive, then '&' resolves to '>>'
00223         archive & mDurationOfSimulation;
00224         archive & mTotalTimeStepsInSimulation;
00225         archive & mTimeStepsElapsed;
00226         archive & mEndTimeAndNumberOfTimeStepsSet;
00227         archive & mCurrentTime;
00228         archive & mEndTime;
00229         archive & mStartTimeSet;
00230         archive & mStartTime;
00231     }
00232 };
00233 
00234 #endif /*SIMULATIONTIME_HPP_*/

Generated on Tue Aug 4 16:10:21 2009 for Chaste by  doxygen 1.5.5