MindlinSpecies.h

Go to the documentation of this file.

//Copyright (c) 2013-2017, 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 MINDLINSPECIES_H
#define MINDLINSPECIES_H
#include "Species/BaseSpecies.h"
#include "Math/ExtendedMath.h"
#include "Interactions/FrictionForceInteractions/MindlinInteraction.h"

class MindlinSpecies : public virtual BaseSpecies
{
public:
    typedef MindlinInteraction InteractionType;

    MindlinSpecies();

    MindlinSpecies(const MindlinSpecies &s);

    virtual ~MindlinSpecies();

    void read(std::istream& is) override;

    void write(std::ostream& os) const override;

    virtual std::string getBaseName() const;

//setters and getters

    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);

    //k_edit
    //allows the shear modulus to be set / changed
    void setShearModulus(Mdouble new_G);
    //k_edit
    //allows the value of the shear modulus to be accessed
    Mdouble getShearModulus() const;

    Mdouble getSlidingFrictionCoefficient() const;

    void setSlidingFrictionCoefficientStatic(Mdouble new_mu);

    Mdouble getSlidingFrictionCoefficientStatic() const;

    bool getUseAngularDOFs() const override;

    void mix(MindlinSpecies* const S, MindlinSpecies* const T);

private:

    Mdouble slidingDissipation_; 
    
    Mdouble slidingFrictionCoefficient_; 
    
    Mdouble slidingFrictionCoefficientStatic_;

    //k_edit
    // the shear modulus of a given particle. By default, set to zero;
    Mdouble shearModulus_;

};
#endif