functionObjects: Updated documentation

This commit is contained in:
Henry Weller
2016-05-04 21:01:22 +01:00
parent dca3d758cd
commit fff57bf797
7 changed files with 9 additions and 16 deletions

View File

@ -32,13 +32,6 @@ Description
field and derived quantities. Alternatively, the same actions can be
executed after the simulation using the \c execFlowFunctionObjects utility.
\linebreak
The current range of features are sub-divided into the following categories:
- \ref grpLagrangianFunctionObjects
- \ref grpFieldFunctionObjects
- \ref grpForcesFunctionObjects
- \ref grpUtilitiesFunctionObjects
\linebreak
\subsection secFunctionObjects Using function objects

View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -23,9 +23,9 @@ License
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
\defgroup grpFunctionObjects Function objects
\defgroup grpFunctionObjects FunctionObjects
@{
This group contains function objects
FunctionObjects are in the Foam::functionObjects namespace
@}
\*---------------------------------------------------------------------------*/

View File

@ -53,7 +53,7 @@ License
\section usingOpenFOAM Using OpenFOAM
- \subpage pagePostProcessing
- Post-processing using Foam::functionObjects
- \ref grpFunctionObjects namespace Foam::functionObjects
- \subpage pageBoundaryConditions
\*---------------------------------------------------------------------------*/

View File

@ -25,7 +25,7 @@ Class
Foam::functionObjects::systemCall
Group
grpFunctionObjects
grpUtilitiesFunctionObjects
Description
This function object executes system calls, entered in the form of a

View File

@ -25,7 +25,7 @@ Class
Foam::probes
Group
grpFunctionObjects
grpUtilitiesFunctionObjects
Description
Set of locations to sample.

View File

@ -25,7 +25,7 @@ Class
Foam::sampledSet
Group
grpFunctionObjects
grpUtilitiesFunctionObjects
Description
Holds list of sampling points which is filled at construction time.

View File

@ -25,7 +25,7 @@ Class
Foam::sampledSurface
Group
grpFunctionObjects
grpUtilitiesFunctionObjects
Description
An abstract class for surfaces with sampling.