src/thermophysicalModels/specie/reaction/reactionRate/ChemicallyActivatedReactionRate/ChemicallyActivatedReactionRate.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::ChemicallyActivatedReactionRate
  27
  28 Description
  29     General class for handling chemically-activated bimolecular reactions.
  30
  31 SourceFiles
  32     ChemicallyActivatedReactionRateI.H
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef ChemicallyActivatedReactionRate_H
  37 #define ChemicallyActivatedReactionRate_H
  38
  39 #include "thirdBodyEfficiencies.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 // Forward declaration of friend functions and operators
  47
  48 template<class ReactionRate, class ChemicallyActivationFunction>
  49 class ChemicallyActivatedReactionRate;
  50
  51 template<class ReactionRate, class ChemicallyActivationFunction>
  52 inline Ostream& operator<<
  53 (
  54     Ostream&,
  55     const ChemicallyActivatedReactionRate
  56         <ReactionRate, ChemicallyActivationFunction>&
  57 );
  58
  59
  60 /*---------------------------------------------------------------------------*\
  61               Class ChemicallyActivatedReactionRate Declaration
  62 \*---------------------------------------------------------------------------*/
  63
  64 template<class ReactionRate, class ChemicallyActivationFunction>
  65 class ChemicallyActivatedReactionRate
  66 {
  67     // Private data
  68
  69         ReactionRate k0_;
  70         ReactionRate kInf_;
  71         ChemicallyActivationFunction F_;
  72         thirdBodyEfficiencies thirdBodyEfficiencies_;
  73
  74
  75 public:
  76
  77     // Constructors
  78
  79         //- Construct from components
  80         inline ChemicallyActivatedReactionRate
  81         (
  82             const ReactionRate& k0,
  83             const ReactionRate& kInf,
  84             const ChemicallyActivationFunction& F,
  85             const thirdBodyEfficiencies& tbes
  86         );
  87
  88         //- Construct from Istream
  89         inline ChemicallyActivatedReactionRate
  90         (
  91             const speciesTable& species,
  92             Istream& is
  93         );
  94
  95
  96     // Member Functions
  97
  98         //- Return the type name
  99         static word type()
 100         {
 101             return ReactionRate::type()
 102                 + ChemicallyActivationFunction::type()
 103                 + "ChemicallyActivated";
 104         }
 105
 106         inline scalar operator()
 107         (
 108             const scalar T,
 109             const scalar p,
 110             const scalarField& c
 111         ) const;
 112
 113
 114     // Ostream Operator
 115
 116         friend Ostream& operator<< <ReactionRate, ChemicallyActivationFunction>
 117         (
 118             Ostream&,
 119             const ChemicallyActivatedReactionRate
 120                 <ReactionRate, ChemicallyActivationFunction>&
 121         );
 122 };
 123
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 } // End namespace Foam
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 #include "ChemicallyActivatedReactionRateI.H"
 132
 133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 134
 135 #endif
 136
 137 // ************************************************************************* //