Merge commit 'OpenCFD/master' into olesenm

applications/solvers/combustion/PDRFoam/PDRModels/dragModels/PDRDragModel/PDRDragModel.H

@@ -26,7 +26,8 @@ Class
     Foam::PDRDragModel
 
 Description
-    Base-class for sub-grid obstacle drag models.
+    Base-class for sub-grid obstacle drag models. The available drag model is at
+    \link basic.H \endlink.
 
 SourceFiles
     PDRDragModel.C

applications/solvers/combustion/PDRFoam/PDRModels/dragModels/basic/basic.H

@@ -70,7 +70,7 @@ Description
         \f$ T \f$ is a tensor in the file CT.
 
     The term \f$ G_{R} \f$ is treated explicitly in the \f$ \kappa-\epsilon
-    \f$ Eqs in the PDRkEpsilon.C file.
+    \f$ Eqs in the \link PDRkEpsilon.C \endlink file.
 
 
 SourceFiles

applications/solvers/combustion/PDRFoam/PDRModels/turbulence/PDRkEpsilon/PDRkEpsilon.C

@@ -50,7 +50,7 @@ PDRkEpsilon::PDRkEpsilon
     const volScalarField& rho,
     const volVectorField& U,
     const surfaceScalarField& phi,
-    const basicThermo& thermophysicalModel
+    basicThermo& thermophysicalModel
 )
 :
     RASModel(typeName, rho, U, phi, thermophysicalModel),

applications/solvers/combustion/PDRFoam/PDRModels/turbulence/PDRkEpsilon/PDRkEpsilon.H

@@ -27,7 +27,7 @@ Class
 
 Description
     Standard k-epsilon turbulence model with additional source terms
-    corresponding to PDR basic drag model (basic.H)
+    corresponding to PDR basic drag model (\link basic.H \endlink)
 
     The turbulence source term \f$ G_{R} \f$ appears in the
     \f$ \kappa-\epsilon \f$ equation for the generation of turbulence due to
@@ -93,7 +93,7 @@ public:
             const volScalarField& rho,
             const volVectorField& U,
             const surfaceScalarField& phi,
-            const basicThermo& thermophysicalModel
+            basicThermo& thermophysicalModel
         );
 
 

applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/SCOPEBlendXiEq/SCOPEBlendXiEq.H

@@ -26,6 +26,10 @@ Class
     Foam::XiEqModels::SCOPEBlend
 
 Description
+    Simple SCOPEBlendXiEq model for XiEq based on SCOPEXiEqs correlation
+    with a linear correction function to give a plausible profile for XiEq.
+    See \link SCOPELaminarFlameSpeed.H \endlink for details on the SCOPE
+    laminar flame speed model.
 
 SourceFiles
     SCOPEBlend.C

applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/SCOPEXiEq/SCOPEXiEq.H

@@ -28,6 +28,8 @@ Class
 Description
     Simple SCOPEXiEq model for XiEq based on SCOPEXiEqs correlation
     with a linear correction function to give a plausible profile for XiEq.
+    See \link SCOPELaminarFlameSpeed.H \endlink for details on the SCOPE laminar
+    flame speed model.
 
 SourceFiles
     SCOPEXiEq.C

applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/XiEqModel/XiEqModel.H

@@ -27,6 +27,12 @@ Class
 
 Description
     Base-class for all XiEq models used by the b-XiEq combustion model.
+    The available models are :
+                                \link basicXiSubXiEq.H \endlink
+                                \link Gulder.H \endlink
+                                \link instabilityXiEq.H \endlink
+                                \link SCOPEBlendXiEq.H \endlink
+                                \link SCOPEXiEq.H \endlink
 
 SourceFiles
     XiEqModel.C

applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/instabilityXiEq/instabilityXiEq.H

@@ -26,6 +26,9 @@ Class
     Foam::XiEqModels::instability
 
 Description
