My Project
AdaptiveSimulatorTimer.hpp
1 /*
2  Copyright 2014 IRIS AS
3 
4  This file is part of the Open Porous Media project (OPM).
5 
6  OPM is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  OPM is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with OPM. If not, see <http://www.gnu.org/licenses/>.
18 */
19 #ifndef OPM_ADAPTIVESIMULATORTIMER_HEADER_INCLUDED
20 #define OPM_ADAPTIVESIMULATORTIMER_HEADER_INCLUDED
21 
22 #include <cassert>
23 #include <iostream>
24 #include <vector>
25 #include <limits>
26 #include <algorithm>
27 #include <memory>
28 #include <numeric>
29 
30 #include <opm/simulators/timestepping/SimulatorTimerInterface.hpp>
31 
32 namespace Opm
33 {
34 
41  {
42  public:
48  const double lastStepTaken,
49  const double maxTimeStep = std::numeric_limits<double>::max() );
50 
53 
55  void advance() { this->operator++ (); }
56 
58  void provideTimeStepEstimate( const double dt_estimate );
59 
61  bool initialStep () const;
62 
64  int currentStepNum () const;
65 
67  int reportStepNum() const;
68 
70  double currentStepLength () const;
71 
73  double totalTime() const;
74 
76  double simulationTimeElapsed() const;
77 
79  bool done () const;
80 
82  double averageStepLength() const;
83 
85  double maxStepLength () const;
86 
88  double minStepLength () const;
89 
92  double stepLengthTaken () const;
93 
95  void report(std::ostream& os) const;
96 
98  boost::posix_time::ptime startDateTime() const;
99 
101  bool lastStepFailed() const {return lastStepFailed_;}
102 
104  void setLastStepFailed(bool lastStepFailed) {lastStepFailed_ = lastStepFailed;}
105 
107  virtual std::unique_ptr< SimulatorTimerInterface > clone() const;
108 
109  protected:
110  std::shared_ptr<boost::posix_time::ptime> start_date_time_;
111  const double start_time_;
112  const double total_time_;
113  const int report_step_;
114  const double max_time_step_;
115 
116  double current_time_;
117  double dt_;
118  int current_step_;
119 
120  std::vector< double > steps_;
121  bool lastStepFailed_;
122 
123  };
124 
125 } // namespace Opm
126 
127 #endif // OPM_SIMULATORTIMER_HEADER_INCLUDED
Simulation timer for adaptive time stepping.
Definition: AdaptiveSimulatorTimer.hpp:41
boost::posix_time::ptime startDateTime() const
start date time of simulation
Definition: AdaptiveSimulatorTimer.cpp:163
bool done() const
Definition: AdaptiveSimulatorTimer.cpp:126
AdaptiveSimulatorTimer(const SimulatorTimerInterface &timer, const double lastStepTaken, const double maxTimeStep=std::numeric_limits< double >::max())
constructor taking a simulator timer to determine start and end time
Definition: AdaptiveSimulatorTimer.cpp:35
virtual std::unique_ptr< SimulatorTimerInterface > clone() const
return copy of object
Definition: AdaptiveSimulatorTimer.cpp:170
double currentStepLength() const
Definition: AdaptiveSimulatorTimer.cpp:108
int reportStepNum() const
return current report step
Definition: AdaptiveSimulatorTimer.cpp:106
double minStepLength() const
return min step length used so far
Definition: AdaptiveSimulatorTimer.cpp:145
int currentStepNum() const
Definition: AdaptiveSimulatorTimer.cpp:103
void provideTimeStepEstimate(const double dt_estimate)
provide and estimate for new time step size
Definition: AdaptiveSimulatorTimer.cpp:72
void report(std::ostream &os) const
report start and end time as well as used steps so far
Definition: AdaptiveSimulatorTimer.cpp:153
double totalTime() const
Definition: AdaptiveSimulatorTimer.cpp:122
double stepLengthTaken() const
Previous step length.
Definition: AdaptiveSimulatorTimer.cpp:114
void advance()
advance time by currentStepLength
Definition: AdaptiveSimulatorTimer.hpp:55
double simulationTimeElapsed() const
Definition: AdaptiveSimulatorTimer.cpp:124
bool lastStepFailed() const
Return true if last time step failed.
Definition: AdaptiveSimulatorTimer.hpp:101
double averageStepLength() const
return average step length used so far
Definition: AdaptiveSimulatorTimer.cpp:128
double maxStepLength() const
return max step length used so far
Definition: AdaptiveSimulatorTimer.cpp:138
bool initialStep() const
Whether this is the first step.
Definition: AdaptiveSimulatorTimer.cpp:56
AdaptiveSimulatorTimer & operator++()
advance time by currentStepLength
Definition: AdaptiveSimulatorTimer.cpp:61
void setLastStepFailed(bool lastStepFailed)
tell the timestepper whether timestep failed or not
Definition: AdaptiveSimulatorTimer.hpp:104
Interface class for SimulatorTimer objects, to be improved.
Definition: SimulatorTimerInterface.hpp:34
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition: BlackoilPhases.hpp:26