HertzianViscoelasticNormalSpecies.cc

Go to the documentation of this file.

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

#include "HertzianViscoelasticNormalSpecies.h"
#include "Interactions/BaseInteraction.h"
#include <cmath>
#include <Species/FrictionForceSpecies/MindlinSpecies.h>
#include "Interactions/NormalForceInteractions/HertzianViscoelasticInteraction.h"
#include "Logger.h"
#include "Species/BaseSpecies.h"

class BaseParticle;

class BaseInteractable;

HertzianViscoelasticNormalSpecies::HertzianViscoelasticNormalSpecies()
        : BaseNormalForce()
{
    elasticModulus_ = 0;
    dissipation_ = 0;
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"HertzianViscoelasticNormalSpecies::HertzianViscoelasticNormalSpecies() finished"<<std::endl;
#endif
}

HertzianViscoelasticNormalSpecies::HertzianViscoelasticNormalSpecies(const HertzianViscoelasticNormalSpecies& p)
        : BaseNormalForce(p)
{
    elasticModulus_ = p.elasticModulus_;
    dissipation_ = p.dissipation_;
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"HertzianViscoelasticNormalSpecies::HertzianViscoelasticNormalSpecies(const HertzianViscoelasticNormalSpecies &p) finished"<<std::endl;
#endif
}

HertzianViscoelasticNormalSpecies::~HertzianViscoelasticNormalSpecies()
{
#ifdef DEBUG_DESTRUCTOR
    std::cout<<"HertzianViscoelasticNormalSpecies::~HertzianViscoelasticNormalSpecies() finished"<<std::endl;
#endif
}

void HertzianViscoelasticNormalSpecies::write(std::ostream& os) const
{
    os << " elasticModulus " << elasticModulus_
       << " dissipation " << dissipation_;
}

void HertzianViscoelasticNormalSpecies::read(std::istream& is)
{
    std::string dummy;
    is >> dummy >> elasticModulus_
       >> dummy >> dissipation_;
}

std::string HertzianViscoelasticNormalSpecies::getBaseName() const
{
    return "HertzianViscoelastic";
}

void HertzianViscoelasticNormalSpecies::setEffectiveElasticModulus(Mdouble elasticModulus)
{
    if (elasticModulus >= 0)
        elasticModulus_ = elasticModulus;
    else
    {
        logger(ERROR, "setEffectiveElasticModulus(%) argument has to be non-negative!", elasticModulus);
    }
}

void HertzianViscoelasticNormalSpecies::setEffectiveElasticModulusAndRestitutionCoefficient(Mdouble elasticModulus, Mdouble rest)
{
    // Here is a very nice paper describing contact modelling
    // http://people.ds.cam.ac.uk/jae1001/CUS/research/pfizer/Antypov_Elliott_EPL_2011.pdf
    // see also: https://answers.launchpad.net/yade/+question/235934
    if (elasticModulus < 0.0)
        logger(ERROR,
               "[HertzianViscoelasticNormalSpecies::setEffectiveElasticModulusAndRestitutionCoefficient] elasticModulus % should be nonnegative",
               elasticModulus);
    
    else if (rest < 0.0 || rest > 1.0)
        logger(ERROR,
               "[HertzianViscoelasticNormalSpecies::setEffectiveElasticModulusAndRestitutionCoefficient] rest % should be between 0 and 1 (inclusive)",
               rest);
    
    else
    {
        elasticModulus_ = elasticModulus;
        if (rest > 0.0)
        {
            Mdouble logRestSquared = log(rest) * log(rest);
            dissipation_ = sqrt(5.0 * logRestSquared / (logRestSquared + constants::sqr_pi));
        }
        else
            dissipation_ = sqrt(5.0);

        //logger(INFO, "Effective elastic modulus %", elasticModulus_);
        //logger(INFO, "Set dissipation % to match restitution coefficient %", dissipation_, rest);
    }
}

void HertzianViscoelasticNormalSpecies::setEffectiveElasticModulusAndPoissonRatio(Mdouble elasticModulus, Mdouble poissonRatio)
{
    if (elasticModulus < 0.0)
        logger(ERROR,
               "[HertzianViscoelasticNormalSpecies::setEffectiveElasticModulusAndRestitutionCoefficient] elasticModulus % should be nonnegative",
               elasticModulus);
    
    else if (poissonRatio < 0.0 || poissonRatio > 1.0)
        logger(ERROR,
               "[HertzianViscoelasticNormalSpecies::setEffectiveElasticModulusAndRestitutionCoefficient] poissonRatio % should be between 0 and 1 (inclusive)",
               poissonRatio);
    else
    {
        elasticModulus_ = elasticModulus;
        auto mindlin = dynamic_cast<MindlinSpecies*>(getBaseSpecies());
        logger.assert_debug(mindlin, "Please define HertzianViscoelasticMindlinSpecies to use this setter");
        mindlin->setEffectiveShearModulus(elasticModulus / 2 * (1 + poissonRatio));
    }
}

void HertzianViscoelasticNormalSpecies::setEffectiveElasticModulusAndEffectiveShearModulus(Mdouble elasticModulus, Mdouble shearModulus)
{
    if (elasticModulus < 0.0)
        logger(ERROR,
               "[HertzianViscoelasticNormalSpecies::setEffectiveElasticModulusAndEffectiveShearModulus] elasticModulus % should be nonnegative",
               elasticModulus);
    
    else if (shearModulus < 0.0)
        logger(ERROR,
               "[HertzianViscoelasticNormalSpecies::setEffectiveElasticModulusAndEffectiveShearModulus] shearModulus % should be nonnegative",
               shearModulus);
    else
    {
        elasticModulus_ = elasticModulus;
        auto mindlin = dynamic_cast<MindlinSpecies*>(getBaseSpecies()->getFrictionForce());
        logger.assert_debug(mindlin, "Please define HertzianViscoelasticMindlinSpecies to use this setter");
        mindlin->setEffectiveShearModulus(shearModulus);
    }
}

