ENH: Solvers - updated group documentation

applications/solvers/DNS/DNSSolversDoc.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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 grpDNSSolvers Direct Numerical Simulation solvers
+@{
+    \ingroup grpSolvers
+    This group contains Direct Numerical Simulation (DNS) solvers.
+@}
+
+\*---------------------------------------------------------------------------*/

applications/solvers/DNS/dnsFoam/dnsFoam.C

@@ -24,6 +24,9 @@ License
 Application
     dnsFoam
 
+Group
+    grpDNSSolvers
+
 Description
     Direct numerical simulation solver for boxes of isotropic turbulence
 

applications/solvers/basic/basicSolversDoc.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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 grpBasicSolvers Basic solvers
+@{
+    \ingroup grpSolvers
+    This group contains basic solvers.
+@}
+
+\*---------------------------------------------------------------------------*/

applications/solvers/basic/laplacianFoam/laplacianFoam.C

@@ -24,8 +24,30 @@ License
 Application
     laplacianFoam
 
+Group
+    grpBasicSolvers
+
 Description
-    Solves a simple Laplace equation, e.g. for thermal diffusion in a solid.
+    Laplace equation solver for a scalar quantity.
+
+    \heading Solver details
+    The solver is applicable to, e.g. for thermal diffusion in a solid.  The
+    equation is given by:
+
+    \f[
+        \ddt{T}  = \div \left( D_T \grad T \right)
+    \f]
+
+    Where:
+    \vartable
+        T     | Scalar field which is solved for, e.g. temperature
+        D_T   | Diffusion coefficient
+    \endvartable
+
+    \heading Required fields
+    \plaintable
+        T     | Scalar field which is solved for, e.g. temperature
+    \endplaintable
 
 \*---------------------------------------------------------------------------*/
 

applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C

@@ -24,8 +24,32 @@ License
 Application
     scalarTransportFoam
 
+Group
+    grpBasicSolvers
+
 Description
-    Solves a transport equation for a passive scalar
+    Passive scalar transport equation solver.
+
+    \heading Solver details
+    The equation is given by:
+
+    \f[
+        \ddt{T} + \div \left(\vec{U} T\right) - \div \left(D_T \grad T \right)
+        = S_{T}
+    \f]
+
+    Where:
+    \vartable
+        T       | Passive scalar
+        D_T     | Diffusion coefficient
+        S_T     | Source
+    \endvartable
+
+    \heading Required fields
+    \plaintable
+        T       | Passive scalar
+        U       | Velocity [m/s]
+    \endplaintable
 
 \*---------------------------------------------------------------------------*/
 

applications/solvers/combustion/PDRFoam/PDRFoam.C

@@ -24,6 +24,9 @@ License
 Application
     PDRFoam
 
+Group
+    grpCombustionSolvers
+
 Description
     Solver for compressible premixed/partially-premixed combustion with
     turbulence modelling.
@@ -54,16 +57,17 @@ Description
     regions containing blockages which cannot be resolved by the mesh.
 
     The fields used by this solver are:
-
+    \plaintable
-    betav:  Volume porosity
+    betav  | Volume porosity
-    Lobs:   Average diameter of obstacle in cell (m)
+    Lobs   | Average diameter of obstacle in cell (m)
-    Aw:     Obstacle surface area per unit volume (1/m)
+    Aw     | Obstacle surface area per unit volume (1/m)
-    CR:     Drag tensor (1/m)
+    CR     | Drag tensor (1/m)
-    CT:     Turbulence generation parameter (1/m)
+    CT     | Turbulence generation parameter (1/m)
-    Nv:     Number of obstacles in cell per unit volume (m^-2)
+    Nv     | Number of obstacles in cell per unit volume (m^-2)
-    nsv:    Tensor whose diagonal indicates the number to substract from
+    nsv    | Tensor whose diagonal indicates the number to substract from
-            Nv to get the number of obstacles crossing the flow in each
+           | Nv to get the number of obstacles crossing the flow in each
-            direction.
+           | direction.
+    \endplaintable
 
 \*---------------------------------------------------------------------------*/
 

applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C

@@ -24,6 +24,9 @@ License
 Application
     XiFoam
 
+Group
+    grpCombustionSolvers grpMovingMeshSolvers
+
 Description
     Solver for compressible premixed/partially-premixed combustion with
     turbulence modelling.

applications/solvers/combustion/XiFoam/XiFoam.C

@@ -24,6 +24,9 @@ License
 Application
     XiFoam
 
+Group
+    grpCombustionSolvers
+
 Description
     Solver for compressible premixed/partially-premixed combustion with
     turbulence modelling.

applications/solvers/combustion/chemFoam/chemFoam.C

@@ -24,6 +24,9 @@ License
 Application
     chemFoam
 
+Group
+    grpCombustionSolvers
+
 Description
     Solver for chemistry problems
     - designed for use on single cell cases to provide comparison against

applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C

@@ -22,7 +22,10 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Application
-    engineFoam
+    coldEngineFoam
+
+Group
+    grpCombustionSolvers grpMovingMeshSolvers
 
 Description
     Solver for cold-flow in internal combustion engines.

applications/solvers/combustion/combustionSolversDoc.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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 grpCombustionSolvers Combustion solvers
+@{
+    \ingroup grpSolvers
+    This group contains combustion solvers.
+@}
+
+\*---------------------------------------------------------------------------*/

applications/solvers/combustion/engineFoam/engineFoam.C

@@ -24,6 +24,9 @@ License
 Application
     engineFoam
 
+Group
+    grpCombustionSolvers
+
 Description
     Solver for internal combustion engines.
 

applications/solvers/combustion/fireFoam/fireFoam.C

@@ -24,8 +24,11 @@ License
 Application
     fireFoam
 
+Group
+    grpCombustionSolvers
+
 Description
-    Transient PIMPLE solver for Fires and turbulent diffusion flames with
+    Transient PIMPLE solver for fires and turbulent diffusion flames with
     reacting Lagrangian parcels, surface film and pyrolysis modelling.
 
 \*---------------------------------------------------------------------------*/

applications/solvers/combustion/reactingFoam/reactingFoam.C

@@ -24,6 +24,9 @@ License
 Application
     reactingFoam
 
+Group
+    grpCombustionSolvers
+
 Description
     Solver for combustion with chemical reactions.
 

applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C

@@ -24,6 +24,9 @@ License
 Application
     rhoReactingBuoyantFoam
 
+Group
+    grpCombustionSolvers
+
 Description
     Solver for combustion with chemical reactions using density based
     thermodynamics package, using enahanced buoyancy treatment.

applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C

@@ -24,6 +24,9 @@ License
 Application
     rhoReactingFoam
 
+Group
+    grpCombustionSolvers
+
 Description
     Solver for combustion with chemical reactions using density based
     thermodynamics package.

applications/solvers/compressible/compressibleSolvers.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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 grpCompressibleSolvers Compressible flow solvers
+@{
+    \ingroup grpSolvers
+    This group contains compressible flow solvers.
+@}
+
+\*---------------------------------------------------------------------------*/

applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C

@@ -24,6 +24,9 @@ License
 Application
     rhoCentralDyMFoam
 
+Group
+    grpCompressibleSolvers grpMovingMeshSolvers
+
 Description
     Density-based compressible flow solver based on central-upwind schemes of
     Kurganov and Tadmor with support for mesh-motion and topology changes

applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C

@@ -24,6 +24,9 @@ License
 Application
     rhoCentralFoam
 
+Group
+    grpCompressibleSolvers
+
 Description
     Density-based compressible flow solver based on central-upwind schemes of
     Kurganov and Tadmor

applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C

@@ -24,6 +24,9 @@ License
 Application
     rhoPimpleFoam
 
