src/lagrangian/intermediate/submodels/Reacting/SurfaceReactionModel/NoSurfaceReaction/NoSurfaceReaction.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::NoSurfaceReaction
  27
  28 Description
  29     Dummy Devolatisation model for 'no devolatisation'
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef NoSurfaceReaction_H
  34 #define NoSurfaceReaction_H
  35
  36 #include "SurfaceReactionModel.H"
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42 /*---------------------------------------------------------------------------*\
  43                             Class NoSurfaceReaction Declaration
  44 \*---------------------------------------------------------------------------*/
  45
  46 template<class CloudType>
  47 class NoSurfaceReaction
  48 :
  49     public SurfaceReactionModel<CloudType>
  50 {
  51
  52 public:
  53
  54     //- Runtime type information
  55     TypeName("NoSurfaceReaction");
  56
  57
  58     // Constructors
  59
  60         //- Construct from dictionary
  61         NoSurfaceReaction
  62         (
  63             const dictionary& dict,
  64             CloudType& owner
  65         );
  66
  67
  68     // Destructor
  69
  70         ~NoSurfaceReaction();
  71
  72
  73     // Member Functions
  74
  75         //- Flag to indicate whether model activates devolatisation model
  76         bool active() const;
  77
  78         //- Update surface reactions
  79         void calculate
  80         (
  81             const scalar dt,
  82             const label celli,
  83             const scalar dp,
  84             const scalar T0,
  85             const scalar T1,
  86             const scalar Tc,
  87             const scalar rhoc,
  88             const scalar massp,
  89             scalarField& YGas,
  90             scalarField& YLiquid,
  91             scalarField& YSolid,
  92             scalarField& YMixture,
  93             scalar& dMassMTSR,
  94             scalarList& dMassSR
  95         ) const;
  96 };
  97
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 } // End namespace Foam
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #ifdef NoRepository
 106 #   include "NoSurfaceReaction.C"
 107 #endif
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #endif
 112
 113 // ************************************************************************* //