Commit 9f475390 authored by Mischa Dombrowski's avatar Mischa Dombrowski
Browse files

Update README.md

parent de585ba9
......@@ -15,9 +15,19 @@ https://github.com/BDuenweg/Lattice-Boltzmann-weights
Assignmentlist not yet implemented !
## Usage:
Get lattices by their established name:
``` Python
from lbmweights import Lattice
Lattice().from_name("D2V37").weights
```
Or by their dimension, order and shell list:
``` Python
from lbmweights import Lattice
lattice = Lattice(dimension=2, order=4, shell_list=[1, 2, 4])
lattice.calculate_weights(boundary="inf")
c_s_sq, weights, velocities = lattice.velocity_set()
```
\ No newline at end of file
c_s_sq, weights, velocities = lattice.velocity_set() # D2Q9
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment