t8  UNKNOWN
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:
42 
44 
60  virtual void
61  t8_element_new (int length, t8_element_t **elem) const;
62 
79  virtual void
80  t8_element_init (int length, t8_element_t *elem) const;
81 
86  virtual int
87  t8_element_level (const t8_element_t *elem) const;
88 
92  virtual int
93  t8_element_maxlevel (void) const;
94 
101  virtual void
102  t8_element_copy (const t8_element_t *source, t8_element_t *dest) const;
103 
110  virtual int
111  t8_element_compare (const t8_element_t *elem1, const t8_element_t *elem2) const;
112 
119  virtual int
120  t8_element_equal (const t8_element_t *elem1, const t8_element_t *elem2) const;
121 
131  virtual void
132  t8_element_parent (const t8_element_t *elem, t8_element_t *parent) const;
133 
143  virtual void
144  t8_element_sibling (const t8_element_t *elem, int sibid, t8_element_t *sibling) const;
145 
150  virtual int
151  t8_element_num_faces (const t8_element_t *elem) const;
152 
157  virtual int
158  t8_element_max_num_faces (const t8_element_t *elem) const;
159 
164  virtual int
165  t8_element_num_children (const t8_element_t *elem) const;
166 
172  virtual int
173  t8_element_num_face_children (const t8_element_t *elem, int face) const;
180  virtual int
181  t8_element_get_face_corner (const t8_element_t *element, int face, int corner) const;
182 
189  virtual int
190  t8_element_get_corner_face (const t8_element_t *element, int corner, int face) const
191  {
192  SC_ABORT ("Not implemented.\n");
193  return 0; /* prevents compiler warning */
194  }
195 
203  virtual void
204  t8_element_child (const t8_element_t *elem, int childid, t8_element_t *child) const;
205 
214  virtual void
215  t8_element_children (const t8_element_t *elem, int length, t8_element_t *c[]) const;
216 
221  virtual int
222  t8_element_child_id (const t8_element_t *elem) const;
223 
229  virtual int
230  t8_element_ancestor_id (const t8_element_t *elem, int level) const;
231 
237  virtual int
238  t8_element_is_family (t8_element_t *const *fam) const;
239 
247  virtual void
248  t8_element_nca (const t8_element_t *elem1, const t8_element_t *elem2, t8_element_t *nca) const;
249 
255  virtual t8_element_shape_t
256  t8_element_face_shape (const t8_element_t *elem, int face) const;
257 
269  virtual void
270  t8_element_children_at_face (const t8_element_t *elem, int face, t8_element_t *children[], int num_children,
271  int *child_indices) const;
272 
291  virtual int
292  t8_element_face_child_face (const t8_element_t *elem, int face, int face_child) const;
293 
302  virtual int
303  t8_element_face_parent_face (const t8_element_t *elem, int face) const;
304 
312  virtual int
313  t8_element_tree_face (const t8_element_t *elem, int face) const;
314 
329  virtual void
330  t8_element_transform_face (const t8_element_t *elem1, t8_element_t *elem2, int orientation, int sign,
331  int is_smaller_face) const
332  {
333  SC_ABORT ("This function is not implemented yet.\n");
334  }
335 
345  virtual int
346  t8_element_extrude_face (const t8_element_t *face, const t8_eclass_scheme_c *face_scheme, t8_element_t *elem,
347  int root_face) const;
348 
357  virtual void
358  t8_element_first_descendant_face (const t8_element_t *elem, int face, t8_element_t *first_desc, int level) const;
359 
367  virtual void
368  t8_element_last_descendant_face (const t8_element_t *elem, int face, t8_element_t *last_desc, int level) const;
369 
378  virtual void
379  t8_element_boundary_face (const t8_element_t *elem, int face, t8_element_t *boundary,
380  const t8_eclass_scheme_c *boundary_scheme) const;
381 
387  virtual int
388  t8_element_is_root_boundary (const t8_element_t *elem, int face) const;
389 
401  virtual int
402  t8_element_face_neighbor_inside (const t8_element_t *elem, t8_element_t *neigh, int face, int *neigh_face) const;
403 
410  virtual void
411  t8_element_set_linear_id (t8_element_t *elem, int level, t8_linearidx_t id) const;
412 
418  virtual t8_linearidx_t
419  t8_element_get_linear_id (const t8_element_t *elem, int level) const;
420 
426  virtual void
427  t8_element_first_descendant (const t8_element_t *elem, t8_element_t *desc, int level) const;
428 
434  virtual void
435  t8_element_last_descendant (const t8_element_t *elem, t8_element_t *desc, int level) const;
436 
442  virtual void
443  t8_element_successor (const t8_element_t *elem, t8_element_t *succ) const;
444 
452  virtual void
453  t8_element_anchor (const t8_element_t *elem, int anchor[3]) const;
454 
464  virtual void
465  t8_element_vertex_reference_coords (const t8_element_t *elem, const int vertex, double coords[]) const;
466 
477  virtual void
478  t8_element_reference_coords (const t8_element_t *elem, const double *ref_coords, const size_t num_coords,
479  double *out_coords) const;
480 
485  virtual int
486  t8_element_refines_irregular (void) const;
487 
488 #ifdef T8_ENABLE_DEBUG
503  virtual int
504  t8_element_is_valid (const t8_element_t *t) const;
505 
513  virtual void
514  t8_element_to_string (const t8_element_t *elem, char *debug_string, const int string_size) const;
515 #endif
516 
520  void
521  t8_element_root (t8_element_t *elem) const;
522 
531  virtual void
532  t8_element_MPI_Pack (t8_element_t **const elements, const unsigned int count, void *send_buffer, int buffer_size,
533  int *position, sc_MPI_Comm comm) const;
534 
540  virtual void
541  t8_element_MPI_Pack_size (const unsigned int count, sc_MPI_Comm comm, int *pack_size) const;
542 
551  virtual void
552  t8_element_MPI_Unpack (void *recvbuf, const int buffer_size, int *position, t8_element_t **elements,
553  const unsigned int count, sc_MPI_Comm comm) const;
554 };
555 
556 #endif /* !T8_DEFAULT_TET_H */
Definition: t8_default_common_cxx.hxx:36
Definition: t8_default_tet_cxx.hxx:38
virtual int t8_element_equal(const t8_element_t *elem1, const t8_element_t *elem2) const
Check if two elements are equal.
Definition: t8_default_tet_cxx.cxx:62
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:292
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:125
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:248
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:194
virtual int t8_element_is_family(t8_element_t *const *fam) const
Query whether a given set of elements is a family or not.
Definition: t8_default_tet_cxx.cxx:163
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:218
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:500
void t8_element_root(t8_element_t *elem) const
Fills an element with the root element.
Definition: t8_default_tet_cxx.cxx:545
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:473
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:157
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:187
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:190
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:117
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:324
virtual void t8_element_MPI_Pack(t8_element_t **const elements, const unsigned int count, void *send_buffer, int buffer_size, int *position, sc_MPI_Comm comm) const
Pack multiple elements into contiguous memory, so they can be sent via MPI.
Definition: t8_default_tet_cxx.cxx:556
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:454
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:56
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:227
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:396
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:150
t8_default_scheme_tet_c()
Constructor.
Definition: t8_default_tet_cxx.cxx:528
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:371
virtual void t8_element_MPI_Unpack(void *recvbuf, const int buffer_size, int *position, t8_element_t **elements, const unsigned int count, sc_MPI_Comm comm) const
Unpack multiple elements from contiguous memory that was received via MPI.
Definition: t8_default_tet_cxx.cxx:572
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:79
virtual void t8_element_successor(const t8_element_t *elem, t8_element_t *succ) const
Construct the successor in a uniform refinement of a given element.
Definition: t8_default_tet_cxx.cxx:415
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:175
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:136
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:443
virtual void t8_element_reference_coords(const t8_element_t *elem, const double *ref_coords, const size_t num_coords, double *out_coords) const
Convert points in the reference space of an element to points in the reference space of the tree.
Definition: t8_default_tet_cxx.cxx:462
virtual int t8_element_is_valid(const t8_element_t *t) const
Query whether a given element can be considered as 'valid' and it is safe to perform any of the above...
Definition: t8_default_tet_cxx.cxx:481
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:406
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:434
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:330
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:68
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:425
virtual void t8_element_init(int length, t8_element_t *elem) const
Initialize an array of allocated tet elements.
Definition: t8_default_tet_cxx.cxx:517
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:380
virtual void t8_element_MPI_Pack_size(const unsigned int count, sc_MPI_Comm comm, int *pack_size) const
Determine an upper bound for the size of the packed message of count elements.
Definition: t8_default_tet_cxx.cxx:565
virtual void t8_element_to_string(const t8_element_t *elem, char *debug_string, const int string_size) const
Print a given element.
Definition: t8_default_tet_cxx.cxx:488
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:235
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:306
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:41
uint64_t t8_linearidx_t
A type for storing SFC indices.
Definition: t8.h:109
We provide some functions that are useful across 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