Container to store Interaction objects. More...

#include <InteractionHandler.h>

Inheritance diagram for InteractionHandler:

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

	InteractionHandler (const InteractionHandler &IH)
	Copy constructor, but since interactions must not be copied, it creates an empty InteractionHandler. More...

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

	~InteractionHandler ()
	Destructor, it destructs the InteractionHandler and all BaseInteraction it contains. More...

void	addObject (BaseInteraction *I)
	Adds an Interaction to the InteractionHandler. More...

void	readObject (std::istream &is)
	Reads an Interaction into the InteractionHandler from restart data. More...

BaseInteraction *	getExistingInteraction (BaseInteractable P, BaseInteractable I)
	Returns the Interaction between the BaseInteractable's P and I if it exists, otherwise returns a null pointer. More...

BaseInteraction *	getInteraction (BaseInteractable P, BaseInteractable I, Mdouble timeStamp)
	Returns the Interaction between the BaseInteractable's P and I. More...

void	removeObjectKeepingPeriodics (unsigned const int id)
	Removes interactions of periodic particles when the periodic particles get deleted (see DPMBase::removeDuplicatePeriodicParticles) More...

void	eraseOldInteractions (Mdouble lastTimeStep)
	erases interactions which have an old timestamp. More...

void	write (std::ostream &os) const
	Writes the InteractionHandler to an output stream, for example a restart file. More...

std::string	getName () const
	Returns the name of the object. More...

Public Member Functions inherited from BaseHandler< BaseInteraction >
	BaseHandler ()
	Default BaseHandler constructor, it creates an empty BaseHandler and assigns DPMBase_ to a null pointer. More...

	BaseHandler (const BaseHandler< BaseInteraction > &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< BaseInteraction > &BH)
	Function that copies the contents (vector of pointers, maxObject_, nextId_, DPMBase_) from one handler (container) to the other. More...

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

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

virtual void	removeObject (unsigned const int id)
	Removes an Object from 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...

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

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

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

BaseInteraction *	getLastObject ()
	Gets a pointer to the last Object in this BaseHandler. More...

const BaseInteraction *	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 < BaseInteraction * > ::const_iterator	begin () const
	Gets the begin of the const_iterator over all Object in this BaseHandler. More...

const std::vector < BaseInteraction * > ::iterator	begin ()
	Gets the begin of the iterator over all BaseBoundary in this BaseHandler. More...

const std::vector < BaseInteraction * > ::const_iterator	end () const
	Gets the end of the const_iterator over all BaseBoundary in this BaseHandler. More...

const std::vector < BaseInteraction * > ::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...

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

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

Detailed Description

Container to store Interaction objects.

The InteractionHandler is a container to store all Interaction objects. It is implemented as a vector of BaseInteraction pointers.

Definition at line 36 of file InteractionHandler.h.

Constructor & Destructor Documentation

InteractionHandler::InteractionHandler ( )

Default constructor, it creates an empty InteractionHandler.

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

Definition at line 39 of file InteractionHandler.cc.

References DEBUG, and logger.

 {
     logger(DEBUG, "InteractionHandler::InteractionHandler() finished");
 }

InteractionHandler::InteractionHandler ( const InteractionHandler & IH )

Copy constructor, but since interactions must not be copied, it creates an empty InteractionHandler.

InteractionHandler::~InteractionHandler ( )

Destructor, it destructs the InteractionHandler and all BaseInteraction it contains.

Definition at line 72 of file InteractionHandler.cc.

References DEBUG, and logger.

 {
     logger(DEBUG, "InteractionHandler::~InteractionHandler() finished");
 }

Member Function Documentation

void InteractionHandler::addObject ( BaseInteraction * I )

virtual

Adds an Interaction to the InteractionHandler.

Parameters

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

Reimplemented from BaseHandler< BaseInteraction >.

Definition at line 80 of file InteractionHandler.cc.

References BaseHandler< T >::addObject(), and BaseInteraction::setHandler().

Referenced by BaseInteraction::copySwitchPointer(), and getInteraction().

 {
     //Puts the particle in the Particle list
     BaseHandler<BaseInteraction>::addObject(I);
     //set the particleHandler pointer
     I->setHandler(this);
 }

void InteractionHandler::eraseOldInteractions ( Mdouble lastTimeStep )

erases interactions which have an old timestamp.

Each interaction contains a time stamp, which stores the last time that an interaction object has been called. Thus, one can see that an interaction has ended by comparing the time stamp with the last value of DPMBase::time_. This function erases all interactions that have ended.

Parameters

[in] lastTimeStep the last used value of DPMBase::time_.

Todo:: TW: this function has to be sped up with sth like this: erase(remove_if(begin(), end(), bind2nd(checkSpringTime(), lastTimeStep)), end());

Definition at line 212 of file InteractionHandler.cc.

