Executes system calls, entered in the form of a string lists. More...

Inheritance diagram for systemCall:

Collaboration diagram for systemCall:

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

	systemCall (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

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

virtual	~systemCall ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read the system calls. More...

virtual wordList	fields () const
	Return the list of fields required. More...

virtual bool	execute ()
	Execute the "executeCalls" at each time-step. More...

virtual bool	end ()
	Execute the "endCalls" at the final time-loop. More...

virtual bool	write ()
	Write, execute the "writeCalls". More...

void	operator= (const systemCall &)=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 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...

Protected Attributes
stringList	executeCalls_
	List of calls to execute - every step. More...

stringList	endCalls_
	List of calls to execute when exiting the time-loop. More...

stringList	writeCalls_
	List of calls to execute - write steps. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. 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

Executes system calls, entered in the form of a string lists.

Calls can be made at the following points in the calculation:

every time step
every output time
end of the calculation

Example of function object specification:

systemCall1
{
    type            systemCall;

    libs            ("libutilityFunctionObjects.so");

    executeCalls
    (
        "echo execute"
    );

    writeCalls
    (
        "echo \*\*\* writing data \*\*\*"
    );

    endCalls
    (
        "echo \*\*\* writing .bashrc \*\*\*"
        "cat ~/.bashrc"
        "echo \*\*\* done \*\*\*"
    );
}

Usage

Property	Description	Required
`type`	type name: systemCall	yes
`executeCalls`	list of calls on execute	yes
`writeCalls`	list of calls on write	yes
`endCalls`	list of calls on end	yes

Note: Since this function object executes system calls, there is a potential security risk. In order to use the systemCall function object, the allowSystemOperations must be set to '1'; otherwise, system calls will not be allowed.