fixup doxygen for RAS/LES models, etc

src/dynamicMesh/polyTopoChange/polyTopoChange/hexRef8.C

@@ -50,7 +50,7 @@ namespace Foam
 {
     defineTypeNameAndDebug(hexRef8, 0);
 
-    // Reduction class. If x and y are not equal assign value.
+    //- Reduction class. If x and y are not equal assign value.
     template< int value >
     class ifEqEqOp
     {

src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.H

@@ -27,6 +27,7 @@ Class
 
 Description
     Templated base class for kinematic cloud
+
     - Kinematic only
       - Dispersion model
       - Drag model

src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H

@@ -27,7 +27,9 @@ Class
 
 Description
     Kinematic parcel class with one/two-way coupling with the continuous
-    phase. Sub-models include:
+    phase.
+
+    Sub-models include:
     - drag
     - break-up
     - wall interactions

src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeInjection/ConeInjection.H

@@ -27,6 +27,7 @@ Class
 
 Description
     Cone injection
+
     - User specifies
       - time of start of injection
       - injector position

src/meshTools/edgeFaceCirculator/edgeFaceCirculator.H

@@ -26,15 +26,15 @@ Class
     Foam::edgeFaceCirculator
 
 Description
-    Walks from starting face around edge. Implicit
+    Walks from starting face around edge.
-    description of edge:
+
+    Implicit description of edge:
     - face
     - index in face. edge is always between f[index] and f[index+1]
     - direction (cell to walk into)
 
-    Use as:
+    -# Use in-place: \n
-
+        @code
-        1) in-place:
             edgeFaceCirculator circ(..);
             // Optionally rotate to beginning: circ.setCanonical();
 
@@ -45,9 +45,10 @@ Description
                 ++circ;
             }
             while (circ != circ.end());
+        @endcode
 
