ChuteWithHopper has a hopper as inflow. More...

#include <ChuteWithHopper.h>

Inheritance diagram for ChuteWithHopper:

Public Member Functions
	ChuteWithHopper (const Chute &other)
	This is a copy constructor for Chute problems. More...

	ChuteWithHopper (const Mercury3D &other)
	Copy constructor, converts an existing Mercury3D object into a ChuteWithHopper object. More...

	ChuteWithHopper (const MercuryBase &other)
	Copy constructor, converts an existing MercuryBase object into a ChuteWithHopper object. More...

	ChuteWithHopper (const DPMBase &other)
	Copy constructor, converts an existing DPMBase object into a ChuteWithHopper object. More...

	ChuteWithHopper ()
	This is the default constructor. More...

void	setHopperFillingPercentage (Mdouble hopperFillingPercentage)
	Sets the hopper filling percentage. More...

void	setHopperLowestPoint (Mdouble hopperLowestPoint)
	Sets the vertical distance of the lowest hopper point relative to the start of the chute. More...

Mdouble	getHopperLowestPoint ()
	Returns the vertical distance of the lowest hopper point relative to the start of the chute. More...

Mdouble	getChuteLength ()
	Allows chute length to be accessed. More...

void	setChuteLength (Mdouble chuteLength)
	sets xMax to chuteLength+hopperlength_, and thus specifies the length off the runoff chute More...

void	setIsHopperCentred (bool isHopperCentred)
	Sets an extra shift in X-direction of the whole system. More...

void	setHopperLowerFillingHeight (Mdouble hopperLowerFillingHeight)
	Sets the height above which the hopper is filled with new particles. More...

void	setHopperShift (Mdouble hopperShift)
	Sets the shift in X-direction of the whole setup after rotation. More...

void	setHopperLift (Mdouble hopperLift)
	This lifts the hopper above the plane of the chute (after rotation) More...

Mdouble	getHopperLift ()
	Returns the hopper's lift above the chute bottom plane. More...

Mdouble	getHopperShift ()
	Returns the shift in X-direction of the whole setup after rotation. More...

void	setHopperDimension (Mdouble hopperDimension)
	Sets whether the hopper should have vertical (1) or inclined (2) walls in Y-direction. More...

void	setIsHopperAlignedWithBottom (bool isHopperAlignedWithBottom)
	Sets the alignment of hopper with chute bottom. More...

Mdouble	getHopperAngle ()
	Returns the angle of the hopper entrance relative to the vertical. More...

Mdouble	getHopperLength ()
	Returns the width of the hopper entrance. More...

Mdouble	getHopperExitLength ()
	Returns the width of the hopper exit. More...

Mdouble	getHopperHeight ()
	Returns the height of the hopper relative to the chute start. More...

Mdouble	getHopperExitHeight ()
	Returns the height of the lowest hopper point above the chute. More...

bool	getIsHopperCentred ()
	Returns whether the setup is shifted another 40 units in X-direction. More...

Mdouble	getHopperFillingPercentage ()
	Returns the vertical percentage of the hopper insertion boundary which is filled. More...

unsigned int	getHopperDimension ()
	Returns whether the hopper has vertical (1) or inclined (2) walls in Y-direction. More...

virtual void	setupInitialConditions ()
	Sets up the initial conditions for the problem. More...

void	setHopper (Mdouble ExitLength, Mdouble ExitHeight, Mdouble Angle, Mdouble Length, Mdouble Height)
	Sets the hopper's geometrical properties. More...

Mdouble	getMaximumVelocityInducedByGravity ()
	Returns the theoretical maximum particle velocity due to gravity. More...

Mdouble	getTimeStepRatio ()
	Returns smallest particle radius over maximum gravitational velocity. More...

virtual void	read (std::istream &is)
	Reads setup properties from an istream. More...

void	write (std::ostream &os, bool writeAllParticles=true) const
	Writes setup properties to an ostream. More...

bool	readNextArgument (int &i, int argc, char *argv[])
	Reads setup properties from a string. More...

Public Member Functions inherited from Chute
	Chute ()
	This is the default constructor. All it does is set sensible defaults. More...

	Chute (const DPMBase &other)
	Copy constructor, converts an existing DPMBase problem into a Chute problem. More...

	Chute (const MercuryBase &other)
	Copy constructor, converts an existing MercuryBase problem into a Chute problem. More...

	Chute (const Mercury3D &other)
	Copy constructor, converts an existing Mercury3D problem into a Chute problem. More...

	Chute (const Chute &other)
	Default copy constructor. More...

void	constructor ()
	This is the actual constructor METHOD; it is called by all constructors above (except the default copy constructor). More...

void	setupSideWalls ()
	Creates chute side walls (either solid or periodic) More...

void	makeChutePeriodic ()
	This makes the chute periodic in Y. More...

bool	getIsPeriodic () const
	Returns whether the chute is periodic in Y. More...

void	setFixedParticleRadius (Mdouble fixedParticleRadius)
	Sets the particle radius of the fixed particles which constitute the (rough) chute bottom. More...

Mdouble	getFixedParticleRadius () const
	Returns the particle radius of the fixed particles which constitute the (rough) chute bottom. More...

void	setRoughBottomType (RoughBottomType roughBottomType)
	Sets the type of rough bottom of the chute. More...

void	setRoughBottomType (std::string roughBottomTypeString)
	Sets the type of rough bottom of the chute, using a string with the EXACT enum type as input. More...

RoughBottomType	getRoughBottomType () const
	Returns the type of (rough) bottom of the chute. More...

void	setChuteAngle (Mdouble chuteAngle)
	Sets gravity vector according to chute angle (in degrees) More...

void	setChuteAngleAndMagnitudeOfGravity (Mdouble chuteAngle, Mdouble gravity)
	Sets gravity vector according to chute angle (in degrees) More...

Mdouble	getChuteAngle () const
	Returns the chute angle (in radians) More...

Mdouble	getChuteAngleDegrees () const
	Returns the chute angle (in degrees) More...

void	setMaxFailed (unsigned int maxFailed)
	Sets the number of times a particle will be tried to be added to the insertion boundary. More...

unsigned int	getMaxFailed () const
	Returns the number of times a particle will be tried to be added to the insertion boundary. More...

void	setInflowParticleRadius (Mdouble inflowParticleRadius)
	Sets the radius of the inflow particles to a single one (i.e. ensures a monodisperse inflow). More...

void	setInflowParticleRadius (Mdouble minInflowParticleRadius, Mdouble maxInflowParticleRadius)
	Sets the minimum and maximum radius of the inflow particles. More...

void	setMinInflowParticleRadius (Mdouble minInflowParticleRadius)
	sets the minimum radius of inflow particles More...

void	setMaxInflowParticleRadius (Mdouble maxInflowParticleRadius)
	Sets the maximum radius of inflow particles. More...

Mdouble	getInflowParticleRadius () const
	Returns the average radius of inflow particles. More...

Mdouble	getMinInflowParticleRadius () const
	returns the minimum radius of inflow particles More...

Mdouble	getMaxInflowParticleRadius () const
	Returns the maximum radius of inflow particles. More...

void	setInflowHeight (Mdouble inflowHeight)
	Sets maximum inflow height (Z-direction) More...

Mdouble	getInflowHeight () const
	Returns the maximum inflow height (Z-direction) More...

void	setInflowVelocity (Mdouble inflowVelocity)
	Sets the average inflow velocity. More...

Mdouble	getInflowVelocity () const
	Returns the average inflow velocity. More...

void	setInflowVelocityVariance (Mdouble inflowVelocityVariance)
	Sets the inflow velocity variance. More...

Mdouble	getInflowVelocityVariance () const
	Returns the inflow velocity variance. More...

void	setChuteWidth (Mdouble chuteWidth)
	Sets the chute width (Y-direction) More...

Mdouble	getChuteWidth () const
	Returns the chute width (Y-direction) More...

Mdouble	getChuteLength () const
	Returns the chute length (X-direction) More...

int	getNCreated () const

void	increaseNCreated ()

void	setInsertionBoundary (InsertionBoundary *insertionBoundary)
	Sets the chute insertion boundary. More...

Public Member Functions inherited from Mercury3D
	Mercury3D ()
	This is the default constructor. All it does is set sensible defaults. More...

	Mercury3D (const DPMBase &other)
	Copy-constructor for creates an Mercury3D problem from an existing MD problem. More...

	Mercury3D (const Mercury3D &other)
	Copy-constructor. More...

void	constructor ()
	Function that sets the SystemDimension and ParticleDimension to 3. More...

Public Member Functions inherited from MercuryBase
	MercuryBase ()
	This is the default constructor. It sets sensible defaults. More...

	~MercuryBase ()
	This is the default destructor. More...

	MercuryBase (const MercuryBase &mercuryBase)
	Copy-constructor. More...

void	constructor ()
	This is the actual constructor, it is called do both constructors above. More...

