All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pureMixture.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 Class
25  Foam::pureMixture
26 
27 Description
28  Foam::pureMixture
29 
30 SourceFiles
31  pureMixture.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef pureMixture_H
36 #define pureMixture_H
37 
38 #include "basicMixture.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class pureMixture Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 template<class ThermoType>
50 class pureMixture
51 :
52  public basicMixture
53 {
54 
55 public:
56 
57  //- The type of thermodynamics this mixture is instantiated for
58  typedef ThermoType thermoType;
59 
60  //- Mixing type for thermodynamic properties
61  typedef ThermoType thermoMixtureType;
62 
63  //- Mixing type for transport properties
64  typedef ThermoType transportMixtureType;
65 
66 
67 private:
68 
69  // Private Data
70 
71  ThermoType mixture_;
72 
73 
74 public:
75 
76  // Constructors
77 
78  //- Construct from dictionary, mesh and phase name
79  pureMixture(const dictionary&, const fvMesh&, const word&);
80 
81  //- Disallow default bitwise copy construction
82  pureMixture(const pureMixture<ThermoType>&) = delete;
83 
84 
85  // Member Functions
86 
87  //- Return the instantiated type name
88  static word typeName()
89  {
90  return "pureMixture<" + ThermoType::typeName() + '>';
91  }
92 
93  const thermoMixtureType& cellThermoMixture(const label) const
94  {
95  return mixture_;
96  }
97 
98  const thermoMixtureType& patchFaceThermoMixture
99  (
100  const label,
101  const label
102  ) const
103  {
104  return mixture_;
105  }
107  const transportMixtureType& cellTransportMixture(const label) const
108  {
109  return mixture_;
110  }
111 
112  const transportMixtureType& patchFaceTransportMixture
113  (
114  const label,
115  const label
116  ) const
117  {
118  return mixture_;
119  }
120 
121  const transportMixtureType& cellTransportMixture
122  (
123  const label,
124  const thermoMixtureType&
125  ) const
126  {
127  return mixture_;
128  }
129 
130  const transportMixtureType& patchFaceTransportMixture
131  (
132  const label,
133  const label,
134  const thermoMixtureType&
135  ) const
136  {
137  return mixture_;
138  }
139 
140  //- Read dictionary
141  void read(const dictionary&);
142 
143 
144  // Member Operators
145 
146  //- Disallow default bitwise assignment
147  void operator=(const pureMixture<ThermoType>&) = delete;
148 };
149 
150 
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
152 
153 } // End namespace Foam
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
156 
157 #ifdef NoRepository
158  #include "pureMixture.C"
159 #endif
160 
161 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
162 
163 #endif
164 
165 // ************************************************************************* //
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
ThermoType thermoMixtureType
Mixing type for thermodynamic properties.
Definition: pureMixture.H:60
const transportMixtureType & cellTransportMixture(const label) const
Definition: pureMixture.H:106
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
const thermoMixtureType & patchFaceThermoMixture(const label, const label) const
Definition: pureMixture.H:98
pureMixture(const dictionary &, const fvMesh &, const word &)
Construct from dictionary, mesh and phase name.
Definition: pureMixture.C:33
Foam::pureMixture.
Definition: pureMixture.H:49
A class for handling words, derived from string.
Definition: word.H:59
static word typeName()
Return the instantiated type name.
Definition: pureMixture.H:87
void operator=(const pureMixture< ThermoType > &)=delete
Disallow default bitwise assignment.
const thermoMixtureType & cellThermoMixture(const label) const
Definition: pureMixture.H:92
Foam::basicMixture.
Definition: basicMixture.H:50
ThermoType transportMixtureType
Mixing type for transport properties.
Definition: pureMixture.H:63
ThermoType thermoType
The type of thermodynamics this mixture is instantiated for.
Definition: pureMixture.H:57
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
void read(const dictionary &)
Read dictionary.
Definition: pureMixture.C:47
const transportMixtureType & patchFaceTransportMixture(const label, const label) const
Definition: pureMixture.H:112
Namespace for OpenFOAM.