-        2) like STL iterator:
+    -# Use like STL iterator: \n
-
+        @code
             edgeFaceCirculator circ(..);
             for
             (
@@ -58,6 +59,7 @@ Description
             {
                 Info<< "face:" << iter.face() << endl;
             }
+        @endcode
 
 
 SourceFiles

src/turbulenceModels/LES/compressible/LESModel/LESModel.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Namespace
-    Foam::compressible
+    Foam::compressible::LESModels
 
 Description
     Namespace for compressible LES models.

src/turbulenceModels/LES/incompressible/DeardorffDiffStress/DeardorffDiffStress.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::DeardorffDiffStress
+    Foam::incompressible::LESModels::DeardorffDiffStress
 
 Description
     Differential SGS Stress Equation Model for incompressible flows

src/turbulenceModels/LES/incompressible/GenEddyVisc/GenEddyVisc.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::GenEddyVisc
+    Foam::incompressible::LESModels::GenEddyVisc
 
 Description
     General base class for all incompressible models that can be implemented

src/turbulenceModels/LES/incompressible/GenSGSStress/GenSGSStress.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::GenSGSStress
+    Foam::incompressible::LESModels::GenSGSStress
 
 Description
     General base class for all incompressible models that directly

src/turbulenceModels/LES/incompressible/LESModel/LESModel.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Namespace
-    Foam::incompressible
+    Foam::incompressible::LESModels
 
 Description
     Namespace for incompressible LES models.

src/turbulenceModels/LES/incompressible/LRRDiffStress/LRRDiffStress.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::LRRDiffStress
+    Foam::incompressible::LESModels::LRRDiffStress
 
 Description
     Differential SGS Stress Equation Model for incompressible flows.

src/turbulenceModels/LES/incompressible/Smagorinsky/Smagorinsky.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::Smagorinsky
+    Foam::incompressible::LESModels::Smagorinsky
 
 Description
     The Isochoric Smagorinsky Model for incompressible flows.

src/turbulenceModels/LES/incompressible/Smagorinsky2/Smagorinsky2.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::Smagorinsky2
+    Foam::incompressible::LESModels::Smagorinsky2
 
 Description
     The Isochoric Smagorinsky Model for incompressible flows

src/turbulenceModels/LES/incompressible/SpalartAllmaras/SpalartAllmaras.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::SpalartAllmaras
+    Foam::incompressible::LESModels::SpalartAllmaras
 
 Description
     SpalartAllmaras for incompressible flows

src/turbulenceModels/LES/incompressible/dynMixedSmagorinsky/dynMixedSmagorinsky.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::dynMixedSmagorinsky
+    Foam::incompressible::LESModels::dynMixedSmagorinsky
 
 Description
     The Mixed Isochoric Smagorinsky Model for incompressible flows.

src/turbulenceModels/LES/incompressible/dynOneEqEddy/dynOneEqEddy.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::dynOneEqEddy
+    Foam::incompressible::LESModels::dynOneEqEddy
 
 Description
     One Equation Eddy Viscosity Model for incompressible flows.

src/turbulenceModels/LES/incompressible/dynSmagorinsky/dynSmagorinsky.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::dynSmagorinsky
+    Foam::incompressible::LESModels::dynSmagorinsky
 
 Description
     The Isochoric dynamic Smagorinsky Model for incompressible flows.
@@ -56,7 +56,7 @@ Description
         m = delta^2*(4*||F(D)||^2 - F(||D||^2))
         L = dev(F(U*U) - F(U)*F(U))
         M = delta^2*(F(||D||*dev(D)) - 4*||F(D)||*F(dev(D)))
-    @verbatim
+    @endverbatim
 
 SourceFiles
     dynSmagorinsky.C

src/turbulenceModels/LES/incompressible/laminar/laminar.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::laminar
+    Foam::incompressible::LESModels::laminar
 
 Description
     LES model for laminar incompressible flow.

src/turbulenceModels/LES/incompressible/locDynOneEqEddy/locDynOneEqEddy.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::locDynOneEqEddy
+    Foam::incompressible::LESModels::locDynOneEqEddy
 
 Description
     Localised Dynamic One Equation Eddy Viscosity Model for incompressible

src/turbulenceModels/LES/incompressible/mixedSmagorinsky/mixedSmagorinsky.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::mixedSmagorinsky
+    Foam::incompressible::LESModels::mixedSmagorinsky
 
 Description
     The mixed Isochoric Smagorinsky Model for incompressible flows.

src/turbulenceModels/LES/incompressible/oneEqEddy/oneEqEddy.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::oneEqEddy
+    Foam::incompressible::LESModels::oneEqEddy
 
 Description
     One Equation Eddy Viscosity Model for incompressible flows

src/turbulenceModels/LES/incompressible/scaleSimilarity/scaleSimilarity.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::scaleSimilarity
+    Foam::incompressible::LESModels::scaleSimilarity
 
 Description
     General base class for all scale similarity models

src/turbulenceModels/LES/incompressible/spectEddyVisc/spectEddyVisc.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::spectEddyVisc
+    Foam::incompressible::LESModels::spectEddyVisc
 
 Description
     The Isochoric spectral Eddy Viscosity Model for incompressible flows.

src/turbulenceModels/LES/incompressible/vanDriestDelta/vanDriestDelta.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::vanDriestDelta
+    Foam::incompressible::LESModels::vanDriestDelta
 
 Description
     Simple cube-root of cell volume delta used in incompressible LES models.

src/turbulenceModels/LES/incompressible/wallFunc/nuSgsWallFunction/nuSgsWallFunctionFvPatchScalarField.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::LES::nuSgsWallFunctionFvPatchScalarField
+    Foam::incompressible::LESModels::nuSgsWallFunctionFvPatchScalarField
 
 Description
     wall function boundary condition for incompressible flows

src/turbulenceModels/RAS/compressible/LRR/LRR.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::compressible::RAS::LRR
+    Foam::compressible::RASModels::LRR
 
 Description
     Launder, Reece and Rodi Reynolds-stress turbulence model for

src/turbulenceModels/RAS/compressible/LaunderGibsonRSTM/LaunderGibsonRSTM.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::compressible::RAS::LaunderGibsonRSTM
+    Foam::compressible::RASModels::LaunderGibsonRSTM
 
 Description
     Launder-Gibson Reynolds stress turbulence model for compressible flows.

src/turbulenceModels/RAS/compressible/LaunderSharmaKE/LaunderSharmaKE.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::compressible::RAS::LaunderSharmaKE
+    Foam::compressible::RASModels::LaunderSharmaKE
 
 Description
     Launder and Sharma low-Reynolds k-epsilon turbulence model for

src/turbulenceModels/RAS/compressible/RASModel/RASModel.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Namespace
-    Foam::compressible::RAS
+    Foam::compressible::RASModels
 
 Description
     Namespace for compressible RAS turbulence models.

src/turbulenceModels/RAS/compressible/RNGkEpsilon/RNGkEpsilon.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::compressible::RAS::RNGkEpsilon
+    Foam::compressible::RASModels::RNGkEpsilon
 
 Description
     Renormalisation group k-epsilon turbulence model for compressible flows.

src/turbulenceModels/RAS/compressible/SpalartAllmaras/SpalartAllmaras.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::compressible::RAS::SpalartAllmaras
+    Foam::compressible::RASModels::SpalartAllmaras
 
 Description
     Spalart-Allmaras one-eqn mixing-length model for compressible

src/turbulenceModels/RAS/compressible/kEpsilon/kEpsilon.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::compressible::RAS::kEpsilon
+    Foam::compressible::RASModels::kEpsilon
 
 Description
     Standard k-epsilon turbulence model for compressible flows

src/turbulenceModels/RAS/compressible/kOmegaSST/kOmegaSST.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::compressible::RAS::kOmegaSST
+    Foam::compressible::RASModels::kOmegaSST
 
 Description
     Implementation of the k-omega-SST turbulence model for compressible flows.

src/turbulenceModels/RAS/compressible/laminar/laminar.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::compressible::RAS::laminar
+    Foam::compressible::RASModels::laminar
 
 Description
     Dummy turbulence model for laminar compressible flow.

src/turbulenceModels/RAS/compressible/realizableKE/realizableKE.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::compressible::RAS::realizableKE
+    Foam::compressible::RASModels::realizableKE
 
 Description
     Realizable k-epsilon turbulence model for compressible flows.

src/turbulenceModels/RAS/compressible/wallFunctions/mutWallFunctions/mutStandardRoughWallFunction/mutStandardRoughWallFunctionFvPatchScalarField.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::compressible::RAS::mutStandardRoughWallFunctionFvPatchScalarField
+    Foam::compressible::RASModels::mutStandardRoughWallFunctionFvPatchScalarField
 
 Description
     Wall function boundary condition for rough walls

src/turbulenceModels/RAS/incompressible/LRR/LRR.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::LRR
+    Foam::incompressible::RASModels::LRR
 
 Description
     Launder, Reece and Rodi Reynolds-stress turbulence model for

src/turbulenceModels/RAS/incompressible/LamBremhorstKE/LamBremhorstKE.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::LamBremhorstKE
+    Foam::incompressible::RASModels::LamBremhorstKE
 
 Description
     Lam and Bremhorst low-Reynolds number k-epsilon turbulence model

src/turbulenceModels/RAS/incompressible/LaunderGibsonRSTM/LaunderGibsonRSTM.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::LaunderGibsonRSTM
+    Foam::incompressible::RASModels::LaunderGibsonRSTM
 
 Description
     Launder-Gibson Reynolds stress turbulence model for incompressible flows.

src/turbulenceModels/RAS/incompressible/LaunderSharmaKE/LaunderSharmaKE.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::LaunderSharmaKE
+    Foam::incompressible::RASModels::LaunderSharmaKE
 
 Description
     Launder and Sharma low-Reynolds k-epsilon turbulence model for

src/turbulenceModels/RAS/incompressible/LienCubicKE/LienCubicKE.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::LienCubicKE
+    Foam::incompressible::RASModels::LienCubicKE
 
 Description
     Lien cubic non-linear k-epsilon turbulence model for incompressible flows.

src/turbulenceModels/RAS/incompressible/LienCubicKELowRe/LienCubicKELowRe.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::LienCubicKELowRe
+    Foam::incompressible::RASModels::LienCubicKELowRe
 
 Description
     Lien cubic non-linear low-Reynolds k-epsilon turbulence models for

src/turbulenceModels/RAS/incompressible/LienLeschzinerLowRe/LienLeschzinerLowRe.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::LienLeschzinerLowRe
+    Foam::incompressible::RASModels::LienLeschzinerLowRe
 
 Description
     Lien and Leschziner low-Reynolds k-epsilon turbulence model for

src/turbulenceModels/RAS/incompressible/NonlinearKEShih/NonlinearKEShih.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::NonlinearKEShih
+    Foam::incompressible::RASModels::NonlinearKEShih
 
 Description
     Shih's quadratic non-linear k-epsilon turbulence model for

src/turbulenceModels/RAS/incompressible/QZeta/QZeta.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::QZeta
+    Foam::incompressible::RASModels::QZeta
 
 Description
     Gibson and Dafa'Alla's q-zeta two-equation low-Re turbulence model

src/turbulenceModels/RAS/incompressible/RASModel/RASModel.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Namespace
-    Foam::incompressible
+    Foam::incompressible::RASModels
 
 Description
     Namespace for incompressible RAS turbulence models.

src/turbulenceModels/RAS/incompressible/RNGkEpsilon/RNGkEpsilon.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::RNGkEpsilon
+    Foam::incompressible::RASModels::RNGkEpsilon
 
 Description
     Renormalisation group k-epsilon turbulence model for incompressible flows.

src/turbulenceModels/RAS/incompressible/SpalartAllmaras/SpalartAllmaras.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::SpalartAllmaras
+    Foam::incompressible::RASModels::SpalartAllmaras
 
 Description
     Spalart-Allmaras 1-eqn mixing-length model for incompressible external

src/turbulenceModels/RAS/incompressible/kEpsilon/kEpsilon.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::kEpsilon
+    Foam::incompressible::RASModels::kEpsilon
 
 Description
     Standard k-epsilon turbulence model for incompressible flows.

src/turbulenceModels/RAS/incompressible/kOmegaSST/kOmegaSST.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::kOmegaSST
+    Foam::incompressible::RASModels::kOmegaSST
 
 Description
     Implementation of the k-omega-SST turbulence model for incompressible

src/turbulenceModels/RAS/incompressible/laminar/laminar.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::laminar
+    Foam::incompressible::RASModels::laminar
 
 Description
     Dummy turbulence model for laminar incompressible flow.

src/turbulenceModels/RAS/incompressible/realizableKE/realizableKE.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::realizableKE
+    Foam::incompressible::RASModels::realizableKE
 
 Description
     Realizable k-epsilon turbulence model for incompressible flows.

src/turbulenceModels/RAS/incompressible/wallFunctions/nutWallFunctions/nutStandardRoughWallFunction/nutStandardRoughWallFunctionFvPatchScalarField.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::nutStandardRoughWallFunctionFvPatchScalarField
+    Foam::incompressible::RASModels::nutStandardRoughWallFunctionFvPatchScalarField
 
 Description
     Wall function boundary condition for rough walls

src/turbulenceModels/RAS/incompressible/wallFunctions/nutWallFunctions/nutStandardWallFunction/nutStandardWallFunctionFvPatchScalarField.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::nutStandardWallFunctionFvPatchScalarField
+    Foam::incompressible::RASModels::nutStandardWallFunctionFvPatchScalarField
 
 Description
     Wall function boundary condition for walls

src/turbulenceModels/RAS/incompressible/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H

@@ -23,7 +23,7 @@ License
     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
 Class
-    Foam::incompressible::RAS::nutWallFunctionFvPatchScalarField
+    Foam::incompressible::RASModels::nutWallFunctionFvPatchScalarField
 
 Description
     Wall function boundary condition for walls