1. Introduction

Today, we will explore the process of setting up our tsunami project.

1.1. Getting Started

Before you begin, make sure you have the following prerequisites:

• A C++ compiler (e.g., g++).

• Scons (for building).

• Git (for cloning the repository).

1.2. Installation

1. Clone the repository from our GitHub Page:

git clone https://github.com/Sinio-Manoka/tsunami_lab.git

2. Install Scons on Linux :

pip3 install Scons

3. Include Catch2 and nlohmann/json.hpp:

3.1. Navigate to the project directory:

cd tsunami_lab/

3.2. initialize the submodules:

git submodule init

3.3. update the submodules within a Git repository:

git submodule update

Important

If you possess an outdated version of our project, please do these steps once more.

4. How to build the project:

4.1. Navigate to the project directory:

cd tsunami_lab/

4.2. Build the project with Scons:

scons

4.3. You will find the compiled binary in the build directory.

1.3. Usage

To use the Riemann solver, follow these steps:

1. To modify the arguments for the initial run, you need to navigate to the “configs” folder.

cd configs

2. Within the folder, locate config.json file and navigate into it:

{
   "solver" : "fwave",
   "dimension_x" : 2700000,
   "dimension_y" : 1500000,
   "setup" :  "tsunamievent2d",
   "nx" : 540,
   "ny" : 300,
   "hu" : 0,
   "location" : 0,
   "hv":0.0,
   "hr": 55,
   "hl": 25,
   "domain_start_x" : -200000,
   "domain_start_y" : -750000,
   "wavepropagation" : "2d",
   "endtime" : 3600,
   "writer" : "netcdf",
   "bathfile" : "data/output/tohoku_gebco20_ucsb3_250m_bath.nc",
   "disfile" : "data/output/tohoku_gebco20_ucsb3_250m_displ.nc",
   "outputfilename": "tests.nc",
   "usecheckpoint" : false
}

Important

All values have to be written in small letters!!

solver: Choose between fwave or roe.

hv: Momentum in the y-direction. should be a number.

ny: Number of cells in the y-direction; should be an integer.

setup: Select from shockshock, rarerare, tsunamievent1d, dambreak1d, supercritical, subcritical, dambreak2d.

nx: Number of cells in the x-direction; should be an integer.

location: Location for the setup; should be a float number.

hr: Right heights; should be a number.

hl: Left heights; should be a number.

wavepropagation: Choose between 1d or 2d.

endtime: End time of the simulation; should be a float number.

writer : csv or netcdf. netcdf only support 2d wavepropagation. csv writer support both wavepropagation.

domain_start_x : Starting point of our x_domain. For the circular dam break, set the dimension to -50.

domain_start_y : Starting point of our y_domain. For the circular dam break, set the dimension to -50.

dimension_x : Width and length of our domain at this point for the x coordinates. l_dx = dimension_x / l_nx;

dimension_y : Width and length of our domain at this point in for the y coordinates. l_dy = dimension_y / l_ny;

bathfile : path file of the bathymetry for the tsunamievent2d setup

disfile : displacement file path for the tsunamievent2d setup.

outputfilenameThe outputfilename is the name of both the output file and the checkpoint.

They will share the same name, and the checkpoint can be found in the following path: /outputs/cp. input example : output.nc

usecheckpointfalse or true. If true, it would use the checkpoint in the ‘cp’ folder. If false, it would not use any checkpoint. Additionally, if there is a checkpoint with the same name as the one for the output file

we are generating now, the old checkpoint would be overwritten.checkpoint would be made automatically after every 7 timestep

Feel free to adjust the arguments to suit your needs. And don’t forget to build the project after every change.

Important

If you opt for wavepropagation1d, go to the “stations.json” file located in the “config” directory, and confirm that all y-coordinates are configured to 0.

For shockshock and rarerare setups, relevant inputs include (hl, hu, location, nx, wavepropagation, dimension, solver, endtime).

For dambreak1d setups, relevant inputs include (hl, hr, location, nx, wavepropagation, dimension, solver, endtime).

For supercritical and subcritical setups, relevant inputs include (nx, wavepropagation, dimension, solver, endtime).

For tsunamievent1d setups, relevant inputs include (dimension=440500.0, endtime, nx, wavepropagation=1d, solver).

For dambreak2d setups, relevant inputs include (nx, ny, endtime, dimension, wavepropagation=2d, domain_start, solver).

For each setup, choose the necessary inputs to modify, as other inputs will not affect the setup.

3. Navigate to the build directory:

cd build

4. To run the the project, use the following command:

./tsunami_lab

Important

After executing ./tsunami_lab, the arguments you specify in the JSON file will be automatically incorporated into the project.

The solution can be located within a directory named outputs.

1.4. Documentation

The Project Documentation can be found Here .

1.4.1. how to build documentation

To build our documentation, you need to install Sphinx and Doxygen on your Linux/Ubuntu system.

apt-get install doxygen

pip install -U sphinx

Important

to build our project in Sphnix we need to install two things:

pip install sphinxcontrib-video

pip install sphinx-rtd-theme

1. doxygen:

You can use our configuration file dconfig, which is located inside the doc\doxygen\data directory.

now just build the doxygen documentation :

doxygen dconfig

2. Sphnix:

   2.1. We need to navigate to the doc\sphnix\maker\

   2.2. execute the following command to build our documentation:

   make html
   

   2.3 The built documentation can be found in \tsunami_lab\doc\sphinx\site.