UHomogeneousMixture.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::UHomogeneousMixture
26 
27 Description
28  Templated unburnt gas mixture for homogeneous lean, stoichiometric or rich
29  conditions
30 
31 See also
32  Foam::uHomogeneousMixture
33 
34 SourceFiles
35  UHomogeneousMixture.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef UHomogeneousMixture_H
40 #define UHomogeneousMixture_H
41 
42 #include "uHomogeneousMixture.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class UHomogeneousMixture Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 template<class ThermoType>
55 :
56  public uHomogeneousMixture
57 {
58 public:
59 
60  // Public Typedefs
61 
62  //- The type of thermodynamics this mixture is instantiated for
63  typedef ThermoType thermoType;
64 
65  //- Mixing type for thermodynamic properties
66  typedef ThermoType thermoMixtureType;
67 
68  //- Mixing type for transport properties
69  typedef ThermoType transportMixtureType;
70 
71 
72 private:
73 
74  // Private Data
75 
76  //- Reactant thermodynamic model
77  thermoType reactants_;
78 
79 
80 public:
81 
82  // Constructors
83 
84  //- Construct from a dictionary
86 
87  //- Disallow default bitwise copy construction
89 
90 
91  // Member Functions
92 
93  //- Return the instantiated type name
94  static word typeName()
95  {
96  return
98  + '<' + ThermoType::typeName() + '>';
99  }
100 
101  inline const ThermoType& specieThermo(const label speciei) const
102  {
103  return reactants_;
104  }
105 
106  //- Return the mixture for thermodynamic properties
108  (
109  const scalarFieldListSlice&
110  ) const
111  {
112  return reactants_;
113  }
114 
115  //- Return the mixture for transport properties
117  (
118  const scalarFieldListSlice&
119  ) const
120  {
121  return reactants_;
122  }
123 
124  //- Return the mixture for transport properties
126  (
127  const scalarFieldListSlice&,
128  const thermoMixtureType&
129  ) const
130  {
131  return reactants_;
132  }
133 
134  //- Read dictionary
135  void read(const dictionary&);
136 
137 
138  // Member Operators
139 
140  //- Disallow default bitwise assignment
141  void operator=(const UHomogeneousMixture<ThermoType>&) = delete;
142 };
143 
144 
145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
146 
147 } // End namespace Foam
148 
149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
150 
151 #ifdef NoRepository
152  #include "UHomogeneousMixture.C"
153 #endif
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 #endif
158 
159 // ************************************************************************* //
Templated unburnt gas mixture for homogeneous lean, stoichiometric or rich conditions.
const ThermoType & specieThermo(const label speciei) const
const transportMixtureType & transportMixture(const scalarFieldListSlice &) const
Return the mixture for transport properties.
void operator=(const UHomogeneousMixture< ThermoType > &)=delete
Disallow default bitwise assignment.
ThermoType thermoType
The type of thermodynamics this mixture is instantiated for.
static word typeName()
Return the instantiated type name.
ThermoType transportMixtureType
Mixing type for transport properties.
ThermoType thermoMixtureType
Mixing type for thermodynamic properties.
void read(const dictionary &)
Read dictionary.
UHomogeneousMixture(const dictionary &)
Construct from a dictionary.
const thermoMixtureType & thermoMixture(const scalarFieldListSlice &) const
Return the mixture for thermodynamic properties.
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Unburnt gas mixture for homogeneous lean, stoichiometric or rich conditions.
A class for handling words, derived from string.
Definition: word.H:63
Namespace for OpenFOAM.
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
String typeName(const std::type_info &info)
Return the un-mangled name given the standard type info.