FreeFOAM The Cross-Platform CFD Toolkit
incompressible.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::incompressible
26 
27 Description
28  Incompressible gas/liquid equation of state.
29 
30 SourceFiles
31  incompressibleI.H
32  incompressible.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef incompressible_H
37 #define incompressible_H
38 
39 #include <specie/specie.H>
40 #include <OpenFOAM/autoPtr.H>
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class incompressible Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public specie
54 {
55  // Private data
56 
57  //- Density
58  scalar rho_;
59 
60 
61 public:
62 
63  // Constructors
64 
65  //- Construct from components
66  inline incompressible(const specie& sp, const scalar rho);
67 
68  //- Construct from Istream
70 
71  //- Construct as named copy
72  inline incompressible(const word& name, const incompressible&);
73 
74  //- Construct and return a clone
75  inline autoPtr<incompressible> clone() const;
76 
77  // Selector from Istream
78  inline static autoPtr<incompressible> New(Istream& is);
79 
80 
81  // Member functions
82 
83  //- Return density [kg/m^3]
84  inline scalar rho(scalar p, scalar T) const;
85 
86  //- Return compressibility rho/p [s^2/m^2]
87  inline scalar psi(scalar p, scalar T) const;
88 
89  //- Return compression factor []
90  inline scalar Z(scalar p, scalar T) const;
91 
92 
93  // Member operators
94 
95  inline void operator+=(const incompressible&);
96  inline void operator-=(const incompressible&);
97 
98  inline void operator*=(const scalar);
99 
100 
101  // Friend operators
102 
103  inline friend incompressible operator+
104  (
105  const incompressible&,
106  const incompressible&
107  );
108 
109  inline friend incompressible operator-
110  (
111  const incompressible&,
112  const incompressible&
113  );
114 
115  inline friend incompressible operator*
116  (
117  const scalar s,
118  const incompressible&
119  );
120 
121  inline friend incompressible operator==
122  (
123  const incompressible&,
124  const incompressible&
125  );
126 
127 
128  // Ostream Operator
129 
130  friend Ostream& operator<<(Ostream&, const incompressible&);
131 };
132 
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 } // End namespace Foam
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 #include "incompressibleI.H"
141 
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 
144 #endif
145 
146 // ************************************************************************* //