src/thermophysicalModels/barotropicCompressibilityModel/linear/linear.H

   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.
  10
  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.
  15
  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.
  20
  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/>.
  23
  24 Class
  25     Foam::compressibilityModels::linear
  26
  27 Description
  28     linear compressibility model.
  29
  30 SourceFiles
  31     linear.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef linear_H
  36 #define linear_H
  37
  38 #include "barotropicCompressibilityModel.H"
  39 #include "dimensionedScalar.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace compressibilityModels
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class linear Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class linear
  53 :
  54     public barotropicCompressibilityModel
  55 {
  56     // Private data
  57
  58         dimensionedScalar psiv_;
  59         dimensionedScalar psil_;
  60
  61
  62 public:
  63
  64     //- Runtime type information
  65     TypeName("linear");
  66
  67
  68     // Constructors
  69
  70         //- construct from components
  71         linear
  72         (
  73             const dictionary& compressibilityProperties,
  74             const volScalarField& gamma,
  75             const word& psiName = "psi"
  76         );
  77
  78
  79     // Destructor
  80
  81         ~linear()
  82         {}
  83
  84
  85     // Member Functions
  86
  87         //- Correct the linear compressibility
  88         void correct();
  89
  90         //- Read transportProperties dictionary
  91         bool read(const dictionary& compressibilityProperties);
  92 };
  93
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  96
  97 } // End namespace compressibilityModels
  98 } // End namespace Foam
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 #endif
 103
 104 // ************************************************************************* //