MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ChuteWithHopper Class Reference

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 () const
 Returns the vertical distance of the lowest hopper point relative to the start of the chute. More...
 
Mdouble getChuteLength () const
 Allows chute length to be accessed. More...
 
void setChuteLength (Mdouble chuteLength) override
 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 () const
 Returns the hopper's lift above the chute bottom plane. More...
 
Mdouble getHopperShift () const
 Returns the shift in X-direction of the whole setup after rotation. More...
 
void setHopperDimension (unsigned int 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 () const
 Returns the angle of the hopper entrance relative to the vertical. More...
 
Mdouble getHopperLength () const
 Returns the width of the hopper entrance. More...
 
Mdouble getHopperExitLength () const
 Returns the width of the hopper exit. More...
 
Mdouble getHopperHeight () const
 Returns the height of the hopper relative to the chute start. More...
 
Mdouble getHopperExitHeight () const
 Returns the height of the lowest hopper point above the chute. More...
 
bool getIsHopperCentred () const
 Returns whether the setup is shifted another 40 units in X-direction. More...
 
Mdouble getHopperFillingPercentage () const
 Returns the vertical percentage of the hopper insertion boundary which is filled. More...
 
unsigned int getHopperDimension () const
 Returns whether the hopper has vertical (1) or inclined (2) walls in Y-direction. More...
 
void setupInitialConditions () override
 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 () const
 Returns the theoretical maximum particle velocity due to gravity. More...
 
Mdouble getTimeStepRatio () const
 Returns smallest particle radius over maximum gravitational velocity. More...
 
void read (std::istream &is, ReadOptions opt=ReadOptions::ReadAll) override
 Reads setup properties from an istream. More...
 
void write (std::ostream &os, bool writeAllParticles=true) const override
 Writes setup properties to an ostream. More...
 
bool readNextArgument (int &i, int argc, char *argv[]) override
 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...
 
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...
 
std::vector< BaseParticle * > hGridFindParticleContacts (const BaseParticle *obj) override
 Returns all particles that have a contact with a given particle. More...
 
- Public Member Functions inherited from MercuryBase
 MercuryBase ()
 This is the default constructor. It sets sensible defaults. More...
 
 ~MercuryBase () override
 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, ReadOptions opt=ReadOptions::ReadAll) 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 final
 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) final
 Checks if given BaseParticle has an interaction with a BaseWall or other BaseParticle. More...
 
bool checkParticleForInteractionLocal (const BaseParticle &P) final
 Checks if the given BaseParticle has an interaction with a BaseWall or other BaseParticles in a local domain. 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 (std::ostream &os=std::cout) 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 DPMBase &other)
 Copy constructor type-2. More...
 
virtual ~DPMBase ()
 virtual destructor More...
 
void autoNumber ()
 The autoNumber() function calls three functions: setRunNumber(), readRunNumberFromFile() and incrementRunNumberInFile(). More...
 
std::vector< int > get1DParametersFromRunNumber (int size_x) const
 This turns a counter into 1 index, which is a useful feature for performing 1D parameter study. The index run from 1:size_x, while the study number starts at 0 (initially the counter=1 in COUNTER_DONOTDEL) More...
 
std::vector< int > get2DParametersFromRunNumber (int size_x, int size_y) const
 This turns a counter into 2 indices which is a very useful feature for performing a 2D study. 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...
 
std::vector< int > get3DParametersFromRunNumber (int size_x, int size_y, int size_z) const
 This turns a counter into 3 indices, which is a useful feature for performing a 3D parameter study. The indices run from 1:size_x, 1:size_y and 1:size_z, 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...
 
virtual void decompose ()
 Sends particles from processorId to the root processor. More...
 
void solve ()
 The work horse of the code. More...
 
virtual void computeOneTimeStep ()
 Performs everything needed for one time step, used in the time-loop of solve(). More...
 
void checkSettings ()
 Checks if the essentials are set properly to go ahead with solving the problem. More...
 
void forceWriteOutputFiles ()
 Writes output files immediately, even if the current time step was not meant to be written. Also resets the last saved time step. More...
 
virtual void writeOutputFiles ()
 Writes simulation data to all the main Mercury files: .data, .ene, .fstat, .xballs and .restart (see the Mercury website for more details regarding these files). More...
 
void solve (int argc, char *argv[])
 The work horse of the code. Can handle flags from the command line. 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 Mdouble getInfo (const BaseParticle &P) const
 A virtual function that returns some user-specified information about a particle. More...
 
ParticleVtkWritergetVtkWriter () const
 
virtual void writeRestartFile ()
 Stores all the particle data for current save time step to a "restart" file, which is a file simply intended to store all the information necessary to "restart" a simulation from a given time step (see also MercuryDPM.org for more information on restart files). More...
 
void writeDataFile ()
 
void writeEneFile ()
 
void writeFStatFile ()
 
void fillDomainWithParticles (unsigned N=50)
 Inserts particles in the whole domain. More...
 
bool readRestartFile (ReadOptions opt=ReadOptions::ReadAll)
 Reads all the particle data corresponding to a given, existing . restart file (for more details regarding restart files, refer to the training materials on the MercuryDPM website).Returns true if it is successful, false otherwise. More...
 
int readRestartFile (std::string fileName, ReadOptions opt=ReadOptions::ReadAll)
 The same as readRestartFile(bool), but also reads all the particle data corresponding to the current saved time step. More...
 
virtual BaseWallreadUserDefinedWall (const std::string &type) const
 Allows you to read in a wall defined in a Driver directory; see USER/Luca/ScrewFiller. More...
 
virtual void readOld (std::istream &is)
 Reads all data from a restart file, e.g. domain data and particle data; old version. More...
 
bool readDataFile (std::string fileName="", unsigned int format=0)
 This allows particle data to be reloaded from data files. More...
 
bool readParAndIniFiles (std::string fileName)
 Allows the user to read par.ini files (useful to read files produced by the MDCLR simulation code - external to MercuryDPM) 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 Visualising data in xballs. More...
 
void readNextFStatFile ()
 Reads the next fstat file. More...
 
bool findNextExistingDataFile (Mdouble tMin, bool verbose=true)
 Finds and opens the next data file, if such a file exists. More...
 
bool readArguments (int argc, char *argv[])
 Can interpret main function input arguments that are passed by the driver codes. More...
 
bool checkParticleForInteractionLocalPeriodic (const BaseParticle &P)
 
void readSpeciesFromDataFile (bool read=true)
 
void importParticlesAs (ParticleHandler &particleHandler, InteractionHandler &interactionHandler, const ParticleSpecies *species)
 Copies particles, interactions assigning species from a local simulation to a global one. Useful for the creation of a cluster. More...
 
MERCURY_DEPRECATED FilegetDataFile ()
 The non const version. Allows one to edit the File::dataFile. More...
 
MERCURY_DEPRECATED FilegetEneFile ()
 The non const version. Allows to edit the File::eneFile. More...
 
MERCURY_DEPRECATED FilegetFStatFile ()
 The non const version. Allows to edit the File::fStatFile. More...
 
MERCURY_DEPRECATED FilegetRestartFile ()
 The non const version. Allows to edit the File::restartFile. More...
 
MERCURY_DEPRECATED FilegetStatFile ()
 The non const version. Allows to edit the File::statFile. More...
 
FilegetInteractionFile ()
 Return a reference to the file InteractionsFile. More...
 
MERCURY_DEPRECATED const FilegetDataFile () const
 The const version. Does not allow for any editing of the File::dataFile. More...
 
MERCURY_DEPRECATED const FilegetEneFile () const
 The const version. Does not allow for any editing of the File::eneFile. More...
 
MERCURY_DEPRECATED const FilegetFStatFile () const
 The const version. Does not allow for any editing of the File::fStatFile. More...
 
MERCURY_DEPRECATED const FilegetRestartFile () const
 The const version. Does not allow for any editing of the File::restartFile. More...
 
MERCURY_DEPRECATED const FilegetStatFile () const
 The const version. Does not allow for any editing of the File::statFile. More...
 
const FilegetInteractionFile () const
 
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 closeFiles ()
 Closes all files (ene, data, fstat, restart, stat) that were opened to read or write. More...
 
