BaseInteraction.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 BASEINTERACTION_H
#define BASEINTERACTION_H

#include <vector>
#include "BaseObject.h"
#include "Math/Vector.h"
#include "Math/Matrix.h"

class InteractionHandler;
class BaseParticle;
class BaseSpecies;
class BaseInteractable;

class BaseInteraction : public BaseObject
{
public:
    BaseInteraction(BaseInteractable* P, BaseInteractable* I, Mdouble timeStamp);

    BaseInteraction(const BaseInteraction &p);
    
    BaseInteraction();

    virtual ~BaseInteraction();

    virtual void actionsOnErase() {};
    
    virtual void computeForce();

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

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

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

    virtual std::string getName() const;

    virtual Mdouble getElasticEnergy() const;

    void setDistance(Mdouble distance);

    void setNormal(Vec3D normal);

    void setOverlap(Mdouble overlap);

    void setContactPoint(Vec3D contactPoint);

    void setTimeStamp(Mdouble timeStamp);

    void setSpecies(BaseSpecies *species);

    void setP(BaseInteractable* P);

    void setI(BaseInteractable* I);

    void setHandler(InteractionHandler* handler);

    InteractionHandler* getHandler() const;

    const Vec3D& getForce() const;

    const Vec3D& getTorque() const;

    const Vec3D& getNormal() const;

    const Vec3D& getContactPoint() const;

    Mdouble getOverlap() const;

    Mdouble getContactRadius() const;

    void removeFromHandler();

    void copySwitchPointer(const BaseInteractable* original, BaseInteractable* ghost) const;

    void gatherContactStatistics();

    BaseInteractable* getP();

    /*
     * \brief Returns a pointer to the second object involved in the interaction (often a wall or a particle). 
     */
    BaseInteractable* getI();

    /*
     * \brief Returns a constant pointer to the first object involved in the interaction.
     */
    const BaseInteractable* getP() const;

    const BaseInteractable* getI() const;

    Mdouble getTimeStamp() const;

    virtual void integrate(Mdouble timeStep);

    virtual Mdouble getTangentialOverlap() const;

    Mdouble getDistance() const;

    const Vec3D& getRelativeVelocity() const;

    Mdouble getNormalRelativeVelocity() const;

    Mdouble getAbsoluteNormalForce() const;

    virtual BaseInteraction* copy() const = 0;

    unsigned int getMultiContactIdentifier() const;

    void setMultiContactIdentifier(unsigned int multiContactIdentifier_);

    virtual void rotateHistory(Matrix3D& rotationMatrix);

    virtual void actionsAfterTimeStep();

    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;

    void setForce(Vec3D force);

protected:

    virtual const Vec3D getTangentialForce() const;

    Mdouble getEffectiveRadius() const;

    Mdouble getEffectiveMass() const;

    Mdouble getEffectiveCorrectedRadius();

    //functions that only the derived Interactions have to know about:
    void addForce(Vec3D force);

    /*
     * \brief add a torque increment to the total torque.
     */
    void addTorque(Vec3D torque);

    //these functions are only used for normal forces and should be made private by the normal forces:

    void setTorque(Vec3D torque);

    void setRelativeVelocity(Vec3D relativeVelocity);

    void setNormalRelativeVelocity(Mdouble normalRelativeVelocit);

    void setAbsoluteNormalForce(Mdouble absoluteNormalForce);

    const BaseSpecies* getBaseSpecies() const;

    virtual Mdouble getElasticEnergyAtEquilibrium(Mdouble adhesiveForce) const {return 0;}

    virtual void reverseHistory();

private:


    InteractionHandler* handler_;

    BaseInteractable* P_;

    BaseInteractable* I_;

    Vec3D contactPoint_;



    Vec3D relativeVelocity_;

    Mdouble normalRelativeVelocity_;

    Mdouble absoluteNormalForce_;

    Mdouble distance_;

    Vec3D force_;

    Vec3D torque_;

    Mdouble timeStamp_;

    Vec3D normal_;

    Mdouble overlap_;

    BaseSpecies* species_;

private:
    unsigned multiContactIdentifier_;
};
#endif