Commit f60822b3 authored by BZoennchen's avatar BZoennchen

Update README.md

parent f7a384f6
Pipeline #109329 failed with stages
in 141 minutes and 53 seconds
...@@ -2,39 +2,38 @@ ...@@ -2,39 +2,38 @@
## Introduction ## Introduction
The eikmesh Java library is part of Vadere and was developed to generate high quality meshes for spatial discretization in the domain of pedestrian dynamics. The EikMesh Java library is part of Vadere and was developed to generate high quality meshes for spatial discretization in the domain of pedestrian dynamics.
We are especially interested in reducing the complexity of dynamic floor field computation which is one of our active research topics. We are especially interested in reducing the complexity of dynamic floor field computation which is one of our active research topics.
Computing a floor field involves the solution of the eikonal equation which led us to the name eikmesh. Computing a floor field involves the solution of the eikonal equation which led us to the name EikMesh.
Aside from the EikMesh algorithm, the library contains multiple algorithms and data structures to generate, change and use unstructured 2D triangular meshes. Aside from the EikMesh algorithm, the library contains multiple algorithms and data structures to generate, change and use unstructured 2D triangular meshes.
The library implements a generic version of the edge based half-edge data structure also called doubly connected edge list (DCEL). The library implements a generic version of the edge based half-edge data structure also called doubly connected edge list (DCEL).
User defined data types can be easily stored at and accessed via mesh elements (vertices, (half-)edges, faces / triangles). User defined data types can be easily stored at and accessed via mesh elements (vertices, (half-)edges, faces / triangles).
Given some mesh elements, adjacent elements can be accessed in O(1) time. Each generated mesh is conforming. Holes are supported. Given some mesh elements, adjacent elements can be accessed in O(1) time. Each generated mesh is conforming. Holes are supported.
The aim was to provide a fast, light and user-friendly meshing tool with parametric input, generic data types and advanced visualization capabilities. The aim was to provide a fast, light and user-friendly meshing tool with parametric input, generic data types and advanced visualization capabilities.
eikmesh generates The EikMesh library generates
- Delaunay triangulations (DT), - Delaunay triangulations (DT),
- constrained Delaunay triangulations (CDT), - constrained Delaunay triangulations (CDT),
- conforming Delaunay triangulations (CCDT), - conforming Delaunay triangulations (CCDT),
- Voronoi diagrams, and - Voronoi diagrams, and
- ****high-quality unstructured and conforming triangular meshes****. - ****high-quality unstructured and conforming triangular meshes****.
## EikMesh ## The EikMesh algorithm
The EikMesh mesh generator was described in [1](https://doi.org/10.1016/j.jocs.2018.09.009) and is heavily based on [DistMesh](http://persson.berkeley.edu/distmesh/) a simple and mesh generator (in MATLAB) which was developed by Per-Olof Persson and Gilbert Strang. The EikMesh algorithm was described in [1](https://doi.org/10.1016/j.jocs.2018.09.009) and is heavily based on [DistMesh](http://persson.berkeley.edu/distmesh/) a simple and mesh generator (in MATLAB) which was developed by Per-Olof Persson and Gilbert Strang.
EikMesh inherits from DistMesh its specification of the geometry via signed distance functions and the concept of iterative smoothing by converging towards a force equilibrium. EikMesh inherits from DistMesh its specification of the geometry via signed distance functions and the concept of iterative smoothing by converging towards a force equilibrium.
However, EikMesh completely avoids the computation of the Delaunay triangulation, generates a different and cache friendly initial triangulation and treats boundary elements more carefully. However, EikMesh completely avoids the computation of the Delaunay triangulation, generates a different and cache friendly initial triangulation and treats boundary elements more carefully.
Additionally, EikMesh supports geometries defined by a [segment bounded planar straight-line graphs](https://en.wikipedia.org/wiki/Planar_straight-line_graph) (PSLG). Additionally, EikMesh supports geometries defined by a [segment bounded planar straight-line graphs](https://en.wikipedia.org/wiki/Planar_straight-line_graph) (PSLG).
## Documentation ## Documentation
- User manuel: [eikmesh - a Java library for 2D unstructured triangular meshes](TODO) - User manuel: [documentation.pdf](http://www.vadere.org/documentation/eikmesh_manual_short.pdf) (offline manual), [Wiki](https://gitlab.lrz.de/vadere/vadere/wikis/eikmesh/Overview) (online manual)
- Publication: [A parallel generator for sparse unstructured meshes to solve the eikonal equation](https://doi.org/10.1016/j.jocs.2018.09.009) - Publication: [A parallel generator for sparse unstructured meshes to solve the eikonal equation](https://doi.org/10.1016/j.jocs.2018.09.009)
- [Wiki](https://gitlab.lrz.de/vadere/vadere/wikis/eikmesh/Overview): Learn how to use the mesh data structure, execute different meshing algorithms and EikMesh by examples. - Demos: [vadere.org](http://www.vadere.org/the-eikmesh-library/)
- Demos: [vadere.org](TODO)
## Download ## Download
The source code is available at [GitLab](https://gitlab.lrz.de/vadere/vadere/tree/master/VadereMeshing). The source code is available at [GitLab](https://gitlab.lrz.de/vadere/vadere/tree/master/VadereMeshing).
A pre-compiled version can be download [here](TODO). A pre-compiled version can be download [here](TODO).
eikmesh is part of [Vadere](http://www.vadere.org/) but can be used seperately. EikMesh is part of [Vadere](http://www.vadere.org/) but can be used seperately.
It is distributed under the LGPL license. It is distributed under the LGPL license.
\ No newline at end of file
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