Skip to content

Commit

Permalink
Added readmes for the 2 examples
Browse files Browse the repository at this point in the history
  • Loading branch information
Rohit-Kakodkar committed Oct 31, 2023
1 parent 02a1a39 commit e767df6
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
29 changes: 29 additions & 0 deletions examples/fluid-solid-interface/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Wave propagration through fluid-solid interface

This example creates the fluid-solid example with flat ocean bottom from [Komatitsch et. al.](https://doi.org/10.1190/1.1444758).

## Generating the mesh

To generate the mesh for the homogeneous media we need a parameter file, `Par_File`, a topography file, `topography_file.dat`, and the mesher executible, `xmeshfem2D`, which should have been compiled during the installation process.

>! Currently, we still use a mesher that was developed for the original [SPECFEM2D](https://specfem2d.readthedocs.io/en/latest/03_mesh_generation/) code. More details on the meshing process can be found [here](https://specfem2d.readthedocs.io/en/latest/03_mesh_generation/).
## Running the mesher

To execute the mesher run

```
./xmeshfem2D -p <PATH TO PAR_FILE>
```

>! Make sure either your are in the build directory of SPECFEM2D kokkos or the build directory is added to your ``PATH``.
Note the path of the database file and :ref:`stations_file` generated after successfully running the mesher.

## Running the solver

Finally, to run the SPECFEM2D kokkos solver

```
./specfem2d -p <PATH TO specfem_config.yaml>
```
28 changes: 28 additions & 0 deletions examples/homogeneous-medium-flat-topography/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,29 @@
# Wave propagation through homogeneous medium with no interfaces

In this example we simulate wave propagation through a 2-dimensional homogeneous medium.

## Generating the mesh

To generate the mesh for the homogeneous media we need a parameter file, `Par_File`, a topography file, `topography_file.dat`, and the mesher executible, `xmeshfem2D`, which should have been compiled during the installation process.

>! Currently, we still use a mesher that was developed for the original [SPECFEM2D](https://specfem2d.readthedocs.io/en/latest/03_mesh_generation/) code. More details on the meshing process can be found [here](https://specfem2d.readthedocs.io/en/latest/03_mesh_generation/).
## Running the mesher

To execute the mesher run

```
./xmeshfem2D -p <PATH TO PAR_FILE>
```

>! Make sure either your are in the build directory of SPECFEM2D kokkos or the build directory is added to your ``PATH``.
Note the path of the database file and :ref:`stations_file` generated after successfully running the mesher.

## Running the solver

Finally, to run the SPECFEM2D kokkos solver

```
./specfem2d -p <PATH TO specfem_config.yaml>
```

0 comments on commit e767df6

Please sign in to comment.