ParticleSpecies.h

Go to the documentation of this file.

// This file is part of the MercuryDPM project (https://www.mercurydpm.org).
// Copyright (c), The MercuryDPM Developers Team. All rights reserved.
// License: BSD 3-Clause License; see the LICENSE file in the root directory.
 
#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