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) 2020 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 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
29 
30 inline const Foam::word& Foam::reaction::name() const
31 {
32  return name_;
33 }
34 
35 
37 {
38  return lhs_;
39 }
40 
41 
43 {
44  return rhs_;
45 }
46 
47 
49 {
50  return species_;
51 }
52 
53 
54 // * * * * * * * * * * * * * * * Ostream Operator * * * * * * * * * * * * * //
55 
57 {
58  r.write(os);
59  return os;
60 }
61 
62 
63 // ************************************************************************* //
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
A wordList with hashed indices for faster lookup by name.
Reaction base-class holding the specie names and coefficients.
Definition: reaction.H:57
void write(Ostream &) const
Write.
Definition: reaction.C:93
const speciesTable & species() const
Return the specie list.
Definition: reactionI.H:48
const List< specieCoeffs > & lhs() const
Return the components of the left hand side.
Definition: reactionI.H:36
const List< specieCoeffs > & rhs() const
Return the components of the right hand side.
Definition: reactionI.H:42
const word & name() const
Return the name of the reaction.
Definition: reactionI.H:30
A class for handling words, derived from string.
Definition: word.H:62
Ostream & operator<<(Ostream &os, const fvConstraints &constraints)