MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 the MercuryBase to an output stream, for example a restart file. More...
 
Mdouble getHGridCurrentMaxRelativeDisplacement () const
 Returns hGridCurrentMaxRelativeDisplacement_. More...
 
Mdouble getHGridTotalCurrentMaxRelativeDisplacement () const
 Returns hGridTotalCurrentMaxRelativeDisplacement_. More...
 
void setHGridUpdateEachTimeStep (bool updateEachTimeStep)
 Sets whether or not the HGrid must be updated every time step. More...
 
bool getHGridUpdateEachTimeStep () const final
 Gets whether or not the HGrid is updated every time step. More...
 
void setHGridMaxLevels (unsigned int HGridMaxLevels)
 Sets the maximum number of levels of the HGrid in this MercuryBase. More...
 
unsigned int getHGridMaxLevels () const
 Gets the maximum number of levels of the HGrid in this MercuryBase. More...
 
HGridMethod getHGridMethod () const
 Gets whether the HGrid in this MercuryBase is BOTTOMUP or TOPDOWN. More...
 
void setHGridMethod (HGridMethod hGridMethod)
 Sets the HGridMethod to either BOTTOMUP or TOPDOWN. More...
 
HGridDistribution getHGridDistribution () const
 Gets how the sizes of the cells of different levels are distributed. More...
 
void setHGridDistribution (HGridDistribution hGridDistribution)
 Sets how the sizes of the cells of different levels are distributed. More...
 
Mdouble getHGridCellOverSizeRatio () const
 Gets the ratio of the smallest cell over the smallest particle. More...
 
void setHGridCellOverSizeRatio (Mdouble cellOverSizeRatio)
 Sets the ratio of the smallest cell over the smallest particle. More...
 
bool hGridNeedsRebuilding ()
 Gets if the HGrid needs rebuilding before anything else happens. More...
 
virtual unsigned int getHGridTargetNumberOfBuckets () const
 Gets the desired number of buckets, which is the maximum of the number of particles and 10. More...
 
virtual Mdouble getHGridTargetMinInteractionRadius () const
 Gets the desired size of the smallest cells of the HGrid. More...
 
virtual Mdouble getHGridTargetMaxInteractionRadius () const
 Gets the desired size of the largest cells of the HGrid. More...
 
bool checkParticleForInteraction (const BaseParticle &P) final
 Checks if given BaseParticle has an interaction with a BaseWall or other BaseParticle. More...
 
bool checkParticleForInteractionLocal (const BaseParticle &P) final
 Checks if the given BaseParticle has an interaction with a BaseWall or other BaseParticles in a local domain. More...
 
virtual Mdouble userHGridCellSize (unsigned int level)
 Virtual function that enables inheriting classes to implement a function to let the user set the cell size of the HGrid. More...
 
void hGridInfo (std::ostream &os=std::cout) const
 Writes the info of the HGrid to the screen in a nice format. More...
 
- Public Member Functions inherited from DPMBase
void constructor ()
 A function which initialises the member variables to default values, so that the problem can be solved off the shelf; sets up a basic two dimensional problem which can be solved off the shelf. It is called in the constructor DPMBase(). More...
 
 DPMBase ()
 Constructor that calls the "void constructor()". More...
 
 DPMBase (const DPMBase &other)
 Copy constructor type-2. More...
 
virtual ~DPMBase ()
 virtual destructor More...
 
void autoNumber ()
 The autoNumber() function calls three functions: setRunNumber(), readRunNumberFromFile() and incrementRunNumberInFile(). More...
 
std::vector< int > get1DParametersFromRunNumber (int size_x) const
 This turns a counter into 1 index, which is a useful feature for performing 1D parameter study. The index run from 1:size_x, while the study number starts at 0 (initially the counter=1 in COUNTER_DONOTDEL) More...
 
std::vector< int > get2DParametersFromRunNumber (int size_x, int size_y) const
 This turns a counter into 2 indices which is a very useful feature for performing a 2D study. The indices run from 1:size_x and 1:size_y, while the study number starts at 0 ( initially the counter=1 in COUNTER_DONOTDEL) More...
 
std::vector< int > get3DParametersFromRunNumber (int size_x, int size_y, int size_z) const
 This turns a counter into 3 indices, which is a useful feature for performing a 3D parameter study. The indices run from 1:size_x, 1:size_y and 1:size_z, while the study number starts at 0 ( initially the counter=1 in COUNTER_DONOTDEL) More...
 
int launchNewRun (const char *name, bool quick=false)
 This launches a code from within this code. Please pass the name of the code to run. More...
 
void setRunNumber (int runNumber)
 This sets the counter/Run number, overriding the defaults. More...
 
int getRunNumber () const
 This returns the current value of the counter (runNumber_) More...
 
virtual void decompose ()
 Sends particles from processorId to the root processor. More...
 
void solve ()
 The work horse of the code. More...
 
virtual void computeOneTimeStep ()
 Performs everything needed for one time step, used in the time-loop of solve(). More...
 
void checkSettings ()
 Checks if the essentials are set properly to go ahead with solving the problem. More...
 
void forceWriteOutputFiles ()
 Writes output files immediately, even if the current time step was not meant to be written. Also resets the last saved time step. More...
 
virtual void writeOutputFiles ()
 Writes simulation data to all the main Mercury files: .data, .ene, .fstat, .xballs and .restart (see the Mercury website for more details regarding these files). More...
 
void solve (int argc, char *argv[])
 The work horse of the code. Can handle flags from the command line. More...
 
virtual void writeXBallsScript () const
 This writes a script which can be used to load the xballs problem to display the data just generated. More...
 
virtual Mdouble getInfo (const BaseParticle &P) const
 A virtual function that returns some user-specified information about a particle. More...
 
ParticleVtkWritergetVtkWriter () const
 
virtual void writeRestartFile ()
 Stores all the particle data for current save time step to a "restart" file, which is a file simply intended to store all the information necessary to "restart" a simulation from a given time step (see also MercuryDPM.org for more information on restart files). More...
 
void writeDataFile ()
 
void writeEneFile ()
 
void writeFStatFile ()
 
void fillDomainWithParticles (unsigned N=50)
 Inserts particles in the whole domain. More...
 
bool readRestartFile (ReadOptions opt=ReadOptions::ReadAll)
 Reads all the particle data corresponding to a given, existing . restart file (for more details regarding restart files, refer to the training materials on the MercuryDPM website).Returns true if it is successful, false otherwise. More...
 
int readRestartFile (std::string fileName, ReadOptions opt=ReadOptions::ReadAll)
 The same as readRestartFile(bool), but also reads all the particle data corresponding to the current saved time step. More...
 
virtual BaseWallreadUserDefinedWall (const std::string &type) const
 Allows you to read in a wall defined in a Driver directory; see USER/Luca/ScrewFiller. More...
 
virtual void readOld (std::istream &is)
 Reads all data from a restart file, e.g. domain data and particle data; old version. More...
 
bool readDataFile (std::string fileName="", unsigned int format=0)
 This allows particle data to be reloaded from data files. More...
 
bool readParAndIniFiles (std::string fileName)
 Allows the user to read par.ini files (useful to read files produced by the MDCLR simulation code - external to MercuryDPM) More...
 
bool readNextDataFile (unsigned int format=0)
 Reads the next data file with default format=0. However, one can modify the format based on whether the particle data corresponds to 3D or 2D data- see Visualising data in xballs. More...
 
void readNextFStatFile ()
 Reads the next fstat file. More...
 
bool findNextExistingDataFile (Mdouble tMin, bool verbose=true)
 Finds and opens the next data file, if such a file exists. More...
 
bool readArguments (int argc, char *argv[])
 Can interpret main function input arguments that are passed by the driver codes. More...
 
bool checkParticleForInteractionLocalPeriodic (const BaseParticle &P)
 
void readSpeciesFromDataFile (bool read=true)
 
void importParticlesAs (ParticleHandler &particleHandler, InteractionHandler &interactionHandler, const ParticleSpecies *species)
 Copies particles, interactions assigning species from a local simulation to a global one. Useful for the creation of a cluster. More...
 
MERCURY_DEPRECATED FilegetDataFile ()
 The non const version. Allows one to edit the File::dataFile. More...
 
MERCURY_DEPRECATED FilegetEneFile ()
 The non const version. Allows to edit the File::eneFile. More...
 
MERCURY_DEPRECATED FilegetFStatFile ()
 The non const version. Allows to edit the File::fStatFile. More...
 
MERCURY_DEPRECATED FilegetRestartFile ()
 The non const version. Allows to edit the File::restartFile. More...
 
MERCURY_DEPRECATED FilegetStatFile ()
 The non const version. Allows to edit the File::statFile. More...
 
FilegetInteractionFile ()
 Return a reference to the file InteractionsFile. More...
 
MERCURY_DEPRECATED const FilegetDataFile () const
 The const version. Does not allow for any editing of the File::dataFile. More...
 
MERCURY_DEPRECATED const FilegetEneFile () const
 The const version. Does not allow for any editing of the File::eneFile. More...
 
MERCURY_DEPRECATED const FilegetFStatFile () const
 The const version. Does not allow for any editing of the File::fStatFile. More...
 
MERCURY_DEPRECATED const FilegetRestartFile () const
 The const version. Does not allow for any editing of the File::restartFile. More...
 
MERCURY_DEPRECATED const FilegetStatFile () const
 The const version. Does not allow for any editing of the File::statFile. More...
 
const FilegetInteractionFile () const
 
const std::string & getName () const
 Returns the name of the file. Does not allow to change it though. More...
 
void setName (const std::string &name)
 Allows to set the name of all the files (ene, data, fstat, restart, stat) More...
 
void setName (const char *name)
 Calls setName(std::string) More...
 
void setSaveCount (unsigned int saveCount)
 Sets File::saveCount_ for all files (ene, data, fstat, restart, stat) More...
 
void setFileType (FileType fileType)
 Sets File::fileType_ for all files (ene, data, fstat, restart, stat) More...
 
