A class for managing sub-cycling times. More...
Public Member Functions | |
subCycleTime (Time &, const label nSubCycles) | |
Construct from original time and number of sub-cycles. More... | |
~subCycleTime () | |
Destructor. More... | |
bool | end () const |
Return true if the number of sub-cycles has been reached. More... | |
void | endSubCycle () |
End the sub-cycling and reset the time-state. More... | |
label | nSubCycles () const |
Return the total number of sub-cycles. More... | |
label | index () const |
Return the current sub-cycle index. More... | |
subCycleTime & | operator++ () |
Prefix increment. More... | |
subCycleTime & | operator++ (int) |
Postfix increment. More... | |
subCycleTime | ( | Time & | t, |
const label | nSubCycles | ||
) |
Construct from original time and number of sub-cycles.
Definition at line 30 of file subCycleTime.C.
References Time::subCycle().
~subCycleTime | ( | ) |
Destructor.
Definition at line 42 of file subCycleTime.C.
References subCycleTime::endSubCycle().
bool end | ( | ) | const |
Return true if the number of sub-cycles has been reached.
Definition at line 50 of file subCycleTime.C.
void endSubCycle | ( | ) |
End the sub-cycling and reset the time-state.
Definition at line 56 of file subCycleTime.C.
References Time::endSubCycle().
Referenced by CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::motion(), and subCycleTime::~subCycleTime().
|
inline |
Return the total number of sub-cycles.
Definition at line 78 of file subCycleTime.H.
|
inline |
Return the current sub-cycle index.
Definition at line 84 of file subCycleTime.H.
References subCycleTime::operator++().
Foam::subCycleTime & operator++ | ( | ) |
Prefix increment.
Definition at line 64 of file subCycleTime.C.
Referenced by subCycleTime::index(), and subCycleTime::operator++().
Foam::subCycleTime & operator++ | ( | int | ) |
Postfix increment.
Definition at line 72 of file subCycleTime.C.
References subCycleTime::operator++().