TimeStepControlInterface.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_TIMESTEPCONTROLINTERFACE_HEADER_INCLUDED
#define OPM_TIMESTEPCONTROLINTERFACE_HEADER_INCLUDED

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


namespace Opm
{

    class RelativeChangeInterface
    {
    protected:
        RelativeChangeInterface() {}
    public:
        virtual double relativeChange() const = 0;

        virtual ~RelativeChangeInterface() {}
    };

    class TimeStepControlInterface
    {
    protected:
        TimeStepControlInterface() {}
    public:
        virtual double computeTimeStepSize(const double dt,
                                           const int iterations,
                                           const RelativeChangeInterface& relativeChange,
                                           const AdaptiveSimulatorTimer& substepTimer) const = 0;

        virtual bool timeStepAccepted(const double error, const double timeStepJustCompleted) const = 0;

        virtual ~TimeStepControlInterface () {}
    };

}
#endif