src/thermophysicalModels/specie/thermo/eConst/eConstThermo.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::eConstThermo
  27
  28 Description
  29     Constant properties thermodynamics package derived from the basic
  30     thermo package data type specieThermo.
  31
  32 SourceFiles
  33     eConstThermoI.H
  34     eConstThermo.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef eConstThermo_H
  39 #define eConstThermo_H
  40
  41 #include "specieThermo.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // Forward declaration of friend functions and operators
  49
  50 template<class equationOfState> class eConstThermo;
  51
  52 template<class equationOfState>
  53 inline eConstThermo<equationOfState> operator+
  54 (
  55     const eConstThermo<equationOfState>&,
  56     const eConstThermo<equationOfState>&
  57 );
  58
  59 template<class equationOfState>
  60 inline eConstThermo<equationOfState> operator-
  61 (
  62     const eConstThermo<equationOfState>&,
  63     const eConstThermo<equationOfState>&
  64 );
  65
  66 template<class equationOfState>
  67 inline eConstThermo<equationOfState> operator*
  68 (
  69     const scalar,
  70     const eConstThermo<equationOfState>&
  71 );
  72
  73 template<class equationOfState>
  74 inline eConstThermo<equationOfState> operator==
  75 (
  76     const eConstThermo<equationOfState>&,
  77     const eConstThermo<equationOfState>&
  78 );
  79
  80 template<class equationOfState>
  81 Ostream& operator<<
  82 (
  83     Ostream&,
  84     const eConstThermo<equationOfState>&
  85 );
  86
  87
  88 /*---------------------------------------------------------------------------*\
  89                            Class eConstThermo Declaration
  90 \*---------------------------------------------------------------------------*/
  91
  92 class eConstThermo
  93 :
  94     public specieThermo
  95 {
  96     // Private data
  97
  98         scalar CV;
  99         scalar Hf;
 100
 101
 102     // Private member functions
 103
 104         //- construct from components
 105         inline eConstThermo
 106         (
 107             const specieThermo& st,
 108             const scalar cv,
 109             const scalar hf
 110         );
 111
 112 public:
 113
 114     // Constructors
 115
 116         //- Construct from Istream
 117         eConstThermo(Istream&);
 118
 119         //- Construct as named copy
 120         inline eConstThermo(const word&, const eConstThermo&);
 121
 122         //- Construct and return a clone
 123         inline autoPtr<eConstThermo> clone() const;
 124
 125         // Selector from Istream
 126         inline static autoPtr<eConstThermo> New(Istream& is);
 127
 128
 129     // Member Functions
 130
 131         // Fundamaental properties
 132
 133             //- Heat capacity at constant pressure [J/(kmol K)]
 134             inline scalar cp(const scalar T) const;
 135
 136             //- Enthalpy [J/kmol]
 137             inline scalar h(const scalar T) const;
 138
 139             //- Entropy [J/(kmol K)]
 140             inline scalar s(const scalar T) const;
 141
 142
 143         // Some derived properties
 144         // Other derived properties obtained from specieThermo base type
 145
 146             //- Temperature from Enthalpy given an initial temperature T0
 147             inline scalar TH(const scalar h, const scalar T0) const;
 148
 149             //- Temperature from internal energy given an initial temperature T0
 150             inline scalar TE(const scalar e, const scalar T0) const;
 151
 152
 153     // Member operators
 154
 155         inline void operator+=(const hConstThermo&);
 156         inline void operator-=(const hConstThermo&);
 157
 158
 159     // Friend operators
 160
 161         friend eConstThermo operator+ <equationOfState>
 162         (
 163             const eConstThermo&,
 164             const eConstThermo&
 165         );
 166
 167         friend eConstThermo operator- <equationOfState>
 168         (
 169             const eConstThermo&,
 170             const eConstThermo&
 171         );
 172
 173         friend eConstThermo operator* <equationOfState>
 174         (
 175             const scalar,
 176             const eConstThermo&
 177         );
 178
 179         friend eConstThermo operator== <equationOfState>
 180         (
 181             const eConstThermo&,
 182             const eConstThermo&
 183         );
 184
 185
 186     // IOstream Operators
 187
 188         friend Ostream& operator<< <equationOfState>
 189         (
 190             Ostream&, const eConstThermo&
 191         );
 192 };
 193
 194
 195 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 196
 197 } // End namespace Foam
 198
 199 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 200
 201 #include "eConstThermoI.H"
 202
 203 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 204
 205 #endif
 206
 207 // ************************************************************************* //