void setOpenMode (std::fstream::openmode openMode)
 Sets File::openMode_ for all files (ene, data, fstat, restart, stat) More...
 
void resetFileCounter ()
 Resets the file counter for each file i.e. for ene, data, fstat, restart, stat) More...
 
void closeFiles ()
 Closes all files (ene, data, fstat, restart, stat) that were opened to read or write. More...
 
void setLastSavedTimeStep (unsigned int nextSavedTimeStep)
 Sets the next time step for all the files (ene, data, fstat, restart, stat) at which the data is to be written or saved. More...
 
Mdouble getTime () const
 Returns the current simulation time. More...
 
Mdouble getNextTime () const
 Returns the current simulation time. More...
 
unsigned int getNumberOfTimeSteps () const
 Returns the current counter of time-steps, i.e. the number of time-steps that the simulation has undergone so far. More...
 
void setTime (Mdouble time)
 Sets a new value for the current simulation time. More...
 
void setTimeMax (Mdouble newTMax)
 Sets a new value for the maximum simulation duration. More...
 
Mdouble getTimeMax () const
 Returns the maximum simulation duration. More...
 
void setLogarithmicSaveCount (Mdouble logarithmicSaveCountBase)
 Sets File::logarithmicSaveCount_ for all files (ene, data, fstat, restart, stat) More...
 
void setRotation (bool rotation)
 Sets whether particle rotation is enabled or disabled. More...
 
bool getRotation () const
 Indicates whether particle rotation is enabled or disabled. More...
 
void setWallsWriteVTK (FileType writeWallsVTK)
 Sets whether walls are written into a VTK file. More...
 
void setWallsWriteVTK (bool)
 Sets whether walls are written into a VTK file. More...
 
void setInteractionsWriteVTK (bool)
 Sets whether interactions are written into a VTK file. More...
 
void setParticlesWriteVTK (bool writeParticlesVTK)
 Sets whether particles are written in a VTK file. More...
 
void setSuperquadricParticlesWriteVTK (bool writeSuperquadricParticlesVTK)
 
FileType getWallsWriteVTK () const
 Returns whether walls are written in a VTK file. More...
 
bool getParticlesWriteVTK () const
 Returns whether particles are written in a VTK file. More...
 
bool getSuperquadricParticlesWriteVTK () const
 
Mdouble getXMin () const
 If the length of the problem domain in x-direction is XMax - XMin, then getXMin() returns XMin. More...
 
Mdouble getXMax () const
 If the length of the problem domain in x-direction is XMax - XMin, then getXMax() returns XMax. More...
 
Mdouble getYMin () const
 If the length of the problem domain in y-direction is YMax - YMin, then getYMin() returns YMin. More...
 
Mdouble getYMax () const
 If the length of the problem domain in y-direction is YMax - YMin, then getYMax() returns XMax. More...
 
Mdouble getZMin () const
 If the length of the problem domain in z-direction is ZMax - ZMin, then getZMin() returns ZMin. More...
 
Mdouble getZMax () const
 If the length of the problem domain in z-direction is ZMax - ZMin, then getZMax() returns ZMax. More...
 
Vec3D getMin () const
 
Vec3D getMax () const
 
void setXMin (Mdouble newXMin)
 Sets the value of XMin, the lower bound of the problem domain in the x-direction. More...
 
void setYMin (Mdouble newYMin)
 Sets the value of YMin, the lower bound of the problem domain in the y-direction. More...
 
void setZMin (Mdouble newZMin)
 Sets the value of ZMin, the lower bound of the problem domain in the z-direction. More...
 
void setXMax (Mdouble newXMax)
 Sets the value of XMax, the upper bound of the problem domain in the x-direction. More...
 
void setYMax (Mdouble newYMax)
 Sets the value of YMax, the upper bound of the problem domain in the y-direction. More...
 
void setZMax (Mdouble newZMax)
 Sets the value of ZMax, the upper bound of the problem domain in the z-direction. More...
 
void setMax (const Vec3D &max)
 Sets the maximum coordinates of the problem domain. More...
 
void setMax (Mdouble, Mdouble, Mdouble)
 Sets the maximum coordinates of the problem domain. More...
 
void setDomain (const Vec3D &min, const Vec3D &max)
 Sets the minimum coordinates of the problem domain. More...
 
void setMin (const Vec3D &min)
 Sets the minimum coordinates of the problem domain. More...
 
void setMin (Mdouble, Mdouble, Mdouble)
 Sets the minimum coordinates of the problem domain. More...
 
void setTimeStep (Mdouble newDt)
 Sets a new value for the simulation time step. More...
 
Mdouble getTimeStep () const
 Returns the simulation time step. More...
 
void setNumberOfOMPThreads (int numberOfOMPThreads)
 
int getNumberOfOMPThreads () const
 
void setXBallsColourMode (int newCMode)
 Set the xballs output mode. More...
 
int getXBallsColourMode () const
 Get the xballs colour mode (CMode). More...
 
void setXBallsVectorScale (double newVScale)
 Set the scale of vectors in xballs. More...
 
double getXBallsVectorScale () const
 Returns the scale of vectors used in xballs. More...
 
void setXBallsAdditionalArguments (std::string newXBArgs)
 Set the additional arguments for xballs. More...
 
std::string getXBallsAdditionalArguments () const
 Returns the additional arguments for xballs. More...
 
void setXBallsScale (Mdouble newScale)
 Sets the scale of the view (either normal, zoom in or zoom out) to display in xballs. The default is fit to screen. More...
 
double getXBallsScale () const
 Returns the scale of the view in xballs. More...
 
void setGravity (Vec3D newGravity)
 Sets a new value for the gravitational acceleration. More...
 
Vec3D getGravity () const
 Returns the gravitational acceleration. More...
 
void setDimension (unsigned int newDim)
 Sets both the system dimensions and the particle dimensionality. More...
 
void setSystemDimensions (unsigned int newDim)
 Sets the system dimensionality. More...
 
unsigned int getSystemDimensions () const
 Returns the system dimensionality. More...
 
void setParticleDimensions (unsigned int particleDimensions)
 Sets the particle dimensionality. More...
 
unsigned int getParticleDimensions () const
 Returns the particle dimensionality. More...
 
std::string getRestartVersion () const
 This is to take into account for different Mercury versions. Returns the version of the restart file. More...
 
void setRestartVersion (std::string newRV)
 Sets restart_version. More...
 
bool getRestarted () const
 Returns the flag denoting if the simulation was restarted or not. More...
 
void setRestarted (bool newRestartedFlag)
 Allows to set the flag stating if the simulation is to be restarted or not. More...
 
bool getAppend () const
 Returns whether the "append" option is on or off. More...
 
void setAppend (bool newAppendFlag)
 Sets whether the "append" option is on or off. More...
 
Mdouble getElasticEnergy () const
 Returns the global elastic energy within the system. More...
 
Mdouble getKineticEnergy () const
 Returns the global kinetic energy stored in the system. More...
 
Mdouble getGravitationalEnergy () const
 Returns the global gravitational potential energy stored in the system. More...
 
Mdouble getRotationalEnergy () const
 JMFT Returns the global rotational energy stored in the system. More...
 
Mdouble getTotalEnergy () const
 
Mdouble getTotalMass () const
 JMFT: Return the total mass of the system, excluding fixed particles. More...
 
Vec3D getCentreOfMass () const
 JMFT: Return the centre of mass of the system, excluding fixed particles. More...
 
Vec3D getTotalMomentum () const
 JMFT: Return the total momentum of the system, excluding fixed particles. More...
 
virtual void hGridInsertParticle (BaseParticle *obj UNUSED)
 
virtual void hGridUpdateParticle (BaseParticle *obj UNUSED)
 
virtual void hGridRemoveParticle (BaseParticle *obj UNUSED)
 
bool mpiIsInCommunicationZone (BaseParticle *particle)
 Checks if the position of the particle is in an mpi communication zone or not. More...
 
bool mpiInsertParticleCheck (BaseParticle *P)
 Function that checks if the mpi particle should really be inserted by the current domain. More...
 
void insertGhostParticle (BaseParticle *P)
 This function inserts a particle in the mpi communication boundaries. More...
 
void updateGhostGrid (BaseParticle *P)
 Checks if the Domain/periodic interaction distance needs to be updated and updates it accordingly. More...
 
virtual void gatherContactStatistics (unsigned int index1, int index2, Vec3D Contact, Mdouble delta, Mdouble ctheta, Mdouble fdotn, Mdouble fdott, Vec3D P1_P2_normal_, Vec3D P1_P2_tangential)
 //Not unsigned index because of possible wall collisions. More...
 
void setNumberOfDomains (std::vector< unsigned > direction)
 Sets the number of domains in x-,y- and z-direction. Required for parallel computations. More...
 
void splitDomain (DomainSplit domainSplit)
 
std::vector< unsignedgetNumberOfDomains ()
 returns the number of domains More...
 
DomaingetCurrentDomain ()
 Function that returns a pointer to the domain corresponding to the processor. More...
 
void removeOldFiles () const
 
void setMeanVelocity (Vec3D V_mean_goal)
 This function will help you set a fixed kinetic energy and mean velocity in your system. More...
 
void setMeanVelocityAndKineticEnergy (Vec3D V_mean_goal, Mdouble Ek_goal)
 This function will help you set a fixed kinetic energy and mean velocity in your system. More...
 
Mdouble getTotalVolume () const
 Get the total volume of the cuboid system. More...
 
Matrix3D getKineticStress () const
 Calculate the kinetic stress tensor in the system averaged over the whole volume. More...
 
Matrix3D getStaticStress () const
 Calculate the static stress tensor in the system averaged over the whole volume. More...
 
Matrix3D getTotalStress () const
 Calculate the total stress tensor in the system averaged over the whole volume. More...
 
void writePythonFileForVTKVisualisation () const
 record when the simulation started More...
 

Protected Member Functions

void actionsBeforeTimeStep () override
 Calls Chute::cleanChute(). More...
 
void cleanChute ()
 Deletes all outflow particles once every 100 time steps. More...
 
