MarbleRun Class Reference
+ Inheritance diagram for MarbleRun:

Public Member Functions

 MarbleRun ()
 
void setParticlePosition (Vec3D pos)
 
void setParticleRadius (double radius)
 
void setParticleDensity (double density)
 
void setSlidingFrictionCoefficient (double coeff)
 
void setRollingFrictionCoefficient (double coeff)
 
void setTorsionFrictionCoefficient (double coeff)
 
double getParticleMass ()
 
void setRestitutionCoefficient (double coeff)
 
void loadSTLFile (std::string stlFile)
 
void includeInDomain (Vec3D pos)
 
void setupInitialConditions () override
 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...
 
 MarbleRun ()
 
void setParticlePosition (Vec3D pos)
 
void setParticleRadius (double radius)
 
void setParticleDensity (double density)
 
void setSlidingFrictionCoefficient (double coeff)
 
void setRollingFrictionCoefficient (double coeff)
 
void setTorsionFrictionCoefficient (double coeff)
 
double getParticleMass ()
 
void setRestitutionCoefficient (double coeff)
 
void loadSTLFile (std::string stlFile)
 
void loadBigSeesaw ()
 
void loadSmallSeesaw ()
 
void includeInDomain (Vec3D pos)
 
void setupInitialConditions () override
 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...
 
void actionsAfterTimeStep () override
 Computes the movement of the two seesaws. More...
 
- Public Member Functions inherited from Mercury3D
 Mercury3D ()
 This is the default constructor. All it does is set sensible defaults. More...
 
 Mercury3D (const DPMBase &other)
 Copy-constructor for creates an Mercury3D problem from an existing MD problem. More...
 
 Mercury3D (const Mercury3D &other)
 Copy-constructor. More...
 
void constructor ()
 Function that sets the SystemDimension and ParticleDimension to 3. More...
 
std::vector< BaseParticle * > hGridFindParticleContacts (const BaseParticle *obj) override
 Returns all particles that have a contact with a given particle. More...
 
- Public Member Functions inherited from MercuryBase
 MercuryBase ()
 This is the default constructor. It sets sensible defaults. More...
 
 ~MercuryBase () override
 This is the default destructor. More...
 
 MercuryBase (const MercuryBase &mercuryBase)
 Copy-constructor. More...
 
void constructor ()
 This is the actual constructor, it is called do both constructors above. More...
 
void hGridActionsBeforeTimeLoop () override
 This sets up the broad phase information, has to be done at this stage because it requires the particle size. More...
 
void hGridActionsBeforeTimeStep () override
 Performs all necessary actions before a time-step, like updating the particles and resetting all the bucket information, etc. More...
 
void read (std::istream &is, ReadOptions opt=ReadOptions::ReadAll) override
 Reads the MercuryBase from an input stream, for example a restart file. More...
 
void write (std::ostream &os, bool writeAllParticles=true) const override
 Writes all data into a restart file. More...
 
Mdouble getHGridCurrentMaxRelativeDisplacement () const
 Returns hGridCurrentMaxRelativeDisplacement_. More...
 
Mdouble getHGridTotalCurrentMaxRelativeDisplacement () const
 Returns hGridTotalCurrentMaxRelativeDisplacement_. More...
 
void setHGridUpdateEachTimeStep (bool updateEachTimeStep)
 Sets whether or not the HGrid must be updated every time step. More...
 
bool getHGridUpdateEachTimeStep () const final
 Gets whether or not the HGrid is updated every time step. More...
 
void setHGridMaxLevels (unsigned int HGridMaxLevels)
 Sets the maximum number of levels of the HGrid in this MercuryBase. More...
 
unsigned int getHGridMaxLevels () const
 Gets the maximum number of levels of the HGrid in this MercuryBase. More...
 
HGridMethod getHGridMethod () const
 Gets whether the HGrid in this MercuryBase is BOTTOMUP or TOPDOWN. More...
 
void setHGridMethod (HGridMethod hGridMethod)
 Sets the HGridMethod to either BOTTOMUP or TOPDOWN. More...
 
HGridDistribution getHGridDistribution () const
 Gets how the sizes of the cells of different levels are distributed. More...
 
void setHGridDistribution (HGridDistribution hGridDistribution)
 Sets how the sizes of the cells of different levels are distributed. More...
 
Mdouble getHGridCellOverSizeRatio () const
 Gets the ratio of the smallest cell over the smallest particle. More...
 
void setHGridCellOverSizeRatio (Mdouble cellOverSizeRatio)
 Sets the ratio of the smallest cell over the smallest particle. More...
 
bool hGridNeedsRebuilding ()
 Gets if the HGrid needs rebuilding before anything else happens. More...
 
virtual unsigned int getHGridTargetNumberOfBuckets () const
 Gets the desired number of buckets, which is the maximum of the number of particles and 10. More...
 
virtual Mdouble getHGridTargetMinInteractionRadius () const
 Gets the desired size of the smallest cells of the HGrid. More...
 
virtual Mdouble getHGridTargetMaxInteractionRadius () const
 Gets the desired size of the largest cells of the HGrid. More...
 
bool checkParticleForInteraction (const BaseParticle &P) final
 Checks if given BaseParticle has an interaction with a BaseWall or other BaseParticle. More...
 
bool checkParticleForInteractionLocal (const BaseParticle &P) final
 Checks if the given BaseParticle has an interaction with a BaseWall or other BaseParticles in a local domain. More...
 
virtual Mdouble userHGridCellSize (unsigned int level)
 Virtual function that enables inheriting classes to implement a function to let the user set the cell size of the HGrid. More...
 
void hGridInfo (std::ostream &os=std::cout) const
 Writes the info of the HGrid to the screen in a nice format. More...
 
- Public Member Functions inherited from DPMBase
void constructor ()
 A function which initialises the member variables to default values, so that the problem can be solved off the shelf; sets up a basic two dimensional problem which can be solved off the shelf. It is called in the constructor DPMBase(). More...
 
 DPMBase ()
 Constructor that calls the "void constructor()". More...
 
 DPMBase (const DPMBase &other)
 Copy constructor type-2. More...
 
virtual ~DPMBase ()
 virtual destructor More...
 
void autoNumber ()
 The autoNumber() function calls three functions: setRunNumber(), readRunNumberFromFile() and incrementRunNumberInFile(). More...
 
std::vector< 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...
 
void initialiseSolve ()
 Beginning of the solve routine, before time stepping. More...
 
void finaliseSolve ()
 End of the solve routine, after time stepping. More...
 
virtual void computeOneTimeStep ()
 Performs everything needed for one time step, used in the time-loop of solve(). More...
 
void checkSettings ()
 Checks if the essentials are set properly to go ahead with solving the problem. More...
 
void forceWriteOutputFiles ()
 Writes output files immediately, even if the current time step was not meant to be written. Also resets the last saved time step. More...
 
virtual void writeOutputFiles ()
 Writes simulation data to all the main Mercury files: .data, .ene, .fstat, .xballs and .restart (see the Mercury website for more details regarding these files). More...
 
void solve (int argc, char *argv[])
 The work horse of the code. Can handle flags from the command line. More...
 
