src/lagrangian/coalCombustion/CoalParcel/CoalParcel.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     CoalParcel
  27
  28 Description
  29
  30
  31 SourceFiles
  32     CoalParcel.C
  33     CoalParcelIO.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef CoalParcel_H
  38 #define CoalParcel_H
  39
  40 #include "ReactingMultiphaseParcel.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of classes
  48 template<class ThermoType>
  49 class CoalParcel;
  50
  51 /*---------------------------------------------------------------------------*\
  52                          Class CoalParcel Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 template<class ThermoType>
  56 class CoalParcel
  57 :
  58     public ReactingMultiphaseParcel<CoalParcel<ThermoType> >
  59 {
  60 public:
  61
  62     //- The type of thermodynamics this parcel was instantiated for
  63     typedef ThermoType thermoType;
  64
  65     // Run-time type information
  66     TypeName("CoalParcel");
  67
  68     // Constructors
  69
  70         //- Construct from owner, position, and cloud owner
  71         //  Other properties initialised as null
  72         CoalParcel
  73         (
  74              ReactingMultiphaseCloud<CoalParcel>& owner,
  75              const vector& position,
  76              const label cellI
  77         );
  78
  79         //- Construct from components
  80         CoalParcel
  81         (
  82              ReactingMultiphaseCloud<CoalParcel>& owner,
  83              const vector& position,
  84              const label cellI,
  85              const label typeId,
  86              const scalar nParticle0,
  87              const scalar d0,
  88              const vector& U0,
  89              const scalarField& YMixture0,
  90              const scalarField& YGas0,
  91              const scalarField& YLiquid0,
  92              const scalarField& YSolid0,
  93              const typename
  94                  ReactingMultiphaseParcel<CoalParcel>::
  95                  constantProperties& constProps
  96         );
  97
  98         //- Construct from Istream
  99         CoalParcel
 100         (
 101             const Cloud<CoalParcel>& c,
 102             Istream& is,
 103             bool readFields = true
 104         );
 105
 106         //- Construct and return a clone
 107         autoPtr<CoalParcel> clone() const
 108         {
 109             return autoPtr<CoalParcel>(new CoalParcel(*this));
 110         }
 111
 112
 113     //- Destructor
 114     virtual ~CoalParcel();
 115 };
 116
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 } // End namespace Foam
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #ifdef NoRepository
 125     #include "CoalParcel.C"
 126 #endif
 127
 128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 129
 130 #endif
 131
 132 // ************************************************************************* //