OpenFOAM logo
Open Source CFD Toolkit

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-2005 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 the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     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, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     FallOffReactionRate
00027 
00028 Description
00029     General class for handling unimolecular/recombination fall-off reactions.
00030 
00031 SourceFiles
00032     FallOffReactionRateI.H
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef FallOffReactionRate_H
00037 #define FallOffReactionRate_H
00038 
00039 #include "thirdBodyEfficiencies.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 // * * * * * * Forward declaration of template friend fuctions * * * * * * * //
00047 
00048 template<class ReactionRate, class FallOffFunction>
00049 class FallOffReactionRate;
00050 
00051 template<class ReactionRate, class FallOffFunction>
00052 inline Ostream& operator<<
00053 (
00054     Ostream&,
00055     const FallOffReactionRate<ReactionRate, FallOffFunction>&
00056 );
00057 
00058 
00059 /*---------------------------------------------------------------------------*\
00060               Class FallOffReactionRate Declaration
00061 \*---------------------------------------------------------------------------*/
00062 
00063 template<class ReactionRate, class FallOffFunction>
00064 class FallOffReactionRate
00065 {
00066     // Private data
00067 
00068         ReactionRate k0_;
00069         ReactionRate kInf_;
00070         FallOffFunction F_;
00071         thirdBodyEfficiencies thirdBodyEfficiencies_;
00072 
00073 
00074 public:
00075 
00076     // Constructors
00077 
00078         //- Construct from components
00079         inline FallOffReactionRate
00080         (
00081             const ReactionRate& k0,
00082             const ReactionRate& kInf,
00083             const FallOffFunction& F,
00084             const thirdBodyEfficiencies& tbes
00085         );
00086 
00087         //- Construct from Istream
00088         inline FallOffReactionRate
00089         (
00090             const speciesTable& species,
00091             Istream& is
00092         );
00093 
00094 
00095     // Member Functions
00096 
00097         //- Return the type name
00098         static word type()
00099         {
00100             return ReactionRate::type() + FallOffFunction::type() + "FallOff";
00101         }
00102 
00103         inline scalar operator()
00104         (
00105             const scalar T,
00106             const scalar p,
00107             const scalarField& c
00108         ) const;
00109 
00110 
00111     // Ostream Operator
00112 
00113         friend Ostream& operator<< <ReactionRate, FallOffFunction>
00114         (
00115             Ostream&,
00116             const FallOffReactionRate<ReactionRate, FallOffFunction>&
00117         );
00118 };
00119 
00120 
00121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00122 
00123 } // End namespace Foam
00124 
00125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00126 
00127 #include "FallOffReactionRateI.H"
00128 
00129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00130 
00131 #endif
00132 
00133 // ************************************************************************* //
For further information go to www.openfoam.org