void	hGridActionsBeforeTimeLoop () override
	This sets up the broad phase information, has to be done at this stage because it requires the particle size. More...

void	hGridActionsBeforeTimeStep () override
	Performs all necessary actions before a time-step, like updating the particles and resetting all the bucket information, etc. More...

void	read (std::istream &is) override
	Reads the MercuryBase from an input stream, for example a restart file. More...

void	write (std::ostream &os, bool writeAllParticles=true) const override
	Writes the MercuryBase to an output stream, for example a restart file. More...

Mdouble	getHGridCurrentMaxRelativeDisplacement () const
	Returns hGridCurrentMaxRelativeDisplacement_. More...

Mdouble	getHGridTotalCurrentMaxRelativeDisplacement () const
	Returns hGridTotalCurrentMaxRelativeDisplacement_. More...

void	setHGridUpdateEachTimeStep (bool updateEachTimeStep)
	Sets whether or not the HGrid must be updated every time step. More...

bool	getHGridUpdateEachTimeStep () const override
	Gets whether or not the HGrid is updated every time step. More...

void	setHGridMaxLevels (unsigned int HGridMaxLevels)
	Sets the maximum number of levels of the HGrid in this MercuryBase. More...

unsigned int	getHGridMaxLevels () const
	Gets the maximum number of levels of the HGrid in this MercuryBase. More...

HGridMethod	getHGridMethod () const
	Gets whether the HGrid in this MercuryBase is BOTTOMUP or TOPDOWN. More...

void	setHGridMethod (HGridMethod hGridMethod)
	Sets the HGridMethod to either BOTTOMUP or TOPDOWN. More...

HGridDistribution	getHGridDistribution () const
	Gets how the sizes of the cells of different levels are distributed. More...

void	setHGridDistribution (HGridDistribution hGridDistribution)
	Sets how the sizes of the cells of different levels are distributed. More...

Mdouble	getHGridCellOverSizeRatio () const
	Gets the ratio of the smallest cell over the smallest particle. More...

void	setHGridCellOverSizeRatio (Mdouble cellOverSizeRatio)
	Sets the ratio of the smallest cell over the smallest particle. More...

bool	hGridNeedsRebuilding ()
	Gets if the HGrid needs rebuilding before anything else happens. More...

virtual unsigned int	getHGridTargetNumberOfBuckets () const
	Gets the desired number of buckets, which is the maximum of the number of particles and 10. More...

virtual Mdouble	getHGridTargetMinInteractionRadius () const
	Gets the desired size of the smallest cells of the HGrid. More...

virtual Mdouble	getHGridTargetMaxInteractionRadius () const
	Gets the desired size of the largest cells of the HGrid. More...

bool	checkParticleForInteraction (const BaseParticle &P) override
	Checks if given BaseParticle has an interaction with a BaseWall or other BaseParticle. More...

virtual Mdouble	userHGridCellSize (unsigned int level)
	Virtual function that enables inheriting classes to implement a function to let the user set the cell size of the HGrid. More...

void	hGridInfo () const
	Writes the info of the HGrid to the screen in a nice format. More...

Public Member Functions inherited from DPMBase
void	constructor ()
	A function which initialises the member variables to default values, so that the problem can be solved off the shelf; sets up a basic two dimensional problem which can be solved off the shelf. It is called in the constructor DPMBase(). More...

	DPMBase ()
	Constructor that calls the "void constructor()". More...

	DPMBase (const FilesAndRunNumber &other)
	Copy constructor type-1. More...

	DPMBase (const DPMBase &other)
	Copy constructor type-2. More...

virtual	~DPMBase ()
	virtual destructor More...

void	solve ()
	The work horse of the code. More...

void	checkSettings ()
	Checks if the essentials are set properly to go ahead with solving the problem. More...

virtual void	writeOutputFiles ()
	Writes the simulation data onto all the files i.e. .data, .ene, .fstat ... More...

void	solve (int argc, char *argv[])
	The solve function is the work horse of the code with the user input. More...

virtual void	writeXBallsScript () const
	This writes a script which can be used to load the xballs problem to display the data just generated. More...

virtual double	getInfo (const BaseParticle &P) const
	A virtual method that allows the user to overrride and set what is written into the info column in the data file. By default it returns the Species ID number. More...

virtual void	writeRestartFile ()
	Stores all the particle data for current save time step. Calls the write function. More...

int	readRestartFile ()
	Reads all the particle data corresponding to the current saved time step. Which is what the restart file basically stores. The problem description with the latest particle data. More...

int	readRestartFile (std::string fileName)
	Also reads all the particle data corresponding to the current saved time step. More...

virtual void	readOld (std::istream &is)
	Reads all particle data into a restart file; old version. More...

bool	readDataFile (const std::string fileName, unsigned int format=0)
	This allows particle data to be reloaded from data files. More...

bool	readParAndIniFiles (const std::string fileName)
	Allows the user to read par.ini files (useful to read MDCLR files) More...

bool	readNextDataFile (unsigned int format=0)
	Reads the next data file with default format=0. However, one can modify the format based on whether the particle data corresponds to 3D or 2D data. See XBalls/xballs.txt. More...

bool	findNextExistingDataFile (Mdouble tMin, bool verbose=true)
	Useful when fileType is chosen as Multiple Files or Multiple files with padded. More...

bool	readArguments (int argc, char *argv[])
	Can interpret main function input arguments that are passed by the driver codes. More...

Mdouble	getTime () const
	Access function for the time. More...

unsigned int	getNtimeSteps () const
	Returns the current counter of time steps. More...

void	setTime (Mdouble time)
	Access function for the time. More...

void	setTimeMax (Mdouble newTMax)
	Allows the upper time limit to be changed. More...

Mdouble	getTimeMax () const
	Allows the user to access the total simulation time during the simulation. Cannot change it though. More...

void	setDoCGAlways (bool newDoCGFlag)

void	setRotation (bool newRotFlag)
	Allows to set the flag for enabling or disabling particle rotation in the simulations. More...

bool	getRotation () const
	Returns a flag indicating if particle rotation is enabled or disabled. More...

bool	getDoCGAlways () const

Mdouble	getXMin () const
	If the length of the problem domain in x-direction is XMax - XMin, then getXMin() returns XMin,. More...

Mdouble	getXMax () const
	If the length of the problem domain in x-direction is XMax - XMin, then getXMax() returns XMax,. More...

Mdouble	getYMin () const
	If the length of the problem domain in y-direction is YMax - YMin, then getYMin() returns YMin,. More...

Mdouble	getYMax () const
	If the length of the problem domain in y-direction is YMax - YMin, then getYMax() returns XMax,. More...

Mdouble	getZMin () const
	If the length of the problem domain in z-direction is ZMax - ZMin, then getZMin() returns ZMin,. More...

Mdouble	getZMax () const
	If the length of the problem domain in z-direction is ZMax - ZMin, then getZMax() returns ZMax,. More...

void	setXMin (Mdouble newXMin)
	If the length of the problem domain in x-direction is XMax - XMin, this method sets XMin. More...

void	setYMin (Mdouble newYMin)
	If the length of the problem domain in y-direction is YMax - YMin, this method sets YMin. More...

void	setZMin (Mdouble newZMin)
	If the length of the problem domain in z-direction is ZMax - ZMin, this method sets ZMin. More...

void	setXMax (Mdouble newXMax)
	If the length of the problem domain in x-direction is XMax - XMin, this method sets XMax. More...

void	setYMax (Mdouble newYMax)
	If the length of the problem domain in y-direction is YMax - YMin, this method sets YMax. More...

void	setZMax (Mdouble newZMax)
	If the length of the problem domain in z-direction is XMax - XMin, this method sets ZMax. More...

void	setTimeStep (Mdouble newDt)
	Allows the time step dt to be changed. More...

Mdouble	getTimeStep () const
	Allows the time step dt to be accessed. More...

void	setXBallsColourMode (int newCMode)
	Set the xball output mode. More...

int	getXBallsColourMode () const
	Get the xball colour mode (CMode) More...

void	setXBallsVectorScale (double newVScale)
	Set the scale of vectors in xballs. More...

double	getXBallsVectorScale () const
	Returns the scale of vectors used in xballs. More...

void	setXBallsAdditionalArguments (std::string newXBArgs)
	Set the additional arguments for xballs. More...

std::string	getXBallsAdditionalArguments () const

void	setXBallsScale (Mdouble newScale)
	Sets the scale of the view (either normal, zoom in or zoom out) to display in xballs. The default is fit to screen. More...

double	getXBallsScale () const
	Returns the scale of the view in xballs. More...

void	setGravity (Vec3D newGravity)
	Allows to modify the gravity vector. More...

Vec3D	getGravity () const
	Returns the gravity vector. More...

void	setDimension (unsigned int newDim)
	Sets the system and particle dimension. More...

void	setSystemDimensions (unsigned int newDim)
	Allows for the dimension of the simulation to be changed. More...

