applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C

@@ -24,6 +24,9 @@ License
 Application
     chtMultiRegionSimpleFoam
 
+Group
+    grpHeatTransferSolvers
+
 Description
     Steady-state version of chtMultiRegionFoam
 

applications/solvers/heatTransfer/heatTransferSolversDoc.H

+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2015 OpenFOAM Foundation
+     \\/     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 grpHeatTransferSolvers Heat transfer solvers
+@{
+    \ingroup grpSolvers
+    This group contains heat transfer solvers.
+@}
+
+\*---------------------------------------------------------------------------*/

applications/solvers/heatTransfer/thermoFoam/thermoFoam.C

@@ -24,6 +24,9 @@ License
 Application
     thermoFoam
 
+Group
+    grpHeatTransferSolvers
+
 Description
     Evolves the thermodynamics on a frozen flow field
 

applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C

@@ -24,6 +24,9 @@ License
 Application
     ajointShapeOptimizationFoam
 
+Group
+    grpIncompressibleSolvers
+
 Description
     Steady-state solver for incompressible, turbulent flow of non-Newtonian
     fluids with optimisation of duct shape by applying "blockage" in regions

applications/solvers/incompressible/boundaryFoam/boundaryFoam.C

@@ -24,6 +24,9 @@ License
 Application
     boundaryFoam
 
+Group
+    grpIncompressibleSolvers
+
 Description
     Steady-state solver for incompressible, 1D turbulent flow, typically to
     generate boundary layer conditions at an inlet, for use in a simulation.

applications/solvers/incompressible/icoFoam/icoFoam.C

@@ -24,9 +24,40 @@ License
 Application
     icoFoam
 
+Group
+    grpIncompressibleSolvers
+
 Description
     Transient solver for incompressible, laminar flow of Newtonian fluids.
 
+    \heading Solver details
+    The solver uses the PISO algorithm to solve the continuity equation:
+
+        \f[
+            \div \vec{U} = 0
+        \f]
+
+    and momentum equation:
+
+        \f[
+            \ddt{\vec{U}}
+          + \div \left( \vec{U} \vec{U} \right)
+          - \div \left(\nu \grad \vec{U} \right)
+          = - \grad p
+        \f]
+
+    Where:
+    \vartable
+        \vec{U} | Velocity
+        p       | Pressure
+    \endvartable
+
+    \heading Required fields
+    \plaintable
+        U       | Velocity [m/s]
+        p       | Kinematic pressure, p/rho [m2/s2]
+    \endplaintable
+
 \*---------------------------------------------------------------------------*/
 
 #include "fvCFD.H"

applications/solvers/incompressible/incompressibleSolversDoc.H

+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2015 OpenFOAM Foundation
+     \\/     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 grpIncompressibleSolvers Incompressible flow solvers
+@{
+    \ingroup grpSolvers
+    This group contains incompressible flow solvers.
+@}
+
+\*---------------------------------------------------------------------------*/

applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C

@@ -24,6 +24,9 @@ License
 Application
     nonNewtonianIcoFoam
 
+Group
+    grpIncompressibleSolvers
+
 Description
     Transient solver for incompressible, laminar flow of non-Newtonian fluids.
 

applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C

@@ -24,6 +24,9 @@ License
 Application
     SRFPimpleFoam
 
+Group
+    grpIncompressibleSolvers
+
 Description
     Large time-step transient solver for incompressible, flow in a single
     rotating frame using the PIMPLE (merged PISO-SIMPLE) algorithm.

applications/solvers/incompressible/pimpleFoam/pimpleDyMFoam/pimpleDyMFoam.C

@@ -24,6 +24,9 @@ License
 Application
     pimpleDyMFoam.C
 
+Group
+    grpIncompressibleSolvers grpMovingMeshSolvers
+
 Description
     Transient solver for incompressible, flow of Newtonian fluids
     on a moving mesh using the PIMPLE (merged PISO-SIMPLE) algorithm.

applications/solvers/incompressible/pimpleFoam/pimpleFoam.C

@@ -24,14 +24,47 @@ License
 Application
     pimpleFoam
 
+Group
+    grpIncompressibleSolvers
+
 Description
     Large time-step transient solver for incompressible, flow using the PIMPLE
     (merged PISO-SIMPLE) algorithm.
 
+    \heading Solver details
+    The solver uses the PIMPLE (merged PISO-SIMPLE) algorithm to solve the
+    continuity equation:
+
+        \f[
+            \div \vec{U} = 0
+        \f]
+
+    and momentum equation:
+
+        \f[
+            \ddt{\vec{U}} + \div \left( \vec{U} \vec{U} \right) - \div \gvec{R}
+          = - \grad p + \vec{S}_U
+        \f]
+
+    Where:
+    \vartable
+        \vec{U} | Velocity
+        p       | Pressure
+        \vec{R} | Stress tensor
+        \vec{S}_U | Momentum source
+    \endvartable
+
     Sub-models include:
     - turbulence modelling, i.e. laminar, RAS or LES
     - run-time selectable MRF and finite volume options, e.g. explicit porosity
 
