Provides a general interface to enable dynamic code compilation. More...

Inheritance diagram for codedFunctionObject:

Collaboration diagram for codedFunctionObject:

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

	codedFunctionObject (const word &name, const Time &time, const dictionary &dict)
	Construct from Time and dictionary. More...

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

virtual	~codedFunctionObject ()
	Destructor. More...

virtual wordList	fields () const
	Return the list of fields required. 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 bool	read (const dictionary &)
	Read and set the function object if its data have changed. More...

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

	functionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from dictionary. 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 scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. 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...

Public Member Functions inherited from codedBase
	TypeName ("codedBase")
	Runtime type information. More...

	codedBase (const word &name, const dictionary &dict, const wordList &codeKeys, const wordList &codeDictVars, const word &codeOptionsFileName, const wordList &compileFiles, const wordList &copyFiles, const bool reloadable=true)
	Construct from name and dictionary. More...

virtual	~codedBase ()
	Destructor. More...

bool	updateLibrary (const dictionary &dict) const
	Update library from given updated dictionary as required. More...

void	operator= (const codedBase &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from dynamicCode
	ClassName ("dynamicCode")

	dynamicCode (const dictionary &contextDict, const dictionary &codeDict, const word &codeName, const word &codeDirName, const wordList &codeKeys, const wordList &codeDictVars, const word &optionsFileName, const wordList &compileFiles, const wordList &copyFiles)
	Construct from the context and code dictionaries. More...

	dynamicCode (const dictionary &contextDict, const word &codeName, const word &codeDirName, const wordList &codeKeys, const wordList &codeDictVars, const word &optionsFileName, const wordList &compileFiles, const wordList &copyFiles)
	Construct from the context dictionary also containing the code. More...

const word &	codeName () const
	Return the code-name. More...

const word &	codeSha1Name () const
	Return the unique code name. More...

fileName	libPath () const
	Library path for specified code name. More...

fileName	libRelPath () const
	Library path for specified code name relative to $FOAM_CASE. More...

HashTable< string > &	varSubstitutions ()

bool	upToDate () const
	Verify if the copied code is up-to-date, based on Make/SHA1Digest. More...

bool	copyOrCreateFiles (const bool verbose=false) const
	Copy/create files prior to compilation. More...

bool	wmakeLibso () const
	Compile a libso. More...

void *	loadLibrary (const fileName &libPath) const

void	createLibrary (const dictionary &dict, const bool masterOnlyRead=false) const

void	read (const dictionary &contextDict, const dictionary &codeDict)

void	read (const dictionary &contextDict)

void	write (Ostream &os) const
	Write the code for restart. 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...

Static Public Member Functions inherited from codedBase
static word	codedName (const word &name)
	Create a coded name from the given name. More...

Static Public Member Functions inherited from dynamicCode
static word	libraryBaseName (const fileName &libPath)
	Return the library basename without leading 'lib' or trailing '.so'. More...

static fileName	resolveTemplate (const fileName &templateName)
	Resolve code-template via Foam::findConfigFile. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch execute at start time. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Static Public Attributes inherited from dynamicCode
static int	allowSystemOperations
	Flag if system operations are allowed. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

Detailed Description

Provides a general interface to enable dynamic code compilation.

The entries are:

codeInclude	:	include files
codeOptions	:	include paths; inserted into EXE_INC in Make/options
codeLibs	:	link line; inserted into LIB_LIBS in Make/options
codeData	:	c++; local member data (null constructed);
localCode	:	c++; local static functions;
codeRead	:	c++; upon functionObject::read();
codeFields	:	c++; upon functionObject::fields();
codeExecute	:	c++; upon functionObject::execute();
codeWrite	:	c++; upon functionObject::write()
codeEnd	:	c++; upon functionObject::end();

Example of function object specification:

    writeMagU
    {
        libs        ("libutilityFunctionObjects.so");

        type coded;

        codeWrite
        #{
            // Lookup U
            const volVectorField& U = mesh().lookupObject<volVectorField>("U");
            // Write
            mag(U)().write();
        #};
    }

See also: Foam::functionObject Foam::codedBase

Source files

Definition at line 125 of file codedFunctionObject.H.

Constructor & Destructor Documentation

◆ codedFunctionObject() [1/2]

codedFunctionObject	(	const word &	name,
		const Time &	time,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 110 of file codedFunctionObject.C.

References dict, Foam::name(), and dynamicCode::varSubstitutions().

Here is the call graph for this function:

◆ codedFunctionObject() [2/2]

codedFunctionObject ( const codedFunctionObject & )

delete

Disallow default bitwise copy construction.

◆ ~codedFunctionObject()

~codedFunctionObject ( )

virtual

Destructor.

Definition at line 138 of file codedFunctionObject.C.

Member Function Documentation

◆ TypeName()

TypeName ( "coded" )

Runtime type information.

◆ fields()

Foam::wordList fields ( ) const

virtual

Return the list of fields required.

Implements functionObject.

Definition at line 156 of file codedFunctionObject.C.

◆ execute()

bool execute ( )

virtual

Called at each ++ or += of the time-loop.

foamPostProcess overrides the usual executeControl behaviour and forces execution (used in post-processing mode)

Implements functionObject.

Definition at line 162 of file codedFunctionObject.C.

◆ write()

bool write ( )

virtual

Called at each ++ or += of the time-loop.

foamPostProcess overrides the usual writeControl behaviour and forces writing always (used in post-processing mode)

Implements functionObject.

Definition at line 168 of file codedFunctionObject.C.

◆ end()

bool end ( )

virtual

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

By default it simply calls execute().

Reimplemented from functionObject.

Definition at line 174 of file codedFunctionObject.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Read and set the function object if its data have changed.

Reimplemented from functionObject.

Definition at line 180 of file codedFunctionObject.C.

References dict, functionObject::read(), and dynamicCode::read().

Here is the call graph for this function:

◆ operator=()

void operator= ( const codedFunctionObject & )

delete

Disallow default bitwise assignment.

The documentation for this class was generated from the following files:

src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ codedFunctionObject() [1/2]

◆ codedFunctionObject() [2/2]

◆ ~codedFunctionObject()

Member Function Documentation

◆ TypeName()

◆ fields()

◆ execute()

◆ write()

◆ end()

◆ read()

◆ operator=()