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_tet_cxx.hxx
Go to the documentation of this file.
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_TET_CXX_H
30 #define T8_DEFAULT_TET_CXX_H
31 
32 #include <t8_element.h>
33 #include <t8_element_cxx.hxx>
34 #include <t8_schemes/t8_default/t8_default_tri/t8_default_tri_cxx.hxx>
36 
38 {
39 public:
40 
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  {
192  SC_ABORT ("Not implemented.\n");
193  return 0; /* prevents compiler warning */
194  }
195 
201  virtual t8_eclass_t t8_element_child_eclass (int childid) const
202  {
203  SC_ABORT ("This function is not implemented yet.\n");
204  return T8_ECLASS_ZERO; /* suppresses compiler warning */
205  }
206 
216  virtual void t8_element_child (const t8_element_t *elem,
217  int childid,
218  t8_element_t *child) const;
219 
231  virtual void t8_element_children (const t8_element_t *elem,
232  int length,
233  t8_element_t *c[]) const;
234 
239  virtual int t8_element_child_id (const t8_element_t *elem) const;
240 
247  virtual int t8_element_ancestor_id (const t8_element_t *elem,
248  int level) const;
249 
256  virtual int t8_element_is_family (t8_element_t **fam) const;
257 
268  virtual void t8_element_nca (const t8_element_t *elem1,
269  const t8_element_t *elem2,
270  t8_element_t *nca) const;
271 
278  int face) const;
279 
294  virtual void t8_element_children_at_face (const t8_element_t *elem,
295  int face,
296  t8_element_t *children[],
297  int num_children,
298  int *child_indices) const;
299 
320  virtual int t8_element_face_child_face (const t8_element_t *elem,
321  int face,
322  int face_child) const;
323 
334  virtual int t8_element_face_parent_face (const t8_element_t *elem,
335  int face) const;
336 
346  virtual int t8_element_tree_face (const t8_element_t *elem,
347  int face) const;
348 
370  virtual void t8_element_transform_face (const t8_element_t *elem1,
371  t8_element_t *elem2,
372  int orientation, int sign,
373  int is_smaller_face) const
374  {
375  SC_ABORT ("This function is not implemented yet.\n");
376  }
377 
391  virtual int t8_element_extrude_face (const t8_element_t *face,
392  const t8_eclass_scheme_c
393  *face_scheme,
394  t8_element_t *elem,
395  int root_face) const;
396 
406  *elem, int face,
408  *first_desc,
409  int level) const;
410 
420  *elem, int face,
422  *last_desc,
423  int level) const;
424 
434  virtual void t8_element_boundary_face (const t8_element_t *elem,
435  int face,
436  t8_element_t *boundary,
437  const t8_eclass_scheme_c
438  *boundary_scheme) const;
439 
445  virtual void t8_element_boundary (const t8_element_t *elem,
446  int min_dim, int length,
447  t8_element_t **boundary) const;
448 
454  virtual int t8_element_is_root_boundary (const t8_element_t *elem,
455  int face) const;
456 
473  *elem,
474  t8_element_t *neigh,
475  int face,
476  int *neigh_face) const;
477 
485  virtual void t8_element_set_linear_id (t8_element_t *elem,
486  int level,
487  t8_linearidx_t id) const;
488 
496  t8_element_t *elem,
497  int level) const;
498 
505  virtual void t8_element_first_descendant (const t8_element_t *elem,
506  t8_element_t *desc,
507  int level) const;
508 
515  virtual void t8_element_last_descendant (const t8_element_t *elem,
516  t8_element_t *desc,
517  int level) const;
518 
524  virtual void t8_element_successor (const t8_element_t *t,
525  t8_element_t *s, int level) const;
526 
537  virtual void t8_element_anchor (const t8_element_t *elem,
538  int anchor[3]) const;
539 
545  virtual int t8_element_root_len (const t8_element_t *elem) const;
546 
557  virtual void t8_element_vertex_coords (const t8_element_t *elem,
558  const int vertex,
559  int coords[]) const;
560 
568  virtual void t8_element_general_function (const t8_element_t *elem,
569  const void *indata,
570  void *outdata) const;
571 
580  *elem,
581  const int vertex,
582  double coords[])
583  const;
584 
593  virtual void t8_element_reference_coords (const t8_element_t *elem,
594  const double *ref_coords,
595  const void *user_data,
596  double *out_coords)
597  const;
598 
603  virtual int t8_element_refines_irregular (void) const;
604 
605 #ifdef T8_ENABLE_DEBUG
620  virtual int t8_element_is_valid (const t8_element_t *t) const;
621 
629  virtual void t8_element_debug_print (const t8_element_t *elem) const;
630 #endif
631 };
632 
633 #endif /* !T8_DEFAULT_TET_H */
Definition: t8_default_common_cxx.hxx:38
Definition: t8_default_tet_cxx.hxx:38
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_tet_cxx.cxx:470
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_tet_cxx.cxx:318
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_tet_cxx.cxx:128
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_tet_cxx.cxx:268
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_tet_cxx.cxx:205
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_tet_cxx.cxx:534
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_tet_cxx.cxx:234
virtual void t8_element_new(int length, t8_element_t **elem) const
Allocate memory for an array of tetrahedra and initialize them.
Definition: t8_default_tet_cxx.cxx:601
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_tet_cxx.hxx:201
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_tet_cxx.cxx:103
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_tet_cxx.cxx:575
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_tet_cxx.cxx:164
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_tet_cxx.cxx:110
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_tet_cxx.cxx:197
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_tet_cxx.hxx:189
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_tet_cxx.cxx:118
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_tet_cxx.cxx:359
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_tet_cxx.cxx:547
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_tet_cxx.cxx:409
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_tet_cxx.cxx:560
virtual int t8_element_compare(const t8_element_t *elem1, const t8_element_t *elem2) const
Compare two elements.
Definition: t8_default_tet_cxx.cxx:57
virtual int t8_element_num_faces(const t8_element_t *elem) const
Compute the number of faces of a given element.
Definition: t8_default_tet_cxx.cxx:90
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_tet_cxx.cxx:245
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_tet_cxx.cxx:171
virtual int t8_element_level(const t8_element_t *elem) const
Return the refinement level of an element.
Definition: t8_default_tet_cxx.cxx:41
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_tet_cxx.cxx:97
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_tet_cxx.cxx:448
virtual int t8_element_child_id(const t8_element_t *elem) const
Compute the child id of an element.
Definition: t8_default_tet_cxx.cxx:157
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_tet_cxx.cxx:518
t8_default_scheme_tet_c()
Constructor.
Definition: t8_default_tet_cxx.cxx:633
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_tet_cxx.cxx:418
virtual void t8_element_sibling(const t8_element_t *elem, int sibid, t8_element_t *sibling) const
Compute a specific sibling of a given tet element elem and store it in sibling.
Definition: t8_default_tet_cxx.cxx:77
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_tet_cxx.cxx:183
virtual void t8_element_vertex_coords(const t8_element_t *elem, const int vertex, int coords[]) const
Compute the integer coordinates of a given element vertex.
Definition: t8_default_tet_cxx.cxx:525
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_tet_cxx.cxx:141
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_tet_cxx.cxx:506
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_tet_cxx.cxx:460
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_tet_cxx.cxx:495
virtual void t8_element_init(int length, t8_element_t *elem, int called_new) const
Initialize an array of allocated tet elements.
Definition: t8_default_tet_cxx.cxx:618
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_tet_cxx.hxx:370
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_tet_cxx.cxx:65
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_tet_cxx.cxx:483
virtual int t8_element_maxlevel(void) const
Return the maximum allowed level for this element class.
Definition: t8_default_tet_cxx.cxx:35
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_tet_cxx.cxx:428
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_tet_cxx.cxx:254
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_tet_cxx.cxx:336
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_tet_cxx.cxx:48
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.
This file defines basic operations on an element in a refinement tree.
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