OpenFOAM logo
Open Source CFD Toolkit

indexedParticle.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     indexedParticle
00027 
00028 Description
00029 
00030 SourceFiles
00031     indexedParticleI.H
00032     indexedParticle.C
00033     indexedParticleIO.C
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 #ifndef indexedParticle_H
00038 #define indexedParticle_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 indexedParticle Declaration
00051 \*---------------------------------------------------------------------------*/
00052 
00053 class indexedParticle
00054 :
00055     public particle<indexedParticle>
00056 {
00057     // Private data
00058 
00059         label index_;
00060 
00061 
00062 public:
00063 
00064     // Constructors
00065 
00066         //- Construct from components
00067         indexedParticle
00068         (
00069             const Cloud<indexedParticle>& c,
00070             const vector& position,
00071             const label celli,
00072             const label index = 0
00073         )
00074         :
00075             particle<indexedParticle>(c, position, celli),
00076             index_(index)
00077         {}
00078 
00079         //- Construct from Istream
00080         indexedParticle
00081         (
00082             const Cloud<indexedParticle>& c,
00083             Istream& is,
00084             bool
00085         )
00086         :
00087             particle<indexedParticle>(c, is)
00088         {}
00089 
00090         //- Construct and return a clone
00091         autoPtr<indexedParticle> clone() const
00092         {
00093             return autoPtr<indexedParticle>(new indexedParticle(*this));
00094         }
00095 
00096 
00097     // Member functions
00098 
00099         label index() const
00100         {
00101             return index_;
00102         }
00103 
00104         label& index()
00105         {
00106             return index_;
00107         }
00108 };
00109 
00110 
00111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00112 
00113 } // End namespace Foam
00114 
00115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00116 
00117 #endif
00118 
00119 // ************************************************************************* //
For further information go to www.openfoam.org