Opm::TimeStepControlInterface Class Reference

TimeStepControlInterface. More...

#include <TimeStepControlInterface.hpp>

Inheritance diagram for Opm::TimeStepControlInterface:

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

computeTimeStepSize()

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::PIDAndIterationCountTimeStepControl, Opm::HardcodedTimeStepControl, and Opm::PIDTimeStepControl.

---

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

• opm/simulators/timestepping/TimeStepControlInterface.hpp