void setLastSavedTimeStep (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...
 
Mdouble getTime () const
 Returns the current simulation time. More...
 
Mdouble getNextTime () const
 Returns the current simulation time. More...
 
unsigned int getNumberOfTimeSteps () const
 Returns the current counter of time-steps, i.e. the number of time-steps that the simulation has undergone so far. More...
 
void setTime (Mdouble time)
 Sets a new value for the current simulation time. More...
 
void setTimeMax (Mdouble newTMax)
 Sets a new value for the maximum simulation duration. More...
 
Mdouble getTimeMax () const
 Returns the maximum simulation duration. More...
 
void setLogarithmicSaveCount (Mdouble logarithmicSaveCountBase)
 Sets File::logarithmicSaveCount_ for all files (ene, data, fstat, restart, stat) More...
 
void setRotation (bool rotation)
 Sets whether particle rotation is enabled or disabled. More...
 
bool getRotation () const
 Indicates whether particle rotation is enabled or disabled. More...
 
void setWallsWriteVTK (FileType writeWallsVTK)
 Sets whether walls are written into a VTK file. More...
 
void setWallsWriteVTK (bool)
 Sets whether walls are written into a VTK file. More...
 
void setInteractionsWriteVTK (bool)
 Sets whether interactions are written into a VTK file. More...
 
void setParticlesWriteVTK (bool writeParticlesVTK)
 Sets whether particles are written in a VTK file. More...
 
void setSuperquadricParticlesWriteVTK (bool writeSuperquadricParticlesVTK)
 
FileType getWallsWriteVTK () const
 Returns whether walls are written in a VTK file. More...
 
bool getParticlesWriteVTK () const
 Returns whether particles are written in a VTK file. More...
 
bool getSuperquadricParticlesWriteVTK () 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...
 
Vec3D getMin () const
 
Vec3D getMax () const
 
void setXMin (Mdouble newXMin)
 Sets the value of XMin, the lower bound of the problem domain in the x-direction. More...
 
void setYMin (Mdouble newYMin)
 Sets the value of YMin, the lower bound of the problem domain in the y-direction. More...
 
void setZMin (Mdouble newZMin)
 Sets the value of ZMin, the lower bound of the problem domain in the z-direction. More...
 
void setXMax (Mdouble newXMax)
 Sets the value of XMax, the upper bound of the problem domain in the x-direction. More...
 
void setYMax (Mdouble newYMax)
 Sets the value of YMax, the upper bound of the problem domain in the y-direction. More...
 
void setZMax (Mdouble newZMax)
 Sets the value of ZMax, the upper bound of the problem domain in the z-direction. More...
 
void setMax (const Vec3D &max)
 Sets the maximum coordinates of the problem domain. More...
 
void setMax (Mdouble, Mdouble, Mdouble)
 Sets the maximum coordinates of the problem domain. More...
 
void setDomain (const Vec3D &min, const Vec3D &max)
 Sets the minimum coordinates of the problem domain. More...
 
void setMin (const Vec3D &min)
 Sets the minimum coordinates of the problem domain. More...
 
void setMin (Mdouble, Mdouble, Mdouble)
 Sets the minimum coordinates of the problem domain. More...
 
void setTimeStep (Mdouble newDt)
 Sets a new value for the simulation time step. More...
 
Mdouble getTimeStep () const
 Returns the simulation time step. More...
 
void setNumberOfOMPThreads (int numberOfOMPThreads)
 
int getNumberOfOMPThreads () const
 
void setXBallsColourMode (int newCMode)
 Set the xballs output mode. More...
 
int getXBallsColourMode () const
 Get the xballs 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
 Returns the additional arguments for xballs. More...
 
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)
 Sets a new value for the gravitational acceleration. More...
 
Vec3D getGravity () const
 Returns the gravitational acceleration. More...
 
void setDimension (unsigned int newDim)
 Sets both the system dimensions and the particle dimensionality. More...
 
void setSystemDimensions (unsigned int newDim)
 Sets the system dimensionality. More...
 
unsigned int getSystemDimensions () const
 Returns the system dimensionality. More...
 
void setParticleDimensions (unsigned int particleDimensions)
 Sets the particle dimensionality. More...
 
unsigned int getParticleDimensions () const
 Returns the particle dimensionality. 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 whether the "append" option is on or off. More...
 
void setAppend (bool newAppendFlag)
 Sets whether the "append" option is on or off. 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...
 
Mdouble getGravitationalEnergy () const
 Returns the global gravitational potential energy stored in the system. More...
 
Mdouble getRotationalEnergy () const
 JMFT Returns the global rotational energy stored in the system. More...
 
Mdouble getTotalEnergy () const
 
Mdouble getTotalMass () const
 JMFT: Return the total mass of the system, excluding fixed particles. More...
 
Vec3D getCentreOfMass () const
 JMFT: Return the centre of mass of the system, excluding fixed particles. More...
 
Vec3D getTotalMomentum () const
 JMFT: Return the total momentum of the system, excluding fixed particles. More...
 
virtual void hGridInsertParticle (BaseParticle *obj UNUSED)
 
virtual void hGridUpdateParticle (BaseParticle *obj UNUSED)
 
virtual void hGridRemoveParticle (BaseParticle *obj UNUSED)
 
bool mpiIsInCommunicationZone (BaseParticle *particle)
 Checks if the position of the particle is in an mpi communication zone or not. More...
 
bool mpiInsertParticleCheck (BaseParticle *P)
 Function that checks if the mpi particle should really be inserted by the current domain. More...
 
void insertGhostParticle (BaseParticle *P)
 This function inserts a particle in the mpi communication boundaries. More...
 
void updateGhostGrid (BaseParticle *P)
 Checks if the Domain/periodic interaction distance needs to be updated and updates it accordingly. More...
 
virtual void gatherContactStatistics (unsigned int index1, int index2, Vec3D Contact, Mdouble delta, Mdouble ctheta, Mdouble fdotn, Mdouble fdott, Vec3D P1_P2_normal_, Vec3D P1_P2_tangential)
 //Not unsigned index because of possible wall collisions. More...
 
void setNumberOfDomains (std::vector< unsigned > direction)
 Sets the number of domains in x-,y- and z-direction. Required for parallel computations. More...
 
void splitDomain (DomainSplit domainSplit)
 
std::vector< unsignedgetNumberOfDomains ()
 returns the number of domains More...
 
DomaingetCurrentDomain ()
 Function that returns a pointer to the domain corresponding to the processor. More...
 
void removeOldFiles () const
 
void setMeanVelocity (Vec3D V_mean_goal)
 This function will help you set a fixed kinetic energy and mean velocity in your system. More...
 
void setMeanVelocityAndKineticEnergy (Vec3D V_mean_goal, Mdouble Ek_goal)
 This function will help you set a fixed kinetic energy and mean velocity in your system. More...
 
Mdouble getTotalVolume () const
 Get the total volume of the cuboid system. More...
 
Matrix3D getKineticStress () const
 Calculate the kinetic stress tensor in the system averaged over the whole volume. More...
 
Matrix3D getStaticStress () const
 Calculate the static stress tensor in the system averaged over the whole volume. More...
 
Matrix3D getTotalStress () const
 Calculate the total stress tensor in the system averaged over the whole volume. More...
 
void writePythonFileForVTKVisualisation () const
 record when the simulation started 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 () override
 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...
 
virtual void addFlowParticlesCompactly ()
 Add initial flow particles in a dense packing. More...
 
virtual SphericalParticle createFlowParticle ()
 
void printTime () const override
 prints time, max time and number of particles More...
 
- Protected Member Functions inherited from Mercury3D
void hGridFindContactsWithinTargetCell (int x, int y, int z, unsigned int l)
 Finds contacts between particles in the target cell. More...
 
void hGridFindContactsWithTargetCell (int x, int y, int z, unsigned int l, BaseParticle *obj)
 Finds contacts between the BaseParticle and the target cell. More...
 
void computeWallForces (BaseWall *w) override
 Compute contacts with a wall. More...
 
void hGridFindParticlesWithTargetCell (int x, int y, int z, unsigned int l, BaseParticle *obj, std::vector< BaseParticle * > &list)
 Finds particles within target cell and stores them in a list. More...
 
