GraSPH Documentation #

WORK IN PROGRESS, CONTENT WILL BE ADDED/CHANGED OVER TIME.

This Page #

Provides more detailed documentation than in the GitHub README. The pages on the right should be enough to get you started on simulating the example. In the future, I aim to add documentation that explains the code structure and how to modify the code. Topics are on the menu on the left. If you have feedback (for the docs or the code), don’t hestiate to open an issue on the GitHub, or email me. And I’ll do my best to get back to you.

About GraSPH #

Gra(nular)SPH is a Smoothed Particle Hydrodynamics (SPH) code written in Fortran. It uses the SPH method to simulate fluid dynamics using the “weakly compressible” approach described in Monaghan 1994. Currently, it can only simulate fluids, but will be developed in the future to incorporate simple granular models such as that described in Bui et al. (2008).

GraSPH can be run in serial, or in parallel using Coarray Fortran (which is based on the MPI implementation described in Yang et al. (2021). It has further been developed to be able to run on an NVIDIA GPU.

It uses HDF5 as the IO library, so output files can be read from Matlab or Python (using h5py). Future work include writing the code in a HDF5 file format compatible with ParaView.

GraSPH is a hobby project of mine that builds on the work I did with SPH in my masters. It is not supported by MCGLAB, which its origins are traced from. You can download the code from my GitHub. See the README for brief instructions on how to get started, or the Getting Started page.

About the Author #

See my about page. I worked on SPH as a part of my time with MCGLAB as an undergrad + masters student between 2017-2020. But now I work in health science research at WEHI as a Research Computing Engineer.