Provide an implementation for the pyramid element class. More...

#include <t8_default_pyramid_cxx.hxx>

Inheritance diagram for t8_default_scheme_pyramid_c:

Public Member Functions
	t8_default_scheme_pyramid_c (void)
	The virtual table for a particular implementation of an element class. More...

virtual void	t8_element_new (int length, t8_element_t **elem) const
	Allocate memory for an array of pyramids and initialize them. More...

virtual void	t8_element_init (int length, t8_element_t *elem, int called_new) const
	Initialize an array of allocated elements. More...

virtual int	t8_element_level (const t8_element_t *elem) const
	Return the refinement level of an element. More...

virtual int	t8_element_maxlevel (void) const
	Return the maximum allowed level for this element class. More...

virtual void	t8_element_copy (const t8_element_t source, t8_element_t dest) const
	Copy all entries of source to dest. More...

virtual int	t8_element_compare (const t8_element_t elem1, const t8_element_t elem2) const
	Compare two elements. More...

virtual void	t8_element_parent (const t8_element_t elem, t8_element_t parent) const
	Compute the parent of a given element elem and store it in parent. More...

virtual int	t8_element_num_siblings (const t8_element_t *elem) const
	Compute the number of siblings of an element. More...

virtual void	t8_element_sibling (const t8_element_t elem, int sibid, t8_element_t sibling) const
	Compute a specific sibling of a given pyramid element elem and store it in sibling. More...

virtual int	t8_element_num_faces (const t8_element_t *elem) const
	Compute the number of faces of a given element. More...

virtual int	t8_element_max_num_faces (const t8_element_t *elem) const
	Compute the maximum number of faces of a given element and all of its descendants. More...

virtual int	t8_element_num_children (const t8_element_t *elem) const
	Return the number of children of an element when it is refined. More...

virtual int	t8_element_num_face_children (const t8_element_t *elem, int face) const
	Return the number of children of an element's face when the element is refined. More...

virtual int	t8_element_get_face_corner (const t8_element_t *element, int face, int corner) const
	Return the corner number of an element's face corner. More...

virtual int	t8_element_num_corners (const t8_element_t *elem) const
	Compute the number of corners of a given element. More...

virtual int	t8_element_get_corner_face (const t8_element_t *element, int corner, int face) const
	Return the face numbers of the faces sharing an element's corner. More...

virtual t8_eclass_t	t8_element_child_eclass (int childid) const
	Return the type of each child in the ordering of the implementation. More...

virtual void	t8_element_child (const t8_element_t elem, int childid, t8_element_t child) const
	Construct the child element of a given number. More...

virtual void	t8_element_children (const t8_element_t elem, int length, t8_element_t c[]) const
	Construct all children of a given element. More...

virtual int	t8_element_child_id (const t8_element_t *elem) const
	Compute the child id of an element. More...

virtual int	t8_element_ancestor_id (const t8_element_t *elem, int level) const
	Compute the ancestor id of an element, that is the child id at a given level. More...

virtual int	t8_element_is_family (t8_element_t **fam) const
	Query whether a given set of elements is a family or not. More...

virtual void	t8_element_nca (const t8_element_t elem1, const t8_element_t elem2, t8_element_t *nca) const
	Compute the nearest common ancestor of two elements. More...

virtual t8_element_shape_t	t8_element_shape (const t8_element_t *elem) const
	Return the shape of an allocated element according its type. More...

virtual t8_element_shape_t	t8_element_face_shape (const t8_element_t *elem, int face) const
	Compute the shape of the face of an element. More...

virtual void	t8_element_children_at_face (const t8_element_t elem, int face, t8_element_t children[], int num_children, int *child_indices) const
	Given an element and a face of the element, compute all children of the element that touch the face. More...

virtual int	t8_element_face_child_face (const t8_element_t *elem, int face, int face_child) const
	Given a face of an element and a child number of a child of that face, return the face number of the child of the element that matches the child face. More...

virtual int	t8_element_face_parent_face (const t8_element_t *elem, int face) const
	Given a face of an element return the face number of the parent of the element that matches the element's face. More...

virtual int	t8_element_tree_face (const t8_element_t *elem, int face) const
	Given an element and a face of this element. More...

virtual void	t8_element_transform_face (const t8_element_t elem1, t8_element_t elem2, int orientation, int sign, int is_smaller_face) const
	Suppose we have two trees that share a common face f. More...

virtual int	t8_element_extrude_face (const t8_element_t face, const t8_eclass_scheme_c face_scheme, t8_element_t *elem, int root_face) const
	Given a boundary face inside a root tree's face construct the element inside the root tree that has the given face as a face. More...

virtual void	t8_element_first_descendant_face (const t8_element_t elem, int face, t8_element_t first_desc, int level) const
	Construct the first descendant of an element at a given level that touches a given face. More...

virtual void	t8_element_last_descendant_face (const t8_element_t elem, int face, t8_element_t last_desc, int level) const
	Construct the last descendant of an element at a given level that touches a given face. More...

virtual void	t8_element_boundary_face (const t8_element_t elem, int face, t8_element_t boundary, const t8_eclass_scheme_c *boundary_scheme) const
	Construct the boundary element at a specific face. More...

virtual void	t8_element_boundary (const t8_element_t elem, int min_dim, int length, t8_element_t *boundary) const
	Construct all codimension-one boundary elements of a given element. More...

virtual int	t8_element_is_root_boundary (const t8_element_t *elem, int face) const
	Compute whether a given element shares a given face with its root tree. More...

virtual int	t8_element_face_neighbor_inside (const t8_element_t elem, t8_element_t neigh, int face, int *neigh_face) const
	Construct the face neighbor of a given element if this face neighbor is inside the root tree. More...

virtual void	t8_element_set_linear_id (t8_element_t *elem, int level, t8_linearidx_t id) const
	Initialize the entries of an allocated element according to a given linear id in a uniform refinement. More...

virtual t8_linearidx_t	t8_element_get_linear_id (const t8_element_t *elem, int level) const
	Compute the linear id of a given element in a hypothetical uniform refinement of a given level. More...

virtual void	t8_element_first_descendant (const t8_element_t elem, t8_element_t desc, int level) const
	Compute the first descendant of a given element. More...

virtual void	t8_element_last_descendant (const t8_element_t elem, t8_element_t desc, int level) const
	Compute the last descendant of a given element. More...

virtual void	t8_element_successor (const t8_element_t t, t8_element_t s, int level) const
	Construct the successor in a uniform refinement of a given element. More...

virtual void	t8_element_anchor (const t8_element_t *elem, int anchor[3]) const
	Get the integer coordinates of the anchor node of an element. More...

virtual int	t8_element_root_len (const t8_element_t *elem) const
	Compute the root length of a given element, that is the length of its level 0 ancestor. More...

virtual void	t8_element_vertex_coords (const t8_element_t *t, int vertex, int coords[]) const
	Compute the integer coordinates of a given element vertex. More...

virtual void	t8_element_general_function (const t8_element_t elem, const void indata, void *outdata) const
	The tetrahedron schemes uses the general function to return the type of a tetrahedron. More...

virtual void	t8_element_vertex_reference_coords (const t8_element_t *elem, const int vertex, double coords[]) const
	Compute the coordinates of a given element vertex inside a reference tree that is embedded into [0,1]^d (d = dimension). More...

virtual void	t8_element_reference_coords (const t8_element_t elem, const double ref_coords, const void user_data, double out_coords) const
	Convert a point in the reference space of an element to a point in the reference space of the tree. More...

virtual int	t8_element_refines_irregular (void) const
	Returns true, if there is one element in the tree, that does not refine into 2^dim children. More...

Public Member Functions inherited from t8_default_scheme_common_c
virtual	~ t8_default_scheme_common_c ()
	Destructor for all default schemes.

virtual void	t8_element_destroy (int length, t8_element_t **elem) const
	Deallocate space for a bunch of elements.

virtual t8_gloidx_t	t8_element_count_leafs (const t8_element_t *t, int level) const
	Count how many leaf descendants of a given uniform level an element would produce. More...

virtual t8_gloidx_t	t8_element_count_leafs_from_root (int level) const
	Count how many leaf descendants of a given uniform level the root element will produce. More...

Public Member Functions inherited from t8_eclass_scheme
virtual	~ t8_eclass_scheme ()
	The destructor. More...

virtual size_t	t8_element_size (void) const
	The virtual table for a particular implementation of an element class. More...

virtual t8_element_t *	t8_element_array_index (sc_array_t *array, size_t it) const
	Return a pointer to a t8_element in an array indexed by a size_t. More...

Additional Inherited Members
Data Fields inherited from t8_eclass_scheme
t8_eclass_t	eclass
	The element class.

Protected Attributes inherited from t8_eclass_scheme
size_t	element_size
	This scheme defines the operations for a particular element class. More...

void *	ts_context
	Anonymous implementation context.

Detailed Description

Provide an implementation for the pyramid element class.

It is written as a self-contained library in the t8_dpyramid_* files.

Constructor & Destructor Documentation

◆ t8_default_scheme_pyramid_c()

t8_default_scheme_pyramid_c::t8_default_scheme_pyramid_c ( void )

