My Project
Opm::SimpleIterationCountTimeStepControl Class Reference

A simple iteration count based adaptive time step control. More...

#include <TimeStepControl.hpp>

Inheritance diagram for Opm::SimpleIterationCountTimeStepControl:
Opm::TimeStepControlInterface

Public Member Functions

 SimpleIterationCountTimeStepControl (const int target_iterations, const double decayrate, const double growthrate, const bool verbose=false)
 constructor More...
 
double computeTimeStepSize (const double dt, const int iterations, const RelativeChangeInterface &, const double) const
 compute new time step size suggestions based on the PID controller More...
 
- Public Member Functions inherited from Opm::TimeStepControlInterface
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)
 

Protected Attributes

const int target_iterations_
 
const double decayrate_
 
const double growthrate_
 
const bool verbose_
 

Detailed Description

A simple iteration count based adaptive time step control.

Constructor & Destructor Documentation

◆ SimpleIterationCountTimeStepControl()

Opm::SimpleIterationCountTimeStepControl::SimpleIterationCountTimeStepControl ( const int  target_iterations,
const double  decayrate,
const double  growthrate,
const bool  verbose = false 
)

constructor

Parameters
target_iterationsnumber of desired iterations (e.g. Newton iterations) per time step in one time step
verboseif true get some output (default = false)

Member Function Documentation

◆ computeTimeStepSize()

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

Implements Opm::TimeStepControlInterface.


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