BaseParticle.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 BASEPARTICLE_H
#define BASEPARTICLE_H

#include <vector>
#include <iostream>
#include "Math/ExtendedMath.h"
#include "Math/Vector.h"
#include "BaseInteractable.h"
//#include "InteractionHandler.h"

class ParticleHandler;
class SpeciesHandler;
class HGrid;
class BaseInteraction;

#ifdef CONTACT_LIST_HGRID
class PossibleContact;
#endif

class BaseParticle : public BaseInteractable
{
public:
    BaseParticle();

    BaseParticle(const BaseParticle &p);

    virtual ~BaseParticle();

    virtual BaseParticle* copy() const;

    Mdouble getVolume() const;

    void fixParticle();

    bool isFixed() const;

    void unfix();

    virtual void read(std::istream& is);

    MERCURY_DEPRECATED
    virtual void oldRead(std::istream& is);

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

    virtual std::string getName() const;

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

    unsigned int getHGridLevel() const;

    BaseParticle* getHGridNextObject() const;

    BaseParticle* getHGridPrevObject() const;

#ifdef CONTACT_LIST_HGRID

    PossibleContact* getFirstPossibleContact() const;
#endif

    int getHGridX() const;

    int getHGridY() const;

    int getHGridZ() const;

    Mdouble getInertia() const;

    Mdouble getInvInertia() const;

    Mdouble getInvMass() const;

    Mdouble getKineticEnergy() const;

    Mdouble getMass() const;

    BaseParticle* getPeriodicFromParticle() const;

    Mdouble getRadius() const;

    Mdouble getInteractionRadius() const;

    Mdouble getWallInteractionRadius() const;

    const Vec3D& getDisplacement() const;

    const Vec3D& getPreviousPosition() const;

    const Vec3D getDisplacement2(Mdouble xmin, Mdouble xmax, Mdouble ymin, Mdouble ymax, Mdouble zmin, Mdouble zmax, Mdouble t) const;

    void setInertia(const Mdouble newInertia);

    void setInfiniteInertia();

    void setPeriodicFromParticle(BaseParticle* p);

    void setHGridX(const int x);

    void setHGridY(const int y);

    void setHGridZ(const int z);

    void setHGridLevel(const unsigned int level);

    void setHGridNextObject(BaseParticle* p);

    void setHGridPrevObject(BaseParticle* p);

#ifdef CONTACT_LIST_HGRID

    void setFirstPossibleContact(PossibleContact* PC);
#endif

    void setRadius(const Mdouble radius);

    MERCURY_DEPRECATED
    void setMass(const Mdouble mass);

    void setMassForP3Statistics(const Mdouble mass);

    void setDisplacement(const Vec3D& disp);

    void setPreviousPosition(const Vec3D& pos);

    void movePrevious(const Vec3D& posMove);

    void accelerate(const Vec3D& vel);

    void angularAccelerate(const Vec3D& angVel);

    void addDisplacement(const Vec3D& addDisp);

    void setHandler(ParticleHandler* handler);

    ParticleHandler* getHandler() const;

    std::vector<BaseInteraction*> getInteractionWith(BaseParticle *P, Mdouble timeStamp, InteractionHandler* interactionHandler);

    void integrateBeforeForceComputation(double time, double timeStep);

    void integrateAfterForceComputation(double time, double timeStep);

    unsigned int getParticleDimensions() const;

    MERCURY_DEPRECATED
    void setIndSpecies(unsigned int indSpecies);

    void setSpecies(const ParticleSpecies* species);

    virtual unsigned getNumberOfFieldsVTK() const;

    virtual std::string getTypeVTK(unsigned i) const;

    virtual std::string getNameVTK(unsigned i) const;

    virtual std::vector<Mdouble> getFieldVTK(unsigned i) const;

private:

    ParticleHandler* handler_;

#ifdef CONTACT_LIST_HGRID

    PossibleContact* firstPossibleContact;
#endif

    int HGridX_, HGridY_, HGridZ_; 
    unsigned int HGridLevel_; 
    BaseParticle* HGridNextObject_; 
    BaseParticle* HGridPrevObject_; 

    Mdouble mass_; 
    Mdouble invMass_; 
    Mdouble inertia_; 
    Mdouble invInertia_; 
    Mdouble radius_; 
    BaseParticle * periodicFromParticle_; 

    Vec3D displacement_; 
    Vec3D previousPosition_; 
    
    friend class ParticleSpecies;
//    //friend class HGrid;
//    template<class T>
//    friend class StatisticsVector;
};
#endif