ArrheniusReactionRate.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::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 // Forward declaration of friend functions and operators
49 
50 class ArrheniusReactionRate;
51 
52 Ostream& operator<<(Ostream&, const ArrheniusReactionRate&);
53 
54 
55 /*---------------------------------------------------------------------------*\
56  Class ArrheniusReactionRate Declaration
57 \*---------------------------------------------------------------------------*/
58 
60 {
61  // Private Data
62 
63  scalar A_;
64  scalar beta_;
65  scalar Ta_;
66 
67 
68 public:
69 
70  // Constructors
71 
72  //- Construct from components
74  (
75  const scalar A,
76  const scalar beta,
77  const scalar Ta
78  );
79 
80  //- Construct from dictionary
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  //- Pre-evaluation hook
97  inline void preEvaluate() const;
98 
99  //- Post-evaluation hook
100  inline void postEvaluate() const;
101 
102  //- Return the rate
103  inline scalar operator()
104  (
105  const scalar p,
106  const scalar T,
107  const scalarField& c,
108  const label li
109  ) const;
110 
111  //- The derivative of the rate w.r.t. temperature
112  inline scalar ddT
113  (
114  const scalar p,
115  const scalar T,
116  const scalarField& c,
117  const label li
118  ) const;
119 
120  //- Is the rate a function of concentration?
121  inline bool hasDdc() const;
122 
123  //- The derivative of the rate w.r.t. concentration
124  inline void ddc
125  (
126  const scalar p,
127  const scalar T,
128  const scalarField& c,
129  const label li,
131  ) const;
132 
133  //- Write to stream
134  inline void write(Ostream& os) const;
135 
136 
137  // Ostream Operator
138 
139  inline friend Ostream& operator<<
140  (
141  Ostream&,
142  const ArrheniusReactionRate&
143  );
144 };
145 
146 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 } // End namespace Foam
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 #include "ArrheniusReactionRateI.H"
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 #endif
158 
159 // ************************************************************************* //
void postEvaluate() const
Post-evaluation hook.
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
scalar ddT(const scalar p, const scalar T, const scalarField &c, const label li) const
The derivative of the rate w.r.t. temperature.
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.
void preEvaluate() const
Pre-evaluation hook.
bool hasDdc() const
Is the rate a function of concentration?
ArrheniusReactionRate(const scalar A, const scalar beta, const scalar Ta)
Construct from components.
const dimensionedScalar c
Speed of light in a vacuum.
A class for handling words, derived from string.
Definition: word.H:59
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
static word type()
Return the type name.
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
A wordList with hashed indices for faster lookup by name.
Ostream & operator<<(Ostream &, const ensightPart &)
Arrhenius reaction rate given by:
volScalarField & p
void write(Ostream &os) const
Write to stream.
Namespace for OpenFOAM.