SimulatorTimerInterface.hpp

/*
  Copyright (c) 2014 IRIS AS

  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_SIMULATORTIMERINTERFACE_HEADER_INCLUDED
#define OPM_SIMULATORTIMERINTERFACE_HEADER_INCLUDED

#include <memory>

namespace boost { namespace posix_time { class ptime; } }

namespace Opm
{

    class ParameterGroup;

    class SimulatorTimerInterface
    {
    protected:
        SimulatorTimerInterface() {}

    public:
        virtual ~SimulatorTimerInterface() {}

        // -----------------------------------------------------------
        // Pure virtual functions to be implemented by derived classes
        // -----------------------------------------------------------

        virtual void advance() = 0 ;

        virtual std::unique_ptr< SimulatorTimerInterface > clone () const = 0;

        virtual double currentStepLength() const = 0;

        virtual int currentStepNum() const = 0;

        virtual bool done() const = 0;

        virtual bool initialStep() const = 0;

        virtual bool lastStepFailed() const = 0;

        virtual double simulationTimeElapsed() const = 0;

        virtual double stepLengthTaken () const = 0;

        virtual boost::posix_time::ptime startDateTime() const = 0;

        // -----------------------------------------------------------------
        // Virtual functions (not pure) to allow for default implementations
        // -----------------------------------------------------------------

        virtual boost::posix_time::ptime currentDateTime() const;

        virtual time_t currentPosixTime() const;

        virtual double reportStepLengthTaken () const { return stepLengthTaken(); }

        virtual int reportStepNum() const { return currentStepNum(); }

    };


} // namespace Opm

#endif // OPM_SIMULATORTIMER_HEADER_INCLUDED