virtual void writeXBallsScript () const
 This writes a script which can be used to load the xballs problem to display the data just generated. More...
 
virtual Mdouble getInfo (const BaseParticle &P) const
 A virtual function that returns some user-specified information about a particle. More...
 
ParticleVtkWritergetVtkWriter () const
 
virtual void writeRestartFile ()
 Stores all the particle data for current save time step to a "restart" file, which is a file simply intended to store all the information necessary to "restart" a simulation from a given time step (see also MercuryDPM.org for more information on restart files). More...
 
void writeDataFile ()
 
void writeEneFile ()
 
void writeFStatFile ()
 
void fillDomainWithParticles (unsigned N=50)
 
bool readRestartFile (ReadOptions opt=ReadOptions::ReadAll)
 Reads all the particle data corresponding to a given, existing . restart file (for more details regarding restart files, refer to the training materials on the MercuryDPM website).Returns true if it is successful, false otherwise. More...
 
int readRestartFile (std::string fileName, ReadOptions opt=ReadOptions::ReadAll)
 The same as readRestartFile(bool), but also reads all the particle data corresponding to the current saved time step. More...
 
virtual BaseWallreadUserDefinedWall (const std::string &type) const
 Allows you to read in a wall defined in a Driver directory; see USER/Luca/ScrewFiller. More...
 
virtual void readOld (std::istream &is)
 Reads all data from a restart file, e.g. domain data and particle data; old version. More...
 
bool readDataFile (std::string fileName="", unsigned int format=0)
 This allows particle data to be reloaded from data files. More...
 
bool readParAndIniFiles (std::string fileName)
 Allows the user to read par.ini files (useful to read files produced by the MDCLR simulation code - external to MercuryDPM) More...
 
bool readNextDataFile (unsigned int format=0)
 Reads the next data file with default format=0. However, one can modify the format based on whether the particle data corresponds to 3D or 2D data- see Visualising data in xballs. More...
 
void readNextFStatFile ()
 Reads the next fstat file. More...
 
bool findNextExistingDataFile (Mdouble tMin, bool verbose=true)
 Finds and opens the next data file, if such a file exists. More...
 
bool readArguments (int argc, char *argv[])
 Can interpret main function input arguments that are passed by the driver codes. More...
 
bool checkParticleForInteractionLocalPeriodic (const BaseParticle &P)
 
void readSpeciesFromDataFile (bool read=true)
 
void importParticlesAs (ParticleHandler &particleHandler, InteractionHandler &interactionHandler, const ParticleSpecies *species)
 Copies particles, interactions assigning species from a local simulation to a global one. Useful for the creation of a cluster. More...
 
MERCURYDPM_DEPRECATED FilegetDataFile ()
 The non const version. Allows one to edit the File::dataFile. More...
 
MERCURYDPM_DEPRECATED FilegetEneFile ()
 The non const version. Allows to edit the File::eneFile. More...
 
MERCURYDPM_DEPRECATED FilegetFStatFile ()
 The non const version. Allows to edit the File::fStatFile. More...
 
MERCURYDPM_DEPRECATED FilegetRestartFile ()
 The non const version. Allows to edit the File::restartFile. More...
 
MERCURYDPM_DEPRECATED FilegetStatFile ()
 The non const version. Allows to edit the File::statFile. More...
 
FilegetInteractionFile ()
 Return a reference to the file InteractionsFile. More...
 
MERCURYDPM_DEPRECATED const FilegetDataFile () const
 The const version. Does not allow for any editing of the File::dataFile. More...
 
MERCURYDPM_DEPRECATED const FilegetEneFile () const
 The const version. Does not allow for any editing of the File::eneFile. More...
 
MERCURYDPM_DEPRECATED const FilegetFStatFile () const
 The const version. Does not allow for any editing of the File::fStatFile. More...
 
MERCURYDPM_DEPRECATED const FilegetRestartFile () const
 The const version. Does not allow for any editing of the File::restartFile. More...
 
MERCURYDPM_DEPRECATED const FilegetStatFile () const
 The const version. Does not allow for any editing of the File::statFile. More...
 
const FilegetInteractionFile () const
 
const std::string & getName () const
 Returns the name of the file. Does not allow to change it though. More...
 
void setName (const std::string &name)
 Allows to set the name of all the files (ene, data, fstat, restart, stat) More...
 
void setName (const char *name)
 Calls setName(std::string) More...
 
void setSaveCount (unsigned int saveCount)
 Sets File::saveCount_ for all files (ene, data, fstat, restart, stat) More...
 
void setFileType (FileType fileType)
 Sets File::fileType_ for all files (ene, data, fstat, restart, stat) More...
 
void setOpenMode (std::fstream::openmode openMode)
 Sets File::openMode_ for all files (ene, data, fstat, restart, stat) More...
 
void resetFileCounter ()
 Resets the file counter for each file i.e. for ene, data, fstat, restart, stat) More...
 
void closeFiles ()
 Closes all files (ene, data, fstat, restart, stat) that were opened to read or write. More...
 
void setLastSavedTimeStep (unsigned int nextSavedTimeStep)
 Sets the next time step for all the files (ene, data, fstat, restart, stat) at which the data is to be written or saved. More...
 
Mdouble getTime () const
 Returns the current simulation time. More...
 
Mdouble getNextTime () const
 Returns the current simulation time. More...
 
unsigned int getNumberOfTimeSteps () const
 Returns the current counter of time-steps, i.e. the number of time-steps that the simulation has undergone so far. More...
 
void setTime (Mdouble time)
 Sets a new value for the current simulation time. More...
 
void setTimeMax (Mdouble newTMax)
 Sets a new value for the maximum simulation duration. More...
 
Mdouble getTimeMax () const
 Returns the maximum simulation duration. More...
 
void setLogarithmicSaveCount (Mdouble logarithmicSaveCountBase)
 Sets File::logarithmicSaveCount_ for all files (ene, data, fstat, restart, stat) More...
 
void setNToWrite (int nToWrite)
 set the number of elements to write to the screen More...
 
int getNToWrite () const
 get the number of elements to write to the More...
 
void setRotation (bool rotation)
 Sets whether particle rotation is enabled or disabled. More...
 
bool getRotation () const
 Indicates whether particle rotation is enabled or disabled. More...
 
MERCURYDPM_DEPRECATED void setWallsWriteVTK (FileType writeWallsVTK)
 Sets whether walls are written into a VTK file. More...
 
MERCURYDPM_DEPRECATED void setWallsWriteVTK (bool)
 Sets whether walls are written into a VTK file. More...
 
MERCURYDPM_DEPRECATED 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)
 
MERCURYDPM_DEPRECATED 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...
 
Mdouble getXCenter () const
 
Mdouble getYCenter () const
 
Mdouble getZCenter () const
 
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 setBackgroundDrag (Mdouble backgroundDrag)
 Simple access function to turn on a background drag. The force of particleVelocity*drag is applied (note, it allowd to be negaitve i.e. create energy) More...
 
const Mdouble getBackgroundDrag () const
 Return the background drag. More...
 
void setDimension (unsigned int newDim)
 Sets both the system dimensions and the particle dimensionality. More...
 
