applications/solvers/combustion/PDRFoam/XiModels/XiEqModels/Gulder/Gulder.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::XiEqModels::Gulder
  27
  28 Description
  29     Simple Gulder model for XiEq based on Gulders correlation
  30     with a linear correction function to give a plausible profile for XiEq.
  31
  32 SourceFiles
  33     Gulder.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef Gulder_H
  38 #define Gulder_H
  39
  40 #include "XiEqModel.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46 namespace XiEqModels
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                           Class Gulder Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class Gulder
  54 :
  55     public XiEqModel
  56 {
  57     // Private data
  58
  59         scalar XiEqCoef;
  60         dimensionedScalar SuMin;
  61
  62
  63     // Private Member Functions
  64
  65         //- Disallow copy construct
  66         Gulder(const Gulder&);
  67
  68         //- Disallow default bitwise assignment
  69         void operator=(const Gulder&);
  70
  71
  72 public:
  73
  74     //- Runtime type information
  75     TypeName("Gulder");
  76
  77
  78     // Constructors
  79
  80         //- Construct from components
  81         Gulder
  82         (
  83             const dictionary& XiEqProperties,
  84             const hhuCombustionThermo& thermo,
  85             const compressible::RASModel& turbulence,
  86             const volScalarField& Su
  87         );
  88
  89
  90     // Destructor
  91
  92         virtual ~Gulder();
  93
  94
  95     // Member Functions
  96
  97         //- Return the flame-wrinking XiEq
  98         virtual tmp<volScalarField> XiEq() const;
  99
 100         //- Update properties from given dictionary
 101         virtual bool read(const dictionary& XiEqProperties);
 102 };
 103
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 } // End namespace XiEqModels
 108 } // End namespace Foam
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #endif
 113
 114 // ************************************************************************* //