Used for removing particles from the problem. Inherits from BaseBoundary. More...

#include <DeletionBoundary.h>

Inheritance diagram for DeletionBoundary:

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

	~DeletionBoundary ()
	destructor More...

DeletionBoundary *	copy () const
	Copy method; creates copy on the heap and returns a pointer to it. More...

void	set (const Vec3D &normal, Mdouble distance)
	Sets boundary position based on a normal and distance. More...

void	move (Mdouble position)
	Sets the boundary's distance property to the given one. More...

Mdouble	getDistance (const Vec3D &position) const
	Returns the shortest distance between the boundary and given position. More...

bool	checkBoundaryAfterParticleMoved (BaseParticle *p, ParticleHandler &pH)
	Checks if particle passed the boundary and deletes the particle if so. More...

void	read (std::istream &is)
	Reads some boundary properties from an std::istream. More...

MERCURY_DEPRECATED void	oldRead (std::istream &is)
	Deprecated read method. use DeletionBoundary::read() instead. More...

void	write (std::ostream &os) const
	Writes the boundary properties to an std::ostream. 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
Vec3D	normal_
	outward unit normal vector More...

Mdouble	scaleFactor_
	This is the factor to rescale the given normal vector to a unit vectors. More...

Mdouble	distance_
	The boundary's distance from the origin. More...

Detailed Description

Used for removing particles from the problem. Inherits from BaseBoundary.

Definition at line 40 of file DeletionBoundary.h.

Constructor & Destructor Documentation

DeletionBoundary::DeletionBoundary ( )

default constructor

Default constructor (calls the parent-constructor of BaseBoundary as well)

Definition at line 35 of file DeletionBoundary.cc.

References DEBUG, distance_, logger, and scaleFactor_.

Referenced by copy().

         : BaseBoundary()
 {
     distance_ = std::numeric_limits<double>::quiet_NaN();
     scaleFactor_ = std::numeric_limits<double>::quiet_NaN();
     logger(DEBUG, "DeletionBoundary::DeletionBoundary() finished");
 }

DeletionBoundary::~DeletionBoundary ( )

destructor

Destructor

Definition at line 46 of file DeletionBoundary.cc.

References DEBUG, and logger.

 {
     logger(DEBUG, "DeletionBoundary::~DeletionBoundary() finished");
 }

Member Function Documentation

bool DeletionBoundary::checkBoundaryAfterParticleMoved	(	BaseParticle *	p,
		ParticleHandler &	pH
	)

Checks if particle passed the boundary and deletes the particle if so.

Checks if particle has passed the boundary, and if so, deletes the particle.

Parameters

[in]	p	pointer to the particle which is to be checked
[out]	pH	the particle's ParticleHandler, from which the particle is removed in case it has passed the boundary.

Returns: TRUE if the particle has actually passed the boundary and is thus deleted.

Definition at line 110 of file DeletionBoundary.cc.

References getDistance(), BaseObject::getIndex(), BaseInteractable::getPosition(), and ParticleHandler::removeObject().

 {
     if (getDistance(p->getPosition()) < 0)
     {
         pH.removeObject(p->getIndex());
         return true;
     }
     else
         return false;
 }

DeletionBoundary * DeletionBoundary::copy ( ) const

virtual

Copy method; creates copy on the heap and returns a pointer to it.

Copy function, which creates a copy and returns a pointer to that copy (on the heap)

Returns: pointer to the copy

Implements BaseBoundary.

Definition at line 56 of file DeletionBoundary.cc.

References DeletionBoundary().

 {
     return new DeletionBoundary(*this);
 }

Mdouble DeletionBoundary::getDistance ( const Vec3D & position ) const

Returns the shortest distance between the boundary and given position.

Calculates the shortest distance between the wall and given position.

Parameters

[in] position the position of which the distance should be calculated.

Definition at line 96 of file DeletionBoundary.cc.

References distance_, Vec3D::dot(), and normal_.

Referenced by checkBoundaryAfterParticleMoved().

 {
     return distance_ - Vec3D::dot(position, normal_);
 }

std::string DeletionBoundary::getName ( ) const

virtual

Returns the name of the object.

