Used for modeling chute inflow. Inherits from InsertionBoundary. More...

#include <ChuteInsertionBoundary.h>

Inheritance diagram for ChuteInsertionBoundary:

Public Member Functions
	ChuteInsertionBoundary ()
	Default constructor. More...

	ChuteInsertionBoundary (const ChuteInsertionBoundary &other)
	Copy constructor. More...

virtual ChuteInsertionBoundary *	copy () const
	Copy method; creates a copy on the heap. More...

void	set (BaseParticle *particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, double radMin, double radMax, double fixedParticleRadius, double inflowVelocity, double inflowVelocityVariance)
	Sets all boundary properties at once. More...

virtual BaseParticle *	generateParticle (RNG &random)
	Generates a random particle. More...

void	read (std::istream &is)
	reads boundary properties from istream More...

MERCURY_DEPRECATED void	oldRead (std::istream &is)
	deprecated version of CubeInsertionBoundary::read(). More...

void	write (std::ostream &os) const
	writes boundary properties to ostream More...

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

Public Member Functions inherited from InsertionBoundary
	InsertionBoundary ()
	Default constructor: set everything to 0/nullptr. More...

	InsertionBoundary (const InsertionBoundary &other)
	Copy constructor (with deep copy) More...

virtual	~InsertionBoundary ()
	Destructor: delete the particle that has to be copied at every insertion. More...

void	set (BaseParticle *particleToCopy, unsigned int maxFailed)
	Sets the particle that will be inserted and the maximum number of times for which insertion may fail. More...

virtual void	checkBoundaryBeforeTimeStep (DPMBase *md)
	Fills the boundary with particles. More...

unsigned int	getNumberOfParticlesInserted () const
	Gets the number of particles inserted by the boundary. More...

void	setMaxFailed (unsigned int maxFailed)
	Sets the number of times that the wall may fail to insert a particle. More...

unsigned int	getMaxFailed () const
	Gets the number of times that the boundary may fail to insert a particle. More...

void	setParticleToCopy (BaseParticle *particleToCopy)
	Sets the particle that will be inserted through the insertion boundary. More...

BaseParticle *	getParticleToCopy () const
	Gets the particle that will be inserted through the insertion boundary. More...

void	read (std::istream &is)
	Reads the boundary's id_ and maxFailed_. More...

void	write (std::ostream &os) const
	Writes the boundary's id_ and maxFailed_. More...

Public Member Functions inherited from BaseBoundary
	BaseBoundary ()
	default constructor. More...

	BaseBoundary (const BaseBoundary &b)
	copy constructor More...

virtual	~BaseBoundary ()
	destructor More...

virtual void	createPeriodicParticles (BaseParticle *P UNUSED, ParticleHandler &pH UNUSED)
	Creates periodic copies of given particle in case of periodic boundaries. More...

virtual bool	checkBoundaryAfterParticleMoved (BaseParticle *P UNUSED, ParticleHandler &pH UNUSED)
	Checks if given particle passed the boundary. More...

virtual void	checkBoundaryBeforeTimeStep (DPMBase *md UNUSED)
	Fills a (3D) boundary with particles. More...

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

	BaseObject (const BaseObject &p)
	Copy constructor, copies all the objects BaseObject contains. More...

virtual	~BaseObject ()
	virtual destructor More...

virtual void	moveInHandler (const unsigned int index)
	Except that it is virtual, it does the same thing as setIndex() does. More...

void	setIndex (const unsigned int index)
	Allows one to assign an index to an object in the handler/container. More...

void	setId (const unsigned int 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...

Private Attributes
Vec3D	posMin_
	The two extremal corners of the cuboidal insertion boundary. More...

Vec3D	posMax_

double	radMin_
	Minimum and maximum radii of the generated particles. More...

double	radMax_

double	fixedParticleRadius_
	radius of the fixed bottom particles, mean particle velocity in X-direction, and allowed maximum randomly added/substracted velocities in all three directions while generating particles (expressed as % of inflowVelocity_). NB: see also documentation of ChuteInsertionBoundary::generateParticle(). More...

double	inflowVelocity_

double	inflowVelocityVariance_

Detailed Description

Used for modeling chute inflow. Inherits from InsertionBoundary.

Definition at line 39 of file ChuteInsertionBoundary.h.

Constructor & Destructor Documentation

ChuteInsertionBoundary::ChuteInsertionBoundary ( )

Default constructor.

Default constructor. Initiates all properties with 0 value.

Definition at line 35 of file ChuteInsertionBoundary.cc.

References fixedParticleRadius_, inflowVelocity_, inflowVelocityVariance_, posMax_, posMin_, radMax_, and radMin_.

Referenced by copy().

                                               : InsertionBoundary()
 {
     posMax_ = Vec3D(0.0, 0.0, 0.0);
     posMin_ = Vec3D(0.0, 0.0, 0.0);
     radMax_ = 0.0;
     radMin_ = 0.0;
     fixedParticleRadius_ = 0.0;
     inflowVelocity_ = 0.0;
     inflowVelocityVariance_ = 0.0;
 }

ChuteInsertionBoundary::ChuteInsertionBoundary ( const ChuteInsertionBoundary & other )

Copy constructor.

Copy constructor. Calls InsertionBoundary parent copy constructor.

Definition at line 49 of file ChuteInsertionBoundary.cc.

References fixedParticleRadius_, inflowVelocity_, inflowVelocityVariance_, posMax_, posMin_, radMax_, and radMin_.

         : InsertionBoundary(other)
 {
     posMax_ = other.posMax_;
     posMin_ = other.posMin_;
     radMax_ = other.radMax_;
     radMin_ = other.radMin_;
     fixedParticleRadius_ = other.fixedParticleRadius_;
     inflowVelocity_ = other.inflowVelocity_;
     inflowVelocityVariance_ = other.inflowVelocityVariance_;
 }

Member Function Documentation

ChuteInsertionBoundary * ChuteInsertionBoundary::copy ( ) const

virtual

Copy method; creates a copy on the heap.

Copy method. Creates a copy on the heap.

Returns: Pointer to the copy.

Implements BaseBoundary.

Definition at line 65 of file ChuteInsertionBoundary.cc.

References ChuteInsertionBoundary().

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

BaseParticle * ChuteInsertionBoundary::generateParticle ( RNG & random )

virtual

Generates a random particle.

Generates a particle within the boundary with random radius, position and velocity (within the allowed intervals). Notable properties:

The minimal Z-position is fixedParticleRadius_ (the radius of the particles fixed at the bottom) above the minimal Z-value of the boundary
The particles have an mean velocity of inflowVelocity_ in the X-direction. Furthermore, each particle has a velocity added in all three directions, based on a given inflowVelocityVariance_, which is expressed as a percentage of the inflowVelocity_.
Parameters

[in] random a random number generator

Returns
pointer to the generated particle

Implements InsertionBoundary.

Definition at line 124 of file ChuteInsertionBoundary.cc.

References BaseParticle::copy(), fixedParticleRadius_, InsertionBoundary::getParticleToCopy(), BaseParticle::getRadius(), RNG::getRandomNumber(), inflowVelocity_, inflowVelocityVariance_, mathsFunc::isEqual(), posMax_, posMin_, radMax_, radMin_, BaseInteractable::setPosition(), BaseParticle::setRadius(), BaseInteractable::setVelocity(), Vec3D::X, Vec3D::Y, and Vec3D::Z.

 {
     BaseParticle* P = getParticleToCopy()->copy();
     
     P->setRadius(random.getRandomNumber(radMin_, radMax_));
     
     Vec3D position, velocity;
 
     position.X = posMin_.X + P->getRadius();
 
     if (mathsFunc::isEqual(posMax_.Y - posMin_.Y , 2.0 * radMax_, 1e-10))
     {
         position.Y = posMin_.Y + P->getRadius();
     }
     else
     {
         position.Y = random.getRandomNumber(posMin_.Y + P->getRadius(), posMax_.Y - P->getRadius());
     }
     position.Z = random.getRandomNumber(posMin_.Z + fixedParticleRadius_ + P->getRadius(), posMax_.Z - P->getRadius());
     
     // The velocity components are first stored in a Vec3D, because if you pass them 
     // directly into setVelocity the compiler is allowed to change the order in 
     // which the numbers are generated
     velocity.X = inflowVelocity_ * random.getRandomNumber(-inflowVelocityVariance_, inflowVelocityVariance_) + inflowVelocity_;
     velocity.Y = inflowVelocity_ * random.getRandomNumber(-inflowVelocityVariance_, inflowVelocityVariance_);
     velocity.Z = inflowVelocity_ * random.getRandomNumber(-inflowVelocityVariance_, inflowVelocityVariance_);
     
     P->setPosition(position);
     P->setVelocity(velocity);
     
     return P;
 }

std::string ChuteInsertionBoundary::getName ( ) const

virtual

Returns the name of the object.

Returns the name of the object class

Returns: the object's class' name, i.e. 'ChuteInsertionBoundary'

Implements BaseObject.

Definition at line 214 of file ChuteInsertionBoundary.cc.

 {
     return "ChuteInsertionBoundary";
 }

void ChuteInsertionBoundary::oldRead ( std::istream & is )

deprecated version of CubeInsertionBoundary::read().

Deprecated version of read().

Deprecated:: Should be gone by Mercury 2.0. Instead, use CubeInsertionBoundary::read().

Definition at line 178 of file ChuteInsertionBoundary.cc.

References fixedParticleRadius_, inflowVelocity_, inflowVelocityVariance_, posMax_, posMin_, radMax_, radMin_, and InsertionBoundary::setMaxFailed().

 {
     unsigned int maxFailed;
     std::string dummy;
     is >> dummy >> maxFailed
             >> dummy >> posMin_
             >> dummy >> posMax_
             >> dummy >> radMin_
             >> dummy >> radMax_
             >> dummy >> fixedParticleRadius_
             >> dummy >> inflowVelocity_
             >> dummy >> inflowVelocityVariance_;
     setMaxFailed(maxFailed);
 }

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

virtual

reads boundary properties from istream

Reads the boundary properties from an istream

Parameters

[in,out] is the istream

Implements BaseBoundary.

Definition at line 161 of file ChuteInsertionBoundary.cc.

References fixedParticleRadius_, inflowVelocity_, inflowVelocityVariance_, posMax_, posMin_, radMax_, radMin_, and InsertionBoundary::read().

 {
     InsertionBoundary::read(is);
     std::string dummy;
     is >> dummy >> posMin_
             >> dummy >> posMax_
             >> dummy >> radMin_
             >> dummy >> radMax_
             >> dummy >> fixedParticleRadius_
             >> dummy >> inflowVelocity_
             >> dummy >> inflowVelocityVariance_;
 }

void ChuteInsertionBoundary::set	(	BaseParticle *	particleToCopy,
		unsigned int	maxFailed,
		Vec3D	posMin,
		Vec3D	posMax,
		double	radMin,
		double	radMax,
		double	fixedParticleRadius,
		double	inflowVelocity,
		double	inflowVelocityVariance
	)

Sets all boundary properties at once.

Sets all the properties of the chute insertion boundary.

Parameters

[in]	particleToCopy	Pointer to the BaseParticle which is used as a basis for the particles to be inserted
[in]	maxFailed	The maximum number of times the insertion of a particle may be tried and failed before the insertion of particles is considered done. NB: this property is used in the parent's InsertionBoundary::checkBoundaryBeforeTimeStep().
[in]	posMin	First defining corner of the chute insertion boundary
[in]	posMax	Second defining corner of the chute insertion boundary
[in]	radMin	Minimum radius of inserted particles
[in]	radMax	Maximum radius of inserted particles
[in]	fixedParticleRadius	radius of the fixed bottom (i.e., positioned at the minimal Z-position) particles
[in]	inflowVelocity	the mean particle velocity, which is in the X-direction
[in]	inflowVelocityVariance	value of minimum (minus ~) and maximum added velocities which are added to the given mean in each of the three dimensions. Expressed as a percentage of inflowVelocity_. See also the documentation of ChuteInsertionBoundary::generateParticle().

Definition at line 95 of file ChuteInsertionBoundary.cc.

References fixedParticleRadius_, inflowVelocity_, inflowVelocityVariance_, posMax_, posMin_, radMax_, radMin_, InsertionBoundary::setMaxFailed(), and InsertionBoundary::setParticleToCopy().

Referenced by Chute::setupInitialConditions().

 {
     if (particleToCopy != nullptr)
     {
         setParticleToCopy(particleToCopy);
     }
     setMaxFailed(maxFailed);
     posMin_ = posMin;
     posMax_ = posMax;
     radMin_ = radMin;
     radMax_ = radMax;
     fixedParticleRadius_ = fixedParticleRadius;
     inflowVelocity_ = inflowVelocity;
     inflowVelocityVariance_ = inflowVelocityVariance;
 }

void ChuteInsertionBoundary::write ( std::ostream & os ) const

virtual

writes boundary properties to ostream

Writes boundary's properties to an ostream

Parameters

[in] os the ostream

Implements BaseBoundary.

Definition at line 197 of file ChuteInsertionBoundary.cc.

References fixedParticleRadius_, inflowVelocity_, inflowVelocityVariance_, posMax_, posMin_, radMax_, radMin_, and InsertionBoundary::write().

         {
     InsertionBoundary::write(os);
     os << " posMin " << posMin_
             << " posMax " << posMax_
             << " radMin " << radMin_
             << " radMax " << radMax_
             << " fixedParticleRadius " << fixedParticleRadius_
             << " inflowVelocity " << inflowVelocity_
             << " inflowVelocityVariance " << inflowVelocityVariance_;
     
 }

Member Data Documentation

double ChuteInsertionBoundary::fixedParticleRadius_

private

radius of the fixed bottom particles, mean particle velocity in X-direction, and allowed maximum randomly added/substracted velocities in all three directions while generating particles (expressed as % of inflowVelocity_). NB: see also documentation of ChuteInsertionBoundary::generateParticle().

Definition at line 105 of file ChuteInsertionBoundary.h.

Referenced by ChuteInsertionBoundary(), generateParticle(), oldRead(), read(), set(), and write().