src/lagrangian/basic/indexedParticle/indexedParticleCloud.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::indexedParticleCloud
  27
  28 Description
  29     A Cloud of particles carrying an additional index.
  30
  31 SourceFiles
  32     indexedParticleCloud.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef indexedParticleCloud_H
  37 #define indexedParticleCloud_H
  38
  39 #include "Cloud.H"
  40 #include "indexedParticle.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class indexedParticleCloud Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class indexedParticleCloud
  52 :
  53     public Cloud<indexedParticle>
  54 {
  55     // Private Member Functions
  56
  57         //- Disallow default bitwise copy construct
  58         indexedParticleCloud(const indexedParticleCloud&);
  59
  60         //- Disallow default bitwise assignment
  61         void operator=(const indexedParticleCloud&);
  62
  63
  64 public:
  65
  66     // Constructors
  67
  68         //- Construct given mesh
  69         indexedParticleCloud
  70         (
  71             const polyMesh&,
  72             const word& cloudName = "defaultCloud"
  73         );
  74
  75
  76     // Member Functions
  77
  78         //- Write fields
  79         virtual void writeFields() const;
  80 };
  81
  82
  83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  84
  85 } // End namespace Foam
  86
  87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  88
  89 #endif
  90
  91 // ************************************************************************* //