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

#include <ParabolaChute.h>

+ Inheritance diagram for ParabolaChute:

Public Member Functions

 ParabolaChute ()
 Default constructor, sets a chute with default parameters. More...
 
 ParabolaChute (const ParabolaChute &other)
 Copy constructor. More...
 
 ParabolaChute (Mdouble length, Mdouble widthscale)
 Constructor in which all parameters are set. More...
 
 ~ParabolaChute () override
 
void set (Mdouble length, Mdouble widthscale)
 
ParabolaChutecopy () const override
 Pure virtual function that can be overwritten in inherited classes in order to copy a BaseWall. 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

Mdouble l_
 
Mdouble ws_
 

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

Parabolic chute Based on the Coil class

Definition at line 34 of file ParabolaChute.h.

Constructor & Destructor Documentation

ParabolaChute::ParabolaChute ( )

Default constructor, sets a chute with default parameters.

Definition at line 30 of file ParabolaChute.cc.

References DEBUG, l_, logger, and ws_.

31 {
32  l_ = 1.0;
33  ws_ = 1.0;
34  logger(DEBUG, "ParabolaChute() constructor finished");
35 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here...
ParabolaChute::ParabolaChute ( const ParabolaChute other)

Copy constructor.

Definition at line 37 of file ParabolaChute.cc.

References DEBUG, l_, logger, and ws_.

37  : BaseWall(other)
38 {
39  l_ = other.l_;
40  ws_ = other.ws_;
41  logger(DEBUG, "ParabolaChute copy constructor finished");
42 }
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
ParabolaChute::ParabolaChute ( Mdouble  length,
Mdouble  widthscale 
)

Constructor in which all parameters are set.

Definition at line 45 of file ParabolaChute.cc.

References DEBUG, l_, logger, and ws_.

46 {
47  l_ = length;
48  ws_ = widthscale;
49  logger(DEBUG, "ParabolaChute(params) constructor finished");
50 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here...
ParabolaChute::~ParabolaChute ( )
override

Definition at line 52 of file ParabolaChute.cc.

References DEBUG, and logger.

53 {
54  logger(DEBUG, "ParabolaChute destructor finished");
55 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here...

Member Function Documentation

ParabolaChute* ParabolaChute::copy ( ) const
overridevirtual

Pure virtual function that can be overwritten in inherited classes in order to copy a BaseWall.

Returns
A pointer to the new BaseWall.

Implements BaseWall.

bool ParabolaChute::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 69 of file ParabolaChute.cc.

References Vec3D::getLength(), BaseInteractable::getPosition(), BaseParticle::getRadius(), BaseParticle::getWallInteractionRadius(), l_, R, mathsFunc::square(), ws_, Vec3D::Y, and Vec3D::Z.

70 {
71  /* Define some shortcuts */
72  Mdouble y0 = p.getPosition().Y;
73  Mdouble z0 = p.getPosition().Z;
74  Mdouble a = p.getRadius();
75 
76  /* First, check whether the particle is definitely out of contact with the
77  * chute. This will be so if the particle's interaction radius is small and
78  * the particle's z-position is high. */
79  // TODO do this properly
80  if (false)
81  {
82  return false;
83  }
84 
85  /* If not, then use Newton's method to minimise (half of the squared) distance */
86  Mdouble R; //TODO
87  Mdouble alpha; //TODO
88  Mdouble dz = p.getPosition().Z; //TODO
89  Mdouble q; // current guess
90  Mdouble dd; // derivative of half of the squared distance at current guess
91  Mdouble ddd; // second derivative at current guess
92  Mdouble q0 = dz / l_; // minimum of the parabolic part
93 
94  // Iterate according to Newton
95  do
96  {
97  dd = -2 * pow(q, 3) / pow(ws_, 2) + (1 - 2 * z0 / ws_) * q - y0;
98  ddd = 6 * pow(q / ws_, 2) + (1 - 2 * z0 / ws_);
99  q -= dd / ddd;
100  } while (fabs(dd / ddd) > 1e-14);
101 
102  // Check whether this location is actually on the parabolic chute, otherwise
103  // a point collision with the end of the chute calculated
104 
105  Mdouble distanceSquared = pow(q - y0, 2) + pow(pow(q, 2) / ws_ - z0, 2);
106  // TODO
107  if (distanceSquared >= mathsFunc::square(p.getWallInteractionRadius(this)))
108  {
109  return false;
110  }
111  else
112  {
113  Vec3D ContactPoint;
114  distance = sqrt(distanceSquared);
115  // ContactPoint.X = // TODO
116  normal_return = ContactPoint - p.getPosition();
117  normal_return /= normal_return.getLength();
118  return true;
119  }
120 }
double Mdouble
Definition: GeneralDefine.h:34
static Mdouble getLength(const Vec3D &a)
Calculates the length of a Vec3D: .
Definition: Vector.cc:331
Definition: Vector.h:49
T square(const T val)
squares a number
Definition: ExtendedMath.h:106
BaseInteraction* ParabolaChute::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:
{DK: What is the contact point for interactions with walls}

Reimplemented from BaseWall.

std::string ParabolaChute::getName ( ) const
overridevirtual

A purely virtual function.

Implements BaseObject.

void ParabolaChute::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.

void ParabolaChute::set ( Mdouble  length,
Mdouble  widthscale 
)

Definition at line 57 of file ParabolaChute.cc.

References l_, and ws_.

58 {
59  l_ = length;
60  ws_ = widthscale;
61 }
void ParabolaChute::write ( std::ostream &  os) const
overridevirtual

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

Reimplemented from BaseWall.

Member Data Documentation

Mdouble ParabolaChute::l_
private

Definition at line 70 of file ParabolaChute.h.

Referenced by getDistanceAndNormal(), ParabolaChute(), and set().

Mdouble ParabolaChute::ws_
private

Definition at line 71 of file ParabolaChute.h.

Referenced by getDistanceAndNormal(), ParabolaChute(), and set().


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