unsigned int	getSystemDimensions () const
	Returns the dimension of the simulation. Note there is also a particle dimension. More...

void	setParticleDimensions (unsigned int particleDimensions)
	Allows the dimension of the particle (f.e. for mass) to be changed. e.g. discs or spheres. More...

unsigned int	getParticleDimensions () const
	Returns the particle dimensions. More...

std::string	getRestartVersion () const
	This is to take into account for different Mercury versions. Returns the version of the restart file. More...

void	setRestartVersion (std::string newRV)
	Sets restart_version. More...

bool	getRestarted () const
	Returns the flag denoting if the simulation was restarted or not. More...

void	setRestarted (bool newRestartedFlag)
	Allows to set the flag stating if the simulation is to be restarted or not. More...

bool	getAppend () const
	Returns the flag denoting if the append option is on or off. More...

void	setAppend (bool newAppendFlag)
	Allows to set the append option. More...

Mdouble	getElasticEnergy () const
	Returns the global elastic energy within the system. More...

Mdouble	getKineticEnergy () const
	Returns the global kinetic energy stored in the system. More...

bool	areInContact (const BaseParticle pI, const BaseParticle pJ) const
	Checks if two particle are in contact or is there any positive overlap. More...

virtual void	hGridInsertParticle (BaseParticle *obj UNUSED)
	no implementation but can be overidden in its derived classes. More...

virtual void	hGridUpdateParticle (BaseParticle *obj UNUSED)
	no implementation but can be overidden in its derived classes. More...

virtual void	hGridRemoveParticle (BaseParticle *obj UNUSED)
	no implementation but can be overidden in its derived classes. More...

virtual void	gatherContactStatistics (unsigned int index1 UNUSED, int index2 UNUSED, Vec3D Contact UNUSED, Mdouble delta UNUSED, Mdouble ctheta UNUSED, Mdouble fdotn UNUSED, Mdouble fdott UNUSED, Vec3D P1_P2_normal_ UNUSED, Vec3D P1_P2_tangential UNUSED)
	//Not unsigned index because of possible wall collisions. More...

Public Member Functions inherited from FilesAndRunNumber
	FilesAndRunNumber ()
	Constructor. More...

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

virtual	~FilesAndRunNumber ()
	Constructor. More...

void	constructor ()
	a function called by the FilesAndRunNumber() (constructor) More...

void	incrementRunNumberInFile ()
	Increment the run Number (counter value) stored in the file_counter (COUNTER_DONOTDEL) by 1 and store the new value in the counter file. More...

int	readRunNumberFromFile ()
	Read the run number or the counter from the counter file (COUNTER_DONOTDEL) More...

void	autoNumber ()
	The autoNumber() function is the trigger. It calls three functions. setRunNumber(), readRunNumberFromFile() and incrementRunNumberInFile(). More...

std::vector< int >	get2DParametersFromRunNumber (int size_x, int size_y)
	This turns a counter into two indices which is an amazing feature for doing two dimensional parameter studies. The indices run from 1:size_x and 1:size_y, while the study number starts at 0 ( initially the counter=1 in COUNTER_DONOTDEL) More...

int	launchNewRun (const char *name, bool quick=false)
	This launches a code from within this code. Please pass the name of the code to run. More...

void	setRunNumber (int runNumber)
	This sets the counter/Run number, overriding the defaults. More...

int	getRunNumber () const
	This returns the current value of the counter (runNumber_) More...

void	read (std::istream &is)
	Accepts an input stream std::istream. More...

void	write (std::ostream &os) const
	Accepts an output stream read function, which accepts an input stream std::ostream. More...

Public Member Functions inherited from Files
	Files ()
	A constructor. More...

virtual	~Files ()
	A destructor, watch out its a virtual destructor. More...

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

MERCURY_DEPRECATED File &	getDataFile ()
	The non const version. Allows one to edit the File::dataFile. More...

MERCURY_DEPRECATED File &	getEneFile ()
	The non const version. Allows to edit the File::eneFile. More...

MERCURY_DEPRECATED File &	getFStatFile ()
	The non const version. Allows to edit the File::fStatFile. More...

MERCURY_DEPRECATED File &	getRestartFile ()
	The non const version. Allows to edit the File::restartFile. More...

MERCURY_DEPRECATED File &	getStatFile ()
	The non const version. Allows to edit the File::statFile. More...

MERCURY_DEPRECATED const File &	getDataFile () const
	The const version. Does not allow for any editing of the File::dataFile. More...

MERCURY_DEPRECATED const File &	getEneFile () const
	The const version. Does not allow for any editing of the File::eneFile. More...

MERCURY_DEPRECATED const File &	getFStatFile () const
	The const version. Does not allow for any editing of the File::fStatFile. More...

MERCURY_DEPRECATED const File &	getRestartFile () const
	The const version. Does not allow for any editing of the File::restartFile. More...

MERCURY_DEPRECATED const File &	getStatFile () const
	The const version. Does not allow for any editing of the File::statFile. More...

const std::string &	getName () const
	Returns the name of the file. Does not allow to change it though. More...

void	setName (const std::string &name)
	Allows to set the name of all the files (ene, data, fstat, restart, stat) More...

void	setName (const char *name)
	Calls setName(std::string) More...

void	setSaveCount (unsigned int saveCount)
	Sets File::saveCount_ for all files (ene, data, fstat, restart, stat) More...

void	setFileType (FileType fileType)
	Sets File::fileType_ for all files (ene, data, fstat, restart, stat) More...

void	setOpenMode (std::fstream::openmode openMode)
	Sets File::openMode_ for all files (ene, data, fstat, restart, stat) More...

void	resetFileCounter ()
	Resets the file counter for each file i.e. for ene, data, fstat, restart, stat) More...

void	read (std::istream &is)
	Extracts data from the input stream (which is basically a file you want to read from) into name_, restartFile .... More...

void	write (std::ostream &os) const
	Writes data into a file from the member variables name_, restartFile, dataFile etc. More...

void	openFiles ()
	Opens all the files (ene, data, fstat, restart, stat) for reading and writing purposes. More...

void	closeFiles ()
	Closes all files (ene, data, fstat, restart, stat) that were opened to read or write. More...

void	setNextSavedTimeStep (unsigned int nextSavedTimeStep)
	Sets the next time step for all the files (ene, data, fstat, restart, stat) at which the data is to be written or saved. More...

Protected Member Functions
void	addHopper ()
	This creates the hopper on top of the chute, see diagram in class description for details of the points. More...

Protected Member Functions inherited from Chute
void	actionsBeforeTimeStep ()
	Calls Chute::cleanChute(). More...

void	cleanChute ()
	Deletes all outflow particles once every 100 time steps. More...

virtual void	createBottom ()
	Creates the chute bottom, which can be either flat or one of three flavours of rough. More...

void	printTime () const
	prints time, max time and number of particles More...

Protected Member Functions inherited from Mercury3D
virtual void	hGridFindContactsWithinTargetCell (int x, int y, int z, unsigned int l)
	Finds contacts between particles in the target cell. More...

virtual void	hGridFindContactsWithTargetCell (int x, int y, int z, unsigned int l, BaseParticle *obj)
	Finds contacts between the BaseParticle and the target cell. More...

void	hGridFindOneSidedContacts (BaseParticle *obj) override
	Finds contacts with the BaseParticle; avoids multiple checks. More...

bool	hGridHasContactsInTargetCell (int x, int y, int z, unsigned int l, const BaseParticle *obj) const
	Tests if the BaseParticle has contacts with other Particles in the target cell. More...

bool	hGridHasParticleContacts (const BaseParticle *obj) override
	Tests if a BaseParticle has any contacts in the HGrid. More...

void	hGridRemoveParticle (BaseParticle *obj)
	Removes a BaseParticle from the HGrid. More...

void	hGridUpdateParticle (BaseParticle *obj) override
	Updates the cell (not the level) of a BaseParticle. More...

Protected Member Functions inherited from MercuryBase
void	hGridRebuild ()
	This sets up the parameters required for the contact model. More...

void	hGridInsertParticle (BaseParticle *obj) override
	Inserts a single Particle to current grid. More...

void	broadPhase (BaseParticle *i) override
	This checks particles in the HGRID to see if for closer enough for possible contact. More...

void	hGridUpdateMove (BaseParticle *iP, Mdouble move) override
	Computes the relative displacement of the given BaseParticle and updates the currentMaxRelativeDisplacement_ accordingly. More...

void	hGridActionsBeforeIntegration () override
	Resets the currentMaxRelativeDisplacement_ to 0. More...

void	hGridActionsAfterIntegration () override
	Sets the totalCurrentMaxRelativeDisplacement_ as 2*currentMaxRelativeDisplacement_. More...

HGrid *	getHGrid ()
	Gets the HGrid used by this problem. More...

const HGrid *	getHGrid () const
	Gets the HGrid used by this problem, const version. More...

bool	readNextArgument (int &i, int argc, char *argv[]) override
	Reads the next command line argument. More...

Protected Member Functions inherited from DPMBase
virtual void	computeAllForces ()
	Computes all the forces acting on the particles by using the setTorque and setForce methods. See BaseInteractible.cc. More...

virtual void	computeInternalForces (BaseParticle *i)
	Computes the forces between particles (internal in the sense that the sum over all these forces is zero i.e. fully modelled forces) More...

virtual void	computeInternalForces (BaseParticle P1, BaseParticle P2)
	Computes the forces between particles (internal in the sense that the sum over all these forces is zero i.e. fully modelled forces) More...

virtual void	computeExternalForces (BaseParticle *PI)
	Computes the external forces acting on particles (e.g. gravitational) More...

virtual void	computeForcesDueToWalls (BaseParticle *PI)
	Computes the forces on the particles due to the walls (normals are outward normals) More...

virtual void	actionsOnRestart ()
	A virtual function where the users can add extra code which is executed only when the code is restarted. More...

virtual void	actionsBeforeTimeLoop ()
	A virtual function. Allows one to carry out any operations before the start of the time loop. More...

virtual void	actionsAfterSolve ()
	A virtual function which allows to define operations to be executed after the solve(). More...

virtual void	actionsAfterTimeStep ()
	A virtual function which allows to define operations to be executed after time step. More...

virtual void	outputXBallsData (std::ostream &os) const
	This function writes the location of the walls and particles in a format the XBalls program can read. See XBalls/xballs.txt. However, MercuryDPM supports a much better viewer now called Paraview. See the tutorials section in the documentation. More...

virtual void	outputXBallsDataParticle (const unsigned int i, const unsigned int format, std::ostream &os) const
	This function writes out the particle locations into an output stream in a format the XBalls program can read. More...

virtual void	writeEneHeader (std::ostream &os) const
	Writes a header with a certain format for ENE file. More...

virtual void	writeFstatHeader (std::ostream &os) const
	Writes a header with a certain format for FStat file. More...

virtual void	writeEneTimestep (std::ostream &os) const
	This function enables one to write the global energy available in the system after each time step. The default is to compute the rotational and translational kinetic energy, potential energy and the centre of mass. More...

virtual void	initialiseStatistics ()
	no implementation but can be overidden in its derived classes. More...

virtual void	outputStatistics ()
	no implementation but can be overidden in its derived classes. More...

void	gatherContactStatistics ()

virtual void	processStatistics (bool usethese UNUSED)
	no implementation but can be overidden in its derived classes. More...

virtual void	finishStatistics ()
	no implementation but can be overidden in its derived classes. More...

virtual void	integrateBeforeForceComputation ()
	This is were the integration is done, at the moment it is velocity Verlet integration and is done before the forces are computed. See http://en.wikipedia.org/wiki/Verlet_integration#Velocity_Verlet. More...

virtual void	integrateAfterForceComputation ()
	Integration is done after force computations. We apply the Velocity verlet scheme. See http://en.wikipedia.org/wiki/Verlet_integration#Velocity_Verlet. More...

virtual void	checkInteractionWithBoundaries ()
	There are a range of boundaries one could implement depending on ones' problem. This methods checks for interactions between particles and such range of boundaries. See BaseBoundary.h and all the boundaries in the Boundaries folder. More...

void	setFixedParticles (unsigned int n)

void	initialiseTangentialSprings ()

virtual bool	continueSolve () const

void	outputInteractionDetails () const
	Displays the interaction details corresponding to the pointer objects in the interaction handler. More...

bool	isTimeEqualTo (Mdouble time) const
	Checks if the input variable "time" is the current time in the simulation. More...

void	removeDuplicatePeriodicParticles ()
	Removes periodic duplicate Particles. More...

void	checkAndDuplicatePeriodicParticles ()
	In case of periodic boundaries, the below methods checks and adds particles when necessary into the particle handler. See DPMBase.cc and PeriodicBoundary.cc for more details. More...

Private Member Functions
void	constructor ()
	This is the actually constructor, get called by all constructors above. More...

Private Attributes
Mdouble	hopperLength_
	Dimension of the hopper in vertical direction. More...

Mdouble	hopperHeight_
	Dimension of the hopper in horizontal direction. More...

Mdouble	hopperAngle_
	Angle between the two pieces of the hopper walls. More...

Mdouble	hopperExitLength_
	Dimension of the hopper exit in vertical direction. More...

Mdouble	hopperExitHeight_
	Dimension of the hopper exit in vertical direction. More...

Mdouble	hopperShift_
	The x position where the Chute starts (defined as the beginning of the hopper) More...

Mdouble	hopperLowerFillingHeight_
	Relative height (in [0,1)) above which the hopper is replenished with new particles. More...

bool	isHopperCentred_
	If this flag is set, the hopper will be constructed in the xy-center of the domain, and not next to the xmin-domain boundary; by default off. More...

Mdouble	hopperLift_
	This is the vertical distance the chute is lifted above the plane. More...

unsigned int	hopperDimension_
	This is the dimension of the hopper, my default it is one dimensional and hence does not have side wall. More...

bool	isHopperAlignedWithBottom_
	This is the flag, which sets if the chute bottom is aligned with the hopper, by default it is. More...

Mdouble	hopperFillingPercentage_
	This is which percentage of the hopper is used for creating new partices;. More...

Mdouble	hopperLowestPoint_
	The NEGATIVE z coordinate of the right C point (when the left C point is in the origin) More...

Additional Inherited Members
Public Attributes inherited from DPMBase
SpeciesHandler	speciesHandler
	A handler to that stores the species type i.e. elastic, linear visco-elastic... et cetera. More...

RNG	random
	This is a random generator, often used for setting up the initial conditions etc... More...

ParticleHandler	particleHandler
	An object of the class ParticleHandler, contains the pointers to all the particles created. More...

WallHandler	wallHandler
	An object of the class WallHandler. Contains pointers to all the walls created. More...

BoundaryHandler	boundaryHandler
	An object of the class BoundaryHandler which concerns insertion and deletion of particles into or from regions. More...

InteractionHandler	interactionHandler
	An object of the class InteractionHandler. More...

Public Attributes inherited from Files
File	dataFile
	An instance of class File to handle in- and output into a .data file. More...

File	fStatFile
	An instance of class File to handle in- and output into a .fstat file. More...

File	eneFile
	An instance of class File to handle in- and output into a .ene file. More...

File	restartFile
	An instance of class File to handle in- and output into a .restart file. More...

File	statFile
	An instance of class File to handle in- and output into a .stat file. More...

Detailed Description

ChuteWithHopper has a hopper as inflow.

The hopper has two parts as follows to create the finite hopper walls, we take vector between two wall points in xz-plane, then rotate clockwise and make unit length.

Sketch of the hopper

A,B,C denote three points on the left and right hopper walls which are used to construct the hopper. Shift denotes the space by which the chute has to be shifted to the right such that the hopper is in the domain. Note: the wall direction has to be set separately either period of walls.

Definition at line 37 of file ChuteWithHopper.h.

Constructor & Destructor Documentation

ChuteWithHopper::ChuteWithHopper ( const Chute & other )

This is a copy constructor for Chute problems.

Bug:: This copy construct is untested

Bug:: This copy construct is untested

Copy constructor with a Chute object as an argument. This constructor basically 'upgrades' the Chute object to one of the ChuteWithHopper class. NB: The copy constructor of DPMBase has to be called because the link from DPMBase to MercuryBase is virtual.

Parameters

[in] other object of Chute class

Definition at line 41 of file ChuteWithHopper.cc.

References constructor().

 : DPMBase(other), Chute(other)
 {
     constructor();
 }

ChuteWithHopper::ChuteWithHopper ( const Mercury3D & other )

Copy constructor, converts an existing Mercury3D object into a ChuteWithHopper object.

Copy constructor with a Mercury3D object as an argument. This constructor basically 'upgrades' the Mercury3D object to one of the ChuteWithHopper class. NB: The copy constructor of DPMBase has to be called because the link from DPMBase to MercuryBase is virtual.

Parameters

[in] other object of Mercury3D class

Definition at line 54 of file ChuteWithHopper.cc.

References constructor().

 : DPMBase(other), Chute(other)
 {
     constructor();
 }

ChuteWithHopper::ChuteWithHopper ( const MercuryBase & other )

Copy constructor, converts an existing MercuryBase object into a ChuteWithHopper object.

Copy constructor with a MercuryBase object as an argument. This constructor basically 'upgrades' the MercuryBase object to one of the ChuteWithHopper class. NB: The copy constructor of DPMBase has to be called because the link from DPMBase to MercuryBase is virtual.

Parameters

[in] other object of MercuryBase class

Definition at line 67 of file ChuteWithHopper.cc.

References constructor().

 : DPMBase(other), Chute(other)
 {
     constructor();
 }

ChuteWithHopper::ChuteWithHopper ( const DPMBase & other )

Copy constructor, converts an existing DPMBase object into a ChuteWithHopper object.

Copy constructor with a DPMBase object as an argument. This constructor basically 'upgrades' the DPMBase object to one of the ChuteWithHopper class. NB: The copy constructor of DPMBase has to be called because the link from DPMBase to MercuryBase is virtual.

Parameters

[in] other object of DPMBase class

Definition at line 80 of file ChuteWithHopper.cc.

References constructor().

 : DPMBase(other), Chute(other)
 {
     constructor();
 }

ChuteWithHopper::ChuteWithHopper ( )

This is the default constructor.

Default constructor. Calls the constructor() method.

Definition at line 89 of file ChuteWithHopper.cc.

References constructor().

 {
     constructor();
 }

Member Function Documentation

void ChuteWithHopper::addHopper ( )

protected

This creates the hopper on top of the chute, see diagram in class description for details of the points.

Creates the actual hopper and rotates it so as to fit in a geometry in which the chute is parallel to the X-axis.

Todo:: Why shift A by arbitrary number of 40, when isHopperCentred_ = True? NB: this is probably the same shift of 40 as happens in HopperInsertionBoundary::generateParticle(RNG) with the calculation of 'point A'. NB2: seems to be just generating a nice 'view' of the hopper (in the center of the viewer...?)

Definition at line 161 of file ChuteWithHopper.cc.

References A, IntersectionOfWalls::addObject(), BaseHandler< T >::begin(), BaseHandler< T >::copyAndAddObject(), Vec3D::cross(), BaseHandler< T >::end(), Chute::getChuteAngle(), Vec3D::getLengthSquared(), DPMBase::getYMax(), DPMBase::getYMin(), hopperAngle_, hopperDimension_, hopperExitHeight_, hopperExitLength_, hopperHeight_, hopperLength_, hopperLift_, hopperLowestPoint_, hopperShift_, isHopperCentred_, DPMBase::particleHandler, setHopperShift(), DPMBase::setZMax(), DPMBase::wallHandler, Vec3D::X, and Vec3D::Z.

Referenced by setupInitialConditions().

 {
     //hopper walls
     //to create the finite hopper walls, we take vector between two wall points in xz-plane, then rotate clockwise and make unit length
     // A\       /A
     //   \     /       A,B,C denote three points on the left and right hopper walls which are used to construct the hopper
     //    \   /        shift denotes the space by which the chute has to be shifted to the right such that the hopper is in the domain
     //   B|   |B
     //    |   |
     //   C|   |
     //        |C
 
     Vec3D A, B, C, temp, normal;
 
     Mdouble s = sin(getChuteAngle());
     Mdouble c = cos(getChuteAngle());
     // height of the lowest part of the hopper (right C in diagram above) as compared to 
     // the vertical position of the start of the chute (left C in diagram above).
     hopperLowestPoint_ = hopperExitHeight_ - hopperExitLength_ * tan(getChuteAngle()); 
     
     // "0.5*(hopperLength_+hopperExitLength_) / tan(hopperAngle_)" is the minimum heigth of the hopper, to make sure things should flow down and not to the sides.
     // hopperHeight_ is now an input variable
     // hopperHeight_ = hopperLowestPoint_ + 1.1 * 0.5*(hopperLength_+hopperExitLength_) / tan(hopperAngle_);
 
     Mdouble HopperCornerHeight = hopperHeight_ - 0.5 * (hopperLength_ - hopperExitLength_) / tan(hopperAngle_);
     // Waarom had ik deze ook al weer gecomment?
     //if (HopperCornerHeight<=0.0) { hopperHeight_ += -HopperCornerHeight + P0.getRadius(); HopperCornerHeight = P0.getRadius(); }
 
     // first we create the LEFT hopper wall
 
     // coordinates of A,B,C in (vertical parallel to flow, vertical normal to flow, horizontal) direction
     A = Vec3D(-0.5 * (hopperLength_ - hopperExitLength_), 0.0, hopperHeight_);
     B = Vec3D(0.0, 0.0, HopperCornerHeight);
     C = Vec3D(0.0, 0.0, 0.0);
 
     // now rotate the coordinates of A,B,C to be in (x,y,z) direction
     A = Vec3D(c * A.X - s * A.Z, 0.0, s * A.X + c * A.Z);
     B = Vec3D(c * B.X - s * B.Z, 0.0, s * B.X + c * B.Z);
     C = Vec3D(c * C.X - s * C.Z, 0.0, s * C.X + c * C.Z);
    
     // the position of A determines hopper shift and zmax
     if (isHopperCentred_)
         setHopperShift(-A.X + 40);
     else
         setHopperShift(-A.X);
     
     setZMax(A.Z);
     A.X += hopperShift_;
     B.X += hopperShift_;
     C.X += hopperShift_;
 
     //This lifts the hopper a distance above the chute
     A.Z += hopperLift_;
     B.Z += hopperLift_;
     C.Z += hopperLift_;
 
     //create a finite wall from B to A and from C to B on the left hand side
     IntersectionOfWalls w_Left;
     temp = B - A;
     normal = Vec3D(temp.Z, 0.0, -temp.X) / sqrt(temp.getLengthSquared());
     w_Left.addObject(normal, A);
     temp = C - B;
     normal = Vec3D(temp.Z, 0.0, -temp.X) / sqrt(temp.getLengthSquared());
     w_Left.addObject(normal, B);
     temp = A - C;
     normal = Vec3D(temp.Z, 0.0, -temp.X) / sqrt(temp.getLengthSquared());
     w_Left.addObject(normal, C);
     wallHandler.copyAndAddObject(w_Left);
 
     //next, do the same for the right wall
     A = Vec3D(hopperLength_ - 0.5 * (hopperLength_ - hopperExitLength_), 0.0, hopperHeight_);
     B = Vec3D(0.5 * (hopperLength_ + hopperExitLength_) - 0.5 * (hopperLength_ - hopperExitLength_), 0.0, HopperCornerHeight);
     C = Vec3D(0.5 * (hopperLength_ + hopperExitLength_) - 0.5 * (hopperLength_ - hopperExitLength_), 0.0, hopperLowestPoint_);
 
     //This rotates the right points
     A = Vec3D(c * A.X - s * A.Z + hopperShift_, 0.0, s * A.X + c * A.Z);
     B = Vec3D(c * B.X - s * B.Z + hopperShift_, 0.0, s * B.X + c * B.Z);
     C = Vec3D(c * C.X - s * C.Z + hopperShift_, 0.0, s * C.X + c * C.Z);
 
     //This lifts the hopper a distance above the chute
     A.Z += hopperLift_;
     B.Z += hopperLift_;
     C.Z += hopperLift_;
 
     //create a finite wall from B to A and from C to B on the right hand side
     IntersectionOfWalls w_Right;
     temp = A - B;
     normal = Vec3D(temp.Z, 0.0, -temp.X) / sqrt(temp.getLengthSquared());
     w_Right.addObject(normal, A);
     temp = B - C;
     normal = Vec3D(temp.Z, 0.0, -temp.X) / sqrt(temp.getLengthSquared());
     w_Right.addObject(normal, B);
     temp = C - A;
     normal = Vec3D(temp.Z, 0.0, -temp.X) / sqrt(temp.getLengthSquared());
     w_Right.addObject(normal, C);
     wallHandler.copyAndAddObject(w_Right);
 
     setZMax(A.Z);
     
     // if hopperDimension_ == 2, create inclined hopper walls (like in the X-direction) also in the Y-direction.
     // (Else, place vertical (possibly periodic) walls in Y-direction. -> not mentioned here, where is this arranged? (BvdH))
     if (hopperDimension_ == 2)
     {
         //coordinates of A,B,C in (vertical parallel to flow,vertical normal to flow, horizontal) direction
         A = Vec3D(0.0, (getYMax() - getYMin() - hopperLength_) / 2.0, hopperHeight_);
         B = Vec3D(0.0, (getYMax() - getYMin() - hopperExitLength_) / 2.0, HopperCornerHeight);
         C = Vec3D(0.0, (getYMax() - getYMin() - hopperExitLength_) / 2.0, 0.0);
 
         //now rotate the coordinates of A,B,C to be in (x,y,z) direction
         A = Vec3D(c * A.X - s * A.Z, A.Y, s * A.X + c * A.Z);
         B = Vec3D(c * B.X - s * B.Z, B.Y, s * B.X + c * B.Z);
         C = Vec3D(c * C.X - s * C.Z, C.Y, s * C.X + c * C.Z);
         // the position of A determines shift and zmax
         A.X += hopperShift_;
         B.X += hopperShift_;
         C.X += hopperShift_;
 
         //This lifts the hopper a distance above the chute
         A.Z += hopperLift_;
         B.Z += hopperLift_;
         C.Z += hopperLift_;
 
         //create a finite wall from B to A and from C to B
         IntersectionOfWalls w_Back;
         temp = B - A;
         normal = Vec3D::cross(Vec3D(-c, 0, -s), temp) / sqrt(temp.getLengthSquared());
         //normal  = Vec3D(0.0,temp.Z,-temp.Y) / sqrt(temp.GetLength2());
         w_Back.addObject(normal, A);
         temp = C - B;
         //normal  = Vec3D(0.0,temp.Z,-temp.Y) / sqrt(temp.GetLength2());
         normal = Vec3D::cross(Vec3D(-c, 0, -s), temp) / sqrt(temp.getLengthSquared());
         w_Back.addObject(normal, B);
         temp = A - C;
         //normal = Vec3D(0.0,temp.Z,-temp.Y)/sqrt(temp.GetLength2());
         normal = Vec3D::cross(Vec3D(-c, 0, -s), temp) / sqrt(temp.getLengthSquared());
         w_Back.addObject(normal, C);
         wallHandler.copyAndAddObject(w_Back);
 
         //Now for the right y-wall
         A = Vec3D(0.0, (getYMax() - getYMin() + hopperLength_) / 2.0, hopperHeight_);
         B = Vec3D(0.0, (getYMax() - getYMin() + hopperExitLength_) / 2.0, HopperCornerHeight);
         C = Vec3D(0.0, (getYMax() - getYMin() + hopperExitLength_) / 2.0, 0.0);
 
         //now rotate the coordinates of A,B,C to be in (x,y,z) direction
         A = Vec3D(c * A.X - s * A.Z, A.Y, s * A.X + c * A.Z);
         B = Vec3D(c * B.X - s * B.Z, B.Y, s * B.X + c * B.Z);
         C = Vec3D(c * C.X - s * C.Z, C.Y, s * C.X + c * C.Z);
         // the position of A determines shift and zmax
         A.X += hopperShift_;
         B.X += hopperShift_;
         C.X += hopperShift_;
 
         //This lifts the hopper a distance above the chute
         A.Z += hopperLift_;
         B.Z += hopperLift_;
         C.Z += hopperLift_;
 
         //create a finite wall from B to A and from C to B
         IntersectionOfWalls w_Front;
         temp = A - B;
         normal = Vec3D::cross(Vec3D(-c, 0, -s), temp) / sqrt(temp.getLengthSquared());
         //normal  = Vec3D(0.0,-temp.Z,temp.Y) / sqrt(temp.GetLength2());
         w_Front.addObject(normal, A);
         temp = B - C;
         //normal  = Vec3D(0.0,-temp.Z,temp.Y) / sqrt(temp.GetLength2());
         normal = Vec3D::cross(Vec3D(-c, 0, -s), temp) / sqrt(temp.getLengthSquared());
         w_Front.addObject(normal, B);
         temp = C - A;
         //normal = Vec3D(0.0,-temp.Z,temp.Y)/sqrt(temp.GetLength2());
         normal = Vec3D::cross(Vec3D(-c, 0, -s), temp) / sqrt(temp.getLengthSquared());
         w_Front.addObject(normal, C);
         wallHandler.copyAndAddObject(w_Front);
     }
 
     //now shift the chute as well, i.e. apply the shift to all the fixed particles 
     // at the bottom of the chute
     for (std::vector<BaseParticle*>::iterator it = particleHandler.begin(); it != particleHandler.end(); ++it)
     {
         (*it)->move(Vec3D(hopperShift_, 0.0, 0.0));
     }
 }

