ReactionI.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-2019 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 \*---------------------------------------------------------------------------*/
25 
26 #include "Reaction.H"
27 
28 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32 
33 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
34 
35 template<class ReactionThermo>
36 inline const word& Reaction<ReactionThermo>::name() const
37 {
38  return name_;
39 }
40 
41 
42 template<class ReactionThermo>
43 inline scalar Reaction<ReactionThermo>::Tlow() const
44 {
45  return Tlow_;
46 }
47 
48 
49 template<class ReactionThermo>
50 inline scalar Reaction<ReactionThermo>::Thigh() const
51 {
52  return Thigh_;
53 }
54 
55 
56 template<class ReactionThermo>
58 {
59  return lhs_;
60 }
61 
62 
63 template<class ReactionThermo>
65 {
66  return rhs_;
67 }
68 
69 
70 // * * * * * * * * * * * * * * * Ostream Operator * * * * * * * * * * * * * //
71 
72 template<class ReactionThermo>
73 inline Ostream& operator<<(Ostream& os, const Reaction<ReactionThermo>& r)
74 {
75  r.write(os);
76  return os;
77 }
78 
79 
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
81 
82 } // End namespace Foam
83 
84 // ************************************************************************* //
virtual Ostream & write(const char)=0
Write character.
const word & name() const
Return the name of the reaction.
Definition: ReactionI.H:36
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
const List< specieCoeffs > & lhs() const
Return the components of the left hand side.
Definition: ReactionI.H:57
scalar Tlow() const
Return the lower temperature limit for the reaction.
Definition: ReactionI.H:43
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:54
scalar Thigh() const
Return the upper temperature limit for the reaction.
Definition: ReactionI.H:50
const List< specieCoeffs > & rhs() const
Return the components of the right hand side.
Definition: ReactionI.H:64
Namespace for OpenFOAM.