src/OpenFOAM/fields/cloud/cloud.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::cloud
  27
  28 Description
  29     A cloud is a collection of lagrangian particles
  30
  31 SourceFiles
  32     cloud.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef cloud_H
  37 #define cloud_H
  38
  39 #include <OpenFOAM/objectRegistry.H>
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 // Forward declaration of classes
  47 class mapPolyMesh;
  48
  49 /*---------------------------------------------------------------------------*\
  50                             Class cloud Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class cloud
  54 :
  55     public objectRegistry
  56 {
  57
  58     // Private Member Functions
  59
  60         //- Disallow default bitwise copy construct
  61         cloud(const cloud&);
  62
  63         //- Disallow default bitwise assignment
  64         void operator=(const cloud&);
  65
  66
  67 public:
  68
  69     //- Runtime type information
  70     TypeName("cloud");
  71
  72         //- The prefix to local: %lagrangian
  73         static const word prefix;
  74
  75         //- The default cloud name: %defaultCloud
  76         static word defaultName;
  77
  78
  79     // Constructors
  80
  81         //- Construct for the given objectRegistry and named cloud instance
  82         cloud(const objectRegistry&, const word& cloudName = "");
  83
  84
  85     //- Destructor
  86     virtual ~cloud();
  87
  88
  89     // Member Functions
  90
  91         // Edit
  92
  93             //- Remap the cells of particles corresponding to the
  94             //  mesh topology change
  95             virtual void autoMap(const mapPolyMesh&) = 0;
  96 };
  97
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 } // End namespace Foam
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #endif
 106
 107 // ************************ vim: set sw=4 sts=4 et: ************************ //