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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2017 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::pureMixture
28 
29 Description
30  Foam::pureMixture
31 
32 SourceFiles
33  pureMixture.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef pureMixture_H
38 #define pureMixture_H
39 
40 #include "basicMixture.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class pureMixture Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class ThermoType>
52 class pureMixture
53 :
54  public basicMixture
55 {
56  // Private data
57 
58  ThermoType mixture_;
59 
60  //- Construct as copy (not implemented)
61  pureMixture(const pureMixture<ThermoType>&);
62 
63 
64 public:
65 
66  //- The type of thermodynamics this mixture is instantiated for
67  typedef ThermoType thermoType;
68 
69 
70  // Constructors
71 
72  //- Construct from dictionary, mesh and phase name
73  pureMixture(const dictionary&, const fvMesh&, const word&);
74 
75 
76  // Member functions
77 
78  //- Return the instantiated type name
79  static word typeName()
80  {
81  return "pureMixture<" + ThermoType::typeName() + '>';
82  }
83 
84  const ThermoType& mixture() const
85  {
86  return mixture_;
87  }
88 
89  const ThermoType& cellMixture(const label) const
90  {
91  return mixture_;
92  }
93 
94  const ThermoType& patchFaceMixture
95  (
96  const label,
97  const label
98  ) const
99  {
100  return mixture_;
101  }
102 
103  const ThermoType& cellVolMixture
104  (
105  const scalar,
106  const scalar,
107  const label
108  ) const
109  {
110  return mixture_;
111  }
112 
113  const ThermoType& patchFaceVolMixture
114  (
115  const scalar,
116  const scalar,
117  const label,
118  const label
119  ) const
120  {
121  return mixture_;
122  }
123 
124  //- Read dictionary
125  void read(const dictionary&);
126 };
127 
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
134 
135 #ifdef NoRepository
136  #include "pureMixture.C"
137 #endif
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 #endif
142 
143 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::pureMixture
Foam::pureMixture.
Definition: InterfaceCompositionModel.H:49
Foam::pureMixture::cellMixture
const ThermoType & cellMixture(const label) const
Definition: pureMixture.H:88
Foam::pureMixture::cellVolMixture
const ThermoType & cellVolMixture(const scalar, const scalar, const label) const
Definition: pureMixture.H:103
Foam::pureMixture::thermoType
ThermoType thermoType
The type of thermodynamics this mixture is instantiated for.
Definition: pureMixture.H:66
Foam::pureMixture::typeName
static word typeName()
Return the instantiated type name.
Definition: pureMixture.H:78
Foam::pureMixture::mixture
const ThermoType & mixture() const
Definition: pureMixture.H:83
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:84
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::pureMixture::read
void read(const dictionary &)
Read dictionary.
Definition: pureMixture.C:49
Foam::pureMixture::patchFaceMixture
const ThermoType & patchFaceMixture(const label, const label) const
Definition: pureMixture.H:94
Foam::pureMixture::patchFaceVolMixture
const ThermoType & patchFaceVolMixture(const scalar, const scalar, const label, const label) const
Definition: pureMixture.H:113
basicMixture.H
pureMixture.C