All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
basicSpecieMixtureI.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-2020 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  return species_;
29 }
30 
31 
32 inline bool Foam::basicSpecieMixture::contains(const word& specieName) const
33 {
34  return species_.found(specieName);
35 }
36 
37 
39 {
40  return defaultSpecieIndex_;
41 }
42 
43 
44 inline bool Foam::basicSpecieMixture::active(label speciei) const
45 {
46  return active_[speciei];
47 }
48 
49 
51 {
52  return active_;
53 }
54 
55 
56 inline void Foam::basicSpecieMixture::setActive(label speciei) const
57 {
58  active_[speciei] = true;
59  const_cast<volScalarField&>(Y_[speciei]).writeOpt() = IOobject::AUTO_WRITE;
60 }
61 
62 
63 inline void Foam::basicSpecieMixture::setInactive(label speciei) const
64 {
65  active_[speciei] = false;
66  const_cast<volScalarField&>(Y_[speciei]).writeOpt() = IOobject::NO_WRITE;
67 }
68 
69 
70 inline bool Foam::basicSpecieMixture::solve(label speciei) const
71 {
72  return speciei != defaultSpecieIndex_ && active_[speciei];
73 }
74 
75 
77 {
78  return Y_;
79 }
80 
81 
84 {
85  return Y_;
86 }
87 
88 
90 {
91  return Y_[i];
92 }
93 
94 
96 (
97  const label i
98 ) const
99 {
100  return Y_[i];
101 }
102 
103 
105 (
106  const word& specieName
107 )
108 {
109  return Y_[species_[specieName]];
110 }
111 
112 
114 (
115  const word& specieName
116 ) const
117 {
118  return Y_[species_[specieName]];
119 }
120 
121 
123 (
124  const volScalarField& Yi
125 ) const
126 {
127  return species_[Yi.name()];
128 }
129 
130 
131 // ************************************************************************* //
void setInactive(label speciei) const
Set speciei inactive.
bool solve(label speciei) const
Return true if the specie should be solved for.
PtrList< volScalarField > Y_
Species mass fractions.
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 word & name() const
Return name.
Definition: IOobject.H:303
bool found(const word &) const
Does the list contain the specified name.
label index(const volScalarField &Yi) const
Return the specie index of the given mass-fraction field.
Generic GeometricField class.
speciesTable species_
Table of specie names.
List< bool > active_
List of specie active flags.
A class for handling words, derived from string.
Definition: word.H:59
bool contains(const word &specieName) const
Does the mixture include this specie?
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
void setActive(label speciei) const
Set speciei active.
PtrList< volScalarField > & Y()
Return the mass-fraction fields.
label defaultSpecieIndex_
The index of the default specie.
const List< bool > & active() const
Return the bool list of active species.
const speciesTable & species() const
Return the table of species.
label defaultSpecie() const
Return the index of the default specie.