TimeStepControlInterface.hpp
1 /*
2  Copyright 2014 IRIS AS
3 
4  This file is part of the Open Porous Media project (OPM).
5 
6  OPM is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  OPM is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with OPM. If not, see <http://www.gnu.org/licenses/>.
18 */
19 #ifndef OPM_TIMESTEPCONTROLINTERFACE_HEADER_INCLUDED
20 #define OPM_TIMESTEPCONTROLINTERFACE_HEADER_INCLUDED
21 
22 
23 namespace Opm
24 {
25 
32  {
33  protected:
35  public:
37  virtual double relativeChange() const = 0;
38 
41  };
42 
49  {
50  protected:
52  public:
59  virtual double computeTimeStepSize( const double dt, const int iterations, const RelativeChangeInterface& relativeChange , const double simulationTimeElapsed) const = 0;
60 
63  };
64 
65 }
66 #endif
virtual ~RelativeChangeInterface()
virtual destructor (empty)
Definition: TimeStepControlInterface.hpp:40
virtual double relativeChange() const =0
virtual ~TimeStepControlInterface()
virtual destructor (empty)
Definition: TimeStepControlInterface.hpp:62
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition: AdditionalObjectDeleter.hpp:22
virtual double computeTimeStepSize(const double dt, const int iterations, const RelativeChangeInterface &relativeChange, const double simulationTimeElapsed) const =0
compute new time step size suggestions based on the PID controller
RelativeChangeInterface.
Definition: TimeStepControlInterface.hpp:31
TimeStepControlInterface.
Definition: TimeStepControlInterface.hpp:48