The virtual table for a particular implementation of an element class.

Constructor.

Member Function Documentation

◆ t8_element_ancestor_id()

int t8_default_scheme_pyramid_c::t8_element_ancestor_id	(	const t8_element_t *	elem,
		int	level
	)		const

virtual

Compute the ancestor id of an element, that is the child id at a given level.

Parameters

[in]	elem	This must be a valid element.
[in]	level	A refinement level. Must satisfy level < elem.level

Returns: The child_id of elem in regard to its level ancestor.

Implements t8_eclass_scheme.

◆ t8_element_anchor()

void t8_default_scheme_pyramid_c::t8_element_anchor	(	const t8_element_t *	elem,
		int	anchor[3]
	)		const

virtual

Get the integer coordinates of the anchor node of an element.

The default scheme implements the Morton type SFCs. In these SFCs the elements are positioned in a cube [0,1]^(dL) with dimension d (=0,1,2,3) and L the maximum refinement level. All element vertices have integer coordinates in this cube and the anchor node is the first of all vertices (index 0). It also has the lowest x,y and z coordinates.

Parameters

[in]	elem	The element.
[out]	anchor	The integer coordinates of the anchor node in the cube [0,1]^(dL)

Implements t8_default_scheme_common_c.

◆ t8_element_boundary()

virtual void t8_default_scheme_pyramid_c::t8_element_boundary	(	const t8_element_t *	elem,
		int	min_dim,
		int	length,
		t8_element_t **	boundary
	)		const

inlinevirtual

Construct all codimension-one boundary elements of a given element.

Parameters

[in]	elem	The input element.
[in]	face	A face of elem.

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

Implements t8_eclass_scheme.

◆ t8_element_boundary_face()

void t8_default_scheme_pyramid_c::t8_element_boundary_face	(	const t8_element_t *	elem,
		int	face,
		t8_element_t *	boundary,
		const t8_eclass_scheme_c *	boundary_scheme
	)		const

virtual

Construct the boundary element at a specific face.

Parameters

[in]	elem	The input element.
[in]	face	The index of the face of which to construct the boundary element.
[in,out]	boundary	An allocated element of dimension of element minus 1. The entries will be filled with the entries of the face of element.
[in]	boundary_scheme	The scheme for the eclass of the boundary face.

Implements t8_eclass_scheme.

◆ t8_element_child()

void t8_default_scheme_pyramid_c::t8_element_child	(	const t8_element_t *	elem,
		int	childid,
		t8_element_t *	child
	)		const

virtual

Construct the child element of a given number.

Parameters

[in]	elem	This must be a valid element, bigger than maxlevel.
[in]	childid	The number of the child to construct.
[in,out]	child	The storage for this element must exist and match the element class of the child. On output, a valid element. It is valid to call this function with elem = child.

See also: t8_element_child_eclass

Implements t8_eclass_scheme.

◆ t8_element_child_eclass()

virtual t8_eclass_t t8_default_scheme_pyramid_c::t8_element_child_eclass ( int childid ) const

inlinevirtual

Return the type of each child in the ordering of the implementation.

Parameters

[in] childid Must be between 0 and the number of children (exclusive). The number of children is defined in t8_element_num_children.

Returns: The type for the given child.

Implements t8_eclass_scheme.

◆ t8_element_child_id()

int t8_default_scheme_pyramid_c::t8_element_child_id ( const t8_element_t * elem ) const

virtual

Compute the child id of an element.

Parameters

[in] elem This must be a valid element.

Returns: The child id of elem.

Implements t8_eclass_scheme.

◆ t8_element_children()

void t8_default_scheme_pyramid_c::t8_element_children	(	const t8_element_t *	elem,
		int	length,
		t8_element_t *	c[]
	)		const

virtual

Construct all children of a given element.

Parameters

[in]	elem	This must be a valid element, bigger than maxlevel.
[in]	length	The length of the output array c must match the number of children.
[in,out]	c	The storage for these length elements must exist and match the element class in the children's ordering. On output, all children are valid. It is valid to call this function with elem = c[0].

See also: t8_element_num_children; t8_element_child_eclass

Implements t8_eclass_scheme.

◆ t8_element_children_at_face()

void t8_default_scheme_pyramid_c::t8_element_children_at_face	(	const t8_element_t *	elem,
		int	face,
		t8_element_t *	children[],
		int	num_children,
		int *	child_indices
	)		const

virtual

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

Parameters

