SinterNormalSpecies.h

Go to the documentation of this file.

//Copyright (c) 2013-2023, 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 SinterNormalSpecies_H
#define SinterNormalSpecies_H
 
#include "Species/NormalForceSpecies/BaseNormalForce.h"
#include "Math/ExtendedMath.h"
#include "Interactions/NormalForceInteractions/SinterInteraction.h"
#include "Math/Helpers.h"
 
enum class SINTERTYPE : unsigned char
{
    PARHAMI_MCKEEPING = 0,
    CONSTANT_RATE = 1,
    TEMPERATURE_DEPENDENT_FRENKEL = 2,
    REGIME_SINTERING = 3
};
 
class SinterNormalSpecies : public BaseNormalForce
{
public:
    typedef SinterInteraction InteractionType;
    
    SinterNormalSpecies();
    
    SinterNormalSpecies(const SinterNormalSpecies& p);
    
    ~SinterNormalSpecies();
    
    void read(std::istream& is);
    
    void write(std::ostream& os) const;
    
    std::string getBaseName() const;
 
// Species-specific functions
    
    void mix(SinterNormalSpecies* S, SinterNormalSpecies* T);
    
    void setCollisionTimeAndRestitutionCoefficient(Mdouble tc, Mdouble eps, Mdouble mass);
    
    void setStiffnessAndRestitutionCoefficient(Mdouble k_, Mdouble eps, Mdouble mass);
    
    Mdouble getCollisionTime(Mdouble mass);
 
//setters and getters
    
    void setPlasticParameters(Mdouble loadingStiffness, Mdouble unloadingStiffnessMax, Mdouble cohesionStiffness,
                              Mdouble penetrationDepthMax);
    
    Mdouble getLoadingStiffness() const;
    
    Mdouble getUnloadingStiffnessMax() const;
    
    Mdouble getCohesionStiffness() const;
    
    Mdouble getPenetrationDepthMax() const;
    
    void setLoadingStiffness(Mdouble loadingStiffness);
    
    void setUnloadingStiffnessMax(Mdouble unloadingStiffnessMax);
    
    void setCohesionStiffness(Mdouble cohesionStiffness);
    
    void setPenetrationDepthMax(Mdouble penetrationDepthMax);
    
    void setDissipation(Mdouble dissipation);
    
    Mdouble getDissipation() const;
    
    void setSinterAdhesion(Mdouble sinterAdhesion);
    
    Mdouble getSinterAdhesion() const;
    
    void setInverseSinterViscosity(Mdouble inverseSinterViscosity);
    
    Mdouble getInverseSinterViscosity() const;
    
    MERCURYDPM_DEPRECATED void setLoadingStiffnessAndDissipation(helpers::KAndDisp new_);
    
    Mdouble computeTimeStep(Mdouble mass);
    
    void setSinterForceAndTime(Mdouble adhesionForce, Mdouble sinterTime, Mdouble radius);
    
    void setParhamiMcKeeping
            (Mdouble alpha, Mdouble beta, Mdouble atomicVolume /*Omega*/, Mdouble surfaceEnergy /*gamma_s*/,
             Mdouble thicknessDiffusion /*deltaB*D0B*/, Mdouble activationEnergy /*QB*/, Mdouble temperature /*T*/);
    
    void setSinterRate(Mdouble sinterRate);
    
    void setSinterType(SINTERTYPE sinterType);
    
    Mdouble getSinterRate() const;
    
    SINTERTYPE getSinterType() const;
    
    std::function<double(double temperature)> getTemperatureDependentSinterRate() const;
    
    double getTemperatureDependentSinterRate(double temperature) const;
    
    void setTemperatureDependentSinterRate(std::function<double(double temperature)> temperatureDependentSinterRate);
 
    void setComplianceZero(Mdouble complianceZero);
 
    Mdouble getComplianceZero() const;
 
    void setSurfTension(Mdouble complianceZero);
 
    Mdouble getSurfTension() const;
 
    void setConstantC1(Mdouble constantC1_);
 
    Mdouble getConstantC1() const;
 
    void setSeparationDis(Mdouble separationDis);
 
    Mdouble getSeparationDis() const;
 
 
private:
    Mdouble loadingStiffness_;
    
    Mdouble unloadingStiffnessMax_;
    
    Mdouble cohesionStiffness_;
    
    Mdouble penetrationDepthMax_;
    
    Mdouble dissipation_;
    
    Mdouble sinterAdhesion_;
    
    Mdouble inverseSinterViscosity_;
    
    Mdouble sinterRate_;
 
    Mdouble complianceZero_;
 
    Mdouble surfTension_;
 
    Mdouble constantC1_;
 
    Mdouble separationDis_;
    
    SINTERTYPE sinterType_;
    
    std::function<double(double temperature)> temperatureDependentSinterRate_ = [this](
            double temperature) { return sinterRate_; };
};
 
#endif