research/OpenFOAM-4.x-lab
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

codedFunctionObject: Updated documentation

Browse source
This commit is contained in:
Henry Weller 2016-05-24 14:01:33 +01:00
parent 9ef803920c
commit 6b1a55dc9b
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
View file

@ -32,16 +32,15 @@ Description
compilation.
The entries are
code : c++; upon functionObject::write()
codeInclude : include files
codeOptions : include paths; inserted into EXE_INC in Make/options
codeLibs : link line; inserted into LIB_LIBS in Make/options
codeExecute : c++;upon functionObject::execute();
codeRead : c++; upon functionObject::read();
codeEnd : c++; upon functionObject::end();
codeData : c++; local member data (null constructed);
localCode : c++; local static functions
codeRead : c++; upon functionObject::read();
codeExecute : c++;upon functionObject::execute();
codeWrite : c++; upon functionObject::write()
codeEnd : c++; upon functionObject::end();
Example of function object specification:
\verbatim
@ -52,7 +51,7 @@ Description
type coded;
// Name of on-the-fly generated functionObject
name writeMagU;
code
codeWrite
#{
// Lookup U
const volVectorField& U = mesh().lookupObject<volVectorField>("U");