Definitions of tet-specific functions. More...

#include <t8_element.h>
#include <t8_schemes/t8_default/t8_default_tet/t8_dtet.h>

Functions
void	t8_dtet_compute_coords (const t8_dtet_t *elem, int vertex, t8_dtet_coord_t coordinates[3])
	Compute the coordinates of a vertex of a tetrahedron. More...

void	t8_dtet_compute_vertex_ref_coords (const t8_dtet_t *elem, int vertex, double coordinates[3])
	Compute the coordinates of a vertex of a tetrahedron when the tree (level 0 tetrahedron) is embedded in [0,1]^3. More...

void	t8_dtet_compute_all_coords (const t8_dtet_t *elem, t8_dtet_coord_t coordinates[4][3])
	Compute the coordinates of the four vertices of a tetrahedron. More...

void	t8_dtet_copy (const t8_dtet_t t, t8_dtet_t dest)
	Copy the values of one tetrahedron to another. More...

int	t8_dtet_compare (const t8_dtet_t t1, const t8_dtet_t t2)
	Compare two tets in their linear order. More...

void	t8_dtet_parent (const t8_dtet_t t, t8_dtet_t parent)
	Compute the parent of a tetrahedron. More...

void	t8_dtet_ancestor (const t8_dtet_t t, int level, t8_dtet_t ancestor)
	Compute the ancestor of a tetrahedron at a given level. More...

void	t8_dtet_child (const t8_dtet_t elem, int childid, t8_dtet_t child)
	Compute the childid-th child in Morton order of a tetrahedron t. More...

void	t8_dtet_childrenpv (const t8_dtet_t t, t8_dtet_t c[T8_DTET_CHILDREN])
	Compute the 8 children of a tetrahedron, array version. More...

int	t8_dtet_is_familypv (const t8_dtet_t *f[])
	Check whether a collection of eight tetrahedra is a family in Morton order. More...

void	t8_dtet_sibling (const t8_dtet_t elem, int sibid, t8_dtet_t sibling)
	Compute a specific sibling of a tetrahedron. More...

int	t8_dtet_face_neighbour (const t8_dtet_t t, int face, t8_dtet_t n)
	Compute the face neighbor of a tetrahedron. More...

void	t8_dtet_nearest_common_ancestor (const t8_dtet_t t1, const t8_dtet_t t2, t8_dtet_t *r)
	Computes the nearest common ancestor of two tetrahedra in the same tree. More...

void	t8_dtet_children_at_face (const t8_dtet_t tet, int face, t8_dtet_t children[], int num_children, int *child_indices)
	Given a tetrahedron and a face of the tetrahedron, compute all children of the tetrahedron that touch the face. More...

int	t8_dtet_face_child_face (const t8_dtet_t *tet, int face, int face_child)
	Given a face of an tetrahedron and a child number of a child of that face, return the face number of the child of the tetrahedron that matches the child face. More...

int	t8_dtet_face_parent_face (const t8_dtet_t *tet, int face)
	Given a face of an tet return the face number of the parent of the tet that matches the tet's face. More...

int	t8_dtet_tree_face (t8_dtet_t *t, int face)
	Given a tetrahedron and a face of this tetrahedron. More...

int	t8_dtet_root_face_to_face (t8_dtet_t *t, int root_face)
	Given a tetrahedron and a face of the root tetrahedron. More...

int	t8_dtet_is_inside_root (t8_dtet_t *t)
	Test if a tetrahedron lies inside of the root tetrahedron, that is the tetrahedron of level 0, anchor node (0,0,0) and type 0. More...

int	t8_dtet_is_root_boundary (const t8_dtet_t *t, int face)
	Compute whether a given tetrahedron shares a given face with its root tree. More...

int	t8_dtet_is_equal (const t8_dtet_t t1, const t8_dtet_t t2)
	Test if two tetrahedra have the same coordinates, type and level. More...

int	t8_dtet_is_sibling (const t8_dtet_t t1, const t8_dtet_t t2)
	Test if two tetrahedra are siblings. More...

