functionObjects: Updated docs
This commit is contained in:
parent
ebafc87137
commit
f6c670dcac
@ -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
|
||||
|
@ -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.
|
||||
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
@ -25,7 +25,7 @@ Class
|
||||
Foam::functionObjects::div
|
||||
|
||||
Group
|
||||
grpFVFunctionObjects
|
||||
grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
This function object calculates the divergence of a field. The operation is
|
||||
|
@ -25,7 +25,7 @@ Class
|
||||
Foam::functionObjects::grad
|
||||
|
||||
Group
|
||||
grpFVFunctionObjects
|
||||
grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
This function object calculates the gradient of a field. The operation is
|
||||
|
@ -25,7 +25,7 @@ Class
|
||||
Foam::functionObjects::mag
|
||||
|
||||
Group
|
||||
grpFVFunctionObjects
|
||||
grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
This function object calculates the magnitude of a field. The operation
|
||||
|
@ -25,7 +25,7 @@ Class
|
||||
Foam::functionObjects::pressureTools
|
||||
|
||||
Group
|
||||
grpUtilitiesFunctionObjects
|
||||
grpForcesFunctionObjects
|
||||
|
||||
Description
|
||||
This function object includes tools to manipulate the pressure into
|
||||
|
@ -25,7 +25,7 @@ Class
|
||||
Foam::functionObjects::wallShearStress
|
||||
|
||||
Group
|
||||
grpUtilitiesFunctionObjects
|
||||
grpForcesFunctionObjects
|
||||
|
||||
Description
|
||||
This function object evaluates and outputs the shear stress at wall
|
||||
|
@ -25,7 +25,7 @@ Class
|
||||
Foam::functionObjects::cloudInfo
|
||||
|
||||
Group
|
||||
grpCloudFunctionObjects
|
||||
grpLagrangianFunctionObjects
|
||||
|
||||
Description
|
||||
This function object outputs Lagrangian cloud information to a file. The
|
||||
|
@ -25,7 +25,7 @@ Class
|
||||
Foam::functionObjects::abort
|
||||
|
||||
Group
|
||||
grpJobControlFunctionObjects
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
Watches for presence of the named file in the $FOAM_CASE directory
|
||||
|
@ -25,7 +25,7 @@ Class
|
||||
Foam::functionObjects::partialWrite
|
||||
|
||||
Group
|
||||
grpIOFunctionObjects
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
This function object allows user-selected fields/registered objects to be
|
||||
|
@ -25,7 +25,7 @@ Class
|
||||
Foam::functionObjects::removeRegisteredObject
|
||||
|
||||
Group
|
||||
grpIOFunctionObjects
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
This function object removes registered objects if present in the database
|
||||
|
@ -25,7 +25,7 @@ Class
|
||||
Foam::functionObjects::writeRegisteredObject
|
||||
|
||||
Group
|
||||
grpIOFunctionObjects
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
This function object allows specification of different writing frequency
|
||||
|
Loading…
Reference in New Issue
Block a user