applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/SCOPEBlendXiEq/SCOPEBlendXiEq.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::XiEqModels::SCOPEBlend
  26
  27 Description
  28     Simple SCOPEBlendXiEq 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
  31     laminar flame speed model.
  32
  33 SourceFiles
  34     SCOPEBlend.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef SCOPEBlend_H
  39 #define SCOPEBlend_H
  40
  41 #include "XiEqModel.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47 namespace XiEqModels
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                           Class SCOPEBlend Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class SCOPEBlend
  55 :
  56     public XiEqModel
  57 {
  58     // Private data
  59
  60         //- Low turbulence intensity equilibrium Xi model
  61         autoPtr<XiEqModel> XiEqModelL_;
  62
  63         //- High turbulence intensity equilibrium Xi model
  64         autoPtr<XiEqModel> XiEqModelH_;
  65
  66
  67     // Private Member Functions
  68
  69         //- Disallow copy construct
  70         SCOPEBlend(const SCOPEBlend&);
  71
  72         //- Disallow default bitwise assignment
  73         void operator=(const SCOPEBlend&);
  74
  75
  76 public:
  77
  78     //- Runtime type information
  79     TypeName("SCOPEBlend");
  80
  81
  82     // Constructors
  83
  84         //- Construct from components
  85         SCOPEBlend
  86         (
  87             const dictionary& XiEqProperties,
  88             const hhuCombustionThermo& thermo,
  89             const compressible::RASModel& turbulence,
  90             const volScalarField& Su
  91         );
  92
  93
  94     //- Destructor
  95     virtual ~SCOPEBlend();
  96
  97
  98     // Member Functions
  99
 100         //- Return the flame-wrinking XiEq
 101         virtual tmp<volScalarField> XiEq() const;
 102
 103         //- Update properties from given dictionary
 104         virtual bool read(const dictionary& XiEqProperties)
 105         {
 106             return true;
 107         }
 108
 109 };
 110
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 } // End namespace XiEqModels
 115 } // End namespace Foam
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 #endif
 120
 121 // ************************************************************************* //