MercuryDPM  Beta
MercuryBase Class Referenceabstract

This is the base class for both Mercury2D and Mercury3D. Note the actually abstract grid is defined in the class Grid defined below. More...

#include <MercuryBase.h>

Inheritance diagram for MercuryBase:

## Public Member Functions

MercuryBase ()
This is the default constructor. It sets sensible defaults. More...

~MercuryBase ()
This is the default destructor. More...

MercuryBase (const MercuryBase &mercuryBase)
Copy-constructor. More...

void constructor ()
This is the actual constructor, it is called do both constructors above. More...

void hGridActionsBeforeTimeLoop () override
This sets up the broad phase information, has to be done at this stage because it requires the particle size. More...

void hGridActionsBeforeTimeStep () override
Performs all necessary actions before a time-step, like updating the particles and resetting all the bucket information, etc. More...

Reads the MercuryBase from an input stream, for example a restart file. More...

void write (std::ostream &os, bool writeAllParticles=true) const override
Writes the MercuryBase to an output stream, for example a restart file. More...

Mdouble getHGridCurrentMaxRelativeDisplacement () const
Returns hGridCurrentMaxRelativeDisplacement_. More...

Mdouble getHGridTotalCurrentMaxRelativeDisplacement () const
Returns hGridTotalCurrentMaxRelativeDisplacement_. More...

void setHGridUpdateEachTimeStep (bool updateEachTimeStep)
Sets whether or not the HGrid must be updated every time step. More...

bool getHGridUpdateEachTimeStep () const override
Gets whether or not the HGrid is updated every time step. More...

void setHGridMaxLevels (unsigned int HGridMaxLevels)
Sets the maximum number of levels of the HGrid in this MercuryBase. More...

unsigned int getHGridMaxLevels () const
Gets the maximum number of levels of the HGrid in this MercuryBase. More...

HGridMethod getHGridMethod () const
Gets whether the HGrid in this MercuryBase is BOTTOMUP or TOPDOWN. More...

void setHGridMethod (HGridMethod hGridMethod)
Sets the HGridMethod to either BOTTOMUP or TOPDOWN. More...

HGridDistribution getHGridDistribution () const
Gets how the sizes of the cells of different levels are distributed. More...

void setHGridDistribution (HGridDistribution hGridDistribution)
Sets how the sizes of the cells of different levels are distributed. More...

Mdouble getHGridCellOverSizeRatio () const
Gets the ratio of the smallest cell over the smallest particle. More...

void setHGridCellOverSizeRatio (Mdouble cellOverSizeRatio)
Sets the ratio of the smallest cell over the smallest particle. More...

bool hGridNeedsRebuilding ()
Gets if the HGrid needs rebuilding before anything else happens. More...

virtual unsigned int getHGridTargetNumberOfBuckets () const
Gets the desired number of buckets, which is the maximum of the number of particles and 10. More...

Gets the desired size of the smallest cells of the HGrid. More...

Gets the desired size of the largest cells of the HGrid. More...

bool checkParticleForInteraction (const BaseParticle &P) override
Checks if given BaseParticle has an interaction with a BaseWall or other BaseParticle. More...

virtual Mdouble userHGridCellSize (unsigned int level)
Virtual function that enables inheriting classes to implement a function to let the user set the cell size of the HGrid. More...

void hGridInfo () const
Writes the info of the HGrid to the screen in a nice format. More...

Public Member Functions inherited from DPMBase
void constructor ()
A function which initialises the member variables to default values, so that the problem can be solved off the shelf; sets up a basic two dimensional problem which can be solved off the shelf. It is called in the constructor DPMBase(). More...

DPMBase ()
Constructor that calls the "void constructor()". More...

DPMBase (const FilesAndRunNumber &other)
Copy constructor type-1. More...

DPMBase (const DPMBase &other)
Copy constructor type-2. More...

virtual ~DPMBase ()
virtual destructor More...

void solve ()
The work horse of the code. More...

void checkSettings ()
Checks if the essentials are set properly to go ahead with solving the problem. More...

virtual void writeOutputFiles ()
Writes the simulation data onto all the files i.e. .data, .ene, .fstat ... More...

void solve (int argc, char *argv[])
The solve function is the work horse of the code with the user input. More...

virtual void 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 double getInfo (const BaseParticle &P) const
A virtual method that allows the user to overrride and set what is written into the info column in the data file. By default it returns the Species ID number. More...

virtual void writeRestartFile ()
Stores all the particle data for current save time step. Calls the write function. More...

Reads all the particle data corresponding to the current saved time step. Which is what the restart file basically stores. The problem description with the latest particle data. More...

Also reads all the particle data corresponding to the current saved time step. More...

Reads all particle data into a restart file; old version. More...

bool readDataFile (const std::string fileName, unsigned int format=0)
This allows particle data to be reloaded from data files. More...

Allows the user to read par.ini files (useful to read MDCLR files) More...

Reads the next data file with default format=0. However, one can modify the format based on whether the particle data corresponds to 3D or 2D data. See XBalls/xballs.txt. More...

bool findNextExistingDataFile (Mdouble tMin, bool verbose=true)
Useful when fileType is chosen as Multiple Files or Multiple files with padded. More...

bool readArguments (int argc, char *argv[])
Can interpret main function input arguments that are passed by the driver codes. More...

Mdouble getTime () const
Access function for the time. More...

unsigned int getNtimeSteps () const
Returns the current counter of time steps. More...

void setTime (Mdouble time)
Access function for the time. More...

void setTimeMax (Mdouble newTMax)
Allows the upper time limit to be changed. More...

Mdouble getTimeMax () const
Allows the user to access the total simulation time during the simulation. Cannot change it though. More...

void setDoCGAlways (bool newDoCGFlag)

void setRotation (bool newRotFlag)
Allows to set the flag for enabling or disabling particle rotation in the simulations. More...

bool getRotation () const
Returns a flag indicating if particle rotation is enabled or disabled. More...

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

void setXMin (Mdouble newXMin)
If the length of the problem domain in x-direction is XMax - XMin, this method sets XMin. More...

void setYMin (Mdouble newYMin)
If the length of the problem domain in y-direction is YMax - YMin, this method sets YMin. More...

void setZMin (Mdouble newZMin)
If the length of the problem domain in z-direction is ZMax - ZMin, this method sets ZMin. More...

void setXMax (Mdouble newXMax)
If the length of the problem domain in x-direction is XMax - XMin, this method sets XMax. More...

void setYMax (Mdouble newYMax)
If the length of the problem domain in y-direction is YMax - YMin, this method sets YMax. More...

void setZMax (Mdouble newZMax)
If the length of the problem domain in z-direction is XMax - XMin, this method sets ZMax. More...

void setTimeStep (Mdouble newDt)
Allows the time step dt to be changed. More...

Mdouble getTimeStep () const
Allows the time step dt to be accessed. More...

void setXBallsColourMode (int newCMode)
Set the xball output mode. More...

int getXBallsColourMode () const
Get the xball colour mode (CMode) More...

void setXBallsVectorScale (double newVScale)
Set the scale of vectors in xballs. More...

double getXBallsVectorScale () const
Returns the scale of vectors used in xballs. More...

Set the additional arguments for xballs. More...

void setXBallsScale (Mdouble newScale)
Sets the scale of the view (either normal, zoom in or zoom out) to display in xballs. The default is fit to screen. More...

double getXBallsScale () const
Returns the scale of the view in xballs. More...

void setGravity (Vec3D newGravity)
Allows to modify the gravity vector. More...

Vec3D getGravity () const
Returns the gravity vector. More...

void setDimension (unsigned int newDim)
Sets the system and particle dimension. More...

void setSystemDimensions (unsigned int newDim)
Allows for the dimension of the simulation to be changed. More...

unsigned int getSystemDimensions () const
Returns the dimension of the simulation. Note there is also a particle dimension. More...

void setParticleDimensions (unsigned int particleDimensions)
Allows the dimension of the particle (f.e. for mass) to be changed. e.g. discs or spheres. More...

unsigned int getParticleDimensions () const
Returns the particle dimensions. More...

std::string getRestartVersion () const
This is to take into account for different Mercury versions. Returns the version of the restart file. More...

void setRestartVersion (std::string newRV)
Sets restart_version. More...

bool getRestarted () const
Returns the flag denoting if the simulation was restarted or not. More...

