From 967cd26d82aa5c976dc18c570450b90e0aabd3a1 Mon Sep 17 00:00:00 2001 From: "Edgar P. Burkhart" Date: Tue, 29 Mar 2022 10:19:33 +0200 Subject: [PATCH] Updated README with info on processing steps --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index bbf17eb..38c524d 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,23 @@ displacement at the Artha breakwater on February 28, 2017" [Report](https://kalliope.edgarpierre.fr/latex/m2cce/internship/report.pdf) +## Bathymetry + +* Insert database in `data/data` +* Run `processing.subdomain` to generate 2D data in a smaller domain +* Run `processing.projection` to generate a 1D bathymetry + +## Swash + +* Run `processing.swash` to run the Swash model +* Run `processing.sws_npz` to convert Swash output to Numpy files +* Run `processing.post` to plot wave height at a point, water level at an + instant, reflection coefficient at a point +* Run `processing.animate` to plot an animation of water level +* Run `processing.layers` to plot an animation of layers with flow velocity + +## OlaFlow + +* Run `processing.bathy` to generate stl input files +* Run `blockMesh`, `snappyHexMesh -overwrite`, copy `0.org` to `0`, `setFields` +* Run `processing.sws_ola` to convert Swash output to OlaFlow input