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

This adds on the hierarchical grid code for 2D problems. More...

#include <Mercury2D.h>

+ Inheritance diagram for Mercury2D:

Public Member Functions

 Mercury2D ()
 This is the default constructor. All it does is set sensible defaults. More...
 
 Mercury2D (const DPMBase &other)
 Copy-constructor for creates an Mercury2D problem from an existing MD problem. More...
 
 Mercury2D (const Mercury2D &other)
 Copy-constructor. More...
 
void constructor ()
 Function that sets the ParticleDimensions and SystemDimensions to 2. 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 setupInitialConditions ()
 This function allows to set the initial conditions for our problem to be solved, by default particle locations are randomly set. Remember particle properties must also be defined here. 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
 
virtual void computeWallForces (BaseWall *w)
 
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

virtual void hGridFindContactsWithinTargetCell (int x, int y, unsigned int l)
 Finds contacts between particles the in the target cell. More...
 
virtual void hGridFindContactsWithTargetCell (int x, int y, unsigned int l, BaseParticle *obj)
 Finds contacts between given BaseParticle and the BaseParticle in the target cell. More...
 
virtual void hGridFindParticlesWithTargetCell (int x, int y, unsigned int l, BaseParticle *obj, std::vector< BaseParticle * > &list)
 
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, 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
 Test if a BaseParticle has any contacts in the HGrid. More...
 
void hGridRemoveParticle (BaseParticle *obj) override
 Removes a BaseParticle to 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 actionsBeforeTimeStep ()
 A virtual function which allows to define operations to be executed before the new time step. 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 void printTime () const
 Displays the current simulation time and the maximum simulation duration. 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...
 

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

This adds on the hierarchical grid code for 2D problems.

Definition at line 35 of file Mercury2D.h.

Constructor & Destructor Documentation

Mercury2D::Mercury2D ( )

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

Definition at line 29 of file Mercury2D.cc.

References constructor(), DEBUG, and logger.

