singleStepReactingMixtureI.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
29 
30 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
31 
32 template<class ThermoType>
33 inline const Foam::dimensionedScalar
35 {
36  return stoicRatio_;
37 }
38 
39 
40 template<class ThermoType>
41 inline const Foam::dimensionedScalar
43 {
44  return s_;
45 }
46 
47 
48 template<class ThermoType>
49 inline const Foam::dimensionedScalar
51 {
52  return qFuel_;
53 }
54 
55 
56 template<class ThermoType>
57 inline const Foam::List<Foam::scalar>&
59 {
60  return specieStoichCoeffs_;
61 }
62 
63 
64 template<class ThermoType>
67 (
68  const label index
69 ) const
70 {
71  return fres_[index];
72 }
73 
74 
75 template<class ThermoType>
76 inline Foam::label
78 {
79  return inertIndex_;
80 }
81 
82 
83 template<class ThermoType>
84 inline Foam::label
86 {
87  return fuelIndex_;
88 }
89 
90 
91 template<class ThermoType>
92 inline const Foam::List<int>&
94 {
95  return specieProd_;
96 }
97 
98 
99 template<class ThermoType>
100 inline const Foam::scalarList&
102 {
103  return Yprod0_;
104 }
105 
106 
107 // ************************************************************************* //
Foam::singleStepReactingMixture::Yprod0
const scalarList & Yprod0() const
Return the list of products mass concentrations.
Definition: singleStepReactingMixtureI.H:101
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::singleStepReactingMixture::specieProd
const List< int > & specieProd() const
Return the list to indicate if specie is produced/consumed.
Definition: singleStepReactingMixtureI.H:93
Foam::singleStepReactingMixture::qFuel
const dimensionedScalar qFuel() const
Return the heat of combustion [J/Kg].
Definition: singleStepReactingMixtureI.H:50
Foam::singleStepReactingMixture::s
const dimensionedScalar s() const
Return the Stoichiometric oxygen-fuel mass ratio.
Definition: singleStepReactingMixtureI.H:42
Foam::singleStepReactingMixture::fres
tmp< volScalarField > fres(const label index) const
Return the list of components residual.
Definition: singleStepReactingMixtureI.H:67
Foam::singleStepReactingMixture::fuelIndex
label fuelIndex() const
Return the fuel specie index.
Definition: singleStepReactingMixtureI.H:85
Foam::dimensioned
Generic dimensioned Type class.
Definition: dimensionedScalarFwd.H:42
Foam::singleStepReactingMixture::inertIndex
label inertIndex() const
Return the inert specie index.
Definition: singleStepReactingMixtureI.H:77
singleStepReactingMixture.H
Foam::List
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: BitOps.H:63
Foam::singleStepReactingMixture::specieStoichCoeffs
const List< scalar > & specieStoichCoeffs() const
Return the stoichiometric coefficient for the reaction.
Definition: singleStepReactingMixtureI.H:58
Foam::singleStepReactingMixture::stoicRatio
const dimensionedScalar stoicRatio() const
Return the stoichiometric air-fuel mass ratio.
Definition: singleStepReactingMixtureI.H:34