ParticleHandler Class Reference

Container to store all BaseParticle. More...

#include <ParticleHandler.h>

Inheritance diagram for ParticleHandler:

Public Member Functions
	ParticleHandler ()
	Default constructor, it creates an empty ParticleHandler. More...
	ParticleHandler (const ParticleHandler &PH)
	Constructor that copies all BaseParticle it contains and then sets the smallest and largest particle. More...
ParticleHandler	operator= (const ParticleHandler &rhs)
	Assignment operator. More...
	~ParticleHandler ()
	Destructor, it destructs the ParticleHandler and all BaseParticle it contains. More...
virtual void	addObject (BaseParticle *P)
	Adds a BaseParticle to the ParticleHandler. More...
virtual void	removeObject (unsigned const int index)
	Removes a BaseParticle from the ParticleHandler. More...
void	removeLastObject ()
	Removes the last BaseParticle from the ParticleHandler. More...
void	computeSmallestParticle ()
	Computes the smallest particle (by interaction radius) and sets it in smallestParticle_. More...
void	computeLargestParticle ()
	Computes the largest particle (by interaction radius) and sets it in largestParticle_. More...
BaseParticle *	getSmallestParticle () const
	Gets a pointer to the smallest BaseParticle (by interactionRadius) in this ParticleHandler. More...
BaseParticle *	getLargestParticle () const
	Gets a pointer to the largest BaseParticle (by interactionRadius) in this ParticleHandler. More...
BaseParticle *	getFastestParticle () const
	Gets a pointer to the fastest BaseParticle in this ParticleHandler. More...
Mdouble	getMeanRadius () const
	Gets a pointer to the fastest BaseParticle in this ParticleHandler. More...
BaseParticle *	getLowestPositionComponentParticle (const int i) const
	Gets a pointer to the particle with the lowest coordinates in direction i in this ParticleHandler. More...
BaseParticle *	getHighestPositionComponentParticle (const int i) const
	Gets a pointer to the particle with the highest coordinates in direction i in this ParticleHandler. More...
BaseParticle *	getLowestVelocityComponentParticle (const int i) const
	Gets a pointer to the particle with the lowest velocity in direction i in this ParticleHandler. More...
BaseParticle *	getHighestVelocityComponentParticle (const int i) const
	Gets a pointer to the particle with the highest velocity in direction i in this ParticleHandler. More...
BaseParticle *	getLightestParticle () const
	Gets a pointer to the lightest BaseParticle (by mass) in this ParticleHandler. More...
void	clear ()
	Empties the whole ParticleHandler by removing all BaseParticle. More...
void	readObject (std::istream &is)
	Reads BaseParticle into the ParticleHandler from restart data. More...
void	readOldObject (std::string type, std::istream &is)
	Reads BaseParticle into the ParticleHandler from old-style restart data. More...
void	write (std::ostream &os) const
void	checkExtrema (BaseParticle *P)
	Checks if the extrema of this ParticleHandler needs updating. More...
void	checkExtremaOnDelete (BaseParticle *P)
	Checks if the extrema of this ParticleHandler needs updating when a particle is deleted. More...
void	computeAllMasses (unsigned int indSpecies)
	Computes the mass for all BaseParticle of the given species in this ParticleHandler. More...
void	computeAllMasses ()
	Computes the mass for all BaseParticle in this ParticleHandler. More...
std::string	getName () const
	Returns the name of the handler, namely the string "ParticleHandler". More...
void	writeVTK () const
	Writes all particles into a vtk file format (unstructured grid), consisting of particle positions, velocities, radii and type of species (IndSpecies) More...
Public Member Functions inherited from BaseHandler< BaseParticle >
	BaseHandler ()
	Default BaseHandler constructor, it creates an empty BaseHandler and assigns DPMBase_ to a null pointer. More...
	BaseHandler (const BaseHandler< BaseParticle > &BH)
	Constructor that copies the objects of the given handler into itself and sets other variables to 0/nullptr. More...
virtual	~BaseHandler ()
	Destructor, it destructs the BaseHandler and all Object it contains. More...
void	copyContentsFromOtherHandler (const BaseHandler< BaseParticle > &BH)
	Function that copies the contents (vector of pointers, maxObject_, nextId_, DPMBase_) from one handler (container) to the other. More...
std::enable_if <!std::is_pointer< U >::value, U * >::type	copyAndAddObject (const U &object)
	Creates a copy of a Object and adds it to the BaseHandler. More...
std::enable_if < std::is_pointer< U >::value, U >::type	copyAndAddObject (const U object)
	Creates a copy of a Object and adds it to the BaseHandler. More...
void	removeLastObject ()
	Removes the last Object from the BaseHandler. More...
void	clear ()
	Empties the whole BaseHandler by removing all Objects and setting all other variables to 0. More...
void	read (std::istream &is)
	Reads all objects from restart data. More...
BaseParticle *	getObjectById (const unsigned int id)
	Gets a pointer to the Object at the specified index in the BaseHandler. More...
BaseParticle *	getObject (const unsigned int id)
	Gets a pointer to the Object at the specified index in the BaseHandler. More...
