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

passiveParticleCloud.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::passiveParticleCloud
00026 
00027 Description
00028     A Cloud of passive particles
00029 
00030 SourceFiles
00031     passiveParticleCloud.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef passiveParticleCloud_H
00036 #define passiveParticleCloud_H
00037 
00038 #include <lagrangian/Cloud.H>
00039 #include "passiveParticle.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                    Class passiveParticleCloud Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class passiveParticleCloud
00051 :
00052     public Cloud<passiveParticle>
00053 {
00054     // Private Member Functions
00055 
00056         //- Disallow default bitwise copy construct
00057         passiveParticleCloud(const passiveParticleCloud&);
00058 
00059         //- Disallow default bitwise assignment
00060         void operator=(const passiveParticleCloud&);
00061 
00062 
00063 public:
00064 
00065     //- Type of parcel the cloud was instantiated for
00066     typedef passiveParticle parcelType;
00067 
00068     // Constructors
00069 
00070         //- Construct given mesh
00071         passiveParticleCloud
00072         (
00073             const polyMesh&,
00074             const word& cloudName = "defaultCloud",
00075             bool readFields = true
00076         );
00077 
00078         //- Construct from mesh, cloud name, and a list of particles
00079         passiveParticleCloud
00080         (
00081             const polyMesh& mesh,
00082             const word& cloudName,
00083             const IDLList<passiveParticle>& particles
00084         );
00085 };
00086 
00087 
00088 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00089 
00090 } // End namespace Foam
00091 
00092 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00093 
00094 #endif
00095 
00096 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines