Inherits from InsertionBoundary Some images are useful to better understand the structure of both the hopper-chute combination, as of the hopper insertion boundary itself: More...

#include <HopperInsertionBoundary.h>

Inheritance diagram for HopperInsertionBoundary:

Public Member Functions
	HopperInsertionBoundary ()
	Default constructor. Sets all properties to 0. More...

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

HopperInsertionBoundary *	copy () const override
	copy method, returns a pointer to a copy. More...

void	set (std::vector< BaseParticle * > particleToCopy, unsigned int maxFailed, double yMin, double yMax, double chuteAngle, double fixedParticleRadius, bool isHopperCentred_, int hopperDim, double hopperAngle, double hopperLength, double hopperExitLength, double hopperHeight, double lift, double fillPercent)
	Sets all boundary properties at once. More...

void	set (BaseParticle *particleToCopy, unsigned int maxFailed, double yMin, double yMax, double chuteAngle, double fixedParticleRadius, bool isHopperCentred_, int hopperDim, double hopperAngle, double hopperLength, double hopperExitLength, double hopperHeight, double lift, double fillPercent)
	Sets all boundary properties at once. More...

void	set (BaseParticle *particleToCopy, unsigned int maxFailed, double yMin, double yMax, Mdouble rMin, Mdouble rMax, double chuteAngle, double fixedParticleRadius, bool isHopperCentred_, int hopperDim, double hopperAngle, double hopperLength, double hopperExitLength, double hopperHeight, double lift, double fillPercent)
	old style set function which assumes a uniform psd. More...

void	placeParticle (BaseParticle *p, RNG &random) override
	This places an inflow particle in the top 50% of the hopper i.e. between gamma=0.5 and gamma=1.0. 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...

std::string	getName () const override
	Returns the name of the object. 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

Public Attributes
double	yMin_
	The minimum and maximum y-positions of the particle for a hopper with vertical walls in the y-direction ('1D hopper'). For the '2D hopper', these variables have no physical meaning, except for the fact that the insertion boundary is centered in the y-direction at (yMax_ - yMin_)/2 . More...

double	yMax_

double	chuteAngle_
	Angle of the chute as compared to the horizontal plane. More...

double	hopperAngle_
	Angle of the hopper as compared to the vertical plane. More...

double	fixedParticleRadius_

double	hopperLength_
	The horizontal (AB-direction) width at the top of the hopper. More...

double	hopperExitLength_
	The horizontal (AB-direction) width at the square exit of the hopper. More...

double	hopperHeight_
	The vertical (AC-direction) height of the hopper, measured from the top of the hopper to the start of the chute. More...

bool	isHopperCentred__

double	fillPercent_
	Percentage of the height of the insertion boundary up to which it should be filled. The part to be filled reaches from the top of the hopper down to {fillPercent * (top - 'position A')}. More...

double	lift_

int	hopperDim_
	Either 1 or 2. If 1, the insertion boundary has vertical walls in the y extrema. This is used e.g. for a hopper with periodic walls in the y-direction. If 2, the insertion boundary has the form of an inverted (truncated) pyramid, with equally inclined walls in both AB and Y directions. More...

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

Detailed Description

Inherits from InsertionBoundary Some images are useful to better understand the structure of both the hopper-chute combination, as of the hopper insertion boundary itself:

Image clarifying the definitions of the data members hopperLength_, hopperExitLength, hopperHeight_ and hopperAngle_.

Image shows the AC and AB directions used to determine a particle position inside the hopper. NB: the X and Z directions are in the same plane, but pointed along the chute and normal to the chute, respectively.

Todo:: (BvdH) Better graphical diagrams are needed for further clarification, as well as some property renaming.

Constructor & Destructor Documentation

◆ HopperInsertionBoundary() [1/2]

HopperInsertionBoundary::HopperInsertionBoundary ( )

Default constructor. Sets all properties to 0.

Default constructor. Sets all properties to 0. Calls the InsertionBoundary parent default constructor as well.

                                                  : InsertionBoundary()
 {
     yMin_ = 0.0;
     yMax_ = 0.0;
     chuteAngle_ = 0.0;
     fixedParticleRadius_ = 0.0;
     isHopperCentred__ = true;
     hopperDim_ = 0;
     hopperAngle_ = 0.0;
     hopperLength_ = 0.0;
     hopperExitLength_ = 0.0;
     hopperHeight_ = 0.0;
     lift_ = 0.0;
     fillPercent_ = 0.0;
 }

References chuteAngle_, fillPercent_, fixedParticleRadius_, hopperAngle_, hopperDim_, hopperExitLength_, hopperHeight_, hopperLength_, isHopperCentred__, lift_, yMax_, and yMin_.

Referenced by copy().

◆ HopperInsertionBoundary() [2/2]

HopperInsertionBoundary::HopperInsertionBoundary ( const HopperInsertionBoundary & other )

Copy constructor.

Copy constructor. Calls InsertionBoundary parent copy constructor.

         : InsertionBoundary(other)
 {
     yMin_ = other.yMin_;
     yMax_ = other.yMax_;
     chuteAngle_ = other.chuteAngle_;
     fixedParticleRadius_ = other.fixedParticleRadius_;
     isHopperCentred__ = other.isHopperCentred__;
     hopperDim_ = other.hopperDim_;
     hopperAngle_ = other.hopperAngle_;
     hopperLength_ = other.hopperLength_;
     hopperExitLength_ = other.hopperExitLength_;
     hopperHeight_ = other.hopperHeight_;
     lift_ = other.lift_;
     fillPercent_ = other.fillPercent_;
 }

References chuteAngle_, fillPercent_, fixedParticleRadius_, hopperAngle_, hopperDim_, hopperExitLength_, hopperHeight_, hopperLength_, isHopperCentred__, lift_, yMax_, and yMin_.

Member Function Documentation

◆ copy()

HopperInsertionBoundary * HopperInsertionBoundary::copy ( ) const

overridevirtual

copy method, returns a pointer to a copy.

Copy method. Creates a copy on the heap.

Returns: Pointer to the copy.

Implements BaseBoundary.

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

References HopperInsertionBoundary().

◆ getName()

std::string HopperInsertionBoundary::getName ( ) const

overridevirtual

Returns the name of the object.

Returns the name of the object class

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

Implements BaseObject.

 {
     return "HopperInsertionBoundary";
 }

◆ placeParticle()

void HopperInsertionBoundary::placeParticle	(	BaseParticle *	p,
		RNG &	random
	)

overridevirtual

This places an inflow particle in the top 50% of the hopper i.e. between gamma=0.5 and gamma=1.0.

This function places random particles inside the hopper. The space in which the particles are placed in a (truncated) triangle in 2D, or a (truncated) pyramid in 3D. Some aspects of the hopper geometry and definitions which are useful in order to understand this particle placement code are:

In the hopper simulation, the direction of the CHUTE is defined to be the X-direction, while the normal of the chute is defined to be the Z-direction. This means that gravity is NOT in the negative Z-direction, but is actually on an angle w.r.t. the X and Z axes. NB: AC and AB are unit vectors in the direction of negative gravity and the 'normal' horizontal plane, respectively.
The third dimensional direction, which points into the plane spanned by the X and Z directions, or the AC and AB directions alternatively, is equal for either of the two definitions. Ergo, AD = the unit vector in the Y-direction. This dimension is not used in the 2D case.
The hopper is filled with particles from the base of the inverted triangle/pyramid (which defines the upper part of the hopper) down to a certain percentage fillPercent_ of the hopper depth. fillPercent_=100 will fill entire inverted triangle/pyramid down to it tip (position A). 'gamma' is the random height between the base and given fillPercent_ at which the particle is placed. NB: 'down' in this case means negative AC (vertical) direction.

See also the images provided at the top of this class' documentation.

Todo:: (BvdH) make a nice (InkScape) diagram with all useful properties in one image, and some angles explaining the definitions of AB and AC directions, the P->setPosition operation and the calculation of the Z-direction of the Vec3D A position.

Parameters

[in] random random number generator

Returns: pointer to the particle generated

Bram: Where does the '40' come from??

The 'one-dimensional' hopper has sloped walls in the AB extrema, while the walls in the AD (Y) extrema are vertical. 'delta' is the randomly generated Y-position of the particle and lies between yMin_ and yMax_ (with a particle radius distance from the extrema on either side).

Bug:: for periodic walls this should be only minus one particle radius, this should be fixed at some point. Thomas' response: using one particle radius gives problems when the wall is not orthogonal to the y-direction; the distance has to be slightly higher than one; if you can figure out the exact value, then correct it please.

Todo:: Thomas, could you check if this bug is still valid? (BvdH)

The 'two-dimensional' hopper has sloped walls in the extrema of both (horizontal) AB and AD directions. I.e., the HopperInsertionBoundary has the form of an inverted (and possibly truncated) pyramid. The possible Y-positions of the generated particle (i.e. delta) in this case is dependent of both the vertical AC-position gamma, and the hopper angle (in this case in the form of its cosine, Hc).

Implements InsertionBoundary.

 {
     //Define an orthogonal coordinate system this is useful in the hopper, see
     //diagram in html documentation for details.
     static Mdouble s = mathsFunc::sin(chuteAngle_);
     static Mdouble c = mathsFunc::cos(chuteAngle_);
     static Mdouble Hc = mathsFunc::cos(hopperAngle_);
     static Mdouble Ht = mathsFunc::sin(hopperAngle_) / Hc; //tangent
     static Vec3D AB = Vec3D(c, 0.0, s);
     static Vec3D AC = Vec3D(-s, 0.0, c);
     static Vec3D AD = Vec3D(0.0, 1.0, 0.0);
     
     //Point A is located in the centre of the hopper.
     static Vec3D A = Vec3D(isHopperCentred__ ? 40 : 0.0,    
                            (yMax_ - yMin_) / 2.0,
                            s * (-0.5 * (hopperLength_ - hopperExitLength_)) + c * hopperHeight_)
                      + AB * 0.5 * hopperLength_
                      + AC * (-0.5 * hopperLength_ / Ht);
     
     Mdouble gamma = random.getRandomNumber((100.0 - fillPercent_) / 100.0, 1.0);
     //std::cout<<"gamma="<<gamma<<"fillPercent="<<fillPercent_<<std::endl;
     
     Mdouble delta;
     
     if (hopperDim_ == 1)
     {
         delta = random.getRandomNumber(-0.5, 0.5) * (yMax_ - yMin_ - 2.0 * p->getRadius());
     
     }
     else
     {
         delta = (random.getRandomNumber(-1.0, 1.0) * (0.5 * gamma * hopperLength_ - p->getRadius() / Hc));
     }
     //std::cout<<A<<" "<<AC<<" "<<AB<<" "<<AD<<" "<<Hc<<" "<<Ht<<"gamma="<<gamma<<" "<<hopperLength_<<" "<<delta<<std::endl;
     p->setPosition(A
                    + AC * (gamma * 0.5 * hopperLength_ / Ht)
                    + AB * (random.getRandomNumber(-1.0, 1.0) * (0.5 * gamma * hopperLength_ - p->getRadius() / Hc))
                    + AD * delta);
     
     p->move(Vec3D(0.0, 0.0, lift_));
     p->setVelocity(Vec3D(0.0, 0.0, 0.0));
 }

References calibrate::c, chuteAngle_, mathsFunc::cos(), MultiOpt::delta, fillPercent_, mathsFunc::gamma(), RNG::getRandomNumber(), hopperAngle_, hopperDim_, hopperExitLength_, hopperHeight_, hopperLength_, isHopperCentred__, lift_, p, s, mathsFunc::sin(), yMax_, and yMin_.

◆ read()

