Container to store all BaseParticle. More...

#include <ParticleHandler.h>

Inheritance diagram for ParticleHandler:

Public Member Functions
	ParticleHandler ()
	Default constructor, it simply creates an empty ParticleHandler. More...

	ParticleHandler (const ParticleHandler &PH)
	Copy constructor, it copies the ParticleHandler and all BaseParticle it contains. More...

ParticleHandler	operator= (const ParticleHandler &rhs)
	Assignment operator. More...

	~ParticleHandler ()
	Destructor, it simply destructs the ParticleHandler and all BaseParticle it contains. More...

virtual void	addObject (BaseParticle *P)
	Adds a BaseParticle to the ParticleHandler. 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 fastests BaseParticle in this ParticleHandler. More...

BaseParticle *	getLowestPositionComponentParticle (const int i) const

BaseParticle *	getHighestPositionComponentParticle (const int i) const

BaseParticle *	getLowestVelocityComponentParticle (const int i) const

BaseParticle *	getHighestVelocityComponentParticle (const int i) const

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	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...

CSpecies &	getSpecies (const int i)

void	setSpecies (std::vector< CSpecies > *)

Public Member Functions inherited from BaseHandler< BaseParticle >
	BaseHandler ()
	Default BaseHandler constructor, it simply creates an empty BaseHandler. More...

	BaseHandler (const BaseHandler< BaseParticle > &BH)
	Copy constructor, it copies the BaseHandler and all Object it contains. More...

virtual	~BaseHandler ()
	Assignment operator. More...

void	copyAndAddObject (const BaseParticle &O)
	Creates a copy of a Object and adds it to the BaseHandler. More...

void	copyAndAddObject (const BaseParticle *O)
	Creates a copy of a Object and adds it to the BaseHandler. More...

virtual void	removeObject (unsigned const int id)
	Removes a Object from the BaseHandler. More...

void	removeLastObject ()
	Removes the last Object from the BaseHandler. More...

void	clear ()
	Empties the whole BaseHandler by removing all Object. More...

BaseParticle *	getObject (const unsigned int id) const
	Gets a pointer to the Object at the specified index in the BaseHandler. More...

BaseParticle *	getLastObject () const
	Gets a 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...

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...

std::vector< CSpecies > *	species_

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 38 of file ParticleHandler.h.

Constructor & Destructor Documentation

ParticleHandler::ParticleHandler ( )

Default constructor, it simply creates an empty ParticleHandler.

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

Definition at line 34 of file ParticleHandler.cc.

References largestParticle_, smallestParticle_, and species_.

                                  : BaseHandler<BaseParticle>()
 {
     species_=0;
     largestParticle_=0;
     smallestParticle_=0;
     #ifdef CONSTUCTOR_OUTPUT
         std::cerr << "ParticleHandler() finished" << std::endl;
     #endif
 }

ParticleHandler::ParticleHandler ( const ParticleHandler & PH )

Copy constructor, it copies the ParticleHandler and all BaseParticle it contains.

Parameters

[in] PH The ParticleHandler that has te be copied.

Definition at line 45 of file ParticleHandler.cc.

References addObject(), BaseHandler< T >::begin(), clear(), BaseHandler< T >::end(), and species_.

 {
     species_=PH.species_;
     clear();
     for (std::vector<BaseParticle*>::const_iterator it=PH.begin();it!=PH.end();it++)
     {
         addObject((*it)->copy());
     }    
     #ifdef CONSTUCTOR_OUTPUT
         std::cerr << "ParticleHandler(const ParticleHandler &PH) finished" << std::endl;
     #endif
 }

ParticleHandler::~ParticleHandler ( )

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

Definition at line 75 of file ParticleHandler.cc.

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

Member Function Documentation

void ParticleHandler::addObject ( BaseParticle * P )

virtual

Adds a BaseParticle to the ParticleHandler.

Parameters

[in] P A pointer to the BaseParticle (or derived class) that has to be added.

Todo:: Also insert the particle in the HGRID

Reimplemented from BaseHandler< BaseParticle >.

Definition at line 84 of file ParticleHandler.cc.

References BaseHandler< T >::addObject(), checkExtrema(), BaseHandler< BaseParticle >::getLastObject(), and BaseParticle::setHandler().

Referenced by CircularPeriodicBoundary::checkBoundaryAfterParticleMoved(), CircularPeriodicBoundary::createPeriodicParticles(), PeriodicBoundary::createPeriodicParticles(), AngledPeriodicBoundary::createPeriodicParticles(), operator=(), and ParticleHandler().

 {
     //Puts the particle in the Particle list
     BaseHandler<BaseParticle>::addObject(P);
     //Check if this particle has new extrema
     checkExtrema(getLastObject());
     //set the particleHandler pointer
     getLastObject()->setHandler(this);
 }

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 266 of file ParticleHandler.cc.