+Group
+    grpCompressibleSolvers
+
 Description
     Transient solver for laminar or turbulent flow of compressible fluids
     for HVAC and similar applications.

applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C

@@ -24,6 +24,9 @@ License
 Application
     rhoPorousSimpleFoam
 
+Group
+    grpCompressibleSolvers
+
 Description
     Steady-state solver for turbulent flow of compressible fluids with
     RANS turbulence modelling, implicit or explicit porosity treatment

applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C

@@ -24,6 +24,9 @@ License
 Application
     rhoSimpleFoam
 
+Group
+    grpCompressibleSolvers
+
 Description
     Steady-state SIMPLE solver for laminar or turbulent RANS flow of
     compressible fluids.

applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C

@@ -21,6 +21,9 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
+Group
+    grpCompressibleSolvers
+
 Application
     sonicLiquidFoam
 

applications/solvers/discreteMethods/discreteMethodsSolversDoc.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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 grpDiscreteMethodsSolvers Discrete method solvers
+@{
+    \ingroup grpSolvers
+    This group contains discrete method solvers.
+@}
+
+\*---------------------------------------------------------------------------*/

applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C

@@ -24,6 +24,9 @@ License
 Application
     dsmcFoam
 
+Group
+    grpDiscreteMethodsSolvers
+
 Description
     Direct simulation Monte Carlo (DSMC) solver for 3D, transient, multi-
     species flows

applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C

@@ -24,6 +24,9 @@ License
 Application
     mdEquilibrationFoam
 
+Group
+    grpDiscreteMethodsSolvers
+
 Description
     Equilibrates and/or preconditions molecular dynamics systems
 

applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C

@@ -24,6 +24,9 @@ License
 Application
     mdFoam
 
+Group
+    grpDiscreteMethodsSolvers
+
 Description
     Molecular dynamics solver for fluid dynamics
 

applications/solvers/doc/solver.dox

@@ -0,0 +1,44 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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/>.
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+\page pageSolvers Solvers
+
+\section secSolvers Overview
+The available solvers are grouped into the following categories:
+  - \ref grpBasicSolvers
+  - \ref grpCombustionSolvers
+  - \ref grpCompressibleSolvers
+  - \ref grpDiscreteMethodsSolvers
+  - \ref grpDNSSolvers
+  - \ref grpElectroMagneticsSolvers
+  - \ref grpFinancialSolvers
+  - \ref grpHeatTransferSolvers
+  - \ref grpIncompressibleSolvers
+  - \ref grpLagrangianSolvers
+  - \ref grpMultiphaseSolvers
+  - \ref grpStressAnalysisSolvers
+
+
+\*---------------------------------------------------------------------------*/

applications/solvers/doc/solversDoc.H

@@ -0,0 +1,37 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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 grpSolvers Solvers
+@{
+    This group contains solvers
+@}
+
+\defgroup grpMovingMeshSolvers Moving mesh solvers
+@{
+    \ingroup grpSolvers
+    This group contains moving mesh solvers solvers
+@}
+
+\*---------------------------------------------------------------------------*/

applications/solvers/electromagnetics/electromagneticsSolversDoc.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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 grpElectroMagneticsSolvers Electro-magnetics solvers
+@{
+    \ingroup grpSolvers
+    This group contains electro-magnetics solvers.
+@}
+
+\*---------------------------------------------------------------------------*/

applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C

@@ -24,6 +24,9 @@ License
 Application
     electrostaticFoam
 
+Group
+    grpElectroMagneticsSolvers
+
 Description
     Solver for electrostatics.
 

applications/solvers/electromagnetics/magneticFoam/magneticFoam.C

@@ -24,6 +24,9 @@ License
 Application
     magneticFoam
 
+Group
+    grpElectroMagneticsSolvers
+
 Description
     Solver for the magnetic field generated by permanent magnets.
 

applications/solvers/electromagnetics/mhdFoam/mhdFoam.C

