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/simulators/timestepping/SimulatorTimerInterface.hpp>
 
#include <boost/date_time/gregorian/gregorian_types.hpp>
 
#include <cstddef>
#include <iosfwd>
#include <memory>
#include <vector>
 
namespace Opm
{
 
    class ParameterGroup;
    class Schedule;
 
    class SimulatorTimer : public SimulatorTimerInterface
    {
    public:
        // use default implementation of these methods
        using SimulatorTimerInterface::currentDateTime;
        using SimulatorTimerInterface::currentPosixTime;
 
        SimulatorTimer();
 
        static SimulatorTimer serializationTestObject();
 
        void init(const ParameterGroup& param);
 
        void init(const Schedule& schedule, std::size_t report_step = 0);
 
        bool initialStep() const override;
 
        int numSteps() const;
 
        int currentStepNum() const override;
 
        void setCurrentStepNum(int step);
 
        double currentStepLength() const override;
 
        double stepLengthTaken () const override;
 
        double simulationTimeElapsed() const override;
 
        double totalTime() const;
 
        boost::posix_time::ptime startDateTime() const override;
 
        void setTotalTime(double time);
 
        void report(std::ostream& os) const;
 
        SimulatorTimer& operator++();
 
        void advance() override { this->operator++(); }
 
        bool done() const override;
 
        bool lastStepFailed() const override { return false; }
 
        std::unique_ptr<SimulatorTimerInterface> clone() const override;
 
        template<class Serializer>
        void serializeOp(Serializer& serializer)
        {
            serializer(timesteps_);
            serializer(current_step_);
            serializer(current_time_);
            serializer(total_time_);
            serializer(start_date_);
        }
 
        bool operator==(const SimulatorTimer& rhs) 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