SWE

An Education-Oriented Code for Parallel Tsunami Simulation.

General Information

This code has been tested under Ubuntu 22.04 or higher. Other Linux distributions will probably work. However, we do not recommend using Windows or MacOS. If you do not have Linux installed on your computer, please use WSL, Virtual Machine, Docker or similar.

Docker

A prebuilt Docker image is available in Dockerhub.

To use the prebuilt image, we do recommended that you first clone SWE, then navigate into the SWE checkout and run the Docker container interactively by mapping the SWE directory into the container (here, we use work as our mapping point):

docker run -it -v ${PWD}:/work --rm --privileged tumi5/swe /bin/bash

Navigate into the work directory and continue with the steps below.

Build and Test

As build system configurator we use CMake. To compile the code execute the following commands in this directory:

• Create a build directory: mkdir build. You can also choose any other name for your build directory.
• Switch to this directory: cd build
• Run CMake: cmake .. (for an overview of all available options, use ccmake ..)
• For a Debug build, run cmake .. -DCMAKE_BUILD_TYPE=Debug
• Run Make: make (or make -j to compile with multiple cores).
• Run Tests: Some example unit tests have been implemented (make test). Feel free to add your own test cases inside the Tests folder.

Running a Simulation

• Run the code in serial via ./SWE-MPI-Runner
• Run the code in parallel via mpirun -np nproc ./SWE-MPI-Runner
• With ./SWE-MPI-Runner --help, you can see additional command-line arguments you can pass.

Visualize the Results

The command line version of SWE will write a netCDF file or multiple ASCII-VTK files (depending on the build configuration) which can be opened and visualized with ParaView.

Hint: The output files contain the absolute height of the water column h. To get the relative height of the water column, use a Calculator in ParaView with the formula h+b. If you have dry cells in your scenario, you may want to use the formula min(h, h+b). This will give you the relative height for wet cells and 0 for dry cells.

Besides the VTKWriter, SWE is also able to write netCDF files. You can enable the NetCDFWriter with the CMake option -DENABLE_NETCDF=ON. It is enabled per default.

The NetCDFWriter has two advantages:

• It creates binary files and is therefore faster to read and write.
• All time steps are stored in a single file.

The NetCDFWriter respects the COARDS standard, thus you can also visualize the netCDF files with ParaView.

Adding New Source Files

You can add new source files by just creating them somewhere within the Source folder. CMake automatically detects these files and adds them to the build.

Creating Doxygen Documentation

• Navigate into the SWE directory
• Run the following Doxygen command: doxygen Documentation/Doxyfile
• You should now see a directory called html
• Open index.html to see the generated documentation.

Development Hints & FAQ

It does not compile and everything seems fine?

Make sure to use make clean before you use make. Sometimes there are build artifacts from previous build processes that spoil your current compilation process. make clean takes care of deleting everything that should not be there and allows the compiler to start from scratch.

Sometimes it is also helpful to delete the build folder and create a new one, following the steps from the compilation section above.

How can I see all the compiler flags the generated Makefile is using?

Instead of using make, run VERBOSE=1 make. You can also run make -n to invoke a dry run where you see what the Makefile would do in case of compilation.

How can I see the test output?

Instead of using make test, run ctest --verbose.

Course Material on SWE:

• SWE - Anatomy of a Parallel Shallow Water Code (introduction given at the CSCS-USI Summer School on Computer Simulations in Science and Engineering in Lugano , July 8-19, 2013)
• SWE – An Education-Oriented Code to Solve the Shallow Water Equations (presentation given at the Gene Golub SIAM Summer School 2012 on "Simulation and Supercomputing in the Geosciences", Monterey, July 29 - August 10, 2012)