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

FallOffReactionRate.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::FallOffReactionRate
00026 
00027 Description
00028     General class for handling unimolecular/recombination fall-off reactions.
00029 
00030 SourceFiles
00031     FallOffReactionRateI.H
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef FallOffReactionRate_H
00036 #define FallOffReactionRate_H
00037 
00038 #include <specie/thirdBodyEfficiencies.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 // Forward declaration of friend functions and operators
00046 
00047 template<class ReactionRate, class FallOffFunction>
00048 class FallOffReactionRate;
00049 
00050 template<class ReactionRate, class FallOffFunction>
00051 inline Ostream& operator<<
00052 (
00053     Ostream&,
00054     const FallOffReactionRate<ReactionRate, FallOffFunction>&
00055 );
00056 
00057 
00058 /*---------------------------------------------------------------------------*\
00059               Class FallOffReactionRate Declaration
00060 \*---------------------------------------------------------------------------*/
00061 
00062 template<class ReactionRate, class FallOffFunction>
00063 class FallOffReactionRate
00064 {
00065     // Private data
00066 
00067         ReactionRate k0_;
00068         ReactionRate kInf_;
00069         FallOffFunction F_;
00070         thirdBodyEfficiencies thirdBodyEfficiencies_;
00071 
00072 
00073 public:
00074 
00075     // Constructors
00076 
00077         //- Construct from components
00078         inline FallOffReactionRate
00079         (
00080             const ReactionRate& k0,
00081             const ReactionRate& kInf,
00082             const FallOffFunction& F,
00083             const thirdBodyEfficiencies& tbes
00084         );
00085 
00086         //- Construct from Istream
00087         inline FallOffReactionRate
00088         (
00089             const speciesTable& species,
00090             Istream& is
00091         );
00092 
00093 
00094     // Member Functions
00095 
00096         //- Return the type name
00097         static word type()
00098         {
00099             return ReactionRate::type() + FallOffFunction::type() + "FallOff";
00100         }
00101 
00102         inline scalar operator()
00103         (
00104             const scalar T,
00105             const scalar p,
00106             const scalarField& c
00107         ) const;
00108 
00109 
00110     // Ostream Operator
00111 
00112         friend Ostream& operator<< <ReactionRate, FallOffFunction>
00113         (
00114             Ostream&,
00115             const FallOffReactionRate<ReactionRate, FallOffFunction>&
00116         );
00117 };
00118 
00119 
00120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00121 
00122 } // End namespace Foam
00123 
00124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00125 
00126 #include <specie/FallOffReactionRateI.H>
00127 
00128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00129 
00130 #endif
00131 
00132 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines