rhoFluidThermo.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-2026 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::rhoFluidThermo
26 
27 Description
28  Base-class for fluid thermodynamic properties based on density.
29 
30 See also
31  Foam::basicThermo
32 
33 SourceFiles
34  rhoFluidThermo.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef rhoFluidThermo_H
39 #define rhoFluidThermo_H
40 
41 #include "RhoFluidThermo.H"
42 #include "pureThermo.H"
43 #include "rhoThermo.H"
44 #include "fluidThermo.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class rhoFluidThermo Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class rhoFluidThermo
56 :
57  virtual public rhoThermo,
58  virtual public fluidThermo
59 {
60 public:
61 
62  // Public Classes
63 
64  //- Forward declare the composite class
65  class composite;
66 
67 
68  // Public Typedefs
69 
70  //- The derived type
71  template<class MixtureType>
72  using DerivedThermoType =
74 
75  //- The derived name
76  static word derivedThermoName()
77  {
78  return "heRhoThermo";
79  }
80 
81 
82  //- Runtime type information
83  TypeName("rhoFluidThermo");
84 
85 
86  //- Declare run-time constructor selection table
88  (
89  autoPtr,
91  fvMesh,
92  (const fvMesh& mesh, const word& phaseName),
93  (mesh, phaseName)
94  );
95 
96 
97  // Selectors
98 
99  //- Standard selection based on fvMesh
101  (
102  const fvMesh&,
103  const word& phaseName=word::null
104  );
105 
106 
107  //- Destructor
108  virtual ~rhoFluidThermo();
109 
110 
111  // Member Functions
112 
113  // Derived Thermodynamic Properties
114 
115  //- Rename and return the thermodynamic density field [kg/m^3]
116  // This is used by solvers which create a separate continuity rho
117  virtual tmp<volScalarField> renameRho();
118 
119  //- Update the density corresponding to the given pressure change
120  // Used to update the density field following pressure solution
121  virtual void correctRho(const volScalarField& dp);
122 };
123 
124 
125 /*---------------------------------------------------------------------------*\
126  Class rhoFluidThermo::composite Declaration
127 \*---------------------------------------------------------------------------*/
128 
130 :
132  public pureThermo,
135  public rhoFluidThermo
136 {
137 public:
138 
139  // Constructors
140 
141  //- Construct from dictionary, mesh and phase name
142  composite
143  (
144  const dictionary& dict,
145  const fvMesh& mesh,
146  const word& phaseName
147  )
148  :
152  {}
153 
154  //- Construct from dictionary, mesh and phase name
155  template<class MixtureType>
156  composite
157  (
158  const dictionary& dict,
159  const MixtureType& mixture,
160  const fvMesh& mesh,
161  const word& phaseName
162  )
163  :
167  {}
168 };
169 
170 
171 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
172 
173 } // End namespace Foam
174 
175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
176 
177 #endif
178 
179 // ************************************************************************* //
Generic GeometricField class.
Thermo implementation based on density.
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:539
virtual const word & phaseName() const
Phase name.
Definition: basicThermo.H:545
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.
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Base-class for fluid thermodynamic properties.
Definition: fluidThermo.H:56
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:98
Base-class for pure (i.e., single-component) thermodynamic properties.
Definition: pureThermo.H:54
composite(const dictionary &dict, const fvMesh &mesh, const word &phaseName)
Construct from dictionary, mesh and phase name.
Base-class for fluid thermodynamic properties based on density.
virtual tmp< volScalarField > renameRho()
Rename and return the thermodynamic density field [kg/m^3].
static word derivedThermoName()
The derived name.
declareRunTimeSelectionTable(autoPtr, rhoFluidThermo, fvMesh,(const fvMesh &mesh, const word &phaseName),(mesh, phaseName))
Declare run-time constructor selection table.
static autoPtr< rhoFluidThermo > New(const fvMesh &, const word &phaseName=word::null)
Standard selection based on fvMesh.
TypeName("rhoFluidThermo")
Runtime type information.
virtual void correctRho(const volScalarField &dp)
Update the density corresponding to the given pressure change.
virtual ~rhoFluidThermo()
Destructor.
Base-class for thermodynamic properties based on density.
Definition: rhoThermo.H:54
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:63
static const word null
An empty word.
Definition: word.H:78
Namespace for OpenFOAM.
dictionary dict