void hGridGetInteractingParticleList (BaseParticle *obj, std::vector< BaseParticle * > &list) override
 Obtains all neighbour particles of a given object, obtained from the hgrid. More...
 
void computeInternalForces (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) override
 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) final
 Inserts a single Particle to current grid. More...
 
void hGridUpdateMove (BaseParticle *iP, Mdouble move) final
 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
 This function has to be called before integrateBeforeForceComputation. More...
 
HGridgetHGrid ()
 Gets the HGrid used by this problem. More...
 
const HGridgetHGrid () 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 using the BaseInteractable::setForce() and BaseInteractable::setTorque() More...
 
virtual void computeInternalForce (BaseParticle *, BaseParticle *)
 Computes the forces between two particles (internal in the sense that the sum over all these forces is zero i.e. fully modelled forces) More...
 
virtual void computeExternalForces (BaseParticle *)
 Computes the external forces, such as gravity, acting on particles. More...
 
void computeForcesDueToWalls (BaseParticle *, BaseWall *)
 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...
 
void writeVTKFiles () const
 
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. For more information on the XBalls program, see Visualising data in xballs. More...
 
virtual void outputXBallsDataParticle (unsigned int i, 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. For more information on the XBalls program, see Visualising data in xballs. 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
 Write the global kinetic, potential energy, etc. in the system. More...
 
virtual void initialiseStatistics ()
 
virtual void outputStatistics ()
 
void gatherContactStatistics ()
 
virtual void processStatistics (bool)
 
virtual void finishStatistics ()
 
virtual void integrateBeforeForceComputation ()
 Update particles' and walls' positions and velocities before force computation. More...
 
virtual void integrateAfterForceComputation ()
 Update particles' and walls' positions and velocities after force computation. 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)
 Sets a number, n, of particles in the particleHandler as "fixed particles". More...
 
virtual bool continueSolve () const
 A virtual function for deciding whether to continue the simulation, based on a user-specified criterion. More...
 
void outputInteractionDetails () const
 Displays the interaction details corresponding to the pointer objects in the interaction handler. More...
 
bool isTimeEqualTo (Mdouble time) const
 Checks whether the input variable "time" is the current time in the simulation. More...
 
void removeDuplicatePeriodicParticles ()
 Removes periodic duplicate Particles. More...
 
void checkAndDuplicatePeriodicParticles ()
 For simulations using periodic boundaries, checks and adds particles when necessary into the particle handler. See DPMBase.cc and PeriodicBoundary.cc for more details. More...
 
void performGhostParticleUpdate ()
 When the Verlet scheme updates the positions and velocities of particles, ghost particles will need an update as wel. Their status will also be updated accordingly. More...
 
void deleteGhostParticles (std::set< BaseParticle * > &particlesToBeDeleted)
 
void synchroniseParticle (BaseParticle *, unsigned fromProcessor=0)
 
void performGhostVelocityUpdate ()
 updates the final time-step velocity of the ghost particles 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 Types inherited from DPMBase
enum  ReadOptions : int { ReadOptions::ReadAll, ReadOptions::ReadNoInteractions, ReadOptions::ReadNoParticlesAndInteractions }
 
enum  DomainSplit {
  DomainSplit::X, DomainSplit::Y, DomainSplit::Z, DomainSplit::XY,
  DomainSplit::XZ, DomainSplit::YZ, DomainSplit::XYZ
}
 
- Static Public Member Functions inherited from DPMBase
static 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...
 
static int readRunNumberFromFile ()
 Read the run number or the counter from the counter file (COUNTER_DONOTDEL) More...
 
static bool areInContact (const BaseParticle *pI, const BaseParticle *pJ)
 Checks if two particle are in contact or is there any positive overlap. More...
 
- Public Attributes inherited from DPMBase
SpeciesHandler speciesHandler
 A handler to that stores the species type i.e. LinearViscoelasticSpecies, etc. 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...
 
ParticleHandler paoloParticleHandler
 Fake particleHandler created by Paolo needed temporary by just Paolo. 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...
 
PeriodicBoundaryHandler periodicBoundaryHandler
 Internal handler that deals with periodic boundaries, especially in a parallel build. More...
 
DomainHandler domainHandler
 An object of the class DomainHandler which deals with parallel code. More...
 
InteractionHandler interactionHandler
 An object of the class InteractionHandler. More...
 
CGHandler cgHandler
 Object of the class cgHandler. More...
 
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...
 
File interactionFile
 File class to handle in- and output into .interactions file. This file hold information about interactions. 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.

hopper.jpg
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 38 of file ChuteWithHopper.h.

Constructor & Destructor Documentation

ChuteWithHopper::ChuteWithHopper ( const Chute other)
explicit

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]otherobject of Chute class

Definition at line 41 of file ChuteWithHopper.cc.

References constructor().

42  : DPMBase(other), Chute(other)
43 {
44  constructor();
45 }
Chute()
This is the default constructor. All it does is set sensible defaults.
Definition: Chute.cc:42
void constructor()
This is the actually constructor, get called by all constructors above.
DPMBase()
Constructor that calls the "void constructor()".
Definition: DPMBase.cc:187
ChuteWithHopper::ChuteWithHopper ( const Mercury3D other)
explicit

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]otherobject of Mercury3D class

Definition at line 54 of file ChuteWithHopper.cc.

References constructor().

55  : DPMBase(other), Chute(other)
56 {
57  constructor();
58 }
Chute()
This is the default constructor. All it does is set sensible defaults.
Definition: Chute.cc:42
void constructor()
This is the actually constructor, get called by all constructors above.
DPMBase()
Constructor that calls the "void constructor()".
Definition: DPMBase.cc:187
ChuteWithHopper::ChuteWithHopper ( const MercuryBase other)
explicit

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]otherobject of MercuryBase class

Definition at line 67 of file ChuteWithHopper.cc.

References constructor().

68  : DPMBase(other), Chute(other)
69 {
70  constructor();
71 }
Chute()
This is the default constructor. All it does is set sensible defaults.
Definition: Chute.cc:42
void constructor()
This is the actually constructor, get called by all constructors above.
DPMBase()
Constructor that calls the "void constructor()".
Definition: DPMBase.cc:187
ChuteWithHopper::ChuteWithHopper ( const DPMBase other)
explicit

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]otherobject of DPMBase class

Definition at line 80 of file ChuteWithHopper.cc.

References constructor().

81  : DPMBase(other), Chute(other)
82 {
83  constructor();
84 }
Chute()
This is the default constructor. All it does is set sensible defaults.
Definition: Chute.cc:42
void constructor()
This is the actually constructor, get called by all constructors above.
DPMBase()
Constructor that calls the "void constructor()".
Definition: DPMBase.cc:187
ChuteWithHopper::ChuteWithHopper ( )

This is the default constructor.

Default constructor. Calls the constructor() method.

Definition at line 89 of file ChuteWithHopper.cc.

References constructor().

90 {
91  constructor();
92 }
void constructor()
This is the actually constructor, get called by all constructors above.

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:
Waarom had ik deze ook al weer gecomment? IFCD: this was probably BvdH
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 >::copyAndAddObject(), mathsFunc::cos(), Vec3D::cross(), Chute::getChuteAngle(), Vec3D::getLengthSquared(), BaseHandler< T >::getObject(), DPMBase::getYMax(), DPMBase::getYMin(), hopperDimension_, hopperExitHeight_, hopperExitLength_, hopperHeight_, hopperLength_, hopperLift_, hopperLowestPoint_, hopperShift_, isHopperCentred_, DPMBase::particleHandler, setHopperShift(), IntersectionOfWalls::setSpecies(), DPMBase::setZMax(), mathsFunc::sin(), DPMBase::speciesHandler, mathsFunc::tan(), DPMBase::wallHandler, Vec3D::X, and Vec3D::Z.

Referenced by setupInitialConditions().

