DPMBase Class Reference

The DPMBase header includes quite a few header files, defining all the handlers, which are essential. Moreover, it defines and solves a DPM problem. It is inherited from FilesAndRunNumber (public). More...

#include <DPMBase.h>

Inheritance diagram for DPMBase:

Public Member Functions
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...
bool	readRestartFile (bool restarted=true)
	Reads all the particle data corresponding to the current saved time step. Which is what the restart file basically stores. The problem description with the latest particle data. Returns 0 if it is successful, 1 otherwise. More...
int	readRestartFile (std::string fileName)
	The same as readRestartFile(bool), but also reads all the particle data corresponding to the current saved time step. More...
virtual void	write (std::ostream &os, bool writeAllParticles=true) const
	Loads all MD data and plots statistics for all timesteps in the .data file. More...
virtual void	read (std::istream &is)
	Reads all data from a restart file, e.g. domain data and particle data. More...
virtual bool	readUserDefinedWall (std::string type, std::istream &is)
virtual void	readOld (std::istream &is)
	Reads all data from a restart file, e.g. domain data and particle data; old version. More...
bool	readDataFile (const std::string fileName, unsigned int format=0)
	This allows particle data to be reloaded from data files. More...
bool	readParAndIniFiles (const std::string fileName)
	Allows the user to read par.ini files (useful to read MDCLR files) More...
bool	readNextDataFile (unsigned int format=0)
	Reads the next data file with default format=0. However, one can modify the format based on whether the particle data corresponds to 3D or 2D data. See XBalls/xballs.txt. More...
bool	findNextExistingDataFile (Mdouble tMin, bool verbose=true)
	Useful when fileType is chosen as Multiple Files or Multiple files with padded. More...
bool	readArguments (int argc, char *argv[])
	Can interpret main function input arguments that are passed by the driver codes. More...
virtual bool	readNextArgument (int &i, int argc, char *argv[])
	Interprets the i^th command-line argument. More...
virtual bool	checkParticleForInteraction (const BaseParticle &P)
	Checks if the particle having any interaction with walls or other particles. More...
virtual bool	checkParticleForInteractionLocal (const BaseParticle &P)
	Checks if a particle P has any interaction with walls or other particles in the local domain. More...
bool	checkParticleForInteractionLocalPeriodic (const BaseParticle &P)
Mdouble	getTime () const
	Access function for the time. More...
unsigned int	getNtimeSteps () const
	Returns the current counter of time steps. More...
void	setTime (Mdouble time)
	Access function for the time. More...
void	setTimeMax (Mdouble newTMax)
	Allows the upper time limit to be changed. More...
Mdouble	getTimeMax () const
	Allows the user to access the total simulation time during the simulation. Cannot change it though. More...
void	setDoCGAlways (bool newDoCGFlag)
void	setRotation (bool newRotFlag)
	Allows to set the flag for enabling or disabling particle rotation in the simulations. More...
bool	getRotation () const
	Returns a flag indicating if particle rotation is enabled or disabled. More...
void	setWallsWriteVTK (FileType writeWallsVTK)
	Allows to set the flag for enabling or disabling particle rotation in the simulations. More...
void	setParticlesWriteVTK (bool writeParticlesVTK)
	Allows to set the flag for enabling or disabling particle rotation in the simulations. More...
FileType	getWallsWriteVTK () const
	Returns a flag indicating if particle rotation is enabled or disabled. More...
bool	getParticlesWriteVTK () const
	Returns a flag indicating if particle rotation is enabled or disabled. More...
bool	getDoCGAlways () const
Vec3D	getMin () const
	Return the "bottom left" corner of the domain, a vector with xMin_, yMin_ and zMin_. More...
Vec3D	getMax () const
	Return the "upper right" corner of the domain, a vector with xMin_, yMin_ and zMin_. More...
Mdouble	getXMin () const
	If the length of the problem domain in x-direction is XMax - XMin, then getXMin() returns XMin,. More...
Mdouble	getXMax () const
	If the length of the problem domain in x-direction is XMax - XMin, then getXMax() returns XMax,. More...
Mdouble	getYMin () const
	If the length of the problem domain in y-direction is YMax - YMin, then getYMin() returns YMin,. More...
Mdouble	getYMax () const
	If the length of the problem domain in y-direction is YMax - YMin, then getYMax() returns XMax,. More...
Mdouble	getZMin () const
	If the length of the problem domain in z-direction is ZMax - ZMin, then getZMin() returns ZMin,. More...
Mdouble	getZMax () const
	If the length of the problem domain in z-direction is ZMax - ZMin, then getZMax() returns ZMax,. More...
void	setMin (Vec3D min)
	Sets the values xMin, yMin, zMin of the problem domain, which is [xMin,xMax]x[yMin,yMax]x[zMin,zMax]. More...
void	setMax (Vec3D max)
	Sets the values xMax, yMax, zMax of the problem domain, which is [xMin,xMax]x[yMin,yMax]x[zMin,zMax]. More...
void	setXMin (Mdouble newXMin)
	If the length of the problem domain in x-direction is XMax - XMin, this method sets XMin. More...
void	setYMin (Mdouble newYMin)
	If the length of the problem domain in y-direction is YMax - YMin, this method sets YMin. More...
void	setZMin (Mdouble newZMin)
	If the length of the problem domain in z-direction is ZMax - ZMin, this method sets ZMin. More...
void	setXMax (Mdouble newXMax)
	If the length of the problem domain in x-direction is XMax - XMin, this method sets XMax. More...
void	setYMax (Mdouble newYMax)
	If the length of the problem domain in y-direction is YMax - YMin, this method sets YMax. More...
void	setZMax (Mdouble newZMax)
	If the length of the problem domain in z-direction is XMax - XMin, this method sets ZMax. More...
int	getAddLarge () const
	returns the number of large particles that are to be added on restart. More...
int	getAddSmall () const
	returns the number of small particles that are to be added on restart. More...
void	setAddLarge (int new_addL)
	sets the number of large particles that are to be added on restart. More...
void	setAddSmall (int new_addS)
	sets the number of small particles that are to be added on restart. More...
void	setTimeStep (Mdouble newDt)
	Allows the time step dt to be changed. More...
Mdouble	getTimeStep () const
	Allows the time step dt to be accessed. More...
void	setXBallsColourMode (int newCMode)
	Set the xball output mode. More...
int	getXBallsColourMode () const
	Get the xball colour mode (CMode) More...
void	setXBallsVectorScale (double newVScale)
	Set the scale of vectors in xballs. More...
double	getXBallsVectorScale () const
	Returns the scale of vectors used in xballs. More...
void	setXBallsAdditionalArguments (std::string newXBArgs)
	Set the additional arguments for xballs. More...
std::string	getXBallsAdditionalArguments () const
	Returns the additional arguments for xballs. More...
void	setXBallsScale (Mdouble newScale)
	Sets the scale of the view (either normal, zoom in or zoom out) to display in xballs. The default is fit to screen. More...
double	getXBallsScale () const
	Returns the scale of the view in xballs. More...
void	setGravity (Vec3D newGravity)
	Allows to modify the gravity vector. More...
Vec3D	getGravity () const
	Returns the gravity vector. More...
void	setDimension (unsigned int newDim)
	Sets the system and particle dimension. More...
void	setSystemDimensions (unsigned int newDim)
	Allows for the dimension of the simulation to be changed. More...
unsigned int	getSystemDimensions () const
	Returns the dimension of the simulation. Note there is also a particle dimension. More...
void	setParticleDimensions (unsigned int particleDimensions)
	Allows the dimension of the particle (f.e. for mass) to be changed. e.g. discs or spheres. More...
unsigned int	getParticleDimensions () const
	Returns the particle dimensions. More...
std::string	getRestartVersion () const
	This is to take into account for different Mercury versions. Returns the version of the restart file. More...
void	setRestartVersion (std::string newRV)
	Sets restart_version. More...
bool	getRestarted () const
	Returns the flag denoting if the simulation was restarted or not. More...
void	setRestarted (bool newRestartedFlag)
	Allows to set the flag stating if the simulation is to be restarted or not. More...
bool	getAppend () const
	Returns the flag denoting if the append option is on or off. More...
void	setAppend (bool newAppendFlag)
	Allows to set the append option. More...
Mdouble	getElasticEnergy () const
	Returns the global elastic energy within the system. More...
Mdouble	getKineticEnergy () const
	Returns the global kinetic energy stored in the system. More...
Mdouble	getGravitationalEnergy () const
	Returns the global gravitational potential energy stored in the system. More...
bool	areInContact (const BaseParticle *pI, const BaseParticle *pJ) const
	Checks if two particle are in contact or is there any positive overlap. More...
virtual void	hGridInsertParticle (BaseParticle *obj UNUSED)
	no implementation but can be overidden in its derived classes. More...
virtual void	hGridUpdateParticle (BaseParticle *obj UNUSED)
	no implementation but can be overidden in its derived classes. More...
virtual void	hGridRemoveParticle (BaseParticle *obj UNUSED)
	no implementation but can be overidden in its derived classes. More...
virtual void	hGridUpdateMove (BaseParticle *, Mdouble)
	no implementation but can be overidden in its derived classes. More...
virtual void	gatherContactStatistics (unsigned int index1 UNUSED, int index2 UNUSED, Vec3D Contact UNUSED, Mdouble delta UNUSED, Mdouble ctheta UNUSED, Mdouble fdotn UNUSED, Mdouble fdott UNUSED, Vec3D P1_P2_normal_ UNUSED, Vec3D P1_P2_tangential UNUSED)
	//Not unsigned index because of possible wall collisions. More...
Public Member Functions inherited from FilesAndRunNumber
	FilesAndRunNumber ()
	Constructor. More...
	FilesAndRunNumber (const FilesAndRunNumber &other)
	Copy constructor. More...
virtual	~FilesAndRunNumber ()
	Constructor. More...
void	constructor ()
	a function called by the FilesAndRunNumber() (constructor) More...
void	incrementRunNumberInFile ()
	Increment the run Number (counter value) stored in the file_counter (COUNTER_DONOTDEL) by 1 and store the new value in the counter file. More...
int	readRunNumberFromFile ()
	Read the run number or the counter from the counter file (COUNTER_DONOTDEL) More...
void	autoNumber ()
	The autoNumber() function is the trigger. It calls three functions. setRunNumber(), readRunNumberFromFile() and incrementRunNumberInFile(). More...
std::vector< int >	get2DParametersFromRunNumber (int size_x, int size_y)
	This turns a counter into two indices which is an amazing feature for doing two dimensional parameter studies. The indices run from 1:size_x and 1:size_y, while the study number starts at 0 ( initially the counter=1 in COUNTER_DONOTDEL) More...
int	launchNewRun (const char *name, bool quick=false)
	This launches a code from within this code. Please pass the name of the code to run. More...
void	setRunNumber (int runNumber)
	This sets the counter/Run number, overriding the defaults. More...
int	getRunNumber () const
	This returns the current value of the counter (runNumber_) More...
void	read (std::istream &is)
	Accepts an input stream std::istream. More...
void	write (std::ostream &os) const
	Accepts an output stream read function, which accepts an input stream std::ostream. More...
Public Member Functions inherited from Files
	Files ()
	A constructor. More...
virtual	~Files ()
	A destructor, watch out its a virtual destructor. More...
	Files (const Files &other)
	Copy constructor. More...
MERCURY_DEPRECATED File &	getDataFile ()
	The non const version. Allows one to edit the File::dataFile. More...
MERCURY_DEPRECATED File &	getEneFile ()
	The non const version. Allows to edit the File::eneFile. More...
MERCURY_DEPRECATED File &	getFStatFile ()
	The non const version. Allows to edit the File::fStatFile. More...
MERCURY_DEPRECATED File &	getRestartFile ()
	The non const version. Allows to edit the File::restartFile. More...
MERCURY_DEPRECATED File &	getStatFile ()
	The non const version. Allows to edit the File::statFile. More...
MERCURY_DEPRECATED const File &	getDataFile () const
	The const version. Does not allow for any editing of the File::dataFile. More...
MERCURY_DEPRECATED const File &	getEneFile () const
	The const version. Does not allow for any editing of the File::eneFile. More...
MERCURY_DEPRECATED const File &	getFStatFile () const
	The const version. Does not allow for any editing of the File::fStatFile. More...
MERCURY_DEPRECATED const File &	getRestartFile () const
	The const version. Does not allow for any editing of the File::restartFile. More...
MERCURY_DEPRECATED const File &	getStatFile () const
	The const version. Does not allow for any editing of the File::statFile. More...
const std::string &	getName () const
	Returns the name of the file. Does not allow to change it though. More...
void	setName (const std::string &name)
	Allows to set the name of all the files (ene, data, fstat, restart, stat) More...
void	setName (const char *name)
	Calls setName(std::string) More...
void	setSaveCount (unsigned int saveCount)
	Sets File::saveCount_ for all files (ene, data, fstat, restart, stat) More...
void	setFileType (FileType fileType)
	Sets File::fileType_ for all files (ene, data, fstat, restart, stat) More...
void	setOpenMode (std::fstream::openmode openMode)
	Sets File::openMode_ for all files (ene, data, fstat, restart, stat) More...
void	resetFileCounter ()
	Resets the file counter for each file i.e. for ene, data, fstat, restart, stat) More...
void	read (std::istream &is)
	Extracts data from the input stream (which is basically a file you want to read from) into name_, restartFile .... More...
void	write (std::ostream &os) const
	Writes data into a file from the member variables name_, restartFile, dataFile etc. More...
void	openFiles ()
	Opens all the files (ene, data, fstat, restart, stat) for reading and writing purposes. More...
void	closeFiles ()
	Closes all files (ene, data, fstat, restart, stat) that were opened to read or write. More...
void	setNextSavedTimeStep (unsigned int nextSavedTimeStep)
	Sets the next time step for all the files (ene, data, fstat, restart, stat) at which the data is to be written or saved. More...

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

Protected Member Functions
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	hGridActionsBeforeTimeLoop ()
	A virtual function that allows one to carry out hGrid operations before the start of the time loop. More...
virtual void	hGridActionsBeforeTimeStep ()
	A virtual function that allows one to set or execute hGrid parameters or operations before every simulation time step. More...
virtual bool	getHGridUpdateEachTimeStep () const
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...
virtual void	hGridActionsBeforeIntegration ()
	no implementation but can be overidden in its derived classes. More...
virtual void	hGridActionsAfterIntegration ()
	no implementation but can be overidden in its derived classes. More...
virtual void	broadPhase (BaseParticle *i)
	By broad one means to screen and determine an approximate number of particles that a given particle can be in contact with. Hence the word "Broad phase" of contact detection. 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...
Mdouble	domainSize () const
void	writeVTK () const

Private Attributes
unsigned int	systemDimensions_
	The dimensions of the simulation i.e. 2D or 3D. More...
unsigned int	particleDimensions_
	determines if 2D or 3D particle volume is used for mass calculations More...
Vec3D	gravity_
	Gravity vector. More...
Mdouble	xMin_
	If the length of the problem domain in x-direction is XMax - XMin, the above variable stores XMin. More...
Mdouble	xMax_
	If the length of the problem domain in x-direction is XMax - XMin, the above variable stores XMax. More...
Mdouble	yMin_
	If the length of the problem domain in y-direction is YMax - YMin, the above variable stores YMin. More...
Mdouble	yMax_
	If the length of the problem domain in y-direction is YMax - XMin, the above variable stores YMax. More...
Mdouble	zMin_
	If the length of the problem domain in z-direction is ZMax - ZMin, the above variable stores ZMin. More...
Mdouble	zMax_
	If the length of the problem domain in z-direction is ZMax - ZMin, the above variable stores ZMax. More...
int	addL_
	Stores the number of large particles that are to be added on restart. More...
int	addS_
	Stores the number of small particles that are to be added on restart. More...
Mdouble	time_
	Stores the current simulation time. More...
unsigned int	ntimeSteps_
	Stores the number of time steps. More...
Mdouble	timeStep_
	Stores the simulation time step. More...
Mdouble	timeMax_
	Stores the duration of the simulation. More...
Mdouble	elasticEnergy_
	used in force calculations More...
std::string	restartVersion_
	Previous versions of MercuryDPM had a different restart file format, the below member variable allows one to specify the version in order to choose between the available version support. More...
bool	restarted_
	A bool to check if the simulation was restarted or not, ie. if setupInitialConditionsShould be run and the fileCounters reset. More...
bool	append_
	A flag to determine if the file has to be appended or not. See DPMBase::Solve() for example. More...
bool	rotation_
	A flag to turn on/off particle rotation. More...
FileType	writeWallsVTK_
	A flag to turn on/off the vtk writer for walls. More...
bool	writeParticlesVTK_
	A flag to turn on/off the vtk writer for particles. More...
int	xBallsColourMode_
	XBalls is a package to view the particle data. As an alternative MercuryDPM also supports Paraview. The below variable is used to set the argument cmode in xballs script (see XBalls/xballs.txt) More...
Mdouble	xBallsVectorScale_
	sets the xballs argument vscale (see XBalls/xballs.txt) More...
Mdouble	xBallsScale_
	sets the xballs argument scale (see XBalls/xballs.txt) More...
std::string	xBallsAdditionalArguments_
	A string of additional arguments for xballs can be specified (see XBalls/xballs.txt). e.g. "-solidf -v0". More...

Friends
std::ostream &	operator<< (std::ostream &os, const DPMBase &md)
	Operator overloading of DPMBase class, writes the StatType to the given ostream. More...

Detailed Description

The DPMBase header includes quite a few header files, defining all the handlers, which are essential. Moreover, it defines and solves a DPM problem. It is inherited from FilesAndRunNumber (public).

Bug:

When restarting the first time step is not saved, therefore there is a missing time step after a restart

Definition at line 65 of file DPMBase.h.

Constructor & Destructor Documentation

DPMBase::DPMBase

(

)

Constructor that calls the "void constructor()".

Definition at line 143 of file DPMBase.cc.

References constructor().

{
    constructor();
}

DPMBase::DPMBase

(

const FilesAndRunNumber &

other

)

Copy constructor type-1.

Parameters

[in]

other

Definition at line 87 of file DPMBase.cc.

References constructor().

        : FilesAndRunNumber(other)
{
    constructor();
}

DPMBase::DPMBase

(

const DPMBase &

other

)

Copy constructor type-2.

Parameters

[in]

other

Definition at line 96 of file DPMBase.cc.