virtual void createBottom ()
 Creates the chute bottom, which can be either flat or one of three flavours of rough. More...
 
virtual void addFlowParticlesCompactly ()
 Add initial flow particles in a dense packing. More...
 
virtual SphericalParticle createFlowParticle ()
 
void printTime () const override
 prints time, max time and number of particles More...
 
- Protected Member Functions inherited from Mercury3D
void hGridFindContactsWithinTargetCell (int x, int y, int z, unsigned int l)
 Finds contacts between particles in the target cell. More...
 
void hGridFindContactsWithTargetCell (int x, int y, int z, unsigned int l, BaseParticle *obj)
 Finds contacts between the BaseParticle and the target cell. More...
 
void computeWallForces (BaseWall *w) override
 Compute contacts with a wall. More...
 
void hGridFindParticlesWithTargetCell (int x, int y, int z, unsigned int l, BaseParticle *obj, std::vector< BaseParticle * > &list)
 Finds particles within target cell and stores them in a list. More...
 
void hGridGetInteractingParticleList (BaseParticle *obj, std::vector< BaseParticle * > &list) override
 Obtains all neighbour particles of a given object, obtained from the hgrid. More...
 
void computeInternalForces (BaseParticle *obj) override
 Finds contacts with the BaseParticle; avoids multiple checks. More...
 
bool hGridHasContactsInTargetCell (int x, int y, int z, unsigned int l, const BaseParticle *obj) const
 Tests if the BaseParticle has contacts with other Particles in the target cell. More...
 
bool hGridHasParticleContacts (const BaseParticle *obj) override
 Tests if a BaseParticle has any contacts in the HGrid. More...
 
void hGridRemoveParticle (BaseParticle *obj) override
 Removes a BaseParticle from the HGrid. More...
 
void hGridUpdateParticle (BaseParticle *obj) override
 Updates the cell (not the level) of a BaseParticle. More...
 
- Protected Member Functions inherited from MercuryBase
void hGridRebuild ()
 This sets up the parameters required for the contact model. More...
 
void hGridInsertParticle (BaseParticle *obj) final
 Inserts a single Particle to current grid. More...
 
void hGridUpdateMove (BaseParticle *iP, Mdouble move) final
 Computes the relative displacement of the given BaseParticle and updates the currentMaxRelativeDisplacement_ accordingly. More...
 
void hGridActionsBeforeIntegration () override
 Resets the currentMaxRelativeDisplacement_ to 0. More...
 
void hGridActionsAfterIntegration () override
 This function has to be called before integrateBeforeForceComputation. More...
 
HGridgetHGrid ()
 Gets the HGrid used by this problem. More...
 
const HGridgetHGrid () const
 Gets the HGrid used by this problem, const version. More...
 
bool readNextArgument (int &i, int argc, char *argv[]) override
 Reads the next command line argument. More...
 
- Protected Member Functions inherited from DPMBase
virtual void computeAllForces ()
 Computes all the forces acting on the particles using the BaseInteractable::setForce() and BaseInteractable::setTorque() More...
 
virtual void computeInternalForce (BaseParticle *, BaseParticle *)
 Computes the forces between two particles (internal in the sense that the sum over all these forces is zero i.e. fully modelled forces) More...
 
virtual void computeExternalForces (BaseParticle *)
 Computes the external forces, such as gravity, acting on particles. More...
 
void computeForcesDueToWalls (BaseParticle *, BaseWall *)
 Computes the forces on the particles due to the walls (normals are outward normals) More...
 
virtual void actionsOnRestart ()
 A virtual function where the users can add extra code which is executed only when the code is restarted. More...
 
virtual void actionsBeforeTimeLoop ()
 A virtual function. Allows one to carry out any operations before the start of the time loop. More...
 
virtual void actionsAfterSolve ()
 A virtual function which allows to define operations to be executed after the solve(). More...
 
virtual void actionsAfterTimeStep ()
 A virtual function which allows to define operations to be executed after time step. More...
 
void writeVTKFiles () const
 
virtual void outputXBallsData (std::ostream &os) const
 This function writes the location of the walls and particles in a format the XBalls program can read. For more information on the XBalls program, see Visualising data in xballs. More...
 
virtual void outputXBallsDataParticle (unsigned int i, unsigned int format, std::ostream &os) const
 This function writes out the particle locations into an output stream in a format the XBalls program can read. For more information on the XBalls program, see Visualising data in xballs. More...
 
virtual void writeEneHeader (std::ostream &os) const
 Writes a header with a certain format for ENE file. More...
 
virtual void writeFstatHeader (std::ostream &os) const
 Writes a header with a certain format for FStat file. More...
 
virtual void writeEneTimeStep (std::ostream &os) const
 Write the global kinetic, potential energy, etc. in the system. More...
 
virtual void initialiseStatistics ()
 
virtual void outputStatistics ()
 
void gatherContactStatistics ()
 
virtual void processStatistics (bool)
 
virtual void finishStatistics ()
 
virtual void integrateBeforeForceComputation ()
 Update particles' and walls' positions and velocities before force computation. More...
 
virtual void integrateAfterForceComputation ()
 Update particles' and walls' positions and velocities after force computation. More...
 
virtual void checkInteractionWithBoundaries ()
 There are a range of boundaries one could implement depending on ones' problem. This methods checks for interactions between particles and such range of boundaries. See BaseBoundary.h and all the boundaries in the Boundaries folder. More...
 
void setFixedParticles (unsigned int n)
 Sets a number, n, of particles in the particleHandler as "fixed particles". More...
 
virtual bool continueSolve () const
 A virtual function for deciding whether to continue the simulation, based on a user-specified criterion. More...
 
void outputInteractionDetails () const
 Displays the interaction details corresponding to the pointer objects in the interaction handler. More...
 
bool isTimeEqualTo (Mdouble time) const
 Checks whether the input variable "time" is the current time in the simulation. More...
 
void removeDuplicatePeriodicParticles ()
 Removes periodic duplicate Particles. More...
 
void checkAndDuplicatePeriodicParticles ()
 For simulations using periodic boundaries, checks and adds particles when necessary into the particle handler. See DPMBase.cc and PeriodicBoundary.cc for more details. More...
 
void performGhostParticleUpdate ()
 When the Verlet scheme updates the positions and velocities of particles, ghost particles will need an update as wel. Their status will also be updated accordingly. More...
 
void deleteGhostParticles (std::set< BaseParticle * > &particlesToBeDeleted)
 
void synchroniseParticle (BaseParticle *, unsigned fromProcessor=0)
 
void performGhostVelocityUpdate ()
 updates the final time-step velocity of the ghost particles More...
 

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

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.

Definition at line 64 of file Chute.h.

Constructor & Destructor Documentation

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.

