TimeStepper.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2011
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 
00029 
00030 #ifndef TIMESTEPPER_HPP_
00031 #define TIMESTEPPER_HPP_
00032 
00033 #include <vector>
00034 
00041 class TimeStepper
00042 {
00043 public:
00057     TimeStepper(double startTime, double endTime, double dt, bool enforceConstantTimeStep=false, std::vector<double> additionalTimes=std::vector<double> ());
00058 
00062     void AdvanceOneTimeStep();
00063 
00067     double GetTime() const;
00068 
00072     double GetNextTime() const;
00073 
00078     double GetNextTimeStep();
00079 
00083     bool IsTimeAtEnd() const;
00084 
00089     unsigned EstimateTimeSteps() const;
00090 
00095     unsigned GetTotalTimeStepsTaken() const;
00096 
00104     void ResetTimeStep(double dt);
00105 
00106 private:
00107     friend class TestTimeStepper;
00108 
00110     double mStart;
00111 
00113     double mEnd;
00114 
00116     double mDt;
00117 
00119     unsigned mTotalTimeStepsTaken;
00120 
00122     unsigned mAdditionalTimesReached;
00123 
00125     double mTime;
00126 
00128     double mNextTime;
00129 
00131     double CalculateNextTime();
00132     
00134     std::vector<double> mAdditionalTimes;
00135 };
00136 
00137 #endif /*TIMESTEPPER_HPP_*/

Generated on Tue May 31 14:31:41 2011 for Chaste by  doxygen 1.5.5