src/thermophysicalModels/specie/reaction/reactionRate/fallOffFunctions/LindemannFallOffFunction/LindemannFallOffFunction.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::LindemannFallOffFunction
  27
  28 Description
  29     Lindemann fall-off function
  30
  31 SourceFiles
  32     LindemannFallOffFunctionI.H
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef LindemannFallOffFunction_H
  37 #define LindemannFallOffFunction_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 LindemannFallOffFunction;
  49 Ostream& operator<<(Ostream&, const LindemannFallOffFunction&);
  50
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class LindemannFallOffFunction Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class LindemannFallOffFunction
  57 {
  58
  59 public:
  60
  61     // Constructors
  62
  63         //- Construct null
  64         inline LindemannFallOffFunction();
  65
  66         //- Construct from Istream
  67         inline LindemannFallOffFunction(Istream&);
  68
  69
  70     // Member Functions
  71
  72         //- Return the type name
  73         static word type()
  74         {
  75             return "Lindemann";
  76         }
  77
  78         inline scalar operator()
  79         (
  80             const scalar T,
  81             const scalar Pr
  82         ) const;
  83
  84
  85     // Ostream Operator
  86
  87         friend Ostream& operator<<(Ostream&, const LindemannFallOffFunction&);
  88 };
  89
  90
  91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  92
  93 } // End namespace Foam
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  96
  97 #include "LindemannFallOffFunctionI.H"
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 #endif
 102
 103 // ************************************************************************* //