revision: v0.14
BaseClusterInsertionBoundary Class Reference

#include <BaseClusterInsertionBoundary.h>

+ Inheritance diagram for BaseClusterInsertionBoundary:

Public Member Functions

 BaseClusterInsertionBoundary ()
 Constructor; sets everything to 0. More...
 
 BaseClusterInsertionBoundary (const BaseClusterInsertionBoundary &other)
 Copy constructor with deep copy. More...
 
 ~BaseClusterInsertionBoundary () override
 Destructor: default destructor. More...
 
BaseClusterInsertionBoundarycopy () const override
 Creates a copy on the heap and returns a pointer. 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 placeParticle (BaseParticle *p, RNG &random) override
 Generates a random position, velocity for the cluster p. More...
 
void checkBoundaryBeforeTimeStep (DPMBase *md) override
 Fills the boundary with clusters. 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...
 
virtual BaseParticlegenerateParticle (RNG &random)
 Sets the properties of the InsertionBoundary for a single particle type ‍/ virtual void set(BaseParticle* particleToCopy, unsigned int maxFailed, Vec3D velMin, Vec3D velMax, double radMin, double radMax)=0;. 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
 

Protected Attributes

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_
 

Private Member Functions

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

Private Attributes

Vec3D position_
 

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...
 

Constructor & Destructor Documentation

◆ BaseClusterInsertionBoundary() [1/2]

BaseClusterInsertionBoundary::BaseClusterInsertionBoundary ( )

Constructor; sets everything to 0.

Default constructor;

35 {
36  /*
37  * CLUSTER VALUES
38  */
39 
41 
42  //Position
43  position_ = {0,0,0};
44 
46 
47  // Time
49 
50  // Particles
52  radiusParticle_ = 0;
53  nParticles_ = 0;
54 
55 
56  // Central force
58 
59  // Data analysis
60  nInternalStructurePoints_ = 1000000;
61 
62  // Energy
63  energyRatioTolerance_ = 1.0e-7;
64 
65  // File
66  isCdatOutputOn_ = false;
67  isOverlOutputOn_ = false;
68  isAmatOutputOn_ = false;
69  isIntStrucOutputOn_ = false;
70  isVtkOutputOn_ = false;
71  isRestartOutputOn_ = false;
72  isFStatOutputOn_ = false;
73  isEneOutputOn_ = false;
74 
75  radiusParticle_ = 0;
76 
77 
78  /*
79  * TYPICAL INSERTION BOUNDARY VALUES
80  */
81 
82  posMin_ = Vec3D(0.0, 0.0, 0.0);
83  posMax_ = Vec3D(0.0, 0.0, 0.0);
84  velMin_ = Vec3D(0.0, 0.0, 0.0);
85  velMax_ = Vec3D(0.0, 0.0, 0.0);
86 
88 
89  randomised_ = true;
90 
91  logger(DEBUG, "BaseClusterInsertionBoundary::BaseClusterInsertionBoundary() finished");
92 
93 }

References clusterSpecies_, collisionTimeOverTimeStep_, energyRatioTolerance_, FATAL, isAmatOutputOn_, isCdatOutputOn_, isEneOutputOn_, isFStatOutputOn_, isIntStrucOutputOn_, isOverlOutputOn_, isRestartOutputOn_, isVtkOutputOn_, logger, nClusterInserted_, nInternalStructurePoints_, nParticles_, position_, posMax_, posMin_, radiusParticle_, randomised_, setRadiusParticleAndNotNumberOfParticles_, sizeDispersityParticle_, velMax_, velMin_, and velocityDampingModulus_.

Referenced by copy().

◆ BaseClusterInsertionBoundary() [2/2]

BaseClusterInsertionBoundary::BaseClusterInsertionBoundary ( const BaseClusterInsertionBoundary other)

Copy constructor with deep copy.

Copy constructor

99  : InsertionBoundary(other)
100 {
101  /*
102  * CLUSTER VALUES
103  */
104 
106 
107  //Position
108  position_ = other.position_;
109 
111 
112  // Time
114 
115  // Particles
118  nParticles_ = other.nParticles_;
119 
120  nParticles_ = other.nParticles_;
121 
122 
123  // Central force
125 
126  // Data analysis
128 
129  // Energy
131 
132  // File
141 
142 
143 
145  /*
146  * TYPICAL INSERTION BOUNDARY VALUES
147  */
148 
149  posMin_ = other.posMin_;
150  posMax_ = other.posMax_;
151  velMin_ = other.velMin_;
152  velMax_ = other.velMax_;
153 
155 
156  randomised_=other.randomised_;
157 
158 }

