ChemicallyActivatedReactionRate.H
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2017 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::ChemicallyActivatedReactionRate
28
29Description
30 General class for handling chemically-activated bimolecular reactions.
31
32SourceFiles
33 ChemicallyActivatedReactionRateI.H
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef ChemicallyActivatedReactionRate_H
38#define ChemicallyActivatedReactionRate_H
39
41
42// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44namespace Foam
45{
46
47// Forward declaration of friend functions and operators
48
49template<class ReactionRate, class ChemicallyActivationFunction>
50class ChemicallyActivatedReactionRate;
51
52template<class ReactionRate, class ChemicallyActivationFunction>
53inline Ostream& operator<<
54(
55 Ostream&,
57 <ReactionRate, ChemicallyActivationFunction>&
58);
59
60
61/*---------------------------------------------------------------------------*\
62 Class ChemicallyActivatedReactionRate Declaration
63\*---------------------------------------------------------------------------*/
64
65template<class ReactionRate, class ChemicallyActivationFunction>
67{
68 // Private data
69
70 ReactionRate k0_;
71 ReactionRate kInf_;
72 ChemicallyActivationFunction F_;
73 thirdBodyEfficiencies thirdBodyEfficiencies_;
74
75
76public:
77
78 // Constructors
79
80 //- Construct from components
82 (
83 const ReactionRate& k0,
84 const ReactionRate& kInf,
85 const ChemicallyActivationFunction& F,
86 const thirdBodyEfficiencies& tbes
87 );
88
89 //- Construct from dictionary
91 (
92 const speciesTable& species,
93 const dictionary& dict
94 );
95
96
97 // Member Functions
98
99 //- Return the type name
100 static word type()
101 {
102 return ReactionRate::type()
103 + ChemicallyActivationFunction::type()
104 + "ChemicallyActivated";
105 }
106
107 inline scalar operator()
108 (
109 const scalar p,
110 const scalar T,
111 const scalarField& c
112 ) const;
113
114 //- Write to stream
115 inline void write(Ostream& os) const;
116
117
118 // Ostream Operator
120 friend Ostream& operator<< <ReactionRate, ChemicallyActivationFunction>
121 (
122 Ostream&,
124 <ReactionRate, ChemicallyActivationFunction>&
125 );
126};
127
128
129// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130
131} // End namespace Foam
132
133// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134
136
137// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138
139#endif
140
141// ************************************************************************* //
General class for handling chemically-activated bimolecular reactions.
friend Ostream & operator(Ostream &, const ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction > &)
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
A wordList with hashed named lookup, which can be faster in some situations than using the normal lis...
Third body efficiencies.
A class for handling words, derived from Foam::string.
Definition: word.H:68
volScalarField & p
const volScalarField & T
OBJstream os(runTime.globalPath()/outputName)
volVectorField F(fluid.F())
Namespace for OpenFOAM.
runTime write()
dictionary dict