162 {
163  //hopper walls
164  //to create the finite hopper walls, we take vector between two wall points in xz-plane, then rotate clockwise and make unit length
165  // A\ /A
166  // \ / A,B,C denote three points on the left and right hopper walls which are used to construct the hopper
167  // \ / shift denotes the space by which the chute has to be shifted to the right such that the hopper is in the domain
168  // B| |B
169  // | |
170  // C| |
171  // |C
172 
173  Vec3D A, B, C, temp, normal;
174 
175  const Mdouble s = mathsFunc::sin(getChuteAngle());
176  const Mdouble c = mathsFunc::cos(getChuteAngle());
177  // height of the lowest part of the hopper (right C in diagram above) as compared to
178  // the vertical position of the start of the chute (left C in diagram above).
180 
181  // "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.
182  // hopperHeight_ is now an input variable
183  // hopperHeight_ = hopperLowestPoint_ + 1.1 * 0.5*(hopperLength_+hopperExitLength_) / tan(hopperAngle_);
184 
185  const Mdouble HopperCornerHeight =
188  //if (HopperCornerHeight<=0.0) { hopperHeight_ += -HopperCornerHeight + P0.getRadius(); HopperCornerHeight = P0.getRadius(); }
189 
190  // first we create the LEFT hopper wall
191 
192  // coordinates of A,B,C in (vertical parallel to flow, vertical normal to flow, horizontal) direction
193  A = Vec3D(-0.5 * (hopperLength_ - hopperExitLength_), 0.0, hopperHeight_);
194  B = Vec3D(0.0, 0.0, HopperCornerHeight);
195  C = Vec3D(0.0, 0.0, 0.0);
196 
197  // now rotate the coordinates of A,B,C to be in (x,y,z) direction
198  A = Vec3D(c * A.X - s * A.Z, 0.0, s * A.X + c * A.Z);
199  B = Vec3D(c * B.X - s * B.Z, 0.0, s * B.X + c * B.Z);
200  C = Vec3D(c * C.X - s * C.Z, 0.0, s * C.X + c * C.Z);
201 
202  // the position of A determines hopper shift and zmax
208  if (isHopperCentred_)
209  {
210  setHopperShift(-A.X + 40);
211  }
212  else
213  {
214  setHopperShift(-A.X);
215  }
216 
217  setZMax(A.Z);
218  A.X += hopperShift_;
219  B.X += hopperShift_;
220  C.X += hopperShift_;
221 
222  //This lifts the hopper a distance above the chute
223  A.Z += hopperLift_;
224  B.Z += hopperLift_;
225  C.Z += hopperLift_;
226 
227  //create a finite wall from B to A and from C to B on the left hand side
228  IntersectionOfWalls w_Left;
230  temp = B - A;
231  normal = Vec3D(temp.Z, 0.0, -temp.X) / std::sqrt(temp.getLengthSquared());
232  w_Left.addObject(normal, A);
233  temp = C - B;
234  normal = Vec3D(temp.Z, 0.0, -temp.X) / std::sqrt(temp.getLengthSquared());
235  w_Left.addObject(normal, B);
236  temp = A - C;
237  normal = Vec3D(temp.Z, 0.0, -temp.X) / std::sqrt(temp.getLengthSquared());
238  w_Left.addObject(normal, C);
240 
241  //next, do the same for the right wall
244  HopperCornerHeight);
247 
248  //This rotates the right points
249  A = Vec3D(c * A.X - s * A.Z + hopperShift_, 0.0, s * A.X + c * A.Z);
250  B = Vec3D(c * B.X - s * B.Z + hopperShift_, 0.0, s * B.X + c * B.Z);
251  C = Vec3D(c * C.X - s * C.Z + hopperShift_, 0.0, s * C.X + c * C.Z);
252 
253  //This lifts the hopper a distance above the chute
254  A.Z += hopperLift_;
255  B.Z += hopperLift_;
256  C.Z += hopperLift_;
257 
258  //create a finite wall from B to A and from C to B on the right hand side
259  IntersectionOfWalls w_Right;
260  w_Right.setSpecies(speciesHandler.getObject(0));
261  temp = A - B;
262  normal = Vec3D(temp.Z, 0.0, -temp.X) / std::sqrt(temp.getLengthSquared());
263  w_Right.addObject(normal, A);
264  temp = B - C;
265  normal = Vec3D(temp.Z, 0.0, -temp.X) / std::sqrt(temp.getLengthSquared());
266  w_Right.addObject(normal, B);
267  temp = C - A;
268  normal = Vec3D(temp.Z, 0.0, -temp.X) / std::sqrt(temp.getLengthSquared());
269  w_Right.addObject(normal, C);
270  wallHandler.copyAndAddObject(w_Right);
271 
272  setZMax(A.Z);
273 
274  // if hopperDimension_ == 2, create inclined hopper walls (like in the X-direction) also in the Y-direction.
275  // (Else, place vertical (possibly periodic) walls in Y-direction. -> not mentioned here, where is this arranged? (BvdH))
276  if (hopperDimension_ == 2)
277  {
278  //coordinates of A,B,C in (vertical parallel to flow,vertical normal to flow, horizontal) direction
279  A = Vec3D(0.0, (getYMax() - getYMin() - hopperLength_) / 2.0, hopperHeight_);
280  B = Vec3D(0.0, (getYMax() - getYMin() - hopperExitLength_) / 2.0, HopperCornerHeight);
281  C = Vec3D(0.0, (getYMax() - getYMin() - hopperExitLength_) / 2.0, 0.0);
282 
283  //now rotate the coordinates of A,B,C to be in (x,y,z) direction
284  A = Vec3D(c * A.X - s * A.Z, A.Y, s * A.X + c * A.Z);
285  B = Vec3D(c * B.X - s * B.Z, B.Y, s * B.X + c * B.Z);
286  C = Vec3D(c * C.X - s * C.Z, C.Y, s * C.X + c * C.Z);
287  // the position of A determines shift and zmax
288  A.X += hopperShift_;
289  B.X += hopperShift_;
290  C.X += hopperShift_;
291 
292  //This lifts the hopper a distance above the chute
293  A.Z += hopperLift_;
294  B.Z += hopperLift_;
295  C.Z += hopperLift_;
296 
297  //create a finite wall from B to A and from C to B
298  IntersectionOfWalls w_Back;
299  temp = B - A;
300  normal = Vec3D::cross(Vec3D(-c, 0, -s), temp) / std::sqrt(temp.getLengthSquared());
301  //normal = Vec3D(0.0,temp.Z,-temp.Y) / std::sqrt(temp.GetLength2());
302  w_Back.addObject(normal, A);
303  temp = C - B;
304  //normal = Vec3D(0.0,temp.Z,-temp.Y) / std::sqrt(temp.GetLength2());
305  normal = Vec3D::cross(Vec3D(-c, 0, -s), temp) / std::sqrt(temp.getLengthSquared());
306  w_Back.addObject(normal, B);
307  temp = A - C;
308  //normal = Vec3D(0.0,temp.Z,-temp.Y)/std::sqrt(temp.GetLength2());
309  normal = Vec3D::cross(Vec3D(-c, 0, -s), temp) / std::sqrt(temp.getLengthSquared());
310  w_Back.addObject(normal, C);
312 
313  //Now for the right y-wall
314  A = Vec3D(0.0, (getYMax() - getYMin() + hopperLength_) / 2.0, hopperHeight_);
315  B = Vec3D(0.0, (getYMax() - getYMin() + hopperExitLength_) / 2.0, HopperCornerHeight);
316  C = Vec3D(0.0, (getYMax() - getYMin() + hopperExitLength_) / 2.0, 0.0);
317 
318  //now rotate the coordinates of A,B,C to be in (x,y,z) direction
319  A = Vec3D(c * A.X - s * A.Z, A.Y, s * A.X + c * A.Z);
320  B = Vec3D(c * B.X - s * B.Z, B.Y, s * B.X + c * B.Z);
321  C = Vec3D(c * C.X - s * C.Z, C.Y, s * C.X + c * C.Z);
322  // the position of A determines shift and zmax
323  A.X += hopperShift_;
324  B.X += hopperShift_;
325  C.X += hopperShift_;
326 
327  //This lifts the hopper a distance above the chute
328  A.Z += hopperLift_;
329  B.Z += hopperLift_;
330  C.Z += hopperLift_;
331 
332  //create a finite wall from B to A and from C to B
333  IntersectionOfWalls w_Front;
334  temp = A - B;
335  normal = Vec3D::cross(Vec3D(-c, 0, -s), temp) / std::sqrt(temp.getLengthSquared());
336  //normal = Vec3D(0.0,-temp.Z,temp.Y) / std::sqrt(temp.GetLength2());
337  w_Front.addObject(normal, A);
338  temp = B - C;
339  //normal = Vec3D(0.0,-temp.Z,temp.Y) / std::sqrt(temp.GetLength2());
340  normal = Vec3D::cross(Vec3D(-c, 0, -s), temp) / std::sqrt(temp.getLengthSquared());
341  w_Front.addObject(normal, B);
342  temp = C - A;
343  //normal = Vec3D(0.0,-temp.Z,temp.Y)/std::sqrt(temp.GetLength2());
344  normal = Vec3D::cross(Vec3D(-c, 0, -s), temp) / std::sqrt(temp.getLengthSquared());
345  w_Front.addObject(normal, C);
346  wallHandler.copyAndAddObject(w_Front);
347  }
348 
349  //now shift the chute as well, i.e. apply the shift to all the fixed particles
350  // at the bottom of the chute
351  for (BaseParticle* particle : particleHandler)
352  {
353  particle->move(Vec3D(hopperShift_, 0.0, 0.0));
354  }
355 }
Mdouble X
the vector components
Definition: Vector.h:65
A IntersectionOfWalls is convex polygon defined as an intersection of InfiniteWall's.
Mdouble hopperExitHeight_
Dimension of the hopper exit in vertical direction.
double Mdouble
Definition: GeneralDefine.h:34
Mdouble getYMin() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMin() returns YMin...
Definition: DPMBase.h:599
Mdouble hopperLowestPoint_
The NEGATIVE z coordinate of the right C point (when the left C point is in the origin) ...
void setZMax(Mdouble newZMax)
Sets the value of ZMax, the upper bound of the problem domain in the z-direction. ...
Definition: DPMBase.cc:1178
void addObject(Vec3D normal, Vec3D point)
Adds a wall to the set of infinite walls, given a normal vector pointing into the wall (i...
void setHopperShift(Mdouble hopperShift)
Sets the shift in X-direction of the whole setup after rotation.
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.
void setSpecies(const ParticleSpecies *species)
sets species of subwalls as well
Mdouble cos(Mdouble x)
Definition: ExtendedMath.cc:64
Mdouble hopperShift_
The x position where the Chute starts (defined as the beginning of the hopper)
Mdouble sin(Mdouble x)
Definition: ExtendedMath.cc:44
unsigned int hopperDimension_
This is the dimension of the hopper, my default it is one dimensional and hence does not have side wa...
Mdouble hopperLength_
Dimension of the hopper in vertical direction.
T tan(T x)
Definition: ExtendedMath.h:176
ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created...
Definition: DPMBase.h:1329
T * getObject(const unsigned int id)
Gets a pointer to the Object at the specified index in the BaseHandler.
Definition: BaseHandler.h:613
std::enable_if<!std::is_pointer< U >::value, U * >::type copyAndAddObject(const U &object)
Creates a copy of a Object and adds it to the BaseHandler.
Definition: BaseHandler.h:379
static Vec3D cross(const Vec3D &a, const Vec3D &b)
Calculates the cross product of two Vec3D: .
Definition: Vector.cc:163
SpeciesHandler speciesHandler
A handler to that stores the species type i.e. LinearViscoelasticSpecies, etc.
Definition: DPMBase.h:1319
Mdouble getYMax() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMax() returns XMax...
Definition: DPMBase.h:605
Mdouble getChuteAngle() const
Returns the chute angle (in radians)
Definition: Chute.cc:742
WallHandler wallHandler
An object of the class WallHandler. Contains pointers to all the walls created.
Definition: DPMBase.h:1339
static Mdouble getLengthSquared(const Vec3D &a)
Calculates the squared length of a Vec3D: .
Definition: Vector.h:316
Mdouble hopperHeight_
Dimension of the hopper in horizontal direction.
Definition: Vector.h:49
Mdouble hopperLift_
This is the vertical distance the chute is lifted above the plane.
Mdouble Z
Definition: Vector.h:65
Mdouble hopperExitLength_
Dimension of the hopper exit in vertical direction.
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().

98 {
100  hopperLift_ = 0.0;
101  setHopper(0.01, 0.01, 60.0, 0.08, 0.04);
102  hopperShift_ = 0.0;
103  hopperDimension_ = 1;
105 
107  isHopperCentred_ = false;
108 
109 }
Mdouble hopperLowerFillingHeight_
Relative height (in [0,1)) above which the hopper is replenished with new particles.
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.
Mdouble hopperShift_
The x position where the Chute starts (defined as the beginning of the hopper)
unsigned int hopperDimension_
This is the dimension of the hopper, my default it is one dimensional and hence does not have side wa...
bool isHopperAlignedWithBottom_
This is the flag, which sets if the chute bottom is aligned with the hopper, by default it is...
Mdouble hopperFillingPercentage_
This is which percentage of the hopper is used for creating new partices;.
void setHopper(Mdouble exitLength, Mdouble exitHeight, Mdouble angle, Mdouble length, Mdouble height)
Sets the hopper's geometrical properties.
Mdouble hopperLift_
This is the vertical distance the chute is lifted above the plane.
Mdouble ChuteWithHopper::getChuteLength ( ) const

Allows chute length to be accessed.

Todo:
this hides the non-virtual function Chute::getChuteLength

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 526 of file ChuteWithHopper.cc.

References DPMBase::getXMax(), and hopperShift_.

527 {
528  return getXMax() - hopperShift_;
529 }
Mdouble getXMax() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMax() returns XMax...
Definition: DPMBase.h:593
Mdouble hopperShift_
The x position where the Chute starts (defined as the beginning of the hopper)
Mdouble ChuteWithHopper::getHopperAngle ( ) const

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

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

Definition at line 620 of file ChuteWithHopper.cc.

References hopperAngle_.

621 {
622  return hopperAngle_;
623 }
Mdouble hopperAngle_
Angle between the two pieces of the hopper walls.
unsigned int ChuteWithHopper::getHopperDimension ( ) const

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 683 of file ChuteWithHopper.cc.

References hopperDimension_.

684 {
685  return hopperDimension_;
686 }
unsigned int hopperDimension_
This is the dimension of the hopper, my default it is one dimensional and hence does not have side wa...
Mdouble ChuteWithHopper::getHopperExitHeight ( ) const

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 653 of file ChuteWithHopper.cc.

References hopperExitHeight_.

654 {
655  return hopperExitHeight_;
656 }
Mdouble hopperExitHeight_
Dimension of the hopper exit in vertical direction.
Mdouble ChuteWithHopper::getHopperExitLength ( ) const

Returns the width of the hopper exit.

Returns the width of the (rectangular) hopper exit

Definition at line 636 of file ChuteWithHopper.cc.

References hopperExitLength_.

637 {
638  return hopperExitLength_;
639 }
Mdouble hopperExitLength_
Dimension of the hopper exit in vertical direction.
Mdouble ChuteWithHopper::getHopperFillingPercentage ( ) const

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 674 of file ChuteWithHopper.cc.

References hopperFillingPercentage_.

675 {
677 }
Mdouble hopperFillingPercentage_
This is which percentage of the hopper is used for creating new partices;.
Mdouble ChuteWithHopper::getHopperHeight ( ) const

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 644 of file ChuteWithHopper.cc.

References hopperHeight_.

645 {
646  return hopperHeight_;
647 }
Mdouble hopperHeight_
Dimension of the hopper in horizontal direction.
Mdouble ChuteWithHopper::getHopperLength ( ) const

Returns the width of the hopper entrance.

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

Definition at line 628 of file ChuteWithHopper.cc.

References hopperLength_.

629 {
630  return hopperLength_;
631 }
Mdouble hopperLength_
Dimension of the hopper in vertical direction.
Mdouble ChuteWithHopper::getHopperLift ( ) const

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 701 of file ChuteWithHopper.cc.

References hopperLift_.

702 {
703  return hopperLift_;
704 }
Mdouble hopperLift_
This is the vertical distance the chute is lifted above the plane.
Mdouble ChuteWithHopper::getHopperLowestPoint ( ) const

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

Definition at line 367 of file ChuteWithHopper.cc.

References hopperLowestPoint_.

Referenced by setHopper().

368 {
369  return hopperLowestPoint_;
370 }
Mdouble hopperLowestPoint_
The NEGATIVE z coordinate of the right C point (when the left C point is in the origin) ...
Mdouble ChuteWithHopper::getHopperShift ( ) const

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 710 of file ChuteWithHopper.cc.

References hopperShift_.

711 {
712  return hopperShift_;
713 }
Mdouble hopperShift_
The x position where the Chute starts (defined as the beginning of the hopper)
bool ChuteWithHopper::getIsHopperCentred ( ) const

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 663 of file ChuteWithHopper.cc.

References isHopperCentred_.

664 {
665  return isHopperCentred_;
666 }
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.
Mdouble ChuteWithHopper::getMaximumVelocityInducedByGravity ( ) const

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 494 of file ChuteWithHopper.cc.

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

Referenced by getTimeStepRatio().

495 {
497 
498  return std::sqrt(2.0 * getGravity().getLength() * height);
499 }
double Mdouble
Definition: GeneralDefine.h:34
Mdouble getXMax() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMax() returns XMax...
Definition: DPMBase.h:593
Mdouble hopperShift_
The x position where the Chute starts (defined as the beginning of the hopper)
Mdouble sin(Mdouble x)
Definition: ExtendedMath.cc:44
Vec3D getGravity() const
Returns the gravitational acceleration.
Definition: DPMBase.cc:1351
Mdouble getChuteAngle() const
Returns the chute angle (in radians)
Definition: Chute.cc:742
Mdouble hopperHeight_
Dimension of the hopper in horizontal direction.
Mdouble ChuteWithHopper::getTimeStepRatio ( ) const

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 508 of file ChuteWithHopper.cc.

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

Referenced by setupInitialConditions().

509 {
511  const Mdouble rmin = getMinInflowParticleRadius();
512 
513  if (rmin / dx < 10.)
514  logger(WARN,
515  "[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!",
516  rmin / dx);
517 
518  return rmin / dx;
519 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
double Mdouble
Definition: GeneralDefine.h:34
Mdouble getMinInflowParticleRadius() const
returns the minimum radius of inflow particles
Definition: Chute.cc:873
Mdouble getTimeStep() const
Returns the simulation time step.
Definition: DPMBase.cc:1211
Mdouble getMaximumVelocityInducedByGravity() const
Returns the theoretical maximum particle velocity due to gravity.
void ChuteWithHopper::read ( std::istream &  is,
ReadOptions  opt = ReadOptions::ReadAll 
)
overridevirtual

Reads setup properties from an istream.

Reads the setup properties from an istream

Parameters
[in,out]isthe istream

Reimplemented from Chute.

Definition at line 593 of file ChuteWithHopper.cc.

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

594 {
595  Chute::read(is,opt);
598 }
Mdouble hopperExitHeight_
Dimension of the hopper exit in vertical direction.
Mdouble hopperShift_
The x position where the Chute starts (defined as the beginning of the hopper)
Mdouble hopperLength_
Dimension of the hopper in vertical direction.
void read(std::istream &is, ReadOptions opt=ReadOptions::ReadAll) override
Reads all chute properties from an istream.
Definition: Chute.cc:139
Mdouble hopperHeight_
Dimension of the hopper in horizontal direction.
Mdouble hopperAngle_
Angle between the two pieces of the hopper walls.
Mdouble hopperExitLength_
Dimension of the hopper exit in vertical direction.
bool ChuteWithHopper::readNextArgument ( int &  i,
int  argc,
char *  argv[] 
)
overridevirtual

Reads setup properties from a string.

this reads parameters from a string.

Parameters
[in]ithe index of the input parameter to be read
[in]argcnumber of input parameters
[in]argv[]pointer to the (first character of the) actual string

Reimplemented from Chute.

Definition at line 738 of file ChuteWithHopper.cc.

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

739 {
740  if (!strcmp(argv[i], "-hopperLength"))
741  {
742  hopperLength_ = (atof(argv[i + 1]));
743  }
744  else if (!strcmp(argv[i], "-hopperHeight"))
745  {
746  hopperHeight_ = (atof(argv[i + 1]));
747  }
748  else if (!strcmp(argv[i], "-hopperAngle"))
749  {
750  hopperAngle_ = (atof(argv[i + 1]));
751  }
752  else if (!strcmp(argv[i], "-hopperExitLength"))
753  {
754  hopperExitLength_ = (atof(argv[i + 1]));
755  }
756  else if (!strcmp(argv[i], "-hopperExitHeight"))
757  {
758  hopperExitHeight_ = (atof(argv[i + 1]));
759  }
760  else if (!strcmp(argv[i], "-hopperLowerFillingHeight_"))
761  {
762  hopperLowerFillingHeight_ = (atof(argv[i + 1]));
763  }
764  else if (!strcmp(argv[i], "-isHopperCentred"))
765  {
766  isHopperCentred_ = static_cast<bool>(atoi(argv[i + 1]));
767  }
768  else if (!strcmp(argv[i], "-alignBase"))
769  {
770  isHopperAlignedWithBottom_ = static_cast<bool>(atoi(argv[i + 1]));
771  }
772  else if (!strcmp(argv[i], "-shift"))
773  {
774  hopperShift_ = (atof(argv[i + 1]));
775  }
776  else if (!strcmp(argv[i], "-lift"))
777  {
778  hopperLift_ = (atof(argv[i + 1]));
779  }
780  else
781  return Chute::readNextArgument(i, argc, argv); //if argv[i] is not found, check the commands in Chute
782  return true; //returns true if argv[i] is found
783 }
Mdouble hopperExitHeight_
Dimension of the hopper exit in vertical direction.
const std::complex< Mdouble > i
Definition: ExtendedMath.h:50
bool readNextArgument(int &i, int argc, char *argv[]) override
This method can be used for reading object properties from a string.
Definition: Chute.cc:518
Mdouble hopperLowerFillingHeight_
Relative height (in [0,1)) above which the hopper is replenished with new particles.
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.
Mdouble hopperShift_
The x position where the Chute starts (defined as the beginning of the hopper)
Mdouble hopperLength_
Dimension of the hopper in vertical direction.
bool isHopperAlignedWithBottom_
This is the flag, which sets if the chute bottom is aligned with the hopper, by default it is...
Mdouble hopperHeight_
Dimension of the hopper in horizontal direction.
Mdouble hopperAngle_
Angle between the two pieces of the hopper walls.
Mdouble hopperLift_
This is the vertical distance the chute is lifted above the plane.
Mdouble hopperExitLength_
Dimension of the hopper exit in vertical direction.
void ChuteWithHopper::setChuteLength ( Mdouble  chuteLength)
overridevirtual

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]chuteLengthThe chute length according to which xMax is to be adapted

Reimplemented from Chute.

Definition at line 536 of file ChuteWithHopper.cc.

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

537 {
538  if (chuteLength >= 0.0)
539  {
540  setXMax(chuteLength + hopperShift_);
541  setXMin(0.0);
542  }
543  else
544  {
545  logger(WARN,
546  "[ChuteWithHopper::setChuteLength()] Chute length unchanged, value must be greater than or equal to zero");
547  }
548 }
void setXMax(Mdouble newXMax)
Sets the value of XMax, the upper bound of the problem domain in the x-direction. ...
Definition: DPMBase.cc:1126
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Mdouble hopperShift_
The x position where the Chute starts (defined as the beginning of the hopper)
void setXMin(Mdouble newXMin)
Sets the value of XMin, the lower bound of the problem domain in the x-direction. ...
Definition: DPMBase.cc:971
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]ExitLengthHorizontal width of the (rectangular) hopper exit
[in]ExitHeightThe vertical position of the lowest point of the right side of the hopper relative to the chute bottom
[in]AngleThe angle of the hopper inlet, relative to the vertical (in DEGREES)
[in]LengthHorizontal width of the hopper entrance (i.e., at the top of the hopper)
[in]HeightThe (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 384 of file ChuteWithHopper.cc.

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

Referenced by constructor().

385 {
386  // hopperCornerHeight: helper variable, just here to check some things
387  const Mdouble hopperCornerHeight =
388  height - 0.5 * (length - exitLength) / mathsFunc::tan(angle * constants::pi / 180.0);
389 
390  if (exitLength >= 0.0)
391  {
392  hopperExitLength_ = exitLength;
393  }
394  else
395  {
396  logger(ERROR, "[ChuteWithHopper::setHopper()] Hopper exit length must be greater than or equal to zero");
397  exit(-1);
398  }
399 
400  // hopperExitHeight_
401  if (exitHeight < 0.0)
402  {
403  logger(ERROR, "[ChuteWithHopper::setHopper()] Hopper exit height must be greater than or equal to zero");
404  exit(-1);
405  }
406  else if (exitHeight > hopperCornerHeight + mathsFunc::tan(getChuteAngle()) * exitLength)
407  {
408  logger(ERROR,
409  "[ChuteWithHopper::setHopper()] Hopper exit height (%) may not exceed height of hopper corner above chute bottom (%)",
410  exitHeight, hopperCornerHeight + mathsFunc::tan(getChuteAngle()) * exitLength);
411  exit(-1);
412  }
413  else //(exitHeight >= 0.0) /// \todo write check: exitHeight may NOT exceed vertical distance between chute base and hopper corner!
414  {
415  hopperExitHeight_ = exitHeight;
416  }
417 
419 
420  if (angle > 0.0 && angle < 90.0)
421  {
422  hopperAngle_ = angle * constants::pi / 180.0;
423  }
424  else
425  {
426  logger(ERROR, "[ChuteWithHopper::setHopper()] Hopper angle must in (0,90)");
427  exit(-1);
428  }
429 
430  if (length > exitLength)
431  {
432  hopperLength_ = length;
433  }
434  else
435  {
436  logger(ERROR, "[ChuteWithHopper::setHopper()] Hopper length must be greater than exit length");
437  exit(-1);
438  }
439 
440  // check hopper 'corner height', i.e. the vertical position of point 'B' as compared to the start of the hopper
441  // Mdouble hopperCornerHeight = height - 0.5 * (length - exitLength) / std::tan(hopperAngle_ * constants::pi / 180.0);
442  if (hopperCornerHeight <= 0.0)
443  {
444  // hopperHeight_ += -hopperCornerHeight + problem.getMaxInflowParticleRadius();
445  // hopperCornerHeight = problem.getMaxInflowParticleRadius();
446  logger(ERROR,
447  "[ChuteWithHopper::setHopper()] height of hopper corner (%) may not be below 0. Increase hopper height to fix.",
448  hopperCornerHeight);
449  exit(-1);
450  }
451  const Mdouble heightCompare = (getHopperLowestPoint() +
453 
454  logger(VERBOSE, " ");
455  logger(VERBOSE, "[ChuteWithHopper::setHopper()] Setting the following hopper geometrical properties:");
456  logger(VERBOSE, " hopperLowestPoint_: %, ", getHopperLowestPoint());
457  logger(VERBOSE, " hopperLength_: %, ", hopperLength_);
458  logger(VERBOSE, " hopperExitLength_: %, ", hopperExitLength_);
459  logger(VERBOSE, " hopperAngle_: %, ", hopperAngle_);
460  logger(VERBOSE, " height: %, ", height);
461  logger(VERBOSE, " comparing height: % ", heightCompare);
462  logger(VERBOSE, " ");
463 
464  //This a semi-ugly fix to check whether height>=Heightcompare and does not take into account rounding errors
465  if ((height - heightCompare) > -1e-6 * heightCompare)
466  {
467  hopperHeight_ = height;
468  }
469  else
470  {
471  logger(ERROR,
472  "[ChuteWithHopper::setHopper()] For these settings, hopper height must be greater then or equal to %, see drawing",
473  heightCompare);
474  exit(-1);
476  }
477 
478  logger(VERBOSE, " ");
479  logger(VERBOSE, "[ChuteWithHopper::setHopper()] Hopper geometry: ");
480  logger(VERBOSE, "hopperHeight_: \t %", hopperHeight_);
481  logger(VERBOSE, "hopperExitLength_: \t %", hopperExitLength_);
482  logger(VERBOSE, "hopperExitHeight_: \t %", hopperExitHeight_);
483  logger(VERBOSE, "hopperAngle_: \t %", hopperAngle_);
484  logger(VERBOSE, "hopperLength_: \t %", hopperLength_);
485  logger(VERBOSE, " ");
486 
487 }
Mdouble hopperExitHeight_
Dimension of the hopper exit in vertical direction.
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
double Mdouble
Definition: GeneralDefine.h:34
void setHopperLowestPoint(Mdouble hopperLowestPoint)
Sets the vertical distance of the lowest hopper point relative to the start of the chute...
Mdouble getHopperLowestPoint() const
Returns the vertical distance of the lowest hopper point relative to the start of the chute...
const Mdouble pi
Definition: ExtendedMath.h:45
Mdouble hopperLength_
Dimension of the hopper in vertical direction.
T tan(T x)
Definition: ExtendedMath.h:176
Mdouble getChuteAngle() const
Returns the chute angle (in radians)
Definition: Chute.cc:742
Mdouble hopperHeight_
Dimension of the hopper in horizontal direction.
Mdouble hopperAngle_
Angle between the two pieces of the hopper walls.
Mdouble hopperExitLength_
Dimension of the hopper exit in vertical direction.
void ChuteWithHopper::setHopperDimension ( unsigned int  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 719 of file ChuteWithHopper.cc.

References hopperDimension_.

720 {
721  hopperDimension_ = hopperDimension;
722 }
unsigned int hopperDimension_
This is the dimension of the hopper, my default it is one dimensional and hence does not have side wa...
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]hopperFillingPercentagePercentage 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_.

119 {
120  hopperFillingPercentage_ = hopperFillingPercentage;
121 }
Mdouble hopperFillingPercentage_
This is which percentage of the hopper is used for creating new partices;.
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 692 of file ChuteWithHopper.cc.

References hopperLift_.

693 {
694  hopperLift_ = hopperLift;
695 }
Mdouble hopperLift_
This is the vertical distance the chute is lifted above the plane.
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 564 of file ChuteWithHopper.cc.

References hopperLowerFillingHeight_.

565 {
566  hopperLowerFillingHeight_ = hopperLowerFillingHeight;
567 }
Mdouble hopperLowerFillingHeight_
Relative height (in [0,1)) above which the hopper is replenished with new particles.
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]hopperLowestPointthe lowest point of the right side of the hopper

Definition at line 362 of file ChuteWithHopper.cc.

References hopperLowestPoint_.

Referenced by setHopper().

363 {
364  hopperLowestPoint_ = hopperLowestPoint;
365 }
Mdouble hopperLowestPoint_
The NEGATIVE z coordinate of the right C point (when the left C point is in the origin) ...
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]hopperShiftThe hopper shift to be set