References append_, boundaryHandler, elasticEnergy_, gravity_, interactionHandler, ntimeSteps_, particleDimensions_, particleHandler, random, restarted_, restartVersion_, rotation_, BaseHandler< T >::setDPMBase(), speciesHandler, systemDimensions_, time_, timeMax_, timeStep_, wallHandler, writeParticlesVTK_, writeWallsVTK_, xBallsAdditionalArguments_, xBallsColourMode_, xBallsScale_, xBallsVectorScale_, xMax_, xMin_, yMax_, yMin_, zMax_, and zMin_.

{
    elasticEnergy_ = other.elasticEnergy_;
    systemDimensions_ = other.systemDimensions_;
    particleDimensions_ = other.particleDimensions_;
    gravity_ = other.gravity_;
    xMin_ = other.xMin_;
    xMax_ = other.xMax_;
    yMin_ = other.yMin_;
    yMax_ = other.yMax_;
    zMin_ = other.zMin_;
    zMax_ = other.zMax_;
    time_ = other.time_;
    timeStep_ = other.timeStep_;
    ntimeSteps_ = other.ntimeSteps_;
    timeMax_ = other.timeMax_;
    restartVersion_ = other.restartVersion_; //to read new and old restart data
    restarted_ = other.restarted_; //to see if it was restarted or not
    append_ = other.append_;
    rotation_ = other.rotation_;
    xBallsColourMode_ = other.xBallsColourMode_; // sets the xballs argument cmode (see xballs.txt)
    xBallsVectorScale_ = other.xBallsVectorScale_; // sets the xballs argument vscale (see xballs.txt)
    xBallsScale_ = other.xBallsScale_; // sets the xballs argument scale (see xballs.txt)
    xBallsAdditionalArguments_ = other.xBallsAdditionalArguments_; // std::string where additional xballs argument can be specified (see xballs.txt)
    writeWallsVTK_ = other.writeWallsVTK_;
    writeParticlesVTK_ = other.writeParticlesVTK_;
#ifdef CONTACT_LIST_HGRID
    possibleContactList=other.possibleContactList;
#endif
    random = other.random;

    boundaryHandler.setDPMBase(this);
    particleHandler.setDPMBase(this);
    interactionHandler.setDPMBase(this);
    speciesHandler.setDPMBase(this);
    wallHandler.setDPMBase(this);

    speciesHandler = other.speciesHandler;
    particleHandler = other.particleHandler;
    wallHandler = other.wallHandler;
    boundaryHandler = other.boundaryHandler;
    interactionHandler = other.interactionHandler;
}

DPMBase::~DPMBase ( )

virtual

virtual destructor

Definition at line 151 of file DPMBase.cc.

{

}

Member Function Documentation

void DPMBase::actionsAfterSolve ( )

protectedvirtual

A virtual function which allows to define operations to be executed after the solve().

no implementation but can be overidden in its derived classes.

Definition at line 786 of file DPMBase.cc.

Referenced by solve(), and Mercury3DRestart::writeOutputFiles().

{
}

void DPMBase::actionsAfterTimeStep ( )

protectedvirtual

A virtual function which allows to define operations to be executed after time step.

no implementation but can be overidden in its derived classes.

Definition at line 793 of file DPMBase.cc.

Referenced by solve().

{
}

void DPMBase::actionsBeforeTimeLoop ( )

protectedvirtual

A virtual function. Allows one to carry out any operations before the start of the time loop.

no implementation but can be overriden in its derived classes.

Definition at line 722 of file DPMBase.cc.

Referenced by solve().

{
}

void DPMBase::actionsBeforeTimeStep ( )

protectedvirtual

A virtual function which allows to define operations to be executed before the new time step.

no implementation but can be overidden in its derived classes.

Reimplemented in Chute, and ChuteBottom.

Definition at line 779 of file DPMBase.cc.

Referenced by helpers::loadingTest(), helpers::normalAndTangentialLoadingTest(), helpers::objectivenessTest(), and solve().

{
}

void DPMBase::actionsOnRestart ( )

protectedvirtual

A virtual function where the users can add extra code which is executed only when the code is restarted.

no implementation but can be overidden in its derived classes.

Definition at line 736 of file DPMBase.cc.

Referenced by solve().

{
}

bool DPMBase::areInContact	(	const BaseParticle *	pI,
		const BaseParticle *	pJ
	)		const

Checks if two particle are in contact or is there any positive overlap.

Parameters

[in]	pI
[in]	pJ

Returns

bool (True or False)

Definition at line 713 of file DPMBase.cc.

References Vec3D::getDistanceSquared(), BaseParticle::getInteractionRadius(), BaseInteractable::getPosition(), and mathsFunc::square().

Referenced by Mercury3D::hGridHasContactsInTargetCell().

{
    return (pI != pJ && Vec3D::getDistanceSquared(pI->getPosition(), pJ->getPosition()) <
                       mathsFunc::square(pI->getInteractionRadius() + pJ->getInteractionRadius()));
}

void DPMBase::broadPhase ( BaseParticle *  i )

protectedvirtual

By broad one means to screen and determine an approximate number of particles that a given particle can be in contact with. Hence the word "Broad phase" of contact detection.

Parameters

[in]

i

Reimplemented in MercuryBase.

Definition at line 866 of file DPMBase.cc.

References BaseHandler< T >::begin(), computeInternalForces(), and particleHandler.

Referenced by computeInternalForces().

{
    for (auto it = particleHandler.begin(); (*it) != i; ++it)
    {
        computeInternalForces(i, *it);
    }
}

void DPMBase::checkAndDuplicatePeriodicParticles ( )

protected

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.

Definition at line 2782 of file DPMBase.cc.

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

Referenced by solve().

{
    for (BaseBoundary* b : boundaryHandler) // For all pointers of type BaseBoundary in Boundary handler
    {
        unsigned int N = particleHandler.getNumberOfObjects(); //Required because the number of particles increases
        for (unsigned int i = 0; i < N; i++)
        {
            b->createPeriodicParticles(particleHandler.getObject(i), particleHandler);
        }
    }
}

void DPMBase::checkInteractionWithBoundaries ( )

protectedvirtual

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.

\\ calls checkBoundaryAfterParticleMoved()

Definition at line 1763 of file DPMBase.cc.

References BaseHandler< T >::begin(), boundaryHandler, BaseHandler< T >::end(), and particleHandler.

Referenced by solve().

{
    for (BaseBoundary* b : boundaryHandler)
    {
        for (auto p = particleHandler.begin(); p != particleHandler.end(); ++p)
        {
            if (b->checkBoundaryAfterParticleMoved(*p, particleHandler))
                //Returns true if the particle is deleted
                --p;
        }
    }
}

bool DPMBase::checkParticleForInteraction ( const BaseParticle &  p )

virtual

Checks if the particle having any interaction with walls or other particles.

A very useful feature. For example, when one wants to have an initial condition with particles free of interactions with other particles or walls, one could use this to see if a particle about to be inserted would have interactions. If yes, then the particle would not be considered for insertion.

However can prove expensive if the number of particles is large.

Parameters

[in]

p

The particle for which one wants to detect collisions (or the lack thereof).

Returns

true if and only if there are no interactions with other particles or walls.

Reimplemented in MercuryBase.

Definition at line 2632 of file DPMBase.cc.

References checkParticleForInteractionLocal(), and checkParticleForInteractionLocalPeriodic().

Referenced by InsertionBoundary::checkBoundaryBeforeTimeStep().

{
#ifdef MERCURY_USE_MPI
    int localInteraction = checkParticleForInteractionLocal(p);

    MPIContainer& communicator = MPIContainer::Instance();
    int numberOfProcessors = communicator.getNumberOfProcessors();

    //The root gathers all values and computes the global value
    int *interactionList = nullptr;
    if (communicator.getProcessorID() == 0)
    {
        interactionList = new int [numberOfProcessors];
    }

    //Gather all local values
    communicator.gather(localInteraction,interactionList);

    //Compute the global value
    int globalInteraction = 1;
    if (communicator.getProcessorID() == 0)
    {
        for (int i = 0; i<numberOfProcessors; i++)
        {
            if (interactionList[i] == 0)
            {
                globalInteraction = 0;
                break;
            }
        }
    }
    //The root now tells the other processors what the global value for the interaction is
    communicator.broadcast(globalInteraction);

    //Convert the result back to bool
    bool interaction = globalInteraction;
#else
    bool interaction = checkParticleForInteractionLocalPeriodic(p);
#endif
    return interaction;
}

bool DPMBase::checkParticleForInteractionLocal ( const BaseParticle &  p )

virtual

Checks if a particle P has any interaction with walls or other particles in the local domain.

A very useful feature. For example, when one wants to have an initial condition with particles free of interactions with other particles or walls, one could use this method and whether particles are interacting. If yes, then it would not consider this particle for insertion and continue onto the next particle. However can prove expensive if the number of particles is large.

Returns true if and only if there are no interactions with other particles in the local domain or walls.

Parameters

[in]

p

The particle for which one wants to detect collisions (or the lack thereof).

Returns

bool - true if particle P has no interactions, false if P has one or more interactions with other particles or walls.

Todo:

tw check against periodic copies (see ShearCell3DInitialConditions.cpp)

Reimplemented in MercuryBase.

Definition at line 2718 of file DPMBase.cc.

References Vec3D::getDistanceSquared(), BaseParticle::getInteractionRadius(), BaseInteractable::getPosition(), particleHandler, mathsFunc::square(), and wallHandler.

Referenced by checkParticleForInteraction(), and checkParticleForInteractionLocalPeriodic().

{
    Mdouble distance;
    Vec3D normal;

    //Check if it has no collision with walls
    for (BaseWall* w : wallHandler)
    {
        //returns false if the function getDistanceAndNormal returns true,
        //i.e. if there exists an interaction between wall and particle
        //\todo TW getDistanceAndNormal(p,distance,normal) should ideally be replaced by a inContact(p) function, as it doesn't require distance and normal for anything (and walls now can have multiple contacts, soon particles can have it too.)
        if (w->getDistanceAndNormal(p, distance, normal))
        {
            //std::cout<<"failure: Collision with wall: "<<**it<<std::endl;
            return false;
        }
        else
        {
            //std::cout<<"No collision with wall: "<<**it<<std::endl;
        }
    }

    //Check if it has no collision with other particles
    for (BaseParticle* q : particleHandler)
    {
        //returns false if the particle separation is less than the relevant sum of interaction radii
        //(i.e. another particle is in contact with P)
        if (Vec3D::getDistanceSquared(q->getPosition(), p.getPosition())
            < mathsFunc::square(q->getInteractionRadius() + p.getInteractionRadius()))
        {
            //std::cout<<"failure: Collision with particle "<<**it<<std::endl;
            return false;
        }
        else
        {
            //std::cout<<"No collision with particle "<<**it<<std::endl;
        }
    }
    return true;
}

bool DPMBase::checkParticleForInteractionLocalPeriodic

(

const BaseParticle &

p

)

Extends the capability of detecting intersecting particles to periodic systems

Todo:

TW the implementation of this function is not very efficient and should be improved

Parameters

p

Returns

Definition at line 2680 of file DPMBase.cc.

References boundaryHandler, checkParticleForInteractionLocal(), PeriodicBoundary::getDistance(), BaseParticle::getInteractionRadius(), ParticleHandler::getLargestParticle(), BaseHandler< T >::getNumberOfObjects(), particleHandler, and PeriodicBoundary::shiftPosition().

Referenced by checkParticleForInteraction(), and MercuryBase::checkParticleForInteraction().

                                                                            {
    //A vector of ghost particles of the particle that is to be inserted (empty if no periodic boundaries are present)
    std::vector<BaseParticle> pPeriodic;
    for (BaseBoundary* b : boundaryHandler) {
        PeriodicBoundary* pb = dynamic_cast<PeriodicBoundary*>(b);
        if (pb) {
            for (int i=pPeriodic.size()-1; i>=0; --i) {
                if (particleHandler.getNumberOfObjects()>0 && pb->getDistance(pPeriodic[i]) < pPeriodic[i].getInteractionRadius() + particleHandler.getLargestParticle()->getInteractionRadius()) {
                    pPeriodic.push_back(pPeriodic[i]);
                    pb->shiftPosition(&pPeriodic.back());
                }
            }
            if (particleHandler.getNumberOfObjects()>0 && pb->getDistance(p) < p.getInteractionRadius() + particleHandler.getLargestParticle()->getInteractionRadius()) {
                pPeriodic.push_back(p);
                pb->shiftPosition(&pPeriodic.back());
            }
        }
    }
    //check the particle AND the ghost particles for intersection problems
    bool insertable = checkParticleForInteractionLocal(p);
    for (BaseParticle& pP : pPeriodic) {
        insertable &= checkParticleForInteractionLocal(pP);
    }
    return insertable;
}

void DPMBase::checkSettings

(

)

Checks if the essentials are set properly to go ahead with solving the problem.

1. Checks if at least one species exists in the SpeciesHandler.
   1. Checks if particle dimensions are set.
   2. Checks if system dimensions are set.
   3. Checks if the time step is set or not.

Definition at line 2115 of file DPMBase.cc.

References BaseHandler< T >::getNumberOfObjects(), getParticleDimensions(), getSystemDimensions(), getTimeStep(), and speciesHandler.

Referenced by solve().

{
    if (speciesHandler.getNumberOfObjects() == 0)
    {
        std::cerr << "Error in solve(): at least one species has to be defined" << std::endl;
        exit(-1);
    }
    if (getParticleDimensions() == 0)
    {
        std::cerr << "Error in solve(): particleDimensions not specified" << std::endl;
        exit(-1);
    }
    if (getSystemDimensions() == 0)
    {
        std::cerr << "Error in solve(): systemDimensions not specified" << std::endl;
        exit(-1);
    }
    if (getTimeStep() == 0.0)
    {
        std::cerr << "Error in solve(): timeStep not specified" << std::endl;
        exit(-1);
    }
}

void DPMBase::computeAllForces ( )

protectedvirtual

Computes all the forces acting on the particles by using the setTorque and setForce methods. See BaseInteractible.cc.

Reset all forces to zero

Now loop over all particles contacts computing force contributions

Now loop over all other particles looking for contacts

Definition at line 1841 of file DPMBase.cc.

References computeExternalForces(), computeInternalForces(), PossibleContact::getNext(), PossibleContact::getP1(), PossibleContact::getP2(), particleHandler, and wallHandler.

Referenced by solve().

{
    for (BaseParticle* const p : particleHandler)
    {
        p->setForce(Vec3D(0.0, 0.0, 0.0));
        p->setTorque(Vec3D(0.0, 0.0, 0.0));
    }
    for (BaseWall* const w : wallHandler)
    {
        w->setForce(Vec3D(0.0, 0.0, 0.0));
        w->setTorque(Vec3D(0.0, 0.0, 0.0));
    } //end reset forces loop

#ifdef DEBUG_OUTPUT
    std::cerr << "Have all forces set to zero " << std::endl;
#endif

    
    for (BaseParticle* p : particleHandler)
    {

        computeInternalForces(p);
        //end inner loop over contacts.

        computeExternalForces(p);

    }

#ifdef CONTACT_LIST_HGRID
    //possibleContactList.write(std::cout);
    PossibleContact* Curr=possibleContactList.getFirstPossibleContact();
    while(Curr)
    {   
        computeInternalForces(Curr->getP1(),Curr->getP2());
        Curr=Curr->getNext();
    }
#endif
    //end outer loop over contacts.

}

void DPMBase::computeExternalForces ( BaseParticle *  CI )

protectedvirtual

Computes the external forces acting on particles (e.g. gravitational)

Todo:

take out computeWalls() from compute External Forces method.

Parameters

[in]

CI

Definition at line 1703 of file DPMBase.cc.

References BaseInteractable::addForce(), computeForcesDueToWalls(), getGravity(), BaseParticle::getMass(), and BaseParticle::isFixed().

Referenced by computeAllForces().

{
    if (!CI->isFixed())
    {
        // Gravitational force
        CI->addForce(getGravity() * CI->getMass());
        // Still calls this in compute External Forces.
        computeForcesDueToWalls(CI);
    }
}

void DPMBase::computeForcesDueToWalls ( BaseParticle *  pI )

protectedvirtual

Computes the forces on the particles due to the walls (normals are outward normals)

Parameters

[in]

pI

Todo:

TW: I think this torque has the wrong sign

Definition at line 1717 of file DPMBase.cc.

References BaseInteractable::addForce(), BaseInteractable::addTorque(), Vec3D::cross(), BaseParticle::getPeriodicFromParticle(), BaseInteractable::getPosition(), getRotation(), getTime(), getTimeStep(), interactionHandler, and wallHandler.

Referenced by computeExternalForces().

{
    //No need to compute interactions between periodic particle images and walls
    if (pI->getPeriodicFromParticle() != nullptr)
        return;

    for (BaseWall* w : wallHandler)
    {
        std::vector<BaseInteraction*> interactions = w->getInteractionWith(pI, getTime() + getTimeStep(),
                                                                           &interactionHandler);

        for (auto i : interactions)
        {
            i->computeForce();

            pI->addForce(i->getForce());
            w->addForce(-i->getForce());

            if (getRotation()) // getRotation() returns a boolean.
            {
                pI->addTorque(i->getTorque() - Vec3D::cross(pI->getPosition() - i->getContactPoint(), i->getForce()));
                w->addTorque(-i->getTorque() + Vec3D::cross(w->getPosition() - i->getContactPoint(), i->getForce()));
            }
        }
    }
}

void DPMBase::computeInternalForces ( BaseParticle *  i )

protectedvirtual

Computes the forces between particles (internal in the sense that the sum over all these forces is zero i.e. fully modelled forces)

Parameters

[in]

i

Definition at line 1888 of file DPMBase.cc.

References broadPhase().

Referenced by broadPhase(), computeAllForces(), Mercury3D::hGridFindContactsWithinTargetCell(), Mercury2D::hGridFindContactsWithinTargetCell(), Mercury2D::hGridFindContactsWithTargetCell(), and Mercury3D::hGridFindContactsWithTargetCell().

{
    broadPhase(i);
}

void DPMBase::computeInternalForces ( BaseParticle *  P1, BaseParticle *  P2  )

protectedvirtual

Computes the forces between particles (internal in the sense that the sum over all these forces is zero i.e. fully modelled forces)

Parameters

[in]	P1
[in]	P2

Definition at line 1657 of file DPMBase.cc.

References BaseInteractable::addForce(), BaseInteractable::addTorque(), Vec3D::cross(), BaseObject::getId(), BaseParticle::getInteractionWith(), BaseParticle::getPeriodicFromParticle(), BaseInteractable::getPosition(), getRotation(), getTime(), getTimeStep(), interactionHandler, and BaseParticle::isFixed().

