m2cce/openfoam_project
Archived
1
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Added readme

Browse source
This commit is contained in:
Edgar P. Burkhart 2022-01-23 15:15:35 +01:00
parent 46d6eaf171
commit a8aec9c20b
Signed by: edpibu
GPG key ID: 9833D3C5A25BD227
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md Normal file
View file

@ -0,0 +1,24 @@
# OpenFoam Project
Repository for an OpenFoam project on the simulation of the breaking wave flow
which caused the displacement of a 50t concrete block at the Artha breakwater
in 2017.
## Structure
### Bathymetry
The `bathymetry` directory contains the raw data and a tool that allows to
generate the stl files necessary for the OpenFoam model.
### OpenFoam
The `openfoam` directory contains the OpenFoam configuration files and a
utility that copies the configuration and runs the `olaFlow` model.
### Post-process
The `post_process` directory provides a utility for plotting an animation of
the simulation.
## Requirements
The required Python packages are listed in the `requirements.txt` file.
Run `pip install -r requirements.txt` to install all the required packages.
Other requirements include OpenFoam and the olaFlow model, as well as OpenScad
for the stl files generation.