src/thermophysicalModels/solid/reaction/reactionRate/solidArrheniusReactionRate/solidArrheniusReactionRate.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::solidArrheniusReactionRate
  26
  27 Description
  28     Arrhenius reaction rate for solids
  29
  30 SourceFiles
  31     solidArrheniusReactionRateI.H
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef solidArrheniusReactionRate_H
  36 #define solidArrheniusReactionRate_H
  37
  38 #include "scalarField.H"
  39 #include "typeInfo.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                        Class solidArrheniusReactionRate Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class solidArrheniusReactionRate
  51 {
  52     // Private data
  53
  54         scalar A_;
  55         scalar Ta_;
  56         scalar Tcrit_;
  57
  58
  59 public:
  60
  61     // Constructors
  62
  63         //- Construct from components
  64         inline solidArrheniusReactionRate
  65         (
  66             const scalar A,
  67             const scalar Ta,
  68             const scalar Tcrit
  69         );
  70
  71         //- Construct from Istream
  72         inline solidArrheniusReactionRate
  73         (
  74             const speciesTable& species,
  75             Istream& is
  76         );
  77
  78
  79     // Member Functions
  80
  81         //- Return the type name
  82         static word type()
  83         {
  84             return "SolidArrhenius";
  85         }
  86
  87         inline scalar operator()
  88         (
  89             const scalar T,
  90             const scalar p,
  91             const scalarField& c
  92         ) const;
  93
  94
  95     // Ostream Operator
  96
  97         inline friend Ostream& operator<<
  98         (
  99             Ostream&,
 100             const solidArrheniusReactionRate&
 101         );
 102 };
 103
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 } // End namespace Foam
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #include "solidArrheniusReactionRateI.H"
 112
 113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 114
 115 #endif
 116
 117 // ************************************************************************* //