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) 2004-2010 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::ArrheniusReactionRate
  26
  27 Description
  28     Arrhenius reaction rate given by:
  29
  30         k = A * T^beta * exp(-Ta/T)
  31
  32 SourceFiles
  33     ArrheniusReactionRateI.H
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef ArrheniusReactionRate_H
  38 #define ArrheniusReactionRate_H
  39
  40 #include "scalarField.H"
  41 #include "typeInfo.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                     Class ArrheniusReactionRate Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class ArrheniusReactionRate
  53 {
  54     // Private data
  55
  56         scalar A_;
  57         scalar beta_;
  58         scalar Ta_;
  59
  60
  61 public:
  62
  63     // Constructors
  64
  65         //- Construct from components
  66         inline ArrheniusReactionRate
  67         (
  68             const scalar A,
  69             const scalar beta,
  70             const scalar Ta
  71         );
  72
  73         //- Construct from Istream
  74         inline ArrheniusReactionRate
  75         (
  76             const speciesTable& species,
  77             Istream& is
  78         );
  79
  80         //- Construct from dictionary
  81         inline ArrheniusReactionRate
  82         (
  83             const speciesTable& species,
  84             const dictionary& dict
  85         );
  86
  87
  88     // Member Functions
  89
  90         //- Return the type name
  91         static word type()
  92         {
  93             return "Arrhenius";
  94         }
  95
  96         inline scalar operator()
  97         (
  98             const scalar T,
  99             const scalar p,
 100             const scalarField& c
 101         ) const;
 102
 103         //- Write to stream
 104         inline void write(Ostream& os) const;
 105
 106
 107     // Ostream Operator
 108
 109         inline friend Ostream& operator<<
 110         (
 111             Ostream&,
 112             const ArrheniusReactionRate&
 113         );
 114 };
 115
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 } // End namespace Foam
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 #include "ArrheniusReactionRateI.H"
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 #endif
 128
 129 // ************************************************************************* //