src/thermophysicalModels/specie/reaction/reactionRate/ArrheniusReactionRate/ArrheniusReactionRate.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::ArrheniusReactionRate
  27
  28 Description
  29     Arrhenius reaction rate.
  30
  31 SourceFiles
  32     ArrheniusReactionRateI.H
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef ArrheniusReactionRate_H
  37 #define ArrheniusReactionRate_H
  38
  39 #include "scalarField.H"
  40 #include "typeInfo.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class ArrheniusReactionRate Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class ArrheniusReactionRate
  52 {
  53     // Private data
  54
  55         scalar A_;
  56         scalar beta_;
  57         scalar Ta_;
  58
  59
  60 public:
  61
  62     // Constructors
  63
  64         //- Construct from components
  65         inline ArrheniusReactionRate
  66         (
  67             const scalar A,
  68             const scalar beta,
  69             const scalar Ta
  70         );
  71
  72         //- Construct from Istream
  73         inline ArrheniusReactionRate
  74         (
  75             const speciesTable& species,
  76             Istream& is
  77         );
  78
  79
  80     // Member Functions
  81
  82         //- Return the type name
  83         static word type()
  84         {
  85             return "Arrhenius";
  86         }
  87
  88         inline scalar operator()
  89         (
  90             const scalar T,
  91             const scalar p,
  92             const scalarField& c
  93         ) const;
  94
  95
  96     // Ostream Operator
  97
  98         inline friend Ostream& operator<<
  99         (
 100             Ostream&,
 101             const ArrheniusReactionRate&
 102         );
 103 };
 104
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 } // End namespace Foam
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #include "ArrheniusReactionRateI.H"
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 #endif
 117
 118 // ************************************************************************* //