Public Types | Public Member Functions | List of all members
timeControl Class Reference

General time dependent execution controller. The default to execute every time-step. More...

Public Types

enum  timeControls {
  timeStep, writeTime, outputTime, adjustableRunTime,
  runTime, 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...
 
timeControls control () const
 Return control. More...
 
scalar interval () const
 Return interval. More...
 
label executionIndex () const
 Return the index of the previous execution. More...
 
void operator= (const timeControl &)=delete
 Disallow default bitwise assignment. More...
 

Detailed Description

General time dependent execution controller. The default to execute every time-step.

Source files

Definition at line 49 of file timeControl.H.

Member Enumeration Documentation

◆ timeControls

enum timeControls
strong

The time control options.

Enumerator
timeStep 

execution is coupled to the time-step

writeTime 

execution is coupled to the write-time

outputTime 

execution is coupled to the output-time

adjustableRunTime 

Adjust time step for execution.

runTime 

run time for execution

clockTime 

clock time for execution

cpuTime 

cpu time for execution

none 

no execution

Definition at line 54 of file timeControl.H.

Constructor & Destructor Documentation

◆ timeControl() [1/2]

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 Foam::read().

Here is the call graph for this function:

◆ timeControl() [2/2]

timeControl ( const timeControl &  )
delete

Disallow default bitwise copy construction.

◆ ~timeControl()

~timeControl ( )

Destructor.

Definition at line 74 of file timeControl.C.

Member Function Documentation

◆ read()

void read ( const dictionary &  dict)

Read from dictionary.

Definition at line 80 of file timeControl.C.

References Foam::endl(), dictionary::found(), IOWarningInFunction, dictionary::lookup(), dictionary::lookupOrDefault(), Foam::nl, and runTime.

Here is the call graph for this function:

◆ time()

const Foam::Time & time ( ) const
inline

Return Time.

Definition at line 28 of file timeControlI.H.

◆ execute()

bool execute ( )

Flag to indicate whether to execute.

Definition at line 140 of file timeControl.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::nl, Foam::returnReduce(), and runTime.

Here is the call graph for this function:

◆ control()

Foam::timeControl::timeControls control ( ) const
inline

Return control.

Definition at line 34 of file timeControlI.H.

◆ interval()

Foam::scalar interval ( ) const
inline

Return interval.

Definition at line 40 of file timeControlI.H.

◆ executionIndex()

Foam::label executionIndex ( ) const
inline

Return the index of the previous execution.

Definition at line 46 of file timeControlI.H.

◆ operator=()

void operator= ( const timeControl &  )
delete

Disallow default bitwise assignment.

The documentation for this class was generated from the following files: