FixedClusterInsertionBoundary Class Reference

#include <FixedClusterInsertionBoundary.h>

+ Inheritance diagram for FixedClusterInsertionBoundary:

Public Member Functions

 FixedClusterInsertionBoundary ()
 Constructor: inherits from BaseClusterInsertionBoundary constructor. More...
 
 FixedClusterInsertionBoundary (const FixedClusterInsertionBoundary &other)
 Copy constructor with deep copy. More...
 
 ~FixedClusterInsertionBoundary () override
 Destructor: default destructor. More...
 
FixedClusterInsertionBoundarycopy () const override
 Creates a copy on the heap and returns a pointer. More...
 
void set (std::vector< BaseParticle * > particleToCopy, std::vector< Vec3D > positions, std::vector< Mdouble > radii, Vec3D velMin, Vec3D velMax, Mdouble rMicroParticle)
 Sets the properties of the ClusterInsertionBoundary. More...
 
void set (BaseParticle *particleToCopy, std::vector< Vec3D > positions, std::vector< Mdouble > radii, Vec3D velMin, Vec3D velMax, Mdouble rMicroParticle)
 Sets the properties of the ClusterInsertionBoundary. More...
 
void setPositionsAndRadii (std::vector< Vec3D > clusterPositions, std::vector< Mdouble > clusterRadii)
 this sets positions and radii of the desired clusters. More...
 
void checkBoundaryBeforeTimeStep (DPMBase *md) final
 inserts cluster: differently from RandomClusterInsertionBoundary, here no check for interaction is computed. More...
 
void placeParticle (BaseParticle *p, RNG &random) final
 Places particles according to vector clusterPositions_ and sets a random velocity, if required. More...
 
BaseParticlegenerateParticle (RNG &random) final
 Sets cluster radii according to vector clusterRadii_. More...
 
- Public Member Functions inherited from BaseClusterInsertionBoundary
 BaseClusterInsertionBoundary ()
 Constructor; sets everything to 0. More...
 
 BaseClusterInsertionBoundary (const BaseClusterInsertionBoundary &other)
 Copy constructor with deep copy. More...
 
 ~BaseClusterInsertionBoundary () override
 Destructor: default destructor. More...
 
void setRandomised (bool randomised)
 this turns off the randomise(): created for UnitTests. More...
 
bool getRandomised ()
 this returns a bool which indicates if the process is randomised (true) or not (false). More...
 
unsigned int getNumberOfClusterInserted ()
 this returns the number of cluster inserted. More...
 
void setRadiusMicroParticle (Mdouble rMP)
 this sets the radius of the micro particle composing the cluster. More...
 
void setGeometry (Vec3D posMin, Vec3D posMax)
 Sets the geometry (position and velocity distribution) of the ClusterInsertionBoundary. More...
 
void setVelocityRange (Vec3D velMin, Vec3D velMax)
 Sets the velocity range of the ClusterInsertionBoundary. More...
 
void setAdditionalClusterProperties (Mdouble collisionTimeOverTimeStep, Mdouble velocityDampingModulus, Mdouble energyRatioTolerance)
 sets additional cluster properties as: More...
 
void setOutputClusterProperties (bool doCdatOutput, bool doOverlOutput, bool doAmatOutput, bool doIntStrucOutput, bool doVtkOutput, bool doRestartOutput, bool doFStatOutput, bool doEneOutput)
 sets cluster whether or not cluster output files will be created, for example: More...
 
void read (std::istream &is) override
 reads boundary properties from istream More...
 
void write (std::ostream &os) const override
 writes boundary properties to ostream More...
 
- Public Member Functions inherited from InsertionBoundary
 InsertionBoundary ()
 
 InsertionBoundary (const InsertionBoundary &other)
 Copy constructor (with deep copy) More...
 
 ~InsertionBoundary () override
 Destructor: delete the particle that has to be copied at every insertion. More...
 
void checkBoundaryBeforeTimeStep (DPMBase *md) override
 Fills the boundary with particles. More...
 
void insertParticles (DPMBase *md)
 Fill a certain domain with particles. More...
 
unsigned int getNumberOfParticlesInserted () const
 Gets the number of particles inserted by the boundary. More...
 
Mdouble getMassOfParticlesInserted () const
 Gets the mass of particles inserted by the boundary. More...
 
Mdouble getVolumeOfParticlesInserted () const
 Gets the volume of particles inserted by the boundary. More...
 
