MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SphericalWall.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2020, 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 SphericalWall_H
32 #define SphericalWall_H
33 
34 #include "BaseWall.h"
35 #include "Math/Vector.h"
36 
47 class SphericalWall : public BaseWall
48 {
49 public:
50 
54  SphericalWall();
55 
59  SphericalWall(const SphericalWall& w);
60 
61 
65  SphericalWall(Mdouble radius, const ParticleSpecies* species);
66 
70  ~SphericalWall() override;
71 
75  SphericalWall* copy() const override;
76 
80  void setRadius(Mdouble radius);
81 
82  using BaseWall::move;
83 
87  Mdouble getDistance(const Vec3D& otherPosition) const;
88 
92  Mdouble getRadius() const;
93 
97  bool getDistanceAndNormal(const BaseParticle& p, Mdouble& distance, Vec3D& normal_return) const override;
98 
102  void read(std::istream& is) override;
103 
107  void write(std::ostream& os) const override;
108 
112  std::string getName() const override;
113 
114 private:
120 };
121 
122 #endif
SphericalWall * copy() const override
Wall copy method. It calls the copy constructor of this Wall, useful for polymorphism.
void write(std::ostream &os) const override
Writes the SphericalWall to an output stream, usually a restart file.
This is a class defining walls.
Definition: SphericalWall.h:47
double Mdouble
Definition: GeneralDefine.h:34
SphericalWall()
Default constructor, the normal is infinitely long.
~SphericalWall() override
Default destructor.
void setRadius(Mdouble radius)
Defines a spherical wall with radius r.
std::string getName() const override
Returns the name of the object, in this case the string "SphericalWall".
Mdouble getRadius() const
Returns the distance of the wall to the particle.
Basic class for walls.
Definition: BaseWall.h:47
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: Vector.h:49
virtual void move(const Vec3D &move)
Moves this BaseInteractable by adding an amount to the position.
Mdouble getDistance(const Vec3D &otherPosition) const
Returns the distance of the wall to the particle.
void read(std::istream &is) override
Reads SphericalWall from a restart file.