LinearViscoelasticNormalSpecies.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 LinearViscoelasticNormalSpecies_H
#define LinearViscoelasticNormalSpecies_H
 
#include "Species/NormalForceSpecies/BaseNormalForce.h"
#include "Math/ExtendedMath.h"
#include "Interactions/NormalForceInteractions/LinearViscoelasticInteraction.h"
#include "Math/Helpers.h"
 
class LinearViscoelasticNormalSpecies : public BaseNormalForce
{
public:
    typedef LinearViscoelasticInteraction InteractionType;
    
    LinearViscoelasticNormalSpecies();
    
    LinearViscoelasticNormalSpecies(const LinearViscoelasticNormalSpecies& p);
    
    ~LinearViscoelasticNormalSpecies();
    
    void read(std::istream& is);
    
    void write(std::ostream& os) const;
    
    std::string getBaseName() const;
 
// Species-specific functions
    
    Mdouble getMaximumVelocity(Mdouble radius, Mdouble mass) const;
    
    void setStiffnessAndRestitutionCoefficient(Mdouble k_, Mdouble eps, Mdouble mass);
    
    void setRestitutionCoefficient(double eps, Mdouble mass);
 
    void setCollisionTimeAndRestitutionCoefficient(Mdouble tc, Mdouble eps, BaseParticle* p);
    
    void setCollisionTimeAndRestitutionCoefficient(Mdouble tc, Mdouble eps, Mdouble mass);
    
    void setCollisionTimeAndRestitutionCoefficient(Mdouble collisionTime, Mdouble restitutionCoefficient, Mdouble mass1,
                                                   Mdouble mass2);
    
    Mdouble getCollisionTime(Mdouble mass) const;
    
    Mdouble getRestitutionCoefficient(Mdouble mass) const;
    
    void mix(LinearViscoelasticNormalSpecies* SBase, LinearViscoelasticNormalSpecies* TBase);
 
//setters and getters
    
    void setStiffness(Mdouble new_k);
    
    Mdouble getStiffness() const;
    
    void setDissipation(Mdouble dissipation);
    
    Mdouble getDissipation() const;
    
    MERCURYDPM_DEPRECATED
    void setStiffnessAndDissipation(helpers::KAndDisp new_);
 
    Mdouble computeTimeStep(Mdouble mass)
    {
        return 0.02 * constants::pi /
               std::sqrt(stiffness_ / (.5 * mass) - mathsFunc::square(dissipation_ / mass));
    }
 
private:
    Mdouble stiffness_; 
    Mdouble dissipation_; 
};
 
#endif