{
    //this is because the rough bottom allows overlapping fixed particles
    if (P1->isFixed() && P2->isFixed())
    {
        return;
    }

    if (P1->getPeriodicFromParticle() && P2->getPeriodicFromParticle())
    {
        return;
    }

    BaseParticle* PI, * PJ;
    if (P1->getId() > P2->getId())
    {
        PI = P2;
        PJ = P1;
    } else
    {
        PI = P1;
        PJ = P2;
    }

    //if statement above ensures that the PI has the lower id than PJ
    std::vector<BaseInteraction*> interactions = PJ->getInteractionWith(PI, getTime() + getTimeStep(),
                                                                        &interactionHandler);
    for (auto i : interactions)
    {
        i->computeForce();

        PI->addForce(i->getForce());
        PJ->addForce(-i->getForce());

        if (getRotation())
        {
            PI->addTorque(i->getTorque() - Vec3D::cross(PI->getPosition() - i->getContactPoint(), i->getForce()));
            PJ->addTorque(-i->getTorque() + Vec3D::cross(PJ->getPosition() - i->getContactPoint(), i->getForce()));
        }
    }
}

void DPMBase::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().

Definition at line 905 of file DPMBase.cc.

References boundaryHandler, gravity_, interactionHandler, loggerOutput, logWriteAndDie(), NO_FILE, ntimeSteps_, LoggerOutput::onFatal, particleHandler, random, setAppend(), BaseHandler< T >::setDPMBase(), Files::setName(), setParticleDimensions(), RNG::setRandomSeed(), setRestarted(), Files::setSaveCount(), BaseHandler< T >::setStorageCapacity(), setSystemDimensions(), speciesHandler, time_, timeMax_, timeStep_, wallHandler, writeParticlesVTK_, writeWallsVTK_, xBallsAdditionalArguments_, xBallsColourMode_, xBallsScale_, xBallsVectorScale_, xMax_, xMin_, yMax_, yMin_, zMax_, and zMin_.

Referenced by DPMBase().

{
    //These are the particle parameters like dissipation etc..
    setRestarted(false);

    //This sets the maximum number of particles
    boundaryHandler.setDPMBase(this);
    speciesHandler.setDPMBase(this);
    particleHandler.setDPMBase(this);
    interactionHandler.setDPMBase(this);
    wallHandler.setDPMBase(this);
    interactionHandler.setDPMBase(this);

    particleHandler.setStorageCapacity(2);
    setSystemDimensions(2);
    setParticleDimensions(2);

    // Set gravitational acceleration
    gravity_ = Vec3D(0.0, -9.8, 0.0);

    //This is the parameter of the numerical part
    time_ = 0.0;
    timeStep_ = 0.0; // if dt is not user-specified, this is set in actionsBeforeTimeLoop()
    ntimeSteps_ = 0;
    setSaveCount(20);
    timeMax_ = 1.0;

    //This sets the default xballs domain
    xMin_ = 0.0;
    xMax_ = 0.01;
    yMin_ = 0.0;
    yMax_ = 0.01;
    zMin_ = 0.0;
    zMax_ = 0.0;

    //sets the default write particles data in VTK format flag to false
    writeParticlesVTK_ = false;
    writeWallsVTK_ = FileType::NO_FILE;

    loggerOutput->onFatal = logWriteAndDie;

    setName("");

    //Default mode is energy with no scale of the vectors
    xBallsColourMode_ = 0;
    xBallsVectorScale_ = -1;
    xBallsScale_ = -1;
    xBallsAdditionalArguments_ = "";
    setAppend(false);
//TODO
    //The default random seed is 0
    random.setRandomSeed(0);

#ifdef DEBUG_OUTPUT
    std::cerr << "MD problem constructor finished " << std::endl;
#endif
}

bool DPMBase::continueSolve ( ) const

protectedvirtual

Returns

bool (True or False)

Definition at line 897 of file DPMBase.cc.

Referenced by solve().

{
    return true;
}

Mdouble DPMBase::domainSize ( ) const

protected

Definition at line 2818 of file DPMBase.cc.

References getXMax(), getXMin(), getYMax(), getYMin(), getZMax(), and getZMin().

{
    return (getXMax() - getXMin()) * (getYMax() - getYMin()) * (getZMax() - getZMin());
}

bool DPMBase::findNextExistingDataFile	(	Mdouble	tMin,
		bool	verbose = true
	)

Useful when fileType is chosen as Multiple Files or Multiple files with padded.

Parameters

[in]	tMin
[in]	verbose

Returns

bool (True or False)

Definition at line 1401 of file DPMBase.cc.

References Files::dataFile, File::getCounter(), File::getFileType(), File::getFstream(), File::getName(), MULTIPLE_FILES, MULTIPLE_FILES_PADDED, and File::openNextFile().

{
    if (dataFile.getFileType() == FileType::MULTIPLE_FILES || dataFile.getFileType() == FileType::MULTIPLE_FILES_PADDED)
    {
        while (true)// This true corresponds to the if s
        {
            dataFile.openNextFile();
            //check if file exists and contains data
            int N;
            dataFile.getFstream() >> N;
            if (dataFile.getFstream().eof() || dataFile.getFstream().peek() == -1)
            {
                std::cout << "file " << dataFile.getName() << " not found" << std::endl;
                return false;
            }
            //check if tmin condition is satisfied
            Mdouble t;
            dataFile.getFstream() >> t;
            if (t > tMin)
            {
                //set_file_counter(get_file_counter()-1);
                return true;
            }
            if (verbose)
                std::cout << "Jumping file counter: " << dataFile.getCounter() << std::endl;
        }
    }
    return true;
}

void DPMBase::finishStatistics ( )

protectedvirtual

no implementation but can be overidden in its derived classes.

Reimplemented in StatisticsVector< T >.

Definition at line 838 of file DPMBase.cc.

Referenced by solve(), and Mercury3DRestart::writeOutputFiles().

{
}

void DPMBase::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  )

virtual

//Not unsigned index because of possible wall collisions.

no implementation but can be overidden in its derived classes.

Reimplemented in StatisticsVector< T >.

Definition at line 822 of file DPMBase.cc.

Referenced by BaseInteraction::gatherContactStatistics().

{
}

void DPMBase::gatherContactStatistics ( )

protected

Definition at line 811 of file DPMBase.cc.

References interactionHandler.

{
    for (BaseInteraction* c : interactionHandler)
    {
        c->gatherContactStatistics();
    }
}

int DPMBase::getAddLarge

(

)

const

returns the number of large particles that are to be added on restart.

Returns

addS_

Definition at line 327 of file DPMBase.cc.

References addL_.

{
    return addL_;
}

int DPMBase::getAddSmall

(

)

const

returns the number of small particles that are to be added on restart.

Returns

addL_

Definition at line 335 of file DPMBase.cc.

References addS_.

{
    return addS_;
}

bool DPMBase::getAppend

(

)

const

Returns the flag denoting if the append option is on or off.

Returns

bool (True or False)

Definition at line 643 of file DPMBase.cc.

References append_.

Referenced by solve(), and writeEneHeader().

{
    return append_;
}

bool DPMBase::getDoCGAlways

(

)

const

Todo:

This method is not implemented

Mdouble DPMBase::getElasticEnergy

(

)

const

Returns the global elastic energy within the system.

Returns

Mdouble elasticEnergy

Definition at line 659 of file DPMBase.cc.

References interactionHandler.

Referenced by writeEneTimestep().

{
    Mdouble elasticEnergy = 0.0;
    for (const BaseInteraction* c : interactionHandler)
    {
        elasticEnergy += c->getElasticEnergy();
    }
    return elasticEnergy;
}

Mdouble DPMBase::getGravitationalEnergy

(

)

const

Returns the global gravitational potential energy stored in the system.

Definition at line 686 of file DPMBase.cc.

References Vec3D::dot(), getGravity(), and particleHandler.

{
    Mdouble gravitationalEnergy = 0;
    for (const BaseParticle* const p : particleHandler)
    {
        if (!(p->isFixed()))
        {
            gravitationalEnergy += p->getMass() * Vec3D::dot((-getGravity()), p->getPosition());
        }
    }
    return gravitationalEnergy;

}

Vec3D DPMBase::getGravity

(

)

const

Returns the gravity vector.

Returns

Vec3D gravity_

Definition at line 545 of file DPMBase.cc.

References gravity_.

Referenced by computeExternalForces(), getGravitationalEnergy(), ChuteWithHopper::getMaximumVelocityInducedByGravity(), Chute::setChuteAngle(), write(), and writeEneTimestep().

{
    return gravity_;
}

bool DPMBase::getHGridUpdateEachTimeStep ( ) const

protectedvirtual

Returns

bool (True or False)

Reimplemented in MercuryBase.

Definition at line 771 of file DPMBase.cc.

{
    return true;
}

double DPMBase::getInfo ( const BaseParticle &  p ) const

virtual

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.

Returns

double

Definition at line 703 of file DPMBase.cc.

References BaseObject::getId(), and BaseInteractable::getSpecies().

Referenced by ParticleHandler::writeVTK().

{
    return p.getSpecies()->getId(); // was getIndex()
}

Mdouble DPMBase::getKineticEnergy

(

)

const

Returns the global kinetic energy stored in the system.

Returns

Mdouble kineticEnergy

Definition at line 672 of file DPMBase.cc.

References particleHandler.

{
    Mdouble kineticEnergy = 0;
    for (const BaseParticle* const p : particleHandler)
    {
        if (!(p->isFixed()))
        {
            kineticEnergy += .5 * p->getMass() * p->getVelocity().getLengthSquared();
        }
    }
    return kineticEnergy;
}

Vec3D DPMBase::getMax ( ) const

inline

Return the "upper right" corner of the domain, a vector with xMin_, yMin_ and zMin_.

Definition at line 335 of file DPMBase.h.

References xMax_, yMax_, and zMax_.

Referenced by InfiniteWall::createVTK(), FileReader::read(), AxisymmetricIntersectionOfWalls::writeVTK(), and WallHandler::writeVTKBoundingBox().

{return Vec3D(xMax_,yMax_,zMax_);}

Vec3D DPMBase::getMin ( ) const

inline

Return the "bottom left" corner of the domain, a vector with xMin_, yMin_ and zMin_.

Definition at line 330 of file DPMBase.h.

References xMin_, yMin_, and zMin_.

Referenced by InfiniteWall::createVTK(), FileReader::read(), AxisymmetricIntersectionOfWalls::writeVTK(), and WallHandler::writeVTKBoundingBox().

{return Vec3D(xMin_,yMin_,zMin_);}

unsigned int DPMBase::getNtimeSteps

(

)

const

Returns the current counter of time steps.

Returns

ntimeSteps_

Definition at line 177 of file DPMBase.cc.

References ntimeSteps_.

Referenced by FileReader::read(), and readNextArgument().

{
    return ntimeSteps_;
}

unsigned int DPMBase::getParticleDimensions

(

)

const

Returns the particle dimensions.

Returns

particleDimensions_

Definition at line 599 of file DPMBase.cc.

References particleDimensions_.

Referenced by checkSettings(), BaseParticle::getParticleDimensions(), ParticleSpecies::getVolumeFromRadius(), and write().

{
    return particleDimensions_;
}

bool DPMBase::getParticlesWriteVTK

(

)

const

Returns a flag indicating if particle rotation is enabled or disabled.

Returns

bool

Definition at line 271 of file DPMBase.cc.

References writeParticlesVTK_.

Referenced by writeVTK().

{
    return writeParticlesVTK_;
}

bool DPMBase::getRestarted

(

)

const

Returns the flag denoting if the simulation was restarted or not.

Returns

restarted_

Definition at line 626 of file DPMBase.cc.

References restarted_.

Referenced by solve(), and writeOutputFiles().

{
    return restarted_;
}

std::string DPMBase::getRestartVersion

(

)

const

This is to take into account for different Mercury versions. Returns the version of the restart file.

Returns

restartVersion_

Definition at line 608 of file DPMBase.cc.

References restartVersion_.

Referenced by Chute::read().

{
    return restartVersion_;
}

bool DPMBase::getRotation

(

)

const

Returns a flag indicating if particle rotation is enabled or disabled.

Returns

bool (True or False)

Definition at line 239 of file DPMBase.cc.

References rotation_.

Referenced by computeForcesDueToWalls(), and computeInternalForces().

{
    return rotation_;
}

unsigned int DPMBase::getSystemDimensions

(

)

const

Returns the dimension of the simulation. Note there is also a particle dimension.

Returns

systemDimensions_

Definition at line 575 of file DPMBase.cc.

References systemDimensions_.

Referenced by checkSettings(), HGridOptimiser::initialise(), outputXBallsData(), readNextDataFile(), StatisticsVector< T >::setNZ(), and write().

{
    return systemDimensions_;
}

Mdouble DPMBase::getTime

(

)

const

Access function for the time.

Returns

time_

Definition at line 169 of file DPMBase.cc.

References time_.

Referenced by StatisticsVector< T >::check_current_time_for_statistics(), computeForcesDueToWalls(), computeInternalForces(), HertzianSinterInteraction::computeSinterForce(), LeesEdwardsBoundary::getCurrentShift(), LeesEdwardsBoundary::getCurrentVelocity(), integrateAfterForceComputation(), integrateBeforeForceComputation(), isTimeEqualTo(), helpers::loadingTest(), main(), helpers::normalAndTangentialLoadingTest(), helpers::objectivenessTest(), outputXBallsData(), Chute::printTime(), printTime(), FileReader::read(), ShearBoxBoundary::shiftHorizontalPosition(), LeesEdwardsBoundary::shiftVerticalPosition(), solve(), LeesEdwardsBoundary::write(), write(), writeEneTimestep(), writeFstatHeader(), and writeVTK().

{
    return time_;
}

Mdouble DPMBase::getTimeMax

(

)

const

Allows the user to access the total simulation time during the simulation. Cannot change it though.

Returns

timeMax_

Definition at line 214 of file DPMBase.cc.

References timeMax_.

Referenced by StatisticsVector< T >::getTimeMaxStat(), helpers::loadingTest(), helpers::normalAndTangentialLoadingTest(), helpers::objectivenessTest(), Chute::printTime(), printTime(), Mercury3DRestart::readNextArgument(), readNextArgument(), solve(), and write().

{
    return timeMax_;
}

Mdouble DPMBase::getTimeStep

(

)

const

Allows the time step dt to be accessed.

Returns

timeStep_

Definition at line 465 of file DPMBase.cc.

References timeStep_.

Referenced by StatisticsVector< T >::check_current_time_for_statistics(), checkSettings(), computeForcesDueToWalls(), SlidingFrictionInteraction::computeFrictionForce(), FrictionInteraction::computeFrictionForce(), MindlinInteraction::computeFrictionForce(), MindlinRollingTorsionInteraction::computeFrictionForce(), computeInternalForces(), SinterInteraction::computeNormalForce(), HertzianSinterInteraction::computeSinterForce(), ChuteWithHopper::getTimeStepRatio(), integrateAfterForceComputation(), integrateBeforeForceComputation(), isTimeEqualTo(), ChuteBottom::makeRoughBottom(), readNextArgument(), readParAndIniFiles(), and write().

{
    return timeStep_;
}

FileType DPMBase::getWallsWriteVTK

(

)

const

Returns a flag indicating if particle rotation is enabled or disabled.

Returns

bool

Definition at line 263 of file DPMBase.cc.

References writeWallsVTK_.

Referenced by writeVTK().

{
    return writeWallsVTK_;
}

std::string DPMBase::getXBallsAdditionalArguments

(

)

const

Returns the additional arguments for xballs.

Returns

xBallsAdditionalArguments_

Definition at line 513 of file DPMBase.cc.

References xBallsAdditionalArguments_.

Referenced by write().

{
    return xBallsAdditionalArguments_;
}

int DPMBase::getXBallsColourMode

(

)

const

Get the xball colour mode (CMode)

Returns

int xBallsColourMode_

Definition at line 481 of file DPMBase.cc.

References xBallsColourMode_.

{
    return xBallsColourMode_;
}

double DPMBase::getXBallsScale

(

)

const

Returns the scale of the view in xballs.

Returns

double xBallsScale_

Definition at line 529 of file DPMBase.cc.

References xBallsScale_.

{
    return xBallsScale_;
}

double DPMBase::getXBallsVectorScale

(

)

const

Returns the scale of vectors used in xballs.

Returns

double xBallsVectorScale_

Definition at line 497 of file DPMBase.cc.

References xBallsVectorScale_.

{
    return xBallsVectorScale_;
}

Mdouble DPMBase::getXMax

(

)

const

If the length of the problem domain in x-direction is XMax - XMin, then getXMax() returns XMax,.

Returns

xMax_

Definition at line 287 of file DPMBase.cc.

References xMax_.

Referenced by Chute::cleanChute(), Chute::createBottom(), domainSize(), ChuteWithHopper::getChuteLength(), Chute::getChuteLength(), ChuteWithHopper::getMaximumVelocityInducedByGravity(), StatisticsVector< T >::getXMaxStat(), HGridOptimiser::initialise(), outputXBallsData(), readParAndIniFiles(), ChuteWithHopper::setHopperShift(), ChuteBottom::setupInitialConditions(), Chute::setupInitialConditions(), setXMin(), write(), and writeFstatHeader().

{
    return xMax_;
}

Mdouble DPMBase::getXMin

(

)

const

If the length of the problem domain in x-direction is XMax - XMin, then getXMin() returns XMin,.

Returns

xMin_

Definition at line 279 of file DPMBase.cc.

References xMin_.

Referenced by Chute::cleanChute(), Chute::createBottom(), domainSize(), StatisticsVector< T >::getXMinStat(), HGridOptimiser::initialise(), outputXBallsData(), readParAndIniFiles(), ChuteBottom::setupInitialConditions(), Chute::setupInitialConditions(), setXMax(), write(), and writeFstatHeader().

{
    return xMin_;
}

Mdouble DPMBase::getYMax

(

)

const

If the length of the problem domain in y-direction is YMax - YMin, then getYMax() returns XMax,.

Returns

yMax_

Definition at line 303 of file DPMBase.cc.

References yMax_.

Referenced by ChuteWithHopper::addHopper(), Chute::createBottom(), domainSize(), Chute::getChuteWidth(), StatisticsVector< T >::getYMaxStat(), HGridOptimiser::initialise(), outputXBallsData(), readParAndIniFiles(), ChuteBottom::setupInitialConditions(), Chute::setupInitialConditions(), ChuteWithHopper::setupInitialConditions(), Chute::setupSideWalls(), setYMin(), write(), and writeFstatHeader().

{
    return yMax_;
}

Mdouble DPMBase::getYMin

(

)

const

If the length of the problem domain in y-direction is YMax - YMin, then getYMin() returns YMin,.

