![]() |
|
Public Types | |
enum | writeControls { wcTimeStep, wcRunTime, wcAdjustableRunTime, wcClockTime, wcCpuTime } |
Write control options. More... | |
enum | stopAtControls { saEndTime, saNoWriteNow, saWriteNow, saNextWrite } |
Stop-run control options. More... | |
enum | fmtflags { general = 0, fixed = ios_base::fixed, scientific = ios_base::scientific } |
Suported time directory name formats. More... | |
Public Member Functions | |
TypeName ("time") | |
Time (const word &name, const fileName &rootPath, const fileName &caseName, const word &systemName="system", const word &constantName="constant") | |
Construct given name, rootPath and casePath. | |
virtual | ~Time () |
Virtual destructor. | |
const fileName & | rootPath () const |
Return root path. | |
const fileName & | caseName () const |
Return case name. | |
fileName | path () const |
Return path. | |
const dictionary & | controlDict () const |
virtual const fileName & | dbDir () const |
Local directory path of this objectRegistry relative to the time. | |
fileName | timePath () const |
Return current time path. | |
IOstream::streamFormat | writeFormat () const |
Default write format. | |
IOstream::versionNumber | writeVersion () const |
Default write version number. | |
IOstream::compressionType | writeCompression () const |
Default write compression. | |
const word & | graphFormat () const |
Default graph format. | |
virtual bool | read () |
Read control dictionary, update controls and time. | |
void | readModifiedObjects () |
Read the objects that have been modified. | |
word | findInstance (const fileName &dir, const word &name, const IOobject::readOption rOpt=IOobject::MUST_READ) const |
Return the location of "dir" containing the file "name". | |
instantList | times () const |
Search tha case for valid time directories. | |
word | findInstancePath (const instant &) const |
Search the case for the time directory path. | |
instant | findClosestTime (const scalar) const |
Search the case for the time closest to the given time. | |
virtual bool | write (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const |
Write using given format, version and compression. | |
bool | write () const |
Write using pre-selected format, version and compression. | |
virtual word | timeName () const |
Return current time name. | |
virtual dimensionedScalar | startTime () const |
Return start time. | |
virtual dimensionedScalar | endTime () const |
Return end time. | |
virtual bool | run () const |
Return true if run should continue. | |
virtual bool | end () const |
Return true if end of run. | |
virtual void | setTime (const Time &) |
Reset the time and time-index to those of the given time. | |
virtual void | setTime (const instant &, const label newIndex) |
Reset the time and time-index. | |
virtual void | setTime (const dimensionedScalar &, const label newIndex) |
Reset the time and time-index. | |
virtual void | setTime (const scalar, const label newIndex) |
Reset the time and time-index. | |
virtual void | setEndTime (const dimensionedScalar &) |
Reset end time. | |
virtual void | setEndTime (const scalar) |
Reset end time. | |
virtual void | setDeltaT (const dimensionedScalar &) |
Reset time step. | |
virtual void | setDeltaT (const scalar) |
Reset time step. | |
virtual TimeState | subCycle (const label nSubCycles) |
Set time to sub-cycle for the given number of steps. | |
virtual void | endSubCycle (const TimeState &) |
Reset time after sub-cycling back to given TimeState. | |
virtual Time & | operator+= (const dimensionedScalar &) |
Set deltaT to that specified and increment time. | |
virtual Time & | operator+= (const scalar) |
Set deltaT to that specified and increment time. | |
virtual Time & | operator++ () |
Prefix increment. | |
virtual Time & | operator++ (int) |
Postfix increment. | |
Static Public Member Functions | |
word | timeName (const scalar) |
Return time name of given scalar time. | |
instantList | findTimes (const fileName &) |
Search a given directory for valid time directories. | |
Static Public Attributes | |
word | controlDictName |
Return the default control dictionary name. | |
Protected Member Functions | |
void | adjustDeltaT () |
Adjust the time step so that writing occurs at the specified time. | |
virtual void | readDict () |
Read the control dictionary and set the write controls etc. | |
Protected Attributes | |
scalar | startTime_ |
Start time in seconds. | |
scalar | endTime_ |
stopAtControls | stopAt_ |
writeControls | writeControl_ |
scalar | writeInterval_ |
label | purgeWrite_ |
FIFOStack< word > | previousOutputTimes_ |
Static Protected Attributes | |
const NamedEnum< stopAtControls, 4 > | stopAtControlNames_ |
const NamedEnum< writeControls, 5 > | writeControlNames_ |
fmtflags | format_ |
Time directory name format. | |
int | precision_ |
Time directory name precision. |
|
Suported time directory name formats.
|
|
Stop-run control options.
|
|
Write control options.
|
|
Construct given name, rootPath and casePath.
|
|
Virtual destructor.
|
|
Adjust the time step so that writing occurs at the specified time.
|
|
Return case name.
Reimplemented from TimePaths. |
|
|
|
Local directory path of this objectRegistry relative to the time.
Reimplemented from objectRegistry. |
|
Return true if end of run.
Reimplemented from HashTable< regIOobject * >. |
|
Reset time after sub-cycling back to given TimeState.
|
|
Return end time.
|
|
Search the case for the time closest to the given time.
|
|
Return the location of "dir" containing the file "name". (Used in reading mesh data) |
|
Search the case for the time directory path. corresponding to the given instance |
|
Search a given directory for valid time directories.
|
|
Default graph format.
Definition at line 247 of file Time.H. References Foam::dimensionedScalar, and Foam::instantList. |
|
Postfix increment.
|
|
Prefix increment.
|
|
Set deltaT to that specified and increment time.
|
|
Set deltaT to that specified and increment time.
|
|
Return path.
Reimplemented from TimePaths. |
|
Read control dictionary, update controls and time.
Reimplemented from regIOobject. Reimplemented in engineTime. |
|
Read the control dictionary and set the write controls etc.
|
|
Read the objects that have been modified.
Reimplemented from objectRegistry. |
|
Return root path.
Reimplemented from TimePaths. |
|
Return true if run should continue.
|
|
Reset time step.
|
|
Reset time step.
|
|
Reset end time.
|
|
Reset end time.
|
|
Reset the time and time-index.
|
|
Reset the time and time-index.
|
|
Reset the time and time-index.
|
|
Reset the time and time-index to those of the given time.
|
|
Return start time.
|
|
Set time to sub-cycle for the given number of steps.
|
|
Return current time name.
|
|
Return time name of given scalar time.
|
|
Return current time path.
|
|
Search tha case for valid time directories.
|
|
|
|
Write using pre-selected format, version and compression.
Reimplemented from objectRegistry. |
|
Write using given format, version and compression.
Reimplemented from objectRegistry. |
|
Default write compression.
|
|
Default write format.
|
|
Default write version number.
|
|
Return the default control dictionary name.
|
|
|
|
Time directory name format.
|
|
Time directory name precision.
|
|
|
|
|
|
Start time in seconds.
Reimplemented from clock. |
|
|
|
|
|
|
|
|
|
|