used to create a circular periodic boundary More...

#include <CircularPeriodicBoundary.h>

Inheritance diagram for CircularPeriodicBoundary:

Public Member Functions
	CircularPeriodicBoundary ()
	default constructor More...

	CircularPeriodicBoundary (double innerRadius)
	Constructor. More...

	~CircularPeriodicBoundary ()
	destructor More...

CircularPeriodicBoundary *	copy () const
	Used to create a copy of the object NB: purely virtual function. More...

void	rotateParticle (BaseParticle *P, double angle)

void	createPeriodicParticles (BaseParticle *P, ParticleHandler &pH)

bool	checkBoundaryAfterParticleMoved (BaseParticle *P, ParticleHandler &pH)

void	read (std::istream &is)
	reads the CircularPeriodicBoundary More...

void	oldRead (std::istream &is)

void	write (std::ostream &os) const
	outputs the CircularPeriodicBoundary More...

virtual std::string	getName () const
	Returns the name of the object. 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
double	innerRadius_

Detailed Description

used to create a circular periodic boundary

Definition at line 38 of file CircularPeriodicBoundary.h.

Constructor & Destructor Documentation

CircularPeriodicBoundary::CircularPeriodicBoundary ( )

default constructor

Definition at line 30 of file CircularPeriodicBoundary.cc.

References innerRadius_.

Referenced by copy().

         : BaseBoundary()
 {
     innerRadius_ = 1.0;
 #ifdef DEBUG_CONSTRUCTOR
     std::cout << "CircularPeriodicBoundary::CircularPeriodicBoundary() finished" << std::endl;
 #endif              
 }

CircularPeriodicBoundary::CircularPeriodicBoundary ( double innerRadius )

Constructor.

Definition at line 39 of file CircularPeriodicBoundary.cc.

References innerRadius_.

         : BaseBoundary()
 {
     this->innerRadius_ = innerRadius;
 #ifdef DEBUG_CONSTRUCTOR
     std::cout << "CircularPeriodicBoundary::CircularPeriodicBoundary(double innerRadius) finished" << std::endl;
 #endif              
 }

CircularPeriodicBoundary::~CircularPeriodicBoundary ( )

destructor

Definition at line 48 of file CircularPeriodicBoundary.cc.

 {
     #ifdef DEBUG_DESTRUCTOR
     std::cerr << "CircularPeriodicBoundary::~CircularPeriodicBoundary() finished" << std::endl;
 #endif  
 }

Member Function Documentation

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

Todo:: TW: Dinant, please confirm that i and oldI should be integer

Definition at line 122 of file CircularPeriodicBoundary.cc.

