Opm::SimulatorTimerInterface Class Referenceabstract Interface class for SimulatorTimer objects, to be improved. More...
Inheritance diagram for Opm::SimulatorTimerInterface:
Detailed DescriptionInterface class for SimulatorTimer objects, to be improved. Constructor & Destructor Documentation◆ SimulatorTimerInterface()
Default constructor, protected to not allow explicit instances of this class. ◆ ~SimulatorTimerInterface()
destructor Member Function Documentation◆ advance()
advance time by currentStepLength Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer. ◆ clone()
return copy of current timer instance Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer. ◆ currentDateTime()
Return the current time as a posix time object. Reimplemented in Opm::SimulatorTimer. ◆ currentPosixTime()
Time elapsed since the start of the POSIX epoch (Jan 1st, 1970) until the current time step begins [s]. Reimplemented in Opm::SimulatorTimer. ◆ currentStepLength()
Current step length. This is the length of the step the simulator will take in the next iteration.
Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer. Referenced by Opm::BlackoilModel< TypeTag >::getConvergence(), Opm::BlackoilModel< TypeTag >::prepareStep(), and Opm::NonlinearSolver< TypeTag, PhysicalModel >::step(). ◆ currentStepNum()
Current step number. This is the number of timesteps that has been completed from the start of the run. The time after initialization but before the simulation has started is timestep number zero. Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer. Referenced by Opm::BlackoilModel< TypeTag >::nonlinearIteration(), and reportStepNum(). ◆ done()
Return true if timer indicates that simulation of timer interval is finished. Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer. ◆ initialStep()
Whether the current step is the first step. Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer. ◆ lastStepFailed()
Return true if last time step failed. Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer. Referenced by Opm::BlackoilModel< TypeTag >::prepareStep(). ◆ reportStepLengthTaken()
Previous report step length. This is the length of the step that was taken to arrive at this report step time.
References stepLengthTaken(). ◆ reportStepNum()
Current report step number. This might differ from currentStepNum in case of sub stepping. Reimplemented in Opm::AdaptiveSimulatorTimer. References currentStepNum(). Referenced by Opm::BlackoilModel< TypeTag >::nonlinearIteration(), Opm::BlackoilModel< TypeTag >::prepareStep(), and Opm::EclWriter< TypeTag >::writeReports(). ◆ simulationTimeElapsed()
Time elapsed since the start of the simulation until the beginning of the current time step [s]. Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer. Referenced by Opm::BlackoilModel< TypeTag >::getConvergence(), Opm::BlackoilModel< TypeTag >::prepareStep(), and Opm::NonlinearSolver< TypeTag, PhysicalModel >::step(). ◆ startDateTime()
Return start date of simulation. Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer. ◆ stepLengthTaken()
Previous step length. This is the length of the step that was taken to arrive at this time.
Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer. Referenced by reportStepLengthTaken(). The documentation for this class was generated from the following file: |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||