src/thermophysicalModels/specie/reaction/reactionRate/FallOffReactionRate/FallOffReactionRate.H

   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.
  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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::FallOffReactionRate
  27
  28 Description
  29     General class for handling unimolecular/recombination fall-off reactions.
  30
  31 SourceFiles
  32     FallOffReactionRateI.H
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef FallOffReactionRate_H
  37 #define FallOffReactionRate_H
  38
  39 #include <specie/thirdBodyEfficiencies.H>
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 // Forward declaration of friend functions and operators
  47
  48 template<class ReactionRate, class FallOffFunction>
  49 class FallOffReactionRate;
  50
  51 template<class ReactionRate, class FallOffFunction>
  52 inline Ostream& operator<<
  53 (
  54     Ostream&,
  55     const FallOffReactionRate<ReactionRate, FallOffFunction>&
  56 );
  57
  58
  59 /*---------------------------------------------------------------------------*\
  60               Class FallOffReactionRate Declaration
  61 \*---------------------------------------------------------------------------*/
  62
  63 template<class ReactionRate, class FallOffFunction>
  64 class FallOffReactionRate
  65 {
  66     // Private data
  67
  68         ReactionRate k0_;
  69         ReactionRate kInf_;
  70         FallOffFunction F_;
  71         thirdBodyEfficiencies thirdBodyEfficiencies_;
  72
  73
  74 public:
  75
  76     // Constructors
  77
  78         //- Construct from components
  79         inline FallOffReactionRate
  80         (
  81             const ReactionRate& k0,
  82             const ReactionRate& kInf,
  83             const FallOffFunction& F,
  84             const thirdBodyEfficiencies& tbes
  85         );
  86
  87         //- Construct from Istream
  88         inline FallOffReactionRate
  89         (
  90             const speciesTable& species,
  91             Istream& is
  92         );
  93
  94
  95     // Member Functions
  96
  97         //- Return the type name
  98         static word type()
  99         {
 100             return ReactionRate::type() + FallOffFunction::type() + "FallOff";
 101         }
 102
 103         inline scalar operator()
 104         (
 105             const scalar T,
 106             const scalar p,
 107             const scalarField& c
 108         ) const;
 109
 110
 111     // Ostream Operator
 112
 113         friend Ostream& operator<< <ReactionRate, FallOffFunction>
 114         (
 115             Ostream&,
 116             const FallOffReactionRate<ReactionRate, FallOffFunction>&
 117         );
 118 };
 119
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 } // End namespace Foam
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 #include <specie/FallOffReactionRateI.H>
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 #endif
 132
 133 // ************************ vim: set sw=4 sts=4 et: ************************ //