functionObjects: Updated docs

This commit is contained in:
Henry Weller 2016-05-04 08:51:39 +01:00
parent ebafc87137
commit f6c670dcac
12 changed files with 16 additions and 19 deletions

View File

@ -191,7 +191,7 @@ void print(Ostream& os, const wordList& flds)
labelList getSelectedPatches
(
const polyBoundaryMesh& patches,
const List<wordRe>& excludePatches //HashSet<word>& excludePatches
const List<wordRe>& excludePatches
)
{
DynamicList<label> patchIDs(patches.size());
@ -205,7 +205,7 @@ labelList getSelectedPatches
if
(
isType<emptyPolyPatch>(pp)
|| (Pstream::parRun() && isType<processorPolyPatch>(pp))
|| (Pstream::parRun() && isType<processorPolyPatch>(pp))
)
{
Info<< " discarding empty/processor patch " << patchi

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2014 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -36,12 +36,9 @@ utility.
\linebreak
The current range of features comprises of:
- \ref grpCloudFunctionObjects
- \ref grpLagrangianFunctionObjects
- \ref grpFieldFunctionObjects
- \ref grpForcesFunctionObjects
- \ref grpFVFunctionObjects
- \ref grpIOFunctionObjects
- \ref grpJobControlFunctionObjects
- \ref grpUtilitiesFunctionObjects
\linebreak
@ -78,7 +75,7 @@ Where:
region | name of region for multi-region cases | no |
enabled | on/off switch | no | yes
timeStart| start time | no |
timeEnd | end 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
@ -88,7 +85,7 @@ typically used as the name of the output directory 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.
using the \c libs entry.
\*---------------------------------------------------------------------------*/

View File

@ -25,7 +25,7 @@ Class
Foam::functionObjects::div
Group
grpFVFunctionObjects
grpFieldFunctionObjects
Description
This function object calculates the divergence of a field. The operation is

View File

@ -25,7 +25,7 @@ Class
Foam::functionObjects::grad
Group
grpFVFunctionObjects
grpFieldFunctionObjects
Description
This function object calculates the gradient of a field. The operation is

View File

@ -25,7 +25,7 @@ Class
Foam::functionObjects::mag
Group
grpFVFunctionObjects
grpFieldFunctionObjects
Description
This function object calculates the magnitude of a field. The operation

View File

@ -25,7 +25,7 @@ Class
Foam::functionObjects::pressureTools
Group
grpUtilitiesFunctionObjects
grpForcesFunctionObjects
Description
This function object includes tools to manipulate the pressure into

View File

@ -25,7 +25,7 @@ Class
Foam::functionObjects::wallShearStress
Group
grpUtilitiesFunctionObjects
grpForcesFunctionObjects
Description
This function object evaluates and outputs the shear stress at wall

View File

@ -25,7 +25,7 @@ Class
Foam::functionObjects::cloudInfo
Group
grpCloudFunctionObjects
grpLagrangianFunctionObjects
Description
This function object outputs Lagrangian cloud information to a file. The

View File

@ -25,7 +25,7 @@ Class
Foam::functionObjects::abort
Group
grpJobControlFunctionObjects
grpUtilitiesFunctionObjects
Description
Watches for presence of the named file in the $FOAM_CASE directory

View File

@ -25,7 +25,7 @@ Class
Foam::functionObjects::partialWrite
Group
grpIOFunctionObjects
grpUtilitiesFunctionObjects
Description
This function object allows user-selected fields/registered objects to be

View File

@ -25,7 +25,7 @@ Class
Foam::functionObjects::removeRegisteredObject
Group
grpIOFunctionObjects
grpUtilitiesFunctionObjects
Description
This function object removes registered objects if present in the database

View File

@ -25,7 +25,7 @@ Class
Foam::functionObjects::writeRegisteredObject
Group
grpIOFunctionObjects
grpUtilitiesFunctionObjects
Description
This function object allows specification of different writing frequency