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

BaseClusterInsertionBoundary *	copy () 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 BaseParticle *	generateParticle (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...

virtual void	shiftBoundary (Vec3D shift)
	virtual function that shifts the boundary. More...

virtual void	rotateBoundary (Vec3D angle)
	virtual function that rotates the boundary. 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< PSD >	getPSD ()
	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...

BoundaryHandler *	getHandler () 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...

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< Mdouble >	variableCumulativeVolumeFlowRate_

Mdouble	samplingInterval_

bool	checkParticleForInteraction_
	Checks if a particle has an interaction with a wall or other particles. More...

std::vector< PSD >	particleSizeDistributionVector_
	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< Mdouble >	probability_
	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...

BaseParticle *	p0 = nullptr
	pointer to the next particle that should be inserted (needs to be stored across time steps). More...

Constructor & Destructor Documentation

◆ BaseClusterInsertionBoundary() [1/2]

BaseClusterInsertionBoundary::BaseClusterInsertionBoundary ( )

Constructor; sets everything to 0.

Default constructor;

                                                            : InsertionBoundary()
 {
     /*
      * CLUSTER VALUES
      */
  
     clusterSpecies_ = new LinearPlasticViscoelasticFrictionSpecies;
  
     //Position
     position_ = {0,0,0};
  
     nClusterInserted_ = 0;
  
     // Time
     collisionTimeOverTimeStep_ = 50;
  
     // Particles
     sizeDispersityParticle_ = 1;
     radiusParticle_ = 0;
     nParticles_ = 0;
  
  
     // Central force
     velocityDampingModulus_ = 0.9;
  
     // Data analysis
     nInternalStructurePoints_ = 1000000;
  
     // Energy
     energyRatioTolerance_ = 1.0e-7;
  
     // File
     isCdatOutputOn_ = false;
     isOverlOutputOn_ = false;
     isAmatOutputOn_ = false;
     isIntStrucOutputOn_ = false;
     isVtkOutputOn_ = false;
     isRestartOutputOn_ = false;
     isFStatOutputOn_ = false;
     isEneOutputOn_ = false;
  
     radiusParticle_ = 0;
  
  
     /*
      * TYPICAL INSERTION BOUNDARY VALUES
      */
  
     posMin_ = Vec3D(0.0, 0.0, 0.0);
     posMax_ = Vec3D(0.0, 0.0, 0.0);
     velMin_ = Vec3D(0.0, 0.0, 0.0);
     velMax_ = Vec3D(0.0, 0.0, 0.0);
  
     setRadiusParticleAndNotNumberOfParticles_ = true;
  
     randomised_ = true;
  
     logger(DEBUG, "BaseClusterInsertionBoundary::BaseClusterInsertionBoundary() finished");
  
 }

References clusterSpecies_, collisionTimeOverTimeStep_, DEBUG, energyRatioTolerance_, 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

         : InsertionBoundary(other)
 {
     /*
      * CLUSTER VALUES
      */
  
     clusterSpecies_ = other.clusterSpecies_;
  
     //Position
     position_ = other.position_;
  
     nClusterInserted_ = other.nClusterInserted_;
  
     // Time
     collisionTimeOverTimeStep_ = other.collisionTimeOverTimeStep_;
  
     // Particles
     sizeDispersityParticle_ = other.sizeDispersityParticle_;
     radiusParticle_ = other.radiusParticle_;
     nParticles_ = other.nParticles_;
  
     nParticles_ = other.nParticles_;
  
  
     // Central force
     velocityDampingModulus_ = other.velocityDampingModulus_;
  
     // Data analysis
     nInternalStructurePoints_ = other.nInternalStructurePoints_;
  
     // Energy
     energyRatioTolerance_ = other.energyRatioTolerance_;
  
     // File
     isCdatOutputOn_ = other.isCdatOutputOn_;
     isOverlOutputOn_ = other.isOverlOutputOn_;
     isAmatOutputOn_ = other.isAmatOutputOn_;
     isIntStrucOutputOn_ = other.isIntStrucOutputOn_;
     isVtkOutputOn_ = other.isVtkOutputOn_;
     isRestartOutputOn_ = other.isRestartOutputOn_;
     isFStatOutputOn_ = other.isFStatOutputOn_;
     isEneOutputOn_ = other.isEneOutputOn_;
  
  
  
     radiusParticle_ = other.radiusParticle_;
     /*
      * TYPICAL INSERTION BOUNDARY VALUES
      */
  
     posMin_ = other.posMin_;
     posMax_ = other.posMax_;
     velMin_ = other.velMin_;
     velMax_ = other.velMax_;
  
     setRadiusParticleAndNotNumberOfParticles_ = other.setRadiusParticleAndNotNumberOfParticles_;
     
     randomised_=other.randomised_;
  
 }

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] md the problem's DPMBase object