43 {
44  constructor();
45  logger(DEBUG, "[Chute::Chute()] constructor finished");
46 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
void constructor()
This is the actual constructor METHOD; it is called by all constructors above (except the default cop...
Definition: Chute.cc:118
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

Definition at line 55 of file Chute.cc.

References constructor(), DEBUG, and logger.

56  : DPMBase(other), Mercury3D(other)
57 {
58  constructor();
59  logger(DEBUG, "[Chute::Chute(const DPMBase& other)] copy constructor finished");
60 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Mercury3D()
This is the default constructor. All it does is set sensible defaults.
Definition: Mercury3D.cc:29
void constructor()
This is the actual constructor METHOD; it is called by all constructors above (except the default cop...
Definition: Chute.cc:118
DPMBase()
Constructor that calls the "void constructor()".
Definition: DPMBase.cc:187
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

Definition at line 69 of file Chute.cc.

References constructor(), DEBUG, and logger.

70  : DPMBase(other), Mercury3D(other)
71 {
72  constructor();
73  logger(DEBUG, "[Chute::Chute(const MercuryBase& other)] copy constructor finished");
74 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Mercury3D()
This is the default constructor. All it does is set sensible defaults.
Definition: Mercury3D.cc:29
void constructor()
This is the actual constructor METHOD; it is called by all constructors above (except the default cop...
Definition: Chute.cc:118
DPMBase()
Constructor that calls the "void constructor()".
Definition: DPMBase.cc:187
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

Definition at line 83 of file Chute.cc.

References constructor(), DEBUG, and logger.

84  : DPMBase(other), Mercury3D(other)
85 {
86  constructor();
87  logger(DEBUG, "[Chute::Chute(const Mercury3D& other) copy constructor finished");
88 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Mercury3D()
This is the default constructor. All it does is set sensible defaults.
Definition: Mercury3D.cc:29
void constructor()
This is the actual constructor METHOD; it is called by all constructors above (except the default cop...
Definition: Chute.cc:118
DPMBase()
Constructor that calls the "void constructor()".
Definition: DPMBase.cc:187
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.

Definition at line 96 of file Chute.cc.

References DEBUG, and logger.

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 }
unsigned int maxFailed_
indicates how many attempts are made to insert a new particle into the insertion boundary before the ...
Definition: Chute.h:352
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Mdouble minInflowParticleRadius_
minimal radius of inflowing particles
Definition: Chute.h:326
bool isChutePeriodic_
Determines whether the chute has periodic (TRUE) or solid (FALSE) walls in the Y-direction.
Definition: Chute.h:361
Mercury3D()
This is the default constructor. All it does is set sensible defaults.
Definition: Mercury3D.cc:29
RoughBottomType roughBottomType_
Determines the type of rough bottom created (if any). See also the enum RoughBottomType at the beginn...
Definition: Chute.h:347
Mdouble inflowVelocity_
Average inflow velocity in x-direction.
Definition: Chute.h:334
Mdouble inflowHeight_
Height of inflow.
Definition: Chute.h:342
InsertionBoundary * insertionBoundary_
(Pointer to) the Chute's insertion boundary
Definition: Chute.h:356
Mdouble chuteAngle_
chute angle in degrees
Definition: Chute.h:318
Mdouble fixedParticleRadius_
radius of the fixed particles at the bottom
Definition: Chute.h:322
Mdouble inflowVelocityVariance_
Inflow velocity variance in x-direction (in ratio of inflowVelocity_)
Definition: Chute.h:338
DPMBase()
Constructor that calls the "void constructor()".
Definition: DPMBase.cc:187
Mdouble maxInflowParticleRadius_
maximal radius of inflowing particles
Definition: Chute.h:330

Member Function Documentation

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.

Definition at line 225 of file Chute.cc.

References cleanChute().

226 {
227  cleanChute();
228 }
void cleanChute()
Deletes all outflow particles once every 100 time steps.
Definition: Chute.cc:472
void Chute::addFlowParticlesCompactly ( )
protectedvirtual

Add initial flow particles in a dense packing.

Definition at line 1018 of file Chute.cc.

References MercuryBase::checkParticleForInteraction(), BaseHandler< T >::copyAndAddObject(), createFlowParticle(), mathsFunc::cubic(), DEBUG, getChuteLength(), getChuteWidth(), getInflowHeight(), getInflowParticleRadius(), getMaxInflowParticleRadius(), ParticleHandler::getNumberOfObjects(), BaseHandler< T >::getSize(), INFO, logger, DPMBase::particleHandler, setInflowHeight(), BaseHandler< T >::setStorageCapacity(), and DPMBase::setZMax().

1019 {
1020  logger(INFO, "Adding flowing particles");
1024  setZMax(1.2 * getInflowHeight());
1025  while (particleHandler.getSize() < N)
1026  {
1029  {
1031  }
1032  else
1033  {
1035  }
1036  }
1037  logger(DEBUG, "InflowHeight = %", getInflowHeight());
1038 }
void setInflowHeight(Mdouble inflowHeight)
Sets maximum inflow height (Z-direction)
Definition: Chute.cc:892
virtual SphericalParticle createFlowParticle()
Definition: Chute.cc:1040
A basic particle.
unsigned int getSize() const
Gets the size of the particleHandler (including mpi and periodic particles)
Definition: BaseHandler.h:655
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
unsigned int getNumberOfObjects() const override
Returns the number of objects in the container. In parallel code this practice is forbidden to avoid ...
void setStorageCapacity(const unsigned int N)
Sets the storage capacity of this BaseHandler.
Definition: BaseHandler.h:669
Mdouble getChuteLength() const
Returns the chute length (X-direction)
Definition: Chute.cc:1004
void setZMax(Mdouble newZMax)
Sets the value of ZMax, the upper bound of the problem domain in the z-direction. ...
Definition: DPMBase.cc:1178
T cubic(const T val)
calculates the cube of a number
Definition: ExtendedMath.h:113
Mdouble getInflowParticleRadius() const
Returns the average radius of inflow particles.
Definition: Chute.cc:864
bool checkParticleForInteraction(const BaseParticle &P) final
Checks if given BaseParticle has an interaction with a BaseWall or other BaseParticle.
Definition: MercuryBase.cc:588
Mdouble getMaxInflowParticleRadius() const
Returns the maximum radius of inflow particles.
Definition: Chute.cc:882
Mdouble getChuteWidth() const
Returns the chute width (Y-direction)
Definition: Chute.cc:984
ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created...
Definition: DPMBase.h:1329
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
Mdouble getInflowHeight() const
Returns the maximum inflow height (Z-direction)
Definition: Chute.cc:909
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.

Definition at line 472 of file Chute.cc.

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

Referenced by actionsBeforeTimeStep().

473 {
474  //clean outflow every 100 time steps
475  static int count = 0, maxcount = 100; // please note: static variables are only initialised once, and their values
476  // are stored even after the method returns. I.e., next time the method is
477  // called, the initialisation is ignored and the previously assigned value is used.
478  if (count > maxcount)
479  {
480  // reset counter
481  count = 0;
482 
483  // check all particles
484  for (unsigned int i = 0; i < particleHandler.getNumberOfObjects();)
485  {
486  // check if particle is outside the problem window
489  getXMin()) //||particleHandler.getObject(i)->Position.Z+particleHandler.getObject(i)->Radius<zMin_)
490  {
491  // if so, delete the particle
492  logger(DEBUG, "[Chute::cleanChute()] erased: %", particleHandler.getObject(i));
494  }
495  else
496  {
497  i++;
498  }
499  }
500  }
501  else
502  {
503  count++;
504  }
505 }
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
Mdouble X
the vector components
Definition: Vector.h:65
void removeObject(unsigned int index) override
Removes a BaseParticle from the ParticleHandler.
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
unsigned int getNumberOfObjects() const override
Returns the number of objects in the container. In parallel code this practice is forbidden to avoid ...
Mdouble getXMin() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMin() returns XMin...
Definition: DPMBase.h:586
const std::complex< Mdouble > i
Definition: ExtendedMath.h:50
Mdouble getXMax() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMax() returns XMax...
Definition: DPMBase.h:593
ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created...
Definition: DPMBase.h:1329
T * getObject(const unsigned int id)
Gets a pointer to the Object at the specified index in the BaseHandler.
Definition: BaseHandler.h:613
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().

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 }
void setInflowVelocity(Mdouble inflowVelocity)
Sets the average inflow velocity.
Definition: Chute.cc:918
void setInflowHeight(Mdouble inflowHeight)
Sets maximum inflow height (Z-direction)
Definition: Chute.cc:892
bool isChutePeriodic_
Determines whether the chute has periodic (TRUE) or solid (FALSE) walls in the Y-direction.
Definition: Chute.h:361
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:762
void setChuteAngle(Mdouble chuteAngle)
Sets gravity vector according to chute angle (in degrees)
Definition: Chute.cc:703
void setRoughBottomType(RoughBottomType roughBottomType)
Sets the type of rough bottom of the chute.
Definition: Chute.cc:649
void setInflowParticleRadius(Mdouble inflowParticleRadius)
Sets the radius of the inflow particles to a single one (i.e. ensures a monodisperse inflow)...
Definition: Chute.cc:783
void setInflowVelocityVariance(Mdouble inflowVelocityVariance)
Sets the inflow velocity variance.
Definition: Chute.cc:945
void setFixedParticleRadius(Mdouble fixedParticleRadius)
Sets the particle radius of the fixed particles which constitute the (rough) chute bottom...
Definition: Chute.cc:616
InsertionBoundary * insertionBoundary_
(Pointer to) the Chute's insertion boundary
Definition: Chute.h:356
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.

Definition at line 331 of file Chute.cc.

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(), BaseWall::setSpecies(), BaseParticle::setSpecies(), BaseInteractable::setVelocity(), DPMBase::speciesHandler, DPMBase::wallHandler, Vec3D::X, and Vec3D::Y.

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

332 {
333  // smooth bottom:
334  if (fabs(getFixedParticleRadius()) < 1e-12 || roughBottomType_ == FLAT)
335  {
336  // flat wall as bottom
337  logger(INFO, "[Chute::createBottom()] create perfectly flat chute bottom");
338 
339  //bottom wall
340  InfiniteWall w0;
342  w0.set(Vec3D(0.0, 0.0, -1.0), Vec3D(0, 0, getZMin()));
344  }
345  else //rough bottom
346  {
347  // Define standard fixed particle
357  F0.setPosition(Vec3D(0.0, 0.0, 0.0));
358  F0.setVelocity(Vec3D(0.0, 0.0, 0.0));
359 
361  {
362  // grid-like fixed-particle bottom
363  logger(INFO, "[Chute::createBottom()] create monolayered, ordered rough chute bottom");
364 
365  // allowed space for each particle in each direction
366  Mdouble dx = 2.0 * F0.getRadius();
367  Mdouble dy = 2.0 * F0.getRadius();
368 
369  // number of particles that fit in each direction
370  unsigned int nx = static_cast<unsigned int>(std::max(1, static_cast<int>(std::floor(
371  (getXMax() - getXMin()) / dx))));
372  unsigned int ny = static_cast<unsigned int>(std::max(1, static_cast<int>(std::floor(
373  (getYMax() - getYMin()) / dy))));
374 
375  // adjust particle spacing (in case total space available in given direction
376  // is not a multiple of 2*F0.getRadius() )
377  dx = (getXMax() - getXMin()) / nx;
378  dy = (getYMax() - getYMin()) / ny;
379 
380  for (unsigned int i = 0; i < nx; i++)
381  {
382  for (unsigned int j = 0; j < ny; j++)
383  {
384  // placing of particles on rectangular grid points
385  F0.setPosition(Vec3D(F0.getRadius() + dx * i, F0.getRadius() + dy * j, 0.0));
387  }
388  }
389 
390  //bottom wall, to make sure no particles will fall through the gaps
391  InfiniteWall w0;
393  w0.set(Vec3D(0.0, 0.0, -1.0), Vec3D(0, 0, getZMin() - dx));
395  }
397  {
398  // random fixed-particle bottom
399  logger(INFO, "[Chute::createBottom()] create monolayered disordered rough chute bottom");
400 
401  Vec3D position;
402  position.X = random.getRandomNumber(F0.getRadius(), getXMax() - F0.getRadius());
403  position.Y = random.getRandomNumber(getYMin() + F0.getRadius(), getYMax() - F0.getRadius());
404  F0.setPosition(position);
406 
409 
410  //now add more particles
411  int failed = 0;
412  while (failed < 500)
413  {
414  //The position components are first stored in a Vec3D, because
415  //if you pass them directly into setPosition the compiler is
416  //allowed to change the order in which the numbers are generated
417  position.X = random.getRandomNumber(F0.getRadius(), getXMax() - F0.getRadius());
418  position.Y = random.getRandomNumber(getYMin() + F0.getRadius(), getYMax() - F0.getRadius());
419  F0.setPosition(position);
421  {
423  failed = 0;
424  }
425  else
426  {
427  failed++;
428  }
429  }
430 
431  //bottom wall (create after particle creation, as
432  //checkParticleForInteraction also checks against walls)
433  InfiniteWall w0;
435  w0.set(Vec3D(0.0, 0.0, -1.0), Vec3D(0, 0, getZMin() - .5 * F0.getRadius()));
437  }
438  else //if (roughBottomType_ == MULTILAYER)
439  {
440  // multilayered particle bottom
441  logger(INFO, "[Chute::createBottom()] create multilayered rough chute bottom");
442 
443  //'this' points to the current Chute object, the class of which is inherited
444  // by the ChuteBottom class. I.e., the bottom is created with the particle
445  // properties from the current class.
446  // ChuteBottom::makeRoughBottom() creates a randomly filled, multilayered
447  // chute bottom.
448  ChuteBottom bottom(*this);
449  bottom.setInflowParticleRadius(getFixedParticleRadius());
450  bottom.makeRoughBottom(*this);
451 
452  //bottom wall
453  InfiniteWall w0;
455  w0.set(Vec3D(0.0, 0.0, -1.0), Vec3D(0, 0, getZMin() - bottom.getThickness()));
457  }
458  //finally, fix particles to the bottom
459  for (BaseParticle* const p : particleHandler)
460  {
461  p->fixParticle();
462  }
463  }
464 }
Mdouble X
the vector components
Definition: Vector.h:65
A basic particle.
void setVelocity(const Vec3D &velocity)
set the velocity of the BaseInteractable.
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
double Mdouble
Definition: GeneralDefine.h:34
virtual void setRadius(Mdouble radius)
Sets the particle's radius_ (and adjusts the mass_ accordingly, based on the particle's species) ...
Mdouble getXMin() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMin() returns XMin...
Definition: DPMBase.h:586
const std::complex< Mdouble > i
Definition: ExtendedMath.h:50
Used by Chute::createBottom to create an unordered particle layer.
Definition: ChuteBottom.h:39
void setHandler(ParticleHandler *handler)
Sets the pointer to the particle's ParticleHandler.
Mdouble getYMin() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMin() returns YMin...
Definition: DPMBase.h:599
void setSpecies(const ParticleSpecies *species)
Mdouble getRandomNumber()
This is a random generating routine can be used for initial positions.
Definition: RNG.cc:143
void hGridActionsBeforeTimeStep() override
Performs all necessary actions before a time-step, like updating the particles and resetting all the ...
Definition: MercuryBase.cc:317
Definition: Chute.h:53
Mdouble getXMax() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMax() returns XMax...
Definition: DPMBase.h:593
bool checkParticleForInteraction(const BaseParticle &P) final
Checks if given BaseParticle has an interaction with a BaseWall or other BaseParticle.
Definition: MercuryBase.cc:588
Mdouble getFixedParticleRadius() const
Returns the particle radius of the fixed particles which constitute the (rough) chute bottom...
Definition: Chute.cc:634
ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created...
Definition: DPMBase.h:1329
T * getObject(const unsigned int id)
Gets a pointer to the Object at the specified index in the BaseHandler.
Definition: BaseHandler.h:613
RoughBottomType roughBottomType_
Determines the type of rough bottom created (if any). See also the enum RoughBottomType at the beginn...
Definition: Chute.h:347
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
Mdouble getRadius() const
Returns the particle's radius.
Definition: BaseParticle.h:345
SpeciesHandler speciesHandler
A handler to that stores the species type i.e. LinearViscoelasticSpecies, etc.
Definition: DPMBase.h:1319
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
Mdouble getYMax() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMax() returns XMax...
Definition: DPMBase.h:605
Mdouble Y
Definition: Vector.h:65
WallHandler wallHandler
An object of the class WallHandler. Contains pointers to all the walls created.
Definition: DPMBase.h:1339
RNG random
This is a random generator, often used for setting up the initial conditions etc...
Definition: DPMBase.h:1324
void setPosition(const Vec3D &position)
Sets the position of this BaseInteractable.
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...
Mdouble getZMin() const
If the length of the problem domain in z-direction is ZMax - ZMin, then getZMin() returns ZMin...
Definition: DPMBase.h:611
This is a class defining walls.
Definition: InfiniteWall.h:47
Definition: Vector.h:49
void setSpecies(const ParticleSpecies *species)
Defines the species of the current wall.
Definition: BaseWall.cc:171
SphericalParticle Chute::createFlowParticle ( )
protectedvirtual

Definition at line 1040 of file Chute.cc.

References getFixedParticleRadius(), getInflowHeight(), getMaxInflowParticleRadius(), getMinInflowParticleRadius(), BaseHandler< T >::getObject(), BaseParticle::getRadius(), RNG::getRandomNumber(), DPMBase::getXMax(), DPMBase::getXMin(), DPMBase::getYMax(), DPMBase::getYMin(), DPMBase::getZMin(), DPMBase::random, BaseInteractable::setPosition(), BaseParticle::setRadius(), BaseParticle::setSpecies(), BaseInteractable::setVelocity(), and DPMBase::speciesHandler.

Referenced by addFlowParticlesCompactly().

1041 {
1042  SphericalParticle p0;
1048  getInflowHeight())));
1049  p0.setVelocity(Vec3D(0.0, 0.0, 0.0));
1050  return p0;
1051 }
A basic particle.
void setVelocity(const Vec3D &velocity)
set the velocity of the BaseInteractable.
virtual void setRadius(Mdouble radius)
Sets the particle's radius_ (and adjusts the mass_ accordingly, based on the particle's species) ...
Mdouble getXMin() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMin() returns XMin...
Definition: DPMBase.h:586
Mdouble getYMin() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMin() returns YMin...
Definition: DPMBase.h:599
void setSpecies(const ParticleSpecies *species)
Mdouble getRandomNumber()
This is a random generating routine can be used for initial positions.
Definition: RNG.cc:143
Mdouble getXMax() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMax() returns XMax...
Definition: DPMBase.h:593
Mdouble getMaxInflowParticleRadius() const
Returns the maximum radius of inflow particles.
Definition: Chute.cc:882
Mdouble getFixedParticleRadius() const
Returns the particle radius of the fixed particles which constitute the (rough) chute bottom...
Definition: Chute.cc:634
T * getObject(const unsigned int id)
Gets a pointer to the Object at the specified index in the BaseHandler.
Definition: BaseHandler.h:613
Mdouble getRadius() const
Returns the particle's radius.
Definition: BaseParticle.h:345
SpeciesHandler speciesHandler
A handler to that stores the species type i.e. LinearViscoelasticSpecies, etc.
Definition: DPMBase.h:1319
Mdouble getYMax() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMax() returns XMax...
Definition: DPMBase.h:605
RNG random
This is a random generator, often used for setting up the initial conditions etc...
Definition: DPMBase.h:1324
void setPosition(const Vec3D &position)
Sets the position of this BaseInteractable.
Mdouble getMinInflowParticleRadius() const
returns the minimum radius of inflow particles
Definition: Chute.cc:873
Mdouble getZMin() const
If the length of the problem domain in z-direction is ZMax - ZMin, then getZMin() returns ZMin...
Definition: DPMBase.h:611
Definition: Vector.h:49
Mdouble getInflowHeight() const
Returns the maximum inflow height (Z-direction)
Definition: Chute.cc:909
Mdouble Chute::getChuteAngle ( ) const

Returns the chute angle (in radians)

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

Returns
the chute angle in RADIANS

Definition at line 742 of file Chute.cc.

References chuteAngle_.

Referenced by ChuteWithHopper::addHopper(), ChuteWithHopper::getMaximumVelocityInducedByGravity(), ChuteWithHopper::setHopper(), and ChuteWithHopper::setupInitialConditions().

743 {
744  return chuteAngle_;
745 }
Mdouble chuteAngle_
chute angle in degrees
Definition: Chute.h:318
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)

Definition at line 751 of file Chute.cc.

References chuteAngle_, and constants::pi.

752 {
753  return chuteAngle_ * 180.0 / constants::pi;
754 }
const Mdouble pi
Definition: ExtendedMath.h:45
Mdouble chuteAngle_
chute angle in degrees
Definition: Chute.h:318
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

Definition at line 1004 of file Chute.cc.

References DPMBase::getXMax().

Referenced by addFlowParticlesCompactly().

1005 {
1006  return getXMax();
1007 }
Mdouble getXMax() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMax() returns XMax...
Definition: DPMBase.h:593
Mdouble 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.

Returns
width of the chute

Definition at line 984 of file Chute.cc.

References DPMBase::getYMax().

Referenced by addFlowParticlesCompactly().

985 {
986  return getYMax();
987 }
Mdouble getYMax() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMax() returns XMax...
Definition: DPMBase.h:605
Mdouble 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() ).

Returns
The radius of the fixed particles.

Definition at line 634 of file Chute.cc.

References fixedParticleRadius_.

Referenced by createBottom(), createFlowParticle(), ChuteBottom::setupInitialConditions(), and ChuteWithHopper::setupInitialConditions().

635 {
636  return fixedParticleRadius_;
637 }
Mdouble fixedParticleRadius_
radius of the fixed particles at the bottom
Definition: Chute.h:322
Mdouble Chute::getInflowHeight ( ) const

Returns the maximum inflow height (Z-direction)

Returns the maximum height at which particles are introduced into the chute

Returns
the inflowHeight_

Definition at line 909 of file Chute.cc.

References inflowHeight_.

Referenced by addFlowParticlesCompactly(), and createFlowParticle().

910 {
911  return inflowHeight_;
912 }
Mdouble inflowHeight_
Height of inflow.
Definition: Chute.h:342
Mdouble Chute::getInflowParticleRadius ( ) const

Returns the average radius of inflow particles.

Returns the mean of the min. and max. inflow particle radius.

Returns
the mean of the min. and max. inflow particle radius.

Definition at line 864 of file Chute.cc.

References maxInflowParticleRadius_, and minInflowParticleRadius_.

Referenced by addFlowParticlesCompactly(), ChuteBottom::makeRoughBottom(), and ChuteBottom::setupInitialConditions().

865 {
867 }
Mdouble minInflowParticleRadius_
minimal radius of inflowing particles
Definition: Chute.h:326
Mdouble maxInflowParticleRadius_
maximal radius of inflowing particles
Definition: Chute.h:330
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

