commit 71f9bd6fde43a343d48b0257e6598030e7c98186
parent 49dce40664bc383769c0f027b928437a40194e26
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 27 Oct 2023 12:28:58 +0200
Wraps the README text in 72 columns
This matches the convention of plain text e-mails. It can therefore be
sent as a publication announcement e-mail without being reformatted.
Diffstat:
| M | README.md | | | 38 | ++++++++++++++++++++------------------ |
1 file changed, 20 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
@@ -1,15 +1,16 @@
# Star Unstructured Volumetric Mesh
-Star-UVM is a C library whose goal is to manage unstructured volumetric meshes
-defined by a soup of tetrahedra. Once spatially partitioned, the user can
-efficiently identify tetrahedra cut by an axis aligned box or access the
-specific tetrahedron that encompasses a given position.
-
-Only geometric data is processed by Star-UVM. No assumption is made on their
-associated properties. Either way, Star-UVM provides data, such as primitive
-indices and barycentric coordinates, needed to retrieve the properties attached
-to each tetrahedron. These properties can thus be managed externally without
-arbitrary constraints imposed by Star-UVM on their size, alignment or type.
+Star-UVM is a C library whose goal is to manage unstructured volumetric
+meshes defined by a soup of tetrahedra. Once spatially partitioned, the
+user can efficiently identify tetrahedra cut by an axis aligned box or
+access the specific tetrahedron that encompasses a given position.
+
+Only geometric data is processed by Star-UVM. No assumption is made on
+their associated properties. Either way, Star-UVM provides data, such as
+primitive indices and barycentric coordinates, needed to retrieve the
+properties attached to each tetrahedron. These properties can thus be
+managed externally without arbitrary constraints imposed by Star-UVM on
+their size, alignment or type.
## Requirements
@@ -30,14 +31,15 @@ Edit config.mk as needed, then run:
### Version 0.2
-Update of the acceleration data structure backend from Embree3 to Embree4
+Update of the acceleration data structure backend from Embree3 to
+Embree4
### Version 0.1
-- Add the `suvm_mesh_desc_compute_hash` function which uses sha256 encryption
- to calculate a digest from the mesh data.
-- Add the `suvm_get_mesh_desc` function that returns the mesh data, i.e. the
- list of node positions and the list of cell indexes.
+- Add the `suvm_mesh_desc_compute_hash` function which uses sha256
+ encryption to calculate a digest from the mesh data.
+- Add the `suvm_get_mesh_desc` function that returns the mesh data, i.e.
+ the list of node positions and the list of cell indexes.
- Replace the obsolete Star-Tetrahedra dependency with Star-Mesh.
- Work around a numerical inaccuracy of barycentric coordinates.
- Fix warnings detected by gcc 11.
@@ -46,6 +48,6 @@ Update of the acceleration data structure backend from Embree3 to Embree4
Copyright (C) 2020-2023 |Méso|Star> (contact@meso-star.com)
-Star-UVM is free software released under the GPL v3+ license: GNU GPL version 3
-or later. You are welcome to redistribute it under certain conditions; refer to
-the COPYING file for details.
+Star-UVM is free software released under the GPL v3+ license: GNU GPL
+version 3 or later. You are welcome to redistribute it under certain
+conditions; refer to the COPYING file for details.