void ChuteWithHopper::constructor ( )

private

This is the actually constructor, get called by all constructors above.

constructor METHOD, which sets all ChuteWithHopper properties to something sensible.

Definition at line 97 of file ChuteWithHopper.cc.

References hopperDimension_, hopperFillingPercentage_, hopperLift_, hopperLowerFillingHeight_, hopperShift_, isHopperAlignedWithBottom_, isHopperCentred_, and setHopper().

Referenced by ChuteWithHopper().

 {
     hopperLowerFillingHeight_ = 0.5;
     hopperLift_ = 0.0;
     setHopper(0.01, 0.01, 60.0, 0.08, 0.04);
     hopperShift_ = 0.0;
     hopperDimension_ = 1;
     isHopperAlignedWithBottom_ = true;
 
     hopperFillingPercentage_ = 50.0;
     isHopperCentred_ = false;
 
 }

Mdouble ChuteWithHopper::getChuteLength ( )

Allows chute length to be accessed.

Returns the length of the chute. The start of the view, at x = 0, is hopperShift_ to the left of the start of the chute.

Returns: the hopper length

Definition at line 506 of file ChuteWithHopper.cc.

References DPMBase::getXMax(), and hopperShift_.

 {
     return getXMax() - hopperShift_;
 }

Mdouble ChuteWithHopper::getHopperAngle ( )

Returns the angle of the hopper entrance relative to the vertical.

Returns the hopper angle (relative to the vertical) in RADIANS

Definition at line 594 of file ChuteWithHopper.cc.

References hopperAngle_.

 {
     return hopperAngle_;
 }

unsigned int ChuteWithHopper::getHopperDimension ( )

Returns whether the hopper has vertical (1) or inclined (2) walls in Y-direction.

Returns the hopperDimension_ property, which determines whether the hopper entrance walls in the Y-direction are inclined (2) or vertical (1).

Definition at line 657 of file ChuteWithHopper.cc.

References hopperDimension_.

 {
     return hopperDimension_;
 }

Mdouble ChuteWithHopper::getHopperExitHeight ( )

Returns the height of the lowest hopper point above the chute.

Returns the (vertical) height of the lowest point of the hopper (hopperLowestPoint_) above the (inclined) chute bottom

Definition at line 627 of file ChuteWithHopper.cc.

References hopperExitHeight_.

 {
     return hopperExitHeight_;
 }

Mdouble ChuteWithHopper::getHopperExitLength ( )

Returns the width of the hopper exit.

Returns the width of the (rectangular) hopper exit

Definition at line 610 of file ChuteWithHopper.cc.

References hopperExitLength_.

 {
     return hopperExitLength_;
 }

Mdouble ChuteWithHopper::getHopperFillingPercentage ( )

Returns the vertical percentage of the hopper insertion boundary which is filled.

Returns the percentage of the height of the hopper 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')}. See also the documentation of the HopperInsertionBoundary class.

Definition at line 648 of file ChuteWithHopper.cc.

References hopperFillingPercentage_.

 {
     return hopperFillingPercentage_;
 }

Mdouble ChuteWithHopper::getHopperHeight ( )

Returns the height of the hopper relative to the chute start.

Returns the (vertical) height of the hopper relative to the start of the chute

Definition at line 618 of file ChuteWithHopper.cc.

References hopperHeight_.

 {
     return hopperHeight_;
 }

Mdouble ChuteWithHopper::getHopperLength ( )

Returns the width of the hopper entrance.

Returns the horizontal width of the hopper input (at the top of the hopper)

Definition at line 602 of file ChuteWithHopper.cc.

References hopperLength_.

 {
     return hopperLength_;
 }

Mdouble ChuteWithHopper::getHopperLift ( )

Returns the hopper's lift above the chute bottom plane.

Returns the amount the hopper is lifted above the X-axis (in Z-direction, i.e. AFTER rotation of the system to have the chute parallel to the X-axis)

Definition at line 675 of file ChuteWithHopper.cc.

References hopperLift_.

 {
     return hopperLift_;
 }

Mdouble ChuteWithHopper::getHopperLowestPoint ( )

Returns the vertical distance of the lowest hopper point relative to the start of the chute.

Definition at line 357 of file ChuteWithHopper.cc.

References hopperLowestPoint_.

Referenced by setHopper().

 {
     return hopperLowestPoint_;
 }

Mdouble ChuteWithHopper::getHopperShift ( )

Returns the shift in X-direction of the whole setup after rotation.

Returns the distance the whole setup is shifted in the X-direction relative from the position at which the start of the CHUTE is at X = 0.

Definition at line 684 of file ChuteWithHopper.cc.

References hopperShift_.

 {
     return hopperShift_;
 }

bool ChuteWithHopper::getIsHopperCentred ( )

Returns whether the setup is shifted another 40 units in X-direction.

Returns the isHopperCentered_ property, which determines whether the whole setup is shifted another 40 units of length in the X-direction. See also ChuteWithHopper::addHopper().

Returns: if TRUE, the whole setup is shifted 40 units of length towards the positive X-direction.

Definition at line 637 of file ChuteWithHopper.cc.

References isHopperCentred_.

 {
     return isHopperCentred_;
 }

Mdouble ChuteWithHopper::getMaximumVelocityInducedByGravity ( )

Returns the theoretical maximum particle velocity due to gravity.

Returns the maximum velocity a particle could theoretically reach by gravity, would it fall from the top of the hopper straight to the bottom of the system.

Returns: The maximum velocity possible due to gravity

Definition at line 476 of file ChuteWithHopper.cc.

References Chute::getChuteAngle(), DPMBase::getGravity(), DPMBase::getXMax(), hopperHeight_, and hopperShift_.