int	t8_dtet_is_parent (const t8_dtet_t t, const t8_dtet_t c)
	Test if a tetrahedron is the parent of another tetrahedron. More...

int	t8_dtet_is_ancestor (const t8_dtet_t t, const t8_dtet_t c)
	Test if a tetrahedron is an ancestor of another tetrahedron. More...

t8_linearidx_t	t8_dtet_linear_id (const t8_dtet_t *t, int level)
	Computes the linear position of a tetrahedron in a uniform grid. More...

void	t8_dtet_init_linear_id_with_level (t8_dtet_t *t, t8_linearidx_t id, int start_level, int end_level, t8_dtet_type_t parenttype)
	Same as init_linear_id, but we only consider the subtree. More...

void	t8_dtet_init_linear_id (t8_dtet_t *t, t8_linearidx_t id, int level)
	Initialize a tetrahedron as the tetrahedron with a given global id in a uniform refinement of a given level. More...

void	t8_dtet_init_root (t8_dtet_t *t)
	Initialize a tetrahedron as the root tetrahedron (type 0 at level 0) More...

void	t8_dtet_successor (const t8_dtet_t t, t8_dtet_t s, int level)
	Computes the successor of a tetrahedron in a uniform grid of level level. More...

void	t8_dtet_first_descendant (const t8_dtet_t t, t8_dtet_t s, int level)
	Compute the first descendant of a tetrahedron at a given level. More...

void	t8_dtet_last_descendant (const t8_dtet_t t, t8_dtet_t s, int level)
	Compute the last descendant of a tetrahedron at a given level. More...

void	t8_dtet_corner_descendant (const t8_dtet_t t, t8_dtet_t s, int corner, int level)
	Compute the descendant of a tetrahedron in a given corner. More...

void	t8_dtet_predecessor (const t8_dtet_t t, t8_dtet_t s, int level)
	Computes the predecessor of a tetrahedron in a uniform grid of level level. More...

int	t8_dtet_ancestor_id (const t8_dtet_t *t, int level)
	Compute the position of the ancestor of this child at level level within its siblings. More...

int	t8_dtet_child_id (const t8_dtet_t *t)
	Compute the position of the ancestor of this child at level level within its siblings. More...

int	t8_dtet_get_level (const t8_dtet_t *t)
	Return the level of a tetrahedron. More...

int	t8_dtet_is_valid (const t8_dtet_t *t)
	Query whether all entries of a tet are in valid ranges. More...

void	t8_dtet_debug_print (const t8_dtet_t *t)

void	t8_dtet_init (t8_dtet_t *t)
	Set sensible default values for a tet. More...

Detailed Description

Definitions of tet-specific functions.

TODO: Run make doxygen and grep for files. Also document all arguments of functions. TODO: Group the dtet_is functions together.

Function Documentation

◆ t8_dtet_ancestor()

void t8_dtet_ancestor	(	const t8_dtet_t *	t,
		int	level,
		t8_dtet_t *	ancestor
	)

Compute the ancestor of a tetrahedron at a given level.

Parameters

[in]	t	Input tetrahedron.
[in]	level	A smaller level than t.
[in,out]	ancestor	Existing tetrahedron whose data will be filled with the data of t's ancestor on level level.

Note: The tetrahedron ancestor may point to the same tetrahedron as t.

◆ t8_dtet_ancestor_id()

int t8_dtet_ancestor_id	(	const t8_dtet_t *	t,
		int	level
	)

Compute the position of the ancestor of this child at level level within its siblings.

Parameters

[in]	t	tetrahedron to be considered.
[in]	level	level to be considered.

Returns: Returns its child id in 0..7

◆ t8_dtet_child()

void t8_dtet_child	(	const t8_dtet_t *	elem,
		int	childid,
		t8_dtet_t *	child
	)

Compute the childid-th child in Morton order of a tetrahedron t.

Parameters

[in]	t	Input tetrahedron.
[in,out]	childid	The id of the child, 0..7 in Bey order.
[out]	child	Existing tetrahedron whose data will be filled with the date of t's childid-th child.

◆ t8_dtet_child_id()

int t8_dtet_child_id ( const t8_dtet_t * t )

Compute the position of the ancestor of this child at level level within its siblings.

Parameters

[in] t tetrahedron to be considered.

Returns: Returns its child id in 0..7

◆ t8_dtet_children_at_face()

void t8_dtet_children_at_face	(	const t8_dtet_t *	tet,
		int	face,
		t8_dtet_t *	children[],
		int	num_children,
		int *	child_indices
	)

Given a tetrahedron and a face of the tetrahedron, compute all children of the tetrahedron that touch the face.

Parameters

[in]	tet	The tetrahedron.
[in]	face	A face of tet.
[in,out]	children	Allocated tetrahedra, in which the children of tet that share a face with face are stored. They will be stored in order of their child_id.
[in]	num_children	The number of tetrahedra in children. Must match the number of children that touch face.

◆ t8_dtet_childrenpv()

void t8_dtet_childrenpv	(	const t8_dtet_t *	t,
		t8_dtet_t *	c[T8_DTET_CHILDREN]
	)

Compute the 8 children of a tetrahedron, array version.

Parameters

[in]	t	Input tetrahedron.
[in,out]	c	Pointers to the 8 computed children in Morton order. t may point to the same quadrant as c[0].

◆ t8_dtet_compare()

int t8_dtet_compare	(	const t8_dtet_t *	t1,
		const t8_dtet_t *	t2
	)

Compare two tets in their linear order.

Parameters

[in]	t1	Tetrahedron one.
[in]	t2	Tetrahedron two.

Returns: Returns negativ if t1 < t2, zero if t1 = t2, positive if t1 > t2

◆ t8_dtet_compute_all_coords()

void t8_dtet_compute_all_coords	(	const t8_dtet_t *	elem,
		t8_dtet_coord_t	coordinates[4][3]
	)

Compute the coordinates of the four vertices of a tetrahedron.

Parameters

[in]	elem	Input tetrahedron.
[out]	coordinates	An array of 4x3 t8_dtet_coord_t that will be filled with the coordinates of t's vertices.

◆ t8_dtet_compute_coords()

void t8_dtet_compute_coords	(	const t8_dtet_t *	elem,
		int	vertex,
		t8_dtet_coord_t	coordinates[3]
	)

Compute the coordinates of a vertex of a tetrahedron.

Parameters

[in]	t	Input tetrahedron.
[in]	vertex	The number of the vertex.
[out]	coordinates	An array of 3 t8_dtet_coord_t that will be filled with the coordinates of the vertex.

◆ t8_dtet_compute_vertex_ref_coords()

void t8_dtet_compute_vertex_ref_coords	(	const t8_dtet_t *	elem,
		int	vertex,
		double	coordinates[3]
	)

Compute the coordinates of a vertex of a tetrahedron when the tree (level 0 tetrahedron) is embedded in [0,1]^3.

Parameters

[in]	elem	Input tetrahedron.
[in]	vertex	The number of the vertex.
[out]	coordinates	An array of 3 double that will be filled with the reference coordinates of the vertex.

◆ t8_dtet_copy()

void t8_dtet_copy	(	const t8_dtet_t *	t,
		t8_dtet_t *	dest
	)

Copy the values of one tetrahedron to another.

Parameters

[in]	t	Tetrahedron whose values will be copied.
[in,out]	dest	Existing tetrahedron whose data will be filled with the data of t. *

◆ t8_dtet_corner_descendant()

void t8_dtet_corner_descendant	(	const t8_dtet_t *	t,
		t8_dtet_t *	s,
		int	corner,
		int	level
	)

Compute the descendant of a tetrahedron in a given corner.

Parameters

[in]	t	Tetrahedron whose descendant is computed.
[out]	s	Existing tetrahedron whose data will be filled with the data of t's descendant in corner.
[in]	corner	The corner in which the descendant should lie.
[in]	level	The refinement level of the descendant. Must be greater or equal to t's level.

◆ t8_dtet_face_child_face()

int t8_dtet_face_child_face	(	const t8_dtet_t *	tet,
		int	face,
		int	face_child
	)

Given a face of an tetrahedron and a child number of a child of that face, return the face number of the child of the tetrahedron that matches the child face.

Parameters

[in]	tet	The tetrahedron.
[in]	face	Then number of the face.
[in]	face_child	The child number of a child of the face tetrahedron.

Returns: The face number of the face of a child of tetrahedron that conincides with face_child.

◆ t8_dtet_face_neighbour()

int t8_dtet_face_neighbour	(	const t8_dtet_t *	t,
		int	face,
		t8_dtet_t *	n
	)

Compute the face neighbor of a tetrahedron.

Parameters

[in]	t	Input tetrahedron.
[in]	face	The face across which to generate the neighbor.
[in,out]	n	Existing tetrahedron whose data will be filled.

Note: t may point to the same tetrahedron as n.

◆ t8_dtet_face_parent_face()

int t8_dtet_face_parent_face	(	const t8_dtet_t *	tet,
		int	face
	)

Given a face of an tet return the face number of the parent of the tet that matches the tet's face.

Or return -1 if no face of the parent matches the face.

Parameters

[in]	elem	The tet.
[in]	face	Then number of the face.

Returns: If face of elem is also a face of elem's parent, the face number of this face. Otherwise -1.

◆ t8_dtet_first_descendant()

void t8_dtet_first_descendant	(	const t8_dtet_t *	t,
		t8_dtet_t *	s,
		int	level
	)

Compute the first descendant of a tetrahedron at a given level.

This is the descendant of the tetrahedron in a uniform maxlevel refinement that has the smaller id.

Parameters

[in]	t	tetrahedron whose descendant is computed.
[in]	level	A given level. Must be greater or equal to t's level.
[out]	s	Existing tetrahedron whose data will be filled with the data of t's first descendant.

◆ t8_dtet_get_level()

int t8_dtet_get_level ( const t8_dtet_t * t )

Return the level of a tetrahedron.

Parameters

[in] t tetrahedron to be considered.

Returns: The level of t.

◆ t8_dtet_init()

void t8_dtet_init ( t8_dtet_t * t )

Set sensible default values for a tet.

Parameters

[in,out] t A tet.

◆ t8_dtet_init_linear_id()

void t8_dtet_init_linear_id	(	t8_dtet_t *	t,
		t8_linearidx_t	id,
		int	level
	)

Initialize a tetrahedron as the tetrahedron with a given global id in a uniform refinement of a given level.

Parameters

[in,out] t Existing tetrahedron whose data will be filled.

[in] id Index to be considered.

[in] level level of uniform grid to be considered.

◆ t8_dtet_init_linear_id_with_level()

void t8_dtet_init_linear_id_with_level	(	t8_dtet_t *	t,
		t8_linearidx_t	id,
		int	start_level,
		int	end_level,
		t8_dtet_type_t	parenttype
	)

Same as init_linear_id, but we only consider the subtree.

Used for computing the index of a tetrahedron lying in a pyramid

Parameters

[in,out]	t	Existing triangle whose data will be filled
	id	Index to be considered
	start_level	The level of the root of the subtree
	end_level	Level of uniform grid to be considered
	parenttype	The type of the parent.

◆ t8_dtet_init_root()

void t8_dtet_init_root ( t8_dtet_t * t )

Initialize a tetrahedron as the root tetrahedron (type 0 at level 0)

Parameters

[in,out] t Existing tetrahedron whose data will be filled.

◆ t8_dtet_is_ancestor()

int t8_dtet_is_ancestor	(	const t8_dtet_t *	t,
		const t8_dtet_t *	c
	)

Test if a tetrahedron is an ancestor of another tetrahedron.

Parameters

[in]	t	tetrahedron to be tested.
[in]	c	Descendent tetrahedron.

Returns: true if t is equal to or an ancestor of c.

◆ t8_dtet_is_equal()

int t8_dtet_is_equal	(	const t8_dtet_t *	t1,
		const t8_dtet_t *	t2
	)

Test if two tetrahedra have the same coordinates, type and level.

Returns: true if t1 describes the same tetrahedron as t2.