Returns

yMin_

Definition at line 295 of file DPMBase.cc.

References yMin_.

Referenced by ChuteWithHopper::addHopper(), Chute::createBottom(), domainSize(), StatisticsVector< T >::getYMinStat(), HGridOptimiser::initialise(), outputXBallsData(), readParAndIniFiles(), ChuteBottom::setupInitialConditions(), Chute::setupInitialConditions(), ChuteWithHopper::setupInitialConditions(), Chute::setupSideWalls(), setYMax(), write(), and writeFstatHeader().

{
    return yMin_;
}

Mdouble DPMBase::getZMax

(

)

const

If the length of the problem domain in z-direction is ZMax - ZMin, then getZMax() returns ZMax,.

Returns

zMax_

Definition at line 319 of file DPMBase.cc.

References zMax_.

Referenced by domainSize(), StatisticsVector< T >::getZMaxStat(), HGridOptimiser::initialise(), outputXBallsData(), readParAndIniFiles(), ChuteBottom::setupInitialConditions(), Chute::setupInitialConditions(), setZMin(), write(), and writeFstatHeader().

{
    return zMax_;
}

Mdouble DPMBase::getZMin

(

)

const

If the length of the problem domain in z-direction is ZMax - ZMin, then getZMin() returns ZMin,.

Returns

zMin_

Definition at line 311 of file DPMBase.cc.

References zMin_.

Referenced by Chute::createBottom(), domainSize(), StatisticsVector< T >::getZMinStat(), HGridOptimiser::initialise(), outputXBallsData(), readParAndIniFiles(), ChuteBottom::setupInitialConditions(), Chute::setupInitialConditions(), setZMax(), write(), and writeFstatHeader().

{
    return zMin_;
}

void DPMBase::hGridActionsAfterIntegration ( )

protectedvirtual

no implementation but can be overidden in its derived classes.

Reimplemented in MercuryBase.

Definition at line 859 of file DPMBase.cc.

Referenced by solve().

{
}

void DPMBase::hGridActionsBeforeIntegration ( )

protectedvirtual

no implementation but can be overidden in its derived classes.

Reimplemented in MercuryBase.

Definition at line 852 of file DPMBase.cc.

Referenced by solve().

{
}

void DPMBase::hGridActionsBeforeTimeLoop ( )

protectedvirtual

A virtual function that allows one to carry out hGrid operations before the start of the time loop.

no implementation but can be overidden in its derived classes.

Reimplemented in MercuryBase.

Definition at line 729 of file DPMBase.cc.

Referenced by solve().

{
}

void DPMBase::hGridActionsBeforeTimeStep ( )

protectedvirtual

A virtual function that allows one to set or execute hGrid parameters or operations before every simulation time step.

no implementation but can be overidden in its derived classes.

Reimplemented in MercuryBase.

Definition at line 743 of file DPMBase.cc.

Referenced by solve().

{
}

void DPMBase::hGridInsertParticle ( BaseParticle *obj  UNUSED )

virtual

no implementation but can be overidden in its derived classes.

Bug:

Why are the hGRID actions public, this seems wrong. Someone please comment [Ant].

Definition at line 750 of file DPMBase.cc.

Referenced by ParticleHandler::addObject().

{
}

void DPMBase::hGridRemoveParticle ( BaseParticle *obj  UNUSED )

virtual

no implementation but can be overidden in its derived classes.

Definition at line 764 of file DPMBase.cc.

Referenced by ParticleHandler::removeLastObject(), and ParticleHandler::removeObject().

{
}

void DPMBase::hGridUpdateMove ( BaseParticle *  , Mdouble    )

virtual

no implementation but can be overidden in its derived classes.

Reimplemented in MercuryBase.

Definition at line 845 of file DPMBase.cc.

Referenced by BaseParticle::integrateBeforeForceComputation().

{
}

void DPMBase::hGridUpdateParticle ( BaseParticle *obj  UNUSED )

virtual

no implementation but can be overidden in its derived classes.

Definition at line 757 of file DPMBase.cc.

Referenced by ParticleHandler::addObject(), MercuryBase::hGridActionsBeforeTimeStep(), and MercuryBase::hGridRebuild().

{
}

void DPMBase::initialiseStatistics ( )

protectedvirtual

no implementation but can be overidden in its derived classes.

Reimplemented in StatisticsVector< T >.

Definition at line 800 of file DPMBase.cc.

Referenced by solve().

{
}

void DPMBase::initialiseTangentialSprings ( )

protected

Todo:

This method is not implemented and never used.

void DPMBase::integrateAfterForceComputation ( )

protectedvirtual

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

Definition at line 1779 of file DPMBase.cc.

References BaseHandler< T >::begin(), BaseHandler< T >::end(), getTime(), getTimeStep(), particleHandler, and wallHandler.

Referenced by solve().

{
    for_each(particleHandler.begin(), particleHandler.end(), [this](BaseParticle* p)
    {
        p->integrateAfterForceComputation(getTime(), getTimeStep());
    });
    for_each(wallHandler.begin(), wallHandler.end(), [this](BaseWall* w)
    {
        w->integrateAfterForceComputation(getTime(), getTimeStep());
    });
}

void DPMBase::integrateBeforeForceComputation ( )

protectedvirtual

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.

Definition at line 1748 of file DPMBase.cc.

References BaseHandler< T >::begin(), BaseHandler< T >::end(), getTime(), getTimeStep(), particleHandler, and wallHandler.

Referenced by solve().

{
    for_each(particleHandler.begin(), particleHandler.end(), [this](BaseParticle* p)
    {
        p->integrateBeforeForceComputation(getTime(), getTimeStep());
    });
    for_each(wallHandler.begin(), wallHandler.end(), [this](BaseWall* w)
    {
        w->integrateBeforeForceComputation(getTime(), getTimeStep());
    });
}

bool DPMBase::isTimeEqualTo ( Mdouble  time ) const

protected

Checks if the input variable "time" is the current time in the simulation.

Returns

bool (True or False)

Definition at line 2813 of file DPMBase.cc.

References getTime(), and getTimeStep().

{
    return getTime() <= time && getTime() + getTimeStep() > time;
}

void DPMBase::outputInteractionDetails ( ) const

protected

Displays the interaction details corresponding to the pointer objects in the interaction handler.

Skims through all the object pointers of type BaseInteraction in the interaction handler. Outputs the type of interaction between two particles P and I.

Definition at line 2798 of file DPMBase.cc.

References interactionHandler.

{
    std::cout << "Interactions currently in the handler:" << std::endl;
    for (BaseInteraction* p : interactionHandler)
    {
        p->write(std::cout);
        std::cout << std::endl;
        std::cout << "Interaction " << p->getName() << " " << p->getId() << " between " << p->getP()->getId() << " and "
                  << p->getI()->getId() << std::endl;
    }
}

void DPMBase::outputStatistics ( )

protectedvirtual

no implementation but can be overidden in its derived classes.

Reimplemented in StatisticsVector< T >.

Definition at line 807 of file DPMBase.cc.

{
}

void DPMBase::outputXBallsData ( std::ostream &  os ) const

protectedvirtual

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.

Parameters

[in]

os

Definition at line 1147 of file DPMBase.cc.

References BaseHandler< T >::getNumberOfObjects(), getSystemDimensions(), getTime(), getXMax(), getXMin(), getYMax(), getYMin(), getZMax(), getZMin(), outputXBallsDataParticle(), and particleHandler.

Referenced by writeOutputFiles().

{
    //Set the correct formation based of dimension if the formation is not specified by the user
    unsigned int format;
    switch (getSystemDimensions())
    {
        case 2:
            format = 8;
            break;
        case 3:
            format = 14;
            break;
        default:
            std::cerr << "Unknown systemdimension" << std::endl;
            exit(-1);
    }

    // This outputs the location of walls and how many particles there are to file this is required by the xballs plotting
    if (format != 14) // dim = 1 or 2
    {
        os << particleHandler.getNumberOfObjects()
           << " " << getTime()
           << " " << getXMin()
           << " " << getYMin()
           << " " << getXMax()
           << " " << getYMax()
           << " " << std::endl;
    } else
    {
        //dim==3
        os << particleHandler.getNumberOfObjects()
           << " " << getTime()
           << " " << getXMin()
           << " " << getYMin()
           << " " << getZMin()
           << " " << getXMax()
           << " " << getYMax()
           << " " << getZMax()
           << " " << std::endl;
    }
    // This outputs the particle data
    for (unsigned int i = 0; i < particleHandler.getNumberOfObjects(); i++)
    {
        outputXBallsDataParticle(i, format, os);
    }
#ifdef DEBUG_OUTPUT
    std::cerr << "Have output the properties of the problem to disk " << std::endl;
#endif
}

virtual void DPMBase::outputXBallsDataParticle ( const unsigned int  i, const unsigned int  format, std::ostream &  os  ) const

protectedvirtual

This function writes out the particle locations into an output stream in a format the XBalls program can read.

Referenced by outputXBallsData().

void DPMBase::printTime ( ) const

protectedvirtual

Displays the current simulation time onto your screen for example.

Reimplemented in Chute.

Definition at line 886 of file DPMBase.cc.

References getTime(), and getTimeMax().

Referenced by Mercury3DRestart::readNextArgument(), and writeOutputFiles().

{
    std::cout << "t=" << std::setprecision(3) << std::left << std::setw(6) << getTime()
              << ", tmax=" << std::setprecision(3) << std::left << std::setw(6) << getTimeMax()
              << std::endl;
    std::cout.flush();
}

void DPMBase::processStatistics ( bool usethese  UNUSED )

protectedvirtual

no implementation but can be overidden in its derived classes.

Reimplemented in StatisticsVector< T >.

Definition at line 831 of file DPMBase.cc.

{
}

void DPMBase::read ( std::istream &  is )

virtual

Reads all data from a restart file, e.g. domain data and particle data.

Todo:

warning: hides non-virtual function from the class 'Files'.

Parameters

[in]

is

todo{Do we want to calculate the mass?}

Reimplemented in ChuteWithHopper, MercuryBase, and Chute.

Definition at line 1955 of file DPMBase.cc.

References boundaryHandler, BaseHandler< T >::clear(), ParticleHandler::clear(), ERROR, FATAL, helpers::getLineFromStringStream(), gravity_, INFO, interactionHandler, logger, NO_FILE, ntimeSteps_, particleDimensions_, particleHandler, random, RNG::read(), FilesAndRunNumber::read(), BaseHandler< T >::read(), BoundaryHandler::readObject(), WallHandler::readObject(), ParticleHandler::readObject(), readOld(), restartVersion_, BaseHandler< T >::setStorageCapacity(), InteractionHandler::setWriteVTK(), setXBallsAdditionalArguments(), speciesHandler, systemDimensions_, time_, timeMax_, timeStep_, wallHandler, writeParticlesVTK_, writeWallsVTK_, xMax_, xMin_, yMax_, yMin_, zMax_, and zMin_.

Referenced by MercuryBase::read(), and readRestartFile().

{
    std::string dummy;
    is >> dummy;
    if (strcmp(dummy.c_str(), "restart_version"))
    {
        //only very old files did not have a restart_version
        logger.log(Log::FATAL, "Error in DPMBase::read(is): this is not a valid restart file");
    } else
    {
        is >> restartVersion_;
        if (!restartVersion_.compare("1.0"))
        {
            FilesAndRunNumber::read(is);
            is >> dummy >> xMin_
               >> dummy >> xMax_
               >> dummy >> yMin_
               >> dummy >> yMax_
               >> dummy >> zMin_
               >> dummy >> zMax_
               >> dummy >> timeStep_
               >> dummy >> time_
               >> dummy >> ntimeSteps_
               >> dummy >> timeMax_
               >> dummy >> systemDimensions_
               >> dummy >> particleDimensions_
               >> dummy >> gravity_;

            std::stringstream line(std::stringstream::in | std::stringstream::out);
            helpers::getLineFromStringStream(is, line);
            line >> dummy;
            if (!dummy.compare("writeVTK")) {
                FileType writeInteractionsVTK = FileType::NO_FILE;
                line >> writeParticlesVTK_ >> writeWallsVTK_ >> writeInteractionsVTK >> dummy;
                interactionHandler.setWriteVTK(writeInteractionsVTK);
            }
            if (!dummy.compare("random"))
            {
                helpers::getLineFromStringStream(line, line);
                random.read(line);
                line >> dummy;
                helpers::getLineFromStringStream(line, line);
                setXBallsAdditionalArguments(line.str());
            }

            speciesHandler.read(is);

            unsigned int N;
            //std::stringstream line(std::stringstream::in | std::stringstream::out);
            is >> dummy >> N;
            if (dummy.compare("Walls"))
                logger(ERROR, "DPMBase::read(is): Error during restart: 'Walls' argument could not be found.");
            wallHandler.clear();
            wallHandler.setStorageCapacity(N);
            helpers::getLineFromStringStream(is, line);

            for (unsigned int i = 0; i < N; i++)
            {
                helpers::getLineFromStringStream(is, line);
                wallHandler.readObject(line);
            }

            is >> dummy >> N;
            boundaryHandler.clear();
            boundaryHandler.setStorageCapacity(N);
            if (dummy.compare("Boundaries"))
                logger(ERROR, "DPMBase::read(is): Error during restart: 'Boundaries' argument could not be found.");
            helpers::getLineFromStringStream(is, line);
            for (unsigned int i = 0; i < N; i++)
            {
                helpers::getLineFromStringStream(is, line);
                boundaryHandler.readObject(line);
            }

            is >> dummy >> N;
            if (dummy.compare("Particles"))
                logger(ERROR, "DPMBase::read(is): Error during restart: 'Boundaries' argument could not be found.");
            particleHandler.clear();
            particleHandler.setStorageCapacity(N);
            helpers::getLineFromStringStream(is, line);
            for (unsigned int i = 0; i < N; i++)
            {
                helpers::getLineFromStringStream(is, line);
                particleHandler.readObject(line);
                //particleHandler.getLastObject()->computeMass();
            }

            interactionHandler.read(is);

        } else if (!restartVersion_.compare("3"))
        {
            logger.log(Log::INFO, "DPMBase::read(is): restarting from an old restart file (restart_version %).",
                       restartVersion_);
            readOld(is);
        } else
        {
            //only very old files did not have a restart_version
            logger.log(Log::FATAL,
                       "Error in DPMBase::read(is): restart_version % cannot be read; use an older version of Mercury to upgrade the file",
                       restartVersion_);
        }
    }
}

bool DPMBase::readArguments	(	int	argc,
		char *	argv[]
	)

Can interpret main function input arguments that are passed by the driver codes.

Parameters

[in]	argc
[in]	*argv[]

Definition at line 2320 of file DPMBase.cc.

References readNextArgument().

Referenced by solve().

{
    bool isRead = true;
    for (int i = 1; i < argc; i += 2)
    {
        std::cout << "interpreting input argument " << argv[i];
        for (int j = i + 1; j < argc; j++)
        {
            if (argv[j][0] == '-')
                break;
            std::cout << " " << argv[j];
        }
        std::cout << std::endl;
        isRead &= readNextArgument(i, argc, argv);
        if (!isRead)
        {
            std::cerr << "Warning: not all arguments read correctly!" << std::endl;
            exit(-1);
        }
    }
    return isRead;
}

bool DPMBase::readDataFile	(	const std::string	fileName,
		unsigned int	format = 0
	)

This allows particle data to be reloaded from data files.

E.g. If one has a data file. This function loads data from the .data file i.e. you get position, velocity, angular velocty, radius .. info. See also MD::readRestartFile For XBalls: Can read in format_ 14 - 8 or format_ 7 data format. This code saves in format_ 8 for 2D and format_ 14 for 3D. So if no extra parameters are specified it will assume things many parameters, like density cannot be set using the data file.

Parameters

[in]	fileName
[in]	format	(format for specifying if its for 2D or 3D data)

Returns

bool (True or False)

Definition at line 1202 of file DPMBase.cc.

References File::close(), Files::dataFile, File::getFileType(), File::getFstream(), File::getName(), ONE_FILE, File::open(), readNextDataFile(), File::setFileType(), and File::setName().

Referenced by readNextArgument().

{
    std::string oldFileName = dataFile.getName();
    //This opens the file the data will be recalled from
    dataFile.setName(fileName);
    dataFile.open(std::fstream::in);
    if (!dataFile.getFstream().is_open() || dataFile.getFstream().bad())
    {
        std::cout << "Loading data file " << fileName << " failed" << std::endl;
        return false;
    }

    //dataFile.getFileType() is ignored
    FileType fileTypeData = dataFile.getFileType();
    dataFile.setFileType(FileType::ONE_FILE);
    readNextDataFile(format);
    dataFile.setFileType(fileTypeData);

    dataFile.close();
    dataFile.setName(oldFileName);

    //std::cout << "Loaded data file " << filename << " (t=" << getTime() << ")" << std::endl;
    return true;
}

bool DPMBase::readNextArgument ( int &  i, int  argc, char *  argv[]  )

virtual

Interprets the i^th command-line argument.

Parameters

[in]	i
[in]	argc
[in]	*argv[]

Returns

bool (True or False)

argv[i+1] interpreted as argument of type char*, Mdouble, integer or boolean unless noted

-gravity_ requires three arguments

-restart or -r loads a restart file. By default, it loads <name>.restart. If an argument "arg" is given it loads the file "arg", or "arg".restart (if the ending is not given).

-clean of -c removes all files <name>.*.

Reimplemented in MercuryBase, ChuteWithHopper, Chute, and Mercury3DRestart.

Definition at line 2349 of file DPMBase.cc.

References FilesAndRunNumber::autoNumber(), Files::dataFile, Files::eneFile, Files::fStatFile, Files::getName(), getNtimeSteps(), File::getSaveCount(), getTimeMax(), getTimeStep(), random, RNG::randomise(), readDataFile(), readRestartFile(), Files::restartFile, setAddLarge(), setAddSmall(), setAppend(), File::setFileType(), Files::setFileType(), setFixedParticles(), setGravity(), Files::setName(), Files::setNextSavedTimeStep(), FilesAndRunNumber::setRunNumber(), File::setSaveCount(), Files::setSaveCount(), setSystemDimensions(), setTimeMax(), setTimeStep(), setXMax(), setXMin(), setYMax(), setYMin(), setZMax(), setZMin(), Files::statFile, and to_string_padded().

Referenced by readArguments(), and MercuryBase::readNextArgument().

