Variation on the PeriodicBoundary with maser-like properties. More...

#include <MaserBoundary.h>

Inheritance diagram for MaserBoundary:

Public Member Functions
MaserBoundary *	copy () const
	Creates a copy on the heap. More...

void	set (Vec3D normal, Mdouble distanceLeft, Mdouble distanceRight)
	Sets all boundary properties at once. More...

void	read (std::istream &is)
	reads boundary properties from istream More...

void	write (std::ostream &os) const
	writes boundary properties to ostream More...

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

Mdouble	getDistance (BaseParticle &p)
	Returns the distance of the wall to the particle. More...

Mdouble	getDistance (const Vec3D &position)
	Returns the distance of the wall to the position. More...

void	shiftPosition (BaseParticle *p)
	shifts the particle to its 'periodic' position More...

void	createPeriodicParticles (BaseParticle *p, ParticleHandler &pH)
	Creates periodic particle when the particle is a maser particle and is sufficiently close to one of the boundary walls. More...

bool	checkBoundaryAfterParticleMoved (BaseParticle *p, ParticleHandler &pH UNUSED)
	Shifts the particle to its 'periodic' position if it is a maser particle and has crossed either of the walls. Creates a 'normal' particle at its current position if it is a maser particle which crossed the RIGHT boundary wall. More...

void	addParticleToMaser (BaseParticle *P)
	Converts a 'normal' particle into a maser particle. More...

Public Member Functions inherited from BaseBoundary
	BaseBoundary ()
	default constructor. More...

	BaseBoundary (const BaseBoundary &b)
	copy constructor More...

virtual	~BaseBoundary ()
	destructor More...

virtual void	createPeriodicParticles (BaseParticle *P UNUSED, ParticleHandler &pH UNUSED)
	Creates periodic copies of given particle in case of periodic boundaries. More...

virtual bool	checkBoundaryAfterParticleMoved (BaseParticle *P UNUSED, ParticleHandler &pH UNUSED)
	Checks if given particle passed the boundary. More...

virtual void	checkBoundaryBeforeTimeStep (DPMBase *md UNUSED)
	Fills a (3D) boundary with particles. More...

void	setHandler (BoundaryHandler *handler)
	Sets the boundary's BoundaryHandler. More...

BoundaryHandler *	getHandler () const
	Returns the boundary's BoundaryHandler. More...

Public Member Functions inherited from BaseObject
	BaseObject ()
	Default constructor. More...

	BaseObject (const BaseObject &p)
	Copy constructor, copies all the objects BaseObject contains. More...

virtual	~BaseObject ()
	virtual destructor More...

virtual void	moveInHandler (const unsigned int index)
	Except that it is virtual, it does the same thing as setIndex() does. More...

void	setIndex (const unsigned int index)
	Allows one to assign an index to an object in the handler/container. More...

void	setId (const unsigned int id)
	Assigns a unique identifier to each object in the handler (container) which remains constant even after the object is deleted from the container/handler. More...

unsigned int	getIndex () const
	Returns the index of the object in the handler. More...

unsigned int	getId () const
	Returns the unique identifier of any particular object. More...

Private Attributes
Vec3D	normal_
	Normal unit vector of both maser walls. Points in the flowing direction. More...

Mdouble	distanceLeft_
	position of left boundary wall, s.t. normal*x=position_left More...

Mdouble	distanceRight_
	position of right boundary wall, s.t. normal*x=position_right More...

bool	closestToLeftBoundary_
	Dummy variable used when checking the proximity of particles to the boundary walls. TRUE if closest wall is the left boundary wall. More...

Vec3D	shift_
	Direction in which particles are to be shifted when they cross the boundary. More...

std::map< const ParticleSpecies , const ParticleSpecies >	speciesConversionNormalToMaser_
	List of 'normal' particles' species, and their maser counterparts. More...

std::map< const ParticleSpecies , const ParticleSpecies >	speciesConversionMaserToNormal_
	List of 'maser' particles' species, and their normal counterparts. More...

Detailed Description

Variation on the PeriodicBoundary with maser-like properties.

Creates a boundary which is similar to a PeriodicBoundary, except that particles which leave

Definition at line 44 of file MaserBoundary.h.

Member Function Documentation

void MaserBoundary::addParticleToMaser ( BaseParticle * P )

Converts a 'normal' particle into a maser particle.

Turns given particle into a 'maser particle' by changing its species into a 'maser particle' copy species. If the particle species is not yet in the std::map speciesConversionNormalToMaser_, it and its maser copy species are added. This function should be called at the beginning of the simulation, right after actually filling the maser with particles, flagging each particle as one belonging to the maser.

