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 word &	type () 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< functionObject >	clone () const
	Return clone. More...

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

const word &	name () 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 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< functionObject >	New (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 Time &	time_
	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.