indexedParticle.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2022 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::indexedParticle
 
Description
    Adds label index to base particle
 
SourceFiles
    indexedParticle.H
 
\*---------------------------------------------------------------------------*/
 
#ifndef indexedParticle_H
#define indexedParticle_H
 
#include "particle.H"
#include "IOstream.H"
#include "autoPtr.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                       Class indexedParticle Declaration
\*---------------------------------------------------------------------------*/
 
class indexedParticle
:
    public particle
{
    // Private Data
 
        label index_;
 
 
public:
 
    // Constructors
 
        //- Construct from Istream
        indexedParticle(Istream& is, bool readFields = true)
        :
            particle(is, readFields)
        {}
 
        //- Construct as a copy
        indexedParticle(const indexedParticle& p)
        :
            particle(p)
        {}
 
        //- Construct and return a clone
        virtual autoPtr<particle> clone() const
        {
            return autoPtr<particle>(new indexedParticle(*this));
        }
 
        //- Construct from Istream and return
        static autoPtr<indexedParticle> New(Istream& is)
        {
            return autoPtr<indexedParticle>(new indexedParticle(is));
        }
 
 
    // Member Functions
 
        label index() const
        {
            return index_;
        }
 
        label& index()
        {
            return index_;
        }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //