Container to store the pointers to all objects that one creates in a simulation. More...

#include <BaseHandler.h>

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

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

template<typename U >
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...

template<typename U >
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...

template<typename U >
std::enable_if <!std::is_pointer< U >::value, U * >::type	copyAndAddGhostObject (const U &object)
	Creates a copy of a Object and adds it to the BaseHandler. This is one locally for inserting mpi particles, they avoid the global check if the particle can actually be inserted, because the mpi domain already knows that is the case. More...

template<typename U >
std::enable_if < std::is_pointer< U >::value, U >::type	copyAndAddGhostObject (const U object)
	Creates a copy of a Object and adds it to the BaseHandler. This is one locally for inserting mpi particles, they avoid the global check if the particle can actually be inserted, because the mpi domain already knows that is the case. More...

virtual void	addExistingObject (T *O)
	Adds an existing object to the BaseHandler without changing the id of the object. More...

virtual void	addObject (T *object)
	Adds a new Object to the BaseHandler. More...

virtual void	addGhostObject (T *O)
	Adds a new Object to the BaseHandler. called by the to avoid increasing the id. More...

void	removeIf (const std::function< bool(T *)> cond)

virtual void	removeObject (unsigned const int index)
	Removes an Object from the BaseHandler. More...

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

virtual void	clear ()
	Empties the whole BaseHandler by removing all Objects and setting all other variables to 0. More...

virtual void	readAndAddObject (std::istream &is)=0
	Reads Object into the BaseHandler from restart data. More...

void	read (std::istream &is)
	Reads all objects from restart data. More...

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

std::vector< T * >	getObjectsById (const unsigned int id)
	Gets a vector of pointers to the objects with the specific id. More...

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

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

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

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

virtual unsigned int	getNumberOfObjects () const
	Gets the number of real Object in this BaseHandler. (i.e. no mpi or periodic particles) More...

unsigned int	getSize () const
	Gets the size of the particleHandler (including mpi and periodic particles) 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...

void	resize (const unsigned int N, const T &obj)
	Resizes the container to contain N elements. More...

const std::vector< T * > ::const_iterator	begin () const
	Gets the begin of the const_iterator over all Object in this BaseHandler. More...

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

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

const std::vector< T * >::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 (T *object, unsigned int id)
	This function sets the id and ensures that nextId is a bigger value than id. More...

void	increaseId ()

unsigned int	getNextId ()

void	setNextId (unsigned int id)

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 std::string	getName () const =0
	Gets the name of this handler. More...

virtual void	writeVTK () const
	now empty function for writing VTK files. More...

unsigned	getNextGroupId ()
	Should be called each time you assign a groupId. Returns the value of nextGroupId_ and increases nextGroupId_ by one. More...

Protected Attributes
std::vector< T * >	objects_
	The actual list of Object pointers. More...

Private Attributes
unsigned int	maxObjects_
	An integer to keep track of the largest number of objects ever stored in this BaseHandler. More...

unsigned int	nextId_
	identifier for next object created More...

unsigned	nextGroupId_ = 1
	value of the next BaseObject::groupId_. Value increased by one each time a groupId is assigned. Default group is 0 More...

DPMBase *	DPMBase_
	A pointer back to the DPMBase class. More...

Detailed Description

template<typename T>
class BaseHandler< T >

Container to store the pointers to all objects that one creates in a simulation.

The BaseHandler allows one to create a container to store all pointer objects of a templated type T It is implemented by a (protected) vector of pointers to objects of type T. Once the container is created, the BaseHandler also provides the provision to manipulate the pointers i.e. by accessing, adding, deleting and few more operations by using its member methods.

Definition at line 50 of file BaseHandler.h.

Constructor & Destructor Documentation

template<typename T >

BaseHandler< T >::BaseHandler ( )

Default BaseHandler constructor, it creates an empty BaseHandler and assigns DPMBase_ to a null pointer.

Definition at line 335 of file BaseHandler.h.

References DEBUG, and logger.

 {
     DPMBase_ = nullptr;
     clear();
     logger(DEBUG, "BaseHandler<T>::BaseHandler() finished");
 }

template<typename T>

BaseHandler< T >::BaseHandler ( const BaseHandler< T > & BH )

Constructor that copies the objects of the given handler into itself and sets other variables to 0/nullptr.

Parameters

[in] BH A reference to the BaseHandler that has to be copied.

This is not a copy constructor! It only copies the vector objects_ from the given handler, and sets all other variables to 0/nullptr.

Todo:: Should max objects be set to the number of objects after this constructor? Maybe in copyContentsFromOtherHandler?

Definition at line 350 of file BaseHandler.h.

