ParticleSpecies.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 ParticleSpecies_H
#define ParticleSpecies_H
 
#include "BaseSpecies.h"
#include "Math/ExtendedMath.h"
#include "Interactions/BaseInteraction.h"
 
class BaseInteractable;
 
//Note the getVelocity can for some Species be dependent on which point on the Species is meant.
class ParticleSpecies : public BaseSpecies
{
public:
    typedef BaseInteraction InteractionType;
    typedef BaseSpecies MixedSpeciesType;
    
    ParticleSpecies();
 
    ParticleSpecies(const ParticleSpecies& p);
 
    ParticleSpecies(BaseNormalForce* normalForce, BaseFrictionForce* frictionForce, BaseAdhesiveForce* adhesiveForce);
 
    ~ParticleSpecies();
    
    ParticleSpecies* copy() const override = 0;
    
    virtual BaseSpecies* copyMixed() const = 0;
    
    void read(std::istream& is) override;
    
    void write(std::ostream& os) const override;
    
    std::string getBaseName() const;
    
    void setDensity(Mdouble density);
    
    Mdouble getMassFromRadius(Mdouble radius) const;
 
    Mdouble getMassFromRadius(const Mdouble radius,SpeciesHandler& speciesHandler);
 
    Mdouble getVolumeFromRadius(Mdouble radius) const;
    
    Mdouble getDensity() const;
    
    void computeMass(BaseParticle* p) const;
    
    void setTemperatureDependentDensity(const std::function<double(double)>& temperatureDependentDensity);
    
    const std::function<double(double)>& getTemperatureDependentDensity() const;
    
    Mdouble getSmallestParticleMass() const;
    
 
    Mdouble getMaxInteractionDistance() const {return maxInteractionDistance_;}
    
    void setMaxInteractionDistance(Mdouble interactionDistance=0);
    
    const BaseSpecies* getMixedSpecies(const ParticleSpecies* s) const;
 
    virtual void actionsAfterTimeStep(BaseParticle* particle) const {};
 
private:
    
    Mdouble getLargestInverseParticleMassLocal() const;
 
    Mdouble density_;
    
    std::function<double(double temperature)> temperatureDependentDensity_;
    
    Mdouble maxInteractionDistance_;
    
    
};
 
#endif