AdaptiveSimulatorTimer.hpp

/*
  Copyright 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_ADAPTIVESIMULATORTIMER_HEADER_INCLUDED
#define OPM_ADAPTIVESIMULATORTIMER_HEADER_INCLUDED

#include <cassert>
#include <iosfwd>
#include <vector>
#include <limits>
#include <algorithm>
#include <memory>
#include <numeric>
#include <optional>

#include <opm/simulators/timestepping/SimulatorTimerInterface.hpp>

namespace Opm
{

    class AdaptiveSimulatorTimer : public SimulatorTimerInterface
    {
    public:
        AdaptiveSimulatorTimer(const boost::posix_time::ptime simulation_start_time,
                               const double step_length,
                               const double elapsed_time,
                               const double last_step_taken,
                               const int report_step,
                               const double max_time_step = std::numeric_limits<double>::max());

        AdaptiveSimulatorTimer& operator++ ();

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

        void provideTimeStepEstimate( const double dt_estimate );

        bool initialStep () const override;

        int currentStepNum () const override;

        int reportStepNum() const override;

        double currentStepLength () const override;

        // \brief Set next step length
        void setCurrentStepLength(double dt);

        double totalTime() const;

        double simulationTimeElapsed() const override;

        bool done () const override;

        double averageStepLength() const;

        double maxStepLength () const;

        double minStepLength () const;

        double stepLengthTaken () const override;

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

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

        bool lastStepFailed() const override { return last_step_failed_; }

        void setLastStepFailed(bool last_step_failed) { last_step_failed_ = last_step_failed; }

        double reportStepStartTime() const;
        double reportStepTotalTime() const;
        int reportStepSubstepNum() const;

        void setReportStepStartTime(double t) { report_step_start_time_ = t; }
        void setReportStepTotalTime(double t) { report_step_total_time_ = t; }
        void setReportStepSubstepOffset(int n) { report_step_substep_offset_ = n; }

        int reportStepSubstepOffset() const { return report_step_substep_offset_; }

        std::unique_ptr<SimulatorTimerInterface> clone() const override;

    protected:
        std::shared_ptr<boost::posix_time::ptime> start_date_time_;
        const double start_time_;
        const double total_time_;
        const int report_step_;
        const double max_time_step_;

        double current_time_;
        double dt_;
        int current_step_;

        std::vector< double > steps_;
        bool last_step_failed_;

        std::optional<double> report_step_start_time_;
        std::optional<double> report_step_total_time_;
        int report_step_substep_offset_ = 0;

    };

} // namespace Opm

#endif // OPM_SIMULATORTIMER_HEADER_INCLUDED