void reset ()
 resets particle property counter variables. More...
 
void activate ()
 Turns on the InsertionBoundary. More...
 
void deactivate ()
 Turns off the InsertionBoundary. More...
 
bool isActivated ()
 Returns whether the InsertionBoundary is activated. More...
 
unsigned int getMaxFailed () const
 Gets the number of times that the boundary may fail to insert a particle. More...
 
void setParticleToCopy (std::vector< BaseParticle * > particleToCopy)
 Sets multiple different particles that will be inserted through the insertion boundary. More...
 
void setParticleToCopy (BaseParticle *particleToCopy)
 Sets the particle that will be inserted through the insertion boundary. More...
 
std::vector< BaseParticle * > getParticleToCopy ()
 Gets the particles that will be inserted through the insertion boundary. More...
 
void read (std::istream &is) override
 Reads the boundary's id_ and maxFailed_. More...
 
void write (std::ostream &os) const override
 Writes the boundary's id_ and maxFailed_. More...
 
Mdouble getVolumeFlowRate () const
 Gets the volume flow rate of the insertion routine. More...
 
void setVolumeFlowRate (Mdouble volumeFlowRate_)
 Sets the volume flow rate of the insertion routine. More...
 
Mdouble getInitialVolume () const
 Gets the initialVolume() . More...
 
void setInitialVolume (Mdouble initialVolume)
 Gets the Volume which should be inserted by the insertion routine. More...
 
void setPSD (const PSD psd)
 Sets the range of particle radii that may be generated from a user defined PSD. More...
 
void setPSD (std::vector< PSD > psd, std::vector< Mdouble > probability)
 Sets the ranges of particle radii that may be generated from user defined PSDs. More...
 
std::vector< PSDgetPSD ()
 Gets the particle size distributions set by the user. More...
 
void setVariableVolumeFlowRate (const std::vector< Mdouble > &variableCumulativeVolumeFlowRate, Mdouble samplingInterval)
 Sets a variable volume flow rate. More...
 
bool insertParticle (Mdouble time)
 Checks the inserted total volume and returns if a particle is still allowed to be inserted. More...
 
bool getCheckParticleForInteraction () const
 Gets the variable that checks if a particle has an interaction. More...
 
void setCheckParticleForInteraction (bool checkParticleForInteraction)
 Sets the variable that checks if a particle has an interaction. More...
 
void setManualInsertion (bool manualInsertion)
 Set the flag for a manual PSD insertion routine. More...
 
- Public Member Functions inherited from BaseBoundary
 BaseBoundary ()
 default constructor. More...
 
 BaseBoundary (const BaseBoundary &b)
 copy constructor More...
 
 ~BaseBoundary () override
 destructor More...
 
virtual void createPeriodicParticle (BaseParticle *p UNUSED, ParticleHandler &pH UNUSED)
 Creates a periodic particle in case of periodic boundaries in serial build. More...
 
virtual void createPeriodicParticles (ParticleHandler &pH UNUSED)
 Creates periodic copies of given particle in case of periodic boundaries. More...
 
virtual void checkBoundaryAfterParticlesMove (ParticleHandler &pH)
 Virtual function that does things to particles, each time step after particles have moved. More...
 
virtual void actionsBeforeTimeLoop ()
 Virtual function that does something after DPMBase::setupInitialConditions but before the first time step. More...
 
virtual void modifyGhostAfterCreation (BaseParticle *particle, int i)
 
virtual void writeVTK (std::fstream &file)
 
void setHandler (BoundaryHandler *handler)
 Sets the boundary's BoundaryHandler. More...
 
BoundaryHandlergetHandler () const
 Returns the boundary's BoundaryHandler. More...
 
- Public Member Functions inherited from BaseObject
 BaseObject ()=default
 Default constructor. More...
 
 BaseObject (const BaseObject &p)=default
 Copy constructor, copies all the objects BaseObject contains. More...
 
virtual ~BaseObject ()=default
 virtual destructor More...
 
virtual void moveInHandler (unsigned int index)
 Except that it is virtual, it does the same thing as setIndex() does. More...
 
void setIndex (unsigned int index)
 Allows one to assign an index to an object in the handler/container. More...
 
void setId (unsigned long id)
 Assigns a unique identifier to each object in the handler (container) which remains constant even after the object is deleted from the container/handler. More...
 
unsigned int getIndex () const
 Returns the index of the object in the handler. More...
 