[in]	elem	The element.
[in]	face	A face of elem.
[in,out]	children	Allocated elements, in which the children of elem that share a face with face are stored. They will be stored in order of their linear id.
[in]	num_children	The number of elements in children. Must match the number of children that touch face. t8_element_num_face_children
[in,out]	child_indices	If not NULL, an array of num_children integers must be given, on output its i-th entry is the child_id of the i-th face_child. It is valid to call this function with elem = children[0].

Implements t8_eclass_scheme.

◆ t8_element_compare()

int t8_default_scheme_pyramid_c::t8_element_compare	(	const t8_element_t *	elem1,
		const t8_element_t *	elem2
	)		const

virtual

Compare two elements.

Parameters

[in]	elem1	The first element.
[in]	elem2	The second element.

Returns: negativ if elem1 < elem2, zero if elem1 equals elem2 and positiv if elem1 > elem2. If elem2 is a copy of elem1 then the elements are equal.

Implements t8_eclass_scheme.

◆ t8_element_copy()

void t8_default_scheme_pyramid_c::t8_element_copy	(	const t8_element_t *	source,
		t8_element_t *	dest
	)		const

virtual

Copy all entries of source to dest.

dest must be an existing element. No memory is allocated by this function.

Parameters

[in]	source	The element whose entries will be copied to dest.
[in,out]	dest	This element's entries will be overwritted with the entries of source.

Note: source and dest may point to the same element.

Implements t8_eclass_scheme.

◆ t8_element_extrude_face()

int t8_default_scheme_pyramid_c::t8_element_extrude_face	(	const t8_element_t *	face,
		const t8_eclass_scheme_c *	face_scheme,
		t8_element_t *	elem,
		int	root_face
	)		const

virtual

Given a boundary face inside a root tree's face construct the element inside the root tree that has the given face as a face.

Parameters

[in]	face	A face element.
[in]	face_scheme	The scheme for the face element.
[in,out]	elem	An allocated element. The entries will be filled with the data of the element that has face as a face and lies within the root tree.
[in]	root_face	The index of the face of the root tree in which face lies.

Returns: The face number of the face of elem that coincides with face.

Implements t8_eclass_scheme.

◆ t8_element_face_child_face()

int t8_default_scheme_pyramid_c::t8_element_face_child_face	(	const t8_element_t *	elem,
		int	face,
		int	face_child
	)		const

virtual

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

 x ---- x   x      x           x ---- x
 |      |   |      |           |   |  | <-- f
 |      |   |      x           |   x--x
 |      |   |                  |      |
 x ---- x   x                  x ---- x
  elem    face  face_child    Returns the face number f

Parameters

[in]	elem	The element.
[in]	face	Then number of the face.
[in]	face_child	A number 0 <= face_child < num_face_children, specifying a child of elem that shares a face with face. These children are counted in linear order. This coincides with the order of children from a call to t8_element_children_at_face.

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

Implements t8_eclass_scheme.

◆ t8_element_face_neighbor_inside()

int t8_default_scheme_pyramid_c::t8_element_face_neighbor_inside	(	const t8_element_t *	elem,
		t8_element_t *	neigh,
		int	face,
		int *	neigh_face
	)		const

virtual

Construct the face neighbor of a given element if this face neighbor is inside the root tree.

Return 0 otherwise.

Parameters

[in]	elem	The element to be considered.
[in,out]	neigh	If the face neighbor of elem along face is inside the root tree, this element's data is filled with the data of the face neighbor. Otherwise the data can be modified arbitrarily.
[in]	face	The number of the face along which the neighbor should be constructed.
[out]	neigh_face	The number of face as viewed from neigh. An arbitrary value, if the neighbor is not inside the root tree.

Returns: True if neigh is inside the root tree. False if not. In this case neigh's data can be arbitrary on output.

Implements t8_eclass_scheme.

◆ t8_element_face_parent_face()

int t8_default_scheme_pyramid_c::t8_element_face_parent_face	(	const t8_element_t *	elem,
		int	face
	)		const

virtual

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

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

Parameters

