libMesh::TetGenWrapper Class Reference

The TetGenWrapper provides an interface for basic access to TetGen data structures and methods. More...

#include <mesh_tetgen_wrapper.h>

Public Member Functions
	TetGenWrapper ()
	Constructor. More...
	~TetGenWrapper ()
	Destructor. More...
void	set_switches (std::string_view s)
	Method to set TetGen commandline switches -p Tetrahedralizes a piecewise linear complex (.poly or .smesh file). More...
void	run_tetgen ()
	Starts the triangulation. More...
int	get_numberoftetrahedra ()
int	get_numberoftrifaces ()
void	set_numberofpoints (int i)
	Sets the number of nodes in the TetGen input. More...
int	get_numberofpoints ()
void	set_numberoffacets (int i)
	Sets the number of facets in the TetGen input. More...
void	set_numberofholes (int i)
	Sets the number of holes in the TetGen input. More...
void	set_numberofregions (int i)
	Sets the number of regions in the TetGen input. More...
void	allocate_pointlist (int numofpoints)
	Allocates memory, sets number of nodes in the TetGen input. More...
void	allocate_facetlist (int numoffacets, int numofholes)
	Allocates memory, sets number of facets, holes in the TetGen input. More...
void	allocate_regionlist (int numofregions)
	Allocates memory, sets number of regions in the TetGen input. More...
void	set_node (unsigned i, REAL x, REAL y, REAL z)
	Sets coordinates of point i in the TetGen input. More...
void	get_output_node (unsigned i, REAL &x, REAL &y, REAL &z)
int	get_element_node (unsigned i, unsigned j)
int	get_triface_node (unsigned i, unsigned j)
REAL	get_element_attribute (unsigned i)
void	set_hole (unsigned i, REAL x, REAL y, REAL z)
	Sets coordinates of hole i in the TetGen input. More...
void	set_facet_numberofpolygons (unsigned i, int num)
	Sets the number of polygons for facet i in the TetGen input. More...
void	set_facet_numberofholes (unsigned i, int num)
	Sets the number of holes for facet i in the TetGen input. More...
void	allocate_facet_polygonlist (unsigned i, int numofpolygons)
	Allocates memory, sets number of polygons for facet i in the TetGen input. More...
void	set_polygon_numberofvertices (unsigned i, unsigned j, int num)
	Sets the number of vertices for polygon j, facet i in the TetGen input. More...
void	allocate_polygon_vertexlist (unsigned i, unsigned j, int numofvertices)
	Allocates memory, sets number of vertices for polygon j, facet i in the TetGen input. More...
void	set_vertex (unsigned i, unsigned j, unsigned k, int nodeindex)
	Sets index of ith facet, jth polygon, kth vertex in the TetGen input. More...
void	set_region (unsigned i, REAL x, REAL y, REAL z, REAL attribute, REAL vol_constraint)
	Sets coordinates, attribute, and volume constraint for region i in the TetGen input. More...

Public Attributes
tetgenio	tetgen_data
	TetGen input structure. More...
std::unique_ptr< tetgenio >	tetgen_output
	TetGen output structure. More...
tetgenmesh	tetgen_mesh
	TetGen mesh structure (from the TetGen library). More...
tetgenbehavior	tetgen_be
	TetGen control class (from the TetGen library). More...

Detailed Description

The TetGenWrapper provides an interface for basic access to TetGen data structures and methods.

Author

Steffen Petersen

Date

2004

Author

John W. Peterson

Date

2011

Definition at line 45 of file mesh_tetgen_wrapper.h.

Constructor & Destructor Documentation

TetGenWrapper()

libMesh::TetGenWrapper::TetGenWrapper

(

)

Constructor.

Definition at line 32 of file mesh_tetgen_wrapper.C.

References tetgen_data.

                             :
  tetgen_output(std::make_unique<tetgenio>())
{
  this->tetgen_data.mesh_dim                = 3;
  this->tetgen_data.numberofpointattributes = 0;
  this->tetgen_data.firstnumber             = 0;
}

