BaseWall.h
Go to the documentation of this file.
1 // This file is part of the MercuryDPM project (https://www.mercurydpm.org).
2 // Copyright (c), The MercuryDPM Developers Team. All rights reserved.
3 // License: BSD 3-Clause License; see the LICENSE file in the root directory.
4 
5 #ifndef BASEWALL_H
6 #define BASEWALL_H
7 
8 #include "BaseInteractable.h"
10 #include "VTKWriter/VTKData.h"
11 
12 class WallHandler;
13 
14 class BaseParticle;
15 
17 {
18  std::vector<Vec3D> points;
19  std::vector<std::vector<double>> triangleStrips;
20 };
21 
27 class BaseWall : public BaseInteractable
28 {
29 public:
33  BaseWall();
34 
38  BaseWall(const BaseWall& w);
39 
43  ~BaseWall() override;
44 
49  virtual BaseWall* copy() const = 0;
50 
54  void read(std::istream& is) override;
55 
59  void write(std::ostream& os) const override;
60 
69  virtual bool getDistanceAndNormal(const BaseParticle& P, Mdouble& distance, Vec3D& normal_return) const = 0;
70 
71 
72  virtual bool
73  getDistanceNormalOverlap(const BaseParticle& P, Mdouble& distance, Vec3D& normal_return, Mdouble& overlap) const;
74 
75  virtual bool getDistanceNormalOverlapSuperquadric(const SuperQuadricParticle& p, Mdouble& distance, Vec3D& normal_return,
76  Mdouble& overlap) const;
77 
78  virtual Vec3D
79  getFurthestPointSuperQuadric(const Vec3D& normalBodyFixed, const Vec3D& axes, Mdouble eps1, Mdouble eps2) const;
80 
84  virtual void setHandler(WallHandler* handler);
85 
89  WallHandler* getHandler() const;
90 
95  void setIndSpecies(unsigned int indSpecies) override;
96 
101  void setSpecies(const ParticleSpecies* species);
102 
107  bool isFixed() const override;
108 
112  void setForceControl(Vec3D forceGoal, Vec3D gainFactor, Vec3D baseVelocity={0,0,0});
113 
117  virtual bool isLocal(Vec3D& min, Vec3D& max) const
118  { return false; }
119 
120  // returns the point intersecting a wall (x-p).n=0 and a line x=p0+t(p1-p0)
121  bool getLinePlaneIntersect(Vec3D& intersect, const Vec3D& p0, const Vec3D& p1, const Vec3D& n, const Vec3D& p);
122  bool isInsideWallVTK(const Vec3D& point, const Vec3D& normal, const Vec3D& position) const;
126 
130  void projectOntoWallVTK(Vec3D& point0, const Vec3D& point1, const Vec3D& normal, const Vec3D& position) const;
131 
136  void intersectVTK(std::vector<Vec3D>& points, Vec3D normal, Vec3D position) const;
137 
138 
139  virtual BaseInteraction*
140  getInteractionWithSuperQuad(SuperQuadricParticle* p, unsigned timeStamp, InteractionHandler* interactionHandler);
141 
147  virtual void writeVTK(VTKContainer& vtk) const;
148 
149  void getVTK(std::vector<Vec3D>& points, std::vector<std::vector<double>>& triangleStrips)
150  {}
151 
152  const Vec3D getAxis() const;
153 
156  getInteractionWith(BaseParticle* p, unsigned timeStamp, InteractionHandler* interactionHandler) override;
157 
163  virtual void actionsOnRestart() {}
164 
173 
182  virtual void handleParticleAddition(unsigned int id, BaseParticle* p) {}
183 
191  virtual void handleParticleRemoval(unsigned int id) {}
192 
199  virtual void checkInteractions(InteractionHandler* interactionHandler, unsigned int timeStamp) {}
200 
201  bool getVTKVisibility() const;
202 
203  void setVTKVisibility(bool vtkVisibility);
204 
208  static void addToVTK(const std::vector<Vec3D>& points, VTKContainer& vtk);
209 
210  //todo how do i write a copy and add function?
211  void addRenderedWall(BaseWall* w);
212 
213  BaseWall* getRenderedWall(size_t i) const;
214 
215  std::vector<BaseWall*> getRenderedWalls() const;
216 
217  void removeRenderedWalls();
218 
219  void renderWall(VTKContainer& vtk);
220 
221  void addParticlesAtWall(unsigned numElements = 50);
222 
223  void setVelocityControl(Vec3D forceGoal, Vec3D gainFactor, Vec3D baseVelocity);
224 
225  virtual void writeWallDetailsVTK(VTKData& data) const { };
226 
227  virtual void computeWear() { };
228 
229 private:
234 
235  bool vtkVisibility_ = true;
236 
240  std::vector<BaseWall*> renderedWalls_;
241 
242 };
243 
244 #endif
int i
Definition: BiCGSTAB_step_by_step.cpp:9
const unsigned n
Definition: CG3DPackingUnitTest.cpp:11
int data[]
Definition: Map_placement_new.cpp:1
Vector3f p0
Definition: MatrixBase_all.cpp:2
Vector3f p1
Definition: MatrixBase_all.cpp:2
RowVector3d w
Definition: Matrix_resize_int.cpp:3
float * p
Definition: Tutorial_Map_using.cpp:9
Defines the basic properties that a interactable object can have.
Definition: BaseInteractable.h:34
Stores information about interactions between two interactable objects; often particles but could be ...
Definition: BaseInteraction.h:39
Definition: BaseParticle.h:33
Basic class for walls.
Definition: BaseWall.h:28
virtual void actionsOnRestart()
No implementation but can be overidden in its derived classes.
Definition: BaseWall.h:163
void renderWall(VTKContainer &vtk)
Definition: BaseWall.cc:557
std::vector< BaseWall * > getRenderedWalls() const
Definition: BaseWall.cc:552
virtual BaseWall * copy() const =0
Pure virtual function that can be overwritten in inherited classes in order to copy a BaseWall.
virtual void writeWallDetailsVTK(VTKData &data) const
Definition: BaseWall.h:225
virtual void actionsAfterParticleGhostUpdate()
No implementation but can be overidden in its derived classes.
Definition: BaseWall.h:172
void setIndSpecies(unsigned int indSpecies) override
Define the species of this wall using the index of the species in the SpeciesHandler in this DPMBase.
Definition: BaseWall.cc:121
virtual bool getDistanceNormalOverlapSuperquadric(const SuperQuadricParticle &p, Mdouble &distance, Vec3D &normal_return, Mdouble &overlap) const
Definition: BaseWall.cc:522
void addParticlesAtWall(unsigned numElements=50)
Definition: BaseWall.cc:597
void setVTKVisibility(bool vtkVisibility)
Definition: BaseWall.cc:500
void intersectVTK(std::vector< Vec3D > &points, Vec3D normal, Vec3D position) const
Definition: BaseWall.cc:220
void projectOntoWallVTK(Vec3D &point0, const Vec3D &point1, const Vec3D &normal, const Vec3D &position) const
Definition: BaseWall.cc:210
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.
Definition: BaseWall.cc:453
void addRenderedWall(BaseWall *w)
Definition: BaseWall.cc:536
virtual void checkInteractions(InteractionHandler *interactionHandler, unsigned int timeStamp)
Check if all interactions are valid.
Definition: BaseWall.h:199
void setVelocityControl(Vec3D forceGoal, Vec3D gainFactor, Vec3D baseVelocity)
Definition: BaseWall.cc:590
WallHandler * getHandler() const
A function which returns the WallHandler that handles this BaseWall.
Definition: BaseWall.cc:113
void write(std::ostream &os) const override
Function that writes a BaseWall to an output stream, usually a restart file.
Definition: BaseWall.cc:79
virtual void handleParticleRemoval(unsigned int id)
Handles the addition of particles to the particleHandler.
Definition: BaseWall.h:191
void removeRenderedWalls()
Definition: BaseWall.cc:541
virtual void setHandler(WallHandler *handler)
A function which sets the WallHandler for this BaseWall.
Definition: BaseWall.cc:104
virtual Vec3D getFurthestPointSuperQuadric(const Vec3D &normalBodyFixed, const Vec3D &axes, Mdouble eps1, Mdouble eps2) const
Definition: BaseWall.cc:529
const Vec3D getAxis() const
Definition: BaseWall.cc:485
virtual void handleParticleAddition(unsigned int id, BaseParticle *p)
Handles the addition of particles to the particleHandler.
Definition: BaseWall.h:182
bool isInsideWallVTK(const Vec3D &point, const Vec3D &normal, const Vec3D &position) const
Definition: BaseWall.cc:199
virtual void writeVTK(VTKContainer &vtk) const
Definition: BaseWall.cc:448
virtual bool isLocal(Vec3D &min, Vec3D &max) const
Definition: BaseWall.h:117
std::vector< BaseWall * > renderedWalls_
Definition: BaseWall.h:240
bool vtkVisibility_
Definition: BaseWall.h:235
~BaseWall() override
Default destructor.
Definition: BaseWall.cc:45
WallHandler * handler_
Definition: BaseWall.h:227
void read(std::istream &is) override
Function that reads a BaseWall from an input stream, usually a restart file.
Definition: BaseWall.cc:57
bool getLinePlaneIntersect(Vec3D &intersect, const Vec3D &p0, const Vec3D &p1, const Vec3D &n, const Vec3D &p)
Definition: BaseWall.cc:183
virtual BaseInteraction * getInteractionWithSuperQuad(SuperQuadricParticle *p, unsigned timeStamp, InteractionHandler *interactionHandler)
Definition: BaseWall.cc:476
BaseWall()
Default constructor.
Definition: BaseWall.cc:15
bool isFixed() const override
Definition: BaseWall.cc:165
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 ...
Definition: BaseWall.cc:175
void setSpecies(const ParticleSpecies *species)
Defines the species of the current wall.
Definition: BaseWall.cc:148
bool getVTKVisibility() const
Definition: BaseWall.cc:495
virtual void computeWear()
Definition: BaseWall.h:227
BaseWall * getRenderedWall(size_t i) const
Definition: BaseWall.cc:547
BaseInteraction * getInteractionWith(BaseParticle *p, unsigned timeStamp, InteractionHandler *interactionHandler) override
Returns the interaction between this wall and a given particle, nullptr if there is no interaction.
Definition: BaseWall.cc:346
virtual bool getDistanceAndNormal(const BaseParticle &P, Mdouble &distance, Vec3D &normal_return) const =0
Pure virtual function that computes the distance of a BaseParticle to this wall and returns the norma...
virtual bool getDistanceNormalOverlap(const BaseParticle &P, Mdouble &distance, Vec3D &normal_return, Mdouble &overlap) const
Definition: BaseWall.cc:505
void getVTK(std::vector< Vec3D > &points, std::vector< std::vector< double >> &triangleStrips)
Definition: BaseWall.h:149
Container to store Interaction objects.
Definition: InteractionHandler.h:25
Definition: ParticleSpecies.h:16
Definition: SuperQuadricParticle.h:36
Definition: Kernel/VTKWriter/VTKData.h:15
Definition: Kernel/Math/Vector.h:30
Container to store all BaseWall.
Definition: WallHandler.h:22
#define min(a, b)
Definition: datatypes.h:22
#define max(a, b)
Definition: datatypes.h:23
double P
Uniform pressure.
Definition: TwenteMeshGluing.cpp:77
void normal(const Vector< double > &x, Vector< double > &normal)
Definition: free_surface_rotation.cc:65
Definition: BaseWall.h:17
std::vector< std::vector< double > > triangleStrips
Definition: BaseWall.h:19
std::vector< Vec3D > points
Definition: BaseWall.h:18