References BaseHandler< BaseInteraction >::getNumberOfObjects(), BaseHandler< BaseInteraction >::getObject(), BaseInteraction::getTimeStamp(), and BaseHandler< BaseInteraction >::removeObject().

Referenced by DPMBase::solve().

 {
     //std::cout<<"void InteractionHandler::eraseOldInteractions(Mdouble lastTimeStep)"<<std::endl;
     //std::cout<<"Current interactions="<<getNumberOfObjects()<<std::endl;
     //Remove_if reconstructs the vector with only elements passing the check_spring_time function
     //Erase removes the end of the vector
     for (unsigned int id = 0; id < getNumberOfObjects(); id++)
     {
         if (getObject(id)->getTimeStamp() < lastTimeStep)
         {
             removeObject(id);
             --id;
         }
     }
 }

BaseInteraction * InteractionHandler::getExistingInteraction	(	BaseInteractable *	P,
		BaseInteractable *	I
	)

Returns the Interaction between the BaseInteractable's P and I if it exists, otherwise returns a null pointer.

Parameters

[in]	P	the first BaseInteractable by which the interaction is defined.
[in]	I	the first BaseInteractable by which the interaction is defined.

Returns: the Interaction between the BaseInteractable's P and I, if it exists.

Definition at line 93 of file InteractionHandler.cc.

References BaseInteractable::getInteractions().

Referenced by getInteraction(), and removeObjectKeepingPeriodics().

 {
     //for particle-particle collision it is assumed BaseInteractable P has a lower index then I, so we only have to check for I, not P
     for (std::list<BaseInteraction*>::const_iterator it = P->getInteractions().begin(); it != P->getInteractions().end(); ++it)
     {
         if ((*it)->getI() == I)
         {
             return *it;
         }
     }
     return nullptr;
 }

BaseInteraction * InteractionHandler::getInteraction	(	BaseInteractable *	P,
		BaseInteractable *	I,
		Mdouble	timeStamp
	)

Returns the Interaction between the BaseInteractable's P and I.

Returns a pointer to the existing Interaction, if the Interaction already exists otherwise creates a new Interaction and returns a pointer to it.

Parameters

[in]	P	the first BaseInteractable by which the interaction is defined.
[in]	I	the first BaseInteractable by which the interaction is defined.
[in]	timeStamp	the current value of DPMBase::time_.

Returns: the Interaction between the BaseInteractable's P and I

Definition at line 114 of file InteractionHandler.cc.

References addObject(), BaseHandler< BaseInteraction >::getDPMBase(), getExistingInteraction(), BaseInteractable::getIndSpecies(), SpeciesHandler::getMixedObject(), BaseSpecies::getNewInteraction(), BaseInteraction::setSpecies(), BaseInteraction::setTimeStamp(), and DPMBase::speciesHandler.

Referenced by Coil::getInteractionWith(), AxisymmetricIntersectionOfWalls::getInteractionWith(), Screw::getInteractionWith(), CylindricalWall::getInteractionWith(), InfiniteWallWithHole::getInteractionWith(), InfiniteWall::getInteractionWith(), IntersectionOfWalls::getInteractionWith(), BaseParticle::getInteractionWith(), and readObject().

 {
     BaseSpecies* species = getDPMBase()->speciesHandler.getMixedObject(P->getIndSpecies(), I->getIndSpecies());
 
     //std::cout << "Trying to reconnect to BaseInteraction between P=" << P->getId() << " and " << I->getId() << std::endl;
     BaseInteraction* C = getExistingInteraction(P, I);
     if (!C)
     {
         C = species->getNewInteraction(P, I, timeStamp);
         addObject(C);
         //std::cout << "Creating new interaction with index=" << getLastObject()->getIndex() << " id=" << getLastObject()->getId() << std::endl;
     }
 
     //set timeStamp
     C->setTimeStamp(timeStamp);
 
     //set species of collision
     C->setSpecies(species);
 
     return C;
 }

std::string InteractionHandler::getName ( ) const

virtual

Returns the name of the object.

Returns: the string InteractionHandler

Implements BaseHandler< BaseInteraction >.

Definition at line 232 of file InteractionHandler.cc.

 {
     return "InteractionHandler";
 }

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

Assignment operator.

Parameters

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

Definition at line 62 of file InteractionHandler.cc.

References BaseHandler< BaseInteraction >::clear(), DEBUG, and logger.

 {
     if (this != &rhs)
     {
         clear();
     }
     logger(DEBUG, "InteractionHandler::operator =(const InteractionHandler& rhs) finished.");
     return *this;
 }

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

virtual

Reads an Interaction into the InteractionHandler from restart data.

Parameters

[in] is The input stream from which the information is read.

