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

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-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::NoSurfaceReaction
  27
  28 Description
  29     Dummy surface reaction model for 'none'
  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 public:
  52
  53     //- Runtime type information
  54     TypeName("none");
  55
  56
  57     // Constructors
  58
  59         //- Construct from dictionary
  60         NoSurfaceReaction
  61         (
  62             const dictionary& dict,
  63             CloudType& owner
  64         );
  65
  66
  67     //- Destructor
  68     virtual ~NoSurfaceReaction();
  69
  70
  71     // Member Functions
  72
  73         //- Flag to indicate whether model activates devolatisation model
  74         virtual bool active() const;
  75
  76         //- Update surface reactions
  77         virtual scalar calculate
  78         (
  79             const scalar dt,
  80             const label cellI,
  81             const scalar d,
  82             const scalar T,
  83             const scalar Tc,
  84             const scalar pc,
  85             const scalar rhoc,
  86             const scalar mass,
  87             const scalarField& YGas,
  88             const scalarField& YLiquid,
  89             const scalarField& YSolid,
  90             const scalarField& YMixture,
  91             const scalarField& dMassVolatile,
  92             scalarField& dMassGas,
  93             scalarField& dMassLiquid,
  94             scalarField& dMassSolid,
  95             scalarField& dMassSRCarrier
  96         ) const;
  97 };
  98
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 } // End namespace Foam
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 #ifdef NoRepository
 107 #   include "NoSurfaceReaction.C"
 108 #endif
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #endif
 113
 114 // ************************************************************************* //