void setSystemDimensions (unsigned int newDim)
 Sets the system dimensionality. More...
 
unsigned int getSystemDimensions () const
 Returns the system dimensionality. More...
 
void setParticleDimensions (unsigned int particleDimensions)
 Sets the particle dimensionality. More...
 
unsigned int getParticleDimensions () const
 Returns the particle dimensionality. More...
 
std::string getRestartVersion () const
 This is to take into account for different Mercury versions. Returns the version of the restart file. More...
 
void setRestartVersion (std::string newRV)
 Sets restart_version. More...
 
bool getRestarted () const
 Returns the flag denoting if the simulation was restarted or not. More...
 
void setRestarted (bool newRestartedFlag)
 Allows to set the flag stating if the simulation is to be restarted or not. More...
 
bool getAppend () const
 Returns whether the "append" option is on or off. More...
 
void setAppend (bool newAppendFlag)
 Sets whether the "append" option is on or off. More...
 
Mdouble getElasticEnergy () const
 Returns the global elastic energy within the system. More...
 
Mdouble getKineticEnergy () const
 Returns the global kinetic energy stored in the system. More...
 
Mdouble getGravitationalEnergy () const
 Returns the global gravitational potential energy stored in the system. More...
 
Mdouble getRotationalEnergy () const
 JMFT Returns the global rotational energy stored in the system. More...
 
Mdouble getTotalEnergy () const
 
Mdouble getTotalMass () const
 JMFT: Return the total mass of the system, excluding fixed particles. More...
 
Vec3D getCentreOfMass () const
 JMFT: Return the centre of mass of the system, excluding fixed particles. More...
 
Vec3D getTotalMomentum () const
 JMFT: Return the total momentum of the system, excluding fixed particles. More...
 
double getCPUTime ()
 
double getWallTime ()
 
virtual void hGridInsertParticle (BaseParticle *obj UNUSED)
 
virtual void hGridUpdateParticle (BaseParticle *obj UNUSED)
 
virtual void hGridRemoveParticle (BaseParticle *obj UNUSED)
 
bool mpiIsInCommunicationZone (BaseParticle *particle)
 Checks if the position of the particle is in an mpi communication zone or not. More...
 
bool mpiInsertParticleCheck (BaseParticle *P)
 Function that checks if the mpi particle should really be inserted by the current domain. More...
 
void insertGhostParticle (BaseParticle *P)
 This function inserts a particle in the mpi communication boundaries. More...
 
void updateGhostGrid (BaseParticle *P)
 Checks if the Domain/periodic interaction distance needs to be updated and updates it accordingly. More...
 
virtual void gatherContactStatistics (unsigned int index1, int index2, Vec3D Contact, Mdouble delta, Mdouble ctheta, Mdouble fdotn, Mdouble fdott, Vec3D P1_P2_normal_, Vec3D P1_P2_tangential)
 //Not unsigned index because of possible wall collisions. More...
 
void setNumberOfDomains (std::vector< unsigned > direction)
 Sets the number of domains in x-,y- and z-direction. Required for parallel computations. More...
 
void splitDomain (DomainSplit domainSplit)
 
std::vector< unsigned > getNumberOfDomains ()
 returns the number of domains More...
 
DomaingetCurrentDomain ()
 Function that returns a pointer to the domain corresponding to the processor. More...
 
void removeOldFiles () const
 
void setMeanVelocity (Vec3D V_mean_goal)
 This function will help you set a fixed kinetic energy and mean velocity in your system. More...
 
void setMeanVelocityAndKineticEnergy (Vec3D V_mean_goal, Mdouble Ek_goal)
 This function will help you set a fixed kinetic energy and mean velocity in your system. More...
 
Mdouble getTotalVolume () const
 Get the total volume of the cuboid system. More...
 
Matrix3D getKineticStress () const
 Calculate the kinetic stress tensor in the system averaged over the whole volume. More...
 
Matrix3D getStaticStress () const
 Calculate the static stress tensor in the system averaged over the whole volume. More...
 
Matrix3D getTotalStress () const
 Calculate the total stress tensor in the system averaged over the whole volume. More...
 
virtual void handleParticleRemoval (unsigned int id)
 Handles the removal of particles from the particleHandler. More...
 
virtual void handleParticleAddition (unsigned int id, BaseParticle *p)
 
void writePythonFileForVTKVisualisation () const
 
void setWritePythonFileForVTKVisualisation (bool forceWritePythonFileForVTKVisualisation)
 
bool getWritePythonFileForVTKVisualisation () const
 
WallVTKWritergetWallVTKWriter ()
 

Public Attributes

unsigned bigSeesawId
 groupId of the big seesaw (so we can find all the triangles belonging to it) More...
 
BaseWallbigSeesawFirstElement = nullptr
 
double bigSeesawMass = 139.49e-3
 mass More...
 
Vec3D bigSeesawCOM0 = {305.03e-3, 186.95e-3, 30e-3}
 
Vec3D bigSeesawCOR = {302e-3,179e-3,30e-3}
 center of rotation More...
 
Matrix3D bigSeesawInvInertia
 
double bigSeesawAngleZMax = 0
 
double bigSeesawAngleZMin = -23.5*constants::pi/180
 
unsigned smallSeesawId
 groupId of the small seesaw (so we can find all the triangles belonging to it) More...
 
BaseWallsmallSeesawFirstElement = nullptr
 
double smallSeesawMass = 145e-3
 mass More...
 
Vec3D smallSeesawCOM0 = {572.02e-3,208.62e-3,30e-3}
 
Vec3D smallSeesawCOR = {572.02e-3,208.62e-3,30e-3}
 center of rotation More...
 
Matrix3D smallSeesawInvInertia
 
double smallSeesawAngleZMax = 6.0*constants::pi/180
 
double smallSeesawAngleZMin = 0
 
- Public Attributes inherited from DPMBase
SpeciesHandler speciesHandler
 A handler to that stores the species type i.e. LinearViscoelasticSpecies, etc. More...
 
RNG random
 This is a random generator, often used for setting up the initial conditions etc... More...
 
ParticleHandler particleHandler
 An object of the class ParticleHandler, contains the pointers to all the particles created. More...
 
ParticleHandler paoloParticleHandler
 Fake particleHandler created by Paolo needed temporary by just Paolo. More...
 
WallHandler wallHandler
 An object of the class WallHandler. Contains pointers to all the walls created. More...
 
BoundaryHandler boundaryHandler
 An object of the class BoundaryHandler which concerns insertion and deletion of particles into or from regions. More...
 
PeriodicBoundaryHandler periodicBoundaryHandler
 Internal handler that deals with periodic boundaries, especially in a parallel build. More...
 
DomainHandler domainHandler
 An object of the class DomainHandler which deals with parallel code. More...
 
InteractionHandler interactionHandler
 An object of the class InteractionHandler. More...
 
CGHandler cgHandler
 Object of the class cgHandler. More...
 
File dataFile
 An instance of class File to handle in- and output into a .data file. More...
 
File fStatFile
 An instance of class File to handle in- and output into a .fstat file. More...
 
File eneFile
 An instance of class File to handle in- and output into a .ene file. More...
 
