ENH: (further) Doxygen documentation updates for module support

efb39a87 · Andrew Heather · 4a0c74d2 · efb39a87 · efb39a87 · efb39a87
Commit efb39a87 authored Jun 27, 2016 by Andrew Heather
75 changed files
--- a/applications/utilities/doc/utilities.dox
+++ b/applications/utilities/doc/utilities.dox
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     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/>.
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+\page pageUtilities Utilities
+
+\section secUtilities Overview
+The available utilities are grouped into the following categories:
+  - \ref grpMeshUtilities
+  - \ref grpMiscUtilities
+  - \ref grpPreProcessingUtilities
+  - \ref grpPostProcessingUtilities
+  - \ref grpThermoUtilities
+  - \ref grpSurfaceUtilities
+
+\*---------------------------------------------------------------------------*/
--- a/applications/utilities/doc/utilitiesDoc.H
+++ b/applications/utilities/doc/utilitiesDoc.H
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     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 grpUtilities Utilities
+@{
+    This group contains utilities
+@}
+
+\defgroup grpMeshUtilities Mesh
+@{
+    \ingroup grpUtilities
+    This group contains meshing utilities
+@}
+
+\defgroup grpPreProcessingUtilities Pre-processing
+@{
+    \ingroup grpUtilities
+    This group contains pre-processing utilities
+@}
+
+\defgroup grpPostProcessingUtilities Post-processing
+@{
+    \ingroup grpUtilities
+    This group contains post-processing utilities
+@}
+
+\defgroup grpParallelUtilities Parallel
+@{
+    \ingroup grpUtilities
+    This group contains parallel utilities
+@}
+
+\defgroup grpSurfaceUtilities Surface
+@{
+    \ingroup grpUtilities
+    This group contains surface utilities
+@}
+
+\defgroup grpThermophysicalUtilities Thermophysical
+@{
+    \ingroup grpUtilities
+    This group contains thermophysical utilities
+@}
+
+\defgroup grpMiscUtilities Miscellaneous
+@{
+    \ingroup grpUtilities
+    This group contains miscellaneous utilities
+@}
+
+\*---------------------------------------------------------------------------*/
--- a/applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C
+++ b/applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C
@@ -24,6 +24,9 @@ License
 Application
    PDRMesh

+Group
+    grpMeshAdvancedUtilities
+
 Description
    Mesh and field preparation utility for PDR type simulations.


--- a/applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C
+++ b/applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C
@@ -24,6 +24,9 @@ License
 Application
    collapseEdges

+Group
+    grpMeshAdvancedUtilities
+
 Description
    Collapses short edges and combines edges that are in line.


--- a/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C
+++ b/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C
@@ -24,6 +24,9 @@ License
 Application
    combinePatchFaces

+Group
+    grpMeshAdvancedUtilities
+
 Description
    Checks for multiple patch faces on same cell and combines them.
    Multiple patch faces can result from e.g. removal of refined

--- a/applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C
+++ b/applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C
@@ -24,6 +24,9 @@ License
 Application
    modifyMesh

+Group
+    grpMeshAdvancedUtilities
+
 Description
    Manipulates mesh elements.


--- a/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C
+++ b/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C
@@ -24,6 +24,9 @@ License
 Application
    refineHexMesh

+Group
+    grpMeshAdvancedUtilities
+
 Description
    Refines a hex mesh by 2x2x2 cell splitting.


--- a/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C
+++ b/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C
@@ -24,6 +24,9 @@ License
 Application
    refineWallLayer

+Group
+    grpMeshAdvancedUtilities
+
 Description
    Utility to refine cells next to patches.


--- a/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C
+++ b/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C
@@ -24,6 +24,9 @@ License
 Application
    refinementLevel

+Group
+    grpMeshAdvancedUtilities
+
 Description
    Tries to figure out what the refinement level is on refined cartesian
    meshes. Run BEFORE snapping.

--- a/applications/utilities/mesh/advanced/removeFaces/removeFaces.C
+++ b/applications/utilities/mesh/advanced/removeFaces/removeFaces.C
@@ -24,6 +24,9 @@ License
 Application
    removeFaces

+Group
+    grpMeshAdvancedUtilities
+
 Description
    Utility to remove faces (combines cells on both sides).


--- a/applications/utilities/mesh/advanced/selectCells/selectCells.C
+++ b/applications/utilities/mesh/advanced/selectCells/selectCells.C
@@ -24,6 +24,9 @@ License
 Application
    selectCells

+Group
+    grpMeshAdvancedUtilities
+
 Description
    Select cells in relation to surface.


--- a/applications/utilities/mesh/advanced/snappyRefineMesh/snappyRefineMesh.C
+++ b/applications/utilities/mesh/advanced/snappyRefineMesh/snappyRefineMesh.C
@@ -24,6 +24,9 @@ License
 Application
    snappyRefineMesh

+Group
+    grpMeshAdvancedUtilities
+
 Description
    Utility to refine cells near to a surface.