References DEBUG, and logger.

 {
     DPMBase_ = nullptr;
     clear();
     copyContentsFromOtherHandler(BH);
     logger(DEBUG, "BaseHandler<T>::BaseHandler(const BaseHandler &BH) finished");
 }

template<typename T >

BaseHandler< T >::~BaseHandler ( )

virtual

Destructor, it destructs the BaseHandler and all Object it contains.

Definition at line 359 of file BaseHandler.h.

References DEBUG, and logger.

 {
     clear();
     logger(DEBUG, "BaseHandler<T>::~BaseHandler() finished");
 }

Member Function Documentation

template<class T>

void BaseHandler< T >::addExistingObject ( T * O )

virtual

Adds an existing object to the BaseHandler without changing the id of the object.

Parameters

[in] object A point to an existing object which already has an id given

Reimplemented in ParticleHandler.

Definition at line 417 of file BaseHandler.h.

Referenced by ParticleHandler::addExistingObject().

 {
     objects_.push_back(O);
     //Set the index of the particle
     getLastObject()->setIndex(getSize() - 1);
     //Adjust the nextId_ value
     if (O->getId() + 1 > nextId_)
     {
         nextId_ = O->getId() + 1;
     }
 }

template<class T>

void BaseHandler< T >::addGhostObject ( T * O )

virtual

Adds a new Object to the BaseHandler. called by the to avoid increasing the id.

Todo:: mx: type the stuff here: keeps the id unique key

Reimplemented in ParticleHandler.

Definition at line 444 of file BaseHandler.h.

Referenced by ParticleHandler::addGhostObject().

 {
     objects_.push_back(O);
     //Set the index of the particle
     getLastObject()->setIndex(getSize() - 1);
 }

template<class T>

void BaseHandler< T >::addObject ( T * object )

virtual

Adds a new Object to the BaseHandler.

Parameters

[in] object A pointer to the object that must be added.

Reimplemented in CGHandler, DomainHandler, ParticleHandler, PeriodicBoundaryHandler, InteractionHandler, WallHandler, BoundaryHandler, and SpeciesHandler.

Definition at line 431 of file BaseHandler.h.

Referenced by SpeciesHandler::addObject(), BoundaryHandler::addObject(), WallHandler::addObject(), InteractionHandler::addObject(), ParticleHandler::addObject(), DomainHandler::addObject(), and CGHandler::addObject().

 {
     objects_.push_back(object);
     //Set the index of the particle
     getLastObject()->setIndex(getSize() - 1);
     //set the non changing particle identifier
     getLastObject()->setId(nextId_);
     //Update Id for next particle
     nextId_++;
 }

template<typename T >

const std::vector< T * >::const_iterator BaseHandler< T >::begin ( ) const

Gets the begin of the const_iterator over all Object in this BaseHandler.

Returns: A const_iterator pointing to the first Object.

Definition at line 690 of file BaseHandler.h.

Referenced by BaseCluster::actionsAfterSolve(), BaseCluster::applyCentralForce(), CircularPeriodicBoundary::checkBoundaryAfterParticlesMove(), FluxBoundary::checkBoundaryAfterParticlesMove(), HeaterBoundary::checkBoundaryAfterParticlesMove(), LeesEdwardsBoundary::checkBoundaryAfterParticlesMove(), AngledPeriodicBoundary::checkBoundaryAfterParticlesMove(), ConstantMassFlowMaserBoundary::checkBoundaryAfterParticlesMove(), PeriodicBoundary::checkBoundaryAfterParticlesMove(), DPMBase::computeInternalForces(), BaseCluster::createAdjacencyMatrix(), BaseCluster::dampVelocities(), DPMBase::getRotationalEnergy(), DPMBase::importParticlesAs(), HGridOptimiser::initialise(), BaseCluster::makeDataAnalysis(), BaseCluster::writeToOverlFile(), and SphericalParticleVtkWriter::writeVTK().

 {
     return objects_.begin();
 }

template<typename T >

const std::vector< T * >::iterator BaseHandler< T >::begin ( )

Gets the begin of the iterator over all BaseBoundary in this BaseHandler.

Returns: A iterator pointing to the first Object.

Definition at line 697 of file BaseHandler.h.

 {
     return objects_.begin();
 }

template<typename T >

void BaseHandler< T >::clear ( )

virtual

Empties the whole BaseHandler by removing all Objects and setting all other variables to 0.

Delete all objects stored in objects_ and set the maximum number of objects that have been in this container to 0, and set the Id of the next object that will be added to 0.

Reimplemented in ParticleHandler, and SpeciesHandler.

Definition at line 528 of file BaseHandler.h.

Referenced by SpeciesHandler::clear(), ParticleHandler::clear(), CGHandler::evaluateRestartFiles(), FileReader::read(), DPMBase::read(), DPMBase::readNextFStatFile(), and ChuteBottom::setupInitialConditions().

 {
     
     for (T* const obj : objects_)
     {
         delete obj;
     }
     objects_.clear();
     
     nextId_ = 0;
     maxObjects_ = 0;
 }

