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

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