~TetGenWrapper()

libMesh::TetGenWrapper::~TetGenWrapper ( )

default

Destructor.

Empty.

Member Function Documentation

allocate_facet_polygonlist()

void libMesh::TetGenWrapper::allocate_facet_polygonlist	(	unsigned	i,
		int	numofpolygons
	)

Allocates memory, sets number of polygons for facet i in the TetGen input.

Definition at line 275 of file mesh_tetgen_wrapper.C.

References set_facet_numberofholes(), set_facet_numberofpolygons(), and tetgen_data.

Referenced by libMesh::TetGenMeshInterface::triangulate_conformingDelaunayMesh_carvehole().

{
  this->set_facet_numberofpolygons(i, numofpolygons);
  this->set_facet_numberofholes(i, 0);

  // Don't try to create an array of size zero, this isn't portable
  if (numofpolygons > 0)
    {
      // Is there previously-allocated memory here?
      libmesh_error_msg_if(this->tetgen_data.facetlist[i].polygonlist != nullptr,
                           "Cannot allocate on top of previously allocated memory!");

      // We allocate memory here, the tetgenio destructor cleans it up.
      this->tetgen_data.facetlist[i].polygonlist = new tetgenio::polygon[numofpolygons];

      for (int j=0; j<this->tetgen_data.facetlist[i].numberofpolygons; j++)
        this->tetgen_data.init(&(this->tetgen_data.facetlist[i].polygonlist[j]));
    }
}

allocate_facetlist()

void libMesh::TetGenWrapper::allocate_facetlist	(	int	numoffacets,
		int	numofholes
	)

Allocates memory, sets number of facets, holes in the TetGen input.

Definition at line 206 of file mesh_tetgen_wrapper.C.

References set_numberoffacets(), set_numberofholes(), and tetgen_data.

Referenced by libMesh::TetGenMeshInterface::triangulate_conformingDelaunayMesh_carvehole().

{
  // These are both stored as ints in TetGen
  this->set_numberoffacets(numoffacets);
  this->set_numberofholes(numofholes);

  // Don't try to allocate an array of size zero, this is not portable...
  if (this->tetgen_data.numberoffacets > 0)
    {
      // Is there previously-allocated memory here?
      libmesh_error_msg_if(this->tetgen_data.facetlist != nullptr,
                           "Cannot allocate on top of previously allocated memory!");

      // We allocate memory here, the tetgenio destructor cleans it up.
      this->tetgen_data.facetlist = new tetgenio::facet[this->tetgen_data.numberoffacets];

      for (int i=0; i<numoffacets; i++)
        this->tetgen_data.init(&(this->tetgen_data.facetlist[i]));
    }


  // Don't try to allocate an array of size zero, this is not portable...
  if (this->tetgen_data.numberofholes > 0)
    {
      // Is there previously-allocated memory here?
      libmesh_error_msg_if(this->tetgen_data.holelist != nullptr,
                           "Cannot allocate on top of previously allocated memory!");

      this->tetgen_data.holelist = new REAL[this->tetgen_data.numberofholes * 3];
    }
}

allocate_pointlist()

void libMesh::TetGenWrapper::allocate_pointlist

(

int

numofpoints

)

Allocates memory, sets number of nodes in the TetGen input.

Definition at line 134 of file mesh_tetgen_wrapper.C.

References set_numberofpoints(), and tetgen_data.

Referenced by libMesh::TetGenMeshInterface::fill_pointlist().

{
  // This is stored as an int in tetgen, so we store it that way as well.
  this->set_numberofpoints(numofpoints);

  // Don't try to allocate an array of size zero, this is not portable...
  if (this->tetgen_data.numberofpoints > 0)
    {
      // Is there previously-allocated memory here?
      libmesh_error_msg_if(this->tetgen_data.pointlist != nullptr,
                           "Cannot allocate on top of previously allocated memory!");

      // We allocate memory here, the tetgenio destructor will delete it.
      this->tetgen_data.pointlist = new REAL[this->tetgen_data.numberofpoints * 3];
    }
}

