SinterNormalSpecies.cc

Go to the documentation of this file.

//Copyright (c) 2013-2014, 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 "SinterNormalSpecies.h"
#include "Interactions/NormalForceInteractions/SinterInteraction.h"
#include "Logger.h"
class BaseParticle;
class BaseInteractable;

SinterNormalSpecies::SinterNormalSpecies()
{
    sinterType_ = SINTERTYPE::PARHAMI_MCKEEPING;
    loadingStiffness_ = 0.0;
    unloadingStiffnessMax_ = 0.0;
    cohesionStiffness_ = 0.0;
    penetrationDepthMax_ = 0.0;
    dissipation_ = 0.0;
    sinterAdhesion_ = 0.0;
    sinterRate_ = 0.0;
    inverseSinterViscosity_ = 0.0;
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"SinterNormalSpecies::SinterNormalSpecies() finished"<<std::endl;
#endif
}

SinterNormalSpecies::SinterNormalSpecies(const SinterNormalSpecies &p)
{
    sinterType_ = p.sinterType_;
    loadingStiffness_ = p.loadingStiffness_;
    unloadingStiffnessMax_ = p.unloadingStiffnessMax_;
    cohesionStiffness_ = p.cohesionStiffness_;
    penetrationDepthMax_ = p.penetrationDepthMax_;
    dissipation_ = p.dissipation_;
    sinterAdhesion_ = p.sinterAdhesion_;
    inverseSinterViscosity_ = p.inverseSinterViscosity_;
    sinterRate_ = p.sinterRate_;
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"SinterNormalSpecies::SinterNormalSpecies(const SinterNormalSpecies &p) finished"<<std::endl;
#endif
}

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

void SinterNormalSpecies::write(std::ostream& os) const
{
    os  << " loadingStiffness " << loadingStiffness_;
    os  << " maxUnloadingStiffness " << unloadingStiffnessMax_;
    os  << " cohesionStiffness " << cohesionStiffness_;
    os  << " maxPenetration " << penetrationDepthMax_;
    os  << " dissipation " << dissipation_;
    os  << " sinterAdhesion " << sinterAdhesion_;
    os  << " inverseSinterViscosity " << inverseSinterViscosity_;
    os  << " sinterRate_ " << sinterRate_;
    os  << " sinterType " << (unsigned) sinterType_;
}

void SinterNormalSpecies::read(std::istream& is)
{
    std::string dummy;
    is >> dummy >> loadingStiffness_;
    is >> dummy >> unloadingStiffnessMax_;
    is >> dummy >> cohesionStiffness_;
    is >> dummy >> penetrationDepthMax_;
    is >> dummy >> dissipation_;
    is >> dummy >> sinterAdhesion_;
    is >> dummy >> inverseSinterViscosity_;
    is >> dummy >> sinterRate_;
    unsigned type;
    is >> dummy >> type;
    sinterType_ = (SINTERTYPE) type;
}

std::string SinterNormalSpecies::getBaseName() const
{
    return "Sinter";
}

void SinterNormalSpecies::mix(SinterNormalSpecies* const S, SinterNormalSpecies* const T)
{
    loadingStiffness_ = average(S->getLoadingStiffness(), T->getLoadingStiffness());
    unloadingStiffnessMax_ = average(S->getUnloadingStiffnessMax(), T->getUnloadingStiffnessMax());
    cohesionStiffness_ = average(S->getCohesionStiffness(), T->getCohesionStiffness());
    penetrationDepthMax_ = average(S->getPenetrationDepthMax(), T->getPenetrationDepthMax());
    dissipation_ = average(S->getDissipation(), T->getDissipation());
    inverseSinterViscosity_ = average(S->getInverseSinterViscosity(), T->getInverseSinterViscosity());
    sinterAdhesion_ = average(S->getSinterAdhesion(), T->getSinterAdhesion());
}

void SinterNormalSpecies::setPlasticParameters (Mdouble loadingStiffness, Mdouble unloadingStiffnessMax, Mdouble cohesionStiffness, Mdouble penetrationDepthMax)
{
    if (loadingStiffness <= 0 || unloadingStiffnessMax < loadingStiffness || cohesionStiffness < 0 || penetrationDepthMax < 0)
    {
        std::cerr << "Error: arguments of setPlasticParameters do not make sense" << std::endl;
        exit(-1);
    }
    setLoadingStiffness(loadingStiffness);
    setUnloadingStiffnessMax(unloadingStiffnessMax);
    setCohesionStiffness(cohesionStiffness);
    setPenetrationDepthMax(penetrationDepthMax);
}

Mdouble SinterNormalSpecies::getLoadingStiffness() const
{
    return loadingStiffness_;
}

