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