Todo:: TW: Change identifier in restart file from id to index; is there any reason the id should be kept after restarting, once this is done? (Note, the id is set to the old one in the particle handler because interactions store id, not indices; also note id's are slow

Implements BaseHandler< BaseInteraction >.

Definition at line 251 of file InteractionHandler.cc.

References BaseHandler< BaseInteraction >::getDPMBase(), getInteraction(), helpers::getLineFromStringStream(), BaseHandler< T >::getObjectById(), DPMBase::particleHandler, and DPMBase::wallHandler.

 {
     std::string type, dummy, idType;
     unsigned int id0, id1;
     Mdouble timeStamp;
 
     std::stringstream line(std::stringstream::in | std::stringstream::out);
     helpers::getLineFromStringStream(is, line);
     line >> type >> idType >> id0 >> id1 >> dummy >> timeStamp;
     BaseInteraction* C;
     if (idType.compare("particleIds") == 0)
         C = getInteraction(getDPMBase()->particleHandler.getObjectById(id0), getDPMBase()->particleHandler.getObjectById(id1), timeStamp);
     else
         C = getInteraction(getDPMBase()->particleHandler.getObjectById(id0), getDPMBase()->wallHandler.getObjectById(id1), timeStamp);
     line >> (*C);
 }

void InteractionHandler::removeObjectKeepingPeriodics ( unsigned const int id )

Removes interactions of periodic particles when the periodic particles get deleted (see DPMBase::removeDuplicatePeriodicParticles)

Deleting the three periodic interactions between two real particles is difficult, because its interaction information has to be saved. If the two real particles interacted (which can be checked by looking at the time stamp), the interaction between the real particles is kept, and all interactions that involve ghost particles gets removed; otherwise, the interaction between the lower-indexed real particle with the ghost particle of the higher indexed particles is saved (with the ghost particle replaced by the real particle), and all other interactions removed.

This is what this function is intended for, and it does it in the following way: When an interaction is removed the periodic particle has to be stored in the I pointer So when an interaction is removed where P is normal and I is periodic, and the information is new it will be transfered when the index of P is lower than the index of the real particle of I.

Parameters

[in] the id of the Interaction that needs to be deleted.

Todo:: this function will create an error if the timeStamp is in the future! This should not happen (ever), but who knows.

Definition at line 154 of file InteractionHandler.cc.

References getExistingInteraction(), BaseInteraction::getI(), BaseObject::getIndex(), BaseHandler< BaseInteraction >::getObject(), BaseInteraction::getP(), BaseParticle::getPeriodicFromParticle(), BaseInteraction::getTimeStamp(), BaseHandler< T >::removeObject(), BaseHandler< BaseInteraction >::removeObject(), and BaseInteraction::setI().

Referenced by DPMBase::removeDuplicatePeriodicParticles().

 {
     BaseInteraction* iMain = getObject(id);
 
     BaseParticle* P = dynamic_cast<BaseParticle*>(iMain->getP());
     BaseParticle* I = dynamic_cast<BaseParticle*>(iMain->getI());
     if (P && I)
     {
         //std::cout<<"Both are particles"<<std::endl;
         BaseInteractable* realI = I->getPeriodicFromParticle();
         if (realI && !P->getPeriodicFromParticle())
         {
             //std::cout << "P is normal and I periodic P=" << P->getId() << " I=" << I->getId() << " I real=" << I->getPeriodicFromParticle()->getId() << std::endl;
             if (P->getIndex() < realI->getIndex())
             {
                 //std::cout << "Reconnecting to spring" << std::endl;
                 BaseInteraction* iOther = getExistingInteraction(P, realI);
                 if (iOther)
                 {
                     //Here we decide which of the two interactions should be kept:
                     //the interaction between the two real particles (iMain), or 
                     //the interaction between the real and a ghost particle (iOther). 
                     //It picks the one for which a collision has happened, 
                     //i.e. the one with the newer timeStamp. 
                     if (iOther->getTimeStamp() < iMain->getTimeStamp())
                     {
                         //std::cout << "Switching" << std::endl;
                         iMain->setI(realI);
                         removeObject(iOther->getIndex());
                         return;
                     }
                     else
                     {
                         //std::cout << "Not switching" << std::endl;
                         BaseHandler<BaseInteraction>::removeObject(id);
                         return;
                     }
                 }
                 else
                 {
                     //std::cout << "Not found, so just move" << std::endl;
                     iMain->setI(realI);
                     return;
                 }
             }
         }
     }
     BaseHandler<BaseInteraction>::removeObject(id);
 }

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

Writes the InteractionHandler to an output stream, for example a restart file.

Parameters

[in] os The output stream where the InteractionHandler must be written to, usually a restart file.

Definition at line 241 of file InteractionHandler.cc.

References BaseHandler< BaseInteraction >::getNumberOfObjects().

Referenced by DPMBase::write().

 {
     os << "Interactions " << getNumberOfObjects() << std::endl;
     for (BaseInteraction* i : *this)
         os << (*i) << std::endl;
 }

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation