pureMixture.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2017 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  const ThermoType& mixture() const
77  {
78  return mixture_;
79  }
80 
81  const ThermoType& cellMixture(const label) const
82  {
83  return mixture_;
84  }
85 
86  const ThermoType& patchFaceMixture
87  (
88  const label,
89  const label
90  ) const
91  {
92  return mixture_;
93  }
94 
95  const ThermoType& cellVolMixture
96  (
97  const scalar,
98  const scalar,
99  const label
100  ) const
101  {
102  return mixture_;
103  }
104 
105  const ThermoType& patchFaceVolMixture
106  (
107  const scalar,
108  const scalar,
109  const label,
110  const label
111  ) const
112  {
113  return mixture_;
114  }
115 
116  //- Read dictionary
117  void read(const dictionary&);
118 };
119 
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 } // End namespace Foam
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
126 
127 #ifdef NoRepository
128  #include "pureMixture.C"
129 #endif
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************************************************************* //
const ThermoType & mixture() const
Definition: pureMixture.H:75
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:137
const ThermoType & cellMixture(const label) const
Definition: pureMixture.H:80
Foam::pureMixture.
Definition: pureMixture.H:49
A class for handling words, derived from string.
Definition: word.H:59
Foam::basicMixture.
Definition: basicMixture.H:49
const ThermoType & patchFaceVolMixture(const scalar, const scalar, const label, const label) const
Definition: pureMixture.H:105
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:86
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:95
Namespace for OpenFOAM.