This repository has been archived on 2022-02-01. You can view files and clone it, but cannot push or open issues or pull requests.
openfoam_project/README.md

40 lines
998 B
Markdown
Raw Permalink Normal View History

2022-01-23 15:15:35 +01:00
# 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.
2022-01-26 18:38:46 +01:00
Usage:
```
python -m generate
```
2022-01-23 15:15:35 +01:00
### OpenFoam
The `openfoam` directory contains the OpenFoam configuration files and a
utility that copies the configuration and runs the `olaFlow` model.
2022-01-26 18:38:46 +01:00
Usage:
```
python -m run
```
2022-01-23 15:15:35 +01:00
### Post-process
The `post_process` directory provides a utility for plotting an animation of
the simulation.
2022-01-26 18:38:46 +01:00
Usage:
```
python -m animate alpha.water
```
2022-01-23 15:15:35 +01:00
## 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.