From bc6485b8f425e55053cebc708b4c723f95cb6c28 Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Tue, 24 May 2016 14:01:33 +0100
Subject: [PATCH] codedFunctionObject: Updated documentation
---
.../codedFunctionObject/codedFunctionObject.H | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)
diff --git a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
index ff8df5c49f8..64f77bbccd9 100644
--- a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
+++ b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
@@ -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");
--
GitLab