{
    if (!strcmp(argv[i], "-name"))
    {
        setName(argv[i + 1]);
    } else if (!strcmp(argv[i], "-xmin"))
    {
        setXMin(atof(argv[i + 1]));
    } else if (!strcmp(argv[i], "-ymin"))
    {
        setYMin(atof(argv[i + 1]));
    } else if (!strcmp(argv[i], "-zmin"))
    {
        setZMin(atof(argv[i + 1]));
    } else if (!strcmp(argv[i], "-xmax"))
    {
        setXMax(atof(argv[i + 1]));
    } else if (!strcmp(argv[i], "-ymax"))
    {
        setYMax(atof(argv[i + 1]));
    } else if (!strcmp(argv[i], "-zmax"))
    {
        setZMax(atof(argv[i + 1]));
        //} else if (!strcmp(argv[i],"-svn")) {
        //  std::cout << "svn version " << SVN_VERSION << std::endl;
        //  i--;
    } else if (!strcmp(argv[i], "-addS"))
    {
        setAddSmall(atof(argv[i + 1]));
    } else if (!strcmp(argv[i], "-addL"))
    {
        setAddLarge(atof(argv[i + 1]));
    } else if (!strcmp(argv[i], "-dt"))
    {
        Mdouble old = getTimeStep();
        setTimeStep(atof(argv[i + 1]));
        std::cout << "  reset dt from " << old << " to " << getTimeStep() << std::endl;
    }
//    else if (!strcmp(argv[i], "-Hertz"))
//    {
//        speciesHandler.getObject(0)->setForceType(ForceType::HERTZ);
//        i--;
//    }
    else if (!strcmp(argv[i], "-tmax"))
    {
        Mdouble old = getTimeMax();
        setTimeMax(atof(argv[i + 1]));
        std::cout << "  reset timeMax from " << old << " to " << getTimeMax() << std::endl;
    } else if (!strcmp(argv[i], "-saveCount"))
    {
        Mdouble old = dataFile.getSaveCount();
        setSaveCount(static_cast<unsigned int>(atoi(argv[i + 1])));
        setNextSavedTimeStep(getNtimeSteps() + restartFile.getSaveCount());
        std::cout << "  reset saveCount from " << old << " to " << dataFile.getSaveCount() << std::endl;
    } else if (!strcmp(argv[i], "-saveCountData"))
    {
        dataFile.setSaveCount(static_cast<unsigned int>(atoi(argv[i + 1])));
    } else if (!strcmp(argv[i], "-saveCountFStat"))
    {
        fStatFile.setSaveCount(static_cast<unsigned int>(atoi(argv[i + 1])));
    } else if (!strcmp(argv[i], "-saveCountStat"))
    {
        statFile.setSaveCount(static_cast<unsigned int>(atoi(argv[i + 1])));
    } else if (!strcmp(argv[i], "-saveCountEne"))
    {
        eneFile.setSaveCount(static_cast<unsigned int>(atoi(argv[i + 1])));
    } else if (!strcmp(argv[i], "-saveCountRestart"))
    {
        restartFile.setSaveCount(static_cast<unsigned int>(atoi(argv[i + 1])));
    } else if (!strcmp(argv[i], "-dim"))
    {
        setSystemDimensions(static_cast<unsigned int>(atoi(argv[i + 1])));
    } else if (!strcmp(argv[i], "-gravity"))
    {
        setGravity(Vec3D(atof(argv[i + 1]), atof(argv[i + 2]), atof(argv[i + 3])));
        i += 2;
    } else if (!strcmp(argv[i], "-fileType"))
    { //uses int input
        setFileType(static_cast<FileType>(atoi(argv[i + 1])));
    } else if (!strcmp(argv[i], "-fileTypeFStat"))
    { //uses int input
        fStatFile.setFileType(static_cast<FileType>(atoi(argv[i + 1])));
    } else if (!strcmp(argv[i], "-fileTypeRestart"))
    {
        restartFile.setFileType(static_cast<FileType>(atoi(argv[i + 1])));
    } else if (!strcmp(argv[i], "-fileTypeData"))
    {
        dataFile.setFileType(static_cast<FileType>(atoi(argv[i + 1])));
    } else if (!strcmp(argv[i], "-fileTypeStat"))
    {
        statFile.setFileType(static_cast<FileType>(atoi(argv[i + 1])));
    } else if (!strcmp(argv[i], "-fileTypeEne"))
    {
        eneFile.setFileType(static_cast<FileType>(atoi(argv[i + 1])));
    } else if (!strcmp(argv[i], "-auto_number"))
    {
        autoNumber();
        i--;
    }
//    else if (!strcmp(argv[i], "-number_of_saves"))
//    {
//        set_number_of_saves_all(atof(argv[i + 1]));
//    }
    else if (!strcmp(argv[i], "-restart") || !strcmp(argv[i], "-r"))
    {
        std::string filename;
        
        //use default filename if no argument is given
        if (i + 1 >= argc || argv[i + 1][0] == '-')
        {
            i--;
            filename = getName();
            std::cout << getName() << std::endl;
        } else
            filename = argv[i + 1];

        //add ".restart" if necessary
        if (filename.find(".restart") == std::string::npos)
        {
            filename = filename + ".restart";
        }
        
        std::cout << "restart from " << filename << std::endl;
        readRestartFile(filename);
    } else if (!strcmp(argv[i], "-clean") || !strcmp(argv[i], "-c"))
    {
        std::cout << "Remove old " << getName() << ".* files" << std::endl;
//        std::string filename;
        std::ostringstream filename;
        std::vector<std::string> ext{".restart", ".stat", ".fstat", ".data", ".ene", ".xballs"};
        for (unsigned int j = 0; j < ext.size(); j++)
        {
            // remove files with given extension for FileType::ONE_FILE
            filename.clear();
            filename << getName() << ext[j];
            if (!remove(filename.str().c_str()))
            {
                std::cout << "  File " << filename.str() << " successfully deleted" << std::endl;
            }
            // remove files with given extension for FileType::MULTIPLE_FILES
            unsigned int k = 0;
            filename.clear();
            filename << getName() << ext[j] << '.' << k;
            while (!remove(filename.str().c_str()))
            {
                std::cout << "  File " << filename.str() << " successfully deleted" << std::endl;
                filename.clear();
                filename << getName() << ext[j] << '.' << ++k;
            }
            // remove files with given extension for FileType::MULTIPLE_FILES_PADDED
            k = 0;
            filename.clear();
            filename << getName() << ext[j] << '.' << to_string_padded(k);
            while (!remove(filename.str().c_str()))
            {
                std::cout << "  File " << filename.str() << " successfully deleted" << std::endl;
                filename.clear();
                filename << getName() << ext[j] << '.' << to_string_padded(++k);
            }
        }
        i--;
    } else if (!strcmp(argv[i], "-data"))
    {
        std::string filename = argv[i + 1];
        readDataFile(filename.c_str());
    }
//    else if (!strcmp(argv[i], "-k"))
//    {
//        Mdouble old = getSpecies(0)->getStiffness();
//        getSpecies(0)->setStiffness(atof(argv[i + 1]));
//        std::cout << "  reset k from " << old << " to " << getSpecies(0)->getStiffness() << std::endl;
//    }
//    else if (!strcmp(argv[i], "-dissipation") || !strcmp(argv[i], "-disp"))
//    {
//        Mdouble old = getSpecies(0)->getDissipation();
//        getSpecies(0)->setDissipation(atof(argv[i + 1]));
//        std::cout << "  reset getDissipation() from " << old << " to " << getSpecies(0)->getDissipation() << std::endl;
//    }
//    else if (!strcmp(argv[i], "-kt"))
//    {
//        Mdouble old = getSpecies(0)->getSlidingStiffness();
//        getSpecies(0)->setSlidingStiffness(atof(argv[i + 1]));
//        std::cout << "  reset kt from " << old << " to " << getSpecies(0)->getSlidingStiffness() << std::endl;
//    }
//    else if (!strcmp(argv[i], "-dispt"))
//    {
//        Mdouble old = getSpecies(0)->getSlidingDissipation();
//        getSpecies(0)->setSlidingDissipation(atof(argv[i + 1]));
//        std::cout << "  reset dispt from " << old << " to " << getSpecies(0)->getSlidingDissipation() << std::endl;
//    }
//    else if (!strcmp(argv[i], "-krolling"))
//    {
//        Mdouble old = getSpecies(0)->getRollingStiffness();
//        getSpecies(0)->setRollingStiffness(atof(argv[i + 1]));
//        std::cout << "  reset krolling from " << old << " to " << getSpecies(0)->getRollingStiffness() << std::endl;
//    }
//    else if (!strcmp(argv[i], "-disprolling"))
//    {
//        Mdouble old = getSpecies(0)->getRollingDissipation();
//        getSpecies(0)->setRollingDissipation(atof(argv[i + 1]));
//        std::cout << "  reset disprolling from " << old << " to " << getSpecies(0)->getRollingDissipation() << std::endl;
//    }
//    else if (!strcmp(argv[i], "-mu"))
//    {
//        Mdouble old = getSpecies(0)->getSlidingFrictionCoefficient();
//        getSpecies(0)->setSlidingFrictionCoefficient(atof(argv[i + 1]));
//        std::cout << "  reset mu from " << old << " to " << getSpecies(0)->getSlidingFrictionCoefficient() << std::endl;
//    }
//    else if (!strcmp(argv[i], "-murolling"))
//    {
//        Mdouble old = getSpecies(0)->getRollingFrictionCoefficient();
//        getSpecies(0)->setRollingFrictionCoefficient(atof(argv[i + 1]));
//        std::cout << "  reset murolling from " << old << " to " << getSpecies(0)->getRollingFrictionCoefficient() << std::endl;
//    }
    else if (!strcmp(argv[i], "-randomise") || !strcmp(argv[i], "-randomize"))
    {
        random.randomise();
        i--;
    }
//    else if (!strcmp(argv[i], "-k0"))
//    {
//        Mdouble old = speciesHandler.getObject(0)->getAdhesionStiffness();
//        speciesHandler.getObject(0)->setAdhesionStiffness(atof(argv[i + 1]));
//        std::cout << "  reset k0 from " << old << " to " << speciesHandler.getObject(0)->getAdhesionStiffness() << std::endl;
//    }
//    else if (!strcmp(argv[i], "-f0"))
//    {
//        Mdouble old = speciesHandler.getObject(0)->getBondForceMax();
//        speciesHandler.getObject(0)->setBondForceMax(atof(argv[i + 1]));
//        std::cout << "  reset f0 from " << old << " to " << speciesHandler.getObject(0)->getBondForceMax() << std::endl;
//    }
//    else if (!strcmp(argv[i], "-AdhesionForceType"))
//    {
//        AdhesionForceType old = speciesHandler.getObject(0)->getAdhesionForceType();
//        speciesHandler.getObject(0)->setAdhesionForceType(argv[i + 1]);
//        std::cout << "  reset AdhesionForceType from "
//                << static_cast<signed char>(old) << " to "
//                << static_cast<signed char>(speciesHandler.getObject(0)->getAdhesionForceType()) << std::endl;
//    }
    else if (!strcmp(argv[i], "-append"))
    {
        setAppend(true);
        i--;
    } else if (!strcmp(argv[i], "-fixedParticles"))
    {
        setFixedParticles(static_cast<unsigned int>(atoi(argv[i + 1])));
    }
//    else if (!strcmp(argv[i], "-rho"))
//    {
//        Mdouble old = speciesHandler.getObject(0)->getDensity();
//        speciesHandler.getObject(0)->setDensity(atof(argv[i + 1]));
//        std::cout << "  reset rho from " << old << " to " << speciesHandler.getObject(0)->getDensity() << std::endl;
//    }
//    else if (!strcmp(argv[i], "-dim_particle"))
//    {
//        setParticleDimensions(atoi(argv[i + 1]));
//    }
    else if (!strcmp(argv[i], "-counter"))
    {
        setRunNumber(atoi(argv[i + 1]));
    } else
        return false;
    return true; //returns true if argv is found
}

bool DPMBase::readNextDataFile

(

unsigned int

format = 0

)

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

Parameters

[in]

format

Definition at line 1434 of file DPMBase.cc.

References ParticleHandler::computeAllMasses(), BaseHandler< T >::copyAndAddObject(), Files::dataFile, File::getFstream(), BaseHandler< T >::getLastObject(), helpers::getLineFromStringStream(), BaseHandler< T >::getNumberOfObjects(), BaseHandler< T >::getObject(), getSystemDimensions(), INFO, logger, File::openNextFile(), particleHandler, ParticleHandler::removeLastObject(), BaseParticle::setSpecies(), setTime(), setXMax(), setXMin(), setYMax(), setYMin(), setZMax(), setZMin(), speciesHandler, time_, BaseParticle::unfix(), Vec3D::X, xMax_, xMin_, Vec3D::Y, yMax_, yMin_, Vec3D::Z, zMax_, and zMin_.

Referenced by main(), and readDataFile().

{
    dataFile.openNextFile(std::fstream::in);
    //fStatFile.openNextFile();
    //Set the correct formation based of dimension if the formation is not specified by the user
    if (format == 0)
    {
        switch (getSystemDimensions())
        {
            case 1:
            case 2:
                format = 8;
                break;
            case 3:
                format = 14;
                break;
        }
        //end case

    }
    //end if

    unsigned int N = 0;
    Mdouble dummy;
    dataFile.getFstream() >> N;
    //read first parameter and check if we reached the end of the file
    if (N == 0)
    {
        //std::cout << "Reached the end of the data file" << std::endl;
        return false;
    }

    //create particles if N is not fixed
    if (particleHandler.getNumberOfObjects() != N)
    {
        if (particleHandler.getNumberOfObjects() == 0)
        {
            BaseParticle p;
            p.setSpecies(speciesHandler.getObject(0));
            particleHandler.copyAndAddObject(p);
            std::cout << "Warning in readNextDataFile: particleHandler is empty, "
                    "so newly created particles will be of BaseParticle type." << std::endl;
        }
        if (particleHandler.getNumberOfObjects() > N)
        {
            while (particleHandler.getNumberOfObjects() != N)
            {
                particleHandler.removeLastObject();
                //std::cout << "S" << particleHandler.getNumberOfObjects() << std::endl;
            }
        } else
        {
            while (particleHandler.getNumberOfObjects() != N)
            {
                particleHandler.copyAndAddObject(particleHandler.getLastObject());
                particleHandler.getLastObject()->unfix();
                //std::cout << particleHandler.getNumberOfObjects() << N << std::endl;
            }
        }
    }
    //for (auto p: particleHandler)
    //    std::cout << *p << std::endl;
#ifdef DEBUG_OUTPUT
    std::cout << "Number of particles read from file "<<N << std::endl;
#endif

    //read all other data available for the time step
    switch (format)
    {
        //This is the format_ that Stefan's and Vitaly's code saves in - note the axis rotation_
        case 7:
        {
            std::stringstream line;
            helpers::getLineFromStringStream(dataFile.getFstream(), line);
            line >> dummy;
            helpers::getLineFromStringStream(dataFile.getFstream(), line);
            line >> dummy;
            setTime(dummy);
            helpers::getLineFromStringStream(dataFile.getFstream(), line);
            line >> dummy;
            setXMin(dummy);
            helpers::getLineFromStringStream(dataFile.getFstream(), line);
            line >> dummy;
            setYMin(dummy);
            helpers::getLineFromStringStream(dataFile.getFstream(), line);
            line >> dummy;
            setZMin(dummy);
            helpers::getLineFromStringStream(dataFile.getFstream(), line);
            line >> dummy;
            setXMax(dummy);
            helpers::getLineFromStringStream(dataFile.getFstream(), line);
            line >> dummy;
            setYMax(dummy);
            helpers::getLineFromStringStream(dataFile.getFstream(), line);
            line >> dummy;
            setZMax(dummy);
            //std::cout << " time " << t <<  std::endl;
            Mdouble radius;
            Vec3D position, velocity;
            for (BaseParticle* p : particleHandler)
            {
                helpers::getLineFromStringStream(dataFile.getFstream(), line);
                line >> position.X >> position.Z >> position.Y >> velocity.X >> velocity.Z >> velocity.Y >> radius
                     >> dummy;
                p->setPosition(position);
                p->setVelocity(velocity);
                p->setOrientation(Vec3D(0.0, 0.0, 0.0));
                p->setAngularVelocity(Vec3D(0.0, 0.0, 0.0));
                p->setRadius(radius);
            }
            break;
        }
            //This is a 2D format_
        case 8:
        {
            std::stringstream line;
            helpers::getLineFromStringStream(dataFile.getFstream(), line);
            line >> time_ >> xMin_ >> yMin_ >> xMax_ >> yMax_;
            zMin_ = 0.0;
            zMax_ = 0.0;
            Mdouble radius;
            Vec3D position, velocity, angle, angularVelocity;
            for (BaseParticle* p : particleHandler)
            {
                helpers::getLineFromStringStream(dataFile.getFstream(), line);
                line >> position.X >> position.Y >> velocity.X >> velocity.Y >> radius >> angle.Z >> angularVelocity.Z
                     >> dummy;
                p->setPosition(position);
                p->setVelocity(velocity);
                p->setOrientation(-angle);
                p->setAngularVelocity(-angularVelocity);
                p->setRadius(radius);
            } //end for all particles
            break;
        }
            //This is a 3D format_
        case 14:
        {
            std::stringstream line;
            helpers::getLineFromStringStream(dataFile.getFstream(), line);
            line >> time_ >> xMin_ >> yMin_ >> zMin_ >> xMax_ >> yMax_ >> zMax_;
            Mdouble radius;
            Vec3D position, velocity, angle, angularVelocity;
            for (BaseParticle* p : particleHandler)
            {
                helpers::getLineFromStringStream(dataFile.getFstream(), line);
                line >> position >> velocity >> radius >> angle >> angularVelocity;
                p->setPosition(position);
                p->setVelocity(velocity);
                p->setOrientation(angle);
                p->setAngularVelocity(angularVelocity);
                p->setRadius(radius);
            } //end read into existing particles
            logger(INFO, "read % particles", particleHandler.getNumberOfObjects());
            break;
        }
            //This is a 3D format_
        case 15:
        {
            std::stringstream line;
            helpers::getLineFromStringStream(dataFile.getFstream(), line);
            line >> time_ >> xMin_ >> yMin_ >> zMin_ >> xMax_ >> yMax_ >> zMax_;
            Mdouble radius;
            Vec3D position, velocity, angle, angularVelocity;
            for (BaseParticle* p : particleHandler)
            {
                helpers::getLineFromStringStream(dataFile.getFstream(), line);
                line >> position >> velocity >> radius >> angle >> angularVelocity >> dummy >> dummy;
                p->setPosition(position);
                p->setVelocity(velocity);
                p->setOrientation(angle);
                p->setAngularVelocity(angularVelocity);
                p->setRadius(radius);
            } //end for all particles
            break;
        }
    } //end switch statement
    particleHandler.computeAllMasses();
    return true;
}

void DPMBase::readOld ( std::istream &  is )

virtual

Reads all data from a restart file, e.g. domain data and particle data; old version.

Parameters

[in]

is

Definition at line 2063 of file DPMBase.cc.

References boundaryHandler, Files::dataFile, Files::eneFile, Files::fStatFile, gravity_, particleHandler, BaseHandler< T >::read(), Files::restartFile, File::setFileType(), Files::setName(), File::setSaveCount(), speciesHandler, Files::statFile, systemDimensions_, time_, timeMax_, timeStep_, wallHandler, xMax_, xMin_, yMax_, yMin_, zMax_, and zMin_.

Referenced by read().

{
    std::string dummy;
    is >> dummy >> dummy;
    setName(dummy);

    unsigned int saveCountData, saveCountEne, saveCountStat, saveCountFStat;
    unsigned int fileTypeFstat, fileTypeData, fileTypeEne, fileTypeRestart;
    is >> dummy >> xMin_
       >> dummy >> xMax_
       >> dummy >> yMin_
       >> dummy >> yMax_
       >> dummy >> zMin_
       >> dummy >> zMax_
       >> dummy >> timeStep_
       >> dummy >> time_
       >> dummy >> timeMax_
       >> dummy >> saveCountData
       >> dummy >> saveCountEne
       >> dummy >> saveCountStat
       >> dummy >> saveCountFStat
       >> dummy >> systemDimensions_
       >> dummy >> gravity_
       >> dummy >> fileTypeFstat
       >> dummy >> fileTypeData
       >> dummy >> fileTypeEne;
    dataFile.setSaveCount(saveCountData);
    eneFile.setSaveCount(saveCountEne);
    statFile.setSaveCount(saveCountStat);
    fStatFile.setSaveCount(saveCountFStat);
    
    fStatFile.setFileType(static_cast<FileType>(fileTypeFstat));
    dataFile.setFileType(static_cast<FileType>(fileTypeData));
    eneFile.setFileType(static_cast<FileType>(fileTypeEne));
    
    //this is optional to allow restart files with and without restartFile.getFileType()
    is >> dummy;
    if (!strcmp(dummy.c_str(), "options_restart"))
    {
        is >> fileTypeRestart;
        restartFile.setFileType(static_cast<FileType>(fileTypeRestart));
    }

    speciesHandler.read(is);
    wallHandler.read(is);
    boundaryHandler.read(is);
    particleHandler.read(is);
}

bool DPMBase::readParAndIniFiles

(

const std::string

fileName

)

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

Parameters

[in]

fileName

Returns

bool (True or False)

Definition at line 1231 of file DPMBase.cc.

References SpeciesHandler::addObject(), boundaryHandler, BaseHandler< T >::clear(), BaseHandler< T >::copyAndAddObject(), Files::dataFile, Files::fStatFile, BaseHandler< T >::getObject(), getTimeStep(), getXMax(), getXMin(), getYMax(), getYMin(), getZMax(), getZMin(), PeriodicBoundary::set(), InfiniteWall::set(), setGravity(), setParticleDimensions(), File::setSaveCount(), Files::setSaveCount(), BaseWall::setSpecies(), setTime(), setTimeMax(), setTimeStep(), speciesHandler, and wallHandler.

{
    //Opens the par.ini file
    std::fstream file;
    file.open(fileName, std::fstream::in);
    if (!file.is_open() || file.bad())
    {
        //std::cout << "Loading par.ini file " << filename << " failed" << std::endl;
        return false;
    }
    
    Mdouble doubleValue;
    int integerValue;
    
    // inputfile par.ini 
    // line 1 =============================================================
    // Example: 1 1 0
    //   1: integer (0|1) switches from non-periodic to periodic
    //      integer (5|6) does 2D integration only (y-coordinates fixed)
    //                    and switches from non-periodic to periodic
    //      integer (11) uses a quarter system with circular b.c.
    file >> integerValue;
    //~ std::cout << "11" << integerValue << std::endl;
    if (integerValue == 0)
    {
        InfiniteWall w0;
        w0.setSpecies(speciesHandler.getObject(0));
        w0.set(Vec3D(-1, 0, 0), Vec3D(getXMin(), 0, 0));
        wallHandler.copyAndAddObject(w0);
        w0.set(Vec3D(1, 0, 0), Vec3D(getXMax(), 0, 0));
        wallHandler.copyAndAddObject(w0);
        w0.set(Vec3D(0, -1, 0), Vec3D(0, getYMin(), 0));
        wallHandler.copyAndAddObject(w0);
        w0.set(Vec3D(0, 1, 0), Vec3D(0, getYMax(), 0));
        wallHandler.copyAndAddObject(w0);
        w0.set(Vec3D(0, 0, -1), Vec3D(0, 0, getZMin()));
        wallHandler.copyAndAddObject(w0);
        w0.set(Vec3D(0, 0, 1), Vec3D(0, 0, getZMax()));
        wallHandler.copyAndAddObject(w0);
    } else if (integerValue == 1)
    {
        PeriodicBoundary b0;
        b0.set(Vec3D(1, 0, 0), getXMin(), getXMax());
        boundaryHandler.copyAndAddObject(b0);
        b0.set(Vec3D(0, 1, 0), getYMin(), getYMax());
        boundaryHandler.copyAndAddObject(b0);
        b0.set(Vec3D(0, 0, 1), getZMin(), getZMax());
        boundaryHandler.copyAndAddObject(b0);
    } else if (integerValue == 5)
    {
        InfiniteWall w0;
        w0.setSpecies(speciesHandler.getObject(0));
        w0.set(Vec3D(-1, 0, 0), Vec3D(-getXMin(), 0, 0));
        wallHandler.copyAndAddObject(w0);
        w0.set(Vec3D(1, 0, 0), Vec3D(getXMax(), 0, 0));
        wallHandler.copyAndAddObject(w0);
        w0.set(Vec3D(0, -1, 0), Vec3D(0, -getYMin(), 0));
        wallHandler.copyAndAddObject(w0);
        w0.set(Vec3D(0, 1, 0), Vec3D(0, getYMax(), 0));
        wallHandler.copyAndAddObject(w0);
        
    } else if (integerValue == 6)
    {
        PeriodicBoundary b0;
        b0.set(Vec3D(1, 0, 0), getXMin(), getXMax());
        boundaryHandler.copyAndAddObject(b0);
        b0.set(Vec3D(0, 1, 0), getYMin(), getYMax());
        boundaryHandler.copyAndAddObject(b0);
        b0.set(Vec3D(0, 0, 1), getZMin(), getZMax());
        boundaryHandler.copyAndAddObject(b0);
    } else
    {
        std::cerr << "Error in par.ini: line 1, value 1 is " << integerValue << std::endl;
        exit(-1);
    }
    
    //   2: integer (0|1) dont use | use the search pattern for linked cells
    file >> integerValue; //ignore

    //   3: real - gravity in z direction: positive points upwards
    file >> doubleValue;
    setGravity(Vec3D(0.0, 0.0, doubleValue));
    
    // line 2 =============================================================
    // Example: -10000 .5e-2
    //   1: time end of simulation - (negative resets start time to zero
    //                                and uses -time as end-time)   
    file >> doubleValue;
    if (doubleValue < 0)
        setTime(0);
    setTimeMax(fabs(doubleValue));
    
    //   2: time-step of simulation
    file >> doubleValue;
    setTimeStep(doubleValue);
    
    // line 3 =============================================================
    // Example: 1e-1 100
    file >> doubleValue;
    if (doubleValue >= 0)
    {
        //   1: time-step for output on time-series protocoll file  -> "ene"
        unsigned int savecount = static_cast<unsigned int>(round(doubleValue / getTimeStep()));
        setSaveCount(savecount);
        
        //   2: time-step for output on film (coordinate) file      -> "c3d"
        //      (fstat-output is coupled to c3d-output time-step)
        file >> doubleValue;
        savecount = static_cast<unsigned int>(round(doubleValue / getTimeStep()));
        dataFile.setSaveCount(savecount);
        fStatFile.setSaveCount(savecount);
    } else
    {
        //  or: ---------------------------------------------------------------
        //   1: negative number is multiplied to the previous log-output-time
        //   2: requires initial log-output time
        //   3: negative number is multiplied to the previous film-output-time
        //   4: requires initial film-output time
        std::cerr << "Error in par.ini: line 3, value 1 is " << doubleValue << std::endl;
        exit(-1);
    }
    
    // line 4 =============================================================
    // Example: 2000 1e5 1e3 1e2
    //   1: particle density (mass=4/3*constants::pi*density*rad^3)
    file >> doubleValue;

    //clear species handler
    speciesHandler.clear();
    auto S = new LinearViscoelasticSlidingFrictionSpecies;
    speciesHandler.addObject(S);

    setParticleDimensions(3);
    S->setDensity(doubleValue);

    //   2: linear spring constant
    file >> doubleValue;
    S->setStiffness(doubleValue);

    //   3: linear dashpot constant
    file >> doubleValue;
    S->setDissipation(doubleValue);

    //   4: background damping dashpot constant
    file >> doubleValue;
    if (doubleValue != 0.0)
        std::cerr << "Warning in par.ini: ignored background damping " << doubleValue << std::endl;
    
    // line 5 =============================================================
    // Example: 0 0
    //   1: growth rate:  d(radius) = xgrow * dt
    file >> doubleValue;
    if (doubleValue != 0.0)
        std::cerr << "Warning in par.ini: ignored growth rate " << doubleValue << std::endl;
    
    //   2: target volume_fraction
    file >> doubleValue;
    if (doubleValue != 0.0)
        std::cerr << "Warning in par.ini: ignored target volume_fraction " << doubleValue << std::endl;
    
    file.close();
    //std::cout << "Loaded par.ini file " << filename << std::endl;
    return true;
}

bool DPMBase::readRestartFile

(

bool

restarted = true

)

Reads all the particle data corresponding to the current saved time step. Which is what the restart file basically stores. The problem description with the latest particle data. Returns 0 if it is successful, 1 otherwise.

Calls the read() and sets the restarted_ flag to true (if the file is found)

Returns

int

Definition at line 1629 of file DPMBase.cc.

References File::close(), File::getFstream(), File::open(), read(), Files::restartFile, and setRestarted().

Referenced by main(), Mercury3DRestart::readNextArgument(), readNextArgument(), and readRestartFile().

{
    if (restartFile.open(std::fstream::in))
    {
        read(restartFile.getFstream());
        restartFile.close();
        setRestarted(restarted);
        return true;
    } else {
        //std::cerr << restartFile.getName() << " could not be loaded" << std::endl;
        return false;
    }
}

int DPMBase::readRestartFile

(

std::string

fileName

)

The same as readRestartFile(bool), but also reads all the particle data corresponding to the current saved time step.

Parameters

[in]

fileName

Returns

int

Definition at line 1647 of file DPMBase.cc.

References readRestartFile(), Files::restartFile, and File::setName().

{
    restartFile.setName(fileName);
    return readRestartFile();
}

virtual bool DPMBase::readUserDefinedWall ( std::string  type, std::istream &  is  )

inlinevirtual

Definition at line 179 of file DPMBase.h.

{ return false;}

void DPMBase::removeDuplicatePeriodicParticles ( )

protected

Removes periodic duplicate Particles.

Removes particles created by CheckAndDuplicatePeriodicParticle(int i, int nWallPeriodic)). Note that between these two functions it is not allowed to create additional functions

Definition at line 2765 of file DPMBase.cc.

References BaseInteractable::getInteractions(), BaseHandler< T >::getNumberOfObjects(), BaseHandler< T >::getObject(), BaseParticle::getPeriodicFromParticle(), interactionHandler, particleHandler, ParticleHandler::removeObject(), and InteractionHandler::removeObjectKeepingPeriodics().

Referenced by solve().

{
    for (unsigned int i = particleHandler.getNumberOfObjects();
         i >= 1 && particleHandler.getObject(i - 1)->getPeriodicFromParticle() != nullptr; i--)
    {
        while (particleHandler.getObject(i - 1)->getInteractions().size() > 0)
        {
            interactionHandler.removeObjectKeepingPeriodics(
                    particleHandler.getObject(i - 1)->getInteractions().front()->getIndex());
        }
        particleHandler.removeObject(i - 1);
    }
}

void DPMBase::setAddLarge

(

int

addL

)

sets the number of large particles that are to be added on restart.

Parameters

[in]

addL

Definition at line 351 of file DPMBase.cc.

References addL_.

Referenced by readNextArgument().

{
    addL_ = addL;
}

void DPMBase::setAddSmall

(

int

addS

)

sets the number of small particles that are to be added on restart.

Parameters

[in]

addS

Definition at line 343 of file DPMBase.cc.

References addS_.

Referenced by readNextArgument().

{
    addS_ = addS;
}

void DPMBase::setAppend

(

bool

newAppendFlag

)

Allows to set the append option.

Parameters

[in]

newAppendFlag

Definition at line 651 of file DPMBase.cc.

References append_.

Referenced by constructor(), Mercury3DRestart::readNextArgument(), and readNextArgument().

{
    append_ = newAppendFlag;
}

void DPMBase::setDimension

(

unsigned int

newDim

)

Sets the system and particle dimension.

Parameters

[in]

newDim

Definition at line 553 of file DPMBase.cc.

References setParticleDimensions(), and setSystemDimensions().

{
    setSystemDimensions(newDim);
    setParticleDimensions(newDim);
}

void DPMBase::setDoCGAlways

(

bool

newDoCGFlag

)

Todo:

This method is not implemented

void DPMBase::setFixedParticles ( unsigned int  n )

protected

Parameters

[in]

n

Definition at line 877 of file DPMBase.cc.

References BaseParticle::fixParticle(), BaseHandler< T >::getNumberOfObjects(), BaseHandler< T >::getObject(), and particleHandler.

Referenced by readNextArgument().

{
    for (unsigned int i = 0; i < std::min(particleHandler.getNumberOfObjects(), n); i++)
        particleHandler.getObject(i)->fixParticle();
}

void DPMBase::setGravity

(

Vec3D

newGravity

)

Allows to modify the gravity vector.

Parameters

[in]

newGravity

Definition at line 537 of file DPMBase.cc.

References gravity_.

Referenced by readNextArgument(), readParAndIniFiles(), and Chute::setChuteAngleAndMagnitudeOfGravity().

{
    gravity_ = newGravity;
}

void DPMBase::setMax

(

Vec3D

max

)

Sets the values xMax, yMax, zMax of the problem domain, which is [xMin,xMax]x[yMin,yMax]x[zMin,zMax].

Parameters

[in]

newXMax

Definition at line 395 of file DPMBase.cc.

References setXMax(), setYMax(), setZMax(), Vec3D::X, Vec3D::Y, and Vec3D::Z.

Referenced by helpers::loadingTest(), helpers::normalAndTangentialLoadingTest(), helpers::objectivenessTest(), and FileReader::read().

{
    setXMax(max.X);
    setYMax(max.Y);
    setZMax(max.Z);
}

void DPMBase::setMin

(

Vec3D

min

)

Sets the values xMin, yMin, zMin of the problem domain, which is [xMin,xMax]x[yMin,yMax]x[zMin,zMax].

Parameters

[in]

newXMax

Definition at line 405 of file DPMBase.cc.

References setXMin(), setYMin(), setZMin(), Vec3D::X, Vec3D::Y, and Vec3D::Z.

Referenced by helpers::loadingTest(), helpers::normalAndTangentialLoadingTest(), helpers::objectivenessTest(), and FileReader::read().

{
    setXMin(min.X);
    setYMin(min.Y);
    setZMin(min.Z);
}

void DPMBase::setParticleDimensions

(

unsigned int

particleDimensions

)

Allows the dimension of the particle (f.e. for mass) to be changed. e.g. discs or spheres.

Parameters

[in]

particleDimensions

Definition at line 583 of file DPMBase.cc.

References ParticleHandler::computeAllMasses(), logger, particleDimensions_, particleHandler, and WARN.

Referenced by Mercury2D::constructor(), Mercury3D::constructor(), constructor(), helpers::loadingTest(), helpers::normalAndTangentialLoadingTest(), helpers::objectivenessTest(), SpeciesHandler::readOldObject(), readParAndIniFiles(), and setDimension().

{
    if (particleDimensions >= 1 && particleDimensions <= 3)
    {
        particleDimensions_ = particleDimensions;
        particleHandler.computeAllMasses();
    } else
    {
        logger(WARN, "Error in setParticleDimensions, input argument is %", particleDimensions);
    }
}

void DPMBase::setParticlesWriteVTK

(

bool

writeParticlesVTK

)

Allows to set the flag for enabling or disabling particle rotation in the simulations.

Parameters

[in]

writeParticlesVTK

Definition at line 255 of file DPMBase.cc.

References writeParticlesVTK_.

{
    writeParticlesVTK_ = writeParticlesVTK;
}

void DPMBase::setRestarted

(

bool

newRestartedFlag

)

Allows to set the flag stating if the simulation is to be restarted or not.

Parameters

[in]

newRestartedFlag

Definition at line 634 of file DPMBase.cc.

References restarted_.

Referenced by constructor(), and readRestartFile().

{
    restarted_ = newRestartedFlag;
    //setAppend(new_);
}

void DPMBase::setRestartVersion

(

std::string

newRV

)

Sets restart_version.

Parameters

[in]

newRV

Definition at line 617 of file DPMBase.cc.

References restartVersion_.

{
    restartVersion_ = newRV;
}

void DPMBase::setRotation

(

bool

newRotFlag

)

Allows to set the flag for enabling or disabling particle rotation in the simulations.

Todo:

{these functions should also update the mixed species}

Parameters

[in]

newRotFlag

Definition at line 231 of file DPMBase.cc.

References rotation_.

Referenced by SpeciesHandler::addObject(), and SpeciesHandler::removeObject().

{
    rotation_ = newRotFlag;
}

void DPMBase::setSystemDimensions

(

unsigned int

newDim

)

Allows for the dimension of the simulation to be changed.

Parameters

[in]

newDim

Definition at line 562 of file DPMBase.cc.

References ERROR, logger, and systemDimensions_.

Referenced by Mercury2D::constructor(), Mercury3D::constructor(), constructor(), helpers::loadingTest(), helpers::normalAndTangentialLoadingTest(), helpers::objectivenessTest(), readNextArgument(), and setDimension().

{
    if (newDim >= 1 && newDim <= 3)
        systemDimensions_ = newDim;
    else
    {
        logger(ERROR,"Error in setSystemDimensions, input argument is %", newDim);
    }
}

