src/thermophysicalModels/specie/thermo/janaf/janafThermo.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::janafThermo
  26
  27 Description
  28     JANAF tables based thermodynamics package templated
  29     into the equationOfState.
  30
  31 SourceFiles
  32     janafThermoI.H
  33     janafThermo.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef janafThermo_H
  38 #define janafThermo_H
  39
  40 #include "scalar.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of friend functions and operators
  48
  49 template<class equationOfState> class janafThermo;
  50
  51 template<class equationOfState>
  52 inline janafThermo<equationOfState> operator+
  53 (
  54     const janafThermo<equationOfState>&,
  55     const janafThermo<equationOfState>&
  56 );
  57
  58 template<class equationOfState>
  59 inline janafThermo<equationOfState> operator-
  60 (
  61     const janafThermo<equationOfState>&,
  62     const janafThermo<equationOfState>&
  63 );
  64
  65 template<class equationOfState>
  66 inline janafThermo<equationOfState> operator*
  67 (
  68     const scalar,
  69     const janafThermo<equationOfState>&
  70 );
  71
  72 template<class equationOfState>
  73 inline janafThermo<equationOfState> operator==
  74 (
  75     const janafThermo<equationOfState>&,
  76     const janafThermo<equationOfState>&
  77 );
  78
  79 template<class equationOfState>
  80 Ostream& operator<<
  81 (
  82     Ostream&,
  83     const janafThermo<equationOfState>&
  84 );
  85
  86
  87 /*---------------------------------------------------------------------------*\
  88                            Class janafThermo Declaration
  89 \*---------------------------------------------------------------------------*/
  90
  91 template<class equationOfState>
  92 class janafThermo
  93 :
  94     public equationOfState
  95 {
  96
  97 public:
  98
  99         static const int nCoeffs_ = 7;
 100         typedef FixedList<scalar, nCoeffs_> coeffArray;
 101
 102 private:
 103
 104     // Private data
 105
 106         // Temperature limits of applicability of functions
 107         scalar Tlow_, Thigh_, Tcommon_;
 108
 109         coeffArray highCpCoeffs_;
 110         coeffArray lowCpCoeffs_;
 111
 112
 113     // Private member functions
 114
 115         //- Check given temperature is within the range of the fitted coeffs
 116         //  Note: bounding T within range.  HJ, 12/Oct/2010
 117         inline void checkT(scalar& T) const;
 118
 119         //- Return the coefficients corresponding to the given temperature
 120         //  Note: bounding T within range.  HJ, 12/Oct/2010
 121         inline const coeffArray& coeffs(scalar& T) const;
 122
 123
 124 public:
 125
 126     // Constructors
 127
 128         //- Construct from components
 129         inline janafThermo
 130         (
 131             const equationOfState& st,
 132             const scalar Tlow,
 133             const scalar Thigh,
 134             const scalar Tcommon,
 135             const coeffArray& highCpCoeffs,
 136             const coeffArray& lowCpCoeffs
 137         );
 138
 139         //- Construct from Istream
 140         janafThermo(Istream&);
 141
 142         //- Construct as a named copy
 143         inline janafThermo(const word&, const janafThermo&);
 144
 145
 146     // Member Functions
 147
 148         //- Heat capacity at constant pressure [J/(kmol K)]
 149         //  Note: bounding T within range.  HJ, 12/Oct/2010
 150         inline scalar cp(scalar T) const;
 151
 152         //- Enthalpy [J/kmol]
 153         //  Note: bounding T within range.  HJ, 12/Oct/2010
 154         inline scalar h(scalar T) const;
 155
 156         //- Sensible enthalpy [J/kmol]
 157         //  Note: bounding T within range.  HJ, 12/Oct/2010
 158         inline scalar hs(scalar T) const;
 159
 160         //- Chemical enthalpy [J/kmol]
 161         inline scalar hc() const;
 162
 163         //- Entropy [J/(kmol K)]
 164         //  Note: bounding T within range.  HJ, 12/Oct/2010
 165         inline scalar s(scalar T) const;
 166
 167
 168     // Member operators
 169
 170         inline void operator+=(const janafThermo&);
 171         inline void operator-=(const janafThermo&);
 172
 173
 174     // Friend operators
 175
 176         friend janafThermo operator+ <equationOfState>
 177         (
 178             const janafThermo&,
 179             const janafThermo&
 180         );
 181
 182         friend janafThermo operator- <equationOfState>
 183         (
 184             const janafThermo&,
 185             const janafThermo&
 186         );
 187
 188         friend janafThermo operator* <equationOfState>
 189         (
 190             const scalar,
 191             const janafThermo&
 192         );
 193
 194         friend janafThermo operator== <equationOfState>
 195         (
 196             const janafThermo&,
 197             const janafThermo&
 198         );
 199
 200
 201     // Ostream Operator
 202
 203         friend Ostream& operator<< <equationOfState>
 204         (
 205             Ostream&,
 206             const janafThermo&
 207         );
 208 };
 209
 210
 211 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 212
 213 } // End namespace Foam
 214
 215 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 216
 217 #include "janafThermoI.H"
 218
 219 #ifdef NoRepository
 220 #   include "janafThermo.C"
 221 #endif
 222
 223 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 224
 225 #endif
 226
 227 // ************************************************************************* //