src/lagrangian/basic/passiveParticle/passiveParticleCloud.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::passiveParticleCloud
  26
  27 Description
  28     A Cloud of passive particles
  29
  30 SourceFiles
  31     passiveParticleCloud.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef passiveParticleCloud_H
  36 #define passiveParticleCloud_H
  37
  38 #include "Cloud.H"
  39 #include "passiveParticle.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                    Class passiveParticleCloud Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class passiveParticleCloud
  51 :
  52     public Cloud<passiveParticle>
  53 {
  54     // Private Member Functions
  55
  56         //- Disallow default bitwise copy construct
  57         passiveParticleCloud(const passiveParticleCloud&);
  58
  59         //- Disallow default bitwise assignment
  60         void operator=(const passiveParticleCloud&);
  61
  62
  63 public:
  64
  65     // Constructors
  66
  67         //- Construct given mesh
  68         passiveParticleCloud
  69         (
  70             const polyMesh&,
  71             const word& cloudName = "defaultCloud",
  72             bool readFields = true
  73         );
  74
  75         //- Construct from mesh, cloud name, and a list of particles
  76         passiveParticleCloud
  77         (
  78             const polyMesh& mesh,
  79             const word& cloudName,
  80             const IDLList<passiveParticle>& particles
  81         );
  82 };
  83
  84
  85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  86
  87 } // End namespace Foam
  88
  89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  90
  91 #endif
  92
  93 // ************************************************************************* //