src/thermophysicalModels/specie/equationOfState/perfectGas/perfectGas.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::perfectGas
  26
  27 Description
  28     Perfect gas equation of state.
  29
  30 SourceFiles
  31     perfectGasI.H
  32     perfectGas.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef perfectGas_H
  37 #define perfectGas_H
  38
  39 #include "specie.H"
  40 #include "autoPtr.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class perfectGas Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class perfectGas
  52 :
  53     public specie
  54 {
  55
  56 public:
  57
  58     // Constructors
  59
  60         //- Construct from components
  61         inline perfectGas(const specie& sp);
  62
  63         //- Construct from Istream
  64         perfectGas(Istream&);
  65
  66         //- Construct as named copy
  67         inline perfectGas(const word& name, const perfectGas&);
  68
  69         //- Construct and return a clone
  70         inline autoPtr<perfectGas> clone() const;
  71
  72         // Selector from Istream
  73         inline static autoPtr<perfectGas> New(Istream& is);
  74
  75
  76     // Member functions
  77
  78         //- Return density [kg/m^3]
  79         inline scalar rho(scalar p, scalar T) const;
  80
  81         //- Return compressibility rho/p [s^2/m^2]
  82         inline scalar psi(scalar p, scalar T) const;
  83
  84         //- Return compression factor []
  85         inline scalar Z(scalar p, scalar T) const;
  86
  87
  88     // Member operators
  89
  90         inline void operator+=(const perfectGas&);
  91         inline void operator-=(const perfectGas&);
  92
  93         inline void operator*=(const scalar);
  94
  95
  96     // Friend operators
  97
  98         inline friend perfectGas operator+
  99         (
 100             const perfectGas&,
 101             const perfectGas&
 102         );
 103
 104         inline friend perfectGas operator-
 105         (
 106             const perfectGas&,
 107             const perfectGas&
 108         );
 109
 110         inline friend perfectGas operator*
 111         (
 112             const scalar s,
 113             const perfectGas&
 114         );
 115
 116         inline friend perfectGas operator==
 117         (
 118             const perfectGas&,
 119             const perfectGas&
 120         );
 121
 122
 123     // Ostream Operator
 124
 125         friend Ostream& operator<<(Ostream&, const perfectGas&);
 126 };
 127
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 } // End namespace Foam
 132
 133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 134
 135 #include "perfectGasI.H"
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 #endif
 140
 141 // ************************************************************************* //