30 {
31  constructor();
32  logger(DEBUG, "Mercury2D::Mercury2D() constructor finished");
33 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
void constructor()
Function that sets the ParticleDimensions and SystemDimensions to 2.
Definition: Mercury2D.cc:59
Mercury2D::Mercury2D ( const DPMBase other)
explicit

Copy-constructor for creates an Mercury2D problem from an existing MD problem.

Parameters
[in]otherDPMBase from which this Mercury2D must copy the properties.

Makes a Mercury2D class from a DPMBase class, so it adds the HGrid functionality to the class. Note that the copy-constructor of DPMBase has to be called because the link from DPMBase to MercuryBase is virtual.

Definition at line 52 of file Mercury2D.cc.

References constructor(), DEBUG, and logger.

53  : DPMBase(other), MercuryBase()
54 {
55  constructor();
56  logger(DEBUG, "Mercury2D::Mercury2D(DPMBase& other) finished");
57 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
void constructor()
Function that sets the ParticleDimensions and SystemDimensions to 2.
Definition: Mercury2D.cc:59
MercuryBase()
This is the default constructor. It sets sensible defaults.
Definition: MercuryBase.cc:31
DPMBase()
Constructor that calls the "void constructor()".
Definition: DPMBase.cc:187
Mercury2D::Mercury2D ( const Mercury2D other)

Copy-constructor.

Parameters
[in]otherMercury2D that must be copied.

Copy constructor. Note that the copy-constructor of DPMBase has to be called because the link from DPMBase to MercuryBase is virtual.

Definition at line 40 of file Mercury2D.cc.

References DEBUG, and logger.

41  : DPMBase(other), MercuryBase(other)
42 {
43  logger(DEBUG, "Mercury2D::Mercury2D(Mercury2D& other) copy constructor finished");
44 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
MercuryBase()
This is the default constructor. It sets sensible defaults.
Definition: MercuryBase.cc:31
DPMBase()
Constructor that calls the "void constructor()".
Definition: DPMBase.cc:187

Member Function Documentation

void Mercury2D::computeInternalForces ( BaseParticle obj)
overrideprotectedvirtual

Finds contacts with the BaseParticle; avoids multiple checks.

Parameters
[in]objThe BaseParticle we want to check for collisions in the HGrid.

Computes all collision between given BaseParticle and all other particles in the grid (of all levels).

Reimplemented from DPMBase.

Definition at line 204 of file Mercury2D.cc.

References BOTTOMUP, MercuryBase::getHGrid(), BaseParticle::getHGridLevel(), MercuryBase::getHGridMethod(), BaseParticle::getHGridX(), BaseParticle::getHGridY(), HGrid::getInvCellSize(), BaseParticle::getMaxInteractionRadius(), HGrid::getNumberOfLevels(), HGrid::getOccupiedLevelsMask(), BaseInteractable::getPosition(), hGridFindContactsWithinTargetCell(), hGridFindContactsWithTargetCell(), TOPDOWN, Vec3D::X, and Vec3D::Y.

205 {
206  HGrid* hgrid = getHGrid();
207  unsigned int startLevel = obj->getHGridLevel();
208 
209  switch (getHGridMethod())
210  {
211  case BOTTOMUP:
212  {
213  int occupiedLevelsMask = hgrid->getOccupiedLevelsMask() >> obj->getHGridLevel();
214  for (unsigned int level = startLevel; level < hgrid->getNumberOfLevels(); occupiedLevelsMask >>= 1, level++)
215  {
216  // If no objects in rest of grid, stop now
217  if (occupiedLevelsMask == 0)
218  {
219  break;
220  }
221 
222  // If no objects at this level, go on to the next level
223  if ((occupiedLevelsMask & 1) == 0)
224  {
225  continue;
226  }
227 
228  if (level == startLevel)
229  {
230  int x = obj->getHGridX();
231  int y = obj->getHGridY();
232 
234  hGridFindContactsWithTargetCell(x, y + 1, level, obj);
235  hGridFindContactsWithTargetCell(x + 1, y - 1, level, obj);
236  hGridFindContactsWithTargetCell(x + 1, y, level, obj);
237  hGridFindContactsWithTargetCell(x + 1, y + 1, level, obj);
238  }
239  else
240  {
241  int xs, ys, xe, ye;
242  Mdouble inv_size = hgrid->getInvCellSize(level);
243  xs = static_cast<int>(std::floor(
244  (obj->getPosition().X - obj->getMaxInteractionRadius()) * inv_size - 0.5));
245  xe = static_cast<int>(std::floor(
246  (obj->getPosition().X + obj->getMaxInteractionRadius()) * inv_size + 0.5));
247  ys = static_cast<int>(std::floor(
248  (obj->getPosition().Y - obj->getMaxInteractionRadius()) * inv_size - 0.5));
249  ye = static_cast<int>(std::floor(
250  (obj->getPosition().Y + obj->getMaxInteractionRadius()) * inv_size + 0.5));
251  for (int x = xs; x <= xe; ++x)
252  {
253  for (int y = ys; y <= ye; ++y)
254  {
255  hGridFindContactsWithTargetCell(x, y, level, obj);
256  }
257  }
258  }
259  }
260  break;
261  }
262  case TOPDOWN:
263  {
264  int occupiedLevelsMask = hgrid->getOccupiedLevelsMask();
265  for (unsigned int level = 0; level <= startLevel; occupiedLevelsMask >>= 1, level++)
266  {
267  // If no objects in rest of grid, stop now
268  if (occupiedLevelsMask == 0)
269  {
270  break;
271  }
272 
273  // If no objects at this level, go on to the next level
274  if ((occupiedLevelsMask & 1) == 0)
275  {
276  continue;
277  }
278 
279  if (level == startLevel)
280  {
281  int x = obj->getHGridX();
282  int y = obj->getHGridY();
283 
285  hGridFindContactsWithTargetCell(x, y + 1, level, obj);
286  hGridFindContactsWithTargetCell(x + 1, y - 1, level, obj);
287  hGridFindContactsWithTargetCell(x + 1, y, level, obj);
288  hGridFindContactsWithTargetCell(x + 1, y + 1, level, obj);
289  }
290  else
291  {
292  int xs, ys, xe, ye;
293  Mdouble inv_size = hgrid->getInvCellSize(level);
294  xs = static_cast<int>(std::floor(
295  (obj->getPosition().X - obj->getMaxInteractionRadius()) * inv_size - 0.5));
296  xe = static_cast<int>(std::floor(
297  (obj->getPosition().X + obj->getMaxInteractionRadius()) * inv_size + 0.5));
298  ys = static_cast<int>(std::floor(
299  (obj->getPosition().Y - obj->getMaxInteractionRadius()) * inv_size - 0.5));
300  ye = static_cast<int>(std::floor(
301  (obj->getPosition().Y + obj->getMaxInteractionRadius()) * inv_size + 0.5));
302  for (int x = xs; x <= xe; ++x)
303  {
304  for (int y = ys; y <= ye; ++y)
305  {
306  hGridFindContactsWithTargetCell(x, y, level, obj);
307  }
308  }
309  }
310  }
311  break;
312  }
313  }
314 }
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
Mdouble X
the vector components
Definition: Vector.h:65
virtual void hGridFindContactsWithTargetCell(int x, int y, unsigned int l, BaseParticle *obj)
Finds contacts between given BaseParticle and the BaseParticle in the target cell.
Definition: Mercury2D.cc:117
double Mdouble
Definition: GeneralDefine.h:34
Mdouble getMaxInteractionRadius() const
Returns the particle's interaction radius, which might be different from radius_ (e.g., when dealing with wet particles)
Definition: BaseParticle.h:359
virtual void hGridFindContactsWithinTargetCell(int x, int y, unsigned int l)
Finds contacts between particles the in the target cell.
Definition: Mercury2D.cc:72
HGridMethod getHGridMethod() const
Gets whether the HGrid in this MercuryBase is BOTTOMUP or TOPDOWN.
Definition: MercuryBase.h:204
int getHGridY() const
Returns particle's HGrid cell Y-coordinate.
Definition: BaseParticle.h:272
int getOccupiedLevelsMask() const
Gets the integer that represents which levels are occupied.
Definition: HGrid.h:213
In the HGrid class, here all information about the HGrid is stored.
Definition: HGrid.h:42
Mdouble Y
Definition: Vector.h:65
HGrid * getHGrid()
Gets the HGrid used by this problem.
Definition: MercuryBase.h:311
unsigned long getNumberOfLevels() const
Gets the number of levels of this HGrid.
Definition: HGrid.h:206
unsigned int getHGridLevel() const
Returns particle's HGrid level.
Definition: BaseParticle.h:234
double getInvCellSize(unsigned int i) const
Gets 1/cellSize for the cells on level i.
Definition: HGrid.h:178
int getHGridX() const
Returns particle's HGrid cell X-coordinate.
Definition: BaseParticle.h:265
void Mercury2D::constructor ( )

Function that sets the ParticleDimensions and SystemDimensions to 2.

Definition at line 59 of file Mercury2D.cc.

References DPMBase::setParticleDimensions(), and DPMBase::setSystemDimensions().

Referenced by Mercury2D().

60 {
63 }
void setParticleDimensions(unsigned int particleDimensions)
Sets the particle dimensionality.
Definition: DPMBase.cc:1408
void setSystemDimensions(unsigned int newDim)
Sets the system dimensionality.
Definition: DPMBase.cc:1377
void Mercury2D::hGridFindContactsWithinTargetCell ( int  x,
int  y,
unsigned int  l 
)
protectedvirtual

Finds contacts between particles the in the target cell.

Parameters
[in]xCoordinate of this cell in x direction.
[in]yCoordinate of this cell in y direction.
[in]lLevel in the HGrid of this cell.

Computes all collision between particles in the same bucket as cell (x,y,l), for all particles from the same cell.

Todo:
replace this generic check of the each bucket to checking only the object to avoid the critical
Bug:
TW: This check is not necessary, I believe. This is the most-expensive function in most codes (the two checks in this function slows down granular jet by 15%) and the selftests are not affected.
Bug:
DK: I do think this is necessary, for example: If two cells hash to the same bucket and a particle in one of these cells check for collisions with the other cell. Then due to the hashing collision it also gets all particles in it's own cell and thus generating false collisions.

Definition at line 72 of file Mercury2D.cc.

References HGrid::computeHashBucketIndex(), DPMBase::computeInternalForce(), HGrid::getBucketIsChecked(), HGrid::getFirstBaseParticleInBucket(), MercuryBase::getHGrid(), BaseParticle::getHGridCell(), BaseParticle::getHGridNextObject(), and HGrid::setBucketIsChecked().

Referenced by computeInternalForces().

73 {
74  HGrid* hgrid = getHGrid();
75  unsigned int bucket = hgrid->computeHashBucketIndex(x, y, l);
76 
78  //Check if this function is already applied to this bucket
79  bool bucketIsChecked;
80  #pragma omp critical
81  {
82  bucketIsChecked = hgrid->getBucketIsChecked(bucket);
83  hgrid->setBucketIsChecked(bucket);
84  }
85  if (bucketIsChecked) return;
86 
87  BaseParticle* p1 = hgrid->getFirstBaseParticleInBucket(bucket);
88  while (p1 != nullptr)
89  {
90  BaseParticle* p2 = p1->getHGridNextObject();
91  while (p2 != nullptr)
92  {
95  //Check if the BaseParticle* p1 and BaseParticle* p2 are really in the same cell (i.e. no hashing error has occurred)
96  if (p1->getHGridCell() == p2->getHGridCell())
97  {
98  computeInternalForce(p1, p2);
99  }
100  p2 = p2->getHGridNextObject();
101  }
102  p1 = p1->getHGridNextObject();
103  }
104 }
const HGridCell & getHGridCell() const
Definition: BaseParticle.h:645
In the HGrid class, here all information about the HGrid is stored.
Definition: HGrid.h:42
void setBucketIsChecked(unsigned int i)
Sets that the bucket with the given index is checked to true.
Definition: HGrid.h:124
virtual void computeInternalForce(BaseParticle *, BaseParticle *)
Computes the forces between two particles (internal in the sense that the sum over all these forces i...
Definition: DPMBase.cc:2994
HGrid * getHGrid()
Gets the HGrid used by this problem.
Definition: MercuryBase.h:311
const BaseParticle * getFirstBaseParticleInBucket(unsigned int i) const
Gets the first BaseParticle in the given bucket, const version.
Definition: HGrid.h:162
unsigned int computeHashBucketIndex(int x, int y, int z, unsigned int l) const
Computes hash bucket index in range [0, NUM_BUCKETS-1] for a 3D domain.
Definition: HGrid.h:76
BaseParticle * getHGridNextObject() const
Returns pointer to next object in particle's HGrid level & cell.
Definition: BaseParticle.h:242
bool getBucketIsChecked(unsigned int i) const
Gets whether or not the bucket with index i is checked.
Definition: HGrid.h:132
void Mercury2D::hGridFindContactsWithTargetCell ( int  x,
int  y,
unsigned int  l,
BaseParticle obj 
)
protectedvirtual

Finds contacts between given BaseParticle and the BaseParticle in the target cell.

Parameters
[in]xCoordinate in x direction of the cell we want to find collisions for.
[in]yCoordinate in y direction of the cell we want to find collisions for.
[in]lThe level in the HGrid of the cell we want to find collisions for.
[in]objThe BaseParticle we want to check for collisions in the cell (x,y,l).

Computes all collisions between given BaseParticle and particles in cell (x,y,l), where the given BaseParticle does currently not belong to that cell. First this function makes sure this BaseParticle is not in the target cell, then it computes the internal forces between the given BaseParticle and the BaseParticle in the target cell.

Definition at line 117 of file Mercury2D.cc.

References HGrid::computeHashBucketIndex(), DPMBase::computeInternalForce(), HGridCell::equals(), HGrid::getFirstBaseParticleInBucket(), MercuryBase::getHGrid(), BaseParticle::getHGridCell(), BaseParticle::getHGridNextObject(), and logger.

Referenced by computeInternalForces().

118 {
119  //Check if the object is not in the same cell as being checked, CheckCell_current should handle these cases.
120  logger.assert(!obj->getHGridCell().equals(x, y, l),
121  "hGridFindContactsWithTargetCell should not be called if object is in the same cell");
122 
123  HGrid* const hgrid = getHGrid();
124 
125  // Calculate the bucket
126  const unsigned int bucket = hgrid->computeHashBucketIndex(x, y, l);
127 
128  // Loop through all objects in the bucket to find nearby objects
129  for (BaseParticle* p = hgrid->getFirstBaseParticleInBucket(bucket); p != nullptr; p = p->getHGridNextObject())
130  {
131  //Check if the BaseParticle *p really is in the target cell (i.e. no hashing error has occurred)
132  if (p->getHGridCell().equals(x, y, l))
133  {
134  computeInternalForce(obj, p);
135  }
136  }
137 }
const HGridCell & getHGridCell() const
Definition: BaseParticle.h:645
bool equals(int x, int y, int z, unsigned int level) const
Checks if the given (x,y,z,level) is the same as the ones in this cell.
Definition: HGridCell.h:39
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
In the HGrid class, here all information about the HGrid is stored.
Definition: HGrid.h:42
virtual void computeInternalForce(BaseParticle *, BaseParticle *)
Computes the forces between two particles (internal in the sense that the sum over all these forces i...
Definition: DPMBase.cc:2994
HGrid * getHGrid()
Gets the HGrid used by this problem.
Definition: MercuryBase.h:311
const BaseParticle * getFirstBaseParticleInBucket(unsigned int i) const
Gets the first BaseParticle in the given bucket, const version.
Definition: HGrid.h:162
unsigned int computeHashBucketIndex(int x, int y, int z, unsigned int l) const
Computes hash bucket index in range [0, NUM_BUCKETS-1] for a 3D domain.
Definition: HGrid.h:76
BaseParticle * getHGridNextObject() const
Returns pointer to next object in particle's HGrid level & cell.
Definition: BaseParticle.h:242
std::vector< BaseParticle * > Mercury2D::hGridFindParticleContacts ( const BaseParticle obj)
overridevirtual

Returns all particles that have a contact with a given particle.

Implements MercuryBase.

Definition at line 498 of file Mercury2D.cc.

References DPMBase::areInContact(), HGrid::computeHashBucketIndex(), HGridCell::equals(), HGrid::getFirstBaseParticleInBucket(), MercuryBase::getHGrid(), BaseParticle::getHGridCell(), BaseParticle::getHGridNextObject(), HGrid::getInvCellSize(), BaseParticle::getMaxInteractionRadius(), HGrid::getNumberOfLevels(), HGrid::getOccupiedLevelsMask(), BaseInteractable::getPosition(), MercuryBase::hGridRebuild(), INFO, logger, VERBOSE, Vec3D::X, and Vec3D::Y.

499 {
500  if (getHGrid() == nullptr || getHGrid()->getNeedsRebuilding())
501  {
502  logger(INFO, "HGrid needs rebuilding for \"bool Mercury2D::hGridHasParticleContacts(BaseParticle *obj)\"");
503  hGridRebuild();
504  }
505 
506  Mdouble inv_size;
507  int occupiedLevelsMask = getHGrid()->getOccupiedLevelsMask();
508 
509  std::vector<BaseParticle*> particlesInContact;
510 
511  for (unsigned int level = 0; level < getHGrid()->getNumberOfLevels(); occupiedLevelsMask >>= 1, level++)
512  {
513  // If no objects in rest of grid, stop now
514  if (occupiedLevelsMask == 0)
515  {
516  logger(VERBOSE, "Level % and higher levels are empty.", level);
517  break;
518  }
519 
520  // If no objects at this level, go on to the next level
521  if ((occupiedLevelsMask & 1) == 0)
522  {
523  logger(VERBOSE, "Level % is empty", level);
524  continue;
525  }
526 
527  int xs, ys, xe, ye;
528  inv_size = getHGrid()->getInvCellSize(level);
529  xs = static_cast<int>(std::floor((obj->getPosition().X - obj->getMaxInteractionRadius()) * inv_size - 0.5));
530  xe = static_cast<int>(std::floor((obj->getPosition().X + obj->getMaxInteractionRadius()) * inv_size + 0.5));
531  ys = static_cast<int>(std::floor((obj->getPosition().Y - obj->getMaxInteractionRadius()) * inv_size - 0.5));
532  ye = static_cast<int>(std::floor((obj->getPosition().Y + obj->getMaxInteractionRadius()) * inv_size + 0.5));
533 
534  logger(VERBOSE, "Level % grid cells [%,%] x [%,%]", level, xs, xe, ys, ye);
535  for (int x = xs; x <= xe; ++x)
536  {
537  for (int y = ys; y <= ye; ++y)
538  {
539  // Loop through all objects in the bucket to find nearby objects
540  const unsigned int bucket = getHGrid()->computeHashBucketIndex(x, y, level);
542  while (p != nullptr)
543  {
544  if (p->getHGridCell().equals(x, y, level))
545  {
546  if (areInContact(obj, p))
547  {
548  particlesInContact.push_back(p);
549  }
550  }
551  p = p->getHGridNextObject();
552  }
553  }
554  }
555  } //end for level
556 
557  return particlesInContact;
558 }
const HGridCell & getHGridCell() const
Definition: BaseParticle.h:645
bool equals(int x, int y, int z, unsigned int level) const
Checks if the given (x,y,z,level) is the same as the ones in this cell.
Definition: HGridCell.h:39
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
Mdouble X
the vector components
Definition: Vector.h:65
static bool areInContact(const BaseParticle *pI, const BaseParticle *pJ)
Checks if two particle are in contact or is there any positive overlap.
Definition: DPMBase.cc:1621
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
double Mdouble
Definition: GeneralDefine.h:34
Mdouble getMaxInteractionRadius() const
Returns the particle's interaction radius, which might be different from radius_ (e.g., when dealing with wet particles)
Definition: BaseParticle.h:359
int getOccupiedLevelsMask() const
Gets the integer that represents which levels are occupied.
Definition: HGrid.h:213
Mdouble Y
Definition: Vector.h:65
void hGridRebuild()
This sets up the parameters required for the contact model.
Definition: MercuryBase.cc:203
HGrid * getHGrid()
Gets the HGrid used by this problem.
Definition: MercuryBase.h:311
unsigned long getNumberOfLevels() const
Gets the number of levels of this HGrid.
Definition: HGrid.h:206
const BaseParticle * getFirstBaseParticleInBucket(unsigned int i) const
Gets the first BaseParticle in the given bucket, const version.
Definition: HGrid.h:162
unsigned int computeHashBucketIndex(int x, int y, int z, unsigned int l) const
Computes hash bucket index in range [0, NUM_BUCKETS-1] for a 3D domain.
Definition: HGrid.h:76
BaseParticle * getHGridNextObject() const
Returns pointer to next object in particle's HGrid level & cell.
Definition: BaseParticle.h:242
double getInvCellSize(unsigned int i) const
Gets 1/cellSize for the cells on level i.
Definition: HGrid.h:178
void Mercury2D::hGridFindParticlesWithTargetCell ( int  x,
int  y,
unsigned int  l,
BaseParticle obj,
std::vector< BaseParticle * > &  list 
)
protectedvirtual
Todo:
: MX: generalise this
Todo:
: MX: generalise this

Definition at line 140 of file Mercury2D.cc.

References HGrid::computeHashBucketIndex(), HGridCell::equals(), HGrid::getFirstBaseParticleInBucket(), MercuryBase::getHGrid(), BaseParticle::getHGridCell(), and BaseParticle::getHGridNextObject().

Referenced by hGridGetInteractingParticleList().

142 {
143  HGrid* const hgrid = getHGrid();
144 
145  // Calculate the bucket
146  const unsigned int bucket = hgrid->computeHashBucketIndex(x, y, l);
147 
148  // Loop through all objects in the bucket to find nearby objects
149  BaseParticle* p = hgrid->getFirstBaseParticleInBucket(bucket);
150  while (p != nullptr)
151  {
152  if (p->getHGridCell().equals(x, y, l))
153  {
154  list.push_back(p);
155  }
156  p = p->getHGridNextObject();
157  }
158 }
const HGridCell & getHGridCell() const
Definition: BaseParticle.h:645
bool equals(int x, int y, int z, unsigned int level) const
Checks if the given (x,y,z,level) is the same as the ones in this cell.
Definition: HGridCell.h:39
In the HGrid class, here all information about the HGrid is stored.
Definition: HGrid.h:42
HGrid * getHGrid()
Gets the HGrid used by this problem.
Definition: MercuryBase.h:311
const BaseParticle * getFirstBaseParticleInBucket(unsigned int i) const
Gets the first BaseParticle in the given bucket, const version.
Definition: HGrid.h:162
unsigned int computeHashBucketIndex(int x, int y, int z, unsigned int l) const
Computes hash bucket index in range [0, NUM_BUCKETS-1] for a 3D domain.
Definition: HGrid.h:76
BaseParticle * getHGridNextObject() const
Returns pointer to next object in particle's HGrid level & cell.
Definition: BaseParticle.h:242
void Mercury2D::hGridGetInteractingParticleList ( BaseParticle obj,
std::vector< BaseParticle * > &  list 
)
overrideprotectedvirtual

Obtains all neighbour particles of a given object, obtained from the hgrid.

Reimplemented from DPMBase.

Definition at line 161 of file Mercury2D.cc.

References MercuryBase::getHGrid(), BaseParticle::getHGridLevel(), HGrid::getInvCellSize(), BaseParticle::getMaxInteractionRadius(), HGrid::getNumberOfLevels(), HGrid::getOccupiedLevelsMask(), BaseInteractable::getPosition(), hGridFindParticlesWithTargetCell(), Vec3D::X, and Vec3D::Y.

162 {
163  HGrid* const hgrid = getHGrid();
164  int occupiedLevelsMask = hgrid->getOccupiedLevelsMask() >> obj->getHGridLevel();
165  for (unsigned int level = 0; level < hgrid->getNumberOfLevels(); level++)
166  {
167  // If no objects in rest of grid, stop now
168  if (occupiedLevelsMask == 0)
169  {
170  break;
171  }
172 
173  // If no objects at this level, go on to the next level
174  if ((occupiedLevelsMask & 1) == 0)
175  {
176  continue;
177  }
178 
179  const Mdouble inv_size = hgrid->getInvCellSize(level);
180  const int xs = static_cast<int>(std::floor(
181  (obj->getPosition().X - obj->getMaxInteractionRadius()) * inv_size - 0.5));
182  const int xe = static_cast<int>(std::floor(
183  (obj->getPosition().X + obj->getMaxInteractionRadius()) * inv_size + 0.5));
184  const int ys = static_cast<int>(std::floor(
185  (obj->getPosition().Y - obj->getMaxInteractionRadius()) * inv_size - 0.5));
186  const int ye = static_cast<int>(std::floor(
187  (obj->getPosition().Y + obj->getMaxInteractionRadius()) * inv_size + 0.5));
188  for (int x = xs; x <= xe; ++x)
189  {
190  for (int y = ys; y <= ye; ++y)
191  {
192  hGridFindParticlesWithTargetCell(x, y, level, obj, list);
193  }
194  }
195  }
196 }
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
Mdouble X
the vector components
Definition: Vector.h:65
double Mdouble
Definition: GeneralDefine.h:34
Mdouble getMaxInteractionRadius() const
Returns the particle's interaction radius, which might be different from radius_ (e.g., when dealing with wet particles)
Definition: BaseParticle.h:359
virtual void hGridFindParticlesWithTargetCell(int x, int y, unsigned int l, BaseParticle *obj, std::vector< BaseParticle * > &list)
Definition: Mercury2D.cc:140
int getOccupiedLevelsMask() const
Gets the integer that represents which levels are occupied.
Definition: HGrid.h:213
In the HGrid class, here all information about the HGrid is stored.
Definition: HGrid.h:42
Mdouble Y
Definition: Vector.h:65
HGrid * getHGrid()
Gets the HGrid used by this problem.
Definition: MercuryBase.h:311
unsigned long getNumberOfLevels() const
Gets the number of levels of this HGrid.
Definition: HGrid.h:206
unsigned int getHGridLevel() const
Returns particle's HGrid level.
Definition: BaseParticle.h:234
double getInvCellSize(unsigned int i) const
Gets 1/cellSize for the cells on level i.
Definition: HGrid.h:178
bool Mercury2D::hGridHasContactsInTargetCell ( int  x,
int  y,
unsigned int  l,
const BaseParticle obj 
) const
protected

Tests if the BaseParticle has contacts with other Particles in the target cell.

Parameters
[in]xThe coordinate of the target cell in x direction.
[in]yThe coordinate of the target cell in y direction.
[in]lThe level in the HGrid of the target cell.
[in]objA pointer to the BaseParticle for which we want to find contacts.
Returns
A boolean which indicates whether or not there are contacts between given BaseParticle and any other BaseParticle in the target cell.

Tests if there are any collisions between given BaseParticle and particles in cell (x, y, l). Do this by going through all BaseParticle in the bucket, and return true if there is a contact between the given BaseParticle and the BaseParticle we're checking for. If there is no contact, go on to the next BaseParticle until either a contact has been found or all BaseParticle have been tested. If there were no contacts, return false.

Definition at line 420 of file Mercury2D.cc.

Referenced by hGridHasParticleContacts().

421 {
422  // Loop through all objects in the bucket to find nearby objects
423  unsigned int bucket = getHGrid()->computeHashBucketIndex(x, y, l);
424 
425  const BaseParticle* p = getHGrid()->getFirstBaseParticleInBucket(bucket);
426  while (p != nullptr)
427  {
428  if (p->getHGridCell().equals(x, y, l))
429  {
430  if (areInContact(obj, p))
431  {
432  return true;
433  }
434  }
435  p = p->getHGridNextObject();
436  }
437  return false;
438 }
const HGridCell & getHGridCell() const
Definition: BaseParticle.h:645
bool equals(int x, int y, int z, unsigned int level) const
Checks if the given (x,y,z,level) is the same as the ones in this cell.
Definition: HGridCell.h:39
static bool areInContact(const BaseParticle *pI, const BaseParticle *pJ)
Checks if two particle are in contact or is there any positive overlap.
Definition: DPMBase.cc:1621
HGrid * getHGrid()
Gets the HGrid used by this problem.
Definition: MercuryBase.h:311
const BaseParticle * getFirstBaseParticleInBucket(unsigned int i) const
Gets the first BaseParticle in the given bucket, const version.
Definition: HGrid.h:162
unsigned int computeHashBucketIndex(int x, int y, int z, unsigned int l) const
Computes hash bucket index in range [0, NUM_BUCKETS-1] for a 3D domain.
Definition: HGrid.h:76
BaseParticle * getHGridNextObject() const
Returns pointer to next object in particle's HGrid level & cell.
Definition: BaseParticle.h:242
bool Mercury2D::hGridHasParticleContacts ( const BaseParticle obj)
overrideprotectedvirtual

Test if a BaseParticle has any contacts in the HGrid.

Parameters
[in]objA pointer to the BaseParticle which we want to check for contacts.
Returns
A boolean which indicates whether or not there are contacts between this BaseParticle.

Tests if there are any collisions between given BaseParticle and all other particles in the HGrid. It does this by first rebuilding the HGrid if necessary, and then for all levels first computing what the area for checking needs to be, and then check for interactions in the appropriate grid cells.

Implements MercuryBase.

Definition at line 448 of file Mercury2D.cc.

References MercuryBase::getHGrid(), HGrid::getInvCellSize(), BaseParticle::getMaxInteractionRadius(), HGrid::getNumberOfLevels(), HGrid::getOccupiedLevelsMask(), BaseInteractable::getPosition(), hGridHasContactsInTargetCell(), MercuryBase::hGridRebuild(), INFO, logger, VERBOSE, Vec3D::X, and Vec3D::Y.

449 {
450  if (getHGrid() == nullptr || getHGrid()->getNeedsRebuilding())
451  {
452  logger(INFO, "HGrid needs rebuilding for \"bool Mercury2D::hGridHasParticleContacts(BaseParticle *obj)\"");
453  hGridRebuild();
454  }
455 
456  Mdouble inv_size;
457  int occupiedLevelsMask = getHGrid()->getOccupiedLevelsMask();
458 
459  for (unsigned int level = 0; level < getHGrid()->getNumberOfLevels(); occupiedLevelsMask >>= 1, level++)
460  {
461  // If no objects in rest of grid, stop now
462  if (occupiedLevelsMask == 0)
463  {
464  logger(VERBOSE, "Level % and higher levels are empty.", level);
465  break;
466  }
467 
468  // If no objects at this level, go on to the next level
469  if ((occupiedLevelsMask & 1) == 0)
470  {
471  logger(VERBOSE, "Level % is empty", level);
472  continue;
473  }
474 
475  int xs, ys, xe, ye;
476  inv_size = getHGrid()->getInvCellSize(level);
477  xs = static_cast<int>(std::floor((obj->getPosition().X - obj->getMaxInteractionRadius()) * inv_size - 0.5));
478  xe = static_cast<int>(std::floor((obj->getPosition().X + obj->getMaxInteractionRadius()) * inv_size + 0.5));
479  ys = static_cast<int>(std::floor((obj->getPosition().Y - obj->getMaxInteractionRadius()) * inv_size - 0.5));
480  ye = static_cast<int>(std::floor((obj->getPosition().Y + obj->getMaxInteractionRadius()) * inv_size + 0.5));
481 
482  logger(VERBOSE, "Level % grid cells [%,%] x [%,%]", level, xs, xe, ys, ye);
483  for (int x = xs; x <= xe; ++x)
484  {
485  for (int y = ys; y <= ye; ++y)
486  {
487  if (hGridHasContactsInTargetCell(x, y, level, obj))
488  {
489  return true;
490  }
491  }
492  }
493  } //end for level
494 
495  return false;
496 }
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
Mdouble X
the vector components
Definition: Vector.h:65
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
double Mdouble
Definition: GeneralDefine.h:34
Mdouble getMaxInteractionRadius() const
Returns the particle's interaction radius, which might be different from radius_ (e.g., when dealing with wet particles)
Definition: BaseParticle.h:359
int getOccupiedLevelsMask() const
Gets the integer that represents which levels are occupied.
Definition: HGrid.h:213
bool hGridHasContactsInTargetCell(int x, int y, unsigned int l, const BaseParticle *obj) const
Tests if the BaseParticle has contacts with other Particles in the target cell.
Definition: Mercury2D.cc:420
Mdouble Y
Definition: Vector.h:65
void hGridRebuild()
This sets up the parameters required for the contact model.
Definition: MercuryBase.cc:203
HGrid * getHGrid()
Gets the HGrid used by this problem.
Definition: MercuryBase.h:311
unsigned long getNumberOfLevels() const
Gets the number of levels of this HGrid.
Definition: HGrid.h:206
double getInvCellSize(unsigned int i) const
Gets 1/cellSize for the cells on level i.
Definition: HGrid.h:178
void Mercury2D::hGridRemoveParticle ( BaseParticle obj)
overrideprotected

Removes a BaseParticle to the HGrid.

Parameters
[in]objThe BaseParticle that has to be removed from the HGrid.

Removes BaseParticle from the HGrid. First check which bucket the BaseParticle is in, then set the pointers correctly again.

Definition at line 378 of file Mercury2D.cc.

References HGrid::computeHashBucketIndex(), HGrid::getFirstBaseParticleInBucket(), MercuryBase::getHGrid(), BaseParticle::getHGridLevel(), BaseParticle::getHGridNextObject(), BaseParticle::getHGridPrevObject(), BaseParticle::getHGridX(), BaseParticle::getHGridY(), HGrid::setFirstBaseParticleInBucket(), BaseParticle::setHGridNextObject(), and BaseParticle::setHGridPrevObject().

Referenced by hGridUpdateParticle().

379 {
380  HGrid* hGrid = getHGrid();
381  if (hGrid != nullptr)
382  {
383  unsigned int bucket = getHGrid()->computeHashBucketIndex(obj->getHGridX(), obj->getHGridY(),
384  obj->getHGridLevel());
385  if (obj->getHGridPrevObject())
386  {
388  }
389  else
390  {
391  if (getHGrid()->getFirstBaseParticleInBucket(bucket) == obj)
392  {
394  }
395  }
396 
397  if (obj->getHGridNextObject())
398  {
400  }
401  }
402 }
void setHGridNextObject(BaseParticle *p)
Sets the pointer to the next object in the particle's HGrid cell & level.
Definition: BaseParticle.h:477
int getHGridY() const
Returns particle's HGrid cell Y-coordinate.
Definition: BaseParticle.h:272
In the HGrid class, here all information about the HGrid is stored.
Definition: HGrid.h:42
void setFirstBaseParticleInBucket(unsigned int i, BaseParticle *p)
Sets the first particle in bucket i to be the given BaseParticle.
Definition: HGrid.h:117
BaseParticle * getHGridPrevObject() const
Returns pointer to previous object in particle's HGrid level & cell.
Definition: BaseParticle.h:250
void setHGridPrevObject(BaseParticle *p)
Sets the pointer to the previous object in the particle's HGrid cell & level.
Definition: BaseParticle.h:485
HGrid * getHGrid()
Gets the HGrid used by this problem.
Definition: MercuryBase.h:311
const BaseParticle * getFirstBaseParticleInBucket(unsigned int i) const
Gets the first BaseParticle in the given bucket, const version.
Definition: HGrid.h:162
unsigned int computeHashBucketIndex(int x, int y, int z, unsigned int l) const
Computes hash bucket index in range [0, NUM_BUCKETS-1] for a 3D domain.
Definition: HGrid.h:76
BaseParticle * getHGridNextObject() const
Returns pointer to next object in particle's HGrid level & cell.
Definition: BaseParticle.h:242
unsigned int getHGridLevel() const
Returns particle's HGrid level.
Definition: BaseParticle.h:234
int getHGridX() const
Returns particle's HGrid cell X-coordinate.
Definition: BaseParticle.h:265
void Mercury2D::hGridUpdateParticle ( BaseParticle obj)
overrideprotected

Updates the cell (not the level) of a BaseParticle.

Parameters
[in]objThe BaseParticle we want to update the position in the grid for.

Updates the HGrid positions (x and y) of the given BaseParticle.

Definition at line 320 of file Mercury2D.cc.

References HGrid::computeHashBucketIndex(), HGrid::getFirstBaseParticleInBucket(), MercuryBase::getHGrid(), BaseParticle::getHGridLevel(), BaseParticle::getHGridX(), BaseParticle::getHGridY(), HGrid::getInvCellSize(), BaseInteractable::getPosition(), hGridRemoveParticle(), HGrid::setFirstBaseParticleInBucket(), BaseParticle::setHGridNextObject(), BaseParticle::setHGridPrevObject(), BaseParticle::setHGridX(), BaseParticle::setHGridY(), Vec3D::X, and Vec3D::Y.

321 {
322  HGrid* hGrid = getHGrid();
323  if (hGrid)
324  {
325  unsigned int l = obj->getHGridLevel();
326  Mdouble inv_size = hGrid->getInvCellSize(l);
327 
328  int x = static_cast<int>(std::floor(obj->getPosition().X * inv_size));
329  int y = static_cast<int>(std::floor(obj->getPosition().Y * inv_size));
330 
331 #ifdef CONTACT_LIST_HGRID
332  if(obj->getHGridX() != x || obj->getHGridY() != y)
333  {
334  int bucket = hGrid->computeHashBucketIndex(x, y, l);
335 
336  //First the object has to be removed
337  hGridRemoveParticle(obj);
338 
339  //Also remove all contact associated with it
340  getPossibleContactList().remove_ParticlePosibleContacts(obj);
341 
342  //And now reinserted
344  obj->setHGridPrevObject(nullptr);
345  if(hGrid->getFirstBaseParticleInBucket(bucket))
346  {
348  }
349  hGrid->setFirstBaseParticleInBucket(bucket,obj);
350 
351  obj->setHGridX(x);
352  obj->setHGridY(y);
353  InsertObjAgainstGrid(obj);
354  }
355 #else
356  unsigned int bucket = hGrid->computeHashBucketIndex(x, y, l);
357 
359  obj->setHGridPrevObject(nullptr);
360  if (hGrid->getFirstBaseParticleInBucket(bucket))
361  {
363  }
364 
365  hGrid->setFirstBaseParticleInBucket(bucket, obj);
366 
367  obj->setHGridX(x);
368  obj->setHGridY(y);
369 #endif
370  }
371 }
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
Mdouble X
the vector components
Definition: Vector.h:65
double Mdouble
Definition: GeneralDefine.h:34
void setHGridY(const int y)
Sets the particle's HGrid cell Y-coordinate.
Definition: BaseParticle.h:454
void setHGridNextObject(BaseParticle *p)
Sets the pointer to the next object in the particle's HGrid cell & level.
Definition: BaseParticle.h:477
int getHGridY() const
Returns particle's HGrid cell Y-coordinate.
Definition: BaseParticle.h:272
void setHGridX(const int x)
Sets the particle's HGrid cell X-coordinate.
Definition: BaseParticle.h:446
In the HGrid class, here all information about the HGrid is stored.
Definition: HGrid.h:42
void setFirstBaseParticleInBucket(unsigned int i, BaseParticle *p)
Sets the first particle in bucket i to be the given BaseParticle.
Definition: HGrid.h:117
Mdouble Y
Definition: Vector.h:65
void setHGridPrevObject(BaseParticle *p)
Sets the pointer to the previous object in the particle's HGrid cell & level.
Definition: BaseParticle.h:485
HGrid * getHGrid()
Gets the HGrid used by this problem.
Definition: MercuryBase.h:311
const BaseParticle * getFirstBaseParticleInBucket(unsigned int i) const
Gets the first BaseParticle in the given bucket, const version.
Definition: HGrid.h:162
unsigned int computeHashBucketIndex(int x, int y, int z, unsigned int l) const
Computes hash bucket index in range [0, NUM_BUCKETS-1] for a 3D domain.
Definition: HGrid.h:76
unsigned int getHGridLevel() const
Returns particle's HGrid level.
Definition: BaseParticle.h:234
double getInvCellSize(unsigned int i) const
Gets 1/cellSize for the cells on level i.
Definition: HGrid.h:178
int getHGridX() const
Returns particle's HGrid cell X-coordinate.
Definition: BaseParticle.h:265
void hGridRemoveParticle(BaseParticle *obj) override
Removes a BaseParticle to the HGrid.
Definition: Mercury2D.cc:378

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