Go to the documentation of this file.
37 #ifndef subCycleTime_H
38 #define subCycleTime_H
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
bool end() const
Return true if the number of sub-cycles has been reached.
A class for managing sub-cycling times.
subCycleTime(Time &runTime, const label nCycle)
Construct referencing the original time and number of sub-cycles.
~subCycleTime()
Destructor.
label nSubCycles() const
Return the total number of sub-cycles.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
void endSubCycle()
End the sub-cycling and reset the time-state.
label index() const
Return the current sub-cycle index.
bool loop()
True if looping is active, increments the index.
bool status() const
True if the sub-cycle is active.
subCycleTime & operator++()
Prefix increment.