OpenFOAM logo
Open Source CFD Toolkit

passiveParticle.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     passiveParticle
00027 
00028 Description
00029 
00030 SourceFiles
00031     passiveParticleI.H
00032     passiveParticle.C
00033     passiveParticleIO.C
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 #ifndef passiveParticle_H
00038 #define passiveParticle_H
00039 
00040 #include "particle.H"
00041 #include "IOstream.H"
00042 #include "autoPtr.H"
00043 
00044 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00045 
00046 namespace Foam
00047 {
00048 
00049 /*---------------------------------------------------------------------------*\
00050                            Class passiveParticle Declaration
00051 \*---------------------------------------------------------------------------*/
00052 
00053 class passiveParticle
00054 :
00055     public particle<passiveParticle>
00056 {
00057 
00058 public:
00059 
00060     // Constructors
00061 
00062         //- Construct from components
00063         passiveParticle
00064         (
00065             const Cloud<passiveParticle>& c,
00066             const vector& position,
00067             const label celli
00068         )
00069         :
00070             particle<passiveParticle>(c, position, celli)
00071         {}
00072 
00073         //- Construct from Istream
00074         passiveParticle
00075         (
00076             const Cloud<passiveParticle>& c,
00077             Istream& is,
00078             bool
00079         )
00080         :
00081             particle<passiveParticle>(c, is)
00082         {}
00083 
00084         //- Construct and return a clone
00085         autoPtr<passiveParticle> clone() const
00086         {
00087             return autoPtr<passiveParticle>(new passiveParticle(*this));
00088         }
00089 };
00090 
00091 
00092 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00093 
00094 } // End namespace Foam
00095 
00096 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00097 
00098 #endif
00099 
00100 // ************************************************************************* //
For further information go to www.openfoam.org