◆ t8_dtet_is_familypv()

int t8_dtet_is_familypv ( const t8_dtet_t * f[] )

Check whether a collection of eight tetrahedra is a family in Morton order.

Parameters

[in] f An array of eight tetrahedra.

Returns: Nonzero if f is a family of tetrahedra.

◆ t8_dtet_is_inside_root()

int t8_dtet_is_inside_root ( t8_dtet_t * t )

Test if a tetrahedron lies inside of the root tetrahedron, that is the tetrahedron of level 0, anchor node (0,0,0) and type 0.

Parameters

[in] t Input tetrahedron.

Returns: true If t lies inside of the root tetrahedron.

◆ t8_dtet_is_parent()

int t8_dtet_is_parent	(	const t8_dtet_t *	t,
		const t8_dtet_t *	c
	)

Test if a tetrahedron is the parent of another tetrahedron.

Parameters

[in]	t	tetrahedron to be tested.
[in]	c	Possible child tetrahedron.

Returns: true if t is the parent of c.

◆ t8_dtet_is_root_boundary()

int t8_dtet_is_root_boundary	(	const t8_dtet_t *	t,
		int	face
	)

Compute whether a given tetrahedron shares a given face with its root tree.

Parameters

[in]	t	The input tet.
[in]	face	A face of t.

Returns: True if face is a subface of the tet's root element.

◆ t8_dtet_is_sibling()

int t8_dtet_is_sibling	(	const t8_dtet_t *	t1,
		const t8_dtet_t *	t2
	)

Test if two tetrahedra are siblings.

Parameters

[in]	t1	First tetrahedron to be tested.
[in]	t2	Second tetrahedron to be tested.

Returns: true if t1 is equal to or a sibling of t2.

◆ t8_dtet_is_valid()

int t8_dtet_is_valid ( const t8_dtet_t * t )

Query whether all entries of a tet are in valid ranges.

Parameters

[in] t tet to be considered.

Returns: True, if t is a valid tet and it is safe to call any function on t. False otherwise.

◆ t8_dtet_last_descendant()

void t8_dtet_last_descendant	(	const t8_dtet_t *	t,
		t8_dtet_t *	s,
		int	level
	)

Compute the last descendant of a tetrahedron at a given level.

This is the descendant of the tetrahedron in a uniform maxlevel refinement that has the bigges id.

Parameters

[in]	t	tetrahedron whose descendant is computed.
[in]	level	A given level. Must be greater or equal to t's level.
[out]	s	Existing tetrahedron whose data will be filled with the data of t's last descendant.

◆ t8_dtet_linear_id()

t8_linearidx_t t8_dtet_linear_id	(	const t8_dtet_t *	t,
		int	level
	)

Computes the linear position of a tetrahedron in a uniform grid.

Parameters

[in]	t	tetrahedron whose id will be computed.
[in]	level	level of uniform grid to be considered.

Returns: Returns the linear position of this tetrahedron on a grid of level level.

Note: This id is not the Morton index.

◆ t8_dtet_nearest_common_ancestor()

void t8_dtet_nearest_common_ancestor	(	const t8_dtet_t *	t1,
		const t8_dtet_t *	t2,
		t8_dtet_t *	r
	)

Computes the nearest common ancestor of two tetrahedra in the same tree.

Parameters

[in]	t1	First input tetrahedron.
[in]	t2	Second input tetrahedron.
[in,out]	r	Existing tetrahedron whose data will be filled.

Note: t1, t2, r may point to the same tetrahedron.

◆ t8_dtet_parent()

void t8_dtet_parent	(	const t8_dtet_t *	t,
		t8_dtet_t *	parent
	)

Compute the parent of a tetrahedron.

Parameters

[in]	elem	Input tetrahedron.
[in,out]	parent	Existing tetrahedron whose data will be filled with the data of elem's parent.

Note: elem may point to the same tetrahedron as parent.

◆ t8_dtet_predecessor()

void t8_dtet_predecessor	(	const t8_dtet_t *	t,
		t8_dtet_t *	s,
		int	level
	)