unsigned int getId () const
 Returns the unique identifier of any particular object. More...
 
void setGroupId (unsigned groupId)
 
unsigned getGroupId () const
 

Private Member Functions

std::string getName () const override
 Returns the name of the object. More...
 

Additional Inherited Members

- Public Attributes inherited from InsertionBoundary
std::vector< BaseParticle * > particleToCopy_
 read Distribution class from file. ‍/ friend std::istream& operator>>(std::istream& is, InsertionBoundary::Distribution& type); More...
 
unsigned int maxFailed_
 Number of times that the wall may fail to insert a particle. More...
 
unsigned int numberOfParticlesInserted_
 Number of particles that are already inserted. More...
 
Mdouble massInserted_
 Total mass of particles inserted. More...
 
Mdouble volumeInserted_
 Total volume of particles inserted. More...
 
bool isActivated_
 The InsertionBoundary is activated by default. If the InsertionBoundary is deactivated, then it introduces no particles (useful for trying to maintain a certain insertion rate). More...
 
Mdouble volumeFlowRate_
 
Mdouble initialVolume_
 
std::vector< MdoublevariableCumulativeVolumeFlowRate_
 
Mdouble samplingInterval_
 
bool checkParticleForInteraction_
 Checks if a particle has an interaction with a wall or other particles. More...
 
std::vector< PSDparticleSizeDistributionVector_
 Defines a particle size distribution as an object of the PSD class; if particleSizeDistributionVector_ is empty, distribution_ is used instead. More...
 
Vec3D velMin_
 Minimum and maximum velocity of the particles to be inserted. More...
 
Vec3D velMax_
 
bool isManuallyInserting_
 A flag to enable a top-down class-by-class manual insertion of a PSD; default is FALSE. More...
 
std::vector< Mdoubleprobability_
 vector of probabilities in range [0,1] which determine the mixing ratio of partice size distributions. More...
 
int chosenSpecies_
 stores the chosen species for each timestep. More...
 
- Protected Attributes inherited from BaseClusterInsertionBoundary
unsigned int nClusterInserted_
 
Mdouble radiusParticle_
 
int nParticles_
 
LinearPlasticViscoelasticFrictionSpeciesclusterSpecies_
 
bool isCdatOutputOn_
 
bool isOverlOutputOn_
 
bool isAmatOutputOn_
 
bool isIntStrucOutputOn_
 
bool isVtkOutputOn_
 
bool isRestartOutputOn_
 
bool isFStatOutputOn_
 
bool isEneOutputOn_
 
Mdouble sizeDispersityParticle_
 
Mdouble velocityDampingModulus_
 
int nInternalStructurePoints_
 
Mdouble energyRatioTolerance_
 
Mdouble collisionTimeOverTimeStep_
 
Vec3D posMin_
 
Vec3D posMax_
 
Vec3D velMin_
 
Vec3D velMax_
 
bool setRadiusParticleAndNotNumberOfParticles_
 
std::vector< Vec3DclusterPositions_
 
std::vector< MdoubleclusterRadii_
 
bool randomised_
 

Detailed Description

RandomClusterInsertionBoundary This class works exactly like CubeInsertionBoundary class but inserts clusters instead of particles, and the insertion process is not random, but determined by radii and positions specified by the user. MPI: It does not work with MPI. One of the reasons is the need to adapt function DPMBase::importParticlesAs(). In particular particles and interaction should be imported as MPIParticle and MPIInteraction. In addition to this, the same should be done inside BaseCluster::actionsAfterSolve() when particles are centred around the desired position.

Constructor & Destructor Documentation

◆ FixedClusterInsertionBoundary() [1/2]

FixedClusterInsertionBoundary::FixedClusterInsertionBoundary ( )

Constructor: inherits from BaseClusterInsertionBoundary constructor.

Default constructor: inherits from BaseClusterInsertionBoundary constructor.

32 {
33  logger(DEBUG, "RandomClusterInsertionBoundary::RandomClusterInsertionBoundary() finished");
34 }
Logger< MERCURYDPM_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
@ DEBUG
BaseClusterInsertionBoundary()
Constructor; sets everything to 0.
Definition: BaseClusterInsertionBoundary.cc:34

References DEBUG, and logger.

Referenced by copy().

◆ FixedClusterInsertionBoundary() [2/2]

FixedClusterInsertionBoundary::FixedClusterInsertionBoundary ( const FixedClusterInsertionBoundary other)

