FallOffReactionRate.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::FallOffReactionRate
28
29Description
30 General class for handling unimolecular/recombination fall-off reactions.
31
32SourceFiles
33 FallOffReactionRateI.H
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef FallOffReactionRate_H
38#define FallOffReactionRate_H
39
41
42// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44namespace Foam
45{
46
47// Forward declaration of friend functions and operators
48
49template<class ReactionRate, class FallOffFunction>
50class FallOffReactionRate;
51
52template<class ReactionRate, class FallOffFunction>
53inline Ostream& operator<<
54(
55 Ostream&,
57);
58
59
60/*---------------------------------------------------------------------------*\
61 Class FallOffReactionRate Declaration
62\*---------------------------------------------------------------------------*/
63
64template<class ReactionRate, class FallOffFunction>
66{
67 // Private data
68
69 ReactionRate k0_;
70 ReactionRate kInf_;
71 FallOffFunction F_;
72 thirdBodyEfficiencies thirdBodyEfficiencies_;
73
74
75public:
76
77 // Constructors
78
79 //- Construct from components
81 (
82 const ReactionRate& k0,
83 const ReactionRate& kInf,
84 const FallOffFunction& F,
85 const thirdBodyEfficiencies& tbes
86 );
87
88 //- Construct from dictionary
90 (
91 const speciesTable& species,
92 const dictionary& dict
93 );
94
95
96 // Member Functions
97
98 //- Return the type name
99 static word type()
100 {
101 return ReactionRate::type() + FallOffFunction::type() + "FallOff";
102 }
103
104 inline scalar operator()
105 (
106 const scalar p,
107 const scalar T,
108 const scalarField& c
109 ) const;
110
111 //- Write to stream
112 inline void write(Ostream& os) const;
113
114
115 // Ostream Operator
117 friend Ostream& operator<< <ReactionRate, FallOffFunction>
118 (
119 Ostream&,
121 );
122};
123
124
125// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126
127} // End namespace Foam
128
129// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130
131#include "FallOffReactionRateI.H"
132
133// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134
135#endif
136
137// ************************************************************************* //
General class for handling unimolecular/recombination fall-off reactions.
friend Ostream & operator(Ostream &, const FallOffReactionRate< ReactionRate, FallOffFunction > &)
static word type()
Return the type name.
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