--- a/applications/utilities/mesh/advanced/splitCells/splitCells.C
+++ b/applications/utilities/mesh/advanced/splitCells/splitCells.C
@@ -24,6 +24,9 @@ License
 Application
    splitCells

+Group
+    grpMeshAdvancedUtilities
+
 Description
    Utility to split cells with flat faces.


--- a/applications/utilities/mesh/conversion/Optional/ccm26ToFoam/ccm26ToFoam.C
+++ b/applications/utilities/mesh/conversion/Optional/ccm26ToFoam/ccm26ToFoam.C
@@ -21,6 +21,12 @@ License
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

+Application
+    ccm26ToFoam
+
+Group
+    grpMeshConversionUtilities
+
 Description
    Reads CCM files as written by Prostar/ccm using ccm 2.6 (not 2.4)


--- a/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L
+++ b/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L
@@ -24,6 +24,9 @@ License
 Application
    ansysToFoam

+Group
+    grpMeshConversionUtilities
+
 Description
    Converts an ANSYS input mesh file, exported from I-DEAS,
    to OpenFOAM format.

--- a/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C
+++ b/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C
@@ -24,6 +24,9 @@ License
 Application
    cfx4ToFoam

+Group
+    grpMeshConversionUtilities
+
 Description
    Converts a CFX 4 mesh to OpenFOAM format.


--- a/applications/utilities/mesh/conversion/datToFoam/datToFoam.C
+++ b/applications/utilities/mesh/conversion/datToFoam/datToFoam.C
@@ -24,6 +24,9 @@ License
 Application
    datToFoam

+Group
+    grpMeshConversionUtilities
+
 Description
    Reads in a datToFoam mesh file and outputs a points file.  Used in
    conjunction with blockMesh.

--- a/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L
+++ b/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L
@@ -24,6 +24,9 @@ License
 Application
    fluent3DMeshToFoam

+Group
+    grpMeshConversionUtilities
+
 Description
    Converts a Fluent mesh to OpenFOAM format.


--- a/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L
+++ b/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L
@@ -24,6 +24,9 @@ License
 Application
    fluentMeshToFoam

+Group
+    grpMeshConversionUtilities
+
 Description
    Converts a Fluent mesh to OpenFOAM format
    including multiple region and region boundary handling.

--- a/applications/utilities/mesh/conversion/foamMeshToFluent/foamMeshToFluent.C
+++ b/applications/utilities/mesh/conversion/foamMeshToFluent/foamMeshToFluent.C
@@ -24,6 +24,9 @@ License
 Application
    foamMeshToFluent

+Group
+    grpMeshConversionUtilities
+
 Description
    Writes out the OpenFOAM mesh in Fluent mesh format.


--- a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
+++ b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
@@ -24,6 +24,9 @@ License
 Application
    foamToStarMesh

+Group
+    grpMeshConversionUtilities
+
 Description
    Reads an OpenFOAM mesh and writes a pro-STAR (v4) bnd/cel/vrt format.


--- a/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C
+++ b/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C
@@ -24,6 +24,9 @@ License
 Application
    foamToSurface

+Group
+    grpMeshConversionUtilities
+
 Description
    Reads an OpenFOAM mesh and writes the boundaries in a surface format.


--- a/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L
+++ b/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L
@@ -24,6 +24,9 @@ License
 Application
    gambitToFoam

+Group
+    grpMeshConversionUtilities
+
 Description
    Converts a GAMBIT mesh to OpenFOAM format.


--- a/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C
+++ b/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C
@@ -24,6 +24,9 @@ License
 Application
    gmshToFoam

+group
+    grpMeshConversionUtilities
+
 Description
    Reads .msh file as written by Gmsh.


--- a/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C
+++ b/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C
@@ -24,6 +24,9 @@ License
 Application
    ideasUnvToFoam

+Group
+    grpMeshConversionUtilities
+
 Description
    I-Deas unv format mesh conversion.


--- a/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C
+++ b/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C
@@ -24,6 +24,9 @@ License
 Application
    kivaToFoam

+Group
+    grpMeshConversionUtilities
+
 Description
    Converts a KIVA3v grid to OpenFOAM format.


--- a/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C
+++ b/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C
@@ -24,6 +24,9 @@ License
 Application
    mshToFoam

+Group
+    grpMeshConversionUtilities
+
 Description
    Converts .msh file generated by the Adventure system.


--- a/applications/utilities/mesh/conversion/netgenNeutralToFoam/netgenNeutralToFoam.C
+++ b/applications/utilities/mesh/conversion/netgenNeutralToFoam/netgenNeutralToFoam.C
@@ -24,6 +24,9 @@ License
 Application
    netgenNeutralToFoam

+Group
+    grpMeshConversionUtilities
+
 Description
    Converts neutral file format as written by Netgen v4.4.


--- a/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C
+++ b/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C
@@ -24,6 +24,9 @@ License
 Application
    plot3dToFoam

