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

This is a class defining walls. More...

#include <BasicUnionOfWalls.h>

+ Inheritance diagram for BasicUnionOfWalls:

Public Member Functions

 BasicUnionOfWalls ()
 Default constructor, the normal is infinitely long. More...
 
 BasicUnionOfWalls (const BasicUnionOfWalls &w)
 Copy constructor, copy the given wall. More...
 
 ~BasicUnionOfWalls () override
 Default destructor. More...
 
BasicUnionOfWallscopy () const override
 Wall copy method. It calls the copy constructor of this Wall, useful for polymorphism. More...
 
unsigned long getNumberOfObjects ()
 Returns the number of objects. More...
 
void add (BaseWall &wall)
 Defines a standard wall, given an outward normal vector s.t. normal*x=normal*point 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 BasicUnionOfWalls from a restart file. More...
 
void oldRead (std::istream &is)
 Reads BasicUnionOfWalls from an old-style restart file. More...
 
void write (std::ostream &os) const override
 Writes the BasicUnionOfWalls 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 "BasicUnionOfWalls". More...
 
void getVTK (std::vector< Vec3D > &points, std::vector< std::vector< double >> &triangleStrips)
 
BaseWallgetObject (unsigned i)
 
- 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

std::vector< BaseWall * > walls_
 

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:

Restriction of a wall to the intersection with another wall

Definition at line 42 of file BasicUnionOfWalls.h.

Constructor & Destructor Documentation

BasicUnionOfWalls::BasicUnionOfWalls ( )

Default constructor, the normal is infinitely long.

Definition at line 35 of file BasicUnionOfWalls.cc.

References DEBUG, and logger.

Referenced by copy().

36 {
37  logger(DEBUG, "BasicUnionOfWalls::BasicUnionOfWalls ) finished");
38 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here...
BasicUnionOfWalls::BasicUnionOfWalls ( const BasicUnionOfWalls b)

Copy constructor, copy the given wall.

Parameters
[in]wBasicUnionOfWalls that has to be copied.

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

Definition at line 45 of file BasicUnionOfWalls.cc.

References DEBUG, logger, and walls_.

46  : BaseWall(b)
47 {
48  for (auto& w : b.walls_)
49  {
50  walls_.push_back(w->copy());
51  }
52  logger(DEBUG, "BasicUnionOfWalls::BasicUnionOfWalls(const BasicUnionOfWalls &p) finished");
53 }
std::vector< BaseWall * > walls_
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
BasicUnionOfWalls::~BasicUnionOfWalls ( )
override

Default destructor.

Definition at line 55 of file BasicUnionOfWalls.cc.

References DEBUG, logger, and walls_.

56 {
57  for (auto& w : walls_)
58  {
59  delete w;
60  }
61  logger(DEBUG, "BasicUnionOfWalls::~BasicUnionOfWalls finished");
62 }
std::vector< BaseWall * > walls_
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here...

Member Function Documentation

void BasicUnionOfWalls::add ( BaseWall wall)

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 BasicUnionOfWalls.cc.

References BaseWall::copy(), and walls_.

91 {
92  walls_.push_back(wall.copy());
93  walls_.back()->setId(walls_.size());
94 }
std::vector< BaseWall * > walls_
virtual BaseWall * copy() const =0
Pure virtual function that can be overwritten in inherited classes in order to copy a BaseWall...
BasicUnionOfWalls * BasicUnionOfWalls::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 67 of file BasicUnionOfWalls.cc.

References BasicUnionOfWalls().

68 {
69  return new BasicUnionOfWalls(*this);
70 }
BasicUnionOfWalls()
Default constructor, the normal is infinitely long.
bool BasicUnionOfWalls::getDistanceAndNormal ( const BaseParticle p,
Mdouble distance,
Vec3D normal 
) 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]normalThe 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.

Return the smallest distance and normal

Implements BaseWall.

Definition at line 103 of file BasicUnionOfWalls.cc.

References BaseInteractable::getOrientation(), BaseInteractable::getPosition(), BaseParticle::getRadius(), BaseInteractable::getSpecies(), Quaternion::rotate(), Quaternion::rotateBack(), BaseInteractable::setPosition(), BaseParticle::setRadius(), BaseParticle::setSpecies(), and walls_.