Definition at line 574 of file ChuteWithHopper.cc.

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

Referenced by addHopper().

575 {
576  if (hopperShift >= 0.0)
577  {
578  //keeps the ChuteLength constant
579  setXMax(getXMax() + hopperShift - hopperShift_);
580  hopperShift_ = hopperShift;
581  }
582  else
583  {
584  logger(WARN,
585  "[ChuteWithHopper::setHopperShift()] Shift length unchanged, value must be greater than or equal to zero");
586  }
587 }
void setXMax(Mdouble newXMax)
Sets the value of XMax, the upper bound of the problem domain in the x-direction. ...
Definition: DPMBase.cc:1126
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Mdouble getXMax() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMax() returns XMax...
Definition: DPMBase.h:593
Mdouble hopperShift_
The x position where the Chute starts (defined as the beginning of the hopper)
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 727 of file ChuteWithHopper.cc.

References isHopperAlignedWithBottom_.

728 {
729  isHopperAlignedWithBottom_ = isHopperAlignedWithBottom;
730 }
bool isHopperAlignedWithBottom_
This is the flag, which sets if the chute bottom is aligned with the hopper, by default it is...
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]isHopperCentredif TRUE, the whole setup is shifted 40 units of length towards the positive X-direction.

Definition at line 556 of file ChuteWithHopper.cc.

