HertzianSinterNormalSpecies.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 HertzianSinterNormalSpecies_H
#define HertzianSinterNormalSpecies_H
 
#include "Species/NormalForceSpecies/BaseNormalForce.h"
#include "Math/ExtendedMath.h"
#include "Interactions/NormalForceInteractions/HertzianSinterInteraction.h"
 
class HertzianSinterNormalSpecies : public BaseNormalForce
{
public:
    typedef HertzianSinterInteraction InteractionType;
    
    HertzianSinterNormalSpecies();
    
    HertzianSinterNormalSpecies(const HertzianSinterNormalSpecies& p);
    
    ~HertzianSinterNormalSpecies();
    
    void read(std::istream& is);
    
    void write(std::ostream& os) const;
    
    std::string getBaseName() const;
 
// Species-specific functions
    
    void mix(HertzianSinterNormalSpecies* S, HertzianSinterNormalSpecies* T);
 
 
//setters and getters
    
    void setPlasticParameters(Mdouble loadingModulus, Mdouble unloadingModulusMax, Mdouble cohesionModulus,
                              Mdouble penetrationDepthMax);
    
    Mdouble getLoadingModulus() const;
    
    Mdouble getUnloadingModulusMax() const;
    
    Mdouble getCohesionModulus() const;
    
    Mdouble getPenetrationDepthMax() const;
    
    void setLoadingModulus(Mdouble loadingModulus);
    
    void setUnloadingModulusMax(Mdouble unloadingModulusMax);
    
    void setCohesionModulus(Mdouble cohesionModulus);
    
    void setPenetrationDepthMax(Mdouble penetrationDepthMax);
    
    void setDissipation(Mdouble dissipation);
    
    Mdouble getDissipation() const;
    
    void setSinterRate(Mdouble sinterRate);
    
    Mdouble getSinterRate() const;
    
    Mdouble computeTimeStep(Mdouble mass);
 
 
private:
    Mdouble loadingModulus_;
    
    Mdouble unloadingModulusMax_;
    
    Mdouble cohesionModulus_;
    
    Mdouble penetrationDepthMax_;
    
    Mdouble dissipation_;
    
    Mdouble sinterRate_;
};
 
#endif