This is a class defining walls. More...

#include <InfiniteWall.h>

Inheritance diagram for InfiniteWall:

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

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

	InfiniteWall (Vec3D normal, Vec3D point, const ParticleSpecies *species)
	Constructor setting values. More...

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

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

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

void	setNormal (const Vec3D normal)
	Changes the normal of the InfiniteWall. More...

MERCURY_DEPRECATED void	set (Vec3D normal, Mdouble position)
	Defines a standard wall by computing normal*position = point and using the overloaded function set(Vec3D, vec3D). More...

MERCURY_DEPRECATED void	move (Mdouble position)
	Move the wall to a new position by giving the new position in the direction of the unit normal vector. More...

Mdouble	getDistance (const Vec3D &otherPosition) const
	Returns the distance of the wall to the particle. 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 InfiniteWall from a restart file. More...

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

void	write (std::ostream &os) const override
	Writes the InfiniteWall 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 "InfiniteWall". More...

Vec3D	getNormal () const
	Access function for normal. More...

void	createVTK (std::vector< Vec3D > &myPoints) const

void	createVTK (std::vector< Vec3D > &myPoints, const Vec3D max, const Vec3D min) const

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

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

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
Vec3D	normal_

Mdouble	factor_

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:

A infinite wall fills the half-space {point: (position_-point)*normal_<=0}.

Thus, the surface of the wall is a plane through position position_ with normal_ the outward unit normal vector of the wall (pointing away from the particles, into the wall). Please note that this wall is infinite and straight.

A particle touches an infinite wall if (position_-point)*normal_<=radius.

Definition at line 47 of file InfiniteWall.h.

Constructor & Destructor Documentation

InfiniteWall::InfiniteWall ( )

Default constructor, the normal is infinitely long.

Definition at line 34 of file InfiniteWall.cc.

References DEBUG, factor_, and logger.

Referenced by copy().

 {
     factor_ = std::numeric_limits<double>::quiet_NaN();
     logger(DEBUG, "InfiniteWall::InfiniteWall ) finished");
 }

InfiniteWall::InfiniteWall ( const InfiniteWall & w )

Copy constructor, copy the given wall.

Parameters

[in] w InfiniteWall that has to be copied.

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

Definition at line 45 of file InfiniteWall.cc.

References DEBUG, factor_, logger, and normal_.

         : BaseWall(w)
 {
     normal_ = w.normal_;
     factor_ = w.factor_;
     logger(DEBUG, "InfiniteWall::InfiniteWall(const InfiniteWall &p) finished");
 }

InfiniteWall::InfiniteWall	(	Vec3D	normal,
		Vec3D	point,
		const ParticleSpecies *	species
	)

Constructor setting values.

Definition at line 53 of file InfiniteWall.cc.

References setNormal(), BaseInteractable::setPosition(), and BaseWall::setSpecies().

 {
     setNormal(normal);
     setPosition(point);
     setSpecies(species);
 }

InfiniteWall::~InfiniteWall ( )

virtual

Default destructor.

Definition at line 60 of file InfiniteWall.cc.

References DEBUG, and logger.

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

Member Function Documentation

InfiniteWall * InfiniteWall::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 68 of file InfiniteWall.cc.

References InfiniteWall().

Referenced by RestrictedWall::set().

 {
     return new InfiniteWall(*this);
 }

void InfiniteWall::createVTK ( std::vector< Vec3D > & myPoints ) const

Returns all intersection points of the infinite wall with the domain boundary.

Used to create an array of points for representing the wall in the VTK viewer. E.g., for a InfiniteWall through p=(0,0,0) with normal n=(0,0,-1) in a domain (-1,1)^3, createVTK returns {(0,-1,-1), (0,-1,1), (0,1,1), (0,1,-1)} Calling addToVTK will then create a triangle strip connecting these points with triangle faces.

Definition at line 202 of file InfiniteWall.cc.

References BaseHandler< T >::getDPMBase(), BaseWall::getHandler(), DPMBase::getMax(), and DPMBase::getMin().

Referenced by writeVTK().

 {
     Vec3D max = getHandler()->getDPMBase()->getMax();
     Vec3D min = getHandler()->getDPMBase()->getMin();
     createVTK (myPoints, min, max);
 }

void InfiniteWall::createVTK	(	std::vector< Vec3D > &	myPoints,
		const Vec3D	max,
		const Vec3D	min
	)		const