[in]	elem	The element.
[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.

Note: For the root element this function always returns face.

Implements t8_eclass_scheme.

◆ t8_element_face_shape()

t8_element_shape_t t8_default_scheme_pyramid_c::t8_element_face_shape	(	const t8_element_t *	elem,
		int	face
	)		const

virtual

Compute the shape of the face of an element.

Parameters

[in]	elem	The element.
[in]	face	A face of elem.

Returns: The element shape of the face.

Implements t8_eclass_scheme.

◆ t8_element_first_descendant()

void t8_default_scheme_pyramid_c::t8_element_first_descendant	(	const t8_element_t *	elem,
		t8_element_t *	desc,
		int	level
	)		const

virtual

Compute the first descendant of a given element.

Parameters

[in]	elem	The element whose descendant is computed.
[out]	desc	The first element in a uniform refinement of elem of the given level.
[in]	level	The level, at which the descendant is computed.

Implements t8_eclass_scheme.

◆ t8_element_first_descendant_face()

void t8_default_scheme_pyramid_c::t8_element_first_descendant_face	(	const t8_element_t *	elem,
		int	face,
		t8_element_t *	first_desc,
		int	level
	)		const

virtual

Construct the first descendant of an element at a given level that touches a given face.

Parameters

[in]	elem	The input element.
[in]	face	A face of elem.
[in,out]	first_desc	An allocated element. This element's data will be filled with the data of the first descendant of elem that shares a face with face.
[in]	level	The level, at which the first descendant is constructed

Implements t8_eclass_scheme.

◆ t8_element_general_function()

void t8_default_scheme_pyramid_c::t8_element_general_function	(	const t8_element_t *	elem,
		const void *	indata,
		void *	outdata
	)		const

virtual

The tetrahedron schemes uses the general function to return the type of a tetrahedron.

Parameters

[in]	elem	An valid element
[in]	indata	Is ignored. Can be NULL.
[out]	outdata	Pointer to an int8_t. The type of elem will be stored here. On output the type of the tetrahedron will be stored in outdata

Reimplemented from t8_default_scheme_common_c.

◆ t8_element_get_corner_face()

virtual int t8_default_scheme_pyramid_c::t8_element_get_corner_face	(	const t8_element_t *	element,
		int	corner,
		int	face
	)		const

inlinevirtual

Return the face numbers of the faces sharing an element's corner.

Parameters

[in]	element	The element.
[in]	corner	A corner index for the face.
[in]	face	A face index for corner.

Returns: The face number of the face-th face at corner.

Implements t8_eclass_scheme.

◆ t8_element_get_face_corner()

int t8_default_scheme_pyramid_c::t8_element_get_face_corner	(	const t8_element_t *	element,
		int	face,
		int	corner
	)		const

virtual

Return the corner number of an element's face corner.

Parameters

[in]	element	The element.
[in]	face	A face index for element.
[in]	corner	A corner index for the face 0 <= corner < num_face_corners.

Returns: The corner number of the corner-th vertex of face.

Implements t8_eclass_scheme.

◆ t8_element_get_linear_id()

t8_linearidx_t t8_default_scheme_pyramid_c::t8_element_get_linear_id	(	const t8_element_t *	elem,
		int	level
	)		const

virtual

Compute the linear id of a given element in a hypothetical uniform refinement of a given level.

Parameters

[in]	elem	The element whose id we compute.
[in]	level	The level of the uniform refinement to consider.

Returns: The linear id of the element.

Implements t8_eclass_scheme.

◆ t8_element_init()

void t8_default_scheme_pyramid_c::t8_element_init	(	int	length,
		t8_element_t *	elem,
		int	called_new
	)		const

virtual

Initialize an array of allocated elements.

Parameters

[in]	length	The number of pyramid elements to be allocated.
[in,out]	elems	On input an array of length many allocated elements.
[in]	called_new	True if the elements in elem were created by a call to t8_element_new. False if no element in elem was created in this way. The case that only some elements were created by t8_element_new should never occur.

Note: In debugging mode, an element that was passed to t8_element_init must pass t8_element_is_valid.; If an element was created by t8_element_new then t8_element_init may not be called for it. Thus, t8_element_new should initialize an element in the same way as a call to t8_element_init would. Thus, if called_new is true this function should usually do nothing.

See also: t8_element_new; t8_element_is_valid

Implements t8_eclass_scheme.

◆ t8_element_is_family()

int t8_default_scheme_pyramid_c::t8_element_is_family ( t8_element_t ** fam ) const

virtual

Query whether a given set of elements is a family or not.

Parameters

[in] fam An array of as many elements as an element of class ts has siblings.

Returns: Zero if fam is not a family, nonzero if it is.

Note: level 0 elements do not form a family.

Implements t8_eclass_scheme.

◆ t8_element_is_root_boundary()

int t8_default_scheme_pyramid_c::t8_element_is_root_boundary	(	const t8_element_t *	elem,
		int	face
	)		const

virtual

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

Parameters

[in]	elem	The input element.
[in]	face	A face of elem.

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

Implements t8_eclass_scheme.

◆ t8_element_last_descendant()

void t8_default_scheme_pyramid_c::t8_element_last_descendant	(	const t8_element_t *	elem,
		t8_element_t *	desc,
		int	level
	)		const

virtual

Compute the last descendant of a given element.

Parameters

[in]	elem	The element whose descendant is computed.
[out]	desc	The last element in a uniform refinement of elem of the given level.
[in]	level	The level, at which the descendant is computed.

Implements t8_eclass_scheme.

◆ t8_element_last_descendant_face()

void t8_default_scheme_pyramid_c::t8_element_last_descendant_face	(	const t8_element_t *	elem,
		int	face,
		t8_element_t *	last_desc,
		int	level
	)		const

virtual

Construct the last descendant of an element at a given level that touches a given face.

Parameters

[in]	elem	The input element.
[in]	face	A face of elem.
[in,out]	last_desc	An allocated element. This element's data will be filled with the data of the last descendant of elem that shares a face with face.
[in]	level	The level, at which the last descendant is constructed

Implements t8_eclass_scheme.

◆ t8_element_level()

int t8_default_scheme_pyramid_c::t8_element_level ( const t8_element_t * elem ) const

virtual

Return the refinement level of an element.

Parameters

[in] elem The element whose level should be returned.

Returns: The level of elem.

Implements t8_eclass_scheme.

◆ t8_element_max_num_faces()

int t8_default_scheme_pyramid_c::t8_element_max_num_faces ( const t8_element_t * elem ) const

virtual

Compute the maximum number of faces of a given element and all of its descendants.

Parameters

[in] elem The element.

Returns: The maximum number of faces of elem and its descendants.

Implements t8_eclass_scheme.

◆ t8_element_maxlevel()

int t8_default_scheme_pyramid_c::t8_element_maxlevel ( void ) const

virtual

Return the maximum allowed level for this element class.

Returns: The maximum allowed level for elements of this class.

Implements t8_eclass_scheme.

◆ t8_element_nca()

void t8_default_scheme_pyramid_c::t8_element_nca	(	const t8_element_t *	elem1,
		const t8_element_t *	elem2,
		t8_element_t *	nca
	)		const

virtual

Compute the nearest common ancestor of two elements.

That is, the element with highest level that still has both given elements as descendants.

Parameters

[in]	elem1	The first of the two input elements.
[in]	elem2	The second of the two input elements.
[in,out]	nca	The storage for this element must exist and match the element class of the child. On output the unique nearest common ancestor of elem1 and elem2.

Implements t8_eclass_scheme.

◆ t8_element_new()

void t8_default_scheme_pyramid_c::t8_element_new	(	int	length,
		t8_element_t **	elem
	)		const

virtual

Allocate memory for an array of pyramids and initialize them.

Parameters

[in]	length	The number of pyramid elements to be allocated.
[in,out]	elems	On input an array of length many unallocated element pointers. On output all these pointers will point to an allocated and initialized element.

Note: Not every element that is created in t8code will be created by a call to this function. However, if an element is not created using t8_element_new, then it is guaranteed that t8_element_init is called on it.; In debugging mode, an element that was created with t8_element_new must pass t8_element_is_valid.; If an element was created by t8_element_new then t8_element_init may not be called for it. Thus, t8_element_new should initialize an element in the same way as a call to t8_element_init would.

See also: t8_element_init; t8_element_is_valid

Reimplemented from t8_default_scheme_common_c.

◆ t8_element_num_children()

int t8_default_scheme_pyramid_c::t8_element_num_children ( const t8_element_t * elem ) const

virtual

Return the number of children of an element when it is refined.

Parameters

[in] elem The element whose number of children is returned.

Returns: The number of children of elem if it is to be refined.

Implements t8_eclass_scheme.

◆ t8_element_num_corners()

int t8_default_scheme_pyramid_c::t8_element_num_corners ( const t8_element_t * elem ) const

virtual

Compute the number of corners of a given element.

Parameters

[in] elem The element.

Returns: The number of corners of elem.

Reimplemented from t8_default_scheme_common_c.

◆ t8_element_num_face_children()

int t8_default_scheme_pyramid_c::t8_element_num_face_children	(	const t8_element_t *	elem,
		int	face
	)		const

virtual

Return the number of children of an element's face when the element is refined.

Parameters

[in]	elem	The element whose face is considered.
[in]	face	A face of elem.

Returns: The number of children of face if elem is to be refined.

Implements t8_eclass_scheme.

◆ t8_element_num_faces()

int t8_default_scheme_pyramid_c::t8_element_num_faces ( const t8_element_t * elem ) const

virtual

Compute the number of faces of a given element.

Parameters

[in] elem The element.

Returns: The number of faces of elem.

Implements t8_eclass_scheme.

◆ t8_element_num_siblings()

int t8_default_scheme_pyramid_c::t8_element_num_siblings ( const t8_element_t * elem ) const

virtual

Compute the number of siblings of an element.

That is the number of Children of its parent.

Parameters

[in] elem The element.

Returns: The number of siblings of element. Note that this number is >= 1, since we count the element itself as a sibling.

Reimplemented from t8_default_scheme_common_c.

◆ t8_element_parent()

void t8_default_scheme_pyramid_c::t8_element_parent	(	const t8_element_t *	elem,
		t8_element_t *	parent
	)		const

virtual

Compute the parent of a given element elem and store it in parent.

parent needs to be an existing element. No memory is allocated by this function. elem and parent can point to the same element, then the entries of elem are overwritten by the ones of its parent.

Parameters

[in]	elem	The element whose parent will be computed.
[in,out]	parent	This element's entries will be overwritten by those of elem's parent. The storage for this element must exist and match the element class of the parent. For a pyramid, for example, it may be either a tetrahedron or a pyramid depending on elem's childid.

Implements t8_eclass_scheme.

◆ t8_element_reference_coords()

void t8_default_scheme_pyramid_c::t8_element_reference_coords	(	const t8_element_t *	elem,
		const double *	ref_coords,
		const void *	user_data,
		double *	out_coords
	)		const

virtual

Convert a point in the reference space of an element to a point in the reference space of the tree.

Parameters

[in]	elem	The element.
[in]	coords_input	The coordinates of the point in the reference space of the element.
[in]	user_data	User data.
[out]	out_coords	The coordinates of the point in the reference space of the tree.

Implements t8_default_scheme_common_c.

◆ t8_element_refines_irregular()

int t8_default_scheme_pyramid_c::t8_element_refines_irregular ( void ) const

virtual

Returns true, if there is one element in the tree, that does not refine into 2^dim children.

Returns false otherwise.

Returns
1, because pyramids refine irregularly

Implements t8_eclass_scheme.

◆ t8_element_root_len()

int t8_default_scheme_pyramid_c::t8_element_root_len ( const t8_element_t * elem ) const

virtual

Compute the root length of a given element, that is the length of its level 0 ancestor.

Parameters

[in] elem The element whose root length should be computed.

Returns: The root length of elem

Implements t8_eclass_scheme.

◆ t8_element_set_linear_id()

void t8_default_scheme_pyramid_c::t8_element_set_linear_id	(	t8_element_t *	elem,
		int	level,
		t8_linearidx_t	id
	)		const

virtual

Initialize the entries of an allocated element according to a given linear id in a uniform refinement.

Parameters

[in,out]	elem	The element whose entries will be set.
[in]	level	The level of the uniform refinement to consider.
[in]	id	The linear id. id must fulfil 0 <= id < 'number of leafs in the uniform refinement'

Implements t8_eclass_scheme.

◆ t8_element_shape()

t8_element_shape_t t8_default_scheme_pyramid_c::t8_element_shape ( const t8_element_t * elem ) const

virtual

Return the shape of an allocated element according its type.

For example, a child of an element can be an element of a different shape and has to be handled differently - according to its shape.

Parameters

[in] elem The element to be considered

Returns: The shape of the element as an eclass

Reimplemented from t8_default_scheme_common_c.

◆ t8_element_sibling()

virtual void t8_default_scheme_pyramid_c::t8_element_sibling	(	const t8_element_t *	elem,
		int	sibid,
		t8_element_t *	sibling
	)		const

inlinevirtual

Compute a specific sibling of a given pyramid element elem and store it in sibling.

sibling needs to be an existing element. No memory is allocated by this function. elem and sibling can point to the same element, then the entries of elem are overwritten by the ones of its sibid -th sibling.

Parameters

[in]	elem	The element whose sibling will be computed.
[in]	sibid	The id of the sibling computed.
[in,out]	sibling	This element's entries will be overwritten by those of elem's sibid-th sibling. The storage for this element must exist and match the element class of the sibling.

Implements t8_eclass_scheme.

◆ t8_element_successor()

void t8_default_scheme_pyramid_c::t8_element_successor	(	const t8_element_t *	t,
		t8_element_t *	s,
		int	level
	)		const

virtual

Construct the successor in a uniform refinement of a given element.

Parameters

[in]	elem1	The element whose successor should be constructed.
[in,out]	elem2	The element whose entries will be set.
[in]	level	The level of the uniform refinement to consider.

Implements t8_eclass_scheme.

◆ t8_element_transform_face()

virtual void t8_default_scheme_pyramid_c::t8_element_transform_face	(	const t8_element_t *	elem1,
		t8_element_t *	elem2,
		int	orientation,
		int	sign,
		int	is_smaller_face
	)		const

inlinevirtual

Suppose we have two trees that share a common face f.

Given an element e that is a subface of f in one of the trees and given the orientation of the tree connection, construct the face element of the respective tree neighbor that logically coincides with e but lies in the coordinate system of the neighbor tree.

Parameters

[in]	elem1	The face element.
[in,out]	elem2	On return the face elment elem1 with respective to the coordinate system of the other tree.
[in]	orientation	The orientation of the tree-tree connection.

See also: t8_cmesh_set_join

Parameters

[in]	sign	Depending on the topological orientation of the two tree faces, either 0 (both faces have opposite orientation) or 1 (both faces have the same top. orientattion). t8_eclass_face_orientation
[in]	is_smaller_face	Flag to declare whether elem1 belongs to the smaller face. A face f of tree T is smaller than f' of T' if either the eclass of T is smaller or if the classes are equal and f<f'. The orientation is defined in relation to the smaller face.

Note: elem1 and elem2 may point to the same element.

Implements t8_eclass_scheme.

◆ t8_element_tree_face()

int t8_default_scheme_pyramid_c::t8_element_tree_face	(	const t8_element_t *	elem,
		int	face
	)		const

virtual

Given an element and a face of this element.

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]	elem	The element.
[in]	face	The index of a face of elem.

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.