Referenced by getTimeStepRatio().

 {
     Mdouble height = hopperHeight_ + (getXMax() - hopperShift_) * sin(getChuteAngle());
 
     return sqrt(2.0 * getGravity().getLength() * height);
 }

Mdouble ChuteWithHopper::getTimeStepRatio ( )

Returns smallest particle radius over maximum gravitational velocity.

Returns the ratio of minimum particle radius over maximum distance travelled per time step due to gravitational acceleration, and returns a warning when this is smaller then a certain threshold.

Todo:

Consider generalising this method by implementing it in the MercuryBase class.

Author: BvdH NB: this method is used in ChuteWithHopper::setupInitialConditions().

Definition at line 490 of file ChuteWithHopper.cc.

References getMaximumVelocityInducedByGravity(), Chute::getMinInflowParticleRadius(), DPMBase::getTimeStep(), logger, and WARN.

Referenced by setupInitialConditions().

 {
     Mdouble dx = getTimeStep() * getMaximumVelocityInducedByGravity();
     Mdouble rmin = getMinInflowParticleRadius();
     
     if (rmin/dx < 10.)
         logger(WARN,"[ChuteWithHopper::getTimeStepRatio()] ratio of minimum particle radius over max distance travelled per time step due to gravity is only %; consider reducing the time step size!",rmin/dx);
     
     return rmin/dx;
 }

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

virtual

Reads setup properties from an istream.

Reads the setup properties from an istream

Parameters

[in,out] is the istream

Reimplemented from Chute.

Definition at line 567 of file ChuteWithHopper.cc.

References hopperAngle_, hopperExitHeight_, hopperExitLength_, hopperHeight_, hopperLength_, hopperShift_, and Chute::read().

 {
     Chute::read(is);
     is >> hopperExitLength_ >> hopperExitHeight_ >> hopperLength_
             >> hopperAngle_ >> hopperHeight_ >> hopperShift_;
 }

bool ChuteWithHopper::readNextArgument	(	int &	i,
		int	argc,
		char *	argv[]
	)

virtual

Reads setup properties from a string.

this reads parameters from a string.

Parameters

[in]	i	the index of the input parameter to be read
[in]	argc	number of input parameters
[in]	argv[]	pointer to the (first character of the) actual string

Reimplemented from Chute.

Definition at line 712 of file ChuteWithHopper.cc.

References hopperAngle_, hopperExitHeight_, hopperExitLength_, hopperHeight_, hopperLength_, hopperLift_, hopperLowerFillingHeight_, hopperShift_, isHopperAlignedWithBottom_, isHopperCentred_, and Chute::readNextArgument().

 {
     if (!strcmp(argv[i], "-hopperLength"))
     {
         hopperLength_ = (atof(argv[i + 1]));
     }
     else if (!strcmp(argv[i], "-hopperHeight"))
     {
         hopperHeight_ = (atof(argv[i + 1]));
     }
     else if (!strcmp(argv[i], "-hopperAngle"))
     {
         hopperAngle_ = (atof(argv[i + 1]));
     }
     else if (!strcmp(argv[i], "-hopperExitLength"))
     {
         hopperExitLength_ = (atof(argv[i + 1]));
     }
     else if (!strcmp(argv[i], "-hopperExitHeight"))
     {
         hopperExitHeight_ = (atof(argv[i + 1]));
     }
     else if (!strcmp(argv[i], "-hopperLowerFillingHeight_"))
     {
         hopperLowerFillingHeight_ = (atof(argv[i + 1]));
     }
     else if (!strcmp(argv[i], "-isHopperCentred"))
     {
         isHopperCentred_ = (atoi(argv[i + 1]));
     }
     else if (!strcmp(argv[i], "-alignBase"))
     {
         isHopperAlignedWithBottom_ = (atoi(argv[i + 1]));
     }
     else if (!strcmp(argv[i], "-shift"))
     {
         hopperShift_ = (atof(argv[i + 1]));
     }
     else if (!strcmp(argv[i], "-lift"))
     {
         hopperLift_ = (atof(argv[i + 1]));
     }
     else
         return Chute::readNextArgument(i, argc, argv); //if argv[i] is not found, check the commands in Chute
     return true; //returns true if argv[i] is found
 }

void ChuteWithHopper::setChuteLength ( Mdouble chuteLength )

virtual

sets xMax to chuteLength+hopperlength_, and thus specifies the length off the runoff chute

Sets xMax_ such that the total chute length matches the argument.

Parameters

[in] chuteLength The chute length according to which xMax is to be adapted

Reimplemented from Chute.

Definition at line 516 of file ChuteWithHopper.cc.

References hopperShift_, logger, DPMBase::setXMax(), DPMBase::setXMin(), and WARN.

 {
     if (chuteLength >= 0.0)
     {
         setXMax(chuteLength + hopperShift_);
         setXMin(0.0);
     }
     else
         logger(WARN,"[ChuteWithHopper::setChuteLength()] Chute length unchanged, value must be greater than or equal to zero");
 }

void ChuteWithHopper::setHopper	(	Mdouble	ExitLength,
		Mdouble	ExitHeight,
		Mdouble	Angle,
		Mdouble	Length,
		Mdouble	Height
	)

Sets the hopper's geometrical properties.

Sets all the geometrical properties of the hopper at once

Parameters

[in]	ExitLength	Horizontal width of the (rectangular) hopper exit
[in]	ExitHeight	The vertical position of the lowest point of the right side of the hopper relative to the chute bottom
[in]	Angle	The angle of the hopper inlet, relative to the vertical (in DEGREES)
[in]	Length	Horizontal width of the hopper entrance (i.e., at the top of the hopper)
[in]	Height	The (vertical) height of the hopper relative to the start of the chute

Todo:: : check whether HopperCornerHeight >=0, if not change hopperangle, line 105, I do not yet understand what the criteria is...

Definition at line 374 of file ChuteWithHopper.cc.

References ERROR, Chute::getChuteAngle(), getHopperLowestPoint(), hopperAngle_, hopperExitHeight_, hopperExitLength_, hopperHeight_, hopperLength_, logger, constants::pi, setHopperLowestPoint(), and VERBOSE.

Referenced by constructor().

 {
     // HopperCornerHeight: helper variable, just here to check some things
     Mdouble HopperCornerHeight = Height - 0.5 * (Length - ExitLength) / std::tan(Angle * constants::pi / 180.0);
     
     if (ExitLength >= 0.0)
     {
         hopperExitLength_ = ExitLength;
     }
     else
     {
         logger(ERROR,"[ChuteWithHopper::setHopper()] Hopper exit length must be greater than or equal to zero");
         exit(-1);
     }
     
     // hopperExitHeight_
     if (ExitHeight < 0.0) 
     {
         logger(ERROR,"[ChuteWithHopper::setHopper()] Hopper exit height must be greater than or equal to zero");
         exit(-1);
     }
     else if(ExitHeight > HopperCornerHeight + std::tan(getChuteAngle())*ExitLength )
     {
         logger(ERROR,"[ChuteWithHopper::setHopper()] Hopper exit height (%) may not exceed height of hopper corner above chute bottom (%)", ExitHeight, HopperCornerHeight + std::tan(getChuteAngle())*ExitLength );
         exit(-1);
     }
     else //(ExitHeight >= 0.0) /// \todo write check: ExitHeight may NOT exceed vertical distance between chute base and hopper corner!
     {
         hopperExitHeight_ = ExitHeight;
     }
     
     setHopperLowestPoint(hopperExitHeight_ - hopperExitLength_ * tan(getChuteAngle()));
 
     if (Angle > 0.0 && Angle < 90.0)
     {
         hopperAngle_ = Angle * constants::pi / 180.0;
     }
     else
     {
         logger(ERROR,"[ChuteWithHopper::setHopper()] Hopper angle must in (0,90)");
         exit(-1);
     }
 
     if (Length > ExitLength)
     {
         hopperLength_ = Length;
     }
     else
     {
         logger(ERROR,"[ChuteWithHopper::setHopper()] Hopper length must be greater than exit length");
         exit(-1);
     }
     
     // check hopper 'corner height', i.e. the vertical position of point 'B' as compared to the start of the hopper
     // Mdouble HopperCornerHeight = Height - 0.5 * (Length - ExitLength) / std::tan(hopperAngle_ * constants::pi / 180.0);
     if (HopperCornerHeight <= 0.0) 
     {
         // hopperHeight_ += -HopperCornerHeight + problem.getMaxInflowParticleRadius();
         // HopperCornerHeight = problem.getMaxInflowParticleRadius();
         logger(ERROR,"[ChuteWithHopper::setHopper()] height of hopper corner (%) may not be below 0. Increase hopper height to fix.", HopperCornerHeight);
         exit(-1);
     }
     
     logger(VERBOSE, " ");
     logger(VERBOSE, "[ChuteWithHopper::setHopper()] Setting the following hopper geometrical properties:");
     logger(VERBOSE, " hopperLowestPoint_: %, ", getHopperLowestPoint());
     logger(VERBOSE, " hopperLength_: %, ", hopperLength_);
     logger(VERBOSE, " hopperExitLength_: %, ", hopperExitLength_);
     logger(VERBOSE, " hopperAngle_: %, ", hopperAngle_);
     logger(VERBOSE, " Height: %, ", Height);
     logger(VERBOSE, " comparing height: % ", getHopperLowestPoint() + 0.5*(hopperLength_+hopperExitLength_) / tan(hopperAngle_));
     logger(VERBOSE, " ");
     
     Mdouble HeightCompare = (getHopperLowestPoint() + 0.5 * (hopperLength_ + hopperExitLength_) / tan(hopperAngle_));
     //This a semi-ugly fix to check whether Height>=Heightcompare and does not take into account rounding errors
     if ((Height - HeightCompare) > -1e-6 * HeightCompare)
     {
         hopperHeight_ = Height;
     }
     else
     {
         logger(ERROR,"[ChuteWithHopper::setHopper()] For these settings, hopper height must be greater then or equal to %, see drawing", HeightCompare);
         exit(-1);
     }
     
     logger(VERBOSE, " ");
     logger(VERBOSE, "[ChuteWithHopper::setHopper()] Hopper geometry: ");
     logger(VERBOSE, "hopperHeight_: \t %", hopperHeight_);
     logger(VERBOSE, "hopperExitLength_: \t %", hopperExitLength_);
     logger(VERBOSE, "hopperExitHeight_: \t %", hopperExitHeight_);
     logger(VERBOSE, "hopperAngle_: \t %", hopperAngle_);
     logger(VERBOSE, "hopperLength_: \t %", hopperLength_);
     logger(VERBOSE, " ");
 
 }

