src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/SingleKineticRateDevolatilisation/SingleKineticRateDevolatilisation.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::SingleKineticRateDevolatilisation
  27
  28 Description
  29     Single kinetic rate devolatisation model
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef SingleKineticRateDevolatilisation_H
  34 #define SingleKineticRateDevolatilisation_H
  35
  36 #include "DevolatilisationModel.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42 /*---------------------------------------------------------------------------*\
  43               Class SingleKineticRateDevolatilisation Declaration
  44 \*---------------------------------------------------------------------------*/
  45
  46 template<class CloudType>
  47 class SingleKineticRateDevolatilisation
  48 :
  49     public DevolatilisationModel<CloudType>
  50 {
  51     // Private data
  52
  53         // Model constants
  54
  55             //- Activation energy
  56             const scalar A1_;
  57
  58             //- Pre-exoponential factor
  59             const scalar E_;
  60
  61             //- Volatile residual coefficient (0-1)
  62             //  When the fraction of volatiles are depleted below this
  63             //  threshold, combustion can occur
  64             const scalar volatileResidualCoeff_;
  65
  66
  67 public:
  68
  69     //- Runtime type information
  70     TypeName("SingleKineticRateDevolatilisation");
  71
  72
  73     // Constructors
  74
  75         //- Construct from dictionary
  76         SingleKineticRateDevolatilisation
  77         (
  78             const dictionary& dict,
  79             CloudType& owner
  80         );
  81
  82
  83     //- Destructor
  84     virtual ~SingleKineticRateDevolatilisation();
  85
  86
  87     // Member Functions
  88
  89         //- Flag to indicate whether model activates devolatilisation model
  90         virtual bool active() const;
  91
  92         //- Update model
  93         virtual scalar calculate
  94         (
  95             const scalar dt,
  96             const scalar mass0,
  97             const scalar mass,
  98             const scalar T,
  99             const scalar YVolatile0,
 100             const scalar YVolatile,
 101             bool& canCombust
 102         ) const;
 103 };
 104
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 } // End namespace Foam
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #ifdef NoRepository
 113 #   include "SingleKineticRateDevolatilisation.C"
 114 #endif
 115
 116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 117
 118 #endif
 119
 120 // ************************************************************************* //