diff --git a/applications/utilities/doc/utilities.dox b/applications/utilities/doc/utilities.dox
new file mode 100644
index 0000000000..f9cbceeb99
--- /dev/null
+++ b/applications/utilities/doc/utilities.dox
@@ -0,0 +1,37 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / 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 .
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+\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
+
+\*---------------------------------------------------------------------------*/
diff --git a/applications/utilities/doc/utilitiesDoc.H b/applications/utilities/doc/utilitiesDoc.H
new file mode 100644
index 0000000000..d953a47480
--- /dev/null
+++ b/applications/utilities/doc/utilitiesDoc.H
@@ -0,0 +1,73 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / 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 .
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+\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
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C b/applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C
index e38319f481..f936134e9a 100644
--- 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.
diff --git a/applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C b/applications/utilities/mesh/advanced/collapseEdges/collapseEdges.C
index b3099f4f28..7cbfa6d9cb 100644
--- 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.
diff --git a/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C b/applications/utilities/mesh/advanced/combinePatchFaces/combinePatchFaces.C
index 9854ec2fef..2666d4c9de 100644
--- 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
diff --git a/applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C b/applications/utilities/mesh/advanced/modifyMesh/modifyMesh.C
index 766cd6a6e5..320a1f2d96 100644
--- 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.
diff --git a/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C b/applications/utilities/mesh/advanced/refineHexMesh/refineHexMesh.C
index dc797fdcee..fcdd7ec8f1 100644
--- 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.
diff --git a/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C b/applications/utilities/mesh/advanced/refineWallLayer/refineWallLayer.C
index ba5b7f8548..754568cc4a 100644
--- 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.
diff --git a/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C b/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C
index a12adf8413..744fcf5c5a 100644
--- 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.
diff --git a/applications/utilities/mesh/advanced/removeFaces/removeFaces.C b/applications/utilities/mesh/advanced/removeFaces/removeFaces.C
index 64191b8bb0..ca82886601 100644
--- 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).
diff --git a/applications/utilities/mesh/advanced/selectCells/selectCells.C b/applications/utilities/mesh/advanced/selectCells/selectCells.C
index c71929e500..87b4398d28 100644
--- 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.
diff --git a/applications/utilities/mesh/advanced/snappyRefineMesh/snappyRefineMesh.C b/applications/utilities/mesh/advanced/snappyRefineMesh/snappyRefineMesh.C
index abb29b1dea..4e4f7e0263 100644
--- 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.
diff --git a/applications/utilities/mesh/advanced/splitCells/splitCells.C b/applications/utilities/mesh/advanced/splitCells/splitCells.C
index 0e1eb5b1e5..7e44c20d36 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/Optional/ccm26ToFoam/ccm26ToFoam.C b/applications/utilities/mesh/conversion/Optional/ccm26ToFoam/ccm26ToFoam.C
index b95acd7978..b0bec171f3 100644
--- 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 .
+Application
+ ccm26ToFoam
+
+Group
+ grpMeshConversionUtilities
+
Description
Reads CCM files as written by Prostar/ccm using ccm 2.6 (not 2.4)
diff --git a/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L b/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L
index 9a21299127..3f17812bb4 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C b/applications/utilities/mesh/conversion/cfx4ToFoam/cfx4ToFoam.C
index c3d2fef073..af7f86f7b6 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/datToFoam/datToFoam.C b/applications/utilities/mesh/conversion/datToFoam/datToFoam.C
index 4ee10d1f15..2b1956e51f 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L b/applications/utilities/mesh/conversion/fluent3DMeshToFoam/fluent3DMeshToFoam.L
index 1d28f046dc..3d1875d717 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L b/applications/utilities/mesh/conversion/fluentMeshToFoam/fluentMeshToFoam.L
index 3300ba9778..6cff0ce962 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/foamMeshToFluent/foamMeshToFluent.C b/applications/utilities/mesh/conversion/foamMeshToFluent/foamMeshToFluent.C
index 31ca1f9db4..d532e27d5f 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C b/applications/utilities/mesh/conversion/foamToStarMesh/foamToStarMesh.C
index a345d30015..adc86dc4b5 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C b/applications/utilities/mesh/conversion/foamToSurface/foamToSurface.C
index 9654b33fc2..16a6752cfb 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L b/applications/utilities/mesh/conversion/gambitToFoam/gambitToFoam.L
index 6821af8fba..c2dfdf4355 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C b/applications/utilities/mesh/conversion/gmshToFoam/gmshToFoam.C
index 5de646c441..9d466f64f2 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C b/applications/utilities/mesh/conversion/ideasUnvToFoam/ideasUnvToFoam.C
index 7a94b27299..8c14a5373d 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C b/applications/utilities/mesh/conversion/kivaToFoam/kivaToFoam.C
index 99d522f741..56653cc921 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C b/applications/utilities/mesh/conversion/mshToFoam/mshToFoam.C
index a69f6047a5..81cc0322fc 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/netgenNeutralToFoam/netgenNeutralToFoam.C b/applications/utilities/mesh/conversion/netgenNeutralToFoam/netgenNeutralToFoam.C
index e004220723..93c4267f77 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C b/applications/utilities/mesh/conversion/plot3dToFoam/plot3dToFoam.C
index 891af306e1..63ddfd1e69 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/sammToFoam/sammToFoam.C b/applications/utilities/mesh/conversion/sammToFoam/sammToFoam.C
index 5bceed621f..543b71cba3 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/star3ToFoam/star3ToFoam.C b/applications/utilities/mesh/conversion/star3ToFoam/star3ToFoam.C
index 9668741305..4e6449b9fd 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C b/applications/utilities/mesh/conversion/star4ToFoam/star4ToFoam.C
index f8e1657e79..cefbf009d1 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C b/applications/utilities/mesh/conversion/tetgenToFoam/tetgenToFoam.C
index 46ea78e599..7eac643583 100644
--- 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.
diff --git a/applications/utilities/mesh/conversion/vtkUnstructuredToFoam/vtkUnstructuredToFoam.C b/applications/utilities/mesh/conversion/vtkUnstructuredToFoam/vtkUnstructuredToFoam.C
index 4c6c7af788..507d8575e7 100644
--- 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 .
+Application
+ vtkUnstructuredToFoam
+
+Group
+ grpMeshConversionUtilities
+
Description
Converts ascii .vtk (legacy format) file generated by vtk/paraview.
diff --git a/applications/utilities/mesh/conversion/writeMeshObj/writeMeshObj.C b/applications/utilities/mesh/conversion/writeMeshObj/writeMeshObj.C
index 3b0a226933..98923ea6ee 100644
--- 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.
diff --git a/applications/utilities/mesh/doc/meshUtilitiesDoc.H b/applications/utilities/mesh/doc/meshUtilitiesDoc.H
new file mode 100644
index 0000000000..f0ff94b39c
--- /dev/null
+++ b/applications/utilities/mesh/doc/meshUtilitiesDoc.H
@@ -0,0 +1,51 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / 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 .
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+\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
+@}
+
+\*---------------------------------------------------------------------------*/
+
diff --git a/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C b/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C
index 0c92180830..3d0624f745 100644
--- 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.
diff --git a/applications/utilities/mesh/generation/extrude/extrudeMesh/extrudeMesh.C b/applications/utilities/mesh/generation/extrude/extrudeMesh/extrudeMesh.C
index 00ced168eb..d52ed1b29f 100644
--- 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.
diff --git a/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C b/applications/utilities/mesh/generation/extrude/extrudeToRegionMesh/extrudeToRegionMesh.C
index 91aab57a1b..7f35de4b22 100644
--- 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).
diff --git a/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMeshApp.C b/applications/utilities/mesh/generation/extrude2DMesh/extrude2DMeshApp.C
index a6916b7076..ef6cd069e9 100644
--- 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.
diff --git a/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C b/applications/utilities/mesh/generation/foamyMesh/foamyHexMesh/foamyHexMesh.C
index fd8d6f1224..3588a9878f 100644
--- 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
diff --git a/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/foamyQuadMesh.C b/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/foamyQuadMesh.C
index 997726bba6..f8d6054644 100644
--- a/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/foamyQuadMesh.C
+++ b/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/foamyQuadMesh.C
@@ -24,6 +24,9 @@ License
Application
foamyQuadMesh
+Group
+ grpMeshGenerationUtilities
+
Description
Conformal-Voronoi 2D extruding automatic mesher with grid or read
initial points and point position relaxation with optional
diff --git a/applications/utilities/mesh/generation/snappyHexMesh/snappyHexMesh.C b/applications/utilities/mesh/generation/snappyHexMesh/snappyHexMesh.C
index b5187f1e94..f318d12b5b 100644
--- a/applications/utilities/mesh/generation/snappyHexMesh/snappyHexMesh.C
+++ b/applications/utilities/mesh/generation/snappyHexMesh/snappyHexMesh.C
@@ -24,6 +24,9 @@ License
Application
snappyHexMesh
+Group
+ grpMeshGenerationUtilities
+
Description
Automatic split hex mesher. Refines and snaps to surface.
diff --git a/applications/utilities/mesh/manipulation/attachMesh/attachMesh.C b/applications/utilities/mesh/manipulation/attachMesh/attachMesh.C
index bf0dff94b0..7dea889f86 100644
--- a/applications/utilities/mesh/manipulation/attachMesh/attachMesh.C
+++ b/applications/utilities/mesh/manipulation/attachMesh/attachMesh.C
@@ -24,6 +24,9 @@ License
Application
attachMesh
+Group
+ grpMeshManipulationUtilities
+
Description
Attach topologically detached mesh using prescribed mesh modifiers.
diff --git a/applications/utilities/mesh/manipulation/autoPatch/autoPatch.C b/applications/utilities/mesh/manipulation/autoPatch/autoPatch.C
index f35f70b45b..abd73d8445 100644
--- a/applications/utilities/mesh/manipulation/autoPatch/autoPatch.C
+++ b/applications/utilities/mesh/manipulation/autoPatch/autoPatch.C
@@ -24,6 +24,9 @@ License
Application
autoPatch
+Group
+ grpMeshManipulationUtilities
+
Description
Divides external faces into patches based on (user supplied) feature
angle.
diff --git a/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C b/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C
index 9a3ab3871e..c1a07e9fca 100644
--- a/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C
+++ b/applications/utilities/mesh/manipulation/checkMesh/checkMesh.C
@@ -24,6 +24,9 @@ License
Application
checkMesh
+Group
+ grpMeshManipulationUtilities
+
Description
Checks validity of a mesh.
diff --git a/applications/utilities/mesh/manipulation/createBaffles/createBaffles.C b/applications/utilities/mesh/manipulation/createBaffles/createBaffles.C
index d0d1439b85..e5892bef4b 100644
--- a/applications/utilities/mesh/manipulation/createBaffles/createBaffles.C
+++ b/applications/utilities/mesh/manipulation/createBaffles/createBaffles.C
@@ -24,6 +24,9 @@ License
Application
createBaffles
+Group
+ grpMeshManipulationUtilities
+
Description
Makes internal faces into boundary faces. Does not duplicate points, unlike
mergeOrSplitBaffles.
diff --git a/applications/utilities/mesh/manipulation/createPatch/createPatch.C b/applications/utilities/mesh/manipulation/createPatch/createPatch.C
index eb89288a30..a97916281d 100644
--- a/applications/utilities/mesh/manipulation/createPatch/createPatch.C
+++ b/applications/utilities/mesh/manipulation/createPatch/createPatch.C
@@ -24,6 +24,9 @@ License
Application
createPatch
+Group
+ grpMeshManipulationUtilities
+
Description
Utility to create patches out of selected boundary faces. Faces come either
from existing patches or from a faceSet.
diff --git a/applications/utilities/mesh/manipulation/deformedGeom/deformedGeom.C b/applications/utilities/mesh/manipulation/deformedGeom/deformedGeom.C
index 58f7447506..181e80e12d 100644
--- a/applications/utilities/mesh/manipulation/deformedGeom/deformedGeom.C
+++ b/applications/utilities/mesh/manipulation/deformedGeom/deformedGeom.C
@@ -24,6 +24,9 @@ License
Application
deformedGeom
+Group
+ grpMeshManipulationUtilities
+
Description
Deforms a polyMesh using a displacement field U and a scaling factor
supplied as an argument.
diff --git a/applications/utilities/mesh/manipulation/flattenMesh/flattenMesh.C b/applications/utilities/mesh/manipulation/flattenMesh/flattenMesh.C
index f10405674d..7e2fd95c58 100644
--- a/applications/utilities/mesh/manipulation/flattenMesh/flattenMesh.C
+++ b/applications/utilities/mesh/manipulation/flattenMesh/flattenMesh.C
@@ -24,6 +24,9 @@ License
Application
flattenMesh
+Group
+ grpMeshManipulationUtilities
+
Description
Flattens the front and back planes of a 2D cartesian mesh.
diff --git a/applications/utilities/mesh/manipulation/insideCells/insideCells.C b/applications/utilities/mesh/manipulation/insideCells/insideCells.C
index 4b0845abcb..177b183864 100644
--- a/applications/utilities/mesh/manipulation/insideCells/insideCells.C
+++ b/applications/utilities/mesh/manipulation/insideCells/insideCells.C
@@ -24,6 +24,9 @@ License
Application
insideCells
+Group
+ grpMeshManipulationUtilities
+
Description
Picks up cells with cell centre 'inside' of surface.
Requires surface to be closed and singly connected.
diff --git a/applications/utilities/mesh/manipulation/mergeMeshes/mergeMeshes.C b/applications/utilities/mesh/manipulation/mergeMeshes/mergeMeshes.C
index 26c67575c7..cb80039e79 100644
--- a/applications/utilities/mesh/manipulation/mergeMeshes/mergeMeshes.C
+++ b/applications/utilities/mesh/manipulation/mergeMeshes/mergeMeshes.C
@@ -24,6 +24,9 @@ License
Application
mergeMeshes
+Group
+ grpMeshManipulationUtilities
+
Description
Merges two meshes.
diff --git a/applications/utilities/mesh/manipulation/mergeOrSplitBaffles/mergeOrSplitBaffles.C b/applications/utilities/mesh/manipulation/mergeOrSplitBaffles/mergeOrSplitBaffles.C
index 6db0d3abc6..5d52574886 100644
--- a/applications/utilities/mesh/manipulation/mergeOrSplitBaffles/mergeOrSplitBaffles.C
+++ b/applications/utilities/mesh/manipulation/mergeOrSplitBaffles/mergeOrSplitBaffles.C
@@ -24,6 +24,9 @@ License
Application
mergeOrSplitBaffles
+Group
+ grpMeshManipulationUtilities
+
Description
Detects faces that share points (baffles). Either merge them or
duplicate the points.
diff --git a/applications/utilities/mesh/manipulation/mirrorMesh/mirrorMesh.C b/applications/utilities/mesh/manipulation/mirrorMesh/mirrorMesh.C
index f7383289cb..e06acc0205 100644
--- a/applications/utilities/mesh/manipulation/mirrorMesh/mirrorMesh.C
+++ b/applications/utilities/mesh/manipulation/mirrorMesh/mirrorMesh.C
@@ -24,6 +24,9 @@ License
Application
mirrorMesh
+Group
+ grpMeshManipulationUtilities
+
Description
Mirrors a mesh around a given plane.
diff --git a/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C b/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C
index 2fac9f25c0..7fed198993 100644
--- a/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C
+++ b/applications/utilities/mesh/manipulation/moveDynamicMesh/moveDynamicMesh.C
@@ -24,6 +24,9 @@ License
Application
moveDynamicMesh
+Group
+ grpMeshManipulationUtilities
+
Description
Mesh motion and topological mesh changes utility.
diff --git a/applications/utilities/mesh/manipulation/moveEngineMesh/moveEngineMesh.C b/applications/utilities/mesh/manipulation/moveEngineMesh/moveEngineMesh.C
index 54727b825a..9757be6655 100644
--- a/applications/utilities/mesh/manipulation/moveEngineMesh/moveEngineMesh.C
+++ b/applications/utilities/mesh/manipulation/moveEngineMesh/moveEngineMesh.C
@@ -24,6 +24,9 @@ License
Application
moveEngineMesh
+Group
+ grpMeshManipulationUtilities
+
Description
Solver for moving meshes for engine calculations.
diff --git a/applications/utilities/mesh/manipulation/moveMesh/moveMesh.C b/applications/utilities/mesh/manipulation/moveMesh/moveMesh.C
index f2ef289053..0f4049ad7c 100644
--- a/applications/utilities/mesh/manipulation/moveMesh/moveMesh.C
+++ b/applications/utilities/mesh/manipulation/moveMesh/moveMesh.C
@@ -24,6 +24,9 @@ License
Application
moveMesh
+Group
+ grpMeshManipulationUtilities
+
Description
Solver for moving meshes.
diff --git a/applications/utilities/mesh/manipulation/objToVTK/objToVTK.C b/applications/utilities/mesh/manipulation/objToVTK/objToVTK.C
index e0da25a526..7b61f097cf 100644
--- a/applications/utilities/mesh/manipulation/objToVTK/objToVTK.C
+++ b/applications/utilities/mesh/manipulation/objToVTK/objToVTK.C
@@ -24,6 +24,9 @@ License
Application
objToVTK
+Group
+ grpMeshManipulationUtilities
+
Description
Read obj line (not surface!) file and convert into vtk.
diff --git a/applications/utilities/mesh/manipulation/orientFaceZone/orientFaceZone.C b/applications/utilities/mesh/manipulation/orientFaceZone/orientFaceZone.C
index 5595138322..a13594496f 100644
--- a/applications/utilities/mesh/manipulation/orientFaceZone/orientFaceZone.C
+++ b/applications/utilities/mesh/manipulation/orientFaceZone/orientFaceZone.C
@@ -24,6 +24,9 @@ License
Application
orientFaceZone
+Group
+ grpMeshManipulationUtilities
+
Description
Corrects orientation of faceZone.
diff --git a/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C b/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C
index f0c4c16d71..27209b9793 100644
--- a/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C
+++ b/applications/utilities/mesh/manipulation/polyDualMesh/polyDualMeshApp.C
@@ -24,6 +24,9 @@ License
Application
polyDualMesh
+Group
+ grpMeshManipulationUtilities
+
Description
Calculates the dual of a polyMesh. Adheres to all the feature and patch
edges.
diff --git a/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C b/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C
index 4877c45319..37cce07659 100644
--- a/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C
+++ b/applications/utilities/mesh/manipulation/refineMesh/refineMesh.C
@@ -24,6 +24,9 @@ License
Application
refineMesh
+Group
+ grpMeshManipulationUtilities
+
Description
Utility to refine cells in multiple directions.
diff --git a/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C b/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C
index 167afe59dd..a4fb8169b0 100644
--- a/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C
+++ b/applications/utilities/mesh/manipulation/renumberMesh/renumberMesh.C
@@ -24,6 +24,9 @@ License
Application
renumberMesh
+Group
+ grpMeshManipulationUtilities
+
Description
Renumbers the cell list in order to reduce the bandwidth, reading and
renumbering all fields from all the time directories.
diff --git a/applications/utilities/mesh/manipulation/rotateMesh/rotateMesh.C b/applications/utilities/mesh/manipulation/rotateMesh/rotateMesh.C
index fb49b074fa..00ebde5cd5 100644
--- a/applications/utilities/mesh/manipulation/rotateMesh/rotateMesh.C
+++ b/applications/utilities/mesh/manipulation/rotateMesh/rotateMesh.C
@@ -24,6 +24,9 @@ License
Application
rotateMesh
+Group
+ grpMeshManipulationUtilities
+
Description
Rotates the mesh and fields from the direction n1 to direction n2.
diff --git a/applications/utilities/mesh/manipulation/setSet/setSet.C b/applications/utilities/mesh/manipulation/setSet/setSet.C
index 1cd3ad6958..4919e21d70 100644
--- a/applications/utilities/mesh/manipulation/setSet/setSet.C
+++ b/applications/utilities/mesh/manipulation/setSet/setSet.C
@@ -24,6 +24,9 @@ License
Application
setSet
+Group
+ grpMeshManipulationUtilities
+
Description
Manipulate a cell/face/point/ set or zone interactively.
diff --git a/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C b/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C
index 8b23cfe5cd..d855e98ca1 100644
--- a/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C
+++ b/applications/utilities/mesh/manipulation/setsToZones/setsToZones.C
@@ -24,6 +24,9 @@ License
Application
setsToZones
+Group
+ grpMeshManipulationUtilities
+
Description
Add pointZones/faceZones/cellZones to the mesh from similar named
pointSets/faceSets/cellSets.
diff --git a/applications/utilities/mesh/manipulation/singleCellMesh/singleCellMesh.C b/applications/utilities/mesh/manipulation/singleCellMesh/singleCellMesh.C
index 7ce51edf61..e015102ab1 100644
--- a/applications/utilities/mesh/manipulation/singleCellMesh/singleCellMesh.C
+++ b/applications/utilities/mesh/manipulation/singleCellMesh/singleCellMesh.C
@@ -24,6 +24,9 @@ License
Application
singleCellMesh
+Group
+ grpMeshManipulationUtilities
+
Description
Reads all fields and maps them to a mesh with all internal faces removed
(singleCellFvMesh) which gets written to region "singleCell".
diff --git a/applications/utilities/mesh/manipulation/splitMesh/splitMesh.C b/applications/utilities/mesh/manipulation/splitMesh/splitMesh.C
index 5cac0dad7d..09a3d25d59 100644
--- a/applications/utilities/mesh/manipulation/splitMesh/splitMesh.C
+++ b/applications/utilities/mesh/manipulation/splitMesh/splitMesh.C
@@ -24,6 +24,9 @@ License
Application
splitMesh
+Group
+ grpMeshManipulationUtilities
+
Description
Splits mesh by making internal faces external. Uses attachDetach.
diff --git a/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C b/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C
index 529153f812..a5789e7ebd 100644
--- a/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C
+++ b/applications/utilities/mesh/manipulation/splitMeshRegions/splitMeshRegions.C
@@ -24,6 +24,9 @@ License
Application
splitMeshRegions
+Group
+ grpMeshManipulationUtilities
+
Description
Splits mesh into multiple regions.
diff --git a/applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C b/applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C
index 1902f1543d..1718d725f9 100644
--- a/applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C
+++ b/applications/utilities/mesh/manipulation/stitchMesh/stitchMesh.C
@@ -24,6 +24,10 @@ License
Application
stitchMesh
+Group
+ grpMeshManipulationUtilities
+
+
Description
'Stitches' a mesh.
diff --git a/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C b/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C
index c158b74842..19489611c4 100644
--- a/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C
+++ b/applications/utilities/mesh/manipulation/subsetMesh/subsetMesh.C
@@ -24,6 +24,9 @@ License
Application
subsetMesh
+Group
+ grpMeshManipulationUtilities
+
Description
Selects a section of mesh based on a cellSet.
diff --git a/applications/utilities/mesh/manipulation/topoSet/topoSet.C b/applications/utilities/mesh/manipulation/topoSet/topoSet.C
index 8f368f1b3f..d5e5358bf5 100644
--- a/applications/utilities/mesh/manipulation/topoSet/topoSet.C
+++ b/applications/utilities/mesh/manipulation/topoSet/topoSet.C
@@ -24,6 +24,9 @@ License
Application
topoSet
+Group
+ grpMeshManipulationUtilities
+
Description
Operates on cellSets/faceSets/pointSets through a dictionary.
diff --git a/applications/utilities/mesh/manipulation/transformPoints/transformPoints.C b/applications/utilities/mesh/manipulation/transformPoints/transformPoints.C
index cfddb19c2e..eb13245ec3 100644
--- a/applications/utilities/mesh/manipulation/transformPoints/transformPoints.C
+++ b/applications/utilities/mesh/manipulation/transformPoints/transformPoints.C
@@ -24,6 +24,9 @@ License
Application
transformPoints
+Group
+ grpMeshManipulationUtilities
+
Description
Transforms the mesh points in the polyMesh directory according to the
translate, rotate and scale options.
diff --git a/applications/utilities/mesh/manipulation/zipUpMesh/zipUpMesh.C b/applications/utilities/mesh/manipulation/zipUpMesh/zipUpMesh.C
index f4df1dd062..4dbc6a4a75 100644
--- a/applications/utilities/mesh/manipulation/zipUpMesh/zipUpMesh.C
+++ b/applications/utilities/mesh/manipulation/zipUpMesh/zipUpMesh.C
@@ -24,6 +24,9 @@ License
Application
zipUpMesh
+Group
+ grpMeshManipulationUtilities
+
Description
Reads in a mesh with hanging vertices and zips up the cells to guarantee
that all polyhedral cells of valid shape are closed.
diff --git a/applications/utilities/miscellaneous/expandDictionary/expandDictionary.C b/applications/utilities/miscellaneous/expandDictionary/expandDictionary.C
index 1b8ecac86d..cdbd3c76a9 100644
--- a/applications/utilities/miscellaneous/expandDictionary/expandDictionary.C
+++ b/applications/utilities/miscellaneous/expandDictionary/expandDictionary.C
@@ -24,6 +24,9 @@ License
Application
expandDictionary
+Group
+ grpMiscUtilities
+
Description
Read the dictionary provided as an argument, expand the macros etc. and
write the resulting dictionary to standard output.
diff --git a/applications/utilities/miscellaneous/foamDebugSwitches/foamDebugSwitches.C b/applications/utilities/miscellaneous/foamDebugSwitches/foamDebugSwitches.C
index 1b5670fc83..c9ad6ca0a9 100644
--- a/applications/utilities/miscellaneous/foamDebugSwitches/foamDebugSwitches.C
+++ b/applications/utilities/miscellaneous/foamDebugSwitches/foamDebugSwitches.C
@@ -24,6 +24,9 @@ License
Application
foamDebugSwitches
+Group
+ grpMiscUtilities
+
Description
Write out all library debug switches.
diff --git a/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C b/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C
index 715af2481a..81971b85f5 100644
--- a/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C
+++ b/applications/utilities/miscellaneous/foamFormatConvert/foamFormatConvert.C
@@ -24,6 +24,9 @@ License
Application
foamFormatConvert
+Group
+ grpMiscUtilities
+
Description
Converts all IOobjects associated with a case into the format specified
in the controlDict.
diff --git a/applications/utilities/miscellaneous/foamHelp/foamHelp.C b/applications/utilities/miscellaneous/foamHelp/foamHelp.C
index 277b7a024a..d4d145ee21 100644
--- a/applications/utilities/miscellaneous/foamHelp/foamHelp.C
+++ b/applications/utilities/miscellaneous/foamHelp/foamHelp.C
@@ -24,6 +24,9 @@ License
Application
foamHelp
+Group
+ grpMiscUtilities
+
Description
Top level wrapper utility around foam help utilities
diff --git a/applications/utilities/miscellaneous/foamInfoExec/foamInfoExec.C b/applications/utilities/miscellaneous/foamInfoExec/foamInfoExec.C
index 74d9028c2b..3b336287f8 100644
--- a/applications/utilities/miscellaneous/foamInfoExec/foamInfoExec.C
+++ b/applications/utilities/miscellaneous/foamInfoExec/foamInfoExec.C
@@ -24,6 +24,9 @@ License
Application
foamInfoExec
+Group
+ grpMiscUtilities
+
Description
Interrogates a case and prints information to stdout.
diff --git a/applications/utilities/miscellaneous/patchSummary/patchSummary.C b/applications/utilities/miscellaneous/patchSummary/patchSummary.C
index 074774676a..2dc5cbcacd 100644
--- a/applications/utilities/miscellaneous/patchSummary/patchSummary.C
+++ b/applications/utilities/miscellaneous/patchSummary/patchSummary.C
@@ -24,6 +24,9 @@ License
Application
patchSummary
+Group
+ grpMiscUtilities
+
Description
Writes fields and boundary condition info for each patch at each requested
time instance.
diff --git a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C
index 06d35e8748..e5ea04995a 100644
--- a/applications/utilities/parallelProcessing/decomposePar/decomposePar.C
+++ b/applications/utilities/parallelProcessing/decomposePar/decomposePar.C
@@ -24,6 +24,9 @@ License
Application
decomposePar
+Group
+ grpParallelUtilities
+
Description
Automatically decomposes a mesh and fields of a case for parallel
execution of OpenFOAM.
diff --git a/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C b/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C
index 47fc4aacce..a561f05462 100644
--- a/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C
+++ b/applications/utilities/parallelProcessing/reconstructPar/reconstructPar.C
@@ -24,6 +24,9 @@ License
Application
reconstructPar
+Group
+ grpParallelUtilities
+
Description
Reconstructs fields of a case that is decomposed for parallel
execution of OpenFOAM.
diff --git a/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C b/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C
index a4ccd17bb1..182fb79f7f 100644
--- a/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C
+++ b/applications/utilities/parallelProcessing/reconstructParMesh/reconstructParMesh.C
@@ -24,6 +24,9 @@ License
Application
reconstructParMesh
+Group
+ grpParallelUtilities
+
Description
Reconstructs a mesh using geometric information only.
diff --git a/applications/utilities/parallelProcessing/redistributePar/redistributePar.C b/applications/utilities/parallelProcessing/redistributePar/redistributePar.C
index a02bf106a7..f950a4b1ad 100644
--- a/applications/utilities/parallelProcessing/redistributePar/redistributePar.C
+++ b/applications/utilities/parallelProcessing/redistributePar/redistributePar.C
@@ -24,6 +24,9 @@ License
Application
redistributePar
+Group
+ grpParallelUtilities
+
Description
Redistributes existing decomposed mesh and fields according to the current
settings in the decomposeParDict file.
diff --git a/applications/utilities/postProcessing/dataConversion/foamDataToFluent/foamDataToFluent.C b/applications/utilities/postProcessing/dataConversion/foamDataToFluent/foamDataToFluent.C
index 8427f9b1b4..a1eb5461b6 100644
--- a/applications/utilities/postProcessing/dataConversion/foamDataToFluent/foamDataToFluent.C
+++ b/applications/utilities/postProcessing/dataConversion/foamDataToFluent/foamDataToFluent.C
@@ -24,6 +24,9 @@ License
Application
foamDataToFluent
+Group
+ grpPostProcessingUtilities
+
Description
Translates OpenFOAM data to Fluent format.
diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C
index 234c9d85b3..16efc46ffd 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToEnsight/foamToEnsight.C
@@ -24,6 +24,9 @@ License
Application
foamToEnsight
+Group
+ grpPostProcessingUtilitie
+
Description
Translates OpenFOAM data to EnSight format.
diff --git a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
index 0a3cdf6509..1146926afe 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToEnsightParts/foamToEnsightParts.C
@@ -24,6 +24,9 @@ License
Application
foamToEnsightParts
+Group
+ grpPostProcessingUtilities
+
Description
Translates OpenFOAM data to Ensight format.
An Ensight part is created for each cellZone and patch.
diff --git a/applications/utilities/postProcessing/dataConversion/foamToGMV/foamToGMV.C b/applications/utilities/postProcessing/dataConversion/foamToGMV/foamToGMV.C
index 9014f10ffd..7c74c7e203 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToGMV/foamToGMV.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToGMV/foamToGMV.C
@@ -24,6 +24,9 @@ License
Application
foamToGMV
+Group
+ grpPostProcessingUtilities
+
Description
Translates foam output to GMV readable files.
diff --git a/applications/utilities/postProcessing/dataConversion/foamToTecplot360/foamToTecplot360.C b/applications/utilities/postProcessing/dataConversion/foamToTecplot360/foamToTecplot360.C
index 3cf58fde37..b834cca26a 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToTecplot360/foamToTecplot360.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToTecplot360/foamToTecplot360.C
@@ -24,6 +24,9 @@ License
Application
foamToTecplot360
+Group
+ grpPostProcessingUtilities
+
Description
Tecplot binary file format writer.
diff --git a/applications/utilities/postProcessing/dataConversion/foamToTetDualMesh/foamToTetDualMesh.C b/applications/utilities/postProcessing/dataConversion/foamToTetDualMesh/foamToTetDualMesh.C
index 6e50d70471..786a137a7d 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToTetDualMesh/foamToTetDualMesh.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToTetDualMesh/foamToTetDualMesh.C
@@ -24,6 +24,9 @@ License
Application
foamToTetDualMesh
+Group
+ grpPostProcessingUtilities
+
Description
Converts polyMesh results to tetDualMesh.
diff --git a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
index b4c26b21cf..46ec648fd5 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
+++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK.C
@@ -24,6 +24,9 @@ License
Application
foamToVTK
+Group
+ grpPostProcessingUtilities
+
Description
Legacy VTK file format writer.
diff --git a/applications/utilities/postProcessing/dataConversion/smapToFoam/smapToFoam.C b/applications/utilities/postProcessing/dataConversion/smapToFoam/smapToFoam.C
index 2b186d88ba..5cceb026f4 100644
--- a/applications/utilities/postProcessing/dataConversion/smapToFoam/smapToFoam.C
+++ b/applications/utilities/postProcessing/dataConversion/smapToFoam/smapToFoam.C
@@ -24,6 +24,9 @@ License
Application
smapToFoam
+Group
+ grpPostProcessingUtilities
+
Description
Translates a STAR-CD SMAP data file into OpenFOAM field format.
diff --git a/applications/utilities/postProcessing/foamCalc/foamCalcApp.C b/applications/utilities/postProcessing/foamCalc/foamCalcApp.C
index 0a24afc131..ecdb57f1cf 100644
--- a/applications/utilities/postProcessing/foamCalc/foamCalcApp.C
+++ b/applications/utilities/postProcessing/foamCalc/foamCalcApp.C
@@ -24,6 +24,9 @@ License
Application
foamCalc
+Group
+ grpPostProcessingUtilities
+
Description
Generic wrapper for calculating a quantity at each time.
diff --git a/applications/utilities/postProcessing/lagrangian/particleTracks/particleTracks.C b/applications/utilities/postProcessing/lagrangian/particleTracks/particleTracks.C
index d6dbcb41e4..3a570236a6 100644
--- a/applications/utilities/postProcessing/lagrangian/particleTracks/particleTracks.C
+++ b/applications/utilities/postProcessing/lagrangian/particleTracks/particleTracks.C
@@ -24,6 +24,9 @@ License
Application
particleTracks
+Group
+ grpPostProcessingUtilities
+
Description
Generates a VTK file of particle tracks for cases that were computed using
a tracked-parcel-type cloud.
diff --git a/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C
index 11f6bd116e..c306ed14ae 100644
--- a/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C
+++ b/applications/utilities/postProcessing/lagrangian/steadyParticleTracks/steadyParticleTracks.C
@@ -24,6 +24,10 @@ License
Application
steadyParticleTracks
+Group
+ grpPostProcessingUtilitie
+
+
Description
Generates a VTK file of particle tracks for cases that were computed using
a steady-state cloud
diff --git a/applications/utilities/postProcessing/miscellaneous/dsmcFieldsCalc/dsmcFieldsCalc.C b/applications/utilities/postProcessing/miscellaneous/dsmcFieldsCalc/dsmcFieldsCalc.C
index 5abf6253fe..c634412aa2 100644
--- a/applications/utilities/postProcessing/miscellaneous/dsmcFieldsCalc/dsmcFieldsCalc.C
+++ b/applications/utilities/postProcessing/miscellaneous/dsmcFieldsCalc/dsmcFieldsCalc.C
@@ -24,6 +24,9 @@ License
Application
dsmcFieldsCalc
+Group
+ grpPostProcessingUtilities
+
Description
Calculate intensive fields (U and T) from averaged extensive fields from a
DSMC calculation.
diff --git a/applications/utilities/postProcessing/miscellaneous/engineCompRatio/engineCompRatio.C b/applications/utilities/postProcessing/miscellaneous/engineCompRatio/engineCompRatio.C
index 42904e4c68..f5d2261bc5 100644
--- a/applications/utilities/postProcessing/miscellaneous/engineCompRatio/engineCompRatio.C
+++ b/applications/utilities/postProcessing/miscellaneous/engineCompRatio/engineCompRatio.C
@@ -24,6 +24,9 @@ License
Application
engineCompRatio
+Group
+ grpPostProcessingUtilities
+
Description
Calculate the geometric compression ratio.
@@ -83,7 +86,7 @@ int main(int argc, char *argv[])
Info<< "\nVmax = " << Vmax
<< ", Vmin = " << Vmin << nl
<< "Vmax/Vmin = " << Vmax/Vmin << endl;
-
+
Info<< "\nEnd\n" << endl;
return 0;
diff --git a/applications/utilities/postProcessing/miscellaneous/execFlowFunctionObjects/execFlowFunctionObjects.C b/applications/utilities/postProcessing/miscellaneous/execFlowFunctionObjects/execFlowFunctionObjects.C
index 2baabfa331..b0c422cc65 100644
--- a/applications/utilities/postProcessing/miscellaneous/execFlowFunctionObjects/execFlowFunctionObjects.C
+++ b/applications/utilities/postProcessing/miscellaneous/execFlowFunctionObjects/execFlowFunctionObjects.C
@@ -24,6 +24,9 @@ License
Application
execFlowFunctionObjects
+Group
+ grpPostProcessingUtilities
+
Description
Execute the set of functionObjects specified in the selected dictionary
(which defaults to system/controlDict) for the selected set of times.
diff --git a/applications/utilities/postProcessing/miscellaneous/foamListTimes/foamListTimes.C b/applications/utilities/postProcessing/miscellaneous/foamListTimes/foamListTimes.C
index 88be47e53d..553f9f7f52 100644
--- a/applications/utilities/postProcessing/miscellaneous/foamListTimes/foamListTimes.C
+++ b/applications/utilities/postProcessing/miscellaneous/foamListTimes/foamListTimes.C
@@ -24,6 +24,9 @@ License
Application
foamListTimes
+Group
+ grpPostProcessingUtilities
+
Description
List times using timeSelector.
diff --git a/applications/utilities/postProcessing/miscellaneous/pdfPlot/pdfPlot.C b/applications/utilities/postProcessing/miscellaneous/pdfPlot/pdfPlot.C
index ea9f4f03bb..57bcfa9510 100644
--- a/applications/utilities/postProcessing/miscellaneous/pdfPlot/pdfPlot.C
+++ b/applications/utilities/postProcessing/miscellaneous/pdfPlot/pdfPlot.C
@@ -24,6 +24,9 @@ License
Application
pdfPlot
+Group
+ grpPostProcessingUtilitie
+
Description
Generates a graph of a probability distribution function.
diff --git a/applications/utilities/postProcessing/miscellaneous/postChannel/postChannel.C b/applications/utilities/postProcessing/miscellaneous/postChannel/postChannel.C
index 93373ee6a9..7533203900 100644
--- a/applications/utilities/postProcessing/miscellaneous/postChannel/postChannel.C
+++ b/applications/utilities/postProcessing/miscellaneous/postChannel/postChannel.C
@@ -24,6 +24,9 @@ License
Application
postChannel
+Group
+ grpPostProcessingUtilities
+
Description
Post-processes data from channel flow calculations.
diff --git a/applications/utilities/postProcessing/miscellaneous/ptot/ptot.C b/applications/utilities/postProcessing/miscellaneous/ptot/ptot.C
index 0f47e54d6a..59f8c66ea4 100644
--- a/applications/utilities/postProcessing/miscellaneous/ptot/ptot.C
+++ b/applications/utilities/postProcessing/miscellaneous/ptot/ptot.C
@@ -24,6 +24,9 @@ License
Application
ptot
+Group
+ grpPostProcessingUtilities
+
Description
For each time: calculate the total pressure.
diff --git a/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C b/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C
index ea8fc4975d..37638d2c9f 100644
--- a/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C
+++ b/applications/utilities/postProcessing/miscellaneous/temporalInterpolate/temporalInterpolate.C
@@ -21,6 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see .
+Application
+ temporalInterpolate
+
+Group
+ grpPostProcessingUtilities
+
Description
Interpolate fields between time-steps e.g. for animation.
diff --git a/applications/utilities/postProcessing/miscellaneous/wdot/wdot.C b/applications/utilities/postProcessing/miscellaneous/wdot/wdot.C
index 873bb53a72..121c88aea5 100644
--- a/applications/utilities/postProcessing/miscellaneous/wdot/wdot.C
+++ b/applications/utilities/postProcessing/miscellaneous/wdot/wdot.C
@@ -24,6 +24,9 @@ License
Application
wdot
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and writes wdot for each time.
diff --git a/applications/utilities/postProcessing/miscellaneous/writeCellCentres/writeCellCentres.C b/applications/utilities/postProcessing/miscellaneous/writeCellCentres/writeCellCentres.C
index 0025015339..fe1a749749 100644
--- a/applications/utilities/postProcessing/miscellaneous/writeCellCentres/writeCellCentres.C
+++ b/applications/utilities/postProcessing/miscellaneous/writeCellCentres/writeCellCentres.C
@@ -21,6 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see .
+Application
+ writeCellCentres
+
+Group
+ grpPostProcessingUtilities
+
Description
Write the three components of the cell centres as volScalarFields so
they can be used in postprocessing in thresholding.
diff --git a/applications/utilities/postProcessing/noise/noise.C b/applications/utilities/postProcessing/noise/noise.C
index 43597560f0..1b0ca07fec 100644
--- a/applications/utilities/postProcessing/noise/noise.C
+++ b/applications/utilities/postProcessing/noise/noise.C
@@ -24,6 +24,9 @@ License
Application
noise
+Group
+ grpPostProcessingUtilities
+
Description
Utility to perform noise analysis of pressure data using the noiseFFT
library.
diff --git a/applications/utilities/postProcessing/patch/patchAverage/patchAverage.C b/applications/utilities/postProcessing/patch/patchAverage/patchAverage.C
index 53190221b7..4830e2d54e 100644
--- a/applications/utilities/postProcessing/patch/patchAverage/patchAverage.C
+++ b/applications/utilities/postProcessing/patch/patchAverage/patchAverage.C
@@ -24,6 +24,9 @@ License
Application
patchAverage
+Group
+ grpPostProcessingUtilities
+
Description
Calculates the average of the specified field over the specified patch.
diff --git a/applications/utilities/postProcessing/patch/patchIntegrate/patchIntegrate.C b/applications/utilities/postProcessing/patch/patchIntegrate/patchIntegrate.C
index e17f43cf29..f1a26f6504 100644
--- a/applications/utilities/postProcessing/patch/patchIntegrate/patchIntegrate.C
+++ b/applications/utilities/postProcessing/patch/patchIntegrate/patchIntegrate.C
@@ -24,6 +24,9 @@ License
Application
patchIntegrate
+Group
+ grpPostProcessingUtilities
+
Description
Calculates the integral of the specified field over the specified patch.
diff --git a/applications/utilities/postProcessing/sampling/probeLocations/probeLocations.C b/applications/utilities/postProcessing/sampling/probeLocations/probeLocations.C
index daf48a3f68..40ce8dc038 100644
--- a/applications/utilities/postProcessing/sampling/probeLocations/probeLocations.C
+++ b/applications/utilities/postProcessing/sampling/probeLocations/probeLocations.C
@@ -24,6 +24,9 @@ License
Application
probeLocations
+Group
+ grpPostProcessingUtilities
+
Description
Probe locations.
diff --git a/applications/utilities/postProcessing/sampling/sample/sample.C b/applications/utilities/postProcessing/sampling/sample/sample.C
index 59abc2e2f1..0f47b2bca8 100644
--- a/applications/utilities/postProcessing/sampling/sample/sample.C
+++ b/applications/utilities/postProcessing/sampling/sample/sample.C
@@ -24,6 +24,9 @@ License
Application
sample
+Group
+ grpPostProcessingUtilities
+
Description
Sample field data with a choice of interpolation schemes, sampling options
and write formats.
diff --git a/applications/utilities/postProcessing/scalarField/pPrime2/pPrime2.C b/applications/utilities/postProcessing/scalarField/pPrime2/pPrime2.C
index 46b11f79f2..e24c4b8542 100644
--- a/applications/utilities/postProcessing/scalarField/pPrime2/pPrime2.C
+++ b/applications/utilities/postProcessing/scalarField/pPrime2/pPrime2.C
@@ -24,6 +24,9 @@ License
Application
pPrime2
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and writes the scalar field of pPrime2 (sqr(p - pMean)) at
each time
diff --git a/applications/utilities/postProcessing/turbulence/R/R.C b/applications/utilities/postProcessing/turbulence/R/R.C
index 2d7bab324c..d75ece4737 100644
--- a/applications/utilities/postProcessing/turbulence/R/R.C
+++ b/applications/utilities/postProcessing/turbulence/R/R.C
@@ -24,6 +24,9 @@ License
Application
R
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and writes the Reynolds stress R for the current time step.
diff --git a/applications/utilities/postProcessing/turbulence/createTurbulenceFields/createTurbulenceFields.C b/applications/utilities/postProcessing/turbulence/createTurbulenceFields/createTurbulenceFields.C
index 06ceb70f49..64754db868 100644
--- a/applications/utilities/postProcessing/turbulence/createTurbulenceFields/createTurbulenceFields.C
+++ b/applications/utilities/postProcessing/turbulence/createTurbulenceFields/createTurbulenceFields.C
@@ -24,6 +24,9 @@ License
Application
createTurbulenceFields
+Group
+ grpPostProcessingUtilities
+
Description
Creates a full set of turbulence fields.
diff --git a/applications/utilities/postProcessing/velocityField/Co/Co.C b/applications/utilities/postProcessing/velocityField/Co/Co.C
index 1e88dd92d3..96e6a2107f 100644
--- a/applications/utilities/postProcessing/velocityField/Co/Co.C
+++ b/applications/utilities/postProcessing/velocityField/Co/Co.C
@@ -24,6 +24,9 @@ License
Application
Co
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and writes the Co number as a volScalarField obtained
from field phi.
diff --git a/applications/utilities/postProcessing/velocityField/Lambda2/Lambda2.C b/applications/utilities/postProcessing/velocityField/Lambda2/Lambda2.C
index 3208b5beeb..d545ae0b95 100644
--- a/applications/utilities/postProcessing/velocityField/Lambda2/Lambda2.C
+++ b/applications/utilities/postProcessing/velocityField/Lambda2/Lambda2.C
@@ -24,6 +24,9 @@ License
Application
Lambda2
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and writes the second largest eigenvalue of the sum of the
square of the symmetrical and anti-symmetrical parts of the velocity
diff --git a/applications/utilities/postProcessing/velocityField/Mach/Mach.C b/applications/utilities/postProcessing/velocityField/Mach/Mach.C
index 9914a3a098..9fdd797c92 100644
--- a/applications/utilities/postProcessing/velocityField/Mach/Mach.C
+++ b/applications/utilities/postProcessing/velocityField/Mach/Mach.C
@@ -24,6 +24,9 @@ License
Application
Mach
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and optionally writes the local Mach number from the velocity
field U at each time.
diff --git a/applications/utilities/postProcessing/velocityField/Pe/Pe.C b/applications/utilities/postProcessing/velocityField/Pe/Pe.C
index 69c4964429..79e9c5bdb2 100644
--- a/applications/utilities/postProcessing/velocityField/Pe/Pe.C
+++ b/applications/utilities/postProcessing/velocityField/Pe/Pe.C
@@ -24,6 +24,9 @@ License
Application
Pe
+Group
+ grpPostProcessingUtilities
+
Description
Calculates the Peclet number Pe from the flux phi and writes the maximum
value, the surfaceScalarField Pef and volScalarField Pe.
diff --git a/applications/utilities/postProcessing/velocityField/Q/Q.C b/applications/utilities/postProcessing/velocityField/Q/Q.C
index b54a4ce399..04f1b7c202 100644
--- a/applications/utilities/postProcessing/velocityField/Q/Q.C
+++ b/applications/utilities/postProcessing/velocityField/Q/Q.C
@@ -24,6 +24,9 @@ License
Application
Q
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and writes the second invariant of the velocity gradient tensor.
diff --git a/applications/utilities/postProcessing/velocityField/enstrophy/enstrophy.C b/applications/utilities/postProcessing/velocityField/enstrophy/enstrophy.C
index ea681d69d9..971ea8d73f 100644
--- a/applications/utilities/postProcessing/velocityField/enstrophy/enstrophy.C
+++ b/applications/utilities/postProcessing/velocityField/enstrophy/enstrophy.C
@@ -24,6 +24,9 @@ License
Application
enstrophy
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and writes the enstrophy of the velocity field U.
diff --git a/applications/utilities/postProcessing/velocityField/flowType/flowType.C b/applications/utilities/postProcessing/velocityField/flowType/flowType.C
index 309393d19d..d26668d52e 100644
--- a/applications/utilities/postProcessing/velocityField/flowType/flowType.C
+++ b/applications/utilities/postProcessing/velocityField/flowType/flowType.C
@@ -24,6 +24,9 @@ License
Application
flowType
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and writes the flowType of velocity field U.
diff --git a/applications/utilities/postProcessing/velocityField/streamFunction/streamFunction.C b/applications/utilities/postProcessing/velocityField/streamFunction/streamFunction.C
index 120c197a91..341832e655 100644
--- a/applications/utilities/postProcessing/velocityField/streamFunction/streamFunction.C
+++ b/applications/utilities/postProcessing/velocityField/streamFunction/streamFunction.C
@@ -24,6 +24,9 @@ License
Application
streamFunction
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and writes the stream function of velocity field U at each
time.
diff --git a/applications/utilities/postProcessing/velocityField/uprime/uprime.C b/applications/utilities/postProcessing/velocityField/uprime/uprime.C
index 8b1b9f15b0..2ec5c44427 100644
--- a/applications/utilities/postProcessing/velocityField/uprime/uprime.C
+++ b/applications/utilities/postProcessing/velocityField/uprime/uprime.C
@@ -24,6 +24,9 @@ License
Application
uprime
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and writes the scalar field of uprime (sqrt(2/3 k)).
diff --git a/applications/utilities/postProcessing/velocityField/vorticity/vorticity.C b/applications/utilities/postProcessing/velocityField/vorticity/vorticity.C
index 7662dff311..efc95a8bd3 100644
--- a/applications/utilities/postProcessing/velocityField/vorticity/vorticity.C
+++ b/applications/utilities/postProcessing/velocityField/vorticity/vorticity.C
@@ -24,6 +24,9 @@ License
Application
vorticity
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and writes the vorticity of velocity field U.
diff --git a/applications/utilities/postProcessing/wall/wallGradU/wallGradU.C b/applications/utilities/postProcessing/wall/wallGradU/wallGradU.C
index 650d075ea7..9d5b29f498 100644
--- a/applications/utilities/postProcessing/wall/wallGradU/wallGradU.C
+++ b/applications/utilities/postProcessing/wall/wallGradU/wallGradU.C
@@ -24,6 +24,9 @@ License
Application
wallGradU
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and writes the gradient of U at the wall.
diff --git a/applications/utilities/postProcessing/wall/wallHeatFlux/wallHeatFlux.C b/applications/utilities/postProcessing/wall/wallHeatFlux/wallHeatFlux.C
index d1c37e70cc..00a2211d2c 100644
--- a/applications/utilities/postProcessing/wall/wallHeatFlux/wallHeatFlux.C
+++ b/applications/utilities/postProcessing/wall/wallHeatFlux/wallHeatFlux.C
@@ -24,6 +24,9 @@ License
Application
wallHeatFlux
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and writes the heat flux for all patches as the boundary field
of a volScalarField and also prints the integrated flux for all wall
diff --git a/applications/utilities/postProcessing/wall/wallShearStress/wallShearStress.C b/applications/utilities/postProcessing/wall/wallShearStress/wallShearStress.C
index 6d8b48dff6..025f3a5a27 100644
--- a/applications/utilities/postProcessing/wall/wallShearStress/wallShearStress.C
+++ b/applications/utilities/postProcessing/wall/wallShearStress/wallShearStress.C
@@ -24,6 +24,9 @@ License
Application
wallShearStress
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and reports the turbulent wall shear stress for all patches,
for the specified times.
diff --git a/applications/utilities/postProcessing/wall/yPlus/yPlus.C b/applications/utilities/postProcessing/wall/yPlus/yPlus.C
index 04d80ab6c0..492cd57fd7 100644
--- a/applications/utilities/postProcessing/wall/yPlus/yPlus.C
+++ b/applications/utilities/postProcessing/wall/yPlus/yPlus.C
@@ -24,6 +24,9 @@ License
Application
yPlus
+Group
+ grpPostProcessingUtilities
+
Description
Calculates and reports yPlus for the near-wall cells of all wall patches,
for the specified times for laminar, LES and RAS.
diff --git a/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C b/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C
index 7b597bd777..3783227fa3 100644
--- a/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C
+++ b/applications/utilities/preProcessing/applyBoundaryLayer/applyBoundaryLayer.C
@@ -24,6 +24,9 @@ License
Application
applyBoundaryLayer
+Group
+ grpPreProcessingUtilities
+
Description
Apply a simplified boundary-layer model to the velocity and
turbulence fields based on the 1/7th power-law.
diff --git a/applications/utilities/preProcessing/boxTurb/boxTurb.C b/applications/utilities/preProcessing/boxTurb/boxTurb.C
index 4ed0356e1c..56cfb42d32 100644
--- a/applications/utilities/preProcessing/boxTurb/boxTurb.C
+++ b/applications/utilities/preProcessing/boxTurb/boxTurb.C
@@ -24,6 +24,9 @@ License
Application
boxTurb
+Group
+ grpPreProcessingUtilities
+
Description
Makes a box of turbulence which conforms to a given energy
spectrum and is divergence free.
diff --git a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
index adacf92248..30f0a480fc 100644
--- a/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
+++ b/applications/utilities/preProcessing/changeDictionary/changeDictionary.C
@@ -24,6 +24,9 @@ License
Application
changeDictionary
+Group
+ grpPreProcessingUtilities
+
Description
Utility to change dictionary entries, e.g. can be used to change the patch
type in the field and polyMesh/boundary files.
diff --git a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C
index 6a8b78c683..bcb6fa7860 100644
--- a/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C
+++ b/applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C
@@ -24,6 +24,9 @@ License
Application
createExternalCoupledPatchGeometry.
+Group
+ grpPreProcessingUtilities
+
Description
Application to generate the patch geometry (points and faces) for use
with the externalCoupled functionObject.
diff --git a/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C b/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C
index e7da840547..68ef4c3d69 100644
--- a/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C
+++ b/applications/utilities/preProcessing/createZeroDirectory/createZeroDirectory.C
@@ -24,6 +24,9 @@ License
Application
createZeroDirectory
+Group
+ grpPreProcessingUtilities
+
Description
Creates a zero directory with fields appropriate for the chosen solver and
turbulence model. Operates on both single and multi-region cases.
diff --git a/applications/utilities/preProcessing/dsmcInitialise/dsmcInitialise.C b/applications/utilities/preProcessing/dsmcInitialise/dsmcInitialise.C
index e873f10d77..f2a2574e9d 100644
--- a/applications/utilities/preProcessing/dsmcInitialise/dsmcInitialise.C
+++ b/applications/utilities/preProcessing/dsmcInitialise/dsmcInitialise.C
@@ -24,6 +24,9 @@ License
Application
dsmcInitialise
+Group
+ grpPreProcessingUtilities
+
Description
Initialise a case for dsmcFoam by reading the initialisation dictionary
system/dsmcInitialise.
diff --git a/applications/utilities/preProcessing/engineSwirl/engineSwirl.C b/applications/utilities/preProcessing/engineSwirl/engineSwirl.C
index 4652cb2afd..f59d166d68 100644
--- a/applications/utilities/preProcessing/engineSwirl/engineSwirl.C
+++ b/applications/utilities/preProcessing/engineSwirl/engineSwirl.C
@@ -24,6 +24,9 @@ License
Application
engineSwirl
+Group
+ grpPreProcessingUtilities
+
Description
Generates a swirling flow for engine calulations.
diff --git a/applications/utilities/preProcessing/faceAgglomerate/faceAgglomerate.C b/applications/utilities/preProcessing/faceAgglomerate/faceAgglomerate.C
index 163c9fa8c1..808e9a7cf8 100644
--- a/applications/utilities/preProcessing/faceAgglomerate/faceAgglomerate.C
+++ b/applications/utilities/preProcessing/faceAgglomerate/faceAgglomerate.C
@@ -24,6 +24,9 @@ License
Application
faceAgglomerate
+Group
+ grpPreProcessingUtilities
+
Description
Agglomerate boundary faces using the pairPatchAgglomeration algorithm.
diff --git a/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C b/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C
index 7f2746338c..66e2f4f651 100644
--- a/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C
+++ b/applications/utilities/preProcessing/foamUpgradeCyclics/foamUpgradeCyclics.C
@@ -24,6 +24,9 @@ License
Application
foamUpgradeCyclics
+Group
+ grpPreProcessingUtilities
+
Description
Tool to upgrade mesh and fields for split cyclics.
diff --git a/applications/utilities/preProcessing/mapFields/mapFields.C b/applications/utilities/preProcessing/mapFields/mapFields.C
index 6e3f4ef06b..5eceb0c2b5 100644
--- a/applications/utilities/preProcessing/mapFields/mapFields.C
+++ b/applications/utilities/preProcessing/mapFields/mapFields.C
@@ -24,6 +24,9 @@ License
Application
mapFields
+Group
+ grpPreProcessingUtilities
+
Description
Maps volume fields from one mesh to another, reading and
interpolating all fields present in the time directory of both cases.
diff --git a/applications/utilities/preProcessing/mapFieldsPar/mapFieldsPar.C b/applications/utilities/preProcessing/mapFieldsPar/mapFieldsPar.C
index fdfdaad1da..2043644e20 100644
--- a/applications/utilities/preProcessing/mapFieldsPar/mapFieldsPar.C
+++ b/applications/utilities/preProcessing/mapFieldsPar/mapFieldsPar.C
@@ -24,6 +24,9 @@ License
Application
mapFieldsPar
+Group
+ grpPreProcessingUtilities
+
Description
Maps volume fields from one mesh to another, reading and
interpolating all fields present in the time directory of both cases.
diff --git a/applications/utilities/preProcessing/mdInitialise/mdInitialise.C b/applications/utilities/preProcessing/mdInitialise/mdInitialise.C
index 7af246cb25..a3127cdc1f 100644
--- a/applications/utilities/preProcessing/mdInitialise/mdInitialise.C
+++ b/applications/utilities/preProcessing/mdInitialise/mdInitialise.C
@@ -21,6 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see .
+Application
+ mdInitialise
+
+Group
+ grpPreProcessingUtilities
+
Description
Initialises fields for a molecular dynamics (MD) simulation.
diff --git a/applications/utilities/preProcessing/setFields/setFields.C b/applications/utilities/preProcessing/setFields/setFields.C
index 7d22cec68b..9517689240 100644
--- a/applications/utilities/preProcessing/setFields/setFields.C
+++ b/applications/utilities/preProcessing/setFields/setFields.C
@@ -21,6 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see .
+Application
+ setFields
+
+Group
+ grpPreProcessingUtilities
+
Description
Set values on a selected set of cells/patchfaces through a dictionary.
diff --git a/applications/utilities/preProcessing/viewFactorsGen/viewFactorsGen.C b/applications/utilities/preProcessing/viewFactorsGen/viewFactorsGen.C
index 02f0c5d9ad..11a8becd5a 100644
--- a/applications/utilities/preProcessing/viewFactorsGen/viewFactorsGen.C
+++ b/applications/utilities/preProcessing/viewFactorsGen/viewFactorsGen.C
@@ -24,6 +24,9 @@ License
Application
viewFactorsGen
+Group
+ grpPreProcessingUtilities
+
Description
View factors are calculated based on a face agglomeration array
(finalAgglom generated by faceAgglomerate utility).
diff --git a/applications/utilities/preProcessing/wallFunctionTable/wallFunctionTableApp.C b/applications/utilities/preProcessing/wallFunctionTable/wallFunctionTableApp.C
index eca14ca40c..6e2da72660 100644
--- a/applications/utilities/preProcessing/wallFunctionTable/wallFunctionTableApp.C
+++ b/applications/utilities/preProcessing/wallFunctionTable/wallFunctionTableApp.C
@@ -24,6 +24,9 @@ License
Application
wallFunctionTable
+Group
+ grpPreProcessingUtilities
+
Description
Generates a table suitable for use by tabulated wall functions.
diff --git a/applications/utilities/surface/surfaceAdd/surfaceAdd.C b/applications/utilities/surface/surfaceAdd/surfaceAdd.C
index 9ac5bbbb94..5072534076 100644
--- a/applications/utilities/surface/surfaceAdd/surfaceAdd.C
+++ b/applications/utilities/surface/surfaceAdd/surfaceAdd.C
@@ -24,6 +24,9 @@ License
Application
surfaceAdd
+Group
+ grpSurfaceUtilities
+
Description
Add two surfaces. Does geometric merge on points. Does not check for
overlapping/intersecting triangles.
diff --git a/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C b/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C
index f8c094c4bd..c24520790b 100644
--- a/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C
+++ b/applications/utilities/surface/surfaceBooleanFeatures/surfaceBooleanFeatures.C
@@ -24,6 +24,9 @@ License
Application
surfaceBooleanFeatures
+Group
+ grpSurfaceUtilities
+
Description
Generates the extendedFeatureEdgeMesh for the interface between a boolean
operation on two surfaces.
diff --git a/applications/utilities/surface/surfaceCheck/surfaceCheck.C b/applications/utilities/surface/surfaceCheck/surfaceCheck.C
index 16989e4771..7b223a36d9 100644
--- a/applications/utilities/surface/surfaceCheck/surfaceCheck.C
+++ b/applications/utilities/surface/surfaceCheck/surfaceCheck.C
@@ -24,6 +24,9 @@ License
Application
surfaceCheck
+Group
+ grpSurfaceUtilities
+
Description
Checks geometric and topological quality of a surface.
diff --git a/applications/utilities/surface/surfaceClean/surfaceClean.C b/applications/utilities/surface/surfaceClean/surfaceClean.C
index eecdbb5155..6c55ce14d5 100644
--- a/applications/utilities/surface/surfaceClean/surfaceClean.C
+++ b/applications/utilities/surface/surfaceClean/surfaceClean.C
@@ -24,6 +24,9 @@ License
Application
surfaceClean
+Group
+ grpSurfaceUtilities
+
Description
Utility to clean surfaces.
diff --git a/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C b/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C
index fdbeca8e28..24284ec5d4 100644
--- a/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C
+++ b/applications/utilities/surface/surfaceCoarsen/surfaceCoarsen.C
@@ -24,6 +24,9 @@ License
Application
surfaceCoarsen
+Group
+ grpSurfaceUtilities
+
Description
Surface coarsening using `bunnylod'
diff --git a/applications/utilities/surface/surfaceConvert/surfaceConvert.C b/applications/utilities/surface/surfaceConvert/surfaceConvert.C
index 1d79b08059..c1f637c3e2 100644
--- a/applications/utilities/surface/surfaceConvert/surfaceConvert.C
+++ b/applications/utilities/surface/surfaceConvert/surfaceConvert.C
@@ -24,6 +24,9 @@ License
Application
surfaceConvert
+Group
+ grpSurfaceUtilities
+
Description
Converts from one surface mesh format to another.
diff --git a/applications/utilities/surface/surfaceFeatureConvert/surfaceFeatureConvert.C b/applications/utilities/surface/surfaceFeatureConvert/surfaceFeatureConvert.C
index 1263b7813a..bf9f1040ca 100644
--- a/applications/utilities/surface/surfaceFeatureConvert/surfaceFeatureConvert.C
+++ b/applications/utilities/surface/surfaceFeatureConvert/surfaceFeatureConvert.C
@@ -24,6 +24,9 @@ License
Application
surfaceFeatureConvert
+Group
+ grpSurfaceUtilities
+
Description
Convert between edgeMesh formats.
diff --git a/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C b/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C
index 5c81c5699c..9c9db1babf 100644
--- a/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C
+++ b/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C
@@ -24,6 +24,9 @@ License
Application
surfaceFeatureExtract
+Group
+ grpSurfaceUtilities
+
Description
Extracts and writes surface features to file. All but the basic feature
extraction is WIP.
diff --git a/applications/utilities/surface/surfaceFind/surfaceFind.C b/applications/utilities/surface/surfaceFind/surfaceFind.C
index b002e13d31..279411cc7e 100644
--- a/applications/utilities/surface/surfaceFind/surfaceFind.C
+++ b/applications/utilities/surface/surfaceFind/surfaceFind.C
@@ -24,6 +24,9 @@ License
Application
surfaceFind
+Group
+ grpSurfaceUtilities
+
Description
Finds nearest face and vertex.
diff --git a/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C b/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C
index b7c5ca03b2..64c0f5f5fa 100644
--- a/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C
+++ b/applications/utilities/surface/surfaceHookUp/surfaceHookUp.C
@@ -24,6 +24,9 @@ License
Application
surfaceHookUp
+Group
+ grpSurfaceUtilities
+
Description
Find close open edges and stitches the surface along them
diff --git a/applications/utilities/surface/surfaceInertia/surfaceInertia.C b/applications/utilities/surface/surfaceInertia/surfaceInertia.C
index 3c83296697..e566d09ca2 100644
--- a/applications/utilities/surface/surfaceInertia/surfaceInertia.C
+++ b/applications/utilities/surface/surfaceInertia/surfaceInertia.C
@@ -24,6 +24,9 @@ License
Application
surfaceInertia
+Group
+ grpSurfaceUtilities
+
Description
Calculates the inertia tensor, principal axes and moments of a
command line specified triSurface.
diff --git a/applications/utilities/surface/surfaceInflate/surfaceInflate.C b/applications/utilities/surface/surfaceInflate/surfaceInflate.C
index e30ff5fc55..c8edf91962 100644
--- a/applications/utilities/surface/surfaceInflate/surfaceInflate.C
+++ b/applications/utilities/surface/surfaceInflate/surfaceInflate.C
@@ -24,6 +24,9 @@ License
Application
surfaceInflate
+Group
+ grpSurfaceUtilities
+
Description
Inflates surface. WIP. Checks for overlaps and locally lowers
inflation distance
diff --git a/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C b/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C
index 0352ce0eef..e7006475c7 100644
--- a/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C
+++ b/applications/utilities/surface/surfaceLambdaMuSmooth/surfaceLambdaMuSmooth.C
@@ -24,6 +24,9 @@ License
Application
surfaceLambdaMuSmooth
+Group
+ grpSurfaceUtilities
+
Description
Smooths a surface using lambda/mu smoothing.
diff --git a/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C b/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
index e34cf579b3..c35819d008 100644
--- a/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
+++ b/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
@@ -24,6 +24,9 @@ License
Application
surfaceMeshConvert
+Group
+ grpSurfaceUtilities
+
Description
Converts between surface formats with optional scaling or
transformations (rotate/translate) on a coordinateSystem.
diff --git a/applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C b/applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C
index 12bd9f32e2..dfd2d5f2cc 100644
--- a/applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C
+++ b/applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C
@@ -24,6 +24,9 @@ License
Application
surfaceMeshConvertTesting
+Group
+ grpSurfaceUtilities
+
Description
Converts from one surface mesh format to another, but primarily
used for testing functionality.
diff --git a/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C b/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C
index d9c98b3e74..11accd59cb 100644
--- a/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C
+++ b/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C
@@ -24,6 +24,9 @@ License
Application
surfaceMeshExport
+Group
+ grpSurfaceUtilities
+
Description
Export from surfMesh to various third-party surface formats with
optional scaling or transformations (rotate/translate) on a
diff --git a/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C b/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C
index 708d5ab5ba..5534398026 100644
--- a/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C
+++ b/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C
@@ -24,6 +24,9 @@ License
Application
surfaceMeshImport
+Group
+ grpSurfaceUtilities
+
Description
Import from various third-party surface formats into surfMesh
with optional scaling or transformations (rotate/translate)
diff --git a/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C b/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C
index 0129154b84..3ea27c4f8b 100644
--- a/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C
+++ b/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C
@@ -24,6 +24,9 @@ License
Application
surfaceMeshInfo
+Group
+ grpSurfaceUtilities
+
Description
Miscellaneous information about surface meshes.
diff --git a/applications/utilities/surface/surfaceMeshTriangulate/surfaceMeshTriangulate.C b/applications/utilities/surface/surfaceMeshTriangulate/surfaceMeshTriangulate.C
index 580411eda6..2a42bd8ce0 100644
--- a/applications/utilities/surface/surfaceMeshTriangulate/surfaceMeshTriangulate.C
+++ b/applications/utilities/surface/surfaceMeshTriangulate/surfaceMeshTriangulate.C
@@ -24,6 +24,9 @@ License
Application
surfaceMeshTriangulate
+Group
+ grpSurfaceUtilities
+
Description
Extracts surface from a polyMesh. Depending on output surface format
triangulates faces.
diff --git a/applications/utilities/surface/surfaceOrient/surfaceOrient.C b/applications/utilities/surface/surfaceOrient/surfaceOrient.C
index 29b60c7916..4dad7dd570 100644
--- a/applications/utilities/surface/surfaceOrient/surfaceOrient.C
+++ b/applications/utilities/surface/surfaceOrient/surfaceOrient.C
@@ -24,6 +24,9 @@ License
Application
surfaceOrient
+Group
+ grpSurfaceUtilities
+
Description
Set normal consistent with respect to a user provided 'outside' point.
If the -inside option is used the point is considered inside.
diff --git a/applications/utilities/surface/surfacePatch/surfacePatch.C b/applications/utilities/surface/surfacePatch/surfacePatch.C
index 3df36f6ec6..474a820623 100644
--- a/applications/utilities/surface/surfacePatch/surfacePatch.C
+++ b/applications/utilities/surface/surfacePatch/surfacePatch.C
@@ -24,6 +24,9 @@ License
Application
surfacePatch
+Group
+ grpSurfaceUtilities
+
Description
Patches (regionises) a surface using a user-selectable method.
diff --git a/applications/utilities/surface/surfacePointMerge/surfacePointMerge.C b/applications/utilities/surface/surfacePointMerge/surfacePointMerge.C
index 585072d7c0..830e861654 100644
--- a/applications/utilities/surface/surfacePointMerge/surfacePointMerge.C
+++ b/applications/utilities/surface/surfacePointMerge/surfacePointMerge.C
@@ -24,6 +24,9 @@ License
Application
surfacePointMerge
+Group
+ grpSurfaceUtilities
+
Description
Merges points on surface if they are within absolute distance.
Since absolute distance use with care!
diff --git a/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C b/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C
index c94e56ac4c..d6bb838e1b 100644
--- a/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C
+++ b/applications/utilities/surface/surfaceRedistributePar/surfaceRedistributePar.C
@@ -24,6 +24,9 @@ License
Application
surfaceRedistributePar
+Group
+ grpSurfaceUtilities
+
Description
(Re)distribution of triSurface. Either takes an undecomposed surface
or an already decomposed surface and redistributes it so that each
diff --git a/applications/utilities/surface/surfaceRefineRedGreen/surfaceRefineRedGreen.C b/applications/utilities/surface/surfaceRefineRedGreen/surfaceRefineRedGreen.C
index d5d1dccd20..2dbea9fce6 100644
--- a/applications/utilities/surface/surfaceRefineRedGreen/surfaceRefineRedGreen.C
+++ b/applications/utilities/surface/surfaceRefineRedGreen/surfaceRefineRedGreen.C
@@ -24,6 +24,9 @@ License
Application
surfaceRefineRedGreen
+Group
+ grpSurfaceUtilities
+
Description
Refine by splitting all three edges of triangle ('red' refinement).
diff --git a/applications/utilities/surface/surfaceSplitByPatch/surfaceSplitByPatch.C b/applications/utilities/surface/surfaceSplitByPatch/surfaceSplitByPatch.C
index 2825822607..ae79b9573c 100644
--- a/applications/utilities/surface/surfaceSplitByPatch/surfaceSplitByPatch.C
+++ b/applications/utilities/surface/surfaceSplitByPatch/surfaceSplitByPatch.C
@@ -24,6 +24,9 @@ License
Application
surfaceSplitByPatch
+Group
+ grpSurfaceUtilities
+
Description
Writes regions of triSurface to separate files.
diff --git a/applications/utilities/surface/surfaceSplitByTopology/surfaceSplitByTopology.C b/applications/utilities/surface/surfaceSplitByTopology/surfaceSplitByTopology.C
index c90dee56e9..d45ce83154 100644
--- a/applications/utilities/surface/surfaceSplitByTopology/surfaceSplitByTopology.C
+++ b/applications/utilities/surface/surfaceSplitByTopology/surfaceSplitByTopology.C
@@ -21,6 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see .
+Application
+ surfaceSplitByTopology
+
+Group
+ grpSurfaceUtilities
+
Description
Strips any baffle parts of a surface.
diff --git a/applications/utilities/surface/surfaceSplitNonManifolds/surfaceSplitNonManifolds.C b/applications/utilities/surface/surfaceSplitNonManifolds/surfaceSplitNonManifolds.C
index b490fe726a..b8a869ef76 100644
--- a/applications/utilities/surface/surfaceSplitNonManifolds/surfaceSplitNonManifolds.C
+++ b/applications/utilities/surface/surfaceSplitNonManifolds/surfaceSplitNonManifolds.C
@@ -24,6 +24,9 @@ License
Application
surfaceSplitNonManifolds
+Group
+ grpSurfaceUtilities
+
Description
Takes multiply connected surface and tries to split surface at
multiply connected edges by duplicating points.
diff --git a/applications/utilities/surface/surfaceSubset/surfaceSubset.C b/applications/utilities/surface/surfaceSubset/surfaceSubset.C
index 0a77fde05f..70932a615c 100644
--- a/applications/utilities/surface/surfaceSubset/surfaceSubset.C
+++ b/applications/utilities/surface/surfaceSubset/surfaceSubset.C
@@ -24,6 +24,9 @@ License
Application
surfaceSubset
+Group
+ grpSurfaceUtilities
+
Description
A surface analysis tool which sub-sets the triSurface
to choose only a part of interest. Based on subsetMesh.
diff --git a/applications/utilities/surface/surfaceToPatch/surfaceToPatch.C b/applications/utilities/surface/surfaceToPatch/surfaceToPatch.C
index bbcf96b96e..f450b6d453 100644
--- a/applications/utilities/surface/surfaceToPatch/surfaceToPatch.C
+++ b/applications/utilities/surface/surfaceToPatch/surfaceToPatch.C
@@ -24,6 +24,9 @@ License
Application
surfaceToPatch
+Group
+ grpSurfaceUtilities
+
Description
Reads surface and applies surface regioning to a mesh. Uses boundaryMesh
to do the hard work.
diff --git a/applications/utilities/surface/surfaceTransformPoints/surfaceTransformPoints.C b/applications/utilities/surface/surfaceTransformPoints/surfaceTransformPoints.C
index 3dcc86b9a9..2f1f7699ca 100644
--- a/applications/utilities/surface/surfaceTransformPoints/surfaceTransformPoints.C
+++ b/applications/utilities/surface/surfaceTransformPoints/surfaceTransformPoints.C
@@ -24,6 +24,9 @@ License
Application
surfaceTransformPoints
+Group
+ grpSurfaceUtilities
+
Description
Transform (scale/rotate) a surface.
Like transformPoints but for surfaces.
diff --git a/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C b/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C
index 2e41a7870e..7ed0fe3f46 100644
--- a/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C
+++ b/applications/utilities/thermophysical/adiabaticFlameT/adiabaticFlameT.C
@@ -24,6 +24,9 @@ License
Application
adiabaticFlameT
+Group
+ grpThermophysicalUtilities
+
Description
Calculates the adiabatic flame temperature for a given fuel over a
range of unburnt temperatures and equivalence ratios.
diff --git a/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C b/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C
index e91f968a87..83bb9b1db5 100644
--- a/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C
+++ b/applications/utilities/thermophysical/chemkinToFoam/chemkinToFoam.C
@@ -24,6 +24,9 @@ License
Application
chemkinToFoam
+Group
+ grpSurfaceUtilities
+
Description
Converts CHEMKINIII thermodynamics and reaction data files into
OpenFOAM format.
diff --git a/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C b/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C
index 9ecd074bb4..974b9c8549 100644
--- a/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C
+++ b/applications/utilities/thermophysical/equilibriumCO/equilibriumCO.C
@@ -24,6 +24,9 @@ License
Application
equilibriumCO
+Group
+ grpThermophysicalUtilities
+
Description
Calculates the equilibrium level of carbon monoxide.
diff --git a/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C b/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C
index fae3960ab6..0f2407223c 100644
--- a/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C
+++ b/applications/utilities/thermophysical/equilibriumFlameT/equilibriumFlameT.C
@@ -24,6 +24,9 @@ License
Application
equilibriumFlameT
+Group
+ grpThermophysicalUtilities
+
Description
Calculates the equilibrium flame temperature for a given fuel and
pressure for a range of unburnt gas temperatures and equivalence
diff --git a/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C b/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C
index c755532d65..227ddb1be8 100644
--- a/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C
+++ b/applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixtureAdiabaticFlameT.C
@@ -24,6 +24,9 @@ License
Application
mixtureAdiabaticFlameT
+Group
+ grpThermophysicalUtilities
+
Description
Calculates the adiabatic flame temperature for a given mixture
at a given temperature.
diff --git a/src/ODE/ODESolvers/Euler/Euler.H b/src/ODE/ODESolvers/Euler/Euler.H
index fecfc57fa0..228bbdea6d 100644
--- a/src/ODE/ODESolvers/Euler/Euler.H
+++ b/src/ODE/ODESolvers/Euler/Euler.H
@@ -24,6 +24,9 @@ License
Class
Foam::Euler
+Group
+ grpODESolvers
+
Description
Euler ODE solver of order (0)1.
diff --git a/src/ODE/ODESolvers/EulerSI/EulerSI.H b/src/ODE/ODESolvers/EulerSI/EulerSI.H
index a6703cc20c..c9776d9713 100644
--- a/src/ODE/ODESolvers/EulerSI/EulerSI.H
+++ b/src/ODE/ODESolvers/EulerSI/EulerSI.H
@@ -24,6 +24,9 @@ License
Class
Foam::EulerSI
+Group
+ grpODESolvers
+
Description
Semi-implicit Euler ODE solver of order (0)1.
diff --git a/src/ODE/ODESolvers/ODESolver/ODESolver.H b/src/ODE/ODESolvers/ODESolver/ODESolver.H
index de4ef399f8..5d9cd4a70b 100644
--- a/src/ODE/ODESolvers/ODESolver/ODESolver.H
+++ b/src/ODE/ODESolvers/ODESolver/ODESolver.H
@@ -24,6 +24,9 @@ License
Class
Foam::ODESolver
+Group
+ grpODESolvers
+
Description
Abstract base-class for ODE system solvers
diff --git a/src/ODE/ODESolvers/RKCK45/RKCK45.H b/src/ODE/ODESolvers/RKCK45/RKCK45.H
index c376a5f423..3a315237d2 100644
--- a/src/ODE/ODESolvers/RKCK45/RKCK45.H
+++ b/src/ODE/ODESolvers/RKCK45/RKCK45.H
@@ -24,6 +24,9 @@ License
Class
Foam::RKCK45
+Group
+ grpODESolvers
+
Description
4/5th Order Cash-Karp Runge-Kutta ODE solver.
diff --git a/src/ODE/ODESolvers/RKDP45/RKDP45.H b/src/ODE/ODESolvers/RKDP45/RKDP45.H
index b3f5c7bca4..f5f783592f 100644
--- a/src/ODE/ODESolvers/RKDP45/RKDP45.H
+++ b/src/ODE/ODESolvers/RKDP45/RKDP45.H
@@ -24,6 +24,9 @@ License
Class
Foam::RKDP45
+Group
+ grpODESolvers
+
Description
4/5th Order Dormand–Prince Runge-Kutta ODE solver.
diff --git a/src/ODE/ODESolvers/RKF45/RKF45.H b/src/ODE/ODESolvers/RKF45/RKF45.H
index 5198d5553f..735fe5e12e 100644
--- a/src/ODE/ODESolvers/RKF45/RKF45.H
+++ b/src/ODE/ODESolvers/RKF45/RKF45.H
@@ -24,6 +24,9 @@ License
Class
Foam::RKF45
+Group
+ grpODESolvers
+
Description
4/5th Order Runge-Kutta-Fehlberg ODE solver
diff --git a/src/ODE/ODESolvers/Rosenbrock12/Rosenbrock12.H b/src/ODE/ODESolvers/Rosenbrock12/Rosenbrock12.H
index b0bf1c79ef..318091b6b8 100644
--- a/src/ODE/ODESolvers/Rosenbrock12/Rosenbrock12.H
+++ b/src/ODE/ODESolvers/Rosenbrock12/Rosenbrock12.H
@@ -24,6 +24,9 @@ License
Class
Foam::Rosenbrock12
+Group
+ grpODESolvers
+
Description
L-stable embedded Rosenbrock ODE solver of order (1)2.
diff --git a/src/ODE/ODESolvers/Rosenbrock23/Rosenbrock23.H b/src/ODE/ODESolvers/Rosenbrock23/Rosenbrock23.H
index 38541a7c99..ff97cf10c7 100644
--- a/src/ODE/ODESolvers/Rosenbrock23/Rosenbrock23.H
+++ b/src/ODE/ODESolvers/Rosenbrock23/Rosenbrock23.H
@@ -24,6 +24,9 @@ License
Class
Foam::Rosenbrock23
+Group
+ grpODESolvers
+
Description
L-stable embedded Rosenbrock ODE solver of order (2)3.
diff --git a/src/ODE/ODESolvers/Rosenbrock34/Rosenbrock34.H b/src/ODE/ODESolvers/Rosenbrock34/Rosenbrock34.H
index 2af18e5d40..9d57979a46 100644
--- a/src/ODE/ODESolvers/Rosenbrock34/Rosenbrock34.H
+++ b/src/ODE/ODESolvers/Rosenbrock34/Rosenbrock34.H
@@ -24,6 +24,9 @@ License
Class
Foam::Rosenbrock34
+Group
+ grpODESolvers
+
Description
L-stable embedded Rosenbrock ODE solver of order (3)4.
diff --git a/src/ODE/ODESolvers/SIBS/SIBS.H b/src/ODE/ODESolvers/SIBS/SIBS.H
index 0ef0a1d40c..83e5385c29 100644
--- a/src/ODE/ODESolvers/SIBS/SIBS.H
+++ b/src/ODE/ODESolvers/SIBS/SIBS.H
@@ -24,6 +24,9 @@ License
Class
Foam::SIBS
+Group
+ grpODESolvers
+
Description
Foam::SIBS
diff --git a/src/ODE/ODESolvers/Trapezoid/Trapezoid.H b/src/ODE/ODESolvers/Trapezoid/Trapezoid.H
index 667b6ee2ad..1f1c5e6674 100644
--- a/src/ODE/ODESolvers/Trapezoid/Trapezoid.H
+++ b/src/ODE/ODESolvers/Trapezoid/Trapezoid.H
@@ -24,6 +24,9 @@ License
Class
Foam::Trapezoid
+Group
+ grpODESolvers
+
Description
Trapezoidal ODE solver of order (1)2.
diff --git a/src/ODE/ODESolvers/adaptiveSolver/adaptiveSolver.H b/src/ODE/ODESolvers/adaptiveSolver/adaptiveSolver.H
index 0d7dcb035c..141ec9bb7a 100644
--- a/src/ODE/ODESolvers/adaptiveSolver/adaptiveSolver.H
+++ b/src/ODE/ODESolvers/adaptiveSolver/adaptiveSolver.H
@@ -24,6 +24,9 @@ License
Class
Foam::adaptiveSolver
+Group
+ grpODESolvers
+
Description
SourceFiles
diff --git a/src/ODE/ODESolvers/rodas23/rodas23.H b/src/ODE/ODESolvers/rodas23/rodas23.H
index 75f0262813..60d6eda446 100644
--- a/src/ODE/ODESolvers/rodas23/rodas23.H
+++ b/src/ODE/ODESolvers/rodas23/rodas23.H
@@ -24,6 +24,9 @@ License
Class
Foam::rodas23
+Group
+ grpODESolvers
+
Description
L-stable, stiffly-accurate embedded Rosenbrock ODE solver of order (2)3.
diff --git a/src/ODE/ODESolvers/rodas34/rodas34.H b/src/ODE/ODESolvers/rodas34/rodas34.H
index 35cb468f6a..87051184db 100644
--- a/src/ODE/ODESolvers/rodas34/rodas34.H
+++ b/src/ODE/ODESolvers/rodas34/rodas34.H
@@ -24,6 +24,9 @@ License
Class
Foam::rodas34
+Group
+ grpODESolvers
+
Description
L-stable, stiffly-accurate embedded Rosenbrock ODE solver of order (3)4.
diff --git a/src/ODE/ODESolvers/seulex/seulex.H b/src/ODE/ODESolvers/seulex/seulex.H
index c3cd540198..224ccc6f90 100644
--- a/src/ODE/ODESolvers/seulex/seulex.H
+++ b/src/ODE/ODESolvers/seulex/seulex.H
@@ -24,6 +24,9 @@ License
Class
Foam::seulex
+Group
+ grpODESolvers
+
Description
An extrapolation-algorithm, based on the linearly implicit Euler method
with step size control and order selection.
diff --git a/src/ODE/doc/ODEDoc.H b/src/ODE/doc/ODEDoc.H
new file mode 100644
index 0000000000..bd293c5823
--- /dev/null
+++ b/src/ODE/doc/ODEDoc.H
@@ -0,0 +1,32 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / 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 .
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+\defgroup grpODESolvers Ordinary Differential Equation (ODE) solvers
+@{
+ \ingroup grpNumerics
+ This group contains ODE solvers
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H
index 1c294e35bf..2912886024 100644
--- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H
+++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H
@@ -23,13 +23,13 @@ License
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-\defgroup grpCmpTurbulenceBoundaryConditions Compressible Turbulence BCs
+\defgroup grpCmpTurbulenceBoundaryConditions Boundary conditions
@{
\ingroup grpCmpTurbulence
This group contains compressible turbulence model boundary conditions
@}
-\defgroup grpCmpWallFunctions Compressible turbulence wall functions
+\defgroup grpCmpWallFunctions Wall functions
@{
\ingroup grpCmpTurbulenceBoundaryConditions
This group contains compressible turbulence model wall functions
diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H
index c65a7170c2..5b589b0221 100644
--- a/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H
+++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H
@@ -23,13 +23,13 @@ License
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-\defgroup grpIcoTurbulenceBoundaryConditions Incompressible Turbulence BCs
+\defgroup grpIcoTurbulenceBoundaryConditions Boundary conditions
@{
\ingroup grpIcoTurbulence
This group contains incompressible turbulence model boundary conditions
@}
-\defgroup grpIcoWallFunctions Incompressible turbulence wall functions
+\defgroup grpIcoWallFunctions Wall functions
@{
\ingroup grpIcoTurbulenceBoundaryConditions
This group contains incompressible turbulence model wall functions
diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/RASBoundaryConditionsDoc.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/RASBoundaryConditionsDoc.H
index aeea3263fb..3c7a006033 100644
--- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/RASBoundaryConditionsDoc.H
+++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/RASBoundaryConditionsDoc.H
@@ -23,7 +23,7 @@ License
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-\defgroup grpRASBoundaryConditions RAS boundary conditions
+\defgroup grpRASBoundaryConditions Boundary conditions
@{
\ingroup grpRASTurbulence
This group contains RAS turbulence model boundary conditions
diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H
index 651e95c161..82709888ae 100644
--- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H
+++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/turbulenceBoundaryConditionsDoc.H
@@ -23,7 +23,7 @@ License
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-\defgroup grpTurbulenceBoundaryConditions Turbulence boundary conditions
+\defgroup grpTurbulenceBoundaryConditions Boundary conditions
@{
\ingroup grpTurbulence
This group contains turbulence model boundary conditions
diff --git a/src/TurbulenceModels/turbulenceModels/doc/turbulenceModelDoc.H b/src/TurbulenceModels/turbulenceModels/doc/turbulenceModelDoc.H
index 91eab7254d..926d957680 100644
--- a/src/TurbulenceModels/turbulenceModels/doc/turbulenceModelDoc.H
+++ b/src/TurbulenceModels/turbulenceModels/doc/turbulenceModelDoc.H
@@ -23,7 +23,7 @@ License
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-\defgroup grpTurbulence Turbulence
+\defgroup grpTurbulence Turbulence models
@{
This group contains turbulence models.
@}
diff --git a/src/combustionModels/FSD/FSD.H b/src/combustionModels/FSD/FSD.H
index c9b4b6fa7d..2d4e17b637 100644
--- a/src/combustionModels/FSD/FSD.H
+++ b/src/combustionModels/FSD/FSD.H
@@ -24,6 +24,9 @@ License
Class
Foam::combustionModels::FSD
+Group
+ grpCombustionModels
+
Description
Flame Surface Dennsity (FDS) combustion model.
diff --git a/src/combustionModels/PaSR/PaSR.H b/src/combustionModels/PaSR/PaSR.H
index 51614ab2e6..cbcb37bc83 100644
--- a/src/combustionModels/PaSR/PaSR.H
+++ b/src/combustionModels/PaSR/PaSR.H
@@ -24,6 +24,9 @@ License
Class
Foam::combustionModels::PaSR
+Group
+ grpCombustionModels
+
Description
Partially stirred reactor combustion model. The model calculates a finite
rate, based on both turbulence and chemistry time scales. Depending on
diff --git a/src/combustionModels/combustionModel/combustionModel.H b/src/combustionModels/combustionModel/combustionModel.H
index badd484829..b5d218cc0a 100644
--- a/src/combustionModels/combustionModel/combustionModel.H
+++ b/src/combustionModels/combustionModel/combustionModel.H
@@ -24,6 +24,9 @@ License
Class
Foam::combustionModel
+Group
+ grpCombustionModels
+
Description
Base class for combustion models
diff --git a/src/combustionModels/diffusion/diffusion.H b/src/combustionModels/diffusion/diffusion.H
index a3023ee32b..59b6ecda4d 100644
--- a/src/combustionModels/diffusion/diffusion.H
+++ b/src/combustionModels/diffusion/diffusion.H
@@ -24,6 +24,9 @@ License
Class
Foam::combustionModels::diffusion
+Group
+ grpCombustionModels
+
Description
Simple diffusion-based combustion model based on the principle mixed is
burnt. Additional parameter C is used to distribute the heat release rate
diff --git a/src/combustionModels/diffusionMulticomponent/diffusionMulticomponent.H b/src/combustionModels/diffusionMulticomponent/diffusionMulticomponent.H
index f7143d00ee..af81c19228 100644
--- a/src/combustionModels/diffusionMulticomponent/diffusionMulticomponent.H
+++ b/src/combustionModels/diffusionMulticomponent/diffusionMulticomponent.H
@@ -24,6 +24,9 @@ License
Class
Foam::combustionModels::diffusionMulticomponent
+Group
+ grpCombustionModels
+
Description
Diffusion based turbulent combustion model for multicomponent species.
diff --git a/src/combustionModels/doc/combustionModelsDoc.H b/src/combustionModels/doc/combustionModelsDoc.H
new file mode 100644
index 0000000000..53c5e1debd
--- /dev/null
+++ b/src/combustionModels/doc/combustionModelsDoc.H
@@ -0,0 +1,31 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / 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 .
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+\defgroup grpCombustionModels Combustion models
+@{
+ This group contains combustion models.
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/src/combustionModels/infinitelyFastChemistry/infinitelyFastChemistry.H b/src/combustionModels/infinitelyFastChemistry/infinitelyFastChemistry.H
index 08dec407c0..16a89b9cee 100644
--- a/src/combustionModels/infinitelyFastChemistry/infinitelyFastChemistry.H
+++ b/src/combustionModels/infinitelyFastChemistry/infinitelyFastChemistry.H
@@ -24,6 +24,9 @@ License
Class
Foam::combustionModels::infinitelyFastChemistry
+Group
+ grpCombustionModels
+
Description
Simple infinitely fast chemistry combustion model based on the principle
mixed is burnt. Additional parameter C is used to distribute the heat
diff --git a/src/combustionModels/laminar/laminar.H b/src/combustionModels/laminar/laminar.H
index 0caf5a80f0..a4589d4ac1 100644
--- a/src/combustionModels/laminar/laminar.H
+++ b/src/combustionModels/laminar/laminar.H
@@ -24,6 +24,9 @@ License
Class
Foam::combustionModels::laminar
+Group
+ grpCombustionModels
+
Description
Laminar combustion model.
diff --git a/src/combustionModels/noCombustion/noCombustion.H b/src/combustionModels/noCombustion/noCombustion.H
index 7e7a3b3781..641970fd6f 100644
--- a/src/combustionModels/noCombustion/noCombustion.H
+++ b/src/combustionModels/noCombustion/noCombustion.H
@@ -24,6 +24,9 @@ License
Class
Foam::combustionModels::noCombustion
+Group
+ grpCombustionModels
+
Description
Dummy combustion model for 'no combustion'
diff --git a/src/combustionModels/singleStepCombustion/singleStepCombustion.H b/src/combustionModels/singleStepCombustion/singleStepCombustion.H
index 404bfe1c13..4a17add9f1 100644
--- a/src/combustionModels/singleStepCombustion/singleStepCombustion.H
+++ b/src/combustionModels/singleStepCombustion/singleStepCombustion.H
@@ -24,6 +24,9 @@ License
Class
Foam::combustionModels::singleStepCombustion
+Group
+ grpCombustionModels
+
Description
Base class for combustion models using singleStepReactingMixture.
diff --git a/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H b/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H
index 8b6889ea03..47684ecc4f 100644
--- a/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H
+++ b/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H
@@ -23,7 +23,7 @@ License
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-\defgroup grpBoundaryConditions Boundary Conditions
+\defgroup grpBoundaryConditions Boundary conditions
@{
This group contains OpenFOAM boundary condition types. All conditions
are derived from the base Foam::fvPatchField class. Patch values are
@@ -38,38 +38,38 @@ License
of the matrix solve, via a call to \.correctBoundaryConditions().
@}
-\defgroup grpConstraintBoundaryConditions Constraint boundary Conditions
+\defgroup grpConstraintBoundaryConditions Constraint
@{
\ingroup grpBoundaryConditions
This group contains constraint boundary condition types. These conditions
are mainly employed to reduced dimensioned cases.
@}
-\defgroup grpInletBoundaryConditions Inlet boundary Conditions
+\defgroup grpInletBoundaryConditions Inlet
@{
\ingroup grpBoundaryConditions
This group contains inlet boundary condition types
@}
-\defgroup grpOutletBoundaryConditions Outlet boundary Conditions
+\defgroup grpOutletBoundaryConditions Outlet
@{
\ingroup grpBoundaryConditions
This group contains outlet boundary condition types
@}
-\defgroup grpGenericBoundaryConditions Generic boundary Conditions
+\defgroup grpGenericBoundaryConditions Generic
@{
\ingroup grpBoundaryConditions
This group contains generic boundary condition types
@}
-\defgroup grpCoupledBoundaryConditions Coupled boundary Conditions
+\defgroup grpCoupledBoundaryConditions Coupled
@{
\ingroup grpBoundaryConditions
This group contains coupled boundary condition types
@}
-\defgroup grpWallBoundaryConditions Wall boundary Conditions
+\defgroup grpWallBoundaryConditions Wall
@{
\ingroup grpBoundaryConditions
This group contains wall boundary condition types
diff --git a/src/fvMotionSolver/doc/motionSolversDoc.H b/src/fvMotionSolver/doc/motionSolversDoc.H
new file mode 100644
index 0000000000..818a34eea9
--- /dev/null
+++ b/src/fvMotionSolver/doc/motionSolversDoc.H
@@ -0,0 +1,37 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / 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 .
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+\defgroup grpMeshMotion Mesh motion
+@{
+ This group contains Mesh motion models.
+@}
+
+\defgroup grpMeshMotionSolvers Solvers
+@{
+ \ingroup grpMeshMotion
+ This group contains Mesh motion solvers.
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/src/fvMotionSolver/fvMotionSolvers/componentDisplacement/componentLaplacian/displacementComponentLaplacianFvMotionSolver.H b/src/fvMotionSolver/fvMotionSolvers/componentDisplacement/componentLaplacian/displacementComponentLaplacianFvMotionSolver.H
index e4b1ae9605..bed5a61674 100644
--- a/src/fvMotionSolver/fvMotionSolvers/componentDisplacement/componentLaplacian/displacementComponentLaplacianFvMotionSolver.H
+++ b/src/fvMotionSolver/fvMotionSolvers/componentDisplacement/componentLaplacian/displacementComponentLaplacianFvMotionSolver.H
@@ -24,6 +24,9 @@ License
Class
Foam::displacementComponentLaplacianFvMotionSolver
+Group
+ grpMeshMotionSolvers
+
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre
Laplacian for the given component of the motion displacement.
diff --git a/src/fvMotionSolver/fvMotionSolvers/componentVelocity/componentLaplacian/velocityComponentLaplacianFvMotionSolver.H b/src/fvMotionSolver/fvMotionSolvers/componentVelocity/componentLaplacian/velocityComponentLaplacianFvMotionSolver.H
index bc7c746ea2..d4075ff93b 100644
--- a/src/fvMotionSolver/fvMotionSolvers/componentVelocity/componentLaplacian/velocityComponentLaplacianFvMotionSolver.H
+++ b/src/fvMotionSolver/fvMotionSolvers/componentVelocity/componentLaplacian/velocityComponentLaplacianFvMotionSolver.H
@@ -24,6 +24,9 @@ License
Class
Foam::velocityComponentLaplacianFvMotionSolver
+Group
+ grpMeshMotionSolvers
+
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre
Laplacian for the given component of the motion velocity.
diff --git a/src/fvMotionSolver/fvMotionSolvers/displacement/SBRStress/displacementSBRStressFvMotionSolver.H b/src/fvMotionSolver/fvMotionSolvers/displacement/SBRStress/displacementSBRStressFvMotionSolver.H
index 3a4779d9db..5e4c7b64c1 100644
--- a/src/fvMotionSolver/fvMotionSolvers/displacement/SBRStress/displacementSBRStressFvMotionSolver.H
+++ b/src/fvMotionSolver/fvMotionSolvers/displacement/SBRStress/displacementSBRStressFvMotionSolver.H
@@ -24,6 +24,9 @@ License
Class
Foam::displacementSBRStressFvMotionSolver
+Group
+ grpMeshMotionSolvers
+
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre
solid-body rotation stress equations for the motion displacement.
diff --git a/src/fvMotionSolver/fvMotionSolvers/displacement/interpolation/displacementInterpolationMotionSolver.H b/src/fvMotionSolver/fvMotionSolvers/displacement/interpolation/displacementInterpolationMotionSolver.H
index 3742417349..2458d1d400 100644
--- a/src/fvMotionSolver/fvMotionSolvers/displacement/interpolation/displacementInterpolationMotionSolver.H
+++ b/src/fvMotionSolver/fvMotionSolvers/displacement/interpolation/displacementInterpolationMotionSolver.H
@@ -24,6 +24,9 @@ License
Class
Foam::displacementInterpolationMotionSolver
+Group
+ grpMeshMotionSolvers
+
Description
Mesh motion solver for an fvMesh.
diff --git a/src/fvMotionSolver/fvMotionSolvers/displacement/laplacian/displacementLaplacianFvMotionSolver.H b/src/fvMotionSolver/fvMotionSolvers/displacement/laplacian/displacementLaplacianFvMotionSolver.H
index 7ec7790985..1df49597a6 100644
--- a/src/fvMotionSolver/fvMotionSolvers/displacement/laplacian/displacementLaplacianFvMotionSolver.H
+++ b/src/fvMotionSolver/fvMotionSolvers/displacement/laplacian/displacementLaplacianFvMotionSolver.H
@@ -24,6 +24,9 @@ License
Class
Foam::displacementLaplacianFvMotionSolver
+Group
+ grpMeshMotionSolvers
+
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre
Laplacian for the motion displacement.
diff --git a/src/fvMotionSolver/fvMotionSolvers/displacement/layeredSolver/displacementLayeredMotionMotionSolver.H b/src/fvMotionSolver/fvMotionSolvers/displacement/layeredSolver/displacementLayeredMotionMotionSolver.H
index c876e560ef..be002c6056 100644
--- a/src/fvMotionSolver/fvMotionSolvers/displacement/layeredSolver/displacementLayeredMotionMotionSolver.H
+++ b/src/fvMotionSolver/fvMotionSolvers/displacement/layeredSolver/displacementLayeredMotionMotionSolver.H
@@ -24,6 +24,9 @@ License
Class
Foam::displacementLayeredMotionMotionSolver
+Group
+ grpMeshMotionSolvers
+
Description
Mesh motion solver for an (multi-block) extruded fvMesh. Gets given the
structure of the mesh blocks and boundary conditions on these blocks.
diff --git a/src/fvMotionSolver/fvMotionSolvers/displacement/surfaceAlignedSBRStress/surfaceAlignedSBRStressFvMotionSolver.H b/src/fvMotionSolver/fvMotionSolvers/displacement/surfaceAlignedSBRStress/surfaceAlignedSBRStressFvMotionSolver.H
index 719c699449..77f83e5ad5 100644
--- a/src/fvMotionSolver/fvMotionSolvers/displacement/surfaceAlignedSBRStress/surfaceAlignedSBRStressFvMotionSolver.H
+++ b/src/fvMotionSolver/fvMotionSolvers/displacement/surfaceAlignedSBRStress/surfaceAlignedSBRStressFvMotionSolver.H
@@ -24,6 +24,9 @@ License
Class
Foam::surfaceAlignedSBRStressFvMotionSolver
+Group
+ grpMeshMotionSolvers
+
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre
solid-body rotation stress equations for the motion displacement.
diff --git a/src/fvMotionSolver/fvMotionSolvers/velocity/laplacian/velocityLaplacianFvMotionSolver.H b/src/fvMotionSolver/fvMotionSolvers/velocity/laplacian/velocityLaplacianFvMotionSolver.H
index 479234dc22..af213a9675 100644
--- a/src/fvMotionSolver/fvMotionSolvers/velocity/laplacian/velocityLaplacianFvMotionSolver.H
+++ b/src/fvMotionSolver/fvMotionSolvers/velocity/laplacian/velocityLaplacianFvMotionSolver.H
@@ -24,6 +24,9 @@ License
Class
Foam::velocityLaplacianFvMotionSolver
+Group
+ grpMeshMotionSolvers
+
Description
Mesh motion solver for an fvMesh. Based on solving the cell-centre
Laplacian for the motion velocity.
diff --git a/src/lagrangian/intermediate/doc/lagrangianIntermediateDoc.H b/src/lagrangian/intermediate/doc/lagrangianIntermediateDoc.H
index 238d0a0a5b..a4b300bfee 100644
--- a/src/lagrangian/intermediate/doc/lagrangianIntermediateDoc.H
+++ b/src/lagrangian/intermediate/doc/lagrangianIntermediateDoc.H
@@ -23,7 +23,7 @@ License
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-\defgroup grpLagrangianIntermediate Lagrangian particle modelling
+\defgroup grpLagrangianIntermediate Lagrangian particle models
@{
This group contains Lagrangian modelling available in the 'intermediate' library
@}
diff --git a/src/postProcessing/functionObjects/utilities/Make/files b/src/postProcessing/functionObjects/utilities/Make/files
index e9b8fed150..29ca6fe361 100644
--- a/src/postProcessing/functionObjects/utilities/Make/files
+++ b/src/postProcessing/functionObjects/utilities/Make/files
@@ -18,6 +18,9 @@ fluxSummary/fluxSummaryFunctionObject.C
Lambda2/Lambda2.C
Lambda2/Lambda2FunctionObject.C
+mapFields/mapFields.C
+mapFields/mapFieldsFunctionObject.C
+
Peclet/Peclet.C
Peclet/PecletFunctionObject.C
diff --git a/src/rigidBodyDynamics/bodies/compositeBody/compositeBody.H b/src/rigidBodyDynamics/bodies/compositeBody/compositeBody.H
index 662ed39e8a..0d7a353d94 100644
--- a/src/rigidBodyDynamics/bodies/compositeBody/compositeBody.H
+++ b/src/rigidBodyDynamics/bodies/compositeBody/compositeBody.H
@@ -24,6 +24,9 @@ License
Class
Foam::compositeBody
+Group
+ grpRigidBodyDynamicsBodies
+
Description
This specialized rigidBody holds the original body after it has been merged
into a parent.
diff --git a/src/rigidBodyDynamics/bodies/cuboid/cuboid.H b/src/rigidBodyDynamics/bodies/cuboid/cuboid.H
index 7432f7cbc0..348792db4a 100644
--- a/src/rigidBodyDynamics/bodies/cuboid/cuboid.H
+++ b/src/rigidBodyDynamics/bodies/cuboid/cuboid.H
@@ -24,6 +24,9 @@ License
Class
Foam::cuboid
+Group
+ grpRigidBodyDynamicsBodies
+
Description
Specialization of rigidBody to construct a cuboid given the mass and
lengths of the sides.
diff --git a/src/rigidBodyDynamics/bodies/jointBody/jointBody.H b/src/rigidBodyDynamics/bodies/jointBody/jointBody.H
index 1784de009d..a4b3d41894 100644
--- a/src/rigidBodyDynamics/bodies/jointBody/jointBody.H
+++ b/src/rigidBodyDynamics/bodies/jointBody/jointBody.H
@@ -24,6 +24,9 @@ License
Class
Foam::jointBody
+Group
+ grpRigidBodyDynamicsBodies
+
Description
SourceFiles
diff --git a/src/rigidBodyDynamics/bodies/masslessBody/masslessBody.H b/src/rigidBodyDynamics/bodies/masslessBody/masslessBody.H
index a29585e3f6..0375a54684 100644
--- a/src/rigidBodyDynamics/bodies/masslessBody/masslessBody.H
+++ b/src/rigidBodyDynamics/bodies/masslessBody/masslessBody.H
@@ -24,6 +24,9 @@ License
Class
Foam::masslessBody
+Group
+ grpRigidBodyDynamicsBodies
+
Description
SourceFiles
diff --git a/src/rigidBodyDynamics/bodies/rigidBody/rigidBody.H b/src/rigidBodyDynamics/bodies/rigidBody/rigidBody.H
index 2c8679b1e4..6307234184 100644
--- a/src/rigidBodyDynamics/bodies/rigidBody/rigidBody.H
+++ b/src/rigidBodyDynamics/bodies/rigidBody/rigidBody.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::rigidBody
+Group
+ grpRigidBodyDynamicsBodies
+
Description
SourceFiles
diff --git a/src/rigidBodyDynamics/bodies/sphere/sphere.H b/src/rigidBodyDynamics/bodies/sphere/sphere.H
index e3310f735d..7538f367c4 100644
--- a/src/rigidBodyDynamics/bodies/sphere/sphere.H
+++ b/src/rigidBodyDynamics/bodies/sphere/sphere.H
@@ -24,6 +24,9 @@ License
Class
Foam::sphere
+Group
+ grpRigidBodyDynamicsBodies
+
Description
Specialization of rigidBody to construct a sphere given the mass and radius.
diff --git a/src/rigidBodyDynamics/bodies/subBody/subBody.H b/src/rigidBodyDynamics/bodies/subBody/subBody.H
index 0cd3f7c930..c6a0bc220e 100644
--- a/src/rigidBodyDynamics/bodies/subBody/subBody.H
+++ b/src/rigidBodyDynamics/bodies/subBody/subBody.H
@@ -24,6 +24,9 @@ License
Class
Foam::subBody
+Group
+ grpRigidBodyDynamicsBodies
+
Description
This specialized rigidBody holds the original body after it has been merged
into a master.
diff --git a/src/rigidBodyDynamics/doc/rigidBodyDynamicsDoc.H b/src/rigidBodyDynamics/doc/rigidBodyDynamicsDoc.H
new file mode 100644
index 0000000000..20f1db927b
--- /dev/null
+++ b/src/rigidBodyDynamics/doc/rigidBodyDynamicsDoc.H
@@ -0,0 +1,50 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / 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 .
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+\defgroup grpRigidBodyDynamics Rigid body dynamics
+@{
+ \ingroup grpMeshMotion
+ This group contains rigid body dynamics models.
+@}
+
+\defgroup grpRigidBodyDynamicsBodies Bodies
+@{
+ \ingroup grpRigidBodyDynamics
+ This group contains rigid body dynamics body models.
+@}
+
+\defgroup grpRigidBodyDynamicsJoints Joints
+@{
+ \ingroup grpRigidBodyDynamics
+ This group contains rigid body dynamics joint models.
+@}
+
+\defgroup grpRigidBodyDynamicsRestraints Restraints
+@{
+ \ingroup grpRigidBodyDynamics
+ This group contains rigid body dynamics restraint models.
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/src/rigidBodyDynamics/joints/Pa/Pa.H b/src/rigidBodyDynamics/joints/Pa/Pa.H
index d67af31d9a..7f02161422 100644
--- a/src/rigidBodyDynamics/joints/Pa/Pa.H
+++ b/src/rigidBodyDynamics/joints/Pa/Pa.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::Pa
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Prismatic joint for translation along the specified arbitrary axis.
diff --git a/src/rigidBodyDynamics/joints/Px/Px.H b/src/rigidBodyDynamics/joints/Px/Px.H
index 979abcf5c0..dc03df42df 100644
--- a/src/rigidBodyDynamics/joints/Px/Px.H
+++ b/src/rigidBodyDynamics/joints/Px/Px.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::Px
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Prismatic joint for translation along the x-axis.
diff --git a/src/rigidBodyDynamics/joints/Pxyz/Pxyz.H b/src/rigidBodyDynamics/joints/Pxyz/Pxyz.H
index 02746bf14c..8f4a83cc02 100644
--- a/src/rigidBodyDynamics/joints/Pxyz/Pxyz.H
+++ b/src/rigidBodyDynamics/joints/Pxyz/Pxyz.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::Pxyz
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Prismatic joint for translation in the x/y/z directions.
diff --git a/src/rigidBodyDynamics/joints/Py/Py.H b/src/rigidBodyDynamics/joints/Py/Py.H
index bcbcd47785..ed324124af 100644
--- a/src/rigidBodyDynamics/joints/Py/Py.H
+++ b/src/rigidBodyDynamics/joints/Py/Py.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::Py
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Prismatic joint for translation along the y-axis.
diff --git a/src/rigidBodyDynamics/joints/Pz/Pz.H b/src/rigidBodyDynamics/joints/Pz/Pz.H
index 611397ded5..bcb9d39df4 100644
--- a/src/rigidBodyDynamics/joints/Pz/Pz.H
+++ b/src/rigidBodyDynamics/joints/Pz/Pz.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::Pz
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Prismatic joint for translation along the x-axis.
diff --git a/src/rigidBodyDynamics/joints/Ra/Ra.H b/src/rigidBodyDynamics/joints/Ra/Ra.H
index cd634f7b89..8a3d342edb 100644
--- a/src/rigidBodyDynamics/joints/Ra/Ra.H
+++ b/src/rigidBodyDynamics/joints/Ra/Ra.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::Ra
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Revolute joint for rotation about the specified arbitrary axis.
diff --git a/src/rigidBodyDynamics/joints/Rs/Rs.H b/src/rigidBodyDynamics/joints/Rs/Rs.H
index f689869056..7a0ae947c6 100644
--- a/src/rigidBodyDynamics/joints/Rs/Rs.H
+++ b/src/rigidBodyDynamics/joints/Rs/Rs.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::Rs
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Spherical joint for rotation about the x/y/z-axes using a quaternion
(Euler parameters) to avoid gimble-lock.
diff --git a/src/rigidBodyDynamics/joints/Rx/Rx.H b/src/rigidBodyDynamics/joints/Rx/Rx.H
index 892cfcb709..c66667a542 100644
--- a/src/rigidBodyDynamics/joints/Rx/Rx.H
+++ b/src/rigidBodyDynamics/joints/Rx/Rx.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::Rx
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Revolute joint for rotation about the x-axis
diff --git a/src/rigidBodyDynamics/joints/Rxyz/Rxyz.H b/src/rigidBodyDynamics/joints/Rxyz/Rxyz.H
index 43582796de..9377f33046 100644
--- a/src/rigidBodyDynamics/joints/Rxyz/Rxyz.H
+++ b/src/rigidBodyDynamics/joints/Rxyz/Rxyz.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::Rxyz
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Spherical joint for rotation about the x/y/z-axes using Euler-angles
in the order x, y, z.
diff --git a/src/rigidBodyDynamics/joints/Ry/Ry.H b/src/rigidBodyDynamics/joints/Ry/Ry.H
index 0a870bd925..832fa26a27 100644
--- a/src/rigidBodyDynamics/joints/Ry/Ry.H
+++ b/src/rigidBodyDynamics/joints/Ry/Ry.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::Ry
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Revolute joint for rotation about the y-axis
diff --git a/src/rigidBodyDynamics/joints/Ryxz/Ryxz.H b/src/rigidBodyDynamics/joints/Ryxz/Ryxz.H
index 1371abcf80..77a2761c19 100644
--- a/src/rigidBodyDynamics/joints/Ryxz/Ryxz.H
+++ b/src/rigidBodyDynamics/joints/Ryxz/Ryxz.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::Ryxz
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Spherical joint for rotation about the x/y/z-axes using Euler-angles
in the order y, x, z.
diff --git a/src/rigidBodyDynamics/joints/Rz/Rz.H b/src/rigidBodyDynamics/joints/Rz/Rz.H
index 01ed3139b0..d7c8486710 100644
--- a/src/rigidBodyDynamics/joints/Rz/Rz.H
+++ b/src/rigidBodyDynamics/joints/Rz/Rz.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::Rz
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Revolute joint for rotation about the z-axis
diff --git a/src/rigidBodyDynamics/joints/Rzyx/Rzyx.H b/src/rigidBodyDynamics/joints/Rzyx/Rzyx.H
index 3aeb85dd63..9797904352 100644
--- a/src/rigidBodyDynamics/joints/Rzyx/Rzyx.H
+++ b/src/rigidBodyDynamics/joints/Rzyx/Rzyx.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::Rzyx
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Spherical joint for rotation about the x/y/z-axes using Euler-angles
in the order z, y, x.
diff --git a/src/rigidBodyDynamics/joints/composite/compositeJoint.H b/src/rigidBodyDynamics/joints/composite/compositeJoint.H
index 5d12bf5025..709b7abcb0 100644
--- a/src/rigidBodyDynamics/joints/composite/compositeJoint.H
+++ b/src/rigidBodyDynamics/joints/composite/compositeJoint.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::composite
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Prismatic joint for translation along the specified arbitrary axis.
diff --git a/src/rigidBodyDynamics/joints/floating/floatingJoint.H b/src/rigidBodyDynamics/joints/floating/floatingJoint.H
index 58c314d784..7850777559 100644
--- a/src/rigidBodyDynamics/joints/floating/floatingJoint.H
+++ b/src/rigidBodyDynamics/joints/floating/floatingJoint.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::floating
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Prismatic joint for translation along the specified arbitrary axis.
diff --git a/src/rigidBodyDynamics/joints/joint/joint.H b/src/rigidBodyDynamics/joints/joint/joint.H
index 0ea00b678b..10bdfc8495 100644
--- a/src/rigidBodyDynamics/joints/joint/joint.H
+++ b/src/rigidBodyDynamics/joints/joint/joint.H
@@ -24,6 +24,9 @@ License
Namespace
Foam::RBD::joints
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Namespace for rigid-body joints
diff --git a/src/rigidBodyDynamics/joints/null/nullJoint.H b/src/rigidBodyDynamics/joints/null/nullJoint.H
index cc97aed72b..de3b1164af 100644
--- a/src/rigidBodyDynamics/joints/null/nullJoint.H
+++ b/src/rigidBodyDynamics/joints/null/nullJoint.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::joints::null
+Group
+ grpRigidBodyDynamicsJoints
+
Description
Null joint for the root-body.
diff --git a/src/rigidBodyDynamics/restraints/linearAxialAngularSpring/linearAxialAngularSpring.H b/src/rigidBodyDynamics/restraints/linearAxialAngularSpring/linearAxialAngularSpring.H
index 66b34e0df7..4698baee70 100644
--- a/src/rigidBodyDynamics/restraints/linearAxialAngularSpring/linearAxialAngularSpring.H
+++ b/src/rigidBodyDynamics/restraints/linearAxialAngularSpring/linearAxialAngularSpring.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::restraints::linearAxialAngularSpring
+Group
+ grpRigidBodyDynamicsRestraints
+
Description
Linear axial angular spring restraint.
diff --git a/src/rigidBodyDynamics/restraints/linearDamper/linearDamper.H b/src/rigidBodyDynamics/restraints/linearDamper/linearDamper.H
index c0a2c37288..b329dcb0de 100644
--- a/src/rigidBodyDynamics/restraints/linearDamper/linearDamper.H
+++ b/src/rigidBodyDynamics/restraints/linearDamper/linearDamper.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::restraints::linearDamper
+Group
+ grpRigidBodyDynamicsRestraints
+
Description
Linear damper restraint. Operates in the local frame of the body.
diff --git a/src/rigidBodyDynamics/restraints/linearSpring/linearSpring.H b/src/rigidBodyDynamics/restraints/linearSpring/linearSpring.H
index b7a90f77d0..c522ffd3f8 100644
--- a/src/rigidBodyDynamics/restraints/linearSpring/linearSpring.H
+++ b/src/rigidBodyDynamics/restraints/linearSpring/linearSpring.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::restraints::linearSpring
+Group
+ grpRigidBodyDynamicsRestraints
+
Description
Linear spring restraint.
diff --git a/src/rigidBodyDynamics/restraints/sphericalAngularDamper/sphericalAngularDamper.H b/src/rigidBodyDynamics/restraints/sphericalAngularDamper/sphericalAngularDamper.H
index ccff2ff660..ae0f3356d1 100644
--- a/src/rigidBodyDynamics/restraints/sphericalAngularDamper/sphericalAngularDamper.H
+++ b/src/rigidBodyDynamics/restraints/sphericalAngularDamper/sphericalAngularDamper.H
@@ -24,6 +24,9 @@ License
Class
Foam::RBD::restraints::sphericalAngularDamper
+Group
+ grpRigidBodyDynamicsRestraints
+
Description
Spherical angular damper restraint.
Operates in the local frame of the body.
diff --git a/src/rigidBodyMeshMotion/rigidBodyMeshMotion.H b/src/rigidBodyMeshMotion/rigidBodyMeshMotion.H
index 35234268d9..1c7b6b8c0e 100644
--- a/src/rigidBodyMeshMotion/rigidBodyMeshMotion.H
+++ b/src/rigidBodyMeshMotion/rigidBodyMeshMotion.H
@@ -24,6 +24,9 @@ License
Class
Foam::rigidBodyMeshMotion
+Group
+ grpMeshMotionSolvers
+
Description
Rigid-body mesh motion solver for fvMesh.
diff --git a/src/sixDoFRigidBodyMotion/doc/sixDofRigidBodyMotionDoc.H b/src/sixDoFRigidBodyMotion/doc/sixDofRigidBodyMotionDoc.H
new file mode 100644
index 0000000000..585cc5ccd8
--- /dev/null
+++ b/src/sixDoFRigidBodyMotion/doc/sixDofRigidBodyMotionDoc.H
@@ -0,0 +1,50 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / 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 .
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+\defgroup grpSixDoFRigidBody Six Degree of Freedom (DoF)
+@{
+ \ingroup grpMeshMotion
+ This group contains six DoF models.
+@}
+
+\defgroup grpSixDoFRigidBodySolvers Solvers
+@{
+ \ingroup grpSixDoFRigidBody
+ This group contains six DoF solvers.
+@}
+
+\defgroup grpSixDoFRigidBodyConstraints Constraints
+@{
+ \ingroup grpSixDoFRigidBody
+ This group contains six DoF Constraints.
+@}
+
+\defgroup grpSixDoFRigidBodyRestraints Restraints
+@{
+ \ingroup grpSixDoFRigidBody
+ This group contains six DoF Restraints.
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionSolver/sixDoFRigidBodyMotionSolver.H b/src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionSolver/sixDoFRigidBodyMotionSolver.H
index 2ad4921aaa..1c9fd69fc7 100644
--- a/src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionSolver/sixDoFRigidBodyMotionSolver.H
+++ b/src/sixDoFRigidBodyMotion/sixDoFRigidBodyMotionSolver/sixDoFRigidBodyMotionSolver.H
@@ -24,6 +24,9 @@ License
Class
Foam::sixDoFRigidBodyMotionSolver
+Group
+ grpMeshMotionSolvers
+
Description
6-DoF solid-body mesh motion solver for an fvMesh.
diff --git a/src/sixDoFRigidBodyMotion/sixDoFSolvers/CrankNicolson/CrankNicolson.H b/src/sixDoFRigidBodyMotion/sixDoFSolvers/CrankNicolson/CrankNicolson.H
index a8dd2ccbff..e2f7ae8226 100644
--- a/src/sixDoFRigidBodyMotion/sixDoFSolvers/CrankNicolson/CrankNicolson.H
+++ b/src/sixDoFRigidBodyMotion/sixDoFSolvers/CrankNicolson/CrankNicolson.H
@@ -24,6 +24,9 @@ License
Class
Foam::sixDoFSolvers::CrankNicolson
+Group
+ grpSixDoFRigidBodySolvers
+
Description
Crank-Nicolson 2nd-order time-integrator for 6DoF solid-body motion.
diff --git a/src/sixDoFRigidBodyMotion/sixDoFSolvers/Newmark/Newmark.H b/src/sixDoFRigidBodyMotion/sixDoFSolvers/Newmark/Newmark.H
index e605fcc294..d15bc2fcb1 100644
--- a/src/sixDoFRigidBodyMotion/sixDoFSolvers/Newmark/Newmark.H
+++ b/src/sixDoFRigidBodyMotion/sixDoFSolvers/Newmark/Newmark.H
@@ -24,6 +24,9 @@ License
Class
Foam::sixDoFSolvers::Newmark
+Group
+ grpSixDoFRigidBodySolvers
+
Description
Newmark 2nd-order time-integrator for 6DoF solid-body motion.
diff --git a/src/sixDoFRigidBodyMotion/sixDoFSolvers/sixDoFSolver/sixDoFSolver.H b/src/sixDoFRigidBodyMotion/sixDoFSolvers/sixDoFSolver/sixDoFSolver.H
index cb00660314..a1e536f755 100644
--- a/src/sixDoFRigidBodyMotion/sixDoFSolvers/sixDoFSolver/sixDoFSolver.H
+++ b/src/sixDoFRigidBodyMotion/sixDoFSolvers/sixDoFSolver/sixDoFSolver.H
@@ -24,6 +24,9 @@ License
Class
Foam::sixDoFSolver
+Group
+ grpSixDoFRigidBodySolvers
+
Description
SourceFiles
diff --git a/src/sixDoFRigidBodyMotion/sixDoFSolvers/symplectic/symplectic.H b/src/sixDoFRigidBodyMotion/sixDoFSolvers/symplectic/symplectic.H
index d03b77bbd5..3aac7c7e18 100644
--- a/src/sixDoFRigidBodyMotion/sixDoFSolvers/symplectic/symplectic.H
+++ b/src/sixDoFRigidBodyMotion/sixDoFSolvers/symplectic/symplectic.H
@@ -24,6 +24,9 @@ License
Class
Foam::sixDoFSolvers::symplectic
+Group
+ grpSixDoFRigidBodySolvers
+
Description
Symplectic 2nd-order explicit time-integrator for 6DoF solid-body motion.
diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H b/src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H
index f7f9389b71..787b9e7dbe 100644
--- a/src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H
+++ b/src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H
@@ -23,7 +23,7 @@ License
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
-\defgroup grpThermoBoundaryConditions Thermophysical boundary conditions
+\defgroup grpThermoBoundaryConditions Thermophysical
@{
\ingroup grpBoundaryConditions
This group contains thermophysical model boundary conditions
diff --git a/src/thermophysicalModels/radiation/doc/radiationModelsDoc.H b/src/thermophysicalModels/radiation/doc/radiationModelsDoc.H
index e192421c2f..20b23cb22d 100644
--- a/src/thermophysicalModels/radiation/doc/radiationModelsDoc.H
+++ b/src/thermophysicalModels/radiation/doc/radiationModelsDoc.H
@@ -29,7 +29,7 @@ License
This group contains radiation models
@}
-\defgroup grpRadiationSubModels Radiation sub-models
+\defgroup grpRadiationSubModels Sub-models
@{
\ingroup grpRadiationModels
This group contains radiation sub-models