General time dependent execution controller. The default to execute every time-step. More...
Public Types | |
enum class | timeControls { timeStep , writeTime , outputTime , adjustableRunTime , runTime , runTimes , clockTime , cpuTime , none } |
The time control options. More... | |
Public Member Functions | |
timeControl (const Time &, const dictionary &, const word &prefix) | |
Construct from Time object and dictionary. More... | |
timeControl (const timeControl &)=delete | |
Disallow default bitwise copy construction. More... | |
~timeControl () | |
Destructor. More... | |
void | read (const dictionary &) |
Read from dictionary. More... | |
const Time & | time () const |
Return Time. More... | |
bool | execute () |
Flag to indicate whether to execute. More... | |
scalar | timeToNextAction () |
Return the time to the next write. More... | |
timeControls | control () const |
Return control. More... | |
void | operator= (const timeControl &)=delete |
Disallow default bitwise assignment. More... | |
General time dependent execution controller. The default to execute every time-step.
Definition at line 50 of file timeControl.H.
|
strong |
The time control options.
Definition at line 55 of file timeControl.H.
timeControl | ( | const Time & | t, |
const dictionary & | dict, | ||
const word & | prefix | ||
) |
Construct from Time object and dictionary.
Definition at line 55 of file timeControl.C.
References dict, and timeControl::read().
|
delete |
Disallow default bitwise copy construction.
~timeControl | ( | ) |
Destructor.
Definition at line 76 of file timeControl.C.
void read | ( | const dictionary & | dict | ) |
Read from dictionary.
Definition at line 82 of file timeControl.C.
References List< T >::append(), dict, Foam::e, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, UList< T >::first(), Foam::first(), forAll, dictionary::found(), IOWarningInFunction, UList< T >::last(), dictionary::lookup(), dictionary::lookupOrDefault(), Foam::nl, Foam::constant::mathematical::pi(), Foam::repeat(), List< T >::size(), and Foam::unitNone.
Referenced by timeControl::timeControl().
|
inline |
Return Time.
Definition at line 28 of file timeControlI.H.
bool execute | ( | ) |
Flag to indicate whether to execute.
Definition at line 235 of file timeControl.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and Foam::returnReduce().
Foam::scalar timeToNextAction | ( | ) |
Return the time to the next write.
Definition at line 339 of file timeControl.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::max(), and Foam::nl.
|
inline |
Return control.
Definition at line 34 of file timeControlI.H.
|
delete |
Disallow default bitwise assignment.