Computes the predecessor of a tetrahedron in a uniform grid of level level.

Parameters

[in]	t	tetrahedron whose id will be computed.
[in,out]	s	Existing tetrahedron whose data will be filled with the data of t's predecessor on level level.
[in]	level	level of uniform grid to be considered.

◆ t8_dtet_root_face_to_face()

int t8_dtet_root_face_to_face	(	t8_dtet_t *	t,
		int	root_face
	)

Given a tetrahedron and a face of the root tetrahedron.

If the tetrahedron lies on the tree boundary, return the corresponding face number of the tetrahedron. If not the return value is arbitrary.

Parameters

[in]	t	The tetrahedron.
[in]	face	The index of a face of the root tetrahedron.

Returns: The index of the face of t that is a subface of face, if t is on the tree boundary. Any arbitrary integer if t is not at a tree boundary.

Note: For boundary tetrahedra, this function is the inverse of t8_dtet_tree_face.

◆ t8_dtet_sibling()

void t8_dtet_sibling	(	const t8_dtet_t *	elem,
		int	sibid,
		t8_dtet_t *	sibling
	)

Compute a specific sibling of a tetrahedron.

Parameters

[in]	elem	Input tetrahedron.
[in,out]	sibling	Existing tetrahedron whose data will be filled with the data of sibling no. sibling_id of elem.
[in]	sibid	The id of the sibling computed, 0..7 in Bey order.

◆ t8_dtet_successor()

void t8_dtet_successor	(	const t8_dtet_t *	t,
		t8_dtet_t *	s,
		int	level
	)

Computes the successor of a tetrahedron in a uniform grid of level level.

Parameters

[in]	t	tetrahedron whose id will be computed.
[out]	s	Existing tetrahedron whose data will be filled with the data of t's successor on level level.
[in]	level	level of uniform grid to be considered.

◆ t8_dtet_tree_face()

int t8_dtet_tree_face	(	t8_dtet_t *	t,
		int	face
	)

Given a tetrahedron and a face of this tetrahedron.

If the face lies on the tree boundary, return the face number of the tree face. If not the return value is arbitrary.

Parameters

[in]	t	The tetrahedron.
[in]	face	The index of a face of t.

Returns: The index of the tree face that face is a subface of, if face is on a tree boundary. Any arbitrary integer if is not at a tree boundary.

Note: For boundary tetrahedra, this function is the inverse of t8_dtet_root_face_to_face.

Functions

Detailed Description

Function Documentation

◆ t8_dtet_ancestor()

◆ t8_dtet_ancestor_id()

◆ t8_dtet_child()

◆ t8_dtet_child_id()

◆ t8_dtet_children_at_face()

◆ t8_dtet_childrenpv()

◆ t8_dtet_compare()

◆ t8_dtet_compute_all_coords()

◆ t8_dtet_compute_coords()

◆ t8_dtet_compute_vertex_ref_coords()

◆ t8_dtet_copy()

◆ t8_dtet_corner_descendant()

◆ t8_dtet_face_child_face()

◆ t8_dtet_face_neighbour()

◆ t8_dtet_face_parent_face()

◆ t8_dtet_first_descendant()

◆ t8_dtet_get_level()

◆ t8_dtet_init()

◆ t8_dtet_init_linear_id()

◆ t8_dtet_init_linear_id_with_level()

◆ t8_dtet_init_root()

◆ t8_dtet_is_ancestor()

◆ t8_dtet_is_equal()

◆ t8_dtet_is_familypv()

◆ t8_dtet_is_inside_root()

◆ t8_dtet_is_parent()

◆ t8_dtet_is_root_boundary()

◆ t8_dtet_is_sibling()

◆ t8_dtet_is_valid()

◆ t8_dtet_last_descendant()

◆ t8_dtet_linear_id()

◆ t8_dtet_nearest_common_ancestor()

◆ t8_dtet_parent()

◆ t8_dtet_predecessor()

◆ t8_dtet_root_face_to_face()

◆ t8_dtet_sibling()

◆ t8_dtet_successor()

◆ t8_dtet_tree_face()