From 5a329962807694a891d581bf3d7273cf4e1c5493 Mon Sep 17 00:00:00 2001 From: Andrew Heather <a.heather@opencfd.co.uk> Date: Wed, 11 Nov 2015 16:10:38 +0000 Subject: [PATCH] ENH: Added FO documentation --- .../forces/doc/forcesFunctionObjectsDoc.H | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 src/postProcessing/functionObjects/forces/doc/forcesFunctionObjectsDoc.H diff --git a/src/postProcessing/functionObjects/forces/doc/forcesFunctionObjectsDoc.H b/src/postProcessing/functionObjects/forces/doc/forcesFunctionObjectsDoc.H new file mode 100644 index 00000000000..b171ef92891 --- /dev/null +++ b/src/postProcessing/functionObjects/forces/doc/forcesFunctionObjectsDoc.H @@ -0,0 +1,33 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation + \\/ M anipulation | +------------------------------------------------------------------------------- +License + This file is part of OpenFOAM. + + OpenFOAM is free software: you can redistribute it and/or modify it under + the terms of the GNU General Public License as published by the Free + Software Foundation, either version 3 of the License, or (at your option) + any later version. + + OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + details. + + You should have received a copy of the GNU General Public License along with + OpenFOAM. If not, see <http://www.gnu.org/licenses/>. + +\defgroup grpForcesFunctionObjects Forces function objects +@{ + \ingroup grpFunctionObjects + This group contains force-based function objects + + Function objects in this group are packaged into the + libforcesFunctionObjects.so library. +@} + +\*---------------------------------------------------------------------------*/ -- GitLab