PossibleContact Class Reference

Class that describes a possible contact between two BaseParticle. More...

#include <PossibleContact.h>

Public Member Functions
	PossibleContact ()
	Default constructor, sets all pointers to nullptr. More...
	PossibleContact (BaseParticle *P1, BaseParticle *P2)
	Constructor that takes two BaseParticle and sets them to be the BaseParticle associated with this PossibleContact. More...
	PossibleContact (BaseParticle *P1, BaseParticle *P2, PossibleContact *Next)
	Constructor that takes two BaseParticle and the next global PossibleContact in the list and constructs a PossibleContact from that. More...
	PossibleContact (BaseParticle *P1, BaseParticle *P2, PossibleContact *Next, PossibleContact *Next1, PossibleContact *Next2)
	Constructor that should be used, takes all required information as parameters and sets it in the data-members. More...
BaseParticle *	getP1 ()
	Gets a pointer to the first BaseParticle in this PossibleContact. More...
BaseParticle *	getP2 ()
	Gets a pointer to the second BaseParticle in this PossibleContact. More...
BaseParticle *	getOtherParticle (BaseParticle *P)
	Given one BaseParticle of the interacting pair, this function gets the other. More...
PossibleContact *	getNext ()
	Gets the next PossibleContact in the general linked list of PossibleContact. More...
PossibleContact *	getNext (BaseParticle *P)
	Gets the next PossibleContact in the linked list of PossibleContact of the given particle. More...
PossibleContact *	getPrevious ()
	Gets the previous PossibleContact in the general linked list of PossibleContact. More...
PossibleContact *	getPrevious (BaseParticle *P)
	Gets the previous PossibleContact in the linked list of PossibleContact of the given particle. More...
PossibleContact *	getNext1 ()
	Gets the next PossibleContact in the linked list of PossibleContact of the first particle in this PossibleContact. More...
PossibleContact *	getPrevious1 ()
	Gets the previous PossibleContact in the linked list of PossibleContact of the first particle in this PossibleContact. More...
PossibleContact *	getNext2 ()
	Gets the next PossibleContact in the linked list of PossibleContact of the second particle in this PossibleContact. More...
PossibleContact *	getPrevious2 ()
	Gets the previous PossibleContact in the linked list of PossibleContact of the second particle in this PossibleContact. More...
int	getIndex ()
	Gets the index of this PossibleContact. More...
void	setP1 (BaseParticle *P1)
	Sets the first particle in this PossibleContact. More...
void	setP2 (BaseParticle *P2)
	Sets the second particle in this PossibleContact. More...
void	setNextPosition (PossibleContact *Next)
	Sets the next PossibleContact in the linked list of PossibleContac. More...
void	setNextPosition (BaseParticle *P, PossibleContact *Next)
	Sets the next PossibleContact in the linked list of PossibleContact of the given particle. More...
void	setPreviousPosition (PossibleContact *Prev)
	Sets the previous PossibleContact in the linked list of PossibleContact of the given particle. More...
void	setPreviousPosition (BaseParticle *P, PossibleContact *Prev)
	Sets the previous PossibleContact in the linked list of PossibleContact of the given particle. More...
void	setNextPosition1 (PossibleContact *Next1)
	Sets the next PossibleContact in the linked list of PossibleContact of the first particle in this PossibleContact. More...
void	setPreviousPosition1 (PossibleContact *Prev1)
	Sets the previous PossibleContact in the linked list of PossibleContact of the first particle in this PossibleContact. More...
void	setNextPosition2 (PossibleContact *Next2)
	Sets the next PossibleContact in the linked list of PossibleContact of the second particle in this PossibleContact. More...
void	setPreviousPosition2 (PossibleContact *Prev2)
	Sets the previous PossibleContact in the linked list of PossibleContact of the second particle in this PossibleContact. More...

Private Attributes
int	index_
	The index of this PossibleContact. More...
BaseParticle *	P1_
	A pointer to the first BaseParticle in this PossibleContact. More...