Mdouble SinterNormalSpecies::getUnloadingStiffnessMax() const
{
    return unloadingStiffnessMax_;
}

Mdouble SinterNormalSpecies::getCohesionStiffness() const
{
    return cohesionStiffness_;
}

Mdouble SinterNormalSpecies::getPenetrationDepthMax() const
{
    return penetrationDepthMax_;
}

void SinterNormalSpecies::setLoadingStiffness(Mdouble loadingStiffness)
{
    loadingStiffness_ = loadingStiffness;
}

void SinterNormalSpecies::setUnloadingStiffnessMax(Mdouble unloadingStiffnessMax)
{
    unloadingStiffnessMax_ = unloadingStiffnessMax;
}

void SinterNormalSpecies::setCohesionStiffness(Mdouble cohesionStiffness)
{
    cohesionStiffness_ = cohesionStiffness;
}

void SinterNormalSpecies::setPenetrationDepthMax(Mdouble penetrationDepthMax)
{
    penetrationDepthMax_ = penetrationDepthMax;
}

Mdouble SinterNormalSpecies::computeTimeStep(Mdouble mass)
{
    if (unloadingStiffnessMax_ / (.5 * mass) < mathsFunc::square(dissipation_ /mass)) {
        std::cerr << "Dissipation too high; max. allowed " << sqrt(2.0 * unloadingStiffnessMax_ * mass) << std::endl;
        exit(-1);
    }
    return 0.02 * constants::pi / std::sqrt(unloadingStiffnessMax_ / (.5 * mass) - mathsFunc::square(dissipation_ /mass));
}

void SinterNormalSpecies::setDissipation(Mdouble dissipation)
{
    if (dissipation < 0)
    {
        logger(ERROR,"setDissipation(%)",dissipation);
        exit(-1);
    }
    dissipation_ = dissipation;
}

void SinterNormalSpecies::setSinterAdhesion(Mdouble sinterAdhesion)
{
    if (sinterAdhesion < 0)
    {
        logger(ERROR,"setSinterAdhesion(%)",sinterAdhesion);
        exit(-1);
    }
    sinterAdhesion_ = sinterAdhesion;
}
void SinterNormalSpecies::setSinterRate(Mdouble sinterRate)
{
    if (sinterRate < 0)
    {
        logger(ERROR,"setSinterRate(%)",sinterRate);
    }
    sinterRate_ = sinterRate;
}

void SinterNormalSpecies::setSinterType(SINTERTYPE sinterType)
{
    sinterType_ = sinterType;
    if (sinterType_==SINTERTYPE::CONSTANT_RATE)
        logger(INFO, "Sintertype set to CONSTANT_RATE");
    else if (sinterType_==SINTERTYPE::PARHAMI_MCKEEPING)
        logger(INFO, "Sintertype set to PARHAMI_MCKEEPING");
    else if (sinterType_==SINTERTYPE::TEMPERATURE_DEPENDENT_FRENKEL)
        logger(INFO, "Sintertype set to TEMPERATURE_DEPENDENT_FRENKEL");
    else
        logger(ERROR, "Sintertype not understood");
}

void SinterNormalSpecies::setInverseSinterViscosity(Mdouble inverseSinterViscosity)
{
    //assertOrDie(inverseSinterViscosity < 0, "inverseSinterViscosity should be non-negative!");
    if (inverseSinterViscosity < 0)
    {
        logger(ERROR,"setInverseSinterViscosity(%)",inverseSinterViscosity);
    }
    setSinterType(SINTERTYPE::PARHAMI_MCKEEPING);
    inverseSinterViscosity_ = inverseSinterViscosity;
}

void SinterNormalSpecies::setSinterForceAndTime (Mdouble adhesionForce, Mdouble sinterTime, Mdouble radius)
{
    sinterType_ = SINTERTYPE::PARHAMI_MCKEEPING;
    setSinterAdhesion(adhesionForce/radius);
    setInverseSinterViscosity(1.0/(93.75 * adhesionForce * sinterTime / std::pow(radius, 5)));
    logger(INFO,"Set sintering parameters: adhesion force f_a=%*r,  sinter viscosity is nu = contactRadius^4/%",
           getSinterAdhesion(), getInverseSinterViscosity());
}