Definition at line 935 of file Chute.cc.

References inflowVelocity_.

936 {
937  return inflowVelocity_;
938 }
Mdouble inflowVelocity_
Average inflow velocity in x-direction.
Definition: Chute.h:334
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_).

Definition at line 964 of file Chute.cc.

References inflowVelocityVariance_.

965 {
967 }
Mdouble inflowVelocityVariance_
Inflow velocity variance in x-direction (in ratio of inflowVelocity_)
Definition: Chute.h:338
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.

Definition at line 605 of file Chute.cc.

References isChutePeriodic_.

606 {
607  return isChutePeriodic_;
608 }
bool isChutePeriodic_
Determines whether the chute has periodic (TRUE) or solid (FALSE) walls in the Y-direction.
Definition: Chute.h:361
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

Definition at line 772 of file Chute.cc.

References maxFailed_.

Referenced by ChuteWithHopper::setupInitialConditions().

773 {
774  return maxFailed_;
775 }
unsigned int maxFailed_
indicates how many attempts are made to insert a new particle into the insertion boundary before the ...
Definition: Chute.h:352
Mdouble Chute::getMaxInflowParticleRadius ( ) const

Returns the maximum radius of inflow particles.

Returns the maximum inflow particle radius

Returns
the maximum inflow particle radius

Definition at line 882 of file Chute.cc.

References maxInflowParticleRadius_.

Referenced by addFlowParticlesCompactly(), createFlowParticle(), ChuteBottom::makeRoughBottom(), ChuteBottom::setupInitialConditions(), and ChuteWithHopper::setupInitialConditions().

883 {
885 }
Mdouble maxInflowParticleRadius_
maximal radius of inflowing particles
Definition: Chute.h:330
Mdouble Chute::getMinInflowParticleRadius ( ) const

returns the minimum radius of inflow particles

returns the minimum inflow particle radius

Returns
the minimum inflow particle radius

Definition at line 873 of file Chute.cc.

References minInflowParticleRadius_.

Referenced by createFlowParticle(), ChuteWithHopper::getTimeStepRatio(), ChuteBottom::makeRoughBottom(), ChuteBottom::setupInitialConditions(), and ChuteWithHopper::setupInitialConditions().

874 {
876 }
Mdouble minInflowParticleRadius_
minimal radius of inflowing particles
Definition: Chute.h:326
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.

Definition at line 689 of file Chute.cc.

References roughBottomType_.

690 {
691  return roughBottomType_;
692 }
RoughBottomType roughBottomType_
Determines the type of rough bottom created (if any). See also the enum RoughBottomType at the beginn...
Definition: Chute.h:347
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 595 of file Chute.cc.

References isChutePeriodic_.

596 {
597  isChutePeriodic_ = true;
598 }
bool isChutePeriodic_
Determines whether the chute has periodic (TRUE) or solid (FALSE) walls in the Y-direction.
Definition: Chute.h:361
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.

Todo:
currently, this is going to cout. Do we want to make it a logger message?

Reimplemented from DPMBase.

Definition at line 235 of file Chute.cc.

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

236 {
237  std::cout << "\rt=" << std::setprecision(3) << std::left << std::setw(6)
238  << getTime()
239  << ", tmax=" << std::setprecision(3) << std::left << std::setw(6) << getTimeMax()
240  << ", N=" << std::setprecision(3) << std::left << std::setw(6)
242  << std::endl;
243  std::cout.flush();
244 }
unsigned int getNumberOfObjects() const override
Returns the number of objects in the container. In parallel code this practice is forbidden to avoid ...
ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created...
Definition: DPMBase.h:1329
Mdouble getTime() const
Returns the current simulation time.
Definition: DPMBase.cc:797
Mdouble getTimeMax() const
Returns the maximum simulation duration.
Definition: DPMBase.cc:855
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.

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

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  std::cout << "Chuteline=" << line_string << std::endl;
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 }
unsigned int maxFailed_
indicates how many attempts are made to insert a new particle into the insertion boundary before the ...
Definition: Chute.h:352
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Mdouble minInflowParticleRadius_
minimal radius of inflowing particles
Definition: Chute.h:326
void setRoughBottomType(RoughBottomType roughBottomType)
Sets the type of rough bottom of the chute.
Definition: Chute.cc:649
const Mdouble pi
Definition: ExtendedMath.h:45
Mdouble inflowVelocity_
Average inflow velocity in x-direction.
Definition: Chute.h:334
Mdouble inflowHeight_
Height of inflow.
Definition: Chute.h:342
Mdouble chuteAngle_
chute angle in degrees
Definition: Chute.h:318
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
Mdouble fixedParticleRadius_
radius of the fixed particles at the bottom
Definition: Chute.h:322
Mdouble inflowVelocityVariance_
Inflow velocity variance in x-direction (in ratio of inflowVelocity_)
Definition: Chute.h:338
std::string getRestartVersion() const
This is to take into account for different Mercury versions. Returns the version of the restart file...
Definition: DPMBase.cc:1435
Mdouble maxInflowParticleRadius_
maximal radius of inflowing particles
Definition: Chute.h:330
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.

Definition at line 518 of file Chute.cc.

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

Referenced by ChuteWithHopper::readNextArgument().

519 {
520  if (!strcmp(argv[i], "-inflowHeight"))
521  {
522  setInflowHeight(atof(argv[i + 1]));
523  setZMax(atof(argv[i + 1]));
524  }
525  else if (!strcmp(argv[i], "-inflowVelocity"))
526  {
527  setInflowVelocity(atof(argv[i + 1]));
528  }
529  else if (!strcmp(argv[i], "-chuteAngle"))
530  {
531  setChuteAngle(atof(argv[i + 1]));
532  }
533  else if (!strcmp(argv[i], "-chuteLength"))
534  {
535  setChuteLength(atof(argv[i + 1]));
536  }
537  else if (!strcmp(argv[i], "-chuteWidth"))
538  {
539  setChuteWidth(atof(argv[i + 1]));
540  }
541  else if (!strcmp(argv[i], "-fixedParticleRadius"))
542  {
543  setFixedParticleRadius(atof(argv[i + 1]));
544  }
545  else if (!strcmp(argv[i], "-max_failed"))
546  {
547  setMaxFailed(static_cast<unsigned int>(atoi(argv[i + 1])));
548  }
549  else if (!strcmp(argv[i], "-inflowParticleRadiusRange"))
550  {
551  setInflowParticleRadius(atof(argv[i + 1]), atof(argv[i + 2]));
552  i++;
553  }
554  else if (!strcmp(argv[i], "-inflowParticleRadius"))
555  {
556  setInflowParticleRadius(atof(argv[i + 1]));
557  }
558  else if (!strcmp(argv[i], "-roughBottomType"))
559  {
560  std::string str(argv[i + 1]);
561  setRoughBottomType(str);
562  }
563 // else if (!strcmp(argv[i], "-k_eps"))
564 // {
565 // Mdouble Mass = getLightestParticleMass();
566 // //~ Mdouble Mass = particleHandler.get_LightestParticle()->getMass();
567 // speciesHandler.getObject(0)->setStiffnessAndRestitutionCoefficient(atof(argv[i + 1]), atof(argv[i + 2]), Mass);
568 // std::cout << "reset contact properties of lightest Particle (mass=" << Mass << ") to k=" << speciesHandler.getObject(0)->getStiffness() << " and dissipation_=" << speciesHandler.getObject(0)->getDissipation() << std::endl;
569 // i += 1;
570 // }
571 // else if (!strcmp(argv[i], "-tc_eps"))
572 // {
573 // Mdouble Mass = getLightestParticleMass();
574 // speciesHandler.getObject(0)->setCollisionTimeAndRestitutionCoefficient(atof(argv[i + 1]), atof(argv[i + 2]), Mass);
575 // std::cout << "reset contact properties of lightest Particle (mass=" << Mass << ") to k=" << speciesHandler.getObject(0)->getStiffness() << " and dissipation_=" << speciesHandler.getObject(0)->getDissipation() << std::endl;
576 // i += 1;
577 // }
578 // else if (!strcmp(argv[i], "-tc_eps_beta"))
579 // {
580 // Mdouble Mass = getLightestParticleMass();
581 // FrictionalSpecies* S = dynamic_cast<FrictionalSpecies*>(speciesHandler.getObject(0));
582 // S->setCollisionTimeAndNormalAndTangentialRestitutionCoefficient(atof(argv[i + 1]), atof(argv[i + 2]), atof(argv[i + 3]), Mass);
583 // 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;
584 // i += 2;
585 // }
586  else
587  return Mercury3D::readNextArgument(i, argc, argv); //if argv[i] is not found, check the commands in Mercury3D
588  return true; //returns true if argv[i] is found
589 }
void setInflowVelocity(Mdouble inflowVelocity)
Sets the average inflow velocity.
Definition: Chute.cc:918
void setInflowHeight(Mdouble inflowHeight)
Sets maximum inflow height (Z-direction)
Definition: Chute.cc:892
void setChuteWidth(Mdouble chuteWidth)
Sets the chute width (Y-direction)
Definition: Chute.cc:974
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:762
const std::complex< Mdouble > i
Definition: ExtendedMath.h:50
void setZMax(Mdouble newZMax)
Sets the value of ZMax, the upper bound of the problem domain in the z-direction. ...
Definition: DPMBase.cc:1178
void setChuteAngle(Mdouble chuteAngle)
Sets gravity vector according to chute angle (in degrees)
Definition: Chute.cc:703
void setRoughBottomType(RoughBottomType roughBottomType)
Sets the type of rough bottom of the chute.
Definition: Chute.cc:649
bool readNextArgument(int &i, int argc, char *argv[]) override
Reads the next command line argument.
Definition: MercuryBase.cc:396
void setInflowParticleRadius(Mdouble inflowParticleRadius)
Sets the radius of the inflow particles to a single one (i.e. ensures a monodisperse inflow)...
Definition: Chute.cc:783
void setFixedParticleRadius(Mdouble fixedParticleRadius)
Sets the particle radius of the fixed particles which constitute the (rough) chute bottom...
Definition: Chute.cc:616
virtual void setChuteLength(Mdouble chuteLength)
Sets the chute length (X-direction)
Definition: Chute.cc:994
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?

