infiniteReactionRate.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 | Copyright (C) 2011-2016 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::infiniteReactionRate
26 
27 Description
28  infinite reaction rate.
29 
30 SourceFiles
31  infiniteReactionRateI.H
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef infiniteReactionRate_H
36 #define infiniteReactionRate_H
37 
38 #include "scalarField.H"
39 #include "typeInfo.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // Forward declaration of friend functions and operators
47 
48 class infiniteReactionRate;
49 
50 Ostream& operator<<(Ostream&, const infiniteReactionRate&);
51 
52 
53 /*---------------------------------------------------------------------------*\
54  Class infiniteReactionRate Declaration
55 \*---------------------------------------------------------------------------*/
56 
58 {
59 public:
60 
61  // Constructors
62 
63  //- Null constructor
65  ();
66 
67  //- Construct from Istream
69  (
70  const speciesTable& species,
71  const dictionary& dict
72  );
73 
74 
75  // Member Functions
76 
77  //- Return the type name
78  static word type()
79  {
80  return "infinite";
81  }
82 
83  inline scalar operator()
84  (
85  const scalar p,
86  const scalar T,
87  const scalarField& c
88  ) const;
89 
90  //- Write to stream
91  inline void write(Ostream& os) const;
92 
93 
94  // Ostream Operator
95 
96  inline friend Ostream& operator<<
97  (
98  Ostream&,
100  );
101 };
102 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #include "infiniteReactionRateI.H"
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 #endif
115 
116 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
void write(Ostream &os) const
Write to stream.
A class for handling words, derived from string.
Definition: word.H:59
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
infiniteReactionRate()
Null constructor.
static word type()
Return the type name.
A wordList with hashed indices for faster lookup by name.
const dimensionedScalar c
Speed of light in a vacuum.
Ostream & operator<<(Ostream &, const ensightPart &)
infinite reaction rate.
volScalarField & p
Namespace for OpenFOAM.