zhyang-dev/OpenFOAM-12
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

functionObjects: Updated documentation

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

7
src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
View File

@ -32,13 +32,6 @@ Description
field and derived quantities. Alternatively, the same actions can be field and derived quantities. Alternatively, the same actions can be
executed after the simulation using the \c execFlowFunctionObjects utility. 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 \linebreak
\subsection secFunctionObjects Using function objects \subsection secFunctionObjects Using function objects

6
src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H
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 OpenFOAM Foundation \\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License 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
@} @}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

4
src/OpenFOAM/global/foamDoc.H
View File

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

2
src/postProcessing/functionObjects/utilities/systemCall/systemCall.H
View File

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

2
src/sampling/probes/probes.H
View File

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

2
src/sampling/sampledSet/sampledSet/sampledSet.H
View File

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

2
src/sampling/sampledSurface/sampledSurface/sampledSurface.H
View File

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