File restartFile
 An instance of class File to handle in- and output into a .restart file. More...
 
File statFile
 An instance of class File to handle in- and output into a .stat file. More...
 
File interactionFile
 File class to handle in- and output into .interactions file. This file hold information about interactions. More...
 
Time clock_
 record when the simulation started More...
 

Private Attributes

SphericalParticleparticle
 
LinearViscoelasticFrictionSpeciesspecies
 
double restitutionCoefficient
 

Additional Inherited Members

- Public Types inherited from DPMBase
enum class  ReadOptions : int { ReadAll , ReadNoInteractions , ReadNoParticlesAndInteractions }
 
enum class  DomainSplit {
  X , Y , Z , XY ,
  XZ , YZ , 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...
 
- Protected Member Functions inherited from Mercury3D
void hGridFindContactsWithinTargetCell (int x, int y, int z, unsigned int l)
 Finds contacts between particles in the target cell. More...
 
void hGridFindContactsWithTargetCell (int x, int y, int z, unsigned int l, BaseParticle *obj)
 Finds contacts between the BaseParticle and the target cell. More...
 
void computeWallForces (BaseWall *w) override
 Compute contacts with a wall. More...
 
void hGridFindParticlesWithTargetCell (int x, int y, int z, unsigned int l, BaseParticle *obj, std::vector< BaseParticle * > &list)
 Finds particles within target cell and stores them in a list. More...
 
void hGridGetInteractingParticleList (BaseParticle *obj, std::vector< BaseParticle * > &list) override
 Obtains all neighbour particles of a given object, obtained from the hgrid. More...
 
void computeInternalForces (BaseParticle *obj) override
 Finds contacts with the BaseParticle; avoids multiple checks. More...
 
bool hGridHasContactsInTargetCell (int x, int y, int z, unsigned int l, const BaseParticle *obj) const
 Tests if the BaseParticle has contacts with other Particles in the target cell. More...
 
bool hGridHasParticleContacts (const BaseParticle *obj) override
 Tests if a BaseParticle has any contacts in the HGrid. More...
 
void hGridRemoveParticle (BaseParticle *obj) override
 Removes a BaseParticle from the HGrid. More...
 
void hGridUpdateParticle (BaseParticle *obj) override
 Updates the cell (not the level) of a BaseParticle. More...
 
- Protected Member Functions inherited from MercuryBase
void hGridRebuild ()
 This sets up the parameters required for the contact model. More...
 
void hGridInsertParticle (BaseParticle *obj) final
 Inserts a single Particle to current grid. More...
 
void hGridUpdateMove (BaseParticle *iP, Mdouble move) final
 Computes the relative displacement of the given BaseParticle and updates the currentMaxRelativeDisplacement_ accordingly. More...
 
void hGridActionsBeforeIntegration () override
 Resets the currentMaxRelativeDisplacement_ to 0. More...
 
void hGridActionsAfterIntegration () override
 This function has to be called before integrateBeforeForceComputation. More...
 
HGridgetHGrid ()
 Gets the HGrid used by this problem. More...
 
const HGridgetHGrid () const
 Gets the HGrid used by this problem, const version. More...
 
bool readNextArgument (int &i, int argc, char *argv[]) override
 Reads the next command line argument. More...
 
- Protected Member Functions inherited from DPMBase
virtual void computeAllForces ()
 Computes all the forces acting on the particles using the BaseInteractable::setForce() and BaseInteractable::setTorque() More...
 
virtual void computeInternalForce (BaseParticle *, BaseParticle *)
 Computes the forces between two particles (internal in the sense that the sum over all these forces is zero i.e. fully modelled forces) More...
 
virtual void computeExternalForces (BaseParticle *)
 Computes the external forces, such as gravity, acting on particles. More...
 
virtual 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 computeAdditionalForces ()
 A virtual function which allows to define operations to be executed prior to the OMP force collect. More...
 
virtual void actionsAfterSolve ()
 A virtual function which allows to define operations to be executed after the solve(). More...
 
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...
 
void setSoftStop ()
 function for setting sigaction constructor. More...
 
- Static Protected Member Functions inherited from DPMBase
static void signalHandler (int signal)
 signal handler function. More...
 

Constructor & Destructor Documentation

◆ MarbleRun() [1/2]

MarbleRun::MarbleRun ( )
inline
46  {
49  }
Species< LinearViscoelasticNormalSpecies, FrictionSpecies > LinearViscoelasticFrictionSpecies
Definition: LinearViscoelasticFrictionSpecies.h:34
std::enable_if<!std::is_pointer< U >::value, U * >::type copyAndAddObject(const U &object)
Creates a copy of a Object and adds it to the BaseHandler.
Definition: BaseHandler.h:379
SpeciesHandler speciesHandler
A handler to that stores the species type i.e. LinearViscoelasticSpecies, etc.
Definition: DPMBase.h:1427
ParticleHandler particleHandler
An object of the class ParticleHandler, contains the pointers to all the particles created.
Definition: DPMBase.h:1437
LinearViscoelasticFrictionSpecies * species
Definition: MarbleRun.cpp:39
SphericalParticle * particle
Definition: MarbleRun.cpp:37
A spherical particle is the most simple particle used in MercuryDPM.
Definition: SphericalParticle.h:37

References BaseHandler< T >::copyAndAddObject(), particle, DPMBase::particleHandler, species, and DPMBase::speciesHandler.

◆ MarbleRun() [2/2]

Member Function Documentation

◆ actionsAfterTimeStep()

void MarbleRun::actionsAfterTimeStep ( )
inlineoverridevirtual

Computes the movement of the two seesaws.

Reimplemented from DPMBase.

220  {
221  // if bigSeesaw is set
222  if (bigSeesawFirstElement) {
223  // branch vector of the COM
225  // \todo gravity torque should act on rotated branch, but something's wrong
226  //bigSeesawFirstElement->getOrientation().rotate(branch);
227  // torque due to gravity
228  Vec3D torque = Vec3D::cross(branch, bigSeesawMass * 0.1 * getGravity());
229  Vec3D torque0 = torque;
230  // add torques due to particle contacts
231  for (auto w : wallHandler) {
232  if (w->getGroupId() == bigSeesawId) {
233  torque += w->getTorque();
234  }
235  }
236  Vec3D angularAcceleration = bigSeesawInvInertia * torque;
237  Vec3D angularVelocity = bigSeesawFirstElement->getAngularVelocity()
238  + angularAcceleration * getTimeStep();
239 
240  //limit angle around the z-axis [-pi,pi]
241  double angleZ = bigSeesawFirstElement->getOrientation().getAngleZ();
242  if (angleZ<bigSeesawAngleZMin && angularVelocity.Z>0) {
243  angularVelocity = -0.1*angularVelocity;
244  //logger(INFO,"Bump off left");
245  } else if (angleZ>bigSeesawAngleZMax && angularVelocity.Z<0) {
246  angularVelocity = -0.1*angularVelocity;
247  //logger(INFO,"Bump off right");
248  }
249  //logger(INFO, "T % % V % A % B %",torque.Z-torque0.Z, torque0.Z, angularVelocity.Z, angleZ, branch);
250  // apply angular velocity
251  for (auto w : wallHandler) {
252  if (w->getGroupId() == bigSeesawId) {
253  w->setAngularVelocity(angularVelocity);
254  }
255  }
256  }
257 
258  // if smallSeesaw is set
260  // branch vector of the COM
262  // \todo gravity torque should act on rotated branch, but something's wrong
263  //smallSeesawFirstElement->getOrientation().rotate(branch);
264  // torque due to gravity
265  Vec3D torque = Vec3D::cross(branch, smallSeesawMass * 0.1 * getGravity());
266  Vec3D torque0 = torque;
267  // add torques due to particle contacts
268  for (auto w : wallHandler) {
269  if (w->getGroupId() == smallSeesawId) {
270  torque += w->getTorque();
271  }
272  }
273  Vec3D angularAcceleration = smallSeesawInvInertia * torque;
275  + angularAcceleration * getTimeStep();
276 
277  //limit angle around the z-axis [-pi,pi]
278  double angleZ = smallSeesawFirstElement->getOrientation().getAngleZ();
279  if (angleZ<smallSeesawAngleZMin && angularVelocity.Z>0) {
280  angularVelocity = -0.1*angularVelocity;
281  //logger(INFO,"Bump off left");
282  } else if (angleZ>smallSeesawAngleZMax && angularVelocity.Z<0) {
283  angularVelocity = -0.1*angularVelocity;
284  //logger(INFO,"Bump off right");
285  }
286  //logger(INFO, "T % % V % A % B %",torque.Z-torque0.Z, torque0.Z, angularVelocity.Z, angleZ, branch);
287  // apply angular velocity
288  for (auto w : wallHandler) {
289  if (w->getGroupId() == smallSeesawId) {
290  w->setAngularVelocity(angularVelocity);
291  }
292  }
293  }
294  }
const Quaternion & getOrientation() const
Returns the orientation of this BaseInteractable.
Definition: BaseInteractable.h:230
virtual const Vec3D & getAngularVelocity() const
Returns the angular velocity of this interactable.
Definition: BaseInteractable.cc:341
Mdouble getTimeStep() const
Returns the simulation time step.
Definition: DPMBase.cc:1250
WallHandler wallHandler
An object of the class WallHandler. Contains pointers to all the walls created.
Definition: DPMBase.h:1447
Vec3D getGravity() const
Returns the gravitational acceleration.
Definition: DPMBase.cc:1391
Vec3D bigSeesawCOM0
Definition: MarbleRunWithSeesaw.cpp:98
BaseWall * smallSeesawFirstElement
Definition: MarbleRunWithSeesaw.cpp:132
Matrix3D bigSeesawInvInertia
Definition: MarbleRunWithSeesaw.cpp:103
double smallSeesawAngleZMax
Definition: MarbleRunWithSeesaw.cpp:147
double bigSeesawAngleZMax
Definition: MarbleRunWithSeesaw.cpp:108
Vec3D bigSeesawCOR
center of rotation
Definition: MarbleRunWithSeesaw.cpp:100
BaseWall * bigSeesawFirstElement
Definition: MarbleRunWithSeesaw.cpp:93
double smallSeesawMass
mass
Definition: MarbleRunWithSeesaw.cpp:134
double bigSeesawMass
mass
Definition: MarbleRunWithSeesaw.cpp:95
Vec3D smallSeesawCOM0
Definition: MarbleRunWithSeesaw.cpp:137
unsigned smallSeesawId
groupId of the small seesaw (so we can find all the triangles belonging to it)
Definition: MarbleRunWithSeesaw.cpp:128
Vec3D smallSeesawCOR
center of rotation
Definition: MarbleRunWithSeesaw.cpp:139
unsigned bigSeesawId
groupId of the big seesaw (so we can find all the triangles belonging to it)
Definition: MarbleRunWithSeesaw.cpp:89
Matrix3D smallSeesawInvInertia
Definition: MarbleRunWithSeesaw.cpp:142
Mdouble getAngleZ() const
Converts a quaternion to the rotation angle in the XY plane (for Mercury2D). See Wikipedia for detail...
Definition: Quaternion.cc:487
Definition: Vector.h:51
Mdouble Z
Definition: Vector.h:66
static Vec3D cross(const Vec3D &a, const Vec3D &b)
Calculates the cross product of two Vec3D: .
Definition: Vector.cc:163

References bigSeesawAngleZMax, bigSeesawCOM0, bigSeesawCOR, bigSeesawFirstElement, bigSeesawId, bigSeesawInvInertia, bigSeesawMass, Vec3D::cross(), Quaternion::getAngleZ(), BaseInteractable::getAngularVelocity(), DPMBase::getGravity(), BaseInteractable::getOrientation(), DPMBase::getTimeStep(), smallSeesawAngleZMax, smallSeesawCOM0, smallSeesawCOR, smallSeesawFirstElement, smallSeesawId, smallSeesawInvInertia, smallSeesawMass, DPMBase::wallHandler, and Vec3D::Z.

◆ getParticleMass() [1/2]

double MarbleRun::getParticleMass ( )
inline
75  {
77  }
Mdouble getRadius() const
Returns the particle's radius.
Definition: BaseParticle.h:348
Mdouble getMassFromRadius(Mdouble radius) const
Definition: ParticleSpecies.cc:123

References ParticleSpecies::getMassFromRadius(), BaseParticle::getRadius(), particle, and species.

Referenced by setupInitialConditions().

◆ getParticleMass() [2/2]

double MarbleRun::getParticleMass ( )
inline

◆ includeInDomain() [1/2]

void MarbleRun::includeInDomain ( Vec3D  pos)
inline
88  {
89  if (pos.X<getXMin()) {
90  setXMin(pos.X);
91  } else if (pos.X>getXMax()) {
92  setXMax(pos.X);
93  }
94  if (pos.Y<getYMin()) {
95  setYMin(pos.Y);
96  } else if (pos.Y>getYMax()) {
97  setYMax(pos.Y);
98  }
99  if (pos.Z<getZMin()) {
100  setZMin(pos.Z);
101  } else if (pos.Z>getZMax()) {
102  setZMax(pos.Z);
103  }
104  }
Mdouble getXMin() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMin() returns XMin.
Definition: DPMBase.h:619
Mdouble getXMax() const
If the length of the problem domain in x-direction is XMax - XMin, then getXMax() returns XMax.
Definition: DPMBase.h:626
void setYMin(Mdouble newYMin)
Sets the value of YMin, the lower bound of the problem domain in the y-direction.
Definition: DPMBase.cc:1034
Mdouble getYMin() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMin() returns YMin.
Definition: DPMBase.h:632
void setYMax(Mdouble newYMax)
Sets the value of YMax, the upper bound of the problem domain in the y-direction.
Definition: DPMBase.cc:1191
void setZMin(Mdouble newZMin)
Sets the value of ZMin, the lower bound of the problem domain in the z-direction.
Definition: DPMBase.cc:1058
void setXMax(Mdouble newXMax)
Sets the value of XMax, the upper bound of the problem domain in the x-direction.
Definition: DPMBase.cc:1165
void setZMax(Mdouble newZMax)
Sets the value of ZMax, the upper bound of the problem domain in the z-direction.
Definition: DPMBase.cc:1217
Mdouble getYMax() const
If the length of the problem domain in y-direction is YMax - YMin, then getYMax() returns XMax.
Definition: DPMBase.h:638
void setXMin(Mdouble newXMin)
Sets the value of XMin, the lower bound of the problem domain in the x-direction.
Definition: DPMBase.cc:1010
Mdouble getZMax() const
If the length of the problem domain in z-direction is ZMax - ZMin, then getZMax() returns ZMax.
Definition: DPMBase.h:650
Mdouble getZMin() const
If the length of the problem domain in z-direction is ZMax - ZMin, then getZMin() returns ZMin.
Definition: DPMBase.h:644
Mdouble Y
Definition: Vector.h:66
Mdouble X
the vector components
Definition: Vector.h:66

