src/lagrangian/intermediate/parcels/baseClasses/reactingParcel/reactingParcel.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::basicReactingParcel
  27
  28 Description
  29     Base class for reacting parcel - simply used to set the contiguous flag
  30
  31 SourceFiles
  32     reactingParcel.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef reactingParcel_H
  37 #define reactingParcel_H
  38
  39 #include "typeInfo.H"
  40 #include "contiguous.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                        Class reactingParcel Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class reactingParcel
  52 {
  53 public:
  54
  55     //- Run-time type information
  56     TypeName("reactingParcel");
  57
  58     //- Construct null
  59     reactingParcel();
  60
  61     //- Destructor
  62     virtual ~reactingParcel();
  63 };
  64
  65
  66 template<>
  67 inline bool contiguous<reactingParcel>()
  68 {
  69     return false; // Derived classes include scalar lists/fields
  70 }
  71
  72
  73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  74
  75 } // End namespace Foam
  76
  77 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  78
  79 #endif
  80
  81 // ************************************************************************* //