revision: v0.14
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 
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
CubeDeletionBoundary::set
void set(Vec3D posMin, Vec3D posMax)
Sets boundary position based on two opposite corners.
Definition: CubeDeletionBoundary.cc:47
CubeInsertionBoundary::read
void read(std::istream &is) override
reads boundary properties from istream
Definition: CubeInsertionBoundary.cc:168
CubeDeletionBoundary
Definition: CubeDeletionBoundary.h:38
InsertionBoundary
Boundary structure for boundaries used for insertion of particles.
Definition: InsertionBoundary.h:50
InsertionBoundary::read
void read(std::istream &is) override
Reads the boundary's id_ and maxFailed_.
Definition: InsertionBoundary.cc:471
PSD::setDistributionUniform
void setDistributionUniform(Mdouble radMin, Mdouble radMax, int numberOfBins)
create a PSD vector for a uniform distribution.
Definition: PSD.cc:297
DPMBase::setName
void setName(const std::string &name)
Allows to set the name of all the files (ene, data, fstat, restart, stat)
Definition: DPMBase.cc:420
File::setFileType
void setFileType(FileType fileType)
Sets the type of file needed to write into or read from. File::fileType_.
Definition: File.cc:215
DPMBase::setTimeStep
void setTimeStep(Mdouble newDt)
Sets a new value for the simulation time step.
Definition: DPMBase.cc:1225
CubeInsertionBoundary::write
void write(std::ostream &os) const override
writes boundary properties to ostream
Definition: CubeInsertionBoundary.cc:182
Vector.h
constants::pi
const Mdouble pi
Definition: ExtendedMath.h:45
InsertionBoundary::velMin_
Vec3D velMin_
Minimum and maximum velocity of the particles to be inserted.
Definition: InsertionBoundary.h:334
CubeInsertionBoundary::set
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...
Definition: CubeInsertionBoundary.h:85
BaseInteractable::setPosition
void setPosition(const Vec3D &position)
Sets the position of this BaseInteractable.
Definition: BaseInteractable.h:239
logger
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
Vec3D::X
Mdouble X
the vector components
Definition: Vector.h:65
InsertionBoundary::maxFailed_
unsigned int maxFailed_
Number of times that the wall may fail to insert a particle.
Definition: InsertionBoundary.h:270
InsertionBoundary::setPSD
void setPSD(const PSD psd)
Sets the range of particle radii that may be generated from a user defined PSD.
Definition: InsertionBoundary.cc:675
BaseHandler::getSize
unsigned int getSize() const
Gets the size of the particleHandler (including mpi and periodic particles)
Definition: BaseHandler.h:655
InsertionBoundary::velMax_
Vec3D velMax_
Definition: InsertionBoundary.h:334
Mercury3D
This adds on the hierarchical grid code for 3D problems.
Definition: Mercury3D.h:37
DPMBase::restartFile
File restartFile
An instance of class File to handle in- and output into a .restart file.
Definition: DPMBase.h:1451
INFO
LL< Log::INFO > INFO
Info log level.
Definition: Logger.cc:55
CubeInsertionBoundary
It's an insertion boundary which has cuboidal shape (yes, 'CuboidalInsertionBoundary' would have been...
Definition: CubeInsertionBoundary.h:42
BaseParticle::setRadius
virtual void setRadius(Mdouble radius)
Sets the particle's radius_ (and adjusts the mass_ accordingly, based on the particle's species)
Definition: BaseParticle.cc:542
CubeInsertionBoundary::getName
std::string getName() const override
Returns the name of the object.
Definition: CubeInsertionBoundary.cc:195
Vec3D
Definition: Vector.h:50
DPMBase::solve
void solve()
The work horse of the code.
Definition: DPMBase.cc:4003
DPMBase::fStatFile
File fStatFile
An instance of class File to handle in- and output into a .fstat file.
Definition: DPMBase.h:1441
DPMBase::boundaryHandler
BoundaryHandler boundaryHandler
An object of the class BoundaryHandler which concerns insertion and deletion of particles into or fro...
Definition: DPMBase.h:1410
CubeInsertionBoundary::placeParticle
void placeParticle(BaseParticle *p, RNG &random) override
Generates a random position, velocity for the particle p.
Definition: CubeInsertionBoundary.cc:151
CubeDeletionBoundarySelfTest::setupInitialConditions
void setupInitialConditions() override
This function allows to set the initial conditions for our problem to be solved, by default particle ...
Definition: CubeDeletionBoundarySelfTest.cpp:34
RNG.h
CubeInsertionBoundary::set
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...
Definition: CubeInsertionBoundary.h:98
CubeDeletionBoundarySelfTest
Definition: CubeDeletionBoundarySelfTest.cpp:31
BaseInteractable::setVelocity
void setVelocity(const Vec3D &velocity)
set the velocity of the BaseInteractable.
Definition: BaseInteractable.cc:350
CubeInsertionBoundary::copy
CubeInsertionBoundary * copy() const override
Creates a copy on the heap and returns a pointer.
Definition: CubeInsertionBoundary.cc:61
InsertionBoundary::write
void write(std::ostream &os) const override
Writes the boundary's id_ and maxFailed_.
Definition: InsertionBoundary.cc:559
RNG
This is a class that generates random numbers i.e. named the Random Number Generator (RNG).
Definition: RNG.h:53
double
DPMBase::setDomain
void setDomain(const Vec3D &min, const Vec3D &max)
Sets the minimum coordinates of the problem domain.
Definition: DPMBase.cc:1089
LinearViscoelasticSpecies.h
DPMBase::getTime
Mdouble getTime() const
Returns the current simulation time.
Definition: DPMBase.cc:805
Species< LinearViscoelasticNormalSpecies >
DPMBase::speciesHandler
SpeciesHandler speciesHandler
A handler to that stores the species type i.e. LinearViscoelasticSpecies, etc.
Definition: DPMBase.h:1385
InsertionBoundary::setParticleToCopy
void setParticleToCopy(std::vector< BaseParticle * > particleToCopy)
Sets multiple different particles that will be inserted through the insertion boundary.
Definition: InsertionBoundary.cc:411
InsertionBoundary.h
CubeDeletionBoundarySelfTest::printTime
void printTime() const override
Displays the current simulation time and the maximum simulation duration.
Definition: CubeDeletionBoundarySelfTest.cpp:61
SphericalParticle
A spherical particle is the most simple particle used in MercuryDPM.
Definition: SphericalParticle.h:37
CubeInsertionBoundary::setGeometry
void setGeometry(Vec3D posMin, Vec3D posMax)
Sets the geometry (position and velocity distribution) of the CubeInsertionBoundary.
Definition: CubeInsertionBoundary.cc:124
DPMBase::setTimeMax
void setTimeMax(Mdouble newTMax)
Sets a new value for the maximum simulation duration.
Definition: DPMBase.cc:870
Vec3D::Y
Mdouble Y
Definition: Vector.h:65
DPMBase::setGravity
void setGravity(Vec3D newGravity)
Sets a new value for the gravitational acceleration.
Definition: DPMBase.cc:1374
CubeInsertionBoundary::~CubeInsertionBoundary
~CubeInsertionBoundary() override
Destructor: default destructor.
BaseHandler::getLastObject
T * getLastObject()
Gets a pointer to the last Object in this BaseHandler.
Definition: BaseHandler.h:634
main
int main(int argc, char *argv[])
Definition: CubeDeletionBoundarySelfTest.cpp:67
DPMBase::eneFile
File eneFile
An instance of class File to handle in- and output into a .ene file.
Definition: DPMBase.h:1446
BaseParticle
Definition: BaseParticle.h:54
CubeInsertionBoundary::CubeInsertionBoundary
CubeInsertionBoundary()
Constructor; sets everything to 0.
Definition: CubeInsertionBoundary.cc:34
BaseHandler::copyAndAddObject
std::enable_if<!std::is_pointer< U >::value, U * >::type copyAndAddObject(const U &object)
Creates a copy of a Object and adds it to the BaseHandler.
Definition: BaseHandler.h:379
RNG::getRandomNumber
Mdouble getRandomNumber()
This is a random generating routine can be used for initial positions.
Definition: RNG.cc:142
CubeInsertionBoundary::posMin_
Vec3D posMin_
Minimal and maximal positions defining the boundary's boundaries, and minimum and maximum velocity of...
Definition: CubeInsertionBoundary.h:145
PSD
Contains a vector with radii and probabilities of a user defined particle size distribution (PSD)
Definition: PSD.h:63
DPMBase::particleHandler
ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created.
Definition: DPMBase.h:1395
CubeDeletionBoundary.h
Vec3D::Z
Mdouble Z
Definition: Vector.h:65
DPMBase::setSaveCount
void setSaveCount(unsigned int saveCount)
Sets File::saveCount_ for all files (ene, data, fstat, restart, stat)
Definition: DPMBase.cc:406
CubeInsertionBoundary.h
Mercury3D.h
BaseParticle.h
CubeInsertionBoundary::set
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.
Definition: CubeInsertionBoundary.cc:107
BaseInteractable::getPosition
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
Definition: BaseInteractable.h:218
CubeInsertionBoundary::posMax_
Vec3D posMax_
Definition: CubeInsertionBoundary.h:145