This is a class defining walls. More...

#include <SphericalWall.h>

Inheritance diagram for SphericalWall:

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

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

	SphericalWall (Mdouble radius, const ParticleSpecies *species)
	Constructor setting values. More...

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

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

void	setRadius (Mdouble radius)
	Defines a spherical wall with radius r. More...

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

Mdouble	getRadius () 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 SphericalWall from a restart file. More...

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

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 void	writeVTK (VTKContainer &vtk) 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
Mdouble	radius_

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 SphericalWall.h.

Constructor & Destructor Documentation

SphericalWall::SphericalWall ( )

Default constructor, the normal is infinitely long.

Definition at line 35 of file SphericalWall.cc.

References DEBUG, logger, and radius_.

Referenced by copy().

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

SphericalWall::SphericalWall ( const SphericalWall & w )

Copy constructor, copy the given wall.

Parameters

[in] w SphericalWall that has to be copied.

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

Definition at line 46 of file SphericalWall.cc.

References DEBUG, logger, and radius_.

         : BaseWall(w)
 {
     radius_ = w.radius_;
     logger(DEBUG, "SphericalWall::SphericalWall(const SphericalWall &p) finished");
 }

SphericalWall::SphericalWall	(	Mdouble	radius,
		const ParticleSpecies *	species
	)

Constructor setting values.

Definition at line 53 of file SphericalWall.cc.

References setRadius().

 {
     setRadius(radius);
 }

SphericalWall::~SphericalWall ( )

virtual

Default destructor.

Definition at line 58 of file SphericalWall.cc.

References DEBUG, and logger.

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

Member Function Documentation

SphericalWall * SphericalWall::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 66 of file SphericalWall.cc.

References SphericalWall().

 {
     return new SphericalWall(*this);
 }

Mdouble SphericalWall::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 87 of file SphericalWall.cc.

References Vec3D::getLength(), and BaseInteractable::getPosition().

 {
     return Vec3D::getLength(getPosition()-otherPosition);
 }

bool SphericalWall::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 112 of file SphericalWall.cc.

References Vec3D::getLength(), BaseInteractable::getPosition(), BaseParticle::getWallInteractionRadius(), and radius_.

 {
     normal_return = p.getPosition()-getPosition();
     distance = Vec3D::getLength(normal_return)-radius_;
     if (distance >= p.getWallInteractionRadius())
         return false;
     normal_return/=distance+radius_;
     //logger(WARN,"p% q% q% q% q%", getPosition(), p.getPosition(), normal_return, distance, p.getWallInteractionRadius());
     return true;
 }

std::string SphericalWall::getName ( ) const

overridevirtual

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

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

Implements BaseObject.

Definition at line 145 of file SphericalWall.cc.

 {
     return "SphericalWall";
 }

Mdouble SphericalWall::getRadius ( ) const

Returns the distance of the wall to the particle.

Returns: The radius of the wall .

Definition at line 95 of file SphericalWall.cc.

References radius_.

 {
     return radius_;
 }

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

overridevirtual

Reads SphericalWall from a restart file.

Parameters

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

Reimplemented from BaseWall.

Definition at line 126 of file SphericalWall.cc.

References radius_, and BaseWall::read().

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

void SphericalWall::setRadius ( Mdouble radius )

Defines a spherical wall with radius r.

Definition at line 77 of file SphericalWall.cc.

References logger, and radius_.

Referenced by SphericalWall().

 {
     logger.assert(radius>=0,"radius=% cannot be negative",radius);
     radius_=radius;
 }

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

overridevirtual

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

Parameters

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

Reimplemented from BaseWall.

Definition at line 136 of file SphericalWall.cc.

References radius_, and BaseWall::write().

 {
     BaseWall::write(os);
     os << " radius " << radius_;
 }

Member Data Documentation

Mdouble SphericalWall::radius_

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 119 of file SphericalWall.h.

Referenced by getDistanceAndNormal(), getRadius(), read(), setRadius(), SphericalWall(), and write().

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

Walls/SphericalWall.h
Walls/SphericalWall.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation