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) 2011 OpenFOAM Foundation
   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::eConstThermo
  26
  27 Description
  28     Constant properties thermodynamics package templated on an equation of
  29     state
  30
  31 SourceFiles
  32     eConstThermoI.H
  33     eConstThermo.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef eConstThermo_H
  38 #define eConstThermo_H
  39
  40 #include "specieThermo.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of friend functions and operators
  48
  49 template<class EquationOfState> class eConstThermo;
  50
  51 template<class EquationOfState>
  52 inline eConstThermo<EquationOfState> operator+
  53 (
  54     const eConstThermo<EquationOfState>&,
  55     const eConstThermo<EquationOfState>&
  56 );
  57
  58 template<class EquationOfState>
  59 inline eConstThermo<EquationOfState> operator-
  60 (
  61     const eConstThermo<EquationOfState>&,
  62     const eConstThermo<EquationOfState>&
  63 );
  64
  65 template<class EquationOfState>
  66 inline eConstThermo<EquationOfState> operator*
  67 (
  68     const scalar,
  69     const eConstThermo<EquationOfState>&
  70 );
  71
  72 template<class EquationOfState>
  73 inline eConstThermo<EquationOfState> operator==
  74 (
  75     const eConstThermo<EquationOfState>&,
  76     const eConstThermo<EquationOfState>&
  77 );
  78
  79 template<class EquationOfState>
  80 Ostream& operator<<
  81 (
  82     Ostream&,
  83     const eConstThermo<EquationOfState>&
  84 );
  85
  86
  87 /*---------------------------------------------------------------------------*\
  88                         Class eConstThermo Declaration
  89 \*---------------------------------------------------------------------------*/
  90
  91 template<class EquationOfState>
  92 class eConstThermo
  93 :
  94     public EquationOfState
  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 EquationOfState& st,
 108             const scalar cv,
 109             const scalar hf
 110         );
 111
 112
 113 public:
 114
 115     // Constructors
 116
 117         //- Construct from Istream
 118         eConstThermo(Istream&);
 119
 120         //- Construct from dictionary
 121         eConstThermo(const dictionary& dict);
 122
 123         //- Construct as named copy
 124         inline eConstThermo(const word&, const eConstThermo&);
 125
 126         //- Construct and return a clone
 127         inline autoPtr<eConstThermo> clone() const;
 128
 129         // Selector from Istream
 130         inline static autoPtr<eConstThermo> New(Istream& is);
 131
 132         // Selector from dictionary
 133         inline static autoPtr<eConstThermo> New(const dictionary& dict);
 134
 135
 136     // Member Functions
 137
 138         //- Limit the temperature to be in the range Tlow_ to Thigh_
 139         inline scalar limit(const scalar T) const;
 140
 141         // Fundamental properties
 142
 143             //- Heat capacity at constant pressure [J/(kmol K)]
 144             inline scalar cp(const scalar T) const;
 145
 146             //- Enthalpy [J/kmol]
 147             inline scalar h(const scalar T) const;
 148
 149             //- Sensible Enthalpy [J/kmol]
 150             inline scalar hs(const scalar T) const;
 151
 152             //- Chemical enthalpy [J/kmol]
 153             inline scalar hc() const;
 154
 155             //- Entropy [J/(kmol K)]
 156             inline scalar s(const scalar T) const;
 157
 158
 159         // I-O
 160
 161             //- Write to Ostream
 162             void write(Ostream& os) const;
 163
 164
 165     // Member operators
 166
 167         inline void operator+=(const eConstThermo&);
 168         inline void operator-=(const eConstThermo&);
 169
 170
 171     // Friend operators
 172
 173         friend eConstThermo operator+ <EquationOfState>
 174         (
 175             const eConstThermo&,
 176             const eConstThermo&
 177         );
 178
 179         friend eConstThermo operator- <EquationOfState>
 180         (
 181             const eConstThermo&,
 182             const eConstThermo&
 183         );
 184
 185         friend eConstThermo operator* <EquationOfState>
 186         (
 187             const scalar,
 188             const eConstThermo&
 189         );
 190
 191         friend eConstThermo operator== <EquationOfState>
 192         (
 193             const eConstThermo&,
 194             const eConstThermo&
 195         );
 196
 197
 198     // IOstream Operators
 199
 200         friend Ostream& operator<< <EquationOfState>
 201         (
 202             Ostream&,
 203             const eConstThermo&
 204         );
 205 };
 206
 207
 208 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 209
 210 } // End namespace Foam
 211
 212 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 213
 214 #include "eConstThermoI.H"
 215
 216 #ifdef NoRepository
 217 #   include "eConstThermo.C"
 218 #endif
 219
 220 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 221
 222 #endif
 223
 224 // ************************************************************************* //