References BaseParticle::get_InteractionRadius(), largestParticle_, and smallestParticle_.

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

 {
     if(!largestParticle_||P->get_InteractionRadius()>largestParticle_->get_InteractionRadius())
     {
         largestParticle_=P;
     }
     if(!smallestParticle_||P->get_InteractionRadius()<smallestParticle_->get_InteractionRadius())
     {
         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 279 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::begin(), BaseHandler< BaseParticle >::end(), largestParticle_, and smallestParticle_.

Referenced by BaseParticle::~BaseParticle().

 {
     if(P==largestParticle_)
     {
         largestParticle_=0;
         Mdouble maxRadius = -std::numeric_limits<Mdouble>::max();
         for (std::vector<BaseParticle*>::const_iterator it=begin();it!=end();it++)
         {
             if ((*it)->get_InteractionRadius()>maxRadius&&P!=(*it))
             {
                 maxRadius = (*it)->get_InteractionRadius();
                 largestParticle_ = (*it);
             }
         }
     }
     if(P==smallestParticle_)
     {
         smallestParticle_=0;
         Mdouble minRadius = std::numeric_limits<Mdouble>::max();
         for (std::vector<BaseParticle*>::const_iterator it=begin();it!=end();it++)
         {
             if ((*it)->get_InteractionRadius()<minRadius&&P!=(*it))
             {
                 minRadius = (*it)->get_InteractionRadius();
                 smallestParticle_ = (*it);
             }
         }
     }
 }

void ParticleHandler::clear ( )

Empties the whole ParticleHandler by removing all BaseParticle.

Definition at line 222 of file ParticleHandler.cc.

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

Referenced by operator=(), ParticleHandler(), MD::read(), and MD::read_v2().

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

BaseParticle * ParticleHandler::getFastestParticle ( ) const

Gets a pointer to the fastests BaseParticle in this ParticleHandler.

Returns: A pointer to the to the fastest BaseParticle in this ParticleHandler.

Definition at line 104 of file ParticleHandler.cc.

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

 {
     if (!getNumberOfObjects())
     {
         std::cerr << "Warning: No particles to set get_FastestParticle()" << std::endl;
     }
     BaseParticle* p = 0;
     Mdouble maxSpeed = -std::numeric_limits<Mdouble>::max();
     for (std::vector<BaseParticle*>::const_iterator it=begin();it!=end();it++)
     {
         if ((*it)->get_Velocity().GetLength()>maxSpeed)
         {
             maxSpeed=(*it)->get_Velocity().GetLength();
             p = (*it);
         }
     }
     return p;
 }

BaseParticle * ParticleHandler::getHighestPositionComponentParticle ( const int i ) const

Definition at line 140 of file ParticleHandler.cc.

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

 {
     if (!getNumberOfObjects())
     {
         std::cerr << "Warning: No getHighestPositionComponentParticle(cons int i)" << std::endl;
     }
     BaseParticle* p = 0;
     Mdouble max = -std::numeric_limits<Mdouble>::max();
     for (std::vector<BaseParticle*>::const_iterator it=begin();it!=end();it++)
     {
         if ((*it)->get_Position().getComponent(i)>max) {
             max=(*it)->get_Position().getComponent(i);
             p = (*it);
         }
     }
     return p;
 }

BaseParticle * ParticleHandler::getHighestVelocityComponentParticle ( const int i ) const

Definition at line 174 of file ParticleHandler.cc.

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

 {
     if (!getNumberOfObjects())
     {
         std::cerr << "Warning: No getHighestVelocityComponentParticle(cons int i)" << std::endl;
     }
     BaseParticle* p = 0;
     Mdouble max = -std::numeric_limits<Mdouble>::max();
     for (std::vector<BaseParticle*>::const_iterator it=begin();it!=end();it++)
     {
         if ((*it)->get_Velocity().getComponent(i)>max) {
             max=(*it)->get_Velocity().getComponent(i);
             p = (*it);
         }
     }
     return p;
 }

BaseParticle * ParticleHandler::getLargestParticle ( ) const

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

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

Definition at line 213 of file ParticleHandler.cc.

References largestParticle_.

Referenced by CircularPeriodicBoundary::createPeriodicParticles(), PeriodicBoundary::createPeriodicParticles(), AngledPeriodicBoundary::createPeriodicParticles(), MD::getLargestParticle(), and HGridOptimiser::Initialise().

                                                        {
     if (!largestParticle_)
     {
         std::cerr << "Warning: No particles to set get_LargestParticle()" << std::endl;
         throw;
     }
     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 193 of file ParticleHandler.cc.

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

Referenced by Chute::get_LightestParticleMass().

                                                         {
     if (!getNumberOfObjects())
     {
         std::cerr << "Warning: No particles to set getLightestParticle()" << std::endl;
         throw;
     }
     BaseParticle* p = 0;
     Mdouble minMass = std::numeric_limits<Mdouble>::max();
     for (std::vector<BaseParticle*>::const_iterator it=begin();it!=end();it++)
     {
         if ((*it)->get_Mass()<minMass)
         {
             minMass=(*it)->get_Mass();
             p = (*it);
         }
     }
     return p;
 }

BaseParticle * ParticleHandler::getLowestPositionComponentParticle ( const int i ) const

Definition at line 123 of file ParticleHandler.cc.

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

 {
     if (!getNumberOfObjects())
     {
         std::cerr << "Warning: No getLowestPositionComponentParticle(cons int i)" << std::endl;
     }
     BaseParticle* p = 0;
     Mdouble min = std::numeric_limits<Mdouble>::max();
     for (std::vector<BaseParticle*>::const_iterator it=begin();it!=end();it++)
     {
         if ((*it)->get_Position().getComponent(i)<min) {
             min=(*it)->get_Position().getComponent(i);
             p = (*it);
         }
     }
     return p;
 }

BaseParticle * ParticleHandler::getLowestVelocityComponentParticle ( const int i ) const

Definition at line 157 of file ParticleHandler.cc.

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

 {
     if (!getNumberOfObjects())
     {
         std::cerr << "Warning: No getLowestVelocityComponentParticle(cons int i)" << std::endl;
     }
     BaseParticle* p = 0;
     Mdouble min = std::numeric_limits<Mdouble>::max();
     for (std::vector<BaseParticle*>::const_iterator it=begin();it!=end();it++)
     {
         if ((*it)->get_Velocity().getComponent(i)<min) {
             min=(*it)->get_Velocity().getComponent(i);
             p = (*it);
         }
     }
     return p;
 }

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 95 of file ParticleHandler.cc.

References smallestParticle_.

Referenced by MD::getSmallestParticle(), and HGridOptimiser::Initialise().

                                                         {
     if (!smallestParticle_)
     {
         std::cerr << "Warning: No particles to set get_SmallestParticle()" << std::endl;
     }
     return smallestParticle_;
 }

CSpecies & ParticleHandler::getSpecies ( const int i )

Definition at line 309 of file ParticleHandler.cc.

References species_.

Referenced by BaseParticle::get_InteractionRadius(), and BaseParticle::get_WallInteractionRadius().

                                                  {
     if (!species_) std::cerr << "B" << species_ << std::endl;
     return (*species_)[i]; }   

ParticleHandler ParticleHandler::operator= ( const ParticleHandler & rhs )

Assignment operator.

Parameters

[in] rhs The ParticleHandler on the right hand side of the assignment.

Definition at line 59 of file ParticleHandler.cc.

References addObject(), BaseHandler< T >::begin(), clear(), and BaseHandler< T >::end().

 {
     if (this != &rhs)
     {
         clear();
         for (std::vector<BaseParticle*>::const_iterator it=rhs.begin();it!=rhs.end();it++)
         {
             addObject((*it)->copy());
         }
     }
     #ifdef CONSTUCTOR_OUTPUT
         std::cerr << "ParticleHandler operator = (const ParticleHandler& rhs) finished" << std::endl;
     #endif
     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.

Implements BaseHandler< BaseParticle >.

Definition at line 230 of file ParticleHandler.cc.

References BaseHandler< BaseParticle >::copyAndAddObject(), and TangentialSpringParticle::oldRead().

Referenced by MD::read(), MD::read_v1(), and MD::read_v2().

 {
     std::string type;
     is >> type;
     if(type.compare("BP")==0)
     {
         BaseParticle baseParticle;
         is>>baseParticle;
         copyAndAddObject(baseParticle);
     }
     else if(type.compare("TSP")==0)
     {
         TangentialSpringParticle tangentialSpringParticle;
         is>>tangentialSpringParticle;
         copyAndAddObject(tangentialSpringParticle);
     }
     else if(type.compare("DMP")==0)
     {
         DeltaMaxsParticle deltaMaxsParticle;
         is>>deltaMaxsParticle;
         copyAndAddObject(deltaMaxsParticle);
     }  
     else if(isdigit(type[0]))
     {
         TangentialSpringParticle tangentialSpringParticle;
         tangentialSpringParticle.oldRead(is,type);
         copyAndAddObject(tangentialSpringParticle);     
     }
     else
     {
         std::cerr<<"Particle type: "<<type<<" not understood in restart file"<<std::endl;
         exit(-1);
     }
 }