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

#include <Combtooth.h>

+ Inheritance diagram for Combtooth:

Public Member Functions

 Combtooth ()
 Default constructor. More...
 
 Combtooth (const Combtooth &ct)
 Copy constructor. More...
 
 ~Combtooth () override
 Default destructor. More...
 
void set (Vec3D axis, Vec3D position, Mdouble radius)
 Set. More...
 
Combtoothcopy () const override
 Copy. More...
 
bool getDistanceAndNormal (const BaseParticle &p, Mdouble &distance, Vec3D &normal_return) const override
 Pure virtual function that computes the distance of a BaseParticle to this wall and returns the normal of this wall if there is a collision. More...
 
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...
 
void read (std::istream &is) override
 Function that reads a BaseWall from an input stream, usually a restart file. More...
 
void write (std::ostream &os) const override
 Function that writes a BaseWall to an output stream, usually a restart file. More...
 
std::string getName () const override
 A purely virtual function. 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
 
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

Vec3D axis_
 
Vec3D position_
 
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

Definition at line 33 of file Combtooth.h.

Constructor & Destructor Documentation

Combtooth::Combtooth ( )

Default constructor.

Definition at line 31 of file Combtooth.cc.

References axis_, position_, and radius_.

Referenced by copy().

32 {
33  axis_ = Vec3D(0, 0, 1);
34  position_ = Vec3D(0, 0, 0);
35  radius_ = 1;
36 }
Vec3D position_
Definition: Combtooth.h:76
Vec3D axis_
Definition: Combtooth.h:75
Mdouble radius_
Definition: Combtooth.h:77
Definition: Vector.h:49
Combtooth::Combtooth ( const Combtooth ct)

Copy constructor.

Definition at line 38 of file Combtooth.cc.

References axis_, Vec3D::getLength(), position_, and radius_.

38  : BaseWall(other)
39 {
40  axis_ = other.axis_;
41  position_ = other.position_;
42  radius_ = other.radius_;
43 
44  /* Normalise axis_ */
45  axis_ /= axis_.getLength();
46 }
Vec3D position_
Definition: Combtooth.h:76
static Mdouble getLength(const Vec3D &a)
Calculates the length of a Vec3D: .
Definition: Vector.cc:331
Vec3D axis_
Definition: Combtooth.h:75
Mdouble radius_
Definition: Combtooth.h:77
BaseWall()
Default constructor.
Definition: BaseWall.cc:36
Combtooth::~Combtooth ( )
overridedefault

Default destructor.

Member Function Documentation

Combtooth * Combtooth::copy ( ) const
overridevirtual

Copy.

Implements BaseWall.

Definition at line 57 of file Combtooth.cc.

References Combtooth().

58 {
59  return new Combtooth(*this);
60 }
Combtooth()
Default constructor.
Definition: Combtooth.cc:31
bool Combtooth::getDistanceAndNormal ( const BaseParticle P,
Mdouble distance,
Vec3D normal_return 
) const
overridevirtual

Pure virtual function that computes the distance of a BaseParticle to this wall and returns the normal of this wall if there is a collision.

Beware, the distance and normal are output parameters, not return values!

Parameters
[in]PReference to the BaseParticle we want to compute the distance to the BaseWall of.
[out]distanceDistance of the BaseParticle to the BaseWall.
[out]normal_returnThe normal of the wall. Is only given if there is a collision.
Returns
A boolean which indicates if there is a collision between the BaseParticle and the wall.

Implements BaseWall.

Definition at line 62 of file Combtooth.cc.

References axis_, Vec3D::dot(), Vec3D::getLength(), BaseInteractable::getPosition(), BaseParticle::getWallInteractionRadius(), position_, radius_, Vec3D::X, Vec3D::Y, and Vec3D::Z.

Referenced by getInteractionWith().

64 {
65  /* define shortcuts */
66  const Mdouble x0 = p.getPosition().X;
67  const Mdouble y0 = p.getPosition().Y;
68  const Mdouble z0 = p.getPosition().Z;
69  const Mdouble ra = p.getWallInteractionRadius(this); // note, not getRadius()
70 
71  // distance between x0 and the *surface* (not the axis)
72  distance = sqrt(
73  pow((p.getPosition() - position_).getLength(), 2)
74  - pow(Vec3D::dot(p.getPosition() - position_, axis_), 2)
75  ) - radius_;
76  if (distance >= p.getWallInteractionRadius(this))
77  return false;
78  else
79  {
80  Vec3D axisContactPoint; // the point on the axis closest to the particle
81  axisContactPoint = position_ + Vec3D::dot(p.getPosition() - position_, axis_) * axis_;
82  normal_return = (axisContactPoint - p.getPosition()); // inward-pointing normal
83  normal_return /= normal_return.getLength();
84  return true;
85  }
86 }
Vec3D position_
Definition: Combtooth.h:76
double Mdouble
Definition: GeneralDefine.h:34
static Mdouble dot(const Vec3D &a, const Vec3D &b)
Calculates the dot product of two Vec3D: .
Definition: Vector.cc:76
static Mdouble getLength(const Vec3D &a)
Calculates the length of a Vec3D: .
Definition: Vector.cc:331
Vec3D axis_
Definition: Combtooth.h:75
Mdouble radius_
Definition: Combtooth.h:77
Definition: Vector.h:49
BaseInteraction * Combtooth::getInteractionWith ( BaseParticle p,
unsigned  timeStamp,
InteractionHandler interactionHandler 
)
overridevirtual

Returns the interaction between this wall and a given particle, nullptr if there is no interaction.

