PDRFoam documentation completion

2025-11-28 03:28:01 +00:00 · 2008-12-08 13:51:31 +00:00
parent f5b23d5065
commit b4a2f37f1b
19 changed files with 63 additions and 32 deletions
--- a/applications/solvers/combustion/PDRFoam/PDRModels/XiEqModels/basicXiSubXiEq/basicXiSubXiEq.H
+++ b/applications/solvers/combustion/PDRFoam/PDRModels/XiEqModels/basicXiSubXiEq/basicXiSubXiEq.H
@ -23,7 +23,7 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    basicSubGrid
+    Foam::XiEqModels::basicSubGrid

 Description
    Basic sub-grid obstacle flame-wrinking enhancement factor model.
--- a/applications/solvers/combustion/PDRFoam/PDRModels/XiGModels/basicXiSubG/basicXiSubG.H
+++ b/applications/solvers/combustion/PDRFoam/PDRModels/XiGModels/basicXiSubG/basicXiSubG.H
@ -23,7 +23,7 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    basicSubGrid
+    Foam::XiGModel::basicSubGrid


 Description
--- a/applications/solvers/combustion/PDRFoam/PDRModels/dragModels/PDRDragModel/PDRDragModel.H
+++ b/applications/solvers/combustion/PDRFoam/PDRModels/dragModels/PDRDragModel/PDRDragModel.H
@ -23,10 +23,11 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    PDRDragModel
+    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
--- a/applications/solvers/combustion/PDRFoam/PDRModels/dragModels/basic/basic.H
+++ b/applications/solvers/combustion/PDRFoam/PDRModels/dragModels/basic/basic.H
@ -23,7 +23,7 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    basic
+    Foam::PDRDragModels::basic

 Description
    Basic sub-grid obstacle drag model.
@ -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
--- a/applications/solvers/combustion/PDRFoam/PDRModels/turbulence/PDRkEpsilon/PDRkEpsilon.C
+++ b/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),
--- a/applications/solvers/combustion/PDRFoam/PDRModels/turbulence/PDRkEpsilon/PDRkEpsilon.H
+++ b/applications/solvers/combustion/PDRFoam/PDRModels/turbulence/PDRkEpsilon/PDRkEpsilon.H
@ -23,11 +23,11 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    PDRkEpsilon
+    Foam::compressible::RASModels::PDRkEpsilon

 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
        );


--- a/applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/Gulder/Gulder.H
+++ b/applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/Gulder/Gulder.H
@ -23,7 +23,7 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    Gulder
+    Foam::XiEqModels::Gulder

 Description
    Simple Gulder model for XiEq based on Gulders correlation
--- a/applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/SCOPEBlendXiEq/SCOPEBlendXiEq.H
+++ b/applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/SCOPEBlendXiEq/SCOPEBlendXiEq.H
@ -23,10 +23,14 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    SCOPEBlend
+    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

--- a/applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/SCOPEXiEq/SCOPEXiEq.H
+++ b/applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/SCOPEXiEq/SCOPEXiEq.H
@ -23,11 +23,13 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    SCOPEXiEq
+    Foam::XiEqModel::SCOPEXiEq

 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
--- a/applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/XiEqModel/XiEqModel.H
+++ b/applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/XiEqModel/XiEqModel.H
@ -23,10 +23,16 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    XiEqModel
+    Foam::XiEqModel

 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
--- a/applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/instabilityXiEq/instabilityXiEq.H
+++ b/applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/instabilityXiEq/instabilityXiEq.H
@ -23,10 +23,14 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    instability
+    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

--- a/applications/solvers/combustion/PDRFoam/XiModels/XiGModels/KTS/KTS.H
+++ b/applications/solvers/combustion/PDRFoam/XiModels/XiGModels/KTS/KTS.H
@ -23,10 +23,11 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    KTS
+    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
--- a/applications/solvers/combustion/PDRFoam/XiModels/XiGModels/XiGModel/XiGModel.H
+++ b/applications/solvers/combustion/PDRFoam/XiModels/XiGModels/XiGModel/XiGModel.H
@ -23,10 +23,13 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    XiGModel
+    Foam::XiGModel

 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
--- a/applications/solvers/combustion/PDRFoam/XiModels/XiGModels/instabilityG/instabilityG.H
+++ b/applications/solvers/combustion/PDRFoam/XiModels/XiGModels/instabilityG/instabilityG.H
@ -23,10 +23,13 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    instabilityG
+    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
--- a/applications/solvers/combustion/PDRFoam/XiModels/XiModel/XiModel.H
+++ b/applications/solvers/combustion/PDRFoam/XiModels/XiModel/XiModel.H
@ -23,14 +23,16 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    XiModel
+    Foam::XiModel

 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

@ -102,8 +106,6 @@ namespace Foam
                          Class XiModel Declaration
 \*---------------------------------------------------------------------------*/

-
-
 class XiModel
 {

--- a/applications/solvers/combustion/PDRFoam/XiModels/algebraic/algebraic.H
+++ b/applications/solvers/combustion/PDRFoam/XiModels/algebraic/algebraic.H
@ -23,11 +23,13 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    algebraic
+    Foam::XiModels::algebraic

 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
--- a/applications/solvers/combustion/PDRFoam/XiModels/fixed/fixed.H
+++ b/applications/solvers/combustion/PDRFoam/XiModels/fixed/fixed.H
@ -23,10 +23,11 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    fixed
+    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
--- a/applications/solvers/combustion/PDRFoam/XiModels/transport/transport.H
+++ b/applications/solvers/combustion/PDRFoam/XiModels/transport/transport.H
@ -23,11 +23,13 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    transport
+    Foam::XiModels::transport

 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
--- a/applications/solvers/combustion/PDRFoam/laminarFlameSpeed/SCOPE/SCOPELaminarFlameSpeed.H
+++ b/applications/solvers/combustion/PDRFoam/laminarFlameSpeed/SCOPE/SCOPELaminarFlameSpeed.H
@ -23,7 +23,7 @@ License
    Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

 Class
-    SCOPE
+    Foam::laminarFlameSpeedModels::SCOPE

 Description
    Laminar flame speed obtained from the SCOPE correlation.