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

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2012-2014 OpenFOAM Foundation \\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -36,12 +36,9 @@ utility.
\linebreak \linebreak
The current range of features comprises of: The current range of features comprises of:
- \ref grpCloudFunctionObjects - \ref grpLagrangianFunctionObjects
- \ref grpFieldFunctionObjects - \ref grpFieldFunctionObjects
- \ref grpForcesFunctionObjects - \ref grpForcesFunctionObjects
- \ref grpFVFunctionObjects
- \ref grpIOFunctionObjects
- \ref grpJobControlFunctionObjects
- \ref grpUtilitiesFunctionObjects - \ref grpUtilitiesFunctionObjects
\linebreak \linebreak

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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