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) 1991-2009 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::XiEqModel::SCOPEXiEq
  27
  28 Description
  29     Simple SCOPEXiEq model for XiEq based on SCOPEXiEqs correlation
  30     with a linear correction function to give a plausible profile for XiEq.
  31     See \link SCOPELaminarFlameSpeed.H \endlink for details on the SCOPE laminar
  32     flame speed model.
  33
  34 SourceFiles
  35     SCOPEXiEq.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef SCOPEXiEq_H
  40 #define SCOPEXiEq_H
  41
  42 #include "XiEqModel.H"
  43 #include "SCOPELaminarFlameSpeed.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49 namespace XiEqModels
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                           Class SCOPEXiEq Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class SCOPEXiEq
  57 :
  58     public XiEqModel
  59 {
  60     // Private data
  61
  62         scalar XiEqCoef;
  63         scalar XiEqExp;
  64         scalar lCoef;
  65         dimensionedScalar SuMin;
  66
  67         //- The SCOPE laminar flame speed model used to obtain the
  68         //  Marstein number.  Note: the laminar flame speed need not be
  69         //  obtained form the same model.
  70         laminarFlameSpeedModels::SCOPE MaModel;
  71
  72
  73     // Private Member Functions
  74
  75         //- Disallow copy construct
  76         SCOPEXiEq(const SCOPEXiEq&);
  77
  78         //- Disallow default bitwise assignment
  79         void operator=(const SCOPEXiEq&);
  80
  81
  82 public:
  83
  84     //- Runtime type information
  85     TypeName("SCOPEXiEq");
  86
  87
  88     // Constructors
  89
  90         //- Construct from components
  91         SCOPEXiEq
  92         (
  93             const dictionary& XiEqProperties,
  94             const hhuCombustionThermo& thermo,
  95             const compressible::RASModel& turbulence,
  96             const volScalarField& Su
  97         );
  98
  99
 100     // Destructor
 101
 102         virtual ~SCOPEXiEq();
 103
 104
 105     // Member Functions
 106
 107         //- Return the flame-wrinking XiEq
 108         virtual tmp<volScalarField> XiEq() const;
 109
 110         //- Update properties from given dictionary
 111         virtual bool read(const dictionary& XiEqProperties);
 112 };
 113
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 } // End namespace XiEqModels
 118 } // End namespace Foam
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 #endif
 123
 124 // ************************************************************************* //