A CFD python package for the shallow water equations
Project description
MattFlow
A CFD python package for the shallow water equations.
MattFlow simulates the surface of the water after any initial conditions, such as drops or stones falling on.
requirements | os |
---|---|
python 3 | GNU/Linux |
numpy 1.16.4 | Windows |
matplotlib 3.1.1 | |
ffmpeg (optional) |
How to install & run MattFlow
- anaconda environment (recomended)
$ mkdir mattflow
$ cd mattflow
$ conda create --name mattflow python=3 matplotlib
$ conda activate mattflow
$ pip install mattflow
$ mattflow
- venv (python>=3.3)
$ mkdir mattflow
$ cd mattflow
$ python3 -m venv mattflow_env
$ source mattflow_env/bin/activate
$ pip install mattflow
$ mattflow
- pip
$ mkdir mattflow
$ cd mattflow
$ pip install --user mattflow
$ mattflow
Swallow Water Equations
SWE is a simpified CFD problem which models the surface of the water, with the assumption
that the horizontal length scale is much greater than the vertical length scale.
SWE is a coupled system of 3 hyperbolic partial deferential equations, that derive from
conservation of mass and conservation of linear momentum (Navier-Stokes) equations, in
case of a horizontal stream bed, with no Coriolis, frictional or viscours forces (wiki).
where:
η : height
u : velocity along the x axis
υ : velocity along the y axis
ρ : density
g : gravity acceleration
MattFlow structure
More details at this jupyter notebook
- configuration of the simulation via a config file
- pre-process
structured/cartesian mesh - solution
supported solvers:- Lax-Friedrichs Reiman | O(Δt, Δx2, Δy2)
- 2-stage Rugne-Kutta | O(Δt2, Δx2, Δy2) | default
- MacCormack | O(Δt2, Δx2, Δy2) | experimental
- post-processing
matplotlib animation
Additional configurations
- mesh sizing
- domain sizing
- initial conditions (single drop, multiple drops, rain)
- boundary conditions (currently: reflective)
- solver
- plotting style
- animation options
Currently, you can configure the simulation at the config module
TODO
- exceptions
- pytest
- linting
- Simple API to configure the simulation
- Implementation of higher order schemes
- Addition of source terms
- Addition of viscous models
- Moving core to C++, Cython or Numba
- Support moving objects inside the domain
- Unstructured mesh
- Extent to 3D CFD
Start the flow!
(C) 2019, Thanasis Mattas
atmattas@physics.auth.gr
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.