Parameters

[in,out] P The particle which is added to the maser. Its species is 'changed' to the maser copy species.

Definition at line 277 of file MaserBoundary.cc.

References ParticleSpecies::copy(), BaseHandler< T >::copyAndAddObject(), BaseHandler< T >::getDPMBase(), BaseBoundary::getHandler(), BaseInteractable::getSpecies(), INFO, logger, BaseParticle::setSpecies(), speciesConversionMaserToNormal_, speciesConversionNormalToMaser_, and DPMBase::speciesHandler.

 {
     // check if particle species already known by the maser
     auto conversion = speciesConversionNormalToMaser_.find(P->getSpecies());
     if (conversion == speciesConversionNormalToMaser_.end())
     {
         // nope: species has to be added to the list
         ParticleSpecies* newSpecies = getHandler()->getDPMBase()->speciesHandler.copyAndAddObject(P->getSpecies()->copy());
         speciesConversionNormalToMaser_.insert(std::pair<const ParticleSpecies*, const ParticleSpecies*>(P->getSpecies(), newSpecies));
         speciesConversionMaserToNormal_.insert(std::pair<const ParticleSpecies*, const ParticleSpecies*>(newSpecies, P->getSpecies()));
         logger(INFO,"[MaserBoundary::addParticleToMaser()] New species conversion created");
         
         // now the species IS added, so flag (convert) it!
         P->setSpecies(newSpecies);
     }
     else
     {
         // yep: species known and flagged (i.e. 'converted')
         logger(INFO,"[MaserBoundary::addParticleToMaser()] Species conversion already present");
         P->setSpecies(conversion->second);
     }
 }

bool MaserBoundary::checkBoundaryAfterParticleMoved	(	BaseParticle *	P,
		ParticleHandler &pH	UNUSED
	)

Shifts the particle to its 'periodic' position if it is a maser particle and has crossed either of the walls. Creates a 'normal' particle at its current position if it is a maser particle which crossed the RIGHT boundary wall.

Checks whether given particle has crossed the closest wall, and if so, shifts its position so as to have it appear at the other wall

Parameters

[in]	p	The particle to be checked and possibly shifted
	pH	The ParticleHandler, which is unused in this implementation

Returns: ALWAYS returns FALSE for periodic boundaries. Only returns TRUE when particle gets actually deleted, e.g. in certain DeletionBoundary implementations.

Todo:

Apparently, somewhere in the ages past, at some time, there has existed a piece of code which prevents the particles crossing the periodic boundary on the left side from reappearing on the right. This was taken out somewhere between the dark ages an the current one (feb. 2015) and should be put back in. Only causes errors very rarely, and not in the compiler but rather in the actual physics going on (So its not detected by the MaserSelfTest). The current arrangement mainly causes problems with particles which oscillate on the boundary, continuously crossing from left to right and back. A visual consideration of this problem can be found in Documentation/Images/Maser_unperiodic_behaviour.jpg, which, granted, is appalling in its own right, but has yet to suffice in awaitance of a better (i.e. clearer) drawing. Therefore:

Create a new diagram explaining the problems with the previous (NOW: CURRENT!) implementation, and the exact differences between the two. I.e., an improved version of Documentation/Images/Maser_unperiodic_behaviour.jpg. (BvdH)

Definition at line 235 of file MaserBoundary.cc.

References getDistance(), BaseInteractable::getSpecies(), shiftPosition(), and speciesConversionMaserToNormal_.

 {
     // check if particle passed either of the boundary walls
     if (getDistance(*P) < 0)
     {
         // check if species is found in the list of maser particle species
         auto conversion = speciesConversionMaserToNormal_.find(P->getSpecies());
         if (conversion != speciesConversionMaserToNormal_.end()) //Test if it is a maser particle
         {
             // yes: shift it periodically!
             shiftPosition(P);
             
             /*
             // check if to be shifted leftward or rightward. Now done by MaserBoundary::shiftPosition().
             if (closestToLeftBoundary_)
             {
                 P->move(shift_);
                 closestToLeftBoundary_ = false;
             }
             else
             {
                 P->move(-shift_);
                 closestToLeftBoundary_ = true;
                 //BaseParticle* pCopy = pH.copyAndAddObject(P);
                 //pCopy->setIndSpecies(conversion->second);
             }
              */
         }
     }
     return false;
 }

MaserBoundary * MaserBoundary::copy ( ) const

virtual

Creates a copy on the heap.

Copy method, creates a copy of the object on the heap and returns a pointer to it.

Returns: pointer to the copy

Implements BaseBoundary.

