Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
FloSewn committed Apr 25, 2024
1 parent bec699c commit 77e4e73
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,6 @@ via CSV files. This example shows an airfoil that has been meshed in this way.
<img src="doc/airfoil.png" alt="TQMesh-airfoil" width="350"/>
</details>



## Output format
Currently, **TQMesh** features the VTU output format (which can be read for example by Paraview) or alternatively a simple text output format.

Expand Down Expand Up @@ -232,13 +230,22 @@ The last entry of the mesh output refers to the size function values at every ve

</details>

## OpenFOAM Support
<img src="doc/banner_3d.jpeg" alt="TQMesh-OpenFOAM-support" width="250"/>
To convert meshes from **TQMesh** to a format that is supported by OpenFOAM
you can use a script that is provided in `scripts/convert2foam.py`.
```sh
python scripts/convert2foam.py [-e EXTRUSION] Mesh.txt export-prefix
```
Optional flags:
* `-e EXTRUSION`: A floating point value by which the mesh gets extruded

## Plot your meshes
A simple python script to plot your mesh is provided under `scripts/plot_mesh.py`.
It requires the mesh given in the format described above.
Simply run it with
```sh
python scipts/plot_mesh.py Mesh.txt (-s -v -e -b -f)
python scripts/plot_mesh.py Mesh.txt (-s -v -e -b -f)
```
Optional flags:
* `-s`: Add a contour plot of the underlying size-function
Expand Down
Binary file added doc/banner_3d.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 77e4e73

Please sign in to comment.