From 70ac064f21f73581673488b8a58f3c65a00d6e24 Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Sat, 28 Jan 2017 18:01:11 +0000
Subject: [PATCH] codedFunctionObject: Updated documentation
Patch contributed by Bruno Santos
Resolves bug-report https://bugs.openfoam.org/view.php?id=2441
---
.../codedFunctionObject/codedFunctionObject.C | 12 +++++++++-
.../codedFunctionObject/codedFunctionObject.H | 24 ++++++++++---------
2 files changed, 24 insertions(+), 12 deletions(-)
diff --git a/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.C b/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.C
index c676703e9da..16a11b154a8 100644
--- a/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.C
+++ b/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.C
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
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_);
return redirectFunctionObject().read(dict);
}
diff --git a/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H b/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
index e57e2418024..bc949c92a34 100644
--- a/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
+++ b/src/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -30,16 +30,18 @@ Group
Description
Provides a general interface to enable dynamic code compilation.
- The entries are
- codeInclude : include files
- codeOptions : include paths; inserted into EXE_INC in Make/options
- codeLibs : link line; inserted into LIB_LIBS in Make/options
- 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();
+ The entries are:
+ \plaintable
+ codeInclude | include files
+ codeOptions | include paths; inserted into EXE_INC in Make/options
+ codeLibs | link line; inserted into LIB_LIBS in Make/options
+ 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();
+ \endplaintable
Example of function object specification:
\verbatim
--
GitLab