TetWild

https://github.com/yixin-hu/tetwild
Admin
TetWild is a robust tetrahedral meshing software that takes a triangle surface mesh as input and...
Tokens:4,542
Snippets:47
Trust Score:6.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Check TetWild Installation

Source: https://github.com/yixin-hu/tetwild/blob/master/README.md

Verify the TetWild installation by running the executable with the --help flag. This should display a list of available parameters.

```bash
./TetWild --help
```

--------------------------------

### Installing the TetWild Executable

Source: https://github.com/yixin-hu/tetwild/blob/master/CMakeLists.txt

Installs the TetWild executable to the 'bin' directory at runtime.

```cmake
install(TARGETS TetWild RUNTIME DESTINATION bin)
```

--------------------------------

### Install CGAL via Homebrew

Source: https://github.com/yixin-hu/tetwild/blob/master/README.md

Alternatively, install the CGAL library using Homebrew, which may be required for compiling TetWild.

```bash
brew install cgal
```

--------------------------------

### TetWild C++ Function Wrapper Setup

Source: https://github.com/yixin-hu/tetwild/blob/master/README.md

This snippet demonstrates how to include the TetWild header and set up the arguments struct for the C++ function wrapper. Ensure you have libigl for mesh handling or load your mesh data manually.

```cpp
#include <tetwild/tetwild.h>

tetwild::Args args;
// Set parameters here, e.g.:
// args.postfix = "_custom";
// args.eps_rel = 1e-4;

// ... mesh data v_in, f_in ...
// tetwild::tetrahedralization(v_in, f_in, v_out, t_out, a_out, args);

```

--------------------------------

### TetWild Docker Installation and Usage

Source: https://github.com/yixin-hu/tetwild/blob/master/README.md

Installs TetWild using Docker and provides a command for running the binary with arguments. Note potential memory limitations with Docker.

```bash
docker pull yixinhu/tetwild
docker run --rm -v "$(pwd)":/data yixinhu/tetwild [TetWild arguments]
```

--------------------------------

### Install gmp and mpfr via Homebrew

Source: https://github.com/yixin-hu/tetwild/blob/master/README.md

Install the gmp and mpfr libraries using Homebrew, which may be required for compiling TetWild.

```bash
brew install gmp
brew install mpfr
```

--------------------------------

### Save Mid-Result Example

Source: https://github.com/yixin-hu/tetwild/blob/master/README.md

Use the `--save-mid-result 2` flag to output the surface of the tetmesh in .obj format, useful for visualizing intermediate results.

```bash
--save-mid-result 2
```

--------------------------------

### TetWild Command Line Usage

Source: https://github.com/yixin-hu/tetwild/blob/master/README.md

This snippet shows the general usage and available options for the TetWild command-line tool. It lists positional arguments for input and output files, as well as various options for controlling the meshing process.

```bash
RobustTetMeshing
Usage: ./TetWild [OPTIONS] input [output]

Positionals:
  input TEXT REQUIRED         Input surface mesh INPUT in .off/.obj/.stl/.ply format. (string, required)
  output TEXT                 Output tetmesh OUTPUT in .msh format. (string, optional, default: input_file+postfix+'.msh')

Options:
  -h,--help                   Print this help message and exit
  --input TEXT REQUIRED       Input surface mesh INPUT in .off/.obj/.stl/.ply format. (string, required)
  --output TEXT               Output tetmesh OUTPUT in .msh or .mesh format. (string, optional, default: input_file+postfix+'.msh')
  --postfix TEXT              Postfix P for output files. (string, optional, default: '_')
  -l,--ideal-edge-length FLOAT
                              ideal_edge_length = diag_of_bbox * L. (double, optional, default: 0.05)
  -e,--epsilon FLOAT          epsilon = diag_of_bbox * EPS. (double, optional, default: 1e-3)
  --stage INT                 Run pipeline in stage STAGE. (integer, optional, default: 1)
  --filter-energy FLOAT       Stop mesh improvement when the maximum energy is smaller than ENERGY. (double, optional, default: 10)
  --max-pass INT              Do PASS mesh improvement passes in maximum. (integer, optional, default: 80)
  --is-laplacian              Do Laplacian smoothing for the surface of output on the holes of input (optional)
  --targeted-num-v INT        Output tetmesh that contains TV vertices. (integer, optional, tolerance: 5%)
  --bg-mesh TEXT              Background tetmesh BGMESH in .msh format for applying sizing field. (string, optional)
  --save-mid-result           0: save result before optimization, 1: save mid-results during optimization, 2: save result without winding number.
  -q,--is-quiet               Mute console output. (optional)
  --log TEXT                  Log info to given file.
  --level INT                 Log level (0 = most verbose, 6 = off).

```

--------------------------------

### Building the TetWild Executable

Source: https://github.com/yixin-hu/tetwild/blob/master/CMakeLists.txt

Defines the main TetWild executable and links it against essential libraries and targets. Includes setting private include directories and copying CGAL DLLs.

```cmake
add_executable(TetWild src/main.cpp)
target_link_libraries(TetWild
	libTetWild
	CLI11::CLI11
	igl::cgal
	warnings::all
)
target_include_directories(TetWild PRIVATE src)
igl_copy_cgal_dll(TetWild)
```

--------------------------------

### Project Settings and Utilities

Source: https://github.com/yixin-hu/tetwild/blob/master/CMakeLists.txt

Configures project-wide settings such as the external directory path, enables colored output, sets Visual Studio folder properties, includes warning configurations, and enables export of compile commands for IDE integration.

```cmake
set(TETWILD_EXTERNAL "${CMAKE_CURRENT_SOURCE_DIR}/extern")

# Color output
include(UseColors)

# Use folder in Visual Studio
set_property(GLOBAL PROPERTY USE_FOLDERS ON)

# Extra warnings
include(Warnings)

# Export compile flags (used for autocompletion of the C++ code)
set(CMAKE_EXPORT_COMPILE_COMMANDS 1)

# Generate position independent code
set(CMAKE_POSITION_INDEPENDENT_CODE ON)
```

--------------------------------

### Configure libigl Library Options

Source: https://github.com/yixin-hu/tetwild/blob/master/CMakeLists.txt

Sets various options for the libigl library, controlling its build type (static/shared), and enabling/disabling support for different external libraries and features like CGAL, MATLAB, Python, and GUI elements.

```cmake
option(LIBIGL_USE_STATIC_LIBRARY "Use libigl as static library" OFF)
option(LIBIGL_WITH_ANTTWEAKBAR      "Use AntTweakBar"    OFF)
option(LIBIGL_WITH_CGAL             "Use CGAL"           ON)
option(LIBIGL_WITH_COMISO           "Use CoMiso"         OFF)
option(LIBIGL_WITH_CORK             "Use Cork"           OFF)
option(LIBIGL_WITH_LIM              "Use LIM"            OFF)
option(LIBIGL_WITH_MATLAB           "Use Matlab"         OFF)
option(LIBIGL_WITH_MOSEK            "Use MOSEK"          OFF)
option(LIBIGL_WITH_PNG              "Use PNG"            OFF)
option(LIBIGL_WITH_PYTHON           "Use Python"         OFF)
option(LIBIGL_WITH_TETGEN           "Use Tetgen"         OFF)
option(LIBIGL_WITH_TRIANGLE         "Use Triangle"       OFF)
option(LIBIGL_WITH_XML              "Use XML"            OFF)
option(LIBIGL_WITH_EMBREE           "Use Embree"         OFF)
option(LIBIGL_WITH_NANOGUI          "Use Nanogui menu"   OFF)
option(LIBIGL_WITH_OPENGL           "Use OpenGL"         OFF)
option(LIBIGL_WITH_OPENGL_GLFW      "Use GLFW"           OFF)
option(LIBIGL_WITH_VIEWER           "Use OpenGL viewer"  OFF)
```

--------------------------------

### Define libTetWild Static Library

Source: https://github.com/yixin-hu/tetwild/blob/master/CMakeLists.txt

Defines the main static library 'libTetWild' for the project, listing all its header and source files. It also specifies include directories and links against other libraries.

