MichaelisMentenReactionRate.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) 2018-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::MichaelisMentenReactionRate
26 
27 Description
28  Michaelis-Menten reaction rate for enzymatic reactions.
29 
30  Reference:
31  \verbatim
32  Michaelis, L., & Menten, M. L. (1913).
33  Die Kinetik der InwertinWirkung.
34  Biochem., (49), 333-369.
35  \endverbatim
36 
37 SourceFiles
38  MichaelisMentenReactionRateI.H
39 
40 \*---------------------------------------------------------------------------*/
41 
42 #ifndef MichaelisMentenReactionRate_H
43 #define MichaelisMentenReactionRate_H
44 
45 #include "Reaction.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 // Forward declaration of friend functions and operators
53 
54 class MichaelisMentenReactionRate;
55 
56 Ostream& operator<<(Ostream&, const MichaelisMentenReactionRate&);
57 
58 
59 /*---------------------------------------------------------------------------*\
60  Class MichaelisMentenReactionRate Declaration
61 \*---------------------------------------------------------------------------*/
62 
64 {
65  // Private Data
66 
67  //- List of species present in reaction system
68  const speciesTable& species_;
69 
70  //- The maximum reaction rate at saturating substrate concentration
71  scalar Vmax_;
72 
73  //- The Michaelis constant
74  // the substrate concentration at which the reaction rate is half Vmax_
75  scalar Km_;
76 
77  //- The substrate specie index
78  label s_;
79 
80 
81 public:
82 
83  // Constructors
84 
85  //- Construct from dictionary
87  (
88  const speciesTable& species,
89  const dimensionSet& dims,
90  const dictionary& dict
91  );
92 
93 
94  // Member Functions
95 
96  //- Return the type name
97  static word type()
98  {
99  return "MichaelisMenten";
100  }
101 
102  //- Pre-evaluation hook
103  inline void preEvaluate() const;
104 
105  //- Post-evaluation hook
106  inline void postEvaluate() const;
107 
108  //- Return the rate
109  inline scalar operator()
110  (
111  const scalar p,
112  const scalar T,
113  const scalarField& c,
114  const label li
115  ) const;
116 
117  //- The derivative of the rate w.r.t. temperature
118  inline scalar ddT
119  (
120  const scalar p,
121  const scalar T,
122  const scalarField& c,
123  const label li
124  ) const;
125 
126  //- Is the rate a function of concentration?
127  inline bool hasDdc() const;
128 
129  //- The derivative of the rate w.r.t. concentration
130  inline void ddc
131  (
132  const scalar p,
133  const scalar T,
134  const scalarField& c,
135  const label li,
137  ) const;
138 
139  //- Write to stream
140  inline void write(Ostream& os) const;
141 
142 
143  // Ostream Operator
144 
145  inline friend Ostream& operator<<
146  (
147  Ostream&,
149  );
150 };
151 
152 
153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
154 
155 } // End namespace Foam
156 
157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158 
160 
161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
162 
163 #endif
164 
165 // ************************************************************************* //
Michaelis-Menten reaction rate for enzymatic reactions.
void preEvaluate() const
Pre-evaluation hook.
void postEvaluate() const
Post-evaluation hook.
static word type()
Return the type name.
MichaelisMentenReactionRate(const speciesTable &species, const dimensionSet &dims, const dictionary &dict)
Construct from dictionary.
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.
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:162
Dimension set for the base types.
Definition: dimensionSet.H:125
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 &os, const fvConstraints &constraints)
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
dictionary dict
volScalarField & p