List of function objects with start(), execute() and end() functions that is called for each object. More...

Inheritance diagram for functionObjectList:

Collaboration diagram for functionObjectList:

Public Member Functions
	functionObjectList (const Time &runTime, const bool execution=true)
	Construct from Time and the execution setting. More...

	functionObjectList (const Time &runTime, const dictionary &parentDict, const bool execution=true)
	Construct from Time, a dictionary with "functions" entry. More...

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

virtual	~functionObjectList ()
	Destructor. More...

void	clear ()
	Clear the list of function objects. More...

label	findObjectID (const word &name) const
	Find the ID of a given function object by name. More...

bool	read ()
	Read and set the function objects if their data have changed. More...

bool	start ()
	Called at the start of the time-loop. More...

bool	execute ()
	Called at each ++ or += of the time-loop. More...

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

scalar	timeToNextAction ()
	Return the time to the next write. 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 functionObjectList &)=delete
	Disallow default bitwise assignment. More...

Static Public Member Functions
static autoPtr< functionObjectList >	New (const argList &args, const Time &runTime, dictionary &controlDict)
	Construct and return a functionObjectList for an application. More...

Detailed Description

List of function objects with start(), execute() and end() functions that is called for each object.

See also: Foam::functionObject Foam::functionObjects::timeControl

Source files

Definition at line 62 of file functionObjectList.H.

Constructor & Destructor Documentation

◆ functionObjectList() [1/3]

functionObjectList	(	const Time &	runTime,
		const bool	execution = `true`
	)

Construct from Time and the execution setting.

The functionObject specifications are read from the controlDict

Definition at line 63 of file functionObjectList.C.

◆ functionObjectList() [2/3]

functionObjectList	(	const Time &	runTime,
		const dictionary &	parentDict,
		const bool	execution = `true`
	)

Construct from Time, a dictionary with "functions" entry.

and the execution setting.

Parameters

[in]	t	- the other Time instance to construct from
[in]	parentDict	- the parent dictionary containing a "functions" entry, which can either be a list or a dictionary of functionObject specifications.
[in]	execution	- whether the function objects should execute or not. Default: true.

Definition at line 79 of file functionObjectList.C.

◆ functionObjectList() [3/3]

functionObjectList ( const functionObjectList & )

delete

Disallow default bitwise copy construction.

◆ ~functionObjectList()

~functionObjectList ( )

virtual

Destructor.

Definition at line 189 of file functionObjectList.C.

Member Function Documentation

◆ New()

Foam::autoPtr< Foam::functionObjectList > New	(	const argList &	args,
		const Time &	runTime,
		dictionary &	controlDict
	)

static

Construct and return a functionObjectList for an application.

If the "dict" argument is specified the functionObjectList is constructed from that dictionary which is returned as controlDict otherwise the functionObjectList is constructed from the "functions" sub-dictionary of "system/controlDict"

Definition at line 96 of file functionObjectList.C.

References args, argList::commandLine(), controlDict(), forAll, includeFuncEntry::functionObjectDictPath, IOobject::MUST_READ_IF_MODIFIED, dictionary::null, word::null, argList::optionFound(), argList::optionLookup(), Foam::readConfigFile(), and autoPtr< T >::reset().