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