void HopperInsertionBoundary::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 >> yMin_
        >> dummy >> yMax_
        >> dummy >> chuteAngle_
        >> dummy >> fixedParticleRadius_
        >> dummy >> isHopperCentred__
        >> dummy >> hopperDim_
        >> dummy >> hopperAngle_
        >> dummy >> hopperLength_
        >> dummy >> hopperExitLength_
        >> dummy >> hopperHeight_
        >> dummy >> lift_
        >> dummy >> fillPercent_;
 }

References chuteAngle_, fillPercent_, fixedParticleRadius_, hopperAngle_, hopperDim_, hopperExitLength_, hopperHeight_, hopperLength_, isHopperCentred__, lift_, InsertionBoundary::read(), oomph::Global_string_for_annotation::string(), yMax_, and yMin_.

◆ set() [1/3]

void HopperInsertionBoundary::set	(	BaseParticle *	particleToCopy,
		unsigned int	maxFailed,
		double	yMin,
		double	yMax,
		double	chuteAngle,
		double	fixedParticleRadius,
		bool	isHopperCentred_,
		int	hopperDim,
		double	hopperAngle,
		double	hopperLength,
		double	hopperExitLength,
		double	hopperHeight,
		double	lift,
		double	fillPercent
	)

Sets all boundary properties at once.

Sets all the properties of the chute insertion boundary. See also the images provided at the top of this class' documentation.

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]	yMin	The minimum y-position of the particle for a hopper with vertical walls in the y-direction ('1D hopper')
[in]	yMax	The maximum y-position of the particle for a hopper with vertical walls in the y-direction ('1D hopper')
[in]	chuteAngle	Angle of the chute as compared to the horizontal plane
[in]	fixedParticleRadius
[in]	isHopperCentred_
[in]	hopperDim	Either 1 or 2. If 1, the insertion boundary has vertical walls in the y extrema. This is used e.g. for a hopper with periodic walls in the y-direction. If 2, the insertion boundary has the form of an inverted (truncated) pyramid, with equally inclined walls in both AB and Y directions.
[in]	hopperAngle	The angle of the hopper walls relative to the vertical (AC).
[in]	hopperLength	The horizontal (AB-dir.) width at the top of the hopper
[in]	hopperExitLength	The horizontal (AB-dir.) width at the square exit of the hopper
[in]	hopperHeight	The vertical (AC-dir.) height of the hopper, measured from the top of the hopper to the start of the chute.
[in]	lift
[in]	fillPercent	Percentage of the height of the insertion boundary up to which it should be filled. The part to be filled reaches from the top of the hopper down to {fillPercent * (top - 'position A')}.

 {
     setParticleToCopy(particleToCopy);
     maxFailed_ = maxFailed;
     yMin_ = yMin;
     yMax_ = yMax;
     chuteAngle_ = chuteAngle;
     fixedParticleRadius_ = fixedParticleRadius;
     isHopperCentred__ = isHopperCentred_;
     hopperDim_ = hopperDim;
     hopperAngle_ = hopperAngle;
     hopperLength_ = hopperLength;
     hopperExitLength_ = hopperExitLength;
     hopperHeight_ = hopperHeight;
     lift_ = lift;
     fillPercent_ = fillPercent;
 }

References chuteAngle_, fillPercent_, fixedParticleRadius_, hopperAngle_, hopperDim_, hopperExitLength_, hopperHeight_, hopperLength_, isHopperCentred__, lift_, InsertionBoundary::maxFailed_, InsertionBoundary::setParticleToCopy(), yMax_, and yMin_.

◆ set() [2/3]

void HopperInsertionBoundary::set	(	BaseParticle *	particleToCopy,
		unsigned int	maxFailed,
		double	yMin,
		double	yMax,
		Mdouble	rMin,
		Mdouble	rMax,
		double	chuteAngle,
		double	fixedParticleRadius,
		bool	isHopperCentred_,
		int	hopperDim,
		double	hopperAngle,
		double	hopperLength,
		double	hopperExitLength,
		double	hopperHeight,
		double	lift,
		double	fillPercent
	)

old style set function which assumes a uniform psd.

old style set function which also assumes a uniform psd. Note if you want a specific PSD do not use but this is quicker for a uniform in size PSD

 {
     PSD uniformPSD;
     uniformPSD.setDistributionUniform(rMin, rMax, 2);
     setPSD(uniformPSD);
     set(particleToCopy, maxFailed, yMin, yMax, chuteAngle, fixedParticleRadius, isHopperCentred_, hopperDim,
         hopperAngle, hopperLength, hopperExitLength, hopperHeight, lift, fillPercent);
 }

References set(), PSD::setDistributionUniform(), and InsertionBoundary::setPSD().

◆ set() [3/3]

void HopperInsertionBoundary::set	(	std::vector< BaseParticle * >	particleToCopy,
		unsigned int	maxFailed,
		double	yMin,
		double	yMax,
		double	chuteAngle,
		double	fixedParticleRadius,
		bool	isHopperCentred_,
		int	hopperDim,
		double	hopperAngle,
		double	hopperLength,
		double	hopperExitLength,
		double	hopperHeight,
		double	lift,
		double	fillPercent
	)

Sets all boundary properties at once.

Sets all the properties of the chute insertion boundary. See also the images provided at the top of this class' documentation.

Parameters

[in]	particleToCopy	Vector of pointers to the BaseParticles which are 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]	yMin	The minimum y-position of the particle for a hopper with vertical walls in the y-direction ('1D hopper')
[in]	yMax	The maximum y-position of the particle for a hopper with vertical walls in the y-direction ('1D hopper')
[in]	chuteAngle	Angle of the chute as compared to the horizontal plane
[in]	fixedParticleRadius
[in]	isHopperCentred_
[in]	hopperDim	Either 1 or 2. If 1, the insertion boundary has vertical walls in the y extrema. This is used e.g. for a hopper with periodic walls in the y-direction. If 2, the insertion boundary has the form of an inverted (truncated) pyramid, with equally inclined walls in both AB and Y directions.
[in]	hopperAngle	The angle of the hopper walls relative to the vertical (AC).
[in]	hopperLength	The horizontal (AB-dir.) width at the top of the hopper
[in]	hopperExitLength	The horizontal (AB-dir.) width at the square exit of the hopper
[in]	hopperHeight	The vertical (AC-dir.) height of the hopper, measured from the top of the hopper to the start of the chute.
[in]	lift
[in]	fillPercent	Percentage of the height of the insertion boundary up to which it should be filled. The part to be filled reaches from the top of the hopper down to {fillPercent * (top - 'position A')}.

 {
     setParticleToCopy(particleToCopy);
     maxFailed_ = maxFailed;
     yMin_ = yMin;
     yMax_ = yMax;
     chuteAngle_ = chuteAngle;
     fixedParticleRadius_ = fixedParticleRadius;
     isHopperCentred__ = isHopperCentred_;
     hopperDim_ = hopperDim;
     hopperAngle_ = hopperAngle;
     hopperLength_ = hopperLength;
     hopperExitLength_ = hopperExitLength;
     hopperHeight_ = hopperHeight;
     lift_ = lift;
     fillPercent_ = fillPercent;
 }

References chuteAngle_, fillPercent_, fixedParticleRadius_, hopperAngle_, hopperDim_, hopperExitLength_, hopperHeight_, hopperLength_, isHopperCentred__, lift_, InsertionBoundary::maxFailed_, InsertionBoundary::setParticleToCopy(), yMax_, and yMin_.

Referenced by set(), FullRestartTest::setupInitialConditions(), and ChuteWithHopper::setupInitialConditions().

◆ write()

void HopperInsertionBoundary::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 << " yMin " << yMin_
        << " yMax " << yMax_
        << " chuteAngle " << chuteAngle_
        << " fixedParticleRadius " << fixedParticleRadius_
        << " isHopperCentred_ " << isHopperCentred__
        << " hopperDim " << hopperDim_
        << " hopperAngle " << hopperAngle_
        << " hopperLength " << hopperLength_
        << " hopperExitLength " << hopperExitLength_
        << " hopperHeight " << hopperHeight_
        << " lift " << lift_
        << " fillPercent " << fillPercent_;
 }

