Opm::SimulatorTimer Class Reference
Inheritance diagram for Opm::SimulatorTimer:
Constructor & Destructor Documentation◆ SimulatorTimer()
Default constructor. Member Function Documentation◆ advance()
◆ clone()
return copy of object Implements Opm::SimulatorTimerInterface. ◆ currentDateTime()
Return the current time as a posix time object. Reimplemented from Opm::SimulatorTimerInterface. Referenced by Opm::EclWriter< TypeTag >::writeReports(). ◆ currentPosixTime()
Time elapsed since the start of the POSIX epoch (Jan 1st, 1970) until the current time step begins [s]. Reimplemented from Opm::SimulatorTimerInterface. ◆ currentStepLength()
Current step length. This is the length of the step the simulator will take in the next iteration.
Implements Opm::SimulatorTimerInterface. Referenced by Opm::SimulatorFullyImplicitBlackoil< TypeTag >::runStep(). ◆ 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. Implements Opm::SimulatorTimerInterface. Referenced by Opm::SimulatorFullyImplicitBlackoil< TypeTag >::init(), Opm::SimulatorFullyImplicitBlackoil< TypeTag >::run(), and Opm::SimulatorFullyImplicitBlackoil< TypeTag >::runStep(). ◆ done()
Return true if op++() has been called numSteps() times. Implements Opm::SimulatorTimerInterface. Referenced by Opm::SimulatorFullyImplicitBlackoil< TypeTag >::run(). ◆ init() [1/2]
Initialize from parameters. Accepts the following: num_psteps (default 1) stepsize_days (default 1) ◆ init() [2/2]
Use the SimulatorTimer as a shim around opm-commons Schedule class. ◆ initialStep()
Whether the current step is the first step. Implements Opm::SimulatorTimerInterface. Referenced by Opm::SimulatorFullyImplicitBlackoil< TypeTag >::runStep(). ◆ lastStepFailed()
Always return false. Timestep failures is handled in the substepTimer Implements Opm::SimulatorTimerInterface. ◆ numSteps()
Total number of steps. ◆ operator++()
advance time by currentStepLength Referenced by advance(). ◆ operator==()
◆ report()
Print a report with current and total time etc. Note: if done(), it is an error to call report(). Referenced by Opm::SimulatorFullyImplicitBlackoil< TypeTag >::runStep(). ◆ reportStepLengthTaken()
Previous report step length. This is the length of the step that was taken to arrive at this report step time.
References Opm::SimulatorTimerInterface::stepLengthTaken(). ◆ reportStepNum()
Current report step number. This might differ from currentStepNum in case of sub stepping. Reimplemented in Opm::AdaptiveSimulatorTimer. References Opm::SimulatorTimerInterface::currentStepNum(). Referenced by Opm::BlackoilModel< TypeTag >::nonlinearIteration(), Opm::BlackoilModel< TypeTag >::prepareStep(), and Opm::EclWriter< TypeTag >::writeReports(). ◆ serializationTestObject()
◆ serializeOp()
template<class Serializer >
◆ setCurrentStepNum()
Set current step number. ◆ setTotalTime()
Set total time. This is primarily intended for multi-epoch schedules, where a timer for a given epoch does not have access to later timesteps. ◆ simulationTimeElapsed()
Time elapsed since the start of the simulation until the beginning of the current time step [s]. Implements Opm::SimulatorTimerInterface. Referenced by Opm::EclWriter< TypeTag >::writeReports(). ◆ startDateTime()
Return start date of simulation. Implements Opm::SimulatorTimerInterface. ◆ stepLengthTaken()
Previous step length. This is the length of the step that was taken to arrive at this time.
Implements Opm::SimulatorTimerInterface. ◆ totalTime()
Total time. The documentation for this class was generated from the following file: |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||