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

codedFunctionObject: Updated documentation

Browse Source 
Patch contributed by Bruno Santos
Resolves bug-report https://bugs.openfoam.org/view.php?id=2441
This commit is contained in:
Henry Weller
2017-01-28 18:01:11 +00:00
parent 4d9a8870c6
commit 6cf939eca3
2 changed files with 24 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.C
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -284,6 +284,16 @@ bool Foam::codedFunctionObject::read(const dictionary& dict)
); );
} }
if(!dataPtr && !readPtr && !execPtr && !writePtr && !endPtr)
{
IOWarningInFunction
(
dict
) << "No critical \"code\" prefixed keywords were found."
<< " Please check the code documentation for more details."
<< nl << endl;
}
updateLibrary(name_); updateLibrary(name_);
return redirectFunctionObject().read(dict); return redirectFunctionObject().read(dict);
} }

24
src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -30,16 +30,18 @@ Group
Description Description
Provides a general interface to enable dynamic code compilation. Provides a general interface to enable dynamic code compilation.
The entries are The entries are:
codeInclude : include files \plaintable
codeOptions : include paths; inserted into EXE_INC in Make/options codeInclude | include files
codeLibs : link line; inserted into LIB_LIBS in Make/options codeOptions | include paths; inserted into EXE_INC in Make/options
codeData : c++; local member data (null constructed); codeLibs | link line; inserted into LIB_LIBS in Make/options
localCode : c++; local static functions codeData | c++; local member data (null constructed);
codeRead : c++; upon functionObject::read(); localCode | c++; local static functions;
codeExecute : c++;upon functionObject::execute(); codeRead | c++; upon functionObject::read();
codeWrite : c++; upon functionObject::write() codeExecute | c++; upon functionObject::execute();
codeEnd : c++; upon functionObject::end(); codeWrite | c++; upon functionObject::write()
codeEnd | c++; upon functionObject::end();
\endplaintable
Example of function object specification: Example of function object specification:
\verbatim \verbatim