Definition at line 703 of file Chute.cc.

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

Referenced by constructor(), ChuteBottom::makeRoughBottom(), and readNextArgument().

704 {
705  // retrieve the magnitude of gravity
706  Mdouble gravity = getGravity().getLength();
707  if (gravity == 0)
708  {
709  logger(WARN, "[Chute::setChuteAngle()] zero gravity");
710  }
711 
712  // reset the gravity vector, with the given angle
713  setChuteAngleAndMagnitudeOfGravity(chuteAngle, gravity);
714 }
void setChuteAngleAndMagnitudeOfGravity(Mdouble chuteAngle, Mdouble gravity)
Sets gravity vector according to chute angle (in degrees)
Definition: Chute.cc:724
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
double Mdouble
Definition: GeneralDefine.h:34
static Mdouble getLength(const Vec3D &a)
Calculates the length of a Vec3D: .
Definition: Vector.cc:331
Vec3D getGravity() const
Returns the gravitational acceleration.
Definition: DPMBase.cc:1351
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

Definition at line 724 of file Chute.cc.

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

Referenced by setChuteAngle().

725 {
726  if (chuteAngle >= -90.0 && chuteAngle <= 90.0)
727  {
728  chuteAngle_ = chuteAngle * constants::pi / 180.0;
729  setGravity(Vec3D(sin(chuteAngle_), 0.0, -cos(chuteAngle_)) * gravity);
730  }
731  else
732  {
733  logger(WARN, "[Chute::setChuteAngleAndMagnitudeOfGravity()] Chute "
734  "angle must be within [-90,90]");
735  }
736 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
void setGravity(Vec3D newGravity)
Sets a new value for the gravitational acceleration.
Definition: DPMBase.cc:1343
Mdouble cos(Mdouble x)
Definition: ExtendedMath.cc:64
Mdouble sin(Mdouble x)
Definition: ExtendedMath.cc:44
const Mdouble pi
Definition: ExtendedMath.h:45
Definition: Vector.h:49
Mdouble chuteAngle_
chute angle in degrees
Definition: Chute.h:318
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.

Definition at line 994 of file Chute.cc.

References DPMBase::setXMax().

Referenced by readNextArgument().

995 {
996  setXMax(chuteLength);
997 }
void setXMax(Mdouble newXMax)
Sets the value of XMax, the upper bound of the problem domain in the x-direction. ...
Definition: DPMBase.cc:1126
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

Definition at line 974 of file Chute.cc.

References DPMBase::setYMax().

Referenced by readNextArgument().

975 {
976  setYMax(chuteWidth);
977 }
void setYMax(Mdouble newYMax)
Sets the value of YMax, the upper bound of the problem domain in the y-direction. ...
Definition: DPMBase.cc:1152
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.

Definition at line 616 of file Chute.cc.

References fixedParticleRadius_, logger, and WARN.

Referenced by constructor(), ChuteBottom::makeRoughBottom(), and readNextArgument().

617 {
618  if (fixedParticleRadius >= 0.0)
619  {
620  fixedParticleRadius_ = fixedParticleRadius;
621  }
622  else
623  {
624  logger(WARN, "[Chute::setFixedParticleRadius()] Fixed particle radius "
625  "must be greater than or equal to zero.");
626  }
627 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Mdouble fixedParticleRadius_
radius of the fixed particles at the bottom
Definition: Chute.h:322
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

Definition at line 892 of file Chute.cc.

References inflowHeight_, and DPMBase::setZMax().

Referenced by addFlowParticlesCompactly(), constructor(), ChuteBottom::makeRoughBottom(), and readNextArgument().

893 {
894  //if (inflowHeight >= minInflowParticleRadius_ + maxInflowParticleRadius_)
895  {
896  inflowHeight_ = inflowHeight;
897  setZMax(1.2 * inflowHeight_);
898  }
899 // else
900 // {
901 // std::cerr << "WARNING : Inflow height not changed to " << inflowHeight << ", value must be greater than or equal to diameter of inflow particle" << std::endl;
902 // }
903 }
void setZMax(Mdouble newZMax)
Sets the value of ZMax, the upper bound of the problem domain in the z-direction. ...
Definition: DPMBase.cc:1178
Mdouble inflowHeight_
Height of inflow.
Definition: Chute.h:342
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

Definition at line 783 of file Chute.cc.

References logger, maxInflowParticleRadius_, minInflowParticleRadius_, and WARN.

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

784 {
785  if (inflowParticleRadius >= 0.0)
786  {
787  minInflowParticleRadius_ = inflowParticleRadius;
788  maxInflowParticleRadius_ = inflowParticleRadius;
789  }
790  else
791  {
792  logger(WARN, "[Chute::setInflowParticleRadius(Mdouble)] Inflow "
793  "particle must be greater than or equal to zero");
794  }
795 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Mdouble minInflowParticleRadius_
minimal radius of inflowing particles
Definition: Chute.h:326
Mdouble maxInflowParticleRadius_
maximal radius of inflowing particles
Definition: Chute.h:330
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

Definition at line 802 of file Chute.cc.

References logger, maxInflowParticleRadius_, minInflowParticleRadius_, and WARN.

804 {
805  if (minInflowParticleRadius >= 0.0)
806  {
807  minInflowParticleRadius_ = minInflowParticleRadius;
808  }
809  else
810  {
811  logger(WARN, "[Chute::setInflowParticleRadius(Mdouble,Mdouble)] Min."
812  "inflow particle radius must be nonnegative");
813  }
814  if (maxInflowParticleRadius >= minInflowParticleRadius)
815  {
816  maxInflowParticleRadius_ = maxInflowParticleRadius;
817  }
818  else
819  {
820  logger(WARN, "[Chute::setInflowParticleRadius(Mdouble,Mdouble)] Max."
821  " inflow particle radius must be >= min. inflow particle "
822  "radius");
823  }
824 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Mdouble minInflowParticleRadius_
minimal radius of inflowing particles
Definition: Chute.h:326
Mdouble maxInflowParticleRadius_
maximal radius of inflowing particles
Definition: Chute.h:330
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

Definition at line 918 of file Chute.cc.

References inflowVelocity_, logger, and WARN.

Referenced by constructor(), and readNextArgument().

919 {
920  if (inflowVelocity >= 0.0)
921  {
922  inflowVelocity_ = inflowVelocity;
923  }
924  else
925  {
926  logger(WARN, "[Chute::setInflowVelocity()] Inflow velocity not changed, "
927  "value must be greater than or equal to zero");
928  }
929 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Mdouble inflowVelocity_
Average inflow velocity in x-direction.
Definition: Chute.h:334
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_).

Definition at line 945 of file Chute.cc.

References ERROR, inflowVelocityVariance_, and logger.

Referenced by constructor().

946 {
947  if (inflowVelocityVariance >= 0.0 && inflowVelocityVariance <= 1.0)
948  {
949  inflowVelocityVariance_ = inflowVelocityVariance;
950  }
951  else
952  {
953  logger(ERROR, "[Chute::setInflowVelocityVariance()] Inflow velocity "
954  "variance not changed, value must be within [0,1]");
955  exit(-1);
956  }
957 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Mdouble inflowVelocityVariance_
Inflow velocity variance in x-direction (in ratio of inflowVelocity_)
Definition: Chute.h:338
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

Definition at line 1013 of file Chute.cc.

References insertionBoundary_.

Referenced by ChuteWithHopper::setupInitialConditions().

1014 {
1015  insertionBoundary_ = insertionBoundary;
1016 }
InsertionBoundary * insertionBoundary_
(Pointer to) the Chute's insertion boundary
Definition: Chute.h:356
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

Definition at line 762 of file Chute.cc.

References maxFailed_.

Referenced by constructor(), and readNextArgument().

763 {
764  maxFailed_ = maxFailed;
765 }
unsigned int maxFailed_
indicates how many attempts are made to insert a new particle into the insertion boundary before the ...
Definition: Chute.h:352
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

Definition at line 847 of file Chute.cc.

References logger, maxInflowParticleRadius_, minInflowParticleRadius_, and WARN.

848 {
849  if (maxInflowParticleRadius >= minInflowParticleRadius_)
850  {
851  maxInflowParticleRadius_ = maxInflowParticleRadius;
852  }
853  else
854  {
855  logger(WARN, "[Chute::setMaxInflowParticleRadius()] Max. inflow particle"
856  " radius must be >= min. inflow particle radius");
857  }
858 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Mdouble minInflowParticleRadius_
minimal radius of inflowing particles
Definition: Chute.h:326
Mdouble maxInflowParticleRadius_
maximal radius of inflowing particles
Definition: Chute.h:330
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

Definition at line 830 of file Chute.cc.

References logger, maxInflowParticleRadius_, minInflowParticleRadius_, and WARN.

831 {
832  if (minInflowParticleRadius <= maxInflowParticleRadius_)
833  {
834  minInflowParticleRadius_ = minInflowParticleRadius;
835  }
836  else
837  {
838  logger(WARN, "[Chute::setMinInflowParticleRadius()] Min. inflow particle"
839  " radius must be <= max. inflow particle radius");
840  }
841 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Mdouble minInflowParticleRadius_
minimal radius of inflowing particles
Definition: Chute.h:326
Mdouble maxInflowParticleRadius_
maximal radius of inflowing particles
Definition: Chute.h:330
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

Definition at line 649 of file Chute.cc.

References roughBottomType_.

Referenced by constructor(), ChuteBottom::makeRoughBottom(), read(), and readNextArgument().

650 {
651  roughBottomType_ = roughBottomType;
652 }
RoughBottomType roughBottomType_
Determines the type of rough bottom created (if any). See also the enum RoughBottomType at the beginn...
Definition: Chute.h:347
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?

Definition at line 658 of file Chute.cc.

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

659 {
660  if (!roughBottomTypeString.compare("MONOLAYER_ORDERED"))
661  {
663  }
664  else if (!roughBottomTypeString.compare("MONOLAYER_DISORDERED"))
665  {
667  }
668  else if (!roughBottomTypeString.compare("MULTILAYER"))
669  {
671  }
672  else if (roughBottomTypeString == "FLAT")
673  {
675  }
676  else
677  {
678  logger(FATAL, "[Chute::setRoughBottomType(std::string)] Invalid "
679  "argument in setRoughBottomType. Given: %",
680  roughBottomTypeString);
681  }
682 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Definition: Chute.h:53
RoughBottomType roughBottomType_
Determines the type of rough bottom created (if any). See also the enum RoughBottomType at the beginn...
Definition: Chute.h:347
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.

Definition at line 249 of file Chute.cc.

References DPMBase::boundaryHandler, BaseHandler< T >::copyAndAddObject(), createBottom(), FATAL, fixedParticleRadius_, 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_, maxInflowParticleRadius_, minInflowParticleRadius_, ChuteInsertionBoundary::set(), BaseParticle::setSpecies(), setupSideWalls(), and DPMBase::speciesHandler.

250 {
252  {
253  logger(FATAL, "[Chute::setupInitialConditions()] Chute % cannot "
254  "complete because no species have been defined.", getName());
255  }
256 
257  // create the chute's side walls in Y-direction
258  // (which are solid if the chute is not periodic)
259  setupSideWalls();
260 
261  // create a particle of which (altered) copies will fill the chute insertion
262  // boundary
263 
264 
265 
266  SphericalParticle* particleToInsert = new SphericalParticle;
267  // by default, insert particles of species 0
268  particleToInsert->setSpecies(speciesHandler.getObject(0));
270  {
271  particleToInsert->setSpecies(speciesHandler.getObject(0));
272  }
273  else
274  {
275  std::cerr << "There is not yet a species defined" << std::endl;
276  }
277 
278  // set up the insertion boundary and add to handler
280  b1.set(particleToInsert, maxFailed_,
281  Vec3D(getXMin(), getYMin(), getZMin()),
282  Vec3D(getXMax(), getYMax(), getZMax()),
285  );
287 
288  //creates the bottom of the chute
289  createBottom();
290 }
A basic particle.
unsigned int maxFailed_
indicates how many attempts are made to insert a new particle into the insertion boundary before the ...
Definition: Chute.h:352
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
Mdouble minInflowParticleRadius_
minimal radius of inflowing particles
Definition: Chute.h:326
Mdouble getZMax() const
If the length of the problem domain in z-direction is ZMax - ZMin, then getZMax() returns ZMax...
Definition: DPMBase.h:617
Mdouble getXMin() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMin() returns XMin...
Definition: DPMBase.h:586
Mdouble getYMin() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMin() returns YMin...
Definition: DPMBase.h:599
const std::string & getName() const
Returns the name of the file. Does not allow to change it though.
Definition: DPMBase.cc:389
void setSpecies(const ParticleSpecies *species)
Mdouble getXMax() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMax() returns XMax...
Definition: DPMBase.h:593
BoundaryHandler boundaryHandler
An object of the class BoundaryHandler which concerns insertion and deletion of particles into or fro...
Definition: DPMBase.h:1344
void setupSideWalls()
Creates chute side walls (either solid or periodic)
Definition: Chute.cc:296
T * getObject(const unsigned int id)
Gets a pointer to the Object at the specified index in the BaseHandler.
Definition: BaseHandler.h:613
std::enable_if<!std::is_pointer< U >::value, U * >::type copyAndAddObject(const U &object)
Creates a copy of a Object and adds it to the BaseHandler.
Definition: BaseHandler.h:379
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
SpeciesHandler speciesHandler
A handler to that stores the species type i.e. LinearViscoelasticSpecies, etc.
Definition: DPMBase.h:1319
Mdouble getYMax() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMax() returns XMax...
Definition: DPMBase.h:605
virtual void createBottom()
Creates the chute bottom, which can be either flat or one of three flavours of rough.
Definition: Chute.cc:331
Mdouble getZMin() const
If the length of the problem domain in z-direction is ZMax - ZMin, then getZMin() returns ZMin...
Definition: DPMBase.h:611
Mdouble inflowVelocity_
Average inflow velocity in x-direction.
Definition: Chute.h:334
Used for modeling chute inflow. Inherits from InsertionBoundary.
Definition: Vector.h:49
InsertionBoundary * insertionBoundary_
(Pointer to) the Chute's insertion boundary
Definition: Chute.h:356
void set(BaseParticle *particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, double radMin, double radMax, double fixedParticleRadius, double inflowVelocity, double inflowVelocityVariance)
Sets all boundary properties at once.
Mdouble fixedParticleRadius_
radius of the fixed particles at the bottom
Definition: Chute.h:322
Mdouble inflowVelocityVariance_
Inflow velocity variance in x-direction (in ratio of inflowVelocity_)
Definition: Chute.h:338
Mdouble maxInflowParticleRadius_
maximal radius of inflowing particles
Definition: Chute.h:330
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 296 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().

297 {
298  // check if walls should be periodic or solid
299  if (isChutePeriodic_)
300  {
301  // create a periodic boundary with walls at yMin_ and yMax_.
302  PeriodicBoundary b0;
303  b0.set(Vec3D(0.0, 1.0, 0.0), getYMin(), getYMax());
305  }
306  else
307  {
308  // create two infinite solid walls; one at yMin_...
309  InfiniteWall w0;
311  w0.set(Vec3D(0.0, -1.0, 0.0), Vec3D(0, getYMin(), 0));
313  // ... and one at yMax_.
314  w0.set(Vec3D(0.0, 1.0, 0.0), Vec3D(0, getYMax(), 0));
316  }
317 }
void set(Vec3D normal, Mdouble distanceLeft, Mdouble distanceRight)
Defines a PeriodicBoundary by its normal and positions.
bool isChutePeriodic_
Determines whether the chute has periodic (TRUE) or solid (FALSE) walls in the Y-direction.
Definition: Chute.h:361
Mdouble getYMin() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMin() returns YMin...
Definition: DPMBase.h:599
Defines a pair of periodic walls. Inherits from BaseBoundary.
BoundaryHandler boundaryHandler
An object of the class BoundaryHandler which concerns insertion and deletion of particles into or fro...
Definition: DPMBase.h:1344
T * getObject(const unsigned int id)
Gets a pointer to the Object at the specified index in the BaseHandler.
Definition: BaseHandler.h:613
std::enable_if<!std::is_pointer< U >::value, U * >::type copyAndAddObject(const U &object)
Creates a copy of a Object and adds it to the BaseHandler.
Definition: BaseHandler.h:379
SpeciesHandler speciesHandler
A handler to that stores the species type i.e. LinearViscoelasticSpecies, etc.
Definition: DPMBase.h:1319
Mdouble getYMax() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMax() returns XMax...
Definition: DPMBase.h:605
WallHandler wallHandler
An object of the class WallHandler. Contains pointers to all the walls created.
Definition: DPMBase.h:1339
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...
This is a class defining walls.
Definition: InfiniteWall.h:47
Definition: Vector.h:49
void setSpecies(const ParticleSpecies *species)
Defines the species of the current wall.
Definition: BaseWall.cc:171
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.

Definition at line 206 of file Chute.cc.

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

Referenced by ChuteWithHopper::write().

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 }
unsigned int maxFailed_
indicates how many attempts are made to insert a new particle into the insertion boundary before the ...
Definition: Chute.h:352
Mdouble minInflowParticleRadius_
minimal radius of inflowing particles
Definition: Chute.h:326
void write(std::ostream &os, bool writeAllParticles=true) const override
Writes the MercuryBase to an output stream, for example a restart file.
Definition: MercuryBase.cc:146
unsigned int getNumberOfParticlesInserted() const
Gets the number of particles inserted by the boundary.
RoughBottomType roughBottomType_
Determines the type of rough bottom created (if any). See also the enum RoughBottomType at the beginn...
Definition: Chute.h:347
Mdouble inflowVelocity_
Average inflow velocity in x-direction.
Definition: Chute.h:334
Mdouble inflowHeight_
Height of inflow.
Definition: Chute.h:342
InsertionBoundary * insertionBoundary_
(Pointer to) the Chute's insertion boundary
Definition: Chute.h:356
Mdouble chuteAngle_
chute angle in degrees
Definition: Chute.h:318
Mdouble fixedParticleRadius_
radius of the fixed particles at the bottom
Definition: Chute.h:322
Mdouble inflowVelocityVariance_
Inflow velocity variance in x-direction (in ratio of inflowVelocity_)
Definition: Chute.h:338
Mdouble maxInflowParticleRadius_
maximal radius of inflowing particles
Definition: Chute.h:330

Member Data Documentation

Mdouble Chute::chuteAngle_
private

chute angle in degrees

Definition at line 318 of file Chute.h.

Referenced by getChuteAngle(), getChuteAngleDegrees(), read(), setChuteAngleAndMagnitudeOfGravity(), and write().

Mdouble Chute::fixedParticleRadius_
private

radius of the fixed particles at the bottom

Definition at line 322 of file Chute.h.

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

Mdouble Chute::inflowHeight_
private

Height of inflow.

Definition at line 342 of file Chute.h.

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

Mdouble Chute::inflowVelocity_
private

Average inflow velocity in x-direction.

Definition at line 334 of file Chute.h.

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

Mdouble Chute::inflowVelocityVariance_
private

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

Definition at line 338 of file Chute.h.

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

InsertionBoundary* Chute::insertionBoundary_
private

(Pointer to) the Chute's insertion boundary

Definition at line 356 of file Chute.h.

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

bool Chute::isChutePeriodic_
private

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

Definition at line 361 of file Chute.h.

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

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.

Definition at line 352 of file Chute.h.

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

Mdouble Chute::maxInflowParticleRadius_
private
Mdouble Chute::minInflowParticleRadius_
private
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.

Definition at line 347 of file Chute.h.

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


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