+Group
+    grpMeshConversionUtilities
+
 Description
    Plot3d mesh (ascii/formatted format) converter.


--- a/applications/utilities/mesh/conversion/sammToFoam/sammToFoam.C
+++ b/applications/utilities/mesh/conversion/sammToFoam/sammToFoam.C
@@ -24,6 +24,9 @@ License
 Application
    sammToFoam

+Group
+    grpMeshConversionUtilities
+
 Description
    Converts a Star-CD (v3) SAMM mesh to OpenFOAM format.


--- a/applications/utilities/mesh/conversion/star3ToFoam/star3ToFoam.C
+++ b/applications/utilities/mesh/conversion/star3ToFoam/star3ToFoam.C
@@ -24,6 +24,9 @@ License
 Application
    star3ToFoam

+Group
+    grpMeshConversionUtilities
+
 Description
    Converts a Star-CD (v3) pro-STAR mesh into OpenFOAM format.


--- a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
+++ b/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
@@ -24,6 +24,9 @@ License
 Application
    star4ToFoam

+Group
+    grpMeshConversionUtilities
+
 Description
    Converts a Star-CD (v4) pro-STAR mesh into OpenFOAM format.


--- a/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C
+++ b/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C
@@ -24,6 +24,9 @@ License
 Application
    tetgenToFoam

+Group
+    grpMeshConversionUtilities
+
 Description
    Converts .ele and .node and .face files, written by tetgen.


--- a/applications/utilities/mesh/conversion/vtkUnstructuredToFoam/vtkUnstructuredToFoam.C
+++ b/applications/utilities/mesh/conversion/vtkUnstructuredToFoam/vtkUnstructuredToFoam.C
@@ -21,6 +21,12 @@ License
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

+Application
+    vtkUnstructuredToFoam
+
+Group
+    grpMeshConversionUtilities
+
 Description
    Converts ascii .vtk (legacy format) file generated by vtk/paraview.


--- a/applications/utilities/mesh/conversion/writeMeshObj/writeMeshObj.C
+++ b/applications/utilities/mesh/conversion/writeMeshObj/writeMeshObj.C
@@ -24,6 +24,9 @@ License
 Application
    writeMeshObj

+Group
+    grpMeshConversionUtilities
+
 Description
    For mesh debugging: writes mesh as three separate OBJ files which can
    be viewed with e.g. javaview.

--- a/applications/utilities/mesh/doc/meshUtilitiesDoc.H
+++ b/applications/utilities/mesh/doc/meshUtilitiesDoc.H
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     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 grpMeshGenerationUtilities Generation
+@{
+    \ingroup grpMeshUtilities
+    This group contains mesh generation utilities
+@}
+
+\defgroup grpMeshConversionUtilities Conversion
+@{
+    \ingroup grpMeshUtilities
+    This group contains mesh conversion utilities
+@}
+
+\defgroup grpMeshManipulationUtilities Manipulation
+@{
+    \ingroup grpMeshUtilities
+    This group contains mesh generation utilities
+@}
+
+\defgroup grpMeshAdvancedUtilities Advanced
+@{
+    \ingroup grpMeshUtilities
+    This group contains advanced mesh utilities
+@}
+
+\*---------------------------------------------------------------------------*/
+
--- a/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C
+++ b/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C
@@ -24,6 +24,9 @@ License
 Application
    blockMesh

+Group
+    grpMeshGenerationUtilities
+
 Description
    A multi-block mesh generator.


--- a/applications/utilities/mesh/generation/extrude/extrudeMesh/extrudeMesh.C
+++ b/applications/utilities/mesh/generation/extrude/extrudeMesh/extrudeMesh.C
@@ -24,6 +24,9 @@ License
 Application
    extrudeMesh

+Group
+    grpMeshGenerationUtilities
+
 Description
    Extrude mesh from existing patch (by default outwards facing normals;
    optional flips faces) or from patch read from file.

--- a/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C
+++ b/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C
@@ -24,6 +24,9 @@ License
 Application
    extrudeToRegionMesh

+Group
+    grpMeshGenerationUtilities
+
 Description
    Extrude faceZones (internal or boundary faces) or faceSets (boundary faces
    only) into a separate mesh (as a different region).

--- a/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMeshApp.C
+++ b/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMeshApp.C
@@ -24,6 +24,9 @@ License
 Application
    extrude2DMesh

+Group
+    grpMeshGenerationUtilities
+
 Description
    Takes 2D mesh (all faces 2 points only, no front and back faces) and
    creates a 3D mesh by extruding with specified thickness.

--- a/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C
+++ b/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C
@@ -24,6 +24,9 @@ License
 Application
    foamyHexMesh

+Group
+    grpMeshGenerationUtilities
+
 Description
    Conformal Voronoi automatic mesh generator


--- a/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/foamyQuadMesh.C
+++ b/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/foamyQuadMesh.C
@@ -24,6 +24,9 @@ License