MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CubeInsertionBoundary.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 BOUNDARIES_CUBEINSERTIONBOUNDARY_H
27 #define BOUNDARIES_CUBEINSERTIONBOUNDARY_H
28 
29 #include "InsertionBoundary.h"
30 #include "Math/Vector.h"
31 
32 class BaseParticle;
33 
34 class RNG;
35 
43 {
44 public:
45 
50 
55 
59  ~CubeInsertionBoundary() override;
60 
64  CubeInsertionBoundary* copy() const override;
65 
69  void
70  set(BaseParticle* particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, Vec3D velMin, Vec3D velMax,
71  double radMin, double radMax);
72 
73  void
74  set(BaseParticle& particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, Vec3D velMin, Vec3D velMax,
75  double radMin, double radMax);
79  void setRadiusRange(Mdouble radMin, Mdouble radMax);
80 
85  void setGeometry(Vec3D posMin, Vec3D posMax, Vec3D velMin, Vec3D velMax);
86 
90  void placeParticle(BaseParticle* p, RNG& random) override;
91 
95  void read(std::istream& is) override;
96 
101  void oldRead(std::istream& is);
102 
106  void write(std::ostream& os) const override;
107 
108 
109 private:
110 
114  std::string getName() const override;
115 
116 protected:
117 
123 };
124 
125 #endif
CubeInsertionBoundary()
Constructor; sets everything to 0.
Vec3D posMin_
Minimal and maximal positions defining the boundary's boundaries, and minimum and maximum velocity of...
double Mdouble
Definition: GeneralDefine.h:34
void setGeometry(Vec3D posMin, Vec3D posMax, Vec3D velMin, Vec3D velMax)
Sets the geometry (position and velocity distribution) of the CubeInsertionBoundary.
~CubeInsertionBoundary() override
Destructor: default destructor.
Boundary structure for boundaries used for insertion of particles.
#define MERCURY_DEPRECATED
Definition: GeneralDefine.h:37
void placeParticle(BaseParticle *p, RNG &random) override
Generates a random position, velocity for the particle p.
This is a class that generates random numbers i.e. named the Random Number Generator (RNG)...
Definition: RNG.h:52
std::string getName() const override
Returns the name of the object.
void set(BaseParticle *particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, Vec3D velMin, Vec3D velMax, double radMin, double radMax)
Sets the properties of the CubeInsertionBoundary.
It's an insertion boundary which has cuboidal shape (yes, 'CuboidalInsertionBoundary' would have been...
CubeInsertionBoundary * copy() const override
Creates a copy on the heap and returns a pointer.
void write(std::ostream &os) const override
writes boundary properties to ostream
void setRadiusRange(Mdouble radMin, Mdouble radMax)
Sets the range of particle radii that may be generated.
void read(std::istream &is) override
reads boundary properties from istream
Definition: Vector.h:49
MERCURY_DEPRECATED void oldRead(std::istream &is)
deprecated version of CubeInsertionBoundary::read().