template<class T >

template<class U >

std::enable_if<!std::is_pointer< U >::value, U * >::type BaseHandler< T >::copyAndAddGhostObject ( const U & object )

Creates a copy of a Object and adds it to the BaseHandler. This is one locally for inserting mpi particles, they avoid the global check if the particle can actually be inserted, because the mpi domain already knows that is the case.

Parameters

[in] object A reference to the BaseHandler of which the objects have to be copied.

Definition at line 399 of file BaseHandler.h.

 {
     U* oCopy = object.copy();
     addGhostObject(oCopy);
     return oCopy;
 }

template<class T >

template<class U >

std::enable_if< std::is_pointer< U >::value, U >::type BaseHandler< T >::copyAndAddGhostObject ( const U object )

Creates a copy of a Object and adds it to the BaseHandler. This is one locally for inserting mpi particles, they avoid the global check if the particle can actually be inserted, because the mpi domain already knows that is the case.

Parameters

[in] object A reference to the Object that has to be copied.

Definition at line 410 of file BaseHandler.h.

 {
     return copyAndAddGhostObject(*object);
 }

template<typename T >

template<typename U >

std::enable_if<!std::is_pointer< U >::value, U * >::type BaseHandler< T >::copyAndAddObject ( const U & object )

Creates a copy of a Object and adds it to the BaseHandler.

Parameters

[in] object A reference to the BaseHandler of which the objects have to be copied.

Definition at line 379 of file BaseHandler.h.

Referenced by Chute::addFlowParticlesCompactly(), ChuteWithHopper::addHopper(), SubcriticalMaserBoundary::addParticleToMaser(), ConstantMassFlowMaserBoundary::addParticleToMaser(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), InsertionBoundary::checkBoundaryBeforeTimeStep(), Chute::createBottom(), DPMBase::importParticlesAs(), BaseCluster::particleInsertionSuccessful(), FileReader::read(), DPMBase::readNextDataFile(), DPMBase::readNextFStatFile(), DPMBase::readParAndIniFiles(), CGHandler::restart(), BaseCluster::setSpecies(), ChuteBottom::setupInitialConditions(), Chute::setupInitialConditions(), ChuteWithHopper::setupInitialConditions(), and Chute::setupSideWalls().

 {
     U* oCopy = object.copy();
     addObject(oCopy);
     return oCopy;
 }

template<typename T >

template<typename U >

std::enable_if< std::is_pointer< U >::value, U >::type BaseHandler< T >::copyAndAddObject ( const U object )

Creates a copy of a Object and adds it to the BaseHandler.

Parameters

[in] object A reference to the Object that has to be copied.

Definition at line 390 of file BaseHandler.h.

 {
     return copyAndAddObject(*object);
 }

template<typename T>

void BaseHandler< T >::copyContentsFromOtherHandler ( const BaseHandler< T > & BH )

Function that copies the contents (vector of pointers, maxObject_, nextId_, DPMBase_) from one handler (container) to the other.

Parameters

[in] BH A reference to the BaseHandler of which the objects have to be copied.

Definition at line 367 of file BaseHandler.h.

References BaseHandler< T >::objects_.

 {
     for (const T* const obj : BH.objects_)
     {
         addObject(obj->copy());
     }
 }

template<typename T >

const std::vector< T * >::const_iterator BaseHandler< T >::end ( ) const

Gets the end of the const_iterator over all BaseBoundary in this BaseHandler.

Returns: A const_iterator pointing to the last BaseBoundary.

Definition at line 704 of file BaseHandler.h.

Referenced by BaseCluster::actionsAfterSolve(), BaseCluster::applyCentralForce(), CircularPeriodicBoundary::checkBoundaryAfterParticlesMove(), FluxBoundary::checkBoundaryAfterParticlesMove(), HeaterBoundary::checkBoundaryAfterParticlesMove(), LeesEdwardsBoundary::checkBoundaryAfterParticlesMove(), AngledPeriodicBoundary::checkBoundaryAfterParticlesMove(), ConstantMassFlowMaserBoundary::checkBoundaryAfterParticlesMove(), PeriodicBoundary::checkBoundaryAfterParticlesMove(), BaseCluster::createAdjacencyMatrix(), BaseCluster::dampVelocities(), PeriodicBoundaryHandler::findNewParticles(), DPMBase::getRotationalEnergy(), DPMBase::importParticlesAs(), HGridOptimiser::initialise(), BaseCluster::makeDataAnalysis(), BaseCluster::writeToOverlFile(), and SphericalParticleVtkWriter::writeVTK().

 {
     return objects_.end();
 }

