bHomogeneousMixture.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) 2025-2026 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 Class
25  Foam::bHomogeneousMixture
26 
27 Description
28  Burnt gas mixture for homogeneous lean, stoichiometric or rich conditions
29 
30 SourceFiles
31  bHomogeneousMixture.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef bHomogeneousMixture_H
36 #define bHomogeneousMixture_H
37 
38 #include "bMixture.H"
39 #include "speciesTable.H"
40 #include "boolList.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class bHomogeneousMixture Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public bMixture
54 {
55 
56 public:
57 
58  //- Runtime type information
59  ClassName("bHomogeneous");
60 
61 
62  // Constructors
63 
64  //- Construct from a dictionary
66 
67  //- Disallow default bitwise copy construction
69 
70 
71  //- Destructor
72  virtual ~bHomogeneousMixture()
73  {}
74 
75 
76  // Member Functions
77 
78  //- Return the mixture type name
79  virtual const word& mixtureType() const
80  {
81  return typeName;
82  }
83 
84  //- Return the table of species
85  const speciesTable& species() const
86  {
87  return speciesTable::null;
88  }
89 
90  //- Access the specie active flags
91  const boolList& speciesActive() const
92  {
94  return boolList::null();
95  }
96 
97  //- Access the specie active flags
99  {
101  return const_cast<boolList&>(boolList::null());
102  }
103 
104  //- Read dictionary
105  void read(const dictionary&);
106 
107 
108  // Member Operators
109 
110  //- Disallow default bitwise assignment
111  void operator=(const bHomogeneousMixture&) = delete;
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace Foam
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 #endif
122 
123 // ************************************************************************* //
static const List< bool > & null()
Return a null List.
Definition: ListI.H:118
Burnt gas mixture for homogeneous lean, stoichiometric or rich conditions.
void operator=(const bHomogeneousMixture &)=delete
Disallow default bitwise assignment.
ClassName("bHomogeneous")
Runtime type information.
virtual const word & mixtureType() const
Return the mixture type name.
const boolList & speciesActive() const
Access the specie active flags.
bHomogeneousMixture(const dictionary &)
Construct from a dictionary.
void read(const dictionary &)
Read dictionary.
const speciesTable & species() const
Return the table of species.
virtual ~bHomogeneousMixture()
Destructor.
Burnt gas mixture base class.
Definition: bMixture.H:49
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
A wordList with hashed indices for faster lookup by name.
static const hashedWordList null
An empty hashedWordList.
A class for handling words, derived from string.
Definition: word.H:63
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:381
Namespace for OpenFOAM.
String typeName(const std::type_info &info)
Return the un-mangled name given the standard type info.