t8  1.2.0
t8code is a C library to manage a forest of adaptive space-trees of general element classes in parallel.
t8_default_tri_cxx.hxx
1 /*
2  This file is part of t8code.
3  t8code is a C library to manage a collection (a forest) of multiple
4  connected adaptive space-trees of general element classes in parallel.
5 
6  Copyright (C) 2015 the developers
7 
8  t8code is free software; you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation; either version 2 of the License, or
11  (at your option) any later version.
12 
13  t8code is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with t8code; if not, write to the Free Software Foundation, Inc.,
20  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 */
22 
29 #ifndef T8_DEFAULT_TRI_CXX_H
30 #define T8_DEFAULT_TRI_CXX_H
31 
32 #include <t8_element_cxx.hxx>
33 #include <t8_schemes/t8_default/t8_default_line/t8_default_line_cxx.hxx>
35 
37 {
38 public:
43 
45 
63  virtual void t8_element_new (int length, t8_element_t **elem) const;
64 
82  virtual void t8_element_init (int length, t8_element_t *elem,
83  int called_new) const;
84 
89  virtual int t8_element_level (const t8_element_t *elem) const;
90 
94  virtual int t8_element_maxlevel (void) const;
95 
103  virtual void t8_element_copy (const t8_element_t *source,
104  t8_element_t *dest) const;
105 
113  virtual int t8_element_compare (const t8_element_t *elem1,
114  const t8_element_t *elem2) const;
115 
128  virtual void t8_element_parent (const t8_element_t *elem,
129  t8_element_t *parent) const;
130 
142  virtual void t8_element_sibling (const t8_element_t *elem,
143  int sibid,
144  t8_element_t *sibling) const;
145 
150  virtual int t8_element_num_faces (const t8_element_t *elem) const;
151 
157  virtual int t8_element_max_num_faces (const t8_element_t *elem)
158  const;
159 
164  virtual int t8_element_num_children (const t8_element_t *elem)
165  const;
166 
172  virtual int t8_element_num_face_children (const t8_element_t *elem,
173  int face) const;
180  virtual int t8_element_get_face_corner (const t8_element_t *element,
181  int face, int corner) const;
182 
189  virtual int t8_element_get_corner_face (const t8_element_t *element,
190  int corner, int face) const;
191 
197  virtual t8_eclass_t t8_element_child_eclass (int childid) const
198  {
199  SC_ABORT ("This function is not implemented yet.\n");
200  return T8_ECLASS_ZERO; /* suppresses compiler warning */
201  }
202 
212  virtual void t8_element_child (const t8_element_t *elem,
213  int childid,
214  t8_element_t *child) const;
215 
227  virtual void t8_element_children (const t8_element_t *elem,
228  int length,
229  t8_element_t *c[]) const;
230 
235  virtual int t8_element_child_id (const t8_element_t *elem) const;
236 
243  virtual int t8_element_ancestor_id (const t8_element_t *elem,
244  int level) const;
245 
252  virtual int t8_element_is_family (t8_element_t **fam) const;
253 
264  virtual void t8_element_nca (const t8_element_t *elem1,
265  const t8_element_t *elem2,
266  t8_element_t *nca) const;
267 
274  int face) const;
275 
290  virtual void t8_element_children_at_face (const t8_element_t *elem,
291  int face,
292  t8_element_t *children[],
293  int num_children,
294  int *child_indices) const;
295 
316  virtual int t8_element_face_child_face (const t8_element_t *elem,
317  int face,
318  int face_child) const;
319 
330  virtual int t8_element_face_parent_face (const t8_element_t *elem,
331  int face) const;
332 
342  virtual int t8_element_tree_face (const t8_element_t *elem,
343  int face) const;
344 
366  virtual void t8_element_transform_face (const t8_element_t *elem1,
367  t8_element_t *elem2,
368  int orientation, int sign,
369  int is_smaller_face) const;
370 
384  virtual int t8_element_extrude_face (const t8_element_t *face,
385  const t8_eclass_scheme_c
386  *face_scheme,
387  t8_element_t *elem,
388  int root_face) const;
389 
399  *elem, int face,
401  *first_desc,
402  int level) const;
403 
413  *elem, int face,
415  *last_desc,
416  int level) const;
417 
427  virtual void t8_element_boundary_face (const t8_element_t *elem,
428  int face,
429  t8_element_t *boundary,
430  const t8_eclass_scheme_c
431  *boundary_scheme) const;
432 
438  virtual void t8_element_boundary (const t8_element_t *elem,
439  int min_dim, int length,
440  t8_element_t **boundary) const;
441 
447  virtual int t8_element_is_root_boundary (const t8_element_t *elem,
448  int face) const;
449 
466  *elem,
467  t8_element_t *neigh,
468  int face,
469  int *neigh_face) const;
470 
478  virtual void t8_element_set_linear_id (t8_element_t *elem,
479  int level,
480  t8_linearidx_t id) const;
481 
489  t8_element_t *elem,
490  int level) const;
491 
498  virtual void t8_element_first_descendant (const t8_element_t *elem,
499  t8_element_t *desc,
500  int level) const;
501 
508  virtual void t8_element_last_descendant (const t8_element_t *elem,
509  t8_element_t *desc,
510  int level) const;
511 
517  virtual void t8_element_successor (const t8_element_t *t,
518  t8_element_t *s, int level) const;
519 
530  virtual void t8_element_anchor (const t8_element_t *elem,
531  int anchor[3]) const;
532 
538  virtual int t8_element_root_len (const t8_element_t *elem) const;
539 
550  virtual void t8_element_vertex_coords (const t8_element_t *elem,
551  int vertex,
552  int coords[]) const;
553 
561  virtual void t8_element_general_function (const t8_element_t *elem,
562  const void *indata,
563  void *outdata) const;
564 
573  *elem,
574  const int vertex,
575  double coords[])
576  const;
577 
586  virtual void t8_element_reference_coords (const t8_element_t *elem,
587  const double *ref_coords,
588  const void *user_data,
589  double *out_coords)
590  const;
591 
596  virtual int t8_element_refines_irregular (void) const;
597 
598 #ifdef T8_ENABLE_DEBUG
613  virtual int t8_element_is_valid (const t8_element_t *t) const;
614 
622  virtual void t8_element_debug_print (const t8_element_t *elem) const;
623 #endif
624 };
625 
626 #endif /* !T8_DEFAULT_TET_H */
Definition: t8_default_common_cxx.hxx:38
Definition: t8_default_tri_cxx.hxx:37
virtual int t8_element_is_family(t8_element_t **fam) const
Query whether a given set of elements is a family or not.
Definition: t8_default_tri_cxx.cxx:187
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.
Definition: t8_default_tri_cxx.cxx:201
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,...
Definition: t8_default_tri_cxx.cxx:566
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.
Definition: t8_default_tri_cxx.cxx:119
virtual void t8_element_vertex_coords(const t8_element_t *elem, int vertex, int coords[]) const
Compute the integer coordinates of a given element vertex.
Definition: t8_default_tri_cxx.cxx:544
virtual int t8_element_maxlevel(void) const
Return the maximum allowed level for this element class.
Definition: t8_default_tri_cxx.cxx:34
virtual int t8_element_level(const t8_element_t *elem) const
Return the refinement level of an element.
Definition: t8_default_tri_cxx.cxx:40
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.
Definition: t8_default_tri_cxx.cxx:437
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 ...
Definition: t8_default_tri_cxx.cxx:250
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.
Definition: t8_default_tri_cxx.cxx:223
virtual int t8_element_num_children(const t8_element_t *elem) const
Return the number of children of an element when it is refined.
Definition: t8_default_tri_cxx.cxx:104
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.
Definition: t8_default_tri_cxx.cxx:130
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.
Definition: t8_default_tri_cxx.cxx:67
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.
Definition: t8_default_tri_cxx.cxx:591
virtual void t8_element_copy(const t8_element_t *source, t8_element_t *dest) const
Copy all entries of source to dest.
Definition: t8_default_tri_cxx.cxx:47
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.
Definition: t8_default_tri_cxx.cxx:513
virtual void t8_element_new(int length, t8_element_t **elem) const
Allocate memory for an array of triangles and initialize them.
Definition: t8_default_tri_cxx.cxx:616
virtual void t8_element_init(int length, t8_element_t *elem, int called_new) const
Initialize an array of allocated tri elements.
Definition: t8_default_tri_cxx.cxx:633
t8_default_scheme_tri_c()
The virtual table for a particular implementation of an element class.
Definition: t8_default_tri_cxx.cxx:648
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.
Definition: t8_default_tri_cxx.cxx:537
virtual int t8_element_child_id(const t8_element_t *elem) const
Compute the child id of an element.
Definition: t8_default_tri_cxx.cxx:173
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.
Definition: t8_default_tri_cxx.cxx:490
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.
Definition: t8_default_tri_cxx.cxx:111
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.
Definition: t8_default_tri_cxx.cxx:215
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 t...
Definition: t8_default_tri_cxx.cxx:296
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.
Definition: t8_default_tri_cxx.cxx:368
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.
Definition: t8_default_tri_cxx.cxx:579
virtual int t8_element_compare(const t8_element_t *elem1, const t8_element_t *elem2) const
Compare two elements.
Definition: t8_default_tri_cxx.cxx:56
virtual void t8_element_children(const t8_element_t *elem, int length, t8_element_t *c[]) const
Construct all children of a given element.
Definition: t8_default_tri_cxx.cxx:154
virtual int t8_element_tree_face(const t8_element_t *elem, int face) const
Given an element and a face of this element.
Definition: t8_default_tri_cxx.cxx:270
virtual int t8_element_num_faces(const t8_element_t *elem) const
Compute the number of faces of a given element.
Definition: t8_default_tri_cxx.cxx:91
virtual t8_eclass_t t8_element_child_eclass(int childid) const
Return the type of each child in the ordering of the implementation.
Definition: t8_default_tri_cxx.hxx:197
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.
Definition: t8_default_tri_cxx.cxx:98
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.
Definition: t8_default_tri_cxx.cxx:279
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.
Definition: t8_default_tri_cxx.cxx:428
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.
Definition: t8_default_tri_cxx.cxx:447
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.
Definition: t8_default_tri_cxx.cxx:525
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.
Definition: t8_default_tri_cxx.cxx:553
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.
Definition: t8_default_tri_cxx.cxx:502
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.
Definition: t8_default_tri_cxx.cxx:141
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 eleme...
Definition: t8_default_tri_cxx.cxx:261
virtual void t8_element_sibling(const t8_element_t *elem, int sibid, t8_element_t *sibling) const
Compute a specific sibling of a given tri element elem and store it in sibling.
Definition: t8_default_tri_cxx.cxx:79
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.
Definition: t8_default_tri_cxx.cxx:180
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.
Definition: t8_default_tri_cxx.cxx:386
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.
Definition: t8_default_tri_cxx.cxx:350
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.
Definition: t8_default_tri_cxx.cxx:480
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...
Definition: t8_default_tri_cxx.cxx:468
This struct holds virtual functions for a particular element class.
Definition: t8_element_cxx.hxx:47
uint64_t t8_linearidx_t
A type for storing SFC indices.
Definition: t8.h:114
We provide some functions that are useful across element classes.
enum t8_eclass t8_eclass_t
This enumeration contains all possible element classes.
struct t8_element t8_element_t
Opaque structure for a generic element, only used as pointer.
Definition: t8_element.h:42
This file defines basic operations on an element in a refinement tree.
t8_eclass_t t8_element_shape_t
Type definition for the geometric shape of an element.
Definition: t8_element_shape.h:38