template<typename T >

const std::vector< T * >::iterator BaseHandler< T >::end ( )

Gets the end of the iterator over all BaseBoundary in this BaseHandler.

Returns: An iterator pointing to the last BaseBoundary.

Definition at line 711 of file BaseHandler.h.

 {
     return objects_.end();
 }

template<typename T >

DPMBase * BaseHandler< T >::getDPMBase ( )

Gets the problem that is solved using this handler.

Returns: A pointer to the DPMBase (problem descriptor) that is using this handler.

Definition at line 725 of file BaseHandler.h.

Referenced by SubcriticalMaserBoundaryTEST::activateMaser(), SubcriticalMaserBoundary::activateMaser(), ConstantMassFlowMaserBoundary::activateMaser(), StressStrainControlBoundary::activateStrainRateControl(), BaseWall::addParticlesAtWall(), SubcriticalMaserBoundary::addParticleToMaser(), ConstantMassFlowMaserBoundary::addParticleToMaser(), BaseInteraction::BaseInteraction(), CGHandler::CGHandler(), DeletionBoundary::checkBoundaryAfterParticleMoved(), HeaterBoundary::checkBoundaryAfterParticleMoved(), DropletBoundary::checkBoundaryAfterParticlesMove(), PeriodicBoundary::checkBoundaryAfterParticlesMove(), FrictionInteraction::computeFrictionForce(), MindlinInteraction::computeFrictionForce(), MindlinRollingTorsionInteraction::computeFrictionForce(), SinterInteraction::computeNormalForce(), HertzianSinterInteraction::computeSinterForce(), SlidingFrictionInteraction::computeSlidingSpring(), SlidingFrictionInteraction::computeSlidingSpringSuperQuadric(), StressStrainControlBoundary::computeStrainRate(), copyDataFromMPIParticleToParticle(), SubcriticalMaserBoundaryTEST::copyExtraParticles(), PeriodicBoundary::createGhostParticle(), InfiniteWall::createVTK(), StressStrainControlBoundary::determineLengthAndCentre(), StressStrainControlBoundary::determineStressControlledShearBoundaries(), SubcriticalMaserBoundaryTEST::extendBottom(), Domain::finaliseBoundaryDataTransmission(), BaseInteraction::gatherContactStatistics(), LeesEdwardsBoundary::getCurrentShift(), LeesEdwardsBoundary::getCurrentVelocity(), NurbsWall::getDistanceAndNormal(), Screw::getDistanceAndNormal(), HorizontalBaseScrew::getDistanceAndNormal(), IntersectionOfWalls::getDistanceAndNormal(), BaseWall::getInteractionWith(), BaseParticle::getParticleDimensions(), BaseParticle::getPeriodicComplexity(), ParticleSpecies::getVolumeFromRadius(), BaseParticle::integrateBeforeForceComputation(), WallHandler::operator=(), CGHandler::operator=(), ParticleHandler::ParticleHandler(), Domain::performBoundaryDataTransmission(), Domain::processReceivedBoundaryParticleData(), Domain::processReceivedInteractionData(), SubcriticalMaserBoundary::read(), ConstantMassFlowMaserBoundary::read(), InsertionBoundary::read(), BaseWall::renderWall(), Screw::rotate(), LiquidMigrationWilletInteraction::rupture(), StressStrainControlBoundary::set(), Domain::setBounds(), ParticleSpecies::setDensity(), BaseParticle::setIndSpecies(), BaseParticle::setPeriodicComplexity(), Domain::setRange(), BaseWall::setSpecies(), BaseParticle::setSpecies(), ShearBoxBoundary::shiftHorizontalPosition(), LeesEdwardsBoundary::shiftVerticalPosition(), SpeciesHandler::SpeciesHandler(), StressStrainControlBoundary::updateDomainSize(), Domain::updateParticlePosition(), Domain::updateParticles(), WallHandler::WallHandler(), LeesEdwardsBoundary::write(), BaseInteraction::writeInteraction(), HorizontalBaseScrew::writeVTK(), AxisymmetricIntersectionOfWalls::writeVTK(), ScrewsymmetricIntersectionOfWalls::writeVTK(), IntersectionOfWalls::writeVTK(), and BaseInteraction::~BaseInteraction().

 {
     return DPMBase_;
 }

template<typename T >

DPMBase * BaseHandler< T >::getDPMBase ( ) const

Gets the problem that is solved using this handler and does not change the class.

Returns: A pointer to the DPMBase (problem descriptor) that is using this handler.

Definition at line 732 of file BaseHandler.h.

 {
     return DPMBase_;
 }

template<typename T >

T * BaseHandler< T >::getLastObject ( )

Gets a pointer to the last Object in this BaseHandler.

