src/thermophysicalModels/specie/reaction/reactionRate/fallOffFunctions/TroeFallOffFunction/TroeFallOffFunction.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::TroeFallOffFunction
  26
  27 Description
  28     The Troe fall-off function
  29
  30 SourceFiles
  31     TroeFallOffFunctionI.H
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef TroeFallOffFunction_H
  36 #define TroeFallOffFunction_H
  37
  38 #include "scalar.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 // Forward declaration of friend functions and operators
  46
  47 class TroeFallOffFunction;
  48 Ostream& operator<<(Ostream&, const TroeFallOffFunction&);
  49
  50
  51 /*---------------------------------------------------------------------------*\
  52                            Class TroeFallOffFunction Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class TroeFallOffFunction
  56 {
  57     // Private data
  58
  59         scalar alpha_;
  60         scalar Tsss_, Ts_, Tss_;
  61
  62
  63 public:
  64
  65     // Constructors
  66
  67         //- Construct from components
  68         inline TroeFallOffFunction
  69         (
  70             const scalar alpha,
  71             const scalar Tsss,
  72             const scalar Ts,
  73             const scalar Tss
  74         );
  75
  76         //- Construct from Istream
  77         inline TroeFallOffFunction(Istream&);
  78
  79
  80     // Member Functions
  81
  82         //- Return the type name
  83         static word type()
  84         {
  85             return "Troe";
  86         }
  87
  88         inline scalar operator()
  89         (
  90             const scalar T,
  91             const scalar Pr
  92         ) const;
  93
  94
  95     // Ostream Operator
  96
  97         friend Ostream& operator<<(Ostream&, const TroeFallOffFunction&);
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #include "TroeFallOffFunctionI.H"
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #endif
 112
 113 // ************************************************************************* //