Opm::TimeStepControlInterface Class Reference

#include <TimeStepControlInterface.hpp>

Inheritance diagram for Opm::TimeStepControlInterface:

Public Member Functions
virtual void	initialize (const SimulatorState &)
virtual double	computeTimeStepSize (const double dt, const int iterations, const SimulatorState &) const =0
virtual	~TimeStepControlInterface ()
	virtual destructor (empty) More...

Protected Member Functions
	TimeStepControlInterface ()

Detailed Description

TimeStepControlInterface

Constructor & Destructor Documentation

Opm::TimeStepControlInterface::TimeStepControlInterface ( )

inlineprotected

virtual Opm::TimeStepControlInterface::~TimeStepControlInterface ( )

inlinevirtual

virtual destructor (empty)

Member Function Documentation

virtual double Opm::TimeStepControlInterface::computeTimeStepSize ( const double  dt, const int  iterations, const SimulatorState &    ) 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)
state	new solution state

Returns

suggested time step size for the next step

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

virtual void Opm::TimeStepControlInterface::initialize ( const SimulatorState &  )

inlinevirtual

Parameters

state

simulation state before computing update in the solver (default is empty)

Reimplemented in Opm::PIDTimeStepControl.

---

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

• TimeStepControlInterface.hpp