p4est  2.8.643-dbc7-dirty
p4est is a software library for parallel adaptive mesh refinement.
p8est_bits.h
Go to the documentation of this file.
1 /*
2  This file is part of p4est.
3  p4est is a C library to manage a collection (a forest) of multiple
4  connected adaptive quadtrees or octrees in parallel.
5 
6  Copyright (C) 2010 The University of Texas System
7  Additional copyright (C) 2011 individual authors
8  Written by Carsten Burstedde, Lucas C. Wilcox, and Tobin Isaac
9 
10  p4est is free software; you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation; either version 2 of the License, or
13  (at your option) any later version.
14 
15  p4est is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  GNU General Public License for more details.
19 
20  You should have received a copy of the GNU General Public License
21  along with p4est; if not, write to the Free Software Foundation, Inc.,
22  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 */
24 
32 #ifndef P8EST_BITS_H
33 #define P8EST_BITS_H
34 
35 #include <p8est.h>
36 #include <sc_random.h>
37 
38 SC_EXTERN_C_BEGIN;
39 
44 
50 void p8est_quadrant_print (int log_priority,
51  const p8est_quadrant_t * q);
52 
57  const p8est_quadrant_t * q2);
58 
65  p8est_quadrant_t * copy);
66 
72  const p8est_quadrant_t * q2);
73 
79  q1,
80  const p8est_quadrant_t *
81  q2);
82 
89 int p8est_quadrant_compare (const void *v1, const void *v2);
90 
101  const p4est_qcoord_t v2[]);
102 
109 int p8est_quadrant_disjoint (const void *v1, const void *v2);
110 
117 int p8est_quadrant_compare_piggy (const void *v1,
118  const void *v2);
119 
126  const void *v2);
127 
131 int p8est_quadrant_equal_fn (const void *v1, const void *v2,
132  const void *u);
133 
136 unsigned p8est_quadrant_hash_fn (const void *v, const void *u);
137 
143 int p8est_node_equal_piggy_fn (const void *v1,
144  const void *v2, const void *u);
145 
150 unsigned p8est_node_hash_piggy_fn (const void *v, const void *u);
151 
157  p8est_quadrant_t * r);
158 
163 
170  int level, p8est_quadrant_t * q);
171 
177  const p8est_quadrant_t * n);
178 
184  int level);
185 
190 
196  coord[]);
197 
203  q);
204 
210 
216  q);
217 
223  q);
224 
233  q, int *edge);
234 
240  q);
241 
249  int inside);
250 
257  int level);
258 
264 
270 
277  const p8est_quadrant_t * q2);
278 
286  p8est_quadrant_t * r, int child_id);
287 
293  const p8est_quadrant_t * q2);
294 
298  const p8est_quadrant_t * q1,
299  const p8est_quadrant_t * q2,
300  const p8est_quadrant_t * q3,
301  const p8est_quadrant_t * q4,
302  const p8est_quadrant_t * q5,
303  const p8est_quadrant_t * q6,
304  const p8est_quadrant_t * q7);
305 
310 
315 
322  const p8est_quadrant_t * r);
323 
329  const p8est_quadrant_t * r);
330 
337  const p8est_quadrant_t * r);
338 
345  const p8est_quadrant_t * r);
346 
354  const p8est_quadrant_t * r);
355 
361  const p8est_quadrant_t * r);
362 
366  const p8est_quadrant_t * q);
367 
371  const p8est_quadrant_t *
372  q);
373 
384  const p8est_quadrant_t * l,
385  const p8est_quadrant_t * a);
386 
396  p8est_quadrant_t * q);
397 
407  p8est_quadrant_t * q);
408 
418  int level, p8est_quadrant_t * r);
419 
429  p8est_quadrant_t * r);
430 
438  p8est_quadrant_t * r,
439  int sibling_id);
440 
448  int face,
449  p8est_quadrant_t * r);
450 
468  * q, p4est_topidx_t t,
469  int face,
470  p8est_quadrant_t * r,
471  int *nface,
473  conn);
474 
489  * q, int face,
490  p8est_quadrant_t n[],
492  nur[]);
493 
512  * q, int face,
513  p8est_quadrant_t n[]);
514 
522  int edge,
523  p8est_quadrant_t * r);
524 
542  * q, p4est_locidx_t t,
543  int edge, sc_array_t *
544  quads, sc_array_t *
545  treeids,
546  sc_array_t * nedges,
548  conn);
549 
557  q, int corner,
558  p8est_quadrant_t * r);
559 
576  q, p4est_locidx_t t,
577  int corner,
578  sc_array_t * quads,
579  sc_array_t *
580  treeids,
581  sc_array_t *
582  ncorners,
584  * conn);
585 
593  p8est_quadrant_t * q,
594  int corner,
596  r);
597 
605  int corner,
606  p8est_quadrant_t * r);
607 
615  p8est_quadrant_t * c0,
616  p8est_quadrant_t * c1,
617  p8est_quadrant_t * c2,
618  p8est_quadrant_t * c3,
619  p8est_quadrant_t * c4,
620  p8est_quadrant_t * c5,
621  p8est_quadrant_t * c6,
622  p8est_quadrant_t * c7);
623 
631  p8est_quadrant_t c[]);
632 
640  p8est_quadrant_t * c[]);
641 
648  q, p8est_quadrant_t * fd,
649  int level);
650 
657  q, p8est_quadrant_t * ld,
658  int level);
659 
668  q, p8est_quadrant_t * r,
669  int c, int level);
670 
680  q1,
681  const p8est_quadrant_t *
682  q2, p8est_quadrant_t * r);
683 
689  q1,
690  const p8est_quadrant_t *
691  q2,
692  p8est_quadrant_t * r);
693 
704  p8est_quadrant_t * r,
705  const int ftransform[]);
706 
716  coords_in[],
718  coords_out[],
719  const int ftransform[]);
720 
724  int edge, int inside);
725 
734  p8est_quadrant_t * r,
735  const p8est_edge_info_t *
736  ei,
737  const
739  et, int inside);
740 
748  coords_in[],
750  coords_out[],
751  const
753  ei,
754  const
756  et);
757 
776  p8est_quadrant_t * r,
777  p8est_quadrant_t * rup,
778  p8est_quadrant_t * rdown,
779  int edge);
780 
784  int corner, int inside);
785 
792  int corner, int inside);
793 
800  p8est_quadrant_t * r,
801  int corner);
802 
821  quadrant, int level);
822 
831  int level, uint64_t id);
832 
840  quadrant,
841  p8est_quadrant_t * result);
842 
850  quadrant,
851  p8est_quadrant_t * result);
852 
859  sc_rand_state_t * rstate);
860 
872  (const p8est_neighbor_transform_t * nt,
873  const p8est_quadrant_t * self_quad, p8est_quadrant_t * neigh_quad);
874 
886  (const p8est_neighbor_transform_t * nt,
887  const p8est_quadrant_t * neigh_quad, p8est_quadrant_t * self_quad);
888 SC_EXTERN_C_END;
889 
890 #endif /* !P8EST_BITS_H */
int32_t p4est_qcoord_t
Typedef for quadrant coordinates.
Definition: p4est_base.h:81
int32_t p4est_topidx_t
Typedef for counting topological entities (trees, tree vertices).
Definition: p4est_base.h:93
int32_t p4est_locidx_t
Typedef for processor-local indexing of quadrants and nodes.
Definition: p4est_base.h:106
The top-level 3D p8est interface.
void p8est_quadrant_set_morton(p8est_quadrant_t *quadrant, int level, uint64_t id)
Set quadrant Morton indices based on linear position in uniform grid.
int p8est_quadrant_contains_node(const p8est_quadrant_t *q, const p8est_quadrant_t *n)
Decide if a node is completely contained within a quadrant.
int p8est_quadrant_is_parent_D(const p8est_quadrant_t *q, const p8est_quadrant_t *r)
Test if a quadrant is the parent of another quadrant.
void p8est_quadrant_half_face_neighbors(const p8est_quadrant_t *q, int face, p8est_quadrant_t n[], p8est_quadrant_t nur[])
Get the smaller face neighbors of q.
void p8est_neighbor_transform_quadrant(const p8est_neighbor_transform_t *nt, const p8est_quadrant_t *self_quad, p8est_quadrant_t *neigh_quad)
Transform a quadrant from self's coordinate system to neighbor's coordinate system.
void p8est_quadrant_parent(const p8est_quadrant_t *q, p8est_quadrant_t *r)
Compute the parent of a quadrant.
int p8est_quadrant_is_first_last(const p8est_quadrant_t *f, const p8est_quadrant_t *l, const p8est_quadrant_t *a)
Whether two descendants of a quadrant are first and last, up to size.
void p8est_quadrant_corner_descendant(const p8est_quadrant_t *q, p8est_quadrant_t *r, int c, int level)
Compute the descendant of a quadrant touching a given corner.
int p8est_quadrant_is_outside_edge_extra(const p8est_quadrant_t *q, int *edge)
Test if a quadrant is outside a tree edge boundary (no corner).
int p8est_quadrant_is_equal(const p8est_quadrant_t *q1, const p8est_quadrant_t *q2)
Test if two quadrants have equal Morton indices.
int p8est_quadrant_is_node(const p8est_quadrant_t *q, int inside)
Test if a quadrant is used to represent a mesh node.
void p8est_quadrant_child(const p8est_quadrant_t *q, p8est_quadrant_t *r, int child_id)
Compute a specific child of a quadrant.
int p8est_quadrant_compare_local_num(const void *v1, const void *v2)
Compare two quadrants with respect to their local_num in the piggy3 member.
int p8est_quadrant_is_sibling_D(const p8est_quadrant_t *q1, const p8est_quadrant_t *q2)
Test if two quadrants are siblings.
void p8est_quadrant_edge_neighbor(const p8est_quadrant_t *q, int edge, p8est_quadrant_t *r)
Compute the edge neighbor of a quadrant.
void p8est_quadrant_transform_corner(p8est_quadrant_t *r, int corner, int inside)
Move a quadrant inside or diagonally outside a corner position.
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)
Compute the edge neighbors of a quadrant, transforming across tree boundaries if necessary.
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)
Transforms a quadrant across an edge between trees.
void p4est_neighbor_transform_quadrant_reverse(const p8est_neighbor_transform_t *nt, const p8est_quadrant_t *neigh_quad, p8est_quadrant_t *self_quad)
Transform a quadrant from a neighbors's coordinate system to self's coordinate system.
void p8est_quadrant_transform_face(const p8est_quadrant_t *q, p8est_quadrant_t *r, const int ftransform[])
Transforms a quadrant/node across a face between trees.
int p8est_quadrant_is_inside_root(const p8est_quadrant_t *q)
Test if a quadrant is inside the unit tree.
void p8est_quadrant_predecessor(const p8est_quadrant_t *quadrant, p8est_quadrant_t *result)
Compute the predecessor according to the Morton index in a uniform mesh.
void p8est_quadrant_corner_neighbor(const p8est_quadrant_t *q, int corner, p8est_quadrant_t *r)
Compute the corner neighbor of a quadrant.
int p8est_quadrant_is_ancestor(const p8est_quadrant_t *q, const p8est_quadrant_t *r)
Test if a quadrant is an ancestor of another quadrant.
void p8est_quadrant_ancestor(const p8est_quadrant_t *q, int level, p8est_quadrant_t *r)
Compute the ancestor of a quadrant at a given level.
void p8est_quadrant_corner_node(const p8est_quadrant_t *q, int corner, p8est_quadrant_t *r)
Compute the corner node of a quadrant.
int p8est_quadrant_compare(const void *v1, const void *v2)
Compare two quadrants in their Morton ordering.
int p8est_quadrant_overlaps(const p8est_quadrant_t *q1, const p8est_quadrant_t *q2)
Test if two quadrants overlap.
int p8est_coordinates_is_inside_root(const p4est_qcoord_t coord[])
Test if Morton indices are inside the unit tree.
void p8est_quadrant_enlarge_first(const p8est_quadrant_t *a, p8est_quadrant_t *q)
Enlarge a quadrant as long as its first corner stays the same.
void p8est_quadrant_shift_corner(const p8est_quadrant_t *q, p8est_quadrant_t *r, int corner)
Shifts a quadrant until it touches the specified corner from the inside.
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)
Test if 8 quadrants are siblings in Morton ordering.
void p8est_quadrant_enlarge_last(const p8est_quadrant_t *a, p8est_quadrant_t *q)
Enlarge a quadrant as long as its last corner stays the same.
int p8est_node_equal_piggy_fn(const void *v1, const void *v2, const void *u)
Test if two nodes are in the same tree and have equal Morton indices.
int p8est_coordinates_compare(const p4est_qcoord_t v1[], const p4est_qcoord_t v2[])
Compare two sets of coordinates in their Morton ordering.
int p8est_quadrant_is_inside_3x3(const p8est_quadrant_t *q)
Test if a quadrant is inside the 3x3 box around the root tree.
int p8est_quadrant_compare_piggy(const void *v1, const void *v2)
Compare two quadrants in their Morton ordering and the which_tree member.
void p8est_node_clamp_inside(const p8est_quadrant_t *n, p8est_quadrant_t *r)
Clamp a node inside the unit tree if it sits on a high border.
int p8est_quadrant_touches_corner(const p8est_quadrant_t *q, int corner, int inside)
Checks if a quadrant touches a corner (diagonally inside or outside).
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)
Compute the corner neighbors of a quadrant, transforming across tree boundaries if necessary.
void p8est_quadrant_pad(p8est_quadrant_t *q)
Write -1 into the pad8 and pad16 members of a quadrant.
void p8est_quadrant_srand(const p8est_quadrant_t *q, sc_rand_state_t *rstate)
Initialize a random number generator by quadrant coordinates.
void p8est_node_to_quadrant(const p8est_quadrant_t *n, int level, p8est_quadrant_t *q)
Find the enclosing quadrant of a given node at a given level.
int p8est_quadrant_equal_fn(const void *v1, const void *v2, const void *u)
Test if two quadrants have equal Morton indices, callback version.
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)
Compute the 8 children of a quadrant.
int p8est_quadrant_is_next_D(const p8est_quadrant_t *q, const p8est_quadrant_t *r)
Test if two quadrants follow each other in the tree with no holes.
void p8est_quadrant_print(int log_priority, const p8est_quadrant_t *q)
Prints one line with quadrant's x, y, z and level.
unsigned p8est_quadrant_hash_fn(const void *v, const void *u)
Computes a hash value for a quadrant by the lookup3 method.
int p8est_coordinates_is_valid(const p4est_qcoord_t coord[], int level)
Test if Morton indices are valid and are inside the unit tree.
int p8est_quadrant_is_next(const p8est_quadrant_t *q, const p8est_quadrant_t *r)
Test if two quadrants follow each other in the tree with no holes.
void p8est_quadrant_half_corner_neighbor(const p8est_quadrant_t *q, int corner, p8est_quadrant_t *r)
Compute the half size corner neighbor of a quadrant.
int p8est_quadrant_touches_edge(const p8est_quadrant_t *q, int edge, int inside)
Checks if a quadrant touches an edge (diagonally inside or outside).
int p8est_quadrant_is_parent(const p8est_quadrant_t *q, const p8est_quadrant_t *r)
Test if a quadrant is the parent of another quadrant.
int p8est_quadrant_disjoint(const void *v1, const void *v2)
Compare two quadrants in their Morton ordering, with equivalence if the two quadrants overlap.
int p8est_quadrant_is_equal_piggy(const p8est_quadrant_t *q1, const p8est_quadrant_t *q2)
Test if two quadrants have equal Morton indices and the same tree id.
void p8est_node_unclamp(p8est_quadrant_t *n)
Move a clamped node out on the border.
void p8est_coordinates_transform_face(const p4est_qcoord_t coords_in[], p4est_qcoord_t coords_out[], const int ftransform[])
Transforms coordinates across a face between trees.
int p8est_quadrant_is_ancestor_D(const p8est_quadrant_t *q, const p8est_quadrant_t *r)
Test if a quadrant is an ancestor of another quadrant.
void p8est_quadrant_shift_edge(const p8est_quadrant_t *q, p8est_quadrant_t *r, p8est_quadrant_t *rup, p8est_quadrant_t *rdown, int edge)
Shifts a quadrant until it touches the specified edge from the inside.
uint64_t p8est_quadrant_linear_id(const p8est_quadrant_t *quadrant, int level)
Computes the linear position of a quadrant in a uniform grid.
void p8est_quadrant_face_neighbor(const p8est_quadrant_t *q, int face, p8est_quadrant_t *r)
Compute the face neighbor of a quadrant.
unsigned p8est_node_hash_piggy_fn(const void *v, const void *u)
Compute hash value of a node based on its tree and Morton index.
int p8est_quadrant_is_inside_tree(p8est_tree_t *tree, const p8est_quadrant_t *q)
Test if a quadrant is completely contained within a tree.
void p8est_quadrant_sibling(const p8est_quadrant_t *q, p8est_quadrant_t *r, int sibling_id)
Compute a specific sibling of a quadrant.
int p8est_quadrant_is_outside_face(const p8est_quadrant_t *q)
Test if a quadrant is outside a tree face boundary (no edge or corner).
int p8est_quadrant_is_extended(const p8est_quadrant_t *q)
Test if a quadrant has valid Morton indices in the 3x3 box around root.
int p8est_quadrant_is_familypv(p8est_quadrant_t *q[])
Test if 8 quadrants are siblings in Morton ordering, array version.
int p8est_quadrant_overlaps_tree(p8est_tree_t *tree, const p8est_quadrant_t *q)
Test if a quadrant has at least partial overlap with a tree.
void p8est_quadrant_copy(const p8est_quadrant_t *q, p8est_quadrant_t *copy)
Copy the Morton indices of the quadrant q.
void p8est_quadrant_last_descendant(const p8est_quadrant_t *q, p8est_quadrant_t *ld, int level)
Compute the last descendant of a quadrant on a given level.
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)
Compute the face neighbor of a quadrant, transforming across tree boundaries if necessary.
int p8est_quadrant_is_outside_corner(const p8est_quadrant_t *q)
Test if a quadrant is outside a tree corner boundary.
int p8est_quadrant_ancestor_id(const p8est_quadrant_t *q, int level)
Compute the position of the ancestor of this child at level level within its siblings.
int p8est_quadrant_is_valid(const p8est_quadrant_t *q)
Test if a quadrant has valid Morton indices and is inside the unit tree.
void p8est_quadrant_first_descendant(const p8est_quadrant_t *q, p8est_quadrant_t *fd, int level)
Compute the first descendant of a quadrant on a given level.
int p8est_quadrant_is_familyv(const p8est_quadrant_t q[])
Test if 8 quadrants are siblings in Morton ordering, array version.
void p8est_quadrant_childrenpv(const p8est_quadrant_t *q, p8est_quadrant_t *c[])
Compute the 8 children of a quadrant, array version.
int p8est_quadrant_child_id(const p8est_quadrant_t *q)
Compute the position of this child within its siblings.
void p8est_quadrant_all_face_neighbors(const p8est_quadrant_t *q, int face, p8est_quadrant_t n[])
Create all possible face neighbors of q.
void p8est_quadrant_childrenv(const p8est_quadrant_t *q, p8est_quadrant_t c[])
Compute the 8 children of a quadrant, array version.
void p8est_quadrant_successor(const p8est_quadrant_t *quadrant, p8est_quadrant_t *result)
Compute the successor according to the Morton index in a uniform mesh.
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)
Transforms coordinates on an edge between trees.
void p8est_nearest_common_ancestor_D(const p8est_quadrant_t *q1, const p8est_quadrant_t *q2, p8est_quadrant_t *r)
Computes the nearest common ancestor of two quadrants in the same tree.
void p8est_nearest_common_ancestor(const p8est_quadrant_t *q1, const p8est_quadrant_t *q2, p8est_quadrant_t *r)
Computes the nearest common ancestor of two quadrants in the same tree.
int p8est_quadrant_is_sibling(const p8est_quadrant_t *q1, const p8est_quadrant_t *q2)
Test if two quadrants are siblings.
int p8est_quadrant_is_outside_edge(const p8est_quadrant_t *q)
Test if a quadrant is outside a tree edge boundary (no corner).
uint64_t sc_rand_state_t
This structure holds the 3D inter-tree connectivity information.
Definition: p8est_connectivity.h:174
Definition: p8est_connectivity.h:229
Definition: p8est_connectivity.h:222
Generic interface for transformations beteen a tree and any of its neighbors.
Definition: p8est_connectivity.h:251
The 3D quadrant (i.e., octant) datatype.
Definition: p8est.h:68
The p8est tree datatype.
Definition: p8est.h:111