src/thermophysicalModels/specie/transport/polynomial/polynomialTransport.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2008-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::polynomialTransport
  27
  28 Description
  29     Transport package using polynomial functions for mu and kappa
  30
  31 SourceFiles
  32     polynomialTransportI.H
  33     polynomialTransport.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef polynomialTransport_H
  38 #define polynomialTransport_H
  39
  40 #include <OpenFOAM/Polynomial.H>
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of friend functions and operators
  48
  49 template<class Thermo, int PolySize> class polynomialTransport;
  50
  51 template<class Thermo, int PolySize>
  52 inline polynomialTransport<Thermo, PolySize> operator+
  53 (
  54     const polynomialTransport<Thermo, PolySize>&,
  55     const polynomialTransport<Thermo, PolySize>&
  56 );
  57
  58 template<class Thermo, int PolySize>
  59 inline polynomialTransport<Thermo, PolySize> operator-
  60 (
  61     const polynomialTransport<Thermo, PolySize>&,
  62     const polynomialTransport<Thermo, PolySize>&
  63 );
  64
  65 template<class Thermo, int PolySize>
  66 inline polynomialTransport<Thermo, PolySize> operator*
  67 (
  68     const scalar,
  69     const polynomialTransport<Thermo, PolySize>&
  70 );
  71
  72 template<class Thermo, int PolySize>
  73 inline polynomialTransport<Thermo, PolySize> operator==
  74 (
  75     const polynomialTransport<Thermo, PolySize>&,
  76     const polynomialTransport<Thermo, PolySize>&
  77 );
  78
  79 template<class Thermo, int PolySize>
  80 Ostream& operator<<
  81 (
  82     Ostream&,
  83     const polynomialTransport<Thermo, PolySize>&
  84 );
  85
  86
  87 /*---------------------------------------------------------------------------*\
  88                      Class polynomialTransport Declaration
  89 \*---------------------------------------------------------------------------*/
  90
  91 template<class Thermo, int PolySize>
  92 class polynomialTransport
  93 :
  94     public Thermo
  95 {
  96     // Private data
  97
  98         //- Dynamic viscosity
  99         Polynomial<PolySize> muPolynomial_;
 100
 101         //- Thermal conductivity
 102         Polynomial<PolySize> kappaPolynomial_;
 103
 104
 105     // Private member functions
 106
 107         //- Construct from components
 108         inline polynomialTransport
 109         (
 110             const Thermo& t,
 111             const Polynomial<PolySize>& muPoly,
 112             const Polynomial<PolySize>& kappaPoly
 113         );
 114
 115
 116 public:
 117
 118     // Constructors
 119
 120         //- Construct as named copy
 121         inline polynomialTransport(const word&, const polynomialTransport&);
 122
 123         //- Construct from Istream
 124         polynomialTransport(Istream& is);
 125
 126         //- Construct and return a clone
 127         inline autoPtr<polynomialTransport> clone() const;
 128
 129         // Selector from Istream
 130         inline static autoPtr<polynomialTransport> New(Istream& is);
 131
 132
 133     // Member functions
 134
 135         //- Dynamic viscosity [kg/ms]
 136         inline scalar mu(const scalar T) const;
 137
 138         //- Thermal conductivity [W/mK]
 139         inline scalar kappa(const scalar T) const;
 140
 141         //- Thermal diffusivity for enthalpy [kg/ms]
 142         inline scalar alpha(const scalar T) const;
 143
 144         // Species diffusivity
 145         //inline scalar D(const scalar T) const;
 146
 147
 148     // Member operators
 149
 150         inline polynomialTransport& operator=(const polynomialTransport&);
 151
 152
 153     // Friend operators
 154
 155         friend polynomialTransport operator+ <Thermo, PolySize>
 156         (
 157             const polynomialTransport&,
 158             const polynomialTransport&
 159         );
 160
 161         friend polynomialTransport operator- <Thermo, PolySize>
 162         (
 163             const polynomialTransport&,
 164             const polynomialTransport&
 165         );
 166
 167         friend polynomialTransport operator* <Thermo, PolySize>
 168         (
 169             const scalar,
 170             const polynomialTransport&
 171         );
 172
 173         friend polynomialTransport operator== <Thermo, PolySize>
 174         (
 175             const polynomialTransport&,
 176             const polynomialTransport&
 177         );
 178
 179
 180     // Ostream Operator
 181
 182         friend Ostream& operator<< <Thermo, PolySize>
 183         (
 184             Ostream&,
 185             const polynomialTransport&
 186         );
 187 };
 188
 189
 190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 191
 192 } // End namespace Foam
 193
 194 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 195
 196 #include "polynomialTransportI.H"
 197
 198 #ifdef NoRepository
 199 #   include "polynomialTransport.C"
 200 #endif
 201
 202 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 203
 204 #endif
 205
 206 // ************************ vim: set sw=4 sts=4 et: ************************ //