FrictionSpecies.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 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