Opm::TimeStepControlInterface Class Reference

TimeStepControlInterface. More...

#include <TimeStepControlInterface.hpp>

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

List of all members.

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

Detailed Description

TimeStepControlInterface.


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:
dt time step size used in the current step
iterations number of iterations used (linear/nonlinear)
timeError object to compute || u^n+1 - u^n || / || u^n+1 ||
Returns:
suggested time step size for the next step

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


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

Generated on 26 Mar 2018 by  doxygen 1.6.1