BaseParticle *	P2_
	A pointer to the second BaseParticle in this PossibleContact. More...
PossibleContact *	Next_
	A pointer to the PossibleContact that comes after this one in the linked list. More...
PossibleContact *	Prev_
	A pointer to the PossibleContact that comes before this one in the linked list. More...
PossibleContact *	Next1_
	A pointer to the PossibleContact that comes after this one in the linked list associated with the first BaseParticle of this PossibleContact. More...
PossibleContact *	Prev1_
	A pointer to the PossibleContact that comes before this one in the linked list associated with the first BaseParticle of this PossibleContact. More...
PossibleContact *	Next2_
	A pointer to the PossibleContact that comes after this one in the linked list associated with the second BaseParticle of this PossibleContact. More...
PossibleContact *	Prev2_
	A pointer to the PossibleContact that comes before this one in the linked list associated with the second BaseParticle of this PossibleContact. More...

Friends
std::ostream &	operator<< (std::ostream &os, const PossibleContact &o)
	Writes the index of this PossibleContact and the indices of the BaseParticle of this PossibleContact to the given ostream. More...

Detailed Description

Class that describes a possible contact between two BaseParticle.

In this class that describes a possible contact two BaseParticle we save both of these BaseParticle, the index of this PossibleContact and the PossibleContact that comes before and after this one in the linked list, both for the general list and the list for each of the particles.

Todo:

Change the names so that they follow the code guidelines.

Definition at line 41 of file PossibleContact.h.

Constructor & Destructor Documentation

PossibleContact::PossibleContact ( )

inline

Default constructor, sets all pointers to nullptr.

Definition at line 47 of file PossibleContact.h.

References index_, Next1_, Next2_, Next_, P1_, P2_, Prev1_, Prev2_, and Prev_.

    {
        P1_ = nullptr;
        P2_ = nullptr;
        Next_ = nullptr;
        Prev_ = nullptr;
        Next1_ = nullptr;
        Prev1_ = nullptr;
        Next2_ = nullptr;
        Prev2_ = nullptr;
        index_ = 0;
    }

PossibleContact::PossibleContact ( BaseParticle *  P1, BaseParticle *  P2  )

inline

Constructor that takes two BaseParticle and sets them to be the BaseParticle associated with this PossibleContact.

Parameters

[in]	P1	A pointer to the first BaseParticle in this PossibleContact.
[in]	P2	A pointer to the second BaseParticle in this PossibleContact.

Definition at line 65 of file PossibleContact.h.

References index_, Next1_, Next2_, Next_, P1_, P2_, Prev1_, Prev2_, and Prev_.

    {
        P1_ = P1;
        P2_ = P2;
        Next_ = nullptr;
        Prev_ = nullptr;
        Next1_ = nullptr;
        Prev1_ = nullptr;
        Next2_ = nullptr;
        Prev2_ = nullptr;
        index_ = 0;
    }

PossibleContact::PossibleContact ( BaseParticle *  P1, BaseParticle *  P2, PossibleContact *  Next  )

inline

Constructor that takes two BaseParticle and the next global PossibleContact in the list and constructs a PossibleContact from that.

Parameters

[in]	P1	A pointer to the first BaseParticle in this PossibleContact.
[in]	P2	A pointer to the second BaseParticle in this PossibleContact.
[in]	Next	A pointer to the PossibleContact that comes after this one in the linked list.

Definition at line 84 of file PossibleContact.h.

References getIndex(), index_, Next1_, Next2_, Next_, P1_, P2_, Prev1_, Prev2_, and Prev_.

    {
        P1_ = P1;
        P2_ = P2;
        Next_ = Next;
        Prev_ = nullptr;
        if (Next != nullptr)
            index_ = Next->getIndex() + 1;
        else
            index_ = 0;
        
        Next1_ = nullptr;
        Prev1_ = nullptr;
        Next2_ = nullptr;
        Prev2_ = nullptr;
    }