References DPMBase::getXMax(), DPMBase::getXMin(), DPMBase::getYMax(), DPMBase::getYMin(), DPMBase::getZMax(), DPMBase::getZMin(), DPMBase::setXMax(), DPMBase::setXMin(), DPMBase::setYMax(), DPMBase::setYMin(), DPMBase::setZMax(), DPMBase::setZMin(), Vec3D::X, Vec3D::Y, and Vec3D::Z.

Referenced by setupInitialConditions().

◆ includeInDomain() [2/2]

void MarbleRun::includeInDomain ( Vec3D  pos)
inline
166  {
167  if (pos.X<getXMin()) {
168  setXMin(pos.X);
169  } else if (pos.X>getXMax()) {
170  setXMax(pos.X);
171  }
172  if (pos.Y<getYMin()) {
173  setYMin(pos.Y);
174  } else if (pos.Y>getYMax()) {
175  setYMax(pos.Y);
176  }
177  if (pos.Z<getZMin()) {
178  setZMin(pos.Z);
179  } else if (pos.Z>getZMax()) {
180  setZMax(pos.Z);
181  }
182  }

References DPMBase::getXMax(), DPMBase::getXMin(), DPMBase::getYMax(), DPMBase::getYMin(), DPMBase::getZMax(), DPMBase::getZMin(), DPMBase::setXMax(), DPMBase::setXMin(), DPMBase::setYMax(), DPMBase::setYMin(), DPMBase::setZMax(), DPMBase::setZMin(), Vec3D::X, Vec3D::Y, and Vec3D::Z.

◆ loadBigSeesaw()

void MarbleRun::loadBigSeesaw ( )
inline

Loads the stl file for the big seesaw, sets the center of rotation to bigSeesawCOR, sets bigSeesawId, bigSeesawFirstElement.

114  {
115  std::string stlFile = "Big Seasaw.STL";
116  Vec3D velocity {0,0,0};
117  Vec3D angularVelocity {0,0,0};
118  bigSeesawId = wallHandler.readTriangleWall(stlFile,speciesHandler.getLastObject(),1e-3,bigSeesawCOR, velocity, angularVelocity);
119  for (auto w : wallHandler) {
120  if (w->getGroupId() == bigSeesawId) {
122  break;
123  }
124  }
125  }
T * getLastObject()
Gets a pointer to the last Object in this BaseHandler.
Definition: BaseHandler.h:634
unsigned readTriangleWall(std::string filename, ParticleSpecies *species, Mdouble scaleFactor=1, Vec3D centerOfRotation={0, 0, 0}, Vec3D velocity={0, 0, 0}, Vec3D angularVelocity={0, 0, 0})
Reads triangulated walls from vtk or stl files, and converts them into a set of TriangleWalls.
Definition: WallHandler.cc:341

References bigSeesawCOR, bigSeesawFirstElement, bigSeesawId, BaseHandler< T >::getLastObject(), WallHandler::readTriangleWall(), DPMBase::speciesHandler, and DPMBase::wallHandler.

Referenced by main().

◆ loadSmallSeesaw()

void MarbleRun::loadSmallSeesaw ( )
inline

Loads the stl file for the small seesaw, sets the center of rotation to smallSeesawCOR, sets smallSeesawId, smallSeesawFirstElement.

153  {
154  std::string stlFile = "Small Seasaw.STL";
155  Vec3D velocity {0,0,0};
156  Vec3D angularVelocity {0,0,0};
157  smallSeesawId = wallHandler.readTriangleWall(stlFile,speciesHandler.getLastObject(),1e-3,smallSeesawCOR, velocity, angularVelocity);
158  for (auto w : wallHandler) {
159  if (w->getGroupId() == smallSeesawId) {
161  break;
162  }
163  }
164  }

References BaseHandler< T >::getLastObject(), WallHandler::readTriangleWall(), smallSeesawCOR, smallSeesawFirstElement, smallSeesawId, DPMBase::speciesHandler, and DPMBase::wallHandler.

Referenced by main().

◆ loadSTLFile() [1/2]

void MarbleRun::loadSTLFile ( std::string  stlFile)
inline
83  {
84  // read assuming the file is written in mm units
86  }

References BaseHandler< T >::getLastObject(), WallHandler::readTriangleWall(), DPMBase::speciesHandler, and DPMBase::wallHandler.

Referenced by main().

◆ loadSTLFile() [2/2]

void MarbleRun::loadSTLFile ( std::string  stlFile)
inline
83  {
84  // read assuming the file is written in mm units
86  }

References BaseHandler< T >::getLastObject(), WallHandler::readTriangleWall(), DPMBase::speciesHandler, and DPMBase::wallHandler.

◆ setParticleDensity() [1/2]

void MarbleRun::setParticleDensity ( double  density)
inline
59  {
60  species->setDensity(density);
61  }
void setDensity(Mdouble density)
Definition: ParticleSpecies.cc:108

References ParticleSpecies::setDensity(), and species.

Referenced by main().

◆ setParticleDensity() [2/2]

void MarbleRun::setParticleDensity ( double  density)
inline
59  {
60  species->setDensity(density);
61  }

References ParticleSpecies::setDensity(), and species.

◆ setParticlePosition() [1/2]

void MarbleRun::setParticlePosition ( Vec3D  pos)
inline
51  {
52  particle->setPosition(pos);
53  }
virtual void setPosition(const Vec3D &position)
Sets the position of this BaseInteractable.
Definition: BaseInteractable.h:239

References particle, and BaseInteractable::setPosition().

Referenced by main().

◆ setParticlePosition() [2/2]

void MarbleRun::setParticlePosition ( Vec3D  pos)
inline
51  {
52  particle->setPosition(pos);
53  }

References particle, and BaseInteractable::setPosition().

◆ setParticleRadius() [1/2]

void MarbleRun::setParticleRadius ( double  radius)
inline
55  {
56  particle->setRadius(radius);
57  }
virtual void setRadius(Mdouble radius)
Sets the particle's radius_ (and adjusts the mass_ accordingly, based on the particle's species)
Definition: BaseParticle.cc:553

References particle, and BaseParticle::setRadius().

Referenced by main().

◆ setParticleRadius() [2/2]

void MarbleRun::setParticleRadius ( double  radius)
inline
55  {
56  particle->setRadius(radius);
57  }

References particle, and BaseParticle::setRadius().

◆ setRestitutionCoefficient() [1/2]

void MarbleRun::setRestitutionCoefficient ( double  coeff)
inline
79  {
80  restitutionCoefficient = coeff;
81  }
double restitutionCoefficient
Definition: MarbleRun.cpp:41

References restitutionCoefficient.

Referenced by main().

◆ setRestitutionCoefficient() [2/2]

void MarbleRun::setRestitutionCoefficient ( double  coeff)
inline
79  {
80  restitutionCoefficient = coeff;
81  }

References restitutionCoefficient.

◆ setRollingFrictionCoefficient() [1/2]

void MarbleRun::setRollingFrictionCoefficient ( double  coeff)
inline
67  {
68  species->setRollingFrictionCoefficient(coeff);
69  }

References species.

Referenced by main().

◆ setRollingFrictionCoefficient() [2/2]

void MarbleRun::setRollingFrictionCoefficient ( double  coeff)
inline
67  {
68  species->setRollingFrictionCoefficient(coeff);
69  }

References species.

◆ setSlidingFrictionCoefficient() [1/2]

void MarbleRun::setSlidingFrictionCoefficient ( double  coeff)
inline
63  {
64  species->setSlidingFrictionCoefficient(coeff);
65  }

References species.

Referenced by main().

◆ setSlidingFrictionCoefficient() [2/2]

void MarbleRun::setSlidingFrictionCoefficient ( double  coeff)
inline
63  {
64  species->setSlidingFrictionCoefficient(coeff);
65  }

References species.

◆ setTorsionFrictionCoefficient() [1/2]

void MarbleRun::setTorsionFrictionCoefficient ( double  coeff)
inline
71  {
72  species->setTorsionFrictionCoefficient(coeff);
73  }

References species.

Referenced by main().

◆ setTorsionFrictionCoefficient() [2/2]

void MarbleRun::setTorsionFrictionCoefficient ( double  coeff)
inline
71  {
72  species->setTorsionFrictionCoefficient(coeff);
73  }

References species.

◆ setupInitialConditions() [1/2]

void MarbleRun::setupInitialConditions ( )
inlineoverridevirtual

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.

A virtual function with no implementation but can be overriden.

Todo:
I (Anthony) wants to change this to be an external function. This has a lot of advantages especially when using copy-constructors. This is a major change and will break other codes, so therefore has to be done carefully.

This sets up the particles initial conditions it is as you expect the user to override this. By default the particles are randomly distributed

Reimplemented from DPMBase.

