diff --git a/applications/utilities/doc/utilities.dox b/applications/utilities/doc/utilities.dox new file mode 100644 index 0000000000000000000000000000000000000000..f9cbceeb993d99a5ed7da53a3a8ce18ef70a0835 --- /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 <http://www.gnu.org/licenses/>. + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\page pageUtilities Utilities + +\section secUtilities Overview +The available utilities are grouped into the following categories: + - \ref grpMeshUtilities + - \ref grpMiscUtilities + - \ref grpPreProcessingUtilities + - \ref grpPostProcessingUtilities + - \ref grpThermoUtilities + - \ref grpSurfaceUtilities + +\*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/doc/utilitiesDoc.H b/applications/utilities/doc/utilitiesDoc.H new file mode 100644 index 0000000000000000000000000000000000000000..d953a47480d2d9562b73bf5dd6b08bfa1f16b616 --- /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 <http://www.gnu.org/licenses/>. + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpUtilities Utilities +@{ + This group contains utilities +@} + +\defgroup grpMeshUtilities Mesh +@{ + \ingroup grpUtilities + This group contains meshing utilities +@} + +\defgroup grpPreProcessingUtilities Pre-processing +@{ + \ingroup grpUtilities + This group contains pre-processing utilities +@} + +\defgroup grpPostProcessingUtilities Post-processing +@{ + \ingroup grpUtilities + This group contains post-processing utilities +@} + +\defgroup grpParallelUtilities Parallel +@{ + \ingroup grpUtilities + This group contains parallel utilities +@} + +\defgroup grpSurfaceUtilities Surface +@{ + \ingroup grpUtilities + This group contains surface utilities +@} + +\defgroup grpThermophysicalUtilities Thermophysical +@{ + \ingroup grpUtilities + This group contains thermophysical utilities +@} + +\defgroup grpMiscUtilities Miscellaneous +@{ + \ingroup grpUtilities + This group contains miscellaneous utilities +@} + +\*---------------------------------------------------------------------------*/ diff --git a/applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C b/applications/utilities/mesh/advanced/PDRMesh/PDRMesh.C index e38319f481a6b75d904b01ee3b28398c16d8c68c..f936134e9a36820d7e22745f6ee3901b739d2a1f 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 b3099f4f28a7282f0b6aabbbbca7dca0801b6d07..7cbfa6d9cb35219ee08840ca8d52576aaf0fd57d 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 9854ec2fef56f81c7fef70ee0865da593eec2d50..2666d4c9de9b2a1d37e52f32a62ebdbb22464a89 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 766cd6a6e5ec5d20b4fa6e0f710cb1671dd01c24..320a1f2d96e089164da6d8afbbab397fde0b39ea 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 dc797fdcee3cb9185eeefa4a860ad4991bab959f..fcdd7ec8f1033e451fdf33ac2fde9fd4fdef5853 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 ba5b7f854826ff36b6a6f5d3e1b26cbe798409f6..754568cc4adefec37cef9a11b9ca6c8418f4d336 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 a12adf8413db3a73d3014c23d154b77c6c7f6bd0..744fcf5c5a667ca1417efebeeea525b4bf151ef0 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 64191b8bb0883c5e91bb1164cbcbc521f51c4e47..ca828866011356aea446f5532f12c59ac98d058a 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 c71929e500328d52efda742aaa6eeb8d87dd14ce..87b4398d287ae6dc9baba5a7c9cf1e8456192f21 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 abb29b1dea922e42c2d530eb323a0ff821632afa..4e4f7e026336ce596b4415218ec704bc01e3a99e 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 0e1eb5b1e50c9e16facfed97846d454d90bd0ad8..7e44c20d36e46865c864b46c24c6b47a06ba21bd 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 b95acd79786a3c5cf386cf6ba6a9f148a5414b24..b0bec171f381bac06d2fe78b9320747f9a7b0f67 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 <http://www.gnu.org/licenses/>. +Application + ccm26ToFoam + +Group + grpMeshConversionUtilities + Description Reads CCM files as written by Prostar/ccm using ccm 2.6 (not 2.4) diff --git a/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L b/applications/utilities/mesh/conversion/ansysToFoam/ansysToFoam.L index 9a2129912795542ee273cf7519d988e293edc059..3f17812bb47eadd8c71a76f66b97990f28d9f22a 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 c3d2fef0732a0170350d1c55a3310fc4be598379..af7f86f7b621879ba5d19139969d55f1ad5cfa82 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 4ee10d1f1592905e845dde5708441640d1b46460..2b1956e51ffde2faaf55aacd1dd8ee5fdafd2199 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 1d28f046dc4e4e56a27c95983d98d9d9a7a9e804..3d1875d717287e4548d488dc03cc6c5210689204 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 3300ba9778666021b4665d0c34706eb648bb6cc7..6cff0ce9621e1198b9619d73f7af3d1bab82d6b8 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 31ca1f9db40c9065cb3356b0bbc50c2f33dda44d..d532e27d5fea4adca126035059f257692e292061 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 a345d300157d7df68dccab658299b95f00168d21..adc86dc4b53d55cbbad40235dddb9aca45c53bf5 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 9654b33fc239cf99433bd11a0019b5fd46c9e5f5..16a6752cfb9b058609b8e72a9e05be9926d81400 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 6821af8fba136ccaedb679828d9df4adfa033fe5..c2dfdf43559e4c2c56d4160edd8ee18e534639bf 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 5de646c441850202b1b541dbacaa2545cf594ba3..9d466f64f2ff2c9d83301e4a7d9969a2ef58dc15 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 7a94b27299716fe1a781ecdc7f32a13940d78785..8c14a5373d7a0627936a9ed2de2ac43ce20ff0f5 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 99d522f741496f335dd6946da2f82a2a77b8f0e7..56653cc9217fd705008abf6f74c8820e36e99c0e 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 a69f6047a593f48d4a0f550b2db303cd266ee609..81cc0322fc49f26cfd7749b910092a2bfebc6297 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 e00422072380f925fc0cba1c8fb2f23366e58d4f..93c4267f7729ab612d5207b172270e7b162f706f 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 891af306e10ac1e93d1490357b9a7d8c55c4cfde..63ddfd1e69bdf03a97a0445d51c30ed26a677249 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 5bceed621fc2452cb53c4fc672395df3d8c01436..543b71cba3470662b09e3dcf0bede2baeb0e2fc2 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 9668741305eebd18b3be63949a4f79a25703327e..4e6449b9fd055ed8d5112bfb68a8ce5266077a12 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 f8e1657e79115d077985736147b5574f910205ae..cefbf009d15ee75fa2c5d840c690d80dc01c5b4e 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 46ea78e5993d65821aadd2a0e56446ca664fc01f..7eac6435832c13064845dbba9c6f1cc3fe8214cd 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 4c6c7af788c7b6398ed43c4a44ac598eff32acf3..507d8575e7b8544fdd7aad00506005d6b97f2a35 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 <http://www.gnu.org/licenses/>. +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 3b0a2269339a16d2e19b5662647e979902c03fde..98923ea6eec316f8307392de9b7f0443bb8902ee 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 0000000000000000000000000000000000000000..f0ff94b39c49067975970b32971533e90ecbf9f9 --- /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 <http://www.gnu.org/licenses/>. + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpMeshGenerationUtilities Generation +@{ + \ingroup grpMeshUtilities + This group contains mesh generation utilities +@} + +\defgroup grpMeshConversionUtilities Conversion +@{ + \ingroup grpMeshUtilities + This group contains mesh conversion utilities +@} + +\defgroup grpMeshManipulationUtilities Manipulation +@{ + \ingroup grpMeshUtilities + This group contains mesh generation utilities +@} + +\defgroup grpMeshAdvancedUtilities Advanced +@{ + \ingroup grpMeshUtilities + This group contains advanced mesh utilities +@} + +\*---------------------------------------------------------------------------*/ + diff --git a/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C b/applications/utilities/mesh/generation/blockMesh/blockMeshApp.C index 0c92180830829a17c9e89f23d00bf13550c9ecca..3d0624f74564efdc38a102a7641d2342ef9ced05 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 00ced168eb0968ceab62cc4b8c706cbfa2505b10..d52ed1b29f2c31c326bbcda49fc757151fc270b8 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 91aab57a1b879badf0dab293cee5da90cbcfb2d4..7f35de4b2286aad60553a3ad76590b76b5340ae9 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 a6916b70763a7625dc76bc9798796973baba3da2..ef6cd069e982feb0ec2aa12195ba46a1bf81da17 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 fd8d6f1224a14d4e996bf2fab8b3bb20ec8ced7c..3588a9878f634f72758a6f2a98a4fe1565517a86 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 997726bba6b0a272d53442af9cee12f6469ffec5..f8d605464481064d7090837bb9b7f319c6b53f0c 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 b5187f1e94f1bb9de8882dc1630d89dc1caa8daf..f318d12b5b77e88fca6f8b5afaeba9013bbb8475 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 bf0dff94b0db9e799eb0ac0a7028a09ceae6ddd8..7dea889f8699c85509cbfd839090087314c16d34 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 f35f70b45b00e45a8685703a8535de85f583be7b..abd73d8445ccfebc3ebf90dedd61f32d07b86c96 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 9a3ab3871e522fe8a86d09f3e78cacbb552fc619..c1a07e9fcae21b3dfbf509e0a5010d5c66bc5583 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 d0d1439b852e10e34f5ffdb9c83016dbf00a3662..e5892bef4b8eb73fdb153ecc0f5b8a11e206efca 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 eb89288a30327a2f0b0e41f09960b00997fe4b9d..a97916281dc25a67f8dfa7c9452ebcf80a7525c1 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 58f74475064e7c4ffbfc0d87a616e204219fa0a8..181e80e12dca7a08984f4406169965175b8428fc 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 f10405674d86fd2fa5a97717dfa4acc62667a112..7e2fd95c58b1b2778d85d03025a90d7fb50cd0c8 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 4b0845abcb354be10b330b9e3d8a0e8a7b7fb5b8..177b1838646d83f3bcd2af6b9bc99cea9fea0d58 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 26c67575c7cb4f817fff123388ff79fefffb8ae8..cb80039e79cc7e340ca6985d14e95c03e3ff5a60 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 6db0d3abc634a6969262c6d7e949569c73658985..5d52574886ed8551f27fb45c24f83663e0484e03 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 f7383289cb8bfa8fd58c89c8777abc33ba3a60d7..e06acc0205db7095f3fe6e42040d486716e4bea9 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 2fac9f25c06e80d3101d7eb52b80cf826ae0ad99..7fed198993520a36d484fd140be7e305ed7a533a 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 54727b825af452c098b865bd9a447a86b2578b1a..9757be665548db91473b0ff619181a443a0b6071 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 f2ef2890538fa7efe9b806f456fc8504b3f6858a..0f4049ad7cb4752fc9361962f7cc4aefa5211c31 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 e0da25a52625c5888b98515f31925d295bb9d91f..7b61f097cfa63a43de80d40131b56f2da9c77370 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 5595138322f86b443f56bac466c1fa64048b8e80..a13594496faa356519430bc3baa8bba2465272ee 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 f0c4c16d71b7b139f17417a70e077e02d90745a9..27209b979305a768a644d891ec970024fe26e67e 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 4877c45319d18e93b1a0d038c6c58731d01b0b99..37cce07659b42426cb6b89a2bc4617e29e08350d 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 167afe59dd0e725c72709eb00e4fa33523e10fc7..a4fb8169b0c74f881c6907a82bac15c6a693abcf 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 fb49b074fa48d45a0eef26c94028e03ed2aef4af..00ebde5cd506747f8534b4afe62db9a77b3f924a 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 1cd3ad69586db3f0fc5d4b2e479d2c7247cd2cc8..4919e21d70617aeaabb1e6d5c334f2b3208a11c3 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 8b23cfe5cd5a6e49711056c2c3c7e68b055d1a5c..d855e98ca14143022c5294a53858c43036867031 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 7ce51edf61269037543a8c398520ddb99bddd287..e015102ab14fbfcb80579cc3049fd1016a6e069c 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 5cac0dad7d9d9405487997f0bd2992f842f52ce0..09a3d25d59a613fa2e0ce004171afb56a441a2d4 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 529153f812886292e1cd390eb318316c4283d40c..a5789e7ebdd348e973bd1218e2d4e2f793eea615 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 1902f1543d473fad84c31b22d06f4a04327f2abf..1718d725f982d59c7814a706cf97a7151ba28b78 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 c158b748421dea4b04c32b56be953eb491f49907..19489611c4bb96e9875b0e59be9534e82dfa8e27 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 8f368f1b3f6f06e06ec58304fa29915d0247d0c3..d5e5358bf55450000ee441cc8cf621ffcc218c00 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 cfddb19c2eae539c5df1947a4e060d21a02b50b4..eb13245ec3632c409cc7c8b15074a6c959a53885 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 f4df1dd062bb9c6f96b39b632ae7df372bd52a48..4dbc6a4a75940c8a64e41bab280203c465be4380 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 1b8ecac86d086750eb52230ef5f97410d8d90ea9..cdbd3c76a96843ef10a0ebff6c576fbe7d5c420f 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 1b5670fc83cd767d22cf7b4dec189333e8b11c3f..c9ad6ca0a92201e26ac5e1771fbd583a67a46e41 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 715af2481ad118eb67a0ecdcbd7988f380adb878..81971b85f5f5c3be18241d9efdbeb9db35ab87e3 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 277b7a024ac63f0ea22bf05d8d271554099ff5c1..d4d145ee218bbcb1365e0e9bca3281a54c817e0c 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 74d9028c2bb8d9ff3c737fc34083aa92d77f2973..3b336287f855375e09c4d621e6c652098f3e4929 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 074774676a9115cc23ef6d578f6009942c573c80..2dc5cbcacd32ffdc8a20123dd9a2e49443947c5b 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 06d35e8748e040a639c797092e2d640101b01bac..e5ea04995a826a11bfaf9042796135452eb85cdf 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 47fc4aaccec8a7ca7d7fe42ac1a348942d622f1a..a561f05462920abaaed74b4116ea98b6de6a48e0 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 a4ccd17bb19c47e82ab06ee0aa58df35d4c325d4..182fb79f7f8f86bc08bf1b45699c8d038ab44110 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 a02bf106a7ed7c4c0141418ba2170a1c9499a5e2..f950a4b1adeeeee7a3c9d6ce42fed0ce7d9e49f3 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 8427f9b1b455959a5bfa317e5039afee4eb7f220..a1eb5461b6952aa19eec04f47c4c90740d91cb54 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 234c9d85b3e7fd40577925dae315abfff09061ba..16efc46ffd6deff2d879ce5ad43666e031883230 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 0a3cdf6509d7f43b17363d8d69212cfc7cfa6fbf..1146926afe9b5c67c58b2cc0ab48bbd7c03ad410 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 9014f10ffd8eb0d13b12f6080ac6f779bb209dd0..7c74c7e20383be892a402c482a37fc5366e1ec5c 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 3cf58fde370a52fe208bb09f695502536fe6982e..b834cca26a66f01df1d951bbee40c0a897601848 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 6e50d704717fb450f1872c89352f17e352d600e1..786a137a7dd6bd88d174c1b003f04e7c5316fade 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 b4c26b21cf628f79916777796adc936063fb642e..46ec648fd53185a1073b59382a9a663c9420e717 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 2b186d88bad3ed8bf8be72c3ed36ca491054ac61..5cceb026f451d1e064f21d782267f41c801552c3 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 0a24afc13181e787242f6979247a7ddd4d9c919e..ecdb57f1cf5af039606891d2b44671bffad9b055 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 d6dbcb41e45b6e070945e7e8b59bb09952c51ae4..3a570236a6a47148a7a630b827eb10833fd7a35b 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 11f6bd116e6bca451cff09b3b12426709afc92c4..c306ed14aee5ef75263a69e1e4b54d4b50e11dd9 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 5abf6253fe1166d608ef53ca47c5685ab2837120..c634412aa2428acf7c6250a2290378af56f14e69 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 42904e4c68157c6e792e54fdbb33ff12568aecf8..f5d2261bc548eb7f957d88fab4b79ee3886e4296 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 2baabfa33139cdec69d79c687c69dc6a48a84587..b0c422cc65d867ec5cd7a503afe65c4a73fb17ba 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 88be47e53dfd9a44652a168ccfbdaa6df16c0ead..553f9f7f52dbe6f50e72b5c48e178cf18268f061 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 ea9f4f03bb306fc31440b8b5c7baa5b320597855..57bcfa95108979db8f8a197999bc23e065e7812f 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 93373ee6a973896dc474551c20a24b5a81ee49f3..7533203900ed0ef516c0d3e9f5bba117204af423 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 0f47e54d6af9ea87f4fcabf7604fd6e63fc682a1..59f8c66ea4e5b1c05b76f2404252cd8eb1bc61a8 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 ea8fc4975dc544857a0bacb40a521bb1ca6deb98..37638d2c9fc748fccad6d9841cba8da7fb0e6cef 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 <http://www.gnu.org/licenses/>. +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 873bb53a72ce1cdb2fe5710de453e94da21e0d12..121c88aea5dedb9269b5f16658ffbd3c0e9fcb81 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 002501533948974bd3b1a1942ef31f85dd986c20..fe1a749749c430f8ec023dfb9fc8a1ec07547ec6 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 <http://www.gnu.org/licenses/>. +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 43597560f0d91822a07aa4a2ec6687175354d8c2..1b0ca07fec6c8f66e7b6569c2ef78e7d131439fa 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 53190221b7d21c61b640cd4adc910cd3069d85db..4830e2d54ea9f8240407ecb7f1937ed09a0a53f3 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 e17f43cf29215b51afb8b988908e854e6fcfa54b..f1a26f65049b7b229e2f06406d1e4693bfe8827d 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 daf48a3f681a1f2ddc65f13b1b0733b33128060a..40ce8dc0388f42e2b9e5f8b9c207efa9290782bc 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 59abc2e2f18ec888ad66ac078f9d29a90f250a0a..0f47b2bca8e696934f8080883bf80a9ac2ae12a4 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 46b11f79f2bc8bd01b23b1e0b7c2c4cb7222ddeb..e24c4b8542cf09c4708bc940d44a5c18207849c1 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 2d7bab324c8067b36a383a13c4a186fce8ec5f16..d75ece47371b952e9550e0973cee4d8303f54738 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 06ceb70f49a44113ae57f8279460f9a391438583..64754db86865ac00e04315b9a2a03fc3a8f3452a 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 1e88dd92d3052d86079fc217bf8bbf4a57ac4a48..96e6a2107f56d4807875452044c5faf59c91e429 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 3208b5beeb0641d8dd0b88be6c9b218d0637f58a..d545ae0b959df8d699cccebee73479bfa1e70fef 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 9914a3a098476a805520617e84f2ab27d151fed9..9fdd797c9229a1f8b56ef4da6e76b9415c2f74bc 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 69c4964429200f0a4c23f08e0174dc4ca43c92f1..79e9c5bdb2167dac584afa54194fb58258836850 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 b54a4ce399d108e1832d1f45efa0c3bac1b8a07a..04f1b7c2021e675a49cc921d34e83ade36744f97 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 ea681d69d98b1051d5eee424033fde0e5c93a8ca..971ea8d73fd7ac7c2580559260cdaa8cfed46b5a 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 309393d19d9c9b7ea55f775aa99ddaf487870a91..d26668d52e9cbd39746bcf0ac3859f1ef0698bc6 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 120c197a91dde7c4a6627e941ead18ddb3ffa95b..341832e65565c13e44359496bdd8c077a4a65005 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 8b1b9f15b05b4f4dc83ff3106fe67d21ffb1bdc0..2ec5c4442780b237c785e50235927b6ac0a46e74 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 7662dff311d8632da0a2948325707ba58ccd793d..efc95a8bd3dc98bb011620cc9ca2f5adca04571a 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 650d075ea735054f7b87d0c544f954cc1f22b747..9d5b29f498ac30255eb6820220ef8aa1d581d965 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 d1c37e70cc48ad7dec9a9c61bb026e97cf8cca1f..00a2211d2c4e6aeab2be63b25772ac7f08844ed0 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 6d8b48dff673c153a4faa61ef88402ff7ac00af0..025f3a5a27c608e9097d0ebcb609d66d80fae5a2 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 04d80ab6c020e24aa667644ea19594ae26120909..492cd57fd71209bade56fb62df0be566a01514da 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 7b597bd77713a1bbbaeeef01b6ab1ea2938744eb..3783227fa3855aa758aa8d0b0cab07b52f030857 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 4ed0356e1cc1976078d4d7c8c7a2931c1ff49322..56cfb42d320836bce4cdd4c4955f717e06ce4d7d 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 adacf92248d8d592d02c17cb6f520d43b7daf1d4..30f0a480fc547f7407dd8c35ee75fba44546df65 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 6a8b78c6837494f75bb4a30a1a419f7fdb26c39b..bcb6fa78600845b20bc222500f33f694b322adb3 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 e7da84054726bfd458ced8f6cb47bf022ed42df3..68ef4c3d69d7a6fe09fe9c9c2df87deb9311fb6c 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 e873f10d770480106f9ced2b7d0c556e1908c14e..f2a2574e9daadfe8c02e5389d911cf92e783c6f7 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 4652cb2afd9c5f6a54b43dc10e32c757d688b592..f59d166d680e2ed1ab9e7d2a5c5ce41d00079b84 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 163c9fa8c101fe133423d28135a5bc9b7f642798..808e9a7cf8f2e0bf19f155f75d55fb4bcc687ee8 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 7f2746338c71a9a85abd0e5eb553f2c2d638833f..66e2f4f65155fbc2d36da30c37b11f560a323579 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 6e3f4ef06b9ae036e5426ec2fa4bb2d0482360c8..5eceb0c2b563f5b339ba2525d6a52ebcfb1d2da3 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 fdfdaad1da2e1d5a22838f92e6140a2b6cb6b3be..2043644e20d6029ef5b417f908ec95e32c1f6118 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 7af246cb25d0c13aa74df732556b64fff8a51cc2..a3127cdc1f04f58edb10b6de551d7824cad941ec 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 <http://www.gnu.org/licenses/>. +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 7d22cec68bba91da0ae33d9bfc9e131e5ef6de86..9517689240129445fb7778989ed5150e10cf50fd 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 <http://www.gnu.org/licenses/>. +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 02f0c5d9ad3f6d4dfe2ea546da74b24e109bedb6..11a8becd5adfb715bab67bce382afaa138149635 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 eca14ca40c10b17e91c28670acb3918f1feb1ae8..6e2da726605363a85bac920f504c960729378570 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 9ac5bbbb94b0603573afa9c3d98b99f23d3e4645..5072534076fae288775aeb545723337defde4f35 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 f8c094c4bdf5c5acd213f9865391decbe58361ce..c24520790b18206ab01aa61b85624ab290f64522 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 16989e477150fc943b8823dc5f67121cf3d143c3..7b223a36d9df834b6fef5bbe99f10a077132e686 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 eecdbb5155e49eaae492156cc893c964beea5627..6c55ce14d526870093e32c43d944379ac6c0e11a 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 fdbeca8e28b56b5d22c49e06416f52e91c83bf5b..24284ec5d4e1888a1b3765b6bb557e5aab3b9588 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 1d79b08059bc2b547c29b30d89659171d7e0e134..c1f637c3e25bc265bd8e7c250a5fa32157ae7a35 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 1263b7813a510f27a18c3d728399c6e3952a14cf..bf9f1040ca77de27dc39a9ca70af552e655d445d 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 5c81c5699c02f1288037a76f1335f923641131b8..9c9db1babfb4e9a10092706b1d03bfec069e7747 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 b002e13d315fee0fd0bfeb369cf35ec56c625810..279411cc7eca2bc6c5c4ee262997c71e5f2c680b 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 b7c5ca03b2a3125727cda5f68b37781269df7d23..64c0f5f5fa61738cd5e8c0d473e4bc677e06ad45 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 3c832966976da7b9334ce638b736a6438d1d7b0c..e566d09ca2f9b5285d2137d5e308775b71241476 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 e30ff5fc551b8e8396a71be5446cdb1602d047ac..c8edf919628efabb54a55ac53486bf78cc2091ac 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 0352ce0eef6ae76230a492a821ff3c4ffc6ae675..e7006475c78eed0f6320abc5a590172be70f3a52 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 e34cf579b3df9132dfd2e182d235779371477496..c35819d0085624f06d460ab3c29a5d6ac413e05d 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 12bd9f32e2222c82f7200361c536434b7a3f14cc..dfd2d5f2ccd8dcf67aee7948fb04551ddd41ca0c 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 d9c98b3e7459ff6a41b56c59de904f0b7a6ee3db..11accd59cb5850d60716adb69322cb8891768796 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 708d5ab5baff716bb1cd4006965bacb545f42dc9..553439802667fed339fdc98a3ae64ad5b0ccbbec 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 0129154b84c2b114ab9d3370af7a3cee6065fd78..3ea27c4f8b677b92260c7254055196bc18b1200e 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 580411eda6420d520de57f97db93b08434588732..2a42bd8ce0d1d263565539bf3e2a720ae93bb051 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 29b60c791677faf28e357f19b408230fbda9179a..4dad7dd57019647cb595d9f859b064ed0ebcacf4 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 3df36f6ec652ed3cb79d8a7ea3c3640d33fb50f4..474a820623bc3cedc5c15eda34f28a5ae79c4f37 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 585072d7c02e8ece5a1debfe5121fe96bcd3a67d..830e861654cfbd3dc203b6a42aa6fd01f26ae728 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 c94e56ac4cce86fc34f6e3662aa8098ca24db479..d6bb838e1bf70f266939372810bf21487a2f0867 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 d5d1dccd20518c9e906f3b279366383807feb21c..2dbea9fce6dbbc908cdfddab3c70dd9c76c2b066 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 2825822607c2620f0d7a4f54b544fca540b599e2..ae79b9573c01426288326e54c25c0e1d0d208803 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 c90dee56e939936575d0c27dcbf6c6c9bee0d7fc..d45ce8315420d9abff31b020c1d30a88bd3614b6 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 <http://www.gnu.org/licenses/>. +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 b490fe726ad53684821e53e6a6476fd042b34b23..b8a869ef76711a5bc4b8696bb38af22e6a46f5aa 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 0a77fde05f3c01ee523cc3d04d5eb495be6cd8d3..70932a615c61374a9a1e9f9768593d7c3ffddb0a 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 bbcf96b96e3a57aca7b44364a4252a404e11a68b..f450b6d453f8375431309a09dd5c6124dd7b8f18 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 3dcc86b9a9e278f359a57de7a02761e10f7cb90a..2f1f7699caab6cf3000d9d9760bb9964505e8d5c 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 2e41a7870e38a0a561c8b03ea9bd9a3a0ba75614..7ed0fe3f46d99567238712bf9203e21ff2da2587 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 e91f968a8724d421d3b1c3de981115eb54698b92..83bb9b1db5634e985f9db067d4e13d06cd55d232 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 9ecd074bb4cf85d35f9e642362722b4345e4e417..974b9c85493c87b66ceeffb080b54de94ec95dc1 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 fae3960ab6602b501700856e91f60333cb691144..0f2407223c8e0a2ab51ffa1d928f28f394a87485 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 c755532d65781541df32bcf0db10ae3e778a3a4b..227ddb1be8ffa18a3dcfd08b32ef2c6d61425841 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 fecfc57fa03bc9c73a19c37c08bd22f8fa57804d..228bbdea6d9dd63fffe4cd5632e9a115db8380b9 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 a6703cc20c7e61ed85f84da530e74aacc1981a19..c9776d97134281be1444d0e4824986062eb397bd 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 de4ef399f89cfee927dd7eec2496e96452f7e6f7..5d9cd4a70baad9e7485392950c3208a10bc3dbc7 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 c376a5f423f491013f81dc7a60b202a3e17f9f22..3a315237d262f580c1dc16190d7cfbb9446d1dd1 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 b3f5c7bca4ae0a8d36396c31039c5e43a714bea2..f5f783592fbef16b8afd18adadf1fc27ae6df08f 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 5198d5553f214c847eea1a645f2fa3777d5833f4..735fe5e12eb86eba2fe75bf503fca2813306c6e7 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 b0bf1c79efffd9bb9cc437960d8e997f88c9ab1a..318091b6b85ba8bc42b530279ffbdeaaa96bfc26 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 38541a7c99c422143ecb478e4fddff41aee6b23a..ff97cf10c780233bcc651d0cdaddbf81c4cc2d6c 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 2af18e5d409d4b8d568897d452451b18d69804e8..9d57979a460836d24c953d61f8fbdfbca7532067 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 0ef0a1d40cd61783d49231085ba3aa82863d5ccb..83e5385c29574d9c3290b14e290f13ade7e60b6c 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 667b6ee2adc517fcb51d576df2e13527951432a3..1f1c5e667482dfa7d8595e3ba0f1e10da09e2de0 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 0d7dcb035c2c312ceb3d383bc2fc8e24cd19ced9..141ec9bb7a6099bda155ba7cc7b86daf77c568f5 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 75f0262813b5d2d2aa3606c005a36ac6fb84b93a..60d6eda44662fbbbba251f3e938db5ed5d221031 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 35cb468f6a4bfc70840c003dcd97cae51df94381..87051184db2c19e17cb88e0ae999d405e4fcf9f5 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 c3cd5401983bd100a4c6b967ffa41dc1ffa161e1..224ccc6f90641411dc4f9f9253a937b573c0fce5 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 0000000000000000000000000000000000000000..bd293c58239c661a35dc1d26017b4d33d6c905bf --- /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 <http://www.gnu.org/licenses/>. + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\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 1c294e35bf916d8437503c0d6e03a9d2f8541fda..29128860247ae56a73a9e49689951803c6da4beb 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 c65a7170c29497e4050006dbe3874807b572f70d..5b589b022162a026d4f7bc47c174e8b352851842 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 aeea3263fb1443c7d9e42173fa58ecfe9413c1a8..3c7a006033d11a8909a0a1702e580417404f8dea 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 651e95c161a83679cdf9abdc2e5d65f8618d562a..82709888aec2211c146b919ccd4b919f1eabbbb5 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 91eab7254d848bea1b925767fc10f35956e86781..926d957680de34d21d3aa1339cbcae6490cc361e 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 c9b4b6fa7d5552873b2a3a23bbd3b7f6b92177d6..2d4e17b63725c8a3a684c92679834346aff689cf 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 51614ab2e680a6c1f16b4fc9dc7811861d5e21e3..cbcb37bc835f81e8f39d7fa86771bae3ed58fd95 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 badd4848294db278c4d07cfd8f7f01a5c882d010..b5d218cc0a186633fa9adb3cc1d9728223947386 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 a3023ee32bd831a0a12bc74da18960640ee96518..59b6ecda4d24eef701436f84cff98c36e91e4e8f 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 f7143d00ee4225769ea86c4161246ead694123f2..af81c192282b180d3122b83bc28cf50e8ea1e906 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 0000000000000000000000000000000000000000..53c5e1debd8917dfc8fafb84759aea82dbbda2c6 --- /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 <http://www.gnu.org/licenses/>. + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpCombustionModels Combustion models +@{ + This group contains combustion models. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/combustionModels/infinitelyFastChemistry/infinitelyFastChemistry.H b/src/combustionModels/infinitelyFastChemistry/infinitelyFastChemistry.H index 08dec407c0815317487903051ba1e4c6f4fac81a..16a89b9cee7c602f11833c3a958316c01d506cb1 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 0caf5a80f09402d1af1d3ecfc203e8b386261717..a4589d4ac1b4598f28000c2d6f3b6e8b2cc470e6 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 7e7a3b37818d874c934e49d4c6e454b7695f8b74..641970fd6ff0840bea6d0506e4e4e6b2e48c9229 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 404bfe1c137eb9b5afc0c9059ec8496586470e26..4a17add9f13a0f4cde35c48af247d07e92750838 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 8b6889ea030a70f6603f2b44747a2e41343feb17..47684ecc4ffb90e6ace9407d3c1ceac4d6e6ea44 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 \<field\>.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 0000000000000000000000000000000000000000..818a34eea981f7088441fce1559e379558c5c9e2 --- /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 <http://www.gnu.org/licenses/>. + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\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 e4b1ae96059c92f3509a69e80dc046911d6343f4..bed5a61674f0c9adbc55d3e14712bc12034dfe5c 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 bc7c746ea2d2e4d12aedba9b9aa83a6c4e86991d..d4075ff93b58196af391033453701aef9372fe2e 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 3a4779d9db8cd47fed214e9ff3b3a4068d461a5b..5e4c7b64c1fc98ab6cf022673d8e7fa760b765a0 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 374241734933c88058aa556859b9a403ea6f9350..2458d1d400c2affdce19c4b9a06d887b1b9c10a5 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 7ec7790985b2b3bf210e1cbc32626affce3c5087..1df49597a6b9fe9c230105a0e0114e0b1ed89887 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 c876e560ef65e47fb6cdaa08fa3af1f7e94b26dc..be002c6056b650204b271a5531a7a9d5866b1960 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 719c699449196fef192c3362f29b9790d8500f68..77f83e5ad5463350d5dd9c668089f1d0e6de4415 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 479234dc22ddc81d6b58a91e2bd9c22adbd2a849..af213a96756a9f57d8fb7183435514533b5de42e 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 238d0a0a5bc0b43d0a31861bd38fba6d98432a97..a4b300bfeebe784a5b9e6999a613deeed441c575 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 e9b8fed1508246f1eedb619433ee712afe639551..29ca6fe361cd309388fcafafd0542770a98be9ca 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 662ed39e8ae9991993d298fdcd8a41a1c9b71deb..0d7a353d949f93e569f7e0a84ba701b39b544c63 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 7432f7cbc0738a3f5006d6aaa89de1bb6bd9f066..348792db4adb9a6d259ac3533d1fcbae819f2b48 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 1784de009db94ff2a0144bbc7432bbffce88e422..a4b3d41894d39dda3a0ce97f2c9d17390fc8004d 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 a29585e3f6b0ec0673692cf585c1be1b17bb62e8..0375a54684221fe2ee353e54715b17a2935d46e6 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 2c8679b1e42bf964f757b6477f4e32aaece25c18..6307234184f99c297c86ebf8e2f0aa59a32b7a15 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 e3310f735d293a47dac349b47f73b127aa507870..7538f367c4cf0d3758b7c8fc25d8830406ed050a 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 0cd3f7c930dd721871b5db7e1381067b778f5cf5..c6a0bc220ee0cedf6cc3a11cfe3b45ec144be30e 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 0000000000000000000000000000000000000000..20f1db927bf92a0cc985df2b5573ee39b9df2efc --- /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 <http://www.gnu.org/licenses/>. + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\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 d67af31d9a9dd29e768a220c449c542b151cb475..7f02161422b929ae53fc4a6e5cf38d358ec95fe6 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 979abcf5c001cc46662df4dbc6fbe4875dcf8e7c..dc03df42df1c0bc5cd6d98d87babbbe973d8606c 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 02746bf14c740cdbe4e7a4e267b874f13fbab8d5..8f4a83cc02881f06095312c7cd2b9ffcb3f172f9 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 bcbcd47785e919c6567a691e86998e62cfb44a01..ed324124afea44bde021323c26a91ff41edb528a 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 611397ded5dfd1f0ce5ae88093a510b558b803d4..bcb9d39df40859850474a3e9cf156d869fba93f8 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 cd634f7b89ce4efe2acd0f2d64b84509f43f85e1..8a3d342edb484e6633b66046d1b037b2b7b985fd 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 f689869056c224c29652693912ca4f747ef11b11..7a0ae947c6610a5d964959c158710d1014dc34e1 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 892cfcb7099b4e4472afdd62f0c66c0b482a4381..c66667a5425a909c448ea789ddf2a0152fd7f244 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 43582796dee2a3f71b2e1b4e21777bf267d42e75..9377f33046fc586e20d7e80e4a915b19ce0b19d1 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 0a870bd9254dfd3fc44318dc908e5303b5578e7b..832fa26a2789139fecc3a4eec96deb4ea0be0da6 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 1371abcf8000938232a8255b9aa8adf8f4e486a0..77a2761c19146a59b7db5e8c26105529f5f13e79 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 01ed3139b0a05cc45ea629859fb14aeba1e977ed..d7c848671091c19f34a50ed930d9af710385e023 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 3aeb85dd63780bcab0f05c9de0f115d977904ab7..9797904352e2fd590183116cf311012e68aece0e 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 5d12bf5025d70be05943b4fdaa16d0d7a6b6f7c3..709b7abcb0a22abbaebca78897cf1b03c0a9842f 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 58c314d7840ad18e21540ba18276e485c64c56d0..785077755910b9adaaf0c73f94723e4b6a4d63af 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 0ea00b678bcd0699eaa16bd109caabcfd7ce40c2..10bdfc849539bceb030b03e8b1532e4feccd1083 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 cc97aed72bc7952f075174a1f9c820f14d6aae33..de3b1164af9f08da6a5fdc1615e99d04eeeedaf9 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 66b34e0df79c621ffb3ef4d8bd17e266175a2916..4698baee707dd8b3bf7adab55427572d0fbf2d64 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 c0a2c3728824cfd67570f1a5abeb1bb7841c2d20..b329dcb0de63cf07609553af4a38b1714014f503 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 b7a90f77d0049965bb28bc536c6d90871a6d7749..c522ffd3f838662b18a98471bed68949690fa2fe 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 ccff2ff660863913966f7477b95ec12f00c9ef09..ae0f3356d17418323491a11fee17bbc091dc96ee 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 35234268d915a39f02ff21288fcd45583301b5ce..1c7b6b8c0ed32d9399bb7179e15856e363b2a041 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 0000000000000000000000000000000000000000..585cc5ccd8125864001a3f12ffde159235276f69 --- /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 <http://www.gnu.org/licenses/>. + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\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 2ad4921aaa961183ed9b1040a7da90fdde1c764f..1c9fd69fc7e323f1a8f8fb9f51b3675a19d0e860 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 a8dd2ccbff3d5c11a7553b1f7475de82fd3bada8..e2f7ae82266efa59d9d32fa88b89079aa2d533f8 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 e605fcc294a3103afb4a4dafa633636ca622b577..d15bc2fcb1fa9d33729e042b630355a7534f5585 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 cb00660314a1be4042070224c4cc0aed1f75cfc1..a1e536f755ea4594f537abfa6e9839d472df032a 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 d03b77bbd59593ea9e914fa828caba5dc2a40a30..3aac7c7e1822fc09bdf7eaee545f3d86f84db61c 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 f7f9389b7188a11ba552920b52956128e8ec6369..787b9e7dbe96924e581f70199deecbc57ae1f36d 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 e192421c2fe906bfcbd8cd40c1a7b8fc42a24dab..20b23cb22d26e0d2d923baa73f8bc64394418c9d 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