allocate_polygon_vertexlist()

void libMesh::TetGenWrapper::allocate_polygon_vertexlist	(	unsigned	i,
		unsigned	j,
		int	numofvertices
	)

Allocates memory, sets number of vertices for polygon j, facet i in the TetGen input.

Definition at line 305 of file mesh_tetgen_wrapper.C.

References set_polygon_numberofvertices(), and tetgen_data.

Referenced by libMesh::TetGenMeshInterface::triangulate_conformingDelaunayMesh_carvehole().

{
  this->set_polygon_numberofvertices(i, j, numofvertices);

  // Don't try to create an array of size zero, this isn't portable
  if (numofvertices > 0)
    {
      // Is there previously-allocated memory here?
      libmesh_error_msg_if(this->tetgen_data.facetlist[i].polygonlist[j].vertexlist != nullptr,
                           "Cannot allocate on top of previously allocated memory!");

      // We allocate memory here, the tetgenio destructor cleans it up.
      this->tetgen_data.facetlist[i].polygonlist[j].vertexlist = new int[numofvertices];
    }
}

allocate_regionlist()

void libMesh::TetGenWrapper::allocate_regionlist

(

int

numofregions

)

Allocates memory, sets number of regions in the TetGen input.

Definition at line 240 of file mesh_tetgen_wrapper.C.

References set_numberofregions(), and tetgen_data.

{
  this->set_numberofregions(numofregions);

  // Don't try to allocate an array of size zero, this is not portable...
  if (this->tetgen_data.numberofregions > 0)
    {
      // Is there previously-allocated memory here?
      libmesh_error_msg_if(this->tetgen_data.regionlist != nullptr,
                           "Cannot allocate on top of previously allocated memory!");

      // We allocate memory here, the tetgenio destructor cleans it up.
      this->tetgen_data.regionlist = new REAL[this->tetgen_data.numberofregions * 5];
    }
}

get_element_attribute()

REAL libMesh::TetGenWrapper::get_element_attribute

(

unsigned

i

)

Returns

The attribute of element i in the TetGen output.

Definition at line 126 of file mesh_tetgen_wrapper.C.

References libMesh::libmesh_assert(), and tetgen_output.

{
  libmesh_assert(tetgen_output->numberoftetrahedronattributes>0);
  return tetgen_output->tetrahedronattributelist[tetgen_output->numberoftetrahedronattributes*i];
}

get_element_node()

int libMesh::TetGenWrapper::get_element_node	(	unsigned	i,
		unsigned	j
	)

Returns

The index of jth node from element i in the TetGen output.

Definition at line 112 of file mesh_tetgen_wrapper.C.

References tetgen_output.

Referenced by libMesh::TetGenMeshInterface::triangulate_conformingDelaunayMesh_carvehole(), and libMesh::TetGenMeshInterface::triangulate_pointset().

{
  return tetgen_output->tetrahedronlist[i*4+j];
}

get_numberofpoints()

int libMesh::TetGenWrapper::get_numberofpoints

(

)

Returns

Number of nodes in the TetGen output.

Definition at line 105 of file mesh_tetgen_wrapper.C.

References tetgen_output.

Referenced by libMesh::TetGenMeshInterface::triangulate_conformingDelaunayMesh_carvehole().

{
  return tetgen_output->numberofpoints;
}

get_numberoftetrahedra()

int libMesh::TetGenWrapper::get_numberoftetrahedra

(

)

Returns

Number of tetrahedra in the TetGen output.

Definition at line 91 of file mesh_tetgen_wrapper.C.

References tetgen_output.

Referenced by libMesh::TetGenMeshInterface::triangulate_conformingDelaunayMesh_carvehole(), and libMesh::TetGenMeshInterface::triangulate_pointset().

{
  return tetgen_output->numberoftetrahedra;
}

get_numberoftrifaces()

int libMesh::TetGenWrapper::get_numberoftrifaces