@@ -24,6 +24,9 @@ License
 Application
     mhdFoam
 
+Group
+    grpElectroMagneticsSolvers
+
 Description
     Solver for magnetohydrodynamics (MHD): incompressible, laminar flow of a
     conducting fluid under the influence of a magnetic field.

applications/solvers/financial/financialFoam/financialFoam.C

@@ -24,6 +24,9 @@ License
 Application
     financialFoam
 
+Group
+    grpFinancialSolvers
+
 Description
     Solves the Black-Scholes equation to price commodities.
 

applications/solvers/financial/financialSolversDoc.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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 grpFinancialSolvers Financial solvers
+@{
+    \ingroup grpSolvers
+    This group contains financial solvers.
+@}
+
+\*---------------------------------------------------------------------------*/

applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C

@@ -24,6 +24,9 @@ License
 Application
     buoyantBoussinesqPimpleFoam
 
+Group
+    grpHeatTransferSolvers
+
 Description
     Transient solver for buoyant, turbulent flow of incompressible fluids
 

applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C

@@ -24,6 +24,9 @@ License
 Application
     buoyantBoussinesqSimpleFoam
 
+Group
+    grpHeatTransferSolvers
+
 Description
     Steady-state solver for buoyant, turbulent flow of incompressible fluids
 

applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C

@@ -24,6 +24,9 @@ License
 Application
     buoyantPimpleFoam
 
+Group
+    grpHeatTransferSolvers
+
 Description
     Transient solver for buoyant, turbulent flow of compressible fluids for
     ventilation and heat-transfer.

applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C

@@ -24,6 +24,9 @@ License
 Application
     buoyantSimpleFoam
 
+Group
+    grpHeatTransferSolvers
+
 Description
     Steady-state solver for buoyant, turbulent flow of compressible fluids,
     including radiation, for ventilation and heat-transfer.

applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C

@@ -24,6 +24,9 @@ License
 Application
     chtMultiRegionFoam
 
+Group
+    grpHeatTransferSolvers
+
 Description
     Combination of heatConductionFoam and buoyantFoam for conjugate heat
     transfer between solid regions and fluid regions. Both regions include

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

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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.

applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C

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

applications/solvers/lagrangian/lagrangianSolversDoc.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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 grpLagrangianSolvers Lagrangian solvers
+@{
+    \ingroup grpSolvers
+    This group contains Lagrangian solvers.
+@}
+
+\*---------------------------------------------------------------------------*/

applications/solvers/lagrangian/reactingParcelFilmFoam/reactingParcelFilmFoam.C

@@ -24,6 +24,9 @@ License
 Application
     reactingParcelFilmFoam
 
+Group
+    grpLagrangianSolvers
+
 Description
     Transient PIMPLE solver for compressible, laminar or turbulent flow with
     reacting Lagrangian parcels, and surface film modelling.

applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C

@@ -24,6 +24,9 @@ License
 Application
     reactingParcelFoam
 
+Group
+    grpLagrangianSolvers
+
 Description
     Transient PIMPLE solver for compressible, laminar or turbulent flow with
     reacting multiphase Lagrangian parcels, including run-time selectable

applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C

@@ -24,6 +24,9 @@ License
 Application
     simpleReactingParcelFoam
 
+Group
+    grpLagrangianSolvers
+
 Description
     Steady state SIMPLE solver for compressible, laminar or turbulent flow with
     reacting multiphase Lagrangian parcels, including run-time selectable

applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C

@@ -24,6 +24,9 @@ License
 Application
     sprayDyMFoam
 
+Group
+    grpLagrangianSolvers grpMovingMeshSolvers
+
 Description
     Transient PIMPLE solver for compressible, laminar or turbulent flow with
     spray parcels and support for moving meshes.

applications/solvers/lagrangian/sprayFoam/sprayEngineFoam/sprayEngineFoam.C

@@ -24,6 +24,9 @@ License
 Application
     sprayEngineFoam
 
