Wallis.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
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::compressibilityModels::Wallis
26 
27 Description
28  Wallis compressibility model.
29 
30 SourceFiles
31  Wallis.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef Wallis_H
36 #define Wallis_H
37 
39 #include "dimensionedScalar.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace compressibilityModels
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class Wallis Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class Wallis
53 :
55 {
56  // Private Data
57 
58  dimensionedScalar psiv_;
59  dimensionedScalar psil_;
60 
61  dimensionedScalar rhovSat_;
62  dimensionedScalar rholSat_;
63 
64 
65 public:
66 
67  //- Runtime type information
68  TypeName("Wallis");
69 
70 
71  // Constructors
72 
73  //- Construct from components
74  Wallis
75  (
77  const volScalarField& gamma,
78  const word& psiName = "psi"
79  );
80 
81 
82  //- Destructor
83  ~Wallis()
84  {}
85 
86 
87  // Member Functions
88 
89  //- Correct the Wallis compressibility
90  void correct();
91 
92  //- Read transportProperties dictionary
93  bool read(const dictionary& compressibilityProperties);
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace compressibilityModels
100 } // End namespace Foam
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
bool read(const dictionary &compressibilityProperties)
Read transportProperties dictionary.
Definition: Wallis.C:95
A class for handling words, derived from string.
Definition: word.H:59
TypeName("Wallis")
Runtime type information.
Wallis compressibility model.
Definition: Wallis.H:51
void correct()
Correct the Wallis compressibility.
Definition: Wallis.C:86
const dictionary & compressibilityProperties() const
Return the phase transport properties dictionary.
Abstract class for barotropic compressibility models.
Wallis(const dictionary &compressibilityProperties, const volScalarField &gamma, const word &psiName="psi")
Construct from components.
Definition: Wallis.C:48
Namespace for OpenFOAM.