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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::LandauTellerReactionRate
  26
  27 Description
  28     Landau-Teller reaction rate.
  29
  30 SourceFiles
  31     LandauTellerReactionRateI.H
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef LandauTellerReactionRate_H
  36 #define LandauTellerReactionRate_H
  37
  38 #include "scalarField.H"
  39 #include "typeInfo.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class LandauTellerReactionRate Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class LandauTellerReactionRate
  51 {
  52     // Private data
  53
  54         scalar A_;
  55         scalar beta_;
  56         scalar Ta_;
  57         scalar B_;
  58         scalar C_;
  59
  60 public:
  61
  62     // Constructors
  63
  64         //- Construct from components
  65         inline LandauTellerReactionRate
  66         (
  67             const scalar A,
  68             const scalar beta,
  69             const scalar Ta,
  70             const scalar B,
  71             const scalar C
  72         );
  73
  74         //- Construct from Istream
  75         inline LandauTellerReactionRate
  76         (
  77             const speciesTable& species,
  78             Istream& is
  79         );
  80
  81
  82     // Member Functions
  83
  84         //- Return the type name
  85         static word type()
  86         {
  87             return "LandauTeller";
  88         }
  89
  90         inline scalar operator()
  91         (
  92             const scalar T,
  93             const scalar p,
  94             const scalarField& c
  95         ) const;
  96
  97
  98     // Ostream Operator
  99
 100         inline friend Ostream& operator<<
 101         (
 102             Ostream&,
 103             const LandauTellerReactionRate&
 104         );
 105 };
 106
 107
 108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 109
 110 } // End namespace Foam
 111
 112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 113
 114 #include "LandauTellerReactionRateI.H"
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 #endif
 119
 120 // ************************************************************************* //