Returns: A pointer to the last Object in the BaseHandler.

Definition at line 634 of file BaseHandler.h.

Referenced by DropletBoundary::checkBoundaryAfterParticlesMove(), ShearBoxBoundary::createVerticalPeriodicParticles(), LeesEdwardsBoundary::createVerticalPeriodicParticles(), DPMBase::fillDomainWithParticles(), Domain::processReceivedBoundaryParticleData(), PeriodicBoundaryHandler::processReceivedGhostParticleData(), DPMBase::readNextFStatFile(), and ParticleVtkWriter::writeExtraFields().

 {
     return objects_.back();
 }

template<typename T >

const T * BaseHandler< T >::getLastObject ( ) const

Gets a constant pointer to the last Object in this BaseHandler.

Returns: A constant pointer to the last Object in the BaseHandler.

Definition at line 641 of file BaseHandler.h.

 {
     return objects_.back();
 }

template<typename T>

virtual std::string BaseHandler< T >::getName ( ) const

pure virtual

Gets the name of this handler.

Returns: A string that contains the name of the handler.

Implemented in ParticleHandler, InteractionHandler, DomainHandler, CGHandler, SpeciesHandler, WallHandler, BoundaryHandler, and PeriodicBoundaryHandler.

template<typename T>

unsigned BaseHandler< T >::getNextGroupId ( )

inline

Should be called each time you assign a groupId. Returns the value of nextGroupId_ and increases nextGroupId_ by one.

Definition at line 293 of file BaseHandler.h.

Referenced by FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), and RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep().

293 { return nextGroupId_++; }

BaseHandler::nextGroupId_

unsigned nextGroupId_

value of the next BaseObject::groupId_. Value increased by one each time a groupId is assigned...

Definition: BaseHandler.h:320

template<typename T>

unsigned int BaseHandler< T >::getNextId ( )

inline

Definition at line 256 of file BaseHandler.h.

Referenced by PeriodicBoundaryHandler::updateMaserParticle(), and PeriodicBoundaryHandler::updateParticleStatus().

     {
         return nextId_;
     }

template<typename T >

unsigned int BaseHandler< T >::getNumberOfObjects ( ) const

virtual

Gets the number of real Object in this BaseHandler. (i.e. no mpi or periodic particles)

Returns: The number of Objects in this BaseHandler.

Reimplemented in ParticleHandler.

Definition at line 648 of file BaseHandler.h.

Referenced by DPMBase::checkSettings(), DPMBase::computeAllForces(), DPMBase::decompose(), CGHandler::evaluateDataFiles(), CGHandler::evaluateRestartFiles(), DPMBase::integrateAfterForceComputation(), DPMBase::integrateBeforeForceComputation(), FileReader::read(), DPMBase::readNextFStatFile(), CGHandler::restart(), Chute::setupInitialConditions(), DPMBase::write(), and InteractionVTKWriter::writeVTK().

 {
     return objects_.size();
 }

template<typename T >

T * BaseHandler< T >::getObject ( const unsigned int index )

Gets a pointer to the Object at the specified index in the BaseHandler.

Parameters

[in] index the index of the requested Object.

Returns: A pointer to the requested Object.

Definition at line 613 of file BaseHandler.h.

References getName(), and logger.

Referenced by ChuteWithHopper::addHopper(), BaseCluster::calculateTimeStep(), DeletionBoundary::checkBoundaryAfterParticlesMove(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), Chute::cleanChute(), DPMBase::computeAllForces(), BaseCluster::computeInternalStructure(), copyDataFromMPIParticleToParticle(), Chute::createBottom(), InteractionHandler::createEmptyInteraction(), Chute::createFlowParticle(), CircularPeriodicBoundary::createPeriodicParticles(), SubcriticalMaserBoundary::createPeriodicParticles(), LeesEdwardsBoundary::createPeriodicParticles(), AngledPeriodicBoundary::createPeriodicParticles(), ConstantMassFlowMaserBoundary::createPeriodicParticles(), PeriodicBoundary::createPeriodicParticles(), InteractionHandler::deleteEmptyInteraction(), DPMBase::importParticlesAs(), MPIContainer::initialiseMercuryMPITypes(), DPMBase::integrateAfterForceComputation(), DPMBase::integrateBeforeForceComputation(), BaseCluster::makeDataAnalysis(), ChuteBottom::makeRoughBottom(), DPMBase::outputXBallsData(), BaseCluster::particleInsertionSuccessful(), FileReader::read(), SubcriticalMaserBoundary::read(), ConstantMassFlowMaserBoundary::read(), InsertionBoundary::read(), DPMBase::readNextDataFile(), DPMBase::readNextFStatFile(), DPMBase::readParAndIniFiles(), DPMBase::removeDuplicatePeriodicParticles(), DPMBase::setFixedParticles(), BaseWall::setHandler(), BaseParticle::setHandler(), BaseWall::setIndSpecies(), BaseParticle::setIndSpecies(), BaseSpecies::setInteractionDistance(), BaseInteractable::setSpecies(), BaseCluster::setSpecies(), ChuteBottom::setupInitialConditions(), Chute::setupInitialConditions(), ChuteWithHopper::setupInitialConditions(), Chute::setupSideWalls(), Domain::updateParticles(), DPMBase::write(), and BaseCluster::writeToOverlFile().

 {
     logger.assert(index < getSize(),
                   "[%::getObject()] Object couldn't be found because index (%) is higher than number of objects (%).",
                   getName(), index, getSize());
     return objects_[index];
 }

