Wrapper around functionObjects to add time control. More...

Inheritance diagram for timeControl:

Collaboration diagram for timeControl:

Public Types
enum	controlMode { TIME, TRIGGER, TIME_OR_TRIGGER, TIME_AND_TRIGGER }

Public Member Functions
	TypeName ("timeControl")

	timeControl (const word &name, const Time &runTime, const dictionary &dict)

const dictionary &	dict () const

const Foam::timeControl &	executeControl () const

const Foam::timeControl &	writeControl () const

const functionObject &	filter () const

virtual bool	execute ()

virtual bool	execute (const label subIndex)

virtual bool	write ()

virtual bool	end ()

virtual bool	adjustTimeStep ()

virtual bool	filesModified () const

virtual bool	read (const dictionary &)

virtual void	updateMesh (const mapPolyMesh &mpm)

virtual void	movePoints (const polyMesh &mesh)

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)

virtual	~timeFunctionObject ()=default

const Time &	time () const

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)

autoPtr< functionObject >	clone () const

virtual	~functionObject ()=default

virtual const word &	type () const =0

const word &	name () const noexcept

bool	useNamePrefix () const noexcept

bool	useNamePrefix (bool on) noexcept

Static Public Member Functions
static bool	entriesPresent (const dictionary &dict)

Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)

Static Public Attributes
static const Enum< controlMode >	controlModeNames_

Static Public Attributes inherited from functionObject
static int	debug

static bool	postProcess

static bool	defaultUseNamePrefix

static word	outputPrefix

Additional Inherited Members
Public Attributes inherited from functionObject
bool	log

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)

	timeFunctionObject (const timeFunctionObject &)=delete

void	operator= (const timeFunctionObject &)=delete

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const

Protected Attributes inherited from timeFunctionObject
const Time &	time_

Detailed Description

Wrapper around functionObjects to add time control.

Adds

timeStart, timeEnd activation
deltaT modification to hit writeInterval (note: if adjustableRunTime also in controlDict this has to be an integer multiple)
smooth deltaT variation through optional deltaTCoeff parameter

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.

The function object can be limited to operate within a time range using the timeStart and timEnd options. All objects are read (and the OutputFilter allocated) on construction. However, if a timeEnd is supplied, the object will call the 'end' function of the filter at the timeEnd time and destroy the filter. Any other callback (execute(), write(), timeSet() etc) will only operate if within the timeStart, timeEnd time range. Note that the time range uses 0.5 * deltaT as a comparison tolerance to account for precision errors.

Source files

Definition at line 72 of file timeControlFunctionObject.H.