Todo:: rename to something like "insertUntilMaxFailed"?

Reimplemented from BaseBoundary.

Reimplemented in RandomClusterInsertionBoundary, and FixedClusterInsertionBoundary.

228 {

229 }

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

 {
 #ifdef DEBUG_CONSTRUCTOR
     std::cout << "BaseClusterInsertionBoundary::copy() const finished" << std::endl;
 #endif
     return new BaseClusterInsertionBoundary(*this);
 }

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.

 {
     return "BaseClusterInsertionBoundary";
 }

◆ getNumberOfClusterInserted()

unsigned int BaseClusterInsertionBoundary::getNumberOfClusterInserted ( )

this returns the number of cluster inserted.

                                                                      {
     return nClusterInserted_;
 }

References nClusterInserted_.

◆ getRandomised()

bool BaseClusterInsertionBoundary::getRandomised ( )

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

                                                 {
     return randomised_;
 }

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.

217 {

218 }

◆ read()

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

overridevirtual

reads boundary properties from istream

Reads the boundary properties from an istream

Parameters

[in,out] is the istream

Implements BaseBoundary.

 {
     InsertionBoundary::read(is);
     std::string dummy;
  
     is >> dummy >> posMin_
        >> dummy >> posMax_;
     is >> dummy >> velMin_
        >> dummy >> velMax_;
     
     is >> dummy >> nClusterInserted_
          >> dummy >> radiusParticle_;
     is >> dummy >> sizeDispersityParticle_
          >> dummy >> velocityDampingModulus_
          >> dummy >> nInternalStructurePoints_;
     is >> dummy >> energyRatioTolerance_
          >> dummy >> collisionTimeOverTimeStep_
          >> dummy >> setRadiusParticleAndNotNumberOfParticles_;
     is >> dummy >> isCdatOutputOn_
          >> dummy >> isOverlOutputOn_
          >> dummy >> isAmatOutputOn_
          >> dummy >> isIntStrucOutputOn_
          >> dummy >> isVtkOutputOn_
          >> dummy >> isRestartOutputOn_
          >> dummy >> isFStatOutputOn_
          >> dummy >> isEneOutputOn_;
  
 }

References collisionTimeOverTimeStep_, energyRatioTolerance_, isAmatOutputOn_, isCdatOutputOn_, isEneOutputOn_, isFStatOutputOn_, isIntStrucOutputOn_, isOverlOutputOn_, isRestartOutputOn_, isVtkOutputOn_, nClusterInserted_, nInternalStructurePoints_, posMax_, posMin_, radiusParticle_, InsertionBoundary::read(), setRadiusParticleAndNotNumberOfParticles_, sizeDispersityParticle_, oomph::Global_string_for_annotation::string(), 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

 {
     collisionTimeOverTimeStep_ = collisionTimeOverTimeStep;
     velocityDampingModulus_ = velocityDampingModulus;
     energyRatioTolerance_ = energyRatioTolerance;
  
 }

References collisionTimeOverTimeStep_, energyRatioTolerance_, and velocityDampingModulus_.

◆ setGeometry()

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

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

 {
     posMin_ = posMin;
     posMax_ = posMax;
 }

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.

 {
     isCdatOutputOn_ = doCdatOutput;
     isOverlOutputOn_ = doOverlOutput;
     isAmatOutputOn_ = doAmatOutput;
     isIntStrucOutputOn_ = doIntStrucOutput;
     isVtkOutputOn_ = doVtkOutput;
     isRestartOutputOn_ = doRestartOutput;
     isFStatOutputOn_ = doFStatOutput;
     isEneOutputOn_ = doEneOutput;
  
 }

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.

 {
     if (radiusMicroParticle <= 0)
         logger(ERROR, "radiusParticle must be greater than zero. radiusMicroParticle = %", radiusMicroParticle);
     else {
         radiusParticle_ = radiusMicroParticle;
         setRadiusParticleAndNotNumberOfParticles_ = true;
     }
 }

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.

                                                                {
     randomised_ = randomised;
 }

