FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

thirdBodyEfficiencies.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::thirdBodyEfficiencies
00026 
00027 Description
00028     Third body efficiencies
00029 
00030 SourceFiles
00031     thirdBodyEfficienciesI.H
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef thirdBodyEfficiencies_H
00036 #define thirdBodyEfficiencies_H
00037 
00038 #include <OpenFOAM/scalarList.H>
00039 #include <specie/speciesTable.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 // Forward declaration of friend functions and operators
00047 
00048 class thirdBodyEfficiencies;
00049 Ostream& operator<<(Ostream&, const thirdBodyEfficiencies&);
00050 
00051 
00052 /*---------------------------------------------------------------------------*\
00053                            Class thirdBodyEfficiencies Declaration
00054 \*---------------------------------------------------------------------------*/
00055 
00056 class thirdBodyEfficiencies
00057 :
00058     public scalarList
00059 {
00060     // Private data
00061 
00062         const speciesTable& species_;
00063 
00064 
00065 public:
00066 
00067     // Constructors
00068 
00069         //- Construct from components
00070         inline thirdBodyEfficiencies
00071         (
00072             const speciesTable& species,
00073             const scalarList& efficiencies
00074         );
00075 
00076         //- Construct from Istream
00077         inline thirdBodyEfficiencies
00078         (
00079             const speciesTable& species,
00080             Istream& is
00081         );
00082 
00083 
00084     // Member functions
00085 
00086         //- Calculate and return M, the concentration of the third-bodies
00087         inline scalar M(const scalarList& c) const;
00088 
00089 
00090     // Ostream Operator
00091 
00092         friend Ostream& operator<<(Ostream&, const thirdBodyEfficiencies&);
00093 };
00094 
00095 
00096 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00097 
00098 } // End namespace Foam
00099 
00100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00101 
00102 #include <specie/thirdBodyEfficienciesI.H>
00103 
00104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00105 
00106 #endif
00107 
00108 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines