From 7760d19c86a135995fd62c670126fd6c15070ba6 Mon Sep 17 00:00:00 2001 From: Andrew Heather Date: Tue, 6 Oct 2015 14:58:13 +0100 Subject: [PATCH] ENH: field function objects - moved documentation to doc sub-directory --- .../field/doc/fieldFunctionObjectsDoc.H | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 src/postProcessing/functionObjects/field/doc/fieldFunctionObjectsDoc.H diff --git a/src/postProcessing/functionObjects/field/doc/fieldFunctionObjectsDoc.H b/src/postProcessing/functionObjects/field/doc/fieldFunctionObjectsDoc.H new file mode 100644 index 0000000000..6c934be48e --- /dev/null +++ b/src/postProcessing/functionObjects/field/doc/fieldFunctionObjectsDoc.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 . + +\defgroup grpFieldFunctionObjects Field function objects +@{ + \ingroup grpFunctionObjects + This group contains field-based function objects + + Function objects in this group are packaged into the + libfieldFunctionObjects.so library. +@} + +\*---------------------------------------------------------------------------*/