References randomised_.

Referenced by RandomClusterInsertionBoundarySelfTest::setupInitialConditions().

◆ setVelocityRange()

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

Sets the velocity range of the ClusterInsertionBoundary.

 {
     velMin_ = velMin;
     velMax_ = velMax;
 }

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] os the ostream

Implements BaseBoundary.

 {
     InsertionBoundary::write(os);
     os << " posMin " << posMin_
        << " posMax " << posMax_
        << " velMin " << velMin_
        << " velMax " << velMax_;
  
     os << " nClusterInserted " << nClusterInserted_ <<
           " radiusParticle " << radiusParticle_ <<
           " sizeDispersityParticle " << sizeDispersityParticle_ <<
           " velocityDampingModulus " << velocityDampingModulus_ <<
           " nInternalStructurePoints " << nInternalStructurePoints_ <<
           " energyRatioTolerance " << energyRatioTolerance_ <<
           " collisionTimeOverTimeStep " << collisionTimeOverTimeStep_ <<
           " setRadiusParticle " << setRadiusParticleAndNotNumberOfParticles_ <<
           " isCdatOutputOn " << isCdatOutputOn_ <<
           " isOverlOutputOn " << isOverlOutputOn_ <<
           " isAmatOutputOn " << isAmatOutputOn_ <<
           " isIntStrucOutputOn " << isIntStrucOutputOn_ <<
           " isVtkOutputOn " << isVtkOutputOn_ <<
           " isRestartOutputOn " << isRestartOutputOn_ <<
           " isFStatOutputOn " << isFStatOutputOn_ <<
           " isEneOutputOn " << isEneOutputOn_;
  
 }

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

Referenced by FixedClusterInsertionBoundary::placeParticle(), and FixedClusterInsertionBoundary::setPositionsAndRadii().

◆ clusterRadii_

std::vector<Mdouble> BaseClusterInsertionBoundary::clusterRadii_

protected

Referenced by FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), FixedClusterInsertionBoundary::generateParticle(), and FixedClusterInsertionBoundary::setPositionsAndRadii().

◆ clusterSpecies_

LinearPlasticViscoelasticFrictionSpecies* BaseClusterInsertionBoundary::clusterSpecies_

protected

Referenced by BaseClusterInsertionBoundary().

◆ collisionTimeOverTimeStep_

Mdouble BaseClusterInsertionBoundary::collisionTimeOverTimeStep_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), read(), setAdditionalClusterProperties(), and write().

◆ energyRatioTolerance_

Mdouble BaseClusterInsertionBoundary::energyRatioTolerance_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), read(), setAdditionalClusterProperties(), and write().

◆ isAmatOutputOn_

bool BaseClusterInsertionBoundary::isAmatOutputOn_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), read(), setOutputClusterProperties(), and write().

◆ isCdatOutputOn_

bool BaseClusterInsertionBoundary::isCdatOutputOn_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), read(), setOutputClusterProperties(), and write().

◆ isEneOutputOn_

bool BaseClusterInsertionBoundary::isEneOutputOn_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), read(), setOutputClusterProperties(), and write().

◆ isFStatOutputOn_

bool BaseClusterInsertionBoundary::isFStatOutputOn_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), read(), setOutputClusterProperties(), and write().

◆ isIntStrucOutputOn_

bool BaseClusterInsertionBoundary::isIntStrucOutputOn_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), read(), setOutputClusterProperties(), and write().

◆ isOverlOutputOn_

bool BaseClusterInsertionBoundary::isOverlOutputOn_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), read(), setOutputClusterProperties(), and write().

◆ isRestartOutputOn_

bool BaseClusterInsertionBoundary::isRestartOutputOn_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), read(), setOutputClusterProperties(), and write().

◆ isVtkOutputOn_

bool BaseClusterInsertionBoundary::isVtkOutputOn_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), read(), setOutputClusterProperties(), and write().

◆ nClusterInserted_

unsigned int BaseClusterInsertionBoundary::nClusterInserted_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), FixedClusterInsertionBoundary::generateParticle(), getNumberOfClusterInserted(), FixedClusterInsertionBoundary::placeParticle(), read(), and write().

