HertzianViscoelasticNormalSpecies.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 HertzianViscoelasticNormalSpecies_H
#define HertzianViscoelasticNormalSpecies_H
 
#include "Species/NormalForceSpecies/BaseNormalForce.h"
#include "Math/ExtendedMath.h"
#include "Interactions/NormalForceInteractions/HertzianViscoelasticInteraction.h"
 
class HertzianViscoelasticNormalSpecies : public BaseNormalForce
{
public:
    typedef HertzianViscoelasticInteraction InteractionType;
    
    HertzianViscoelasticNormalSpecies();
    
    HertzianViscoelasticNormalSpecies(const HertzianViscoelasticNormalSpecies& p);
    
    ~HertzianViscoelasticNormalSpecies();
    
    void read(std::istream& is);
    
    void write(std::ostream& os) const;
    
    virtual std::string getBaseName() const;
    
    Mdouble getCollisionTime(Mdouble particleDiameter, Mdouble particleDensity, Mdouble relativeVelocity) const;
 
// Species-specific functions
 
//    ///Calculates the maximum velocity allowed for a collision of two copies of P (for higher velocities particles could pass through each other)
//    Mdouble getMaximumVelocity(Mdouble radius, Mdouble mass);
//
//    ///Sets k, disp such that it matches a given tc and eps for a collision of two copies of P
//    void setStiffnessAndRestitutionCoefficient(Mdouble k_, Mdouble eps, Mdouble mass);
//
//    ///Sets k, disp such that it matches a given tc and eps for a collision of two copies of equal mass m
//    void setCollisionTimeAndRestitutionCoefficient(Mdouble tc, Mdouble eps, Mdouble mass);
//
//    ///Set k, disp such that is matches a given tc and eps for a collision of two different masses.
//    ///Recall the resitution constant is a function of k, disp and the mass of each particle in the collision
//    /// See also setCollisionTimeAndRestitutionCoefficient(Mdouble tc, Mdouble eps, Mdouble mass)
//    void setCollisionTimeAndRestitutionCoefficient(Mdouble collisionTime, Mdouble restitutionCoefficient, Mdouble mass1, Mdouble mass2);
//
//    /*!
//     * \brief Calculates collision time for two copies of a particle of given disp, k, mass
//     */
//    Mdouble getCollisionTime(Mdouble mass);
//
//    /*!
//     * \brief Calculates restitution coefficient for two copies of given disp, k, mass
//     */
//    Mdouble getRestitutionCoefficient(Mdouble mass);
    
    void mix(HertzianViscoelasticNormalSpecies* SBase, HertzianViscoelasticNormalSpecies* TBase);
 
//setters and getters
    
    void setEffectiveElasticModulus(Mdouble elasticModulus);
    
    virtual void setEffectiveElasticModulusAndRestitutionCoefficient(Mdouble elasticModulus, Mdouble rest);
    
    Mdouble getEffectiveElasticModulus() const;
    
    void setEffectiveElasticModulusAndPoissonRatio(Mdouble elasticModulus, Mdouble poissonRatio);
    
    void setEffectiveElasticModulusAndEffectiveShearModulus(Mdouble elasticModulus, Mdouble shearModulus);
    
    void setDissipation(Mdouble dissipation);
    
    Mdouble getDissipation() const;
 
    void setRestitutionCoefficient(Mdouble rest);
    
private:
    Mdouble elasticModulus_;
    
    Mdouble dissipation_;
};
 
#endif