References isHopperCentred_.

557 {
558  isHopperCentred_ = isHopperCentred;
559 }
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.
void ChuteWithHopper::setupInitialConditions ( )
overridevirtual

Sets up the initial conditions for the problem.

Sets up the problem initial conditions:

  1. Creates chute side walls
  2. Creates a hopper insertion boundary
  3. Creates a chute bottom
  4. 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(), 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.

131 {
132 
133  // check time step ratio
135 
136  // create chute side walls (either periodic or solid, based on (the inherited)
137  // boolean Chute::isChutePeriodic_ data member).
138  setupSideWalls();
139 
140  // create insertion boundary for the hopper and set a fill percentage
148  setInsertionBoundary(b1Added);
149 
150  // create the chute bottom
151  createBottom();
152 
153  // create the hopper
154  addHopper();
155 }
void addHopper()
This creates the hopper on top of the chute, see diagram in class description for details of the poin...
A basic particle.
Mdouble getYMin() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMin() returns YMin...
Definition: DPMBase.h:599
void setSpecies(const ParticleSpecies *species)
Boundary structure for boundaries used for insertion of particles.
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.
Mdouble getMaxInflowParticleRadius() const
Returns the maximum radius of inflow particles.
Definition: Chute.cc:882
Mdouble getTimeStepRatio() const
Returns smallest particle radius over maximum gravitational velocity.
BoundaryHandler boundaryHandler
An object of the class BoundaryHandler which concerns insertion and deletion of particles into or fro...
Definition: DPMBase.h:1344
unsigned int hopperDimension_
This is the dimension of the hopper, my default it is one dimensional and hence does not have side wa...
Mdouble hopperLength_
Dimension of the hopper in vertical direction.
Mdouble getFixedParticleRadius() const
Returns the particle radius of the fixed particles which constitute the (rough) chute bottom...
Definition: Chute.cc:634
void setupSideWalls()
Creates chute side walls (either solid or periodic)
Definition: Chute.cc:296
T * getObject(const unsigned int id)
Gets a pointer to the Object at the specified index in the BaseHandler.
Definition: BaseHandler.h:613
std::enable_if<!std::is_pointer< U >::value, U * >::type copyAndAddObject(const U &object)
Creates a copy of a Object and adds it to the BaseHandler.
Definition: BaseHandler.h:379
void set(BaseParticle *particleToCopy, unsigned int maxFailed, double yMin, double yMax, double radMin, double radMax, 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.
void setInsertionBoundary(InsertionBoundary *insertionBoundary)
Sets the chute insertion boundary.
Definition: Chute.cc:1013
SpeciesHandler speciesHandler
A handler to that stores the species type i.e. LinearViscoelasticSpecies, etc.
Definition: DPMBase.h:1319
Mdouble getYMax() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMax() returns XMax...
Definition: DPMBase.h:605
Mdouble getChuteAngle() const
Returns the chute angle (in radians)
Definition: Chute.cc:742
virtual void createBottom()
Creates the chute bottom, which can be either flat or one of three flavours of rough.
Definition: Chute.cc:331
Mdouble getMinInflowParticleRadius() const
returns the minimum radius of inflow particles
Definition: Chute.cc:873
Inherits from InsertionBoundary Some images are useful to better understand the structure of both the...
Mdouble hopperHeight_
Dimension of the hopper in horizontal direction.
Mdouble hopperAngle_
Angle between the two pieces of the hopper walls.
Mdouble hopperFillingPercentage_
This is which percentage of the hopper is used for creating new partices;.
Mdouble hopperLift_
This is the vertical distance the chute is lifted above the plane.
Mdouble hopperExitLength_
Dimension of the hopper exit in vertical direction.
unsigned int getMaxFailed() const
Returns the number of times a particle will be tried to be added to the insertion boundary...
Definition: Chute.cc:772
void ChuteWithHopper::write ( std::ostream &  os,
bool  writeAllParticles = true 
) const
overridevirtual

Writes setup properties to an ostream.

Writes object's properties to an ostream

Parameters
[in]osthe ostream
[in]writeAllParticlesIf 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 610 of file ChuteWithHopper.cc.

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

611 {
612  Chute::write(os, writeAllParticles);
613  os << hopperExitLength_ << " " << hopperExitHeight_ << " " << hopperLength_
614  << " " << hopperAngle_ << " " << hopperHeight_ << " " << hopperShift_ << " " << '\n';
615 }
Mdouble hopperExitHeight_
Dimension of the hopper exit in vertical direction.
Mdouble hopperShift_
The x position where the Chute starts (defined as the beginning of the hopper)
Mdouble hopperLength_
Dimension of the hopper in vertical direction.
void write(std::ostream &os, bool writeAllParticles=true) const override
This function writes the Chute properties to an ostream, and adds the properties of ALL chute particl...
Definition: Chute.cc:206
Mdouble hopperHeight_
Dimension of the hopper in horizontal direction.
Mdouble hopperAngle_
Angle between the two pieces of the hopper walls.
Mdouble hopperExitLength_
Dimension of the hopper exit in vertical direction.

Member Data Documentation

Mdouble ChuteWithHopper::hopperAngle_
private

Angle between the two pieces of the hopper walls.

Definition at line 243 of file ChuteWithHopper.h.

Referenced by getHopperAngle(), read(), readNextArgument(), setHopper(), setupInitialConditions(), and write().

unsigned int ChuteWithHopper::hopperDimension_
private

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

Definition at line 272 of file ChuteWithHopper.h.

Referenced by addHopper(), constructor(), getHopperDimension(), setHopperDimension(), and setupInitialConditions().

Mdouble ChuteWithHopper::hopperExitHeight_
private

Dimension of the hopper exit in vertical direction.

Definition at line 251 of file ChuteWithHopper.h.

Referenced by addHopper(), getHopperExitHeight(), read(), readNextArgument(), setHopper(), and write().

Mdouble ChuteWithHopper::hopperExitLength_
private

Dimension of the hopper exit in vertical direction.

Definition at line 247 of file ChuteWithHopper.h.

Referenced by addHopper(), getHopperExitLength(), read(), readNextArgument(), setHopper(), setupInitialConditions(), and write().

Mdouble ChuteWithHopper::hopperFillingPercentage_
private

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

Definition at line 280 of file ChuteWithHopper.h.

Referenced by constructor(), getHopperFillingPercentage(), setHopperFillingPercentage(), and setupInitialConditions().

Mdouble ChuteWithHopper::hopperHeight_
private

Dimension of the hopper in horizontal direction.

Definition at line 239 of file ChuteWithHopper.h.

Referenced by addHopper(), getHopperHeight(), getMaximumVelocityInducedByGravity(), read(), readNextArgument(), setHopper(), setupInitialConditions(), and write().

Mdouble ChuteWithHopper::hopperLength_
private

Dimension of the hopper in vertical direction.

Definition at line 235 of file ChuteWithHopper.h.

Referenced by addHopper(), getHopperLength(), read(), readNextArgument(), setHopper(), setupInitialConditions(), and write().

Mdouble ChuteWithHopper::hopperLift_
private

This is the vertical distance the chute is lifted above the plane.

Definition at line 268 of file ChuteWithHopper.h.

Referenced by addHopper(), constructor(), getHopperLift(), readNextArgument(), setHopperLift(), and setupInitialConditions().

Mdouble ChuteWithHopper::hopperLowerFillingHeight_
private

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

Definition at line 259 of file ChuteWithHopper.h.

Referenced by constructor(), readNextArgument(), and setHopperLowerFillingHeight().

Mdouble ChuteWithHopper::hopperLowestPoint_
private

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

Definition at line 284 of file ChuteWithHopper.h.

Referenced by addHopper(), getHopperLowestPoint(), and setHopperLowestPoint().

Mdouble ChuteWithHopper::hopperShift_
private

The x position where the Chute starts (defined as the beginning of the hopper)

Definition at line 255 of file ChuteWithHopper.h.

Referenced by addHopper(), constructor(), getChuteLength(), getHopperShift(), getMaximumVelocityInducedByGravity(), read(), readNextArgument(), setChuteLength(), setHopperShift(), and write().

bool ChuteWithHopper::isHopperAlignedWithBottom_
private

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

Definition at line 276 of file ChuteWithHopper.h.

Referenced by constructor(), readNextArgument(), and setIsHopperAlignedWithBottom().

bool ChuteWithHopper::isHopperCentred_
private

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.

Definition at line 263 of file ChuteWithHopper.h.

Referenced by addHopper(), constructor(), getIsHopperCentred(), readNextArgument(), setIsHopperCentred(), and setupInitialConditions().


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