+Group
+    grpLagrangianSolvers grpMovingMeshSolvers
+
 Description
     Transient PIMPLE solver for compressible, laminar or turbulent engine
     flow swith spray parcels.

applications/solvers/lagrangian/sprayFoam/sprayFoam.C

@@ -24,6 +24,9 @@ License
 Application
     sprayFoam
 
+Group
+    grpLagrangianSolvers
+
 Description
     Transient PIMPLE solver for compressible, laminar or turbulent flow with
     spray parcels.

applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C

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

applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C

@@ -24,6 +24,9 @@ License
 Application
     cavitatingFoam
 
+Group
+    grpMultiphaseSolvers grpMovingMeshSolvers
+
 Description
     Transient cavitation code based on the homogeneous equilibrium model
     from which the compressibility of the liquid/vapour "mixture" is obtained.

applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C

@@ -24,6 +24,9 @@ License
 Application
     cavitatingFoam
 
+Group
+    grpMultiphaseSolvers
+
 Description
     Transient cavitation code based on the homogeneous equilibrium model
     from which the compressibility of the liquid/vapour "mixture" is obtained.

applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C

@@ -24,6 +24,9 @@ License
 Application
     compressibleInterDyMFoam
 
+Group
+    grpMultiphaseSolvers grpMovingMeshSolvers
+
 Description
     Solver for 2 compressible, non-isothermal immiscible fluids using a VOF
     (volume of fluid) phase-fraction based interface capturing approach,

applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C

@@ -24,6 +24,9 @@ License
 Application
     compressibleInterFoam
 
+Group
+    grpMultiphaseSolvers
+
 Description
     Solver for 2 compressible, non-isothermal immiscible fluids using a VOF
     (volume of fluid) phase-fraction based interface capturing approach.

applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C

@@ -24,6 +24,9 @@ License
 Application
     compressibleMultiphaseInterFoam
 
+Group
+    grpMultiphaseSolvers
+
 Description
     Solver for n compressible, non-isothermal immiscible fluids using a VOF
     (volume of fluid) phase-fraction based interface capturing approach.

applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C

@@ -24,6 +24,9 @@ License
 Application
     driftFluxFoam
 
+Group
+    grpMultiphaseSolvers
+
 Description
     Solver for 2 incompressible fluids using the mixture approach with the
     drift-flux approximation for relative motion of the phases.

applications/solvers/multiphase/interFoam/interDyMFoam/interDyMFoam.C

@@ -24,6 +24,9 @@ License
 Application
     interDyMFoam
 
+Group
+    grpMultiphaseSolvers grpMovingMeshSolvers
+
 Description
     Solver for 2 incompressible, isothermal immiscible fluids using a VOF
     (volume of fluid) phase-fraction based interface capturing approach,

applications/solvers/multiphase/interFoam/interFoam.C

@@ -24,6 +24,9 @@ License
 Application
     interFoam
 
+Group
+    grpMultiphaseSolvers
+
 Description
     Solver for 2 incompressible, isothermal immiscible fluids using a VOF
     (volume of fluid) phase-fraction based interface capturing approach.

applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C

@@ -24,6 +24,9 @@ License
 Application
     interMixingFoam
 
+Group
+    grpMultiphaseSolvers
+
 Description
     Solver for 3 incompressible fluids, two of which are miscible,
     using a VOF method to capture the interface.

applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C

@@ -24,6 +24,9 @@ License
 Application
     interPhaseChangeDyMFoam
 
+Group
+    grpMultiphaseSolvers grpMovingMeshSolvers
+
 Description
     Solver for 2 incompressible, isothermal immiscible fluids with phase-change
     (e.g. cavitation).  Uses a VOF (volume of fluid) phase-fraction based

applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C

@@ -24,6 +24,9 @@ License
 Application
     interPhaseChangeFoam
 
