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) 2004-2010 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, 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 from dictionary
  67         perfectGas(const dictionary& dict);
  68
  69         //- Construct as named copy
  70         inline perfectGas(const word& name, const perfectGas&);
  71
  72         //- Construct and return a clone
  73         inline autoPtr<perfectGas> clone() const;
  74
  75         // Selector from Istream
  76         inline static autoPtr<perfectGas> New(Istream& is);
  77
  78         // Selector from dictionary
  79         inline static autoPtr<perfectGas> New(const dictionary& dict);
  80
  81
  82     // Member functions
  83
  84         // Fundamental properties
  85
  86             //- Return density [kg/m^3]
  87             inline scalar rho(scalar p, scalar T) const;
  88
  89             //- Return compressibility rho/p [s^2/m^2]
  90             inline scalar psi(scalar p, scalar T) const;
  91
  92             //- Return compression factor []
  93             inline scalar Z(scalar p, scalar T) const;
  94
  95
  96         // I-O
  97
  98             //- Write to Ostream
  99             void write(Ostream& os) const;
 100
 101
 102     // Member operators
 103
 104         inline void operator+=(const perfectGas&);
 105         inline void operator-=(const perfectGas&);
 106
 107         inline void operator*=(const scalar);
 108
 109
 110     // Friend operators
 111
 112         inline friend perfectGas operator+
 113         (
 114             const perfectGas&,
 115             const perfectGas&
 116         );
 117
 118         inline friend perfectGas operator-
 119         (
 120             const perfectGas&,
 121             const perfectGas&
 122         );
 123
 124         inline friend perfectGas operator*
 125         (
 126             const scalar s,
 127             const perfectGas&
 128         );
 129
 130         inline friend perfectGas operator==
 131         (
 132             const perfectGas&,
 133             const perfectGas&
 134         );
 135
 136
 137     // Ostream Operator
 138
 139         friend Ostream& operator<<(Ostream&, const perfectGas&);
 140 };
 141
 142
 143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 144
 145 } // End namespace Foam
 146
 147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 148
 149 #include "perfectGasI.H"
 150
 151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 152
 153 #endif
 154
 155 // ************************************************************************* //