PossibleContact::PossibleContact ( BaseParticle *  P1, BaseParticle *  P2, PossibleContact *  Next, PossibleContact *  Next1, PossibleContact *  Next2  )

inline

Constructor that should be used, takes all required information as parameters and sets it in the data-members.

Parameters

[in]	P1	A pointer to the first BaseParticle in this PossibleContact.
[in]	P2	A pointer to the second BaseParticle in this PossibleContact.
[in]	Next	A pointer to the PossibleContact that comes after this one in the linked list.
[in]	Next1	A pointer to the PossibleContact that comes after this one in the linked list associated with the first BaseParticle of this PossibleContact.
[in]	Next2	A pointer to the PossibleContact that comes after this one in the linked list associated with the second BaseParticle of this PossibleContact.

Definition at line 109 of file PossibleContact.h.

References getIndex(), index_, Next1_, Next2_, Next_, P1_, P2_, Prev1_, Prev2_, and Prev_.

    {
        P1_ = P1;
        P2_ = P2;
        Next_ = Next;
        Next1_ = Next1;
        Next2_ = Next2;
        Prev_ = 0;
        Prev1_ = 0;
        Prev2_ = 0;
        if (Next != nullptr)
            index_ = Next->getIndex() + 1;
        else
            index_ = 0;
    }

Member Function Documentation

int PossibleContact::getIndex ( )

inline

Gets the index of this PossibleContact.

Returns

The index of this PossibleContact.

Definition at line 255 of file PossibleContact.h.

References index_.

Referenced by PossibleContact(), and PossibleContactList::remove_ParticlePosibleContacts().

    {
        return index_;
    }

PossibleContact* PossibleContact::getNext ( )

inline

Gets the next PossibleContact in the general linked list of PossibleContact.

Returns

A pointer to the next PossibleContact in the linked list.

Definition at line 165 of file PossibleContact.h.

References Next_.

Referenced by PossibleContactList::add_PossibleContact(), DPMBase::computeAllForces(), PossibleContactList::remove_ParticlePosibleContacts(), and PossibleContactList::write().

    {
        return Next_;
    }

PossibleContact* PossibleContact::getNext ( BaseParticle *  P )

inline

Gets the next PossibleContact in the linked list of PossibleContact of the given particle.

Parameters

[in]

P

A pointer to the BaseParticle for which we want to have the next contact of.

Returns

A pointer to the next PossibleContact in the linked list of PossibleContact of the given particle.

Definition at line 175 of file PossibleContact.h.

References BaseObject::getIndex(), logger, Next1_, Next2_, P1_, P2_, and WARN.

    {
        if (P1_ == P)
            return Next1_;
        else if (P2_ == P)
            return Next2_;
        else
        {
            logger(WARN, "PossibleContact* getNext(Particle* P), no match for %. Possibilities are % and %.", P->getIndex(), P1_->getIndex(), P2_->getIndex());
            return nullptr;
        }
    }

PossibleContact* PossibleContact::getNext1 ( )

inline

Gets the next PossibleContact in the linked list of PossibleContact of the first particle in this PossibleContact.

Returns

A pointer to the next PossibleContact in the linked list of PossibleContact of the first particle in this PossibleContact.

Definition at line 219 of file PossibleContact.h.

References Next1_.

Referenced by PossibleContactList::add_PossibleContact().

    {
        return Next1_;
    }

PossibleContact* PossibleContact::getNext2 ( )

inline

Gets the next PossibleContact in the linked list of PossibleContact of the second particle in this PossibleContact.

Returns

A pointer to the next PossibleContact in the linked list of PossibleContact of the second particle in this PossibleContact.

Definition at line 237 of file PossibleContact.h.

References Next2_.

Referenced by PossibleContactList::add_PossibleContact().

    {
        return Next2_;
    }

BaseParticle* PossibleContact::getOtherParticle ( BaseParticle *  P )

inline