References clusterSpecies_, collisionTimeOverTimeStep_, energyRatioTolerance_, isAmatOutputOn_, isCdatOutputOn_, isEneOutputOn_, isFStatOutputOn_, isIntStrucOutputOn_, isOverlOutputOn_, isRestartOutputOn_, isVtkOutputOn_, nClusterInserted_, nInternalStructurePoints_, nParticles_, position_, posMax_, posMin_, radiusParticle_, randomised_, setRadiusParticleAndNotNumberOfParticles_, sizeDispersityParticle_, velMax_, velMin_, and velocityDampingModulus_.

◆ ~BaseClusterInsertionBoundary()

BaseClusterInsertionBoundary::~BaseClusterInsertionBoundary ( )
overridedefault

Destructor: default destructor.

Destructor. Since there are no pointers in this class, there is no need for any actions here.

Member Function Documentation

◆ checkBoundaryBeforeTimeStep()

void BaseClusterInsertionBoundary::checkBoundaryBeforeTimeStep ( DPMBase md)
overridevirtual

Fills the boundary with clusters.

Is used to fill the insides of the boundary with clusters until it is filled up. Function overridden in children classes FixedClusterInsertionBoundary and RandomClusterInsertionBoundary

Parameters
[in,out]mdthe problem's DPMBase object
Todo:
rename to something like "insertUntilMaxFailed"?

Reimplemented from BaseBoundary.

Reimplemented in RandomClusterInsertionBoundary, and FixedClusterInsertionBoundary.

249 {
250 }

◆ copy()

BaseClusterInsertionBoundary * BaseClusterInsertionBoundary::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

Implements BaseBoundary.

Reimplemented in RandomClusterInsertionBoundary, and FixedClusterInsertionBoundary.

172 {
173 #ifdef DEBUG_CONSTRUCTOR
174  std::cout << "BaseClusterInsertionBoundary::copy() const finished" << std::endl;
175 #endif
176  return new BaseClusterInsertionBoundary(*this);
177 }

References BaseClusterInsertionBoundary().

◆ getName()

std::string BaseClusterInsertionBoundary::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'

Implements BaseObject.

Reimplemented in RandomClusterInsertionBoundary, and FixedClusterInsertionBoundary.

328 {
329  return "BaseClusterInsertionBoundary";
330 }

◆ getNumberOfClusterInserted()

unsigned int BaseClusterInsertionBoundary::getNumberOfClusterInserted ( )

this returns the number of cluster inserted.

188  {
189  return nClusterInserted_;
190 }

References nClusterInserted_.

◆ getRandomised()

bool BaseClusterInsertionBoundary::getRandomised ( )

this returns a bool which indicates if the process is randomised (true) or not (false).

184  {
185  return randomised_;
186 }

References randomised_.

Referenced by FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), FixedClusterInsertionBoundary::placeParticle(), and RandomClusterInsertionBoundary::placeParticle().

◆ placeParticle()

void BaseClusterInsertionBoundary::placeParticle ( BaseParticle p,
RNG random 
)
overridevirtual

Generates a random position, velocity for the cluster p.

function overridden in children classes FixedClusterInsertionBoundary and RandomClusterInsertionBoundary

Implements InsertionBoundary.

Reimplemented in RandomClusterInsertionBoundary, and FixedClusterInsertionBoundary.

238 {
239 }

◆ read()

void BaseClusterInsertionBoundary::read ( std::istream &  is)
overridevirtual

reads boundary properties from istream

Reads the boundary properties from an istream

Parameters
[in,out]isthe istream

Implements BaseBoundary.

