ParticleSpecies Class Reference

#include <ParticleSpecies.h>

Inheritance diagram for ParticleSpecies:

Public Types
typedef BaseInteraction	InteractionType

Public Member Functions
	ParticleSpecies ()
	The default constructor. More...
	ParticleSpecies (const ParticleSpecies &p)
	The default copy constructor. More...
virtual	~ParticleSpecies ()
	The default destructor. More...
virtual ParticleSpecies *	copy () const =0
	Creates a deep copy of the object from which it is called. More...
virtual BaseSpecies *	copyMixed () const =0
	Creates a new MixedSpecies with the same force properties as the Species from which it is called. See Species::copyMixed for details. More...
void	read (std::istream &is)
	Reads the species properties from an input stream. More...
void	write (std::ostream &os) const
	Writes the species properties to an output stream. More...
std::string	getBaseName () const
	Used in Species::getName to obtain a unique name for each Species. More...
void	setDensity (Mdouble density)
	Allows density_ to be changed. More...
Mdouble	getMassFromRadius (const Mdouble radius) const
Mdouble	getVolumeFromRadius (const Mdouble radius) const
Mdouble	getDensity () const
	Allows density_ to be accessed. More...
void	computeMass (BaseParticle *p) const
	Compute Particle mass function, which required a reference to the Species vector. It computes the Particles mass, Inertia and the inverses. More...
Public Member Functions inherited from BaseSpecies
	BaseSpecies ()
	The default constructor. More...
	BaseSpecies (const BaseSpecies &p)
	The copy constructor. More...
virtual	~BaseSpecies ()
	The default destructor. More...
void	setHandler (SpeciesHandler *handler)
	Sets the pointer to the handler to which this species belongs. More...
SpeciesHandler *	getHandler () const
	Returns the pointer to the handler to which this species belongs. More...
Mdouble	average (Mdouble a, Mdouble b)
	defines the average of two variables by the harmonic mean. More...
virtual void	mixAll (BaseSpecies *const S, BaseSpecies *const T)=0
	creates default values for mixed species More...
virtual Mdouble	getInteractionDistance () const =0
	returns the largest separation distance at which adhesive short-range forces can occur. More...
virtual bool	getUseAngularDOFs () const =0
	Returns true if torques (i.e. angular degrees of freedom) have to be calculated. More...
virtual BaseInteraction *	getNewInteraction (BaseInteractable *P, BaseInteractable *I, Mdouble timeStamp) const =0
	returns new Interaction object. More...
Public Member Functions inherited from BaseObject
	BaseObject ()
	Default constructor. More...
	BaseObject (const BaseObject &p)
	Copy constructor, copies all the objects BaseObject contains. More...
virtual	~BaseObject ()
	virtual destructor More...
virtual std::string	getName () const =0
	A purely virtual function. More...
virtual void	moveInHandler (const unsigned int index)
	Except that it is virtual, it does the same thing as setIndex() does. More...
void	setIndex (const unsigned int index)
	Allows one to assign an index to an object in the handler/container. More...
void	setId (const unsigned int id)
	Assigns a unique identifier to each object in the handler (container) which remains constant even after the object is deleted from the container/handler. More...
unsigned int	getIndex () const
	Returns the index of the object in the handler. More...
unsigned int	getId () const
	Returns the unique identifier of any particular object. More...

Private Attributes
Mdouble	density_
	The mass density. More...

Detailed Description

Definition at line 36 of file ParticleSpecies.h.

Member Typedef Documentation

typedef BaseInteraction ParticleSpecies::InteractionType

Definition at line 39 of file ParticleSpecies.h.

Constructor & Destructor Documentation

ParticleSpecies::ParticleSpecies

(

)

The default constructor.

Definition at line 37 of file ParticleSpecies.cc.

References density_.

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

ParticleSpecies::ParticleSpecies

(

const ParticleSpecies &

p

)

The default copy constructor.

Parameters

[in]

p

the species that is copied

Definition at line 48 of file ParticleSpecies.cc.

References density_.

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

ParticleSpecies::~ParticleSpecies ( )

virtual

The default destructor.

Definition at line 56 of file ParticleSpecies.cc.

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

Member Function Documentation

void ParticleSpecies::computeMass

(

BaseParticle *

p

)

const

Compute Particle mass function, which required a reference to the Species vector. It computes the Particles mass, Inertia and the inverses.

Compute BaseParticle mass function, which required a reference to the Species vector.

