includeFuncEntry Class Reference

Specify a functionObject dictionary file to include, expects the functionObject name to follow with option arguments (without quotes). More...

Inheritance diagram for includeFuncEntry:

Collaboration diagram for includeFuncEntry:

Public Member Functions
	ClassName ("includeFunc")
	Runtime type information. More...
Public Member Functions inherited from functionEntry
	declareMemberFunctionSelectionTable (bool, functionEntry, execute, dictionaryIstream,(dictionary &parentDict, Istream &is),(parentDict, is))
	declareMemberFunctionSelectionTable (bool, functionEntry, execute, primitiveEntryIstream,(const dictionary &parentDict, primitiveEntry &entry, Istream &is),(parentDict, entry, is))

Static Public Member Functions
static bool	execute (dictionary &parentDict, Istream &)
	Execute the functionEntry in a sub-dict context. More...
Static Public Member Functions inherited from functionEntry
static bool	execute (const word &functionName, dictionary &parentDict, Istream &)
	Execute the functionEntry in a sub-dict context. More...
static bool	execute (const word &functionName, const dictionary &parentDict, primitiveEntry &, Istream &)
	Execute the functionEntry in a primitiveEntry context. More...

Detailed Description

Specify a functionObject dictionary file to include, expects the functionObject name to follow with option arguments (without quotes).

Searches for functionObject dictionary file in user/group/shipped directories allowing for version-specific and version-independent files using the following hierarchy:

• user settings:
  • ~/.OpenFOAM/<VERSION>/caseDicts/postProcessing
  • ~/.OpenFOAM/caseDicts/postProcessing
• group (site) settings (when $WM_PROJECT_SITE is set):
  • $WM_PROJECT_SITE/<VERSION>/caseDicts/postProcessing
  • $WM_PROJECT_SITE/caseDicts/postProcessing
• group (site) settings (when $WM_PROJECT_SITE is not set):
  • $WM_PROJECT_INST_DIR/site/<VERSION>/caseDicts/postProcessing
  • $WM_PROJECT_INST_DIR/site/caseDicts/postProcessing
• other (shipped) settings:
  • $WM_PROJECT_DIR/etc/caseDicts/postProcessing

The optional field arguments included in the name are inserted in 'field' or 'fields' entries in the functionObject dictionary and included in the name of the functionObject entry to avoid conflict.

Examples:

    #includeFunc Q
    #includeFunc components(U)
    #includeFunc mag(Ux)
    #includeFunc mag(p)

See also

Foam::functionObjectList

Source files

• includeFuncEntry.H
• includeFuncEntry.C

Definition at line 81 of file includeFuncEntry.H.

Member Function Documentation

ClassName

(

"includeFunc"

)

Runtime type information.

bool execute ( dictionary &  parentDict, Istream &  is  )

static

Execute the functionEntry in a sub-dict context.

Definition at line 52 of file includeFuncEntry.C.

References functionObjectList::readFunctionObject().

Here is the call graph for this function:

---

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

• src/OpenFOAM/db/dictionary/functionEntries/includeFuncEntry/includeFuncEntry.H
• src/OpenFOAM/db/dictionary/functionEntries/includeFuncEntry/includeFuncEntry.C