◆ nInternalStructurePoints_

int BaseClusterInsertionBoundary::nInternalStructurePoints_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), read(), and write().

◆ nParticles_

int BaseClusterInsertionBoundary::nParticles_

protected

Referenced by BaseClusterInsertionBoundary(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), and RandomClusterInsertionBoundary::setNumberOfParticlesPerCluster().

◆ position_

Vec3D BaseClusterInsertionBoundary::position_

private

Referenced by BaseClusterInsertionBoundary().

◆ posMax_

Vec3D BaseClusterInsertionBoundary::posMax_

protected

Referenced by BaseClusterInsertionBoundary(), RandomClusterInsertionBoundary::placeParticle(), read(), setGeometry(), and write().

◆ posMin_

Vec3D BaseClusterInsertionBoundary::posMin_

protected

Referenced by BaseClusterInsertionBoundary(), RandomClusterInsertionBoundary::placeParticle(), read(), setGeometry(), and write().

◆ radiusParticle_

Mdouble BaseClusterInsertionBoundary::radiusParticle_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), read(), setRadiusMicroParticle(), and write().

◆ randomised_

bool BaseClusterInsertionBoundary::randomised_

protected

Referenced by BaseClusterInsertionBoundary(), getRandomised(), and setRandomised().

◆ setRadiusParticleAndNotNumberOfParticles_

bool BaseClusterInsertionBoundary::setRadiusParticleAndNotNumberOfParticles_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), read(), RandomClusterInsertionBoundary::setNumberOfParticlesPerCluster(), setRadiusMicroParticle(), and write().

◆ sizeDispersityParticle_

Mdouble BaseClusterInsertionBoundary::sizeDispersityParticle_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), read(), and write().

◆ velMax_

Vec3D BaseClusterInsertionBoundary::velMax_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::placeParticle(), RandomClusterInsertionBoundary::placeParticle(), read(), RandomClusterInsertionBoundary::set(), setVelocityRange(), and write().

◆ velMin_

Vec3D BaseClusterInsertionBoundary::velMin_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::placeParticle(), RandomClusterInsertionBoundary::placeParticle(), read(), RandomClusterInsertionBoundary::set(), setVelocityRange(), and write().

◆ velocityDampingModulus_

Mdouble BaseClusterInsertionBoundary::velocityDampingModulus_

protected

Referenced by BaseClusterInsertionBoundary(), FixedClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), read(), setAdditionalClusterProperties(), and write().

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

Protected Attributes
unsigned int	nClusterInserted_

Mdouble	radiusParticle_

int	nParticles_

LinearPlasticViscoelasticFrictionSpecies *	clusterSpecies_

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< Vec3D >	clusterPositions_

std::vector< Mdouble >	clusterRadii_

bool	randomised_

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ BaseClusterInsertionBoundary() [1/2]

◆ BaseClusterInsertionBoundary() [2/2]

◆ ~BaseClusterInsertionBoundary()

Member Function Documentation

◆ checkBoundaryBeforeTimeStep()

◆ copy()

◆ getName()

◆ getNumberOfClusterInserted()

◆ getRandomised()

◆ placeParticle()

◆ read()

◆ setAdditionalClusterProperties()

◆ setGeometry()

◆ setOutputClusterProperties()

◆ setRadiusMicroParticle()

◆ setRandomised()

◆ setVelocityRange()

◆ write()

Member Data Documentation

◆ clusterPositions_

◆ clusterRadii_

◆ clusterSpecies_

◆ collisionTimeOverTimeStep_

◆ energyRatioTolerance_

◆ isAmatOutputOn_

◆ isCdatOutputOn_

◆ isEneOutputOn_

◆ isFStatOutputOn_

◆ isIntStrucOutputOn_

◆ isOverlOutputOn_

◆ isRestartOutputOn_

◆ isVtkOutputOn_

◆ nClusterInserted_

◆ nInternalStructurePoints_

◆ nParticles_

◆ position_

◆ posMax_

◆ posMin_

◆ radiusParticle_

◆ randomised_

◆ setRadiusParticleAndNotNumberOfParticles_

◆ sizeDispersityParticle_

◆ velMax_

◆ velMin_

◆ velocityDampingModulus_