My Project
|
Interface class for SimulatorTimer objects, to be improved. More...
#include <SimulatorTimerInterface.hpp>
Public Member Functions | |
virtual | ~SimulatorTimerInterface () |
destructor | |
virtual int | currentStepNum () const =0 |
Current step number. | |
virtual int | reportStepNum () const |
Current report step number. This might differ from currentStepNum in case of sub stepping. | |
virtual double | currentStepLength () const =0 |
Current step length. | |
virtual double | stepLengthTaken () const =0 |
Previous step length. | |
virtual double | reportStepLengthTaken () const |
Previous report step length. | |
virtual double | simulationTimeElapsed () const =0 |
Time elapsed since the start of the simulation until the beginning of the current time step [s]. | |
virtual void | advance ()=0 |
advance time by currentStepLength | |
virtual bool | done () const =0 |
Return true if timer indicates that simulation of timer interval is finished. | |
virtual bool | initialStep () const =0 |
Whether the current step is the first step. | |
virtual boost::posix_time::ptime | startDateTime () const =0 |
Return start date of simulation. | |
virtual boost::posix_time::ptime | currentDateTime () const |
Return the current time as a posix time object. | |
virtual time_t | currentPosixTime () const |
Time elapsed since the start of the POSIX epoch (Jan 1st, 1970) until the current time step begins [s]. | |
virtual bool | lastStepFailed () const =0 |
Return true if last time step failed. | |
virtual std::unique_ptr< SimulatorTimerInterface > | clone () const =0 |
return copy of current timer instance | |
Protected Member Functions | |
SimulatorTimerInterface () | |
Default constructor, protected to not allow explicit instances of this class. | |
Interface class for SimulatorTimer objects, to be improved.
advance time by currentStepLength
Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer.
|
pure virtual |
return copy of current timer instance
Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer.
|
virtual |
Return the current time as a posix time object.
Reimplemented in Opm::SimulatorTimer.
|
virtual |
Time elapsed since the start of the POSIX epoch (Jan 1st, 1970) until the current time step begins [s].
Reimplemented in Opm::SimulatorTimer.
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.
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.
Return true if timer indicates that simulation of timer interval is finished.
Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer.
Whether the current step is the first step.
Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer.
Return true if last time step failed.
Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer.
Previous report step length.
This is the length of the step that was taken to arrive at this report step time.
Current report step number. This might differ from currentStepNum in case of sub stepping.
Reimplemented in Opm::AdaptiveSimulatorTimer.
Time elapsed since the start of the simulation until the beginning of the current time step [s].
Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer.
|
pure virtual |
Return start date of simulation.
Implemented in Opm::AdaptiveSimulatorTimer, and Opm::SimulatorTimer.
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.