psiMulticomponentThermo.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-2022 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::psiMulticomponentThermo
26 
27 Description
28  Base-class for multi-component fluid thermodynamic properties based on
29  compressibility.
30 
31 See also
32  Foam::basicThermo
33 
34 SourceFiles
35  psiMulticomponentThermo.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef psiMulticomponentThermo_H
40 #define psiMulticomponentThermo_H
41 
42 #include "psiThermo.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class psiMulticomponentThermo Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
56  virtual public psiThermo,
57  virtual public fluidMulticomponentThermo
58 {
59 public:
60 
61  // Public Classes
62 
63  //- Forward declare the implementation class
64  class implementation;
65 
66  //- Forward declare the composite class
67  class composite;
68 
69 
70  //- Runtime type information
71  TypeName("psiMulticomponentThermo");
72 
73 
74  //- Declare run-time constructor selection tables
76  (
77  autoPtr,
79  fvMesh,
80  (const fvMesh& mesh, const word& phaseName),
81  (mesh, phaseName)
82  );
83 
84 
85  // Selectors
86 
87  //- Standard selection based on fvMesh
89  (
90  const fvMesh&,
92  );
93 
94 
95  //- Destructor
96  virtual ~psiMulticomponentThermo();
97 };
98 
99 
100 /*---------------------------------------------------------------------------*\
101  Class psiMulticomponentThermo::implementation Declaration
102 \*---------------------------------------------------------------------------*/
103 
105 :
106  virtual public psiMulticomponentThermo
107 {
108 public:
109 
110  // Constructors
111 
112  //- Construct from mesh and phase name
113  implementation(const fvMesh&, const word& phaseName);
114 
115 
116  //- Destructor
117  virtual ~implementation();
118 };
119 
120 
121 /*---------------------------------------------------------------------------*\
122  Class psiMulticomponentThermo::composite Declaration
123 \*---------------------------------------------------------------------------*/
124 
126 :
132 {
133 public:
134 
135  // Constructors
136 
137  //- Construct from mesh and phase name
138  composite
139  (
140  const fvMesh& mesh,
141  const word& phaseName
142  )
143  :
149  {}
150 };
151 
152 
153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
154 
155 } // End namespace Foam
156 
157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
158 
159 #endif
160 
161 // ************************************************************************* //
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
virtual const fvMesh & mesh() const
Return const access to the mesh.
Definition: basicThermo.H:484
virtual const word & phaseName() const
Phase name.
Definition: basicThermo.H:490
Base-class for fluid and solid thermodynamic properties.
Definition: basicThermo.H:78
virtual const fvMesh & mesh() const =0
Return const access to the mesh.
virtual const word & phaseName() const =0
Phase name.
Base-class for multi-component fluid thermodynamic properties.
Base-class for fluid thermodynamic properties.
Definition: fluidThermo.H:57
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:101
composite(const fvMesh &mesh, const word &phaseName)
Construct from mesh and phase name.
implementation(const fvMesh &, const word &phaseName)
Construct from mesh and phase name.
Base-class for multi-component fluid thermodynamic properties based on compressibility.
static autoPtr< psiMulticomponentThermo > New(const fvMesh &, const word &phaseName=word::null)
Standard selection based on fvMesh.
virtual ~psiMulticomponentThermo()
Destructor.
TypeName("psiMulticomponentThermo")
Runtime type information.
declareRunTimeSelectionTable(autoPtr, psiMulticomponentThermo, fvMesh,(const fvMesh &mesh, const word &phaseName),(mesh, phaseName))
Declare run-time constructor selection tables.
Base-class for fluid thermodynamic properties based on compressibility.
Definition: psiThermo.H:54
A class for handling words, derived from string.
Definition: word.H:62
static const word null
An empty word.
Definition: word.H:77
Namespace for OpenFOAM.