Inheritance diagram for timeControl:

Collaboration diagram for timeControl:

Public Member Functions
	TypeName ("timeControl")
	Runtime type information. More...

	timeControl (const word &name, const Time &, const dictionary &)
	Construct from components. More...

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

const Time &	time () const
	Return time database. More...

const dictionary &	dict () const
	Return the input dictionary. More...

const Foam::timeControl &	executeControl () const
	Return the execute control object. More...

const Foam::timeControl &	writeControl () const
	Return the write control object. More...

const functionObject &	filter () const
	Return the functionObject filter. More...

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed. 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...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual scalar	timeToNextWrite ()
	Return the time to the next write. 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...

void	operator= (const timeControl &)=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)
	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	setTimeStep ()
	Called by Time::setDeltaT(). Allows the functionObject to override. 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...

Detailed Description

Note: Since the timeIndex is used directly from Foam::Time, it is unaffected by user-time conversions. For example, Foam::engineTime might cause writeInterval to be degrees crank angle, but the functionObject execution interval would still be in timestep.

Source files

Definition at line 57 of file timeControlFunctionObject.H.