References ParticleHandler::addObject(), BaseParticle::copy(), BaseParticle::getDisplacement(), BaseObject::getIndex(), BaseInteractable::getPosition(), innerRadius_, mathsFunc::log(), constants::pi, R, ParticleHandler::removeObject(), rotateParticle(), BaseParticle::setDisplacement(), Vec3D::X, and Vec3D::Y.

 {
     double R = sqrt(pow(P->getPosition().X, 2) + pow(P->getPosition().Y, 2));
     double alpha = atan2(P->getPosition().Y, P->getPosition().X);
     int i = static_cast<int>(std::floor(std::log(R / innerRadius_) / std::log(2.0))) + 1;
     double pieSize = 2.0 / pow(2.0, i) * constants::pi;
     
     double oldR = sqrt(pow(P->getPosition().X - P->getDisplacement().X, 2) + pow(P->getPosition().Y - P->getDisplacement().Y, 2));
     int oldI = static_cast<int>(std::floor(std::log(oldR / innerRadius_) / std::log(2.0))) + 1;
     
     if (i > 0 && i > oldI) //Particle moves outward so it may have to be deleted
     {
         //std::cout<<"Particle="<<P->getIndex()<<" moving outward with alpha="<<alpha<<" and pieSize="<<pieSize<<" ";
         if (alpha < 0 || alpha > pieSize)
         {
             if (alpha > 2.0 * pieSize)
             {
                 //std::cout<<"and it is rotated into the pie"<<std::endl;
                 rotateParticle(P, -pieSize);
             }
             else
             {
                 //Delete particle
                 //std::cout<<"and it should be deleted"<<std::endl;
                 pH.removeObject(P->getIndex());
                 return true;
             }
         }
         //else
         //std::cout<<"and nothing happens"<<std::endl;
     }
     else if (i >= 0 && i < oldI) //Particle moves inward so it has to be coppied
     {
         //std::cout<<"Particle="<<P->getIndex()<<" moving inward and is thus coppied with alpha="<<alpha<<" and pieSize="<<pieSize<<std::endl;
         //std::cout<<"i="<<i<<" oldI="<<oldI<<" R="<<R<<" oldR="<<oldR<<std::endl;
         //std::cout<<"Position="<<P->getPosition()<<" Displacement="<<P->get_Displacement()<<std::endl;
         BaseParticle* F0 = P->copy();
         F0->setDisplacement(Vec3D(0.0, 0.0, 0.0));
         if (alpha < 0)
         {
             rotateParticle(P, pieSize);
             rotateParticle(F0, 0.5 * pieSize);
         }
         else if (alpha < 0.5 * pieSize)
         {
             rotateParticle(F0, 0.5 * pieSize);
         }
         else if (alpha < pieSize)
         {
             rotateParticle(F0, -0.5 * pieSize);
         }
         else
         {
             rotateParticle(P, -pieSize);
             rotateParticle(F0, -0.5 * pieSize);
         }
         pH.addObject(F0);
     }
     else if (i > 0 && alpha < 0)
     {
         //std::cout<<"Particle="<<P->getIndex()<<" i="<<i<<" R="<<R<<" alpha="<<alpha<<" positive rotated pieSize="<<pieSize<<std::endl;            
         rotateParticle(P, pieSize);
     }
     else if (i > 0 && alpha > pieSize)
     {
         //std::cout<<"Particle="<<P->getIndex()<<" i="<<i<<" R="<<R<<" alpha="<<alpha<<" negative rotated pieSize="<<pieSize<<std::endl;            
         rotateParticle(P, -pieSize);
     }
     return false;
 }

CircularPeriodicBoundary * CircularPeriodicBoundary::copy ( ) const

virtual

Used to create a copy of the object NB: purely virtual function.

Implements BaseBoundary.

Definition at line 55 of file CircularPeriodicBoundary.cc.

References CircularPeriodicBoundary().

 {
 #ifdef DEBUG_CONSTRUCTOR
     std::cerr << "CircularPeriodicBoundary::copy() const finished" << std::endl;
 #endif              
     return new CircularPeriodicBoundary(*this);
 }

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

Parameters

[in]

Definition at line 77 of file CircularPeriodicBoundary.cc.

References ParticleHandler::addObject(), BaseParticle::copy(), mathsFunc::cos(), BaseParticle::getInteractionRadius(), ParticleHandler::getLargestParticle(), BaseParticle::getPeriodicFromParticle(), BaseInteractable::getPosition(), innerRadius_, mathsFunc::log(), constants::pi, R, rotateParticle(), BaseParticle::setPeriodicFromParticle(), Vec3D::X, and Vec3D::Y.

 {
     double R = sqrt(pow(P->getPosition().X, 2) + pow(P->getPosition().Y, 2));
     double alpha = atan2(P->getPosition().Y, P->getPosition().X);
     unsigned int i = static_cast<unsigned int>(std::floor(std::log(R / innerRadius_) / std::log(2.0))) + 1;
     double pieSize = 2.0 / pow(2.0, i) * constants::pi;
     //std::cout<<"R="<<R<<" alpha="<<alpha<<" i="<<i<<" pieSize="<<pieSize<<std::endl;
     
     //Check if the particle is close to it's inner Radius or is is close to zero alpha (small y)
     if (i > 0 && (R - (P->getInteractionRadius() + pH.getLargestParticle()->getInteractionRadius()) < pow(2.0, i - 1) * innerRadius_ || P->getPosition().Y < (P->getInteractionRadius() + pH.getLargestParticle()->getInteractionRadius())))
     {
         //std::cout<<"Going to shift because "<<R-P->getRadius()<<"<"<<pow(2,i-1)*innerRadius<<" or "<<P->getPosition().Y<<"<"<<P->getRadius()<<std::endl;
         //std::cout<<*P<<" has been shifted"<<std::endl;
         
         BaseParticle* F0 = P->copy();
         rotateParticle(F0, pieSize);
         
         //If Particle is Mdouble shifted, get correct original particle         
         BaseParticle* From = P;
         while (From->getPeriodicFromParticle() != nullptr)
             From = From->getPeriodicFromParticle();
         F0->setPeriodicFromParticle(From);
         
         //std::cout<<*F0<<" is the result"<<std::endl;
         pH.addObject(F0);
     }
     //Check here only for i>0 becuase for i=1 they both give the same particle
     if (i > 1 && R * R * (1 - pow(cos(alpha - pieSize), 2)) < P->getInteractionRadius() + pH.getLargestParticle()->getInteractionRadius())
     {
         //std::cout<<*P<<" has been shifted back"<<std::endl;
         
         BaseParticle* F0 = P->copy();
         rotateParticle(F0, -pieSize);
         
         //If Particle is Mdouble shifted, get correct original particle         
         BaseParticle* From = P;
         while (From->getPeriodicFromParticle() != nullptr)
             From = From->getPeriodicFromParticle();
         F0->setPeriodicFromParticle(From);
         
         //std::cout<<*F0<<" is the result"<<std::endl;
         pH.addObject(F0);
     }
 }

