src/lagrangian/basic/passiveParticle/passiveParticleCloud.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::passiveParticleCloud
  27
  28 Description
  29     A Cloud of passive particles
  30
  31 SourceFiles
  32     passiveParticleCloud.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef passiveParticleCloud_H
  37 #define passiveParticleCloud_H
  38
  39 #include "Cloud.H"
  40 #include "passiveParticle.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                    Class passiveParticleCloud Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class passiveParticleCloud
  52 :
  53     public Cloud<passiveParticle>
  54 {
  55     // Private Member Functions
  56
  57         //- Disallow default bitwise copy construct
  58         passiveParticleCloud(const passiveParticleCloud&);
  59
  60         //- Disallow default bitwise assignment
  61         void operator=(const passiveParticleCloud&);
  62
  63
  64 public:
  65
  66     //- Type of parcel the cloud was instantiated for
  67     typedef passiveParticle parcelType;
  68
  69     // Constructors
  70
  71         //- Construct given mesh
  72         passiveParticleCloud
  73         (
  74             const polyMesh&,
  75             const word& cloudName = "defaultCloud",
  76             bool readFields = true
  77         );
  78
  79         //- Construct from mesh, cloud name, and a list of particles
  80         passiveParticleCloud
  81         (
  82             const polyMesh& mesh,
  83             const word& cloudName,
  84             const IDLList<passiveParticle>& particles
  85         );
  86 };
  87
  88
  89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  90
  91 } // End namespace Foam
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 #endif
  96
  97 // ************************************************************************* //