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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
   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::XiEqModel::SCOPEXiEq
  26
  27 Description
  28     Simple SCOPEXiEq model for XiEq based on SCOPEXiEqs correlation
  29     with a linear correction function to give a plausible profile for XiEq.
  30     See \link SCOPELaminarFlameSpeed.H \endlink for details on the SCOPE laminar
  31     flame speed model.
  32
  33 SourceFiles
  34     SCOPEXiEq.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef SCOPEXiEq_H
  39 #define SCOPEXiEq_H
  40
  41 #include "XiEqModel.H"
  42 #include "SCOPELaminarFlameSpeed.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48 namespace XiEqModels
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                           Class SCOPEXiEq Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class SCOPEXiEq
  56 :
  57     public XiEqModel
  58 {
  59     // Private data
  60
  61         // Model constant
  62         scalar XiEqCoef_;
  63
  64         // Model constant
  65         scalar XiEqExp_;
  66
  67         // Model constant
  68         scalar lCoef_;
  69
  70         //- Minimum Su
  71         dimensionedScalar SuMin_;
  72
  73         //- The SCOPE laminar flame speed model used to obtain the
  74         //  Marstein number.  Note: the laminar flame speed need not be
  75         //  obtained form the same model.
  76         laminarFlameSpeedModels::SCOPE MaModel;
  77
  78
  79     // Private Member Functions
  80
  81         //- Disallow copy construct
  82         SCOPEXiEq(const SCOPEXiEq&);
  83
  84         //- Disallow default bitwise assignment
  85         void operator=(const SCOPEXiEq&);
  86
  87
  88 public:
  89
  90     //- Runtime type information
  91     TypeName("SCOPEXiEq");
  92
  93
  94     // Constructors
  95
  96         //- Construct from components
  97         SCOPEXiEq
  98         (
  99             const dictionary& XiEqProperties,
 100             const hhuCombustionThermo& thermo,
 101             const compressible::RASModel& turbulence,
 102             const volScalarField& Su
 103         );
 104
 105
 106     //- Destructor
 107     virtual ~SCOPEXiEq();
 108
 109
 110     // Member Functions
 111
 112         //- Return the flame-wrinking XiEq
 113         virtual tmp<volScalarField> XiEq() const;
 114
 115         //- Update properties from given dictionary
 116         virtual bool read(const dictionary& XiEqProperties);
 117
 118 };
 119
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 } // End namespace XiEqModels
 124 } // End namespace Foam
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 #endif
 129
 130 // ************************************************************************* //