Given one BaseParticle of the interacting pair, this function gets the other.

Parameters

[in]

P

A pointer to one of the BaseParticle of this PossibleContact.

Returns

The other BaseParticle of this PossibleContact.

Definition at line 148 of file PossibleContact.h.

References BaseObject::getIndex(), P1_, and P2_.

Referenced by PossibleContactList::remove_ParticlePosibleContacts().

    {
        if (P1_ == P)
            return P2_;
        else if (P2_ == P)
            return P1_;
        else
        {
            std::cout << "Particle* getOtherParticle(Particle *P), no match for " << P->getIndex() << " posibilities are " << P1_->getIndex() << " and " << P2_->getIndex() << std::endl;
            return nullptr;
        }
    }

BaseParticle* PossibleContact::getP1 ( )

inline

Gets a pointer to the first BaseParticle in this PossibleContact.

Returns

A pointer to the first BaseParticle in this PossibleContact.

Definition at line 129 of file PossibleContact.h.

References P1_.

Referenced by DPMBase::computeAllForces(), and PossibleContactList::remove_ParticlePosibleContacts().

    {
        return P1_;
    }

BaseParticle* PossibleContact::getP2 ( )

inline

Gets a pointer to the second BaseParticle in this PossibleContact.

Returns

A pointer to the second BaseParticle in this PossibleContact.

Definition at line 138 of file PossibleContact.h.

References P2_.

Referenced by DPMBase::computeAllForces(), and PossibleContactList::remove_ParticlePosibleContacts().

    {
        return P2_;
    }

PossibleContact* PossibleContact::getPrevious ( )

inline

Gets the previous PossibleContact in the general linked list of PossibleContact.

Returns

A pointer to the previous PossibleContact in the general linked list of PossibleContact.

Definition at line 192 of file PossibleContact.h.

References Prev_.

Referenced by PossibleContactList::remove_ParticlePosibleContacts().

    {
        return Prev_;
    }

PossibleContact* PossibleContact::getPrevious ( BaseParticle *  P )

inline

Gets the previous PossibleContact in the linked list of PossibleContact of the given particle.

Parameters

[in]

P

A pointer to the BaseParticle we want to know the previous PossibleContact for.

Returns

A pointer to the previous PossibleContact in the linked list of PossibleContact of the given particle.

Definition at line 202 of file PossibleContact.h.

References BaseObject::getIndex(), logger, P1_, P2_, Prev1_, Prev2_, and WARN.

    {
        if (P1_ == P)
            return Prev1_;
        else if (P2_ == P)
            return Prev2_;
        else
        {
            logger(WARN, "PossibleContact* getPrevious(Particle* P), no match for %. Possibilities are % and %.", P->getIndex(), P1_->getIndex(), P2_->getIndex());
            return nullptr;
        }
    }

PossibleContact* PossibleContact::getPrevious1 ( )

inline

Gets the previous PossibleContact in the linked list of PossibleContact of the first particle in this PossibleContact.

Returns

A pointer to the previous PossibleContact in the linked list of PossibleContact of the first particle in this PossibleContact.

Definition at line 228 of file PossibleContact.h.

References Prev1_.

    {
        return Prev1_;
    }

PossibleContact* PossibleContact::getPrevious2 ( )

inline

Gets the previous PossibleContact in the linked list of PossibleContact of the second particle in this PossibleContact.

Returns

A pointer to the previous PossibleContact in the linked list of PossibleContact of the second particle in this PossibleContact.

Definition at line 246 of file PossibleContact.h.

References Prev2_.

    {
        return Prev2_;
    }

void PossibleContact::setNextPosition ( PossibleContact *  Next )

inline

Sets the next PossibleContact in the linked list of PossibleContac.

Parameters

[in]

Next

A pointer to the PossibleContact which is the next PossibleContact in the linked list of PossibleContact

Definition at line 282 of file PossibleContact.h.

References Next_.

Referenced by PossibleContactList::remove_ParticlePosibleContacts().

    {
        Next_ = Next;
    }

