RestrictedWall.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2023, 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 
30 
31 #ifndef RESTRICTEDWALL_H
32 #define RESTRICTEDWALL_H
33 
34 #include "BaseWall.h"
35 #include "Math/Vector.h"
36 #include "InfiniteWall.h"
37 
42 class RestrictedWall : public BaseWall
43 {
44 public:
45 
50 
55 
56 
60  RestrictedWall(BaseWall* wall, InfiniteWall* restriction);
61 
65  ~RestrictedWall() override;
66 
70  RestrictedWall* copy() const override;
71 
75  void set(BaseWall* wall, InfiniteWall* restriction);
76 
80  bool getDistanceAndNormal(const BaseParticle& p, Mdouble& distance, Vec3D& normal_return) const override;
81 
85  void read(std::istream& is) override;
86 
90  void oldRead(std::istream& is);
91 
95  void write(std::ostream& os) const override;
96 
100  std::string getName() const override;
101 
106  getInteractionWith(BaseParticle* p, unsigned timeStamp, InteractionHandler* interactionHandler) override;
107 
108  void writeVTK(VTKContainer& vtk) const override;
109 
110 private:
116 };
117 
118 #endif
Stores information about interactions between two interactable objects; often particles but could be ...
Definition: BaseInteraction.h:60
Definition: BaseParticle.h:54
Basic class for walls.
Definition: BaseWall.h:49
A infinite wall fills the half-space {point: (position_-point)*normal_<=0}.
Definition: InfiniteWall.h:48
Container to store Interaction objects.
Definition: InteractionHandler.h:45
Restriction of a wall to the intersection with another wall.
Definition: RestrictedWall.h:43
void set(BaseWall *wall, InfiniteWall *restriction)
Defines a standard wall, given an outward normal vector s.t. normal*x=normal*point for all x of the w...
Definition: RestrictedWall.cc:92
BaseInteraction * getInteractionWith(BaseParticle *p, unsigned timeStamp, InteractionHandler *interactionHandler) override
Look up the interaction between this wall and a BaseParticle at a certain timeStamp.
Definition: RestrictedWall.cc:170
bool getDistanceAndNormal(const BaseParticle &p, Mdouble &distance, Vec3D &normal_return) const override
Compute the distance from the wall for a given BaseParticle and return if there is a collision....
Definition: RestrictedWall.cc:124
InfiniteWall * restriction_
Definition: RestrictedWall.h:115
void oldRead(std::istream &is)
Reads RestrictedWall from an old-style restart file.
RestrictedWall * copy() const override
Wall copy method. It calls the copy constructor of this Wall, useful for polymorphism.
Definition: RestrictedWall.cc:80
void write(std::ostream &os) const override
Writes the RestrictedWall to an output stream, usually a restart file.
Definition: RestrictedWall.cc:144
void writeVTK(VTKContainer &vtk) const override
Definition: RestrictedWall.cc:184
void read(std::istream &is) override
Reads RestrictedWall from a restart file.
Definition: RestrictedWall.cc:135
std::string getName() const override
Returns the name of the object, in this case the string "RestrictedWall".
Definition: RestrictedWall.cc:156
RestrictedWall()
Default constructor, the normal is infinitely long.
Definition: RestrictedWall.cc:34
BaseWall * wall_
Definition: RestrictedWall.h:114
~RestrictedWall() override
Default destructor.
Definition: RestrictedWall.cc:62
Definition: Vector.h:51
Definition: BaseWall.h:38