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 public:
44 
49 
54 
58  ~CubeInsertionBoundary() override;
59 
63  CubeInsertionBoundary *copy() const override;
64 
68  void
69  set(BaseParticle *particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, Vec3D velMin, Vec3D velMax);
70 
71  void
72  set(BaseParticle &particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, Vec3D velMin, Vec3D velMax);
73 
77  void
78  set(std::vector<BaseParticle *> particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, Vec3D velMin,
79  Vec3D velMax);
80 
85  void set(BaseParticle* particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, Vec3D velMin,
86  Vec3D velMax, Mdouble rMin, Mdouble rMax)
87  {
88  PSD uniformPSD;
89  uniformPSD.setDistributionUniform(rMin,rMax,1000);
90  setPSD(uniformPSD);
91  set(particleToCopy, maxFailed,posMin, posMax, velMin, velMax);
92  }
93 
98  void set(BaseParticle &particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, Vec3D velMin,
99  Vec3D velMax, Mdouble rMin, Mdouble rMax)
100  {
101  PSD uniformPSD;
102  uniformPSD.setDistributionUniform(rMin,rMax,1000);
103  setPSD(uniformPSD);
104  set(particleToCopy, maxFailed,posMin, posMax, velMin, velMax);
105  }
106 
107 
108 
109 
114  void setGeometry(Vec3D posMin, Vec3D posMax);
115 
119  void placeParticle(BaseParticle* p, RNG& random) override;
120 
124  void read(std::istream& is) override;
125 
129  void write(std::ostream& os) const override;
130 
131 
132 private:
133 
137  std::string getName() const override;
138 
139 protected:
140 
146 };
147 
148 #endif
CubeInsertionBoundary()
Constructor; sets everything to 0.
void set(BaseParticle *particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, Vec3D velMin, Vec3D velMax)
Sets the properties of the InsertionBoundary for mutliple different particle types.
Vec3D posMin_
Minimal and maximal positions defining the boundary's boundaries, and minimum and maximum velocity of...
double Mdouble
Definition: GeneralDefine.h:34
void set(BaseParticle *particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, Vec3D velMin, Vec3D velMax, Mdouble rMin, Mdouble rMax)
old style set function which also assumes a uniform psd. Note if you want a general PSD do not use bu...
void setPSD(const PSD psd)
Sets the range of particle radii that may be generated from a user defined PSD.
~CubeInsertionBoundary() override
Destructor: default destructor.
Boundary structure for boundaries used for insertion of particles.
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.
It's an insertion boundary which has cuboidal shape (yes, 'CuboidalInsertionBoundary' would have been...
void set(BaseParticle &particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, Vec3D velMin, Vec3D velMax, Mdouble rMin, Mdouble rMax)
old style set function which also assumes a uniform psd. Note if you want a general PSD do not use bu...
CubeInsertionBoundary * copy() const override
Creates a copy on the heap and returns a pointer.
void setDistributionUniform(Mdouble radMin, Mdouble radMax, int numberOfBins)
create a PSD vector for a uniform distribution.
Definition: PSD.cc:290
void write(std::ostream &os) const override
writes boundary properties to ostream
void read(std::istream &is) override
reads boundary properties from istream
Contains a vector with radii and probabilities of a user defined particle size distribution (PSD) ...
Definition: PSD.h:62
Definition: Vector.h:49
void setGeometry(Vec3D posMin, Vec3D posMax)
Sets the geometry (position and velocity distribution) of the CubeInsertionBoundary.