src/thermophysicalModels/barotropicCompressibilityModel/linear/linear.H

   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.
  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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::compressibilityModels::linear
  27
  28 Description
  29     linear compressibility model.
  30
  31 SourceFiles
  32     linear.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef linear_H
  37 #define linear_H
  38
  39 #include "barotropicCompressibilityModel.H"
  40 #include "dimensionedScalar.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46 namespace compressibilityModels
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class linear Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class linear
  54 :
  55     public barotropicCompressibilityModel
  56 {
  57     // Private data
  58
  59         dimensionedScalar psiv_;
  60         dimensionedScalar psil_;
  61
  62
  63 public:
  64
  65     //- Runtime type information
  66     TypeName("linear");
  67
  68
  69     // Constructors
  70
  71         //- construct from components
  72         linear
  73         (
  74             const dictionary& compressibilityProperties,
  75             const volScalarField& gamma
  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 // ************************************************************************* //