All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
singleStepCombustionI.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 "singleStepCombustion.H"
27 
28 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32 namespace combustionModels
33 {
34 
35 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
36 
37 template<class ReactionThermo, class ThermoType>
38 inline const Foam::Reaction<ThermoType>&
40 {
41  return reaction_();
42 }
43 
44 
45 template<class ReactionThermo, class ThermoType>
46 inline const dimensionedScalar
48 {
49  return stoicRatio_;
50 }
51 
52 
53 template<class ReactionThermo, class ThermoType>
54 inline const dimensionedScalar
56 {
57  return s_;
58 }
59 
60 
61 template<class ReactionThermo, class ThermoType>
62 inline const dimensionedScalar
64 {
65  return qFuel_;
66 }
67 
68 
69 template<class ReactionThermo, class ThermoType>
70 inline const List<scalar>&
72 {
73  return specieStoichCoeffs_;
74 }
75 
76 
77 template<class ReactionThermo, class ThermoType>
80 (
81  const label index
82 ) const
83 {
84  return fres_[index];
85 }
86 
87 
88 template<class ReactionThermo, class ThermoType>
89 inline label
91 {
92  return inertIndex_;
93 }
94 
95 
96 template<class ReactionThermo, class ThermoType>
97 inline label
99 {
100  return fuelIndex_;
101 }
102 
103 
104 template<class ReactionThermo, class ThermoType>
105 inline const List<int>&
107 {
108  return specieProd_;
109 }
110 
111 
112 template<class ReactionThermo, class ThermoType>
113 inline const scalarList&
115 {
116  return Yprod0_;
117 }
118 
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 } // End namespace combustionModels
123 } // End namespace Foam
124 
125 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
label fuelIndex() const
Return the fuel specie index.
const dimensionedScalar stoicRatio() const
Return the stoichiometric air-fuel mass ratio.
const scalarList & Yprod0() const
Return the list of products mass concentrations.
const List< scalar > & specieStoichCoeffs() const
Return the stoichiometric coefficient for the reaction.
label inertIndex() const
Return the inert specie index.
const dimensionedScalar qFuel() const
Return the heat of combustion [J/Kg].
const Reaction< ThermoType > & reaction() const
Return the single step reaction.
tmp< volScalarField > fres(const label index) const
Return the list of components residual.
const dimensionedScalar s() const
Return the Stoichiometric oxygen-fuel mass ratio.
A class for managing temporary objects.
Definition: PtrList.H:53
const List< int > & specieProd() const
Return the list to indicate if specie is produced/consumed.
Namespace for OpenFOAM.