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