const BaseParticle *	getObject (const unsigned int id) const
	Gets a constant pointer to the Object at the specified index in the BaseHandler. More...
BaseParticle *	getLastObject ()
	Gets a pointer to the last Object in this BaseHandler. More...
const BaseParticle *	getLastObject () const
	Gets a constant pointer to the last Object in this BaseHandler. More...
unsigned int	getNumberOfObjects () const
	Gets the number of Object in this BaseHandler. More...
unsigned int	getStorageCapacity () const
	Gets the storage capacity of this BaseHandler. More...
void	setStorageCapacity (const unsigned int N)
	Sets the storage capacity of this BaseHandler. More...
const std::vector < BaseParticle * > ::const_iterator	begin () const
	Gets the begin of the const_iterator over all Object in this BaseHandler. More...
const std::vector < BaseParticle * >::iterator	begin ()
	Gets the begin of the iterator over all BaseBoundary in this BaseHandler. More...
const std::vector < BaseParticle * > ::const_iterator	end () const
	Gets the end of the const_iterator over all BaseBoundary in this BaseHandler. More...
const std::vector < BaseParticle * >::iterator	end ()
	Gets the end of the iterator over all BaseBoundary in this BaseHandler. More...
void	setDPMBase (DPMBase *DPMBase)
	Sets the problem that is solved using this handler. More...
void	setId (BaseParticle *object, unsigned int id)
	This function sets the id and ensures that nextId is a bigger value than id. More...
DPMBase *	getDPMBase ()
	Gets the problem that is solved using this handler. More...
DPMBase *	getDPMBase () const
	Gets the problem that is solved using this handler and does not change the class. More...
virtual void	writeVTK ()
	Over written in WallHandler and ParticleHandler. More...

Static Public Member Functions
static BaseParticle *	getNewObject (const std::string &type)

Private Attributes
BaseParticle *	largestParticle_
	A pointer to the largest BaseParticle (by interactionRadius) in this ParticleHandler. More...
BaseParticle *	smallestParticle_
	A pointer to the smallest BaseParticle (by interactionRadius) in this ParticleHandler. More...

Additional Inherited Members
Protected Attributes inherited from BaseHandler< BaseParticle >
std::vector< BaseParticle * >	objects_
	The actual list of Object pointers. More...

Detailed Description

Container to store all BaseParticle.

The ParticleHandler is a container to store all BaseParticle. It is implemented by a vector of pointers to BaseParticle.

Definition at line 40 of file ParticleHandler.h.

Constructor & Destructor Documentation

ParticleHandler::ParticleHandler

(

)

Default constructor, it creates an empty ParticleHandler.

Constructor of the ParticleHandler class. It creates and empty ParticleHandler.

Definition at line 42 of file ParticleHandler.cc.

References DEBUG, largestParticle_, logger, and smallestParticle_.

{
    largestParticle_ = nullptr;
    smallestParticle_ = nullptr;
    logger(DEBUG, "ParticleHandler::ParticleHandler() finished");
}

ParticleHandler::ParticleHandler

(

const ParticleHandler &

PH

)

Constructor that copies all BaseParticle it contains and then sets the smallest and largest particle.

Parameters

[in]

PH

The ParticleHandler that has to be copied.

This is not a copy constructor! It copies the DPMBase and all BaseParticle, and sets the other variables to 0. After that, it computes the smallest and largest particle in this handler.

Definition at line 55 of file ParticleHandler.cc.

References clear(), computeLargestParticle(), computeSmallestParticle(), BaseHandler< BaseParticle >::copyContentsFromOtherHandler(), DEBUG, BaseHandler< T >::getDPMBase(), largestParticle_, logger, BaseHandler< BaseParticle >::objects_, BaseHandler< BaseParticle >::setDPMBase(), and smallestParticle_.

    : BaseHandler<BaseParticle>() 
{
    clear();
    setDPMBase(PH.getDPMBase());
    largestParticle_ = nullptr;
    smallestParticle_ = nullptr;
    copyContentsFromOtherHandler(PH);
    if (objects_.size() != 0)
    {
        computeLargestParticle();
        computeSmallestParticle();
    }
    logger(DEBUG, "ParticleHandler::ParticleHandler(const ParticleHandler &PH) finished");
}

ParticleHandler::~ParticleHandler

(

)

Destructor, it destructs the ParticleHandler and all BaseParticle it contains.

Set the pointers to largestParticle_ and smallestParticle_ to nullptr, all BaseParticle are destroyed by the BaseHandler afterwards.

Definition at line 99 of file ParticleHandler.cc.

References DEBUG, largestParticle_, logger, and smallestParticle_.

{
    //First reset the pointers, such that they are not checked twice when removing particles
    largestParticle_ = nullptr;
    smallestParticle_ = nullptr;
    logger(DEBUG, "ParticleHandler::~ParticleHandler() finished");
}

Member Function Documentation

void ParticleHandler::addObject ( BaseParticle *  P )

virtual

Adds a BaseParticle to the ParticleHandler.

Parameters

[in]

P

