From b594d73c65cae3525dbe5e54124777e7f7910fce Mon Sep 17 00:00:00 2001
From: Andrew Heather <a.heather@opencfd.co.uk>
Date: Thu, 3 Dec 2015 22:05:55 +0000
Subject: [PATCH] ENH: Solvers - updated group documentation
---
applications/solvers/DNS/DNSSolversDoc.H | 30 +++++++++++++
applications/solvers/DNS/dnsFoam/dnsFoam.C | 3 ++
applications/solvers/basic/basicSolversDoc.H | 30 +++++++++++++
.../basic/laplacianFoam/laplacianFoam.C | 24 +++++++++-
.../scalarTransportFoam/scalarTransportFoam.C | 26 ++++++++++-
.../solvers/combustion/PDRFoam/PDRFoam.C | 24 +++++-----
.../combustion/XiFoam/XiDyMFoam/XiDyMFoam.C | 3 ++
.../solvers/combustion/XiFoam/XiFoam.C | 3 ++
.../solvers/combustion/chemFoam/chemFoam.C | 3 ++
.../coldEngineFoam/coldEngineFoam.C | 5 ++-
.../solvers/combustion/combustionSolversDoc.H | 30 +++++++++++++
.../combustion/engineFoam/engineFoam.C | 3 ++
.../solvers/combustion/fireFoam/fireFoam.C | 5 ++-
.../combustion/reactingFoam/reactingFoam.C | 3 ++
.../rhoReactingBuoyantFoam.C | 3 ++
.../rhoReactingFoam/rhoReactingFoam.C | 3 ++
.../compressible/compressibleSolvers.H | 30 +++++++++++++
.../rhoCentralDyMFoam/rhoCentralDyMFoam.C | 3 ++
.../rhoCentralFoam/rhoCentralFoam.C | 3 ++
.../rhoPimpleFoam/rhoPimpleFoam.C | 3 ++
.../rhoPorousSimpleFoam/rhoPorousSimpleFoam.C | 3 ++
.../rhoSimpleFoam/rhoSimpleFoam.C | 3 ++
.../sonicLiquidFoam/sonicLiquidFoam.C | 3 ++
.../discreteMethodsSolversDoc.H | 30 +++++++++++++
.../discreteMethods/dsmc/dsmcFoam/dsmcFoam.C | 3 ++
.../mdEquilibrationFoam/mdEquilibrationFoam.C | 3 ++
.../molecularDynamics/mdFoam/mdFoam.C | 3 ++
applications/solvers/doc/solver.dox | 44 +++++++++++++++++++
applications/solvers/doc/solversDoc.H | 37 ++++++++++++++++
.../electromagneticsSolversDoc.H | 30 +++++++++++++
.../electrostaticFoam/electrostaticFoam.C | 3 ++
.../magneticFoam/magneticFoam.C | 3 ++
.../electromagnetics/mhdFoam/mhdFoam.C | 3 ++
.../financial/financialFoam/financialFoam.C | 3 ++
.../solvers/financial/financialSolversDoc.H | 30 +++++++++++++
.../buoyantBoussinesqPimpleFoam.C | 3 ++
.../buoyantBoussinesqSimpleFoam.C | 3 ++
.../buoyantPimpleFoam/buoyantPimpleFoam.C | 3 ++
.../buoyantSimpleFoam/buoyantSimpleFoam.C | 3 ++
.../chtMultiRegionFoam/chtMultiRegionFoam.C | 3 ++
.../chtMultiRegionSimpleFoam.C | 3 ++
.../heatTransfer/heatTransferSolversDoc.H | 30 +++++++++++++
.../heatTransfer/thermoFoam/thermoFoam.C | 3 ++
.../adjointShapeOptimizationFoam.C | 3 ++
.../boundaryFoam/boundaryFoam.C | 3 ++
.../solvers/incompressible/icoFoam/icoFoam.C | 31 +++++++++++++
.../incompressible/incompressibleSolversDoc.H | 30 +++++++++++++
.../nonNewtonianIcoFoam/nonNewtonianIcoFoam.C | 3 ++
.../pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C | 3 ++
.../pimpleFoam/pimpleDyMFoam/pimpleDyMFoam.C | 3 ++
.../incompressible/pimpleFoam/pimpleFoam.C | 33 ++++++++++++++
.../incompressible/pisoFoam/pisoFoam.C | 31 +++++++++++++
.../shallowWaterFoam/shallowWaterFoam.C | 3 ++
.../simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C | 3 ++
.../porousSimpleFoam/porousSimpleFoam.C | 3 ++
.../incompressible/simpleFoam/simpleFoam.C | 34 +++++++++++++-
.../solvers/lagrangian/DPMFoam/DPMFoam.C | 3 ++
.../lagrangian/DPMFoam/MPPICFoam/MPPICFoam.C | 3 ++
.../coalChemistryFoam/coalChemistryFoam.C | 3 ++
.../icoUncoupledKinematicParcelDyMFoam.C | 3 ++
.../icoUncoupledKinematicParcelFoam.C | 3 ++
.../solvers/lagrangian/lagrangianSolversDoc.H | 30 +++++++++++++
.../reactingParcelFilmFoam.C | 3 ++
.../reactingParcelFoam/reactingParcelFoam.C | 3 ++
.../simpleReactingParcelFoam.C | 3 ++
.../sprayFoam/sprayDyMFoam/sprayDyMFoam.C | 3 ++
.../sprayEngineFoam/sprayEngineFoam.C | 3 ++
.../solvers/lagrangian/sprayFoam/sprayFoam.C | 3 ++
.../uncoupledKinematicParcelFoam.C | 3 ++
.../cavitatingDyMFoam/cavitatingDyMFoam.C | 3 ++
.../cavitatingFoam/cavitatingFoam.C | 3 ++
.../compressibleInterDyMFoam.C | 3 ++
.../compressibleInterFoam.C | 3 ++
.../compressibleMultiphaseInterFoam.C | 3 ++
.../multiphase/driftFluxFoam/driftFluxFoam.C | 3 ++
.../interFoam/interDyMFoam/interDyMFoam.C | 3 ++
.../solvers/multiphase/interFoam/interFoam.C | 3 ++
.../interMixingFoam/interMixingFoam.C | 3 ++
.../interPhaseChangeDyMFoam.C | 3 ++
.../interPhaseChangeFoam.C | 3 ++
.../multiphaseEulerFoam/multiphaseEulerFoam.C | 3 ++
.../multiphaseInterDyMFoam.C | 3 ++
.../multiphaseInterFoam/multiphaseInterFoam.C | 3 ++
.../solvers/multiphase/multiphaseSolversDoc.H | 30 +++++++++++++
.../potentialFreeSurfaceDyMFoam.C | 3 ++
.../potentialFreeSurfaceFoam.C | 3 ++
.../reactingMultiphaseEulerFoam.C | 3 ++
.../reactingTwoPhaseEulerFoam.C | 3 ++
.../twoLiquidMixingFoam/twoLiquidMixingFoam.C | 3 ++
.../twoPhaseEulerFoam/twoPhaseEulerFoam.C | 3 ++
.../solidDisplacementFoam.C | 3 ++
.../solidEquilibriumDisplacementFoam.C | 3 ++
.../stressAnalysis/stressAnalysisSolversDoc.H | 30 +++++++++++++
93 files changed, 849 insertions(+), 15 deletions(-)
create mode 100644 applications/solvers/DNS/DNSSolversDoc.H
create mode 100644 applications/solvers/basic/basicSolversDoc.H
create mode 100644 applications/solvers/combustion/combustionSolversDoc.H
create mode 100644 applications/solvers/compressible/compressibleSolvers.H
create mode 100644 applications/solvers/discreteMethods/discreteMethodsSolversDoc.H
create mode 100644 applications/solvers/doc/solver.dox
create mode 100644 applications/solvers/doc/solversDoc.H
create mode 100644 applications/solvers/electromagnetics/electromagneticsSolversDoc.H
create mode 100644 applications/solvers/financial/financialSolversDoc.H
create mode 100644 applications/solvers/heatTransfer/heatTransferSolversDoc.H
create mode 100644 applications/solvers/incompressible/incompressibleSolversDoc.H
create mode 100644 applications/solvers/lagrangian/lagrangianSolversDoc.H
create mode 100644 applications/solvers/multiphase/multiphaseSolversDoc.H
create mode 100644 applications/solvers/stressAnalysis/stressAnalysisSolversDoc.H
diff --git a/applications/solvers/DNS/DNSSolversDoc.H b/applications/solvers/DNS/DNSSolversDoc.H
new file mode 100644
index 00000000000..307be76cc59
--- /dev/null
+++ b/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.
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/DNS/dnsFoam/dnsFoam.C b/applications/solvers/DNS/dnsFoam/dnsFoam.C
index 38c5b7be8f0..444874c82f9 100644
--- a/applications/solvers/DNS/dnsFoam/dnsFoam.C
+++ b/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
diff --git a/applications/solvers/basic/basicSolversDoc.H b/applications/solvers/basic/basicSolversDoc.H
new file mode 100644
index 00000000000..c8bb86db95e
--- /dev/null
+++ b/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.
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/basic/laplacianFoam/laplacianFoam.C b/applications/solvers/basic/laplacianFoam/laplacianFoam.C
index 218d91ac447..846a4b00a03 100644
--- a/applications/solvers/basic/laplacianFoam/laplacianFoam.C
+++ b/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
\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C b/applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C
index 2430732e6dd..5db9981db67 100644
--- a/applications/solvers/basic/scalarTransportFoam/scalarTransportFoam.C
+++ b/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
\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/combustion/PDRFoam/PDRFoam.C b/applications/solvers/combustion/PDRFoam/PDRFoam.C
index fa8518ba495..08e82833820 100644
--- a/applications/solvers/combustion/PDRFoam/PDRFoam.C
+++ b/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:
-
- betav: Volume porosity
- Lobs: Average diameter of obstacle in cell (m)
- Aw: Obstacle surface area per unit volume (1/m)
- CR: Drag tensor (1/m)
- CT: Turbulence generation parameter (1/m)
- Nv: Number of obstacles in cell per unit volume (m^-2)
- nsv: Tensor whose diagonal indicates the number to substract from
- Nv to get the number of obstacles crossing the flow in each
- direction.
+ \plaintable
+ betav | Volume porosity
+ Lobs | Average diameter of obstacle in cell (m)
+ Aw | Obstacle surface area per unit volume (1/m)
+ CR | Drag tensor (1/m)
+ CT | Turbulence generation parameter (1/m)
+ Nv | Number of obstacles in cell per unit volume (m^-2)
+ nsv | Tensor whose diagonal indicates the number to substract from
+ | Nv to get the number of obstacles crossing the flow in each
+ | direction.
+ \endplaintable
\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C b/applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C
index d4cb0666e29..4b2c35f3664 100644
--- a/applications/solvers/combustion/XiFoam/XiDyMFoam/XiDyMFoam.C
+++ b/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.
diff --git a/applications/solvers/combustion/XiFoam/XiFoam.C b/applications/solvers/combustion/XiFoam/XiFoam.C
index 6090f923ca6..3b2c18f9257 100644
--- a/applications/solvers/combustion/XiFoam/XiFoam.C
+++ b/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.
diff --git a/applications/solvers/combustion/chemFoam/chemFoam.C b/applications/solvers/combustion/chemFoam/chemFoam.C
index a3455519332..cc94807a394 100644
--- a/applications/solvers/combustion/chemFoam/chemFoam.C
+++ b/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
diff --git a/applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C b/applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C
index e85010239b8..77c07e98540 100644
--- a/applications/solvers/combustion/coldEngineFoam/coldEngineFoam.C
+++ b/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.
diff --git a/applications/solvers/combustion/combustionSolversDoc.H b/applications/solvers/combustion/combustionSolversDoc.H
new file mode 100644
index 00000000000..bc68bdb7fef
--- /dev/null
+++ b/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.
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/combustion/engineFoam/engineFoam.C b/applications/solvers/combustion/engineFoam/engineFoam.C
index 4602eac9976..fc14f49da22 100644
--- a/applications/solvers/combustion/engineFoam/engineFoam.C
+++ b/applications/solvers/combustion/engineFoam/engineFoam.C
@@ -24,6 +24,9 @@ License
Application
engineFoam
+Group
+ grpCombustionSolvers
+
Description
Solver for internal combustion engines.
diff --git a/applications/solvers/combustion/fireFoam/fireFoam.C b/applications/solvers/combustion/fireFoam/fireFoam.C
index 31ace4dda83..203b4d475e6 100644
--- a/applications/solvers/combustion/fireFoam/fireFoam.C
+++ b/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.
\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/combustion/reactingFoam/reactingFoam.C b/applications/solvers/combustion/reactingFoam/reactingFoam.C
index 79deedb763f..793677b695b 100644
--- a/applications/solvers/combustion/reactingFoam/reactingFoam.C
+++ b/applications/solvers/combustion/reactingFoam/reactingFoam.C
@@ -24,6 +24,9 @@ License
Application
reactingFoam
+Group
+ grpCombustionSolvers
+
Description
Solver for combustion with chemical reactions.
diff --git a/applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C b/applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C
index e8645bb47c0..3d854c03ef3 100644
--- a/applications/solvers/combustion/reactingFoam/rhoReactingBuoyantFoam/rhoReactingBuoyantFoam.C
+++ b/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.
diff --git a/applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C b/applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C
index 6eb245028d0..c9e349a2601 100644
--- a/applications/solvers/combustion/reactingFoam/rhoReactingFoam/rhoReactingFoam.C
+++ b/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.
diff --git a/applications/solvers/compressible/compressibleSolvers.H b/applications/solvers/compressible/compressibleSolvers.H
new file mode 100644
index 00000000000..85ab71f5177
--- /dev/null
+++ b/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.
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C b/applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C
index 38ffddc7796..4bb65304bfc 100644
--- a/applications/solvers/compressible/rhoCentralFoam/rhoCentralDyMFoam/rhoCentralDyMFoam.C
+++ b/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
diff --git a/applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C b/applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C
index 4faed39f75b..808962e0935 100644
--- a/applications/solvers/compressible/rhoCentralFoam/rhoCentralFoam.C
+++ b/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
diff --git a/applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C b/applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C
index 382d041fd95..ddfab009b77 100644
--- a/applications/solvers/compressible/rhoPimpleFoam/rhoPimpleFoam.C
+++ b/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.
diff --git a/applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C b/applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C
index a7482b3df14..0e9fef5e26a 100644
--- a/applications/solvers/compressible/rhoSimpleFoam/rhoPorousSimpleFoam/rhoPorousSimpleFoam.C
+++ b/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
diff --git a/applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C b/applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C
index d554931e628..7f0908689d9 100644
--- a/applications/solvers/compressible/rhoSimpleFoam/rhoSimpleFoam.C
+++ b/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.
diff --git a/applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C b/applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C
index c60a331b2d6..9fda4612118 100644
--- a/applications/solvers/compressible/sonicFoam/sonicLiquidFoam/sonicLiquidFoam.C
+++ b/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
diff --git a/applications/solvers/discreteMethods/discreteMethodsSolversDoc.H b/applications/solvers/discreteMethods/discreteMethodsSolversDoc.H
new file mode 100644
index 00000000000..06c67407aa7
--- /dev/null
+++ b/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.
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C b/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C
index a5e0562155e..edf3691fb40 100644
--- a/applications/solvers/discreteMethods/dsmc/dsmcFoam/dsmcFoam.C
+++ b/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
diff --git a/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C b/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C
index 50c7f66085a..fa2b04f563b 100644
--- a/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C
+++ b/applications/solvers/discreteMethods/molecularDynamics/mdEquilibrationFoam/mdEquilibrationFoam.C
@@ -24,6 +24,9 @@ License
Application
mdEquilibrationFoam
+Group
+ grpDiscreteMethodsSolvers
+
Description
Equilibrates and/or preconditions molecular dynamics systems
diff --git a/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C b/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C
index 68f6530c95f..f06436c603f 100644
--- a/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C
+++ b/applications/solvers/discreteMethods/molecularDynamics/mdFoam/mdFoam.C
@@ -24,6 +24,9 @@ License
Application
mdFoam
+Group
+ grpDiscreteMethodsSolvers
+
Description
Molecular dynamics solver for fluid dynamics
diff --git a/applications/solvers/doc/solver.dox b/applications/solvers/doc/solver.dox
new file mode 100644
index 00000000000..4c829de1624
--- /dev/null
+++ b/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
+
+
+\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/doc/solversDoc.H b/applications/solvers/doc/solversDoc.H
new file mode 100644
index 00000000000..da58bc0ce33
--- /dev/null
+++ b/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
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/electromagnetics/electromagneticsSolversDoc.H b/applications/solvers/electromagnetics/electromagneticsSolversDoc.H
new file mode 100644
index 00000000000..773733f5bb3
--- /dev/null
+++ b/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.
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C b/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C
index 94cd1f0ca76..5c4a248df0a 100644
--- a/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C
+++ b/applications/solvers/electromagnetics/electrostaticFoam/electrostaticFoam.C
@@ -24,6 +24,9 @@ License
Application
electrostaticFoam
+Group
+ grpElectroMagneticsSolvers
+
Description
Solver for electrostatics.
diff --git a/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C b/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C
index 1b7d4f4f948..6613d2f206e 100644
--- a/applications/solvers/electromagnetics/magneticFoam/magneticFoam.C
+++ b/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.
diff --git a/applications/solvers/electromagnetics/mhdFoam/mhdFoam.C b/applications/solvers/electromagnetics/mhdFoam/mhdFoam.C
index c9cb0242bd1..497e977e85a 100644
--- a/applications/solvers/electromagnetics/mhdFoam/mhdFoam.C
+++ b/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.
diff --git a/applications/solvers/financial/financialFoam/financialFoam.C b/applications/solvers/financial/financialFoam/financialFoam.C
index 16640d7ce7e..2c912c7b93c 100644
--- a/applications/solvers/financial/financialFoam/financialFoam.C
+++ b/applications/solvers/financial/financialFoam/financialFoam.C
@@ -24,6 +24,9 @@ License
Application
financialFoam
+Group
+ grpFinancialSolvers
+
Description
Solves the Black-Scholes equation to price commodities.
diff --git a/applications/solvers/financial/financialSolversDoc.H b/applications/solvers/financial/financialSolversDoc.H
new file mode 100644
index 00000000000..02197d5e375
--- /dev/null
+++ b/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.
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C b/applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C
index e71cd3febe2..01477f9ed1d 100644
--- a/applications/solvers/heatTransfer/buoyantBoussinesqPimpleFoam/buoyantBoussinesqPimpleFoam.C
+++ b/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
diff --git a/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C b/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C
index 6dff329d1fe..ebe4bac86c3 100644
--- a/applications/solvers/heatTransfer/buoyantBoussinesqSimpleFoam/buoyantBoussinesqSimpleFoam.C
+++ b/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
diff --git a/applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C b/applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C
index cd254643b08..42104ed54e5 100644
--- a/applications/solvers/heatTransfer/buoyantPimpleFoam/buoyantPimpleFoam.C
+++ b/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.
diff --git a/applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C b/applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C
index 403fb6fecd1..e6f5573e362 100644
--- a/applications/solvers/heatTransfer/buoyantSimpleFoam/buoyantSimpleFoam.C
+++ b/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.
diff --git a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C b/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C
index 7fe33fab37f..f00fb7fa05d 100644
--- a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionFoam.C
+++ b/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
diff --git a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C b/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C
index 6c07dcbdfc4..dca30c63130 100644
--- a/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C
+++ b/applications/solvers/heatTransfer/chtMultiRegionFoam/chtMultiRegionSimpleFoam/chtMultiRegionSimpleFoam.C
@@ -24,6 +24,9 @@ License
Application
chtMultiRegionSimpleFoam
+Group
+ grpHeatTransferSolvers
+
Description
Steady-state version of chtMultiRegionFoam
diff --git a/applications/solvers/heatTransfer/heatTransferSolversDoc.H b/applications/solvers/heatTransfer/heatTransferSolversDoc.H
new file mode 100644
index 00000000000..e85a79b97ce
--- /dev/null
+++ b/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.
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C b/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C
index a23ce288e3c..01de8352313 100644
--- a/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C
+++ b/applications/solvers/heatTransfer/thermoFoam/thermoFoam.C
@@ -24,6 +24,9 @@ License
Application
thermoFoam
+Group
+ grpHeatTransferSolvers
+
Description
Evolves the thermodynamics on a frozen flow field
diff --git a/applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C b/applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C
index f57f444121b..d4eb1d72d16 100644
--- a/applications/solvers/incompressible/adjointShapeOptimizationFoam/adjointShapeOptimizationFoam.C
+++ b/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
diff --git a/applications/solvers/incompressible/boundaryFoam/boundaryFoam.C b/applications/solvers/incompressible/boundaryFoam/boundaryFoam.C
index 4e35c5258f7..dc707b61dd1 100644
--- a/applications/solvers/incompressible/boundaryFoam/boundaryFoam.C
+++ b/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.
diff --git a/applications/solvers/incompressible/icoFoam/icoFoam.C b/applications/solvers/incompressible/icoFoam/icoFoam.C
index 80e13faa8df..a7d0da4a8a2 100644
--- a/applications/solvers/incompressible/icoFoam/icoFoam.C
+++ b/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"
diff --git a/applications/solvers/incompressible/incompressibleSolversDoc.H b/applications/solvers/incompressible/incompressibleSolversDoc.H
new file mode 100644
index 00000000000..1ae50df0346
--- /dev/null
+++ b/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.
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C b/applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C
index 9d3b567d3bf..e1153a2772a 100644
--- a/applications/solvers/incompressible/nonNewtonianIcoFoam/nonNewtonianIcoFoam.C
+++ b/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.
diff --git a/applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C b/applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C
index bfa86ea1d9b..eb5b2640694 100644
--- a/applications/solvers/incompressible/pimpleFoam/SRFPimpleFoam/SRFPimpleFoam.C
+++ b/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.
diff --git a/applications/solvers/incompressible/pimpleFoam/pimpleDyMFoam/pimpleDyMFoam.C b/applications/solvers/incompressible/pimpleFoam/pimpleDyMFoam/pimpleDyMFoam.C
index cb01c03d63c..2ef70009692 100644
--- a/applications/solvers/incompressible/pimpleFoam/pimpleDyMFoam/pimpleDyMFoam.C
+++ b/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.
diff --git a/applications/solvers/incompressible/pimpleFoam/pimpleFoam.C b/applications/solvers/incompressible/pimpleFoam/pimpleFoam.C
index 72c6178d723..23cf9208bbe 100644
--- a/applications/solvers/incompressible/pimpleFoam/pimpleFoam.C
+++ b/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"
diff --git a/applications/solvers/incompressible/pisoFoam/pisoFoam.C b/applications/solvers/incompressible/pisoFoam/pisoFoam.C
index 482b695cb94..b5a76a540a1 100644
--- a/applications/solvers/incompressible/pisoFoam/pisoFoam.C
+++ b/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"
diff --git a/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C b/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C
index 47ec8ac9f63..e7693a073ed 100644
--- a/applications/solvers/incompressible/shallowWaterFoam/shallowWaterFoam.C
+++ b/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.
diff --git a/applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C b/applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C
index 97617bd925f..43a3d418658 100644
--- a/applications/solvers/incompressible/simpleFoam/SRFSimpleFoam/SRFSimpleFoam.C
+++ b/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.
diff --git a/applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C b/applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C
index 3c9ef15c954..d0864330127 100644
--- a/applications/solvers/incompressible/simpleFoam/porousSimpleFoam/porousSimpleFoam.C
+++ b/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
diff --git a/applications/solvers/incompressible/simpleFoam/simpleFoam.C b/applications/solvers/incompressible/simpleFoam/simpleFoam.C
index eeb7bc1e345..5ea3fd50b13 100644
--- a/applications/solvers/incompressible/simpleFoam/simpleFoam.C
+++ b/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
\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/lagrangian/DPMFoam/DPMFoam.C b/applications/solvers/lagrangian/DPMFoam/DPMFoam.C
index 8999e03663d..22c16b4c80e 100644
--- a/applications/solvers/lagrangian/DPMFoam/DPMFoam.C
+++ b/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
diff --git a/applications/solvers/lagrangian/DPMFoam/MPPICFoam/MPPICFoam.C b/applications/solvers/lagrangian/DPMFoam/MPPICFoam/MPPICFoam.C
index 69048cf5a6f..4bb369f11b4 100644
--- a/applications/solvers/lagrangian/DPMFoam/MPPICFoam/MPPICFoam.C
+++ b/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
diff --git a/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C b/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C
index 3bfb2be7764..ab799c64965 100644
--- a/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C
+++ b/applications/solvers/lagrangian/coalChemistryFoam/coalChemistryFoam.C
@@ -24,6 +24,9 @@ License
Application
coalChemistryFoam
+Group
+ grpLagrangianSolvers
+
Description
Transient solver for:
- compressible,
diff --git a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C
index b355148a94c..0110832f2d7 100644
--- a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelDyMFoam/icoUncoupledKinematicParcelDyMFoam.C
+++ b/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.
diff --git a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C b/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C
index befcb57d02b..42273c1be5b 100644
--- a/applications/solvers/lagrangian/icoUncoupledKinematicParcelFoam/icoUncoupledKinematicParcelFoam.C
+++ b/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.
diff --git a/applications/solvers/lagrangian/lagrangianSolversDoc.H b/applications/solvers/lagrangian/lagrangianSolversDoc.H
new file mode 100644
index 00000000000..7eb88c4f3f9
--- /dev/null
+++ b/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.
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/lagrangian/reactingParcelFilmFoam/reactingParcelFilmFoam.C b/applications/solvers/lagrangian/reactingParcelFilmFoam/reactingParcelFilmFoam.C
index 98b33ff2854..446fbb7b1a9 100644
--- a/applications/solvers/lagrangian/reactingParcelFilmFoam/reactingParcelFilmFoam.C
+++ b/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.
diff --git a/applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C b/applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C
index b3e758df12f..38f205d3206 100644
--- a/applications/solvers/lagrangian/reactingParcelFoam/reactingParcelFoam.C
+++ b/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
diff --git a/applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C b/applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C
index 9a49318c23e..d99253d077f 100644
--- a/applications/solvers/lagrangian/reactingParcelFoam/simpleReactingParcelFoam/simpleReactingParcelFoam.C
+++ b/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
diff --git a/applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C b/applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C
index 38ac4e515b6..5633a94bc0b 100644
--- a/applications/solvers/lagrangian/sprayFoam/sprayDyMFoam/sprayDyMFoam.C
+++ b/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.
diff --git a/applications/solvers/lagrangian/sprayFoam/sprayEngineFoam/sprayEngineFoam.C b/applications/solvers/lagrangian/sprayFoam/sprayEngineFoam/sprayEngineFoam.C
index 730d0f3fb46..8c4efc35557 100644
--- a/applications/solvers/lagrangian/sprayFoam/sprayEngineFoam/sprayEngineFoam.C
+++ b/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.
diff --git a/applications/solvers/lagrangian/sprayFoam/sprayFoam.C b/applications/solvers/lagrangian/sprayFoam/sprayFoam.C
index 066ce82f68b..8365bdfadec 100644
--- a/applications/solvers/lagrangian/sprayFoam/sprayFoam.C
+++ b/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.
diff --git a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C b/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C
index 6545c4d72b4..c6b592fb45f 100644
--- a/applications/solvers/lagrangian/uncoupledKinematicParcelFoam/uncoupledKinematicParcelFoam.C
+++ b/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.
diff --git a/applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C b/applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C
index 189208de950..b578ed26c71 100644
--- a/applications/solvers/multiphase/cavitatingFoam/cavitatingDyMFoam/cavitatingDyMFoam.C
+++ b/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.
diff --git a/applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C b/applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C
index b521f5b9c62..a71fc55e77d 100644
--- a/applications/solvers/multiphase/cavitatingFoam/cavitatingFoam.C
+++ b/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.
diff --git a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C
index 4e40addf207..6930d6e9621 100644
--- a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterDyMFoam/compressibleInterDyMFoam.C
+++ b/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,
diff --git a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C b/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C
index 7736099eaa8..f7f44c16a9b 100644
--- a/applications/solvers/multiphase/compressibleInterFoam/compressibleInterFoam.C
+++ b/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.
diff --git a/applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C b/applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C
index 4fd75efebff..bf84f44e3c5 100644
--- a/applications/solvers/multiphase/compressibleMultiphaseInterFoam/compressibleMultiphaseInterFoam.C
+++ b/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.
diff --git a/applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C b/applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C
index 3b88b1b9567..45baf407b87 100644
--- a/applications/solvers/multiphase/driftFluxFoam/driftFluxFoam.C
+++ b/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.
diff --git a/applications/solvers/multiphase/interFoam/interDyMFoam/interDyMFoam.C b/applications/solvers/multiphase/interFoam/interDyMFoam/interDyMFoam.C
index f30a1958069..f5f61b4ac16 100644
--- a/applications/solvers/multiphase/interFoam/interDyMFoam/interDyMFoam.C
+++ b/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,
diff --git a/applications/solvers/multiphase/interFoam/interFoam.C b/applications/solvers/multiphase/interFoam/interFoam.C
index 26f22af205a..9f929e7f0b8 100644
--- a/applications/solvers/multiphase/interFoam/interFoam.C
+++ b/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.
diff --git a/applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C b/applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C
index 86a05e71f1a..8d64b4b5e01 100644
--- a/applications/solvers/multiphase/interFoam/interMixingFoam/interMixingFoam.C
+++ b/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.
diff --git a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C b/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C
index 93e4ebc0d11..95146cfbc50 100644
--- a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeDyMFoam/interPhaseChangeDyMFoam.C
+++ b/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
diff --git a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C b/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C
index 8552126034e..6a91b597f67 100644
--- a/applications/solvers/multiphase/interPhaseChangeFoam/interPhaseChangeFoam.C
+++ b/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
diff --git a/applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C b/applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C
index 8244f739d75..503f5f776db 100644
--- a/applications/solvers/multiphase/multiphaseEulerFoam/multiphaseEulerFoam.C
+++ b/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.
diff --git a/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterDyMFoam/multiphaseInterDyMFoam.C b/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterDyMFoam/multiphaseInterDyMFoam.C
index a04341c7ba9..c67b681d069 100644
--- a/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterDyMFoam/multiphaseInterDyMFoam.C
+++ b/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.
diff --git a/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C b/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C
index 0fb8ff1208f..38a7f00a40c 100644
--- a/applications/solvers/multiphase/multiphaseInterFoam/multiphaseInterFoam.C
+++ b/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.
diff --git a/applications/solvers/multiphase/multiphaseSolversDoc.H b/applications/solvers/multiphase/multiphaseSolversDoc.H
new file mode 100644
index 00000000000..1efb73e01bf
--- /dev/null
+++ b/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.
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C b/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C
index b740ab2b9b1..4c4aa314876 100644
--- a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceDyMFoam/potentialFreeSurfaceDyMFoam.C
+++ b/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.
diff --git a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C b/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C
index b98bdb694d5..3cef9aab1e0 100644
--- a/applications/solvers/multiphase/potentialFreeSurfaceFoam/potentialFreeSurfaceFoam.C
+++ b/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
diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C b/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C
index cb90ee11962..0271175a9e3 100644
--- a/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C
+++ b/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
diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C
index d18171a35d3..29b28ae332c 100644
--- a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C
+++ b/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
diff --git a/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C b/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C
index d8519d6182b..0a097dec837 100644
--- a/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C
+++ b/applications/solvers/multiphase/twoLiquidMixingFoam/twoLiquidMixingFoam.C
@@ -24,6 +24,9 @@ License
Application
twoLiquidMixingFoam
+Group
+ grpMultiphaseSolvers
+
Description
Solver for mixing 2 incompressible fluids.
diff --git a/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C b/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C
index 646b340c826..e030446d1c7 100644
--- a/applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseEulerFoam.C
+++ b/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.
diff --git a/applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C b/applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C
index e2c6c943379..129df9315d9 100644
--- a/applications/solvers/stressAnalysis/solidDisplacementFoam/solidDisplacementFoam.C
+++ b/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
diff --git a/applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C b/applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C
index 240593d8146..4abd493e2f4 100644
--- a/applications/solvers/stressAnalysis/solidEquilibriumDisplacementFoam/solidEquilibriumDisplacementFoam.C
+++ b/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
diff --git a/applications/solvers/stressAnalysis/stressAnalysisSolversDoc.H b/applications/solvers/stressAnalysis/stressAnalysisSolversDoc.H
new file mode 100644
index 00000000000..fe3e73b0d4d
--- /dev/null
+++ b/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.
+@}
+
+\*---------------------------------------------------------------------------*/
--
GitLab