All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
rhoThermo.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::rhoThermo
26 
27 Description
28  Base-class for thermodynamic properties based on density.
29 
30 See also
31  Foam::basicThermo
32 
33 SourceFiles
34  rhoThermo.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef rhoThermo_H
39 #define rhoThermo_H
40 
41 #include "basicThermo.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class rhoThermo Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class rhoThermo
53 :
54  virtual public basicThermo
55 {
56 public:
57 
58  // Public Classes
59 
60  //- Forward declare the implementation class
61  class implementation;
62 
63 
64  //- Destructor
65  virtual ~rhoThermo();
66 
67 
68  // Member Functions
69 
70  // Derived thermodynamic properties
71 
72  //- Density [kg/m^3]
73  virtual tmp<volScalarField> rho() const = 0;
74 
75  //- Density for patch [kg/m^3]
76  virtual tmp<scalarField> rho(const label patchi) const = 0;
77 
78  //- Return non-const access to the local density field [kg/m^3]
79  virtual volScalarField& rho() = 0;
80 };
81 
82 
83 /*---------------------------------------------------------------------------*\
84  Class rhoThermo::implementation Declaration
85 \*---------------------------------------------------------------------------*/
86 
88 :
89  virtual public rhoThermo
90 {
91 protected:
92 
93  // Protected data
94 
95  //- Density field [kg/m^3]
97 
98 
99 public:
100 
101  // Constructors
102 
103  //- Construct from dictionary, mesh and phase name
104  implementation(const dictionary&, const fvMesh&, const word&);
105 
106  //- Disallow default bitwise copy construction
107  implementation(const implementation&) = delete;
108 
109 
110  //- Destructor
111  virtual ~implementation();
112 
113 
114  // Member Functions
115 
116  // Derived thermodynamic properties
117 
118  //- Density [kg/m^3]
119  virtual tmp<volScalarField> rho() const;
120 
121  //- Density for patch [kg/m^3]
122  virtual tmp<scalarField> rho(const label patchi) const;
123 
124  //- Return non-const access to the local density field [kg/m^3]
125  virtual volScalarField& rho();
126 
127 
128  // Member Operators
129 
130  //- Disallow default bitwise assignment
131  void operator=(const implementation&) = delete;
132 };
133 
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 } // End namespace Foam
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 #endif
142 
143 // ************************************************************************* //
Generic GeometricField class.
Base-class for fluid and solid thermodynamic properties.
Definition: basicThermo.H:78
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
volScalarField rho_
Density field [kg/m^3].
Definition: rhoThermo.H:95
virtual ~implementation()
Destructor.
Definition: rhoThermo.C:59
implementation(const dictionary &, const fvMesh &, const word &)
Construct from dictionary, mesh and phase name.
Definition: rhoThermo.C:31
void operator=(const implementation &)=delete
Disallow default bitwise assignment.
virtual tmp< volScalarField > rho() const
Density [kg/m^3].
Definition: rhoThermo.C:66
Base-class for thermodynamic properties based on density.
Definition: rhoThermo.H:54
virtual ~rhoThermo()
Destructor.
Definition: rhoThermo.C:55
virtual tmp< volScalarField > rho() const =0
Density [kg/m^3].
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:62
label patchi
Namespace for OpenFOAM.
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