openfoam_project/README.md

# 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.

Usage:
```
python -m generate
```

### OpenFoam
The `openfoam` directory contains the OpenFoam configuration files and a
utility that copies the configuration and runs the `olaFlow` model.

Usage:
```
python -m run
```

### Post-process
The `post_process` directory provides a utility for plotting an animation of
the simulation.

Usage:
```
python -m animate alpha.water
```

## 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.