Returns the object's class name (i.e. 'DeletionBoundary').

Returns: the object's class name

Implements BaseObject.

Definition at line 161 of file DeletionBoundary.cc.

 {
     return "DeletionBoundary";
 }

void DeletionBoundary::move ( Mdouble distance )

Sets the boundary's distance property to the given one.

Resets the boundary's 'distance' from the origin to be the one given.

Parameters

[in] distance the new 'distance' between boundary and origin. see also comments of DeletionBoundary::set().

Definition at line 87 of file DeletionBoundary.cc.

References distance_, and scaleFactor_.

 {
     distance_ = distance * scaleFactor_;
 }

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

Deprecated read method. use DeletionBoundary::read() instead.

the deprecated version of the read-method. Should not be used by new users!

Deprecated:: Should be gone by Mercury 2.0. Use DeletionBoundary::read() instead.

Definition at line 139 of file DeletionBoundary.cc.

References distance_, normal_, and scaleFactor_.

 {
     std::string dummy;
     is >> dummy >> normal_ >> dummy >> scaleFactor_ >> dummy >> distance_;
 }

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

virtual

Reads some boundary properties from an std::istream.

Reads a number of boundary properties from the given std::istream.

Parameters

[in,out] is the istream

Implements BaseBoundary.

Definition at line 125 of file DeletionBoundary.cc.

References distance_, normal_, BaseBoundary::read(), and scaleFactor_.

 {
     BaseBoundary::read(is);
     std::string dummy;
     is >> dummy >> normal_
        >> dummy >> scaleFactor_
        >> dummy >> distance_;
 }

void DeletionBoundary::set	(	const Vec3D &	normal,
		Mdouble	distance
	)

Sets boundary position based on a normal and distance.

Defines the placing of the (2D) boundary based on the given normal and distance.

Parameters

[in]	normal	boundary normal vector
[in]	distance	'distance' between the origin and the boundary, such that the following relation is satisfied: $\mathbf{r} \cdot \mathbf{\hat{n}} = d$ in which $\mathbf{\hat{n}}$ and are the given normal vector and distance, respectively. NB: If the distance is the ACTUAL distance from the origin, the normal vector must be of UNIT LENGTH for the placing of the boundary to be done correctly.

Definition at line 75 of file DeletionBoundary.cc.

References distance_, Vec3D::dot(), normal_, and scaleFactor_.

 {
     scaleFactor_ = 1. / std::sqrt(Vec3D::dot(normal, normal));
     normal_ = normal * scaleFactor_;
     distance_ = distance * scaleFactor_;
 }

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

virtual

Writes the boundary properties to an std::ostream.

Parameters

[out] os the ostream the properties are to be written to.

Implements BaseBoundary.

Definition at line 149 of file DeletionBoundary.cc.

References distance_, normal_, scaleFactor_, and BaseBoundary::write().

 {
     BaseBoundary::write(os);
     os << " normal " << normal_
        << " scaleFactor " << scaleFactor_
        << " distance " << distance_;
 }

Member Data Documentation

Mdouble DeletionBoundary::distance_

private

The boundary's distance from the origin.

Definition at line 114 of file DeletionBoundary.h.

Referenced by DeletionBoundary(), getDistance(), move(), oldRead(), read(), set(), and write().

Vec3D DeletionBoundary::normal_

private

outward unit normal vector

Definition at line 101 of file DeletionBoundary.h.

Referenced by getDistance(), oldRead(), read(), set(), and write().

Mdouble DeletionBoundary::scaleFactor_

private

This is the factor to rescale the given normal vector to a unit vectors.

NB: Not only the normal vector is rescaled by this factor, also the 'distance' from the origin of the boundary is scaled by this factor! Also, once the boundary position is set with DeletionBoundary::set(), the arguments of any reset of the distance_ property (i.e. usage of DeletionBoundary::move()) will be rescaled by the same factor!

Definition at line 110 of file DeletionBoundary.h.

Referenced by DeletionBoundary(), move(), oldRead(), read(), set(), and write().

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

Boundaries/DeletionBoundary.h
Boundaries/DeletionBoundary.cc

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation