From e767df67d195f4f58d339f7ac078e74a7d302ecd Mon Sep 17 00:00:00 2001 From: Rohit Kakodkar Date: Tue, 31 Oct 2023 09:30:44 -0400 Subject: [PATCH] Added readmes for the 2 examples --- examples/fluid-solid-interface/README.md | 29 +++++++++++++++++++ .../README.md | 28 ++++++++++++++++++ 2 files changed, 57 insertions(+) create mode 100644 examples/fluid-solid-interface/README.md diff --git a/examples/fluid-solid-interface/README.md b/examples/fluid-solid-interface/README.md new file mode 100644 index 00000000..04e0f8b7 --- /dev/null +++ b/examples/fluid-solid-interface/README.md @@ -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 +``` + +>! 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 +``` diff --git a/examples/homogeneous-medium-flat-topography/README.md b/examples/homogeneous-medium-flat-topography/README.md index 9f322790..ba2fabb3 100644 --- a/examples/homogeneous-medium-flat-topography/README.md +++ b/examples/homogeneous-medium-flat-topography/README.md @@ -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 +``` + +>! 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 +```