From e57a0e68a21be9d828bd3f81717b39564e3ac70a Mon Sep 17 00:00:00 2001
From: Andrew Heather <a.heather@opencfd.co.uk>
Date: Fri, 17 Jun 2016 17:41:04 +0100
Subject: [PATCH] ENH: (further) Doxygen documentation updates for module
support
---
doc/Doxygen/Doxyfile | 2 +-
src/OpenFOAM/global/foamDoc.H | 16 +++++-
.../matrices/lduMatrix/doc/lduMatrix.dox | 36 ++++++++++++
.../matrices/lduMatrix/doc/lduMatrixDoc.H | 56 +++++++++++++++++++
.../DICPreconditioner/DICPreconditioner.H | 3 +
.../DILUPreconditioner/DILUPreconditioner.H | 3 +
.../FDICPreconditioner/FDICPreconditioner.H | 3 +
.../GAMGPreconditioner/GAMGPreconditioner.H | 3 +
.../diagonalPreconditioner.H | 3 +
.../noPreconditioner/noPreconditioner.H | 3 +
.../lduMatrix/smoothers/DIC/DICSmoother.H | 3 +
.../DICGaussSeidel/DICGaussSeidelSmoother.H | 3 +
.../lduMatrix/smoothers/DILU/DILUSmoother.H | 3 +
.../GaussSeidel/GaussSeidelSmoother.H | 3 +
.../nonBlockingGaussSeidelSmoother.H | 3 +
.../symGaussSeidel/symGaussSeidelSmoother.H | 3 +
.../matrices/lduMatrix/solvers/BICCG/BICCG.H | 7 ++-
.../lduMatrix/solvers/GAMG/GAMGSolver.H | 7 ++-
.../matrices/lduMatrix/solvers/ICCG/ICCG.H | 5 +-
.../matrices/lduMatrix/solvers/PCG/PCG.H | 5 +-
.../solvers/diagonalSolver/diagonalSolver.H | 5 +-
.../solvers/smoothSolver/smoothSolver.H | 4 ++
.../turbulenceModels/doc/turbulenceModel.dox | 36 ++++++++++++
.../finiteVolume/doc/finiteVolumeSchemes.dox | 40 +++++++++++++
.../finiteVolume/doc/finiteVolumeSchemesDoc.H | 1 +
.../fixedTemperatureConstraint.H | 3 +
.../velocityDampingConstraint.H | 3 +
.../explicitSetValue/ExplicitSetValue.H | 3 +
.../limitTemperature/limitTemperature.H | 3 +
src/fvOptions/doc/fvOptionsDoc.H | 51 +++++++++++++++++
.../actuationDiskSource/actuationDiskSource.H | 3 +
.../derived/buoyancyEnergy/buoyancyEnergy.H | 3 +
.../derived/buoyancyForce/buoyancyForce.H | 3 +
...irectionalPressureGradientExplicitSource.H | 3 +
.../effectivenessHeatExchangerSource.H | 3 +
.../explicitPorositySource.H | 3 +
.../meanVelocityForce/meanVelocityForce.H | 3 +
.../radialActuationDiskSource.H | 3 +
.../derived/rotorDiskSource/rotorDiskSource.H | 3 +
.../solidificationMeltingSource.H | 3 +
.../tabulatedAccelerationSource.H | 6 +-
.../sources/general/codedSource/CodedSource.H | 3 +
.../semiImplicitSource/SemiImplicitSource.H | 3 +
.../interRegionExplicitPorositySource.H | 3 +
.../constantHeatTransfer.H | 3 +
.../interRegionHeatTransferModel.H | 3 +
.../tabulatedHeatTransfer.H | 3 +
.../tabulatedNTUHeatTransfer.H | 3 +
.../variableHeatTransfer.H | 3 +
.../doc/lagrangianIntermediate.dox | 41 ++++++++++++++
...hemesDoc.H => lagrangianIntermediateDoc.H} | 0
.../functionObjects/doc/functionObjects.dox | 3 +-
.../reactionsSensitivityAnalysis.H | 2 +-
.../doc/thermophysicalModels.dox | 33 +++++++++++
.../doc/thermophysicalModelsDoc.H | 6 ++
.../chemistryReader/chemistryReader.H | 3 +
.../chemkinReader/chemkinReader.H | 3 +
.../foamChemistryReader/foamChemistryReader.H | 3 +
.../fixedUnburntEnthalpyFvPatchScalarField.H | 5 +-
...radientUnburntEnthalpyFvPatchScalarField.H | 3 +
.../mixedUnburntEnthalpyFvPatchScalarField.H | 3 +
.../reactionThermo/doc/reactionThermoDoc.H | 43 ++++++++++++++
.../moleFractions/moleFractions.H | 3 +
.../mixtures/SpecieMixture/SpecieMixture.H | 3 +
.../basicCombustionMixture.H | 3 +
.../basicMultiComponentMixture.H | 3 +
.../basicSpecieMixture/basicSpecieMixture.H | 3 +
.../mixtures/egrMixture/egrMixture.H | 3 +
.../homogeneousMixture/homogeneousMixture.H | 3 +
.../inhomogeneousMixture.H | 3 +
.../multiComponentMixture.H | 3 +
.../reactingMixture/reactingMixture.H | 3 +
.../singleStepReactingMixture.H | 3 +
.../veryInhomogeneousMixture.H | 3 +
74 files changed, 550 insertions(+), 13 deletions(-)
create mode 100644 src/OpenFOAM/matrices/lduMatrix/doc/lduMatrix.dox
create mode 100644 src/OpenFOAM/matrices/lduMatrix/doc/lduMatrixDoc.H
create mode 100644 src/TurbulenceModels/turbulenceModels/doc/turbulenceModel.dox
create mode 100644 src/finiteVolume/finiteVolume/doc/finiteVolumeSchemes.dox
create mode 100644 src/fvOptions/doc/fvOptionsDoc.H
create mode 100644 src/lagrangian/intermediate/doc/lagrangianIntermediate.dox
rename src/lagrangian/intermediate/doc/{finiteVolumeSchemesDoc.H => lagrangianIntermediateDoc.H} (100%)
create mode 100644 src/thermophysicalModels/doc/thermophysicalModels.dox
create mode 100644 src/thermophysicalModels/reactionThermo/doc/reactionThermoDoc.H
diff --git a/doc/Doxygen/Doxyfile b/doc/Doxygen/Doxyfile
index 4e86e5338df..694463d0721 100644
--- a/doc/Doxygen/Doxyfile
+++ b/doc/Doxygen/Doxyfile
@@ -578,7 +578,7 @@ SORT_MEMBERS_CTORS_1ST = NO
# appear in their defined order.
# The default value is: NO.
-SORT_GROUP_NAMES = NO
+SORT_GROUP_NAMES = YES
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
diff --git a/src/OpenFOAM/global/foamDoc.H b/src/OpenFOAM/global/foamDoc.H
index 73210859be8..1d251618f5f 100644
--- a/src/OpenFOAM/global/foamDoc.H
+++ b/src/OpenFOAM/global/foamDoc.H
@@ -3,7 +3,7 @@
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
- \\/ M anipulation |
+ \\/ M anipulation | Copyright (C) 2016 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
@@ -56,8 +56,22 @@ License
\section usingTheCode Using the code
+ Solvers
- \subpage pageSolvers
+
+ Modelling
+ - \subpage pageThermophsyicalModels
+ - \subpage pageTurbulenceModelling
+ - \subpage pageLagrangianIntermediate
+
+ Boundary conditions
- \subpage pageBoundaryConditions
+
+ Numerics
+ - \subpage pageFiniteVolumeSchemes
+ - \subpage pageMatrixSolvers
+
+ Post-processing
- \subpage pagePostProcessing
diff --git a/src/OpenFOAM/matrices/lduMatrix/doc/lduMatrix.dox b/src/OpenFOAM/matrices/lduMatrix/doc/lduMatrix.dox
new file mode 100644
index 00000000000..12e9bd033ae
--- /dev/null
+++ b/src/OpenFOAM/matrices/lduMatrix/doc/lduMatrix.dox
@@ -0,0 +1,36 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
+ \\/ 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 pageMatrixSolvers Matrix solvers
+
+\section secSchemes Overview
+The available matrix solvers are grouped into the following categories:
+ - \ref grpLduMatrix
+ - \ref grpLduMatrixPreconditioners
+ - \ref grpLduMatrixSmoothers
+ - \ref grpLduMatrixSolvers
+
+
+\*---------------------------------------------------------------------------*/
diff --git a/src/OpenFOAM/matrices/lduMatrix/doc/lduMatrixDoc.H b/src/OpenFOAM/matrices/lduMatrix/doc/lduMatrixDoc.H
new file mode 100644
index 00000000000..c9da613b45e
--- /dev/null
+++ b/src/OpenFOAM/matrices/lduMatrix/doc/lduMatrixDoc.H
@@ -0,0 +1,56 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
+ \\/ 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 grpNumerics Numerics
+@{
+ This group contains numerics
+@}
+
+\defgroup grpLduMatrix Matrix manipulation and solvers
+@{
+ \ingroup grpNumerics
+ This group contains matrices
+@}
+
+\defgroup grpLduMatrixPreconditioners Preconditioners
+@{
+ \ingroup grpLduMatrix
+ This group contains matrix preconditioners
+@}
+
+\defgroup grpLduMatrixSmoothers Smoothers
+@{
+ \ingroup grpLduMatrix
+ This group contains matrix smoothers
+@}
+
+\defgroup grpLduMatrixSolvers Solvers
+@{
+ \ingroup grpLduMatrix
+ This group contains matrix solvers
+@}
+
+
+\*---------------------------------------------------------------------------*/
diff --git a/src/OpenFOAM/matrices/lduMatrix/preconditioners/DICPreconditioner/DICPreconditioner.H b/src/OpenFOAM/matrices/lduMatrix/preconditioners/DICPreconditioner/DICPreconditioner.H
index 24c7432ebe1..31a29b5b5c2 100644
--- a/src/OpenFOAM/matrices/lduMatrix/preconditioners/DICPreconditioner/DICPreconditioner.H
+++ b/src/OpenFOAM/matrices/lduMatrix/preconditioners/DICPreconditioner/DICPreconditioner.H
@@ -24,6 +24,9 @@ License
Class
Foam::DICPreconditioner
+Group
+ grpLduMatrixPreconditioners
+
Description
Simplified diagonal-based incomplete Cholesky preconditioner for symmetric
matrices (symmetric equivalent of DILU). The reciprocal of the
diff --git a/src/OpenFOAM/matrices/lduMatrix/preconditioners/DILUPreconditioner/DILUPreconditioner.H b/src/OpenFOAM/matrices/lduMatrix/preconditioners/DILUPreconditioner/DILUPreconditioner.H
index 90a9e8d694d..5a9c5fda5c2 100644
--- a/src/OpenFOAM/matrices/lduMatrix/preconditioners/DILUPreconditioner/DILUPreconditioner.H
+++ b/src/OpenFOAM/matrices/lduMatrix/preconditioners/DILUPreconditioner/DILUPreconditioner.H
@@ -24,6 +24,9 @@ License
Class
Foam::DILUPreconditioner
+Group
+ grpLduMatrixPreconditioners
+
Description
Simplified diagonal-based incomplete LU preconditioner for asymmetric
matrices. The reciprocal of the preconditioned diagonal is calculated
diff --git a/src/OpenFOAM/matrices/lduMatrix/preconditioners/FDICPreconditioner/FDICPreconditioner.H b/src/OpenFOAM/matrices/lduMatrix/preconditioners/FDICPreconditioner/FDICPreconditioner.H
index 7f75f6ec64e..044f44c2539 100644
--- a/src/OpenFOAM/matrices/lduMatrix/preconditioners/FDICPreconditioner/FDICPreconditioner.H
+++ b/src/OpenFOAM/matrices/lduMatrix/preconditioners/FDICPreconditioner/FDICPreconditioner.H
@@ -24,6 +24,9 @@ License
Class
Foam::FDICPreconditioner
+Group
+ grpLduMatrixPreconditioners
+
Description
Faster version of the DICPreconditioner diagonal-based incomplete
Cholesky preconditioner for symmetric matrices
diff --git a/src/OpenFOAM/matrices/lduMatrix/preconditioners/GAMGPreconditioner/GAMGPreconditioner.H b/src/OpenFOAM/matrices/lduMatrix/preconditioners/GAMGPreconditioner/GAMGPreconditioner.H
index f79f7f1f1fc..adf0c63e707 100644
--- a/src/OpenFOAM/matrices/lduMatrix/preconditioners/GAMGPreconditioner/GAMGPreconditioner.H
+++ b/src/OpenFOAM/matrices/lduMatrix/preconditioners/GAMGPreconditioner/GAMGPreconditioner.H
@@ -24,6 +24,9 @@ License
Class
Foam::GAMGPreconditioner
+Group
+ grpLduMatrixPreconditioners
+
Description
Geometric agglomerated algebraic multigrid preconditioner.
diff --git a/src/OpenFOAM/matrices/lduMatrix/preconditioners/diagonalPreconditioner/diagonalPreconditioner.H b/src/OpenFOAM/matrices/lduMatrix/preconditioners/diagonalPreconditioner/diagonalPreconditioner.H
index 83484535441..20552e66fdf 100644
--- a/src/OpenFOAM/matrices/lduMatrix/preconditioners/diagonalPreconditioner/diagonalPreconditioner.H
+++ b/src/OpenFOAM/matrices/lduMatrix/preconditioners/diagonalPreconditioner/diagonalPreconditioner.H
@@ -24,6 +24,9 @@ License
Class
Foam::diagonalPreconditioner
+Group
+ grpLduMatrixPreconditioners
+
Description
Diagonal preconditioner for both symmetric and asymmetric matrices.
diff --git a/src/OpenFOAM/matrices/lduMatrix/preconditioners/noPreconditioner/noPreconditioner.H b/src/OpenFOAM/matrices/lduMatrix/preconditioners/noPreconditioner/noPreconditioner.H
index 56fa4558113..549f873a960 100644
--- a/src/OpenFOAM/matrices/lduMatrix/preconditioners/noPreconditioner/noPreconditioner.H
+++ b/src/OpenFOAM/matrices/lduMatrix/preconditioners/noPreconditioner/noPreconditioner.H
@@ -24,6 +24,9 @@ License
Class
Foam::noPreconditioner
+Group
+ grpLduMatrixPreconditioners
+
Description
Null preconditioner for both symmetric and asymmetric matrices.
diff --git a/src/OpenFOAM/matrices/lduMatrix/smoothers/DIC/DICSmoother.H b/src/OpenFOAM/matrices/lduMatrix/smoothers/DIC/DICSmoother.H
index d4c610f043c..95a98fc94f5 100644
--- a/src/OpenFOAM/matrices/lduMatrix/smoothers/DIC/DICSmoother.H
+++ b/src/OpenFOAM/matrices/lduMatrix/smoothers/DIC/DICSmoother.H
@@ -24,6 +24,9 @@ License
Class
Foam::DICSmoother
+Group
+ grpLduMatrixSmoothers
+
Description
Simplified diagonal-based incomplete Cholesky smoother for symmetric
matrices.
diff --git a/src/OpenFOAM/matrices/lduMatrix/smoothers/DICGaussSeidel/DICGaussSeidelSmoother.H b/src/OpenFOAM/matrices/lduMatrix/smoothers/DICGaussSeidel/DICGaussSeidelSmoother.H
index b95a0209399..84407dcdeb7 100644
--- a/src/OpenFOAM/matrices/lduMatrix/smoothers/DICGaussSeidel/DICGaussSeidelSmoother.H
+++ b/src/OpenFOAM/matrices/lduMatrix/smoothers/DICGaussSeidel/DICGaussSeidelSmoother.H
@@ -24,6 +24,9 @@ License
Class
Foam::DICGaussSeidelSmoother
+Group
+ grpLduMatrixSmoothers
+
Description
Combined DIC/GaussSeidel smoother for symmetric matrices in which DIC
smoothing is followed by GaussSeidel to ensure that any "spikes" created
diff --git a/src/OpenFOAM/matrices/lduMatrix/smoothers/DILU/DILUSmoother.H b/src/OpenFOAM/matrices/lduMatrix/smoothers/DILU/DILUSmoother.H
index 843b386e77f..e9eb245b0b7 100644
--- a/src/OpenFOAM/matrices/lduMatrix/smoothers/DILU/DILUSmoother.H
+++ b/src/OpenFOAM/matrices/lduMatrix/smoothers/DILU/DILUSmoother.H
@@ -24,6 +24,9 @@ License
Class
Foam::DILUSmoother
+Group
+ grpLduMatrixSmoothers
+
Description
Simplified diagonal-based incomplete LU smoother for asymmetric matrices.
diff --git a/src/OpenFOAM/matrices/lduMatrix/smoothers/GaussSeidel/GaussSeidelSmoother.H b/src/OpenFOAM/matrices/lduMatrix/smoothers/GaussSeidel/GaussSeidelSmoother.H
index 9a1ad0480c2..d0720d5c1b5 100644
--- a/src/OpenFOAM/matrices/lduMatrix/smoothers/GaussSeidel/GaussSeidelSmoother.H
+++ b/src/OpenFOAM/matrices/lduMatrix/smoothers/GaussSeidel/GaussSeidelSmoother.H
@@ -24,6 +24,9 @@ License
Class
Foam::GaussSeidelSmoother
+Group
+ grpLduMatrixSmoothers
+
Description
A lduMatrix::smoother for Gauss-Seidel
diff --git a/src/OpenFOAM/matrices/lduMatrix/smoothers/nonBlockingGaussSeidel/nonBlockingGaussSeidelSmoother.H b/src/OpenFOAM/matrices/lduMatrix/smoothers/nonBlockingGaussSeidel/nonBlockingGaussSeidelSmoother.H
index 0562d875cfd..13aeb851867 100644
--- a/src/OpenFOAM/matrices/lduMatrix/smoothers/nonBlockingGaussSeidel/nonBlockingGaussSeidelSmoother.H
+++ b/src/OpenFOAM/matrices/lduMatrix/smoothers/nonBlockingGaussSeidel/nonBlockingGaussSeidelSmoother.H
@@ -24,6 +24,9 @@ License
Class
Foam::nonBlockingGaussSeidelSmoother
+Group
+ grpLduMatrixSmoothers
+
Description
Variant of gaussSeidelSmoother that expects processor boundary
cells to be sorted last and so can block later. Only when the
diff --git a/src/OpenFOAM/matrices/lduMatrix/smoothers/symGaussSeidel/symGaussSeidelSmoother.H b/src/OpenFOAM/matrices/lduMatrix/smoothers/symGaussSeidel/symGaussSeidelSmoother.H
index a9a25e651fb..2a920a7cae5 100644
--- a/src/OpenFOAM/matrices/lduMatrix/smoothers/symGaussSeidel/symGaussSeidelSmoother.H
+++ b/src/OpenFOAM/matrices/lduMatrix/smoothers/symGaussSeidel/symGaussSeidelSmoother.H
@@ -24,6 +24,9 @@ License
Class
Foam::symGaussSeidelSmoother
+Group
+ grpLduMatrixSmoothers
+
Description
A lduMatrix::smoother for symmetric Gauss-Seidel
diff --git a/src/OpenFOAM/matrices/lduMatrix/solvers/BICCG/BICCG.H b/src/OpenFOAM/matrices/lduMatrix/solvers/BICCG/BICCG.H
index 68a792c3795..9990e8b23b3 100644
--- a/src/OpenFOAM/matrices/lduMatrix/solvers/BICCG/BICCG.H
+++ b/src/OpenFOAM/matrices/lduMatrix/solvers/BICCG/BICCG.H
@@ -24,6 +24,9 @@ License
Class
Foam::BICCG
+Group
+ grpLduMatrixSolvers
+
Description
Diagonal incomplete LU preconditioned BiCG solver derived from the general
preconditioned BiCG solver PBiCG but with the choice of preconditioner
@@ -49,7 +52,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
- Class BICCG Declaration
+ Class BICCG Declaration
\*---------------------------------------------------------------------------*/
class BICCG
@@ -64,6 +67,7 @@ class BICCG
//- Disallow default bitwise assignment
void operator=(const BICCG&);
+
public:
//- Return the dictionary constructed from the components.
@@ -112,7 +116,6 @@ public:
//- Destructor
virtual ~BICCG()
{}
-
};
diff --git a/src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGSolver.H b/src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGSolver.H
index 9e220067d17..c7cbd2c02b2 100644
--- a/src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGSolver.H
+++ b/src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/GAMGSolver.H
@@ -24,10 +24,13 @@ License
Class
Foam::GAMGSolver
+Group
+ grpLduMatrixSolvers
+
Description
Geometric agglomerated algebraic multigrid solver.
- Characteristics:
+ Characteristics:
- Requires positive definite, diagonally dominant matrix.
- Agglomeration algorithm: selectable and optionally cached.
- Restriction operator: summation.
@@ -65,7 +68,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
- Class GAMGSolver Declaration
+ Class GAMGSolver Declaration
\*---------------------------------------------------------------------------*/
class GAMGSolver
diff --git a/src/OpenFOAM/matrices/lduMatrix/solvers/ICCG/ICCG.H b/src/OpenFOAM/matrices/lduMatrix/solvers/ICCG/ICCG.H
index f3cf016461d..494cff4558f 100644
--- a/src/OpenFOAM/matrices/lduMatrix/solvers/ICCG/ICCG.H
+++ b/src/OpenFOAM/matrices/lduMatrix/solvers/ICCG/ICCG.H
@@ -24,6 +24,9 @@ License
Class
Foam::ICCG
+Group
+ grpLduMatrixSolvers
+
Description
Incomplete Cholesky preconditioned CG solver derived from the general
preconditioned CG solver PCG but with the choice of preconditioner
@@ -64,6 +67,7 @@ class ICCG
//- Disallow default bitwise assignment
void operator=(const ICCG&);
+
public:
//- Return the dictionary constructed from the components.
@@ -111,7 +115,6 @@ public:
//- Destructor
virtual ~ICCG()
{}
-
};
diff --git a/src/OpenFOAM/matrices/lduMatrix/solvers/PCG/PCG.H b/src/OpenFOAM/matrices/lduMatrix/solvers/PCG/PCG.H
index 74b3abd17c8..92b1b02d60f 100644
--- a/src/OpenFOAM/matrices/lduMatrix/solvers/PCG/PCG.H
+++ b/src/OpenFOAM/matrices/lduMatrix/solvers/PCG/PCG.H
@@ -24,6 +24,9 @@ License
Class
Foam::PCG
+Group
+ grpLduMatrixSolvers
+
Description
Preconditioned conjugate gradient solver for symmetric lduMatrices
using a run-time selectable preconditioner.
@@ -44,7 +47,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
- Class PCG Declaration
+ Class PCG Declaration
\*---------------------------------------------------------------------------*/
class PCG
diff --git a/src/OpenFOAM/matrices/lduMatrix/solvers/diagonalSolver/diagonalSolver.H b/src/OpenFOAM/matrices/lduMatrix/solvers/diagonalSolver/diagonalSolver.H
index 85908b33496..ea0a754bb17 100644
--- a/src/OpenFOAM/matrices/lduMatrix/solvers/diagonalSolver/diagonalSolver.H
+++ b/src/OpenFOAM/matrices/lduMatrix/solvers/diagonalSolver/diagonalSolver.H
@@ -24,6 +24,9 @@ License
Class
Foam::diagonalSolver
+Group
+ grpLduMatrixSolvers
+
Description
Foam::diagonalSolver
@@ -43,7 +46,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
- Class diagonalSolver Declaration
+ Class diagonalSolver Declaration
\*---------------------------------------------------------------------------*/
class diagonalSolver
diff --git a/src/OpenFOAM/matrices/lduMatrix/solvers/smoothSolver/smoothSolver.H b/src/OpenFOAM/matrices/lduMatrix/solvers/smoothSolver/smoothSolver.H
index 3561969e0f4..e795d19ff76 100644
--- a/src/OpenFOAM/matrices/lduMatrix/solvers/smoothSolver/smoothSolver.H
+++ b/src/OpenFOAM/matrices/lduMatrix/solvers/smoothSolver/smoothSolver.H
@@ -24,6 +24,9 @@ License
Class
Foam::smoothSolver
+Group
+ grpLduMatrixSolvers
+
Description
Iterative solver for symmetric and asymetric matrices which uses a
run-time selected smoother e.g. GaussSeidel to converge the solution to
@@ -65,6 +68,7 @@ protected:
//- Read the control parameters from the controlDict_
virtual void readControls();
+
public:
//- Runtime type information
diff --git a/src/TurbulenceModels/turbulenceModels/doc/turbulenceModel.dox b/src/TurbulenceModels/turbulenceModels/doc/turbulenceModel.dox
new file mode 100644
index 00000000000..4aa49fd43a5
--- /dev/null
+++ b/src/TurbulenceModels/turbulenceModels/doc/turbulenceModel.dox
@@ -0,0 +1,36 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
+ \\/ 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 pageTurbulenceModelling Turbulence modelling
+
+\section secSchemes Overview
+The available turbulence models are grouped into the following categories:
+ - \ref grpTurbulence
+ - \ref grpRASTurbulence
+ - \ref grpDESTurbulence
+ - \ref grpLESTurbulence
+
+
+\*---------------------------------------------------------------------------*/
diff --git a/src/finiteVolume/finiteVolume/doc/finiteVolumeSchemes.dox b/src/finiteVolume/finiteVolume/doc/finiteVolumeSchemes.dox
new file mode 100644
index 00000000000..fe019b88501
--- /dev/null
+++ b/src/finiteVolume/finiteVolume/doc/finiteVolumeSchemes.dox
@@ -0,0 +1,40 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
+ \\/ 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 pageFiniteVolumeSchemes Numerical schemes
+
+\section secSchemes Overview
+The available numerical schemes are grouped into the following categories:
+ - \ref grpFvGradSchemes
+ - \ref grpFvSnGradSchemes
+ - \ref grpFvDivSchemes
+ - \ref grpFvLaplacianSchemes
+ - \ref grpFvDdtSchemes
+ - \ref grpFvConvectionSchemes
+ - \ref grpFvSurfaceInterpolationSchemes
+ - \ref grpFvLimitedSurfaceInterpolationSchemes
+
+
+\*---------------------------------------------------------------------------*/
diff --git a/src/finiteVolume/finiteVolume/doc/finiteVolumeSchemesDoc.H b/src/finiteVolume/finiteVolume/doc/finiteVolumeSchemesDoc.H
index 6a82c72d9cc..a8886e33d7f 100644
--- a/src/finiteVolume/finiteVolume/doc/finiteVolumeSchemesDoc.H
+++ b/src/finiteVolume/finiteVolume/doc/finiteVolumeSchemesDoc.H
@@ -25,6 +25,7 @@ License
\defgroup grpFvSchemes Finite volume numerical schemes
@{
+ \ingroup grpNumerics
This group contains finite volume numerical schemes
@}
diff --git a/src/fvOptions/constraints/derived/fixedTemperatureConstraint/fixedTemperatureConstraint.H b/src/fvOptions/constraints/derived/fixedTemperatureConstraint/fixedTemperatureConstraint.H
index f2b7029425a..5d9f9148d47 100644
--- a/src/fvOptions/constraints/derived/fixedTemperatureConstraint/fixedTemperatureConstraint.H
+++ b/src/fvOptions/constraints/derived/fixedTemperatureConstraint/fixedTemperatureConstraint.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::fixedTemperatureConstraint
+Group
+ grpFvOptionsConstraints
+
Description
Fixed temperature equation constraint
diff --git a/src/fvOptions/constraints/derived/velocityDampingConstraint/velocityDampingConstraint.H b/src/fvOptions/constraints/derived/velocityDampingConstraint/velocityDampingConstraint.H
index 1b78c293302..cfc69515f8e 100644
--- a/src/fvOptions/constraints/derived/velocityDampingConstraint/velocityDampingConstraint.H
+++ b/src/fvOptions/constraints/derived/velocityDampingConstraint/velocityDampingConstraint.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::velocityDampingConstraint
+Group
+ grpFvOptionsConstraints
+
Description
Constraint for velocity to dampen velocity fluctuations in
steady simulations
diff --git a/src/fvOptions/constraints/general/explicitSetValue/ExplicitSetValue.H b/src/fvOptions/constraints/general/explicitSetValue/ExplicitSetValue.H
index 780ff55787f..eaa4beab47a 100644
--- a/src/fvOptions/constraints/general/explicitSetValue/ExplicitSetValue.H
+++ b/src/fvOptions/constraints/general/explicitSetValue/ExplicitSetValue.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::explicitSetValue
+Group
+ grpFvOptionsConstraints
+
Description
Set values field values explicity.
diff --git a/src/fvOptions/corrections/limitTemperature/limitTemperature.H b/src/fvOptions/corrections/limitTemperature/limitTemperature.H
index 03d65570459..a3eb829ed63 100644
--- a/src/fvOptions/corrections/limitTemperature/limitTemperature.H
+++ b/src/fvOptions/corrections/limitTemperature/limitTemperature.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::limitTemperature
+Group
+ grpFvOptionsCorrections
+
Description
Correction for temperature to apply limits between minimum and maximum
values
diff --git a/src/fvOptions/doc/fvOptionsDoc.H b/src/fvOptions/doc/fvOptionsDoc.H
new file mode 100644
index 00000000000..574618b6122
--- /dev/null
+++ b/src/fvOptions/doc/fvOptionsDoc.H
@@ -0,0 +1,51 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
+ \\/ 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 grpFvOptions Finite volume Options
+@{
+ \ingroup grpNumerics
+ This group contains finite volume options
+@}
+
+\defgroup grpFvOptionsSources Sources
+@{
+ \ingroup grpFvOptions
+ This group contains finite volume sources
+@}
+
+\defgroup grpFvOptionsCorrections Corrections
+@{
+ \ingroup grpFvOptions
+ This group contains finite volume corrections
+@}
+
+\defgroup grpFvOptionsConstraints Constraints
+@{
+ \ingroup grpFvOptions
+ This group contains finite volume constraints
+@}
+
+
+\*---------------------------------------------------------------------------*/
diff --git a/src/fvOptions/sources/derived/actuationDiskSource/actuationDiskSource.H b/src/fvOptions/sources/derived/actuationDiskSource/actuationDiskSource.H
index c825d0fd272..1810390d802 100644
--- a/src/fvOptions/sources/derived/actuationDiskSource/actuationDiskSource.H
+++ b/src/fvOptions/sources/derived/actuationDiskSource/actuationDiskSource.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::actuationDiskSource
+Group
+ grpFvOptionsSources
+
Description
Actuation disk source
diff --git a/src/fvOptions/sources/derived/buoyancyEnergy/buoyancyEnergy.H b/src/fvOptions/sources/derived/buoyancyEnergy/buoyancyEnergy.H
index 7c59a950acb..e27b5d82d98 100644
--- a/src/fvOptions/sources/derived/buoyancyEnergy/buoyancyEnergy.H
+++ b/src/fvOptions/sources/derived/buoyancyEnergy/buoyancyEnergy.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::buoyancyEnergy
+Group
+ grpFvOptionsSources
+
Description
Calculates and applies the buoyancy energy source rho*(U&g) to the energy
equation.
diff --git a/src/fvOptions/sources/derived/buoyancyForce/buoyancyForce.H b/src/fvOptions/sources/derived/buoyancyForce/buoyancyForce.H
index a1ac3cc2ad6..a167e620eba 100644
--- a/src/fvOptions/sources/derived/buoyancyForce/buoyancyForce.H
+++ b/src/fvOptions/sources/derived/buoyancyForce/buoyancyForce.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::buoyancyForce
+Group
+ grpFvOptionsSources
+
Description
Calculates and applies the buoyancy force rho*g to the momentum equation
corresponding to the specified velocity field.
diff --git a/src/fvOptions/sources/derived/directionalPressureGradientExplicitSource/directionalPressureGradientExplicitSource.H b/src/fvOptions/sources/derived/directionalPressureGradientExplicitSource/directionalPressureGradientExplicitSource.H
index a36cbfe2d6c..b6f3479bf07 100644
--- a/src/fvOptions/sources/derived/directionalPressureGradientExplicitSource/directionalPressureGradientExplicitSource.H
+++ b/src/fvOptions/sources/derived/directionalPressureGradientExplicitSource/directionalPressureGradientExplicitSource.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::directionalPressureGradientExplicitSource
+Group
+ grpFvOptionsSources
+
Description
Creates an explicit pressure gradient source in such a way to deflect the
flow towards an specific direction (flowDir). Alternatively add an extra
diff --git a/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H b/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H
index a1629d9624f..e2532e254de 100644
--- a/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H
+++ b/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::effectivenessHeatExchangerSource
+Group
+ grpFvOptionsSources
+
Description
Heat exchanger source model, in which the heat exchanger is defined as a
selection of cells.
diff --git a/src/fvOptions/sources/derived/explicitPorositySource/explicitPorositySource.H b/src/fvOptions/sources/derived/explicitPorositySource/explicitPorositySource.H
index 8fa468916e6..345b6bda3d2 100644
--- a/src/fvOptions/sources/derived/explicitPorositySource/explicitPorositySource.H
+++ b/src/fvOptions/sources/derived/explicitPorositySource/explicitPorositySource.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::explicitPorositySource
+Group
+ grpFvOptionsSources
+
Description
Explicit porosity source
diff --git a/src/fvOptions/sources/derived/meanVelocityForce/meanVelocityForce.H b/src/fvOptions/sources/derived/meanVelocityForce/meanVelocityForce.H
index 72809cfc09f..37dc57d1792 100644
--- a/src/fvOptions/sources/derived/meanVelocityForce/meanVelocityForce.H
+++ b/src/fvOptions/sources/derived/meanVelocityForce/meanVelocityForce.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::meanVelocityForce
+Group
+ grpFvOptionsSources
+
Description
Calculates and applies the force necessary to maintain the specified mean
velocity.
diff --git a/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H b/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H
index 0df0d1347cc..31d585e6f6b 100644
--- a/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H
+++ b/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::radialActuationDiskSource
+Group
+ grpFvOptionsSources
+
Description
Actuation disk source including radial thrust
diff --git a/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H b/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H
index f94a463eb7f..0162fba0724 100644
--- a/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H
+++ b/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::rotorDiskSource
+Group
+ grpFvOptionsSources
+
Description
Rotor disk source
diff --git a/src/fvOptions/sources/derived/solidificationMeltingSource/solidificationMeltingSource.H b/src/fvOptions/sources/derived/solidificationMeltingSource/solidificationMeltingSource.H
index 14a34a82f52..661be30ddfa 100644
--- a/src/fvOptions/sources/derived/solidificationMeltingSource/solidificationMeltingSource.H
+++ b/src/fvOptions/sources/derived/solidificationMeltingSource/solidificationMeltingSource.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::solidificationMeltingSource
+Group
+ grpFvOptionsSources
+
Description
This source is designed to model the effect of solidification and melting
processes, e.g. windhield defrosting. The phase change occurs at the
diff --git a/src/fvOptions/sources/derived/tabulatedAccelerationSource/tabulatedAccelerationSource.H b/src/fvOptions/sources/derived/tabulatedAccelerationSource/tabulatedAccelerationSource.H
index 6127d0bff6e..26d3d65de1a 100644
--- a/src/fvOptions/sources/derived/tabulatedAccelerationSource/tabulatedAccelerationSource.H
+++ b/src/fvOptions/sources/derived/tabulatedAccelerationSource/tabulatedAccelerationSource.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::tabulatedAccelerationSource
+Group
+ grpFvOptionsSources
+
Description
Solid-body 6-DoF acceleration source
@@ -64,7 +67,7 @@ namespace fv
{
/*---------------------------------------------------------------------------*\
- Class tabulatedAccelerationSource Declaration
+ Class tabulatedAccelerationSource Declaration
\*---------------------------------------------------------------------------*/
class tabulatedAccelerationSource
@@ -84,6 +87,7 @@ protected:
dimensionedVector g0_;
+
private:
// Private Member Functions
diff --git a/src/fvOptions/sources/general/codedSource/CodedSource.H b/src/fvOptions/sources/general/codedSource/CodedSource.H
index 6961faffbdb..678e98d73eb 100644
--- a/src/fvOptions/sources/general/codedSource/CodedSource.H
+++ b/src/fvOptions/sources/general/codedSource/CodedSource.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::codedSource
+Group
+ grpFvOptionsSources
+
Description
Constructs on-the-fly fvOption source
diff --git a/src/fvOptions/sources/general/semiImplicitSource/SemiImplicitSource.H b/src/fvOptions/sources/general/semiImplicitSource/SemiImplicitSource.H
index 9a61f1b94a4..6cdc0793dc7 100644
--- a/src/fvOptions/sources/general/semiImplicitSource/SemiImplicitSource.H
+++ b/src/fvOptions/sources/general/semiImplicitSource/SemiImplicitSource.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::SemiImplicitSource
+Group
+ grpFvOptionsSources
+
Description
Semi-implicit source, described using an input dictionary. The injection
rate coefficients are specified as pairs of Su-Sp coefficients, i.e.
diff --git a/src/fvOptions/sources/interRegion/interRegionExplicitPorositySource/interRegionExplicitPorositySource.H b/src/fvOptions/sources/interRegion/interRegionExplicitPorositySource/interRegionExplicitPorositySource.H
index 93f50a39306..320a5b66ef0 100644
--- a/src/fvOptions/sources/interRegion/interRegionExplicitPorositySource/interRegionExplicitPorositySource.H
+++ b/src/fvOptions/sources/interRegion/interRegionExplicitPorositySource/interRegionExplicitPorositySource.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::interRegionExplicitPorositySource
+Group
+ grpFvOptionsSources
+
Description
Inter-region explicit porosity source.
diff --git a/src/fvOptions/sources/interRegion/interRegionHeatTransfer/constantHeatTransfer/constantHeatTransfer.H b/src/fvOptions/sources/interRegion/interRegionHeatTransfer/constantHeatTransfer/constantHeatTransfer.H
index e3bd2830a20..1de41547262 100644
--- a/src/fvOptions/sources/interRegion/interRegionHeatTransfer/constantHeatTransfer/constantHeatTransfer.H
+++ b/src/fvOptions/sources/interRegion/interRegionHeatTransfer/constantHeatTransfer/constantHeatTransfer.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::constantHeatTransfer
+Group
+ grpFvOptionsSources
+
Description
Constant heat transfer model. htcConst [W/m2/K] and area/volume [1/m]
must be provided.
diff --git a/src/fvOptions/sources/interRegion/interRegionHeatTransfer/interRegionHeatTransferModel/interRegionHeatTransferModel.H b/src/fvOptions/sources/interRegion/interRegionHeatTransfer/interRegionHeatTransferModel/interRegionHeatTransferModel.H
index c5810cc321a..3cca854aad5 100644
--- a/src/fvOptions/sources/interRegion/interRegionHeatTransfer/interRegionHeatTransferModel/interRegionHeatTransferModel.H
+++ b/src/fvOptions/sources/interRegion/interRegionHeatTransfer/interRegionHeatTransferModel/interRegionHeatTransferModel.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::interRegionHeatTransferModel
+Group
+ grpFvOptionsSources
+
Description
Base class for inter region heat exchange. The derived classes must
provide the heat transfer coeffisine (htc) which is used as follows
diff --git a/src/fvOptions/sources/interRegion/interRegionHeatTransfer/tabulatedHeatTransfer/tabulatedHeatTransfer.H b/src/fvOptions/sources/interRegion/interRegionHeatTransfer/tabulatedHeatTransfer/tabulatedHeatTransfer.H
index 888f1e97a24..a16e94b1b2c 100644
--- a/src/fvOptions/sources/interRegion/interRegionHeatTransfer/tabulatedHeatTransfer/tabulatedHeatTransfer.H
+++ b/src/fvOptions/sources/interRegion/interRegionHeatTransfer/tabulatedHeatTransfer/tabulatedHeatTransfer.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::tabulatedHeatTransfer
+Group
+ grpFvOptionsSources
+
Description
Tabulated heat transfer model. The heat exchange area per unit volume
must be provided. The 2D table returns the heat transfer coefficient
diff --git a/src/fvOptions/sources/interRegion/interRegionHeatTransfer/tabulatedNTUHeatTransfer/tabulatedNTUHeatTransfer.H b/src/fvOptions/sources/interRegion/interRegionHeatTransfer/tabulatedNTUHeatTransfer/tabulatedNTUHeatTransfer.H
index 1343dd4ac65..fb488418d4f 100644
--- a/src/fvOptions/sources/interRegion/interRegionHeatTransfer/tabulatedNTUHeatTransfer/tabulatedNTUHeatTransfer.H
+++ b/src/fvOptions/sources/interRegion/interRegionHeatTransfer/tabulatedNTUHeatTransfer/tabulatedNTUHeatTransfer.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::tabulatedNTUHeatTransfer
+Group
+ grpFvOptionsSources
+
Description
Tabulated heat transfer model.
diff --git a/src/fvOptions/sources/interRegion/interRegionHeatTransfer/variableHeatTransfer/variableHeatTransfer.H b/src/fvOptions/sources/interRegion/interRegionHeatTransfer/variableHeatTransfer/variableHeatTransfer.H
index 3b9d0f66fd0..e639fc07928 100644
--- a/src/fvOptions/sources/interRegion/interRegionHeatTransfer/variableHeatTransfer/variableHeatTransfer.H
+++ b/src/fvOptions/sources/interRegion/interRegionHeatTransfer/variableHeatTransfer/variableHeatTransfer.H
@@ -24,6 +24,9 @@ License
Class
Foam::fv::variableHeatTransfer
+Group
+ grpFvOptionsSources
+
Description
Variable heat transfer model depending on local values. The area of contact
between regions (area) must be provided. The Nu number is calculated as:
diff --git a/src/lagrangian/intermediate/doc/lagrangianIntermediate.dox b/src/lagrangian/intermediate/doc/lagrangianIntermediate.dox
new file mode 100644
index 00000000000..a314c0c60b7
--- /dev/null
+++ b/src/lagrangian/intermediate/doc/lagrangianIntermediate.dox
@@ -0,0 +1,41 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
+ \\/ 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 pageLagrangianIntermediate Lagrangian modelling
+
+\section secSchemes Overview
+The available Lagrangian models are grouped into the following categories:
+ - \ref grpLagrangianIntermediateClouds
+ - \ref grpLagrangianIntermediateParcels
+ - \ref grpLagrangianIntermediateSubModels
+ - \ref grpLagrangianIntermediateKinematicSubModels
+ - \ref grpLagrangianIntermediateThermoSubModels
+ - \ref grpLagrangianIntermediateReactingSubModels
+ - \ref grpLagrangianIntermediateReactingMultiphaseSubModels
+ - \ref grpLagrangianIntermediateMPPICSubModels
+ - \ref grpLagrangianIntermediateFunctionObjects
+
+
+\*---------------------------------------------------------------------------*/
diff --git a/src/lagrangian/intermediate/doc/finiteVolumeSchemesDoc.H b/src/lagrangian/intermediate/doc/lagrangianIntermediateDoc.H
similarity index 100%
rename from src/lagrangian/intermediate/doc/finiteVolumeSchemesDoc.H
rename to src/lagrangian/intermediate/doc/lagrangianIntermediateDoc.H
diff --git a/src/postProcessing/functionObjects/doc/functionObjects.dox b/src/postProcessing/functionObjects/doc/functionObjects.dox
index d39e82c1371..1f1702dca1a 100644
--- a/src/postProcessing/functionObjects/doc/functionObjects.dox
+++ b/src/postProcessing/functionObjects/doc/functionObjects.dox
@@ -3,7 +3,7 @@
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2014 OpenFOAM Foundation
- \\/ M anipulation | Copyright (C) 2015 OpenCFD Ltd.
+ \\/ M anipulation | Copyright (C) 2015-2016 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
@@ -44,6 +44,7 @@ The current range of features comprises of:
- \ref grpIOFunctionObjects
- \ref grpJobControlFunctionObjects
- \ref grpUtilitiesFunctionObjects
+- \ref grpThermophysicalFunctionObjects
\linebreak
\subsection secFieldFunctionObjectUsage Using function objects
diff --git a/src/postProcessing/functionObjects/utilities/reactionSensitivityAnalysis/reactionsSensitivityAnalysis.H b/src/postProcessing/functionObjects/utilities/reactionSensitivityAnalysis/reactionsSensitivityAnalysis.H
index 270d0f40565..1a75aa7192f 100644
--- a/src/postProcessing/functionObjects/utilities/reactionSensitivityAnalysis/reactionsSensitivityAnalysis.H
+++ b/src/postProcessing/functionObjects/utilities/reactionSensitivityAnalysis/reactionsSensitivityAnalysis.H
@@ -25,7 +25,7 @@ Class
Foam::reactionsSensitivityAnalysis
Group
- grpUtilitiesFunctionObjects
+ grpUtilitiesFunctionObjects grpThermophysicalFunctionObjects
Description
This function object creates four data files named:
diff --git a/src/thermophysicalModels/doc/thermophysicalModels.dox b/src/thermophysicalModels/doc/thermophysicalModels.dox
new file mode 100644
index 00000000000..a8f7f48ae9b
--- /dev/null
+++ b/src/thermophysicalModels/doc/thermophysicalModels.dox
@@ -0,0 +1,33 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
+ \\/ 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 pageThermophsyicalModels Thermophsyical Models
+
+\section secSchemes Overview
+The available thermophysical models are grouped into the following categories:
+ - \ref grpThermophysicalModels
+
+
+\*---------------------------------------------------------------------------*/
diff --git a/src/thermophysicalModels/doc/thermophysicalModelsDoc.H b/src/thermophysicalModels/doc/thermophysicalModelsDoc.H
index a6bf6cf9279..25563efa1e4 100644
--- a/src/thermophysicalModels/doc/thermophysicalModelsDoc.H
+++ b/src/thermophysicalModels/doc/thermophysicalModelsDoc.H
@@ -28,5 +28,11 @@ License
This group contains thermophysical models
@}
+\defgroup grpThermophysicalFunctionObjects Thermophysical function objects
+@{
+ \ingroup grpFunctionObjects
+ This group contains thermo-based function objects
+@}
+
\*---------------------------------------------------------------------------*/
diff --git a/src/thermophysicalModels/reactionThermo/chemistryReaders/chemistryReader/chemistryReader.H b/src/thermophysicalModels/reactionThermo/chemistryReaders/chemistryReader/chemistryReader.H
index f298f1b9b7c..e0429cbd709 100644
--- a/src/thermophysicalModels/reactionThermo/chemistryReaders/chemistryReader/chemistryReader.H
+++ b/src/thermophysicalModels/reactionThermo/chemistryReaders/chemistryReader/chemistryReader.H
@@ -24,6 +24,9 @@ License
Class
Foam::chemistryReader
+Group
+ grpReactionThermophysicalChemistryReaders
+
Description
Abstract class for reading chemistry
diff --git a/src/thermophysicalModels/reactionThermo/chemistryReaders/chemkinReader/chemkinReader.H b/src/thermophysicalModels/reactionThermo/chemistryReaders/chemkinReader/chemkinReader.H
index 916c8c06f8b..19aa7806f39 100644
--- a/src/thermophysicalModels/reactionThermo/chemistryReaders/chemkinReader/chemkinReader.H
+++ b/src/thermophysicalModels/reactionThermo/chemistryReaders/chemkinReader/chemkinReader.H
@@ -24,6 +24,9 @@ License
Class
Foam::chemkinReader
+Group
+ grpReactionThermophysicalChemistryReaders
+
Description
Foam::chemkinReader
diff --git a/src/thermophysicalModels/reactionThermo/chemistryReaders/foamChemistryReader/foamChemistryReader.H b/src/thermophysicalModels/reactionThermo/chemistryReaders/foamChemistryReader/foamChemistryReader.H
index 16046fd29cd..ec723e1e2c2 100644
--- a/src/thermophysicalModels/reactionThermo/chemistryReaders/foamChemistryReader/foamChemistryReader.H
+++ b/src/thermophysicalModels/reactionThermo/chemistryReaders/foamChemistryReader/foamChemistryReader.H
@@ -24,6 +24,9 @@ License
Class
Foam::foamChemistryReader
+Group
+ grpReactionThermophysicalChemistryReaders
+
Description
Chemistry reader for OpenFOAM format
diff --git a/src/thermophysicalModels/reactionThermo/derivedFvPatchFields/fixedUnburntEnthalpy/fixedUnburntEnthalpyFvPatchScalarField.H b/src/thermophysicalModels/reactionThermo/derivedFvPatchFields/fixedUnburntEnthalpy/fixedUnburntEnthalpyFvPatchScalarField.H
index 5571f28489c..e6b3b59c35c 100644
--- a/src/thermophysicalModels/reactionThermo/derivedFvPatchFields/fixedUnburntEnthalpy/fixedUnburntEnthalpyFvPatchScalarField.H
+++ b/src/thermophysicalModels/reactionThermo/derivedFvPatchFields/fixedUnburntEnthalpy/fixedUnburntEnthalpyFvPatchScalarField.H
@@ -24,6 +24,9 @@ License
Class
Foam::fixedUnburntEnthalpyFvPatchScalarField
+Group
+ grpThermoBoundaryConditions
+
Description
Fixed boundary condition for unburnt
@@ -43,7 +46,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
- Class fixedUnburntEnthalpyFvPatchScalarField Declaration
+ Class fixedUnburntEnthalpyFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/
class fixedUnburntEnthalpyFvPatchScalarField
diff --git a/src/thermophysicalModels/reactionThermo/derivedFvPatchFields/gradientUnburntEnthalpy/gradientUnburntEnthalpyFvPatchScalarField.H b/src/thermophysicalModels/reactionThermo/derivedFvPatchFields/gradientUnburntEnthalpy/gradientUnburntEnthalpyFvPatchScalarField.H
index f23cc1f25e7..2fcd45c3d2a 100644
--- a/src/thermophysicalModels/reactionThermo/derivedFvPatchFields/gradientUnburntEnthalpy/gradientUnburntEnthalpyFvPatchScalarField.H
+++ b/src/thermophysicalModels/reactionThermo/derivedFvPatchFields/gradientUnburntEnthalpy/gradientUnburntEnthalpyFvPatchScalarField.H
@@ -24,6 +24,9 @@ License
Class
Foam::gradientUnburntEnthalpyFvPatchScalarField
+Group
+ grpThermoBoundaryConditions
+
Description
gradient boundary condition for unburnt
diff --git a/src/thermophysicalModels/reactionThermo/derivedFvPatchFields/mixedUnburntEnthalpy/mixedUnburntEnthalpyFvPatchScalarField.H b/src/thermophysicalModels/reactionThermo/derivedFvPatchFields/mixedUnburntEnthalpy/mixedUnburntEnthalpyFvPatchScalarField.H
index 5bbf130aa0a..a7800ee3bc8 100644
--- a/src/thermophysicalModels/reactionThermo/derivedFvPatchFields/mixedUnburntEnthalpy/mixedUnburntEnthalpyFvPatchScalarField.H
+++ b/src/thermophysicalModels/reactionThermo/derivedFvPatchFields/mixedUnburntEnthalpy/mixedUnburntEnthalpyFvPatchScalarField.H
@@ -24,6 +24,9 @@ License
Class
Foam::mixedUnburntEnthalpyFvPatchScalarField
+Group
+ grpThermoBoundaryConditions
+
Description
Mixed boundary condition for unburnt
diff --git a/src/thermophysicalModels/reactionThermo/doc/reactionThermoDoc.H b/src/thermophysicalModels/reactionThermo/doc/reactionThermoDoc.H
new file mode 100644
index 00000000000..01baf0e53b2
--- /dev/null
+++ b/src/thermophysicalModels/reactionThermo/doc/reactionThermoDoc.H
@@ -0,0 +1,43 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Copyright (C) 2016 OpenCFD Ltd.
+ \\/ 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 grpReactionThermophysicalModels Reaction thermophysical models
+@{
+ \ingroup grpThermophysicalModels
+ This group contains reaction thermophysical models
+@}
+
+\defgroup grpReactionThermophysicalMixtures Mixtures
+@{
+ \ingroup grpReactionThermophysicalModels
+ This group contains reaction mixtures
+@}
+
+\defgroup grpReactionThermophysicalChemistryReaders Chemistry readers
+@{
+ \ingroup grpReactionThermophysicalModels
+ This group contains chemistry readers
+@}
+
+
+\*---------------------------------------------------------------------------*/
diff --git a/src/thermophysicalModels/reactionThermo/functionObjects/moleFractions/moleFractions.H b/src/thermophysicalModels/reactionThermo/functionObjects/moleFractions/moleFractions.H
index fa158e47545..6429ed66209 100644
--- a/src/thermophysicalModels/reactionThermo/functionObjects/moleFractions/moleFractions.H
+++ b/src/thermophysicalModels/reactionThermo/functionObjects/moleFractions/moleFractions.H
@@ -24,6 +24,9 @@ License
Class
Foam::moleFractions
+Group
+ grpThermophysicalFunctionObjects
+
Description
This function object calculates mole-fraction fields from the mass-fraction
fields of the psi/rhoReactionThermo and caches them for output and further
diff --git a/src/thermophysicalModels/reactionThermo/mixtures/SpecieMixture/SpecieMixture.H b/src/thermophysicalModels/reactionThermo/mixtures/SpecieMixture/SpecieMixture.H
index 24f95915abf..72219a4ac3a 100644
--- a/src/thermophysicalModels/reactionThermo/mixtures/SpecieMixture/SpecieMixture.H
+++ b/src/thermophysicalModels/reactionThermo/mixtures/SpecieMixture/SpecieMixture.H
@@ -24,6 +24,9 @@ License
Class
Foam::SpecieMixture
+Group
+ grpReactionThermophysicalMixtures
+
Description
Foam::SpecieMixture
diff --git a/src/thermophysicalModels/reactionThermo/mixtures/basicCombustionMixture/basicCombustionMixture.H b/src/thermophysicalModels/reactionThermo/mixtures/basicCombustionMixture/basicCombustionMixture.H
index 341418e1db3..f192ef1c53c 100644
--- a/src/thermophysicalModels/reactionThermo/mixtures/basicCombustionMixture/basicCombustionMixture.H
+++ b/src/thermophysicalModels/reactionThermo/mixtures/basicCombustionMixture/basicCombustionMixture.H
@@ -24,6 +24,9 @@ License
Class
Foam::basicCombustionMixture
+Group
+ grpReactionThermophysicalMixtures
+
Description
Specialization of the basicSpecieMixture for combustion.
diff --git a/src/thermophysicalModels/reactionThermo/mixtures/basicMultiComponentMixture/basicMultiComponentMixture.H b/src/thermophysicalModels/reactionThermo/mixtures/basicMultiComponentMixture/basicMultiComponentMixture.H
index 51b08b6a598..f31318de5b1 100644
--- a/src/thermophysicalModels/reactionThermo/mixtures/basicMultiComponentMixture/basicMultiComponentMixture.H
+++ b/src/thermophysicalModels/reactionThermo/mixtures/basicMultiComponentMixture/basicMultiComponentMixture.H
@@ -24,6 +24,9 @@ License
Class
Foam::basicMultiComponentMixture
+Group
+ grpReactionThermophysicalMixtures
+
Description
Multi-component mixture.
diff --git a/src/thermophysicalModels/reactionThermo/mixtures/basicSpecieMixture/basicSpecieMixture.H b/src/thermophysicalModels/reactionThermo/mixtures/basicSpecieMixture/basicSpecieMixture.H
index e814154a9cd..d967e8931f6 100644
--- a/src/thermophysicalModels/reactionThermo/mixtures/basicSpecieMixture/basicSpecieMixture.H
+++ b/src/thermophysicalModels/reactionThermo/mixtures/basicSpecieMixture/basicSpecieMixture.H
@@ -24,6 +24,9 @@ License
Class
Foam::basicSpecieMixture
+Group
+ grpReactionThermophysicalMixtures
+
Description
Specialization of basicMultiComponentMixture for a mixture consisting
of a number for molecular species.
diff --git a/src/thermophysicalModels/reactionThermo/mixtures/egrMixture/egrMixture.H b/src/thermophysicalModels/reactionThermo/mixtures/egrMixture/egrMixture.H
index fa81aa92e14..5b9f0312485 100644
--- a/src/thermophysicalModels/reactionThermo/mixtures/egrMixture/egrMixture.H
+++ b/src/thermophysicalModels/reactionThermo/mixtures/egrMixture/egrMixture.H
@@ -24,6 +24,9 @@ License
Class
Foam::egrMixture
+Group
+ grpReactionThermophysicalMixtures
+
Description
Foam::egrMixture
diff --git a/src/thermophysicalModels/reactionThermo/mixtures/homogeneousMixture/homogeneousMixture.H b/src/thermophysicalModels/reactionThermo/mixtures/homogeneousMixture/homogeneousMixture.H
index 31915735d16..bb77c4601e7 100644
--- a/src/thermophysicalModels/reactionThermo/mixtures/homogeneousMixture/homogeneousMixture.H
+++ b/src/thermophysicalModels/reactionThermo/mixtures/homogeneousMixture/homogeneousMixture.H
@@ -24,6 +24,9 @@ License
Class
Foam::homogeneousMixture
+Group
+ grpReactionThermophysicalMixtures
+
Description
Foam::homogeneousMixture
diff --git a/src/thermophysicalModels/reactionThermo/mixtures/inhomogeneousMixture/inhomogeneousMixture.H b/src/thermophysicalModels/reactionThermo/mixtures/inhomogeneousMixture/inhomogeneousMixture.H
index ef9284dde8d..d6ec1b63e09 100644
--- a/src/thermophysicalModels/reactionThermo/mixtures/inhomogeneousMixture/inhomogeneousMixture.H
+++ b/src/thermophysicalModels/reactionThermo/mixtures/inhomogeneousMixture/inhomogeneousMixture.H
@@ -24,6 +24,9 @@ License
Class
Foam::inhomogeneousMixture
+Group
+ grpReactionThermophysicalMixtures
+
Description
Foam::inhomogeneousMixture
diff --git a/src/thermophysicalModels/reactionThermo/mixtures/multiComponentMixture/multiComponentMixture.H b/src/thermophysicalModels/reactionThermo/mixtures/multiComponentMixture/multiComponentMixture.H
index eaf395a91e9..5f11d35b76a 100644
--- a/src/thermophysicalModels/reactionThermo/mixtures/multiComponentMixture/multiComponentMixture.H
+++ b/src/thermophysicalModels/reactionThermo/mixtures/multiComponentMixture/multiComponentMixture.H
@@ -24,6 +24,9 @@ License
Class
Foam::multiComponentMixture
+Group
+ grpReactionThermophysicalMixtures
+
Description
Foam::multiComponentMixture
diff --git a/src/thermophysicalModels/reactionThermo/mixtures/reactingMixture/reactingMixture.H b/src/thermophysicalModels/reactionThermo/mixtures/reactingMixture/reactingMixture.H
index 5261eb726ed..6ef1df6d885 100644
--- a/src/thermophysicalModels/reactionThermo/mixtures/reactingMixture/reactingMixture.H
+++ b/src/thermophysicalModels/reactionThermo/mixtures/reactingMixture/reactingMixture.H
@@ -24,6 +24,9 @@ License
Class
Foam::reactingMixture
+Group
+ grpReactionThermophysicalMixtures
+
Description
Foam::reactingMixture
diff --git a/src/thermophysicalModels/reactionThermo/mixtures/singleStepReactingMixture/singleStepReactingMixture.H b/src/thermophysicalModels/reactionThermo/mixtures/singleStepReactingMixture/singleStepReactingMixture.H
index b5a4a90fbf1..10119b24f71 100644
--- a/src/thermophysicalModels/reactionThermo/mixtures/singleStepReactingMixture/singleStepReactingMixture.H
+++ b/src/thermophysicalModels/reactionThermo/mixtures/singleStepReactingMixture/singleStepReactingMixture.H
@@ -24,6 +24,9 @@ License
Class
Foam::singleStepReactingMixture
+Group
+ grpReactionThermophysicalMixtures
+
Description
Single step reacting mixture
diff --git a/src/thermophysicalModels/reactionThermo/mixtures/veryInhomogeneousMixture/veryInhomogeneousMixture.H b/src/thermophysicalModels/reactionThermo/mixtures/veryInhomogeneousMixture/veryInhomogeneousMixture.H
index 2e852b80c1c..5b81432aa94 100644
--- a/src/thermophysicalModels/reactionThermo/mixtures/veryInhomogeneousMixture/veryInhomogeneousMixture.H
+++ b/src/thermophysicalModels/reactionThermo/mixtures/veryInhomogeneousMixture/veryInhomogeneousMixture.H
@@ -24,6 +24,9 @@ License
Class
Foam::veryInhomogeneousMixture
+Group
+ grpReactionThermophysicalMixtures
+
Description
Foam::veryInhomogeneousMixture
--
GitLab