Referenced by getVTK().

104 {
105  if (walls_.empty()) return false;
106 
107  Vec3D position = p.getPosition() - getPosition();
108  getOrientation().rotateBack(position);
109  SphericalParticle shifted;
110  shifted.setSpecies(p.getSpecies());
111  shifted.setPosition(position);
112  shifted.setRadius(p.getRadius());
113 
114  //check wall after wall; the first wall that returns an interaction is chosen
115  for (auto w : walls_) {
116  if (w->getDistanceAndNormal(shifted, distance, normal) == true) {
117  getOrientation().rotate(normal);
118  return true;
119  }
120  }
121 
122  return false;
123 }
std::vector< BaseWall * > walls_
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
A spherical particle is the most simple particle used in MercuryDPM.
void rotateBack(Vec3D &position) const
Applies the inverse rotation to a position.
Definition: Quaternion.cc:592
const ParticleSpecies * getSpecies() const
Returns a pointer to the species of this BaseInteractable.
virtual void setRadius(Mdouble radius)
Sets the particle's radius_ (and adjusts the mass_ accordingly, based on the particle's species) ...
void setSpecies(const ParticleSpecies *species)
void rotate(Vec3D &position) const
Applies the rotation to a position.
Definition: Quaternion.cc:563
Mdouble getRadius() const
Returns the particle's radius.
Definition: BaseParticle.h:345
void setPosition(const Vec3D &position)
Sets the position of this BaseInteractable.
Definition: Vector.h:49
const Quaternion & getOrientation() const
Returns the orientation of this BaseInteractable.
std::string BasicUnionOfWalls::getName ( ) const
overridevirtual

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

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

Implements BaseObject.

Definition at line 163 of file BasicUnionOfWalls.cc.

164 {
165  return "BasicUnionOfWalls";
166 }
unsigned long BasicUnionOfWalls::getNumberOfObjects ( )

Returns the number of objects.

Suppose your simulation adds to an BasicUnionOfWalls after a certain time or condition is met. Checking the number of objects is useful for checking if this has happened yet, when restarting.

Definition at line 77 of file BasicUnionOfWalls.cc.

References walls_.

78 {
79  return walls_.size();
80 }
std::vector< BaseWall * > walls_
BaseWall * BasicUnionOfWalls::getObject ( unsigned  i)

Definition at line 222 of file BasicUnionOfWalls.cc.

References constants::i, logger, and walls_.

223 {
224  logger.assert_always(walls_.size() > i, "Index % exceeds number of walls %", i, walls_.size());
225  return walls_[i];
226 }
std::vector< BaseWall * > walls_
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here...
const std::complex< Mdouble > i
Definition: ExtendedMath.h:50
void BasicUnionOfWalls::getVTK ( std::vector< Vec3D > &  points,
std::vector< std::vector< double >> &  triangleStrips 
)
Todo:
change getVTK to writeVTK
Parameters
points
triangleStrips
Todo:
this function could be improved; might not plot full wall

Definition at line 168 of file BasicUnionOfWalls.cc.

References getDistanceAndNormal(), BaseInteractable::getOrientation(), BaseInteractable::getSpecies(), constants::i, Quaternion::rotate(), BaseInteractable::setPosition(), BaseParticle::setRadius(), BaseParticle::setSpecies(), and walls_.