(

)

Returns

Number of triangle surface elements in the TetGen output.

Definition at line 98 of file mesh_tetgen_wrapper.C.

References tetgen_output.

Referenced by libMesh::TetGenMeshInterface::pointset_convexhull().

{
  return tetgen_output->numberoftrifaces;
}

get_output_node()

void libMesh::TetGenWrapper::get_output_node	(	unsigned	i,
		REAL &	x,
		REAL &	y,
		REAL &	z
	)

Returns

The coordinates of point i in the TetGen output.

Definition at line 74 of file mesh_tetgen_wrapper.C.

References tetgen_output.

Referenced by libMesh::TetGenMeshInterface::triangulate_conformingDelaunayMesh_carvehole().

{
  // Bounds checking...
  libmesh_error_msg_if(i >= static_cast<unsigned>(tetgen_output->numberofpoints),
                       "Error, requested point "
                       << i
                       << ", but there are only "
                       << tetgen_output->numberofpoints
                       << " points available.");

  x = tetgen_output->pointlist[3*i];
  y = tetgen_output->pointlist[3*i+1];
  z = tetgen_output->pointlist[3*i+2];
}

get_triface_node()

int libMesh::TetGenWrapper::get_triface_node	(	unsigned	i,
		unsigned	j
	)

Returns

The index of the jth node from surface triangle i in the TetGen output.

Definition at line 119 of file mesh_tetgen_wrapper.C.

References tetgen_output.

Referenced by libMesh::TetGenMeshInterface::pointset_convexhull().

{
  return tetgen_output->trifacelist[i*3+j];
}

run_tetgen()

void libMesh::TetGenWrapper::run_tetgen

(

)

Starts the triangulation.

Definition at line 174 of file mesh_tetgen_wrapper.C.

References tetgen_be, tetgen_data, and tetgen_output.

Referenced by libMesh::TetGenMeshInterface::pointset_convexhull(), libMesh::TetGenMeshInterface::triangulate_conformingDelaunayMesh_carvehole(), and libMesh::TetGenMeshInterface::triangulate_pointset().

{
  // Call tetrahedralize from the TetGen library.
  tetrahedralize(&tetgen_be, &tetgen_data, tetgen_output.get());
}

set_facet_numberofholes()

void libMesh::TetGenWrapper::set_facet_numberofholes	(	unsigned	i,
		int	num
	)

Sets the number of holes for facet i in the TetGen input.

Definition at line 266 of file mesh_tetgen_wrapper.C.

References tetgen_data.

Referenced by allocate_facet_polygonlist().

{
  // numberofholes is stored as an int in TetGen
  this->tetgen_data.facetlist[i].numberofholes = num;
}

set_facet_numberofpolygons()

void libMesh::TetGenWrapper::set_facet_numberofpolygons	(	unsigned	i,
		int	num
	)

Sets the number of polygons for facet i in the TetGen input.

Definition at line 258 of file mesh_tetgen_wrapper.C.

References tetgen_data.

Referenced by allocate_facet_polygonlist().

{
  // numberofpolygons is stored as an int in TetGen
  this->tetgen_data.facetlist[i].numberofpolygons = num;
}

set_hole()

void libMesh::TetGenWrapper::set_hole	(	unsigned	i,
		REAL	x,
		REAL	y,
		REAL	z
	)

Sets coordinates of hole i in the TetGen input.

Definition at line 56 of file mesh_tetgen_wrapper.C.

References tetgen_data.

Referenced by libMesh::TetGenMeshInterface::triangulate_conformingDelaunayMesh_carvehole().

{
  unsigned index = i*3;
  tetgen_data.holelist[index++] = x;
  tetgen_data.holelist[index++] = y;
  tetgen_data.holelist[index++] = z;
}

set_node()

void libMesh::TetGenWrapper::set_node	(	unsigned	i,
		REAL	x,
		REAL	y,
		REAL	z
	)

Sets coordinates of point i in the TetGen input.

Definition at line 46 of file mesh_tetgen_wrapper.C.

