A class for managing sub-cycling times. More...
#include <OpenFOAM/subCycleTime.H>
A class for managing sub-cycling times.
Definition at line 49 of file subCycleTime.H.
Inheritance diagram for subCycleTime:
Collaboration diagram for subCycleTime:Public Member Functions | |
| subCycleTime (Time &, const label nSubCycles) | |
| Construct from original time and number of sub-cycles.
| |
| ~subCycleTime () | |
| bool | end () const |
| Return true if the number of sub-cycles has been reached.
| |
| void | endSubCycle () |
| End the sub-cycling and reset the time-state.
| |
| subCycleTime & | operator++ () |
| Prefix increment.
| |
| subCycleTime & | operator++ (int) |
| Postfix increment.
| |
| 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 | ( | ) |
Definition at line 42 of file subCycleTime.C.
| 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.
Referenced by subCycle< GeometricField >::~subCycle().
| Foam::subCycleTime & operator++ | ( | ) |
Prefix increment.
Definition at line 64 of file subCycleTime.C.
| Foam::subCycleTime & operator++ | ( | int | ) |
Postfix increment.
Definition at line 72 of file subCycleTime.C.