+    \heading Required fields
+    \plaintable
+        U       | Velocity [m/s]
+        p       | Kinematic pressure, p/rho [m2/s2]
+        \<turbulence fields\> | As required by user selection
+    \endplaintable
+
 \*---------------------------------------------------------------------------*/
 
 #include "fvCFD.H"

applications/solvers/incompressible/pisoFoam/pisoFoam.C

@@ -24,13 +24,44 @@ License
 Application
     pisoFoam
 
+Group
+    grpIncompressibleSolvers
+
 Description
     Transient solver for incompressible flow.
 
+    \heading Solver details
+    The solver uses the PISO algorithm to solve the continuity equation:
+
+        \f[
+            \div \vec{U} = 0
+        \f]
+
+    and momentum equation:
+
+        \f[
+            \ddt{\vec{U}} + \div \left( \vec{U} \vec{U} \right) - \div \gvec{R}
+          = - \grad p
+        \f]
+
+    Where:
+    \vartable
+        \vec{U} | Velocity
+        p       | Pressure
+        \vec{R} | Stress tensor
+    \endvartable
+
     Sub-models include:
     - turbulence modelling, i.e. laminar, RAS or LES
     - run-time selectable MRF and finite volume options, e.g. explicit porosity
 
+    \heading Required fields
+    \plaintable
+        U       | Velocity [m/s]
+        p       | Kinematic pressure, p/rho [m2/s2]
+        \<turbulence fields\> | As required by user selection
+    \endplaintable
+
 \*---------------------------------------------------------------------------*/
 
 #include "fvCFD.H"

applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C

@@ -24,6 +24,9 @@ License
 Application
     shallowWaterFoam
 
+Group
+    grpIncompressibleSolvers
+
 Description
     Transient solver for inviscid shallow-water equations with rotation.
 

applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C

@@ -24,6 +24,9 @@ License
 Application
     SRFSimpleFoam
 
+Group
+    grpIncompressibleSolvers
+
 Description
     Steady-state solver for incompressible, turbulent flow of non-Newtonian
     fluids in a single rotating frame.

applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C

@@ -24,6 +24,9 @@ License
 Application
     porousSimpleFoam
 
+Group
+    grpIncompressibleSolvers
+
 Description
     Steady-state solver for incompressible, turbulent flow with
     implicit or explicit porosity treatment and support for multiple reference

applications/solvers/incompressible/simpleFoam/simpleFoam.C

@@ -24,8 +24,40 @@ License
 Application
     simpleFoam
 
+Group
+    grpIncompressibleSolvers
+
 Description
-    Steady-state solver for incompressible, turbulent flow
+    Steady-state solver for incompressible flows with turbulence modelling.
+
+    \heading Solver details
+    The solver uses the SIMPLE algorithm to solve the continuity equation:
+
+        \f[
+            \div \vec{U} = 0
+        \f]
+
+    and momentum equation:
+
+        \f[
+            \div \left( \vec{U} \vec{U} \right) - \div \gvec{R}
+          = - \grad p + \vec{S}_U
+        \f]
+
+    Where:
+    \vartable
+        \vec{U} | Velocity
+        p       | Pressure
+        \vec{R} | Stress tensor
+        \vec{S}_U | Momentum source
+    \endvartable
+
+    \heading Required fields
+    \plaintable
+        U       | Velocity [m/s]
+        p       | Kinematic pressure, p/rho [m2/s2]
+        \<turbulence fields\> | As required by user selection
+    \endplaintable
 
 \*---------------------------------------------------------------------------*/
 

applications/solvers/lagrangian/DPMFoam/DPMFoam.C

@@ -24,6 +24,9 @@ License
 Application
     DPMFoam
 
+Group
+    grpLagrangianSolvers
+
 Description
     Transient solver for the coupled transport of a single kinematic particle
     cloud including the effect of the volume fraction of particles on the

applications/solvers/lagrangian/DPMFoam/MPPICFoam/MPPICFoam.C

@@ -24,6 +24,9 @@ License
 Application
     MPPICFoam
 
+Group
+    grpLagrangianSolvers
+
 Description
     Transient solver for the coupled transport of a single kinematic particle
     cloud including the effect of the volume fraction of particles on the

applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C

@@ -24,6 +24,9 @@ License
 Application
     coalChemistryFoam
 
+Group
+    grpLagrangianSolvers
+
 Description
     Transient solver for:
     - compressible,

applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C

@@ -24,6 +24,9 @@ License
 Application
     uncoupledKinematicParcelDyMFoam
 
+Group
+    grpLagrangianSolvers grpMovingMeshSolvers
+
 Description
     Transient solver for the passive transport of a single kinematic
     particle cloud.