Implements t8_eclass_scheme.

◆ t8_element_vertex_coords()

void t8_default_scheme_pyramid_c::t8_element_vertex_coords	(	const t8_element_t *	t,
		int	vertex,
		int	coords[]
	)		const

virtual

Compute the integer coordinates of a given element vertex.

The default scheme implements the Morton type SFCs. In these SFCs the elements are positioned in a cube [0,1]^(dL) with dimension d (=0,1,2,3) and L the maximum refinement level. All element vertices have integer coordinates in this cube.

Parameters

[in]	t	The element to be considered.
[in]	vertex	The id of the vertex whose coordinates shall be computed.
[out]	coords	An array of at least as many integers as the element's dimension whose entries will be filled with the coordinates of vertex.

Implements t8_default_scheme_common_c.

◆ t8_element_vertex_reference_coords()

void t8_default_scheme_pyramid_c::t8_element_vertex_reference_coords	(	const t8_element_t *	elem,
		const int	vertex,
		double	coords[]
	)		const

virtual

Compute the coordinates of a given element vertex inside a reference tree that is embedded into [0,1]^d (d = dimension).

Parameters

[in]	elem	The element to be considered.
[in]	vertex	The id of the vertex whose coordinates shall be computed.
[out]	coords	An array of at least as many doubles as the element's dimension whose entries will be filled with the coordinates of vertex.

