FreeFOAM The Cross-Platform CFD Toolkit
FallOffReactionRate.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::FallOffReactionRate
26 
27 Description
28  General class for handling unimolecular/recombination fall-off reactions.
29 
30 SourceFiles
31  FallOffReactionRateI.H
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef FallOffReactionRate_H
36 #define FallOffReactionRate_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 // Forward declaration of friend functions and operators
46 
47 template<class ReactionRate, class FallOffFunction>
48 class FallOffReactionRate;
49 
50 template<class ReactionRate, class FallOffFunction>
51 inline Ostream& operator<<
52 (
53  Ostream&,
54  const FallOffReactionRate<ReactionRate, FallOffFunction>&
55 );
56 
57 
58 /*---------------------------------------------------------------------------*\
59  Class FallOffReactionRate Declaration
60 \*---------------------------------------------------------------------------*/
61 
62 template<class ReactionRate, class FallOffFunction>
64 {
65  // Private data
66 
67  ReactionRate k0_;
68  ReactionRate kInf_;
69  FallOffFunction F_;
70  thirdBodyEfficiencies thirdBodyEfficiencies_;
71 
72 
73 public:
74 
75  // Constructors
76 
77  //- Construct from components
78  inline FallOffReactionRate
79  (
80  const ReactionRate& k0,
81  const ReactionRate& kInf,
82  const FallOffFunction& F,
83  const thirdBodyEfficiencies& tbes
84  );
85 
86  //- Construct from Istream
87  inline FallOffReactionRate
88  (
89  const speciesTable& species,
90  Istream& is
91  );
92 
93 
94  // Member Functions
95 
96  //- Return the type name
97  static word type()
98  {
99  return ReactionRate::type() + FallOffFunction::type() + "FallOff";
100  }
101 
102  inline scalar operator()
103  (
104  const scalar T,
105  const scalar p,
106  const scalarField& c
107  ) const;
108 
109 
110  // Ostream Operator
111 
112  friend Ostream& operator<< <ReactionRate, FallOffFunction>
113  (
114  Ostream&,
116  );
117 };
118 
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #endif
131 
132 // ************************ vim: set sw=4 sts=4 et: ************************ //