MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SineWall.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 SINEWALL_H
27 #define SINEWALL_H
28 
29 #include "BaseWall.h"
30 #include "Math/Vector.h"
31 
40 class SineWall : public BaseWall
41 {
42 public:
46  SineWall();
47 
51  SineWall(const SineWall& other);
52 
56  SineWall(Mdouble length, Mdouble sw_wavn, Mdouble sw_phshift, Mdouble sw_amp);
57 
58  ~SineWall() override;
59 
60  void set(Mdouble length, Mdouble sw_wavn, Mdouble sw_phshift, Mdouble sw_amp);
61 
62  SineWall* copy() const override;
63 
64  bool getDistanceAndNormal(const BaseParticle& P, Mdouble& distance, Vec3D& normal_return) const override;
65 
67  getInteractionWith(BaseParticle* p, unsigned timeStamp, InteractionHandler* interactionHandler) override;
68 
69  void read(std::istream& is) override;
70 
71  void write(std::ostream& os) const override;
72 
73  std::string getName() const override;
74 
75 private:
77  Mdouble sw_amp_; // amplitude of sinusoidal variations
78  Mdouble sw_wavn_; // (angular) wavenumber of sinusoidal variations
79  Mdouble sw_phshift_; // phase shift of sinusoidal variations
80 };
81 
82 #endif
double Mdouble
Definition: GeneralDefine.h:34
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: SineWall.cc:75
Mdouble sw_amp_
Definition: SineWall.h:77
Mdouble l_
Definition: SineWall.h:76
Stores information about interactions between two interactable objects; often particles but could be ...
~SineWall() override
Definition: SineWall.cc:57
void read(std::istream &is) override
Definition: SineWall.cc:214
SineWall()
Default constructor, sets a chute with default parameters.
Definition: SineWall.cc:30
Mdouble sw_phshift_
Definition: SineWall.h:79
Container to store Interaction objects.
Basic class for walls.
Definition: BaseWall.h:47
SineWall * copy() const override
Pure virtual function that can be overwritten in inherited classes in order to copy a BaseWall...
Definition: SineWall.cc:70
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: SineWall.cc:192
std::string getName() const override
Definition: SineWall.cc:239
Mdouble sw_wavn_
Definition: SineWall.h:78
Definition: Vector.h:49
void set(Mdouble length, Mdouble sw_wavn, Mdouble sw_phshift, Mdouble sw_amp)
Definition: SineWall.cc:62
void write(std::ostream &os) const override
Definition: SineWall.cc:227