BaseSpecies.h

Go to the documentation of this file.

//Copyright (c) 2013-2020, 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 BASESPECIES_H
#define BASESPECIES_H

#include "BaseObject.h"
#include "Math/ExtendedMath.h"
#include "Math/Helpers.h"
#include "Species/NormalForceSpecies/BaseNormalForce.h"
#include "Species/FrictionForceSpecies/BaseFrictionForce.h"
#include "Species/AdhesiveForceSpecies/BaseAdhesiveForce.h"

class SpeciesHandler;// derived from BaseHandler<ParticleSpecies>
//class BaseParticle; //
class BaseInteractable;

class BaseInteraction;

//Note the getVelocity can for some Species be dependent on which point on the Species is meant.
class BaseSpecies : public BaseObject
{
public:
    
    BaseSpecies();

    BaseSpecies(BaseNormalForce* normalForce, BaseFrictionForce* frictionForce_, BaseAdhesiveForce* adhesiveForce);

    BaseSpecies(const BaseSpecies& p);
    
    ~BaseSpecies();
    
    virtual BaseSpecies* copy() const = 0;
    
    virtual void copyInto(BaseSpecies* s) const =0;
    
    void setHandler(SpeciesHandler* handler);
    
    SpeciesHandler* getHandler() const;
    
    static Mdouble average(Mdouble a, Mdouble b);

    static Mdouble averageInf(Mdouble a, Mdouble b);
    

    virtual void mixAll(BaseSpecies* S, BaseSpecies* T) = 0;
    
//setters and getters
    

    virtual bool getUseAngularDOFs() const = 0;
    

    virtual BaseInteraction* getNewInteraction(BaseInteractable* P, BaseInteractable* I, unsigned timeStamp) const = 0;
    
    //TODO add documentation 
    virtual BaseInteraction* getEmptyInteraction() const = 0;
    
    virtual void deleteEmptyInteraction(BaseInteraction* interaction) const = 0;


    Mdouble getInteractionDistance() const {return interactionDistance_;}

    BaseNormalForce* getNormalForce() const {return normalForce_;}

    BaseFrictionForce* getFrictionForce() const {return frictionForce_;}

    BaseAdhesiveForce* getAdhesiveForce() const {return adhesiveForce_;}

    void setInteractionDistance(Mdouble interactionDistance);

protected:

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

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

    BaseNormalForce* normalForce_;

    BaseFrictionForce* frictionForce_;

    BaseAdhesiveForce* adhesiveForce_;

private:
    SpeciesHandler* handler_;

    Mdouble interactionDistance_;
};

#endif