```cmake
add_library(libTetWild 
	include/tetwild/Args.h
	include/tetwild/Exception.h
	include/tetwild/Logger.h
	include/tetwild/tetwild.h
	src/tetwild/BSPSubdivision.cpp
	src/tetwild/BSPSubdivision.h
	src/tetwild/CGALTypes.h
	src/tetwild/Common.cpp
	src/tetwild/Common.h
	src/tetwild/DelaunayTetrahedralization.cpp
	src/tetwild/DelaunayTetrahedralization.h
	src/tetwild/DistanceQuery.cpp
	src/tetwild/DistanceQuery.h
	src/tetwild/EdgeCollapser.cpp
	src/tetwild/EdgeCollapser.h
	src/tetwild/EdgeRemover.cpp
	src/tetwild/EdgeRemover.h
	src/tetwild/EdgeSplitter.cpp
	src/tetwild/EdgeSplitter.h
	src/tetwild/ForwardDecls.h
	src/tetwild/InoutFiltering.cpp
	src/tetwild/InoutFiltering.h
	src/tetwild/LocalOperations.cpp
	src/tetwild/LocalOperations.h
	src/tetwild/Logger.cpp
	src/tetwild/MeshConformer.cpp
	src/tetwild/MeshConformer.h
	src/tetwild/MeshRefinement.cpp
	src/tetwild/MeshRefinement.h
	src/tetwild/Preprocess.cpp
	src/tetwild/Preprocess.h
	src/tetwild/SimpleTetrahedralization.cpp
	src/tetwild/SimpleTetrahedralization.h
	src/tetwild/State.cpp
	src/tetwild/State.h
	src/tetwild/TetmeshElements.cpp
	src/tetwild/TetmeshElements.h
	src/tetwild/tetwild.cpp
	src/tetwild/VertexSmoother.cpp
	src/tetwild/VertexSmoother.h
	src/tetwild/geogram/mesh_AABB.cpp
	src/tetwild/geogram/mesh_AABB.h
)
target_include_directories(libTetWild
	PRIVATE
		src
	PUBLIC
		include
)
target_link_libraries(libTetWild
	PUBLIC
		geogram
		igl::core
		pymesh::pymesh
		spdlog::spdlog
	PRIVATE
		igl::cgal
		warnings::all
)
set_target_properties(libTetWild PROPERTIES OUTPUT_NAME "tetwild")
```

--------------------------------

### Project Name and Build Type Configuration

Source: https://github.com/yixin-hu/tetwild/blob/master/CMakeLists.txt

Sets the project name to 'TetWild' and ensures a build type (e.g., Debug, Release) is set, defaulting to 'Release' if none is specified.

```cmake
project(TetWild)

if(NOT CMAKE_BUILD_TYPE)
	message(STATUS "No build type selected, default to Release")
	set(CMAKE_BUILD_TYPE "Release")
endif()
```

--------------------------------

### Compile TetWild with CMake

Source: https://github.com/yixin-hu/tetwild/blob/master/README.md

Compile the TetWild code using CMake. This process involves creating a build directory, configuring the build with CMake, and then compiling the project.

```bash
cd TetWild
mkdir build
cd build
cmake ..
make
```

--------------------------------

### Clone TetWild Repository

Source: https://github.com/yixin-hu/tetwild/blob/master/README.md

Clone the TetWild repository from GitHub to your local machine.

```bash
git clone https://github.com/Yixin-Hu/TetWild
```

--------------------------------

### Link PyMesh Tiny with igl_common

Source: https://github.com/yixin-hu/tetwild/blob/master/extern/pymesh/CMakeLists.txt

Links the 'pymesh_tiny' library against 'igl_common'. This makes Eigen and C++11 features available to PyMesh.

```cmake
target_link_libraries(pymesh_tiny PUBLIC igl_common)
```

--------------------------------

### Configure TetWild Options

Source: https://github.com/yixin-hu/tetwild/blob/master/CMakeLists.txt

Defines build options for TetWild, such as enabling Hunter for dependency management and ISPC support. These options control various features and external library integrations.

```cmake
option(TETWILD_WITH_HUNTER "Use Hunter to download and configure Boost" OFF)
option(TETWILD_WITH_ISPC   "Use ISPC"                                   OFF)
```

--------------------------------

### Define PyMesh Tiny Library

Source: https://github.com/yixin-hu/tetwild/blob/master/extern/pymesh/CMakeLists.txt

Defines the 'pymesh_tiny' static library, listing its header and source files. This is the core build unit for PyMesh.

```cmake
add_library(pymesh_tiny
		MshLoader.h
		MshLoader.cpp
		MshSaver.h
		MshSaver.cpp
		Exception.h
)
```

--------------------------------

### Set Minimum CMake Version and Module Path

Source: https://github.com/yixin-hu/tetwild/blob/master/CMakeLists.txt

Specifies the minimum required CMake version and appends the local cmake directory to the module path for custom modules.

```cmake
cmake_minimum_required(VERSION 3.3)
list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
```

--------------------------------

### Include Directories for PyMesh Tiny

Source: https://github.com/yixin-hu/tetwild/blob/master/extern/pymesh/CMakeLists.txt

Specifies public include directories for the 'pymesh_tiny' target. This ensures that headers from the parent directory are accessible during compilation.

```cmake
target_include_directories(pymesh_tiny PUBLIC ..)
```

--------------------------------

### Include Third-Party Dependencies

Source: https://github.com/yixin-hu/tetwild/blob/master/CMakeLists.txt

Includes the TetWildDependencies CMake module, which is responsible for finding and configuring external libraries required by the project.

```cmake
include(TetWildDependencies)
```

--------------------------------

