Chaste  Release::3.4
TimeStepper.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 TIMESTEPPER_HPP_
37 #define TIMESTEPPER_HPP_
38 
39 #include <vector>
40 #include <climits>
41 #include <boost/serialization/vector.hpp>
42 
43 #include "ChasteSerialization.hpp"
44 #include "Exception.hpp"
45 
53 {
54  friend class TestTimeStepper;
55 private:
56  /*
57  * Private default constructor for archiving
58  */
59  TimeStepper(){};
60 
61 public:
62 
78  TimeStepper(double startTime, double endTime, double dt, bool enforceConstantTimeStep=false, std::vector<double> additionalTimes=std::vector<double> ());
79 
86  void AdvanceOneTimeStep();
87 
91  double GetTime() const;
92 
96  double GetNextTime() const;
97 
113  double GetNextTimeStep();
114 
120  double GetIdealTimeStep();
121 
125  bool IsTimeAtEnd() const;
126 
131  unsigned EstimateTimeSteps() const;
132 
137  unsigned GetTotalTimeStepsTaken() const;
138 
146  void ResetTimeStep(double dt);
147 
148 private:
149 
151  double mStart;
152 
154  double mEnd;
155 
157  double mDt;
158 
161 
164 
166  double mTime;
167 
169  double mNextTime;
170 
176  double mEpsilon;
177 
179  double CalculateNextTime();
180 
182  std::vector<double> mAdditionalTimesDeprecated;
183 
186 
192  template<class Archive>
193  void serialize(Archive & archive, const unsigned int version)
194  {
195  archive & mStart;
196  archive & mEnd;
197  archive & mDt;
198  archive & mTotalTimeStepsTaken;
199  archive & mTime;
200  archive & mNextTime;
201  archive & mEpsilon;
203  archive & mAdditionalTimesDeprecated;
204  }
205 
206 };
207 
209 // Declare identifier for the serializer
211 
212 #endif /*TIMESTEPPER_HPP_*/
double GetNextTimeStep()
double GetTime() const
friend class boost::serialization::access
void ResetTimeStep(double dt)
void AdvanceOneTimeStep()
bool IsTimeAtEnd() const
void serialize(Archive &archive, const unsigned int version)
unsigned GetTotalTimeStepsTaken() const
double GetIdealTimeStep()
double CalculateNextTime()
unsigned EstimateTimeSteps() const
double mNextTime
unsigned mAdditionalTimesReachedDeprecated
std::vector< double > mAdditionalTimesDeprecated
#define CHASTE_CLASS_EXPORT(T)
double GetNextTime() const
unsigned mTotalTimeStepsTaken
double mEpsilon