BaseHandler< T > Class Template Reference

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 >
U *	copyAndAddObject (const U &O)
	Creates a copy of a Object and adds it to the BaseHandler. More...
template<typename U >
U *	copyAndAddObject (U *O)
	Creates a copy of a Object and adds it to the BaseHandler. More...
virtual void	addObject (T *O)
	Adds a new Object 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...
virtual void	readObject (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...
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...
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< 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...
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...

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...
DPMBase *	DPMBase_
	A pointer back to the DPMBase class. More...

Detailed Description

template<class 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<class T >

BaseHandler< T >::BaseHandler

(

)

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

Definition at line 230 of file BaseHandler.h.

References DEBUG, and logger.

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

template<class 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 244 of file BaseHandler.h.

References DEBUG, and logger.

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

template<class T >

BaseHandler< T >::~BaseHandler ( )

virtual

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

Definition at line 252 of file BaseHandler.h.

References DEBUG, and logger.

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

Member Function Documentation

template<class T>

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

virtual

Adds a new Object to the BaseHandler.

Parameters

[in]

O

A pointer to the object that must be added.

Reimplemented in WallHandler, ParticleHandler, BoundaryHandler, InteractionHandler, and SpeciesHandler.

Definition at line 284 of file BaseHandler.h.

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

{
    objects_.push_back(O);
    //Set the index of the particle
    getLastObject()->setIndex(getNumberOfObjects() - 1);
    //set the non changing particle identifier
    getLastObject()->setId(nextId_);
    //Update Id for next particle
    nextId_++;
    //Update the maximum number of Particles
    if (getNumberOfObjects() > maxObjects_)
        maxObjects_ = getNumberOfObjects();
}

template<class 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 482 of file BaseHandler.h.

Referenced by ChuteWithHopper::addHopper(), DPMBase::broadPhase(), DPMBase::checkInteractionWithBoundaries(), MercuryBase::checkParticleForInteraction(), DPMBase::checkParticleForInteraction(), DPMBase::computeAllForces(), DPMBase::computeForcesDueToWalls(), Chute::createBottom(), DPMBase::gatherContactStatistics(), DPMBase::getElasticEnergy(), DPMBase::getKineticEnergy(), MercuryBase::hGridActionsBeforeTimeStep(), MercuryBase::hGridRebuild(), HGridOptimiser::initialise(), DPMBase::integrateAfterForceComputation(), DPMBase::integrateBeforeForceComputation(), ChuteBottom::makeRoughBottom(), DPMBase::outputInteractionDetails(), DPMBase::readNextDataFile(), DPMBase::solve(), DPMBase::write(), DPMBase::writeEneTimestep(), and DPMBase::writeFstatHeader().

{
    return objects_.begin();
}

template<class 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 488 of file BaseHandler.h.

{
    return objects_.begin();
}

template<class T >

void BaseHandler< T >::clear

(

)

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.

Definition at line 360 of file BaseHandler.h.

Referenced by ParticleHandler::clear(), DPMBase::read(), DPMBase::readParAndIniFiles(), and ChuteBottom::setupInitialConditions().

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

template<class T >

template<class U >

U * BaseHandler< T >::copyAndAddObject

(

const U &

O

)

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

Parameters

[in]

O

A reference to the BaseHandler of which the objects have to be copied.

Definition at line 268 of file BaseHandler.h.

Referenced by ChuteWithHopper::addHopper(), MaserBoundary::addParticleToMaser(), InsertionBoundary::checkBoundaryBeforeTimeStep(), Chute::createBottom(), DPMBase::readNextDataFile(), DPMBase::readParAndIniFiles(), ChuteBottom::setupInitialConditions(), Chute::setupInitialConditions(), ChuteWithHopper::setupInitialConditions(), and Chute::setupSideWalls().

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

template<class T >

template<class U >

U * BaseHandler< T >::copyAndAddObject

(

U *

O

)

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

Parameters

[in]

O

A reference to the Object that has to be copied.

Definition at line 276 of file BaseHandler.h.

{
    U* oCopy = O->copy();
    addObject(oCopy);
    return oCopy;
}

template<class 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 259 of file BaseHandler.h.

References BaseHandler< T >::objects_.

{
    for (auto obj : BH.objects_) 
    {
        addObject(obj->copy());
    }
}

template<class 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 494 of file BaseHandler.h.

Referenced by ChuteWithHopper::addHopper(), DPMBase::checkInteractionWithBoundaries(), MercuryBase::checkParticleForInteraction(), DPMBase::checkParticleForInteraction(), DPMBase::computeAllForces(), DPMBase::computeForcesDueToWalls(), Chute::createBottom(), DPMBase::gatherContactStatistics(), DPMBase::getElasticEnergy(), DPMBase::getKineticEnergy(), MercuryBase::hGridActionsBeforeTimeStep(), MercuryBase::hGridRebuild(), HGridOptimiser::initialise(), DPMBase::integrateAfterForceComputation(), DPMBase::integrateBeforeForceComputation(), ChuteBottom::makeRoughBottom(), DPMBase::outputInteractionDetails(), DPMBase::readNextDataFile(), DPMBase::solve(), DPMBase::write(), DPMBase::writeEneTimestep(), and DPMBase::writeFstatHeader().

{
    return objects_.end();
}

template<class 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 500 of file BaseHandler.h.

{
    return objects_.end();
}

template<class 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 512 of file BaseHandler.h.

References ERROR, and logger.

Referenced by MaserBoundary::addParticleToMaser(), SlidingFrictionInteraction::computeFrictionForce(), FrictionInteraction::computeFrictionForce(), BaseInteraction::gatherContactStatistics(), ParticleSpecies::getMassFromRadius(), BaseParticle::getParticleDimensions(), BaseParticle::integrateBeforeForceComputation(), WallHandler::operator=(), ParticleHandler::ParticleHandler(), ParticleSpecies::setDensity(), BaseParticle::setIndSpecies(), BaseWall::setSpecies(), BaseParticle::setSpecies(), LeesEdwardsBoundary::shiftVerticalPosition(), SpeciesHandler::SpeciesHandler(), WallHandler::WallHandler(), and LeesEdwardsBoundary::write().

{
#ifdef NDEBUG
    return DPMBase_;
#else
    if (DPMBase_ == nullptr)
    {
        logger(ERROR, "[BaseHandler::getDPMBase()] in Object* %: pointer to DPMBase class is not set.", getName());
    }
    return DPMBase_;
#endif
}

template<class 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 526 of file BaseHandler.h.

References ERROR, and logger.

{
#ifdef NDEBUG
    return DPMBase_;
#else
    if (DPMBase_ == nullptr)
    {
        logger(ERROR, "[BaseHandler::getDPMBase() const] in Object* %: pointer to DPMBase class is not set.", getName());
    }
    return DPMBase_;
#endif
}

template<class 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 452 of file BaseHandler.h.

Referenced by LeesEdwardsBoundary::createVerticalPeriodicParticles(), and ChuteWithHopper::setupInitialConditions().

{
    return objects_.back();
}

template<class 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 458 of file BaseHandler.h.

{
    return objects_.back();
}

template<class 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, SpeciesHandler, WallHandler, and BoundaryHandler.

template<class T >

unsigned int BaseHandler< T >::getNumberOfObjects

(

)

const

Gets the number of Object in this BaseHandler.

Returns

The number of Objects in this BaseHandler.

Definition at line 464 of file BaseHandler.h.

Referenced by DPMBase::checkAndDuplicatePeriodicParticles(), DPMBase::checkSettings(), Chute::cleanChute(), MercuryBase::getHGridTargetMaxInteractionRadius(), MercuryBase::getHGridTargetMinInteractionRadius(), MercuryBase::getHGridTargetNumberOfBuckets(), MercuryBase::hGridNeedsRebuilding(), HGridOptimiser::initialise(), ChuteBottom::makeRoughBottom(), DPMBase::outputXBallsData(), Chute::printTime(), DPMBase::readNextDataFile(), DPMBase::removeDuplicatePeriodicParticles(), DPMBase::setFixedParticles(), ChuteBottom::setupInitialConditions(), Chute::setupInitialConditions(), and DPMBase::write().

{
    return objects_.size();
}

template<class 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 415 of file BaseHandler.h.

References ERROR, and logger.

Referenced by DPMBase::checkAndDuplicatePeriodicParticles(), Chute::cleanChute(), ChuteBottom::makeRoughBottom(), DPMBase::removeDuplicatePeriodicParticles(), DPMBase::setFixedParticles(), BaseWall::setHandler(), BaseParticle::setHandler(), BaseWall::setIndSpecies(), BaseParticle::setIndSpecies(), Chute::setupInitialConditions(), ChuteWithHopper::setupInitialConditions(), and DPMBase::write().

{
#ifdef NDEBUG
    return objects_[index];
#else
    if (index >= getNumberOfObjects())
    {
        logger(ERROR, "[BaseHandler::getObject(const unsigned int index)] in Object* %: Object couldn't be found because index (%) is higher than number of objects.", getName(), index);
        return nullptr;
    }
    else
    {
        return objects_[index];
    }
#endif
}

template<class 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 434 of file BaseHandler.h.

References ERROR, and logger.

{
#ifdef NDEBUG
    return objects_[index];
#else
    if (index >= getNumberOfObjects())
    {
        logger(ERROR, "[BaseHandler::getObject(const unsigned int index) const] in Object* %: No object exist with index % number of objects is %", getName(), index, getNumberOfObjects());
        return nullptr;
    }
    else
    {
        return objects_[index];
    }
#endif
}

template<class 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 394 of file BaseHandler.h.

References ERROR, and logger.

Referenced by InteractionHandler::readObject().

{
    // Usually, the id and the index into the backing storage matches
    // So check this postion 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;
    }
    logger(ERROR, "[BaseHandler::getObjectById()] in Object* %: Object with ID % could not be found.", getName(), id);
    return nullptr;
}

