SlidingFrictionSpecies.h

Go to the documentation of this file.

//Copyright (c) 2013-2023, 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 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