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 othe other ones 'timeStart', 'timeEnd', 'outputControl' 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 const Timetime () const
 Return time database. More...
 
virtual bool enabled () const
 Return the enabled flag. More...
 
virtual void on ()
 Switch the function object on. More...
 
virtual void off ()
 Switch the function object off. More...
 
virtual bool start ()
 Called at the start of the time-loop. More...
 
virtual bool execute (const bool forceWrite)
 Called at each ++ or += of the time-loop. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual bool timeSet ()
 Called when time was set at the end of the Time::operator++. 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 void updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update for changes of mesh. 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 &t, const dictionary &dict),(name, t, dict))
 
 functionObject (const word &name)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()
 Destructor. More...
 
virtual const wordname () const
 Name. 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...
 
- Static Public Attributes inherited from functionObject
static int debug
 

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 othe other ones 'timeStart', 'timeEnd', 'outputControl' etc.

Source files

Definition at line 57 of file setTimeStepFunctionObject.H.

Constructor & Destructor Documentation

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

Construct from components.

Definition at line 47 of file setTimeStepFunctionObject.C.

References Foam::read().

Here is the call graph for this function:

Member Function Documentation

TypeName ( "setTimeStep"  )

Runtime type information.

virtual const Time& time ( ) const
inlinevirtual

Return time database.

Definition at line 103 of file setTimeStepFunctionObject.H.

virtual bool enabled ( ) const
inlinevirtual
void on ( )
virtual

Switch the function object on.

Definition at line 63 of file setTimeStepFunctionObject.C.

Referenced by setTimeStepFunctionObject::enabled().

Here is the caller graph for this function:

void off ( )
virtual

Switch the function object off.

Definition at line 69 of file setTimeStepFunctionObject.C.

Referenced by setTimeStepFunctionObject::enabled().

Here is the caller graph for this function:

bool start ( )
virtual

Called at the start of the time-loop.

Implements functionObject.

Definition at line 75 of file setTimeStepFunctionObject.C.

Referenced by setTimeStepFunctionObject::enabled().

Here is the caller graph for this function:

bool execute ( const bool  forceWrite)
virtual

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

Implements functionObject.

Definition at line 81 of file setTimeStepFunctionObject.C.

Referenced by setTimeStepFunctionObject::enabled().

Here is the caller graph for this function:

bool end ( )
virtual

Called when Time::run() determines that the time-loop exits.

Reimplemented from functionObject.

Definition at line 87 of file setTimeStepFunctionObject.C.

Referenced by setTimeStepFunctionObject::enabled().

Here is the caller graph for this function:

bool timeSet ( )
virtual

Called when time was set at the end of the Time::operator++.

Reimplemented from functionObject.

Definition at line 93 of file setTimeStepFunctionObject.C.

Referenced by setTimeStepFunctionObject::enabled().

Here is the caller graph for this function:

bool adjustTimeStep ( )
virtual

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

Reimplemented from functionObject.

Definition at line 99 of file setTimeStepFunctionObject.C.

Referenced by setTimeStepFunctionObject::enabled().

Here is the caller graph for this function:

bool read ( const dictionary dict)
virtual

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

Implements functionObject.

Definition at line 117 of file setTimeStepFunctionObject.C.

References controlDict(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, dictionary::lookupOrDefault(), DataEntry< Type >::New(), and dictionary::readIfPresent().

Referenced by setTimeStepFunctionObject::enabled().

Here is the call graph for this function:

Here is the caller graph for this function:

void updateMesh ( const mapPolyMesh mpm)
virtual

Update for changes of mesh.

Implements functionObject.

Definition at line 144 of file setTimeStepFunctionObject.C.

Referenced by setTimeStepFunctionObject::enabled().

Here is the caller graph for this function:

void movePoints ( const polyMesh mesh)
virtual

Update for changes of mesh.

Implements functionObject.

Definition at line 148 of file setTimeStepFunctionObject.C.

Referenced by setTimeStepFunctionObject::enabled().

Here is the caller graph for this function:


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