SimulatorTimer.hpp

Go to the documentation of this file.

/*
  Copyright 2012 SINTEF ICT, Applied Mathematics.

  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 OPM_SIMULATORTIMER_HEADER_INCLUDED
#define OPM_SIMULATORTIMER_HEADER_INCLUDED

#include <opm/parser/eclipse/EclipseState/Schedule/TimeMap.hpp>
#include <opm/core/simulator/SimulatorTimerInterface.hpp>

#include <iosfwd>
#include <vector>

namespace Opm
{

    namespace parameter { class ParameterGroup; }

    class SimulatorTimer : public SimulatorTimerInterface
    {
    public:
        // use default implementation of these methods
        using SimulatorTimerInterface::currentDateTime;
        using SimulatorTimerInterface::currentPosixTime;

        SimulatorTimer();

        void init(const parameter::ParameterGroup& param);

        void init(TimeMapConstPtr timeMap);

        int numSteps() const;

        int currentStepNum() const;

        void setCurrentStepNum(int step);

        double currentStepLength() const;

        double stepLengthTaken () const;

        double simulationTimeElapsed() const;

        double totalTime() const;

        boost::posix_time::ptime startDateTime() const;

        void setTotalTime(double time);

        void report(std::ostream& os) const;

        SimulatorTimer& operator++();

        void advance() { this->operator++(); }

        bool done() const;

    private:
        std::vector<double> timesteps_;
        int current_step_;
        double current_time_;
        double total_time_;
        boost::gregorian::date start_date_;
    };


} // namespace Opm

#endif // OPM_SIMULATORTIMER_HEADER_INCLUDED