OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

SimulatorTimer: rename currentTime() to simulationTimeElapsed()

Browse Source 
because the name "currentTime()" can be mistaken for the point in
real-life time at which the simulation is run (e.g. March 11, 2014,
15:07:45.123), the _point_ in time which the simulator timer currently
represents (e.g. Jun 5, 1985, 02:33:12.345) instead of the simulator
time in seconds which elapsed since the START date
(e.g. 52633.345 s).

this rename may lead to some fallout in other modules. I'll
fix them after this PR has been merged...
This commit is contained in:
Andreas Lauser
2014-03-11 15:06:07 +01:00
parent 85a0032247
commit caf10e0e7f
2 changed files with 16 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
opm/simulators/timestepping/SimulatorTimer.cpp
View File

@@ -113,8 +113,8 @@ namespace Opm
return timesteps_[current_step_ - 1]; return timesteps_[current_step_ - 1];
} }
/// Current time. /// time elapsed since the start of the simulation [s].
double SimulatorTimer::currentTime() const double SimulatorTimer::simulationTimeElapsed() const
{ {
if (timeMap_) if (timeMap_)
return timeMap_->getTimePassedUntil(current_step_); return timeMap_->getTimePassedUntil(current_step_);
@@ -122,6 +122,12 @@ namespace Opm
return current_time_; return current_time_;
} }
/// time elapsed since the start of the POSIX epoch (Jan 1st, 1970) [s].
time_t SimulatorTimer::currentPosixTime() const
{
tm t = boost::posix_time::to_tm(currentDateTime());
return std::mktime(&t);
}
boost::posix_time::ptime SimulatorTimer::currentDateTime() const boost::posix_time::ptime SimulatorTimer::currentDateTime() const
{ {
@@ -161,7 +167,7 @@ namespace Opm
void SimulatorTimer::report(std::ostream& os) const void SimulatorTimer::report(std::ostream& os) const
{ {
os << "\n\n--------------- Simulation step number " << currentStepNum() << " ---------------" os << "\n\n--------------- Simulation step number " << currentStepNum() << " ---------------"
<< "\n Current time (days) " << Opm::unit::convert::to(currentTime(), Opm::unit::day) << "\n Current time (days) " << Opm::unit::convert::to(simulationTimeElapsed(), Opm::unit::day)
<< "\n Current stepsize (days) " << Opm::unit::convert::to(currentStepLength(), Opm::unit::day) << "\n Current stepsize (days) " << Opm::unit::convert::to(currentStepLength(), Opm::unit::day)
<< "\n Total time (days) " << Opm::unit::convert::to(totalTime(), Opm::unit::day) << "\n Total time (days) " << Opm::unit::convert::to(totalTime(), Opm::unit::day)
<< "\n" << std::endl; << "\n" << std::endl;

9
opm/simulators/timestepping/SimulatorTimer.hpp
View File

@@ -79,8 +79,13 @@ namespace Opm
/// it is an error to call stepLengthTaken(). /// it is an error to call stepLengthTaken().
double stepLengthTaken () const; double stepLengthTaken () const;
/// Current time. /// Time elapsed since the start of the POSIX epoch (Jan 1st,
double currentTime() const; /// 1970) until the current time step begins [s].
time_t currentPosixTime() const;
/// Time elapsed since the start of the simulation until the
/// beginning of the current time step [s].
double simulationTimeElapsed() const;
/// Return the current time as a posix time object. /// Return the current time as a posix time object.
boost::posix_time::ptime currentDateTime() const; boost::posix_time::ptime currentDateTime() const;