singleStepReactingMixtureI.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-2018 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 
27 
28 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
29 
30 template<class ThermoType>
31 inline const Foam::dimensionedScalar
33 {
34  return stoicRatio_;
35 }
36 
37 
38 template<class ThermoType>
39 inline const Foam::dimensionedScalar
41 {
42  return s_;
43 }
44 
45 
46 template<class ThermoType>
47 inline const Foam::dimensionedScalar
49 {
50  return qFuel_;
51 }
52 
53 
54 template<class ThermoType>
55 inline const Foam::List<Foam::scalar>&
57 {
58  return specieStoichCoeffs_;
59 }
60 
61 
62 template<class ThermoType>
65 (
66  const label index
67 ) const
68 {
69  return fres_[index];
70 }
71 
72 
73 template<class ThermoType>
74 inline Foam::label
76 {
77  return inertIndex_;
78 }
79 
80 
81 template<class ThermoType>
82 inline Foam::label
84 {
85  return fuelIndex_;
86 }
87 
88 
89 template<class ThermoType>
90 inline const Foam::List<int>&
92 {
93  return specieProd_;
94 }
95 
96 
97 template<class ThermoType>
98 inline const Foam::scalarList&
100 {
101  return Yprod0_;
102 }
103 
104 
105 // ************************************************************************* //
const List< int > & specieProd() const
Return the list to indicate if specie is produced/consumed.
const dimensionedScalar s() const
Return the Stoichiometric oxygen-fuel mass ratio.
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
const dimensionedScalar qFuel() const
Return the heat of combustion [J/Kg].
tmp< volScalarField > fres(const label index) const
Return the list of components residual.
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:60
Generic dimensioned Type class.
label fuelIndex() const
Return the fuel specie index.
label inertIndex() const
Return the inert specie index.
const scalarList & Yprod0() const
Return the list of products mass concentrations.
const List< scalar > & specieStoichCoeffs() const
Return the stoichiometric coefficient for the reaction.
const dimensionedScalar stoicRatio() const
Return the stoichiometric air-fuel mass ratio.
A class for managing temporary objects.
Definition: PtrList.H:53