Definition at line 40 of file MaserBoundary.cc.

 {
     return new MaserBoundary(*this);
 }

void MaserBoundary::createPeriodicParticles	(	BaseParticle *	P,
		ParticleHandler &	pH
	)

Creates periodic particle when the particle is a maser particle and is sufficiently close to one of the boundary walls.

Checks the distance of given particle to the closest of both walls, and creates a periodic copy of the particle if needed (i.e. if the particle is closer to the periodic wall than the radius of the largest particle in the system).

Parameters

[in]	P	Particle to be checked and possibly periodically copied
[in,out]	pH	System's ParticleHandler, (1) from which the interaction radius of its largest particle is retrieved to determine the maximum distance from the wall at which a particle should still have a periodic copy created, and (2) to which a possible periodic copy of the particle will be added

Todo:: The code has not implemented the actual outflow of 'normal' particles from the right boundary wall. I.e., the maser now is 'simply' a normal Periodic Boundary, with a lot of potential ;). I think the 'original author' planned to implement the outflow below, which is still left to be done. (BvdH) NB: a better place would be in the MaserBoundary::shiftPosition() or MaserBoundary::checkBoundaryAfterParticleMoved() method, which are called when the particles actually cross either of the boundary walls.

Definition at line 164 of file MaserBoundary.cc.

References ParticleHandler::addObject(), closestToLeftBoundary_, BaseParticle::copy(), BaseInteractable::copyInteractionsForPeriodicParticles(), getDistance(), BaseParticle::getInteractionRadius(), ParticleHandler::getLargestParticle(), BaseParticle::getPeriodicFromParticle(), BaseInteractable::getSpecies(), BaseParticle::setPeriodicFromParticle(), shiftPosition(), and speciesConversionMaserToNormal_.

 {
     // check if particle is close to either of the boundary walls
     if (getDistance(*P) < P->getInteractionRadius() + pH.getLargestParticle()->getInteractionRadius())
     {
         auto conversion = speciesConversionMaserToNormal_.find(P->getSpecies());
         if (conversion != speciesConversionMaserToNormal_.end()) //Test if it is a maser particle
         {
             // Copy the particle if it IS a maser particle
             BaseParticle* F0 = P->copy();
             F0->copyInteractionsForPeriodicParticles(*P);
             
             // shift to the periodic location
             shiftPosition(F0);
 
             //Set the 'from' particle. If Particle is multiply shifted, get correct original particle
             BaseParticle* From = P;
             while (From->getPeriodicFromParticle() != nullptr)
             {
                 From = From->getPeriodicFromParticle();
             }
             F0->setPeriodicFromParticle(From);
             
             // add the periodic particle to the handler
             pH.addObject(F0);
             
             if (closestToLeftBoundary_)
             {   
             }
             else
             {
             }
         }
     }
 }

Mdouble MaserBoundary::getDistance ( BaseParticle & p )

Returns the distance of the wall to the particle.

Returns the distance to the closest wall of the boundary to the particle, , and sets closestToLeftBoundary_ = true if the left wall is the wall closest to the particle.

Parameters

[in] p A reference to the particle of which the distance to the boundary wall is to be calculated

Definition at line 93 of file MaserBoundary.cc.

References BaseInteractable::getPosition().

Referenced by checkBoundaryAfterParticleMoved(), and createPeriodicParticles().

 {
     return getDistance(p.getPosition());
 }

Mdouble MaserBoundary::getDistance ( const Vec3D & position )

Returns the distance of the wall to the position.

Returns the distance to the wall closest to the position, and sets closestToLeftBoundary_ = true if the left wall is the wall closest to the position.

Parameters

[in] position (A reference to) the position of which the distance to the boundary wall is to be calculated

Definition at line 104 of file MaserBoundary.cc.

References closestToLeftBoundary_, distanceLeft_, distanceRight_, Vec3D::dot(), and normal_.

 {
     Mdouble distance = Vec3D::dot(position, normal_);
 
     if (distance - distanceLeft_ < distanceRight_ - distance)
     {
         closestToLeftBoundary_ = true;
         return distance - distanceLeft_;
     }
     else
     {
         closestToLeftBoundary_ = false;
         return distanceRight_ - distance;
     }
 }

std::string MaserBoundary::getName ( ) const

virtual

Returns the name of the object.

Returns the name of the object class

Returns: the object's class' name, i.e. 'MaserBoundary'

Implements BaseObject.

Definition at line 82 of file MaserBoundary.cc.

 {
     return "MaserBoundary";
 }

void MaserBoundary::read ( std::istream & is )

virtual

reads boundary properties from istream

Reads the boundary properties from an istream

Parameters

[in,out] is the istream