A pointer to the BaseParticle that has to be added.

To add a BaseParticle to the ParticleHandler, first check if it has a species, since it is as common bug to use a BaseParticle without species, which leads to a segmentation fault. To help the user with debugging, a warning is given if a particle without species is added. After that, the actions for adding the particle to the BaseHandler are taken, which include adding it to the vector of pointers to all BaseParticle and assigning the correct id and index. Then the particle is added to the HGrid, the particle is told that this is its handler, its mass is computed and finally it is checked if this is the smallest or largest particle in this ParticleHandler.

Reimplemented from BaseHandler< BaseParticle >.

Definition at line 120 of file ParticleHandler.cc.

References BaseHandler< T >::addObject(), checkExtrema(), ParticleSpecies::computeMass(), BaseHandler< BaseParticle >::getDPMBase(), BaseObject::getId(), BaseInteractable::getSpecies(), DPMBase::hGridInsertParticle(), DPMBase::hGridUpdateParticle(), logger, BaseParticle::setHandler(), and WARN.

Referenced by CircularPeriodicBoundary::checkBoundaryAfterParticleMoved(), LeesEdwardsBoundary::createHorizontalPeriodicParticles(), ShearBoxBoundary::createHorizontalPeriodicParticles(), CircularPeriodicBoundary::createPeriodicParticles(), MaserBoundary::createPeriodicParticles(), AngledPeriodicBoundary::createPeriodicParticles(), PeriodicBoundary::createPeriodicParticles(), ShearBoxBoundary::createVerticalPeriodicParticles(), and LeesEdwardsBoundary::createVerticalPeriodicParticles().

{
    if (P->getSpecies() == nullptr)
    {
        logger(WARN, "WARNING: The particle with ID % that is added in "
                "ParticleHandler::addObject does not have a species yet."
                "Please make sure that you have "
                "set the species somewhere in the driver code.", P->getId());
    }
    //Puts the particle in the Particle list
    BaseHandler<BaseParticle>::addObject(P);
    if (getDPMBase() != nullptr)
    {
        //This places the particle in this grid
        getDPMBase()->hGridInsertParticle(P);
        //This computes where the particle currently is in the grid
        getDPMBase()->hGridUpdateParticle(P);
    }
    //set the particleHandler pointer
    P->setHandler(this);
    //compute mass of the particle
    P->getSpecies()->computeMass(P) ;
    //Check if this particle has new extrema
    checkExtrema(P);
}

void ParticleHandler::checkExtrema

(

BaseParticle *

P

)

Checks if the extrema of this ParticleHandler needs updating.

Parameters

[in]

P

A pointer to the particle, which properties have to be checked against the ParticleHandlers extrema.

Definition at line 548 of file ParticleHandler.cc.

References computeLargestParticle(), computeSmallestParticle(), BaseParticle::getInteractionRadius(), largestParticle_, and smallestParticle_.

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

{
    if (P == largestParticle_) 
    {
        //if the properties of the largest particle changes
        computeLargestParticle();
    } 
    else if (!largestParticle_ || P->getInteractionRadius() > largestParticle_->getInteractionRadius())
    {
        largestParticle_ = P;
    }
    
    if (P == smallestParticle_) 
    {
        //if the properties of the smallest particle changes
        computeSmallestParticle();
    } 
    else if (!smallestParticle_ || P->getInteractionRadius() < smallestParticle_->getInteractionRadius())
    {
        smallestParticle_ = P;
    }
}

void ParticleHandler::checkExtremaOnDelete

(

BaseParticle *

P

)

Checks if the extrema of this ParticleHandler needs updating when a particle is deleted.

Parameters

[in]

P

A pointer to the particle, which is going to get deleted.

Definition at line 574 of file ParticleHandler.cc.

References computeLargestParticle(), computeSmallestParticle(), largestParticle_, and smallestParticle_.

Referenced by BaseParticle::~BaseParticle().

{
    if (P == largestParticle_)
    {
        computeLargestParticle();
    }
    if (P == smallestParticle_)
    {
        computeSmallestParticle();
    }
}

void ParticleHandler::clear

(

)

Empties the whole ParticleHandler by removing all BaseParticle.

Note that the pointers to smallestParticle_ and largestParticle_ are set to nullptr since these particles don't exist anymore after calling this function.

Definition at line 402 of file ParticleHandler.cc.

References BaseHandler< T >::clear(), largestParticle_, and smallestParticle_.

Referenced by operator=(), ParticleHandler(), FileReader::read(), and DPMBase::read().

{
    smallestParticle_ = nullptr;
    largestParticle_ = nullptr;
    BaseHandler<BaseParticle>::clear();
}

void ParticleHandler::computeAllMasses

(

unsigned int

indSpecies

)

Computes the mass for all BaseParticle of the given species in this ParticleHandler.

Parameters

[in]

indSpecies

Unsigned integer with the index of the species for which the masses must be computed.

Definition at line 590 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::objects_.

Referenced by SpeciesHandler::addObject(), DPMBase::readNextDataFile(), ParticleSpecies::setDensity(), DPMBase::setParticleDimensions(), and DPMBase::solve().

{
     for (BaseParticle* particle : objects_)
     {
        if (particle->getIndSpecies() == indSpecies)
        {
            particle->getSpecies()->computeMass(particle);
        }
     }
}

void ParticleHandler::computeAllMasses

(

)

Computes the mass for all BaseParticle in this ParticleHandler.

Definition at line 601 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::objects_.

{
    for (BaseParticle* particle : objects_)
    {
        particle->getSpecies()->computeMass(particle);
    }
}

void ParticleHandler::computeLargestParticle

(

)

Computes the largest particle (by interaction radius) and sets it in largestParticle_.

Definition at line 194 of file ParticleHandler.cc.

References BaseParticle::getInteractionRadius(), BaseHandler< BaseParticle >::getNumberOfObjects(), largestParticle_, logger, BaseHandler< BaseParticle >::objects_, and WARN.

Referenced by checkExtrema(), checkExtremaOnDelete(), operator=(), and ParticleHandler().

{
    if (getNumberOfObjects() == 0)
    {
        logger(WARN, "No particles, so cannot compute the largest particle.");
        return;
    }
    Mdouble max = -std::numeric_limits<Mdouble>::max();
    largestParticle_ = nullptr;
    for (BaseParticle* const particle : objects_)
    {
        if (particle->getInteractionRadius() > max)
        {
            max = particle->getInteractionRadius();
            largestParticle_ = particle;
        }
    }
}

void ParticleHandler::computeSmallestParticle

(

)

Computes the smallest particle (by interaction radius) and sets it in smallestParticle_.

Definition at line 175 of file ParticleHandler.cc.

References BaseParticle::getInteractionRadius(), BaseHandler< BaseParticle >::getNumberOfObjects(), logger, BaseHandler< BaseParticle >::objects_, smallestParticle_, and WARN.

Referenced by checkExtrema(), checkExtremaOnDelete(), operator=(), and ParticleHandler().

{
    if (getNumberOfObjects() == 0)
    {
        logger(WARN, "No particles, so cannot compute the smallest particle.");
        return;
    }
    Mdouble min = std::numeric_limits<Mdouble>::max();
    smallestParticle_ = nullptr;
    for (BaseParticle* const particle : objects_)
    {
        if (particle->getInteractionRadius() < min)
        {
            min = particle->getInteractionRadius();
            smallestParticle_ = particle;
        }
    }
}

BaseParticle * ParticleHandler::getFastestParticle

(

)

const

Gets a pointer to the fastest BaseParticle in this ParticleHandler.

Returns

A pointer to the fastest BaseParticle in this ParticleHandler.

Definition at line 242 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::getNumberOfObjects(), logger, BaseHandler< BaseParticle >::objects_, and WARN.

{
    if (getNumberOfObjects() == 0)
    {
        logger(WARN, "No particles to set getFastestParticle()" );
        return nullptr;
    }
    BaseParticle* p = nullptr;
    Mdouble maxSpeed = -std::numeric_limits<Mdouble>::max();
    for (BaseParticle* const pLoop : objects_)
    {
        if ((pLoop->getVelocity().getLength()) > maxSpeed)
        {
            maxSpeed = pLoop->getVelocity().getLength();
            p = pLoop;
        }
    }
    return p;
}

BaseParticle * ParticleHandler::getHighestPositionComponentParticle

(

const int

i

)

const

Gets a pointer to the particle with the highest coordinates in direction i in this ParticleHandler.

Parameters

[in]

i

Direction for which one wants the particle with highest coordinates.

Returns

A pointer to the particle with the highest coordinates in direction i in this ParticleHandler.

Definition at line 303 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::getNumberOfObjects(), logger, BaseHandler< BaseParticle >::objects_, and WARN.

{
    if (getNumberOfObjects() == 0)
    {
        logger(WARN, "No getHighestPositionComponentParticle(const int i) since there are no particles.");
        return nullptr;
    }
    BaseParticle* p = nullptr;
    Mdouble max = -std::numeric_limits<Mdouble>::max();
    for (BaseParticle* const pLoop : objects_)
    {
        if (pLoop->getPosition().getComponent(i) > max)
        {
            max = pLoop->getPosition().getComponent(i);
            p = pLoop;
        }
    }
    
    return p;
}

BaseParticle * ParticleHandler::getHighestVelocityComponentParticle

(

const int

i

)

const

Gets a pointer to the particle with the highest velocity in direction i in this ParticleHandler.

Parameters

[in]

i

Direction for which you want the particle with highest velocity.

Returns

A pointer to the particle with the highest velocity in direction i in this ParticleHandler.

Definition at line 354 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::getNumberOfObjects(), logger, BaseHandler< BaseParticle >::objects_, and WARN.

{
    if (!getNumberOfObjects())
    {
        logger(WARN, "No getHighestVelocityComponentParticle(const int i) since there are no particles");
        return nullptr;
    }
    BaseParticle* p = nullptr;
    Mdouble max = -std::numeric_limits<Mdouble>::max();
    for (BaseParticle* const pLoop : objects_)
    {
        if (pLoop->getVelocity().getComponent(i) > max)
        {
            max = pLoop->getVelocity().getComponent(i);
            p = pLoop;
        }
    }
    return p;
}

BaseParticle * ParticleHandler::getLargestParticle

(

)

const

Gets a pointer to the largest BaseParticle (by interactionRadius) in this ParticleHandler.

Returns

A pointer to the largest BaseParticle (by interactionRadius) in this ParticleHandler.

Definition at line 230 of file ParticleHandler.cc.

References largestParticle_, logger, and WARN.

Referenced by DPMBase::checkParticleForInteractionLocalPeriodic(), LeesEdwardsBoundary::createHorizontalPeriodicParticles(), ShearBoxBoundary::createHorizontalPeriodicParticles(), CircularPeriodicBoundary::createPeriodicParticles(), MaserBoundary::createPeriodicParticles(), AngledPeriodicBoundary::createPeriodicParticles(), PeriodicBoundary::createPeriodicParticles(), LeesEdwardsBoundary::createVerticalPeriodicParticles(), ShearBoxBoundary::createVerticalPeriodicParticles(), MercuryBase::getHGridTargetMaxInteractionRadius(), MercuryBase::hGridNeedsRebuilding(), HGridOptimiser::initialise(), and DPMBase::writeFstatHeader().

{
    if (largestParticle_ == nullptr)
    {
        logger(WARN, "No particles to set get_LargestParticle()");
    }
    return largestParticle_;
}

BaseParticle * ParticleHandler::getLightestParticle

(

)

const

Gets a pointer to the lightest BaseParticle (by mass) in this ParticleHandler.

Returns

A pointer to the to the lightest BaseParticle (by mass) in this ParticleHandler.

Definition at line 377 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::getNumberOfObjects(), logger, BaseHandler< BaseParticle >::objects_, and WARN.

{
    if (getNumberOfObjects() == 0)
    {
        logger(WARN, "No particles to set getLightestParticle()");
        return nullptr;
    }
    BaseParticle* p = nullptr;
    Mdouble minMass = std::numeric_limits<Mdouble>::max();
    for (BaseParticle* const pLoop : objects_)
    {
        if (pLoop->getMass() < minMass)
        {
            minMass = pLoop->getMass();
            p = pLoop;
        }
    }
    return p;
}

BaseParticle * ParticleHandler::getLowestPositionComponentParticle

(

const int

i

)

const

Gets a pointer to the particle with the lowest coordinates in direction i in this ParticleHandler.

Parameters

[in]

i

Direction for which you want the particle with lowest coordinates.

Returns

A pointer to the particle with the lowest coordinates in the given direction in this ParticleHandler.

Definition at line 278 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::getNumberOfObjects(), logger, BaseHandler< BaseParticle >::objects_, and WARN.

{
    if (getNumberOfObjects() == 0)
    {
        logger(WARN, "No getLowestPositionComponentParticle(const int i) since there are no particles.");
        return nullptr;
    }
    BaseParticle* p = nullptr;
    Mdouble min = std::numeric_limits<Mdouble>::max();
    for (BaseParticle* const pLoop : objects_)
    {
        if (pLoop->getPosition().getComponent(i) < min)
        {
            min = pLoop->getPosition().getComponent(i);
            p = pLoop;
        }
    }
    return p;
}

BaseParticle * ParticleHandler::getLowestVelocityComponentParticle

(

const int

i

)

const

Gets a pointer to the particle with the lowest velocity in direction i in this ParticleHandler.

Parameters

[in]

i

Direction for which you want the particle with lowest velocity.

Returns

A pointer to the particle with the lowest velocity in direction i in this ParticleHandler.

Definition at line 329 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::getNumberOfObjects(), logger, BaseHandler< BaseParticle >::objects_, and WARN.

{
    if (getNumberOfObjects() == 0)
    {
        logger(WARN, "No getLowestVelocityComponentParticle(const int i) since there are no particles");
        return nullptr;
    }
    BaseParticle* p = nullptr;
    Mdouble min = std::numeric_limits<Mdouble>::max();
    for (BaseParticle* const pLoop : objects_)
    {
        if (pLoop->getVelocity().getComponent(i) < min)
        {
            min = pLoop->getVelocity().getComponent(i);
            p = pLoop;
        }
    }
    return p;
}

Mdouble ParticleHandler::getMeanRadius

(

)

const

Gets a pointer to the fastest BaseParticle in this ParticleHandler.

Returns

The mean radius of all particles

Definition at line 265 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::getNumberOfObjects(), and BaseHandler< BaseParticle >::objects_.

                                             {
    Mdouble sumRadius = 0;
    for (BaseParticle* const p : objects_) {
        sumRadius += p->getRadius();
    }
    return sumRadius/getNumberOfObjects();
}

std::string ParticleHandler::getName ( ) const

virtual

Returns the name of the handler, namely the string "ParticleHandler".

Returns

The string "ParticleHandler".

Implements BaseHandler< BaseParticle >.

Definition at line 612 of file ParticleHandler.cc.

