FrictionSpecies.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 FrictionSpecies_H
#define FrictionSpecies_H
 
#include "SlidingFrictionSpecies.h"
#include "Math/ExtendedMath.h"
#include "Interactions/FrictionForceInteractions/FrictionInteraction.h"
 
class FrictionSpecies : public SlidingFrictionSpecies
{
public:
    typedef FrictionInteraction InteractionType;
    
    FrictionSpecies();
    
    FrictionSpecies(const FrictionSpecies& s);
    
    ~FrictionSpecies();
    
    void read(std::istream& is);
    
    void write(std::ostream& os) const;
    
    std::string getBaseName() const override;
    
    bool getUseAngularDOFs() const override;
    
    void mix(FrictionSpecies* S, FrictionSpecies* T);
 
//setters and getters
    
    void setRollingStiffness(Mdouble new_kt);
    
    Mdouble getRollingStiffness() const;
    
    void setRollingDissipation(Mdouble new_dispt);
    
    Mdouble getRollingDissipation() const;
    
    //mu has to be set to allow tangential forces (sets dispt=disp as default)
    void setRollingFrictionCoefficient(Mdouble new_mu);
    
    Mdouble getRollingFrictionCoefficient() const;
    
    void setRollingFrictionCoefficientStatic(Mdouble new_mu);
    
    Mdouble getRollingFrictionCoefficientStatic() const;
    
    void setTorsionStiffness(Mdouble new_kt);
    
    Mdouble getTorsionStiffness() const;
    
    void setTorsionDissipation(Mdouble new_dispt);
    
    Mdouble getTorsionDissipation() const;
    
    //mu has to be set to allow tangential forces (sets dispt=disp as default)
    void setTorsionFrictionCoefficient(Mdouble new_mu);
    
    Mdouble getTorsionFrictionCoefficient() const;
    
    void setTorsionFrictionCoefficientStatic(Mdouble new_mu);
    
    Mdouble getTorsionFrictionCoefficientStatic() const;
 
private:
    Mdouble rollingStiffness_;
    
    Mdouble rollingDissipation_;
    
    
    Mdouble rollingFrictionCoefficient_;
    
    Mdouble rollingFrictionCoefficientStatic_;
    
    Mdouble torsionStiffness_;
    
    Mdouble torsionDissipation_;
    
    Mdouble torsionFrictionCoefficient_;
    
    Mdouble torsionFrictionCoefficientStatic_;
};
 
#endif