MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CircularPeriodicBoundary.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 CircularPeriodicBoundary_H
27 #define CircularPeriodicBoundary_H
28 
29 #include "BaseBoundary.h"
30 
31 class ParticleHandler;
32 
33 class BaseParticle;
34 
40 {
41 public:
46 
50  explicit CircularPeriodicBoundary(double innerRadius);
51 
55  ~CircularPeriodicBoundary() override;
56 
60  CircularPeriodicBoundary* copy() const override;
61 
66  void rotateParticle(BaseParticle* P, double angle);
67 
73 
74  void createPeriodicParticles(ParticleHandler& pH) override;
75 
80 
83 
87  void read(std::istream& is) override;
88 
92  void oldRead(std::istream& is);
93 
97  void write(std::ostream& os) const override;
98 
103  std::string getName() const override;
104 
105 private:
106 
110  double innerRadius_;
111 
112  //A particle is between to Radii in plane (i) and has two (straight) walls (plane 0 defines centre)
113  //If it is close to its inner Radius it should be copied once with a positive rotation of 2*pi/2^i
114  //If it is close to one of its straight walls is should be rotative with +/- 2*pi/2^i
115 
116  //Particles can only apply forces to real particles
117 
118  //If a particle crosses a straight wall it should simply be shifted
119  //If a particle crosses its inner Radius it should be coppied
120  //If a particle crosses its outer Radius it may need to be deleted
121 
122 };
123 
124 #endif
void read(std::istream &is) override
reads the CircularPeriodicBoundary
CircularPeriodicBoundary()
default constructor
std::string getName() const override
Returns the name of the object.
used to create a circular periodic boundary
void rotateParticle(BaseParticle *P, double angle)
~CircularPeriodicBoundary() override
destructor
void checkBoundaryAfterParticlesMove(ParticleHandler &pH) override
Container to store all BaseParticle.
void createPeriodicParticle(BaseParticle *p, ParticleHandler &pH) override
CircularPeriodicBoundary * copy() const override
Used to create a copy of the object NB: purely virtual function.
void createPeriodicParticles(ParticleHandler &pH) override
void write(std::ostream &os) const override
outputs the CircularPeriodicBoundary
bool checkBoundaryAfterParticleMoved(BaseParticle *P, ParticleHandler &pH)