ChemicallyActivatedReactionRate.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) 2011-2017 OpenFOAM Foundation
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::ChemicallyActivatedReactionRate
26 
27 Description
28  General class for handling chemically-activated bimolecular reactions.
29 
30 SourceFiles
31  ChemicallyActivatedReactionRateI.H
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef ChemicallyActivatedReactionRate_H
36 #define ChemicallyActivatedReactionRate_H
37 
38 #include "thirdBodyEfficiencies.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 // Forward declaration of friend functions and operators
46 
47 template<class ReactionRate, class ChemicallyActivationFunction>
49 
50 template<class ReactionRate, class ChemicallyActivationFunction>
51 inline Ostream& operator<<
52 (
53  Ostream&,
55  <ReactionRate, ChemicallyActivationFunction>&
56 );
57 
58 
59 /*---------------------------------------------------------------------------*\
60  Class ChemicallyActivatedReactionRate Declaration
61 \*---------------------------------------------------------------------------*/
62 
63 template<class ReactionRate, class ChemicallyActivationFunction>
65 {
66  // Private data
67 
68  ReactionRate k0_;
69  ReactionRate kInf_;
70  ChemicallyActivationFunction F_;
71  thirdBodyEfficiencies thirdBodyEfficiencies_;
72 
73 
74 public:
75 
76  // Constructors
77 
78  //- Construct from components
80  (
81  const ReactionRate& k0,
82  const ReactionRate& kInf,
83  const ChemicallyActivationFunction& F,
84  const thirdBodyEfficiencies& tbes
85  );
86 
87  //- Construct from dictionary
89  (
90  const speciesTable& species,
91  const dictionary& dict
92  );
93 
94 
95  // Member Functions
96 
97  //- Return the type name
98  static word type()
99  {
100  return ReactionRate::type()
102  + "ChemicallyActivated";
103  }
104 
105  inline scalar operator()
106  (
107  const scalar p,
108  const scalar T,
109  const scalarField& c
110  ) const;
111 
112  //- Write to stream
113  inline void write(Ostream& os) const;
114 
115 
116  // Ostream Operator
117 
118  friend Ostream& operator<< <ReactionRate, ChemicallyActivationFunction>
119  (
120  Ostream&,
122  <ReactionRate, ChemicallyActivationFunction>&
123  );
124 };
125 
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 } // End namespace Foam
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 #endif
138 
139 // ************************************************************************* //
dictionary dict
type
Types of root.
Definition: Roots.H:52
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
ChemicallyActivatedReactionRate(const ReactionRate &k0, const ReactionRate &kInf, const ChemicallyActivationFunction &F, const thirdBodyEfficiencies &tbes)
Construct from components.
A class for handling words, derived from string.
Definition: word.H:59
General class for handling chemically-activated bimolecular reactions.
void write(Ostream &os) const
Write to stream.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
const dimensionedScalar F
Faraday constant: default SI units: [C/mol].
friend Ostream & operator(Ostream &, const ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction > &)
A wordList with hashed indices for faster lookup by name.
const dimensionedScalar c
Speed of light in a vacuum.
volScalarField & p
Third body efficiencies.
Namespace for OpenFOAM.