zhyang-dev/OpenFOAM-12
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

functionObjectList: Expanded documentation of the readFunctionObject function

Browse Source
This commit is contained in:
Henry Weller
2019-08-11 00:51:41 +01:00
parent 81f9320119
commit 2469e5576f
2 changed files with 18 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.C
View File

@ -233,13 +233,6 @@ bool Foam::functionObjectList::readFunctionObject
const word& region
)
{
// Parse the optional functionObject arguments:
// 'Q(U)' -> funcName = Q; args = (U); field = U
//
// Supports named arguments:
// 'patchAverage(patch=inlet, p)' -> funcName = patchAverage;
// args = (patch=inlet, p); field = p
word funcName(funcCall);
int argLevel = 0;

23
src/OpenFOAM/db/functionObjects/functionObjectList/functionObjectList.H
View File

@ -245,15 +245,28 @@ public:
const word& region = word::null
);
//- Read the specified functionObject configuration dictionary parsing
// the optional arguments included in the name 'funcNameArgs0',
//- Read the specified functionObject configuration dictionary
// parsing the optional arguments included in the string 'funcCall',
// inserting 'field' or 'fields' entries as required and merging the
// resulting functionObject dictionary into 'functionsDict'. Any
// fields required to execute the functionObject are added to
// resulting functionObject dictionary into 'functionsDict'.
// Any fields required to execute the functionObject are added to
// 'requiredFields'
//
// Parses the optional functionObject arguments:
// 'Q(U)' -> funcName = Q; args = (U)
// -> field U;
//
// Supports named arguments:
// 'patchAverage(patch=inlet, p,U)'
// or
// 'patchAverage(patch=inlet, field=(p U))'
// -> funcName = patchAverage;
// args = (patch=inlet, p,U)
// -> patch inlet;
// fields (p U);
static bool readFunctionObject
(
const string& funcNameArgs0,
const string& funcCall,
dictionary& functionsDict,
const string& context,
HashSet<word>& requiredFields,