t8_element_shape.h File Reference

TODO: comment. More...

#include <t8.h>
#include <t8_eclass.h>

Go to the source code of this file.

Macros
#define	T8_MPI_ELEMENT_SHAPE_TYPE
	The MPI datatype used for t8_element_shape_t. More...
#define	T8_ELEMENT_SHAPE_MAX_FACES   6
	The maximum number of boundary faces an element class can have.
#define	T8_ELEMENT_SHAPE_MAX_CORNERS   8
	The maximum number of cornes a 3-dimensional element class can have.

Typedefs
typedef t8_eclass_t	t8_element_shape_t
	Type definition for the geometric shape of an element. More...

Functions
int	t8_element_shape_num_faces (int element_shape)
	The number of codimension-one boundaries of an element class.
int	t8_element_shape_max_num_faces (int element_shape)
	For each dimension the maximum possible number of faces of an element_shape of that dimension.
int	t8_element_shape_num_vertices (int element_shape)
	The number of vertices of an element class.
int	t8_element_shape_vtk_type (int element_shape)
	The vtk cell type for the element_shape.
int	t8_element_shape_vtk_corner_number (int element_shape, int index)
	Maps the t8code corner number of the element to the vtk corner number.
const char *	t8_element_shape_to_string (int element_shape)
	For each element_shape, the name of this class as a string.
int	t8_element_shape_compare (t8_element_shape_t element_shape1, t8_element_shape_t element_shape2)
	Compare two element_shapees of the same dimension as necessary for face neighbor orientation. More...

Variables
const int	t8_element_shape_max_num_corner [T8_ECLASS_MAX_DIM+1]

Detailed Description

TODO: comment.

Macro Definition Documentation

T8_MPI_ELEMENT_SHAPE_TYPE

#define T8_MPI_ELEMENT_SHAPE_TYPE

Value:

  (T8_ASSERT (sizeof (int) == sizeof (t8_element_shape_t)),\
  sc_MPI_INT)

The MPI datatype used for t8_element_shape_t.

Typedef Documentation

t8_element_shape_t

typedef t8_eclass_t t8_element_shape_t

Type definition for the geometric shape of an element.

Currently the possible shapes are the same as the possible element classes. I.e. T8_ECLASS_VERTEX, T8_ECLASS_TET, etc...

Function Documentation

t8_element_shape_compare()

int t8_element_shape_compare	(	t8_element_shape_t	element_shape1,
		t8_element_shape_t	element_shape2
	)

Compare two element_shapees of the same dimension as necessary for face neighbor orientation.

The implemented order is Triangle < Square in 2D and Tet < Hex < Prism < Pyramid in 3D.

Parameters

[in]	element_shape1	The first element_shape to compare.
[in]	element_shape2	The second element_shape to compare.

Returns

0 if the element_shapees are equal, 1 if element_shape1 > element_shape2 and -1 if element_shape1 < element_shape2