initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / thermophysicalModels / specie / transport / speciesTransport / speciesTransport.H
blob885e4bb2fd97351c1014f2b662ffea9513ed7f42
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.
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.
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.
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
25 Class
26     Foam::speciesTransport
28 Description
29     Basic species transport type based on the use of a fitting
30     function for nu.
32     All other properties are derived from this primitive function.
34     The nu function must be provided by the derived type,
35     e.g. SutherlandTransport.
37 SourceFiles
38     speciesTransportI.H
39     speciesTransport.C
42 \*---------------------------------------------------------------------------*/
44 #ifndef speciesTransport_H
45 #define speciesTransport_H
47 //#include "speciesThermo.H"
48 #include "janafThermo.H"
50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52 namespace Foam
55 /*---------------------------------------------------------------------------*\
56                            Class speciesTransport Declaration
57 \*---------------------------------------------------------------------------*/
59 class speciesTransport
61     public janafThermo
64 public:
66     // Constructors
68         //- Construct from speciesThermo
69         inline speciesTransport
70         (
71             const janafThermo& sThermo
72         );
74         //- Construct from Istream
75         speciesTransport(Istream&);
78     // Member Functions
80         // Dynamic viscosity [kg/ms]
81         //inline scalar mu(const scalar T) const
83         // Thermal conductivity [W/mK]
84         //inline scalar kappa(const scalar T) const;
86         // Thermal diffusivity for enthalpy [kg/ms]
87         //inline scalar alpha(const scalar T) const;
89         // Species diffusivity
90         //inline scalar D(const scalar T) const;
93     // Ostream Operator
95         friend Ostream& operator<<(Ostream&, const speciesTransport&);
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 } // End namespace Foam
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 #include "speciesTransportI.H"
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 #endif
111 // ************************************************************************* //