Public Member Functions | List of all members
setTimeStepFunctionObject Class Reference

Overrides the timeStep. Can only be used with solvers with adjustTimeStep control (e.g. pimpleFoam). Makes no attempt to cooperate with other timeStep 'controllers' (maxCo, other functionObjects). Supports 'enabled' flag but none of the other ones 'timeStart', 'timeEnd', 'writeControl' etc. More...

Inheritance diagram for setTimeStepFunctionObject:
Inheritance graph
[legend]
Collaboration diagram for setTimeStepFunctionObject:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("setTimeStep")
 Runtime type information. More...
 
 setTimeStepFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from components. More...
 
virtual ~setTimeStepFunctionObject ()
 
const Timetime () const
 Return time database. More...
 
virtual bool adjustTimeStep ()
 Called at the end of Time::adjustDeltaT() if adjustTime is true. More...
 
virtual bool read (const dictionary &)
 Read and set the function object if its data have changed. More...
 
virtual bool execute ()
 Called at each ++ or += of the time-loop. More...
 
virtual bool write ()
 Called at each ++ or += of the time-loop. More...
 
- Public Member Functions inherited from functionObject
virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 
 functionObject (const word &name)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual void updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update for changes of mesh. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &, const dictionary &)
 Select from dictionary, based on its "type" entry. More...
 
- Public Attributes inherited from functionObject
Switch log
 Switch write log to Info. More...
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 Global post-processing mode switch. More...
 

Detailed Description

Overrides the timeStep. Can only be used with solvers with adjustTimeStep control (e.g. pimpleFoam). Makes no attempt to cooperate with other timeStep 'controllers' (maxCo, other functionObjects). Supports 'enabled' flag but none of the other ones 'timeStart', 'timeEnd', 'writeControl' etc.

Source files

Definition at line 58 of file setTimeStepFunctionObject.H.

Constructor & Destructor Documentation

◆ setTimeStepFunctionObject()

setTimeStepFunctionObject ( const word name,
const Time runTime,
const dictionary dict 
)

Construct from components.

Definition at line 50 of file setTimeStepFunctionObject.C.

References Foam::read().

Here is the call graph for this function:

◆ ~setTimeStepFunctionObject()

Definition at line 65 of file setTimeStepFunctionObject.C.

Member Function Documentation

◆ TypeName()

TypeName ( "setTimeStep"  )

Runtime type information.

◆ time()

const Foam::Time & time ( ) const

Return time database.

Definition at line 72 of file setTimeStepFunctionObject.C.

◆ adjustTimeStep()

bool adjustTimeStep ( )
virtual

Called at the end of Time::adjustDeltaT() if adjustTime is true.

Reimplemented from functionObject.

Definition at line 78 of file setTimeStepFunctionObject.C.

References setTimeStepFunctionObject::read().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary dict)
virtual

Read and set the function object if its data have changed.

Reimplemented from functionObject.

Definition at line 91 of file setTimeStepFunctionObject.C.

References controlDict(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Function1< Type >::New(), and dictionary::readIfPresent().

Referenced by setTimeStepFunctionObject::adjustTimeStep().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ execute()

bool execute ( )
virtual

Called at each ++ or += of the time-loop.

postProcess overrides the usual executeControl behaviour and forces execution (used in post-processing mode)

Implements functionObject.

Definition at line 116 of file setTimeStepFunctionObject.C.

◆ write()

bool write ( )
virtual

Called at each ++ or += of the time-loop.

postProcess overrides the usual writeControl behaviour and forces writing always (used in post-processing mode)

Implements functionObject.

Definition at line 122 of file setTimeStepFunctionObject.C.


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