{
    return "ParticleHandler";
}

BaseParticle * ParticleHandler::getNewObject ( const std::string &  type )

static

Definition at line 409 of file ParticleHandler.cc.

References ERROR, and logger.

Referenced by InsertionBoundary::read().

{
    if (type == "BaseParticle"||type == "BP"||isdigit(type[0])) 
    {
        return new BaseParticle;
    } 
    else if (type == "LiquidFilmParticle") 
    {
        return new LiquidFilmParticle;
    } 
    else 
    {
        logger(ERROR, "Particle type % not understood in restart file. Particle has not been read.", type);
        return nullptr;
    }
}

BaseParticle * ParticleHandler::getSmallestParticle

(

)

const

Gets a pointer to the smallest BaseParticle (by interactionRadius) in this ParticleHandler.

Returns

A pointer to the to the smallest BaseParticle (by interactionRadius) in this ParticleHandler.

Definition at line 217 of file ParticleHandler.cc.

References logger, smallestParticle_, and WARN.

Referenced by MercuryBase::getHGridTargetMinInteractionRadius(), HGridOptimiser::initialise(), and DPMBase::writeFstatHeader().

{
    if (smallestParticle_ == nullptr)
    {
        logger(WARN, "No particles to return in getSmallestParticle()");
    }
    return smallestParticle_;
}

ParticleHandler ParticleHandler::operator=

(

const ParticleHandler &

rhs

)

Assignment operator.

Parameters

[in]

rhs

The ParticleHandler on the right hand side of the assignment.

This is not a copy assignment operator! It copies the DPMBase and all BaseParticle, and sets the other variables to 0. After that, it computes the smallest and largest particle in this handler.

Definition at line 77 of file ParticleHandler.cc.

References clear(), computeLargestParticle(), computeSmallestParticle(), BaseHandler< BaseParticle >::copyContentsFromOtherHandler(), DEBUG, largestParticle_, logger, BaseHandler< BaseParticle >::objects_, and smallestParticle_.

{
    if (this != &rhs)
    {
        clear();
        largestParticle_ = nullptr;
        smallestParticle_ = nullptr;
        copyContentsFromOtherHandler(rhs);
        if (objects_.size() != 0)
        {
            computeLargestParticle();
            computeSmallestParticle();
        }
    }
    logger(DEBUG, "ParticleHandler::operator = (const ParticleHandler& rhs) finished");
    return *this;
}

void ParticleHandler::readObject ( std::istream &  is )

virtual

Reads BaseParticle into the ParticleHandler from restart data.

Parameters

[in]

is

The input stream from which the information is read.

Todo:

make sure setting the id doesn't break the id setter :)

Todo:

make sure setting the id doesn't break the id setter :)

Todo:

make sure setting the id doesn't break the id setter :)

Todo:

{Remove for final version}

Implements BaseHandler< BaseParticle >.

Definition at line 429 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::copyAndAddObject(), DEBUG, ERROR, BaseHandler< BaseParticle >::getDPMBase(), BaseObject::getId(), BaseInteractable::getIndSpecies(), BaseHandler< BaseParticle >::getLastObject(), logger, BaseParticle::oldRead(), readOldObject(), BaseParticle::setHandler(), BaseHandler< BaseParticle >::setId(), and BaseParticle::setSpecies().

Referenced by DPMBase::read().

{
    std::string type;
    is >> type;
    logger.log(Log::DEBUG, "ParticleHandler::readObject(is): reading type %.", type);
    if (type == "BaseParticle")
    {
        BaseParticle baseParticle;
        is >> baseParticle;
        //set the species pointer correctly
        baseParticle.setSpecies(getDPMBase()->speciesHandler.getObject(baseParticle.getIndSpecies()));
        copyAndAddObject(baseParticle);
        setId(getLastObject(),baseParticle.getId()); 
        //getLastObject()->setId(baseParticle.getId()); //to ensure old id
    }
    else if (type == "LiquidFilmParticle")
    {
        LiquidFilmParticle particle;
        is >> particle;
        //set the species pointer correctly
        particle.setSpecies(getDPMBase()->speciesHandler.getObject(particle.getIndSpecies()));
        copyAndAddObject(particle);
        setId(getLastObject(),particle.getId());
        //getLastObject()->setId(particle.getId()); //to ensure old id
    }
    else if (type == "ThermalParticle")
    {
        ThermalParticle particle;
        is >> particle;
        //set the species pointer correctly
        particle.setSpecies(getDPMBase()->speciesHandler.getObject(particle.getIndSpecies()));
        copyAndAddObject(particle);
        setId(getLastObject(),particle.getId());
        //getLastObject()->setId(particle.getId()); //to ensure old id
    }
    else if (type == "BP")
    {
        BaseParticle baseParticle;
        baseParticle.setHandler(this);//to be able to set the species
        baseParticle.oldRead(is);
        //set the species pointer correctly
        baseParticle.setSpecies(getDPMBase()->speciesHandler.getObject(baseParticle.getIndSpecies()));
        copyAndAddObject(baseParticle);
        setId(getLastObject(),baseParticle.getId()); 
        //getLastObject()->setId(baseParticle.getId()); //to ensure old id
    }
    else if (isdigit(type[0]))
    {
        readOldObject(type, is);
    }
    else
    {
        logger(ERROR, "Particle type % not understood in restart file: You need to add this particle to ParticleHandler::readObject.", type);
        return;
    }
}