+    This is the equilibrium level of the flame wrinkling generated by
+    inestability. It is a constant (default 2.5). It is used in
+    \link XiModel.H \endlink.
 
 SourceFiles
     instability.C

applications/solvers/combustion/PDRFoam/XiModels/XiGModels/KTS/KTS.H

@@ -26,7 +26,8 @@ Class
     Foam::XiGModels::KTS
 
 Description
-    Simple Kolmogorov time-scale model for the flame-wrinling generation rate.
+    Simple Kolmogorov time-scale (KTS) model for the flame-wrinling generation
+    rate.
 
 SourceFiles
     KTS.C

applications/solvers/combustion/PDRFoam/XiModels/XiGModels/XiGModel/XiGModel.H

@@ -27,6 +27,9 @@ Class
 
 Description
     Base-class for all Xi generation models used by the b-Xi combustion model.
+    See Technical Report SH/RE/01R for details on the PDR modelling. For details
+    on the use of XiGModel see \link XiModel.H \endlink. The model available is
+    \link instabilityG.H \endlink
 
 SourceFiles
     XiGModel.C

applications/solvers/combustion/PDRFoam/XiModels/XiGModels/instabilityG/instabilityG.H

@@ -26,7 +26,10 @@ Class
     Foam::XiGModels::instabilityG
 
 Description
-    Flame-surface instabilityG flame-wrinking generation rate coefficient model.
+    Flame-surface instabilityG flame-wrinking generation rate coefficient model
+    used in \link XiModel.H \endlink.
+
+    See Technical Report SH/RE/01R for details on the PDR modelling.
 
 SourceFiles
     instabilityG.C

applications/solvers/combustion/PDRFoam/XiModels/XiModel/XiModel.H

@@ -29,8 +29,10 @@ Description
     Base-class for all Xi models used by the b-Xi combustion model.
     See Technical Report SH/RE/01R for details on the PDR modelling.
 
-    Xi is given through an algebraic expression (algebraic.H),
-    by solving a transport equation (transport.H) or a fixed value (fixed.H).
+    Xi is given through an algebraic expression (\link algebraic.H \endlink),
+    by solving a transport equation (\link transport.H \endlink) or a
+    fixed value (\link fixed.H \endlink).
+
     See report TR/HGW/10 for details on the Weller two equations model.
 
     In the algebraic and transport methods \f$\Xi_{eq}\f$ is calculated in
@@ -45,6 +47,8 @@ Description
 
         \f$ \dwea{b} \f$ is the regress variable.
 
+        \f$ \Xi_{coeff} \f$ is a model constant.
+
         \f$ \Xi^* \f$ is the total equilibrium wrinkling combining the effects
         of the flame inestability and turbulence interaction and is given by
 

applications/solvers/combustion/PDRFoam/XiModels/algebraic/algebraic.H

@@ -28,6 +28,8 @@ Class
 Description
     Simple algebraic model for Xi based on Gulders correlation
     with a linear correction function to give a plausible profile for Xi.
+    See report TR/HGW/10 for details on the Weller two equations model.
+    See \link XiModel.H \endlink for more details on flame wrinkling modelling.
 
 SourceFiles
     algebraic.C

applications/solvers/combustion/PDRFoam/XiModels/fixed/fixed.H

@@ -26,7 +26,8 @@ Class
     Foam::XiModels::fixed
 
 Description
-    Fixed value model for Xi.
+    Fixed value model for Xi. See \link XiModel.H \endlink for more details
+    on flame wrinkling modelling.
 
 SourceFiles
     fixed.C

applications/solvers/combustion/PDRFoam/XiModels/transport/transport.H

@@ -28,6 +28,8 @@ Class
 Description
     Simple transport model for Xi based on Gulders correlation
     with a linear correction function to give a plausible profile for Xi.
+    See report TR/HGW/10 for details on the Weller two equations model.
+    See \link XiModel.H \endlink for more details on flame wrinkling modelling.
 
 SourceFiles
     transport.C