template<class T >

unsigned int BaseHandler< T >::getStorageCapacity

(

)

const

Gets the storage capacity of this BaseHandler.

Returns

The storage capacity of this BaseHandler.

Definition at line 470 of file BaseHandler.h.

{
    return objects_.capacity();
}

template<class 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 374 of file BaseHandler.h.

References helpers::getLineFromStringStream(), logger, and VERBOSE.

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

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

template<class T>

virtual void BaseHandler< T >::readObject ( 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, WallHandler, BoundaryHandler, InteractionHandler, and SpeciesHandler.

template<class T >

void BaseHandler< T >::removeLastObject

(

)

Removes the last Object from the BaseHandler.

Definition at line 345 of file BaseHandler.h.

References logger, and WARN.

Referenced by ParticleHandler::removeLastObject().

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

template<class T >

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

virtual

Removes an Object from the BaseHandler.

This methods removes a particle. This methods invalidates ANY iterators to particles 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.

Reimplemented in ParticleHandler, and SpeciesHandler.

Definition at line 303 of file BaseHandler.h.

References ERROR, and logger.

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

{
    if (index >= getNumberOfObjects())
    {
        logger(ERROR, "In: void %::removeOject(const unsigned int index) const, no object exists with index %, number of objects is %", getName(), index, getNumberOfObjects());
        return;
    }
    
    //Okay, this function deletes the particle. Now, the problem is that
    //particles store their position in the handler (@dducks: do they?)
    //which means that we would absolutely destroy performance if we took
    //something out in the middle. Now, what we'll do is swap our particle
    //with the last one (in case it already is, it is invariant); then
    //remove the last one.
    //So, we want the last index.
    std::size_t lastIndex = objects_.size() - 1;
  
    //So, step one, retrieve the pointer
    T* objectToDelete = objects_[index];

    if (index != lastIndex) //Are we not the last object?
    {
      //well.. let's swap.
      T* 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 _NOW_ we delete it.
    delete objectToDelete;
      
    //And clear it from the backing container.
    objects_.pop_back();
}

template<class T >

void BaseHandler< T >::setDPMBase

(

DPMBase *

DPMBase

)

Sets the problem that is solved using this handler.

Parameters

[in]

DPMBase

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

Definition at line 506 of file BaseHandler.h.

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

{
    DPMBase_ = DPMBase;
}

template<class 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 476 of file BaseHandler.h.

Referenced by DPMBase::constructor(), ChuteBottom::makeRoughBottom(), and ChuteBottom::setupInitialConditions().

{
    objects_.reserve(N);
}

Member Data Documentation

template<class 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 224 of file BaseHandler.h.

template<class 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 211 of file BaseHandler.h.

template<class T>

unsigned int BaseHandler< T >::nextId_

private

identifier for next object created

Definition at line 216 of file BaseHandler.h.

template<class 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 205 of file BaseHandler.h.

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

---

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

• BaseHandler.h