Implements BaseBoundary.

Definition at line 64 of file MaserBoundary.cc.

References BaseBoundary::read().

 {
     BaseBoundary::read(is);
 }

void MaserBoundary::set	(	Vec3D	normal,
		Mdouble	distanceLeft,
		Mdouble	distanceRight
	)

Sets all boundary properties at once.

Set all the properties of the boundary at once.

Parameters

[in]	normal	Normal unit vector of the (parallel) boundary walls
[in]	distanceLeft	The distance of the left wall to the origin
[in]	distanceRight	The distance of the right wall to the origin

Definition at line 51 of file MaserBoundary.cc.

References distanceLeft_, distanceRight_, normal_, and shift_.

 {
     // factor is used to set normal to unit length
     normal_ = normal;
     distanceLeft_ = distanceLeft;
     distanceRight_ = distanceRight;
     shift_ = normal_ * (distanceRight_ - distanceLeft_);
 }

void MaserBoundary::shiftPosition ( BaseParticle * p )

shifts the particle to its 'periodic' position

Shifts the particle (using the closestToLeftBoundary_ value)

Parameters

[in] p A pointer to the particle which will be shifted.

Todo:: Reconsider the way in which the shifting of particles is done. Now, the procedure is as follows: > PARTICLE's distance to either of the two walls is gotten by MaserBoundary::getDistance > Which of the two walls the particle is closest to, is saved in the BOUNDARY's boolean data member closestToLeftBoundary_ > PARTICLE's position is then shifted based on the BOUNDARY's closestToLeftBoundary_ data member and shift vector What might go wrong, is that it is allowed now to do a shift operation on the particle without being forced to first have the closestToLeftBoundary_ boolean set based on the same particle. Suggestion: get rid of the closestToLeftBoundary_ data member all together (it is a property of the particle after all, rather than one of the boundary), and implement the obtaining of which boundary to shift relatively to directly into the shift function. (NB: The PeriodicBoundary class contains the same TODO).

Definition at line 138 of file MaserBoundary.cc.

References closestToLeftBoundary_, BaseInteractable::move(), and shift_.

Referenced by checkBoundaryAfterParticleMoved(), and createPeriodicParticles().

 {
     if (closestToLeftBoundary_)
     {
         p->move(shift_);
         closestToLeftBoundary_ = false;
     }
     else
     {
         p->move(-shift_);
         closestToLeftBoundary_ = true;
     }
 }

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

virtual

writes boundary properties to ostream

Writes boundary's properties to an ostream

Parameters

[in] os the ostream

Implements BaseBoundary.

Definition at line 73 of file MaserBoundary.cc.

References BaseBoundary::write().

 {
     BaseBoundary::write(os);
 }

Member Data Documentation

bool MaserBoundary::closestToLeftBoundary_

private

Dummy variable used when checking the proximity of particles to the boundary walls. TRUE if closest wall is the left boundary wall.

Definition at line 122 of file MaserBoundary.h.

Referenced by createPeriodicParticles(), getDistance(), and shiftPosition().

Mdouble MaserBoundary::distanceLeft_

private

position of left boundary wall, s.t. normal*x=position_left

Definition at line 113 of file MaserBoundary.h.

Referenced by getDistance(), and set().

Mdouble MaserBoundary::distanceRight_

private

position of right boundary wall, s.t. normal*x=position_right

Definition at line 117 of file MaserBoundary.h.

Referenced by getDistance(), and set().

Vec3D MaserBoundary::normal_

private

Normal unit vector of both maser walls. Points in the flowing direction.

Definition at line 109 of file MaserBoundary.h.

Referenced by getDistance(), and set().

Vec3D MaserBoundary::shift_

private

Direction in which particles are to be shifted when they cross the boundary.

I.e., the vector pointing from a point the left boundary wall to the equivalent point on the right one.

Definition at line 128 of file MaserBoundary.h.

Referenced by set(), and shiftPosition().

std::map<const ParticleSpecies*,const ParticleSpecies*> MaserBoundary::speciesConversionMaserToNormal_

private

List of 'maser' particles' species, and their normal counterparts.

Definition at line 138 of file MaserBoundary.h.

Referenced by addParticleToMaser(), checkBoundaryAfterParticleMoved(), and createPeriodicParticles().

std::map<const ParticleSpecies*,const ParticleSpecies*> MaserBoundary::speciesConversionNormalToMaser_

private

List of 'normal' particles' species, and their maser counterparts.

Definition at line 133 of file MaserBoundary.h.

Referenced by addParticleToMaser().

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

Boundaries/MaserBoundary.h
Boundaries/MaserBoundary.cc

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation