LangmuirHinshelwoodReactionRate.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2021 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::LangmuirHinshelwoodReactionRate
26 
27 Description
28  Langmuir-Hinshelwood reaction rate for gaseous reactions on surfaces.
29 
30  Reference:
31  \verbatim
32  Hinshelwood, C.N. (1940).
33  The Kinetics of Chemical Change.
34  Oxford Clarendon Press
35  \endverbatim
36 
37 SourceFiles
38  LangmuirHinshelwoodReactionRateI.H
39 
40 \*---------------------------------------------------------------------------*/
41 
42 #ifndef LangmuirHinshelwoodReactionRate_H
43 #define LangmuirHinshelwoodReactionRate_H
44 
45 #include "scalarField.H"
46 #include "typeInfo.H"
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 namespace Foam
51 {
52 
53 // Forward declaration of friend functions and operators
54 
55 class LangmuirHinshelwoodReactionRate;
56 
57 Ostream& operator<<(Ostream&, const LangmuirHinshelwoodReactionRate&);
58 
59 
60 /*---------------------------------------------------------------------------*\
61  Class LangmuirHinshelwoodReactionRate Declaration
62 \*---------------------------------------------------------------------------*/
63 
65 {
66  // Private Data
67 
68  //- Reactant names
69  FixedList<word, 2> reactantNames_;
70 
71  //- Reactant indices
73 
74  scalar a_;
79 
80 
81 public:
82 
83  // Constructors
84 
85  //- Construct from dictionary
87  (
88  const speciesTable& species,
89  const dictionary& dict
90  );
91 
92 
93  // Member Functions
94 
95  //- Return the type name
96  static word type()
97  {
98  return "LangmuirHinshelwood";
99  }
100 
101  //- Pre-evaluation hook
102  inline void preEvaluate() const;
103 
104  //- Post-evaluation hook
105  inline void postEvaluate() const;
106 
107  //- Return the rate
108  inline scalar operator()
109  (
110  const scalar p,
111  const scalar T,
112  const scalarField& c,
113  const label li
114  ) const;
115 
116  //- The derivative of the rate w.r.t. temperature
117  inline scalar ddT
118  (
119  const scalar p,
120  const scalar T,
121  const scalarField& c,
122  const label li
123  ) const;
124 
125  //- Is the rate a function of concentration?
126  inline bool hasDdc() const;
127 
128  //- The derivative of the rate w.r.t. concentration
129  inline void ddc
130  (
131  const scalar p,
132  const scalar T,
133  const scalarField& c,
134  const label li,
136  ) const;
137 
138  //- Write to stream
139  inline void write(Ostream& os) const;
140 
141 
142  // Ostream Operator
143 
144  inline friend Ostream& operator<<
145  (
146  Ostream&,
148  );
149 };
150 
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 
154 } // End namespace Foam
155 
156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
157 
159 
160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 
162 #endif
163 
164 // ************************************************************************* //
A 1D vector of objects of type <T> with a fixed size <Size>.
Definition: FixedList.H:78
Langmuir-Hinshelwood reaction rate for gaseous reactions on surfaces.
void write(Ostream &os) const
Write to stream.
void ddc(const scalar p, const scalar T, const scalarField &c, const label li, scalarField &ddc) const
The derivative of the rate w.r.t. concentration.
LangmuirHinshelwoodReactionRate(const speciesTable &species, const dictionary &dict)
Construct from dictionary.
scalar ddT(const scalar p, const scalar T, const scalarField &c, const label li) const
The derivative of the rate w.r.t. temperature.
bool hasDdc() const
Is the rate a function of concentration?
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:160
A wordList with hashed indices for faster lookup by name.
A class for handling words, derived from string.
Definition: word.H:62
const dimensionedScalar c
Speed of light in a vacuum.
Namespace for OpenFOAM.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Ostream & operator<<(Ostream &, const ensightPart &)
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
dictionary dict
volScalarField & p