diff --git a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H
index 1d8d005f6c..a5165aaf51 100644
--- a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H
+++ b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H
@@ -28,10 +28,33 @@ Group
grpIOFunctionObjects
Description
- Allows some fields/registered objects to be written more often than others.
+ This function object allows user-selected fields/registered objects to be
+ written at a custom write interval. It operates by deleting all entries
+ except those selected after writing.
- Works in the opposite way: deletes at intermediate times all
- but selected fields.
+ Example of function object specification:
+ \verbatim
+ partialWrite1
+ {
+ type partialWrite;
+ functionObjectLibs ("libIOFunctionObjects.so");
+ ...
+ objectNames (p U T);
+ writeInterval 100;
+ }
+ \endverbatim
+
+ \heading Function object usage
+ \table
+ Property | Description | Required | Default value
+ type | type name: partialWrite | yes |
+ objectNames | objects to write | yes |
+ writeInterval | write interval | yes |
+ \endtable
+
+SeeAlso
+ Foam::functionObject
+ Foam::OutputFilterFunctionObject
SourceFiles
partialWrite.C
@@ -58,7 +81,7 @@ class dictionary;
class mapPolyMesh;
/*---------------------------------------------------------------------------*\
- Class partialWrite Declaration
+ Class partialWrite Declaration
\*---------------------------------------------------------------------------*/
class partialWrite
diff --git a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H
index edd4e16bca..b25925c3c1 100644
--- a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H
+++ b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H
@@ -28,7 +28,29 @@ Group
grpIOFunctionObjects
Description
- Removes registered IO objects if present in the database
+ This function object removes registered objects if present in the database
+
+ Example of function object specification:
+ \verbatim
+ removeRegisteredObject1
+ {
+ type removeRegisteredObject;
+ functionObjectLibs ("libIOFunctionObjects.so");
+ ...
+ objectNames (obj1 obj2);
+ }
+ \endverbatim
+
+ \heading Function object usage
+ \table
+ Property | Description | Required | Default value
+ type | type name: removeRegisteredObject | yes |
+ objectNames | objects to remove | yes |
+ \endtable
+
+SeeAlso
+ Foam::functionObject
+ Foam::OutputFilterFunctionObject
SourceFiles
removeRegisteredObject.C
diff --git a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H
index 01d2c29037..7dbdb4bd25 100644
--- a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H
+++ b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H
@@ -28,7 +28,30 @@ Group
grpIOFunctionObjects
Description
- Takes over the writing of registered IO objects
+ This function object takes-over the writing of objects registered to the
+ database.
+
+ Example of function object specification:
+ \verbatim
+ writeRegisteredObject1
+ {
+ type writeRegisteredObject;
+ functionObjectLibs ("libIOFunctionObjects.so");
+ ...
+ objectNames (obj1 obj2);
+ }
+ \endverbatim
+
+ \heading Function object usage
+ \table
+ Property | Description | Required | Default value
+ type | type name: writeRegisteredObject | yes |
+ objectNames | objects to write | yes |
+ \endtable
+
+SeeAlso
+ Foam::functionObject
+ Foam::OutputFilterFunctionObject
SourceFiles
writeRegisteredObject.C
diff --git a/src/postProcessing/functionObjects/doc/functionObjects.dox b/src/postProcessing/functionObjects/doc/functionObjects.dox
index b3ea86de52..098b7ae12d 100644
--- a/src/postProcessing/functionObjects/doc/functionObjects.dox
+++ b/src/postProcessing/functionObjects/doc/functionObjects.dox
@@ -34,7 +34,7 @@ extract predicted field and derived quantities at run-time. Alternatively,
the actions can be executed afterwards using the \c execFlowFunctionObjects
utility.
-
+\linebreak
The current range of features comprises of:
- \ref grpCloudFunctionObjects
- \ref grpFieldFunctionObjects
@@ -43,12 +43,13 @@ The current range of features comprises of:
- \ref grpJobControlFunctionObjects
- \ref grpUtilitiesFunctionObjects
-
+\linebreak
\subsection secFieldFunctionObjectUsage Using function objects
Function objects are defined by additional entries in the
$FOAM_CASE/system/controlDict input dictionary. Each object is listed in a
-\c functions sub-dictionary entry, e.g. for `output' type objects:
+\c functions sub-dictionary entry, e.g. the following shows the input options
+applicable to `output' -type objects:
\verbatim
functions
diff --git a/src/postProcessing/functionObjects/forces/forces/forces.H b/src/postProcessing/functionObjects/forces/forces/forces.H
index 4875da5c4f..3b04128494 100644
--- a/src/postProcessing/functionObjects/forces/forces/forces.H
+++ b/src/postProcessing/functionObjects/forces/forces/forces.H
@@ -43,7 +43,6 @@ Description
...
log yes;
patches (walls);
-
}
\endverbatim
diff --git a/src/postProcessing/functionObjects/systemCall/systemCall.H b/src/postProcessing/functionObjects/systemCall/systemCall.H
index bb26a7e1b9..ad82219bce 100644
--- a/src/postProcessing/functionObjects/systemCall/systemCall.H
+++ b/src/postProcessing/functionObjects/systemCall/systemCall.H
@@ -28,7 +28,55 @@ Group
grpFunctionObjects
Description
- Executes system calls, entered in the form of a string list
+ This function object executes system calls, entered in the form of a
+ string lists. Calls can be made at the following points in the
+ calculation:
+ - every time step
+ - every output time
+ - end of the calculation
+
+ Example of function object specification:
+ \verbatim
+ systemCall1
+ {
+ type systemCall;
+ functionObjectLibs ("libsystemCall.so");
+ ...
+ executeCalls
+ (
+ "echo execute"
+ );
+ writeCalls
+ (
+ "echo \*\*\* writing data \*\*\*"
+ );
+ endCalls
+ (
+ "echo \*\*\* writing .bashrc \*\*\*"
+ "cat ~/.bashrc"
+ "echo \*\*\* done \*\*\*"
+ );
+ }
+ \endverbatim
+
+ \heading Function object usage
+ \table
+ Property | Description | Required | Default value
+ type | type name: systemCall | yes |
+ executeCalls | list of calls on execute | yes |
+ writeCalls | list of calls on write | yes |
+ endCalls | list of calls on end | yes |
+ \endtable
+
+Note
+ Since this function object executes system calls, there is a potential
+ security risk. In order to use the \c systemCall function object, the
+ \c allowSystemOperations must be set to '1'; otherwise, system calls will
+ not be allowed.
+
+SeeAlso
+ Foam::functionObject
+ Foam::OutputFilterFunctionObject
SourceFiles
systemCall.C
@@ -53,7 +101,7 @@ class dictionary;
class mapPolyMesh;
/*---------------------------------------------------------------------------*\
- Class systemCall Declaration
+ Class systemCall Declaration
\*---------------------------------------------------------------------------*/
class systemCall
diff --git a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
index 4a99468d09..a9c6818f77 100644
--- a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
+++ b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H
@@ -28,7 +28,13 @@ Group
grpUtilitiesFunctionObjects
Description
- functionObject using dynamic code compilation.
+ This function object provides a general interface to enable dynamic code
+ compilation.
+
+SeeAlso
+ Foam::functionObject
+ Foam::OutputFilterFunctionObject
+ Foam::codedBase
SourceFiles
codedFunctionObject.C
@@ -47,7 +53,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
- Class codedFunctionObject Declaration
+ Class codedFunctionObject Declaration
\*---------------------------------------------------------------------------*/
class codedFunctionObject