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
Default constructor, protected to not allow explicit instances of this class.
destructor Member Function Documentation
advance time by currentStepLength Implemented in Opm::SimulatorTimer, and Opm::AdaptiveSimulatorTimer.
Return the current time as a posix time object. References simulationTimeElapsed(), and startDateTime(). Referenced by currentPosixTime().
Time elapsed since the start of the POSIX epoch (Jan 1st, 1970) until the current time step begins [s]. References currentDateTime().
Current step length. This is the length of the step the simulator will take in the next iteration.
Implemented in Opm::SimulatorTimer, and Opm::AdaptiveSimulatorTimer.
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 reportStepNum().
Return true if timer indicates that simulation of timer interval is finished. Implemented in Opm::SimulatorTimer, and Opm::AdaptiveSimulatorTimer.
Previous report step length. This is the length of the step that was taken to arrive at this report step time.
References stepLengthTaken().
Current report step number. This might differ from currentStepNum in case of sub stepping. Reimplemented in Opm::AdaptiveSimulatorTimer. References currentStepNum().
Time elapsed since the start of the simulation until the beginning of the current time step [s]. Implemented in Opm::SimulatorTimer, and Opm::AdaptiveSimulatorTimer. Referenced by currentDateTime().
Return start date of simulation. Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer. Referenced by currentDateTime().
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: |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||