Files
opm-common/opm/parser/eclipse/EclipseState/Schedule/TimeMap.hpp

70 lines
2.8 KiB
C++

/*
Copyright 2013 Statoil ASA.
This file is part of the Open Porous Media project (OPM).
OPM is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OPM is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef TIMEMAP_HPP_
#define TIMEMAP_HPP_
#include <vector>
#include <boost/date_time.hpp>
#include <opm/parser/eclipse/Deck/Deck.hpp>
#include <opm/parser/eclipse/Deck/DeckKeyword.hpp>
#include <opm/parser/eclipse/Deck/DeckRecord.hpp>
namespace Opm {
class TimeMap {
public:
TimeMap(boost::posix_time::ptime startDate);
TimeMap(Opm::DeckConstPtr deck);
void addTime(boost::posix_time::ptime newTime);
void addTStep(boost::posix_time::time_duration step);
void addFromDATESKeyword( DeckKeywordConstPtr DATESKeyword );
void addFromTSTEPKeyword( DeckKeywordConstPtr TSTEPKeyword );
size_t size() const;
size_t numTimesteps() const;
double getTotalTime() const;
/// Return the date and time where a given time step starts.
boost::posix_time::ptime getStartTime(size_t tStepIdx) const;
/// Return the period of time in seconds which passed between the start of the simulation and a given point in time.
double getTimePassedUntil(size_t tLevelIdx) const;
/// Return the length of a given time step in seconds.
double getTimeStepLength(size_t tStepIdx) const;
/// Return a list of the first timesteps of each month
void initFirstTimestepsMonths(std::vector<size_t>& timesteps, size_t timestep=0) const;
/// Return a list of the first timesteps of each year
void initFirstTimestepsYears(std::vector<size_t>& timesteps, size_t start_timestep=0) const;
static boost::posix_time::ptime timeFromEclipse(DeckRecordConstPtr dateRecord);
static boost::posix_time::ptime timeFromEclipse(int day , const std::string& month, int year, const std::string& eclipseTimeString = "00:00:00.000");
static boost::posix_time::time_duration dayTimeFromEclipse(const std::string& eclipseTimeString);
private:
static const std::map<std::string , boost::gregorian::greg_month>& eclipseMonthNames();
std::vector<boost::posix_time::ptime> m_timeList;
};
typedef std::shared_ptr<TimeMap> TimeMapPtr;
typedef std::shared_ptr<const TimeMap> TimeMapConstPtr;
}
#endif /* TIMEMAP_HPP_ */