void PossibleContact::setNextPosition ( BaseParticle *  P, PossibleContact *  Next  )

inline

Sets the next PossibleContact in the linked list of PossibleContact of the given particle.

Parameters

[in]	P	A pointer to the BaseParticle for which the next PossibleContact in the linked list must be set for.
[in]	Next	A pointer to the PossibleContact which is the next PossibleContact for the given BaseParticle.

Definition at line 292 of file PossibleContact.h.

References BaseObject::getIndex(), logger, Next1_, Next2_, P1_, P2_, and WARN.

    {
        if (P1_ == P)
            Next1_ = Next;
        else if (P2_ == P)
            Next2_ = Next;
        else
            logger(WARN, "void setNextPosition(Particle* P,PossibleContact* Next), no match for %. Possibilities are %  and % ", P->getIndex(), P1_->getIndex(), P2_->getIndex());
    }

void PossibleContact::setNextPosition1 ( PossibleContact *  Next1 )

inline

Sets the next PossibleContact in the linked list of PossibleContact of the first particle in this PossibleContact.

Parameters

[in]

Next1

A pointer to the PossibleContact which is the next PossibleContact for the first BaseParticle.

Definition at line 330 of file PossibleContact.h.

References Next1_.

    {
        Next1_ = Next1;
    }

void PossibleContact::setNextPosition2 ( PossibleContact *  Next2 )

inline

Sets the next PossibleContact in the linked list of PossibleContact of the second particle in this PossibleContact.

Parameters

[in]

Next2

A pointer to the PossibleContact which is the next PossibleContact for the second BaseParticle.

Definition at line 348 of file PossibleContact.h.

References Next2_.

    {
        Next2_ = Next2;
    }

void PossibleContact::setP1 ( BaseParticle *  P1 )

inline

Sets the first particle in this PossibleContact.

Parameters

[in]

P1

A pointer to the BaseParticle that must be set as the first BaseParticle.

Definition at line 264 of file PossibleContact.h.

References P1_.

    {
        P1_ = P1;
    }

void PossibleContact::setP2 ( BaseParticle *  P2 )

inline

Sets the second particle in this PossibleContact.

Parameters

[in]

P2

A pointer to the BaseParticle that must be set as the second BaseParticle.

Definition at line 273 of file PossibleContact.h.

References P2_.

    {
        P2_ = P2;
    }

void PossibleContact::setPreviousPosition ( PossibleContact *  Prev )

inline

Sets the previous PossibleContact in the linked list of PossibleContact of the given particle.

Parameters

[in]

Prev

A pointer to the PossibleContact which is the previous PossibleContact in the linked list of PossibleContact

Definition at line 306 of file PossibleContact.h.

References Prev_.

Referenced by PossibleContactList::add_PossibleContact(), and PossibleContactList::remove_ParticlePosibleContacts().

    {
        Prev_ = Prev;
    }

void PossibleContact::setPreviousPosition ( BaseParticle *  P, PossibleContact *  Prev  )

inline

Sets the previous PossibleContact in the linked list of PossibleContact of the given particle.

Parameters

[in]	P	A pointer to the BaseParticle for which the previous PossibleContact in the linked list must be set for.
[in]	Prev	A pointer to the PossibleContact which is the previous PossibleContact for the given BaseParticle.

Definition at line 316 of file PossibleContact.h.

References BaseObject::getIndex(), logger, P1_, P2_, Prev1_, Prev2_, and WARN.

    {
        if (P1_ == P)
            Prev1_ = Prev;
        else if (P2_ == P)
            Prev2_ = Prev;
        else
            logger(WARN, "void setPreviousPosition(Particle* P,PossibleContact* Prev), no match for %. Possibilities are %  and % ", P->getIndex(), P1_->getIndex(), P2_->getIndex());            
    }

void PossibleContact::setPreviousPosition1 ( PossibleContact *  Prev1 )

inline

