p8est_bits.h

Go to the documentation of this file.

/*
  This file is part of p4est.
  p4est is a C library to manage a collection (a forest) of multiple
  connected adaptive quadtrees or octrees in parallel.
 
  Copyright (C) 2010 The University of Texas System
  Additional copyright (C) 2011 individual authors
  Written by Carsten Burstedde, Lucas C. Wilcox, and Tobin Isaac
 
  p4est 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.
 
  p4est 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 p4est; if not, write to the Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
 
#ifndef P8EST_BITS_H
#define P8EST_BITS_H
 
#include <p8est.h>
#include <sc_random.h>
 
SC_EXTERN_C_BEGIN;
 
#define P8EST_COORDINATES_IS_VALID(c) \
  (p8est_coordinates_is_valid ((c), P8EST_MAXLEVEL))
 
void                p8est_quadrant_pad (p8est_quadrant_t * q);
 
void                p8est_quadrant_print (int log_priority,
                                          const p8est_quadrant_t * q);
 
int                 p8est_quadrant_is_equal (const p8est_quadrant_t * q1,
                                             const p8est_quadrant_t * q2);
 
void                p8est_quadrant_copy (const p8est_quadrant_t * q,
                                         p8est_quadrant_t * copy);
 
int                 p8est_quadrant_overlaps (const p8est_quadrant_t * q1,
                                             const p8est_quadrant_t * q2);
 
int                 p8est_quadrant_is_equal_piggy (const p8est_quadrant_t *
                                                   q1,
                                                   const p8est_quadrant_t *
                                                   q2);
 
int                 p8est_quadrant_compare (const void *v1, const void *v2);
 
int                 p8est_coordinates_compare (const p4est_qcoord_t v1[],
                                               const p4est_qcoord_t v2[]);
 
int                 p8est_quadrant_disjoint (const void *v1, const void *v2);
 
int                 p8est_quadrant_compare_piggy (const void *v1,
                                                  const void *v2);
 
int                 p8est_quadrant_compare_local_num (const void *v1,
                                                      const void *v2);
 
int                 p8est_quadrant_equal_fn (const void *v1, const void *v2,
                                             const void *u);
 
unsigned            p8est_quadrant_hash_fn (const void *v, const void *u);
 
int                 p8est_node_equal_piggy_fn (const void *v1,
                                               const void *v2, const void *u);
 
unsigned            p8est_node_hash_piggy_fn (const void *v, const void *u);
 
void                p8est_node_clamp_inside (const p8est_quadrant_t * n,
                                             p8est_quadrant_t * r);
 
void                p8est_node_unclamp (p8est_quadrant_t * n);
 
void                p8est_node_to_quadrant (const p8est_quadrant_t * n,
                                            int level, p8est_quadrant_t * q);
 
int                 p8est_quadrant_contains_node (const p8est_quadrant_t * q,
                                                  const p8est_quadrant_t * n);
 
int                 p8est_quadrant_ancestor_id (const p8est_quadrant_t * q,
                                                int level);
 
int                 p8est_quadrant_child_id (const p8est_quadrant_t * q);
 
int                 p8est_coordinates_is_inside_root (const p4est_qcoord_t
                                                      coord[]);
 
int                 p8est_quadrant_is_inside_root (const p8est_quadrant_t *
                                                   q);
 
int                 p8est_quadrant_is_inside_3x3 (const p8est_quadrant_t * q);
 
int                 p8est_quadrant_is_outside_face (const p8est_quadrant_t *
                                                    q);
 
int                 p8est_quadrant_is_outside_edge (const p8est_quadrant_t *
                                                    q);
 
int                 p8est_quadrant_is_outside_edge_extra (const
                                                          p8est_quadrant_t *
                                                          q, int *edge);
 
int                 p8est_quadrant_is_outside_corner (const p8est_quadrant_t *
                                                      q);
 
int                 p8est_quadrant_is_node (const p8est_quadrant_t * q,
                                            int inside);
 
int                 p8est_coordinates_is_valid (const p4est_qcoord_t coord[],
                                                int level);
 
int                 p8est_quadrant_is_valid (const p8est_quadrant_t * q);
 
int                 p8est_quadrant_is_extended (const p8est_quadrant_t * q);
 
int                 p8est_quadrant_is_sibling (const p8est_quadrant_t * q1,
                                               const p8est_quadrant_t * q2);
 
void                p8est_quadrant_child (const p8est_quadrant_t * q,
                                          p8est_quadrant_t * r, int child_id);
 
int                 p8est_quadrant_is_sibling_D (const p8est_quadrant_t * q1,
                                                 const p8est_quadrant_t * q2);
 
int                 p8est_quadrant_is_family (const p8est_quadrant_t * q0,
                                              const p8est_quadrant_t * q1,
                                              const p8est_quadrant_t * q2,
                                              const p8est_quadrant_t * q3,
                                              const p8est_quadrant_t * q4,
                                              const p8est_quadrant_t * q5,
                                              const p8est_quadrant_t * q6,
                                              const p8est_quadrant_t * q7);
 
int                 p8est_quadrant_is_familyv (const p8est_quadrant_t q[]);
 
int                 p8est_quadrant_is_familypv (p8est_quadrant_t * q[]);
 
int                 p8est_quadrant_is_parent (const p8est_quadrant_t * q,
                                              const p8est_quadrant_t * r);
 
int                 p8est_quadrant_is_parent_D (const p8est_quadrant_t * q,
                                                const p8est_quadrant_t * r);
 
int                 p8est_quadrant_is_ancestor (const p8est_quadrant_t * q,
                                                const p8est_quadrant_t * r);
 
int                 p8est_quadrant_is_ancestor_D (const p8est_quadrant_t * q,
                                                  const p8est_quadrant_t * r);
 
int                 p8est_quadrant_is_next (const p8est_quadrant_t * q,
                                            const p8est_quadrant_t * r);
 
int                 p8est_quadrant_is_next_D (const p8est_quadrant_t * q,
                                              const p8est_quadrant_t * r);
 
int                 p8est_quadrant_overlaps_tree (p8est_tree_t * tree,
                                                  const p8est_quadrant_t * q);
 
int                 p8est_quadrant_is_inside_tree (p8est_tree_t * tree,
                                                   const p8est_quadrant_t *
                                                   q);
 
int                 p8est_quadrant_is_first_last (const p8est_quadrant_t * f,
                                                  const p8est_quadrant_t * l,
                                                  const p8est_quadrant_t * a);
 
void                p8est_quadrant_enlarge_first (const p8est_quadrant_t * a,
                                                  p8est_quadrant_t * q);
 
void                p8est_quadrant_enlarge_last (const p8est_quadrant_t * a,
                                                 p8est_quadrant_t * q);
 
void                p8est_quadrant_root (p8est_quadrant_t *root);
 
void                p8est_quadrant_ancestor (const p8est_quadrant_t * q,
                                             int level, p8est_quadrant_t * r);
 
void                p8est_quadrant_parent (const p8est_quadrant_t * q,
                                           p8est_quadrant_t * r);
 
void                p8est_quadrant_sibling (const p8est_quadrant_t * q,
                                            p8est_quadrant_t * r,
                                            int sibling_id);
 
void                p8est_quadrant_volume_coordinates
  (const p8est_quadrant_t * q, p4est_qcoord_t coords[]);
 
void                p8est_quadrant_face_neighbor (const p8est_quadrant_t * q,
                                                  int face,
                                                  p8est_quadrant_t * r);
 
p4est_locidx_t      p8est_quadrant_face_neighbor_extra (const p8est_quadrant_t
                                                        * q, p4est_topidx_t t,
                                                        int face,
                                                        p8est_quadrant_t * r,
                                                        int *nface,
                                                        p8est_connectivity_t *
                                                        conn);
 
void                p8est_quadrant_half_face_neighbors (const p8est_quadrant_t
                                                        * q, int face,
                                                        p8est_quadrant_t n[4],
                                                        p8est_quadrant_t
                                                        nur[4]);
 
void                p8est_quadrant_all_face_neighbors (const p8est_quadrant_t
                                                       * q, int face,
                                                       p8est_quadrant_t n[6]);
 
void                p8est_quadrant_face_coordinates
  (const p8est_quadrant_t * q, int face, p4est_qcoord_t coords[]);
 
void                p8est_quadrant_edge_neighbor (const p8est_quadrant_t * q,
                                                  int edge,
                                                  p8est_quadrant_t * r);
 
void                p8est_quadrant_edge_neighbor_extra (const p8est_quadrant_t
                                                        * q, p4est_locidx_t t,
                                                        int edge, sc_array_t *
                                                        quads, sc_array_t *
                                                        treeids,
                                                        sc_array_t * nedges,
                                                        p8est_connectivity_t *
                                                        conn);
 
void                p8est_quadrant_edge_coordinates
  (const p8est_quadrant_t * q, int edge, p4est_qcoord_t coords[]);
 
void                p8est_quadrant_corner_neighbor (const p8est_quadrant_t *
                                                    q, int corner,
                                                    p8est_quadrant_t * r);
 
void                p8est_quadrant_corner_neighbor_extra (const
                                                          p8est_quadrant_t *
                                                          q, p4est_locidx_t t,
                                                          int corner,
                                                          sc_array_t * quads,
                                                          sc_array_t *
                                                          treeids,
                                                          sc_array_t *
                                                          ncorners,
                                                          p8est_connectivity_t
                                                          * conn);
 
void                p8est_quadrant_half_corner_neighbor (const
                                                         p8est_quadrant_t * q,
                                                         int corner,
                                                         p8est_quadrant_t *
                                                         r);
 
void                p8est_quadrant_corner_node (const p8est_quadrant_t * q,
                                                int corner,
                                                p8est_quadrant_t * r);
 
void                p8est_quadrant_corner_coordinates
  (const p8est_quadrant_t * q, int corner, p4est_qcoord_t coords[]);
 
void                p8est_quadrant_children (const p8est_quadrant_t * q,
                                             p8est_quadrant_t * c0,
                                             p8est_quadrant_t * c1,
                                             p8est_quadrant_t * c2,
                                             p8est_quadrant_t * c3,
                                             p8est_quadrant_t * c4,
                                             p8est_quadrant_t * c5,
                                             p8est_quadrant_t * c6,
                                             p8est_quadrant_t * c7);
 
void                p8est_quadrant_childrenv (const p8est_quadrant_t * q,
                                              p8est_quadrant_t c[]);
 
void                p8est_quadrant_childrenpv (const p8est_quadrant_t * q,
                                               p8est_quadrant_t * c[]);
 
void                p8est_quadrant_first_descendant (const p8est_quadrant_t *
                                                     q, p8est_quadrant_t * fd,
                                                     int level);
 
void                p8est_quadrant_last_descendant (const p8est_quadrant_t *
                                                    q, p8est_quadrant_t * ld,
                                                    int level);
 
void                p8est_quadrant_corner_descendant (const p8est_quadrant_t *
                                                      q, p8est_quadrant_t * r,
                                                      int c, int level);
 
void                p8est_nearest_common_ancestor (const p8est_quadrant_t *
                                                   q1,
                                                   const p8est_quadrant_t *
                                                   q2, p8est_quadrant_t * r);
 
void                p8est_nearest_common_ancestor_D (const p8est_quadrant_t *
                                                     q1,
                                                     const p8est_quadrant_t *
                                                     q2,
                                                     p8est_quadrant_t * r);
 
void                p8est_quadrant_transform_face (const p8est_quadrant_t * q,
                                                   p8est_quadrant_t * r,
                                                   const int ftransform[]);
 
void                p8est_coordinates_transform_face (const p4est_qcoord_t
                                                      coords_in[],
                                                      p4est_qcoord_t
                                                      coords_out[],
                                                      const int ftransform[]);
 
int                 p8est_quadrant_touches_edge (const p8est_quadrant_t * q,
                                                 int edge, int inside);
 
void                p8est_quadrant_transform_edge (const p8est_quadrant_t * q,
                                                   p8est_quadrant_t * r,
                                                   const p8est_edge_info_t *
                                                   ei,
                                                   const
                                                   p8est_edge_transform_t *
                                                   et, int inside);
 
void                p8est_coordinates_transform_edge (const p4est_qcoord_t
                                                      coords_in[],
                                                      p4est_qcoord_t
                                                      coords_out[],
                                                      const
                                                      p8est_edge_info_t *
                                                      ei,
                                                      const
                                                      p8est_edge_transform_t *
                                                      et);
 
void                p8est_quadrant_shift_edge (const p8est_quadrant_t * q,
                                               p8est_quadrant_t * r,
                                               p8est_quadrant_t * rup,
                                               p8est_quadrant_t * rdown,
                                               int edge);
 
int                 p8est_quadrant_touches_corner (const p8est_quadrant_t * q,
                                                   int corner, int inside);
 
void                p8est_coordinates_transform_corner
  (p4est_qcoord_t coords[], int corner);
 
void                p8est_quadrant_transform_corner (p8est_quadrant_t * q,
                                                     int corner, int inside);
 
void                p8est_quadrant_shift_corner (const p8est_quadrant_t * q,
                                                 p8est_quadrant_t * r,
                                                 int corner);
 
uint64_t            p8est_quadrant_linear_id (const p8est_quadrant_t *
                                              quadrant, int level);
 
void                p8est_quadrant_set_morton (p8est_quadrant_t * quadrant,
                                               int level, uint64_t id);
 
void                p8est_quadrant_successor (const p8est_quadrant_t *
                                              quadrant,
                                              p8est_quadrant_t * result);
 
void                p8est_quadrant_predecessor (const p8est_quadrant_t *
                                                quadrant,
                                                p8est_quadrant_t * result);
 
void                p8est_quadrant_srand (const p8est_quadrant_t * q,
                                          sc_rand_state_t * rstate);
 
void                p8est_neighbor_transform_quadrant
  (const p8est_neighbor_transform_t * nt,
   const p8est_quadrant_t * self_quad, p8est_quadrant_t * neigh_quad);
 
void                p8est_neighbor_transform_quadrant_reverse
  (const p8est_neighbor_transform_t * nt,
   const p8est_quadrant_t * neigh_quad, p8est_quadrant_t * self_quad);
 
int                 p8est_quadrant_is_ancestor_face (const p8est_quadrant_t *
                                                     descendant,
                                                     const p8est_quadrant_t *
                                                     ancestor, int face);
 
int                 p8est_quadrant_is_ancestor_corner (const p8est_quadrant_t
                                                       * descendant,
                                                       const p8est_quadrant_t
                                                       * ancestor,
                                                       int corner);
 
SC_EXTERN_C_END;
 
#endif /* !P8EST_BITS_H */