diff --git a/doc/Doxygen/Doxyfile b/doc/Doxygen/Doxyfile index 88a67c002d..cce0feda75 100644 --- a/doc/Doxygen/Doxyfile +++ b/doc/Doxygen/Doxyfile @@ -477,40 +477,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = $(WM_PROJECT_DIR)/src/OpenFOAM \ - $(WM_PROJECT_DIR)/src/Pstream \ - $(WM_PROJECT_DIR)/src/finiteVolume \ - $(WM_PROJECT_DIR)/src/transportModels/incompressible \ - $(WM_PROJECT_DIR)/src/transportModels/interfaceProperties \ - $(WM_PROJECT_DIR)/src/thermophysicalModels/thermophysicalFunctions \ - $(WM_PROJECT_DIR)/src/thermophysicalModels/specie \ - $(WM_PROJECT_DIR)/src/thermophysicalModels/liquids \ - $(WM_PROJECT_DIR)/src/thermophysicalModels/liquidMixture \ - $(WM_PROJECT_DIR)/src/thermophysicalModels/basic \ - $(WM_PROJECT_DIR)/src/thermophysicalModels/combustion \ - $(WM_PROJECT_DIR)/src/thermophysicalModels/pdfs \ - $(WM_PROJECT_DIR)/src/thermophysicalModels/chemistryModel \ - $(WM_PROJECT_DIR)/src/thermophysicalModels/laminarFlameSpeed \ - $(WM_PROJECT_DIR)/src/turbulenceModels/incompressible \ - $(WM_PROJECT_DIR)/src/turbulenceModels/compressible \ - $(WM_PROJECT_DIR)/src/LESmodels/LESfilters \ - $(WM_PROJECT_DIR)/src/LESmodels/incompressible \ - $(WM_PROJECT_DIR)/src/LESmodels/compressible \ - $(WM_PROJECT_DIR)/src/errorEstimation \ - $(WM_PROJECT_DIR)/src/dynamicMesh \ - $(WM_PROJECT_DIR)/src/triSurface \ - $(WM_PROJECT_DIR)/src/edgeMesh \ - $(WM_PROJECT_DIR)/src/lagrangian/basic \ - $(WM_PROJECT_DIR)/src/lagrangian/solidParticle \ - $(WM_PROJECT_DIR)/src/lagrangian/dieselSpray \ - $(WM_PROJECT_DIR)/src/engine \ - $(WM_PROJECT_DIR)/src/ODE \ - $(WM_PROJECT_DIR)/src/randomProcesses \ - $(WM_PROJECT_DIR)/src/sampling \ - $(WM_PROJECT_DIR)/src/meshTools \ - $(WM_PROJECT_DIR)/src/dynamicFvMesh \ - $(WM_PROJECT_DIR)/src/topoChangerFvMesh \ - $(WM_PROJECT_DIR)/src/fvMotionSolver \ +INPUT = $(WM_PROJECT_DIR)/src \ $(WM_PROJECT_DIR)/applications/utilities \ $(WM_PROJECT_DIR)/applications/solvers diff --git a/src/OpenFOAM/containers/HashTables/HashSet/HashSet.H b/src/OpenFOAM/containers/HashTables/HashSet/HashSet.H index 5c7f893671..4bad027fd1 100644 --- a/src/OpenFOAM/containers/HashTables/HashSet/HashSet.H +++ b/src/OpenFOAM/containers/HashTables/HashSet/HashSet.H @@ -28,6 +28,11 @@ Class Description A HashTable with word keys but without contents. +Class + Foam::wordHashSet + +Description + A HashSet with (the default) word keys. \*---------------------------------------------------------------------------*/ #ifndef HashSet_H diff --git a/src/OpenFOAM/global/foamVersion.H b/src/OpenFOAM/global/foamVersion.H index e6d1630da2..d46dd65150 100644 --- a/src/OpenFOAM/global/foamVersion.H +++ b/src/OpenFOAM/global/foamVersion.H @@ -30,7 +30,7 @@ Description Global - foamVersion + Foam::FOAMversion Description OpenFOAM version number static string. diff --git a/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/coupled/coupledPolyPatch.H b/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/coupled/coupledPolyPatch.H index 5c37ea0528..e272e7db70 100644 --- a/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/coupled/coupledPolyPatch.H +++ b/src/OpenFOAM/meshes/polyMesh/polyPatches/basic/coupled/coupledPolyPatch.H @@ -23,11 +23,12 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - coupledPolyPatch + Foam::coupledPolyPatch Description - coupledPolyPatch is an abstract base class for patches that couple regions - of the computational domain e.g. cyclic and processor-processor links. + The coupledPolyPatch is an abstract base class for patches that couple + regions of the computational domain e.g. cyclic and processor-processor + links. SourceFiles coupledPolyPatch.C diff --git a/src/autoMesh/autoHexMesh/autoHexMeshDriver/autoHexMeshDriver.C b/src/autoMesh/autoHexMesh/autoHexMeshDriver/autoHexMeshDriver.C index 6435d491d9..b753e26785 100644 --- a/src/autoMesh/autoHexMesh/autoHexMeshDriver/autoHexMeshDriver.C +++ b/src/autoMesh/autoHexMesh/autoHexMeshDriver/autoHexMeshDriver.C @@ -22,9 +22,6 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Class - autoHexMeshDriver - \*----------------------------------------------------------------------------*/ #include "autoHexMeshDriver.H" diff --git a/src/autoMesh/autoHexMesh/autoHexMeshDriver/autoHexMeshDriver.H b/src/autoMesh/autoHexMesh/autoHexMeshDriver/autoHexMeshDriver.H index fccb96a337..6576e3699c 100644 --- a/src/autoMesh/autoHexMesh/autoHexMeshDriver/autoHexMeshDriver.H +++ b/src/autoMesh/autoHexMesh/autoHexMeshDriver/autoHexMeshDriver.H @@ -23,7 +23,7 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - autoHexMeshDriver + Foam::autoHexMeshDriver Description main meshing driver. @@ -85,9 +85,9 @@ class autoHexMeshDriver //- Extrusion controls enum extrudeMode { - NOEXTRUDE, // Do not extrude. No layers added. - EXTRUDE, // Extrude - EXTRUDEREMOVE // Extrude but afterwards remove added faces locally + NOEXTRUDE, /*!< Do not extrude. No layers added. */ + EXTRUDE, /*!< Extrude */ + EXTRUDEREMOVE /*!< Extrude but afterwards remove added faces locally */ }; @@ -107,7 +107,7 @@ class autoHexMeshDriver } }; - // Combine operator class to combine normal with other normal. + //- Combine operator class to combine normal with other normal. class nomalsCombine { public: diff --git a/src/autoMesh/autoHexMesh/autoHexMeshDriver/pointData/pointData.H b/src/autoMesh/autoHexMesh/autoHexMeshDriver/pointData/pointData.H index e989184699..7b5634eb50 100644 --- a/src/autoMesh/autoHexMesh/autoHexMeshDriver/pointData/pointData.H +++ b/src/autoMesh/autoHexMesh/autoHexMeshDriver/pointData/pointData.H @@ -23,11 +23,12 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - pointData + Foam::pointData Description Holds information regarding nearest wall point. Used in pointEdgeWave. (so not standard meshWave) + To be used in wall distance calculation. SourceFiles diff --git a/src/autoMesh/autoHexMesh/meshRefinement/meshRefinement.C b/src/autoMesh/autoHexMesh/meshRefinement/meshRefinement.C index ffac7a5e8d..14dc51dca6 100644 --- a/src/autoMesh/autoHexMesh/meshRefinement/meshRefinement.C +++ b/src/autoMesh/autoHexMesh/meshRefinement/meshRefinement.C @@ -22,9 +22,6 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Class - meshRefinement - \*----------------------------------------------------------------------------*/ #include "Pstream.H" diff --git a/src/autoMesh/autoHexMesh/meshRefinement/meshRefinement.H b/src/autoMesh/autoHexMesh/meshRefinement/meshRefinement.H index 1919c860f8..ef71ed989d 100644 --- a/src/autoMesh/autoHexMesh/meshRefinement/meshRefinement.H +++ b/src/autoMesh/autoHexMesh/meshRefinement/meshRefinement.H @@ -23,11 +23,12 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - meshRefinement + Foam::meshRefinement Description Helper class which maintains intersections of (changing) mesh with (static) surfaces. + Maintains - per face any intersections of this edge with any of the surfaces @@ -90,9 +91,9 @@ public: //- Enumeration for how the userdata is to be mapped upon refinement. enum mapType { - MASTERONLY = 1, // maintain master only - KEEPALL = 2, // have slaves (upon refinement) from master - REMOVE = 4 // set value to -1 any face that has been refined + MASTERONLY = 1, /*!< maintain master only */ + KEEPALL = 2, /*!< have slaves (upon refinement) from master */ + REMOVE = 4 /*!< set value to -1 any face that has been refined */ }; diff --git a/src/autoMesh/autoHexMesh/meshRefinement/meshRefinementBaffles.C b/src/autoMesh/autoHexMesh/meshRefinement/meshRefinementBaffles.C index c37f3cc36d..5e6a4be44a 100644 --- a/src/autoMesh/autoHexMesh/meshRefinement/meshRefinementBaffles.C +++ b/src/autoMesh/autoHexMesh/meshRefinement/meshRefinementBaffles.C @@ -22,9 +22,6 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Class - meshRefinement - \*----------------------------------------------------------------------------*/ #include "meshRefinement.H" diff --git a/src/autoMesh/autoHexMesh/meshRefinement/meshRefinementMerge.C b/src/autoMesh/autoHexMesh/meshRefinement/meshRefinementMerge.C index 74ee5b4bf3..f8e7b366a4 100644 --- a/src/autoMesh/autoHexMesh/meshRefinement/meshRefinementMerge.C +++ b/src/autoMesh/autoHexMesh/meshRefinement/meshRefinementMerge.C @@ -22,9 +22,6 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Class - meshRefinement - \*----------------------------------------------------------------------------*/ #include "meshRefinement.H" diff --git a/src/autoMesh/autoHexMesh/meshRefinement/meshRefinementRefine.C b/src/autoMesh/autoHexMesh/meshRefinement/meshRefinementRefine.C index 48f1ba8d9f..bc0ffe26c5 100644 --- a/src/autoMesh/autoHexMesh/meshRefinement/meshRefinementRefine.C +++ b/src/autoMesh/autoHexMesh/meshRefinement/meshRefinementRefine.C @@ -22,9 +22,6 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Class - meshRefinement - \*----------------------------------------------------------------------------*/ #include "meshRefinement.H" diff --git a/src/autoMesh/autoHexMesh/refinementSurfaces/refinementSurfaces.C b/src/autoMesh/autoHexMesh/refinementSurfaces/refinementSurfaces.C index 6dbccc7c14..cbe1be1ad3 100644 --- a/src/autoMesh/autoHexMesh/refinementSurfaces/refinementSurfaces.C +++ b/src/autoMesh/autoHexMesh/refinementSurfaces/refinementSurfaces.C @@ -22,9 +22,6 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Class - refinementSurfaces - \*----------------------------------------------------------------------------*/ #include "refinementSurfaces.H" @@ -261,7 +258,7 @@ Foam::refinementSurfaces::refinementSurfaces << " which has regions " << regionNames << abort(FatalError); } - + label globalRegionI = regionOffset_[surfI] + regionI; minLevel_[globalRegionI] = iter(); diff --git a/src/autoMesh/autoHexMesh/refinementSurfaces/refinementSurfaces.H b/src/autoMesh/autoHexMesh/refinementSurfaces/refinementSurfaces.H index 9e0b720d68..625fef00a4 100644 --- a/src/autoMesh/autoHexMesh/refinementSurfaces/refinementSurfaces.H +++ b/src/autoMesh/autoHexMesh/refinementSurfaces/refinementSurfaces.H @@ -23,7 +23,7 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - refinementSurfaces + Foam::refinementSurfaces Description Container for triSurfaces used for surface-driven refinement. diff --git a/src/autoMesh/autoHexMesh/trackedParticle/ExactParticle.H b/src/autoMesh/autoHexMesh/trackedParticle/ExactParticle.H index df4d0c61c3..80146fc700 100644 --- a/src/autoMesh/autoHexMesh/trackedParticle/ExactParticle.H +++ b/src/autoMesh/autoHexMesh/trackedParticle/ExactParticle.H @@ -23,7 +23,7 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - ExactParticle + Foam::ExactParticle Description Special version of Particle to do tracking on non-convex cells. diff --git a/src/autoMesh/autoHexMesh/trackedParticle/trackedParticle.H b/src/autoMesh/autoHexMesh/trackedParticle/trackedParticle.H index e064a4da81..2678be6b86 100644 --- a/src/autoMesh/autoHexMesh/trackedParticle/trackedParticle.H +++ b/src/autoMesh/autoHexMesh/trackedParticle/trackedParticle.H @@ -23,7 +23,7 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - trackedParticle + Foam::trackedParticle Description Particle class that marks cells it passes through. Used to mark cells diff --git a/src/dynamicFvMesh/dynamicRefineFvMesh/dynamicRefineFvMesh.H b/src/dynamicFvMesh/dynamicRefineFvMesh/dynamicRefineFvMesh.H index ea47f6e3fa..e2c0ac5992 100644 --- a/src/dynamicFvMesh/dynamicRefineFvMesh/dynamicRefineFvMesh.H +++ b/src/dynamicFvMesh/dynamicRefineFvMesh/dynamicRefineFvMesh.H @@ -23,11 +23,12 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - dynamicRefineFvMesh + Foam::dynamicRefineFvMesh Description - fvMesh with built-in refinement. Determines which cells to refine/unrefine - and does all in update(). + A fvMesh with built-in refinement. + + Determines which cells to refine/unrefine and does all in update(). SourceFiles dynamicRefineFvMesh.C diff --git a/src/dynamicMesh/polyTopoChange/polyTopoChange/addPatchCellLayer.H b/src/dynamicMesh/polyTopoChange/polyTopoChange/addPatchCellLayer.H index 7e443d76f7..015238970d 100644 --- a/src/dynamicMesh/polyTopoChange/polyTopoChange/addPatchCellLayer.H +++ b/src/dynamicMesh/polyTopoChange/polyTopoChange/addPatchCellLayer.H @@ -23,27 +23,29 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - addPatchCellLayer + Foam::addPatchCellLayer Description - Adds layers of cells to outside of polyPatch. Call setRefinement with - offset vector for every patch point and number of layers per patch face - and number of layers per patch point. + Adds layers of cells to outside of polyPatch. + + Call setRefinement with offset vector for every patch point and number + of layers per patch face and number of layers per patch point. - offset vector should be zero for any non-manifold point and synchronised - on coupled points before calling this. + on coupled points before calling this. - offset vector of zero will not add any points. - gets supplied the number of extruded layers both per face and per point. Usually the point nlayers is the max of surrounding face nlayers. - point nlayers: - 0 : no extrusion. Any surrounding face being extruded becomes 'prism' - >0 : should be max of surrounding face nlayers. + point nlayers: + - 0 : no extrusion. Any surrounding face being extruded becomes 'prism' + - >0 : should be max of surrounding face nlayers. - differing face nlayers: 'termination' : (e.g. from 2 to 4 layers) match at original patch face side. E.g. 2 boundary faces on patches a,b. 2 layers for a, 3 for b. + @verbatim Was: a b <- patch of boundary face @@ -51,7 +53,6 @@ Description | | | <- original cells +------+------+ - Becomes: a b <- patch of boundary face @@ -61,6 +62,7 @@ Description +------+------+ | | | <- original cells +------+------+ + @endverbatim - added faces get same patchID as face they are extruded from @@ -70,24 +72,26 @@ Description E.g. 3 boundary faces on patches a,b. b gets extruded, a doesn't. - a b b <- patch of boundary face - +------+------+------+ - | | | | <- cells - +------+------+------+ + @verbatim + a b b <- patch of boundary face + +------+------+------+ + | | | | <- cells + +------+------+------+ - ^ ^ <- wanted extrusion vector (none at far right) - a | b | b <- patch of boundary face - +------+------+------+ - | | | | <- cells - +------+------+------+ + ^ ^ <- wanted extrusion vector (none at far right) + a | b | b <- patch of boundary face + +------+------+------+ + | | | | <- cells + +------+------+------+ - b - +------+\ b 1. prism cell added onto second b face since - a a| | ----\ only one side gets extruded. - +------+------+------+ 2. side-face gets patch a, not b. - | | | | - +------+------+------+ + b + +------+\ b 1. prism cell added onto second b face since + a a| | ----\ only one side gets extruded. + +------+------+------+ 2. side-face gets patch a, not b. + | | | | + +------+------+------+ + @endverbatim SourceFiles diff --git a/src/dynamicMesh/polyTopoChange/polyTopoChange/combineFaces.H b/src/dynamicMesh/polyTopoChange/polyTopoChange/combineFaces.H index c7b76fa874..60f412eb16 100644 --- a/src/dynamicMesh/polyTopoChange/polyTopoChange/combineFaces.H +++ b/src/dynamicMesh/polyTopoChange/polyTopoChange/combineFaces.H @@ -23,7 +23,7 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - combineFaces + Foam::combineFaces Description Combines boundary faces into single face. The faces get the patch diff --git a/src/finiteVolume/finiteVolume/fvc/fvc.H b/src/finiteVolume/finiteVolume/fvc/fvc.H index 4c410483bc..4dc3daad9d 100644 --- a/src/finiteVolume/finiteVolume/fvc/fvc.H +++ b/src/finiteVolume/finiteVolume/fvc/fvc.H @@ -22,7 +22,7 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -InNamespace +Namespace Foam::fvc Description diff --git a/src/finiteVolume/finiteVolume/fvm/fvm.H b/src/finiteVolume/finiteVolume/fvm/fvm.H index 4e534f6e02..754d089b8a 100644 --- a/src/finiteVolume/finiteVolume/fvm/fvm.H +++ b/src/finiteVolume/finiteVolume/fvm/fvm.H @@ -27,7 +27,9 @@ Namespace Description Namespace of functions to calculate implicit derivatives returning a - matrix. Time derivatives are calculated using Euler-implicit, backward + matrix. + + Temporal derivatives are calculated using Euler-implicit, backward differencing or Crank-Nicholson. Spatial derivatives are calculated using Gauss' Theorem. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitFuncs.C b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitFuncs.C index eade866f54..ba6b3d2239 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitFuncs.C +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitFuncs.C @@ -22,20 +22,6 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Description - Class to create the weighting-factors based on the NVD - (Normalised Variable Diagram). - The particular differencing scheme class is supplied as a template argument, - the weight function of which is called by the weight function of this class - for the internal faces as well as faces of coupled patches - (e.g. processor-processor patches). The weight function is supplied the - central-differencing weighting factor, the face-flux, the cell and face - gradients (from which the normalised variable distribution may be created) - and the cell centre distance. - - This code organisation is both neat and efficient, allowing for convenient - implementation of new schemes to run on parallelised cases. - \*---------------------------------------------------------------------------*/ #include "volFields.H" diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitFuncs.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitFuncs.H index 406ea8b810..2e1749af1f 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitFuncs.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitFuncs.H @@ -22,12 +22,19 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +Namespace + Foam::limitFuncs + +Description + Namespace for limiting functions + + Class Foam::limitFuncs::LimitFuncs Description Class to create NVD/TVD limited weighting-factors. - + The particular differencing scheme class is supplied as a template argument, the weight function of which is called by the weight function of this class for the internal faces as well as faces of coupled diff --git a/src/lagrangian/intermediate/clouds/Templates/ReactingCloud/ReactingCloudThermoTypes.H b/src/lagrangian/intermediate/clouds/Templates/ReactingCloud/ReactingCloudThermoTypes.H index 9fe413101d..bd739253f7 100644 --- a/src/lagrangian/intermediate/clouds/Templates/ReactingCloud/ReactingCloudThermoTypes.H +++ b/src/lagrangian/intermediate/clouds/Templates/ReactingCloud/ReactingCloudThermoTypes.H @@ -22,7 +22,7 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Class +Typedefs Foam::cloudThermoTypes Description diff --git a/src/lagrangian/intermediate/submodels/addOns/radiation/absorptionEmission/cloudAbsorptionEmission/cloudAbsorptionEmission.H b/src/lagrangian/intermediate/submodels/addOns/radiation/absorptionEmission/cloudAbsorptionEmission/cloudAbsorptionEmission.H index 0f4c9e5a53..20f4ceab3a 100644 --- a/src/lagrangian/intermediate/submodels/addOns/radiation/absorptionEmission/cloudAbsorptionEmission/cloudAbsorptionEmission.H +++ b/src/lagrangian/intermediate/submodels/addOns/radiation/absorptionEmission/cloudAbsorptionEmission/cloudAbsorptionEmission.H @@ -23,7 +23,7 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - Foam::cloudAbsorptionEmission + Foam::radiation::cloudAbsorptionEmission Description Retrieves absorption/emission data from a cloud object diff --git a/src/lagrangian/intermediate/submodels/addOns/radiation/scatter/cloudScatter/cloudScatter.H b/src/lagrangian/intermediate/submodels/addOns/radiation/scatter/cloudScatter/cloudScatter.H index 579a3faaf2..26185f6362 100644 --- a/src/lagrangian/intermediate/submodels/addOns/radiation/scatter/cloudScatter/cloudScatter.H +++ b/src/lagrangian/intermediate/submodels/addOns/radiation/scatter/cloudScatter/cloudScatter.H @@ -23,7 +23,7 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - Foam::scatterModel + Foam::radiation::cloudScatter Description Cloud radiation scatter model diff --git a/src/lagrangian/molecule/molecule/molecule.H b/src/lagrangian/molecule/molecule/molecule.H index 0f9b478d05..68cff646b1 100755 --- a/src/lagrangian/molecule/molecule/molecule.H +++ b/src/lagrangian/molecule/molecule/molecule.H @@ -23,9 +23,10 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - molecule + Foam::molecule Description + Foam::molecule SourceFiles moleculeI.H diff --git a/src/meshTools/triSurface/searchableSurface/triSurfaceMesh.H b/src/meshTools/triSurface/searchableSurface/triSurfaceMesh.H index 6d99d8a080..4f47b212da 100644 --- a/src/meshTools/triSurface/searchableSurface/triSurfaceMesh.H +++ b/src/meshTools/triSurface/searchableSurface/triSurfaceMesh.H @@ -23,7 +23,7 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - triSurfaceMesh + Foam::triSurfaceMesh Description IOoject and searching on triSurface diff --git a/src/postProcessing/foamCalcFunctions/calcType/calcType.H b/src/postProcessing/foamCalcFunctions/calcType/calcType.H index 5e7d1079d2..99809aaae1 100644 --- a/src/postProcessing/foamCalcFunctions/calcType/calcType.H +++ b/src/postProcessing/foamCalcFunctions/calcType/calcType.H @@ -22,6 +22,13 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +Namespace + Foam::calcTypes + +Description + Namespace for post-processing calculation functions + + Class Foam::calcType diff --git a/src/postProcessing/foamCalcFunctions/field/components/components.H b/src/postProcessing/foamCalcFunctions/field/components/components.H index 8c66325a62..6567f45ed6 100644 --- a/src/postProcessing/foamCalcFunctions/field/components/components.H +++ b/src/postProcessing/foamCalcFunctions/field/components/components.H @@ -23,7 +23,7 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - Foam::components + Foam::calcTypes::components Description Writes scalar fields corresponding to each component of the supplied diff --git a/src/postProcessing/foamCalcFunctions/field/div/div.H b/src/postProcessing/foamCalcFunctions/field/div/div.H index 7b920d369d..39c5a9e98b 100644 --- a/src/postProcessing/foamCalcFunctions/field/div/div.H +++ b/src/postProcessing/foamCalcFunctions/field/div/div.H @@ -23,7 +23,7 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - Foam::div + Foam::calcTypes::div Description Writes scalar fields corresponding to the divergence of the supplied diff --git a/src/postProcessing/foamCalcFunctions/field/mag/mag.H b/src/postProcessing/foamCalcFunctions/field/mag/mag.H index 179d5b235d..8c1bebde56 100644 --- a/src/postProcessing/foamCalcFunctions/field/mag/mag.H +++ b/src/postProcessing/foamCalcFunctions/field/mag/mag.H @@ -23,7 +23,7 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - Foam::mag + Foam::calcTypes::mag Description Calculates and writes the magnitude of a field for each time diff --git a/src/postProcessing/foamCalcFunctions/field/magGrad/magGrad.H b/src/postProcessing/foamCalcFunctions/field/magGrad/magGrad.H index 9ab358bdfb..48911fd4d9 100644 --- a/src/postProcessing/foamCalcFunctions/field/magGrad/magGrad.H +++ b/src/postProcessing/foamCalcFunctions/field/magGrad/magGrad.H @@ -23,7 +23,7 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - Foam::magGrad + Foam::calcTypes::magGrad Description Writes scalar fields corresponding to the magnitude ot the gradient diff --git a/src/postProcessing/foamCalcFunctions/field/magSqr/magSqr.H b/src/postProcessing/foamCalcFunctions/field/magSqr/magSqr.H index 7609763e9e..f2ca53d3ed 100644 --- a/src/postProcessing/foamCalcFunctions/field/magSqr/magSqr.H +++ b/src/postProcessing/foamCalcFunctions/field/magSqr/magSqr.H @@ -23,7 +23,7 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - Foam::magSqr + Foam::calcTypes::magSqr Description Calculates and writes the magnitude-sqaured of a field for each time diff --git a/src/postProcessing/forces/forceCoeffs/forceCoeffs.H b/src/postProcessing/forces/forceCoeffs/forceCoeffs.H index 846bcbc47c..977ef135a8 100644 --- a/src/postProcessing/forces/forceCoeffs/forceCoeffs.H +++ b/src/postProcessing/forces/forceCoeffs/forceCoeffs.H @@ -23,7 +23,7 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - forceCoeffs + Foam::forceCoeffs Description Derived from the forces function object, creates a specialisation to diff --git a/src/postProcessing/forces/forces/forces.H b/src/postProcessing/forces/forces/forces.H index 25bbe02f99..1c730b34b5 100644 --- a/src/postProcessing/forces/forces/forces.H +++ b/src/postProcessing/forces/forces/forces.H @@ -23,7 +23,7 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - forces + Foam::forces Description Calculates the forces and moments by integrating the pressure and @@ -77,8 +77,7 @@ public: // pressure/viscous forces Tuples. typedef Tuple2 forcesMoments; - // Sum operation class used to accumulate the pressure and viscous - // forces and moments + //- Sum operation class to accumulate the pressure, viscous forces and moments class sumOp { public: diff --git a/src/sampling/sampledSurface/writers/dx/dxWriters.H b/src/sampling/sampledSurface/writers/dx/dxWriters.H index 7a3f9e27a9..39dfedabdd 100644 --- a/src/sampling/sampledSurface/writers/dx/dxWriters.H +++ b/src/sampling/sampledSurface/writers/dx/dxWriters.H @@ -22,8 +22,8 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Class - dxWriters +InClass + Foam::dxWriters Description diff --git a/src/sampling/sampledSurface/writers/foamFile/foamFile.H b/src/sampling/sampledSurface/writers/foamFile/foamFile.H index 532e920a45..69b020ec51 100644 --- a/src/sampling/sampledSurface/writers/foamFile/foamFile.H +++ b/src/sampling/sampledSurface/writers/foamFile/foamFile.H @@ -23,9 +23,10 @@ License Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Class - foamFile + Foam::foamFile Description + A surfaceWriter for foamFiles SourceFiles foamFile.C diff --git a/src/sampling/sampledSurface/writers/foamFile/foamFileWriters.H b/src/sampling/sampledSurface/writers/foamFile/foamFileWriters.H index d321c0d509..61868b618e 100644 --- a/src/sampling/sampledSurface/writers/foamFile/foamFileWriters.H +++ b/src/sampling/sampledSurface/writers/foamFile/foamFileWriters.H @@ -22,8 +22,8 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Class - foamFileWriters +InClass + Foam::foamFileWriters Description diff --git a/src/sampling/sampledSurface/writers/null/nullWriters.H b/src/sampling/sampledSurface/writers/null/nullWriters.H index ebf4d63a5b..a12d33fc59 100644 --- a/src/sampling/sampledSurface/writers/null/nullWriters.H +++ b/src/sampling/sampledSurface/writers/null/nullWriters.H @@ -22,8 +22,8 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Class - nullWriters +InClass + Foam::nullWriters Description diff --git a/src/sampling/sampledSurface/writers/raw/rawSurfaceWriters.H b/src/sampling/sampledSurface/writers/raw/rawSurfaceWriters.H index af54c85c78..e3e76fef57 100644 --- a/src/sampling/sampledSurface/writers/raw/rawSurfaceWriters.H +++ b/src/sampling/sampledSurface/writers/raw/rawSurfaceWriters.H @@ -22,8 +22,8 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Class - rawSurfaceWriters +InClass + Foam::rawSurfaceWriters Description diff --git a/src/sampling/sampledSurface/writers/stl/stlWriters.H b/src/sampling/sampledSurface/writers/stl/stlWriters.H index 15d1f77802..735587ef8b 100644 --- a/src/sampling/sampledSurface/writers/stl/stlWriters.H +++ b/src/sampling/sampledSurface/writers/stl/stlWriters.H @@ -22,8 +22,8 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Class - stlWriters +InClass + Foam::stlWriters Description diff --git a/src/sampling/sampledSurface/writers/surfaceWriters.H b/src/sampling/sampledSurface/writers/surfaceWriters.H index 0d3d72c058..4640c1c4bf 100644 --- a/src/sampling/sampledSurface/writers/surfaceWriters.H +++ b/src/sampling/sampledSurface/writers/surfaceWriters.H @@ -22,8 +22,8 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Class - surfaceWriter +InClass + Foam::surfaceWriters Description diff --git a/src/sampling/sampledSurface/writers/vtk/vtkWriters.H b/src/sampling/sampledSurface/writers/vtk/vtkWriters.H index 9ec1f75c20..1e8e0cea19 100644 --- a/src/sampling/sampledSurface/writers/vtk/vtkWriters.H +++ b/src/sampling/sampledSurface/writers/vtk/vtkWriters.H @@ -22,8 +22,8 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Class - vtkWriters +InClass + Foam::vtkWriters Description diff --git a/src/thermophysicalModels/barotropicCompressibilityModel/barotropicCompressibilityModel/barotropicCompressibilityModel.H b/src/thermophysicalModels/barotropicCompressibilityModel/barotropicCompressibilityModel/barotropicCompressibilityModel.H index 87110a662a..adcdb08ec0 100644 --- a/src/thermophysicalModels/barotropicCompressibilityModel/barotropicCompressibilityModel/barotropicCompressibilityModel.H +++ b/src/thermophysicalModels/barotropicCompressibilityModel/barotropicCompressibilityModel/barotropicCompressibilityModel.H @@ -22,10 +22,18 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +Namespace + Foam::compressibilityModels + +Description + Namespace for compressibility models. + + Class Foam::barotropicCompressibilityModel Description + Abstract class for barotropic compressibility models SourceFiles barotropicCompressibilityModel.C diff --git a/src/triSurface/triSurfaceFields/triSurfaceFields.H b/src/triSurface/triSurfaceFields/triSurfaceFields.H index 82af3c7984..55e69f593e 100644 --- a/src/triSurface/triSurfaceFields/triSurfaceFields.H +++ b/src/triSurface/triSurfaceFields/triSurfaceFields.H @@ -22,7 +22,7 @@ License along with OpenFOAM; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -Class +InClass Foam::triSurfaceFields Description