codedFunctionObject: Updated documentation

This commit is contained in:
Henry Weller
2016-05-24 14:01:33 +01:00
parent cc84047797
commit bc6485b8f4

View File

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