Sets the previous PossibleContact in the linked list of PossibleContact of the first particle in this PossibleContact.

Parameters

[in]

Prev1

A pointer to the PossibleContact which is the previous PossibleContact for the first BaseParticle.

Definition at line 339 of file PossibleContact.h.

References Prev1_.

    {
        Prev1_ = Prev1;
    }

void PossibleContact::setPreviousPosition2 ( PossibleContact *  Prev2 )

inline

Sets the previous PossibleContact in the linked list of PossibleContact of the second particle in this PossibleContact.

Parameters

[in]

Prev2

A pointer to the PossibleContact which is the previous PossibleContact for the second BaseParticle.

Definition at line 357 of file PossibleContact.h.

References Prev2_.

    {
        Prev2_ = Prev2;
    }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const PossibleContact &  o  )

friend

Writes the index of this PossibleContact and the indices of the BaseParticle of this PossibleContact to the given ostream.

Parameters

[in,out]	os	The output stream to which this PossibleContact must be written.
[in]	o	The PossibleContact that must be written.

Returns

The output stream to which this PossibleContact has been written.

Definition at line 368 of file PossibleContact.h.

    {
        os<<o.index_<<" between ("<<o.P1_->getIndex()<<","<<o.P2_->getIndex()<<")";
        return os;
    }

Member Data Documentation

int PossibleContact::index_

private

The index of this PossibleContact.

Definition at line 378 of file PossibleContact.h.

Referenced by getIndex(), and PossibleContact().

PossibleContact* PossibleContact::Next1_

private

A pointer to the PossibleContact that comes after this one in the linked list associated with the first BaseParticle of this PossibleContact.

Definition at line 398 of file PossibleContact.h.

Referenced by getNext(), getNext1(), PossibleContact(), setNextPosition(), and setNextPosition1().

PossibleContact* PossibleContact::Next2_

private

A pointer to the PossibleContact that comes after this one in the linked list associated with the second BaseParticle of this PossibleContact.

Definition at line 406 of file PossibleContact.h.

Referenced by getNext(), getNext2(), PossibleContact(), setNextPosition(), and setNextPosition2().

PossibleContact* PossibleContact::Next_

private

A pointer to the PossibleContact that comes after this one in the linked list.

Definition at line 390 of file PossibleContact.h.

Referenced by getNext(), PossibleContact(), and setNextPosition().

BaseParticle* PossibleContact::P1_

private

A pointer to the first BaseParticle in this PossibleContact.

Definition at line 382 of file PossibleContact.h.

Referenced by getNext(), getOtherParticle(), getP1(), getPrevious(), PossibleContact(), setNextPosition(), setP1(), and setPreviousPosition().

BaseParticle* PossibleContact::P2_

private

A pointer to the second BaseParticle in this PossibleContact.

Definition at line 386 of file PossibleContact.h.

Referenced by getNext(), getOtherParticle(), getP2(), getPrevious(), PossibleContact(), setNextPosition(), setP2(), and setPreviousPosition().

PossibleContact* PossibleContact::Prev1_

private

A pointer to the PossibleContact that comes before this one in the linked list associated with the first BaseParticle of this PossibleContact.

Definition at line 402 of file PossibleContact.h.

Referenced by getPrevious(), getPrevious1(), PossibleContact(), setPreviousPosition(), and setPreviousPosition1().

PossibleContact* PossibleContact::Prev2_

private

A pointer to the PossibleContact that comes before this one in the linked list associated with the second BaseParticle of this PossibleContact.

Definition at line 410 of file PossibleContact.h.

Referenced by getPrevious(), getPrevious2(), PossibleContact(), setPreviousPosition(), and setPreviousPosition2().

PossibleContact* PossibleContact::Prev_

private

A pointer to the PossibleContact that comes before this one in the linked list.

Definition at line 394 of file PossibleContact.h.

Referenced by getPrevious(), PossibleContact(), and setPreviousPosition().

---

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

• PossibleContact.h