### Configure Geogram Library Options

Source: https://github.com/yixin-hu/tetwild/blob/master/CMakeLists.txt

Sets options for the Geogram library, specifically controlling its support for the Triangle library.

```cmake
option(GEOGRAM_WITH_TRIANGLE        "Use Triangle"       OFF)
```

--------------------------------

### Hunter Integration for Dependencies

Source: https://github.com/yixin-hu/tetwild/blob/master/CMakeLists.txt

Includes the Hunter package manager if TETWILD_WITH_HUNTER is enabled. This is used for downloading and configuring external dependencies like Boost.

```cmake
if(TETWILD_WITH_HUNTER)
	include(HunterGate)
	HunterGate(
		URL "https://github.com/ruslo/hunter/archive/v0.23.25.tar.gz"
		SHA1 "cb75cce9a3a8d552e70e7118f3203eb4ac05c201"
	)
endif()
```

--------------------------------

### Setting IDE Folder Properties for PyMesh

Source: https://github.com/yixin-hu/tetwild/blob/master/CMakeLists.txt

Organizes PyMesh-related targets into a dedicated folder within IDEs like Visual Studio or XCode for better project structure.

```cmake
set_target_properties(pymesh_tiny PROPERTIES FOLDER extern/pymesh)
```

--------------------------------

### Create PyMesh Alias Target

Source: https://github.com/yixin-hu/tetwild/blob/master/extern/pymesh/CMakeLists.txt

Creates an alias target 'pymesh::pymesh' that points to 'pymesh_tiny'. This provides a modern CMake interface for linking against PyMesh.

```cmake
add_library(pymesh::pymesh ALIAS pymesh_tiny)
```

--------------------------------

### Conditional ISPC Compilation

Source: https://github.com/yixin-hu/tetwild/blob/master/CMakeLists.txt

Conditionally compiles energy-related code using ISPC if the TETWILD_WITH_ISPC flag is enabled. Requires the ISPC compiler to be available.

```cmake
if(TETWILD_WITH_ISPC)
	message(STATUS "Compiling energy with ISPC")
	add_subdirectory(src/ispc)
	ispc_add_energy(libTetWild)
endif()
```

--------------------------------

### Setting IDE Folder Properties for Geogram

Source: https://github.com/yixin-hu/tetwild/blob/master/CMakeLists.txt

Organizes Geogram-related targets into a dedicated folder within IDEs like Visual Studio or XCode for better project structure.

```cmake
set_target_properties(geogram PROPERTIES FOLDER extern/geogram)
set_target_properties(geogram_third_party PROPERTIES FOLDER extern/geogram)
set_target_properties(uninstall PROPERTIES FOLDER extern/geogram)
```

--------------------------------

### Add ISPC Compiled Objects to Target

Source: https://github.com/yixin-hu/tetwild/blob/master/src/ispc/CMakeLists.txt

Defines a CMake function to add ISPC-compiled source files to a target. It generates C++ header and object files from an ISPC source file and links them to the specified target.

```cmake
function(ispc_add_energy target_name)
	# Compilation flags for ISPC
	if(CMAKE_BUILD_TYPE MATCHES Release)
		set(TETWILD_ISPC_FLAGS "")
	else()
		set(TETWILD_ISPC_FLAGS "-g")
	endif()

	add_custom_command(
		COMMAND
			ispc --pic --target=host ${TETWILD_ISPC_FLAGS}
				${tetwild_ispc__internal_dir}/energy.ispc
				-h ${tetwild_ispc__internal_dir}/energy.h
				-o ${CMAKE_CURRENT_BINARY_DIR}/energy_ispc.o
		DEPENDS
			${tetwild_ispc__internal_dir}/energy.ispc
		OUTPUT
			${tetwild_ispc__internal_dir}/energy.h
			${CMAKE_CURRENT_BINARY_DIR}/energy_ispc.o
	)

	target_sources(${target_name} PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/energy_ispc.o)
	target_compile_definitions(${target_name} PUBLIC -DTETWILD_WITH_ISPC)
	target_include_directories(${target_name} PUBLIC ${tetwild_ispc__internal_dir}/..)
endfunction()
```

--------------------------------

### Define ISPC Compilation Flags

Source: https://github.com/yixin-hu/tetwild/blob/master/src/ispc/CMakeLists.txt

Sets ISPC compilation flags based on the CMake build type. Debug flags are enabled for non-release builds.

```cmake
if(CMAKE_BUILD_TYPE MATCHES Release)
		set(TETWILD_ISPC_FLAGS "")
	else()
		set(TETWILD_ISPC_FLAGS "-g")
	endif()
```
Tokens:
Raw