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

#include <CylindricalWall.h>

+ Inheritance diagram for CylindricalWall:

Public Member Functions

 CylindricalWall ()
 
 CylindricalWall (const CylindricalWall &p)
 
 CylindricalWall (double radius)
 
CylindricalWallcopy () const override
 Wall copy method. It calls the copy contrustor of this Wall, usefull for polymorfism. More...
 
void set (Mdouble radius)
 Defines a standard wall, given an outward normal vector s. t. normal*x=position. More...
 
bool getDistanceAndNormal (const BaseParticle &P, Mdouble &distance, Vec3D &normal_return) const override
 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. More...
 
void read (std::istream &is) override
 reads wall More...
 
void oldRead (std::istream &is)
 
void write (std::ostream &os) const override
 outputs wall More...
 
std::string getName () const override
 Returns the name of the object. More...
 
double getRadius () const
 access function for radius 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...
 
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

Deprecated:
This class will be gone in Mercury 2.0, use AxisymmetricIntersectionOfWalls instead.

Definition at line 37 of file CylindricalWall.h.

Constructor & Destructor Documentation

CylindricalWall::CylindricalWall ( )

Definition at line 32 of file CylindricalWall.cc.

References radius_.

Referenced by copy().

33  : BaseWall()
34 {
35  radius_ = std::numeric_limits<double>::quiet_NaN();
36 #ifdef DEBUG_CONSTRUCTOR
37  std::cout<<"CylindricalWall () finished"<<std::endl;
38 #endif
39 }
BaseWall()
Default constructor.
Definition: BaseWall.cc:36
CylindricalWall::CylindricalWall ( const CylindricalWall p)

Definition at line 41 of file CylindricalWall.cc.

References radius_.

42  : BaseWall(p)
43 {
44  radius_ = p.radius_;
45 #ifdef DEBUG_CONSTRUCTOR
46  std::cout<<"CylindricalWall (const CylindricalWall &p) finished"<<std::endl;
47 #endif
48 }
BaseWall()
Default constructor.
Definition: BaseWall.cc:36
CylindricalWall::CylindricalWall ( double  radius)
explicit

Definition at line 50 of file CylindricalWall.cc.

References radius_.

51  : BaseWall()
52 {
53  this->radius_ = radius;
54 #ifdef DEBUG_CONSTRUCTOR
55  std::cout<<"CylindricalWall (double radius) finished"<<std::endl;
56 #endif
57 }
BaseWall()
Default constructor.
Definition: BaseWall.cc:36

Member Function Documentation

CylindricalWall * CylindricalWall::copy ( ) const
overridevirtual

Wall copy method. It calls the copy contrustor of this Wall, usefull for polymorfism.

Implements BaseWall.

Definition at line 60 of file CylindricalWall.cc.

References CylindricalWall().

61 {
62  return new CylindricalWall(*this);
63 }
bool CylindricalWall::getDistanceAndNormal ( const BaseParticle P,
Mdouble distance,
Vec3D normal_return 
) const
overridevirtual

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 72 of file CylindricalWall.cc.

References Vec3D::getLength(), BaseInteractable::getPosition(), BaseParticle::getRadius(), R, radius_, Vec3D::X, Vec3D::Y, and Vec3D::Z.

73 {
74  double R = sqrt(pow(P.getPosition().X, 2) + pow(P.getPosition().Y, 2));
75  distance = radius_ - R;
76  if (distance >= P.getRadius())
77  return false;
78 
79  normal_return.X = P.getPosition().X;
80  normal_return.Y = P.getPosition().Y;
81  normal_return.Z = 0.0;
82  normal_return /= normal_return.getLength();
83 
84  return true;
85 }
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
Mdouble X
the vector components
Definition: Vector.h:65
static Mdouble getLength(const Vec3D &a)
Calculates the length of a Vec3D: .
Definition: Vector.cc:331
Mdouble getRadius() const
Returns the particle's radius.
Definition: BaseParticle.h:345
Mdouble Y
Definition: Vector.h:65
Mdouble Z
Definition: Vector.h:65
std::string CylindricalWall::getName ( ) const
overridevirtual

Returns the name of the object.

Implements BaseObject.

Definition at line 108 of file CylindricalWall.cc.

109 {
110  return "CylindricalWall";
111 }
double CylindricalWall::getRadius ( ) const

access function for radius

Definition at line 114 of file CylindricalWall.cc.

References radius_.

115 {
116  return radius_;
117 }
void CylindricalWall::oldRead ( std::istream &  is)

Definition at line 95 of file CylindricalWall.cc.

References radius_.

96 {
97  std::string dummy;
98  is >> dummy >> radius_;
99 }
void CylindricalWall::read ( std::istream &  is)
overridevirtual

reads wall

Reimplemented from BaseWall.

Definition at line 88 of file CylindricalWall.cc.

References radius_, and BaseWall::read().

89 {
90  BaseWall::read(is);
91  std::string dummy;
92  is >> dummy >> radius_;
93 }
void read(std::istream &is) override
Function that reads a BaseWall from an input stream, usually a restart file.
Definition: BaseWall.cc:80
void CylindricalWall::set ( Mdouble  radius)

Defines a standard wall, given an outward normal vector s. t. normal*x=position.

Definition at line 66 of file CylindricalWall.cc.

References radius_.

67 {
68  this->radius_ = radius;
69 }
void CylindricalWall::write ( std::ostream &  os) const
overridevirtual

outputs wall

Reimplemented from BaseWall.

Definition at line 102 of file CylindricalWall.cc.

References radius_, and BaseWall::write().

103 {
104  BaseWall::write(os);
105  os << " radius " << radius_;
106 }
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 CylindricalWall::radius_
private

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