applications/solvers/combustion/PDRFoam/PDRModels/XiGModels/basicXiSubG/basicXiSubG.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::XiGModel::basicSubGrid
  26
  27
  28 Description
  29
  30     Basic sub-grid obstacle flame-wrinking generation rate coefficient model.
  31     Details supplied by J Puttock 2/7/06.
  32
  33     \f$ G_{sub} \f$ denotes the generation coefficient and it is given by
  34
  35     \f[
  36         G_{sub} = k_{1} /frac{\vert \dwea{\vec{U}} \vert}{L_{obs}}
  37                  \frac{/Xi_{{sub}_{eq}}-1}{/Xi_{sub}}
  38     \f]
  39
  40     and the removal:
  41
  42     \f[ - k_{1} /frac{\vert \dwea{\vec{U}} \vert}{L_{sub}}
  43     \frac{\Xi_{sub}-1}{\Xi_{sub}} \f]
  44
  45     Finally, \f$ G_{sub} \f$ is added to generation rate \f$ G_{in} \f$
  46     due to the turbulence.
  47
  48
  49 SourceFiles
  50     basicSubGrid.C
  51
  52 \*---------------------------------------------------------------------------*/
  53
  54 #ifndef basicSubGrid_H
  55 #define basicSubGrid_H
  56
  57 #include "XiGModel.H"
  58
  59 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  60
  61 namespace Foam
  62 {
  63 namespace XiGModels
  64 {
  65
  66 /*---------------------------------------------------------------------------*\
  67                           Class basicSubGrid Declaration
  68 \*---------------------------------------------------------------------------*/
  69
  70 class basicSubGrid
  71 :
  72     public XiGModel
  73 {
  74     // Private data
  75
  76         //- Sub-grid generation rate coefficient
  77         scalar k1;
  78
  79         //- Xi generation rate model due to turbulence
  80         autoPtr<XiGModel> XiGModel_;
  81
  82
  83     // Private Member Functions
  84
  85         //- Disallow copy construct
  86         basicSubGrid(const basicSubGrid&);
  87
  88         //- Disallow default bitwise assignment
  89         void operator=(const basicSubGrid&);
  90
  91
  92 public:
  93
  94     //- Runtime type information
  95     TypeName("basicSubGridG");
  96
  97
  98     // Constructors
  99
 100         //- Construct from components
 101         basicSubGrid
 102         (
 103             const dictionary& XiGProperties,
 104             const hhuCombustionThermo& thermo,
 105             const compressible::RASModel& turbulence,
 106             const volScalarField& Su
 107         );
 108
 109
 110     //- Destructor
 111     virtual ~basicSubGrid();
 112
 113
 114     // Member Functions
 115
 116         //- Return the flame-wrinking generation rate
 117         virtual tmp<volScalarField> G() const;
 118
 119         //- Return the flame diffusivity
 120         virtual tmp<volScalarField> Db() const;
 121
 122         //- Update properties from given dictionary
 123         virtual bool read(const dictionary& XiGProperties);
 124 };
 125
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 } // End namespace XiGModels
 130 } // End namespace Foam
 131
 132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 133
 134 #endif
 135
 136 // ************************************************************************* //