BaseSpecies.h

Go to the documentation of this file.

// This file is part of the MercuryDPM project (https://www.mercurydpm.org).
// Copyright (c), The MercuryDPM Developers Team. All rights reserved.
// License: BSD 3-Clause License; see the LICENSE file in the root directory.
 
#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;
    
    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