void ParticleHandler::readOldObject	(	std::string	type,
		std::istream &	is
	)

Reads BaseParticle into the ParticleHandler from old-style restart data.

Parameters

[in]	type	The first value of the position.
[in]	is	The input stream from which the information is read.

The old objects did not have their type in the beginning of the line. Instead, the first string of the file was the position in x-direction. Since we already read the first string of the file, we need to give it to this function and convert it to the position in x-direction. The rest of the stream is then read in the usual way.

Definition at line 499 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::copyAndAddObject(), BaseHandler< BaseParticle >::getDPMBase(), helpers::getLineFromStringStream(), logger, VERBOSE, Vec3D::X, Vec3D::Y, and Vec3D::Z.

Referenced by readObject().

{
    //read in next line
    std::stringstream line(std::stringstream::in | std::stringstream::out);
    helpers::getLineFromStringStream(is, line);
    logger(VERBOSE, line.str());
    //std::cout << line.str() << std::endl;

    BaseParticle particle;
    
    //Declare all properties of the particle
    unsigned int indSpecies;
    Mdouble radius, inverseMass, inverseInertia;
    Vec3D position, velocity, orientation, angularVelocity;
    
    //Read all values
    position.X = atof(type.c_str());

    line >> position.Y >> position.Z >> velocity >> radius >> orientation >> angularVelocity >> inverseMass >> inverseInertia >> indSpecies;
    
    //Put the values in the particle    
    particle.setSpecies(getDPMBase()->speciesHandler.getObject(indSpecies));       
    particle.setPosition(position);
    particle.setVelocity(velocity);
    particle.setRadius(radius);
    particle.setOrientation(orientation);
    particle.setAngularVelocity(angularVelocity);
    if (inverseMass == 0.0)
        particle.fixParticle();
    else
    {
        particle.setInertia(1./inverseInertia);
    }
    
    //Put the particle in the  handler
    copyAndAddObject(particle);
}

void ParticleHandler::removeLastObject

(

)

Removes the last BaseParticle from the ParticleHandler.

Function that removes the last object from this ParticleHandler. It also removes the particle from the HGrid.

Definition at line 166 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::getDPMBase(), BaseHandler< BaseParticle >::getLastObject(), DPMBase::hGridRemoveParticle(), and BaseHandler< T >::removeLastObject().

Referenced by DPMBase::readNextDataFile().

{
#ifdef CONTACT_LIST_HGRID
    getDPMBase()->getPossibleContactList().remove_ParticlePosibleContacts(getLastObject());
#endif
    getDPMBase()->hGridRemoveParticle(getLastObject());
    BaseHandler<BaseParticle>::removeLastObject();
}

void ParticleHandler::removeObject ( unsigned const int  index )

virtual

Removes a BaseParticle from the ParticleHandler.

Parameters

[in]

index

The index of which BaseParticle has to be removed from this ParticleHandler.

The BaseParticle with index is removed and the last BaseParticle in the vector is moved to its position. It also removes the BaseParticle from the HGrid.

Reimplemented from BaseHandler< BaseParticle >.

Definition at line 153 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::getDPMBase(), BaseHandler< BaseParticle >::getObject(), DPMBase::hGridRemoveParticle(), and BaseHandler< T >::removeObject().

Referenced by DeletionBoundary::checkBoundaryAfterParticleMoved(), CircularPeriodicBoundary::checkBoundaryAfterParticleMoved(), Chute::cleanChute(), and DPMBase::removeDuplicatePeriodicParticles().

{
#ifdef CONTACT_LIST_HGRID
    getDPMBase()->getPossibleContactList().remove_ParticlePosibleContacts(getObject(id));
#endif
    getDPMBase()->hGridRemoveParticle(getObject(index));
    BaseHandler<BaseParticle>::removeObject(index);
}

void ParticleHandler::write

(

std::ostream &

os

)

const

Definition at line 537 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::getNumberOfObjects().

Referenced by DPMBase::write().

{
    os << "Particles " << getNumberOfObjects() << std::endl;
    for (BaseParticle* it : *this)
        os << (*it) << std::endl;
}

void ParticleHandler::writeVTK

(

)

const

Writes all particles into a vtk file format (unstructured grid), consisting of particle positions, velocities, radii and type of species (IndSpecies)

Writes all points ans cells to a file in the VTK format. The filename is hard-coded in this method, and is based on the name of the DPMBase and has a unique counter in it to ensure there are no two files with the same name.

Todo:

Check if this should indeed be a WARN

Definition at line 623 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::getDPMBase(), DPMBase::getInfo(), BaseHandler< BaseParticle >::getLastObject(), Files::getName(), BaseParticle::getNameVTK(), BaseParticle::getNumberOfFieldsVTK(), BaseHandler< BaseParticle >::getNumberOfObjects(), BaseParticle::getTypeVTK(), INFO, logger, helpers::to_string(), and WARN.

