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-2019 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  // Private Data
55 
56  ThermoType mixture_;
57 
58  //- Construct as copy (not implemented)
60 
61 
62 public:
63 
64  //- The type of thermodynamics this mixture is instantiated for
65  typedef ThermoType thermoType;
66 
67 
68  // Constructors
69 
70  //- Construct from dictionary, mesh and phase name
71  pureMixture(const dictionary&, const fvMesh&, const word&);
72 
73 
74  // Member Functions
75 
76  //- Return the instantiated type name
77  static word typeName()
78  {
79  return "pureMixture<" + ThermoType::typeName() + '>';
80  }
81 
82  const ThermoType& mixture() const
83  {
84  return mixture_;
85  }
86 
87  const ThermoType& cellMixture(const label) const
88  {
89  return mixture_;
90  }
91 
92  const ThermoType& patchFaceMixture
93  (
94  const label,
95  const label
96  ) const
97  {
98  return mixture_;
99  }
100 
101  const ThermoType& cellVolMixture
102  (
103  const scalar,
104  const scalar,
105  const label
106  ) const
107  {
108  return mixture_;
109  }
110 
111  const ThermoType& patchFaceVolMixture
112  (
113  const scalar,
114  const scalar,
115  const label,
116  const label
117  ) const
118  {
119  return mixture_;
120  }
121 
122  //- Read dictionary
123  void read(const dictionary&);
124 };
125 
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 } // End namespace Foam
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
132 
133 #ifdef NoRepository
134  #include "pureMixture.C"
135 #endif
136 
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 
139 #endif
140 
141 // ************************************************************************* //
const ThermoType & mixture() const
Definition: pureMixture.H:81
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
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
const ThermoType & cellMixture(const label) const
Definition: pureMixture.H:86
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:76
Foam::basicMixture.
Definition: basicMixture.H:50
const ThermoType & patchFaceVolMixture(const scalar, const scalar, const label, const label) const
Definition: pureMixture.H:111
ThermoType thermoType
The type of thermodynamics this mixture is instantiated for.
Definition: pureMixture.H:64
const ThermoType & patchFaceMixture(const label, const label) const
Definition: pureMixture.H:92
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
void read(const dictionary &)
Read dictionary.
Definition: pureMixture.C:47
const ThermoType & cellVolMixture(const scalar, const scalar, const label) const
Definition: pureMixture.H:101
Namespace for OpenFOAM.