169 {
170 // for (auto w : walls_) {
171 // w->writeVTK (points, triangleStrips);
172 // }
173  //writes points and strips for all walls; points are added to the global point vector, but the strips are held back
174  std::vector<std::vector<double>> myTriangleStrips;
175  unsigned long n = points.size();
176  for (auto w : walls_)
177  {
178  w->getVTK(points, myTriangleStrips);
179  }
180  //add position of the BasicUnionOfWalls to the point
181  for (std::vector<Vec3D>::iterator p = points.begin() + n; p != points.end(); p++)
182  {
183  getOrientation().rotate(*p);
184  }
185  //create a vector which points are in the wall (actually, only the new points are necessary)
186  std::vector<bool> pointInWall;
187  pointInWall.reserve(points.size());
188  SphericalParticle particle;
189  particle.setSpecies(getSpecies());
190  particle.setRadius(1e-10); //points within that distance are declared part of the wall
191  Mdouble distance;
192  Vec3D normal;
193  for (auto p : points)
194  {
195  particle.setPosition(p);
196  pointInWall.push_back(getDistanceAndNormal(particle, distance, normal));
197  }
198  //now loop through myTriangleStrips to find the strip parts that are fully inside the wall
199  std::vector<double> strip;
200  for (auto t : myTriangleStrips)
201  {
202  for (unsigned i : t)
203  {
204  if (pointInWall[i] == true)
205  {
206  strip.push_back(i);
207  }
208  else
209  {
210  if (strip.size() > 2)
211  triangleStrips.push_back(strip);
212  strip.clear();
213  }
214  }
215  if (strip.size() > 2)
216  triangleStrips.push_back(strip);
217  strip.clear();
218  }
220 }
std::vector< BaseWall * > walls_
A spherical particle is the most simple particle used in MercuryDPM.
double Mdouble
Definition: GeneralDefine.h:34
const ParticleSpecies * getSpecies() const
Returns a pointer to the species of this BaseInteractable.
virtual void setRadius(Mdouble radius)
Sets the particle's radius_ (and adjusts the mass_ accordingly, based on the particle's species) ...
const std::complex< Mdouble > i
Definition: ExtendedMath.h:50
void setSpecies(const ParticleSpecies *species)
void rotate(Vec3D &position) const
Applies the rotation to a position.
Definition: Quaternion.cc:563
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...
void setPosition(const Vec3D &position)
Sets the position of this BaseInteractable.
Definition: Vector.h:49
const Quaternion & getOrientation() const
Returns the orientation of this BaseInteractable.
void BasicUnionOfWalls::oldRead ( std::istream &  is)

Reads BasicUnionOfWalls from an old-style restart file.

void BasicUnionOfWalls::read ( std::istream &  is)
overridevirtual

Reads BasicUnionOfWalls from a restart file.

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

Reimplemented from BaseWall.

Definition at line 128 of file BasicUnionOfWalls.cc.

References WallHandler::createObject(), BaseWall::getHandler(), constants::i, BaseWall::read(), BaseWall::setHandler(), and walls_.

129 {
130  BaseWall::read(is);
131  std::string dummy;
132  unsigned size;
133  is >> dummy >> size;
134  for (unsigned i = 0; i < size; i++)
135  {
136  std::string type;
137  is >> type;
138  BaseWall* wall = getHandler()->createObject(type);
139  wall->setHandler(getHandler());
140  wall->read(is);
141  walls_.push_back(wall);
142  walls_.back()->setId(walls_.size());
143  }
144 }
std::vector< BaseWall * > walls_
const std::complex< Mdouble > i
Definition: ExtendedMath.h:50
virtual void setHandler(WallHandler *handler)
A function which sets the WallHandler for this BaseWall.
Definition: BaseWall.cc:127
WallHandler * getHandler() const
A function which returns the WallHandler that handles this BaseWall.
Definition: BaseWall.cc:136
static BaseWall * createObject(const std::string &type)
Create a new wall, with the type given as a string (required for restarting).
Definition: WallHandler.cc:123
Basic class for walls.
Definition: BaseWall.h:47
void read(std::istream &is) override
Function that reads a BaseWall from an input stream, usually a restart file.
Definition: BaseWall.cc:80
void BasicUnionOfWalls::write ( std::ostream &  os) const
overridevirtual

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

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

Reimplemented from BaseWall.

Definition at line 149 of file BasicUnionOfWalls.cc.

References walls_, and BaseWall::write().

150 {
151  BaseWall::write(os);
152  os << " numWalls " << walls_.size();
153  for (auto w : walls_)
154  {
155  os << " ";
156  w->write(os);
157  }
158 }
std::vector< BaseWall * > walls_
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

std::vector<BaseWall*> BasicUnionOfWalls::walls_
private

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

Definition at line 114 of file BasicUnionOfWalls.h.

Referenced by add(), BasicUnionOfWalls(), getDistanceAndNormal(), getNumberOfObjects(), getObject(), getVTK(), read(), write(), and ~BasicUnionOfWalls().


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