template<typename T >

const T * BaseHandler< T >::getObject ( const unsigned int index ) const

Gets a constant pointer to the Object at the specified index in the BaseHandler.

Parameters

[in] index the index of the requested Object.

Returns: A constant pointer to the requested Object.

Definition at line 624 of file BaseHandler.h.

References getName(), and logger.

 {
     logger.assert(index < getSize(),
                   "[%::getObject() const] Object couldn't be found because index (%) is higher than number of objects (%).",
                   getName(), index, getSize());
     return objects_[index];
 }

template<typename T >

T * BaseHandler< T >::getObjectById ( const unsigned int id )

Gets a pointer to the Object at the specified index in the BaseHandler.

Parameters

[in] id The id of the requested Object.

Returns: A pointer to the Object with the correct Id. Gets an object with the identity id. Please note that the object with this identity does not have to be at place id in the vector of Object objects_.

Definition at line 565 of file BaseHandler.h.

References ERROR, getName(), and logger.

Referenced by PeriodicBoundaryHandler::processLocalInteractionData(), PeriodicBoundaryHandler::processReceivedInteractionData(), Domain::processReceivedInteractionData(), and FileReader::read().

 {
     // Usually, the id and the index into the backing storage matches
     // So check this position first!
     // dducks: Can't we guarantee more? That should speed up searches. 
     if (id < objects_.size() && objects_[id]->getId() == id)
     {
         return objects_[id]; //There is a hit, return early
     }
     
     for (T* obj : objects_) //Search for the correct id, since it wasn't where
     {                        // we expected it. Just use a linear search..
         if (obj->getId() == id) //Found it, so return!
             return obj;
     }
 #ifndef MERCURY_USE_MPI
     logger(ERROR, "[BaseHandler::getObjectById()] in Object* %: Object with ID % could not be found.", getName(), id);
 #endif
     return nullptr;
 }

template<typename T >

std::vector< T * > BaseHandler< T >::getObjectsById ( const unsigned int id )

Gets a vector of pointers to the objects with the specific id.

Gets all the objects with the id from the handler. This is especially useful in parallel where ghost particles of a real particle have the same id

Parameters

[in] id The id of the requested objects.

Returns: A list of pointers towards objects with the specified id

Definition at line 593 of file BaseHandler.h.

References ERROR, getName(), and logger.

Referenced by InteractionHandler::readAndAddObject().

 {
     std::vector<T*> list;
     for (T* obj : objects_)
     {
         if (obj->getId() == id)
         {
             list.push_back(obj);
         }
     }
 #ifndef MERCURY_USE_MPI
     logger(ERROR, "[BaseHandler::getObjectById()] in Object* %: Object with ID % could not be found.", getName(), id);
 #endif
     return list;
     
 }

template<class T >

unsigned int BaseHandler< T >::getSize ( ) const

Gets the size of the particleHandler (including mpi and periodic particles)

Returns: The number of items in this BaseHandler

Definition at line 655 of file BaseHandler.h.

Referenced by Chute::addFlowParticlesCompactly(), BaseWall::addParticlesAtWall(), DeletionBoundary::checkBoundaryAfterParticlesMove(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), BaseCluster::createAdjacencyMatrix(), CircularPeriodicBoundary::createPeriodicParticles(), LeesEdwardsBoundary::createPeriodicParticles(), SubcriticalMaserBoundary::createPeriodicParticles(), AngledPeriodicBoundary::createPeriodicParticles(), ConstantMassFlowMaserBoundary::createPeriodicParticles(), PeriodicBoundary::createPeriodicParticles(), DPMBase::decompose(), DPMBase::deleteGhostParticles(), CGHandler::evaluateDataFiles(), CGHandler::evaluateRestartFiles(), DPMBase::fillDomainWithParticles(), MercuryBase::getHGridTargetMaxInteractionRadius(), MercuryBase::getHGridTargetMinInteractionRadius(), MercuryBase::getHGridTargetNumberOfBuckets(), BaseParticle::getPeriodicComplexity(), WallVTKWriter::getVTKData(), MercuryBase::hGridNeedsRebuilding(), DPMBase::importParticlesAs(), HGridOptimiser::initialise(), DPMBase::insertGhostParticle(), BaseCluster::makeDataAnalysis(), BaseCluster::makeGnuplotFile(), DPMBase::mpiInsertParticleCheck(), DPMBase::outputXBallsData(), BaseCluster::printTime(), DPMBase::readNextDataFile(), DPMBase::removeDuplicatePeriodicParticles(), CGHandler::restart(), DPMBase::setFixedParticles(), ParticleSpecies::setMaxInteractionDistance(), BaseParticle::setPeriodicComplexity(), BaseCluster::setupInitialConditions(), DPMBase::write(), BaseCluster::writeAmatFile(), ParticleVtkWriter::writeExtraFields(), and SuperQuadricParticleVtkWriter::writeVTK().

 {
     return objects_.size();
 }

template<typename T >

unsigned int BaseHandler< T >::getStorageCapacity ( ) const

Gets the storage capacity of this BaseHandler.

Returns: The storage capacity of this BaseHandler.

Definition at line 662 of file BaseHandler.h.

 {
     return objects_.capacity();
 }

template<typename T>

void BaseHandler< T >::increaseId ( )

inline

Definition at line 251 of file BaseHandler.h.

Referenced by ParticleHandler::addObject(), and PeriodicBoundaryHandler::updateMaserParticle().

     {
         nextId_++;
     }

template<typename T >

void BaseHandler< T >::read ( std::istream & is )

Reads all objects from restart data.

Parameters

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

Definition at line 543 of file BaseHandler.h.

References helpers::getLineFromStringStream(), getName(), constants::i, logger, and VERBOSE.

Referenced by DPMBase::read(), and DPMBase::readOld().

 {
     clear();
     unsigned int N;
     std::string dummy;
     is >> dummy;
     std::stringstream line;
     helpers::getLineFromStringStream(is, line);
     line >> N;
     logger(VERBOSE, "In %::read(is): reading in % objects.", getName(), N);
     setStorageCapacity(N);
     for (unsigned int i = 0; i < N; i++)
     {
         readAndAddObject(is);
     }
 }

template<typename T>

virtual void BaseHandler< T >::readAndAddObject ( std::istream & is )

pure virtual

Reads Object into the BaseHandler from restart data.

Parameters

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

Implemented in ParticleHandler, CGHandler, DomainHandler, WallHandler, InteractionHandler, PeriodicBoundaryHandler, BoundaryHandler, and SpeciesHandler.

template<class T>

void BaseHandler< T >::removeIf ( const std::function< bool(T *)> cond )

Definition at line 453 of file BaseHandler.h.

References constants::i.

 {
     for (int i = 0; i < objects_.size(); ++i) {
         if (cond(objects_[i]))
         {
             //objects_(i)->actionsOnErase();
             removeObject(i);
             --i;
         }
     }
 }

template<typename T >

void BaseHandler< T >::removeLastObject ( )

Removes the last Object from the BaseHandler.

Definition at line 511 of file BaseHandler.h.

References getName(), logger, and WARN.

Referenced by ParticleHandler::removeLastObject().

 {
     if (getSize() == 0)
     {
         logger(WARN, "In: void %::removeLastObject, no Object exists in this BaseHandler.", getName());
         return;
     }
     T* const object = objects_.back();
     //Remove the (now double) reference to that last Object
     objects_.pop_back();
     //Physically removes Object
     delete object;
 }

template<typename T>

void BaseHandler< T >::removeObject ( unsigned const int index )

virtual

Removes an Object from the BaseHandler.

This methods removes an object. This methods invalidates ANY iterators to objects in this container. This method may shuffle the order of objects in this container.

Parameters

[in] index An unsigned integer that gives the id of the Object that has to be removed.

Definition at line 472 of file BaseHandler.h.

References getName(), and logger.

Referenced by BaseInteraction::removeFromHandler(), ParticleHandler::removeGhostObject(), SpeciesHandler::removeObject(), ParticleHandler::removeObject(), and InteractionHandler::removeObjectKeepingPeriodics().

 {
     logger.assert(index < getSize(),
                   "In: void %::removeObject(const unsigned int index) const, "
                   "no object exists with index %, number of objects is %",
                   getName(), index, getSize());
     
     //Removing a particle within the list is not efficient.
     //Swap with last element and then perform the deletion
     const unsigned int lastIndex = objects_.size() - 1;
     
     T* const objectToDelete = objects_[index];
     
     //No swapping required if it is the last object
     if (index != lastIndex)
     {
         
         T* const objectToMove = objects_[lastIndex];
         
         objects_[index] = objectToMove; //place it back
         objects_[lastIndex] = objectToDelete; //Just to make sure.
         
         //and notify it of the change.
         objects_[index]->moveInHandler(index);
         //Even though we are going to delete this particle,
         //we still need to keep it consistent.
         objects_[lastIndex]->moveInHandler(lastIndex);
     }
     
     
     //And clear it from the backing container.
     objects_.pop_back();
     //And _NOW_ we delete it.
     
     delete objectToDelete;
     
 }

