basicMultiComponentMixtureI.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 | Copyright (C) 2011-2015 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 inline const Foam::speciesTable&
28 {
29  return species_;
30 }
31 
32 
35 {
36  return Y_;
37 }
38 
39 
42 {
43  return Y_;
44 }
45 
46 
48 {
49  return Y_[i];
50 }
51 
52 
54 (
55  const label i
56 ) const
57 {
58  return Y_[i];
59 }
60 
61 
63 (
64  const word& specieName
65 )
66 {
67  return Y_[species_[specieName]];
68 }
69 
70 
72 (
73  const word& specieName
74 ) const
75 {
76  return Y_[species_[specieName]];
77 }
78 
79 
81 (
82  const word& specieName
83 ) const
84 {
85  return species_.contains(specieName);
86 }
87 
88 
89 // ************************************************************************* //
PtrList< volScalarField > Y_
Species mass fractions.
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:61
A class for handling words, derived from string.
Definition: word.H:59
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
PtrList< volScalarField > & Y()
Return the mass-fraction fields.
speciesTable species_
Table of specie names.
A wordList with hashed indices for faster lookup by name.
bool contains(const word &specieName) const
Does the mixture include this specie?
bool contains(const word &) const
Does the list contain the specified name.
const speciesTable & species() const
Return the table of species.