void ChuteWithHopper::setHopperDimension ( Mdouble hopperDimension )

Sets whether the hopper should have vertical (1) or inclined (2) walls in Y-direction.

Sets the hopperDimension_ property, which determines whether the hopper entrance walls in the Y-direction are inclined (2) or vertical (1).

Definition at line 693 of file ChuteWithHopper.cc.

References hopperDimension_.

 {
     hopperDimension_ = hopperDimension;
 }

void ChuteWithHopper::setHopperFillingPercentage ( Mdouble hopperFillingPercentage )

Sets the hopper filling percentage.

Sets the hopper filling percentage. See also the documentation of the HopperInsertionBoundary class.

Parameters

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

Definition at line 118 of file ChuteWithHopper.cc.

References hopperFillingPercentage_.

 {
     hopperFillingPercentage_ = hopperFillingPercentage;
 }

void ChuteWithHopper::setHopperLift ( Mdouble hopperLift )

This lifts the hopper above the plane of the chute (after rotation)

Sets the amount the hopper is lifted above the X-axis (in Z-direction, i.e. AFTER rotation of the system to have the chute parallel to the X-axis)

Definition at line 666 of file ChuteWithHopper.cc.

References hopperLift_.

 {
     hopperLift_ = hopperLift;
 }

void ChuteWithHopper::setHopperLowerFillingHeight ( Mdouble hopperLowerFillingHeight )

Sets the height above which the hopper is filled with new particles.

Sets the relative height (in [0,1)) above which the hopper is replenished with new particles

Definition at line 541 of file ChuteWithHopper.cc.

References hopperLowerFillingHeight_.

 {
     hopperLowerFillingHeight_ = hopperLowerFillingHeight;
 }

void ChuteWithHopper::setHopperLowestPoint ( Mdouble hopperLowestPoint )

Sets the vertical distance of the lowest hopper point relative to the start of the chute.

Sets the height difference between left hopper bottom (where the chute starts) and right hopper bottom (which 'hovers' above the chute).

Parameters

[in] hopperLowestPoint the lowest point of the right side of the hopper

Definition at line 353 of file ChuteWithHopper.cc.

References hopperLowestPoint_.

Referenced by setHopper().

 {
     hopperLowestPoint_ = hopperLowestPoint;
 }

void ChuteWithHopper::setHopperShift ( Mdouble hopperShift )

Sets the shift in X-direction of the whole setup after rotation.

Sets the distance the whole setup is shifted in the X-direction relative from the position at which the start of the CHUTE is at X = 0.

Parameters

[in] hopperShift The hopper shift to be set

Definition at line 551 of file ChuteWithHopper.cc.

References DPMBase::getXMax(), hopperShift_, logger, DPMBase::setXMax(), and WARN.

Referenced by addHopper().

 {
     if (hopperShift >= 0.0)
     {
         //keeps the ChuteLength constant
         setXMax(getXMax() + hopperShift - hopperShift_);
         hopperShift_ = hopperShift;
     }
     else
         logger(WARN, "[ChuteWithHopper::setHopperShift()] Shift length unchanged, value must be greater than or equal to zero");
 }

void ChuteWithHopper::setIsHopperAlignedWithBottom ( bool isHopperAlignedWithBottom )

Sets the alignment of hopper with chute bottom.

This sets the flag, which determines if the chute bottom is aligned with the hopper

Definition at line 701 of file ChuteWithHopper.cc.

References isHopperAlignedWithBottom_.

 {
     isHopperAlignedWithBottom_ = isHopperAlignedWithBottom;
 }

void ChuteWithHopper::setIsHopperCentred ( bool isHopperCentred )

Sets an extra shift in X-direction of the whole system.

Sets the isHopperCentered_ property, which determines whether the whole setup is shifted another 40 units of length in the X-direction. See also ChuteWithHopper::addHopper().

Parameters

[in] isHopperCentred if TRUE, the whole setup is shifted 40 units of length towards the positive X-direction.

Definition at line 533 of file ChuteWithHopper.cc.

References isHopperCentred_.

 {
     isHopperCentred_ = isHopperCentred;
 }

void ChuteWithHopper::setupInitialConditions ( )

virtual

Sets up the initial conditions for the problem.

Sets up the problem initial conditions:

Creates chute side walls
Creates a hopper insertion boundary
Creates a chute bottom
Creates a hopper at the start of the chute

Reimplemented from Chute.

Definition at line 130 of file ChuteWithHopper.cc.

References addHopper(), DPMBase::boundaryHandler, BaseHandler< T >::copyAndAddObject(), Chute::createBottom(), Chute::getChuteAngle(), Chute::getFixedParticleRadius(), BaseHandler< T >::getLastObject(), Chute::getMaxFailed(), Chute::getMaxInflowParticleRadius(), Chute::getMinInflowParticleRadius(), BaseHandler< T >::getObject(), getTimeStepRatio(), DPMBase::getYMax(), DPMBase::getYMin(), hopperAngle_, hopperDimension_, hopperExitLength_, hopperFillingPercentage_, hopperHeight_, hopperLength_, hopperLift_, isHopperCentred_, HopperInsertionBoundary::set(), Chute::setInsertionBoundary(), BaseParticle::setSpecies(), Chute::setupSideWalls(), and DPMBase::speciesHandler.

 {
     
     // check time step ratio
     getTimeStepRatio();
     
     // create chute side walls (either periodic or solid, based on (the inherited) 
     // boolean Chute::isChutePeriodic_ data member).
     setupSideWalls();
     
     // create insertion boundary for the hopper and set a fill percentage
     HopperInsertionBoundary b1;
     BaseParticle* p1 = new BaseParticle();
     p1->setSpecies(speciesHandler.getObject(0));
     b1.set(p1, getMaxFailed(), getYMin(), getYMax(), getMinInflowParticleRadius(), getMaxInflowParticleRadius(),
             getChuteAngle(), getFixedParticleRadius(), isHopperCentred_, hopperDimension_, hopperAngle_, hopperLength_,
             hopperExitLength_,hopperHeight_, hopperLift_, hopperFillingPercentage_);
     boundaryHandler.copyAndAddObject(b1);
     setInsertionBoundary(dynamic_cast<InsertionBoundary*>(boundaryHandler.getLastObject()));
     
     // create the chute bottom
     createBottom();
 
     // create the hopper
     addHopper();
 }

void ChuteWithHopper::write	(	std::ostream &	os,
		bool	writeAllParticles = `true`
	)		const

virtual

Writes setup properties to an ostream.

Writes object's properties to an ostream

Parameters

[in]	os	the ostream
[in]	writeAllParticles	If TRUE, the properties of ALL particles in the particleHandler are written to the ostream. If FALSE, only the properties of the first two particles in the handler are written to the ostream (see DPMBase::write(std::ostream& os, bool writeAllParticles)).

Reimplemented from Chute.

Definition at line 584 of file ChuteWithHopper.cc.

References hopperAngle_, hopperExitHeight_, hopperExitLength_, hopperHeight_, hopperLength_, hopperShift_, and Chute::write().

 {
     Chute::write(os, writeAllParticles);
     os << hopperExitLength_ << " " << hopperExitHeight_ << " " << hopperLength_
             << " " << hopperAngle_ << " " << hopperHeight_ << " " << hopperShift_ << " " << std::endl;
 }