Referenced by main(), and DPMBase::writeVTK().

{
    static unsigned fileCounter = 0;
    const std::string fileName = getDPMBase()->getName() + "Particle_" +
            std::to_string(fileCounter++) + ".vtu";
    logger(INFO, "writing % (t=%, N=%)", fileName, getDPMBase()->getTime(), this->getNumberOfObjects());

    std::fstream file;
    file.open(fileName.c_str(), std::ios::out);
    if (file.fail())
    {
        logger(WARN,  "Error in writeToFile: file % could not be opened", fileName);
    }
    //
    file << "<?xml version=\"1.0\"?>\n\n";
    file << "<VTKFile type=\"UnstructuredGrid\" version=\"0.1\" byte_order=\"LittleEndian\">\n";
    file << "<UnstructuredGrid>\n";
    file << "<Piece NumberOfPoints=\"" << this->getNumberOfObjects() << "\" NumberOfCells=\"" << 0 << "\">\n";
    file << "<Points>\n";
    file << "  <DataArray type=\"Float32\" Name=\"Position\" NumberOfComponents=\"3\" format=\"ascii\">\n";
    for (const auto& p: *this)
    {
        file << '\t' << p->getPosition() << '\n';        
    }   
    file << "  </DataArray>\n";
    file << "</Points>\n";
    file << "<PointData  Vectors=\"vector\">\n";
    file << "  <DataArray type=\"Float32\" Name=\"Velocity\" NumberOfComponents=\"3\" format=\"ascii\">\n";
    // Add velocity
    for (const auto& p: *this)
    {
        file << '\t' << p->getVelocity() << '\n';        
    }  
    file << "  </DataArray>\n";
    file << "  <DataArray type=\"Float32\" Name=\"Radius\" format=\"ascii\">\n";
    // Add radius
    for (const auto& p: *this)
    {
        file << '\t' << p->getRadius() << '\n';        
    }  
    file << "  </DataArray>\n";
    file << "  <DataArray type=\"Float32\" Name=\"SpeciesType\" format=\"ascii\">\n";
    // Add species type
    for (const auto& p: *this)
    {
        file << '\t' << p->getIndSpecies() << '\n';        
    }  
    file << "  </DataArray>\n";
    file << "  <DataArray type=\"Float32\" Name=\"Info\" format=\"ascii\">\n";
    // Add species type
    for (const auto& p: *this)
    {
        file << '\t' << getDPMBase()->getInfo(*p) << '\n';
    }
    file << "  </DataArray>\n";
    //check if this type of Interaction has extra fields
    if (getLastObject()!= nullptr)
    {
        for (unsigned i = 0; i<getLastObject()->getNumberOfFieldsVTK(); i++)
        {
            file << "  <DataArray type=\"" << getLastObject()->getTypeVTK(i) << "\" Name=\"" << getLastObject()->getNameVTK(i) << "\" format=\"ascii\">\n";
            // Add species type
            for (const auto &p: *this)
            {
                for (auto f : p->getFieldVTK(i))
                    file << '\t' << f << '\n';
            }
            file << "  </DataArray>\n";
        }
    }
    file << "</PointData>\n";
    file << "<Cells>\n";
    file << "  <DataArray type=\"Int32\" Name=\"connectivity\" format=\"ascii\">\n";  
    file << "  </DataArray>\n";
    file << "  <DataArray type=\"Int32\" Name=\"offsets\" format=\"ascii\">\n";   
    file << "  </DataArray>\n";
    file << "  <DataArray type=\"UInt8\"  Name=\"types\" format=\"ascii\">\n";    
    file << "  </DataArray>\n";
    file << "</Cells>\n";
    file << "</Piece>\n";
    file << "</UnstructuredGrid>\n";
    file << "</VTKFile>\n";
    file.close();
}

Member Data Documentation

BaseParticle* ParticleHandler::largestParticle_

private

A pointer to the largest BaseParticle (by interactionRadius) in this ParticleHandler.

Todo:

TW: note that checkExtrema gets called if a particle gets created and its Species and Radius gets set, even if it's not yet included in the particleHandler! This is necessary to check a not included particle for overlaps before inserting it into the handler. Not sure if this is a sensible structure; to be discussed.

Definition at line 192 of file ParticleHandler.h.

Referenced by checkExtrema(), checkExtremaOnDelete(), clear(), computeLargestParticle(), getLargestParticle(), operator=(), ParticleHandler(), and ~ParticleHandler().

BaseParticle* ParticleHandler::smallestParticle_

private

A pointer to the smallest BaseParticle (by interactionRadius) in this ParticleHandler.

Definition at line 197 of file ParticleHandler.h.

Referenced by checkExtrema(), checkExtremaOnDelete(), clear(), computeSmallestParticle(), getSmallestParticle(), operator=(), ParticleHandler(), and ~ParticleHandler().

---

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

• ParticleHandler.h
• ParticleHandler.cc