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::indexedParticle 00026 00027 Description 00028 00029 SourceFiles 00030 indexedParticleI.H 00031 indexedParticle.C 00032 indexedParticleIO.C 00033 00034 \*---------------------------------------------------------------------------*/ 00035 00036 #ifndef indexedParticle_H 00037 #define indexedParticle_H 00038 00039 #include <lagrangian/Particle.H> 00040 #include <OpenFOAM/IOstream.H> 00041 #include <OpenFOAM/autoPtr.H> 00042 00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00044 00045 namespace Foam 00046 { 00047 00048 /*---------------------------------------------------------------------------*\ 00049 Class indexedParticle Declaration 00050 \*---------------------------------------------------------------------------*/ 00051 00052 class indexedParticle 00053 : 00054 public Particle<indexedParticle> 00055 { 00056 // Private data 00057 00058 label index_; 00059 00060 00061 public: 00062 00063 // Constructors 00064 00065 //- Construct from components 00066 indexedParticle 00067 ( 00068 const Cloud<indexedParticle>& c, 00069 const vector& position, 00070 const label celli, 00071 const label index = 0 00072 ) 00073 : 00074 Particle<indexedParticle>(c, position, celli), 00075 index_(index) 00076 {} 00077 00078 //- Construct from Istream 00079 indexedParticle 00080 ( 00081 const Cloud<indexedParticle>& c, 00082 Istream& is, 00083 bool readFields = true 00084 ) 00085 : 00086 Particle<indexedParticle>(c, is, readFields) 00087 {} 00088 00089 //- Construct as a copy 00090 indexedParticle(const indexedParticle& p) 00091 : 00092 Particle<indexedParticle>(p) 00093 {} 00094 00095 //- Construct and return a clone 00096 autoPtr<indexedParticle> clone() const 00097 { 00098 return autoPtr<indexedParticle>(new indexedParticle(*this)); 00099 } 00100 00101 00102 // Member functions 00103 00104 label index() const 00105 { 00106 return index_; 00107 } 00108 00109 label& index() 00110 { 00111 return index_; 00112 } 00113 }; 00114 00115 00116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00117 00118 } // End namespace Foam 00119 00120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00121 00122 #endif 00123 00124 // ************************ vim: set sw=4 sts=4 et: ************************ //