107  {
108  // set domain such that both particle and walls are included
110  for (const auto wall : wallHandler) {
111  auto triangle = static_cast<TriangleWall*>(wall);
112  includeInDomain(triangle->getVertices()[0]);
113  includeInDomain(triangle->getVertices()[1]);
114  includeInDomain(triangle->getVertices()[2]);
115  }
116  logger(INFO,"Simulation domain set to [%,%]x[%,%],[%,%]",
118  // set restitution and contact time
119  double gravityTimeScale = sqrt(2.0*particle->getRadius()/getGravity().getLength());
120  double collisionTime = gravityTimeScale/20; //ensures small overlaps
121  species->setCollisionTimeAndRestitutionCoefficient(collisionTime,restitutionCoefficient, getParticleMass());
122  species->setSlidingDissipation(2./7.*species->getDissipation());
123  species->setRollingDissipation(2./5.*species->getDissipation());
124  species->setTorsionDissipation(2./5.*species->getDissipation());
125  species->setSlidingStiffness(2./7.*species->getStiffness());
126  species->setRollingStiffness(2./5.*species->getStiffness());
127  species->setTorsionStiffness(2./5.*species->getStiffness());
128  // set time step
129  setTimeStep(collisionTime/25.0);
130  logger(INFO,"Simulating for %s with a time step of %s",getTimeMax(),getTimeStep());
131  // output
132  removeOldFiles();
133  setSaveCount(0.05/getTimeStep());
136  setParticlesWriteVTK(true);
138  }
@ NO_FILE
file will not be created/read
@ ONE_FILE
all data will be written into/ read from a single file called name_
Logger< MERCURYDPM_LOGLEVEL > logger("MercuryKernel")
Definition of different loggers with certain modules. A user can define its own custom logger here.
@ INFO
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
Definition: BaseInteractable.h:218
void setSaveCount(unsigned int saveCount)
Sets File::saveCount_ for all files (ene, data, fstat, restart, stat)
Definition: DPMBase.cc:408
void removeOldFiles() const
Definition: DPMBase.cc:4422
File fStatFile
An instance of class File to handle in- and output into a .fstat file.
Definition: DPMBase.h:1483
void setDomain(const Vec3D &min, const Vec3D &max)
Sets the minimum coordinates of the problem domain.
Definition: DPMBase.cc:1098
File restartFile
An instance of class File to handle in- and output into a .restart file.
Definition: DPMBase.h:1493
void setParticlesWriteVTK(bool writeParticlesVTK)
Sets whether particles are written in a VTK file.
Definition: DPMBase.cc:942
void setTimeStep(Mdouble newDt)
Sets a new value for the simulation time step.
Definition: DPMBase.cc:1234
Mdouble getTimeMax() const
Returns the maximum simulation duration.
Definition: DPMBase.cc:888
void writeFirstAndLastTimeStep()
Sets File::saveCount_ to the highest possible value such that only the first and last time step is wr...
Definition: File.cc:264
void setFileType(FileType fileType)
Sets the type of file needed to write into or read from. File::fileType_.
Definition: File.cc:215
double getParticleMass()
Definition: MarbleRun.cpp:75
void includeInDomain(Vec3D pos)
Definition: MarbleRun.cpp:88
A TriangleWall is convex polygon defined as an intersection of InfiniteWall's.
Definition: TriangleWall.h:57
void setWriteVTK(FileType)
Sets whether walls are written into a VTK file.
Definition: WallHandler.cc:467

References DPMBase::fStatFile, DPMBase::getGravity(), getParticleMass(), BaseInteractable::getPosition(), BaseParticle::getRadius(), DPMBase::getTimeMax(), DPMBase::getTimeStep(), DPMBase::getXMax(), DPMBase::getXMin(), DPMBase::getYMax(), DPMBase::getYMin(), DPMBase::getZMax(), DPMBase::getZMin(), includeInDomain(), INFO, logger, NO_FILE, ONE_FILE, particle, DPMBase::removeOldFiles(), DPMBase::restartFile, restitutionCoefficient, DPMBase::setDomain(), File::setFileType(), DPMBase::setParticlesWriteVTK(), DPMBase::setSaveCount(), DPMBase::setTimeStep(), WallHandler::setWriteVTK(), species, DPMBase::wallHandler, and File::writeFirstAndLastTimeStep().

◆ setupInitialConditions() [2/2]

void MarbleRun::setupInitialConditions ( )
inlineoverridevirtual

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.

A virtual function with no implementation but can be overriden.

Todo:
I (Anthony) wants to change this to be an external function. This has a lot of advantages especially when using copy-constructors. This is a major change and will break other codes, so therefore has to be done carefully.

This sets up the particles initial conditions it is as you expect the user to override this. By default the particles are randomly distributed

Reimplemented from DPMBase.

185  {
186  // set domain such that both particle and walls are included
188  for (const auto wall : wallHandler) {
189  auto triangle = static_cast<TriangleWall*>(wall);
190  includeInDomain(triangle->getVertices()[0]);
191  includeInDomain(triangle->getVertices()[1]);
192  includeInDomain(triangle->getVertices()[2]);
193  }
194  logger(INFO,"Simulation domain set to [%,%]x[%,%],[%,%]",
196  // set restitution and contact time
197  double gravityTimeScale = sqrt(2.0*particle->getRadius()/getGravity().getLength());
198  double collisionTime = gravityTimeScale/20; //ensures small overlaps
199  species->setCollisionTimeAndRestitutionCoefficient(collisionTime,restitutionCoefficient, getParticleMass());
200  species->setSlidingDissipation(2./7.*species->getDissipation());
201  species->setRollingDissipation(2./5.*species->getDissipation());
202  species->setTorsionDissipation(2./5.*species->getDissipation());
203  species->setSlidingStiffness(2./7.*species->getStiffness());
204  species->setRollingStiffness(2./5.*species->getStiffness());
205  species->setTorsionStiffness(2./5.*species->getStiffness());
206  // set time step
207  setTimeStep(collisionTime/25.0);
208  logger(INFO,"Simulating for %s with a time step of %s",getTimeMax(),getTimeStep());
209  // output
210  removeOldFiles();
211  setSaveCount(0.02/getTimeStep());
214  setParticlesWriteVTK(true);
216  }
@ MULTIPLE_FILES
each time-step will be written into/read from separate files numbered consecutively: name_....

References DPMBase::fStatFile, DPMBase::getGravity(), getParticleMass(), BaseInteractable::getPosition(), BaseParticle::getRadius(), DPMBase::getTimeMax(), DPMBase::getTimeStep(), DPMBase::getXMax(), DPMBase::getXMin(), DPMBase::getYMax(), DPMBase::getYMin(), DPMBase::getZMax(), DPMBase::getZMin(), includeInDomain(), INFO, logger, MULTIPLE_FILES, NO_FILE, particle, DPMBase::removeOldFiles(), DPMBase::restartFile, restitutionCoefficient, DPMBase::setDomain(), File::setFileType(), DPMBase::setParticlesWriteVTK(), DPMBase::setSaveCount(), DPMBase::setTimeStep(), WallHandler::setWriteVTK(), species, DPMBase::wallHandler, and File::writeFirstAndLastTimeStep().

Member Data Documentation

◆ bigSeesawAngleZMax

double MarbleRun::bigSeesawAngleZMax = 0

limits on the angle in the xy-plane the seesaw can make (necessary to limit the seesaw movement, since inter-wall forces are not computed)

Referenced by actionsAfterTimeStep().

◆ bigSeesawAngleZMin

double MarbleRun::bigSeesawAngleZMin = -23.5*constants::pi/180

◆ bigSeesawCOM0

Vec3D MarbleRun::bigSeesawCOM0 = {305.03e-3, 186.95e-3, 30e-3}

initial center of mass (use getOrientation.rotate(bigSeesawCOM0) to compute the current center of mass)

Referenced by actionsAfterTimeStep().

◆ bigSeesawCOR

Vec3D MarbleRun::bigSeesawCOR = {302e-3,179e-3,30e-3}

center of rotation

Referenced by actionsAfterTimeStep(), and loadBigSeesaw().

◆ bigSeesawFirstElement

BaseWall* MarbleRun::bigSeesawFirstElement = nullptr

first element in the wallHandler belonging to the big seesaw (so we can extract information that is equal for all seesaw triangles, like getOrientation, getAngularVelocity)

Referenced by actionsAfterTimeStep(), and loadBigSeesaw().

◆ bigSeesawId

unsigned MarbleRun::bigSeesawId

groupId of the big seesaw (so we can find all the triangles belonging to it)

Referenced by actionsAfterTimeStep(), and loadBigSeesaw().

◆ bigSeesawInvInertia

Matrix3D MarbleRun::bigSeesawInvInertia
Initial value:
Matrix3D(70476.55, -37641.24, 0, -37641.24, 329397.59, 0, 0, 0, 296830.02)*1e-9
)
Implementation of a 3D matrix.
Definition: Matrix.h:38
static Matrix3D inverse(const Matrix3D &A)
Computes the inverse of a matrix.
Definition: Matrix.cc:349

inertia around com

Todo:
apply the parallel axis theorem to compute the inertia around the center of roation instead of the center of mass: https://en.wikipedia.org/wiki/Parallel_axis_theorem

Referenced by actionsAfterTimeStep().

◆ bigSeesawMass

double MarbleRun::bigSeesawMass = 139.49e-3

mass

Referenced by actionsAfterTimeStep().

◆ particle

◆ restitutionCoefficient

double MarbleRun::restitutionCoefficient
private

◆ smallSeesawAngleZMax

double MarbleRun::smallSeesawAngleZMax = 6.0*constants::pi/180

limits on the angle in the xy-plane the seesaw can make (necessary to limit the seesaw movement, since inter-wall forces are not computed)

Referenced by actionsAfterTimeStep().

◆ smallSeesawAngleZMin

double MarbleRun::smallSeesawAngleZMin = 0

◆ smallSeesawCOM0

Vec3D MarbleRun::smallSeesawCOM0 = {572.02e-3,208.62e-3,30e-3}

initial center of mass (use getOrientation.rotate(smallSeesawCOM0) to compute the current center of mass)

Referenced by actionsAfterTimeStep().

◆ smallSeesawCOR

Vec3D MarbleRun::smallSeesawCOR = {572.02e-3,208.62e-3,30e-3}

center of rotation

Referenced by actionsAfterTimeStep(), and loadSmallSeesaw().

◆ smallSeesawFirstElement

BaseWall* MarbleRun::smallSeesawFirstElement = nullptr

first element in the wallHandler belonging to the small seesaw (so we can extract information that is equal for all seesaw triangles, like getOrientation, getAngularVelocity)

Referenced by actionsAfterTimeStep(), and loadSmallSeesaw().

◆ smallSeesawId

unsigned MarbleRun::smallSeesawId

groupId of the small seesaw (so we can find all the triangles belonging to it)

Referenced by actionsAfterTimeStep(), and loadSmallSeesaw().

◆ smallSeesawInvInertia

Matrix3D MarbleRun::smallSeesawInvInertia
Initial value:
Matrix3D(77503.61, -50757.9, 0, -50757.9, 353140.21, 0, 0, 0, 327073.81)*1e-9
)

inertia around com

Todo:
apply the parallel axis theorem to compute the inertia around the center of roation instead of the center of mass: https://en.wikipedia.org/wiki/Parallel_axis_theorem

Referenced by actionsAfterTimeStep().

◆ smallSeesawMass

double MarbleRun::smallSeesawMass = 145e-3

mass

Referenced by actionsAfterTimeStep().

◆ species


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