void DPMBase::setTime

(

Mdouble

time

)

Access function for the time.

Parameters

[in]

time

Definition at line 185 of file DPMBase.cc.

References interactionHandler, and time_.

Referenced by FileReader::read(), readNextDataFile(), readParAndIniFiles(), and solve().

{
    Mdouble diff = time_ - time;
    time_ = time;
    //this sets the interaction timestamp, so each interaction has the right time
    for (auto i : interactionHandler)
    {
        i->setTimeStamp(i->getTimeStamp() - diff);
    }
}

void DPMBase::setTimeMax

(

Mdouble

newTMax

)

Allows the upper time limit to be changed.

Parameters

[in]

newTMmax

Definition at line 199 of file DPMBase.cc.

References ERROR, logger, and timeMax_.

Referenced by helpers::loadingTest(), ChuteBottom::makeRoughBottom(), helpers::normalAndTangentialLoadingTest(), helpers::objectivenessTest(), readNextArgument(), and readParAndIniFiles().

{
    if (newTMax >= 0)
    {
        timeMax_ = newTMax;
    }
    else
    {
        logger(ERROR, "Error in setTimeMax, newTMax=%", newTMax);
    }
}

void DPMBase::setTimeStep

(

Mdouble

timeStep

)

Allows the time step dt to be changed.

Parameters

[in]

timeStep

Definition at line 451 of file DPMBase.cc.

References ERROR, logger, and timeStep_.

Referenced by helpers::loadingTest(), ChuteBottom::makeRoughBottom(), helpers::normalAndTangentialLoadingTest(), helpers::objectivenessTest(), readNextArgument(), and readParAndIniFiles().

{
    if (timeStep >= 0.0)
    {
        timeStep_ = timeStep;
    } else
    {
        logger(ERROR, "Error in setTimeStep, proposed time step %", timeStep);
    }
}

void DPMBase::setupInitialConditions ( )

virtual

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 disibuted

Reimplemented in ChuteWithHopper, Chute, ChuteBottom, and Mercury2PVD.

Definition at line 966 of file DPMBase.cc.

Referenced by helpers::loadingTest(), helpers::normalAndTangentialLoadingTest(), helpers::objectivenessTest(), and solve().

{
}

void DPMBase::setWallsWriteVTK

(

FileType

writeWallsVTK

)

Allows to set the flag for enabling or disabling particle rotation in the simulations.

Parameters

[in]

writeWallsVTK

Definition at line 247 of file DPMBase.cc.

References writeWallsVTK_.

{
    writeWallsVTK_ = writeWallsVTK;
}

void DPMBase::setXBallsAdditionalArguments

(

std::string

newXBArgs

)

Set the additional arguments for xballs.

Parameters

[in]

newXBArgs

Definition at line 505 of file DPMBase.cc.

References xBallsAdditionalArguments_.

Referenced by read().

{
    xBallsAdditionalArguments_ = newXBArgs.c_str();
}

void DPMBase::setXBallsColourMode

(

int

newCMode

)

Set the xball output mode.

Parameters

[in]

newCMode

Definition at line 473 of file DPMBase.cc.

References xBallsColourMode_.

{
    xBallsColourMode_ = newCMode;
}

void DPMBase::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.

Parameters

[in]

newScale

Definition at line 521 of file DPMBase.cc.

References xBallsScale_.

{
    xBallsScale_ = newScale;
}

void DPMBase::setXBallsVectorScale

(

double

newVScale

)

Set the scale of vectors in xballs.

Parameters

[in]

newVScale

Definition at line 489 of file DPMBase.cc.

References xBallsVectorScale_.

{
    xBallsVectorScale_ = newVScale;
}

void DPMBase::setXMax

(

Mdouble

xMax

)

If the length of the problem domain in x-direction is XMax - XMin, this method sets XMax.

Parameters

[in]

newXMax

Definition at line 415 of file DPMBase.cc.

References getXMin(), logger, WARN, and xMax_.

Referenced by readNextArgument(), readNextDataFile(), ChuteWithHopper::setChuteLength(), Chute::setChuteLength(), ChuteWithHopper::setHopperShift(), and setMax().

{
    if (xMax < getXMin())
    {
        logger(WARN, "Warning in setXMax(%): value cannot be smaller than xMin=%", xMax, getXMin());
    }
    xMax_ = xMax;
}

void DPMBase::setXMin

(

Mdouble

xMin

)

If the length of the problem domain in x-direction is XMax - XMin, this method sets XMin.

Parameters

[in]

newXMin

Definition at line 359 of file DPMBase.cc.

References getXMax(), logger, WARN, and xMin_.

Referenced by readNextArgument(), readNextDataFile(), ChuteWithHopper::setChuteLength(), and setMin().

{
    if (xMin > getXMax())
    {
        logger(WARN, "Warning in setXMin(%): value cannot be larger than xMax=%", xMin, getXMax());
    }
    xMin_ = xMin;
}

void DPMBase::setYMax

(

Mdouble

yMax

)

If the length of the problem domain in y-direction is YMax - YMin, this method sets YMax.

Parameters

[in]

newYMax

Definition at line 427 of file DPMBase.cc.

References getYMin(), logger, WARN, and yMax_.

Referenced by readNextArgument(), readNextDataFile(), Chute::setChuteWidth(), and setMax().

{
    if (yMax < getYMin())
    {
        logger(WARN, "Warning in setYMax(%): value cannot be smaller than yMin=%", yMax, getYMin());
    }
    yMax_ = yMax;
}

void DPMBase::setYMin

(

Mdouble

yMin

)

If the length of the problem domain in y-direction is YMax - YMin, this method sets YMin.

Parameters

[in]

newYMin

Definition at line 371 of file DPMBase.cc.

References getYMax(), logger, WARN, and yMin_.

Referenced by readNextArgument(), readNextDataFile(), and setMin().

{
    if (yMin > getYMax())
    {
        logger(WARN, "Warning in setYMin(%): value cannot be larger than yMax=%", yMin, getYMax());
    }
    yMin_ = yMin;
}

void DPMBase::setZMax

(

Mdouble

zMax

)

If the length of the problem domain in z-direction is XMax - XMin, this method sets ZMax.

Parameters

[in]

newZMax

Definition at line 439 of file DPMBase.cc.

References getZMin(), logger, WARN, and zMax_.

Referenced by ChuteWithHopper::addHopper(), Chute::readNextArgument(), readNextArgument(), readNextDataFile(), Chute::setInflowHeight(), and setMax().

{
    if (zMax < getZMin())
    {
        logger(WARN, "Warning in setZMax(%): value cannot be smaller than zMin=%", zMax, getZMin());
    }
    zMax_ = zMax;
}

void DPMBase::setZMin

(

Mdouble

zMin

)

If the length of the problem domain in z-direction is ZMax - ZMin, this method sets ZMin.

Parameters

[in]

newZMin

Definition at line 383 of file DPMBase.cc.

References getZMax(), logger, WARN, and zMin_.

Referenced by readNextArgument(), readNextDataFile(), and setMin().

{
    if (zMin > getZMax())
    {
        logger(WARN, "Warning in setZMin(%): value cannot be larger than zMax=%", zMin, getZMax());
    }
    zMin_ = zMin;
}

void DPMBase::solve

(

)

The work horse of the code.

• Initialises the time, sets up the initial conditions for the simulation by calling the setupInitialConditions() and resets the counter using setNExtSavedTimeStep().
  • HGrid operations which is the contact detection algorithm.
  • Checks if the basic essentials are set for carrying out the simulations using checkSettings()
  • And many more vital operations. See below ;)

    Todo:

    Is it neccesarry to reset initial conditions here and in setTimeStepByParticle (i.e. should it be in constructor) Thomas: I agree, setTimeStepByParticle should be rewritten to work without calling setupInitialConditions

Initialise the time and sets up the initial conditions for the simulation

Todo:

Is it neccesarry to reset initial conditions here and in setTimeStepByParticle (i.e. should it be in constructor)? Thomas: I agree, setTimeStepByParticle should be rewritten to work without calling setupInitialConditions

Bug:

{In chute particles are added in actions_before_time_set(), however they are not written to the xballs data yet, but can have a collison and be written to the fstat data}

Definition at line 2188 of file DPMBase.cc.

References actionsAfterSolve(), InteractionHandler::actionsAfterTimeStep(), actionsAfterTimeStep(), actionsBeforeTimeLoop(), actionsBeforeTimeStep(), actionsOnRestart(), boundaryHandler, checkAndDuplicatePeriodicParticles(), checkInteractionWithBoundaries(), checkSettings(), Files::closeFiles(), computeAllForces(), ParticleHandler::computeAllMasses(), continueSolve(), DEBUG, InteractionHandler::eraseOldInteractions(), finishStatistics(), getAppend(), Files::getName(), getRestarted(), FilesAndRunNumber::getRunNumber(), getTime(), getTimeMax(), hGridActionsAfterIntegration(), hGridActionsBeforeIntegration(), hGridActionsBeforeTimeLoop(), hGridActionsBeforeTimeStep(), INFO, initialiseStatistics(), integrateAfterForceComputation(), integrateBeforeForceComputation(), interactionHandler, logger, ntimeSteps_, particleHandler, removeDuplicatePeriodicParticles(), Files::resetFileCounter(), Files::restartFile, Files::setName(), Files::setNextSavedTimeStep(), File::setOpenMode(), Files::setOpenMode(), setTime(), setupInitialConditions(), time_, timeStep_, and writeOutputFiles().

Referenced by ChuteBottom::makeRoughBottom(), and solve().

{
    logger(DEBUG, "Entered solve");
#ifdef CONTACT_LIST_HGRID
    logger(INFO,"Using CONTACT_LIST_HGRID");
#endif
    
    if (!getRestarted())
    {
        ntimeSteps_ = 0;
        resetFileCounter();
        setTime(0.0);
        setNextSavedTimeStep(0); //reset the counter
        //this is to ensure that the interaction time stamps agree with the resetting of the time value
        for (auto& i : interactionHandler)
            i->setTimeStamp(0);
        setupInitialConditions();
        logger(DEBUG, "Have created the particles initial conditions");
    }
    else
    {
        actionsOnRestart();
    }

    checkSettings();

    if (getRunNumber() > 0 && !getRestarted())
    {
        std::stringstream name;
        name << getName() << "." << getRunNumber();
        setName(name.str());
    }

    //append_ determines if files have to be appended or not
    if (getAppend())
    {
        setOpenMode(std::fstream::out | std::fstream::app);
        restartFile.setOpenMode(std::fstream::out); //Restart files should always be overwritten.
    }
    else
    {
        setOpenMode(std::fstream::out);
    }

    initialiseStatistics();

    // Setup the mass of each particle.
    particleHandler.computeAllMasses();

    // Other initialisations
    //max_radius = getLargestParticle()->getRadius();
    actionsBeforeTimeLoop();
    hGridActionsBeforeTimeLoop();

    // do a first force computation
    checkAndDuplicatePeriodicParticles();
    hGridActionsBeforeTimeStep();
    time_ -= timeStep_; //to enforce that old  time stamps are created
    ntimeSteps_--;
    computeAllForces();
    ntimeSteps_++;
    time_ += timeStep_;
    removeDuplicatePeriodicParticles();
    interactionHandler.actionsAfterTimeStep();
    logger(DEBUG, "Have computed the initial values for the forces ");

    // This is the main loop over advancing time
    while (getTime() < getTimeMax() && continueSolve())
    {
        writeOutputFiles(); //everything is written at the beginning of the timestep!
        // Loop over all particles doing the time integration step
        hGridActionsBeforeIntegration();
        integrateBeforeForceComputation();
        checkInteractionWithBoundaries(); // INSERTION boundaries handled
        hGridActionsAfterIntegration();

        // Compute forces

        // INSERTION/DELETION boundary flag change
        for (BaseBoundary* b : boundaryHandler)
        {
            b->checkBoundaryBeforeTimeStep(this);
        }

        actionsBeforeTimeStep();

        checkAndDuplicatePeriodicParticles();

        hGridActionsBeforeTimeStep();

        computeAllForces();

        removeDuplicatePeriodicParticles();

        actionsAfterTimeStep();

        // Loop over all particles doing the time integration step
        hGridActionsBeforeIntegration();
        integrateAfterForceComputation();

        checkInteractionWithBoundaries(); // DELETION boundaries handled
        hGridActionsAfterIntegration();

        //erase interactions that have not been used during the last timestep
        interactionHandler.eraseOldInteractions(getTime());
        interactionHandler.actionsAfterTimeStep();

        time_ += timeStep_;
        ntimeSteps_++;
    }
    //force writing of the last time step
    setNextSavedTimeStep(ntimeSteps_);
    writeOutputFiles();

    //end loop over interaction count
    actionsAfterSolve();

    //To make sure getTime gets the correct time for outputting statistics
    finishStatistics();

    closeFiles();
}

void DPMBase::solve	(	int	argc,
		char *	argv[]
	)

The solve function is the work horse of the code with the user input.

Parameters

[in]	argc
[in]	argv

Definition at line 160 of file DPMBase.cc.

References readArguments(), and solve().

{
    readArguments(argc, argv);
    solve();
}

void DPMBase::write ( std::ostream &  os, bool  writeAllParticles = true  ) const

virtual

Loads all MD data and plots statistics for all timesteps in the .data file.

Todo:

what to do with statisticsFromRestartData?

Writes all data into a restart file

Parameters

[in]	os
[in]	writeAllParticles

Todo:

TW: random number seed is not stored

Todo:

TW: xBalls arguments are not stored

Reimplemented in ChuteWithHopper, MercuryBase, and Chute.

Definition at line 1897 of file DPMBase.cc.

References boundaryHandler, helpers::compare(), getGravity(), BaseHandler< T >::getNumberOfObjects(), BaseHandler< T >::getObject(), getParticleDimensions(), getSystemDimensions(), getTime(), getTimeMax(), getTimeStep(), InteractionHandler::getWriteVTK(), getXBallsAdditionalArguments(), getXMax(), getXMin(), getYMax(), getYMin(), getZMax(), getZMin(), interactionHandler, ntimeSteps_, particleHandler, random, speciesHandler, wallHandler, RNG::write(), SpeciesHandler::write(), InteractionHandler::write(), FilesAndRunNumber::write(), ParticleHandler::write(), writeParticlesVTK_, and writeWallsVTK_.

Referenced by operator<<(), MercuryBase::write(), and writeRestartFile().

{
    os << "restart_version " << "1.0";
    FilesAndRunNumber::write(os);
    os << "xMin " << getXMin()
       << " xMax " << getXMax()
       << " yMin " << getYMin()
       << " yMax " << getYMax()
       << " zMin " << getZMin()
       << " zMax " << getZMax() << std::endl
       << "timeStep " << getTimeStep()
       << " time " << getTime()
       << " ntimeSteps " << ntimeSteps_
       << " timeMax " << getTimeMax() << std::endl
       << "systemDimensions " << getSystemDimensions()
       << " particleDimensions " << getParticleDimensions()
       << " gravity " << getGravity();
    os << " writeVTK " << writeParticlesVTK_ << " " << writeWallsVTK_ << " " << interactionHandler.getWriteVTK();
    os << " random "; random.write(os);
    //only write xBallsArguments if they are nonzero
    if (getXBallsAdditionalArguments().compare(""))
        os << " xBallsArguments " << getXBallsAdditionalArguments();
    os << std::endl;

    speciesHandler.write(os);
    os << "Walls " << wallHandler.getNumberOfObjects() << std::endl;
    for (BaseWall* w : wallHandler)
        os << (*w) << std::endl;
    os << "Boundaries " << boundaryHandler.getNumberOfObjects() << std::endl;
    for (BaseBoundary* b : boundaryHandler)
        os << (*b) << std::endl;
    if (writeAllParticles || particleHandler.getNumberOfObjects() < 4)
    {
        particleHandler.write(os);
    } else
    {
        os << "Particles " << particleHandler.getNumberOfObjects() << std::endl;
        for (unsigned int i = 0; i < 2; i++)
            os << *particleHandler.getObject(i) << std::endl;
        os << "..." << std::endl;
    }
    if (writeAllParticles || interactionHandler.getNumberOfObjects() < 4)
    {
        interactionHandler.write(os);
    } else
    {
        os << "Interactions " << interactionHandler.getNumberOfObjects() << std::endl;
        for (unsigned int i = 0; i < 2; i++)
            os << *interactionHandler.getObject(i) << std::endl;
        os << "..." << std::endl;
    }
}

void DPMBase::writeEneHeader ( std::ostream &  os ) const

protectedvirtual

Writes a header with a certain format for ENE file.

Parameters

[in]

os

todo{Why is there a +6 here? TW: to get the numbers and title aligned}

Definition at line 973 of file DPMBase.cc.

References getAppend().

Referenced by writeOutputFiles().

{
    //only write if we don't restart
    if (getAppend())
        return;
    
    long width = os.precision() + 6;
    os << std::setw(width) << "t" << " " << std::setw(width)
       << "ene_gra" << " " << std::setw(width)
       << "ene_kin" << " " << std::setw(width)
       << "ene_rot" << " " << std::setw(width)
       << "ene_ela" << " " << std::setw(width)
       << "X_COM" << " " << std::setw(width)
       << "Y_COM" << " " << std::setw(width)
       << "Z_COM" << std::endl;
}

void DPMBase::writeEneTimestep ( std::ostream &  os ) const

protectedvirtual

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.

Parameters

[in]

os

todo{Why is there a +6 here? TW: to ensure the numbers fit into a constant width column}

Definition at line 1044 of file DPMBase.cc.

References Vec3D::dot(), getElasticEnergy(), getGravity(), getTime(), and particleHandler.

Referenced by writeOutputFiles().

{
    Mdouble ene_kin = 0, ene_elastic = 0, ene_rot = 0, ene_gra = 0, mass_sum = 0, x_masslength = 0, y_masslength = 0, z_masslength = 0;

    for (BaseParticle* p : particleHandler)
        if (!p->isFixed())
        {
            ene_kin += .5 * p->getMass() * p->getVelocity().getLengthSquared();
            ene_rot += .5 * p->getInertia() * p->getAngularVelocity().getLengthSquared();
            ene_gra -= p->getMass() * Vec3D::dot(getGravity(), p->getPosition());
            mass_sum += p->getMass();
            x_masslength += p->getMass() * p->getPosition().X;
            y_masslength += p->getMass() * p->getPosition().Y;
            z_masslength += p->getMass() * p->getPosition().Z;
        } //end for loop over Particles

    ene_elastic = getElasticEnergy();

    long width = os.precision() + 6;
    os << std::setw(width) << getTime()
       << " " << std::setw(width) << ene_gra
       << " " << std::setw(width) << ene_kin
       << " " << std::setw(width) << ene_rot
       << " " << std::setw(width) << ene_elastic
       << " " << std::setw(width)
       << (mass_sum != 0.0 ? x_masslength / mass_sum : std::numeric_limits<double>::quiet_NaN())
       << " " << std::setw(width)
       << (mass_sum != 0.0 ? y_masslength / mass_sum : std::numeric_limits<double>::quiet_NaN())
       << " " << std::setw(width)
       << (mass_sum != 0.0 ? z_masslength / mass_sum : std::numeric_limits<double>::quiet_NaN()) << std::endl;

    //sliding = sticking = 0;
}

