t8_dpyramid_bits.h

Go to the documentation of this file.

/*
  This file is part of t8code.
  t8code is a C library to manage a collection (a forest) of multiple
  connected adaptive space-trees of general element classes in parallel.
 
  Copyright (C) 2015 the developers
 
  t8code is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.
 
  t8code is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with t8code; if not, write to the Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
 
#ifndef T8_DPYRAMID_BITS_H
#define T8_DPYRAMID_BITS_H
 
#include "t8_element.h"
#include "t8_dpyramid.h"
 
T8_EXTERN_C_BEGIN ();
 
void                t8_dpyramid_init_linear_id (t8_dpyramid_t *p,
                                                const int level,
                                                t8_linearidx_t id);
 
int                 t8_dpyramid_get_level (const t8_dpyramid_t *p);
 
void                t8_dpyramid_copy (const t8_dpyramid_t *source,
                                      t8_dpyramid_t *dest);
 
t8_linearidx_t      t8_dpyramid_linear_id (const t8_dpyramid_t *p,
                                           const int level);
 
void                t8_dpyramid_child (const t8_dpyramid_t *elem,
                                       const int child_id,
                                       t8_dpyramid_t *child);
 
void                t8_dpyramid_children (const t8_dpyramid_t *p,
                                          t8_dpyramid_t **c);
 
void                t8_dpyramid_children_at_face (const t8_dpyramid_t *p,
                                                  const int face,
                                                  t8_dpyramid_t *children[],
                                                  const int num_children,
                                                  int *child_indices);
 
int                 t8_dpyramid_face_child_face (const t8_dpyramid_t *p,
                                                 const int face,
                                                 const int face_child);
 
t8_element_shape_t  t8_dpyramid_face_shape (const t8_dpyramid_t *pyra,
                                            int face);
 
int                 t8_dpyramid_get_face_corner (const t8_dpyramid_t *pyra,
                                                 int face, int corner);
 
void                t8_dpyramid_boundary_face (const t8_dpyramid_t *p,
                                               const int face,
                                               t8_element_t *boundary);
 
int                 t8_dpyramid_extrude_face (const t8_element_t *face,
                                              t8_dpyramid_t *p,
                                              const int root_face);
 
int                 t8_dpyramid_compare (const t8_dpyramid_t *p1,
                                         const t8_dpyramid_t *p2);
 
int                 t8_dpyramid_is_family (t8_dpyramid_t **fam);
 
int                 t8_dpyramid_is_root_boundary (const t8_dpyramid_t *p,
                                                  const int face);
 
int                 t8_dpyramid_face_neighbor_inside (const t8_dpyramid_t *p,
                                                      t8_dpyramid_t *neigh,
                                                      const int face,
                                                      int *neigh_face);
 
int                 t8_dpyramid_child_id (const t8_dpyramid_t *p);
 
int                 t8_dpyramid_is_inside_root (const t8_dpyramid_t *p);
 
int                 t8_dpyramid_tet_boundary (const t8_dpyramid_t *p,
                                              const int face);
 
int                 t8_dpyramid_tree_face (const t8_dpyramid_t *p,
                                           const int face);
 
void                t8_dpyramid_first_descendant (const t8_dpyramid_t *p,
                                                  t8_dpyramid_t *desc,
                                                  const int level);
 
void                t8_dpyramid_first_descendant_face (const t8_dpyramid_t *p,
                                                       const int face,
                                                       t8_dpyramid_t
                                                       *first_desc,
                                                       const int level);
 
void                t8_dpyramid_last_descendant (const t8_dpyramid_t *p,
                                                 t8_dpyramid_t *desc,
                                                 int level);
 
void                t8_dpyramid_last_descendant_face (const t8_dpyramid_t *p,
                                                      const int face,
                                                      t8_dpyramid_t
                                                      *last_desc,
                                                      const int level);
 
void                t8_dpyramid_compute_coords (const t8_dpyramid_t *p,
                                                const int vertex,
                                                int coords[]);
 
void                t8_dpyramid_parent (const t8_dpyramid_t *p,
                                        t8_dpyramid_t *parent);
 
int                 t8_dpyramid_num_corners (const t8_dpyramid_t *p);
 
int                 t8_dpyramid_num_children (const t8_dpyramid_t *p);
 
int                 t8_dpyramid_num_siblings (const t8_dpyramid_t *p);
 
int                 t8_dpyramid_num_faces (const t8_dpyramid_t *p);
 
int                 t8_dpyramid_max_num_faces (const t8_dpyramid_t *p);
 
int                 t8_dpyramid_face_parent_face (const t8_dpyramid_t *elem,
                                                  const int face);
 
int                 t8_dpyramid_ancestor_id (const t8_dpyramid_t *p,
                                             const int level);
 
void                t8_dpyramid_ancestor (const t8_dpyramid_t *pyra,
                                          const int level,
                                          t8_dpyramid_t *anc);
 
int                 t8_dpyramid_type_at_level (const t8_dpyramid_t *p,
                                               const int level);
 
t8_element_shape_t  t8_dpyramid_shape (const t8_dpyramid_t *p);
 
void                t8_dpyramid_successor (const t8_dpyramid_t *elem,
                                           t8_dpyramid_t *s, const int level);
 
void                t8_dpyramid_vertex_reference_coords (const t8_dpyramid_t
                                                         *elem,
                                                         const int vertex,
                                                         double coords[]);
 
void                t8_dpyramid_nearest_common_ancestor (const t8_dpyramid_t
                                                         *pyra1,
                                                         const t8_dpyramid_t
                                                         *pyra2,
                                                         t8_dpyramid_t *nca);
 
int                 t8_dpyramid_is_valid (const t8_dpyramid_t *p);
 
void                t8_dpyramid_debug_print (const t8_dpyramid_t *p);
 
T8_EXTERN_C_END ();
 
#endif /* T8_DPYRAMID_BITS_H */