std::string CircularPeriodicBoundary::getName ( ) const

virtual

Returns the name of the object.

Returns: string type

Implements BaseObject.

Definition at line 213 of file CircularPeriodicBoundary.cc.

 {
     return "CircularPeriodicBoundary";
 }

void CircularPeriodicBoundary::oldRead ( std::istream & is )

Definition at line 201 of file CircularPeriodicBoundary.cc.

References innerRadius_.

 {
     std::string dummy;
     is >> dummy >> innerRadius_;
 }

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

virtual

reads the CircularPeriodicBoundary

Implements BaseBoundary.

Definition at line 194 of file CircularPeriodicBoundary.cc.

References innerRadius_, and BaseBoundary::read().

 {
     BaseBoundary::read(is);
     std::string dummy;
     is >> dummy >> innerRadius_;
 }

void CircularPeriodicBoundary::rotateParticle	(	BaseParticle *	P,
		double	angle
	)

Parameters

[in]

todo{Do we need to update rotations and rotational velocitys?}

Definition at line 63 of file CircularPeriodicBoundary.cc.

References mathsFunc::cos(), BaseInteractable::getPosition(), BaseInteractable::getVelocity(), R, BaseInteractable::setPosition(), BaseInteractable::setVelocity(), mathsFunc::sin(), Vec3D::X, Vec3D::Y, and Vec3D::Z.

Referenced by checkBoundaryAfterParticleMoved(), and createPeriodicParticles().

 {
     double R = sqrt(pow(P->getPosition().X, 2) + pow(P->getPosition().Y, 2));
     double alphaPos = atan2(P->getPosition().Y, P->getPosition().X);
     double V = sqrt(pow(P->getVelocity().X, 2) + pow(P->getVelocity().Y, 2));
     double alphaVel = atan2(P->getVelocity().Y, P->getVelocity().X);
     alphaPos += angle;
     alphaVel += angle;
     
     P->setPosition(Vec3D(cos(alphaPos) * R, sin(alphaPos * R), P->getPosition().Z));
     P->setVelocity(Vec3D(cos(alphaVel) * V, sin(alphaVel * V), P->getVelocity().Z));
 }

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

virtual

outputs the CircularPeriodicBoundary

Implements BaseBoundary.

Definition at line 207 of file CircularPeriodicBoundary.cc.

References innerRadius_, and BaseBoundary::write().

         {
     BaseBoundary::write(os);
     os << " innerRadius " << innerRadius_;
 }

Member Data Documentation

double CircularPeriodicBoundary::innerRadius_

private

Definition at line 104 of file CircularPeriodicBoundary.h.

Referenced by checkBoundaryAfterParticleMoved(), CircularPeriodicBoundary(), createPeriodicParticles(), oldRead(), read(), and write().

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

Boundaries/CircularPeriodicBoundary.h
Boundaries/CircularPeriodicBoundary.cc

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation