From 4281d14eb12945455bf6542a9b5e56deaf321e76 Mon Sep 17 00:00:00 2001
From: Henry Weller <http://cfd.direct>
Date: Wed, 4 May 2016 21:01:22 +0100
Subject: [PATCH] functionObjects: Updated documentation
---
.../db/functionObjects/functionObject/functionObject.H | 7 -------
.../db/functionObjects/functionObject/functionObjectsDoc.H | 6 +++---
src/OpenFOAM/global/foamDoc.H | 4 ++--
.../functionObjects/utilities/systemCall/systemCall.H | 2 +-
src/sampling/probes/probes.H | 2 +-
src/sampling/sampledSet/sampledSet/sampledSet.H | 2 +-
.../sampledSurface/sampledSurface/sampledSurface.H | 2 +-
7 files changed, 9 insertions(+), 16 deletions(-)
diff --git a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
index d1709c44b34..0af33e3817e 100644
--- a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
+++ b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
@@ -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
diff --git a/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H b/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H
index 2e093012329..e46859e3d04 100644
--- a/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H
+++ b/src/OpenFOAM/db/functionObjects/functionObject/functionObjectsDoc.H
@@ -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
@}
\*---------------------------------------------------------------------------*/
diff --git a/src/OpenFOAM/global/foamDoc.H b/src/OpenFOAM/global/foamDoc.H
index 4f92fa4d27f..46b69ff11da 100644
--- a/src/OpenFOAM/global/foamDoc.H
+++ b/src/OpenFOAM/global/foamDoc.H
@@ -53,7 +53,7 @@ License
\section usingOpenFOAM Using OpenFOAM
- - \subpage pagePostProcessing
- - Post-processing using Foam::functionObjects
+ - \ref grpFunctionObjects namespace Foam::functionObjects
+ - \subpage pageBoundaryConditions
\*---------------------------------------------------------------------------*/
diff --git a/src/postProcessing/functionObjects/utilities/systemCall/systemCall.H b/src/postProcessing/functionObjects/utilities/systemCall/systemCall.H
index 3219fe22d81..0e145a38cba 100644
--- a/src/postProcessing/functionObjects/utilities/systemCall/systemCall.H
+++ b/src/postProcessing/functionObjects/utilities/systemCall/systemCall.H
@@ -25,7 +25,7 @@ Class
Foam::functionObjects::systemCall
Group
- grpFunctionObjects
+ grpUtilitiesFunctionObjects
Description
This function object executes system calls, entered in the form of a
diff --git a/src/sampling/probes/probes.H b/src/sampling/probes/probes.H
index 18de7b51510..55ffc625664 100644
--- a/src/sampling/probes/probes.H
+++ b/src/sampling/probes/probes.H
@@ -25,7 +25,7 @@ Class
Foam::probes
Group
- grpFunctionObjects
+ grpUtilitiesFunctionObjects
Description
Set of locations to sample.
diff --git a/src/sampling/sampledSet/sampledSet/sampledSet.H b/src/sampling/sampledSet/sampledSet/sampledSet.H
index 56a63b2f235..7623524f87b 100644
--- a/src/sampling/sampledSet/sampledSet/sampledSet.H
+++ b/src/sampling/sampledSet/sampledSet/sampledSet.H
@@ -25,7 +25,7 @@ Class
Foam::sampledSet
Group
- grpFunctionObjects
+ grpUtilitiesFunctionObjects
Description
Holds list of sampling points which is filled at construction time.
diff --git a/src/sampling/sampledSurface/sampledSurface/sampledSurface.H b/src/sampling/sampledSurface/sampledSurface/sampledSurface.H
index 0fdcca5dd70..0507a6887a0 100644
--- a/src/sampling/sampledSurface/sampledSurface/sampledSurface.H
+++ b/src/sampling/sampledSurface/sampledSurface/sampledSurface.H
@@ -25,7 +25,7 @@ Class
Foam::sampledSurface
Group
- grpFunctionObjects
+ grpUtilitiesFunctionObjects
Description
An abstract class for surfaces with sampling.
--
GitLab