src/thermophysicalModels/specie/transport/speciesTransport/speciesTransport.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::speciesTransport
  26
  27 Description
  28     Basic species transport type based on the use of a fitting
  29     function for nu.
  30
  31     All other properties are derived from this primitive function.
  32
  33     The nu function must be provided by the derived type,
  34     e.g. SutherlandTransport.
  35
  36 SourceFiles
  37     speciesTransportI.H
  38     speciesTransport.C
  39
  40 \*---------------------------------------------------------------------------*/
  41
  42 #ifndef speciesTransport_H
  43 #define speciesTransport_H
  44
  45 //#include "speciesThermo.H"
  46 #include "janafThermo.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 /*---------------------------------------------------------------------------*\
  54                            Class speciesTransport Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class speciesTransport
  58 :
  59     public janafThermo
  60 {
  61
  62 public:
  63
  64     // Constructors
  65
  66         //- Construct from speciesThermo
  67         inline speciesTransport(const janafThermo& sThermo);
  68
  69         //- Construct from Istream
  70         speciesTransport(Istream&);
  71
  72         //- Construct from dictionary
  73         speciesTransport(const dictionary& dict);
  74
  75
  76     // Member Functions
  77
  78         // Dynamic viscosity [kg/ms]
  79         //inline scalar mu(const scalar T) const
  80
  81         // Thermal conductivity [W/mK]
  82         //inline scalar kappa(const scalar T) const;
  83
  84         // Thermal diffusivity for enthalpy [kg/ms]
  85         //inline scalar alpha(const scalar T) const;
  86
  87         // Species diffusivity
  88         //inline scalar D(const scalar T) const;
  89
  90         //- Write to Ostream
  91         void write(Ostream& os) const;
  92
  93
  94     // Ostream Operator
  95
  96         friend Ostream& operator<<(Ostream&, const speciesTransport&);
  97 };
  98
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 } // End namespace Foam
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 #include "speciesTransportI.H"
 107
 108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 109
 110 #endif
 111
 112 // ************************************************************************* //