References tetgen_data.

Referenced by libMesh::TetGenMeshInterface::fill_pointlist().

{
  unsigned index = i*3;
  tetgen_data.pointlist[index++] = x;
  tetgen_data.pointlist[index++] = y;
  tetgen_data.pointlist[index++] = z;
}

set_numberoffacets()

void libMesh::TetGenWrapper::set_numberoffacets

(

int

i

)

Sets the number of facets in the TetGen input.

Definition at line 182 of file mesh_tetgen_wrapper.C.

References tetgen_data.

Referenced by allocate_facetlist().

{
  // This is stored as an int in TetGen
  this->tetgen_data.numberoffacets = i;
}

set_numberofholes()

void libMesh::TetGenWrapper::set_numberofholes

(

int

i

)

Sets the number of holes in the TetGen input.

Definition at line 190 of file mesh_tetgen_wrapper.C.

References tetgen_data.

Referenced by allocate_facetlist().

{
  // This is stored as an int in TetGen
  this->tetgen_data.numberofholes = i;
}

set_numberofpoints()

void libMesh::TetGenWrapper::set_numberofpoints

(

int

i

)

Sets the number of nodes in the TetGen input.

Definition at line 66 of file mesh_tetgen_wrapper.C.

References tetgen_data.

Referenced by allocate_pointlist().

{
  // This is an int in tetgen, so use an int here even though it should be unsigned
  tetgen_data.numberofpoints = i;
}

set_numberofregions()

void libMesh::TetGenWrapper::set_numberofregions

(

int

i

)

Sets the number of regions in the TetGen input.

Definition at line 198 of file mesh_tetgen_wrapper.C.

References tetgen_data.

Referenced by allocate_regionlist().

{
  // This is stored as an int in TetGen
  this->tetgen_data.numberofregions = i;
}

set_polygon_numberofvertices()

void libMesh::TetGenWrapper::set_polygon_numberofvertices	(	unsigned	i,
		unsigned	j,
		int	num
	)

Sets the number of vertices for polygon j, facet i in the TetGen input.

Definition at line 297 of file mesh_tetgen_wrapper.C.

References tetgen_data.

Referenced by allocate_polygon_vertexlist().

{
  // numberofvertices is stored as an int in TetGen
  this->tetgen_data.facetlist[i].polygonlist[j].numberofvertices = num;
}

set_region()

void libMesh::TetGenWrapper::set_region	(	unsigned	i,
		REAL	x,
		REAL	y,
		REAL	z,
		REAL	attribute,
		REAL	vol_constraint
	)

Sets coordinates, attribute, and volume constraint for region i in the TetGen input.

Note

Coordinates and attributes will only be considered if the corresponding switches are enabled. See TetGen documentation for more details.

Definition at line 332 of file mesh_tetgen_wrapper.C.

References tetgen_data.

{
  unsigned index = i*5;
  tetgen_data.regionlist[index++] = x;
  tetgen_data.regionlist[index++] = y;
  tetgen_data.regionlist[index++] = z;
  tetgen_data.regionlist[index++] = attribute;
  tetgen_data.regionlist[index++] = vol_constraint;
}

set_switches()

void libMesh::TetGenWrapper::set_switches

(

std::string_view

s

)

Method to set TetGen commandline switches -p Tetrahedralizes a piecewise linear complex (.poly or .smesh file).