void setRestarted (bool newRestartedFlag)
Allows to set the flag stating if the simulation is to be restarted or not. More...

bool getAppend () const
Returns the flag denoting if the append option is on or off. More...

void setAppend (bool newAppendFlag)
Allows to set the append option. More...

Mdouble getElasticEnergy () const
Returns the global elastic energy within the system. More...

Mdouble getKineticEnergy () const
Returns the global kinetic energy stored in the system. More...

bool areInContact (const BaseParticle *pI, const BaseParticle *pJ) const
Checks if two particle are in contact or is there any positive overlap. More...

virtual void hGridInsertParticle (BaseParticle *obj UNUSED)
no implementation but can be overidden in its derived classes. More...

virtual void hGridUpdateParticle (BaseParticle *obj UNUSED)
no implementation but can be overidden in its derived classes. More...

virtual void hGridRemoveParticle (BaseParticle *obj UNUSED)
no implementation but can be overidden in its derived classes. More...

virtual void gatherContactStatistics (unsigned int index1 UNUSED, int index2 UNUSED, Vec3D Contact UNUSED, Mdouble delta UNUSED, Mdouble ctheta UNUSED, Mdouble fdotn UNUSED, Mdouble fdott UNUSED, Vec3D P1_P2_normal_ UNUSED, Vec3D P1_P2_tangential UNUSED)
//Not unsigned index because of possible wall collisions. More...

Public Member Functions inherited from FilesAndRunNumber
FilesAndRunNumber ()
Constructor. More...

FilesAndRunNumber (const FilesAndRunNumber &other)
Copy constructor. More...

virtual ~FilesAndRunNumber ()
Constructor. More...

void constructor ()
a function called by the FilesAndRunNumber() (constructor) More...

void incrementRunNumberInFile ()
Increment the run Number (counter value) stored in the file_counter (COUNTER_DONOTDEL) by 1 and store the new value in the counter file. More...

Read the run number or the counter from the counter file (COUNTER_DONOTDEL) More...

void autoNumber ()
The autoNumber() function is the trigger. It calls three functions. setRunNumber(), readRunNumberFromFile() and incrementRunNumberInFile(). More...

std::vector< int > get2DParametersFromRunNumber (int size_x, int size_y)
This turns a counter into two indices which is an amazing feature for doing two dimensional parameter studies. The indices run from 1:size_x and 1:size_y, while the study number starts at 0 ( initially the counter=1 in COUNTER_DONOTDEL) More...

int launchNewRun (const char *name, bool quick=false)
This launches a code from within this code. Please pass the name of the code to run. More...

void setRunNumber (int runNumber)
This sets the counter/Run number, overriding the defaults. More...

int getRunNumber () const
This returns the current value of the counter (runNumber_) More...

Accepts an input stream std::istream. More...

void write (std::ostream &os) const
Accepts an output stream read function, which accepts an input stream std::ostream. More...

Public Member Functions inherited from Files
Files ()
A constructor. More...

virtual ~Files ()
A destructor, watch out its a virtual destructor. More...

Files (const Files &other)
Copy constructor. More...

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

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

Extracts data from the input stream (which is basically a file you want to read from) into name_, restartFile .... More...

void write (std::ostream &os) const
Writes data into a file from the member variables name_, restartFile, dataFile etc. More...

void openFiles ()
Opens all the files (ene, data, fstat, restart, stat) for reading and writing purposes. More...

void closeFiles ()
Closes all files (ene, data, fstat, restart, stat) that were opened to read or write. More...

void setNextSavedTimeStep (unsigned int nextSavedTimeStep)
Sets the next time step for all the files (ene, data, fstat, restart, stat) at which the data is to be written or saved. More...

## Protected Member Functions

void hGridRebuild ()
This sets up the parameters required for the contact model. More...

void hGridInsertParticle (BaseParticle *obj) override
Inserts a single Particle to current grid. More...

This checks particles in the HGRID to see if for closer enough for possible contact. More...

virtual void hGridFindOneSidedContacts (BaseParticle *obj)=0
This is a purely virtual function that checks if an object is in the grid, this code is dimension dependent so purely virtual at this stage. More...

virtual bool hGridHasParticleContacts (const BaseParticle *obj)=0
Purely virtual function that checks if the given particle has a possible contact with any other BaseParticle in the HGrid. More...

void hGridUpdateMove (BaseParticle *iP, Mdouble move) override
Computes the relative displacement of the given BaseParticle and updates the currentMaxRelativeDisplacement_ accordingly. More...

void hGridActionsBeforeIntegration () override
Resets the currentMaxRelativeDisplacement_ to 0. More...

void hGridActionsAfterIntegration () override
Sets the totalCurrentMaxRelativeDisplacement_ as 2*currentMaxRelativeDisplacement_. More...

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 by using the setTorque and setForce methods. See BaseInteractible.cc. More...

virtual void computeInternalForces (BaseParticle *i)
Computes the forces between particles (internal in the sense that the sum over all these forces is zero i.e. fully modelled forces) More...

virtual void computeInternalForces (BaseParticle *P1, BaseParticle *P2)
Computes the forces between particles (internal in the sense that the sum over all these forces is zero i.e. fully modelled forces) More...

virtual void computeExternalForces (BaseParticle *PI)
Computes the external forces acting on particles (e.g. gravitational) More...

virtual void computeForcesDueToWalls (BaseParticle *PI)
Computes the forces on the particles due to the walls (normals are outward normals) More...

virtual void actionsOnRestart ()
A virtual function where the users can add extra code which is executed only when the code is restarted. More...

virtual void actionsBeforeTimeLoop ()
A virtual function. Allows one to carry out any operations before the start of the time loop. More...

virtual void 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...

virtual void outputXBallsData (std::ostream &os) const
This function writes the location of the walls and particles in a format the XBalls program can read. See XBalls/xballs.txt. However, MercuryDPM supports a much better viewer now called Paraview. See the tutorials section in the documentation. More...

virtual void outputXBallsDataParticle (const unsigned int i, const unsigned int format, std::ostream &os) const
This function writes out the particle locations into an output stream in a format the XBalls program can read. More...

virtual void writeEneHeader (std::ostream &os) const
Writes a header with a certain format for ENE file. More...

virtual void writeFstatHeader (std::ostream &os) const
Writes a header with a certain format for FStat file. More...

virtual void writeEneTimestep (std::ostream &os) const
This function enables one to write the global energy available in the system after each time step. The default is to compute the rotational and translational kinetic energy, potential energy and the centre of mass. More...

virtual void initialiseStatistics ()
no implementation but can be overidden in its derived classes. More...

virtual void outputStatistics ()
no implementation but can be overidden in its derived classes. More...

void gatherContactStatistics ()

virtual void processStatistics (bool usethese UNUSED)
no implementation but can be overidden in its derived classes. More...

virtual void finishStatistics ()
no implementation but can be overidden in its derived classes. More...

virtual void integrateBeforeForceComputation ()
This is were the integration is done, at the moment it is velocity Verlet integration and is done before the forces are computed. See http://en.wikipedia.org/wiki/Verlet_integration#Velocity_Verlet. More...

virtual void integrateAfterForceComputation ()
Integration is done after force computations. We apply the Velocity verlet scheme. See http://en.wikipedia.org/wiki/Verlet_integration#Velocity_Verlet. More...

virtual void checkInteractionWithBoundaries ()
There are a range of boundaries one could implement depending on ones' problem. This methods checks for interactions between particles and such range of boundaries. See BaseBoundary.h and all the boundaries in the Boundaries folder. More...

void setFixedParticles (unsigned int n)

void initialiseTangentialSprings ()

virtual void printTime () const
Displays the current simulation time onto your screen for example. More...

virtual bool continueSolve () const

void outputInteractionDetails () const
Displays the interaction details corresponding to the pointer objects in the interaction handler. More...

bool isTimeEqualTo (Mdouble time) const
Checks if the input variable "time" is the current time in the simulation. More...

void removeDuplicatePeriodicParticles ()
Removes periodic duplicate Particles. More...

void checkAndDuplicatePeriodicParticles ()
In case of periodic boundaries, the below methods checks and adds particles when necessary into the particle handler. See DPMBase.cc and PeriodicBoundary.cc for more details. More...

## Private Attributes

HGridgrid
A pointer to the HGrid associated with this MercuryBase. More...

HGridMethod hGridMethod_
Indicator of which way the interactions between different levels are tested. More...

HGridDistribution hGridDistribution_
Indicator for the distribution of the sizes of the cells of different levels of the HGrid. The default is EXPONENTIAL. More...

Mdouble currentMaxRelativeDisplacement_
Mdouble that denotes the maximum of the displacement of a particle divided by the cell size of the level of that particle at the current time step. This is useful to see whether a particle could have moved more than one cell. More...

Mdouble totalCurrentMaxRelativeDisplacement_
After each time step, this Mdouble is increased by 2*currentMaxRelativeDisplacement_. More...

bool gridNeedsUpdate_
Boolean that indicates whether or not the grid needs to be updated. More...

bool updateEachTimeStep_
Boolean which indicates whether or not the cell in which a particle is must be updated every timestep. More...

unsigned int hGridMaxLevels_
Unsigned integer that indicates the maximum number of levels of the HGrid. More...

Mdouble hGridCellOverSizeRatio_
The maximum ratio between the size of the cells and the BaseParticle they contain. More...

Public Attributes inherited from DPMBase
SpeciesHandler speciesHandler
A handler to that stores the species type i.e. elastic, linear visco-elastic... et cetera. More...

RNG random
This is a random generator, often used for setting up the initial conditions etc... More...

ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created. More...

WallHandler wallHandler
An object of the class WallHandler. Contains pointers to all the walls created. More...

BoundaryHandler boundaryHandler
An object of the class BoundaryHandler which concerns insertion and deletion of particles into or from regions. More...

InteractionHandler interactionHandler
An object of the class InteractionHandler. More...

Public Attributes inherited from Files
File dataFile
An instance of class File to handle in- and output into a .data file. More...

File fStatFile
An instance of class File to handle in- and output into a .fstat file. More...

File eneFile
An instance of class File to handle in- and output into a .ene file. More...

File restartFile
An instance of class File to handle in- and output into a .restart file. More...

File statFile
An instance of class File to handle in- and output into a .stat file. More...

## Detailed Description

This is the base class for both Mercury2D and Mercury3D. Note the actually abstract grid is defined in the class Grid defined below.

Todo:
Discuss if we want to remove Mercury2D and Mercury3D and template MercuryBase as the interface for the user.

Definition at line 74 of file MercuryBase.h.

## Constructor & Destructor Documentation

 MercuryBase::MercuryBase ( )

This is the default constructor. It sets sensible defaults.

Definition at line 34 of file MercuryBase.cc.

References constructor(), DEBUG, and logger.

