setTimeStepFunctionObject Class Reference

Updates the time step as a Function1 of time. More...

Inheritance diagram for setTimeStepFunctionObject:
Collaboration diagram for setTimeStepFunctionObject:

Public Member Functions

 TypeName ("setTimeStep")
 Runtime type information. More...
 
 setTimeStepFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from components. More...
 
 setTimeStepFunctionObject (const setTimeStepFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~setTimeStepFunctionObject ()
 
virtual bool read (const dictionary &)
 Read and reset the timeStep Function1. More...
 
virtual wordList fields () const
 Return the list of fields required. More...
 
virtual bool execute ()
 Reset the timeStep from the Function1 of time. More...
 
virtual bool write ()
 Do nothing. More...
 
void operator= (const setTimeStepFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from functionObject
 ClassName ("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, const Time &runTime)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
 functionObject (const functionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool executeAtStart () const
 Return true if the functionObject should be executed at the start. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual scalar timeToNextAction ()
 Called by Time::adjustTimeStep(). Allows the functionObject to. More...
 
virtual scalar maxDeltaT () const
 Return the maximum time-step for stable operation. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update topology using the given map. More...
 
virtual void topoChange (const polyTopoChangeMap &map)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
void operator= (const functionObject &)=delete
 Disallow default bitwise assignment. 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...
 
Switch executeAtStart_
 Switch write log to Info. More...
 
- Static Public Attributes inherited from functionObject
static bool postProcess
 Global post-processing mode switch. More...
 
- Protected Attributes inherited from functionObject
const Timetime_
 Reference to time. More...
 

Detailed Description

Updates the time step as a Function1 of time.

If the case is running with userTime specified in controlDict then the time-step values returned by the Function1 are assumed to be in user-time rather than real-time.

Makes no attempt to cooperate with other timeStep controllers (i.e., solver courant number control or other functionObjects). In general any value set here will be overwritten by solver time-step adjustment if enabled, so for this to work 'adjustTime' should be switched off. This is compatible with 'adjustableWriteTime', in which case the time-step values set will not be exactly as specified, but write intervals will be matched exactly.

This function supports the 'enabled' flag but none of the other run controls; 'startTime', 'endTime', 'writeControl', etc...

Source files

Definition at line 66 of file setTimeStepFunctionObject.H.

Constructor & Destructor Documentation

◆ setTimeStepFunctionObject() [1/2]

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

Construct from components.

Definition at line 49 of file setTimeStepFunctionObject.C.

References dict, and setTimeStepFunctionObject::read().

Here is the call graph for this function:

◆ setTimeStepFunctionObject() [2/2]

Disallow default bitwise copy construction.

◆ ~setTimeStepFunctionObject()

Definition at line 64 of file setTimeStepFunctionObject.C.

Member Function Documentation

◆ TypeName()

TypeName ( "setTimeStep"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read and reset the timeStep Function1.

Reimplemented from functionObject.

Definition at line 70 of file setTimeStepFunctionObject.C.

References dict, and Function1< Type >::New().

Referenced by setTimeStepFunctionObject::setTimeStepFunctionObject().

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

◆ fields()

virtual wordList fields ( ) const
inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 106 of file setTimeStepFunctionObject.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Reset the timeStep from the Function1 of time.

Implements functionObject.

Definition at line 88 of file setTimeStepFunctionObject.C.

References adjustTimeStep, and Foam::setDeltaT().

Here is the call graph for this function:

◆ write()

bool write ( )
virtual

Do nothing.

Implements functionObject.

Definition at line 102 of file setTimeStepFunctionObject.C.

◆ operator=()

void operator= ( const setTimeStepFunctionObject )
delete

Disallow default bitwise assignment.


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