zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues 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 566f2734b9
commit 4281d14eb1
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
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

6
src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H
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
@}
\*---------------------------------------------------------------------------*/