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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 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 
28 inline const Foam::speciesTable&
30 {
31  return species_;
32 }
33 
34 
36 (
37  const word& specieName
38 ) const
39 {
40  return species_.found(specieName);
41 }
42 
43 
44 inline bool Foam::basicMultiComponentMixture::active(label speciei) const
45 {
46  return active_[speciei];
47 }
48 
49 
51 {
52  return active_;
53 }
54 
55 
57 {
58  active_[speciei] = true;
59 }
60 
61 
63 {
64  active_[speciei] = false;
65 }
66 
67 
70 {
71  return Y_;
72 }
73 
74 
77 {
78  return Y_;
79 }
80 
81 
83 {
84  return Y_[i];
85 }
86 
87 
89 (
90  const label i
91 ) const
92 {
93  return Y_[i];
94 }
95 
96 
98 (
99  const word& specieName
100 )
101 {
102  return Y_[species_[specieName]];
103 }
104 
105 
107 (
108  const word& specieName
109 ) const
110 {
111  return Y_[species_[specieName]];
112 }
113 
114 
115 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::basicMultiComponentMixture::species
const speciesTable & species() const
Return the table of species.
Definition: basicMultiComponentMixtureI.H:29
Foam::basicMultiComponentMixture::setInactive
void setInactive(label speciei)
Set speciei inactive.
Definition: basicMultiComponentMixtureI.H:62
Foam::basicMultiComponentMixture::Y
PtrList< volScalarField > & Y()
Return the mass-fraction fields.
Definition: basicMultiComponentMixtureI.H:69
Foam::basicMultiComponentMixture::active
const List< bool > & active() const
Return the bool list of active species.
Definition: basicMultiComponentMixtureI.H:50
Foam::hashedWordList
A wordList with hashed named lookup, which can be faster in some situations than using the normal lis...
Definition: hashedWordList.H:54
Foam::PtrList
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers....
Definition: List.H:59
Foam::basicMultiComponentMixture::setActive
void setActive(label speciei)
Set speciei active.
Definition: basicMultiComponentMixtureI.H:56
Foam::basicMultiComponentMixture::contains
bool contains(const word &specieName) const
Does the mixture include this specie?
Definition: basicMultiComponentMixtureI.H:36
Foam::basicMultiComponentMixture::species_
speciesTable species_
Table of specie names.
Definition: basicMultiComponentMixture.H:70
Foam::List< bool >
Foam::GeometricField< scalar, fvPatchField, volMesh >