My Project
Loading...
Searching...
No Matches
SimulatorTimer.hpp
1/*
2 Copyright 2012 SINTEF ICT, Applied Mathematics.
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
20#ifndef OPM_SIMULATORTIMER_HEADER_INCLUDED
21#define OPM_SIMULATORTIMER_HEADER_INCLUDED
22
23#include <opm/simulators/timestepping/SimulatorTimerInterface.hpp>
24
25#include <boost/date_time/gregorian/gregorian_types.hpp>
26
27#include <iosfwd>
28#include <memory>
29#include <vector>
30
31namespace Opm
32{
33
34 class ParameterGroup;
35 class Schedule;
36
38 {
39 public:
40 // use default implementation of these methods
43
46
47 static SimulatorTimer serializationTestObject();
48
52 void init(const ParameterGroup& param);
53
55 void init(const Schedule& schedule, size_t report_step = 0);
56
58 bool initialStep() const override;
59
61 int numSteps() const;
62
67 int currentStepNum() const override;
68
70 void setCurrentStepNum(int step);
71
76 double currentStepLength() const override;
77
84 double stepLengthTaken () const override;
85
88 double simulationTimeElapsed() const override;
89
91 double totalTime() const;
92
94 boost::posix_time::ptime startDateTime() const override;
95
100 void setTotalTime(double time);
101
104 void report(std::ostream& os) const;
105
108
110 void advance() override { this->operator++(); }
111
113 bool done() const override;
114
117 bool lastStepFailed() const override { return false; }
118
120 std::unique_ptr<SimulatorTimerInterface> clone() const override;
121
122 template<class Serializer>
123 void serializeOp(Serializer& serializer)
124 {
125 serializer(timesteps_);
126 serializer(current_step_);
127 serializer(current_time_);
128 serializer(total_time_);
129 serializer(start_date_);
130 }
131
132 bool operator==(const SimulatorTimer& rhs) const;
133
134 private:
135 std::vector<double> timesteps_;
136 int current_step_;
137 double current_time_;
138 double total_time_;
139 boost::gregorian::date start_date_;
140 };
141
142
143} // namespace Opm
144
145#endif // OPM_SIMULATORTIMER_HEADER_INCLUDED
Definition AquiferInterface.hpp:35
Interface class for SimulatorTimer objects, to be improved.
Definition SimulatorTimerInterface.hpp:34
virtual time_t currentPosixTime() const
Time elapsed since the start of the POSIX epoch (Jan 1st, 1970) until the current time step begins [s...
Definition SimulatorTimerInterface.cpp:37
virtual boost::posix_time::ptime currentDateTime() const
Return the current time as a posix time object.
Definition SimulatorTimerInterface.cpp:28
Definition SimulatorTimer.hpp:38
void setTotalTime(double time)
Set total time.
Definition SimulatorTimer.cpp:141
double totalTime() const
Total time.
Definition SimulatorTimer.cpp:132
bool lastStepFailed() const override
Always return false.
Definition SimulatorTimer.hpp:117
boost::posix_time::ptime startDateTime() const override
Return start date of simulation.
Definition SimulatorTimer.cpp:125
int numSteps() const
Total number of steps.
Definition SimulatorTimer.cpp:87
double currentStepLength() const override
Current step length.
Definition SimulatorTimer.cpp:107
bool initialStep() const override
Whether the current step is the first step.
Definition SimulatorTimer.cpp:81
void advance() override
advance time by currentStepLength
Definition SimulatorTimer.hpp:110
std::unique_ptr< SimulatorTimerInterface > clone() const override
return copy of object
Definition SimulatorTimer.cpp:173
void setCurrentStepNum(int step)
Set current step number.
Definition SimulatorTimer.cpp:99
void report(std::ostream &os) const
Print a report with current and total time etc.
Definition SimulatorTimer.cpp:147
double simulationTimeElapsed() const override
Time elapsed since the start of the simulation until the beginning of the current time step [s].
Definition SimulatorTimer.cpp:120
int currentStepNum() const override
Current step number.
Definition SimulatorTimer.cpp:93
double stepLengthTaken() const override
Previous step length.
Definition SimulatorTimer.cpp:113
SimulatorTimer()
Default constructor.
Definition SimulatorTimer.cpp:35
SimulatorTimer & operator++()
advance time by currentStepLength
Definition SimulatorTimer.cpp:157
bool done() const override
Return true if op++() has been called numSteps() times.
Definition SimulatorTimer.cpp:166
void init(const ParameterGroup &param)
Initialize from parameters.
Definition SimulatorTimer.cpp:57
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition BlackoilPhases.hpp:27