Merge branch 'develop' of develop.openfoam.com:Development/OpenFOAM-plus into develop

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
 
 

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
+
+
+\*---------------------------------------------------------------------------*/

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
+@}
+
+
+\*---------------------------------------------------------------------------*/

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
+
+
+\*---------------------------------------------------------------------------*/

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
+
+
+\*---------------------------------------------------------------------------*/

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
+@}
+
+
+\*---------------------------------------------------------------------------*/

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
+
+
+\*---------------------------------------------------------------------------*/

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

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:

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
+
+
+\*---------------------------------------------------------------------------*/

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
+@}
+
 
 \*---------------------------------------------------------------------------*/

src/thermophysicalModels/reactionThermo/chemistryReaders/chemistryReader/chemistryReader.H

@@ -24,6 +24,9 @@ License
 Class
     Foam::chemistryReader
 
+Group
+    grpReactionThermophysicalChemistryReaders
+
 Description
     Abstract class for reading chemistry
 

src/thermophysicalModels/reactionThermo/chemistryReaders/chemkinReader/chemkinReader.H

@@ -24,6 +24,9 @@ License
 Class
     Foam::chemkinReader
 
+Group
+    grpReactionThermophysicalChemistryReaders
+
 Description
     Foam::chemkinReader
 

src/thermophysicalModels/reactionThermo/chemistryReaders/foamChemistryReader/foamChemistryReader.H

@@ -24,6 +24,9 @@ License
 Class
     Foam::foamChemistryReader
 
+Group
+    grpReactionThermophysicalChemistryReaders
+
 Description
     Chemistry reader for OpenFOAM format
 

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

src/thermophysicalModels/reactionThermo/derivedFvPatchFields/gradientUnburntEnthalpy/gradientUnburntEnthalpyFvPatchScalarField.H

@@ -24,6 +24,9 @@ License
 Class
     Foam::gradientUnburntEnthalpyFvPatchScalarField
 
+Group
+    grpThermoBoundaryConditions
+
 Description
     gradient boundary condition for unburnt
 

src/thermophysicalModels/reactionThermo/derivedFvPatchFields/mixedUnburntEnthalpy/mixedUnburntEnthalpyFvPatchScalarField.H

@@ -24,6 +24,9 @@ License
 Class
     Foam::mixedUnburntEnthalpyFvPatchScalarField
 
+Group
+    grpThermoBoundaryConditions
+
 Description
     Mixed boundary condition for unburnt
 

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
+@}
+
+
+\*---------------------------------------------------------------------------*/

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

src/thermophysicalModels/reactionThermo/mixtures/SpecieMixture/SpecieMixture.H

@@ -24,6 +24,9 @@ License
 Class
     Foam::SpecieMixture
 
+Group
+    grpReactionThermophysicalMixtures
+
 Description
     Foam::SpecieMixture
 

src/thermophysicalModels/reactionThermo/mixtures/basicCombustionMixture/basicCombustionMixture.H

@@ -24,6 +24,9 @@ License
 Class
     Foam::basicCombustionMixture
 
+Group
+    grpReactionThermophysicalMixtures
+
 Description
     Specialization of the basicSpecieMixture for combustion.
 

src/thermophysicalModels/reactionThermo/mixtures/basicMultiComponentMixture/basicMultiComponentMixture.H

@@ -24,6 +24,9 @@ License
 Class
     Foam::basicMultiComponentMixture
 
+Group
+    grpReactionThermophysicalMixtures
+
 Description
     Multi-component mixture.
 

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.

src/thermophysicalModels/reactionThermo/mixtures/egrMixture/egrMixture.H

@@ -24,6 +24,9 @@ License
 Class
     Foam::egrMixture
 
+Group
+    grpReactionThermophysicalMixtures
+
 Description
     Foam::egrMixture
 

src/thermophysicalModels/reactionThermo/mixtures/homogeneousMixture/homogeneousMixture.H

@@ -24,6 +24,9 @@ License
 Class
     Foam::homogeneousMixture
 
+Group
+    grpReactionThermophysicalMixtures
+
 Description
     Foam::homogeneousMixture
 

src/thermophysicalModels/reactionThermo/mixtures/inhomogeneousMixture/inhomogeneousMixture.H

@@ -24,6 +24,9 @@ License
 Class
     Foam::inhomogeneousMixture
 
+Group
+    grpReactionThermophysicalMixtures
+
 Description
     Foam::inhomogeneousMixture
 

src/thermophysicalModels/reactionThermo/mixtures/multiComponentMixture/multiComponentMixture.H

@@ -24,6 +24,9 @@ License
 Class
     Foam::multiComponentMixture
 
+Group
+    grpReactionThermophysicalMixtures
+
 Description
     Foam::multiComponentMixture
 

src/thermophysicalModels/reactionThermo/mixtures/reactingMixture/reactingMixture.H

@@ -24,6 +24,9 @@ License
 Class
     Foam::reactingMixture
 
+Group
+    grpReactionThermophysicalMixtures
+
 Description
     Foam::reactingMixture
 

src/thermophysicalModels/reactionThermo/mixtures/singleStepReactingMixture/singleStepReactingMixture.H

@@ -24,6 +24,9 @@ License
 Class
     Foam::singleStepReactingMixture
 
+Group
+    grpReactionThermophysicalMixtures
+
 Description
     Single step reacting mixture
 

src/thermophysicalModels/reactionThermo/mixtures/veryInhomogeneousMixture/veryInhomogeneousMixture.H

@@ -24,6 +24,9 @@ License
 Class
     Foam::veryInhomogeneousMixture
 
+Group
+    grpReactionThermophysicalMixtures
+
 Description
     Foam::veryInhomogeneousMixture