MercuryDPM  Alpha
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
BaseWall.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2014, The MercuryDPM Developers Team. All rights reserved.
2 //For the list of developers, see <http://www.MercuryDPM.org/Team>.
3 //
4 //Redistribution and use in source and binary forms, with or without
5 //modification, are permitted provided that the following conditions are met:
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright
9 // notice, this list of conditions and the following disclaimer in the
10 // documentation and/or other materials provided with the distribution.
11 // * Neither the name MercuryDPM nor the
12 // names of its contributors may be used to endorse or promote products
13 // derived from this software without specific prior written permission.
14 //
15 //THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 //ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 //WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 //DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
19 //DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 //(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 //LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 //ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 //(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 //SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 
26 #ifndef BASEWALL_H
27 #define BASEWALL_H
28 
29 #include "BaseInteractable.h"
30 
31 class WallHandler;
32 class BaseParticle;
33 
34 struct VTKContainer {
35  std::vector<Vec3D> points;
36  std::vector<std::vector<double>> triangleStrips;
37 };
38 
44 class BaseWall : public BaseInteractable
45 {
46 public:
50  BaseWall();
51 
55  BaseWall(const BaseWall& w);
56 
60  virtual ~BaseWall();
61 
66  virtual BaseWall* copy() const = 0;
67 
71  void read(std::istream& is);
72 
76  void write(std::ostream& os) const;
77 
84  virtual void clear();
85 
94  virtual bool getDistanceAndNormal(const BaseParticle& P, Mdouble& distance, Vec3D& normal_return) const = 0;
95 
99  virtual void setHandler(WallHandler* handler);
100 
104  WallHandler* getHandler() const;
105 
110  void setIndSpecies(unsigned int indSpecies);
111 
116  void setSpecies(const ParticleSpecies* species);
117 
118  // returns the point intersecting a wall (x-p).n=0 and a line x=p0+t(p1-p0)
119  bool getLinePlaneIntersect (Vec3D& intersect, const Vec3D& p0, const Vec3D& p1, const Vec3D& n, const Vec3D& p);
120 
124  bool isInsideWallVTK (const Vec3D& point, const Vec3D& normal, const Vec3D& position) const;
125 
129  void projectOntoWallVTK (Vec3D& point0, const Vec3D& point1, const Vec3D& normal, const Vec3D& position) const;
130 
135  void intersectVTK (std::vector<Vec3D> &points, const Vec3D normal, const Vec3D position) const;
136 
142  virtual void writeVTK (VTKContainer& vtk) const;
143 
144  virtual std::vector<BaseInteraction*> getInteractionWith(BaseParticle* p, Mdouble timeStamp, InteractionHandler* interactionHandler);
145 
149  static void addToVTK (const std::vector<Vec3D>& points, VTKContainer& vtk);
150 
155 };
156 #endif
virtual void writeVTK(VTKContainer &vtk) const
Definition: BaseWall.cc:284
virtual MERCURY_DEPRECATED void clear()
A function that removes all data from this BaseWall, so sets handler_ to nullptr. ...
Definition: BaseWall.cc:52
void setIndSpecies(unsigned int indSpecies)
Define the species of this wall using the index of the species in the SpeciesHandler in this DPMBase...
Definition: BaseWall.cc:93
virtual void setHandler(WallHandler *handler)
A function which sets the WallHandler for this BaseWall.
Definition: BaseWall.cc:76
double Mdouble
static void addToVTK(const std::vector< Vec3D > &points, VTKContainer &vtk)
Definition: BaseWall.cc:289
WallHandler * handler_
Definition: BaseWall.h:154
void intersectVTK(std::vector< Vec3D > &points, const Vec3D normal, const Vec3D position) const
Definition: BaseWall.cc:163
virtual std::vector< BaseInteraction * > getInteractionWith(BaseParticle *p, Mdouble timeStamp, InteractionHandler *interactionHandler)
Definition: BaseWall.cc:266
#define MERCURY_DEPRECATED
Definition: GeneralDefine.h:37
WallHandler * getHandler() const
A function which returns the WallHandler that handles this BaseWall.
Definition: BaseWall.cc:85
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...
std::vector< std::vector< double > > triangleStrips
Definition: BaseWall.h:36
Container to store Interaction objects.
bool isInsideWallVTK(const Vec3D &point, const Vec3D &normal, const Vec3D &position) const
Definition: BaseWall.cc:144
BaseWall()
Default constructor. It makes an empty BaseWall.
Definition: BaseWall.cc:31
Basic class for walls.
Definition: BaseWall.h:44
Container to store all BaseWall.
Definition: WallHandler.h:42
std::vector< Vec3D > points
Definition: BaseWall.h:35
Defines the basic properties that a interactable object can have.
Implementation of a 3D vector (by Vitaliy).
Definition: Vector.h:45
void write(std::ostream &os) const
Function that writes a BaseWall to an output stream, usually a restart file.
Definition: BaseWall.cc:68
void projectOntoWallVTK(Vec3D &point0, const Vec3D &point1, const Vec3D &normal, const Vec3D &position) const
Definition: BaseWall.cc:154
bool getLinePlaneIntersect(Vec3D &intersect, const Vec3D &p0, const Vec3D &p1, const Vec3D &n, const Vec3D &p)
Definition: BaseWall.cc:128
virtual ~BaseWall()
Default destructor.
Definition: BaseWall.cc:47
virtual BaseWall * copy() const =0
Pure virtual function that copies a BaseWall.
void read(std::istream &is)
Function that reads a BaseWall from an input stream, usually a restart file.
Definition: BaseWall.cc:60
void setSpecies(const ParticleSpecies *species)
Define the species of this wall.
Definition: BaseWall.cc:113