ParticleSpecies.cc

Go to the documentation of this file.

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


class BaseParticle;
class BaseInteractable;

ParticleSpecies::ParticleSpecies()
{
    density_ = 0.0;
#ifdef DEBUG_CONSTRUCTOR
    std::cout<<"ParticleSpecies::ParticleSpecies() finished"<<std::endl;
#endif
}

ParticleSpecies::ParticleSpecies(const ParticleSpecies &p)
{
    density_=p.density_;
#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_;
}

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

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::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
{
    if (!p->isFixed())
    {
        switch (p->getParticleDimensions())
        {
            case 3:
            {
                p->mass_ = (4.0 / 3.0 * constants::pi * p->getRadius() * p->getRadius() * p->getRadius() * getDensity());
                p->invMass_ = 1.0 / (p->mass_);
                p->inertia_ = (.4 * p->getMass() * mathsFunc::square(p->getRadius()));
                p->invInertia_ = 1.0 / (p->inertia_);
                break;
            }
            case 2:
            {
                p->mass_ = (constants::pi * p->getRadius() * p->getRadius() * getDensity());
                p->invMass_ = 1.0 / (p->mass_);
                p->inertia_ = (.5 * p->getMass() * mathsFunc::square(p->getRadius()));
                p->invInertia_ = 1.0 / (p->inertia_);
                break;
            }
            case 1:
            {
                p->mass_ = (2.0 * p->getRadius() * getDensity());
                p->invMass_ = 1.0/p->mass_;
                p->inertia_ = 0.0;
                p->invInertia_ = std::numeric_limits<Mdouble>::quiet_NaN();
                break;
            }
            default:
            {
                logger(ERROR, "ParticleSpecies::computeMass()] the dimension of the particle is not set");
            }
        }
    }
}