This is a class defining walls. More...

#include <RestrictedWall.h>

Inheritance diagram for RestrictedWall:

Public Member Functions
	RestrictedWall ()
	Default constructor, the normal is infinitely long. More...

	RestrictedWall (const RestrictedWall &w)
	Copy constructor, copy the given wall. More...

	RestrictedWall (BaseWall wall, InfiniteWall restriction)
	Constructor setting values. More...

virtual	~RestrictedWall ()
	Default destructor. More...

RestrictedWall *	copy () const override
	Wall copy method. It calls the copy constructor of this Wall, useful for polymorphism. More...

void	set (BaseWall wall, InfiniteWall restriction)
	Defines a standard wall, given an outward normal vector s.t. normalx=normalpoint for all x of the wall. More...

bool	getDistanceAndNormal (const BaseParticle &p, Mdouble &distance, Vec3D &normal_return) const override
	Compute the distance from the wall for a given BaseParticle and return if there is a collision. If there is a collision, also return the normal vector. More...

void	read (std::istream &is) override
	Reads RestrictedWall from a restart file. More...

void	oldRead (std::istream &is)
	Reads RestrictedWall from an old-style restart file. More...

void	write (std::ostream &os) const override
	Writes the RestrictedWall to an output stream, usually a restart file. More...

std::string	getName () const override
	Returns the name of the object, in this case the string "RestrictedWall". More...

std::vector< BaseInteraction * >	getInteractionWith (BaseParticle p, Mdouble timeStamp, InteractionHandler interactionHandler) override
	Look up the interaction between this wall and a BaseParticle at a certain timeStamp. More...

void	writeVTK (VTKContainer &vtk) const override

Public Member Functions inherited from BaseWall
	BaseWall ()
	Default constructor. It makes an empty BaseWall. More...

	BaseWall (const BaseWall &w)
	Copy constructor. More...

virtual	~BaseWall ()
	Default destructor. More...

virtual MERCURY_DEPRECATED void	clear ()
	A function that removes all data from this BaseWall, so sets handler_ to nullptr. More...

virtual void	setHandler (WallHandler *handler)
	A function which sets the WallHandler for this BaseWall. More...

WallHandler *	getHandler () const
	A function which returns the WallHandler that handles this BaseWall. More...

void	setIndSpecies (unsigned int indSpecies)
	Define the species of this wall using the index of the species in the SpeciesHandler in this DPMBase. More...

void	setSpecies (const ParticleSpecies *species)
	Define the species of this wall. More...

bool	getLinePlaneIntersect (Vec3D &intersect, const Vec3D &p0, const Vec3D &p1, const Vec3D &n, const Vec3D &p)

bool	isInsideWallVTK (const Vec3D &point, const Vec3D &normal, const Vec3D &position) const

void	projectOntoWallVTK (Vec3D &point0, const Vec3D &point1, const Vec3D &normal, const Vec3D &position) const

void	intersectVTK (std::vector< Vec3D > &points, const Vec3D normal, const Vec3D position) const

Public Member Functions inherited from BaseInteractable
	BaseInteractable ()
	Default BaseInteractable constructor, it simply creates an empty BaseInteractable. More...

	BaseInteractable (const BaseInteractable &p)
	Copy constructor. It copies the BaseInteractable and all objects it contains. More...

virtual	~BaseInteractable ()
	Destructor, it simply destructs the BaseInteractable and all the objects it contains. More...

unsigned int	getIndSpecies () const
	Returns the index of the Species of this BaseInteractable. More...

const ParticleSpecies *	getSpecies () const
	Returns a pointer to the species of this BaseInteractable. More...

void	setSpecies (const ParticleSpecies *species)
	Sets the species of this BaseInteractable. More...

const Vec3D &	getForce () const
	Returns the force on this BaseInteractable. More...

const Vec3D &	getTorque () const
	Returns the torque on this BaseInteractable. More...

void	setForce (const Vec3D &force)
	Sets the force on this BaseInteractable. More...

void	setTorque (const Vec3D &torque)
	Sets the torque on this BaseInteractable. More...

void	addForce (const Vec3D &addForce)
	Adds an amount to the force on this BaseInteractable. More...

void	addTorque (const Vec3D &addTorque)
	Adds an amount to the torque on this BaseInteractable. More...

const Vec3D &	getPosition () const
	Returns the position of this BaseInteractable. More...

const Vec3D &	getOrientation () const
	Returns the orientation of this BaseInteractable. More...

void	setPosition (const Vec3D &position)
	Sets the position of this BaseInteractable. More...

void	setOrientation (const Vec3D &orientation)
	Sets the orientation of this BaseInteractable. More...

virtual void	move (const Vec3D &move)
	Moves this BaseInteractable by adding an amount to the position. More...

void	rotate (const Vec3D &rotate)
	Rotates this BaseInteractable. More...

const std::list < BaseInteraction * > &	getInteractions () const
	Returns a reference to the list of interactions in this BaseInteractable. More...

void	addInteraction (BaseInteraction *I)
	Adds an interaction to this BaseInteractable. More...

bool	removeInteraction (BaseInteraction *I)
	Removes an interaction from this BaseInteractable. More...

void	copyInteractionsForPeriodicParticles (const BaseInteractable &p)
	Copies interactions to this BaseInteractable whenever a periodic copy made. More...

void	setVelocity (const Vec3D &velocity)
	set the velocity of the BaseInteractable. More...

void	setAngularVelocity (const Vec3D &angularVelocity)
	set the angular velocity of the BaseInteractble. More...

void	addVelocity (const Vec3D &velocity)
	adds an increment to the velocity. More...

void	addAngularVelocity (const Vec3D &angularVelocity)
	add an increment to the angular velocity. More...

virtual const Vec3D &	getVelocity () const
	Returns the velocity of this interactable. More...

virtual const Vec3D &	getAngularVelocity () const
	Returns the angular velocity of this interactable. More...

void	setPrescribedPosition (const std::function< Vec3D(double)> &prescribedPosition)
	Allows the position of an infinite mass interactable to be prescribed. More...

void	applyPrescribedPosition (double time)
	Computes the position from the user defined prescribed position function. More...

void	setPrescribedVelocity (const std::function< Vec3D(double)> &prescribedVelocity)
	Allows the velocity of an infinite mass interactable to be prescribed. More...

void	applyPrescribedVelocity (double time)
	Computes the velocity from the user defined prescribed velocity function. More...

void	setPrescribedOrientation (const std::function< Vec3D(double)> &prescribedOrientation)
	Allows the orientation of the infinite mass interactbale to be prescribed. More...

void	applyPrescribedOrientation (double time)
	Computes the orientation from the user defined prescribed orientation function. More...

void	setPrescribedAngularVelocity (const std::function< Vec3D(double)> &prescribedAngularVelocity)
	Allows the angular velocity of the infinite mass interactable to be prescribed. More...

void	applyPrescribedAngularVelocity (double time)
	Computes the angular velocity from the user defined prescribed angular velocity. More...

virtual const Vec3D	getVelocityAtContact (const Vec3D &contact) const
	Returns the velocity at the contact point, use by many force laws. More...

void	integrateBeforeForceComputation (double time, double timeStep)
	This is part of integrate routine for objects with infinite mass. More...

void	integrateAfterForceComputation (double time, double timeStep)
	This is part of the integration routine for objects with infinite mass. 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
BaseWall *	wall_

InfiniteWall *	restriction_

Additional Inherited Members
Static Public Member Functions inherited from BaseWall
static void	addToVTK (const std::vector< Vec3D > &points, VTKContainer &vtk)

Public Attributes inherited from BaseWall
WallHandler *	handler_

Detailed Description

This is a class defining walls.

It defines the interaction of regular walls and periodic walls with particles as defined in Particle Modifications:

Restriction of a wall to the intersection with another wall

Definition at line 42 of file RestrictedWall.h.

Constructor & Destructor Documentation

RestrictedWall::RestrictedWall ( )

Default constructor, the normal is infinitely long.

Definition at line 34 of file RestrictedWall.cc.

References DEBUG, logger, restriction_, and wall_.

Referenced by copy().

 {
     wall_ = nullptr;
     restriction_ = nullptr;
     logger(DEBUG, "RestrictedWall::RestrictedWall ) finished");
 }

RestrictedWall::RestrictedWall ( const RestrictedWall & w )

Copy constructor, copy the given wall.

Parameters

[in] w RestrictedWall that has to be copied.

First copy the attributes of the BaseWall, then copy the ones that are specific for the RestrictedWall.

Definition at line 46 of file RestrictedWall.cc.

References DEBUG, logger, restriction_, set(), and wall_.

         : BaseWall(w)
 {
     wall_ = nullptr;
     restriction_ = nullptr;
     set(w.wall_, w.restriction_);
     logger(DEBUG, "RestrictedWall::RestrictedWall(const RestrictedWall &p) finished");
 }

RestrictedWall::RestrictedWall	(	BaseWall *	wall,
		InfiniteWall *	restriction
	)

Constructor setting values.

Definition at line 55 of file RestrictedWall.cc.

References restriction_, set(), and wall_.

 {
     wall_ = nullptr;
     restriction_ = nullptr;
     set(wall, restriction);
 }

RestrictedWall::~RestrictedWall ( )

virtual

Default destructor.

Definition at line 62 of file RestrictedWall.cc.

References DEBUG, logger, restriction_, and wall_.

 {
     if (wall_!=nullptr) {
         delete wall_;
         wall_ = nullptr;
     }
     if (restriction_!=nullptr) {
         delete restriction_;
         restriction_ = nullptr;
     }
     logger(DEBUG, "RestrictedWall::~RestrictedWall finished");
 }

Member Function Documentation

RestrictedWall * RestrictedWall::copy ( ) const

overridevirtual

Wall copy method. It calls the copy constructor of this Wall, useful for polymorphism.

Wall copy method. It calls the copy constructor of this Wall, useful for polymorphism

Implements BaseWall.

Definition at line 78 of file RestrictedWall.cc.

References RestrictedWall().

 {
     return new RestrictedWall(*this);
 }

bool RestrictedWall::getDistanceAndNormal	(	const BaseParticle &	p,
		Mdouble &	distance,
		Vec3D &	normal_return
	)		const

overridevirtual

Compute the distance from the wall for a given BaseParticle and return if there is a collision. If there is a collision, also return the normal vector.

Parameters

[in]	p	BaseParticle for which the distance to the wall must be computed.
[out]	distance	Distance between the particle and the wall.
[out]	normal_return	The normal of this wall, will only be set if there is a collision.

Returns: A boolean value for whether or not there is a collision.

First the distance is checked. If there is no collision, this function will return false and give the distance. If there is a collision, the function will return true and give the distance and the normal vector of this wall. Since this function should be called before calculating any Particle-Wall interactions, it can also be used to set the normal vector in case of curved walls.

Implements BaseWall.

Definition at line 120 of file RestrictedWall.cc.

References InfiniteWall::getDistance(), BaseWall::getDistanceAndNormal(), BaseInteractable::getPosition(), BaseParticle::getWallInteractionRadius(), restriction_, and wall_.

 {
     if (restriction_->getDistance(p.getPosition()) < p.getWallInteractionRadius())
         return wall_->getDistanceAndNormal(p, distance, normal_return);
     else
         return false;
 }

std::vector< BaseInteraction * > RestrictedWall::getInteractionWith	(	BaseParticle *	p,
		Mdouble	timeStamp,
		InteractionHandler *	interactionHandler
	)

overridevirtual

Look up the interaction between this wall and a BaseParticle at a certain timeStamp.

Parameters

[in]	p	Pointer to the BaseParticle which we want to check the interaction for.
[in]	timeStamp	The time at which we want to look at the interaction.
[in]	interactionHandler	A pointer to the InteractionHandler in which the interaction can be found.

Returns: A pointer to the BaseInteraction that happened between this RestrictedWall and the BaseParticle at the timeStamp.

Todo:: Shouldn't this function be defined in BaseWall?

Todo:: {setting the index of the wall is necessary to get the right index reported in fstat; however, the better way would be to make setIndex virtual.}

Reimplemented from BaseWall.

Definition at line 165 of file RestrictedWall.cc.

                                                                                                                                           {
     if (restriction_->getDistance(p->getPosition()) < p->getWallInteractionRadius()) {
         wall_->setIndex(getIndex());
         return wall_->getInteractionWith(p, timeStamp, interactionHandler);
     } else {
         return std::vector<BaseInteraction*>();
     }
 }

std::string RestrictedWall::getName ( ) const

overridevirtual

Returns the name of the object, in this case the string "RestrictedWall".

Returns: The string "RestrictedWall", which is the name of this class.

Implements BaseObject.

Definition at line 152 of file RestrictedWall.cc.

Referenced by write().

 {
     return "RestrictedWall";
 }

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

Reads RestrictedWall from an old-style restart file.

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

overridevirtual

Reads RestrictedWall from a restart file.

Parameters

[in] is The input stream from which the RestrictedWall is read.

Reimplemented from BaseWall.

Definition at line 131 of file RestrictedWall.cc.

References BaseWall::read(), InfiniteWall::read(), restriction_, and wall_.

 {
     wall_->read(is);
     restriction_->read(is);
 }

void RestrictedWall::set	(	BaseWall *	wall,
		InfiniteWall *	restriction
	)

Defines a standard wall, given an outward normal vector s.t. normal*x=normal*point for all x of the wall.

Todo:: TW maybe the Restricted wall should be templated with the wall type such that we don't need to use new and delete.

Definition at line 90 of file RestrictedWall.cc.

References BaseWall::copy(), InfiniteWall::copy(), BaseInteractable::getSpecies(), restriction_, BaseWall::setSpecies(), and wall_.

Referenced by RestrictedWall().

 {
     if (wall_!=nullptr) {
         delete wall_;
         wall_ = nullptr;
     }
     wall_ = wall->copy();
     setSpecies(wall_->getSpecies());
 
     if (restriction_!=nullptr) {
         delete restriction_;
         restriction_ = nullptr;
     }
     restriction_ = restriction->copy();
 
     // std::cout << *this << std::endl;
 }

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

overridevirtual

Writes the RestrictedWall to an output stream, usually a restart file.

Parameters

[in] os The output stream the RestrictedWall is written to.

Reimplemented from BaseWall.

Definition at line 140 of file RestrictedWall.cc.

References getName(), restriction_, wall_, BaseWall::write(), and InfiniteWall::write().

 {
     //todo check
     os << getName() << ' ';
     wall_->write(os);
     os << ' ';
     restriction_->write(os);
 }

void RestrictedWall::writeVTK ( VTKContainer & vtk ) const

overridevirtual

adds extra information to the points and triangleStrips vectors needed to plot the wall in vtk format

Parameters

points	Coordinates of the vertices of the triangulated surfaces (in the VTK file this is called POINTS)
triangleStrips	Indices of three vertices forming one triangulated surface (in the VTK file this is called CELL)

Reimplemented from BaseWall.

Definition at line 175 of file RestrictedWall.cc.

References InfiniteWall::getDistance(), InfiniteWall::getNormal(), VTKContainer::points, restriction_, VTKContainer::triangleStrips, wall_, and BaseWall::writeVTK().

 {
     std::vector<std::vector<double>> myTriangleStrips;
     wall_->writeVTK(vtk);
 
     // for (auto myTriangleStrip: myTriangleStrips) {
     //     triangleStrips.push_back(myTriangleStrip);
     // }
     
     std::vector<double> cell;
     
     for (auto myTriangleStrip: myTriangleStrips) {
         unsigned counter = 0;
         for (const auto c: myTriangleStrip) {
             Mdouble distance = restriction_->getDistance(vtk.points[c]);
             if (distance < 0) {
                 //if the current point is in restriction, write it
                 cell.push_back(c);
                 counter=0;
             } else {
                 if (counter>=2) {
                     //if the current point is not in restriction, don't write it and flush the cell into the cells array
                     if (cell.size()>2)
                         vtk.triangleStrips.push_back(cell);
                     cell.clear();
                     counter=0;
                 }
                 vtk.points[c] += distance*restriction_->getNormal();
                 cell.push_back(c);
                 counter++;
             }
         }
         if (cell.size()>2) {
             //if the current point is not in restriction, don't write it and flush the cell into the cells array
             vtk.triangleStrips.push_back(cell);
             cell.clear();
         }
     }
 }

Member Data Documentation

InfiniteWall* RestrictedWall::restriction_

private

Definition at line 114 of file RestrictedWall.h.

Referenced by getDistanceAndNormal(), read(), RestrictedWall(), set(), write(), writeVTK(), and ~RestrictedWall().

BaseWall* RestrictedWall::wall_

private

Outward normal vector. This does not have to be a unit vector.

Definition at line 113 of file RestrictedWall.h.

Referenced by getDistanceAndNormal(), read(), RestrictedWall(), set(), write(), writeVTK(), and ~RestrictedWall().

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

Walls/RestrictedWall.h
Walls/RestrictedWall.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation