src/thermophysicalModels/specie/transport/const/constTransport.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::constTransport
  27
  28 Description
  29     Constant properties Transport package.
  30     Templated into a given thermodynamics package (needed for thermal
  31     conductivity).
  32
  33 SourceFiles
  34     constTransportI.H
  35     constTransport.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef constTransport_H
  40 #define constTransport_H
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of friend functions and operators
  48
  49 template<class thermo> class constTransport;
  50
  51 template<class thermo>
  52 inline constTransport<thermo> operator+
  53 (
  54     const constTransport<thermo>&,
  55     const constTransport<thermo>&
  56 );
  57
  58 template<class thermo>
  59 inline constTransport<thermo> operator-
  60 (
  61     const constTransport<thermo>&,
  62     const constTransport<thermo>&
  63 );
  64
  65 template<class thermo>
  66 inline constTransport<thermo> operator*
  67 (
  68     const scalar,
  69     const constTransport<thermo>&
  70 );
  71
  72 template<class thermo>
  73 inline constTransport<thermo> operator==
  74 (
  75     const constTransport<thermo>&,
  76     const constTransport<thermo>&
  77 );
  78
  79 template<class thermo>
  80 Ostream& operator<<
  81 (
  82     Ostream&,
  83     const constTransport<thermo>&
  84 );
  85
  86
  87 /*---------------------------------------------------------------------------*\
  88                            Class constTransport Declaration
  89 \*---------------------------------------------------------------------------*/
  90
  91 template<class thermo>
  92 class constTransport
  93 :
  94     public thermo
  95 {
  96     // Private data
  97
  98         //- Constant viscosity and reciprocal Prandtl Number.
  99         scalar Mu, rPr;
 100
 101
 102     // Private member functions
 103
 104         //- Construct from components
 105         inline constTransport
 106         (
 107             const thermo& t,
 108             const scalar nu,
 109             const scalar Pr
 110         );
 111
 112
 113 public:
 114
 115     // Constructors
 116
 117         //- Construct as named copy
 118         inline constTransport(const word&, const constTransport&);
 119
 120         //- Construct from Istream
 121         constTransport(Istream&);
 122
 123
 124     // Member functions
 125
 126         //- Dynamic viscosity [kg/ms]
 127         inline scalar mu(const scalar T) const;
 128
 129         //- Thermal conductivity [W/mK]
 130         inline scalar kappa(const scalar T) const;
 131
 132         //- Thermal diffusivity for enthalpy [kg/ms]
 133         inline scalar alpha(const scalar T) const;
 134
 135         // Species diffusivity
 136         //inline scalar D(const scalar T) const;
 137
 138
 139     // Member operators
 140
 141         inline constTransport& operator=
 142         (
 143             const constTransport&
 144         );
 145
 146
 147     // Friend operators
 148
 149         friend constTransport operator+ <thermo>
 150         (
 151             const constTransport&,
 152             const constTransport&
 153         );
 154
 155         friend constTransport operator- <thermo>
 156         (
 157             const constTransport&,
 158             const constTransport&
 159         );
 160
 161         friend constTransport operator* <thermo>
 162         (
 163             const scalar,
 164             const constTransport&
 165         );
 166
 167         friend constTransport operator== <thermo>
 168         (
 169             const constTransport&,
 170             const constTransport&
 171         );
 172
 173
 174     // Ostream Operator
 175
 176         friend Ostream& operator<< <thermo>
 177         (
 178             Ostream&,
 179             const constTransport&
 180         );
 181 };
 182
 183
 184 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 185
 186 } // End namespace Foam
 187
 188 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 189
 190 #include "constTransportI.H"
 191
 192 #ifdef NoRepository
 193 #   include "constTransport.C"
 194 #endif
 195
 196 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 197
 198 #endif
 199
 200 // ************************************************************************* //