src/lagrangian/intermediate/parcels/derived/basicThermoParcel/basicThermoParcel.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::basicThermoParcel
  27
  28 Description
  29
  30
  31 SourceFiles
  32     basicThermoParcel.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef basicThermoParcel_H
  37 #define basicThermoParcel_H
  38
  39 #include "ThermoParcel.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                       Class basicThermoParcel Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class basicThermoParcel
  51 :
  52     public ThermoParcel<basicThermoParcel>
  53 {
  54
  55 public:
  56
  57     //- Runtime type information
  58     TypeName("basicThermoParcel");
  59
  60     // Constructors
  61
  62        //- Construct from owner, position, and cloud owner
  63        //  Other properties initialised as null
  64        basicThermoParcel
  65        (
  66             ThermoCloud<basicThermoParcel>& owner,
  67             const vector position,
  68             const label cellI
  69        );
  70
  71        //- Construct from components
  72        basicThermoParcel
  73        (
  74             ThermoCloud<basicThermoParcel>& owner,
  75             const vector position,
  76             const label cellI,
  77             const label typeId,
  78             const scalar nParticle0,
  79             const scalar d0,
  80             const vector U0,
  81             const constantProperties& constProps
  82         );
  83
  84         //- Construct from Istream
  85         basicThermoParcel
  86         (
  87             const Cloud<basicThermoParcel>& c,
  88             Istream& is,
  89             bool readFields = true
  90         );
  91
  92         //- Construct as a copy
  93         basicThermoParcel(const basicThermoParcel& p);
  94
  95         //- Construct and return a clone
  96         autoPtr<basicThermoParcel> clone() const
  97         {
  98             return
  99                 autoPtr<basicThermoParcel>
 100                 (
 101                     new basicThermoParcel(*this)
 102                 );
 103         }
 104
 105
 106     //- Destructor
 107     virtual ~basicThermoParcel();
 108 };
 109
 110
 111 template<>
 112 inline bool contiguous<basicThermoParcel>()
 113 {
 114     return true;
 115 }
 116
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 } // End namespace Foam
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #endif
 125
 126 // ************************************************************************* //