void SinterNormalSpecies::setParhamiMcKeeping
        (Mdouble alpha, Mdouble beta, Mdouble atomicVolume /*Omega*/, Mdouble surfaceEnergy /*gamma_s*/,
         Mdouble thicknessDiffusion /*deltaB*D0B*/, Mdouble activationEnergy /*QB*/, Mdouble temperature /*T*/)
{
    setSinterType(SINTERTYPE::PARHAMI_MCKEEPING);
    const Mdouble boltzmannConstant /*k_B*/ = 1.38064852e-23;
    const Mdouble gasConstant /*R_g*/ = 8.314459848;
    const Mdouble thicknessDiffusionVacancy /*DB*/ = thicknessDiffusion*exp(-activationEnergy/gasConstant/temperature);
    const Mdouble diffusionParameter /*DeltaB*/ = atomicVolume/boltzmannConstant/temperature*thicknessDiffusionVacancy;
    setInverseSinterViscosity(constants::pi / (2.0 * beta * diffusionParameter));
    setSinterAdhesion(alpha/beta*constants::pi*surfaceEnergy);
    logger(INFO,"Set sintering parameters: the adhesion force f_a=%*r, the rate of change of the plastic overlap is d(delta0)/dt=f_ep/(%*a^4)", getSinterAdhesion(),
           getInverseSinterViscosity());
}

void SinterNormalSpecies::setLoadingStiffnessAndDissipation(helpers::KAndDisp new_)
{
    setLoadingStiffness(new_.k);
    setDissipation(new_.disp);
}

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

Mdouble SinterNormalSpecies::getSinterAdhesion() const
{
    return sinterAdhesion_;
}
Mdouble SinterNormalSpecies::getInverseSinterViscosity() const
{
    return inverseSinterViscosity_;
}
Mdouble SinterNormalSpecies::getSinterRate() const
{
    return sinterRate_;
}
SINTERTYPE SinterNormalSpecies::getSinterType() const
{
    return sinterType_;
}

double SinterNormalSpecies::getTemperatureDependentSinterRate(double temperature) const
{
    return temperatureDependentSinterRate_(temperature);
}

std::function<double(double temperature)> SinterNormalSpecies::getTemperatureDependentSinterRate() const
{
    return temperatureDependentSinterRate_;
}

void SinterNormalSpecies::setTemperatureDependentSinterRate(std::function<double(double temperature)> temperatureDependentSinterRate)
{
    temperatureDependentSinterRate_ = temperatureDependentSinterRate;
}


void SinterNormalSpecies::setCollisionTimeAndRestitutionCoefficient(Mdouble tc, Mdouble eps, Mdouble mass)
{
    if (eps==0.0) {
        loadingStiffness_ = .5 * mass * mathsFunc::square(constants::pi / tc);
        dissipation_ = std::sqrt(2.0 * mass * loadingStiffness_);
    } else {
        dissipation_ = -mass / tc * std::log(eps);
        loadingStiffness_ = .5 * mass * (mathsFunc::square(constants::pi / tc) + mathsFunc::square(dissipation_ / mass));
    }
    unloadingStiffnessMax_ = loadingStiffness_;
}

void SinterNormalSpecies::setStiffnessAndRestitutionCoefficient(Mdouble stiffness, Mdouble eps, Mdouble mass)
{
    loadingStiffness_ = stiffness;
    if (eps==0.0) {
        dissipation_ = std::sqrt(2.0 * mass * stiffness);
    } else {
        dissipation_ = -std::sqrt(2.0 * mass * stiffness / (constants::sqr_pi + mathsFunc::square(log(eps)))) * log(eps);
    }
    unloadingStiffnessMax_ = loadingStiffness_;
}

Mdouble SinterNormalSpecies::getCollisionTime(Mdouble mass)
{
    if (mass <= 0)
    {
        std::cerr << "Error in getCollisionTime(" << mass << ") mass is not set or has an unexpected value, (getCollisionTime(" << mass << "))" << std::endl;
        exit(-1);
    }
    if (loadingStiffness_ <= 0)
    {
        std::cerr << "Error in getCollisionTime(" << mass << ") stiffness=" << loadingStiffness_ << " is not set or has an unexpected value, (getCollisionTime(" << mass << "), with stiffness=" << loadingStiffness_ << ")" << std::endl;
        exit(-1);
    }
    if (dissipation_ < 0)
    {
        std::cerr << "Error in getCollisionTime(" << mass << ") dissipation=" << dissipation_ << " is not set or has an unexpected value, (getCollisionTime(" << mass << "), with dissipation=" << dissipation_ << ")" << std::endl;
        exit(-1);
    }
    Mdouble tosqrt = loadingStiffness_ / (.5 * mass) - mathsFunc::square(dissipation_ / mass);
    if (tosqrt <= -1e-8*loadingStiffness_ / (.5 * mass))
    {
        std::cerr << "Error in getCollisionTime(" << mass << ") values for mass, stiffness and dissipation would lead to an overdamped system, (getCollisionTime(" << mass << "), with stiffness=" << loadingStiffness_ << " and dissipation=" << dissipation_ << ")" << std::endl;
        exit(-1);
    }
    return constants::pi / std::sqrt(tosqrt);
}