src/thermophysicalModels/specie/reaction/reactionRate/fallOffFunctions/TroeFallOffFunction/TroeFallOffFunction.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::TroeFallOffFunction
  27
  28 Description
  29     The Troe fall-off function
  30
  31 SourceFiles
  32     TroeFallOffFunctionI.H
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef TroeFallOffFunction_H
  37 #define TroeFallOffFunction_H
  38
  39 #include "scalar.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 // Forward declaration of friend functions and operators
  47
  48 class TroeFallOffFunction;
  49 Ostream& operator<<(Ostream&, const TroeFallOffFunction&);
  50
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class TroeFallOffFunction Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class TroeFallOffFunction
  57 {
  58     // Private data
  59
  60         scalar alpha_;
  61         scalar Tsss_, Ts_, Tss_;
  62
  63
  64 public:
  65
  66     // Constructors
  67
  68         //- Construct from components
  69         inline TroeFallOffFunction
  70         (
  71             const scalar alpha,
  72             const scalar Tsss,
  73             const scalar Ts,
  74             const scalar Tss
  75         );
  76
  77         //- Construct from Istream
  78         inline TroeFallOffFunction(Istream&);
  79
  80
  81     // Member Functions
  82
  83         //- Return the type name
  84         static word type()
  85         {
  86             return "Troe";
  87         }
  88
  89         inline scalar operator()
  90         (
  91             const scalar T,
  92             const scalar Pr
  93         ) const;
  94
  95
  96     // Ostream Operator
  97
  98         friend Ostream& operator<<(Ostream&, const TroeFallOffFunction&);
  99 };
 100
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 } // End namespace Foam
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 #include "TroeFallOffFunctionI.H"
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #endif
 113
 114 // ************************************************************************* //