ParticleSpecies.cc

Go to the documentation of this file.

//Copyright (c) 2013-2020, 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 "Logger.h"
#include "ParticleSpecies.h"
#include "DPMBase.h"
#include "Particles/BaseParticle.h"
#include "Particles/SuperQuadricParticle.h"

class BaseParticle;

class BaseInteractable;

ParticleSpecies::ParticleSpecies()
    : BaseSpecies(), density_(1.0)
{
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"ParticleSpecies::ParticleSpecies() finished"<<std::endl;
#endif
}

ParticleSpecies::ParticleSpecies(BaseNormalForce* normalForce, BaseFrictionForce* frictionForce, BaseAdhesiveForce* adhesiveForce)
    : BaseSpecies(normalForce,frictionForce, adhesiveForce), density_(1.0)
{
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"ParticleSpecies::ParticleSpecies(n,f,a) finished"<<std::endl;
#endif
}


ParticleSpecies::ParticleSpecies(const ParticleSpecies& p)
    : BaseSpecies(p)
{
    density_ = p.density_;
    temperatureDependentDensity_ = p.temperatureDependentDensity_;
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"ParticleSpecies::ParticleSpecies(const ParticleSpecies &p) finished"<<std::endl;
#endif
}

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

void ParticleSpecies::write(std::ostream& os) const
{
    //note we inherit from BaseObject, not BaseParticle
    BaseObject::write(os);
    os << " density " << density_;
    BaseSpecies::write(os);
    //todo flip the two values
}

void ParticleSpecies::read(std::istream& is)
{
    BaseObject::read(is);
    std::string dummy;
    is >> dummy >> density_;
    BaseSpecies::read(is);
}

std::string ParticleSpecies::getBaseName() const
{
    return "Particle";
}

void ParticleSpecies::setDensity(Mdouble density)
{
    logger.assert_always(density >= 0, "[ParticleSpecies::setDensity(%)] value cannot be negative", density);
    density_ = density;
    if (getHandler()) getHandler()->getDPMBase()->particleHandler.computeAllMasses(getIndex());
}

Mdouble ParticleSpecies::getDensity() const
{
    return density_;
}

Mdouble ParticleSpecies::getMassFromRadius(const Mdouble radius) const
{
    return getDensity() * getVolumeFromRadius(radius);
}

Mdouble ParticleSpecies::getMassFromRadius(const Mdouble radius,SpeciesHandler& speciesHandler)
{
    setHandler(&speciesHandler);
    return getMassFromRadius(radius);
}

Mdouble ParticleSpecies::getVolumeFromRadius(const Mdouble radius) const
{
    if (getHandler() == nullptr)
    {
        logger(ERROR,
               "[Species::VolumeFromRadius()] No handler has been set, therefore, I can't figure out the dimensions.");
        return 0;
    }
    
    unsigned int particleDimensions = getHandler()->getDPMBase()->getParticleDimensions();
    if (particleDimensions == 3)
    {
        return 4.0 / 3.0 * constants::pi * radius * radius * radius;
    }
    else if (particleDimensions == 2)
    {
        return constants::pi * radius * radius;
    }
    else if (particleDimensions == 1)
    {
        return 2.0 * radius;
    }
    else
    {
        logger(ERROR, "[Species::VolumeFromRadius()] the dimension of the particle is wrongly set to %",
               particleDimensions);
        return 0.0;
    }
}

void ParticleSpecies::computeMass(BaseParticle* p) const
{
    p->computeMass(*this);
}

const std::function<double(double)>& ParticleSpecies::getTemperatureDependentDensity() const
{
    return temperatureDependentDensity_;
}

void ParticleSpecies::setTemperatureDependentDensity(
        const std::function<double(double)>& temperatureDependentDensity)
{
    temperatureDependentDensity_ = temperatureDependentDensity;
//    density_ = temperatureDependentDensity_(0);
//    logger(INFO,"Setting initial density to %",temperature_);
}

Mdouble ParticleSpecies::getLargestInverseParticleMassLocal() const
{
    Mdouble maxInvMass = 0;
    logger.assert_debug(getHandler() != nullptr && getHandler()->getDPMBase() != nullptr,"speciesHandler must be set");
    for (BaseParticle* const p : getHandler()->getDPMBase()->particleHandler)
    {
        if (p->getSpecies()==this && !(p->isFixed() || p->isMPIParticle() || p->isPeriodicGhostParticle()) && p->getInvMass() > maxInvMass)
        {
            maxInvMass = p->getInvMass();
        }
    }
    return maxInvMass;
}

Mdouble ParticleSpecies::getSmallestParticleMass() const
{
#ifdef MERCURY_USE_MPI
    Mdouble maxInvMass = 0;
    Mdouble invMassLocal = getLargestInverseParticleMassLocal();
    //Obtain the global value
    MPIContainer::Instance().allReduce(invMassLocal, maxInvMass, MPI_MAX);
    //return value
    return 1.0 / maxInvMass;
#else
    return 1.0 / getLargestInverseParticleMassLocal();
#endif

}

void ParticleSpecies::setMaxInteractionDistance(Mdouble interactionDistance) {
    // if maxInteractionDistance_ has increased it's simple
    if (interactionDistance>=maxInteractionDistance_) {
        maxInteractionDistance_ = interactionDistance;
    } else /*else we need to recompute*/ {
        maxInteractionDistance_ = 0;
        int j = getIndex();
        for (int i=0; i<getHandler()->getSize(); ++i) {
            const auto mixedSpecies = getHandler()->getMixedObject(i,j);
            if (mixedSpecies) { //this check is necessary because the mixed species handler might not yet be built fully
                maxInteractionDistance_ = std::max(maxInteractionDistance_,
                        mixedSpecies->getInteractionDistance());
            }
        }
    }
}

const BaseSpecies* ParticleSpecies::getMixedSpecies(const ParticleSpecies* s) const {
    return (getIndex()==s->getIndex())?this:getHandler()->getMixedObject(getIndex(),s->getIndex());
}