t8  UNKNOWN
t8code is a C library to manage a forest of adaptive space-trees of general element classes in parallel.
t8_default_prism_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_PRISM_CXX_HXX
30 #define T8_DEFAULT_PRISM_CXX_HXX
31 
32 #include <t8_element_cxx.hxx>
33 #include <t8_schemes/t8_default/t8_default_line/t8_default_line_cxx.hxx>
34 #include <t8_schemes/t8_default/t8_default_tri/t8_default_tri_cxx.hxx>
36 
42 {
43  public:
48 
50 
68  virtual void
69  t8_element_new (int length, t8_element_t **elem) const;
70 
88  virtual void
89  t8_element_init (int length, t8_element_t *elem) const;
90 
95  virtual int
96  t8_element_level (const t8_element_t *elem) const;
97 
101  virtual int
102  t8_element_maxlevel (void) const;
103 
111  virtual void
112  t8_element_copy (const t8_element_t *source, t8_element_t *dest) const;
113 
120  virtual int
121  t8_element_compare (const t8_element_t *elem1, const t8_element_t *elem2) const;
122 
129  virtual int
130  t8_element_equal (const t8_element_t *elem1, const t8_element_t *elem2) const;
131 
141  virtual void
142  t8_element_parent (const t8_element_t *elem, t8_element_t *parent) const;
143 
153  virtual void
154  t8_element_sibling (const t8_element_t *elem, int sibid, t8_element_t *sibling) const
155  {
156  SC_ABORT ("This function is not implemented yet.\n");
157  return; /* suppresses compiler warning */
158  }
159 
164  virtual int
165  t8_element_num_faces (const t8_element_t *elem) const;
166 
172  virtual int
173  t8_element_max_num_faces (const t8_element_t *elem) const;
174 
179  virtual int
180  t8_element_num_children (const t8_element_t *elem) const;
181 
187  virtual int
188  t8_element_num_face_children (const t8_element_t *elem, int face) const;
195  virtual int
196  t8_element_get_face_corner (const t8_element_t *element, int face, int corner) const;
197 
204  virtual int
205  t8_element_get_corner_face (const t8_element_t *element, int corner, int face) const
206  {
207  SC_ABORT ("This function is not implemented yet.\n");
208  return 0; /* suppresses compiler warning */
209  }
210 
217  virtual void
218  t8_element_child (const t8_element_t *elem, int childid, t8_element_t *child) const;
219 
230  virtual void
231  t8_element_children (const t8_element_t *elem, int length, t8_element_t *c[]) const;
232 
237  virtual int
238  t8_element_child_id (const t8_element_t *elem) const;
239 
245  virtual int
246  t8_element_ancestor_id (const t8_element_t *elem, int level) const;
247 
254  virtual int
255  t8_element_is_family (t8_element_t *const *fam) const;
256 
264  virtual void
265  t8_element_nca (const t8_element_t *elem1, const t8_element_t *elem2, t8_element_t *nca) const;
266 
272  virtual t8_element_shape_t
273  t8_element_face_shape (const t8_element_t *elem, int face) const;
274 
286  virtual void
287  t8_element_children_at_face (const t8_element_t *elem, int face, t8_element_t *children[], int num_children,
288  int *child_indices) const;
289 
308  virtual int
309  t8_element_face_child_face (const t8_element_t *elem, int face, int face_child) const;
310 
319  virtual int
320  t8_element_face_parent_face (const t8_element_t *elem, int face) const;
321 
330  virtual int
331  t8_element_tree_face (const t8_element_t *elem, int face) const;
332 
354  virtual void
355  t8_element_transform_face (const t8_element_t *elem1, t8_element_t *elem2, int orientation, int sign,
356  int is_smaller_face) const
357  {
358  SC_ABORT ("This function is not implemented yet.\n");
359  return; /* suppresses compiler warning */
360  }
361 
375  virtual int
376  t8_element_extrude_face (const t8_element_t *face, const t8_eclass_scheme_c *face_scheme, t8_element_t *elem,
377  int root_face) const;
378 
387  virtual void
388  t8_element_first_descendant_face (const t8_element_t *elem, int face, t8_element_t *first_desc, int level) const;
389 
398  virtual void
399  t8_element_last_descendant_face (const t8_element_t *elem, int face, t8_element_t *last_desc, int level) const;
400 
410  virtual void
411  t8_element_boundary_face (const t8_element_t *elem, int face, t8_element_t *boundary,
412  const t8_eclass_scheme_c *boundary_scheme) const;
413 
419  virtual int
420  t8_element_is_root_boundary (const t8_element_t *elem, int face) const;
421 
437  virtual int
438  t8_element_face_neighbor_inside (const t8_element_t *elem, t8_element_t *neigh, int face, int *neigh_face) const;
439 
446  virtual void
447  t8_element_set_linear_id (t8_element_t *elem, int level, t8_linearidx_t id) const;
448 
455  virtual t8_linearidx_t
456  t8_element_get_linear_id (const t8_element_t *elem, int level) const;
457 
463  virtual void
464  t8_element_first_descendant (const t8_element_t *elem, t8_element_t *desc, int level) const;
465 
471  virtual void
472  t8_element_last_descendant (const t8_element_t *elem, t8_element_t *desc, int level) const;
473 
479  virtual void
480  t8_element_successor (const t8_element_t *elem, t8_element_t *succ) const;
481 
489  virtual void
490  t8_element_anchor (const t8_element_t *elem, int anchor[3]) const;
491 
501  virtual void
502  t8_element_vertex_reference_coords (const t8_element_t *elem, const int vertex, double coords[]) const;
503 
514  virtual void
515  t8_element_reference_coords (const t8_element_t *elem, const double *ref_coords, const size_t num_coords,
516  double *out_coords) const;
517 
522  virtual int
523  t8_element_refines_irregular (void) const;
524 
525 #ifdef T8_ENABLE_DEBUG
540  virtual int
541  t8_element_is_valid (const t8_element_t *t) const;
542 
550  virtual void
551  t8_element_to_string (const t8_element_t *elem, char *debug_string, const int string_size) const;
552 #endif
553 
557  void
558  t8_element_root (t8_element_t *elem) const;
559 
568  virtual void
569  t8_element_MPI_Pack (t8_element_t **const elements, const unsigned int count, void *send_buffer, int buffer_size,
570  int *position, sc_MPI_Comm comm) const;
571 
577  virtual void
578  t8_element_MPI_Pack_size (const unsigned int count, sc_MPI_Comm comm, int *pack_size) const;
579 
588  virtual void
589  t8_element_MPI_Unpack (void *recvbuf, const int buffer_size, int *position, t8_element_t **elements,
590  const unsigned int count, sc_MPI_Comm comm) const;
591 };
592 
593 #endif /* !T8_DEFAULT_PRISM_CXX_HXX */
Definition: t8_default_common_cxx.hxx:36
Provide an implementation for the prism element class.
Definition: t8_default_prism_cxx.hxx:42
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_prism_cxx.cxx:381
void t8_element_root(t8_element_t *elem) const
Fills an element with the root element.
Definition: t8_default_prism_cxx.cxx:459
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_prism_cxx.cxx:372
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_prism_cxx.cxx:220
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_prism_cxx.cxx:407
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_prism_cxx.cxx:287
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_prism_cxx.cxx:243
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_prism_cxx.hxx:205
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_prism_cxx.cxx:318
virtual int t8_element_maxlevel(void) const
Return the maximum allowed level for this element class.
Definition: t8_default_prism_cxx.cxx:63
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_prism_cxx.hxx:355
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_prism_cxx.cxx:129
virtual int t8_element_compare(const t8_element_t *elem1, const t8_element_t *elem2) const
Compare two elements.
Definition: t8_default_prism_cxx.cxx:93
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_prism_cxx.cxx:85
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_prism_cxx.cxx:161
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_prism_cxx.cxx:353
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_prism_cxx.cxx:228
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_prism_cxx.cxx:269
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_prism_cxx.cxx:115
virtual void t8_element_init(int length, t8_element_t *elem) const
Initialize an array of allocated prism elements.
Definition: t8_default_prism_cxx.cxx:50
virtual void t8_element_new(int length, t8_element_t **elem) const
Allocate memory for an array of prisms and initialize them.
Definition: t8_default_prism_cxx.cxx:33
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_prism_cxx.cxx:255
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_prism_cxx.cxx:391
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_prism_cxx.cxx:300
virtual int t8_element_num_faces(const t8_element_t *elem) const
Compute the number of faces of a given element.
Definition: t8_default_prism_cxx.cxx:139
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_prism_cxx.cxx:212
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_prism_cxx.cxx:430
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_prism_cxx.cxx:188
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_prism_cxx.cxx:414
t8_default_scheme_prism_c(void)
The virtual table for a particular implementation of an element class.
Definition: t8_default_prism_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_prism_cxx.cxx:399
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_prism_cxx.cxx:203
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_prism_cxx.cxx:107
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_prism_cxx.cxx:122
virtual int t8_element_child_id(const t8_element_t *elem) const
Compute the child id of an element.
Definition: t8_default_prism_cxx.cxx:146
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_prism_cxx.cxx:471
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_prism_cxx.cxx:325
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_prism_cxx.cxx:76
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_prism_cxx.cxx:516
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_prism_cxx.cxx:153
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_prism_cxx.cxx:168
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_prism_cxx.cxx:363
virtual int t8_element_level(const t8_element_t *elem) const
Return the refinement level of an element.
Definition: t8_default_prism_cxx.cxx:69
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_prism_cxx.cxx:423
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_prism_cxx.cxx:495
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_prism_cxx.cxx:181
virtual void t8_element_sibling(const t8_element_t *elem, int sibid, t8_element_t *sibling) const
Compute a specific sibling of a given prism element elem and store it in sibling.
Definition: t8_default_prism_cxx.hxx:154
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_prism_cxx.cxx:342
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_prism_cxx.cxx:101
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.
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