FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::cloud
00026 
00027 Description
00028     A cloud is a collection of lagrangian particles
00029 
00030 SourceFiles
00031     cloud.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef cloud_H
00036 #define cloud_H
00037 
00038 #include <OpenFOAM/objectRegistry.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 // Forward declaration of classes
00046 class mapPolyMesh;
00047 
00048 /*---------------------------------------------------------------------------*\
00049                             Class cloud Declaration
00050 \*---------------------------------------------------------------------------*/
00051 
00052 class cloud
00053 :
00054     public objectRegistry
00055 {
00056 
00057     // Private Member Functions
00058 
00059         //- Disallow default bitwise copy construct
00060         cloud(const cloud&);
00061 
00062         //- Disallow default bitwise assignment
00063         void operator=(const cloud&);
00064 
00065 
00066 public:
00067 
00068     //- Runtime type information
00069     TypeName("cloud");
00070 
00071         //- The prefix to local: %lagrangian
00072         static const word prefix;
00073 
00074         //- The default cloud name: %defaultCloud
00075         static word defaultName;
00076 
00077 
00078     // Constructors
00079 
00080         //- Construct for the given objectRegistry and named cloud instance
00081         cloud(const objectRegistry&, const word& cloudName = "");
00082 
00083 
00084     //- Destructor
00085     virtual ~cloud();
00086 
00087 
00088     // Member Functions
00089 
00090         // Edit
00091 
00092             //- Remap the cells of particles corresponding to the
00093             //  mesh topology change
00094             virtual void autoMap(const mapPolyMesh&) = 0;
00095 };
00096 
00097 
00098 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00099 
00100 } // End namespace Foam
00101 
00102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00103 
00104 #endif
00105 
00106 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines