initial commit for version 1.5.x patch release
[OpenFOAM-1.5.x.git] / src / thermophysicalModels / barotropicCompressibilityModel / Chung / Chung.H
blob56419ecbe991dea9362686938fa977c42a4b2521
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     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, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::compressibilityModels::Chung
28 Description
29     Chung compressibility model.
31 SourceFiles
32     Chung.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef Chung_H
37 #define Chung_H
39 #include "barotropicCompressibilityModel.H"
40 #include "dimensionedScalar.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
46 namespace compressibilityModels
49 /*---------------------------------------------------------------------------*\
50                            Class Chung Declaration
51 \*---------------------------------------------------------------------------*/
53 class Chung
55     public barotropicCompressibilityModel
57     // Private data
59         dimensionedScalar psiv_;
60         dimensionedScalar psil_;
62         dimensionedScalar rhovSat_;
63         dimensionedScalar rholSat_;
66 public:
68     //- Runtime type information
69     TypeName("Chung");
72     // Constructors
74         //- construct from components
75         Chung
76         (
77             const dictionary& compressibilityProperties,
78             const volScalarField& gamma
79         );
82     // Destructor
84         ~Chung()
85         {}
88     // Member Functions
90         //- Correct the Chung compressibility
91         void correct();
93         //- Read transportProperties dictionary
94         bool read(const dictionary& compressibilityProperties);
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 } // End namespace compressibilityModels
101 } // End namespace Foam
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 #endif
107 // ************************************************************************* //