Implements t8_eclass_scheme.

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

src/t8_schemes/t8_default/t8_default_pyramid/t8_default_pyramid_cxx.hxx
src/t8_schemes/t8_default/t8_default_pyramid/t8_default_pyramid_cxx.cxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ t8_default_scheme_pyramid_c()

Member Function Documentation

◆ t8_element_ancestor_id()

◆ t8_element_anchor()

◆ t8_element_boundary()

◆ t8_element_boundary_face()

◆ t8_element_child()

◆ t8_element_child_eclass()

◆ t8_element_child_id()

◆ t8_element_children()

◆ t8_element_children_at_face()

◆ t8_element_compare()

◆ t8_element_copy()

◆ t8_element_extrude_face()

◆ t8_element_face_child_face()

◆ t8_element_face_neighbor_inside()

◆ t8_element_face_parent_face()

◆ t8_element_face_shape()

◆ t8_element_first_descendant()

◆ t8_element_first_descendant_face()

◆ t8_element_general_function()

◆ t8_element_get_corner_face()

◆ t8_element_get_face_corner()

◆ t8_element_get_linear_id()

◆ t8_element_init()

◆ t8_element_is_family()

◆ t8_element_is_root_boundary()

◆ t8_element_last_descendant()

◆ t8_element_last_descendant_face()

◆ t8_element_level()

◆ t8_element_max_num_faces()

◆ t8_element_maxlevel()

◆ t8_element_nca()

◆ t8_element_new()

◆ t8_element_num_children()

◆ t8_element_num_corners()

◆ t8_element_num_face_children()

◆ t8_element_num_faces()

◆ t8_element_num_siblings()

◆ t8_element_parent()

◆ t8_element_reference_coords()

◆ t8_element_refines_irregular()

◆ t8_element_root_len()

◆ t8_element_set_linear_id()

◆ t8_element_shape()

◆ t8_element_sibling()

◆ t8_element_successor()

◆ t8_element_transform_face()

◆ t8_element_tree_face()

◆ t8_element_vertex_coords()

◆ t8_element_vertex_reference_coords()