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