OpenFOAM logo
Open Source CFD Toolkit

cloud.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     cloud
00027 
00028 Description
00029 
00030 SourceFiles
00031     cloud.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef cloud_H
00036 #define cloud_H
00037 
00038 #include "regIOobject.H"
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 // Class forward declarations
00046 class mapPolyMesh;
00047 
00048 /*---------------------------------------------------------------------------*\
00049                            Class cloud Declaration
00050 \*---------------------------------------------------------------------------*/
00051 
00052 class cloud
00053 :
00054     public regIOobject
00055 {
00056     // Private Member Functions
00057 
00058         //- Disallow default bitwise copy construct
00059         cloud(const cloud&);
00060 
00061         //- Disallow default bitwise assignment
00062         void operator=(const cloud&);
00063 
00064 
00065 public:
00066 
00067     //- Runtime type information
00068     TypeName("Cloud");
00069 
00070 
00071     // Constructors
00072 
00073         //- Construct for the given objectRegistry
00074         cloud(const objectRegistry& obr);
00075 
00076 
00077     // Destructor
00078 
00079         virtual ~cloud();
00080 
00081 
00082     // Member Functions
00083 
00084         // Edit
00085 
00086             //- Remap the cells of particles corresponding to the
00087             //  mesh topology change
00088             virtual void autoMap(const mapPolyMesh&) = 0;
00089 };
00090 
00091 
00092 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00093 
00094 } // End namespace Foam
00095 
00096 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00097 
00098 #endif
00099 
00100 // ************************************************************************* //
For further information go to www.openfoam.org