All Classes Namespaces Files Functions Variables Typedefs Enumerator Pages
Opm::TimeStepControlInterface Class Referenceabstract

TimeStepControlInterface. More...

#include <TimeStepControlInterface.hpp>

Inheritance diagram for Opm::TimeStepControlInterface:
Opm::HardcodedTimeStepControl Opm::PIDTimeStepControl Opm::SimpleIterationCountTimeStepControl Opm::PIDAndIterationCountTimeStepControl

Public Member Functions

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 More...
 
virtual ~TimeStepControlInterface ()
 virtual destructor (empty)
 

Detailed Description

Member Function Documentation

virtual double Opm::TimeStepControlInterface::computeTimeStepSize ( const double  dt,
const int  iterations,
const RelativeChangeInterface relativeChange,
const double  simulationTimeElapsed 
) const
pure virtual

compute new time step size suggestions based on the PID controller

Parameters
dttime step size used in the current step
iterationsnumber of iterations used (linear/nonlinear)
timeErrorobject to compute || u^n+1 - u^n || / || u^n+1 ||
Returns
suggested time step size for the next step

Implemented in Opm::HardcodedTimeStepControl, Opm::PIDAndIterationCountTimeStepControl, Opm::PIDTimeStepControl, and Opm::SimpleIterationCountTimeStepControl.


The documentation for this class was generated from the following file: