Welcome to the SPHysics FAQ Page. If you do not find the answer to the question you were looking for, please try the other Forum pages:
SPHysics is a platform of free open-source codes for Smoothed Particle Hydrodynamics (SPH) written in a variety of languages for different computational resources (fortran, MPI, C++, CUDA) for the simulation of potentially violent free-surface hydrodynamics. The SPHysics codes can simulate various phenomena including wave breaking, dam breaks, sloshing, sliding objects, floating objects, wave impact on a structure, etc. More information on the technical capabilities can be found on the SPHysics home page.
We now have a range of codes based on SPHysics:
Please see the Downloads Page.
SPHysics has been written by a number of contributors from universities from around the world. For a list of the authors of the different codes please see the Developers page. The code took several years to develop, apply to test cases and improve.
The SPHysics source codes are downloadable from the main Downloads page. Therefore, the code can run on any operating system or platform where you have the relevant compilers (e.g. fortran, MPICH, OpenMPI, CUDA). During development every effort has been made to ensure that the SPHysics codes are as portable as possible.
The serial codes have been tested on the following operating systems and compilers below.
The parallel Code has been tested on the linux/unix-based operating systems using either MPICH v2 or OpenMPI compilers with Intel ifort or GNU gfortran as the underlying compiler.
The DualSPHysics code has been tested on the linux/unix-based and windows operating systems using the CUDA (nvcc) compiler v3.0.
The SPHysics serial and parallel codes come with 7 example cases in 2-D and 5 example cases in 3-D to give users an idea on how to generate their own geometries. The SPHYSICSgen_2D.f and SPHYSICSgen_3D.f codes can generated different geometries depending on the input (we use input files or keyboard entry). From version 2.0, the default setting for the code is to use one batch file to generate the geometry and run the code. If you just want to generate the geometry only (e.g. for checking purposes), follow these steps for 2-D (for 3-D just change 2D to 3D throughout):
Change to the directory: source\SPHYSICSgen2D\ Use one of the following options depending on your compiler:
Then change to the relevant directory (run_directory/CaseN where N is a number) to run one of the example test cases (see below). Note the input files (CaseN.txt) require you to specify which compiler you wish to use (around the last line):
Note, for Silverfrost FTN95, the CaseN.txt files must NOT have TABS immediately after the numerical values. Instead, use two consecutive spaces.
This depends whether you are using an Intergrated Development Environment (IDE). Generally, your compiler will produce SPHYSICS.exe which are then run from the command line:
The code includes special subroutines to generate the appropriate compilation make files which can be adjusted for other compilers and operating environments. The code has been developed to run on Windows using Intel Visual Fortran. For example, If you are using the Compaq Visual Fortran Compiler to run Case1, you can use the batch file:
OR for the Silverfrost FTN95 compiler:
This will compile SPHYSICSgen_2D/3D which will generate the geometry and subsequently compile the executable SPHYSICS_2D/3D under the directory \execs. The code will then start to run writing the output to a file called "sph.out" aswell as to the screen. Note the input files (CaseN.txt) require you to specify which compiler you wish to use (the last line); for the CVF compiler use the value 3; for the Silverfrost FTN95 compiler use the value 4.
The SPHysics code comes with batch files which are used to compile the source code and then run the codes. For example, for Case1 which is supplied with the code (under run_directory), at the command prompt, for the gfortran compiler type:
OR if you use the ifortran compiler
This will compile SPHYSICSgen_2D/3D which will generate the geometry, the makefile SPHYSICS.mak and subsequently compile the executable SPHYSICS_2D/3D under the directory execs/. The code will then start to run writing the output to a file called "sph.out" aswell as to the screen. Note the input files (CaseN.txt) require you to specify which compiler you wish to use (the last line); for the gfortran compiler use the value 1, and for the Intel Compiler use the value 2.
This will depend on your parallel or HPC hardware and more particularly on the Job Submission System for your hardware. parallelSPHysics comes with submission scripts for the SGE and LSF systems. See the guide here: parallelSPHysics_v2.0_GUIDE.pdf October 2010
See DualSPHysics FAQ
Some basic visualisation tools are included with the source codes. The results can be visualized either with Matlab or ParaView. In order to use ParaView, the raw data files require some processing which at present is done using a choice of either some fortran or Matlab code.
From version 1.4, you can now use new fortran routines to generate the VTU files for use with ParaView. If you are running CaseN, copy and run the relevant batch file from \Post-Processing\fortranRoutines\ to \run_directory\CaseN\, e.g. using the cvf compiler on windows, copy PART2VTU_windows_cvf.bat to the CaseN directory, and then run from the command line using:
On linux, copy the file(s) PART2VTU_unix_gfortran/ifort.bat to the CaseN directory and run from the command line using
The code has been validated for a number of different test cases including dam breaks, waves hitting structures, breaking waves at beaches, Poiseuille flow, Couette flow. Interested readers are referred to the following publications for more detailed information Publication list.
We are often asked questions on whether the code can do certain things - usually this requires extra code to be added requiring work on your part. To help you we have added Chapter 5 to the guide. You can download Chapter 5 here with an image of the Code Structure here.
A good rule of thumb is that in a commerical code there is a bug every 100 lines of code. If you find a bug in the SPHysics code, please let the developers know either by emailing us or by using the Forum pages.
Of course, download the guides here:
There are now Training Courses held each year in different locations, sometimes 2-day courses and sometimes as part the SPHERIC workshops - see Training Courses
For starters you can buy the main developers a drink of beer at the next conference or workshop. Failing that, you can post any new subroutines that you want to share with other users to the core SPHysics team. Periodically the core developers of SPHysics will meet and discuss future developments and directions of SPHysics. If your new subroutines are considered to be an invaluable addition to the code, they will be considered for inclusion in the next release version.