basicMultiComponentMixtureI.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 
26 inline const Foam::speciesTable&
28 {
29  return species_;
30 }
31 
32 
34 (
35  const word& specieName
36 ) const
37 {
38  return species_.contains(specieName);
39 }
40 
41 
43 {
44  return active_[speciei];
45 }
46 
47 
49 {
50  return active_;
51 }
52 
53 
55 {
56  active_[speciei] = true;
57 }
58 
59 
61 {
62  active_[speciei] = false;
63 }
64 
65 
68 {
69  return Y_;
70 }
71 
72 
75 {
76  return Y_;
77 }
78 
79 
81 {
82  return Y_[i];
83 }
84 
85 
87 (
88  const label i
89 ) const
90 {
91  return Y_[i];
92 }
93 
94 
96 (
97  const word& specieName
98 )
99 {
100  return Y_[species_[specieName]];
101 }
102 
103 
105 (
106  const word& specieName
107 ) const
108 {
109  return Y_[species_[specieName]];
110 }
111 
112 
113 // ************************************************************************* //
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_
Species mass fractions.
const speciesTable & species() const
Return the table of species.
PtrList< volScalarField > & Y()
Return the mass-fraction fields.
List< bool > active_
List of specie active flags.
void setInactive(label speciei)
Set speciei inactive.
speciesTable species_
Table of specie names.
A class for handling words, derived from string.
Definition: word.H:59
void setActive(label speciei)
Set speciei active.
const List< bool > & active() const
Return the bool list of active species.
A wordList with hashed indices for faster lookup by name.
A templated 1D list of pointers to objects of type <T>, where the size of the array is known and used...
Definition: List.H:70
bool contains(const word &) const
Does the list contain the specified name.
bool contains(const word &specieName) const
Does the mixture include this specie?