257 {
259  std::string dummy;
260 
261  is >> dummy >> posMin_
262  >> dummy >> posMax_;
263  is >> dummy >> velMin_
264  >> dummy >> velMax_;
265 
266  is >> dummy >> nClusterInserted_
267  >> dummy >> radiusParticle_;
268  is >> dummy >> sizeDispersityParticle_
269  >> dummy >> velocityDampingModulus_
270  >> dummy >> nInternalStructurePoints_;
271  is >> dummy >> energyRatioTolerance_
272  >> dummy >> collisionTimeOverTimeStep_
274  is >> dummy >> isCdatOutputOn_
275  >> dummy >> isOverlOutputOn_
276  >> dummy >> isAmatOutputOn_
277  >> dummy >> isIntStrucOutputOn_
278  >> dummy >> isVtkOutputOn_
279  >> dummy >> isRestartOutputOn_
280  >> dummy >> isFStatOutputOn_
281  >> dummy >> isEneOutputOn_;
282 
283 }

References collisionTimeOverTimeStep_, energyRatioTolerance_, isAmatOutputOn_, isCdatOutputOn_, isEneOutputOn_, isFStatOutputOn_, isIntStrucOutputOn_, isOverlOutputOn_, isRestartOutputOn_, isVtkOutputOn_, nClusterInserted_, nInternalStructurePoints_, posMax_, posMin_, radiusParticle_, InsertionBoundary::read(), setRadiusParticleAndNotNumberOfParticles_, sizeDispersityParticle_, velMax_, velMin_, and velocityDampingModulus_.

◆ setAdditionalClusterProperties()

void BaseClusterInsertionBoundary::setAdditionalClusterProperties ( Mdouble  collisionTimeOverTimeStep,
Mdouble  velocityDampingModulus,
Mdouble  energyRatioTolerance 
)

sets additional cluster properties as:

  • collision time over time step ratio
  • velocity damping modulus
  • energy ratio tolerance
215 {
216  collisionTimeOverTimeStep_ = collisionTimeOverTimeStep;
217  velocityDampingModulus_ = velocityDampingModulus;
218  energyRatioTolerance_ = energyRatioTolerance;
219 
220 }

References collisionTimeOverTimeStep_, energyRatioTolerance_, and velocityDampingModulus_.

◆ setGeometry()

void BaseClusterInsertionBoundary::setGeometry ( Vec3D  posMin,
Vec3D  posMax 
)

Sets the geometry (position and velocity distribution) of the ClusterInsertionBoundary.

203 {
204  posMin_ = posMin;
205  posMax_ = posMax;
206 }

References posMax_, and posMin_.

Referenced by RandomClusterInsertionBoundary::set().

◆ setOutputClusterProperties()

void BaseClusterInsertionBoundary::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:

  • cluster data
  • overlap output
  • adjacensy matrix output
  • internal structure output
  • vtk output
  • restart file output
  • fstat file output
  • ene file output For more information and details see class BaseCluster.
224 {
225  isCdatOutputOn_ = doCdatOutput;
226  isOverlOutputOn_ = doOverlOutput;
227  isAmatOutputOn_ = doAmatOutput;
228  isIntStrucOutputOn_ = doIntStrucOutput;
229  isVtkOutputOn_ = doVtkOutput;
230  isRestartOutputOn_ = doRestartOutput;
231  isFStatOutputOn_ = doFStatOutput;
232  isEneOutputOn_ = doEneOutput;
233 
234 }

References isAmatOutputOn_, isCdatOutputOn_, isEneOutputOn_, isFStatOutputOn_, isIntStrucOutputOn_, isOverlOutputOn_, isRestartOutputOn_, and isVtkOutputOn_.

◆ setRadiusMicroParticle()

void BaseClusterInsertionBoundary::setRadiusMicroParticle ( Mdouble  rMP)

this sets the radius of the micro particle composing the cluster.

193 {
194  if (radiusMicroParticle <= 0)
195  logger(ERROR, "radiusParticle must be greater than zero. radiusMicroParticle = %", radiusMicroParticle);
196  else {
197  radiusParticle_ = radiusMicroParticle;
199  }
200 }

References ERROR, logger, radiusParticle_, and setRadiusParticleAndNotNumberOfParticles_.

Referenced by RandomClusterInsertionBoundary::set(), and FixedClusterInsertionBoundary::set().

◆ setRandomised()

void BaseClusterInsertionBoundary::setRandomised ( bool  randomised)

this turns off the randomise(): created for UnitTests.

180  {
181  randomised_ = randomised;
182 }

References randomised_.

Referenced by RandomClusterInsertionBoundarySelfTest::setupInitialConditions().

◆ setVelocityRange()

void BaseClusterInsertionBoundary::setVelocityRange ( Vec3D  velMin,
Vec3D  velMax 
)

Sets the velocity range of the ClusterInsertionBoundary.

209 {
210  velMin_ = velMin;
211  velMax_ = velMax;
212 }

References velMax_, and velMin_.

Referenced by FixedClusterInsertionBoundary::set().

◆ write()

void BaseClusterInsertionBoundary::write ( std::ostream &  os) const
overridevirtual

writes boundary properties to ostream

Writes boundary's properties to an ostream

Parameters
[in]osthe ostream

Implements BaseBoundary.

290 {
292  os << " posMin " << posMin_
293  << " posMax " << posMax_
294  << " velMin " << velMin_
295  << " velMax " << velMax_;
296 
297  os << " nClusterInserted " << nClusterInserted_ <<
298  " radiusParticle " << radiusParticle_ <<
299  " sizeDispersityParticle " << sizeDispersityParticle_ <<
300  " velocityDampingModulus " << velocityDampingModulus_ <<
301  " nInternalStructurePoints " << nInternalStructurePoints_ <<
302  " energyRatioTolerance " << energyRatioTolerance_ <<
303  " collisionTimeOverTimeStep " << collisionTimeOverTimeStep_ <<
304  " setRadiusParticle " << setRadiusParticleAndNotNumberOfParticles_ <<
305  " isCdatOutputOn " << isCdatOutputOn_ <<
306  " isOverlOutputOn " << isOverlOutputOn_ <<
307  " isAmatOutputOn " << isAmatOutputOn_ <<
308  " isIntStrucOutputOn " << isIntStrucOutputOn_ <<
309  " isVtkOutputOn " << isVtkOutputOn_ <<
310  " isRestartOutputOn " << isRestartOutputOn_ <<
311  " isFStatOutputOn " << isFStatOutputOn_ <<
312  " isEneOutputOn " << isEneOutputOn_;
313 
314 }

References collisionTimeOverTimeStep_, energyRatioTolerance_, isAmatOutputOn_, isCdatOutputOn_, isEneOutputOn_, isFStatOutputOn_, isIntStrucOutputOn_, isOverlOutputOn_, isRestartOutputOn_, isVtkOutputOn_, nClusterInserted_, nInternalStructurePoints_, posMax_, posMin_, radiusParticle_, setRadiusParticleAndNotNumberOfParticles_, sizeDispersityParticle_, velMax_, velMin_, velocityDampingModulus_, and InsertionBoundary::write().

Member Data Documentation

◆ clusterPositions_

std::vector<Vec3D> BaseClusterInsertionBoundary::clusterPositions_
protected

◆ clusterRadii_

◆ clusterSpecies_

LinearPlasticViscoelasticFrictionSpecies* BaseClusterInsertionBoundary::clusterSpecies_
protected

◆ collisionTimeOverTimeStep_

◆ energyRatioTolerance_

◆ isAmatOutputOn_

◆ isCdatOutputOn_

◆ isEneOutputOn_

◆ isFStatOutputOn_

◆ isIntStrucOutputOn_

◆ isOverlOutputOn_

◆ isRestartOutputOn_

◆ isVtkOutputOn_

◆ nClusterInserted_

◆ nInternalStructurePoints_

◆ nParticles_

◆ position_

Vec3D BaseClusterInsertionBoundary::position_
private

◆ posMax_

Vec3D BaseClusterInsertionBoundary::posMax_
protected

◆ posMin_

Vec3D BaseClusterInsertionBoundary::posMin_
protected

◆ radiusParticle_

◆ randomised_

bool BaseClusterInsertionBoundary::randomised_
protected

◆ setRadiusParticleAndNotNumberOfParticles_

◆ sizeDispersityParticle_

◆ velMax_

◆ velMin_

◆ velocityDampingModulus_