Mdouble HertzianViscoelasticNormalSpecies::getEffectiveElasticModulus() const
{
    return elasticModulus_;
}

void HertzianViscoelasticNormalSpecies::setDissipation(Mdouble dissipation)
{
    if (dissipation >= 0)
    {
        dissipation_ = dissipation;
    }
    else
    {
        logger(ERROR, "setDissipation(%) argument has to be non-negative!", dissipation);
    }
}

Mdouble HertzianViscoelasticNormalSpecies::getDissipation() const
{
    return dissipation_;
}

//Mdouble HertzianViscoelasticNormalSpecies::getCollisionTime(Mdouble mass)
//{
//    if (mass <= 0)
//    {
//        std::cerr << "Error in getCollisionTime(Mdouble mass) mass is not set or has an unexpected value, (getCollisionTime(" << mass << "))" << std::endl;
//        exit(-1);
//    }
//    if (elasticModulus_ <= 0)
//    {
//        std::cerr << "Error in getCollisionTime(Mdouble mass) stiffness is not set or has an unexpected value, (getCollisionTime(" << mass << "), with stiffness=" << elasticModulus_ << ")" << std::endl;
//        exit(-1);
//    }
//    if (dissipation_ < 0)
//    {
//        std::cerr << "Error in getCollisionTime(Mdouble mass) dissipation is not set or has an unexpected value, (getCollisionTime(" << mass << "), with dissipation=" << dissipation_ << ")" << std::endl;
//        exit(-1);
//    }
//    Mdouble tosqrt = elasticModulus_ / (.5 * mass) - mathsFunc::square(dissipation_ / mass);
//    if (tosqrt <= 0)
//    {
//        std::cerr << "Error in getCollisionTime(Mdouble mass) values for mass, stiffness and dissipation would lead to an overdamped system, (getCollisionTime(" << mass << "), with stiffness=" << elasticModulus_ << " and dissipation=" << dissipation_ << ")" << std::endl;
//        exit(-1);
//    }
//    return constants::pi / std::sqrt(tosqrt);
//}
//
//Mdouble HertzianViscoelasticNormalSpecies::getRestitutionCoefficient(Mdouble mass)
//{
//    return std::exp(-dissipation_ / mass * getCollisionTime(mass));
//}
//
//Mdouble HertzianViscoelasticNormalSpecies::getMaximumVelocity(Mdouble radius, Mdouble mass)
//{
//    return radius * std::sqrt(elasticModulus_ / (.5 * mass));
//}
//
//void HertzianViscoelasticNormalSpecies::setStiffnessAndRestitutionCoefficient(Mdouble k_, Mdouble eps, Mdouble mass)
//{
//    elasticModulus_ = k_;
//    dissipation_ = -std::sqrt(2.0 * mass * elasticModulus_ / (constants::sqr_pi + mathsFunc::square(log(eps)))) * log(eps);
//}
//
//void HertzianViscoelasticNormalSpecies::setCollisionTimeAndRestitutionCoefficient(Mdouble tc, Mdouble eps, Mdouble mass)
//{
//    dissipation_ = -mass / tc * std::log(eps);
//    elasticModulus_ = .5 * mass * (mathsFunc::square(constants::pi / tc) + mathsFunc::square(dissipation_ / mass));
//}
//
//void HertzianViscoelasticNormalSpecies::setCollisionTimeAndRestitutionCoefficient(Mdouble collisionTime, Mdouble restitutionCoefficient, Mdouble mass1, Mdouble mass2)
//{
//    Mdouble reduced_mass = mass1 * mass2 / (mass1 + mass2);
//    setCollisionTimeAndRestitutionCoefficient(collisionTime, restitutionCoefficient, 2.0 * reduced_mass);
//}

void HertzianViscoelasticNormalSpecies::mix(HertzianViscoelasticNormalSpecies* const S,
                                            HertzianViscoelasticNormalSpecies* const T)
{
    elasticModulus_ = BaseSpecies::average(S->getEffectiveElasticModulus(), T->getEffectiveElasticModulus());
    dissipation_ = BaseSpecies::average(S->getDissipation(), T->getDissipation());
}

Mdouble HertzianViscoelasticNormalSpecies::getCollisionTime(Mdouble particleDiameter, Mdouble particleDensity,
                                                            Mdouble relativeVelocity) const
{
    // Here is a very nice paper describing contact modelling
    // http://people.ds.cam.ac.uk/jae1001/CUS/research/pfizer/Antypov_Elliott_EPL_2011.pdf
    //caution: this function assumes the contact is elastic (no dissipation)
    //Mdouble omega0 = 2.0/constants::sqrt_pi*sqrt(getEffectiveElasticModulus()/particleDensity)/relativeVelocity;
    //Mdouble omega1 = sqrt(omega0*omega0-getDissipation()*getDissipation());
    return 2.214 * pow(mathsFunc::square(particleDensity / getEffectiveElasticModulus()) / relativeVelocity, 0.2) *
           particleDiameter;
}