MercuryDPM

Fast, flexible particle simulations

MercuryDPM is an open-source C++ framework for discrete particle simulations of granular materials, powders, and other particulate systems.

It was started in 2009 to support complex scientific and industrial particle simulations. Its core strengths include flexible wall and boundary conditions, efficient neighbourhood detection for highly polydisperse particle systems, MercuryCG coarse-graining for continuum-field analysis, and coupling to continuum and multiscale simulation tools.

MercuryDPM is developed by an international open-source community and is released under the BSD 3-Clause licence.

Key features

• Discrete particle simulations
• Flexible boundary conditions, such as curved walls
• Elastic, plastic, viscous, frictional, and adhesive contact models
• Efficient neighbour detection, even for highly polydisperse systems
• MercuryCG coarse-graining and continuum-field analysis
• Multiphysics and multiscale coupling
• CMake-based builds
• Automated self-test suite
• Support for Linux, macOS, and Windows

Getting started

• Project website: https://www.mercurydpm.org/
• Documentation: https://mercurydpm.readthedocs.io/
• Installation: https://www.mercurydpm.org/downloads/
• Source code: https://bitbucket.org/mercurydpm/mercurydpm

Citation

If you use MercuryDPM in research, please cite:

T. Weinhart et al., Fast, flexible particle simulations — An introduction to MercuryDPM, Computer Physics Communications 249, 107129 (2020). https://doi.org/10.1016/j.cpc.2019.107129

Further citation guidance and a list of publications using MercuryDPM are available at:

• https://www.mercurydpm.org/about/citing-the-code
• https://www.mercurydpm.org/about/publications

Contributing

Contributions are welcome.

Please read CONTRIBUTING.md before submitting changes.

Development takes place through branches and pull requests, with review by MercuryDPM developers and automated testing.

Further developer information is available at:

• https://www.mercurydpm.org/for-developers
• https://www.mercurydpm.org/for-developers/contribution-guideline

For questions and user support, see:

• https://mercurydpm.atlassian.net/wiki/spaces/CQ/overview

We also host a public Q&A session every two weeks. See the event calendar on https://www.mercurydpm.org/ for upcoming dates.

Licence

MercuryDPM is distributed under the BSD 3-Clause licence.

See: https://www.mercurydpm.org/about/license