|
MercuryDPM
Alpha
|
|
MercuryDPM
Alpha
|
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[]) |
| 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 () |
| Creates bottom, side walls and a particle insertion boundary. More... | |
| void | read (std::istream &is) |
| Reads all chute properties from an istream. More... | |
| void | write (std::ostream &os, bool writeAllParticles=true) const |
| 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... | |
| int | getNCreated () const |
| void | increaseNCreated () |
| void | setInsertionBoundary (InsertionBoundary *insertionBoundary) |
| Sets the chute insertion boundary. More... | |
| Public Member Functions inherited from Mercury3D | |
| Mercury3D () | |
| This is the default constructor. All it does is set sensible defaults. More... | |
| Mercury3D (const DPMBase &other) | |
| Copy-constructor for creates an Mercury3D problem from an existing MD problem. More... | |
| Mercury3D (const Mercury3D &other) | |
| Copy-constructor. More... | |
| void | constructor () |
| Function that sets the SystemDimension and ParticleDimension to 3. More... | |
| Public Member Functions inherited from MercuryBase | |
| MercuryBase () | |
| This is the default constructor. It sets sensible defaults. More... | |
| ~MercuryBase () | |
| This is the default destructor. More... | |
| MercuryBase (const MercuryBase &mercuryBase) | |
| Copy-constructor. More... | |
| void | constructor () |
| This is the actual constructor, it is called do both constructors above. More... | |
| void | hGridActionsBeforeTimeLoop () override |
| This sets up the broad phase information, has to be done at this stage because it requires the particle size. More... | |
| void | hGridActionsBeforeTimeStep () override |
| Performs all necessary actions before a time-step, like updating the particles and resetting all the bucket information, etc. More... | |
| void | read (std::istream &is) override |
| Reads the MercuryBase from an input stream, for example a restart file. More... | |
| void | write (std::ostream &os, bool writeAllParticles=true) const override |
| Writes the MercuryBase to an output stream, for example a restart file. More... | |
| Mdouble | getHGridCurrentMaxRelativeDisplacement () const |
| Returns hGridCurrentMaxRelativeDisplacement_. More... | |
| Mdouble | getHGridTotalCurrentMaxRelativeDisplacement () const |
| Returns hGridTotalCurrentMaxRelativeDisplacement_. More... | |
| void | setHGridUpdateEachTimeStep (bool updateEachTimeStep) |
| Sets whether or not the HGrid must be updated every time step. More... | |
| bool | getHGridUpdateEachTimeStep () const override |
| Gets whether or not the HGrid is updated every time step. More... | |
| void | setHGridMaxLevels (unsigned int HGridMaxLevels) |
| Sets the maximum number of levels of the HGrid in this MercuryBase. More... | |
| unsigned int | getHGridMaxLevels () const |
| Gets the maximum number of levels of the HGrid in this MercuryBase. More... | |
| HGridMethod | getHGridMethod () const |
| Gets whether the HGrid in this MercuryBase is BOTTOMUP or TOPDOWN. More... | |
| void | setHGridMethod (HGridMethod hGridMethod) |
| Sets the HGridMethod to either BOTTOMUP or TOPDOWN. More... | |
| HGridDistribution | getHGridDistribution () const |
| Gets how the sizes of the cells of different levels are distributed. More... | |
| void | setHGridDistribution (HGridDistribution hGridDistribution) |
| Sets how the sizes of the cells of different levels are distributed. More... | |
| Mdouble | getHGridCellOverSizeRatio () const |
| Gets the ratio of the smallest cell over the smallest particle. More... | |
| void | setHGridCellOverSizeRatio (Mdouble cellOverSizeRatio) |
| Sets the ratio of the smallest cell over the smallest particle. More... | |
| bool | hGridNeedsRebuilding () |
| Gets if the HGrid needs rebuilding before anything else happens. More... | |
| virtual unsigned int | getHGridTargetNumberOfBuckets () const |
| Gets the desired number of buckets, which is the maximum of the number of particles and 10. More... | |
| virtual Mdouble | getHGridTargetMinInteractionRadius () const |
| Gets the desired size of the smallest cells of the HGrid. More... | |
| virtual Mdouble | getHGridTargetMaxInteractionRadius () const |
| Gets the desired size of the largest cells of the HGrid. More... | |
| bool | checkParticleForInteraction (const BaseParticle &P) override |
| Checks if given BaseParticle has an interaction with a BaseWall or other BaseParticle. More... | |
| bool | checkParticleForInteractionLocal (const BaseParticle &P) override |
| virtual Mdouble | userHGridCellSize (unsigned int level) |
| Virtual function that enables inheriting classes to implement a function to let the user set the cell size of the HGrid. More... | |
| void | hGridInfo () const |
| Writes the info of the HGrid to the screen in a nice format. More... | |
| Public Member Functions inherited from DPMBase | |
| void | constructor () |
| A function which initialises the member variables to default values, so that the problem can be solved off the shelf; sets up a basic two dimensional problem which can be solved off the shelf. It is called in the constructor DPMBase(). More... | |
| DPMBase () | |
| Constructor that calls the "void constructor()". More... | |
| DPMBase (const FilesAndRunNumber &other) | |
| Copy constructor type-1. More... | |
| DPMBase (const DPMBase &other) | |
| Copy constructor type-2. More... | |
| virtual | ~DPMBase () |
| virtual destructor More... | |
| void | solve () |
| The work horse of the code. More... | |
| void | checkSettings () |
| Checks if the essentials are set properly to go ahead with solving the problem. More... | |
| virtual void | writeOutputFiles () |
| Writes the simulation data onto all the files i.e. .data, .ene, .fstat ... More... | |
| void | solve (int argc, char *argv[]) |
| The solve function is the work horse of the code with the user input. More... | |
| virtual void | writeXBallsScript () const |
| This writes a script which can be used to load the xballs problem to display the data just generated. More... | |
| virtual double | getInfo (const BaseParticle &P) const |
| A virtual method that allows the user to overrride and set what is written into the info column in the data file. By default it returns the Species ID number. More... | |
| virtual void | writeRestartFile () |
| Stores all the particle data for current save time step. Calls the write function. More... | |
| bool | readRestartFile (bool restarted=true) |
| Reads all the particle data corresponding to the current saved time step. Which is what the restart file basically stores. The problem description with the latest particle data. Returns 0 if it is successful, 1 otherwise. More... | |
| int | readRestartFile (std::string fileName) |
| The same as readRestartFile(bool), but also reads all the particle data corresponding to the current saved time step. More... | |
| virtual bool | readUserDefinedWall (std::string type, std::istream &is) |
| 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 (const std::string fileName, unsigned int format=0) |
| This allows particle data to be reloaded from data files. More... | |
| bool | readParAndIniFiles (const std::string fileName) |
| Allows the user to read par.ini files (useful to read MDCLR files) More... | |
| bool | readNextDataFile (unsigned int format=0) |
| Reads the next data file with default format=0. However, one can modify the format based on whether the particle data corresponds to 3D or 2D data. See XBalls/xballs.txt. More... | |
| bool | findNextExistingDataFile (Mdouble tMin, bool verbose=true) |
| Useful when fileType is chosen as Multiple Files or Multiple files with padded. More... | |
| bool | readArguments (int argc, char *argv[]) |
| Can interpret main function input arguments that are passed by the driver codes. More... | |
| bool | checkParticleForInteractionLocalPeriodic (const BaseParticle &P) |
| Mdouble | getTime () const |
| Access function for the time. More... | |
| unsigned int | getNtimeSteps () const |
| Returns the current counter of time steps. More... | |
| void | setTime (Mdouble time) |
| Access function for the time. More... | |
| void | setTimeMax (Mdouble newTMax) |
| Allows the upper time limit to be changed. More... | |
| Mdouble | getTimeMax () const |
| Allows the user to access the total simulation time during the simulation. Cannot change it though. More... | |
| void | setDoCGAlways (bool newDoCGFlag) |
| void | setRotation (bool newRotFlag) |
| Allows to set the flag for enabling or disabling particle rotation in the simulations. More... | |
| bool | getRotation () const |
| Returns a flag indicating if particle rotation is enabled or disabled. More... | |
| void | setWallsWriteVTK (FileType writeWallsVTK) |
| Allows to set the flag for enabling or disabling particle rotation in the simulations. More... | |
| void | setParticlesWriteVTK (bool writeParticlesVTK) |
| Allows to set the flag for enabling or disabling particle rotation in the simulations. More... | |
| FileType | getWallsWriteVTK () const |
| Returns a flag indicating if particle rotation is enabled or disabled. More... | |
| bool | getParticlesWriteVTK () const |
| Returns a flag indicating if particle rotation is enabled or disabled. More... | |
| bool | getDoCGAlways () const |
| Vec3D | getMin () const |
| Return the "bottom left" corner of the domain, a vector with xMin_, yMin_ and zMin_. More... | |
| Vec3D | getMax () const |
| Return the "upper right" corner of the domain, a vector with xMin_, yMin_ and zMin_. More... | |
| Mdouble | getXMin () const |
| If the length of the problem domain in x-direction is XMax - XMin, then getXMin() returns XMin,. More... | |
| Mdouble | getXMax () const |
| If the length of the problem domain in x-direction is XMax - XMin, then getXMax() returns XMax,. More... | |
| Mdouble | getYMin () const |
| If the length of the problem domain in y-direction is YMax - YMin, then getYMin() returns YMin,. More... | |
| Mdouble | getYMax () const |
| If the length of the problem domain in y-direction is YMax - YMin, then getYMax() returns XMax,. More... | |
| Mdouble | getZMin () const |
| If the length of the problem domain in z-direction is ZMax - ZMin, then getZMin() returns ZMin,. More... | |
| Mdouble | getZMax () const |
| If the length of the problem domain in z-direction is ZMax - ZMin, then getZMax() returns ZMax,. More... | |
| void | setMin (Vec3D min) |
| Sets the values xMin, yMin, zMin of the problem domain, which is [xMin,xMax]x[yMin,yMax]x[zMin,zMax]. More... | |
| void | setMax (Vec3D max) |
| Sets the values xMax, yMax, zMax of the problem domain, which is [xMin,xMax]x[yMin,yMax]x[zMin,zMax]. More... | |
| void | setXMin (Mdouble newXMin) |
| If the length of the problem domain in x-direction is XMax - XMin, this method sets XMin. More... | |
| void | setYMin (Mdouble newYMin) |
| If the length of the problem domain in y-direction is YMax - YMin, this method sets YMin. More... | |
| void | setZMin (Mdouble newZMin) |
| If the length of the problem domain in z-direction is ZMax - ZMin, this method sets ZMin. More... | |
| void | setXMax (Mdouble newXMax) |
| If the length of the problem domain in x-direction is XMax - XMin, this method sets XMax. More... | |
| void | setYMax (Mdouble newYMax) |
| If the length of the problem domain in y-direction is YMax - YMin, this method sets YMax. More... | |
| void | setZMax (Mdouble newZMax) |
| If the length of the problem domain in z-direction is XMax - XMin, this method sets ZMax. More... | |
| int | getAddLarge () const |
| returns the number of large particles that are to be added on restart. More... | |
| int | getAddSmall () const |
| returns the number of small particles that are to be added on restart. More... | |
| void | setAddLarge (int new_addL) |
| sets the number of large particles that are to be added on restart. More... | |
| void | setAddSmall (int new_addS) |
| sets the number of small particles that are to be added on restart. More... | |
| void | setTimeStep (Mdouble newDt) |
| Allows the time step dt to be changed. More... | |
| Mdouble | getTimeStep () const |
| Allows the time step dt to be accessed. More... | |
| void | setXBallsColourMode (int newCMode) |
| Set the xball output mode. More... | |
| int | getXBallsColourMode () const |
| Get the xball colour mode (CMode) More... | |
| void | setXBallsVectorScale (double newVScale) |
| Set the scale of vectors in xballs. More... | |
| double | getXBallsVectorScale () const |
| Returns the scale of vectors used in xballs. More... | |
| void | setXBallsAdditionalArguments (std::string newXBArgs) |
| Set the additional arguments for xballs. More... | |
| std::string | getXBallsAdditionalArguments () const |
| 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) |
| Allows to modify the gravity vector. More... | |
| Vec3D | getGravity () const |
| Returns the gravity vector. More... | |
| void | setDimension (unsigned int newDim) |
| Sets the system and particle dimension. More... | |
| void | setSystemDimensions (unsigned int newDim) |
| Allows for the dimension of the simulation to be changed. More... | |
| unsigned int | getSystemDimensions () const |
| Returns the dimension of the simulation. Note there is also a particle dimension. More... | |
| void | setParticleDimensions (unsigned int particleDimensions) |
| Allows the dimension of the particle (f.e. for mass) to be changed. e.g. discs or spheres. More... | |
| unsigned int | getParticleDimensions () const |
| Returns the particle dimensions. More... | |
| std::string | getRestartVersion () const |
| This is to take into account for different Mercury versions. Returns the version of the restart file. More... | |
| void | setRestartVersion (std::string newRV) |
| Sets restart_version. More... | |
| bool | getRestarted () const |
| Returns the flag denoting if the simulation was restarted or not. More... | |
| void | setRestarted (bool newRestartedFlag) |
| Allows to set the flag stating if the simulation is to be restarted or not. More... | |
| bool | getAppend () const |
| Returns the flag denoting if the append option is on or off. More... | |
| void | setAppend (bool newAppendFlag) |
| Allows to set the append option. More... | |
| Mdouble | getElasticEnergy () const |
| Returns the global elastic energy within the system. More... | |
| Mdouble | getKineticEnergy () const |
| Returns the global kinetic energy stored in the system. More... | |
| Mdouble | getGravitationalEnergy () const |
| Returns the global gravitational potential energy stored in the system. More... | |
| bool | areInContact (const BaseParticle *pI, const BaseParticle *pJ) const |
| Checks if two particle are in contact or is there any positive overlap. More... | |
| virtual void | hGridInsertParticle (BaseParticle *obj UNUSED) |
| no implementation but can be overidden in its derived classes. More... | |
| virtual void | hGridUpdateParticle (BaseParticle *obj UNUSED) |
| no implementation but can be overidden in its derived classes. More... | |
| virtual void | hGridRemoveParticle (BaseParticle *obj UNUSED) |
| no implementation but can be overidden in its derived classes. More... | |
| virtual void | gatherContactStatistics (unsigned int index1 UNUSED, int index2 UNUSED, Vec3D Contact UNUSED, Mdouble delta UNUSED, Mdouble ctheta UNUSED, Mdouble fdotn UNUSED, Mdouble fdott UNUSED, Vec3D P1_P2_normal_ UNUSED, Vec3D P1_P2_tangential UNUSED) |
| //Not unsigned index because of possible wall collisions. More... | |
| Public Member Functions inherited from FilesAndRunNumber | |
| FilesAndRunNumber () | |
| Constructor. More... | |
| FilesAndRunNumber (const FilesAndRunNumber &other) | |
| Copy constructor. More... | |
| virtual | ~FilesAndRunNumber () |
| Constructor. More... | |
| void | constructor () |
| a function called by the FilesAndRunNumber() (constructor) More... | |
| void | incrementRunNumberInFile () |
| Increment the run Number (counter value) stored in the file_counter (COUNTER_DONOTDEL) by 1 and store the new value in the counter file. More... | |
| int | readRunNumberFromFile () |
| Read the run number or the counter from the counter file (COUNTER_DONOTDEL) More... | |
| void | autoNumber () |
| The autoNumber() function is the trigger. It calls three functions. setRunNumber(), readRunNumberFromFile() and incrementRunNumberInFile(). More... | |
| std::vector< int > | get2DParametersFromRunNumber (int size_x, int size_y) |
| This turns a counter into two indices which is an amazing feature for doing two dimensional parameter studies. The indices run from 1:size_x and 1:size_y, while the study number starts at 0 ( initially the counter=1 in COUNTER_DONOTDEL) More... | |
| int | launchNewRun (const char *name, bool quick=false) |
| This launches a code from within this code. Please pass the name of the code to run. More... | |
| void | setRunNumber (int runNumber) |
| This sets the counter/Run number, overriding the defaults. More... | |
| int | getRunNumber () const |
| This returns the current value of the counter (runNumber_) More... | |
| void | read (std::istream &is) |
| Accepts an input stream std::istream. More... | |
| void | write (std::ostream &os) const |
| Accepts an output stream read function, which accepts an input stream std::ostream. More... | |
| Public Member Functions inherited from Files | |
| Files () | |
| A constructor. More... | |
| virtual | ~Files () |
| A destructor, watch out its a virtual destructor. More... | |
| Files (const Files &other) | |
| Copy constructor. More... | |
| MERCURY_DEPRECATED File & | getDataFile () |
| The non const version. Allows one to edit the File::dataFile. More... | |
| MERCURY_DEPRECATED File & | getEneFile () |
| The non const version. Allows to edit the File::eneFile. More... | |
| MERCURY_DEPRECATED File & | getFStatFile () |
| The non const version. Allows to edit the File::fStatFile. More... | |
| MERCURY_DEPRECATED File & | getRestartFile () |
| The non const version. Allows to edit the File::restartFile. More... | |
| MERCURY_DEPRECATED File & | getStatFile () |
| The non const version. Allows to edit the File::statFile. More... | |
| MERCURY_DEPRECATED const File & | getDataFile () const |
| The const version. Does not allow for any editing of the File::dataFile. More... | |
| MERCURY_DEPRECATED const File & | getEneFile () const |
| The const version. Does not allow for any editing of the File::eneFile. More... | |
| MERCURY_DEPRECATED const File & | getFStatFile () const |
| The const version. Does not allow for any editing of the File::fStatFile. More... | |
| MERCURY_DEPRECATED const File & | getRestartFile () const |
| The const version. Does not allow for any editing of the File::restartFile. More... | |
| MERCURY_DEPRECATED const File & | getStatFile () const |
| The const version. Does not allow for any editing of the File::statFile. More... | |
| const std::string & | getName () const |
| Returns the name of the file. Does not allow to change it though. More... | |
| void | setName (const std::string &name) |
| Allows to set the name of all the files (ene, data, fstat, restart, stat) More... | |
| void | setName (const char *name) |
| Calls setName(std::string) More... | |
| void | setSaveCount (unsigned int saveCount) |
| Sets File::saveCount_ for all files (ene, data, fstat, restart, stat) More... | |
| void | setFileType (FileType fileType) |
| Sets File::fileType_ for all files (ene, data, fstat, restart, stat) More... | |
| void | setOpenMode (std::fstream::openmode openMode) |
| Sets File::openMode_ for all files (ene, data, fstat, restart, stat) More... | |
| void | resetFileCounter () |
| Resets the file counter for each file i.e. for ene, data, fstat, restart, stat) More... | |
| void | read (std::istream &is) |
| Extracts data from the input stream (which is basically a file you want to read from) into name_, restartFile .... More... | |
| void | write (std::ostream &os) const |
| Writes data into a file from the member variables name_, restartFile, dataFile etc. More... | |
| void | openFiles () |
| Opens all the files (ene, data, fstat, restart, stat) for reading and writing purposes. More... | |
| void | closeFiles () |
| Closes all files (ene, data, fstat, restart, stat) that were opened to read or write. More... | |
| void | setNextSavedTimeStep (unsigned int nextSavedTimeStep) |
| Sets the next time step for all the files (ene, data, fstat, restart, stat) at which the data is to be written or saved. More... | |
Protected Member Functions | |
| void | actionsBeforeTimeStep () |
| Calls Chute::cleanChute(). More... | |
| void | cleanChute () |
| Deletes all outflow particles once every 100 time steps. More... | |
| virtual void | createBottom () |
| Creates the chute bottom, which can be either flat or one of three flavours of rough. More... | |
| void | printTime () const |
| prints time, max time and number of particles More... | |
| Protected Member Functions inherited from Mercury3D | |
| virtual void | hGridFindContactsWithinTargetCell (int x, int y, int z, unsigned int l) |
| Finds contacts between particles in the target cell. More... | |
| virtual void | hGridFindContactsWithTargetCell (int x, int y, int z, unsigned int l, BaseParticle *obj) |
| Finds contacts between the BaseParticle and the target cell. More... | |
| void | hGridFindOneSidedContacts (BaseParticle *obj) override |
| Finds contacts with the BaseParticle; avoids multiple checks. More... | |
| bool | hGridHasContactsInTargetCell (int x, int y, int z, unsigned int l, const BaseParticle *obj) const |
| Tests if the BaseParticle has contacts with other Particles in the target cell. More... | |
| bool | hGridHasParticleContacts (const BaseParticle *obj) override |
| Tests if a BaseParticle has any contacts in the HGrid. More... | |
| void | hGridRemoveParticle (BaseParticle *obj) 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) override |
| Inserts a single Particle to current grid. More... | |
| void | broadPhase (BaseParticle *i) override |
| This checks particles in the HGRID to see if for closer enough for possible contact. More... | |
| void | hGridUpdateMove (BaseParticle *iP, Mdouble move) override |
| Computes the relative displacement of the given BaseParticle and updates the currentMaxRelativeDisplacement_ accordingly. More... | |
| void | hGridActionsBeforeIntegration () override |
| Resets the currentMaxRelativeDisplacement_ to 0. More... | |
| void | hGridActionsAfterIntegration () override |
| Sets the totalCurrentMaxRelativeDisplacement_ as 2*currentMaxRelativeDisplacement_. More... | |
| HGrid * | getHGrid () |
| Gets the HGrid used by this problem. More... | |
| const HGrid * | getHGrid () const |
| Gets the HGrid used by this problem, const version. More... | |
| bool | readNextArgument (int &i, int argc, char *argv[]) override |
| Reads the next command line argument. More... | |
| Protected Member Functions inherited from DPMBase | |
| virtual void | computeAllForces () |
| Computes all the forces acting on the particles by using the setTorque and setForce methods. See BaseInteractible.cc. More... | |
| virtual void | computeInternalForces (BaseParticle *i) |
| Computes the forces between particles (internal in the sense that the sum over all these forces is zero i.e. fully modelled forces) More... | |
| virtual void | computeInternalForces (BaseParticle *P1, BaseParticle *P2) |
| Computes the forces between particles (internal in the sense that the sum over all these forces is zero i.e. fully modelled forces) More... | |
| virtual void | computeExternalForces (BaseParticle *PI) |
| Computes the external forces acting on particles (e.g. gravitational) More... | |
| virtual void | computeForcesDueToWalls (BaseParticle *PI) |
| Computes the forces on the particles due to the walls (normals are outward normals) More... | |
| virtual void | actionsOnRestart () |
| A virtual function where the users can add extra code which is executed only when the code is restarted. More... | |
| virtual void | actionsBeforeTimeLoop () |
| A virtual function. Allows one to carry out any operations before the start of the time loop. More... | |
| virtual void | actionsAfterSolve () |
| A virtual function which allows to define operations to be executed after the solve(). More... | |
| virtual void | actionsAfterTimeStep () |
| A virtual function which allows to define operations to be executed after time step. More... | |
| virtual void | outputXBallsData (std::ostream &os) const |
| This function writes the location of the walls and particles in a format the XBalls program can read. See XBalls/xballs.txt. However, MercuryDPM supports a much better viewer now called Paraview. See the tutorials section in the documentation. More... | |
| virtual void | outputXBallsDataParticle (const unsigned int i, const unsigned int format, std::ostream &os) const |
| This function writes out the particle locations into an output stream in a format the XBalls program can read. More... | |
| virtual void | writeEneHeader (std::ostream &os) const |
| Writes a header with a certain format for ENE file. More... | |
| virtual void | writeFstatHeader (std::ostream &os) const |
| Writes a header with a certain format for FStat file. More... | |
| virtual void | writeEneTimestep (std::ostream &os) const |
| This function enables one to write the global energy available in the system after each time step. The default is to compute the rotational and translational kinetic energy, potential energy and the centre of mass. More... | |
| virtual void | initialiseStatistics () |
| no implementation but can be overidden in its derived classes. More... | |
| virtual void | outputStatistics () |
| no implementation but can be overidden in its derived classes. More... | |
| void | gatherContactStatistics () |
| virtual void | processStatistics (bool usethese UNUSED) |
| no implementation but can be overidden in its derived classes. More... | |
| virtual void | finishStatistics () |
| no implementation but can be overidden in its derived classes. More... | |
| virtual void | integrateBeforeForceComputation () |
| This is were the integration is done, at the moment it is velocity Verlet integration and is done before the forces are computed. See http://en.wikipedia.org/wiki/Verlet_integration#Velocity_Verlet. More... | |
| virtual void | integrateAfterForceComputation () |
| Integration is done after force computations. We apply the Velocity verlet scheme. See http://en.wikipedia.org/wiki/Verlet_integration#Velocity_Verlet. More... | |
| virtual void | checkInteractionWithBoundaries () |
| There are a range of boundaries one could implement depending on ones' problem. This methods checks for interactions between particles and such range of boundaries. See BaseBoundary.h and all the boundaries in the Boundaries folder. More... | |
| void | setFixedParticles (unsigned int n) |
| void | initialiseTangentialSprings () |
| virtual bool | continueSolve () const |
| void | outputInteractionDetails () const |
| Displays the interaction details corresponding to the pointer objects in the interaction handler. More... | |
| bool | isTimeEqualTo (Mdouble time) const |
| Checks if the input variable "time" is the current time in the simulation. More... | |
| void | removeDuplicatePeriodicParticles () |
| Removes periodic duplicate Particles. More... | |
| void | checkAndDuplicatePeriodicParticles () |
| In case of periodic boundaries, the below methods checks and adds particles when necessary into the particle handler. See DPMBase.cc and PeriodicBoundary.cc for more details. More... | |
| Mdouble | domainSize () const |
| void | writeVTK () const |
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... | |
| InsertionBoundary * | insertionBoundary_ |
| (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 Attributes inherited from DPMBase | |
| SpeciesHandler | speciesHandler |
| A handler to that stores the species type i.e. elastic, linear visco-elastic... et cetera. More... | |
| RNG | random |
| This is a random generator, often used for setting up the initial conditions etc... More... | |
| ParticleHandler | particleHandler |
| An object of the class ParticleHandler, contains the pointers to all the particles created. More... | |
| WallHandler | wallHandler |
| An object of the class WallHandler. Contains pointers to all the walls created. More... | |
| BoundaryHandler | boundaryHandler |
| An object of the class BoundaryHandler which concerns insertion and deletion of particles into or from regions. More... | |
| InteractionHandler | interactionHandler |
| An object of the class InteractionHandler. More... | |
| Public Attributes inherited from Files | |
| File | dataFile |
| An instance of class File to handle in- and output into a .data file. More... | |
| File | fStatFile |
| An instance of class File to handle in- and output into a .fstat file. More... | |
| File | eneFile |
| An instance of class File to handle in- and output into a .ene file. More... | |
| File | restartFile |
| An instance of class File to handle in- and output into a .restart file. More... | |
| File | statFile |
| An instance of class File to handle in- and output into a .stat file. More... | |
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.
| Chute::Chute | ( | ) |
This is the default constructor. All it does is set sensible defaults.
Default constructor.
Definition at line 42 of file Chute.cc.
References constructor(), DEBUG, and logger.
| Chute::Chute | ( | const DPMBase & | other | ) |
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.
| [in] | other | object of DPMBase class |
Definition at line 55 of file Chute.cc.
References constructor(), DEBUG, and logger.
| Chute::Chute | ( | const MercuryBase & | other | ) |
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.
| [in] | other | object of MercuryBase class |
Definition at line 69 of file Chute.cc.
References constructor(), DEBUG, and logger.
| Chute::Chute | ( | const Mercury3D & | other | ) |
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.
| [in] | other | object of DPMBase class |
Definition at line 83 of file Chute.cc.
References constructor(), DEBUG, and logger.
| 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.
| [in] | other | Chute object to be copied |
Definition at line 96 of file Chute.cc.
|
protectedvirtual |
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.
Definition at line 223 of file Chute.cc.
References 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.
Definition at line 443 of file Chute.cc.
References DEBUG, BaseHandler< T >::getNumberOfObjects(), BaseHandler< T >::getObject(), BaseInteractable::getPosition(), DPMBase::getXMax(), DPMBase::getXMin(), logger, DPMBase::particleHandler, ParticleHandler::removeObject(), and Vec3D::X.
Referenced by actionsBeforeTimeStep().
| 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.
Definition at line 118 of file Chute.cc.
References insertionBoundary_, isChutePeriodic_, MONOLAYER_DISORDERED, setChuteAngle(), setFixedParticleRadius(), setInflowHeight(), setInflowParticleRadius(), setInflowVelocity(), setInflowVelocityVariance(), setMaxFailed(), and setRoughBottomType().
Referenced by Chute().
|
protectedvirtual |
Creates the chute bottom, which can be either flat or one of three flavours of rough.
Creates the bottom of the chute; either:
Definition at line 316 of file Chute.cc.
References MercuryBase::checkParticleForInteraction(), BaseHandler< T >::copyAndAddObject(), FLAT, getFixedParticleRadius(), BaseHandler< T >::getObject(), BaseParticle::getRadius(), RNG::getRandomNumber(), DPMBase::getXMax(), DPMBase::getXMin(), DPMBase::getYMax(), DPMBase::getYMin(), DPMBase::getZMin(), MercuryBase::hGridActionsBeforeTimeLoop(), MercuryBase::hGridActionsBeforeTimeStep(), INFO, logger, ChuteBottom::makeRoughBottom(), MONOLAYER_DISORDERED, MONOLAYER_ORDERED, DPMBase::particleHandler, DPMBase::random, roughBottomType_, InfiniteWall::set(), BaseParticle::setHandler(), setInflowParticleRadius(), BaseInteractable::setPosition(), BaseParticle::setRadius(), BaseWall::setSpecies(), BaseParticle::setSpecies(), BaseInteractable::setVelocity(), DPMBase::speciesHandler, DPMBase::wallHandler, Vec3D::X, and Vec3D::Y.
Referenced by ChuteBottom::setupInitialConditions(), setupInitialConditions(), and ChuteWithHopper::setupInitialConditions().
| Mdouble Chute::getChuteAngle | ( | ) | const |
Returns the chute angle (in radians)
Returns the chute angle (as compared to the horizontal plane) in RADIANS
Definition at line 711 of file Chute.cc.
References chuteAngle_.
Referenced by ChuteWithHopper::addHopper(), ChuteWithHopper::getMaximumVelocityInducedByGravity(), ChuteWithHopper::setHopper(), and ChuteWithHopper::setupInitialConditions().
| Mdouble Chute::getChuteAngleDegrees | ( | ) | const |
Returns the chute angle (in degrees)
Returns the chute angle (as compared to the horizontal plane) in DEGREES
Definition at line 720 of file Chute.cc.
References chuteAngle_, and constants::pi.
| 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.
Definition at line 973 of file Chute.cc.
References DPMBase::getXMax().
| Mdouble Chute::getChuteWidth | ( | ) | const |
Returns the chute width (Y-direction)
Returns the width of the chute. Actually returns yMax_, while it assumes yMin_ to have stayed 0.
Definition at line 953 of file Chute.cc.
References DPMBase::getYMax().
| Mdouble Chute::getFixedParticleRadius | ( | ) | const |
Returns the particle radius of the fixed particles which constitute the (rough) chute bottom.
Returns the radius of the fixed particles at the bottom (in case of a rough bottom; see also Chute::createBottom() ).
Definition at line 603 of file Chute.cc.
References fixedParticleRadius_.
Referenced by createBottom(), ChuteBottom::setupInitialConditions(), and ChuteWithHopper::setupInitialConditions().
| Mdouble Chute::getInflowHeight | ( | ) | const |
Returns the maximum inflow height (Z-direction)
Returns the maximum height at which particles are introduced into the chute
Definition at line 878 of file Chute.cc.
References inflowHeight_.
| Mdouble Chute::getInflowParticleRadius | ( | ) | const |
Returns the average radius of inflow particles.
Returns the mean of the min. and max. inflow particle radius.
Definition at line 833 of file Chute.cc.
References maxInflowParticleRadius_, and minInflowParticleRadius_.
Referenced by ChuteBottom::makeRoughBottom(), and ChuteBottom::setupInitialConditions().
| Mdouble Chute::getInflowVelocity | ( | ) | const |
Returns the average inflow velocity.
Returns the mean velocity at which the particles enter the chute
Definition at line 904 of file Chute.cc.
References inflowVelocity_.
| Mdouble Chute::getInflowVelocityVariance | ( | ) | const |
Returns the inflow velocity variance.
Returns the variance of the velocities of the inflow particles around the mean
Definition at line 933 of file Chute.cc.
References inflowVelocityVariance_.
| 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
Definition at line 574 of file Chute.cc.
References isChutePeriodic_.
| 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.
Definition at line 741 of file Chute.cc.
References maxFailed_.
Referenced by ChuteWithHopper::setupInitialConditions().
| Mdouble Chute::getMaxInflowParticleRadius | ( | ) | const |
Returns the maximum radius of inflow particles.
Returns the maximum inflow particle radius
Definition at line 851 of file Chute.cc.
References maxInflowParticleRadius_.
Referenced by ChuteBottom::makeRoughBottom(), ChuteBottom::setupInitialConditions(), and ChuteWithHopper::setupInitialConditions().
| Mdouble Chute::getMinInflowParticleRadius | ( | ) | const |
returns the minimum radius of inflow particles
returns the minimum inflow particle radius
Definition at line 842 of file Chute.cc.
References minInflowParticleRadius_.
Referenced by ChuteWithHopper::getTimeStepRatio(), ChuteBottom::makeRoughBottom(), ChuteBottom::setupInitialConditions(), and ChuteWithHopper::setupInitialConditions().
| int Chute::getNCreated | ( | ) | const |
| 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.
Definition at line 658 of file Chute.cc.
References roughBottomType_.
| void Chute::increaseNCreated | ( | ) |
| 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
Definition at line 564 of file Chute.cc.
References isChutePeriodic_.
|
protectedvirtual |
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.
Definition at line 233 of file Chute.cc.
References BaseHandler< T >::getNumberOfObjects(), DPMBase::getTime(), DPMBase::getTimeMax(), and DPMBase::particleHandler.
|
virtual |
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.
| [in,out] | is | the istream from which is read, usually a restart file. |
Reimplemented from DPMBase.
Reimplemented in ChuteWithHopper.
Definition at line 139 of file Chute.cc.
References chuteAngle_, fixedParticleRadius_, DPMBase::getRestartVersion(), inflowHeight_, inflowVelocity_, inflowVelocityVariance_, logger, maxFailed_, maxInflowParticleRadius_, minInflowParticleRadius_, constants::pi, MercuryBase::read(), setRoughBottomType(), and WARN.
Referenced by ChuteWithHopper::read().
|
virtual |
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.
| [in] | i | the index of the input parameter to be read |
| [in] | argc | number of input parameters |
| [in] | argv[] | pointer to the (first character of the) actual string of input parameters. |
Reimplemented from DPMBase.
Reimplemented in ChuteWithHopper.
Definition at line 487 of file Chute.cc.
References MercuryBase::readNextArgument(), setChuteAngle(), setChuteLength(), setChuteWidth(), setFixedParticleRadius(), setInflowHeight(), setInflowParticleRadius(), setInflowVelocity(), setMaxFailed(), setRoughBottomType(), and DPMBase::setZMax().
Referenced by ChuteWithHopper::readNextArgument().
| 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.
| [in] | chuteAngle | the angle of the chute relative to the horizontal plane in DEGREES. |
Definition at line 672 of file Chute.cc.
References DPMBase::getGravity(), Vec3D::getLength(), logger, setChuteAngleAndMagnitudeOfGravity(), and WARN.
Referenced by constructor(), ChuteBottom::makeRoughBottom(), and readNextArgument().
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.
| [in] | chuteAngle | the angle of the chute relative to the horizontal plane in DEGREES |
| [in] | gravity | magnitude of the gravity vector |
Definition at line 693 of file Chute.cc.
References chuteAngle_, mathsFunc::cos(), logger, constants::pi, DPMBase::setGravity(), mathsFunc::sin(), and WARN.
Referenced by setChuteAngle().
|
virtual |
Sets the chute length (X-direction)
Sets the length of the chute. Actually sets xMax_, while xMin_ is assumed to have stayed 0.
| [in] | chuteLength | length of the chute |
Reimplemented in ChuteWithHopper.
Definition at line 963 of file Chute.cc.
References DPMBase::setXMax().
Referenced by readNextArgument().
| 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.
| [in] | chuteWidth | width of the chute |
Definition at line 943 of file Chute.cc.
References DPMBase::setYMax().
Referenced by readNextArgument().
| 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() ).
| [in] | fixedParticleRadius | The radius of the fixed particles on the bottom as an MDouble. |
Definition at line 585 of file Chute.cc.
References fixedParticleRadius_, logger, and WARN.
Referenced by constructor(), ChuteBottom::makeRoughBottom(), and readNextArgument().
| 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.
| [in] | inflowHeight | the maximum inflow height to be set |
Definition at line 861 of file Chute.cc.
References inflowHeight_, and DPMBase::setZMax().
Referenced by constructor(), ChuteBottom::makeRoughBottom(), and readNextArgument().
| 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).
| [in] | inflowParticleRadius | the radius of the particles entering the chute |
Definition at line 752 of file Chute.cc.
References logger, maxInflowParticleRadius_, minInflowParticleRadius_, and WARN.
Referenced by constructor(), createBottom(), and readNextArgument().
| 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.
| [in] | minInflowParticleRadius | the minimum radius |
| [in] | maxInflowParticleRadius | the maximum radius |
Definition at line 771 of file Chute.cc.
References logger, maxInflowParticleRadius_, minInflowParticleRadius_, and WARN.
| void Chute::setInflowVelocity | ( | Mdouble | inflowVelocity | ) |
Sets the average inflow velocity.
Sets the mean velocity at which the particles enter the chute
| [in] | inflowVelocity | the mean velocity at which the particles enter the chute |
Definition at line 887 of file Chute.cc.
References inflowVelocity_, logger, and WARN.
Referenced by constructor(), and readNextArgument().
| void Chute::setInflowVelocityVariance | ( | Mdouble | inflowVelocityVariance | ) |
Sets the inflow velocity variance.
Sets the variance of the velocities of the inflow particles around the mean
| [in] | inflowVelocityVariance | the variance of the velocities of the inflow particles around the mean (expressed in ratio of the mean, i.e. the inflowVelocity_). |
Definition at line 914 of file Chute.cc.
References ERROR, inflowVelocityVariance_, and logger.
Referenced by constructor().
| void Chute::setInsertionBoundary | ( | InsertionBoundary * | insertionBoundary | ) |
Sets the chute insertion boundary.
Sets the insertion boundary of the chute.
| [in] | insertionBoundary | the insertion boundary of the chute |
Definition at line 982 of file Chute.cc.
References insertionBoundary_.
Referenced by ChuteWithHopper::setupInitialConditions().
| 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.
| [in] | maxFailed | The number of times that the boundary may fail to insert a particle |
Definition at line 731 of file Chute.cc.
References maxFailed_.
Referenced by constructor(), and readNextArgument().
| void Chute::setMaxInflowParticleRadius | ( | Mdouble | maxInflowParticleRadius | ) |
Sets the maximum radius of inflow particles.
Sets the maximum radius possible of particles entering the chute.
| [in] | maxInflowParticleRadius | the maximum radius |
Definition at line 816 of file Chute.cc.
References logger, maxInflowParticleRadius_, minInflowParticleRadius_, and WARN.
| void Chute::setMinInflowParticleRadius | ( | Mdouble | minInflowParticleRadius | ) |
sets the minimum radius of inflow particles
Sets the minimum radius possible of particles entering the chute.
| [in] | minInflowParticleRadius | the minimum radius |
Definition at line 799 of file Chute.cc.
References logger, maxInflowParticleRadius_, minInflowParticleRadius_, and WARN.
| 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:
| [in] | roughBottomType | The bottom type to be set |
Definition at line 618 of file Chute.cc.
References roughBottomType_.
Referenced by constructor(), ChuteBottom::makeRoughBottom(), read(), and readNextArgument().
| 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.
Definition at line 627 of file Chute.cc.
References FATAL, FLAT, logger, MONOLAYER_ORDERED, and roughBottomType_.
|
virtual |
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.
Definition at line 247 of file Chute.cc.
References DPMBase::boundaryHandler, BaseHandler< T >::copyAndAddObject(), createBottom(), FATAL, fixedParticleRadius_, Files::getName(), BaseHandler< T >::getNumberOfObjects(), BaseHandler< T >::getObject(), DPMBase::getXMax(), DPMBase::getXMin(), DPMBase::getYMax(), DPMBase::getYMin(), DPMBase::getZMax(), DPMBase::getZMin(), inflowVelocity_, inflowVelocityVariance_, insertionBoundary_, logger, maxFailed_, maxInflowParticleRadius_, minInflowParticleRadius_, ChuteInsertionBoundary::set(), BaseParticle::setSpecies(), setupSideWalls(), and DPMBase::speciesHandler.
| 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).
Definition at line 281 of file Chute.cc.
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().
|
virtual |
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.
| [in] | os | the ostream to which the properties have to be written. |
| [in] | writeAllParticles | If TRUE, the properties of ALL particles in the particleHandler are written to the ostream. If FALSE, only the properties of the first two particles in the handler are written to the ostream (see DPMBase::write(std::ostream& os, bool writeAllParticles)). The default value is true. |
Reimplemented from DPMBase.
Reimplemented in ChuteWithHopper.
Definition at line 204 of file Chute.cc.
References chuteAngle_, fixedParticleRadius_, InsertionBoundary::getNumberOfParticlesInserted(), inflowHeight_, inflowVelocity_, inflowVelocityVariance_, insertionBoundary_, maxFailed_, maxInflowParticleRadius_, minInflowParticleRadius_, roughBottomType_, and MercuryBase::write().
Referenced by ChuteWithHopper::write().
|
private |
chute angle in degrees
Definition at line 323 of file Chute.h.
Referenced by getChuteAngle(), getChuteAngleDegrees(), read(), setChuteAngleAndMagnitudeOfGravity(), and write().
|
private |
radius of the fixed particles at the bottom
Definition at line 327 of file Chute.h.
Referenced by getFixedParticleRadius(), read(), setFixedParticleRadius(), setupInitialConditions(), and write().
|
private |
Height of inflow.
Definition at line 347 of file Chute.h.
Referenced by getInflowHeight(), read(), setInflowHeight(), and write().
|
private |
Average inflow velocity in x-direction.
Definition at line 339 of file Chute.h.
Referenced by getInflowVelocity(), read(), setInflowVelocity(), setupInitialConditions(), and write().
|
private |
Inflow velocity variance in x-direction (in ratio of inflowVelocity_)
Definition at line 343 of file Chute.h.
Referenced by getInflowVelocityVariance(), read(), setInflowVelocityVariance(), setupInitialConditions(), and write().
|
private |
(Pointer to) the Chute's insertion boundary
Definition at line 361 of file Chute.h.
Referenced by constructor(), setInsertionBoundary(), setupInitialConditions(), and write().
|
private |
Determines whether the chute has periodic (TRUE) or solid (FALSE) walls in the Y-direction.
Definition at line 366 of file Chute.h.
Referenced by constructor(), getIsPeriodic(), makeChutePeriodic(), and setupSideWalls().
|
private |
indicates how many attempts are made to insert a new particle into the insertion boundary before the boundary is considered filled.
Definition at line 357 of file Chute.h.
Referenced by getMaxFailed(), read(), setMaxFailed(), setupInitialConditions(), and write().
|
private |
maximal radius of inflowing particles
Definition at line 335 of file Chute.h.
Referenced by getInflowParticleRadius(), getMaxInflowParticleRadius(), read(), setInflowParticleRadius(), setMaxInflowParticleRadius(), setMinInflowParticleRadius(), setupInitialConditions(), and write().
|
private |
minimal radius of inflowing particles
Definition at line 331 of file Chute.h.
Referenced by getInflowParticleRadius(), getMinInflowParticleRadius(), read(), setInflowParticleRadius(), setMaxInflowParticleRadius(), setMinInflowParticleRadius(), setupInitialConditions(), and write().
|
private |
Determines the type of rough bottom created (if any). See also the enum RoughBottomType at the beginning of this header file.
Definition at line 352 of file Chute.h.
Referenced by createBottom(), getRoughBottomType(), setRoughBottomType(), and write().
1.8.7 