template<class T>

void BaseHandler< T >::resize	(	const unsigned int	N,
		const T &	obj
	)

Resizes the container to contain N elements.

If the current size is greater than count, the container is reduced to its first count elements.

If the current size is less than count, additional elements are appended and initialized with copies of obj.

Parameters

[in]	N	Container resized to contain N elements.
[in]	obj	additional elements are appended and initialized with copies of obj.

Definition at line 679 of file BaseHandler.h.

 {
     //objects_.resize(N,obj); //doesn't work because the handler stores pointers only (data needs to be allocated);
     while (getSize() < N)
         copyAndAddObject(obj);
     while (getSize() > N)
         removeLastObject();
 }

template<typename T >

void BaseHandler< T >::setDPMBase ( DPMBase * DPMBase )

Sets the problem that is solved using this handler.

Todo:: MX: Bad practice to have a function parameter with the exact name of the class

Parameters

[in] DPMBase A pointer to a DPMBase, which is the superclass for all problem descriptions.

Definition at line 718 of file BaseHandler.h.

Referenced by DPMBase::constructor(), DPMBase::decompose(), and DPMBase::DPMBase().

 {
     DPMBase_ = DPMBase;
 }

template<typename T>

void BaseHandler< T >::setId	(	T *	object,
		unsigned int	id
	)

inline

This function sets the id and ensures that nextId is a bigger value than id.

Todo:: we should use this function only to set the id of particles, not BaseObject::setId; however, to block BaseObject::setId, I need to make this function a friend of BaseObject, and I don't know how to do that.

Definition at line 238 of file BaseHandler.h.

     {
         object->setId(id);
         if (nextId_ <= id)
         {
             nextId_ = id + 1;
         }
     }

template<typename T>

void BaseHandler< T >::setNextId ( unsigned int id )

inline

Definition at line 261 of file BaseHandler.h.

Referenced by PeriodicBoundaryHandler::updateParticleStatus().

     {
         nextId_ = id;
     }

template<typename T >

void BaseHandler< T >::setStorageCapacity ( const unsigned int N )

Sets the storage capacity of this BaseHandler.

Parameters

[in] N The storage capacity the BaseHandler will have

Definition at line 669 of file BaseHandler.h.

Referenced by Chute::addFlowParticlesCompactly(), FileReader::read(), DPMBase::read(), DPMBase::readNextDataFile(), and ChuteBottom::setupInitialConditions().

 {
     objects_.reserve(N);
 }

template<typename T>

virtual void BaseHandler< T >::writeVTK ( ) const

inlinevirtual

now empty function for writing VTK files.

Deprecated:: Now the VTK-writers have their own classes, and are called from DPMBase.

Definition at line 286 of file BaseHandler.h.

287 {};

Member Data Documentation

template<typename T>

DPMBase* BaseHandler< T >::DPMBase_

private

A pointer back to the DPMBase class.

Please note that this pointer back to the DPMBase class is a "shared" pointer and should not be deallocated by this class.

Definition at line 328 of file BaseHandler.h.

template<typename T>

unsigned int BaseHandler< T >::maxObjects_

private

An integer to keep track of the largest number of objects ever stored in this BaseHandler.

Definition at line 308 of file BaseHandler.h.

template<typename T>

unsigned BaseHandler< T >::nextGroupId_ = 1

private

value of the next BaseObject::groupId_. Value increased by one each time a groupId is assigned. Default group is 0

Definition at line 320 of file BaseHandler.h.

Referenced by BaseHandler< BaseCG >::getNextGroupId().

template<typename T>

unsigned int BaseHandler< T >::nextId_

private

identifier for next object created

Definition at line 313 of file BaseHandler.h.

Referenced by BaseHandler< BaseCG >::getNextId(), BaseHandler< BaseCG >::increaseId(), BaseHandler< BaseCG >::setId(), and BaseHandler< BaseCG >::setNextId().

template<typename T>

std::vector<T*> BaseHandler< T >::objects_

protected

The actual list of Object pointers.

The list of Object pointers. This handler is responsible for the memory-deallocation of these objects.

Definition at line 302 of file BaseHandler.h.

Referenced by BaseHandler< T >::copyContentsFromOtherHandler().

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

BaseHandler.h

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

template<typename T> class BaseHandler< T >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T>
class BaseHandler< T >