src/lagrangian/intermediate/parcels/derived/BasicReactingParcel/BasicReactingParcel.H

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