zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: Updated function object documentation

Browse Source
This commit is contained in:
andy
2012-08-13 14:29:42 +01:00
parent 93e7d6e392
commit 536c4aa210
2 changed files with 53 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
src/postProcessing/functionObjects/doc/functionObjects.dox
View File

@ -27,9 +27,15 @@ License
\section secFunctionObjects Function objects
OpenFOAM includes a variety of \ref grpFunctionObjects that can be applied during
the calculation, or afterwards using the execFlowFunctionObjects utility. The
range of uses include:
OpenFOAM includes a collection of \ref grpFunctionObjects that offer users the
opportunity to closely manage their computational analyses. These objects can
be applied to manipulate the workflow process, and provide a mechanism to
extract predicted field and derived quantities at run-time. Alternatively,
the actions can be executed afterwards using the \c execFlowFunctionObjects
utility.
<br>
The current range of features comprises of:
- \ref grpCloudFunctionObjects
- \ref grpFieldFunctionObjects
- \ref grpForcesFunctionObjects
@ -40,31 +46,47 @@ range of uses include:
<br>
\subsection secFieldFunctionObjectUsage Using function objects
To employ function objects, additional entries are required in the
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.
\c functions sub-dictionary entry, e.g. for `output' type objects:
\verbatim
functions
{
myFunctionObject
myFunctionObject // user-defined name of function object entry
{
type functionObjectType;
libs ("libMyFunctionObjectlib.so");
active yes; // active by default
outputControl outputTime; // output or timeStep
outputInterval 1; // only necessary for outputControl=timeStep
region defaultRegion;
enabled yes;
timeStart 0;
timeEnd 10;
outputControl outputTime;
outputInterval 1;
...
}
}
\endverbatim
Where:
\table
Property | Description | Required | Default value
type | type of function object | yes |
libs | libraries containing object implementation | yes |
region | name of region for multi-region cases | no |
enabled | on/off switch | no | yes
timeStart| start time | no |
timeEnd | end time | no |
outputControl | when to output: either 'outputTime' or 'timeStep'| no | timeStep
outputInterval| steps between output when outputControl=timeStep | no | 1
\endtable
The sub-dictionary name \c myFunctionObject is chosen by the user, and is
often used as the name of the output folder of any generated data. The \c type
entry defines the type of function object properties that follow. Since the
function objects are packaged into separate libraries, the user must tell the
code where to find the function object implementation, identified using the
\c libs entry.
typically used as the name of the output folder for any derived data. The
\c type entry defines the type of function object properties that follow.
Since the function objects are packaged into separate libraries, the user must
tell the code where to find the function object implementation, identified
using the \c libs entry.
\*---------------------------------------------------------------------------*/