void DPMBase::writeFstatHeader ( std::ostream &  os ) const

protectedvirtual

Writes a header with a certain format for FStat file.

Parameters

[in]

os

Definition at line 994 of file DPMBase.cc.

References ParticleHandler::getLargestParticle(), BaseParticle::getRadius(), ParticleHandler::getSmallestParticle(), getTime(), getXMax(), getXMin(), getYMax(), getYMin(), getZMax(), getZMin(), interactionHandler, and particleHandler.

Referenced by writeOutputFiles().

{

    // line #1: time, volume fraction
    // line #2: wall box: wx0, wy0, wz0, wx1, wy1, wz1
    // line #3: radii-min-max & moments: rad_min, rad_max, r1, r2, r3, r4
    os << "#"
       << " " << getTime()
       << " " << 0
       << std::endl;
    os << "#"
       << " " << getXMin()
       << " " << getYMin()
       << " " << getZMin()
       << " " << getXMax()
       << " " << getYMax()
       << " " << getZMax()
       << std::endl;
    os << "#"
       << " ";
    if (particleHandler.getSmallestParticle())
    {
        os << particleHandler.getSmallestParticle()->getRadius();
    } else
    {
        os << std::numeric_limits<double>::quiet_NaN();
    }
    os << " ";
    if (particleHandler.getLargestParticle())
    {
        os << particleHandler.getLargestParticle()->getRadius();
    } else
    {
        os << std::numeric_limits<double>::quiet_NaN();
    }
    os << " " << 0
       << " " << 0
       << " " << 0
       << " " << 0
       << std::endl;
    //B: write data
    for (BaseInteraction* c : interactionHandler)
    {
        c->writeToFStat(os);
    }
}

void DPMBase::writeOutputFiles ( )

virtual

Writes the simulation data onto all the files i.e. .data, .ene, .fstat ...

Reimplemented in Mercury3DRestart, and StatisticsVector< T >.

Definition at line 2139 of file DPMBase.cc.

References File::close(), Files::dataFile, Files::eneFile, Files::fStatFile, File::getCounter(), File::getFileType(), File::getFstream(), getRestarted(), MULTIPLE_FILES, MULTIPLE_FILES_PADDED, NO_FILE, ntimeSteps_, outputXBallsData(), printTime(), Files::restartFile, File::saveCurrentTimestep(), writeEneHeader(), writeEneTimestep(), writeFstatHeader(), writeRestartFile(), writeVTK(), and writeXBallsScript().

Referenced by FileReader::read(), solve(), and Mercury3DRestart::writeOutputFiles().

{
    if (fStatFile.saveCurrentTimestep(ntimeSteps_))
        writeFstatHeader(fStatFile.getFstream());

    if (eneFile.saveCurrentTimestep(ntimeSteps_))
    {
        if (eneFile.getCounter() == 1 || eneFile.getFileType() == FileType::MULTIPLE_FILES ||
            eneFile.getFileType() == FileType::MULTIPLE_FILES_PADDED)
            writeEneHeader(eneFile.getFstream());
        writeEneTimestep(eneFile.getFstream());
    }

    if (dataFile.saveCurrentTimestep(ntimeSteps_))
    {
        printTime();
        if ((getRestarted() || dataFile.getCounter() == 1) && dataFile.getFileType() != FileType::NO_FILE)
            writeXBallsScript();
        outputXBallsData(dataFile.getFstream());
        writeVTK();
    }

//    if (statFile.saveCurrentTimestep(ntimeSteps_))
//    {
//        outputStatistics();
//        gatherContactStatistics();
//        processStatistics(true);
//    }

    //write restart file last, otherwise the output cunters are wrong
    if (restartFile.saveCurrentTimestep(ntimeSteps_))
    {
        writeRestartFile();
        restartFile.close(); //overwrite old restart file if FileType::ONE_FILE
    }
}

void DPMBase::writeRestartFile ( )

virtual

Stores all the particle data for current save time step. Calls the write function.

/// See also MD::readRestartFile

Todo:

DPMBase::writeRestartFile should check if restartFIle is open or not

Definition at line 1618 of file DPMBase.cc.

References File::getFstream(), Files::restartFile, and write().

Referenced by writeOutputFiles().

{
    write(restartFile.getFstream());
}

void DPMBase::writeVTK ( ) const

protected

Definition at line 1080 of file DPMBase.cc.

References Files::getName(), getParticlesWriteVTK(), getTime(), getWallsWriteVTK(), InteractionHandler::getWriteVTK(), INFO, interactionHandler, logger, MULTIPLE_FILES, MULTIPLE_FILES_PADDED, NO_FILE, ONE_FILE, particleHandler, wallHandler, helpers::writeToFile(), WallHandler::writeVTK(), InteractionHandler::writeVTK(), and ParticleHandler::writeVTK().

Referenced by writeOutputFiles().

                             {
    if ((getWallsWriteVTK() == FileType::ONE_FILE && getTime() == 0.0)
        || getWallsWriteVTK() == FileType::MULTIPLE_FILES
        || getWallsWriteVTK() == FileType::MULTIPLE_FILES_PADDED)
    {
        wallHandler.writeVTK();
    }
    if (getParticlesWriteVTK() == true)
    {
        particleHandler.writeVTK();
    }
    interactionHandler.writeVTK();

    if (getTime()==0 && interactionHandler.getWriteVTK() != FileType::NO_FILE)
    {
        logger(INFO,"Writing python script for paraview visualisation");
        helpers::writeToFile(getName()+".paraview.py",
                             "#script to visualise the output of data2pvd of MercuryDPM in paraview.\n"
                              "#usage: change the path below to your own path, open paraview\n"
                              "#Tools->Python Shell->Run Script->VisualisationScript.py\n"
                              "#or run paraview --script=VisualisationScript.py \n"
                              "\n"
                              "try: paraview.simple\n"
                              "except: from paraview.simple import *\n"
                              "import glob\n"
                              //"import os\n"
                              //"os.chdir(\"/Users/weinhartt/Mercury/Alpha/cmake-build-debug/Drivers/USER/Thomas/Mainz\")\n"
                              "\n"
                              "particles = XMLUnstructuredGridReader(FileName=glob.glob('./"
                             + getName() + "Particle_*.vtu'))\n"
                              "\n"
                              "walls = XMLUnstructuredGridReader(FileName=glob.glob('./"
                             + getName() + "Wall_*.vtu'))\n"
                              "\n"
                              "interactions = XMLUnstructuredGridReader(FileName=glob.glob('./"
                             + getName() + "Interaction_*.vtu'))\n"
                              "\n"
                              "#Make the glyph, see visualisation guide on the docs\n"
                              "glyphP = Glyph(particles)\n"
                              "glyphP.GlyphType = 'Sphere'\n"
                              "glyphP.Scalars = 'Radius'\n"
                              "glyphP.Vectors = 'None'\n"
                              "glyphP.ScaleMode = 'scalar'\n"
                              "glyphP.ScaleFactor = 2\n"
                              "glyphP.GlyphMode = 'All Points'\n"
                              "\n"
                              "#Make the glyph, see visualisation guide on the docs\n"
                              "glyphI = Glyph(interactions)\n"
                              "glyphI.GlyphType = 'Sphere'\n"
                              "glyphI.Scalars = 'ContactRadius'\n"
                              "glyphI.Vectors = 'None'\n"
                              "glyphI.ScaleMode = 'scalar'\n"
                              "glyphI.ScaleFactor = 10\n" //5 times too large
                              "glyphI.GlyphMode = 'All Points'\n"
                              "\n"
                              "#show on screen\n"
                              "Show(glyphI)\n"
                              "Show(glyphP)\n"
                              "Show(walls)\n"
                              "Render()\n"
                              "ResetCamera()");
    }
}

virtual void DPMBase::writeXBallsScript ( ) const

virtual

This writes a script which can be used to load the xballs problem to display the data just generated.

Todo:

Implement or make pure virtual

Referenced by writeOutputFiles().

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const DPMBase &  md  )

friend

Operator overloading of DPMBase class, writes the StatType to the given ostream.

Member Data Documentation

int DPMBase::addL_

private

Stores the number of large particles that are to be added on restart.

Definition at line 886 of file DPMBase.h.

Referenced by getAddLarge(), and setAddLarge().

int DPMBase::addS_

private

Stores the number of small particles that are to be added on restart.

Definition at line 892 of file DPMBase.h.

Referenced by getAddSmall(), and setAddSmall().

bool DPMBase::append_

private

A flag to determine if the file has to be appended or not. See DPMBase::Solve() for example.

Definition at line 939 of file DPMBase.h.

Referenced by DPMBase(), getAppend(), and setAppend().

BoundaryHandler DPMBase::boundaryHandler

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

Definition at line 1011 of file DPMBase.h.

Referenced by checkAndDuplicatePeriodicParticles(), checkInteractionWithBoundaries(), checkParticleForInteractionLocalPeriodic(), constructor(), DPMBase(), read(), readOld(), readParAndIniFiles(), ChuteBottom::setupInitialConditions(), Chute::setupInitialConditions(), ChuteWithHopper::setupInitialConditions(), Chute::setupSideWalls(), solve(), and write().

Mdouble DPMBase::elasticEnergy_

private

used in force calculations

Stores the potential energy in the elastic springs (global, because it has to be calculated in the force loop

Definition at line 921 of file DPMBase.h.

Referenced by DPMBase().

Vec3D DPMBase::gravity_

private

Gravity vector.

Definition at line 842 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getGravity(), read(), readOld(), and setGravity().

InteractionHandler DPMBase::interactionHandler

An object of the class InteractionHandler.

Definition at line 1016 of file DPMBase.h.

Referenced by computeForcesDueToWalls(), computeInternalForces(), constructor(), DPMBase(), gatherContactStatistics(), getElasticEnergy(), main(), outputInteractionDetails(), FileReader::read(), read(), removeDuplicatePeriodicParticles(), setTime(), solve(), write(), writeFstatHeader(), and writeVTK().

unsigned int DPMBase::ntimeSteps_

private

Stores the number of time steps.

Definition at line 904 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getNtimeSteps(), read(), solve(), write(), and writeOutputFiles().

unsigned int DPMBase::particleDimensions_

private

determines if 2D or 3D particle volume is used for mass calculations

Definition at line 837 of file DPMBase.h.

Referenced by DPMBase(), getParticleDimensions(), read(), and setParticleDimensions().

ParticleHandler DPMBase::particleHandler

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

Definition at line 1001 of file DPMBase.h.

Referenced by ChuteWithHopper::addHopper(), SpeciesHandler::addObject(), broadPhase(), checkAndDuplicatePeriodicParticles(), InsertionBoundary::checkBoundaryBeforeTimeStep(), checkInteractionWithBoundaries(), checkParticleForInteractionLocal(), checkParticleForInteractionLocalPeriodic(), Chute::cleanChute(), computeAllForces(), constructor(), Chute::createBottom(), DPMBase(), getGravitationalEnergy(), MercuryBase::getHGridTargetMaxInteractionRadius(), MercuryBase::getHGridTargetMinInteractionRadius(), MercuryBase::getHGridTargetNumberOfBuckets(), getKineticEnergy(), MercuryBase::hGridActionsBeforeTimeStep(), MercuryBase::hGridNeedsRebuilding(), MercuryBase::hGridRebuild(), HGridOptimiser::initialise(), integrateAfterForceComputation(), integrateBeforeForceComputation(), main(), ChuteBottom::makeRoughBottom(), outputXBallsData(), Chute::printTime(), FileReader::read(), read(), readNextDataFile(), InteractionHandler::readObject(), readOld(), removeDuplicatePeriodicParticles(), LiquidMigrationWilletInteraction::rupture(), ParticleSpecies::setDensity(), setFixedParticles(), setParticleDimensions(), BaseParticle::setSpecies(), ChuteBottom::setupInitialConditions(), solve(), write(), writeEneTimestep(), writeFstatHeader(), and writeVTK().

RNG DPMBase::random

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

Definition at line 996 of file DPMBase.h.

Referenced by InsertionBoundary::checkBoundaryBeforeTimeStep(), constructor(), Chute::createBottom(), DPMBase(), read(), readNextArgument(), ChuteBottom::setupInitialConditions(), and write().

bool DPMBase::restarted_

private

A bool to check if the simulation was restarted or not, ie. if setupInitialConditionsShould be run and the fileCounters reset.

Definition at line 933 of file DPMBase.h.

Referenced by DPMBase(), getRestarted(), and setRestarted().

std::string DPMBase::restartVersion_

private

Previous versions of MercuryDPM had a different restart file format, the below member variable allows one to specify the version in order to choose between the available version support.

Definition at line 928 of file DPMBase.h.

Referenced by DPMBase(), getRestartVersion(), read(), and setRestartVersion().

bool DPMBase::rotation_

private

A flag to turn on/off particle rotation.

Definition at line 944 of file DPMBase.h.

Referenced by DPMBase(), getRotation(), and setRotation().

SpeciesHandler DPMBase::speciesHandler

A handler to that stores the species type i.e. elastic, linear visco-elastic... et cetera.

Definition at line 991 of file DPMBase.h.

Referenced by ChuteWithHopper::addHopper(), MaserBoundary::addParticleToMaser(), checkSettings(), constructor(), Chute::createBottom(), DPMBase(), InteractionHandler::getInteraction(), ChuteBottom::makeRoughBottom(), FileReader::read(), read(), readNextDataFile(), WallHandler::readObject(), readOld(), readParAndIniFiles(), BaseParticle::setIndSpecies(), ChuteBottom::setupInitialConditions(), Chute::setupInitialConditions(), ChuteWithHopper::setupInitialConditions(), Chute::setupSideWalls(), and write().

unsigned int DPMBase::systemDimensions_

private

The dimensions of the simulation i.e. 2D or 3D.

Definition at line 832 of file DPMBase.h.

Referenced by DPMBase(), getSystemDimensions(), read(), readOld(), and setSystemDimensions().

Mdouble DPMBase::time_

private

Stores the current simulation time.

Definition at line 899 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getTime(), read(), readNextDataFile(), readOld(), setTime(), and solve().

Mdouble DPMBase::timeMax_

private

Stores the duration of the simulation.

Definition at line 914 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getTimeMax(), read(), readOld(), and setTimeMax().

Mdouble DPMBase::timeStep_

private

Stores the simulation time step.

Definition at line 909 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getTimeStep(), read(), readOld(), setTimeStep(), and solve().

WallHandler DPMBase::wallHandler

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

Definition at line 1006 of file DPMBase.h.

Referenced by ChuteWithHopper::addHopper(), checkParticleForInteractionLocal(), MercuryBase::checkParticleForInteractionLocal(), computeAllForces(), computeForcesDueToWalls(), constructor(), Chute::createBottom(), DPMBase(), integrateAfterForceComputation(), integrateBeforeForceComputation(), main(), FileReader::read(), read(), InteractionHandler::readObject(), readOld(), readParAndIniFiles(), BaseWall::setSpecies(), ChuteBottom::setupInitialConditions(), Chute::setupSideWalls(), write(), and writeVTK().

bool DPMBase::writeParticlesVTK_

private

A flag to turn on/off the vtk writer for particles.

Definition at line 954 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getParticlesWriteVTK(), read(), setParticlesWriteVTK(), and write().

FileType DPMBase::writeWallsVTK_

private

A flag to turn on/off the vtk writer for walls.

Definition at line 949 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getWallsWriteVTK(), read(), setWallsWriteVTK(), and write().

std::string DPMBase::xBallsAdditionalArguments_

private

A string of additional arguments for xballs can be specified (see XBalls/xballs.txt). e.g. "-solidf -v0".

Definition at line 977 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getXBallsAdditionalArguments(), and setXBallsAdditionalArguments().

int DPMBase::xBallsColourMode_

private

XBalls is a package to view the particle data. As an alternative MercuryDPM also supports Paraview. The below variable is used to set the argument cmode in xballs script (see XBalls/xballs.txt)

Definition at line 962 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getXBallsColourMode(), and setXBallsColourMode().

Mdouble DPMBase::xBallsScale_

private

sets the xballs argument scale (see XBalls/xballs.txt)

Definition at line 972 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getXBallsScale(), and setXBallsScale().

Mdouble DPMBase::xBallsVectorScale_

private

sets the xballs argument vscale (see XBalls/xballs.txt)

Definition at line 967 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getXBallsVectorScale(), and setXBallsVectorScale().

Mdouble DPMBase::xMax_

private

If the length of the problem domain in x-direction is XMax - XMin, the above variable stores XMax.

Definition at line 854 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getMax(), getXMax(), read(), readNextDataFile(), readOld(), and setXMax().

Mdouble DPMBase::xMin_

private

If the length of the problem domain in x-direction is XMax - XMin, the above variable stores XMin.

Definition at line 848 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getMin(), getXMin(), read(), readNextDataFile(), readOld(), and setXMin().

Mdouble DPMBase::yMax_

private

If the length of the problem domain in y-direction is YMax - XMin, the above variable stores YMax.

Definition at line 866 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getMax(), getYMax(), read(), readNextDataFile(), readOld(), and setYMax().

Mdouble DPMBase::yMin_

private

If the length of the problem domain in y-direction is YMax - YMin, the above variable stores YMin.

Definition at line 860 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getMin(), getYMin(), read(), readNextDataFile(), readOld(), and setYMin().

Mdouble DPMBase::zMax_

private

If the length of the problem domain in z-direction is ZMax - ZMin, the above variable stores ZMax.

Definition at line 878 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getMax(), getZMax(), read(), readNextDataFile(), readOld(), and setZMax().

Mdouble DPMBase::zMin_

private

If the length of the problem domain in z-direction is ZMax - ZMin, the above variable stores ZMin.

Definition at line 872 of file DPMBase.h.

Referenced by constructor(), DPMBase(), getMin(), getZMin(), read(), readNextDataFile(), readOld(), and setZMin().

---

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

• DPMBase.h
• DPMBase.cc