Transferred copyright to the OpenFOAM Foundation
[OpenFOAM-2.0.x.git] / src / thermophysicalModels / properties / liquidProperties / H2O / H2O.H
blob40681662510db5c3e43a0ee38bcfa712ec152dee
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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/>.
24 Class
25     Foam::H2O
27 Description
28     water
30 SourceFiles
31     H2O.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef H2O_H
36 #define H2O_H
38 #include "liquidProperties.H"
39 #include "NSRDSfunc0.H"
40 #include "NSRDSfunc1.H"
41 #include "NSRDSfunc2.H"
42 #include "NSRDSfunc3.H"
43 #include "NSRDSfunc4.H"
44 #include "NSRDSfunc5.H"
45 #include "NSRDSfunc6.H"
46 #include "NSRDSfunc7.H"
47 #include "APIdiffCoefFunc.H"
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
51 namespace Foam
54 /*---------------------------------------------------------------------------*\
55                            Class H2O Declaration
56 \*---------------------------------------------------------------------------*/
58 class H2O
60     public liquidProperties
62     // Private data
64         NSRDSfunc5 rho_;
65         NSRDSfunc1 pv_;
66         NSRDSfunc6 hl_;
67         NSRDSfunc0 Cp_;
68         NSRDSfunc0 h_;
69         NSRDSfunc7 Cpg_;
70         NSRDSfunc4 B_;
71         NSRDSfunc1 mu_;
72         NSRDSfunc2 mug_;
73         NSRDSfunc0 K_;
74         NSRDSfunc2 Kg_;
75         NSRDSfunc6 sigma_;
76         APIdiffCoefFunc D_;
79 public:
81     //- Runtime type information
82     TypeName("H2O");
85     // Constructors
87         //- Construct null
88         H2O();
90         //- Construct from components
91         H2O
92         (
93             const liquidProperties& l,
94             const NSRDSfunc5& density,
95             const NSRDSfunc1& vapourPressure,
96             const NSRDSfunc6& heatOfVapourisation,
97             const NSRDSfunc0& heatCapacity,
98             const NSRDSfunc0& enthalpy,
99             const NSRDSfunc7& idealGasHeatCapacity,
100             const NSRDSfunc4& secondVirialCoeff,
101             const NSRDSfunc1& dynamicViscosity,
102             const NSRDSfunc2& vapourDynamicViscosity,
103             const NSRDSfunc0& thermalConductivity,
104             const NSRDSfunc2& vapourThermalConductivity,
105             const NSRDSfunc6& surfaceTension,
106             const APIdiffCoefFunc& vapourDiffussivity
107         );
109         //- Construct from Istream
110         H2O(Istream& is);
112         //- Construct from dictionary
113         H2O(const dictionary& dict);
115         //- Construct copy
116         H2O(const H2O& liq);
118         //- Construct and return clone
119         virtual autoPtr<liquidProperties> clone() const
120         {
121             return autoPtr<liquidProperties>(new H2O(*this));
122         }
125     // Member Functions
127         //- Liquid density [kg/m^3]
128         inline scalar rho(scalar p, scalar T) const;
130         //- Vapour pressure [Pa]
131         inline scalar pv(scalar p, scalar T) const;
133         //- Heat of vapourisation [J/kg]
134         inline scalar hl(scalar p, scalar T) const;
136         //- Liquid heat capacity [J/(kg K)]
137         inline scalar Cp(scalar p, scalar T) const;
139         //- Liquid Enthalpy [J/(kg)]
140         inline scalar h(scalar p, scalar T) const;
142         //- Ideal gas heat capacity [J/(kg K)]
143         inline scalar Cpg(scalar p, scalar T) const;
145         //- Second Virial Coefficient [m^3/kg]
146         inline scalar B(scalar p, scalar T) const;
148         //- Liquid viscosity [Pa s]
149         inline scalar mu(scalar p, scalar T) const;
151         //- Vapour viscosity [Pa s]
152         inline scalar mug(scalar p, scalar T) const;
154         //- Liquid thermal conductivity  [W/(m K)]
155         inline scalar K(scalar p, scalar T) const;
157         //- Vapour thermal conductivity  [W/(m K)]
158         inline scalar Kg(scalar p, scalar T) const;
160         //- Surface tension [N/m]
161         inline scalar sigma(scalar p, scalar T) const;
163         //- Vapour diffussivity [m2/s]
164         inline scalar D(scalar p, scalar T) const;
166         //- Vapour diffussivity [m2/s] with specified binary pair
167         inline scalar D(scalar p, scalar T, scalar Wb) const;
170     // I-O
172         //- Write the function coefficients
173         void writeData(Ostream& os) const
174         {
175             liquidProperties::writeData(os); os << nl;
176             rho_.writeData(os); os << nl;
177             pv_.writeData(os); os << nl;
178             hl_.writeData(os); os << nl;
179             Cp_.writeData(os); os << nl;
180             Cpg_.writeData(os); os << nl;
181             B_.writeData(os); os << nl;
182             mu_.writeData(os); os << nl;
183             mug_.writeData(os); os << nl;
184             K_.writeData(os); os << nl;
185             Kg_.writeData(os); os << nl;
186             sigma_.writeData(os); os << nl;
187             D_.writeData(os); os << endl;
188         }
191         //- Ostream Operator
192         friend Ostream& operator<<(Ostream& os, const H2O& l)
193         {
194             l.writeData(os);
195             return os;
196         }
200 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
202 } // End namespace Foam
204 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
206 #include "H2OI.H"
208 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
210 #endif
212 // ************************************************************************* //