All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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-2023 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 const word derivedThermoName;
77 
78 
79  //- Runtime type information
80  TypeName("rhoFluidThermo");
81 
82 
83  //- Declare run-time constructor selection table
85  (
86  autoPtr,
88  fvMesh,
89  (const fvMesh& mesh, const word& phaseName),
90  (mesh, phaseName)
91  );
92 
93 
94  // Selectors
95 
96  //- Standard selection based on fvMesh
98  (
99  const fvMesh&,
100  const word& phaseName=word::null
101  );
102 
103 
104  //- Destructor
105  virtual ~rhoFluidThermo();
106 
107 
108  // Member Functions
109 
110  // Derived Thermodynamic Properties
111 
112  //- Rename and return the thermodynamic density field [kg/m^3]
113  // This is used by solvers which create a separate continuity rho
114  virtual tmp<volScalarField> renameRho();
115 
116  //- Add the given density correction to the density field.
117  // Used to update the density field following pressure solution
118  virtual void correctRho(const volScalarField& deltaRho);
119 };
120 
121 
122 /*---------------------------------------------------------------------------*\
123  Class rhoFluidThermo::composite Declaration
124 \*---------------------------------------------------------------------------*/
125 
127 :
129  public pureThermo,
132  public rhoFluidThermo
133 {
134 public:
135 
136  // Constructors
137 
138  //- Construct from dictionary, mesh and phase name
139  template<class MixtureType>
140  composite
141  (
142  const dictionary& dict,
143  const MixtureType& mixture,
144  const fvMesh& mesh,
145  const word& phaseName
146  )
147  :
151  {}
152 };
153 
154 
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
156 
157 } // End namespace Foam
158 
159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
160 
161 #endif
162 
163 // ************************************************************************* //
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:496
virtual const word & phaseName() const
Phase name.
Definition: basicThermo.H:502
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 keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Base-class for fluid thermodynamic properties.
Definition: fluidThermo.H:57
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
Base-class for multi-component thermodynamic properties.
Definition: pureThermo.H:54
composite(const dictionary &dict, const MixtureType &mixture, 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 const word derivedThermoName
The derived name.
virtual void correctRho(const volScalarField &deltaRho)
Add the given density correction to the density field.
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 ~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:62
static const word null
An empty word.
Definition: word.H:77
Namespace for OpenFOAM.
dictionary dict