PolydisperseInsertionBoundary.h
Go to the documentation of this file.
1 // This file is part of the MercuryDPM project (https://www.mercurydpm.org).
2 // Copyright (c), The MercuryDPM Developers Team. All rights reserved.
3 // License: BSD 3-Clause License; see the LICENSE file in the root directory.
4 
5 #ifndef BOUNDARIES_POLYDISPERSEINSERTIONBOUNDARY_H
6 #define BOUNDARIES_POLYDISPERSEINSERTIONBOUNDARY_H
7 
8 #include "BaseBoundary.h"
9 #include "InsertionBoundary.h"
10 #include "Particles/BaseParticle.h"
11 #include "Math/RNG.h"
12 #include "Math/Vector.h"
13 
14 #include <vector>
15 
26 {
27 public:
32 
37 
42 
46  PolydisperseInsertionBoundary* copy() const override;
47 
51  void setGeometry(int maxFailed, Vec3D posMin, Vec3D posMax, Vec3D velMin, Vec3D velMax);
52 
56  BaseParticle* getGenerandum(unsigned int spec) const;
57 
61  void addGenerandum(BaseParticle* generandum, double probability, double sizeDispersity);
62 
66  void setGenerandum(unsigned int spec, BaseParticle* generandum, double probability, double sizeDispersity);
67 
71  BaseParticle* generateParticle(RNG& random) override;
72 
76  void placeParticle(BaseParticle* p, RNG& random) override;
77 
81  void read(std::istream& is) override;
82 
86  void write(std::ostream& os) const override;
87 
91  std::string getName() const override;
92 
93 // private:
94 
98  std::vector<BaseParticle*> generanda_;
99 
104  std::vector<Mdouble> probabilitates_;
105 
109  std::vector<Mdouble> sizeDispersities_; // size dispersity in the radii
110 
118 
122  std::vector<unsigned int> numbersInserted_;
123  std::vector<Mdouble> massesInserted_;
124  std::vector<Mdouble> volumesInserted_;
125 };
126 
127 #endif
float * p
Definition: Tutorial_Map_using.cpp:9
Definition: BaseParticle.h:33
Boundary structure for boundaries used for insertion of particles.
Definition: InsertionBoundary.h:29
Like an InsertionBoundary but generates particles of multiple types. Note that, as a child of Inserti...
Definition: PolydisperseInsertionBoundary.h:26
std::vector< Mdouble > sizeDispersities_
The dispersity allowed in the particle size.
Definition: PolydisperseInsertionBoundary.h:109
std::string getName() const override
Returns the name of the object.
Definition: PolydisperseInsertionBoundary.cc:206
void setGeometry(int maxFailed, Vec3D posMin, Vec3D posMax, Vec3D velMin, Vec3D velMax)
Set position and velocity of inserted particles.
Definition: PolydisperseInsertionBoundary.cc:61
void write(std::ostream &os) const override
writes boundary properties to ostream
Definition: PolydisperseInsertionBoundary.cc:191
std::vector< Mdouble > massesInserted_
Definition: PolydisperseInsertionBoundary.h:123
std::vector< Mdouble > volumesInserted_
Definition: PolydisperseInsertionBoundary.h:124
Vec3D velMax_
Definition: PolydisperseInsertionBoundary.h:117
void setGenerandum(unsigned int spec, BaseParticle *generandum, double probability, double sizeDispersity)
Change a particle to be copied.
Definition: PolydisperseInsertionBoundary.cc:84
void read(std::istream &is) override
reads boundary properties from istream
Definition: PolydisperseInsertionBoundary.cc:166
void placeParticle(BaseParticle *p, RNG &random) override
Places the particle in a random position with a random velocity.
Definition: PolydisperseInsertionBoundary.cc:152
void addGenerandum(BaseParticle *generandum, double probability, double sizeDispersity)
Add a new prototype of particle to be copied.
Definition: PolydisperseInsertionBoundary.cc:70
Vec3D posMin_
As in CubeInsertionBoundary. JMFT: TODO: Later we should completely separate InsertionBoundary geomet...
Definition: PolydisperseInsertionBoundary.h:117
std::vector< unsigned int > numbersInserted_
For keeping track of how much of each prototype we have inserted.
Definition: PolydisperseInsertionBoundary.h:122
PolydisperseInsertionBoundary * copy() const override
Creates a copy on the heap and returns a pointer.
Definition: PolydisperseInsertionBoundary.cc:53
BaseParticle * generateParticle(RNG &random) override
Generates a particle from the possible species.
Definition: PolydisperseInsertionBoundary.cc:108
std::vector< BaseParticle * > generanda_
Prototypes of the particles that can be generated.
Definition: PolydisperseInsertionBoundary.h:98
Vec3D posMax_
Definition: PolydisperseInsertionBoundary.h:117
PolydisperseInsertionBoundary()
Constructor; sets everything to 0.
Definition: PolydisperseInsertionBoundary.cc:15
std::vector< Mdouble > probabilitates_
The probabilities of generating each type of particle. These probabilities are not normalised.
Definition: PolydisperseInsertionBoundary.h:104
BaseParticle * getGenerandum(unsigned int spec) const
Get the particles that need to be copied.
~PolydisperseInsertionBoundary() override
Destructor: default destructor.
Definition: PolydisperseInsertionBoundary.cc:45
Vec3D velMin_
Definition: PolydisperseInsertionBoundary.h:117
This is a class that generates random numbers i.e. named the Random Number Generator (RNG).
Definition: RNG.h:32
Definition: Kernel/Math/Vector.h:30
std::string string(const unsigned &i)
Definition: oomph_definitions.cc:286