revision: v0.14
Chute Class Reference

Creates chutes with different bottoms. Inherits from Mercury3D (-> MercuryBase -> DPMBase). More...

#include <Chute.h>

+ Inheritance diagram for Chute:

Public Member Functions

 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...
 
bool readNextArgument (int &i, int argc, char *argv[]) override
 This method can be used for reading object properties from a string. 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 setupInitialConditions () override
 Creates bottom, side walls and a particle insertion boundary. More...
 
void read (std::istream &is, ReadOptions opt=ReadOptions::ReadAll) override
 Reads all chute properties from an istream. More...
 
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 particles as well. 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...
 
virtual void setChuteLength (Mdouble chuteLength)
 Sets the chute length (X-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 all data into 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< intget1DParametersFromRunNumber (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< intget2DParametersFromRunNumber (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< intget3DParametersFromRunNumber (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)
 
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 setNToWrite (int nToWrite)
 set the number of elements to write to the screen More...
 
int getNToWrite () const
 get the number of elements to write to the 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...
 
double getCPUTime ()
 
double getWallTime ()
 
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...
 
virtual void handleParticleRemoval (unsigned int id)
 Handles the removal of particles from the particleHandler. More...
 
virtual void handleParticleAddition (unsigned int id, BaseParticle *p)
 
void writePythonFileForVTKVisualisation () const
 

Protected Member Functions

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 computeAdditionalForces ()
 A virtual function which allows to define operations to be executed prior to the OMP force collect. 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...
 
void setSoftStop ()
 function for setting sigaction constructor. More...
 

Private Attributes

Mdouble chuteAngle_
 chute angle in degrees More...
 
Mdouble fixedParticleRadius_
 radius of the fixed particles at the bottom More...
 
Mdouble minInflowParticleRadius_
 minimal radius of inflowing particles More...
 
Mdouble maxInflowParticleRadius_
 maximal radius of inflowing particles More...
 
Mdouble inflowVelocity_
 Average inflow velocity in x-direction. More...
 
Mdouble inflowVelocityVariance_
 Inflow velocity variance in x-direction (in ratio of inflowVelocity_) More...
 
Mdouble inflowHeight_
 Height of inflow. More...
 
RoughBottomType roughBottomType_
 Determines the type of rough bottom created (if any). See also the enum RoughBottomType at the beginning of this header file. More...
 
unsigned int maxFailed_
 indicates how many attempts are made to insert a new particle into the insertion boundary before the boundary is considered filled. More...
 
InsertionBoundaryinsertionBoundary_
 (Pointer to) the Chute's insertion boundary More...
 
bool isChutePeriodic_
 Determines whether the chute has periodic (TRUE) or solid (FALSE) walls in the Y-direction. 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...
 
Time clock_
 record when the simulation started More...
 
- Static Protected Member Functions inherited from DPMBase
static void signalHandler (int signal)
 signal handler function. More...
 

Detailed Description

Creates chutes with different bottoms. Inherits from Mercury3D (-> MercuryBase -> DPMBase).

Chute adds three new effects as compared to a 'normal' Mercury3D object: the gravity direction can be set using the ChuteAngle variable, a (smooth or rough) bottom wall is created by default, and some basic inflow and outflow routines are added.

Constructor & Destructor Documentation

◆ Chute() [1/5]

Chute::Chute ( )

This is the default constructor. All it does is set sensible defaults.

Default constructor.

43 {
44  constructor();
45  logger(DEBUG, "[Chute::Chute()] constructor finished");
46 }

References constructor(), FATAL, and logger.

◆ Chute() [2/5]

Chute::Chute ( const DPMBase other)
explicit

Copy constructor, converts an existing DPMBase problem into a Chute problem.

Copy constructor with a DPMBase object as an argument. This constructor basically 'upgrades' a DPMBase object to one of the Chute 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
56  : DPMBase(other), Mercury3D(other)
57 {
58  constructor();
59  logger(DEBUG, "[Chute::Chute(const DPMBase& other)] copy constructor finished");
60 }

References constructor(), FATAL, and logger.

◆ Chute() [3/5]

Chute::Chute ( const MercuryBase other)
explicit

Copy constructor, converts an existing MercuryBase problem into a Chute problem.

Copy constructor with a MercuryBase object as an argument. This constructor basically 'upgrades' a MercuryBase object to one of the Chute 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
70  : DPMBase(other), Mercury3D(other)
71 {
72  constructor();
73  logger(DEBUG, "[Chute::Chute(const MercuryBase& other)] copy constructor finished");
74 }

References constructor(), FATAL, and logger.

◆ Chute() [4/5]

Chute::Chute ( const Mercury3D other)
explicit

Copy constructor, converts an existing Mercury3D problem into a Chute problem.

Copy constructor with a Mercury3D object as an argument. This constructor basically 'upgrades' a Mercury3D object to one of the Chute 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
84  : DPMBase(other), Mercury3D(other)
85 {
86  constructor();
87  logger(DEBUG, "[Chute::Chute(const Mercury3D& other) copy constructor finished");
88 }

References constructor(), FATAL, and logger.

◆ Chute() [5/5]

Chute::Chute ( const Chute other)

Default copy constructor.

'normal' copy constructor. This is a shallow copy, namely of the insertionBoundary, only the pointer is copied instead of the entire boundary.

Parameters
[in]otherChute object to be copied
Todo:
Check if this should indeed be a shallow copy.
97  : DPMBase(other), Mercury3D(other),
98  chuteAngle_(other.chuteAngle_),
106  maxFailed_(other.maxFailed_),
109 {
110  logger(DEBUG, "[Chute::Chute(const Chute& other)] copy constructor finished");
111 }

References FATAL, and logger.

Member Function Documentation

◆ actionsBeforeTimeStep()

void Chute::actionsBeforeTimeStep ( )
overrideprotectedvirtual

Calls Chute::cleanChute().

Applies all necessary actions before the next time step. In this case, it only calls Chute::cleanChute().

Reimplemented from DPMBase.

Reimplemented in ChuteBottom.

226 {
227  cleanChute();
228 }

References cleanChute().

◆ addFlowParticlesCompactly()

◆ cleanChute()

void Chute::cleanChute ( )
protected

Deletes all outflow particles once every 100 time steps.

Removes all particles which are outside the horizontal window, i.e. all particles with an x-direction position greater than xMax_ or smaller than xMin_. The removal operation is performed once every 100 time steps.

465 {
466  //clean outflow every 100 time steps
467  static int count = 0, maxcount = 100; // please note: static variables are only initialised once, and their values
468  // are stored even after the method returns. I.e., next time the method is
469  // called, the initialisation is ignored and the previously assigned value is used.
470  if (count > maxcount)
471  {
472  // reset counter
473  count = 0;
474 
475  // check all particles
476  for (unsigned int i = 0; i < particleHandler.getNumberOfObjects();)
477  {
478  // check if particle is outside the problem window
481  getXMin()) //||particleHandler.getObject(i)->Position.Z+particleHandler.getObject(i)->Radius<zMin_)
482  {
483  // if so, delete the particle
484  logger(DEBUG, "[Chute::cleanChute()] erased: %", particleHandler.getObject(i));
486  }
487  else
488  {
489  i++;
490  }
491  }
492  }
493  else
494  {
495  count++;
496  }
497 }

References FATAL, ParticleHandler::getNumberOfObjects(), BaseHandler< T >::getObject(), BaseInteractable::getPosition(), DPMBase::getXMax(), DPMBase::getXMin(), constants::i, logger, DPMBase::particleHandler, ParticleHandler::removeObject(), and Vec3D::X.

Referenced by SmoothChute::actionsBeforeTimeStep(), and actionsBeforeTimeStep().

◆ constructor()

void Chute::constructor ( )

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

constructor METHOD, which sets all chute properties to something sensible. This method should be called by all constructors except for the copy constructor that accepts another Chute.

119 {
120  insertionBoundary_ = nullptr;
121  isChutePeriodic_ = false;
122  setFixedParticleRadius(0.001);
124  setChuteAngle(0.0);
125 
126  setMaxFailed(1);
128  setInflowVelocity(0.1);
130  setInflowHeight(0.02);
131 }

References insertionBoundary_, isChutePeriodic_, MONOLAYER_DISORDERED, setChuteAngle(), setFixedParticleRadius(), setInflowHeight(), setInflowParticleRadius(), setInflowVelocity(), setInflowVelocityVariance(), setMaxFailed(), and setRoughBottomType().

Referenced by Chute().

◆ createBottom()

void Chute::createBottom ( )
protectedvirtual

Creates the chute bottom, which can be either flat or one of three flavours of rough.

Creates the bottom of the chute; either:

  • smooth: fixedParticleRadius_ smaller than 1e-12 or roughBottomType_ == FLAT, monolayered:
  • grid-like: roughBottomType_ == MONOLAYER_ORDERED,
  • random: roughBottomType_ == MONOLAYER_DISORDERED, or
  • multilayer: 'else' (roughBottomType_ == MULTILAYER), with by default contains all particles with a center within a depth band of 2.4 (= ChuteBottom::thickness_) * maxInflowParticleRadius_.
Todo:
Does the bottom we always has to be this particle? Maybe add a BaseParticle* argument, and add a default value with particle radius < 1e-12.

Reimplemented in FlowRule, VariableBottom, and VariableBottom.

324 {
325  // smooth bottom:
326  if (fabs(getFixedParticleRadius()) < 1e-12 || roughBottomType_ == FLAT)
327  {
328  // flat wall as bottom
329  logger(INFO, "[Chute::createBottom()] create perfectly flat chute bottom");
330 
331  //bottom wall
332  InfiniteWall w0;
334  w0.set(Vec3D(0.0, 0.0, -1.0), Vec3D(0, 0, getZMin()));
336  }
337  else //rough bottom
338  {
339  // Define standard fixed particle
349  F0.setPosition(Vec3D(0.0, 0.0, 0.0));
350  F0.setVelocity(Vec3D(0.0, 0.0, 0.0));
351 
353  {
354  // grid-like fixed-particle bottom
355  logger(INFO, "[Chute::createBottom()] create monolayered, ordered rough chute bottom");
356 
357  // allowed space for each particle in each direction
358  Mdouble dx = 2.0 * F0.getRadius();
359  Mdouble dy = 2.0 * F0.getRadius();
360 
361  // number of particles that fit in each direction
362  unsigned int nx = static_cast<unsigned int>(std::max(1, static_cast<int>(std::floor(
363  (getXMax() - getXMin()) / dx))));
364  unsigned int ny = static_cast<unsigned int>(std::max(1, static_cast<int>(std::floor(
365  (getYMax() - getYMin()) / dy))));
366 
367  // adjust particle spacing (in case total space available in given direction
368  // is not a multiple of 2*F0.getRadius() )
369  dx = (getXMax() - getXMin()) / nx;
370  dy = (getYMax() - getYMin()) / ny;
371 
372  for (unsigned int i = 0; i < nx; i++)
373  {
374  for (unsigned int j = 0; j < ny; j++)
375  {
376  // placing of particles on rectangular grid points
377  F0.setPosition(Vec3D(F0.getRadius() + dx * i, F0.getRadius() + dy * j, 0.0));
379  }
380  }
381 
382  //bottom wall, to make sure no particles will fall through the gaps
383  InfiniteWall w0;
385  w0.set(Vec3D(0.0, 0.0, -1.0), Vec3D(0, 0, getZMin() - dx));
387  }
389  {
390  // random fixed-particle bottom
391  logger(INFO, "[Chute::createBottom()] create monolayered disordered rough chute bottom");
392 
393  Vec3D position;
394  position.X = random.getRandomNumber(F0.getRadius(), getXMax() - F0.getRadius());
395  position.Y = random.getRandomNumber(getYMin() + F0.getRadius(), getYMax() - F0.getRadius());
396  F0.setPosition(position);
398 
401 
402  //now add more particles
403  int failed = 0;
404  while (failed < 500)
405  {
406  //The position components are first stored in a Vec3D, because
407  //if you pass them directly into setPosition the compiler is
408  //allowed to change the order in which the numbers are generated
409  position.X = random.getRandomNumber(F0.getRadius(), getXMax() - F0.getRadius());
410  position.Y = random.getRandomNumber(getYMin() + F0.getRadius(), getYMax() - F0.getRadius());
411  F0.setPosition(position);
413  {
415  failed = 0;
416  }
417  else
418  {
419  failed++;
420  }
421  }
422 
423  //bottom wall (create after particle creation, as
424  //checkParticleForInteraction also checks against walls)
425  InfiniteWall w0;
427  w0.set(Vec3D(0.0, 0.0, -1.0), Vec3D(0, 0, getZMin() - .5 * F0.getRadius()));
429  }
430  else //if (roughBottomType_ == MULTILAYER)
431  {
432  // multilayered particle bottom
433  logger(INFO, "[Chute::createBottom()] create multilayered rough chute bottom");
434 
435  //'this' points to the current Chute object, the class of which is inherited
436  // by the ChuteBottom class. I.e., the bottom is created with the particle
437  // properties from the current class.
438  // ChuteBottom::makeRoughBottom() creates a randomly filled, multilayered
439  // chute bottom.
440  ChuteBottom bottom(*this);
441  bottom.setInflowParticleRadius(getFixedParticleRadius());
442  bottom.makeRoughBottom(*this);
443 
444  //bottom wall
445  InfiniteWall w0;
447  w0.set(Vec3D(0.0, 0.0, -1.0), Vec3D(0, 0, getZMin() - bottom.getThickness()));
449  }
450  //finally, fix particles to the bottom
451  for (BaseParticle* const p : particleHandler)
452  {
453  p->fixParticle();
454  }
455  }
456 }

References MercuryBase::checkParticleForInteraction(), BaseHandler< T >::copyAndAddObject(), FLAT, getFixedParticleRadius(), BaseHandler< T >::getObject(), BaseParticle::getRadius(), RNG::getRandomNumber(), ChuteBottom::getThickness(), DPMBase::getXMax(), DPMBase::getXMin(), DPMBase::getYMax(), DPMBase::getYMin(), DPMBase::getZMin(), MercuryBase::hGridActionsBeforeTimeLoop(), MercuryBase::hGridActionsBeforeTimeStep(), constants::i, INFO, logger, ChuteBottom::makeRoughBottom(), MONOLAYER_DISORDERED, MONOLAYER_ORDERED, DPMBase::particleHandler, DPMBase::random, roughBottomType_, InfiniteWall::set(), BaseParticle::setHandler(), setInflowParticleRadius(), BaseInteractable::setPosition(), BaseParticle::setRadius(), BaseParticle::setSpecies(), BaseWall::setSpecies(), BaseInteractable::setVelocity(), DPMBase::speciesHandler, DPMBase::wallHandler, Vec3D::X, and Vec3D::Y.

Referenced by Funnel::setupInitialConditions(), AngleOfRepose::setupInitialConditions(), SilbertPeriodic::setupInitialConditions(), setupInitialConditions(), ChuteBottom::setupInitialConditions(), and ChuteWithHopper::setupInitialConditions().

◆ createFlowParticle()

◆ getChuteAngle()

Mdouble Chute::getChuteAngle ( ) const

◆ getChuteAngleDegrees()

Mdouble Chute::getChuteAngleDegrees ( ) const

Returns the chute angle (in degrees)

Returns the chute angle (as compared to the horizontal plane) in DEGREES

Returns
the chute angle in DEGREES (for writing to the terminal/an output stream)
744 {
745  return chuteAngle_ * 180.0 / constants::pi;
746 }

References chuteAngle_, and constants::pi.

Referenced by LawinenBox::actionsBeforeTimeStep(), PointIsAboveCurve(), LawinenBox::printTime(), SilbertPeriodic::printTime(), vibratedBed::printTime(), LawinenBox::rotateChute(), AngleOfRepose::set_study(), SilbertPeriodic::set_study(), FlowRule::setName(), Funnel::setName_(), SilbertHstop::solve_analytic(), and LawinenBox::writeEneTimeStep().

◆ getChuteLength()

Mdouble Chute::getChuteLength ( ) const

Returns the chute length (X-direction)

Returns the length of the chute. Actually returns xMax_, while xMin_ is assumed to have stayed 0.

Returns
length of the chute
997 {
998  return getXMax();
999 }

References DPMBase::getXMax().

Referenced by ChutePeriodic::add_flow_particles(), SilbertPeriodic::add_flow_particles(), addFlowParticlesCompactly(), Funnel::setName_(), and SilbertPeriodic::setupInitialConditions().

◆ getChuteWidth()

Mdouble Chute::getChuteWidth ( ) const

◆ getFixedParticleRadius()

Mdouble Chute::getFixedParticleRadius ( ) const

◆ getInflowHeight()

◆ getInflowParticleRadius()

◆ getInflowVelocity()

Mdouble Chute::getInflowVelocity ( ) const

Returns the average inflow velocity.

Returns the mean velocity at which the particles enter the chute

Returns
the mean velocity at which the particles enter the chute
928 {
929  return inflowVelocity_;
930 }

References inflowVelocity_.

Referenced by ChuteWithContraction::create_inflow_particle(), Funnel::create_inflow_particle(), SilbertPeriodic::create_inflow_particle(), and main().

◆ getInflowVelocityVariance()

Mdouble Chute::getInflowVelocityVariance ( ) const

Returns the inflow velocity variance.

Returns the variance of the velocities of the inflow particles around the mean

Returns
the variance of the velocities of the inflow particles around the mean (expressed in ratio of the mean, i.e. the inflowVelocity_).
957 {
959 }

References inflowVelocityVariance_.

Referenced by ChuteWithContraction::create_inflow_particle(), Funnel::create_inflow_particle(), and main().

◆ getIsPeriodic()

bool Chute::getIsPeriodic ( ) const

Returns whether the chute is periodic in Y.

Returns isChutePeriodic_, which is TRUE if the side walls (i.e. the walls in the Y-direction) of the chute are periodic

Returns
Whether or not the Chute is periodic.
598 {
599  return isChutePeriodic_;
600 }

References isChutePeriodic_.

Referenced by Chutebelt::actionsAfterTimeStep(), ChuteWithPeriodicInflow::Check_and_Duplicate_Periodic_Particle(), Funnel::create_walls(), ChuteWithPeriodicInflow::integrateBeforeForceComputation(), and Chutebelt::setupInitialConditions().

◆ getMaxFailed()

unsigned int Chute::getMaxFailed ( ) const

Returns the number of times a particle will be tried to be added to the insertion boundary.

Returns the number of times that the boundary may fail to insert a particle, before the boundary is considered filled.

Returns
The number of times that the boundary may fail to insert a particle
765 {
766  return maxFailed_;
767 }

References maxFailed_.

Referenced by AngleOfRepose::actionsBeforeTimeStep(), and ChuteWithHopper::setupInitialConditions().

◆ getMaxInflowParticleRadius()

◆ getMinInflowParticleRadius()

◆ getRoughBottomType()

RoughBottomType Chute::getRoughBottomType ( ) const

Returns the type of (rough) bottom of the chute.

Returns the roughBottomType_, which determines the type of rough bottom of the chute.

Returns
The type of the rough bottom.
682 {
683  return roughBottomType_;
684 }

References roughBottomType_.

◆ makeChutePeriodic()

void Chute::makeChutePeriodic ( )

This makes the chute periodic in Y.

Sets the side walls (i.e. the walls in the Y-direction) of the chute to be made periodic

588 {
589  isChutePeriodic_ = true;
590 }

References isChutePeriodic_.

Referenced by ChutePeriodicDemo::ChutePeriodicDemo(), main(), and ChutePeriodic::setup().

◆ printTime()

void Chute::printTime ( ) const
overrideprotectedvirtual

prints time, max time and number of particles

Prints the current simulation time, the maximum simulation time, and the current number of particles in the chute.

Reimplemented from DPMBase.

235 {
236  logger(INFO, "\rt=%3, tmax=%3, N=%3", getTime(), getTimeMax(), particleHandler.getNumberOfObjects());
237 }

References ParticleHandler::getNumberOfObjects(), DPMBase::getTime(), DPMBase::getTimeMax(), INFO, logger, and DPMBase::particleHandler.

◆ read()

void Chute::read ( std::istream &  is,
ReadOptions  opt = ReadOptions::ReadAll 
)
overridevirtual

Reads all chute properties from an istream.

Reads the object properties from an istream, usually a restart file. Note that there are several versions of restart files at the moment, this method determines which version this restart file is by itself.

Parameters
[in,out]isthe istream from which is read, usually a restart file.

Reimplemented from DPMBase.

Reimplemented in ChuteWithHopper.

140 {
141  MercuryBase::read(is, opt);
142  //read out the full line first, so if there is an error it does not affect
143  //the read of the next line
144  std::string line_string;
145  std::getline(is, line_string);
146  logger(INFO, "Chuteline=%", line_string);
147  std::stringstream line;
148  line << line_string;
149 
150  if (getRestartVersion() != "1") //Other versions..
151  {
152  std::string dummy;
153  unsigned int roughBottomType;
154  line >> fixedParticleRadius_
155  >> roughBottomType >> chuteAngle_
158  >> maxFailed_
159  >> dummy
160  >> inflowVelocity_
162  >> inflowHeight_;
163  setRoughBottomType(static_cast<RoughBottomType>(roughBottomType));
164  //if the Chute Angle is given in degrees, move to radians;
165  if (chuteAngle_ > 1.0)
166  {
167  logger(WARN, "Restartfile angle converted into radians from degrees! (% rad -> % deg)", chuteAngle_,
168  chuteAngle_ * constants::pi / 180.);
169  chuteAngle_ *= constants::pi / 180.;
170 
171  }
172  }
173  else //Version 1
174  {
175  std::string dummy;
176  unsigned int roughBottomType;
177  line >> dummy >> fixedParticleRadius_
178  >> dummy >> minInflowParticleRadius_
179  >> dummy >> maxInflowParticleRadius_
180  >> dummy >> roughBottomType
181  >> dummy >> chuteAngle_
182  >> dummy >> maxFailed_
183  >> dummy >> dummy
184  >> dummy >> inflowVelocity_
185  >> dummy >> inflowVelocityVariance_
186  >> dummy >> inflowHeight_;
187  setRoughBottomType(static_cast<RoughBottomType>(roughBottomType));
188  //This version always writes radians
189  }
190 
191 }

References chuteAngle_, fixedParticleRadius_, DPMBase::getRestartVersion(), inflowHeight_, inflowVelocity_, inflowVelocityVariance_, INFO, logger, maxFailed_, maxInflowParticleRadius_, minInflowParticleRadius_, constants::pi, MercuryBase::read(), setRoughBottomType(), and WARN.

Referenced by Funnel::read(), and ChuteWithHopper::read().

◆ readNextArgument()

bool Chute::readNextArgument ( int i,
int  argc,
char argv[] 
)
overridevirtual

This method can be used for reading object properties from a string.

this reads chute parameters from a string. It is used to read command-line arguments. Note that the last else calls the readNextArgument of the parent, Mercury3D.

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 of input parameters.
Returns
a bool which indicates whether the argument is a valid option.

Reimplemented from DPMBase.

Reimplemented in ChuteWithHopper.

511 {
512  if (!strcmp(argv[i], "-inflowHeight"))
513  {
514  setInflowHeight(atof(argv[i + 1]));
515  setZMax(atof(argv[i + 1]));
516  }
517  else if (!strcmp(argv[i], "-inflowVelocity"))
518  {
519  setInflowVelocity(atof(argv[i + 1]));
520  }
521  else if (!strcmp(argv[i], "-chuteAngle"))
522  {
523  setChuteAngle(atof(argv[i + 1]));
524  }
525  else if (!strcmp(argv[i], "-chuteLength"))
526  {
527  setChuteLength(atof(argv[i + 1]));
528  }
529  else if (!strcmp(argv[i], "-chuteWidth"))
530  {
531  setChuteWidth(atof(argv[i + 1]));
532  }
533  else if (!strcmp(argv[i], "-fixedParticleRadius"))
534  {
535  setFixedParticleRadius(atof(argv[i + 1]));
536  }
537  else if (!strcmp(argv[i], "-max_failed"))
538  {
539  setMaxFailed(static_cast<unsigned int>(atoi(argv[i + 1])));
540  }
541  else if (!strcmp(argv[i], "-inflowParticleRadiusRange"))
542  {
543  setInflowParticleRadius(atof(argv[i + 1]), atof(argv[i + 2]));
544  i++;
545  }
546  else if (!strcmp(argv[i], "-inflowParticleRadius"))
547  {
548  setInflowParticleRadius(atof(argv[i + 1]));
549  }
550  else if (!strcmp(argv[i], "-roughBottomType"))
551  {
552  std::string str(argv[i + 1]);
553  setRoughBottomType(str);
554  }
555 // else if (!strcmp(argv[i], "-k_eps"))
556 // {
557 // Mdouble Mass = getLightestParticleMass();
558 // //~ Mdouble Mass = particleHandler.get_LightestParticle()->getMass();
559 // speciesHandler.getObject(0)->setStiffnessAndRestitutionCoefficient(atof(argv[i + 1]), atof(argv[i + 2]), Mass);
560 // std::cout << "reset contact properties of lightest Particle (mass=" << Mass << ") to k=" << speciesHandler.getObject(0)->getStiffness() << " and dissipation_=" << speciesHandler.getObject(0)->getDissipation() << std::endl;
561 // i += 1;
562 // }
563 // else if (!strcmp(argv[i], "-tc_eps"))
564 // {
565 // Mdouble Mass = getLightestParticleMass();
566 // speciesHandler.getObject(0)->setCollisionTimeAndRestitutionCoefficient(atof(argv[i + 1]), atof(argv[i + 2]), Mass);
567 // std::cout << "reset contact properties of lightest Particle (mass=" << Mass << ") to k=" << speciesHandler.getObject(0)->getStiffness() << " and dissipation_=" << speciesHandler.getObject(0)->getDissipation() << std::endl;
568 // i += 1;
569 // }
570 // else if (!strcmp(argv[i], "-tc_eps_beta"))
571 // {
572 // Mdouble Mass = getLightestParticleMass();
573 // FrictionalSpecies* S = dynamic_cast<FrictionalSpecies*>(speciesHandler.getObject(0));
574 // S->setCollisionTimeAndNormalAndTangentialRestitutionCoefficient(atof(argv[i + 1]), atof(argv[i + 2]), atof(argv[i + 3]), Mass);
575 // std::cout << "reset contact properties of lightest Particle (mass=" << Mass << ") to k=" << S->getStiffness() << ", dissipation_=" << S->getDissipation() << ", kt=" << S->getSlidingStiffness() << " and dispt=" << S->getSlidingDissipation() << std::endl;
576 // i += 2;
577 // }
578  else
579  return Mercury3D::readNextArgument(i, argc, argv); //if argv[i] is not found, check the commands in Mercury3D
580  return true; //returns true if argv[i] is found
581 }

References constants::i, MercuryBase::readNextArgument(), setChuteAngle(), setChuteLength(), setChuteWidth(), setFixedParticleRadius(), setInflowHeight(), setInflowParticleRadius(), setInflowVelocity(), setMaxFailed(), setRoughBottomType(), and DPMBase::setZMax().

Referenced by AxisymmetricHopper::readNextArgument(), SilbertPeriodic::readNextArgument(), Funnel::readNextArgument(), ChuteWithHopper::readNextArgument(), and GranularJet::readNextArgument().

◆ setChuteAngle()

void Chute::setChuteAngle ( Mdouble  chuteAngle)

Sets gravity vector according to chute angle (in degrees)

Sets the angle of the chute as compared to the horizontal (i.e., the normal to gravity). NB: since the X and Z directions are defined to be parallel and normal to the chute bottom respectively, this function effectively sets the GRAVITY angle.

Parameters
[in]chuteAnglethe angle of the chute relative to the horizontal plane in DEGREES.
Todo:
would a check on the angle be beneficial to check if it is indeed in degrees?
696 {
697  // retrieve the magnitude of gravity
698  Mdouble gravity = getGravity().getLength();
699  if (gravity == 0)
700  {
701  logger(WARN, "[Chute::setChuteAngle()] zero gravity");
702  }
703 
704  // reset the gravity vector, with the given angle
705  setChuteAngleAndMagnitudeOfGravity(chuteAngle, gravity);
706 }

References DPMBase::getGravity(), Vec3D::getLength(), logger, setChuteAngleAndMagnitudeOfGravity(), and WARN.

Referenced by Chutebelt::actionsAfterTimeStep(), LawinenBox::actionsBeforeTimeStep(), constructor(), main(), ChuteBottom::makeRoughBottom(), PointIsAboveCurve(), readNextArgument(), LawinenBox::rotateChute(), FlowRule::run(), vibratedBed::run(), SilbertPeriodic::set_study(), and ChutePeriodic::setup().

◆ setChuteAngleAndMagnitudeOfGravity()

void Chute::setChuteAngleAndMagnitudeOfGravity ( Mdouble  chuteAngle,
Mdouble  gravity 
)

Sets gravity vector according to chute angle (in degrees)

Sets the angle of the chute as compared to the horizontal (i.e., the normal to gravity), as well as the magnitude of gravity. NB: since the X and Z directions are defined to be parallel and normal to the chute bottom, respectively, this function effectively sets the GRAVITY angle.

Parameters
[in]chuteAnglethe angle of the chute relative to the horizontal plane in DEGREES
[in]gravitymagnitude of the gravity vector
717 {
718  if (chuteAngle >= -90.0 && chuteAngle <= 90.0)
719  {
720  chuteAngle_ = chuteAngle * constants::pi / 180.0;
721  setGravity(Vec3D(sin(chuteAngle_), 0.0, -cos(chuteAngle_)) * gravity);
722  }
723  else
724  {
725  logger(WARN, "[Chute::setChuteAngleAndMagnitudeOfGravity()] Chute "
726  "angle must be within [-90,90]");
727  }
728 }

References chuteAngle_, mathsFunc::cos(), logger, constants::pi, DPMBase::setGravity(), mathsFunc::sin(), and WARN.

Referenced by AngleOfRepose::AngleOfRepose(), main(), setChuteAngle(), and SilbertPeriodic::SilbertPeriodic().

◆ setChuteLength()

void Chute::setChuteLength ( Mdouble  chuteLength)
virtual

Sets the chute length (X-direction)

Sets the length of the chute. Actually sets xMax_, while xMin_ is assumed to have stayed 0.

Parameters
[in]chuteLengthlength of the chute

Reimplemented in ChuteWithHopper.

987 {
988  setXMax(chuteLength);
989 }

References DPMBase::setXMax().

Referenced by ChutePeriodicDemo::ChutePeriodicDemo(), main(), readNextArgument(), ChutePeriodic::setup(), and SilbertPeriodic::SilbertPeriodic().

◆ setChuteWidth()

void Chute::setChuteWidth ( Mdouble  chuteWidth)

Sets the chute width (Y-direction)

Sets the width of the chute. Actually sets yMax_, while it assumes yMin_ to have stayed 0.

Parameters
[in]chuteWidthwidth of the chute
967 {
968  setYMax(chuteWidth);
969 }

References DPMBase::setYMax().

Referenced by AngleOfRepose::AngleOfRepose(), ChutePeriodicDemo::ChutePeriodicDemo(), main(), readNextArgument(), ChutePeriodic::setup(), and SilbertPeriodic::SilbertPeriodic().

◆ setFixedParticleRadius()

void Chute::setFixedParticleRadius ( Mdouble  fixedParticleRadius)

Sets the particle radius of the fixed particles which constitute the (rough) chute bottom.

Sets the radius of the fixed particles at the bottom (in case of a rough bottom; see also Chute::createBottom() ).

Parameters
[in]fixedParticleRadiusThe radius of the fixed particles on the bottom as an MDouble.
609 {
610  if (fixedParticleRadius >= 0.0)
611  {
612  fixedParticleRadius_ = fixedParticleRadius;
613  }
614  else
615  {
616  logger(WARN, "[Chute::setFixedParticleRadius()] Fixed particle radius "
617  "must be greater than or equal to zero.");
618  }
619 }

References fixedParticleRadius_, logger, and WARN.

Referenced by AngleOfRepose::AngleOfRepose(), ChutePeriodicDemo::ChutePeriodicDemo(), constructor(), LawinenBox::LawinenBox(), main(), ChuteBottom::makeRoughBottom(), readNextArgument(), Cstatic2d::set_particle_properties(), Cstatic3D::set_particle_properties(), AngleOfRepose::set_study(), SilbertPeriodic::set_study(), FlowRule::setPolydispersity(), ChutePeriodic::setup(), and SilbertPeriodic::SilbertPeriodic().

◆ setInflowHeight()

void Chute::setInflowHeight ( Mdouble  inflowHeight)

Sets maximum inflow height (Z-direction)

Sets the maximum height in Z-direction at which particles are introduced into the chute.

Parameters
[in]inflowHeightthe maximum inflow height to be set
885 {
886  //if (inflowHeight >= minInflowParticleRadius_ + maxInflowParticleRadius_)
887  {
888  inflowHeight_ = inflowHeight;
889  setZMax(1.2 * inflowHeight_);
890  }
891 // else
892 // {
893 // std::cerr << "WARNING : Inflow height not changed to " << inflowHeight << ", value must be greater than or equal to diameter of inflow particle" << std::endl;
894 // }
895 }

References inflowHeight_, and DPMBase::setZMax().

Referenced by ChutePeriodic::add_flow_particles(), SilbertPeriodic::add_flow_particles(), addFlowParticlesCompactly(), ChutePeriodicDemo::ChutePeriodicDemo(), constructor(), main(), ChuteBottom::makeRoughBottom(), PointIsAboveCurve(), readNextArgument(), FlowRule::run(), vibratedBed::run(), AngleOfRepose::set_H(), SilbertPeriodic::set_H(), SilbertPeriodic::set_study(), and Funnel::update_funnel().

◆ setInflowParticleRadius() [1/2]

void Chute::setInflowParticleRadius ( Mdouble  inflowParticleRadius)

Sets the radius of the inflow particles to a single one (i.e. ensures a monodisperse inflow).

Sets the radius of particles flowing in at the start of the chute to be constant and the given one (i.e., the minimum and maximum allowed radius are set equal to each other and the argument).

Parameters
[in]inflowParticleRadiusthe radius of the particles entering the chute
776 {
777  if (inflowParticleRadius >= 0.0)
778  {
779  minInflowParticleRadius_ = inflowParticleRadius;
780  maxInflowParticleRadius_ = inflowParticleRadius;
781  }
782  else
783  {
784  logger(WARN, "[Chute::setInflowParticleRadius(Mdouble)] Inflow "
785  "particle must be greater than or equal to zero");
786  }
787 }

References logger, maxInflowParticleRadius_, minInflowParticleRadius_, and WARN.

Referenced by AngleOfRepose::AngleOfRepose(), ChutePeriodicDemo::ChutePeriodicDemo(), constructor(), FlowRule::createBottom(), createBottom(), LawinenBox::LawinenBox(), main(), readNextArgument(), Cstatic2d::set_particle_properties(), Cstatic3D::set_particle_properties(), ChutePeriodic::setup(), and SilbertPeriodic::SilbertPeriodic().

◆ setInflowParticleRadius() [2/2]

void Chute::setInflowParticleRadius ( Mdouble  minInflowParticleRadius,
Mdouble  maxInflowParticleRadius 
)

Sets the minimum and maximum radius of the inflow particles.

Sets the minimum and maximum radius possible of particles entering the chute.

Parameters
[in]minInflowParticleRadiusthe minimum radius
[in]maxInflowParticleRadiusthe maximum radius
796 {
797  if (minInflowParticleRadius >= 0.0)
798  {
799  minInflowParticleRadius_ = minInflowParticleRadius;
800  }
801  else
802  {
803  logger(WARN, "[Chute::setInflowParticleRadius(Mdouble,Mdouble)] Min."
804  "inflow particle radius must be nonnegative");
805  }
806  if (maxInflowParticleRadius >= minInflowParticleRadius)
807  {
808  maxInflowParticleRadius_ = maxInflowParticleRadius;
809  }
810  else
811  {
812  logger(WARN, "[Chute::setInflowParticleRadius(Mdouble,Mdouble)] Max."
813  " inflow particle radius must be >= min. inflow particle "
814  "radius");
815  }
816 }

References logger, maxInflowParticleRadius_, minInflowParticleRadius_, and WARN.

◆ setInflowVelocity()

void Chute::setInflowVelocity ( Mdouble  inflowVelocity)

Sets the average inflow velocity.

Sets the mean velocity at which the particles enter the chute

Parameters
[in]inflowVelocitythe mean velocity at which the particles enter the chute
911 {
912  if (inflowVelocity >= 0.0)
913  {
914  inflowVelocity_ = inflowVelocity;
915  }
916  else
917  {
918  logger(WARN, "[Chute::setInflowVelocity()] Inflow velocity not changed, "
919  "value must be greater than or equal to zero");
920  }
921 }

References inflowVelocity_, logger, and WARN.

Referenced by ChuteWithContraction::ChuteWithContraction(), constructor(), main(), readNextArgument(), and SilbertPeriodic::SilbertPeriodic().

◆ setInflowVelocityVariance()

void Chute::setInflowVelocityVariance ( Mdouble  inflowVelocityVariance)

Sets the inflow velocity variance.

Sets the variance of the velocities of the inflow particles around the mean

Parameters
[in]inflowVelocityVariancethe variance of the velocities of the inflow particles around the mean (expressed in ratio of the mean, i.e. the inflowVelocity_).
938 {
939  if (inflowVelocityVariance >= 0.0 && inflowVelocityVariance <= 1.0)
940  {
941  inflowVelocityVariance_ = inflowVelocityVariance;
942  }
943  else
944  {
945  logger(ERROR, "[Chute::setInflowVelocityVariance()] Inflow velocity "
946  "variance not changed, value must be within [0,1]");
947  exit(-1);
948  }
949 }

References ERROR, inflowVelocityVariance_, and logger.

Referenced by constructor(), and main().

◆ setInsertionBoundary()

void Chute::setInsertionBoundary ( InsertionBoundary insertionBoundary)

Sets the chute insertion boundary.

Sets the insertion boundary of the chute.

Parameters
[in]insertionBoundarythe insertion boundary of the chute
1006 {
1007  insertionBoundary_ = insertionBoundary;
1008 }

References insertionBoundary_.

Referenced by ChuteWithHopper::setupInitialConditions().

◆ setMaxFailed()

void Chute::setMaxFailed ( unsigned int  maxFailed)

Sets the number of times a particle will be tried to be added to the insertion boundary.

Sets the number of times that the boundary may fail to insert a particle,before the boundary is considered filled.

Parameters
[in]maxFailedThe number of times that the boundary may fail to insert a particle
755 {
756  maxFailed_ = maxFailed;
757 }

References maxFailed_.

Referenced by constructor(), main(), readNextArgument(), and ChutePeriodic::setup().

◆ setMaxInflowParticleRadius()

void Chute::setMaxInflowParticleRadius ( Mdouble  maxInflowParticleRadius)

Sets the maximum radius of inflow particles.

Sets the maximum radius possible of particles entering the chute.

Parameters
[in]maxInflowParticleRadiusthe maximum radius
840 {
841  if (maxInflowParticleRadius >= minInflowParticleRadius_)
842  {
843  maxInflowParticleRadius_ = maxInflowParticleRadius;
844  }
845  else
846  {
847  logger(WARN, "[Chute::setMaxInflowParticleRadius()] Max. inflow particle"
848  " radius must be >= min. inflow particle radius");
849  }
850 }

References logger, maxInflowParticleRadius_, minInflowParticleRadius_, and WARN.

Referenced by FlowRule::setPolydispersity().

◆ setMinInflowParticleRadius()

void Chute::setMinInflowParticleRadius ( Mdouble  minInflowParticleRadius)

sets the minimum radius of inflow particles

Sets the minimum radius possible of particles entering the chute.

Parameters
[in]minInflowParticleRadiusthe minimum radius
823 {
824  if (minInflowParticleRadius <= maxInflowParticleRadius_)
825  {
826  minInflowParticleRadius_ = minInflowParticleRadius;
827  }
828  else
829  {
830  logger(WARN, "[Chute::setMinInflowParticleRadius()] Min. inflow particle"
831  " radius must be <= max. inflow particle radius");
832  }
833 }

References logger, maxInflowParticleRadius_, minInflowParticleRadius_, and WARN.

Referenced by FlowRule::setPolydispersity().

◆ setRoughBottomType() [1/2]

void Chute::setRoughBottomType ( RoughBottomType  roughBottomType)

Sets the type of rough bottom of the chute.

Sets the roughBottomType_. Possible choices are defined by the enum RoughBottomType, which is defined in Chute.h:

  • MONOLAYER_ORDERED: Bottom will be a rectangularly ordered monolayer of particles
  • MONOLAYER_DISORDERED: Bottom will be a disordered monolayer of particles
  • MULTILAYER: Bottom will be a multilayer of particles
  • FLAT: Flat bottom. See also the documentation of Chute::createBottom().
    Parameters
    [in]roughBottomTypeThe bottom type to be set
642 {
643  roughBottomType_ = roughBottomType;
644 }

References roughBottomType_.

Referenced by AngleOfRepose::AngleOfRepose(), ChutePeriodicDemo::ChutePeriodicDemo(), constructor(), main(), ChuteBottom::makeRoughBottom(), read(), readNextArgument(), ChutePeriodic::setup(), SilbertPeriodic::SilbertPeriodic(), SilbertHstop::solve_analytic(), and vibratedBed::vibratedBed().

◆ setRoughBottomType() [2/2]

void Chute::setRoughBottomType ( std::string  roughBottomTypeString)

Sets the type of rough bottom of the chute, using a string with the EXACT enum type as input.

Same as Chute::setRoughBottomType(RoughBottomType roughBottomType), but takes a string identical to the RoughBottomType as an argument instead.

Todo:
: logger::Fatal seems very strong here, maybe set a default instead?
651 {
652  if (!roughBottomTypeString.compare("MONOLAYER_ORDERED"))
653  {
655  }
656  else if (!roughBottomTypeString.compare("MONOLAYER_DISORDERED"))
657  {
659  }
660  else if (!roughBottomTypeString.compare("MULTILAYER"))
661  {
663  }
664  else if (roughBottomTypeString == "FLAT")
665  {
667  }
668  else
669  {
670  logger(FATAL, "[Chute::setRoughBottomType(std::string)] Invalid "
671  "argument in setRoughBottomType. Given: %",
672  roughBottomTypeString);
673  }
674 }

References FATAL, FLAT, logger, MONOLAYER_ORDERED, and roughBottomType_.

◆ setupInitialConditions()

void Chute::setupInitialConditions ( )
overridevirtual

Creates bottom, side walls and a particle insertion boundary.

Adds side walls, a bottom and a particle insertion boundary

Reimplemented from DPMBase.

Reimplemented in ChuteWithHopper, and ChuteBottom.

243 {
245  {
246  logger(FATAL, "[Chute::setupInitialConditions()] Chute % cannot "
247  "complete because no species have been defined.", getName());
248  }
249 
250  // create the chute's side walls in Y-direction
251  // (which are solid if the chute is not periodic)
252  setupSideWalls();
253 
254  // create a particle of which (altered) copies will fill the chute insertion
255  // boundary
256 
257 
258 
259  SphericalParticle* particleToInsert = new SphericalParticle;
260  // by default, insert particles of species 0
261  particleToInsert->setSpecies(speciesHandler.getObject(0));
263  {
264  particleToInsert->setSpecies(speciesHandler.getObject(0));
265  }
266  else
267  {
268  logger(ERROR, "There is not yet a species defined");
269  }
270  PSD psd;
272  // set up the insertion boundary and add to handler
274  b1.set(particleToInsert, maxFailed_, Vec3D(getXMin(), getYMin(), getZMin()),
277  b1.setPSD(psd);
279 
280  //creates the bottom of the chute
281  createBottom();
282 }

References DPMBase::boundaryHandler, BaseHandler< T >::copyAndAddObject(), createBottom(), ERROR, FATAL, fixedParticleRadius_, getMaxInflowParticleRadius(), getMinInflowParticleRadius(), DPMBase::getName(), BaseHandler< T >::getNumberOfObjects(), BaseHandler< T >::getObject(), DPMBase::getXMax(), DPMBase::getXMin(), DPMBase::getYMax(), DPMBase::getYMin(), DPMBase::getZMax(), DPMBase::getZMin(), inflowVelocity_, inflowVelocityVariance_, insertionBoundary_, logger, maxFailed_, ChuteInsertionBoundary::set(), PSD::setDistributionUniform(), InsertionBoundary::setPSD(), BaseParticle::setSpecies(), setupSideWalls(), and DPMBase::speciesHandler.

Referenced by ChutePeriodic::setupInitialConditions(), Vreman::setupInitialConditions(), SegregationPeriodic::setupInitialConditions(), Chutebelt::setupInitialConditions(), ChutePeriodicDemo::setupInitialConditions(), and ChuteWithWedge::setupInitialConditions().

◆ setupSideWalls()

void Chute::setupSideWalls ( )

Creates chute side walls (either solid or periodic)

Create side walls (i.e., in the Y-direction), which can be either periodic (if isChutePeriodic_ is TRUE), or solid (if isChutePeriodic_ is FALSE).

289 {
290  // check if walls should be periodic or solid
291  if (isChutePeriodic_)
292  {
293  // create a periodic boundary with walls at yMin_ and yMax_.
294  PeriodicBoundary b0;
295  b0.set(Vec3D(0.0, 1.0, 0.0), getYMin(), getYMax());
297  }
298  else
299  {
300  // create two infinite solid walls; one at yMin_...
301  InfiniteWall w0;
303  w0.set(Vec3D(0.0, -1.0, 0.0), Vec3D(0, getYMin(), 0));
305  // ... and one at yMax_.
306  w0.set(Vec3D(0.0, 1.0, 0.0), Vec3D(0, getYMax(), 0));
308  }
309 }

References DPMBase::boundaryHandler, BaseHandler< T >::copyAndAddObject(), BaseHandler< T >::getObject(), DPMBase::getYMax(), DPMBase::getYMin(), isChutePeriodic_, PeriodicBoundary::set(), InfiniteWall::set(), BaseWall::setSpecies(), DPMBase::speciesHandler, and DPMBase::wallHandler.

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

◆ write()

void Chute::write ( std::ostream &  os,
bool  writeAllParticles = true 
) const
overridevirtual

This function writes the Chute properties to an ostream, and adds the properties of ALL chute particles as well.

Writes object's properties to an ostream, usually a restart file, but it can also for example write to the screen by passing std::cout as the ostream.

Parameters
[in]osthe ostream to which the properties have to be written.
[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)). The default value is true.

Reimplemented from DPMBase.

Reimplemented in ChuteWithHopper.

207 {
208  MercuryBase::write(os, writeAllParticles);
209  os << "FixedParticleRadius " << fixedParticleRadius_
210  << " MinInflowParticleRadius " << minInflowParticleRadius_
211  << " MaxInflowParticleRadius " << maxInflowParticleRadius_
212  << " RoughBottomType " << roughBottomType_
213  << " ChuteAngle " << chuteAngle_
214  << " MaxFailed " << maxFailed_
216  << " InflowVelocity " << inflowVelocity_
217  << " InflowVelocityVariance " << inflowVelocityVariance_
218  << " InflowHeight " << inflowHeight_ << std::endl;
219 }

References chuteAngle_, fixedParticleRadius_, InsertionBoundary::getNumberOfParticlesInserted(), inflowHeight_, inflowVelocity_, inflowVelocityVariance_, insertionBoundary_, maxFailed_, maxInflowParticleRadius_, minInflowParticleRadius_, roughBottomType_, and MercuryBase::write().

Referenced by SilbertPeriodic::add_flow_particles(), ChuteWithPeriodicInflowAndContraction::ChuteWithPeriodicInflowAndContraction(), ContractionWithPeriodicInflow::ContractionWithPeriodicInflow(), main(), ChuteWithContraction::setup_particles_initial_conditions(), ChutePeriodic::setupInitialConditions(), Cstatic2d::setupInitialConditions(), Cstatic3D::setupInitialConditions(), CLiveStatistics< T >::setupInitialConditions(), statistics_while_running< T >::setupInitialConditions(), Funnel::write(), and ChuteWithHopper::write().

Member Data Documentation

◆ chuteAngle_

Mdouble Chute::chuteAngle_
private

◆ fixedParticleRadius_

Mdouble Chute::fixedParticleRadius_
private

radius of the fixed particles at the bottom

Referenced by getFixedParticleRadius(), read(), setFixedParticleRadius(), setupInitialConditions(), and write().

◆ inflowHeight_

Mdouble Chute::inflowHeight_
private

Height of inflow.

Referenced by getInflowHeight(), read(), setInflowHeight(), and write().

◆ inflowVelocity_

Mdouble Chute::inflowVelocity_
private

Average inflow velocity in x-direction.

Referenced by getInflowVelocity(), read(), setInflowVelocity(), setupInitialConditions(), and write().

◆ inflowVelocityVariance_

Mdouble Chute::inflowVelocityVariance_
private

Inflow velocity variance in x-direction (in ratio of inflowVelocity_)

Referenced by getInflowVelocityVariance(), read(), setInflowVelocityVariance(), setupInitialConditions(), and write().

◆ insertionBoundary_

InsertionBoundary* Chute::insertionBoundary_
private

(Pointer to) the Chute's insertion boundary

Referenced by constructor(), setInsertionBoundary(), setupInitialConditions(), and write().

◆ isChutePeriodic_

bool Chute::isChutePeriodic_
private

Determines whether the chute has periodic (TRUE) or solid (FALSE) walls in the Y-direction.

Referenced by constructor(), getIsPeriodic(), makeChutePeriodic(), and setupSideWalls().

◆ maxFailed_

unsigned int Chute::maxFailed_
private

indicates how many attempts are made to insert a new particle into the insertion boundary before the boundary is considered filled.

Referenced by getMaxFailed(), read(), setMaxFailed(), setupInitialConditions(), and write().

◆ maxInflowParticleRadius_

Mdouble Chute::maxInflowParticleRadius_
private

◆ minInflowParticleRadius_

Mdouble Chute::minInflowParticleRadius_
private

◆ roughBottomType_

RoughBottomType Chute::roughBottomType_
private

Determines the type of rough bottom created (if any). See also the enum RoughBottomType at the beginning of this header file.

Referenced by createBottom(), getRoughBottomType(), setRoughBottomType(), and write().


The documentation for this class was generated from the following files:
Chute::isChutePeriodic_
bool isChutePeriodic_
Determines whether the chute has periodic (TRUE) or solid (FALSE) walls in the Y-direction.
Definition: Chute.h:361
PSD::setDistributionUniform
void setDistributionUniform(Mdouble radMin, Mdouble radMax, int numberOfBins)
create a PSD vector for a uniform distribution.
Definition: PSD.cc:297
ChuteInsertionBoundary
Used for modeling chute inflow. Inherits from InsertionBoundary.
Definition: ChuteInsertionBoundary.h:41
BaseParticle::setHandler
void setHandler(ParticleHandler *handler)
Sets the pointer to the particle's ParticleHandler.
Definition: BaseParticle.cc:651
Chute::getMinInflowParticleRadius
Mdouble getMinInflowParticleRadius() const
returns the minimum radius of inflow particles
Definition: Chute.cc:865
MercuryBase::hGridActionsBeforeTimeStep
void hGridActionsBeforeTimeStep() override
Performs all necessary actions before a time-step, like updating the particles and resetting all the ...
Definition: MercuryBase.cc:323
constants::pi
const Mdouble pi
Definition: ExtendedMath.h:45
Chute::setChuteAngleAndMagnitudeOfGravity
void setChuteAngleAndMagnitudeOfGravity(Mdouble chuteAngle, Mdouble gravity)
Sets gravity vector according to chute angle (in degrees)
Definition: Chute.cc:716
Chute::getMaxInflowParticleRadius
Mdouble getMaxInflowParticleRadius() const
Returns the maximum radius of inflow particles.
Definition: Chute.cc:874
Chute::setMaxFailed
void setMaxFailed(unsigned int maxFailed)
Sets the number of times a particle will be tried to be added to the insertion boundary.
Definition: Chute.cc:754
MercuryBase::read
void read(std::istream &is, ReadOptions opt=ReadOptions::ReadAll) override
Reads the MercuryBase from an input stream, for example a restart file.
Definition: MercuryBase.cc:104
Chute::maxFailed_
unsigned int maxFailed_
indicates how many attempts are made to insert a new particle into the insertion boundary before the ...
Definition: Chute.h:352
DPMBase::getXMax
Mdouble getXMax() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMax() returns XMax.
Definition: DPMBase.h:607
BaseInteractable::setPosition
void setPosition(const Vec3D &position)
Sets the position of this BaseInteractable.
Definition: BaseInteractable.h:239
Chute::setInflowVelocity
void setInflowVelocity(Mdouble inflowVelocity)
Sets the average inflow velocity.
Definition: Chute.cc:910
Chute::setInflowHeight
void setInflowHeight(Mdouble inflowHeight)
Sets maximum inflow height (Z-direction)
Definition: Chute.cc:884
logger
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
ChuteBottom
Used by Chute::createBottom to create an unordered particle layer.
Definition: ChuteBottom.h:40
DPMBase::random
RNG random
This is a random generator, often used for setting up the initial conditions etc.....
Definition: DPMBase.h:1390
InsertionBoundary::getNumberOfParticlesInserted
unsigned int getNumberOfParticlesInserted() const
Gets the number of particles inserted by the boundary.
Definition: InsertionBoundary.cc:338
ParticleHandler::getNumberOfObjects
unsigned int getNumberOfObjects() const override
Returns the number of objects in the container. In parallel code this practice is forbidden to avoid ...
Definition: ParticleHandler.cc:1315
Vec3D::X
Mdouble X
the vector components
Definition: Vector.h:65
DPMBase::DPMBase
DPMBase()
Constructor that calls the "void constructor()".
Definition: DPMBase.cc:193
MercuryBase::checkParticleForInteraction
bool checkParticleForInteraction(const BaseParticle &P) final
Checks if given BaseParticle has an interaction with a BaseWall or other BaseParticle.
Definition: MercuryBase.cc:594
DPMBase::setYMax
void setYMax(Mdouble newYMax)
Sets the value of YMax, the upper bound of the problem domain in the y-direction.
Definition: DPMBase.cc:1182
InsertionBoundary::setPSD
void setPSD(const PSD psd)
Sets the range of particle radii that may be generated from a user defined PSD.
Definition: InsertionBoundary.cc:675
BaseHandler::getSize
unsigned int getSize() const
Gets the size of the particleHandler (including mpi and periodic particles)
Definition: BaseHandler.h:655
Chute::setChuteWidth
void setChuteWidth(Mdouble chuteWidth)
Sets the chute width (Y-direction)
Definition: Chute.cc:966
Chute::minInflowParticleRadius_
Mdouble minInflowParticleRadius_
minimal radius of inflowing particles
Definition: Chute.h:326
INFO
LL< Log::INFO > INFO
Info log level.
Definition: Logger.cc:55
Chute::setChuteAngle
void setChuteAngle(Mdouble chuteAngle)
Sets gravity vector according to chute angle (in degrees)
Definition: Chute.cc:695
BaseHandler::setStorageCapacity
void setStorageCapacity(const unsigned int N)
Sets the storage capacity of this BaseHandler.
Definition: BaseHandler.h:669
BaseParticle::setRadius
virtual void setRadius(Mdouble radius)
Sets the particle's radius_ (and adjusts the mass_ accordingly, based on the particle's species)
Definition: BaseParticle.cc:542
Mercury3D::Mercury3D
Mercury3D()
This is the default constructor. All it does is set sensible defaults.
Definition: Mercury3D.cc:29
Vec3D
Definition: Vector.h:50
DPMBase::getYMin
Mdouble getYMin() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMin() returns YMin.
Definition: DPMBase.h:613
DPMBase::setZMax
void setZMax(Mdouble newZMax)
Sets the value of ZMax, the upper bound of the problem domain in the z-direction.
Definition: DPMBase.cc:1208
Mdouble
double Mdouble
Definition: GeneralDefine.h:34
DPMBase::boundaryHandler
BoundaryHandler boundaryHandler
An object of the class BoundaryHandler which concerns insertion and deletion of particles into or fro...
Definition: DPMBase.h:1410
ChuteInsertionBoundary::set
void set(std::vector< BaseParticle * > particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, double fixedParticleRadius, double inflowVelocity, double inflowVelocityVariance)
Sets all boundary properties at once.
Definition: ChuteInsertionBoundary.cc:89
RoughBottomType
RoughBottomType
enum for determining the type of rough bottom (if any) of the chute. Either of the enum options can b...
Definition: Chute.h:52
Chute::roughBottomType_
RoughBottomType roughBottomType_
Determines the type of rough bottom created (if any). See also the enum RoughBottomType at the beginn...
Definition: Chute.h:347
Chute::setRoughBottomType
void setRoughBottomType(RoughBottomType roughBottomType)
Sets the type of rough bottom of the chute.
Definition: Chute.cc:641
BaseParticle::getRadius
Mdouble getRadius() const
Returns the particle's radius.
Definition: BaseParticle.h:348
BaseInteractable::setVelocity
void setVelocity(const Vec3D &velocity)
set the velocity of the BaseInteractable.
Definition: BaseInteractable.cc:350
Chute::setInflowParticleRadius
void setInflowParticleRadius(Mdouble inflowParticleRadius)
Sets the radius of the inflow particles to a single one (i.e. ensures a monodisperse inflow).
Definition: Chute.cc:775
ERROR
LL< Log::ERROR > ERROR
Error log level.
Definition: Logger.cc:53
MONOLAYER_DISORDERED
@ MONOLAYER_DISORDERED
Definition: Chute.h:53
mathsFunc::sin
Mdouble sin(Mdouble x)
Definition: ExtendedMath.cc:44
BaseParticle::setSpecies
void setSpecies(const ParticleSpecies *species)
Definition: BaseParticle.cc:804
Vec3D::getLength
static Mdouble getLength(const Vec3D &a)
Calculates the length of a Vec3D: .
Definition: Vector.cc:331
FLAT
@ FLAT
Definition: Chute.h:53
DPMBase::getTime
Mdouble getTime() const
Returns the current simulation time.
Definition: DPMBase.cc:805
Chute::constructor
void constructor()
This is the actual constructor METHOD; it is called by all constructors above (except the default cop...
Definition: Chute.cc:118
DPMBase::setXMax
void setXMax(Mdouble newXMax)
Sets the value of XMax, the upper bound of the problem domain in the x-direction.
Definition: DPMBase.cc:1156
WARN
LL< Log::WARN > WARN
Warning log level.
Definition: Logger.cc:54
Log::FATAL
@ FATAL
DPMBase::speciesHandler
SpeciesHandler speciesHandler
A handler to that stores the species type i.e. LinearViscoelasticSpecies, etc.
Definition: DPMBase.h:1385
SphericalParticle
A spherical particle is the most simple particle used in MercuryDPM.
Definition: SphericalParticle.h:37
DPMBase::wallHandler
WallHandler wallHandler
An object of the class WallHandler. Contains pointers to all the walls created.
Definition: DPMBase.h:1405
BaseHandler::getNumberOfObjects
virtual unsigned int getNumberOfObjects() const
Gets the number of real Object in this BaseHandler. (i.e. no mpi or periodic particles)
Definition: BaseHandler.h:648
Chute::getChuteLength
Mdouble getChuteLength() const
Returns the chute length (X-direction)
Definition: Chute.cc:996
Chute::setChuteLength
virtual void setChuteLength(Mdouble chuteLength)
Sets the chute length (X-direction)
Definition: Chute.cc:986
Vec3D::Y
Mdouble Y
Definition: Vector.h:65
Chute::inflowVelocity_
Mdouble inflowVelocity_
Average inflow velocity in x-direction.
Definition: Chute.h:334
DPMBase::setGravity
void setGravity(Vec3D newGravity)
Sets a new value for the gravitational acceleration.
Definition: DPMBase.cc:1374
InfiniteWall
A infinite wall fills the half-space {point: (position_-point)*normal_<=0}.
Definition: InfiniteWall.h:48
FATAL
LL< Log::FATAL > FATAL
Definition of the different loglevels by its wrapper class LL. These are used as tags in template met...
Definition: Logger.cc:52
Chute::setFixedParticleRadius
void setFixedParticleRadius(Mdouble fixedParticleRadius)
Sets the particle radius of the fixed particles which constitute the (rough) chute bottom.
Definition: Chute.cc:608
DPMBase::getName
const std::string & getName() const
Returns the name of the file. Does not allow to change it though.
Definition: DPMBase.cc:397
Chute::getFixedParticleRadius
Mdouble getFixedParticleRadius() const
Returns the particle radius of the fixed particles which constitute the (rough) chute bottom.
Definition: Chute.cc:626
constants::i
const std::complex< Mdouble > i
Definition: ExtendedMath.h:51
DPMBase::getZMin
Mdouble getZMin() const
If the length of the problem domain in z-direction is ZMax - ZMin, then getZMin() returns ZMin.
Definition: DPMBase.h:625
BaseWall::setSpecies
void setSpecies(const ParticleSpecies *species)
Defines the species of the current wall.
Definition: BaseWall.cc:171
Chute::setInflowVelocityVariance
void setInflowVelocityVariance(Mdouble inflowVelocityVariance)
Sets the inflow velocity variance.
Definition: Chute.cc:937
Chute::setupSideWalls
void setupSideWalls()
Creates chute side walls (either solid or periodic)
Definition: Chute.cc:288
BaseHandler::getObject
T * getObject(const unsigned int id)
Gets a pointer to the Object at the specified index in the BaseHandler.
Definition: BaseHandler.h:613
Chute::insertionBoundary_
InsertionBoundary * insertionBoundary_
(Pointer to) the Chute's insertion boundary
Definition: Chute.h:356
Chute::chuteAngle_
Mdouble chuteAngle_
chute angle in degrees
Definition: Chute.h:318
MercuryBase::write
void write(std::ostream &os, bool writeAllParticles=true) const override
Writes all data into a restart file.
Definition: MercuryBase.cc:147
BaseParticle
Definition: BaseParticle.h:54
BaseHandler::copyAndAddObject
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
MONOLAYER_ORDERED
@ MONOLAYER_ORDERED
Definition: Chute.h:53
DPMBase::getRestartVersion
std::string getRestartVersion() const
This is to take into account for different Mercury versions. Returns the version of the restart file.
Definition: DPMBase.cc:1466
RNG::getRandomNumber
Mdouble getRandomNumber()
This is a random generating routine can be used for initial positions.
Definition: RNG.cc:142
PeriodicBoundary
Defines a pair of periodic walls. Inherits from BaseBoundary.
Definition: PeriodicBoundary.h:41
MercuryBase::hGridActionsBeforeTimeLoop
void hGridActionsBeforeTimeLoop() override
This sets up the broad phase information, has to be done at this stage because it requires the partic...
Definition: MercuryBase.cc:94
DPMBase::getGravity
Vec3D getGravity() const
Returns the gravitational acceleration.
Definition: DPMBase.cc:1382
DPMBase::getYMax
Mdouble getYMax() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMax() returns XMax.
Definition: DPMBase.h:619
MercuryBase::readNextArgument
bool readNextArgument(int &i, int argc, char *argv[]) override
Reads the next command line argument.
Definition: MercuryBase.cc:402
DPMBase::getZMax
Mdouble getZMax() const
If the length of the problem domain in z-direction is ZMax - ZMin, then getZMax() returns ZMax.
Definition: DPMBase.h:631
PeriodicBoundary::set
void set(Vec3D normal, Mdouble distanceLeft, Mdouble distanceRight)
Defines a PeriodicBoundary by its normal and positions.
Definition: PeriodicBoundary.cc:84
ParticleHandler::removeObject
void removeObject(unsigned int index) override
Removes a BaseParticle from the ParticleHandler.
Definition: ParticleHandler.cc:390
PSD
Contains a vector with radii and probabilities of a user defined particle size distribution (PSD)
Definition: PSD.h:63
Chute::getInflowHeight
Mdouble getInflowHeight() const
Returns the maximum inflow height (Z-direction)
Definition: Chute.cc:901
DPMBase::particleHandler
ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created.
Definition: DPMBase.h:1395
Chute::fixedParticleRadius_
Mdouble fixedParticleRadius_
radius of the fixed particles at the bottom
Definition: Chute.h:322
Chute::cleanChute
void cleanChute()
Deletes all outflow particles once every 100 time steps.
Definition: Chute.cc:464
Chute::inflowVelocityVariance_
Mdouble inflowVelocityVariance_
Inflow velocity variance in x-direction (in ratio of inflowVelocity_)
Definition: Chute.h:338
Chute::createBottom
virtual void createBottom()
Creates the chute bottom, which can be either flat or one of three flavours of rough.
Definition: Chute.cc:323
Chute::createFlowParticle
virtual SphericalParticle createFlowParticle()
Definition: Chute.cc:1032
Chute::inflowHeight_
Mdouble inflowHeight_
Height of inflow.
Definition: Chute.h:342
InfiniteWall::set
void set(Vec3D normal, Vec3D point)
Defines a standard wall, given an outward normal vector s.t. normal*x=normal*point for all x of the w...
Definition: InfiniteWall.cc:118
mathsFunc::cubic
T cubic(const T val)
calculates the cube of a number
Definition: ExtendedMath.h:115
Chute::getChuteWidth
Mdouble getChuteWidth() const
Returns the chute width (Y-direction)
Definition: Chute.cc:976
Chute::maxInflowParticleRadius_
Mdouble maxInflowParticleRadius_
maximal radius of inflowing particles
Definition: Chute.h:330
Chute::getInflowParticleRadius
Mdouble getInflowParticleRadius() const
Returns the average radius of inflow particles.
Definition: Chute.cc:856
DPMBase::getXMin
Mdouble getXMin() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMin() returns XMin.
Definition: DPMBase.h:600
mathsFunc::cos
Mdouble cos(Mdouble x)
Definition: ExtendedMath.cc:64
BaseInteractable::getPosition
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
Definition: BaseInteractable.h:218
DPMBase::getTimeMax
Mdouble getTimeMax() const
Returns the maximum simulation duration.
Definition: DPMBase.cc:885