The documentation for this class was generated from the following files:
InsertionBoundary::InsertionBoundary
InsertionBoundary()
Definition: InsertionBoundary.cc:38
BaseClusterInsertionBoundary::isFStatOutputOn_
bool isFStatOutputOn_
Definition: BaseClusterInsertionBoundary.h:183
InsertionBoundary::read
void read(std::istream &is) override
Reads the boundary's id_ and maxFailed_.
Definition: InsertionBoundary.cc:471
BaseClusterInsertionBoundary::nInternalStructurePoints_
int nInternalStructurePoints_
Definition: BaseClusterInsertionBoundary.h:193
BaseClusterInsertionBoundary::BaseClusterInsertionBoundary
BaseClusterInsertionBoundary()
Constructor; sets everything to 0.
Definition: BaseClusterInsertionBoundary.cc:34
BaseClusterInsertionBoundary::nParticles_
int nParticles_
Definition: BaseClusterInsertionBoundary.h:164
logger
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
BaseClusterInsertionBoundary::clusterSpecies_
LinearPlasticViscoelasticFrictionSpecies * clusterSpecies_
Definition: BaseClusterInsertionBoundary.h:167
BaseClusterInsertionBoundary::isEneOutputOn_
bool isEneOutputOn_
Definition: BaseClusterInsertionBoundary.h:185
BaseClusterInsertionBoundary::energyRatioTolerance_
Mdouble energyRatioTolerance_
Definition: BaseClusterInsertionBoundary.h:195
BaseClusterInsertionBoundary::setRadiusParticleAndNotNumberOfParticles_
bool setRadiusParticleAndNotNumberOfParticles_
Definition: BaseClusterInsertionBoundary.h:208
LinearPlasticViscoelasticFrictionSpecies
Species< LinearPlasticViscoelasticNormalSpecies, FrictionSpecies > LinearPlasticViscoelasticFrictionSpecies
Definition: LinearPlasticViscoelasticFrictionSpecies.h:34
BaseClusterInsertionBoundary::sizeDispersityParticle_
Mdouble sizeDispersityParticle_
Definition: BaseClusterInsertionBoundary.h:189
Vec3D
Definition: Vector.h:50
BaseClusterInsertionBoundary::isVtkOutputOn_
bool isVtkOutputOn_
Definition: BaseClusterInsertionBoundary.h:179
BaseClusterInsertionBoundary::randomised_
bool randomised_
Definition: BaseClusterInsertionBoundary.h:215
BaseClusterInsertionBoundary::nClusterInserted_
unsigned int nClusterInserted_
Definition: BaseClusterInsertionBoundary.h:157
BaseClusterInsertionBoundary::isAmatOutputOn_
bool isAmatOutputOn_
Definition: BaseClusterInsertionBoundary.h:175
InsertionBoundary::write
void write(std::ostream &os) const override
Writes the boundary's id_ and maxFailed_.
Definition: InsertionBoundary.cc:559
ERROR
LL< Log::ERROR > ERROR
Error log level.
Definition: Logger.cc:53
BaseClusterInsertionBoundary::position_
Vec3D position_
Definition: BaseClusterInsertionBoundary.h:151
Log::FATAL
@ FATAL
BaseClusterInsertionBoundary::isOverlOutputOn_
bool isOverlOutputOn_
Definition: BaseClusterInsertionBoundary.h:173
BaseClusterInsertionBoundary::velMax_
Vec3D velMax_
Definition: BaseClusterInsertionBoundary.h:204
BaseClusterInsertionBoundary::isRestartOutputOn_
bool isRestartOutputOn_
Definition: BaseClusterInsertionBoundary.h:181
BaseClusterInsertionBoundary::isIntStrucOutputOn_
bool isIntStrucOutputOn_
Definition: BaseClusterInsertionBoundary.h:177
BaseClusterInsertionBoundary::radiusParticle_
Mdouble radiusParticle_
Definition: BaseClusterInsertionBoundary.h:160
BaseClusterInsertionBoundary::isCdatOutputOn_
bool isCdatOutputOn_
Definition: BaseClusterInsertionBoundary.h:171
BaseClusterInsertionBoundary::collisionTimeOverTimeStep_
Mdouble collisionTimeOverTimeStep_
Definition: BaseClusterInsertionBoundary.h:198
BaseClusterInsertionBoundary::posMax_
Vec3D posMax_
Definition: BaseClusterInsertionBoundary.h:204
BaseClusterInsertionBoundary::velMin_
Vec3D velMin_
Definition: BaseClusterInsertionBoundary.h:204
BaseClusterInsertionBoundary::velocityDampingModulus_
Mdouble velocityDampingModulus_
Definition: BaseClusterInsertionBoundary.h:191
BaseClusterInsertionBoundary::posMin_
Vec3D posMin_
Definition: BaseClusterInsertionBoundary.h:204