Same as createVTK(), but with a self-defined domain size (useful for plotting AxisymmetricWall's).

Definition at line 209 of file InfiniteWall.cc.

References BaseInteractable::getPosition(), BaseWall::intersectVTK(), normal_, Vec3D::X, Vec3D::Y, and Vec3D::Z.

 {
     const Vec3D& n = normal_;
     const Vec3D& p = getPosition();
     
     if (fabs(n.X)>0.5) {
         // If the wall normal has a nonzero x-component,
         // We first find four intersection points with the four domain edges pointing in x-direction.
         // Because these points might be outside the domain in x-direction, we use the intersection function have points in the domain
         myPoints.push_back(Vec3D(p.X-((min.Y-p.Y)*n.Y+(min.Z-p.Z)*n.Z)/n.X,min.Y,min.Z));
         myPoints.push_back(Vec3D(p.X-((min.Y-p.Y)*n.Y+(max.Z-p.Z)*n.Z)/n.X,min.Y,max.Z));
         myPoints.push_back(Vec3D(p.X-((max.Y-p.Y)*n.Y+(max.Z-p.Z)*n.Z)/n.X,max.Y,max.Z));
         myPoints.push_back(Vec3D(p.X-((max.Y-p.Y)*n.Y+(min.Z-p.Z)*n.Z)/n.X,max.Y,min.Z));
         intersectVTK(myPoints, Vec3D(+1, 0, 0), Vec3D(max.X, 0, 0));
         intersectVTK(myPoints, Vec3D(-1, 0, 0), Vec3D(min.X, 0, 0));
     } else if (fabs(n.Y)>0.5) {
         // Else, if the wall normal has a nonzero y-component ...
         myPoints.push_back(Vec3D(min.X,p.Y-((min.X-p.X)*n.X+(min.Z-p.Z)*n.Z)/n.Y,min.Z));
         myPoints.push_back(Vec3D(min.X,p.Y-((min.X-p.X)*n.X+(max.Z-p.Z)*n.Z)/n.Y,max.Z));
         myPoints.push_back(Vec3D(max.X,p.Y-((max.X-p.X)*n.X+(max.Z-p.Z)*n.Z)/n.Y,max.Z));
         myPoints.push_back(Vec3D(max.X,p.Y-((max.X-p.X)*n.X+(min.Z-p.Z)*n.Z)/n.Y,min.Z));
         intersectVTK(myPoints, Vec3D(0, +1, 0), Vec3D(0, max.Y, 0));
         intersectVTK(myPoints, Vec3D(0, -1, 0), Vec3D(0, min.Y, 0));
     } else {
         // Else, the wall normal has to have a a nonzero z-component ...
         myPoints.push_back(Vec3D(min.X,min.Y,p.Z-((min.Y-p.Y)*n.Y+(min.X-p.X)*n.X)/n.Z));
         myPoints.push_back(Vec3D(min.X,max.Y,p.Z-((max.Y-p.Y)*n.Y+(min.X-p.X)*n.X)/n.Z));
         myPoints.push_back(Vec3D(max.X,max.Y,p.Z-((max.Y-p.Y)*n.Y+(max.X-p.X)*n.X)/n.Z));
         myPoints.push_back(Vec3D(max.X,min.Y,p.Z-((min.Y-p.Y)*n.Y+(max.X-p.X)*n.X)/n.Z));
         intersectVTK(myPoints, Vec3D(0, 0, +1), Vec3D(0, 0, max.Z));
         intersectVTK(myPoints, Vec3D(0, 0, -1), Vec3D(0, 0, min.Z));
     }
 }

Mdouble InfiniteWall::getDistance ( const Vec3D & otherPosition ) const

Returns the distance of the wall to the particle.

Parameters

[in] otherPosition The position to which the distance must be computed to.

Returns: The distance of the wall to the particle.

Definition at line 120 of file InfiniteWall.cc.

References Vec3D::dot(), BaseInteractable::getPosition(), and normal_.

Referenced by RestrictedWall::getDistanceAndNormal(), getDistanceAndNormal(), and RestrictedWall::writeVTK().

 {
     return Vec3D::dot(getPosition()-otherPosition, normal_);
 }

bool InfiniteWall::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 137 of file InfiniteWall.cc.

References getDistance(), BaseInteractable::getPosition(), BaseParticle::getWallInteractionRadius(), and normal_.

 {
     distance = getDistance(p.getPosition());
     if (distance >= p.getWallInteractionRadius())
         return false;
     normal_return = normal_;
     return true;
 }

std::string InfiniteWall::getName ( ) const

overridevirtual

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

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

Implements BaseObject.

Definition at line 183 of file InfiniteWall.cc.

 {
     return "InfiniteWall";
 }

Vec3D InfiniteWall::getNormal ( ) const

Access function for normal.

Returns: The 3D vector that represents the normal to the wall.

Definition at line 191 of file InfiniteWall.cc.

References normal_.

Referenced by IntersectionOfWalls::addObject(), and RestrictedWall::writeVTK().

 {
     return normal_;
 }

void InfiniteWall::move ( Mdouble positionInNormalDirection )

Move the wall to a new position by giving the new position in the direction of the unit normal vector.

Deprecated:: In Mercury 2, the user will have the new interface, namely move(Vec3D) that is implemented in BaseInteractable.

Parameters

[in] positionInNormalDirection The position of the wall in the direction of the normal vector.

Definition at line 110 of file InfiniteWall.cc.

References factor_, logger, normal_, BaseInteractable::setPosition(), and WARN.

 {
     logger(WARN, "InfiniteWall::move(Mdouble) is deprecated. Use move(Vec3D) instead.");
     setPosition(positionInNormalDirection * normal_ / factor_);
 }

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

Reads InfiniteWall from an old-style restart file.

Parameters

[in] is The input stream from which the InfiniteWall old style is read.

Definition at line 160 of file InfiniteWall.cc.

References normal_, BaseInteractable::setPosition(), and BaseInteractable::setVelocity().

 {
     std::string dummy;
     Vec3D velocity;
     Vec3D position;
     is >> dummy >> normal_ >> dummy >> position >> dummy >> velocity;
     setPosition(position);
     setVelocity(velocity);
 }

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

overridevirtual

Reads InfiniteWall from a restart file.

Parameters

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

Reimplemented from BaseWall.

Definition at line 149 of file InfiniteWall.cc.

References factor_, normal_, and BaseWall::read().

Referenced by RestrictedWall::read().

 {
     BaseWall::read(is);
     std::string dummy;
     is >> dummy >> normal_;
     is >> dummy >> factor_;
 }

void InfiniteWall::set	(	Vec3D	normal,
		Vec3D	point
	)

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

Definition at line 79 of file InfiniteWall.cc.

References setNormal(), and BaseInteractable::setPosition().

Referenced by IntersectionOfWalls::addObject(), Chute::createBottom(), helpers::loadingTest(), helpers::normalAndTangentialLoadingTest(), WallHandler::readOldObject(), DPMBase::readParAndIniFiles(), set(), ChuteBottom::setupInitialConditions(), and Chute::setupSideWalls().

 {
     setNormal(normal);
     setPosition(point);
 }

void InfiniteWall::set	(	Vec3D	normal,
		Mdouble	positionInNormalDirection
	)

Defines a standard wall by computing normal*position = point and using the overloaded function set(Vec3D, vec3D).

Deprecated:: In Mercury 2, the user will have to use the new interface, namely set(Vec3D, Vec3D).

Defines a standard wall, given an outward normal vector s. t. normal*x=position

Parameters

[in]	normal	A Vec3D that represents the normal vector to the wall.
[in]	positionInNormalDirection	The position of the wall in the direction of the normal vector.

Definition at line 100 of file InfiniteWall.cc.

References logger, set(), and WARN.

 {
     logger(WARN, "InfiniteWall::set(Vec3D, Mdouble) is deprecated. Use set(Vec3D, Vec3D) instead.");
     set(normal, positionInNormalDirection*normal);
 }

void InfiniteWall::setNormal ( const Vec3D normal )

Changes the normal of the InfiniteWall.

Parameters

[in] normal The vector normal to the wall.

Definition at line 88 of file InfiniteWall.cc.

References factor_, Vec3D::getLength(), and normal_.

Referenced by InfiniteWall(), and set().

 {
     factor_ = 1. / Vec3D::getLength(normal);
     normal_ = normal * factor_;
 }

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

overridevirtual

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

Parameters

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

Reimplemented from BaseWall.

Definition at line 173 of file InfiniteWall.cc.

References factor_, normal_, and BaseWall::write().

Referenced by RestrictedWall::write().

 {
     BaseWall::write(os);
     os << " normal " << normal_
        << " factor "<< factor_;
 }

void InfiniteWall::writeVTK ( VTKContainer & vtk ) const

overridevirtual

Adds the vtk wall representation to the VTK container

Reimplemented from BaseWall.

Definition at line 243 of file InfiniteWall.cc.

References BaseWall::addToVTK(), and createVTK().

 {
     std::vector<Vec3D> points;
     createVTK (points);
     addToVTK (points, vtk);
 }

Member Data Documentation

Mdouble InfiniteWall::factor_

private

This is the factor used to rescale the normal given by the user to a unit vector. It is only used by the deprecated function move(Mdouble).

Definition at line 165 of file InfiniteWall.h.

Referenced by InfiniteWall(), move(), read(), setNormal(), and write().

Vec3D InfiniteWall::normal_

private

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

Definition at line 159 of file InfiniteWall.h.

Referenced by createVTK(), getDistance(), getDistanceAndNormal(), getNormal(), InfiniteWall(), move(), oldRead(), read(), setNormal(), and write().

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

Walls/InfiniteWall.h
Walls/InfiniteWall.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation