MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SphericalWall Class Reference

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...
 
 ~SphericalWall () override
 Default destructor. More...
 
SphericalWallcopy () 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. More...
 
 BaseWall (const BaseWall &w)
 Copy constructor. More...
 
 ~BaseWall () override
 Default destructor. More...
 
virtual bool getDistanceNormalOverlap (const BaseParticle &P, Mdouble &distance, Vec3D &normal_return, Mdouble &overlap) const
 
virtual bool getDistanceNormalOverlapSuperquadric (const SuperQuadricParticle &p, Mdouble &distance, Vec3D &normal_return, Mdouble &overlap) const
 
virtual Vec3D getFurthestPointSuperQuadric (const Vec3D &normalBodyFixed, const Vec3D &axes, Mdouble eps1, Mdouble eps2) const
 
virtual void setHandler (WallHandler *handler)
 A function which sets the WallHandler for this BaseWall. More...
 
WallHandlergetHandler () const
 A function which returns the WallHandler that handles this BaseWall. More...
 
void setIndSpecies (unsigned int indSpecies) override
 Define the species of this wall using the index of the species in the SpeciesHandler in this DPMBase. More...
 
void setSpecies (const ParticleSpecies *species)
 Defines the species of the current wall. More...
 
bool isFixed () const override
 
void setForceControl (Vec3D forceGoal, Vec3D gainFactor, Vec3D baseVelocity={0, 0, 0})
 Slowly adjusts the force on a wall towards a specified goal, by adjusting (prescribing) the velocity of the wall. More...
 
virtual bool isLocal (Vec3D &min, Vec3D &max) const
 
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, Vec3D normal, Vec3D position) const
 
virtual BaseInteractiongetInteractionWithSuperQuad (SuperQuadricParticle *p, unsigned timeStamp, InteractionHandler *interactionHandler)
 
virtual void writeVTK (VTKContainer &vtk) const
 
void getVTK (std::vector< Vec3D > &points, std::vector< std::vector< double >> &triangleStrips)
 
const Vec3D getAxis () const
 
BaseInteractiongetInteractionWith (BaseParticle *p, unsigned timeStamp, InteractionHandler *interactionHandler) override
 Returns the interaction between this wall and a given particle, nullptr if there is no interaction. More...
 
virtual void actionsOnRestart ()
 No implementation but can be overidden in its derived classes. More...
 
virtual void actionsAfterParticleGhostUpdate ()
 No implementation but can be overidden in its derived classes. More...
 
virtual void handleParticleAddition (unsigned int id, BaseParticle *p)
 Handles the addition of particles to the particleHandler. More...
 
virtual void handleParticleRemoval (unsigned int id)
 Handles the addition of particles to the particleHandler. More...
 
virtual void checkInteractions (InteractionHandler *interactionHandler, unsigned int timeStamp)
 Check if all interactions are valid. More...
 
bool getVTKVisibility () const
 
void setVTKVisibility (bool vtkVisibility)
 
void addRenderedWall (BaseWall *w)
 
BaseWallgetRenderedWall (size_t i) const
 
void removeRenderedWalls ()
 
void renderWall (VTKContainer &vtk)
 
void addParticlesAtWall (unsigned numElements=50)
 
void setVelocityControl (Vec3D forceGoal, Vec3D gainFactor, Vec3D baseVelocity)
 
- Public Member Functions inherited from BaseInteractable
 BaseInteractable ()
 Default BaseInteractable constructor. More...
 
 BaseInteractable (const BaseInteractable &p)
 Copy constructor. More...
 
 ~BaseInteractable () override
 Destructor, it simply destructs the BaseInteractable and all the objects it contains. More...
 
unsigned int getIndSpecies () const
 Returns the index of the species associated with the interactable object. More...
 
const ParticleSpeciesgetSpecies () const
 Returns a pointer to the species of this BaseInteractable. More...
 
void setSpecies (const ParticleSpecies *species)
 Sets the species of this BaseInteractable. More...
 
const Vec3DgetForce () const
 Returns the force on this BaseInteractable. More...
 
const Vec3DgetTorque () 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...
 
void resetForceTorque (int numberOfOMPthreads)
 
void sumForceTorqueOMP ()
 
const Vec3DgetPosition () const
 Returns the position of this BaseInteractable. More...
 
const QuaterniongetOrientation () const
 Returns the orientation of this BaseInteractable. More...
 
void setPosition (const Vec3D &position)
 Sets the position of this BaseInteractable. More...
 
void setOrientationViaNormal (Vec3D normal)
 Sets the orientation of this BaseInteractable by defining the vector that results from the rotation of the (1,0,0) vector. More...
 
void setOrientationViaEuler (Vec3D eulerAngle)
 Sets the orientation of this BaseInteractable by defining the euler angles. More...
 
