surfaceArrheniusReactionRate.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) 2019-2024 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::surfaceArrheniusReactionRate
26 
27 Description
28  A modified Arrhenius reaction rate given by:
29 
30  k = (A * T^beta * exp(-Ta/T))*a
31 
32  Where a is the surface area per unit volume, the name of which is
33  specified by the user.
34 
35 SourceFiles
36  surfaceArrheniusReactionRateI.H
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef surfaceArrheniusReactionRate_H
41 #define surfaceArrheniusReactionRate_H
42 
43 #include "ArrheniusReactionRate.H"
44 #include "speciesTable.H"
45 #include "objectRegistry.H"
46 #include "volFields.H"
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 namespace Foam
51 {
52 
53 // Forward declaration of friend functions and operators
54 
55 class surfaceArrheniusReactionRate;
56 
57 Ostream& operator<<(Ostream&, const surfaceArrheniusReactionRate&);
58 
59 /*---------------------------------------------------------------------------*\
60  Class surfaceArrheniusReactionRate Declaration
61 \*---------------------------------------------------------------------------*/
62 
64 :
66 {
67  // Private Data
68 
69  //- Name of the surface area per unit volume field
70  const word AvName_;
71 
72  //- Reference to the object registry
73  const objectRegistry& ob_;
74 
75  //- The surface area per unit volume field
76  mutable tmp<volScalarField::Internal> tAv_;
77 
78 
79 public:
80 
81  // Constructors
82 
83  //- Construct from dictionary
85  (
86  const speciesTable& species,
87  const objectRegistry& ob,
88  const dimensionSet& dims,
89  const dictionary& dict
90  );
91 
92 
93  // Member Functions
94 
95  //- Return the type name
96  static word type()
97  {
98  return "surfaceArrhenius";
99  }
100 
101  //- Pre-evaluation hook
102  inline void preEvaluate() const;
103 
104  //- Post-evaluation hook
105  inline void postEvaluate() const;
106 
107  //- Evaluate 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  //- Evaluate the derivative
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  //- Write to stream
126  inline void write(Ostream& os) const;
127 
128 
129  // Ostream Operator
130 
131  inline friend Ostream& operator<<
132  (
133  Ostream&,
135  );
136 };
137 
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 } // End namespace Foam
142 
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 
146 
147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 
149 #endif
150 
151 // ************************************************************************* //
Arrhenius reaction rate given by:
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:162
Dimension set for the base types.
Definition: dimensionSet.H:125
A wordList with hashed indices for faster lookup by name.
Registry of regIOobjects.
A modified Arrhenius reaction rate given by:
void preEvaluate() const
Pre-evaluation hook.
surfaceArrheniusReactionRate(const speciesTable &species, const objectRegistry &ob, const dimensionSet &dims, const dictionary &dict)
Construct from dictionary.
void postEvaluate() const
Post-evaluation hook.
static word type()
Return the type name.
void write(Ostream &os) const
Write to stream.
scalar ddT(const scalar p, const scalar T, const scalarField &c, const label li) const
Evaluate the derivative.
A class for managing temporary objects.
Definition: tmp.H:55
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 &os, const fvConstraints &constraints)
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
dictionary dict
volScalarField & p