src/thermophysicalModels/specie/equationOfState/perfectGas/perfectGas.H

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