void setOrientation (const Quaternion &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...
 
virtual void rotate (const Vec3D &angularVelocityDt)
 Rotates this BaseInteractable. More...
 
const std::vector
< BaseInteraction * > & 
getInteractions () const
 Returns a list of interactions which belong to this interactable. 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 Vec3DgetVelocity () const
 Returns the velocity of this interactable. More...
 
virtual const Vec3DgetAngularVelocity () 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< Quaternion(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...
 
virtual Mdouble getInvMass () const
 
virtual Mdouble getCurvature (const Vec3D &labFixedCoordinates) const
 
- Public Member Functions inherited from BaseObject
 BaseObject ()=default
 Default constructor. More...
 
 BaseObject (const BaseObject &p)=default
 Copy constructor, copies all the objects BaseObject contains. More...
 
virtual ~BaseObject ()=default
 virtual destructor More...
 
virtual void moveInHandler (unsigned int index)
 Except that it is virtual, it does the same thing as setIndex() does. More...
 
void setIndex (unsigned int index)
 Allows one to assign an index to an object in the handler/container. More...
 
void setId (unsigned long 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...
 
void setGroupId (unsigned groupId)
 
unsigned getGroupId () const
 

Private Attributes

Mdouble radius_
 

Additional Inherited Members

- Static Public Member Functions inherited from BaseWall
static void addToVTK (const std::vector< Vec3D > &points, VTKContainer &vtk)
 Takes the points provided and adds a triangle strip connecting these points to the vtk container. More...
 

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 34 of file SphericalWall.cc.

References DEBUG, logger, and radius_.

Referenced by copy().

35 {
36  radius_ = std::numeric_limits<double>::quiet_NaN();
37  logger(DEBUG, "SphericalWall::SphericalWall ) finished");
38 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here...
SphericalWall::SphericalWall ( const SphericalWall w)

Copy constructor, copy the given wall.

Parameters
[in]wSphericalWall 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 45 of file SphericalWall.cc.

References DEBUG, logger, and radius_.

46  : BaseWall(w)
47 {
48  radius_ = w.radius_;
49  logger(DEBUG, "SphericalWall::SphericalWall(const SphericalWall &p) finished");
50 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here...
BaseWall()
Default constructor.
Definition: BaseWall.cc:36
SphericalWall::SphericalWall ( Mdouble  radius,
const ParticleSpecies species 
)

Constructor setting values.

Definition at line 52 of file SphericalWall.cc.

References setRadius().

53 {
54  setRadius(radius);
55 }
void setRadius(Mdouble radius)
Defines a spherical wall with radius r.
SphericalWall::~SphericalWall ( )
override

Default destructor.

Definition at line 57 of file SphericalWall.cc.

References DEBUG, and logger.

58 {
59  logger(DEBUG, "SphericalWall::~SphericalWall finished");
60 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here...

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 65 of file SphericalWall.cc.

References SphericalWall().

66 {
67  return new SphericalWall(*this);
68 }
SphericalWall()
Default constructor, the normal is infinitely long.
Mdouble SphericalWall::getDistance ( const Vec3D otherPosition) const

Returns the distance of the wall to the particle.

Parameters
[in]otherPositionThe position to which the distance must be computed to.
Returns
The distance of the wall to the particle.

Definition at line 86 of file SphericalWall.cc.

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

87 {
88  return Vec3D::getLength(getPosition() - otherPosition);
89 }
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
Mdouble getLength() const
Calculates the length of this Vec3D: .
Definition: Vector.cc:320
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]pBaseParticle for which the distance to the wall must be computed.
[out]distanceDistance between the particle and the wall.
[out]normal_returnThe 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 111 of file SphericalWall.cc.

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

112 {
113  normal_return = p.getPosition() - getPosition();
114  distance = Vec3D::getLength(normal_return) - radius_;
115  if (distance >= p.getWallInteractionRadius(this))
116  return false;
117  normal_return /= distance + radius_;
118  //logger(WARN,"p% q% q% q% q%", getPosition(), p.getPosition(), normal_return, distance, p.getWallInteractionRadius(this));
119  return true;
120 }
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
Mdouble getWallInteractionRadius(const BaseWall *wall) const
returns the radius plus the interactionDistance
Definition: BaseParticle.h:386
Mdouble getLength() const
Calculates the length of this Vec3D: .
Definition: Vector.cc:320
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 144 of file SphericalWall.cc.

145 {
146  return "SphericalWall";
147 }
Mdouble SphericalWall::getRadius ( ) const

Returns the distance of the wall to the particle.

Returns
The radius of the wall .

Definition at line 94 of file SphericalWall.cc.

References radius_.

95 {
96  return radius_;
97 }
void SphericalWall::read ( std::istream &  is)
overridevirtual

Reads SphericalWall from a restart file.

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

Reimplemented from BaseWall.

Definition at line 125 of file SphericalWall.cc.

References radius_, and BaseWall::read().

126 {
127  BaseWall::read(is);
128  std::string dummy;
129  is >> dummy >> radius_;
130 }
void read(std::istream &is) override
Function that reads a BaseWall from an input stream, usually a restart file.
Definition: BaseWall.cc:80
void SphericalWall::setRadius ( Mdouble  radius)

Defines a spherical wall with radius r.

Definition at line 76 of file SphericalWall.cc.

References logger, and radius_.

Referenced by SphericalWall().

77 {
78  logger.assert_debug(radius >= 0, "radius=% cannot be negative", radius);
79  radius_ = radius;
80 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here...
void SphericalWall::write ( std::ostream &  os) const
overridevirtual

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

Parameters
[in]osThe output stream the SphericalWall is written to.

Reimplemented from BaseWall.

Definition at line 135 of file SphericalWall.cc.

References radius_, and BaseWall::write().

136 {
137  BaseWall::write(os);
138  os << " radius " << radius_;
139 }
void write(std::ostream &os) const override
Function that writes a BaseWall to an output stream, usually a restart file.
Definition: BaseWall.cc:102

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: