Formatting
[foam-extend-3.2.git] / src / thermophysicalModels / barotropicCompressibilityModel / Chung / Chung.H
blobe62a9bb43fc0569a41906264584c743e41fdb0f6
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend 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 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::compressibilityModels::Chung
27 Description
28     Chung compressibility model.
30 SourceFiles
31     Chung.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef Chung_H
36 #define Chung_H
38 #include "barotropicCompressibilityModel.H"
39 #include "dimensionedScalar.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
45 namespace compressibilityModels
48 /*---------------------------------------------------------------------------*\
49                            Class Chung Declaration
50 \*---------------------------------------------------------------------------*/
52 class Chung
54     public barotropicCompressibilityModel
56     // Private data
58         dimensionedScalar psiv_;
59         dimensionedScalar psil_;
61         dimensionedScalar rhovSat_;
62         dimensionedScalar rholSat_;
65 public:
67     //- Runtime type information
68     TypeName("Chung");
71     // Constructors
73         //- construct from components
74         Chung
75         (
76             const dictionary& compressibilityProperties,
77             const volScalarField& gamma,
78             const word& psiName = "psi"
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 // ************************************************************************* //