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_line_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_LINE_CXX_HXX
30 #define T8_DEFAULT_LINE_CXX_HXX
31 
32 #include <t8_element.h>
33 #include <t8_element_cxx.hxx>
35 
41 {
42 public:
47 
49 
67  virtual void t8_element_new (int length, t8_element_t **elem) const;
68 
86  virtual void t8_element_init (int length, t8_element_t *elem,
87  int called_new) const;
88 
93  virtual int t8_element_level (const t8_element_t *elem) const;
94 
98  virtual int t8_element_maxlevel (void) const;
99 
107  virtual void t8_element_copy (const t8_element_t *source,
108  t8_element_t *dest) const;
109 
117  virtual int t8_element_compare (const t8_element_t *elem1,
118  const t8_element_t *elem2) const;
119 
132  virtual void t8_element_parent (const t8_element_t *elem,
133  t8_element_t *parent) const;
134 
146  virtual void t8_element_sibling (const t8_element_t *elem,
147  int sibid,
148  t8_element_t *sibling) const
149  {
150  SC_ABORT ("This function is not implemented yet.\n");
151  return; /* suppresses compiler warning */
152  }
153 
158  virtual int t8_element_num_faces (const t8_element_t *elem) const;
159 
165  virtual int t8_element_max_num_faces (const t8_element_t *elem)
166  const;
167 
172  virtual int t8_element_num_children (const t8_element_t *elem)
173  const;
174 
180  virtual int t8_element_num_face_children (const t8_element_t *elem,
181  int face) const;
188  virtual int t8_element_get_face_corner (const t8_element_t *element,
189  int face, int corner) const
190  {
191  SC_ABORT ("Not implemented.\n");
192  return 0; /* prevents compiler warning */
193  }
194 
201  virtual int t8_element_get_corner_face (const t8_element_t *element,
202  int corner, int face) const
203  {
204  SC_ABORT ("Not implemented.\n");
205  return 0; /* prevents compiler warning */
206  }
207 
213  virtual t8_eclass_t t8_element_child_eclass (int childid) const
214  {
215  SC_ABORT ("This function is not implemented yet.\n");
216  return T8_ECLASS_ZERO; /* suppresses compiler warning */
217  }
218 
228  virtual void t8_element_child (const t8_element_t *elem,
229  int childid,
230  t8_element_t *child) const;
231 
243  virtual void t8_element_children (const t8_element_t *elem,
244  int length,
245  t8_element_t *c[]) const;
246 
251  virtual int t8_element_child_id (const t8_element_t *elem) const;
252 
259  virtual int t8_element_ancestor_id (const t8_element_t *elem,
260  int level) const;
261 
268  virtual int t8_element_is_family (t8_element_t **fam) const;
269 
280  virtual void t8_element_nca (const t8_element_t *elem1,
281  const t8_element_t *elem2,
282  t8_element_t *nca) const;
283 
290  int face) const;
291 
306  virtual void t8_element_children_at_face (const t8_element_t *elem,
307  int face,
308  t8_element_t *children[],
309  int num_children,
310  int *child_indices) const;
311 
332  virtual int t8_element_face_child_face (const t8_element_t *elem,
333  int face,
334  int face_child) const;
335 
346  virtual int t8_element_face_parent_face (const t8_element_t *elem,
347  int face) const;
348 
358  virtual int t8_element_tree_face (const t8_element_t *elem,
359  int face) const;
360 
382  virtual void t8_element_transform_face (const t8_element_t *elem1,
383  t8_element_t *elem2,
384  int orientation, int sign,
385  int is_smaller_face) const;
386 
400  virtual int t8_element_extrude_face (const t8_element_t *face,
401  const t8_eclass_scheme_c
402  *face_scheme,
403  t8_element_t *elem,
404  int root_face) const;
405 
415  *elem, int face,
417  *first_desc,
418  int level) const;
419 
429  *elem, int face,
431  *last_desc,
432  int level) const;
433 
443  virtual void t8_element_boundary_face (const t8_element_t *elem,
444  int face,
445  t8_element_t *boundary,
446  const t8_eclass_scheme_c
447  *boundary_scheme) const;
448 
454  virtual void t8_element_boundary (const t8_element_t *elem,
455  int min_dim, int length,
456  t8_element_t **boundary) const
457  {
458  SC_ABORT ("This function is not implemented yet.\n");
459  return; /* suppresses compiler warning */
460  }
461 
467  virtual int t8_element_is_root_boundary (const t8_element_t *elem,
468  int face) const;
469 
486  *elem,
487  t8_element_t *neigh,
488  int face,
489  int *neigh_face) const;
490 
498  virtual void t8_element_set_linear_id (t8_element_t *elem,
499  int level,
500  t8_linearidx_t id) const;
501 
509  t8_element_t *elem,
510  int level) const;
511 
518  virtual void t8_element_first_descendant (const t8_element_t *elem,
519  t8_element_t *desc,
520  int level) const;
521 
528  virtual void t8_element_last_descendant (const t8_element_t *elem,
529  t8_element_t *desc,
530  int level) const;
531 
537  virtual void t8_element_successor (const t8_element_t *t,
538  t8_element_t *s, int level) const;
539 
550  virtual void t8_element_anchor (const t8_element_t *elem,
551  int anchor[3]) const
552  {
553  SC_ABORT ("This function is not implemented yet.\n");
554  return; /* suppresses compiler warning */
555  }
561  virtual int t8_element_root_len (const t8_element_t *elem) const;
562 
573  virtual void t8_element_vertex_coords (const t8_element_t *elem,
574  int vertex,
575  int coords[]) const;
576 
585  *elem,
586  const int vertex,
587  double coords[])
588  const;
589 
598  virtual void t8_element_reference_coords (const t8_element_t *elem,
599  const double *ref_coords,
600  const void *user_data,
601  double *out_coords)
602  const;
603 
608  virtual int t8_element_refines_irregular (void) const;
609 
610 #ifdef T8_ENABLE_DEBUG
625  virtual int t8_element_is_valid (const t8_element_t *t) const;
626 
634  virtual void t8_element_debug_print (const t8_element_t *elem) const;
635 #endif
636 };
637 
638 #endif /* !T8_DEFAULT_LINE_CXX_HXX */
Definition: t8_default_common_cxx.hxx:38
Provide an implementation for the line element class.
Definition: t8_default_line_cxx.hxx:41
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_line_cxx.cxx:457
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_line_cxx.cxx:322
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_line_cxx.cxx:371
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_line_cxx.cxx:47
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_line_cxx.cxx:358
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_line_cxx.hxx:201
virtual int t8_element_num_faces(const t8_element_t *elem) const
Compute the number of faces of a given element.
Definition: t8_default_line_cxx.cxx:400
virtual int t8_element_level(const t8_element_t *elem) const
Return the refinement level of an element.
Definition: t8_default_line_cxx.cxx:40
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_line_cxx.hxx:213
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_line_cxx.cxx:104
virtual int t8_element_child_id(const t8_element_t *elem) const
Compute the child id of an element.
Definition: t8_default_line_cxx.cxx:431
virtual int t8_element_maxlevel(void) const
Return the maximum allowed level for this element class.
Definition: t8_default_line_cxx.cxx:34
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_line_cxx.cxx:407
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_line_cxx.cxx:280
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_line_cxx.cxx:207
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_line_cxx.cxx:254
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_line_cxx.hxx:188
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_line_cxx.cxx:421
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_line_cxx.cxx:349
virtual void t8_element_init(int length, t8_element_t *elem, int called_new) const
Initialize an array of allocated line elements.
Definition: t8_default_line_cxx.cxx:511
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_line_cxx.cxx:148
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_line_cxx.cxx:336
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_line_cxx.cxx:91
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_line_cxx.cxx:158
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_line_cxx.cxx:168
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_line_cxx.cxx:469
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_line_cxx.cxx:383
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_line_cxx.cxx:190
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_line_cxx.cxx:270
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_line_cxx.cxx:66
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_line_cxx.cxx:414
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_line_cxx.cxx:112
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_line_cxx.cxx:78
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_line_cxx.cxx:135
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_line_cxx.cxx:309
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_line_cxx.hxx:550
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_line_cxx.hxx:454
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_line_cxx.cxx:297
virtual void t8_element_new(int length, t8_element_t **elem) const
Allocate memory for an array of lines and initialize them.
Definition: t8_default_line_cxx.cxx:494
t8_default_scheme_line_c()
The virtual table for a particular implementation of an element class.
Definition: t8_default_line_cxx.cxx:526
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_line_cxx.cxx:438
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_line_cxx.cxx:228
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_line_cxx.cxx:390
virtual void t8_element_sibling(const t8_element_t *elem, int sibid, t8_element_t *sibling) const
Compute a specific sibling of a given line element elem and store it in sibling.
Definition: t8_default_line_cxx.hxx:146
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_line_cxx.cxx:449
virtual int t8_element_compare(const t8_element_t *elem1, const t8_element_t *elem2) const
Compare two elements.
Definition: t8_default_line_cxx.cxx:56
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