+Group
+    grpMultiphaseSolvers
+
 Description
     Solver for 2 incompressible, isothermal immiscible fluids with phase-change
     (e.g. cavitation).  Uses a VOF (volume of fluid) phase-fraction based

applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C

@@ -24,6 +24,9 @@ License
 Application
     multiphaseEulerFoam
 
+Group
+    grpMultiphaseSolvers
+
 Description
     Solver for a system of many compressible fluid phases including
     heat-transfer.

applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterDyMFoam/multiphaseInterDyMFoam.C

@@ -24,6 +24,9 @@ License
 Application
     multiphaseInterFoam
 
+Group
+    grpMultiphaseSolvers grpMovingMeshSolvers
+
 Description
     Solver for n incompressible fluids which captures the interfaces and
     includes surface-tension and contact-angle effects for each phase.

applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C

@@ -24,6 +24,9 @@ License
 Application
     multiphaseInterFoam
 
+Group
+    grpMultiphaseSolvers
+
 Description
     Solver for n incompressible fluids which captures the interfaces and
     includes surface-tension and contact-angle effects for each phase.

applications/solvers/multiphase/multiphaseSolversDoc.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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 grpMultiphaseSolvers Multiphase solvers
+@{
+    \ingroup grpSolvers
+    This group contains multiphase solvers.
+@}
+
+\*---------------------------------------------------------------------------*/

applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C

@@ -24,6 +24,9 @@ License
 Application
     potentialFreeSurfaceDyMFoam
 
+Group
+    grpMultiphaseSolvers grpMovingMeshSolvers
+
 Description
     Incompressible Navier-Stokes solver with inclusion of a wave height field
     to enable single-phase free-surface approximations.

applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C

@@ -24,6 +24,9 @@ License
 Application
     potentialFreeSurfaceFoam
 
+Group
+    grpMultiphaseSolvers
+
 Description
     Incompressible Navier-Stokes solver with inclusion of a wave height field
     to enable single-phase free-surface approximations

applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C

@@ -24,6 +24,9 @@ License
 Application
     reactingMultiphaseEulerFoam
 
+Group
+    grpMultiphaseSolvers
+
 Description
     Solver for a system of any number of compressible fluid phases with a
     common pressure, but otherwise separate properties. The type of phase model

applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C

@@ -24,6 +24,9 @@ License
 Application
     reactingTwoPhaseEulerFoam
 
+Group
+    grpMultiphaseSolvers
+
 Description
     Solver for a system of 2 compressible fluid phases with a common pressure,
     but otherwise separate properties. The type of phase model is run time

applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C

@@ -24,6 +24,9 @@ License
 Application
     twoLiquidMixingFoam
 
+Group
+    grpMultiphaseSolvers
+
 Description
     Solver for mixing 2 incompressible fluids.
 

applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C

@@ -24,6 +24,9 @@ License
 Application
     twoPhaseEulerFoam
 
+Group
+    grpMultiphaseSolvers
+
 Description
     Solver for a system of 2 compressible fluid phases with one phase
     dispersed, e.g. gas bubbles in a liquid including heat-transfer.

applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C

@@ -24,6 +24,9 @@ License
 Application
     solidDisplacementFoam
 
+Group
+    grpStressAnalysisSolvers
+
 Description
     Transient segregated finite-volume solver of linear-elastic,
     small-strain deformation of a solid body, with optional thermal

applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C

@@ -24,6 +24,9 @@ License
 Application
     solidEquilibriumDisplacementFoam
 
+Group
+    grpStressAnalysisSolvers
+
 Description
     Steady-state segregated finite-volume solver of linear-elastic,
     small-strain deformation of a solid body, with optional thermal

applications/solvers/stressAnalysis/stressAnalysisSolversDoc.H

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  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 grpStressAnalysisSolvers Stress analysis solvers
+@{
+    \ingroup grpSolvers
+    This group contains stress analysis solvers.
+@}
+
+\*---------------------------------------------------------------------------*/