MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Combtooth.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 
26 #ifndef COMBTOOTH_H
27 #define COMBTOOTH_H
28 
29 #include "BaseWall.h"
30 #include "Math/Vector.h"
31 #include <cmath>
32 
33 class Combtooth : public BaseWall
34 {
35 public:
39  Combtooth();
40 
44  Combtooth(const Combtooth& ct);
45 
49  ~Combtooth() override;
50 
54  void set(Vec3D axis, Vec3D position, Mdouble radius);
55 
59  Combtooth* copy() const override;
60 
61  bool getDistanceAndNormal(const BaseParticle& p,
62  Mdouble& distance, Vec3D& normal_return) const override;
63 
65  unsigned timeStamp,
66  InteractionHandler* interactionHandler) override;
67 
68  void read(std::istream& is) override;
69 
70  void write(std::ostream& os) const override;
71 
72  std::string getName() const override;
73 
74 private:
75  Vec3D axis_; // unit vector pointing in direction of axis
76  Vec3D position_; // position vector of a point that the axis goes through
78 
79 };
80 
81 #endif
Vec3D position_
Definition: Combtooth.h:76
double Mdouble
Definition: GeneralDefine.h:34
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: Combtooth.cc:88
Combtooth * copy() const override
Copy.
Definition: Combtooth.cc:57
void set(Vec3D axis, Vec3D position, Mdouble radius)
Set.
Definition: Combtooth.cc:50
Stores information about interactions between two interactable objects; often particles but could be ...
~Combtooth() override
Default destructor.
Combtooth()
Default constructor.
Definition: Combtooth.cc:31
void write(std::ostream &os) const override
Function that writes a BaseWall to an output stream, usually a restart file.
Definition: Combtooth.cc:116
std::string getName() const override
A purely virtual function.
Definition: Combtooth.cc:124
void read(std::istream &is) override
Function that reads a BaseWall from an input stream, usually a restart file.
Definition: Combtooth.cc:107
Vec3D axis_
Definition: Combtooth.h:75
Container to store Interaction objects.
Mdouble radius_
Definition: Combtooth.h:77
Basic class for walls.
Definition: BaseWall.h:47
bool getDistanceAndNormal(const BaseParticle &p, Mdouble &distance, Vec3D &normal_return) const override
Pure virtual function that computes the distance of a BaseParticle to this wall and returns the norma...
Definition: Combtooth.cc:62
Definition: Vector.h:49