35 {
36  constructor();
37  logger(DEBUG, "MercuryBase::MercuryBase() constructor finished");
38 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
void constructor()
This is the actual constructor, it is called do both constructors above.
Definition: MercuryBase.cc:80
 MercuryBase::~MercuryBase ( )

This is the default destructor.

Definition at line 40 of file MercuryBase.cc.

References DEBUG, grid, and logger.

41 {
42  if (grid != nullptr)
43  {
44  delete grid;
45  grid = nullptr;
46  }
47  logger(DEBUG, "MercuryBase::~MercuryBase() destructor finished.");
48 }
HGrid * grid
A pointer to the HGrid associated with this MercuryBase.
Definition: MercuryBase.h:281
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
 MercuryBase::MercuryBase ( const MercuryBase & mercuryBase )

Copy-constructor.

Parameters
 [in] mercuryBase The MercuryBase that needs to be copied.

Copy constructor that copies almost all properties of the given MercuryBase into the new MercuryBase. Please note that the grid is not literally copied, but everything to make that grid is copied and the gridNeedsUpdate_ is set to true, so that the grid is made before anything else happens.

Definition at line 58 of file MercuryBase.cc.

59 {
60  grid = nullptr;
61  gridNeedsUpdate_ = true;
62
63  hGridMethod_ = mercuryBase.hGridMethod_;
65
68
70  hGridMaxLevels_ = mercuryBase.hGridMaxLevels_;
72
73  logger(DEBUG, "HGRID_base(HGrid_base& other) constructor finished.");
74 }
Mdouble totalCurrentMaxRelativeDisplacement_
After each time step, this Mdouble is increased by 2*currentMaxRelativeDisplacement_.
Definition: MercuryBase.h:313
HGrid * grid
A pointer to the HGrid associated with this MercuryBase.
Definition: MercuryBase.h:281
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
HGridDistribution hGridDistribution_
Indicator for the distribution of the sizes of the cells of different levels of the HGrid...
Definition: MercuryBase.h:299
unsigned int hGridMaxLevels_
Unsigned integer that indicates the maximum number of levels of the HGrid.
Definition: MercuryBase.h:341
Mdouble hGridCellOverSizeRatio_
The maximum ratio between the size of the cells and the BaseParticle they contain.
Definition: MercuryBase.h:349
HGridMethod hGridMethod_
Indicator of which way the interactions between different levels are tested.
Definition: MercuryBase.h:293
bool updateEachTimeStep_
Boolean which indicates whether or not the cell in which a particle is must be updated every timestep...
Definition: MercuryBase.h:327
bool gridNeedsUpdate_
Boolean that indicates whether or not the grid needs to be updated.
Definition: MercuryBase.h:321
Mdouble currentMaxRelativeDisplacement_
Mdouble that denotes the maximum of the displacement of a particle divided by the cell size of the le...
Definition: MercuryBase.h:307

## Member Function Documentation

 void MercuryBase::broadPhase ( BaseParticle * i )
overrideprotectedvirtual

This checks particles in the HGRID to see if for closer enough for possible contact.

Parameters
 [in] i A pointer to the BaseParticle for which we want to see if there are interactions on its own level.

Reimplemented from DPMBase.

Definition at line 314 of file MercuryBase.cc.

References hGridFindOneSidedContacts().

315 {
317 }
virtual void hGridFindOneSidedContacts(BaseParticle *obj)=0
This is a purely virtual function that checks if an object is in the grid, this code is dimension dep...
 bool MercuryBase::checkParticleForInteraction ( const BaseParticle & p )
overridevirtual

Checks if given BaseParticle has an interaction with a BaseWall or other BaseParticle.

Parameters
 [in] p The BaseParticle for which we want to check if there is an interaction.
Returns
A boolean which is false if there was an interaction and true if there was no interaction.

Check for the given BaseParticle if there is an interaction with any other object. First check all walls, then all particles.

Todo:
IFCD: I think it might be better if it returns true if there is an interaction.

Reimplemented from DPMBase.

Definition at line 609 of file MercuryBase.cc.

Referenced by Chute::createBottom(), and ChuteBottom::setupInitialConditions().

610 {
611  Mdouble distance;
612  Vec3D normal;
613
614  //Check if it has no collision with walls
615  for (std::vector<BaseWall*>::const_iterator it = wallHandler.begin(); it != wallHandler.end(); it++)
616  {
617  if ((*it)->getDistanceAndNormal(p, distance, normal))
618  {
619  logger(VERBOSE, "Collision with wall %.", **it);
620  return false;
621  }
622  else
623  {
624  logger(VERBOSE, "No collision with wall %.", **it);
625  }
626  }
627
628  //Check if it has no collision with other particles
629  if (hGridHasParticleContacts(&p))
630  {
631  logger(VERBOSE, "Collision with particle.");
632  return false;
633  }
634  else
635  {
636  logger(VERBOSE, "No collision with particles.");
637  }
638  return true;
639 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
const std::vector< T * >::const_iterator end() const
Gets the end of the const_iterator over all BaseBoundary in this BaseHandler.
Definition: BaseHandler.h:494
double Mdouble
const std::vector< T * >::const_iterator begin() const
Gets the begin of the const_iterator over all Object in this BaseHandler.
Definition: BaseHandler.h:482
WallHandler wallHandler
An object of the class WallHandler. Contains pointers to all the walls created.
Definition: DPMBase.h:883
virtual bool hGridHasParticleContacts(const BaseParticle *obj)=0
Purely virtual function that checks if the given particle has a possible contact with any other BaseP...
Implementation of a 3D vector (by Vitaliy).
Definition: Vector.h:45
 void MercuryBase::constructor ( )

This is the actual constructor, it is called do both constructors above.

Function that is called by the default constructor, it sets all parameters for the MercuryBase to sensible defaults.

Definition at line 80 of file MercuryBase.cc.

Referenced by MercuryBase().

81 {
82  grid = nullptr;
83  gridNeedsUpdate_ = true;
84  hGridMaxLevels_ = 3;
86  updateEachTimeStep_ = true;
89 }
HGrid * grid
A pointer to the HGrid associated with this MercuryBase.
Definition: MercuryBase.h:281
HGridDistribution hGridDistribution_
Indicator for the distribution of the sizes of the cells of different levels of the HGrid...
Definition: MercuryBase.h:299
unsigned int hGridMaxLevels_
Unsigned integer that indicates the maximum number of levels of the HGrid.
Definition: MercuryBase.h:341
Mdouble hGridCellOverSizeRatio_
The maximum ratio between the size of the cells and the BaseParticle they contain.
Definition: MercuryBase.h:349
HGridMethod hGridMethod_
Indicator of which way the interactions between different levels are tested.
Definition: MercuryBase.h:293
bool updateEachTimeStep_
Boolean which indicates whether or not the cell in which a particle is must be updated every timestep...
Definition: MercuryBase.h:327
bool gridNeedsUpdate_
Boolean that indicates whether or not the grid needs to be updated.
Definition: MercuryBase.h:321
 HGrid * MercuryBase::getHGrid ( )
protected

Gets the HGrid used by this problem.

Returns
A pointer to the HGrid associated with this MercuryBase.

Definition at line 389 of file MercuryBase.cc.

References grid.

390 {
391  return grid;
392 }
HGrid * grid
A pointer to the HGrid associated with this MercuryBase.
Definition: MercuryBase.h:281
 const HGrid * MercuryBase::getHGrid ( ) const
protected

Gets the HGrid used by this problem, const version.

Returns
A pointer to the (constant) HGrid associated with this MercuryBase.

Definition at line 397 of file MercuryBase.cc.

References grid.

398 {
399  return grid;
400 }
HGrid * grid
A pointer to the HGrid associated with this MercuryBase.
Definition: MercuryBase.h:281
 Mdouble MercuryBase::getHGridCellOverSizeRatio ( ) const

Gets the ratio of the smallest cell over the smallest particle.

Returns
The maximum ratio between the cells and the size of the BaseParticle it contains.

Definition at line 477 of file MercuryBase.cc.

References hGridCellOverSizeRatio_.

478 {
480 }
Mdouble hGridCellOverSizeRatio_
The maximum ratio between the size of the cells and the BaseParticle they contain.
Definition: MercuryBase.h:349
 Mdouble MercuryBase::getHGridCurrentMaxRelativeDisplacement ( ) const

Returns hGridCurrentMaxRelativeDisplacement_.

Returns
currentMaxRelativeDisplacement_, which is the highest relative speed of a BaseParticle compared to the cell size of the grid in which the BaseParticle is.

Definition at line 154 of file MercuryBase.cc.

References currentMaxRelativeDisplacement_.

155 {
157 }
Mdouble currentMaxRelativeDisplacement_
Mdouble that denotes the maximum of the displacement of a particle divided by the cell size of the le...
Definition: MercuryBase.h:307
 HGridDistribution MercuryBase::getHGridDistribution ( ) const

Gets how the sizes of the cells of different levels are distributed.

Returns
The HGridDistribution (distribution of cell sizes) used by this MercuryBase.

Definition at line 455 of file MercuryBase.cc.

References hGridDistribution_.

Referenced by hGridRebuild().

456 {
457  return hGridDistribution_;
458 }
HGridDistribution hGridDistribution_
Indicator for the distribution of the sizes of the cells of different levels of the HGrid...
Definition: MercuryBase.h:299
 unsigned int MercuryBase::getHGridMaxLevels ( ) const

Gets the maximum number of levels of the HGrid in this MercuryBase.

Returns
The maximum number of levels in the HGrid.

Definition at line 512 of file MercuryBase.cc.

References hGridMaxLevels_.

Referenced by hGridRebuild(), and write().

513 {
514  return hGridMaxLevels_;
515 }
unsigned int hGridMaxLevels_
Unsigned integer that indicates the maximum number of levels of the HGrid.
Definition: MercuryBase.h:341
 HGridMethod MercuryBase::getHGridMethod ( ) const

Gets whether the HGrid in this MercuryBase is BOTTOMUP or TOPDOWN.

Returns
The HGridMethod used by this MercuryBase.

Definition at line 439 of file MercuryBase.cc.

References hGridMethod_.

Referenced by Mercury2D::hGridFindOneSidedContacts(), and Mercury3D::hGridFindOneSidedContacts().

440 {
441  return hGridMethod_;
442 }
HGridMethod hGridMethod_
Indicator of which way the interactions between different levels are tested.
Definition: MercuryBase.h:293
virtual

Gets the desired size of the largest cells of the HGrid.

Returns
The interaction radius of the largest particle multiplied by the maximum ratio between the cell size and particle size.

Definition at line 591 of file MercuryBase.cc.

Referenced by hGridRebuild().

592 {
594  {
595  return 0.0;
596  }
597  else
598  {
600  }
601 }
BaseParticle * getLargestParticle() const
Gets a pointer to the largest BaseParticle (by interactionRadius) in this ParticleHandler.
Mdouble getHGridCellOverSizeRatio() const
Gets the ratio of the smallest cell over the smallest particle.
Definition: MercuryBase.cc:477
ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created...
Definition: DPMBase.h:878
unsigned int getNumberOfObjects() const
Gets the number of Object in this BaseHandler.
Definition: BaseHandler.h:464
Returns the particle's interaction radius, which might be different from radius_ (e.g., when dealing with wet particles)
virtual

Gets the desired size of the smallest cells of the HGrid.

Returns
The interaction radius of the smallest particle multiplied by the maximum ratio between the cell size and particle size.

Definition at line 575 of file MercuryBase.cc.

Referenced by hGridRebuild().

576 {
578  {
579  return 0.0;
580  }
581  else
582  {
584  }
585 }
Mdouble getHGridCellOverSizeRatio() const
Gets the ratio of the smallest cell over the smallest particle.
Definition: MercuryBase.cc:477
BaseParticle * getSmallestParticle() const
Gets a pointer to the smallest BaseParticle (by interactionRadius) in this ParticleHandler.
ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created...
Definition: DPMBase.h:878
unsigned int getNumberOfObjects() const
Gets the number of Object in this BaseHandler.
Definition: BaseHandler.h:464
Returns the particle's interaction radius, which might be different from radius_ (e.g., when dealing with wet particles)
 unsigned int MercuryBase::getHGridTargetNumberOfBuckets ( ) const
virtual

Gets the desired number of buckets, which is the maximum of the number of particles and 10.

Returns
The number of possible values the hash function can have.

Definition at line 558 of file MercuryBase.cc.

References BaseHandler< T >::getNumberOfObjects(), and DPMBase::particleHandler.

Referenced by hGridNeedsRebuilding(), and hGridRebuild().

559 {
560  unsigned int nParticles = particleHandler.getNumberOfObjects();
561  if (nParticles > 10)
562  {
563  return nParticles;
564  }
565  else
566  {
567  return 10;
568  }
569 }
ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created...
Definition: DPMBase.h:878
unsigned int getNumberOfObjects() const
Gets the number of Object in this BaseHandler.
Definition: BaseHandler.h:464
 Mdouble MercuryBase::getHGridTotalCurrentMaxRelativeDisplacement ( ) const

Returns hGridTotalCurrentMaxRelativeDisplacement_.

Returns
totalCurrentMaxRelativeDisplacement_, which is the cumulative value of 2*currentMaxRelativeDisplacement_

Definition at line 163 of file MercuryBase.cc.

References totalCurrentMaxRelativeDisplacement_.

Referenced by hGridActionsBeforeTimeStep().

164 {
166 }
Mdouble totalCurrentMaxRelativeDisplacement_
After each time step, this Mdouble is increased by 2*currentMaxRelativeDisplacement_.
Definition: MercuryBase.h:313
 bool MercuryBase::getHGridUpdateEachTimeStep ( ) const
overridevirtual

Gets whether or not the HGrid is updated every time step.

Returns
A boolean which indicates if the HGrid must be updated every time step.

Reimplemented from DPMBase.

Definition at line 180 of file MercuryBase.cc.

References updateEachTimeStep_.

Referenced by hGridActionsBeforeTimeStep().

181 {
182  return updateEachTimeStep_;
183 }
bool updateEachTimeStep_
Boolean which indicates whether or not the cell in which a particle is must be updated every timestep...
Definition: MercuryBase.h:327
 void MercuryBase::hGridActionsAfterIntegration ( )
overrideprotectedvirtual

Sets the totalCurrentMaxRelativeDisplacement_ as 2*currentMaxRelativeDisplacement_.

Reimplemented from DPMBase.

Definition at line 381 of file MercuryBase.cc.

382 {
384 }
Mdouble totalCurrentMaxRelativeDisplacement_
After each time step, this Mdouble is increased by 2*currentMaxRelativeDisplacement_.
Definition: MercuryBase.h:313
Mdouble currentMaxRelativeDisplacement_
Mdouble that denotes the maximum of the displacement of a particle divided by the cell size of the le...
Definition: MercuryBase.h:307
 void MercuryBase::hGridActionsBeforeIntegration ( )
overrideprotectedvirtual

Resets the currentMaxRelativeDisplacement_ to 0.

Reimplemented from DPMBase.

Definition at line 376 of file MercuryBase.cc.

References currentMaxRelativeDisplacement_.

377 {
379 }
Mdouble currentMaxRelativeDisplacement_
Mdouble that denotes the maximum of the displacement of a particle divided by the cell size of the le...
Definition: MercuryBase.h:307
 void MercuryBase::hGridActionsBeforeTimeLoop ( )
overridevirtual

This sets up the broad phase information, has to be done at this stage because it requires the particle size.

Performs all actions that need to be done before the time loop. At the moment, this means nothing.

Reimplemented from DPMBase.

Definition at line 95 of file MercuryBase.cc.

Referenced by Chute::createBottom(), and ChuteBottom::setupInitialConditions().

96 {
97 }
 void MercuryBase::hGridActionsBeforeTimeStep ( )
overridevirtual

Performs all necessary actions before a time-step, like updating the particles and resetting all the bucket information, etc.

The actions that are done before each time step, it rebuilds the HGrid if necessary, otherwise it computes which cell each particle is in.

Todo:
IFCD Look up if stepsBeforeUpdate is actually used.
Todo:
TW: I believe the following two steps should be in hGridRebuild

Reimplemented from DPMBase.

Definition at line 324 of file MercuryBase.cc.

Referenced by Chute::createBottom().

325 {
327  static int stepsBeforeUpdate = 0;
328  if (hGridNeedsRebuilding())
329  {
330  //std::cout<<"HGrid needs rebuilding for void HGRID_base::hGridActionsBeforeTimeStep()"<<std::endl;
331  hGridRebuild();
334  stepsBeforeUpdate = 0;
335  }
336  else
337  {
338 #ifndef CONTACT_LIST_HGRID
340 #endif
342  {
343 #ifndef CONTACT_LIST_HGRID
345 #endif
347  for (std::vector<BaseParticle*>::iterator it = particleHandler.begin(); it != particleHandler.end(); ++it)
348  {
349  hGridUpdateParticle(*it);
350  }
351  stepsBeforeUpdate = 0;
352  }
353  else
354  {
355  stepsBeforeUpdate++;
356  }
357  }
358
359 }
virtual void hGridUpdateParticle(BaseParticle *obj UNUSED)
no implementation but can be overidden in its derived classes.
Definition: DPMBase.cc:633
bool hGridNeedsRebuilding()
Gets if the HGrid needs rebuilding before anything else happens.
Definition: MercuryBase.cc:520
Mdouble totalCurrentMaxRelativeDisplacement_
After each time step, this Mdouble is increased by 2*currentMaxRelativeDisplacement_.
Definition: MercuryBase.h:313
Mdouble getHGridCellOverSizeRatio() const
Gets the ratio of the smallest cell over the smallest particle.
Definition: MercuryBase.cc:477
void clearFirstBaseParticleInBucket()
For all buckets, it removes the pointer to the first BaseParticle in it, practically emptying the buc...
Definition: HGrid.cc:188
const std::vector< T * >::const_iterator end() const
Gets the end of the const_iterator over all BaseBoundary in this BaseHandler.
Definition: BaseHandler.h:494
const std::vector< T * >::const_iterator begin() const
Gets the begin of the const_iterator over all Object in this BaseHandler.
Definition: BaseHandler.h:482
Mdouble getHGridTotalCurrentMaxRelativeDisplacement() const
Returns hGridTotalCurrentMaxRelativeDisplacement_.
Definition: MercuryBase.cc:163
ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created...
Definition: DPMBase.h:878
void clearBucketIsChecked()
Sets all buckets to not-checked.
Definition: HGrid.cc:164
void hGridRebuild()
This sets up the parameters required for the contact model.
Definition: MercuryBase.cc:201
bool getHGridUpdateEachTimeStep() const override
Gets whether or not the HGrid is updated every time step.
Definition: MercuryBase.cc:180
HGrid * getHGrid()
Gets the HGrid used by this problem.
Definition: MercuryBase.cc:389
 virtual void MercuryBase::hGridFindOneSidedContacts ( BaseParticle * obj )
protectedpure virtual

This is a purely virtual function that checks if an object is in the grid, this code is dimension dependent so purely virtual at this stage.

Implemented in Mercury2D, and Mercury3D.

 virtual bool MercuryBase::hGridHasParticleContacts ( const BaseParticle * obj )
protectedpure virtual

Purely virtual function that checks if the given particle has a possible contact with any other BaseParticle in the HGrid.

Implemented in Mercury2D, and Mercury3D.

Referenced by checkParticleForInteraction().

 void MercuryBase::hGridInfo ( ) const

Writes the info of the HGrid to the screen in a nice format.

Definition at line 642 of file MercuryBase.cc.

643 {
644  std::cout << "Status of hGrid parameters:" << std::endl;
645  std::cout << "HGridMethod hGridMethod_=" << hGridMethod_ << std::endl;
646  std::cout << "HGridDistribution hGridDistribution_=" << hGridDistribution_ << std::endl;
647  std::cout << "Mdouble currentMaxRelativeDisplacement_=" << currentMaxRelativeDisplacement_ << std::endl;
648  std::cout << "Mdouble totalCurrentMaxRelativeDisplacement_=" << totalCurrentMaxRelativeDisplacement_ << std::endl;
649  std::cout << "bool gridNeedsUpdate_=" << gridNeedsUpdate_ << std::endl;
650  std::cout << "bool updateEachTimeStep_=" << updateEachTimeStep_ << std::endl;
651  std::cout << "unsigned int hGridMaxLevels_=" << hGridMaxLevels_ << std::endl;
652  std::cout << "Mdouble hGridCellOverSizeRatio_=" << hGridCellOverSizeRatio_ << std::endl;
653  if (grid != nullptr)
654  {
655  grid->info();
656  } else
657  {
658  std::cout << "hGrid does not exist yet" << std::endl;
659  }
660 }
Mdouble totalCurrentMaxRelativeDisplacement_
After each time step, this Mdouble is increased by 2*currentMaxRelativeDisplacement_.
Definition: MercuryBase.h:313
HGrid * grid
A pointer to the HGrid associated with this MercuryBase.
Definition: MercuryBase.h:281
void info() const
Displays the member variables of the hGrid object. This function is intended for debugging the hGrid...
Definition: HGrid.cc:290
HGridDistribution hGridDistribution_
Indicator for the distribution of the sizes of the cells of different levels of the HGrid...
Definition: MercuryBase.h:299
unsigned int hGridMaxLevels_
Unsigned integer that indicates the maximum number of levels of the HGrid.
Definition: MercuryBase.h:341
Mdouble hGridCellOverSizeRatio_
The maximum ratio between the size of the cells and the BaseParticle they contain.
Definition: MercuryBase.h:349
HGridMethod hGridMethod_
Indicator of which way the interactions between different levels are tested.
Definition: MercuryBase.h:293
bool updateEachTimeStep_
Boolean which indicates whether or not the cell in which a particle is must be updated every timestep...
Definition: MercuryBase.h:327
bool gridNeedsUpdate_
Boolean that indicates whether or not the grid needs to be updated.
Definition: MercuryBase.h:321
Mdouble currentMaxRelativeDisplacement_
Mdouble that denotes the maximum of the displacement of a particle divided by the cell size of the le...
Definition: MercuryBase.h:307
 void MercuryBase::hGridInsertParticle ( BaseParticle * obj )
overrideprotected

Inserts a single Particle to current grid.

Parameters
 [in] obj A pointer to the BaseParticle that needs to be inserted in the HGrid.

Definition at line 297 of file MercuryBase.cc.

References grid, and HGrid::insertParticleToHgrid().

Referenced by hGridRebuild().

298 {
299  if (grid != nullptr)
300  {
302  }
303 }
HGrid * grid
A pointer to the HGrid associated with this MercuryBase.
Definition: MercuryBase.h:281
void insertParticleToHgrid(BaseParticle *obj)
Inserts the given BaseParticle in to the HGrid.
Definition: HGrid.cc:88
 bool MercuryBase::hGridNeedsRebuilding ( )

Gets if the HGrid needs rebuilding before anything else happens.

Returns
A boolean which indicates if the HGrid needs to be rebuilt.

Definition at line 520 of file MercuryBase.cc.

Referenced by hGridActionsBeforeTimeStep().

521 {
522  if (grid == nullptr)
523  {
524  logger(VERBOSE, "HGrid needs updating, because there is no grid.");
525  return true;
526  }
527  else if (gridNeedsUpdate_)
528  {
529  logger(VERBOSE, "HGrid needs updating, because some of its initialisation parameters have changed.");
530  return true;
531  }
532  else if (grid->getNeedsRebuilding())
533  {
534  logger(VERBOSE, "HGrid needs updating, because said so by the grid itself");
535  return true;
536  }
537  else if (getHGrid()->getNumberOfBuckets() > 10 * getHGridTargetNumberOfBuckets() || 10 * getHGrid()->getNumberOfBuckets() < getHGridTargetNumberOfBuckets())
538  {
539  logger(VERBOSE, "HGrid needs updating, because of number of buckets, current = %, target = %.", grid->getNumberOfBuckets(), particleHandler.getNumberOfObjects());
540  return true;
541  }
543  {
544  logger(VERBOSE, "HGrid needs updating, because of maximum cell size, current = %, required = %.", grid->getCellSizes().back() * hGridCellOverSizeRatio_, particleHandler.getLargestParticle()->getInteractionRadius());
545  return true;
546  }
547  else
548  {
549  //std::cout<<"HGrid does not need updating, because of number of buckets, current="<<grid->NUM_BUCKETS<<" target="<<particleHandler.getNumberOfObjects()<<std::endl;
550  //std::cout<<"HGrid does not need updating, because of maximum cell size, current="<<grid->cellSizes_.back()*grid->cellOverSizeRatio_<<" required="<<2.0*particleHandler.getLargestParticle()->getInteractionRadius()<<std::endl;
551  return false;
552  }
553 }
BaseParticle * getLargestParticle() const
Gets a pointer to the largest BaseParticle (by interactionRadius) in this ParticleHandler.
const std::vector< double > & getCellSizes() const
Gets the sizes of the cells at all levels as a vector.
Definition: HGrid.cc:175
HGrid * grid
A pointer to the HGrid associated with this MercuryBase.
Definition: MercuryBase.h:281
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
virtual unsigned int getHGridTargetNumberOfBuckets() const
Gets the desired number of buckets, which is the maximum of the number of particles and 10...
Definition: MercuryBase.cc:558
Mdouble getCellOverSizeRatio() const
Gets the maximum ratio of the cell to a particle it contains.
Definition: HGrid.cc:277
Mdouble hGridCellOverSizeRatio_
The maximum ratio between the size of the cells and the BaseParticle they contain.
Definition: MercuryBase.h:349
ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created...
Definition: DPMBase.h:878
unsigned int getNumberOfObjects() const
Gets the number of Object in this BaseHandler.
Definition: BaseHandler.h:464
bool gridNeedsUpdate_
Boolean that indicates whether or not the grid needs to be updated.
Definition: MercuryBase.h:321
bool getNeedsRebuilding() const
Gets whether or not the grid needs to be rebuilt before something else is done with it...
Definition: HGrid.cc:269
Returns the particle's interaction radius, which might be different from radius_ (e.g., when dealing with wet particles)
HGrid * getHGrid()
Gets the HGrid used by this problem.
Definition: MercuryBase.cc:389
unsigned int getNumberOfBuckets() const
Gets the number of buckets of this HGrid.
Definition: HGrid.cc:159
 void MercuryBase::hGridRebuild ( )
protected

This sets up the parameters required for the contact model.

Rebuild the HGrid with the current data. First compute the cell sizes of the new HGrid, then delete the old HGrid and build the new HGrid. Finally add all particles to the new HGrid. First check if either the ParticleHandler is empty or the particle distribution is monodispersed. If this is the case, make a grid that contains only one level which has a cell size defined by the diameter of the particle * hGridCellOverSizeRatio_. Otherwise, make cell sizes depending on the distribution given in hGridDistribution_. LINEAR and EXPONENTIAL first compute the smallest and biggest cell size, and then compute the ones in between according to the distribution. USER just takes the cell sizes given by the user. OLDHGRID computes the smallest cell size and then makes the cells of each subsequent level twice as big.

Definition at line 201 of file MercuryBase.cc.

Referenced by hGridActionsBeforeTimeStep(), and Mercury2D::hGridHasParticleContacts().

202 {
203
204  std::vector<Mdouble> cellSizes;
205
209  {
210  //this case is executed if the particleHandler is empty (minParticleInteractionRadius == 0)
211  //or if the particle distribution is monodispersed.
212  //nextafter(d,std::numeric_limits<Mdouble>::max()) chooses the smallest
213  // Mdouble that is bigger than d.
214  Mdouble maxCellSize = nextafter(2.0 * maxParticleInteractionRadius * getHGridCellOverSizeRatio(), std::numeric_limits<Mdouble>::max());
215  cellSizes.push_back(maxCellSize);
216  if(getHGridMaxLevels() != 1)
217  {
218  logger(INFO, "While rebuilding the hgrid: the number of levels was "
219  "set to one, as the particle distribution is monodispersed");
220  }
221  }
222  else
223  {
224  switch(getHGridDistribution())
225  {
226  case LINEAR:
227  {
228  Mdouble minCellSize = nextafter(2.0 * minParticleInteractionRadius * getHGridCellOverSizeRatio(), 0.0);
229  Mdouble maxCellSize = nextafter(2.0 * maxParticleInteractionRadius * getHGridCellOverSizeRatio(), std::numeric_limits<Mdouble>::max());
230  //std::cout << "HGrid: using a linear cell size distribution from " << minCellSize << " to " << maxCellSize << " over " << getHGridMaxLevels() << " levels" << std::endl;
231  for(unsigned int i = 0; i + 1 < getHGridMaxLevels(); i++)
232  {
233  cellSizes.push_back(minCellSize + (maxCellSize - minCellSize)
234  * (static_cast<Mdouble>(i + 1)) / getHGridMaxLevels());
235  }
236  //The last cell is added separately because in some cases accuracy was lost when calculating it.
237  cellSizes.push_back(maxCellSize);
238  break;
239  }
240  case EXPONENTIAL:
241  {
242  Mdouble minCellSize = nextafter(2.0 * minParticleInteractionRadius * getHGridCellOverSizeRatio(), 0.0);
243  Mdouble maxCellSize = nextafter(2.0 * maxParticleInteractionRadius * getHGridCellOverSizeRatio(), std::numeric_limits<Mdouble>::max());
244  //std::cout << "HGrid: using an exponential cell size distribution from " << minCellSize << " to " << maxCellSize << " over " << getHGridMaxLevels() << " levels" << std::endl;
245  for(unsigned int i = 0; i + 1 < getHGridMaxLevels(); i++)
246  {
247  cellSizes.push_back(minCellSize
248  * std::pow(maxCellSize / minCellSize, static_cast<Mdouble>(i + 1)
249  / getHGridMaxLevels()));
250  }
251  //The last cell is added separately because in some cases accuracy was lost when calculating it.
252  cellSizes.push_back(maxCellSize);
253  break;
254  }
255  case USER:
256  {
257  for(unsigned int i = 0; i < getHGridMaxLevels(); i++)
258  {
259  cellSizes.push_back(userHGridCellSize(i));
260  }
261  break;
262  }
263  case OLDHGRID:
264  {
265  Mdouble minCellSize = nextafter(2.0 * minParticleInteractionRadius * getHGridCellOverSizeRatio(), 0.0);
266
267  //std::cout<<"HGrid: using the old HGrid cell size distribution starting from " <<minCellSize<<std::endl;
268  for(unsigned int i = 0; i < getHGridMaxLevels(); i++)
269  {
270  cellSizes.push_back(minCellSize * std::pow(2, i));
271  }
272  break;
273  }
274  }
275  }
276
277  if(grid != nullptr)
278  {
279  delete grid;
280  }
281
283
284  for(std::vector<BaseParticle*>::iterator it = particleHandler.begin(); it != particleHandler.end(); ++it)
285  {
286  hGridInsertParticle(*it);
287  //\todo{This is really ugly fix to force the particle to update}
288  (*it)->setHGridX(9999);
289  hGridUpdateParticle(*it);
290  }
291  gridNeedsUpdate_ = false;
292 }
virtual void hGridUpdateParticle(BaseParticle *obj UNUSED)
no implementation but can be overidden in its derived classes.
Definition: DPMBase.cc:633
Mdouble getHGridCellOverSizeRatio() const
Gets the ratio of the smallest cell over the smallest particle.
Definition: MercuryBase.cc:477
HGrid * grid
A pointer to the HGrid associated with this MercuryBase.
Definition: MercuryBase.h:281
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
virtual unsigned int getHGridTargetNumberOfBuckets() const
Gets the desired number of buckets, which is the maximum of the number of particles and 10...
Definition: MercuryBase.cc:558
Gets the desired size of the smallest cells of the HGrid.
Definition: MercuryBase.cc:575
const std::vector< T * >::const_iterator end() const
Gets the end of the const_iterator over all BaseBoundary in this BaseHandler.
Definition: BaseHandler.h:494
double Mdouble
unsigned int getHGridMaxLevels() const
Gets the maximum number of levels of the HGrid in this MercuryBase.
Definition: MercuryBase.cc:512
Gets the desired size of the largest cells of the HGrid.
Definition: MercuryBase.cc:591
const std::vector< T * >::const_iterator begin() const
Gets the begin of the const_iterator over all Object in this BaseHandler.
Definition: BaseHandler.h:482
In the HGrid class, here all information about the HGrid is stored.
Definition: HGrid.h:41
ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created...
Definition: DPMBase.h:878
void hGridInsertParticle(BaseParticle *obj) override
Inserts a single Particle to current grid.
Definition: MercuryBase.cc:297
HGridDistribution getHGridDistribution() const
Gets how the sizes of the cells of different levels are distributed.
Definition: MercuryBase.cc:455
bool gridNeedsUpdate_
Boolean that indicates whether or not the grid needs to be updated.
Definition: MercuryBase.h:321
virtual Mdouble userHGridCellSize(unsigned int level)
Virtual function that enables inheriting classes to implement a function to let the user set the cell...
Definition: MercuryBase.cc:406
 void MercuryBase::hGridUpdateMove ( BaseParticle * iP, Mdouble move )
overrideprotectedvirtual

Computes the relative displacement of the given BaseParticle and updates the currentMaxRelativeDisplacement_ accordingly.

Parameters
 [in] iP A pointer to the BaseParticle for which we want to compare the relative speed to the currentMaxRelativeDisplacement_ to. [in] move An Mdouble that represents the distance the BaseParticle has moved.

Reimplemented from DPMBase.

Definition at line 367 of file MercuryBase.cc.

368 {
369  Mdouble currentRelativeDisplacement = move / (getHGrid()->getCellSize(iP->getHGridLevel()));
370  if (currentRelativeDisplacement > currentMaxRelativeDisplacement_)
371  {
372  currentMaxRelativeDisplacement_ = currentRelativeDisplacement;
373  }
374 }
double Mdouble
double getCellSize(unsigned int i) const
Gets the size of the cells at the given level.
Definition: HGrid.cc:252
unsigned int getHGridLevel() const
Returns particle's HGrid level.
HGrid * getHGrid()
Gets the HGrid used by this problem.
Definition: MercuryBase.cc:389
Mdouble currentMaxRelativeDisplacement_
Mdouble that denotes the maximum of the displacement of a particle divided by the cell size of the le...
Definition: MercuryBase.h:307
 void MercuryBase::read ( std::istream & is )
overridevirtual

Reads the MercuryBase from an input stream, for example a restart file.

Parameters
 [in,out] is The input stream from which the MercuryBase must be read.

This function reads first the properties that are DPMBase related from the given input stream, after that it reads the hGridMaxLevels_ and the hGridCellOverSizeRatio_ from the input stream.

Reimplemented from DPMBase.

Definition at line 105 of file MercuryBase.cc.

106 {
108
109  std::stringstream line(std::stringstream::in | std::stringstream::out);
111
112  std::string dummy;
113
114  line >> dummy >> dummy
115  >> dummy >> hGridMaxLevels_
116  >> dummy >> hGridCellOverSizeRatio_;
117 }
unsigned int hGridMaxLevels_
Unsigned integer that indicates the maximum number of levels of the HGrid.
Definition: MercuryBase.h:341
Mdouble hGridCellOverSizeRatio_
The maximum ratio between the size of the cells and the BaseParticle they contain.
Definition: MercuryBase.h:349
void getLineFromStringStream(std::istream &in, std::stringstream &out)
Reads a line from one stringstream into another, and prepares the latter for reading in...
Definition: Helpers.cc:389
Reads all particle data into a restart file.
Definition: DPMBase.cc:1695
 bool MercuryBase::readNextArgument ( int & i, int argc, char * argv[] )
overrideprotectedvirtual

Reads the next command line argument.

Parameters
 [in] i The ordinal number in the input arguments we want to read. [in] argc The number of arguments in the command line, not used. [in] argv The command line input arguments.
Returns
A boolean which is true if the argument is found and false otherwise.

Reimplemented from DPMBase.

Definition at line 419 of file MercuryBase.cc.

420 {
421  if (!strcmp(argv[i], "-hGridMaxLevels"))
422  {
423  setHGridMaxLevels(static_cast<unsigned int>(atoi(argv[i + 1])));
424  }
425  else if (!strcmp(argv[i], "-cellOverSizeRatio"))
426  {
427  setHGridCellOverSizeRatio(atof(argv[i + 1]));
428  }
429  else
430  {
432  }
433  return true; //returns true if argv[i] is found
434 }
virtual bool readNextArgument(int &i, int argc, char *argv[])
Definition: DPMBase.cc:2057
void setHGridCellOverSizeRatio(Mdouble cellOverSizeRatio)
Sets the ratio of the smallest cell over the smallest particle.
Definition: MercuryBase.cc:487
void setHGridMaxLevels(unsigned int HGridMaxLevels)
Sets the maximum number of levels of the HGrid in this MercuryBase.
Definition: MercuryBase.cc:500
 void MercuryBase::setHGridCellOverSizeRatio ( Mdouble hGridCellOverSizeRatio )

Sets the ratio of the smallest cell over the smallest particle.

Parameters
 [in] hGridCellOverSizeRatio The desired maximum ratio between the cells and the size of the BaseParticle it contains.
Todo:
IFCD: I changed the if unequal to if equal, can someone check this is correct?

Definition at line 487 of file MercuryBase.cc.

References gridNeedsUpdate_, hGridCellOverSizeRatio_, and mathsFunc::isEqual().

488 {
489  //If the hGridCellOverSizeRatio changes significantly, assign the given parameter.
490  if (mathsFunc::isEqual(hGridCellOverSizeRatio_, hGridCellOverSizeRatio, 1e-10))
491  {
492  gridNeedsUpdate_ = true;
493  hGridCellOverSizeRatio_ = hGridCellOverSizeRatio;
494  }
495 }
Mdouble hGridCellOverSizeRatio_
The maximum ratio between the size of the cells and the BaseParticle they contain.
Definition: MercuryBase.h:349
bool isEqual(Mdouble v1, Mdouble v2, double absError)
Compares the difference of two Mdouble with an absolute error, useful in UnitTests.
bool gridNeedsUpdate_
Boolean that indicates whether or not the grid needs to be updated.
Definition: MercuryBase.h:321
 void MercuryBase::setHGridDistribution ( HGridDistribution hGridDistribution )

Sets how the sizes of the cells of different levels are distributed.

Parameters
 [in] hGridDistribution The distribution of the cell sizes that will be used by this MercuryBase.

Definition at line 464 of file MercuryBase.cc.

References gridNeedsUpdate_, and hGridDistribution_.

465 {
466  if (hGridDistribution_ != hGridDistribution)
467  {
468  gridNeedsUpdate_ = true;
469  hGridDistribution_ = hGridDistribution;
470  }
471 }
HGridDistribution hGridDistribution_
Indicator for the distribution of the sizes of the cells of different levels of the HGrid...
Definition: MercuryBase.h:299
bool gridNeedsUpdate_
Boolean that indicates whether or not the grid needs to be updated.
Definition: MercuryBase.h:321
 void MercuryBase::setHGridMaxLevels ( unsigned int hGridMaxLevels )

Sets the maximum number of levels of the HGrid in this MercuryBase.

Parameters
 [in] hGridMaxLevels The maximum number of levels that will be used in the HGrid.

Definition at line 500 of file MercuryBase.cc.

References gridNeedsUpdate_, and hGridMaxLevels_.

501 {
502  if (hGridMaxLevels_ != hGridMaxLevels)
503  {
504  gridNeedsUpdate_ = true;
505  hGridMaxLevels_ = hGridMaxLevels;
506  }
507 }
unsigned int hGridMaxLevels_
Unsigned integer that indicates the maximum number of levels of the HGrid.
Definition: MercuryBase.h:341
bool gridNeedsUpdate_
Boolean that indicates whether or not the grid needs to be updated.
Definition: MercuryBase.h:321
 void MercuryBase::setHGridMethod ( HGridMethod hGridMethod )

Sets the HGridMethod to either BOTTOMUP or TOPDOWN.

Parameters
 [in] hGridMethod The HGridMethod that will be used in this MercuryBase.

Definition at line 447 of file MercuryBase.cc.

References hGridMethod_.

448 {
449  hGridMethod_ = hGridMethod;
450 }
HGridMethod hGridMethod_
Indicator of which way the interactions between different levels are tested.
Definition: MercuryBase.h:293
 void MercuryBase::setHGridUpdateEachTimeStep ( bool updateEachTimeStep )

Sets whether or not the HGrid must be updated every time step.

Parameters
 [in] updateEachTimeStep A boolean which indicates if the HGrid must be updated every time step.

Definition at line 172 of file MercuryBase.cc.

References updateEachTimeStep_.

173 {
174  updateEachTimeStep_ = updateEachTimeStep;
175 }
bool updateEachTimeStep_
Boolean which indicates whether or not the cell in which a particle is must be updated every timestep...
Definition: MercuryBase.h:327
 Mdouble MercuryBase::userHGridCellSize ( unsigned int level )
virtual

Virtual function that enables inheriting classes to implement a function to let the user set the cell size of the HGrid.

Parameters
 [in] level The level of the cell we want to know the size set by the user for.
Returns
The size of the cells at the given level.

Definition at line 406 of file MercuryBase.cc.

References logger, and WARN.

Referenced by hGridRebuild().

407 {
408  logger(WARN, "In Mdouble MercuryBase::userHGridCellSize(unsigned int level) with level= %", level);
409  logger(WARN, "If you want to use user defined HGrid cell sizes, this function should be redefined");
410  return 0.0;
411 }
Logger< MERCURY_LOGLEVEL > logger("MercuryKernel")
 void MercuryBase::write ( std::ostream & os, bool writeAllParticles = true ) const
overridevirtual

Writes the MercuryBase to an output stream, for example a restart file.

Parameters
 [in,out] os The output stream to which this MercuryBase must be written. [in] writeAllParticles A boolean which indicates whether or not all BaseParticle from the ParticleHandler must be written to the ostream. If it is set to true or if there are at most 4 BaseParticle, all BaseParticle are written. If it is set to false, only the first two BaseParticle are written, followed by ...

Function that writes this MercuryBase to an output stream, for example a restart file. First writes the domain information, then the walls, followed by the boundaries and particles, and finally the HGrid information.

Reimplemented from DPMBase.

Definition at line 132 of file MercuryBase.cc.

Referenced by Chute::write().

133 {
134  DPMBase::write(os, writeAllParticles);
135  if (grid != nullptr)
136  {
137  os << "NUM_BUCKETS " << grid->getNumberOfBuckets() << " "
138  << "hGridMaxLevels " << getHGridMaxLevels() << " "
139  << "cellOverSizeRatio " << getHGridCellOverSizeRatio() << std::endl;
140  }
141  else
142  {
143  os << "NUM_BUCKETS " << 0.0 << " "
144  << "hGridMaxLevels " << getHGridMaxLevels() << " "
145  << "cellOverSizeRatio " << getHGridCellOverSizeRatio() << std::endl;
146  }
147 }
virtual void write(std::ostream &os, bool writeAllParticles=true) const
Loads all MD data and plots statistics for all timesteps in the .data file.
Definition: DPMBase.cc:1642
Mdouble getHGridCellOverSizeRatio() const
Gets the ratio of the smallest cell over the smallest particle.
Definition: MercuryBase.cc:477
HGrid * grid
A pointer to the HGrid associated with this MercuryBase.
Definition: MercuryBase.h:281
unsigned int getHGridMaxLevels() const
Gets the maximum number of levels of the HGrid in this MercuryBase.
Definition: MercuryBase.cc:512
unsigned int getNumberOfBuckets() const
Gets the number of buckets of this HGrid.
Definition: HGrid.cc:159

## Member Data Documentation

 Mdouble MercuryBase::currentMaxRelativeDisplacement_
private

Mdouble that denotes the maximum of the displacement of a particle divided by the cell size of the level of that particle at the current time step. This is useful to see whether a particle could have moved more than one cell.

Definition at line 307 of file MercuryBase.h.

 HGrid* MercuryBase::grid
private

A pointer to the HGrid associated with this MercuryBase.

Definition at line 281 of file MercuryBase.h.

 bool MercuryBase::gridNeedsUpdate_
private

Boolean that indicates whether or not the grid needs to be updated.

The grid needs to be updated before the HGrid is constructed and whenever something of the HGrid changes, such as the distribution, the number of levels, etc.

Definition at line 321 of file MercuryBase.h.

 Mdouble MercuryBase::hGridCellOverSizeRatio_
private

The maximum ratio between the size of the cells and the BaseParticle they contain.

The hGrifCellOverSizeRatio_ can be found by dividing the size of the smallest cell by the size of the smallest particle, so this can be set to give particles more space within a cell. Currently, the default is set to 1.

Definition at line 349 of file MercuryBase.h.

 HGridDistribution MercuryBase::hGridDistribution_
private

Indicator for the distribution of the sizes of the cells of different levels of the HGrid. The default is EXPONENTIAL.

Definition at line 299 of file MercuryBase.h.

Referenced by constructor(), getHGridDistribution(), hGridInfo(), MercuryBase(), and setHGridDistribution().

 unsigned int MercuryBase::hGridMaxLevels_
private

Unsigned integer that indicates the maximum number of levels of the HGrid.

The number of levels in the HGrid is currently dependent on the maximum number of levels of the HGrid the user has given, either in the constructor or in setHGridMaxLevels, and whether the BaseParticle are monodispersed or not. If they are monodispersed, there is only one level in the HGrid, otherwise there are usually as many levels as the maximum set by the user. Note, by default the code sorts out these parameters itself but they can be overridden by the user.

Definition at line 341 of file MercuryBase.h.

Referenced by constructor(), getHGridMaxLevels(), hGridInfo(), MercuryBase(), read(), and setHGridMaxLevels().

 HGridMethod MercuryBase::hGridMethod_
private

Indicator of which way the interactions between different levels are tested.

If hGridMethod_ is TOPDOWN, then larger particles are inserted into the grid of smaller particles when looking for cross level interactions. If hGridMethod_ is BOTTOMUP, then smaller particles are inserted into the grid of larger particles when looking for cross-level interactions. The default for the hGridMethod_ is TOPDOWN.

Definition at line 293 of file MercuryBase.h.

Referenced by constructor(), getHGridMethod(), hGridInfo(), MercuryBase(), and setHGridMethod().

 Mdouble MercuryBase::totalCurrentMaxRelativeDisplacement_
private

After each time step, this Mdouble is increased by 2*currentMaxRelativeDisplacement_.

Definition at line 313 of file MercuryBase.h.

 bool MercuryBase::updateEachTimeStep_
private

Boolean which indicates whether or not the cell in which a particle is must be updated every timestep.

Definition at line 327 of file MercuryBase.h.

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