FreeFOAM The Cross-Platform CFD Toolkit
ArrheniusReactionRate.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-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.
29 
30 SourceFiles
31  ArrheniusReactionRateI.H
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef ArrheniusReactionRate_H
36 #define ArrheniusReactionRate_H
37 
38 #include <OpenFOAM/scalarField.H>
39 #include <OpenFOAM/typeInfo.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class ArrheniusReactionRate Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 {
52  // Private data
53 
54  scalar A_;
55  scalar beta_;
56  scalar Ta_;
57 
58 
59 public:
60 
61  // Constructors
62 
63  //- Construct from components
65  (
66  const scalar A,
67  const scalar beta,
68  const scalar Ta
69  );
70 
71  //- Construct from Istream
73  (
74  const speciesTable& species,
75  Istream& is
76  );
77 
78 
79  // Member Functions
80 
81  //- Return the type name
82  static word type()
83  {
84  return "Arrhenius";
85  }
86 
87  inline scalar operator()
88  (
89  const scalar T,
90  const scalar p,
91  const scalarField& c
92  ) const;
93 
94 
95  // Ostream Operator
96 
97  inline friend Ostream& operator<<
98  (
99  Ostream&,
100  const ArrheniusReactionRate&
101  );
102 };
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace Foam
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************ vim: set sw=4 sts=4 et: ************************ //