Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/dengwirda/jigsaw

JIGSAW is a Delaunay-based unstructured mesh generator for two- and three-dimensional geometries.
https://github.com/dengwirda/jigsaw

delaunay delaunay-refinement delaunay-triangulation laguerre-tessellation mesh mesh-generation scientific-computing triangulation voronoi voronoi-tessellation

Last synced: 3 months ago
JSON representation

JIGSAW is a Delaunay-based unstructured mesh generator for two- and three-dimensional geometries.

Awesome Lists containing this project

README 

          
## `JIGSAW: An unstructured mesh generator`





  

  

  

  




`JIGSAW` is an unstructured mesh generator and tessellation library; designed to generate high-quality triangulations and polyhedral decompositions of general planar, surface and volumetric domains. 



`JIGSAW` includes refinement-based algorithms for constructing new meshes, optimisation-driven techniques for improving existing grids, as well as routines to assemble (restricted) Delaunay tessellations, Voronoi complexes and Power diagrams. 



This package provides the underlying `c++` source for `JIGSAW`; defining a basic command-line interface and a `c`-format `API`. Higher-level scripting interfaces, supporting additional facilities for file I/O, mesh visualisation and post-processing operations are also available, including for `MATLAB` / `OCTAVE` here and for `PYTHON` here.



`JIGSAW` has been compiled and tested on various `64-bit` `Linux`, `Windows` and `MacOS` platforms using `>=c++17` versions of the `g++`, `clang++` and `msvc` compilers.



### `Code Structure`



`JIGSAW` is a header-only `c++` library. Both a basic command-line interface and a `c`-format `API` are defined:



      JIGSAW::

      ├── src -- JIGSAW src code

      ├── inc -- JIGSAW header files (for libjigsaw)

      ├── bin -- JIGSAW's exe binaries live here

      ├── lib -- JIGSAW's lib binaries live here

      ├── geo -- geometry definitions and input data

      ├── out -- default folder for JIGSAW output

      └── uni -- unit tests and libjigsaw example programs



### `Getting Started`



`JIGSAW` can be built using the `cmake` utility:



    Navigate to the root ../jigsaw/ directory.

    mkdir build && cd build

    cmake .. -DCMAKE_BUILD_TYPE=BUILD_MODE

    cmake --build . --config BUILD_MODE --target install EXTRAS

    

A set of executables and shared libraries is built: `jigsaw` itself - the main command-line meshing utility, `tripod` - `JIGSAW`'s tessellation infrastructure, `marche` - a fast-marching solver designed to optimise mesh-spacing configurations, as well as `libjigsaw` - `JIGSAW`'s shared `API`. 



`BUILD_MODE` can be used to select different compiler configurations (either `Release` or `Debug`). `EXTRAS` can be used to pass additional compile-time arguments, for example `-- -j4` will build in parallel on supported architectures.



See `example.jig` for documentation, as well as the headers in `../jigsaw/inc/` for details on the `API`.



### `cmd-line Examples`



After compiling the code, try running the following command-line example:



    /bin/jigsaw{.exe} example.jig



In this example, a high-quality tetrahedral mesh is generated for the `stanford-bunny` geometry. The input geometry is specified as a triangulated surface, and is read from `../jigsaw/geo/bunny.msh`. The volume and surface mesh outputs are written to `../jigsaw/out/bunny.msh`. See the `example.jig` text-file for a description of `JIGSAW`'s configuration options. 



A repository of additional surface models generated using `JIGSAW` can be found here. A description of the `*.jig` and `*.msh` input file formats can be found in the wiki.



### `libJIGSAW Scripts`



A set of unit-tests and `libjigsaw` example programs are contained in `../jigsaw/uni/`. The `JIGSAW-API` is documented via the header files in `../jigsaw/inc/`. 



The unit-tests can be built using the `cmake` utility:



    Navigate to the ../jigsaw/uni/ directory.

    mkdir build && cd build

    cmake .. -DCMAKE_BUILD_TYPE=BUILD_MODE

    cmake --build . --config BUILD_MODE --target install EXTRAS

    

This process will build the unit-tests as a set of executables in `../jigsaw/uni/`. `BUILD_MODE` is a compiler configuration flag (either `Release` or `Debug`). `EXTRAS` can be used to pass additional compile-time arguments.



### `Contributors`



1. [@dengwirda](https://github.com/dengwirda) is `JIGSAW`'s developer and maintainer.

2. [@xylar](https://github.com/xylar) contributed the `cmake` build system and `conda` environment.

3. [@tunnellm](https://github.com/tunnellm) extended the sequential optimisation algorithms to support thread-parallelism.



### `License`



This program may be freely redistributed under the condition that the copyright notices (including this entire header) are not removed, and no compensation is received through use of the software.  Private, research, and institutional use is free.  You may distribute modified versions of this code `UNDER THE CONDITION THAT THIS CODE AND ANY MODIFICATIONS MADE TO IT IN THE SAME FILE REMAIN UNDER COPYRIGHT OF THE ORIGINAL AUTHOR, BOTH SOURCE AND OBJECT CODE ARE MADE FREELY AVAILABLE WITHOUT CHARGE, AND CLEAR NOTICE IS GIVEN OF THE MODIFICATIONS`. Distribution of this code as part of a commercial system is permissible `ONLY BY DIRECT ARRANGEMENT WITH THE AUTHOR`. (If you are not directly supplying this code to a customer, and you are instead telling them how they can obtain it for free, then you are not required to make any arrangement with me.) 



`DISCLAIMER`: Neither I nor `THE CONTRIBUTORS` warrant this code in any way whatsoever.  This code is provided "as-is" to be used at your own risk.



`THE CONTRIBUTORS` include:

(a) The University of Sydney

(b) The Massachusetts Institute of Technology

(c) Columbia University

(d) The National Aeronautics & Space Administration

(e) Los Alamos National Laboratory



### `References`



There are a number of publications that describe the algorithms used in `JIGSAW` in detail. If you make use of `JIGSAW` in your work, please include references as appropriate:



`[1]` - Darren Engwirda: Generalised primal-dual grids for unstructured co-volume schemes, J. Comp. Phys., 375, pp. 155-176, https://doi.org/10.1016/j.jcp.2018.07.025, 2018.



`[2]` - Darren Engwirda, Conforming Restricted Delaunay Mesh Generation for Piecewise Smooth Complexes, Procedia Engineering, 163, pp. 84-96, https://doi.org/10.1016/j.proeng.2016.11.024, 2016.



`[3]` - Darren Engwirda, Voronoi-based Point-placement for Three-dimensional Delaunay-refinement, Procedia Engineering, 124, pp. 330-342, http://dx.doi.org/10.1016/j.proeng.2015.10.143, 2015.



`[4]` - Darren Engwirda, David Ivers, Off-centre Steiner points for Delaunay-refinement on curved surfaces, Computer-Aided Design, 72, pp. 157-171, http://dx.doi.org/10.1016/j.cad.2015.10.007, 2016.



`[5]` - Darren Engwirda, Locally-optimal Delaunay-refinement and optimisation-based mesh generation, Ph.D. Thesis, School of Mathematics and Statistics, The University of Sydney, http://hdl.handle.net/2123/13148, 2014.