FreeFOAM The Cross-Platform CFD Toolkit
basicRhoThermo.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 | Copyright (C) 1991-2010 OpenCFD Ltd.
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::basicRhoThermo
26 
27 Description
28  Basic thermodynamic properties based on density
29 
30 SourceFiles
31  basicRhoThermo.C
32  newBasicRhoThermo.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef basicRhoThermo_H
37 #define basicRhoThermo_H
38 
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class basicRhoThermo Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public basicThermo
54 {
55 
56 protected:
57 
58  // Protected data
59 
60  //- Density field [kg/m^3]
61  // Named 'rhoThermo' to avoid (potential) conflict with solver density
63 
64 
65  // Protected member functions
66 
67  //- Construct as copy (not implemented)
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("basicRhoThermo");
75 
76 
77  //- Declare run-time constructor selection table
79  (
80  autoPtr,
82  fvMesh,
83  (const fvMesh& mesh),
84  (mesh)
85  );
86 
87 
88  // Constructors
89 
90  //- Construct from mesh
91  basicRhoThermo(const fvMesh&);
92 
93 
94  //- Selector
95  static autoPtr<basicRhoThermo> New(const fvMesh&);
96 
97 
98  //- Destructor
99  virtual ~basicRhoThermo();
100 
101 
102  // Member functions
103 
104  // Fields derived from thermodynamic state variables
105 
106  //- Density [kg/m^3]
107  virtual tmp<volScalarField> rho() const;
108 
109  //- Return non-const access to the local density field [kg/m^3]
110  virtual volScalarField& rho();
111 };
112 
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 } // End namespace Foam
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 #endif
121 
122 // ************************ vim: set sw=4 sts=4 et: ************************ //