linear.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2015 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::compressibilityModels::linear
28 
29 Description
30  linear compressibility model.
31 
32 SourceFiles
33  linear.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef linear_H
38 #define linear_H
39 
41 #include "dimensionedScalar.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace compressibilityModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class linear Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class linear
55 :
57 {
58  // Private data
59 
60  dimensionedScalar psiv_;
61  dimensionedScalar psil_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("linear");
68 
69 
70  // Constructors
71 
72  //- Construct from components
73  linear
74  (
76  const volScalarField& gamma,
77  const word& psiName = "psi"
78  );
79 
80 
81  //- Destructor
82  ~linear()
83  {}
84 
85 
86  // Member Functions
87 
88  //- Correct the linear compressibility
89  void correct();
90 
91  //- Read transportProperties dictionary
93 };
94 
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 } // End namespace compressibilityModels
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #endif
104 
105 // ************************************************************************* //
Foam::compressibilityModels::linear
linear compressibility model.
Definition: linear.H:53
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::compressibilityModels::linear::~linear
~linear()
Destructor.
Definition: linear.H:81
Foam::compressibilityModels::linear::TypeName
TypeName("linear")
Runtime type information.
barotropicCompressibilityModel.H
Foam::barotropicCompressibilityModel
Abstract class for barotropic compressibility models.
Definition: barotropicCompressibilityModel.H:64
Foam::compressibilityModels::linear::correct
void correct()
Correct the linear compressibility.
Definition: linear.C:77
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::dimensioned< scalar >
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::compressibilityModels::linear::linear
linear(const dictionary &compressibilityProperties, const volScalarField &gamma, const word &psiName="psi")
Construct from components.
Definition: linear.C:50
dimensionedScalar.H
Foam::compressibilityModels::linear::read
bool read(const dictionary &compressibilityProperties)
Read transportProperties dictionary.
Definition: linear.C:84
Foam::barotropicCompressibilityModel::compressibilityProperties
const dictionary & compressibilityProperties() const
Return the phase transport properties dictionary.
Definition: barotropicCompressibilityModel.H:140
gamma
const scalar gamma
Definition: EEqn.H:9
Foam::GeometricField< scalar, fvPatchField, volMesh >