References chuteAngle_, fillPercent_, fixedParticleRadius_, hopperAngle_, hopperDim_, hopperExitLength_, hopperHeight_, hopperLength_, isHopperCentred__, lift_, InsertionBoundary::write(), yMax_, and yMin_.

Member Data Documentation

◆ chuteAngle_

double HopperInsertionBoundary::chuteAngle_

Angle of the chute as compared to the horizontal plane.

Referenced by HopperInsertionBoundary(), placeParticle(), read(), set(), and write().

◆ fillPercent_

double HopperInsertionBoundary::fillPercent_

Percentage of the height of the insertion boundary up to which it should be filled. The part to be filled reaches from the top of the hopper down to {fillPercent * (top - 'position A')}.

Referenced by HopperInsertionBoundary(), placeParticle(), read(), set(), and write().

◆ fixedParticleRadius_

double HopperInsertionBoundary::fixedParticleRadius_

Referenced by HopperInsertionBoundary(), read(), set(), and write().

◆ hopperAngle_

double HopperInsertionBoundary::hopperAngle_

Angle of the hopper as compared to the vertical plane.

Referenced by HopperInsertionBoundary(), placeParticle(), read(), set(), and write().

◆ hopperDim_

int HopperInsertionBoundary::hopperDim_

Either 1 or 2. If 1, the insertion boundary has vertical walls in the y extrema. This is used e.g. for a hopper with periodic walls in the y-direction. If 2, the insertion boundary has the form of an inverted (truncated) pyramid, with equally inclined walls in both AB and Y directions.

Referenced by HopperInsertionBoundary(), placeParticle(), read(), set(), and write().

◆ hopperExitLength_

double HopperInsertionBoundary::hopperExitLength_

The horizontal (AB-direction) width at the square exit of the hopper.

Referenced by HopperInsertionBoundary(), placeParticle(), read(), set(), and write().

◆ hopperHeight_

double HopperInsertionBoundary::hopperHeight_

The vertical (AC-direction) height of the hopper, measured from the top of the hopper to the start of the chute.

Referenced by HopperInsertionBoundary(), placeParticle(), read(), set(), and write().

◆ hopperLength_

double HopperInsertionBoundary::hopperLength_

The horizontal (AB-direction) width at the top of the hopper.

Referenced by HopperInsertionBoundary(), placeParticle(), read(), set(), and write().

◆ isHopperCentred__

bool HopperInsertionBoundary::isHopperCentred__

Referenced by HopperInsertionBoundary(), placeParticle(), read(), set(), and write().

◆ lift_

double HopperInsertionBoundary::lift_

Referenced by HopperInsertionBoundary(), placeParticle(), read(), set(), and write().

◆ yMax_

double HopperInsertionBoundary::yMax_

Referenced by HopperInsertionBoundary(), placeParticle(), read(), set(), and write().

◆ yMin_

double HopperInsertionBoundary::yMin_

The minimum and maximum y-positions of the particle for a hopper with vertical walls in the y-direction ('1D hopper'). For the '2D hopper', these variables have no physical meaning, except for the fact that the insertion boundary is centered in the y-direction at (yMax_ - yMin_)/2 .

Referenced by HopperInsertionBoundary(), placeParticle(), read(), set(), and write().

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HopperInsertionBoundary() [1/2]

◆ HopperInsertionBoundary() [2/2]

Member Function Documentation

◆ copy()

◆ getName()

◆ placeParticle()

◆ read()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ write()

Member Data Documentation

◆ chuteAngle_

◆ fillPercent_

◆ fixedParticleRadius_

◆ hopperAngle_

◆ hopperDim_

◆ hopperExitLength_

◆ hopperHeight_

◆ hopperLength_

◆ isHopperCentred__

◆ lift_

◆ yMax_

◆ yMin_