Parameters
[in]pPointer to the BaseParticle which we want to check the interaction for.
[in]timeStampThe time at which we want to look at the interaction.
[in]interactionHandlerA pointer to the InteractionHandler in which the interaction can be found.
Returns
A pointer to the BaseInteraction that happened between this BaseWall and the BaseParticle at the timeStamp.
Todo:
Quick hack JMF2 please clean up with teh new way
Todo:
{DK: What is the contact point for interactions with walls}

Reimplemented from BaseWall.

Definition at line 88 of file Combtooth.cc.

References getDistanceAndNormal(), InteractionHandler::getInteraction(), BaseInteraction::getNormal(), BaseInteraction::getOverlap(), BaseInteractable::getPosition(), BaseParticle::getRadius(), BaseInteraction::setContactPoint(), BaseInteraction::setDistance(), BaseInteraction::setNormal(), and BaseInteraction::setOverlap().

90 {
91  Mdouble distance;
92  Vec3D normal;
93  if (getDistanceAndNormal(*p, distance, normal))
94  {
95  BaseInteraction* c = interactionHandler->getInteraction(p, this, timeStamp);
96  c->setNormal(-normal); // outward-pointing normal to cylinder
97  c->setDistance(distance);
98  c->setOverlap(p->getRadius() - distance);
100  c->setContactPoint(p->getPosition() - (p->getRadius() - 0.5 * c->getOverlap()) * c->getNormal());
101  return c;
102  }
103  else
104  return nullptr;
105 }
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
void setNormal(Vec3D normal)
Sets the normal vector between the two interacting objects.
void setOverlap(Mdouble overlap)
Set the overlap between the two interacting object.
double Mdouble
Definition: GeneralDefine.h:34
void setContactPoint(Vec3D contactPoint)
Set the location of the contact point between the two interacting objects.
void setDistance(Mdouble distance)
Sets the interaction distance between the two interacting objects.
Stores information about interactions between two interactable objects; often particles but could be ...
const Vec3D & getNormal() const
Gets the normal vector between the two interacting objects.
BaseInteraction * getInteraction(BaseInteractable *P, BaseInteractable *I, unsigned timeStamp)
Returns the Interaction between the BaseInteractable's P and I.
Mdouble getRadius() const
Returns the particle's radius.
Definition: BaseParticle.h:348
Mdouble getOverlap() const
Returns a Mdouble with the current overlap between the two interacting objects.
bool getDistanceAndNormal(const BaseParticle &p, Mdouble &distance, Vec3D &normal_return) const override
Pure virtual function that computes the distance of a BaseParticle to this wall and returns the norma...
Definition: Combtooth.cc:62
Definition: Vector.h:49
std::string Combtooth::getName ( ) const
overridevirtual

A purely virtual function.

Implements BaseObject.

Definition at line 124 of file Combtooth.cc.

125 {
126  return "Combtooth";
127 }
void Combtooth::read ( std::istream &  is)
overridevirtual

Function that reads a BaseWall from an input stream, usually a restart file.

The BaseWall takes no more information than for a BaseInteractable. (A derived class' read method does most of the work.)

Parameters
[in]is- The input stream from which the BaseWall is read.

Reimplemented from BaseWall.

Definition at line 107 of file Combtooth.cc.

References axis_, position_, radius_, and BaseWall::read().

108 {
109  BaseWall::read(is);
110  std::string dummy;
111  is >> dummy >> axis_
112  >> dummy >> position_
113  >> dummy >> radius_;
114 }
Vec3D position_
Definition: Combtooth.h:76
Vec3D axis_
Definition: Combtooth.h:75
Mdouble radius_
Definition: Combtooth.h:77
void read(std::istream &is) override
Function that reads a BaseWall from an input stream, usually a restart file.
Definition: BaseWall.cc:80
void Combtooth::set ( Vec3D  axis,
Vec3D  position,
Mdouble  radius 
)

Set.

Definition at line 50 of file Combtooth.cc.

References axis_, Vec3D::getLength(), position_, and radius_.

51 {
52  axis_ = axis / axis.getLength();
53  position_ = position;
54  radius_ = radius;
55 }
Vec3D position_
Definition: Combtooth.h:76
static Mdouble getLength(const Vec3D &a)
Calculates the length of a Vec3D: .
Definition: Vector.cc:331
Vec3D axis_
Definition: Combtooth.h:75
Mdouble radius_
Definition: Combtooth.h:77
void Combtooth::write ( std::ostream &  os) const
overridevirtual

Function that writes a BaseWall to an output stream, usually a restart file.

Reimplemented from BaseWall.

Definition at line 116 of file Combtooth.cc.

References axis_, position_, radius_, and BaseWall::write().

117 {
118  BaseWall::write(os);
119  os << " axis " << axis_
120  << " position " << position_
121  << " radius " << radius_;
122 }
Vec3D position_
Definition: Combtooth.h:76
void write(std::ostream &os) const override
Function that writes a BaseWall to an output stream, usually a restart file.
Definition: BaseWall.cc:102
Vec3D axis_
Definition: Combtooth.h:75
Mdouble radius_
Definition: Combtooth.h:77

Member Data Documentation

Vec3D Combtooth::axis_
private

Definition at line 75 of file Combtooth.h.

Referenced by Combtooth(), getDistanceAndNormal(), read(), set(), and write().

Vec3D Combtooth::position_
private

Definition at line 76 of file Combtooth.h.

Referenced by Combtooth(), getDistanceAndNormal(), read(), set(), and write().

Mdouble Combtooth::radius_
private

Definition at line 77 of file Combtooth.h.

Referenced by Combtooth(), getDistanceAndNormal(), read(), set(), and write().


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