-q Quality mesh generation. A minimum radius-edge ratio may be specified (default 2.0). -a Applies a maximum tetrahedron volume constraint. -A Assigns attributes to identify tetrahedra in certain regions. -r Reconstructs and Refines a previously generated mesh. -Y Suppresses boundary facets/segments splitting. -i Inserts a list of additional points into mesh. -M Does not merge coplanar facets. -T Set a tolerance for coplanar test (default 1e-8). -d Detect intersections of PLC facets. -z Numbers all output items starting from zero. -o2 Generates second-order subparametric elements. -f Outputs faces (including non-boundary faces) to .face file. -e Outputs subsegments to .edge file. -n Outputs tetrahedra neighbors to .neigh file. -g Outputs mesh to .mesh file for viewing by Medit. -G Outputs mesh to .msh file for viewing by Gid. -O Outputs mesh to .off file for viewing by Geomview. -J No jettison of unused vertices from output .node file. -B Suppresses output of boundary information. -N Suppresses output of .node file. -E Suppresses output of .ele file. -F Suppresses output of .face file. -I Suppresses mesh iteration numbers. -C Checks the consistency of the final mesh. -Q Quiet: No terminal output except errors. -V Verbose: Detailed information, more terminal output. -v Prints the version information. -h Help: A brief instruction for using TetGen.

Definition at line 153 of file mesh_tetgen_wrapper.C.

References libMesh::out, and tetgen_be.

Referenced by libMesh::TetGenMeshInterface::pointset_convexhull(), libMesh::TetGenMeshInterface::triangulate_conformingDelaunayMesh_carvehole(), and libMesh::TetGenMeshInterface::triangulate_pointset().

{
  // A temporary buffer for passing to the C API, it requires
  // a char *, not a const char *...
  char buffer[256];

  // Make sure char buffer has enough room
  libmesh_error_msg_if(s.size() >= sizeof(buffer)-1,
                       "Fixed size buffer of length "
                       << sizeof(buffer)
                       << " not large enough to hold TetGen switches.");

  // Copy the string, don't forget to terminate!
  buffer[ s.copy( buffer , sizeof( buffer ) - 1 ) ] = '\0' ;

  if (!tetgen_be.parse_commandline(buffer))
    libMesh::out << "TetGen replies: Wrong switches!" << std::endl;
}

set_vertex()

void libMesh::TetGenWrapper::set_vertex	(	unsigned	i,
		unsigned	j,
		unsigned	k,
		int	nodeindex
	)

Sets index of ith facet, jth polygon, kth vertex in the TetGen input.

Definition at line 324 of file mesh_tetgen_wrapper.C.

References tetgen_data.

Referenced by libMesh::TetGenMeshInterface::triangulate_conformingDelaunayMesh_carvehole().

{
  // vertexlist entries are stored as ints in TetGen
  this->tetgen_data.facetlist[i].polygonlist[j].vertexlist[k] = nodeindex;
}

Member Data Documentation

tetgen_be

tetgenbehavior libMesh::TetGenWrapper::tetgen_be

TetGen control class (from the TetGen library).

Definition at line 240 of file mesh_tetgen_wrapper.h.

Referenced by run_tetgen(), and set_switches().

tetgen_data

tetgenio libMesh::TetGenWrapper::tetgen_data

TetGen input structure.

Definition at line 225 of file mesh_tetgen_wrapper.h.

Referenced by allocate_facet_polygonlist(), allocate_facetlist(), allocate_pointlist(), allocate_polygon_vertexlist(), allocate_regionlist(), run_tetgen(), set_facet_numberofholes(), set_facet_numberofpolygons(), set_hole(), set_node(), set_numberoffacets(), set_numberofholes(), set_numberofpoints(), set_numberofregions(), set_polygon_numberofvertices(), set_region(), set_vertex(), and TetGenWrapper().

tetgen_mesh

tetgenmesh libMesh::TetGenWrapper::tetgen_mesh

TetGen mesh structure (from the TetGen library).

Definition at line 235 of file mesh_tetgen_wrapper.h.

tetgen_output

std::unique_ptr<tetgenio> libMesh::TetGenWrapper::tetgen_output

TetGen output structure.

Definition at line 230 of file mesh_tetgen_wrapper.h.

Referenced by get_element_attribute(), get_element_node(), get_numberofpoints(), get_numberoftetrahedra(), get_numberoftrifaces(), get_output_node(), get_triface_node(), and run_tetgen().

---

The documentation for this class was generated from the following files:

• include/mesh/mesh_tetgen_wrapper.h
• src/mesh/mesh_tetgen_wrapper.C