Copy constructor with deep copy.

Copy constructor

41 
42  logger(DEBUG, "RandomClusterInsertionBoundary::RandomClusterInsertionBoundary() finished");
43 }

References DEBUG, and logger.

◆ ~FixedClusterInsertionBoundary()

FixedClusterInsertionBoundary::~FixedClusterInsertionBoundary ( )
overridedefault

Destructor: default destructor.

Default Destructor.

Member Function Documentation

◆ checkBoundaryBeforeTimeStep()

void FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep ( DPMBase md)
finalvirtual

inserts cluster: differently from RandomClusterInsertionBoundary, here no check for interaction is computed.

Here the insertion process takes place. Differently from RandomClusterInsertionBoundary, this is basically just a for loop.

Reimplemented from BaseClusterInsertionBoundary.

130 {
131  logger(VERBOSE, "In FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep\n");
132 
133  if (!isActivated_)
134  return;
135 
136  /* Each time step, the InsertionBoundary attempts to fill up a region with
137  * clusters.
138  *
139  * It first calls generateParticle() to get a randomised particle, subject
140  * to a specified distribution over sizes and species. (The basic class
141  * supports size dispersity only but PolydisperseInsertionBoundary will
142  * support species dispersity.)
143  * Then it repeatedly calls placeParticle(), which gives the cluster a
144  * random location (and possibly velocity) in a specified,
145  * geometry-dependent bound. Each time, it checks whether the new cluster
146  * would have an interaction with another cluster or a wall.
147  *
148  * If it manages to do that within maxFailed_ tries, then:
149  * * the new cluster is created and inserted,
150  * * the failure counter is reset, and
151  * the processes is repeated with a new generateParticle().
152  *
153  * Otherwise, the processes terminates for this time step.
154  * */
155 
156  for (std::vector<Mdouble>::const_iterator i = clusterRadii_.begin(); i != clusterRadii_.end(); ++i) {
157 
158 
159  auto p0 = generateParticle(md->random);
160 
161  placeParticle(p0, md->random);
162 
163 
164  BaseCluster cluster;
165  if(getRandomised())
166  cluster.random.randomise();
172  cluster.doCdatOutput(isCdatOutputOn_);
174  cluster.doAmatOutput(isAmatOutputOn_);
176  cluster.doVtkOutput(isVtkOutputOn_);
179  cluster.doEneOutput(isEneOutputOn_);
181  //Here, differently from RandomClusterInsertionBoundary the only possibility is to set radiusCluster and
182  // radiusParticle.
185  cluster.setRadiusCluster(p0->getRadius());
186  cluster.setPosition(p0->getPosition());
187  cluster.setVelocity(p0->getVelocity());
188  cluster.setParticleSpecies(
190  md->speciesHandler.getObject(p0->getIndSpecies())));
191  cluster.solve();
192 
193  md->importParticlesAs( cluster.particleHandler, cluster.interactionHandler, p0->getSpecies() );
194 
195  // Number of cluster inserted
197  // Total number of particles inserted
199  // This is the total mass composed by every single particle (not cluster!) inserted
201  // This is the total volume composed by every single particle (not cluster!) inserted
203  logger(VERBOSE, "Successfully inserted cluster %/%.", nClusterInserted_, clusterRadii_.size());
204 
205  delete p0;
206  }
207 
208 }
@ VERBOSE
bool isIntStrucOutputOn_
Definition: BaseClusterInsertionBoundary.h:177
bool isFStatOutputOn_
Definition: BaseClusterInsertionBoundary.h:183
bool isOverlOutputOn_
Definition: BaseClusterInsertionBoundary.h:173
int nInternalStructurePoints_
Definition: BaseClusterInsertionBoundary.h:193
bool isCdatOutputOn_
Definition: BaseClusterInsertionBoundary.h:171
Mdouble energyRatioTolerance_
Definition: BaseClusterInsertionBoundary.h:195
bool isRestartOutputOn_
Definition: BaseClusterInsertionBoundary.h:181
bool isAmatOutputOn_
Definition: BaseClusterInsertionBoundary.h:175
Mdouble velocityDampingModulus_
Definition: BaseClusterInsertionBoundary.h:191
std::vector< Mdouble > clusterRadii_
Definition: BaseClusterInsertionBoundary.h:212
unsigned int nClusterInserted_
Definition: BaseClusterInsertionBoundary.h:157
Mdouble collisionTimeOverTimeStep_
Definition: BaseClusterInsertionBoundary.h:198
bool isVtkOutputOn_
Definition: BaseClusterInsertionBoundary.h:179
Mdouble sizeDispersityParticle_
Definition: BaseClusterInsertionBoundary.h:189
Mdouble radiusParticle_
Definition: BaseClusterInsertionBoundary.h:160
bool isEneOutputOn_
Definition: BaseClusterInsertionBoundary.h:185
bool getRandomised()
this returns a bool which indicates if the process is randomised (true) or not (false).
Definition: BaseClusterInsertionBoundary.cc:184
bool setRadiusParticleAndNotNumberOfParticles_
Definition: BaseClusterInsertionBoundary.h:208
Definition: BaseCluster.h:51
void setRadiusParticle(Mdouble rP)
This sets the value of particles' radius if there's no dispersity in size.
Definition: BaseCluster.cc:97
void doFStatOutput(bool isfStatOutputOn)
This sets the bool variable that defines whether the cluster fStat output will be written or not.
Definition: BaseCluster.cc:362
void setEnergyRatioTolerance(Mdouble eRT)
This sets the value of the value of the energy ratio threshold under which the process can be conside...
Definition: BaseCluster.cc:234
void doRestartOutput(bool isRestartOutputOn)
This sets the bool variable that defines whether the cluster restart output will be written or not.
Definition: BaseCluster.cc:348
void doEneOutput(bool isEneOutputOn)
This sets the bool variable that defines whether the cluster ene output will be written or not.
Definition: BaseCluster.cc:376
void setParticleSpecies(LinearPlasticViscoelasticFrictionSpecies *particleSpecies)
This sets the species of the particle.
Definition: BaseCluster.cc:250
void setPosition(Vec3D p)
This sets the value of position_, which is the position in which the cluster will be inserted.
Definition: BaseCluster.cc:60
void setRadiusCluster(Mdouble rCR)
This sets the desired value of the cluster radius (there is no getter of this value,...
Definition: BaseCluster.cc:149
void doCdatOutput(bool iCOO)
This sets the bool variable that defines whether the cluster data output will be written or not.
Definition: BaseCluster.cc:278
void setVelocity(Vec3D v)
This sets the value of velocity after creation.
Definition: BaseCluster.cc:264
void setVelocityDampingModulus(Mdouble vDM)
This sets the value of the velocity damping modulus.
Definition: BaseCluster.cc:200
void doVtkOutput(bool iVOO)
This sets the bool variable that defines whether the cluster vtk output will be written or not.
Definition: BaseCluster.cc:334
void setSizeDispersityParticle(Mdouble sDP)
This sets the value of particles' dispersity in size.
Definition: BaseCluster.cc:117
void doAmatOutput(bool iAOO)
This sets the bool variable that defines whether the cluster adjacency matrix output will be written ...
Definition: BaseCluster.cc:306
void setNumberOfInternalStructurePoints(int gL)
This sets the value of the number of particles used to compute the internal structure.
Definition: BaseCluster.cc:217
void setClusterId(unsigned int iC)
This sets the value of the cluster ID.
Definition: BaseCluster.cc:183
void doIntStrucOutput(bool iISOO)
This sets the bool variable that defines whether the cluster internal structure output will be writte...
Definition: BaseCluster.cc:320
void setCollisionTimeOverTimeStep(Mdouble cTOTS)
This sets the collisionTimeOverTimeStep number (which is the ratio between collision time and time st...
Definition: BaseCluster.cc:76
void doOverlOutput(bool iOOO)
This sets the bool variable that defines whether the cluster overlap output will be written or not.
Definition: BaseCluster.cc:292
unsigned getNextGroupId()
Should be called each time you assign a groupId. Returns the value of nextGroupId_ and increases next...
Definition: BaseHandler.h:293
unsigned int getSize() const
Gets the size of the particleHandler (including mpi and periodic particles)
Definition: BaseHandler.h:655
T * getObject(const unsigned int id)
Gets a pointer to the Object at the specified index in the BaseHandler.
Definition: BaseHandler.h:613
SpeciesHandler speciesHandler
A handler to that stores the species type i.e. LinearViscoelasticSpecies, etc.
Definition: DPMBase.h:1427
InteractionHandler interactionHandler
An object of the class InteractionHandler.
Definition: DPMBase.h:1467
ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created.
Definition: DPMBase.h:1437
RNG random
This is a random generator, often used for setting up the initial conditions etc.....
Definition: DPMBase.h:1432
void importParticlesAs(ParticleHandler &particleHandler, InteractionHandler &interactionHandler, const ParticleSpecies *species)
Copies particles, interactions assigning species from a local simulation to a global one....
Definition: DPMBase.cc:4954
void solve()
The work horse of the code.
Definition: DPMBase.cc:4270
BaseParticle * generateParticle(RNG &random) final
Sets cluster radii according to vector clusterRadii_.
Definition: FixedClusterInsertionBoundary.cc:225
void placeParticle(BaseParticle *p, RNG &random) final
Places particles according to vector clusterPositions_ and sets a random velocity,...
Definition: FixedClusterInsertionBoundary.cc:211
unsigned int numberOfParticlesInserted_
Number of particles that are already inserted.
Definition: InsertionBoundary.h:275
bool isActivated_
The InsertionBoundary is activated by default. If the InsertionBoundary is deactivated,...
Definition: InsertionBoundary.h:293
Mdouble massInserted_
Total mass of particles inserted.
Definition: InsertionBoundary.h:280
Mdouble volumeInserted_
Total volume of particles inserted.
Definition: InsertionBoundary.h:285
Mdouble getVolume() const
Definition: ParticleHandler.cc:1263
Mdouble getMass() const
Definition: ParticleHandler.cc:611
void randomise()
sets the random variables such that they differ for each run
Definition: RNG.cc:98
Contains material and contact force properties.
Definition: Species.h:35
const std::complex< Mdouble > i
Definition: ExtendedMath.h:51

References BaseClusterInsertionBoundary::clusterRadii_, BaseClusterInsertionBoundary::collisionTimeOverTimeStep_, BaseCluster::doAmatOutput(), BaseCluster::doCdatOutput(), BaseCluster::doEneOutput(), BaseCluster::doFStatOutput(), BaseCluster::doIntStrucOutput(), BaseCluster::doOverlOutput(), BaseCluster::doRestartOutput(), BaseCluster::doVtkOutput(), BaseClusterInsertionBoundary::energyRatioTolerance_, generateParticle(), ParticleHandler::getMass(), BaseHandler< T >::getNextGroupId(), BaseHandler< T >::getObject(), BaseClusterInsertionBoundary::getRandomised(), BaseHandler< T >::getSize(), ParticleHandler::getVolume(), constants::i, DPMBase::importParticlesAs(), DPMBase::interactionHandler, InsertionBoundary::isActivated_, BaseClusterInsertionBoundary::isAmatOutputOn_, BaseClusterInsertionBoundary::isCdatOutputOn_, BaseClusterInsertionBoundary::isEneOutputOn_, BaseClusterInsertionBoundary::isFStatOutputOn_, BaseClusterInsertionBoundary::isIntStrucOutputOn_, BaseClusterInsertionBoundary::isOverlOutputOn_, BaseClusterInsertionBoundary::isRestartOutputOn_, BaseClusterInsertionBoundary::isVtkOutputOn_, logger, InsertionBoundary::massInserted_, BaseClusterInsertionBoundary::nClusterInserted_, BaseClusterInsertionBoundary::nInternalStructurePoints_, InsertionBoundary::numberOfParticlesInserted_, DPMBase::particleHandler, placeParticle(), BaseClusterInsertionBoundary::radiusParticle_, DPMBase::random, RNG::randomise(), BaseCluster::setClusterId(), BaseCluster::setCollisionTimeOverTimeStep(), BaseCluster::setEnergyRatioTolerance(), BaseCluster::setNumberOfInternalStructurePoints(), BaseCluster::setParticleSpecies(), BaseCluster::setPosition(), BaseCluster::setRadiusCluster(), BaseCluster::setRadiusParticle(), BaseClusterInsertionBoundary::setRadiusParticleAndNotNumberOfParticles_, BaseCluster::setSizeDispersityParticle(), BaseCluster::setVelocity(), BaseCluster::setVelocityDampingModulus(), BaseClusterInsertionBoundary::sizeDispersityParticle_, DPMBase::solve(), DPMBase::speciesHandler, BaseClusterInsertionBoundary::velocityDampingModulus_, VERBOSE, and InsertionBoundary::volumeInserted_.

Referenced by RandomClusterInsertionBoundarySelfTest::setupInitialConditions().

◆ copy()

FixedClusterInsertionBoundary * FixedClusterInsertionBoundary::copy ( ) const
overridevirtual

Creates a copy on the heap and returns a pointer.

Copy method; creates a copy on the heap and returns its pointer.

Returns
pointer to the copy on the heap

Reimplemented from BaseClusterInsertionBoundary.

56 {
57 #ifdef DEBUG_CONSTRUCTOR
58  std::cout << "BaseClusterInsertionBoundary::copy() const finished" << std::endl;
59 #endif
60  return new FixedClusterInsertionBoundary(*this);
61 }
FixedClusterInsertionBoundary()
Constructor: inherits from BaseClusterInsertionBoundary constructor.
Definition: FixedClusterInsertionBoundary.cc:31

References FixedClusterInsertionBoundary().

◆ generateParticle()

BaseParticle * FixedClusterInsertionBoundary::generateParticle ( RNG random)
finalvirtual

Sets cluster radii according to vector clusterRadii_.

Reimplemented from InsertionBoundary.

226 {
227  BaseParticle* P = particleToCopy_[0]->copy();
228  P->setRadius(clusterRadii_[nClusterInserted_]);
229  return P;
230 }
Definition: BaseParticle.h:54
std::vector< BaseParticle * > particleToCopy_
read Distribution class from file. ‍/ friend std::istream& operator>>(std::istream& is,...
Definition: InsertionBoundary.h:265
double P
Uniform pressure.
Definition: TwenteMeshGluing.cpp:73

References BaseClusterInsertionBoundary::clusterRadii_, BaseClusterInsertionBoundary::nClusterInserted_, Global_Physical_Variables::P, and InsertionBoundary::particleToCopy_.

Referenced by checkBoundaryBeforeTimeStep().

◆ getName()

std::string FixedClusterInsertionBoundary::getName ( ) const
overrideprivatevirtual

Returns the name of the object.

Returns the name of the object class

Returns
the object's class' name, i.e. 'ClusterInsertionBoundary'

Reimplemented from BaseClusterInsertionBoundary.

237 {
238  return "FixedClusterInsertionBoundary";
239 }

◆ placeParticle()

void FixedClusterInsertionBoundary::placeParticle ( BaseParticle p,
RNG random 
)
finalvirtual

Places particles according to vector clusterPositions_ and sets a random velocity, if required.

Reimplemented from BaseClusterInsertionBoundary.

212 {
213  if(getRandomised())
214  random.randomise();
215  Vec3D pos, vel;
217  vel.X = random.getRandomNumber(velMin_.X, velMax_.X);
218  vel.Y = random.getRandomNumber(velMin_.Y, velMax_.Y);
219  vel.Z = random.getRandomNumber(velMin_.Z, velMax_.Z);
220  p->setPosition(pos);
221  p->setVelocity(vel);
222 }
std::vector< Vec3D > clusterPositions_
Definition: BaseClusterInsertionBoundary.h:211
Vec3D velMin_
Definition: BaseClusterInsertionBoundary.h:204
Vec3D velMax_
Definition: BaseClusterInsertionBoundary.h:204
void setVelocity(const Vec3D &velocity)
set the velocity of the BaseInteractable.
Definition: BaseInteractable.cc:350
virtual void setPosition(const Vec3D &position)
Sets the position of this BaseInteractable.
Definition: BaseInteractable.h:239
Mdouble getRandomNumber()
This is a random generating routine can be used for initial positions.
Definition: RNG.cc:143
Definition: Vector.h:51
Mdouble Y
Definition: Vector.h:66
Mdouble Z
Definition: Vector.h:66
Mdouble X
the vector components
Definition: Vector.h:66

References BaseClusterInsertionBoundary::clusterPositions_, BaseClusterInsertionBoundary::getRandomised(), RNG::getRandomNumber(), BaseClusterInsertionBoundary::nClusterInserted_, RNG::randomise(), BaseInteractable::setPosition(), BaseInteractable::setVelocity(), BaseClusterInsertionBoundary::velMax_, BaseClusterInsertionBoundary::velMin_, Vec3D::X, Vec3D::Y, and Vec3D::Z.

Referenced by checkBoundaryBeforeTimeStep().

◆ set() [1/2]

void FixedClusterInsertionBoundary::set ( BaseParticle particleToCopy,
std::vector< Vec3D positions,
std::vector< Mdouble radii,
Vec3D  velMin,
Vec3D  velMax,
Mdouble  rMicroParticle 
)

Sets the properties of the ClusterInsertionBoundary.

Sets all the properties of the cuboidal insertion boundary.

Parameters
[in]particleToCopyPointer to the BaseParticle which is used as a basis for clusters to be inserted
[in]positionsVector containing all clusters positions
[in]radiiVector containing all clusters radii
[in]velMinMinimum velocity of inserted particles
[in]velMaxMaximum velocity of inserted particles
[in]rMicroParticleRadius of the single particle composing the cluster.
98 {
99  setParticleToCopy(particleToCopy);
100 
101  setPositionsAndRadii(positions, radii);
102  setVelocityRange(velMin, velMax);
103 
104  setRadiusMicroParticle(rMicroParticle);
105 }
void setRadiusMicroParticle(Mdouble rMP)
this sets the radius of the micro particle composing the cluster.
Definition: BaseClusterInsertionBoundary.cc:192
void setVelocityRange(Vec3D velMin, Vec3D velMax)
Sets the velocity range of the ClusterInsertionBoundary.
Definition: BaseClusterInsertionBoundary.cc:208
void setPositionsAndRadii(std::vector< Vec3D > clusterPositions, std::vector< Mdouble > clusterRadii)
this sets positions and radii of the desired clusters.
Definition: FixedClusterInsertionBoundary.cc:108
void setParticleToCopy(std::vector< BaseParticle * > particleToCopy)
Sets multiple different particles that will be inserted through the insertion boundary.
Definition: InsertionBoundary.cc:411

References InsertionBoundary::setParticleToCopy(), setPositionsAndRadii(), BaseClusterInsertionBoundary::setRadiusMicroParticle(), and BaseClusterInsertionBoundary::setVelocityRange().

◆ set() [2/2]

void FixedClusterInsertionBoundary::set ( std::vector< BaseParticle * >  particleToCopy,
std::vector< Vec3D positions,
std::vector< Mdouble radii,
Vec3D  velMin,
Vec3D  velMax,
Mdouble  rMicroParticle 
)

Sets the properties of the ClusterInsertionBoundary.

Sets all the properties of the cuboidal insertion boundary.

Parameters
[in]particleToCopyVector of pointers to the BaseParticles which are used as a basis for clusters to be inserted
[in]positionsVector containing all clusters positions
[in]radiiVector containing all clusters radii
[in]velMinMinimum velocity of inserted particles
[in]velMaxMaximum velocity of inserted particles
[in]rMicroParticleRadius of the single particle composing the cluster.
76 {
77  setParticleToCopy(particleToCopy);
78 
79  setPositionsAndRadii(positions, radii);
80  setVelocityRange(velMin, velMax);
81 
82  setRadiusMicroParticle(rMicroParticle);
83 }

References InsertionBoundary::setParticleToCopy(), setPositionsAndRadii(), BaseClusterInsertionBoundary::setRadiusMicroParticle(), and BaseClusterInsertionBoundary::setVelocityRange().

Referenced by RandomClusterInsertionBoundarySelfTest::setupInitialConditions().

◆ setPositionsAndRadii()

void FixedClusterInsertionBoundary::setPositionsAndRadii ( std::vector< Vec3D clusterPositions,
std::vector< Mdouble clusterRadii 
)

this sets positions and radii of the desired clusters.

After a few checks, this sets positions and radii of the desired clusters.

109 {
110  if (clusterPositions.size() != clusterRadii.size())
111  logger(ERROR, "clusterPositions and clusterRadii have different size."
112  " clusterPositions.size() = %, clusterRadii.size() = %.",
113  clusterPositions.size(), clusterRadii.size());
114  else if (clusterPositions.empty())
115  logger(ERROR, "clusterPositions is empty."
116  " clusterPositions.size() = %.", clusterPositions.size() );
117  else if (clusterRadii.empty())
118  logger(ERROR, "clusterRadii is empty."
119  " clusterRadii.size() = %.", clusterRadii.size());
120  else
121  {
122  clusterPositions_ = clusterPositions;
123  clusterRadii_ = clusterRadii;
124  }
125 }
@ ERROR

References BaseClusterInsertionBoundary::clusterPositions_, BaseClusterInsertionBoundary::clusterRadii_, ERROR, and logger.

Referenced by set().


The documentation for this class was generated from the following files: