ParticleHandler.h

Go to the documentation of this file.

//Copyright (c) 2013-2014, The MercuryDPM Developers Team. All rights reserved.
//For the list of developers, see <http://www.MercuryDPM.org/Team>.
//
//Redistribution and use in source and binary forms, with or without
//modification, are permitted provided that the following conditions are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name MercuryDPM nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
//ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
//DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
//(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
//LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
//ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
//(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


#ifndef PARTICLE_HANDLER_H
#define PARTICLE_HANDLER_H

#include "BaseHandler.h"
class SpeciesHandler;
class BaseSpecies;
class BaseParticle;

class ParticleHandler : public BaseHandler<BaseParticle>
{
public:
    ParticleHandler();

    ParticleHandler(const ParticleHandler& PH);

    ParticleHandler operator=(const ParticleHandler& rhs);
    
    ~ParticleHandler();

    virtual void addObject(BaseParticle* P);

    virtual void removeObject(unsigned const int index);

    void removeLastObject();

    void computeSmallestParticle();
    
    void computeLargestParticle();
    
    BaseParticle* getSmallestParticle() const;

    BaseParticle* getLargestParticle() const;

    BaseParticle* getFastestParticle() const;

    Mdouble getMeanRadius() const;

    BaseParticle* getLowestPositionComponentParticle(const int i) const;

    BaseParticle* getHighestPositionComponentParticle(const int i) const;

    BaseParticle* getLowestVelocityComponentParticle(const int i) const;

    BaseParticle* getHighestVelocityComponentParticle(const int i) const;

    BaseParticle* getLightestParticle() const;

    void clear();

    void readObject(std::istream& is);

    void readOldObject(std::string type, std::istream& is);

    void write(std::ostream& os) const;

    void checkExtrema(BaseParticle* P);

    void checkExtremaOnDelete(BaseParticle* P);

    void computeAllMasses(unsigned int indSpecies);

    void computeAllMasses();

    std::string getName() const;

    static BaseParticle* getNewObject(const std::string& type);
    
    void writeVTK() const;

private:
    BaseParticle* largestParticle_;

    BaseParticle* smallestParticle_;
};

#endif