src/thermophysicalModels/specie/equationOfState/icoPolynomial/icoPolynomial.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::icoPolynomial
  26
  27 Description
  28     Incompressible, polynomial form of equation of state, using a polynomial
  29     function for density.
  30
  31 SourceFiles
  32     icoPolynomialI.H
  33     icoPolynomial.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef icoPolynomial_H
  38 #define icoPolynomial_H
  39
  40 #include "specie.H"
  41 #include "autoPtr.H"
  42 #include "Polynomial.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 // Forward declaration of friend functions and operators
  50
  51 template<int PolySize>
  52 class icoPolynomial;
  53
  54 template<int PolySize>
  55 icoPolynomial<PolySize> operator+
  56 (
  57     const icoPolynomial<PolySize>&,
  58     const icoPolynomial<PolySize>&
  59 );
  60
  61 template<int PolySize>
  62 icoPolynomial<PolySize> operator-
  63 (
  64     const icoPolynomial<PolySize>&,
  65     const icoPolynomial<PolySize>&
  66 );
  67
  68 template<int PolySize>
  69 icoPolynomial<PolySize> operator*
  70 (
  71     const scalar,
  72     const icoPolynomial<PolySize>&
  73 );
  74
  75 template<int PolySize>
  76 icoPolynomial<PolySize> operator==
  77 (
  78     const icoPolynomial<PolySize>&,
  79     const icoPolynomial<PolySize>&
  80 );
  81
  82 template<int PolySize>
  83 Ostream& operator<<
  84 (
  85     Ostream&,
  86     const icoPolynomial<PolySize>&
  87 );
  88
  89
  90 /*---------------------------------------------------------------------------*\
  91                         Class icoPolynomial Declaration
  92 \*---------------------------------------------------------------------------*/
  93
  94 template<int PolySize>
  95 class icoPolynomial
  96 :
  97     public specie
  98 {
  99     // Private data
 100
 101         //- Density polynomial coefficients
 102         //  Note: input in [kg/m3], but internally uses [kg/m3/kmol]
 103         Polynomial<PolySize> rhoCoeffs_;
 104
 105
 106 public:
 107
 108     // Constructors
 109
 110         //- Construct from components
 111         inline icoPolynomial
 112         (
 113             const specie& sp,
 114             const Polynomial<PolySize>& rhoPoly
 115         );
 116
 117         //- Construct from Istream
 118         icoPolynomial(Istream&);
 119
 120         //- Construct from dictionary
 121         icoPolynomial(const dictionary& dict);
 122
 123         //- Construct as copy
 124         inline icoPolynomial(const icoPolynomial&);
 125
 126         //- Construct as named copy
 127         inline icoPolynomial(const word& name, const icoPolynomial&);
 128
 129         //- Construct and return a clone
 130         inline autoPtr<icoPolynomial> clone() const;
 131
 132         // Selector from Istream
 133         inline static autoPtr<icoPolynomial> New(Istream& is);
 134
 135         // Selector from dictionary
 136         inline static autoPtr<icoPolynomial> New(const dictionary& dict);
 137
 138
 139     // Member functions
 140
 141         // Fundamental properties
 142
 143             //- Return density [kg/m^3]
 144             inline scalar rho(scalar p, scalar T) const;
 145
 146             //- Return compressibility rho/p [s^2/m^2]
 147             inline scalar psi(scalar p, scalar T) const;
 148
 149             //- Return compression factor []
 150             inline scalar Z(scalar p, scalar T) const;
 151
 152
 153         // I-O
 154
 155             //- Write to Ostream
 156             void write(Ostream& os) const;
 157
 158
 159     // Member operators
 160
 161         inline icoPolynomial& operator=(const icoPolynomial&);
 162         inline void operator+=(const icoPolynomial&);
 163         inline void operator-=(const icoPolynomial&);
 164
 165         inline void operator*=(const scalar);
 166
 167
 168     // Friend operators
 169
 170         friend icoPolynomial operator+ <PolySize>
 171         (
 172             const icoPolynomial&,
 173             const icoPolynomial&
 174         );
 175
 176         friend icoPolynomial operator- <PolySize>
 177         (
 178             const icoPolynomial&,
 179             const icoPolynomial&
 180         );
 181
 182         friend icoPolynomial operator* <PolySize>
 183         (
 184             const scalar s,
 185             const icoPolynomial&
 186         );
 187
 188         friend icoPolynomial operator== <PolySize>
 189         (
 190             const icoPolynomial&,
 191             const icoPolynomial&
 192         );
 193
 194
 195     // Ostream Operator
 196
 197         friend Ostream& operator<< <PolySize>(Ostream&, const icoPolynomial&);
 198 };
 199
 200
 201 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 202
 203 } // End namespace Foam
 204
 205 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 206
 207 #define makeIcoPolynomial(PolySize)                                          \
 208                                                                              \
 209 defineTemplateTypeNameAndDebugWithName                                       \
 210 (                                                                            \
 211     icoPolynomial<PolySize>,                                                 \
 212     "icoPolynomial<"#PolySize">",                                            \
 213     0                                                                        \
 214 );
 215
 216 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 217
 218 #include "icoPolynomialI.H"
 219
 220 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 221
 222 #ifdef NoRepository
 223 #   include "icoPolynomial.C"
 224 #endif
 225
 226 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 227
 228 #endif
 229
 230 // ************************************************************************* //