SlidingFrictionSpecies.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 SLIDINGFRICTIONSPECIES_H
#define SLIDINGFRICTIONSPECIES_H
 
#include "Species/FrictionForceSpecies/BaseFrictionForce.h"
#include "Math/ExtendedMath.h"
#include "Interactions/FrictionForceInteractions/SlidingFrictionInteraction.h"
 
class SlidingFrictionSpecies : public BaseFrictionForce
{
public:
    typedef SlidingFrictionInteraction InteractionType;
    
    SlidingFrictionSpecies();
    
    SlidingFrictionSpecies(const SlidingFrictionSpecies& s);
    
    ~SlidingFrictionSpecies();
    
    void read(std::istream& is);
    
    void write(std::ostream& os) const;
    
    virtual std::string getBaseName() const;
 
//setters and getters
    void setSlidingStiffness(Mdouble new_kt);
    
    Mdouble getSlidingStiffness() const;
    
    void setSlidingDissipation(Mdouble new_dispt);
    
    Mdouble getSlidingDissipation() const;
    
    //mu has to be set to allow tangential forces (sets dispt=disp as default)
    void setSlidingFrictionCoefficient(Mdouble new_mu);
    
    Mdouble getSlidingFrictionCoefficient() const;
    
    void setSlidingFrictionCoefficientStatic(Mdouble new_mu);
    
    Mdouble getSlidingFrictionCoefficientStatic() const;
    
    bool getUseAngularDOFs() const override;
    
    void mix(SlidingFrictionSpecies* S, SlidingFrictionSpecies* T);
    
    void
    setCollisionTimeAndNormalAndTangentialRestitutionCoefficient(Mdouble tc, Mdouble eps, Mdouble beta, Mdouble mass);
    
    void setCollisionTimeAndNormalAndTangentialRestitutionCoefficientNoDispt(Mdouble tc, Mdouble eps, Mdouble beta,
                                                                             Mdouble mass);
        
    void setIsSuperquadricSpecies(bool isSuperquadricSpecies);
    bool getIsSuperquadricSpecies() const;
 
private:
    Mdouble slidingStiffness_;
    
    Mdouble slidingDissipation_;
    
    Mdouble slidingFrictionCoefficient_;
    
    Mdouble slidingFrictionCoefficientStatic_;
    
    bool isSuperquadricSpecies_;
};
 
#endif