MercuryDPM  Beta
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
InfiniteWallWithHole.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 INFINITEWALLWITHHOLE_H
27 #define INFINITEWALLWITHHOLE_H
28 
34 #include "BaseWall.h"
35 #include "Math/Vector.h"
36 
38 {
39 public:
40 
45 
49  InfiniteWallWithHole(Vec3D normal, Mdouble position, Mdouble holeRadius);
50 
55 
59  InfiniteWallWithHole* copy() const;
60 
64  void clear();
65 
69  void set(Vec3D normal, Mdouble position, Mdouble holeRadius);
70 
74  void moveTo(Mdouble position);
75 
76 // /*!
77 // * \brief Allows the wall to be moved to a new position (also orthogonal to the normal), and setting the velocity
78 // * note: I commented this function out as it does not add new functionality (instead, BaseInteractable::move(velocity*dt) can be used),
79 // * and it hides the virtual function BaseInteractable::move. If this is really needed, please add it again. \author weinhartt
80 // */
81 // void move(Vec3D velocity, Mdouble dt);
82 
86  void move_time(Mdouble dt);
87 
91  Mdouble getWallDistance(const Vec3D &position) const;
92 
96  Mdouble getHoleDistance(const Vec3D &position) const;
97 
101  bool getDistanceAndNormal(const BaseParticle& P, Mdouble& distance, Vec3D& normal_return) const;
102 
106  BaseInteraction* getInteractionWith(BaseParticle *P, Mdouble timeStamp, InteractionHandler* interactionHandler);
107 
111  void read(std::istream& is);
112 
116  void oldRead(std::istream& is);
117 
121  void write(std::ostream& os) const;
122 
126  virtual std::string getName() const;
127 
131  Vec3D getNormal();
132 
137 
138 private:
149 
150 };
151 
152 #endif
void write(std::ostream &os) const
outputs wall
void read(std::istream &is)
reads wall
bool getDistanceAndNormal(const BaseParticle &P, Mdouble &distance, Vec3D &normal_return) const
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.
double Mdouble
void oldRead(std::istream &is)
reads wall
Vec3D normal_
Outward normal vector, does not have to be a unit vector.
virtual std::string getName() const
Returns the name of the object.
InfiniteWallWithHole()
default constructor
void clear()
A function that removes all data from this BaseWall, so sets handler_ to nullptr. ...
Stores information about interactions between two interactable objects; often particles but could be ...
void set(Vec3D normal, Mdouble position, Mdouble holeRadius)
Defines a standard wall, given an outward normal vector s. t. normal*x=position.
Mdouble getHoleDistance(const Vec3D &position) const
BaseInteraction * getInteractionWith(BaseParticle *P, Mdouble timeStamp, InteractionHandler *interactionHandler)
Returns the interaction between this object and a given BaseParticle.
InfiniteWallWithHole * copy() const
Wall copy method. It calls the copy contrustor of this Wall, usefull for polymorfism.
Container to store Interaction objects.
Mdouble position_
position n*x=p
Basic class for walls.
Definition: BaseWall.h:39
Vec3D getNormal()
access function for normal
Mdouble getPosition()
access function for position
void move_time(Mdouble dt)
Allows the wall to be moved to a new position (also orthogonal to the normal), and setting the veloci...
Implementation of a 3D vector (by Vitaliy).
Definition: Vector.h:45
void moveTo(Mdouble position)
Allows the wall to be moved to a new position.
Mdouble getWallDistance(const Vec3D &position) const
Returns the distance of the wall to the particle.