It computes the Particles mass, Inertia and the inverses. this function is called, if BaseParticleHandler::addObject, SpeciesHandler::addObject, ParticleSpecies::setDensity, BaseParticle::setRadius or DPMBase::setParticleDimensions is called

Definition at line 145 of file ParticleSpecies.cc.

References ERROR, getDensity(), BaseParticle::getMass(), BaseParticle::getParticleDimensions(), BaseParticle::getRadius(), BaseParticle::inertia_, BaseParticle::invInertia_, BaseParticle::invMass_, BaseParticle::isFixed(), logger, BaseParticle::mass_, constants::pi, and mathsFunc::square().

Referenced by ParticleHandler::addObject(), BaseParticle::setRadius(), and BaseParticle::unfix().

{
    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");
            }
        }
    }
}

virtual ParticleSpecies* ParticleSpecies::copy ( ) const

pure virtual

Creates a deep copy of the object from which it is called.

See BaseSpecies::copy for details

Implements BaseSpecies.

Implemented in Species< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >.

Referenced by MaserBoundary::addParticleToMaser().

virtual BaseSpecies* ParticleSpecies::copyMixed ( ) const

pure virtual

Creates a new MixedSpecies with the same force properties as the Species from which it is called. See Species::copyMixed for details.

Implemented in Species< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >.

Referenced by SpeciesHandler::addObject().

std::string ParticleSpecies::getBaseName

(

)

const

Used in Species::getName to obtain a unique name for each Species.

Returns

a string containing the name of the species (minus the word "Species")

Definition at line 86 of file ParticleSpecies.cc.

{
    return "Particle";
}

Mdouble ParticleSpecies::getDensity

(

)

const

Allows density_ to be accessed.

Returns

the particle density

Definition at line 104 of file ParticleSpecies.cc.

References density_.

Referenced by computeMass(), HertzianSinterNormalSpecies::computeTimeStep(), getMassFromRadius(), and FileReader::read().

{
    return density_;
}

Mdouble ParticleSpecies::getMassFromRadius

(

const Mdouble

radius

)

const

Todo:

TW: should getMassFromRadius be removed? IFCD: it is used in at least one driver (AxisymmetricHopper).

Definition at line 109 of file ParticleSpecies.cc.

References getDensity(), and getVolumeFromRadius().

Referenced by ChuteBottom::makeRoughBottom().

{
    return getDensity()*getVolumeFromRadius(radius);
}

Mdouble ParticleSpecies::getVolumeFromRadius

(

const Mdouble

radius

)

const

Todo:

this should depend on the particle shape; thus, it should be a static function of BaseParticle

Definition at line 115 of file ParticleSpecies.cc.

References ERROR, BaseHandler< T >::getDPMBase(), BaseSpecies::getHandler(), DPMBase::getParticleDimensions(), logger, and constants::pi.

Referenced by getMassFromRadius().

{
    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::read ( std::istream &  is )

virtual

Reads the species properties from an input stream.

Parameters

[in]

is

input stream (typically the restart file)

Implements BaseObject.

Reimplemented in Species< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >.

Definition at line 76 of file ParticleSpecies.cc.

References density_, and BaseObject::read().

Referenced by Species< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::read().

{
    BaseSpecies::read(is);
    std::string dummy;
    is >> dummy >> density_;
}

void ParticleSpecies::setDensity

(

Mdouble

density

)

Allows density_ to be changed.

Todo:

recalculate masses when setting dim_particle or rho

Parameters

[in]

density

the particle density

Definition at line 94 of file ParticleSpecies.cc.

References ParticleHandler::computeAllMasses(), density_, BaseHandler< T >::getDPMBase(), BaseSpecies::getHandler(), BaseObject::getIndex(), logger, and DPMBase::particleHandler.

Referenced by FileReader::read(), and SpeciesHandler::readOldObject().

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

void ParticleSpecies::write ( std::ostream &  os ) const

virtual

Writes the species properties to an output stream.

Parameters

[out]

os

output stream (typically the restart file)

Implements BaseObject.

Reimplemented in Species< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >.

Definition at line 66 of file ParticleSpecies.cc.

References density_, and BaseObject::write().

Referenced by Species< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::write().

{
    //note we inherit from BaseObject, not BaseParticle
    BaseObject::write(os);
    os << " density " << density_;
}

Member Data Documentation

Mdouble ParticleSpecies::density_

private

The mass density.

Definition at line 93 of file ParticleSpecies.h.

Referenced by getDensity(), ParticleSpecies(), read(), setDensity(), and write().

---

The documentation for this class was generated from the following files:

• Species/ParticleSpecies.h
• Species/ParticleSpecies.cc