                                                               2009-09-03
TriTetMesh
==========
TriTetMesh provides an intuitive interface to Triangle and Tetgen. These 
packages produces quality mesh in 2D and 3D based on triangles and 
tetrahedrons. The interface is provided as a C++/Python (through swig) 
wrapper.

Structure
---------
TriTetMesh is a package that includes TriMesh and TetMesh, which are 
the actuall wrappers of Triangle and Tetgen. These comes as standalone 
c++ libraries and python modules.

Mesh formats
------------
TriTetMesh can save generated mesh in the native format that both Triangle 
and Tetgen use and in the dolfin format. It can also read PLCs (see the 
documentation of tetgen) that tetgen natively can read.

Usage
-----
The documentation is sparse but for now there excists four demos, two c++
and two python demos that demonstrates the usage. To compile your own c++ 
mesh generator, you need to build and install tritetmesh. Then you use the 
produced pkg-config files to compile your program.

g++ -c your_main_file.cpp `pkg-config --cflags tritetmesh_[trimesh,tetmesh]`
g++ your_main_file.o `pkg-config --libs tritetmesh_[trimesh,tetmesh]` -o program

Before you use TriTetMesh you need to source the tritetmesh.conf file.

Triangle and Tetgen
===================
TriTetMesh provides a slightly modified copy of both triangle and tetgen. 
The modifications are all build related. All changes made to the provided 
files tetgen and triangle files remains under copyrights of the original 
authors. Look in the tetgen and triangle files for more information.

All published work that uses meshes generated from either triangle and/or 
tetgen are asked to cite the original papers. Look at the web pages for these 
two programs for more information:

Triangle <http://www.cs.cmu.edu/~quake/triangle.html>
Tetgen  <http://tetgen.berlios.de>

Installation
============
See INSTALL file


