My Project
List of all members | Public Member Functions | Protected Attributes
Opm::PIDAndIterationCountTimeStepControl Class Reference

PID controller based adaptive time step control as above that also takes an target iteration into account. More...

#include <TimeStepControl.hpp>

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

Public Member Functions

 PIDAndIterationCountTimeStepControl (const int target_iterations=20, const double decayDampingFactor=1.0, const double growthDampingFactor=1.0/1.2, const double tol=1e-3, const double minTimeStepBasedOnIterations=0., const bool verbose=false)
 constructor More...
 
double computeTimeStepSize (const double dt, const int iterations, const RelativeChangeInterface &relativeChange, const double) const
 compute new time step size suggestions based on the PID controller More...
 
- Public Member Functions inherited from Opm::PIDTimeStepControl
 PIDTimeStepControl (const double tol=1e-3, const bool verbose=false)
 constructor More...
 
- Public Member Functions inherited from Opm::TimeStepControlInterface
virtual ~TimeStepControlInterface ()
 virtual destructor (empty)
 

Protected Attributes

const int target_iterations_
 
const double decayDampingFactor_
 
const double growthDampingFactor_
 
const double minTimeStepBasedOnIterations_
 
- Protected Attributes inherited from Opm::PIDTimeStepControl
const double tol_
 
std::vector< double > errors_
 
const bool verbose_
 

Detailed Description

PID controller based adaptive time step control as above that also takes an target iteration into account.

Constructor & Destructor Documentation

◆ PIDAndIterationCountTimeStepControl()

Opm::PIDAndIterationCountTimeStepControl::PIDAndIterationCountTimeStepControl ( const int  target_iterations = 20,
const double  decayDampingFactor = 1.0,
const double  growthDampingFactor = 1.0/1.2,
const double  tol = 1e-3,
const double  minTimeStepBasedOnIterations = 0.,
const bool  verbose = false 
)

constructor

Parameters
target_iterationsnumber of desired iterations per time step
toltolerance for the relative changes of the numerical solution to be accepted in one time step (default is 1e-3)
verboseif true get some output (default = false)

Member Function Documentation

◆ computeTimeStepSize()

double Opm::PIDAndIterationCountTimeStepControl::computeTimeStepSize ( const double  dt,
const int  iterations,
const RelativeChangeInterface &  relativeChange,
const double  simulationTimeElapsed 
) const
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

Reimplemented from Opm::PIDTimeStepControl.

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