powerSeriesReactionRate.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-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::powerSeriesReactionRate
26 
27 Description
28  Power series reaction rate.
29 
30 SourceFiles
31  powerSeriesReactionRateI.H
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef powerSeriesReactionRate_H
36 #define powerSeriesReactionRate_H
37 
38 #include "speciesTable.H"
39 #include "scalarField.H"
40 #include "typeInfo.H"
41 #include "FixedList.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 // Forward declaration of friend functions and operators
49 
50 class powerSeriesReactionRate;
51 
52 Ostream& operator<<(Ostream&, const powerSeriesReactionRate&);
53 
54 
55 /*---------------------------------------------------------------------------*\
56  Class powerSeriesReactionRate Declaration
57 \*---------------------------------------------------------------------------*/
58 
60 {
61  // Private Data
62 
63  scalar beta_;
64  scalar A_;
65 
66  static const label nCoeff_ = 4;
68 
69 
70 public:
71 
72  // Constructors
73 
74  //- Construct from components
76  (
77  const scalar A,
78  const scalar beta,
79  const FixedList<scalar, nCoeff_> coeffs
80  );
81 
82  //- Construct from dictionary
84  (
85  const speciesTable& species,
86  const dimensionSet& dims,
87  const dictionary& dict
88  );
89 
90 
91  // Member Functions
92 
93  //- Return the type name
94  static word type()
95  {
96  return "powerSeries";
97  }
98 
99  //- Pre-evaluation hook
100  inline void preEvaluate() const;
101 
102  //- Post-evaluation hook
103  inline void postEvaluate() const;
104 
105  //- Return the rate
106  inline scalar operator()
107  (
108  const scalar p,
109  const scalar T,
110  const scalarField& c,
111  const label li
112  ) const;
113 
114  //- The derivative of the rate w.r.t. temperature
115  inline scalar ddT
116  (
117  const scalar p,
118  const scalar T,
119  const scalarField& c,
120  const label li
121  ) const;
122 
123  //- Is the rate a function of concentration?
124  inline bool hasDdc() const;
125 
126  //- The derivative of the rate w.r.t. concentration
127  inline void ddc
128  (
129  const scalar p,
130  const scalar T,
131  const scalarField& c,
132  const label li,
134  ) const;
135 
136  //- Write to stream
137  inline void write(Ostream& os) const;
138 
139 
140  // Ostream Operator
141 
142  inline friend Ostream& operator<<
143  (
144  Ostream&,
146  );
147 };
148 
149 
150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
151 
152 } // End namespace Foam
153 
154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
155 
157 
158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
159 
160 #endif
161 
162 // ************************************************************************* //
static const Foam::dimensionedScalar A("A", Foam::dimPressure, 611.21)
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.
Power series reaction rate.
void preEvaluate() const
Pre-evaluation hook.
void postEvaluate() const
Post-evaluation hook.
static word type()
Return the type name.
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.
scalar ddT(const scalar p, const scalar T, const scalarField &c, const label li) const
The derivative of the rate w.r.t. temperature.
powerSeriesReactionRate(const scalar A, const scalar beta, const FixedList< scalar, nCoeff_ > coeffs)
Construct from components.
bool hasDdc() const
Is the rate a function of concentration?
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
Basic run-time type information using word as the type's name. Used to enhance the standard RTTI to c...