/usr/include/p8est_bits.h is in libp4est-dev 1.1-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 | /*
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
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.
*/
/** \file p8est_bits.h
*
* Routines for manipulating quadrants (neighbors, parents, children, etc.)
*
* \ingroup p8est
*/
#ifndef P8EST_BITS_H
#define P8EST_BITS_H
#include <p8est.h>
SC_EXTERN_C_BEGIN;
/** Prints one line with quadrant's x, y, z and level.
* \param [in] log_priority see \ref logpriorities in sc.h for the meanings
* of numerical priority values
* \param [in] q quadrant to print
*/
void p8est_quadrant_print (int log_priority,
const p8est_quadrant_t * q);
/** Test if two quadrants have equal Morton indices.
* \return true if \a q1 describes the same quadrant as \a q2.
*/
int p8est_quadrant_is_equal (const p8est_quadrant_t * q1,
const p8est_quadrant_t * q2);
/** Test if two quadrants overlap.
* \return true if \a q1 and \a q2 are equal or one is the ancestor of the
* other.
*/
int p8est_quadrant_overlaps (const p8est_quadrant_t * q1,
const p8est_quadrant_t * q2);
/** Test if two quadrants have equal Morton indices and the same tree id.
* \return true if \a q1 describes the same quadrant as \a q2
* and the p.which_tree fields are equal.
*/
int p8est_quadrant_is_equal_piggy (const p8est_quadrant_t *
q1,
const p8est_quadrant_t *
q2);
/** Compare two quadrants in their Morton ordering.
* Both quadrants must be valid.
* \return Returns < 0 if \a v1 < \a v2,
* 0 if \a v1 == \a v2,
* > 0 if \a v1 > \a v2
*/
int p8est_quadrant_compare (const void *v1, const void *v2);
/** Compare two quadrants in their Morton ordering, with equivalence if the
* two quadrants overlap.
* \return Returns < 0 if \a v1 < \a v2 and \a v1 and \v2 do not overlap,
* 0 if \a v1 and \a v2 overlap,
* > 0 if \a v1 > \a v2 and \a v1 and \v2 do not overlap.
*/
int p8est_quadrant_disjoint (const void *v1, const void *v2);
/** Compare two quadrants in their Morton ordering and the which_tree member.
* Both quadrants must be extended (superset of valid, see below).
* \return Returns < 0 if \a v1 < \a v2,
* 0 if \a v1 == \a v2,
* > 0 if \a v1 > \a v2
*/
int p8est_quadrant_compare_piggy (const void *v1,
const void *v2);
/** Compare two quadrants with respect to their local_num in the piggy3 member.
* \return Returns < 0 if \a v1 < \a v2,
* 0 if \a v1 == \a v2,
* > 0 if \a v1 > \a v2
*/
int p8est_quadrant_compare_local_num (const void *v1,
const void *v2);
/** Test if two quadrants have equal Morton indices, callback version.
* \return true if \a v1 describes the same quadrant as \a v2.
*/
int p8est_quadrant_equal_fn (const void *v1, const void *v2,
const void *u);
/** Computes a hash value for a quadrant by the lookup3 method.
*/
unsigned p8est_quadrant_hash_fn (const void *v, const void *u);
/** Test if two nodes are in the same tree and have equal Morton indices.
* \param [in] v1 Pointer to a clamped or unclamped node, depending on u.
* \param [in] v2 Pointer to a clamped or unclamped node, depending on u.
* \param [in] u User data, points to an int holding the clamped-flag.
*/
int p8est_node_equal_piggy_fn (const void *v1,
const void *v2, const void *u);
/** Compute hash value of a node based on its tree and Morton index.
* \param [in] v Pointer to a clamped or unclamped node, depending on u.
* \param [in] u User data, points to an int holding the clamped-flag.
*/
unsigned p8est_node_hash_piggy_fn (const void *v, const void *u);
/** Clamp a node inside the unit tree if it sits on a high border.
* \param [in] n Node to be clamped. Must not yet be clamped.
* \param [out] r Existing node overwritten by the clamped result.
*/
void p8est_node_clamp_inside (const p8est_quadrant_t * n,
p8est_quadrant_t * r);
/** Move a clamped node out on the border.
* \param [in] n Node to be unclamped in-place.
*/
void p8est_node_unclamp (p8est_quadrant_t * n);
/** Find the enclosing quadrant of a given node at a given level.
* \param [in] n Clamped node.
* \param [in] level Level of the quadrant to be created.
* \param [out] q Output quadrant, n == q is permitted.
*/
void p8est_node_to_quadrant (const p8est_quadrant_t * n,
int level, p8est_quadrant_t * q);
/** Decide if a node is completely contained within a quadrant.
* \param [in] q Valid quadrant.
* \param [in] n Clamped node.
*/
int p8est_quadrant_contains_node (const p8est_quadrant_t * q,
const p8est_quadrant_t * n);
/** Compute the position of the ancestor of this child at level \a level within
* its siblings.
* \return Returns its child id in 0..7
*/
int p8est_quadrant_ancestor_id (const p8est_quadrant_t * q,
int level);
/** Compute the position of this child within its siblings.
* \return Returns its child id in 0..7
*/
int p8est_quadrant_child_id (const p8est_quadrant_t * q);
/** Test if a quadrant is inside the unit tree.
* \param [in] q Quadrant to be tested.
* \return Returns true if \a q is inside the unit tree.
*/
int p8est_quadrant_is_inside_root (const p8est_quadrant_t *
q);
/** Test if a quadrant is inside the 3x3 box around the root tree.
* \param [in] q Quadrant to be tested.
* \return Returns true if \a q is inside the unit tree.
*/
int p8est_quadrant_is_inside_3x3 (const p8est_quadrant_t * q);
/** Test if a quadrant is outside a tree face boundary (no edge or corner).
* \param [in] q Quadrant to be tested.
* \return Returns true if \a q is outside across a unit tree face.
*/
int p8est_quadrant_is_outside_face (const p8est_quadrant_t *
q);
/** Test if a quadrant is outside a tree edge boundary (no corner).
* \param [in] q Quadrant to be tested.
* \return Returns true if \a q is outside across a unit tree edge.
*/
int p8est_quadrant_is_outside_edge (const p8est_quadrant_t *
q);
/** Test if a quadrant is outside a tree edge boundary (no corner).
* \param [in] q Quadrant to be tested.
* \param [out] edge The tree edge number is computed if outside edge.
* This pointer may be NULL.
* \return Returns true if \a q is outside across a unit tree edge.
*/
int p8est_quadrant_is_outside_edge_extra (const
p8est_quadrant_t *
q, int *edge);
/** Test if a quadrant is outside a tree corner boundary.
* \param [in] q Quadrant to be tested.
* \return Returns true if \a q is outside across a unit tree corner.
*/
int p8est_quadrant_is_outside_corner (const p8est_quadrant_t *
q);
/** Test if a quadrant is used to represent a mesh node.
* \param [in] q Quadrant to be tested.
* \param [in] inside If true, boundary nodes must be clamped inside.
* If false, nodes must align with the quadrant grid.
* \return Returns true if \a q is a node.
*/
int p8est_quadrant_is_node (const p8est_quadrant_t * q,
int inside);
/** Test if a quadrant has valid Morton indices and is inside the unit tree.
* \param [in] q Quadrant to be tested.
* \return Returns true if \a q is valid.
*/
int p8est_quadrant_is_valid (const p8est_quadrant_t * q);
/** Test if a quadrant has valid Morton indices in the 3x3 box around root.
* \param [in] q Quadrant to be tested.
* \return Returns true if \a q is extended.
*/
int p8est_quadrant_is_extended (const p8est_quadrant_t * q);
/** Test if two quadrants are siblings.
* \param [in] q1 First quadrant to be tested.
* \param [in] q2 Second quadrant to be tested.
* \return true if \a q1 is unequal to and a sibling of \a q2.
*/
int p8est_quadrant_is_sibling (const p8est_quadrant_t * q1,
const p8est_quadrant_t * q2);
/** Test if two quadrants are siblings.
* Descriptive, slower version of \a p8est_quadrant_is_sibling.
* For debugging and educational purposes only.
*/
int p8est_quadrant_is_sibling_D (const p8est_quadrant_t * q1,
const p8est_quadrant_t * q2);
/** Test if 8 quadrants are siblings in Morton ordering.
*/
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, array version.
* \param [in] q Array of 8 quadrants.
*/
int p8est_quadrant_is_familyv (const p8est_quadrant_t q[]);
/** Test if 8 quadrants are siblings in Morton ordering, array version.
* \param [in] q Array of 8 pointers to quadrants.
*/
int p8est_quadrant_is_familypv (p8est_quadrant_t * q[]);
/** Test if a quadrant is the parent of another quadrant.
* \param [in] q Quadrant to be tested.
* \param [in] r Possible child quadrant.
* \return true if \a q is the parent of \a r.
*/
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.
* Descriptive, slower version of \a p8est_quadrant_is_parent.
* For debugging and educational purposes only.
*/
int p8est_quadrant_is_parent_D (const p8est_quadrant_t * q,
const p8est_quadrant_t * r);
/** Test if a quadrant is an ancestor of another quadrant.
* \param [in] q Quadrant to be tested.
* \param [in] r Descendent quadrant.
* \return true if \a q is unequal to and an ancestor of \a r.
*/
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.
* Descriptive, slower version of \a p8est_quadrant_is_ancestor.
* Contrary to \a p8est_quadrant_is_ancestor, it aborts for inter-tree q, r.
* For debugging and educational purposes only.
*/
int p8est_quadrant_is_ancestor_D (const p8est_quadrant_t * q,
const p8est_quadrant_t * r);
/** Test if two quadrants follow each other in the tree with no holes.
* \param [in] q A quadrant
* \param [in] r Another quadrant
* \return true if \a q is immediately before \a r in the tree.
* \note for every \a q there are between 0 and P8EST_MAXLEVEL+1 possible nexts.
*/
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.
* Descriptive, slower version of \a p8est_quadrant_is_next.
* For debugging and educational purposes only.
*/
int p8est_quadrant_is_next_D (const p8est_quadrant_t * q,
const p8est_quadrant_t * r);
/** Test if a quadrant has at least partial overlap with a tree.
*/
int p8est_quadrant_overlaps_tree (p8est_tree_t * tree,
const p8est_quadrant_t * q);
/** Test if a quadrant is completely contained within a tree.
*/
int p8est_quadrant_is_inside_tree (p8est_tree_t * tree,
const p8est_quadrant_t *
q);
/** Compute the ancestor of a quadrant at a given level.
* \param [in] q Input quadrant.
* \param [in] level A smaller level than q.
* \param [in,out] r Existing quadrent whose Morton index will be filled
* with the ancestor of q at the given level.
* \note The quadrant q may point to the same quadrant as r.
* The user_data of r are never modified.
*/
void p8est_quadrant_ancestor (const p8est_quadrant_t * q,
int level, p8est_quadrant_t * r);
/** Compute the parent of a quadrant.
* \param [in] q Input quadrant.
* \param [in,out] r Existing quadrant whose Morton index will be filled
* with the Morton index of the parent of \a q.
* Its user_data will be untouched.
* \note \a q may point to the same quadrant as \a r.
The user_data of \a r is never modified.
*/
void p8est_quadrant_parent (const p8est_quadrant_t * q,
p8est_quadrant_t * r);
/** Compute a specific sibling of a quadrant.
* \param [in] q Input quadrant.
* \param [in,out] r Existing quadrant whose Morton index will be filled
* with the coordinates of sibling no. sibling_id of q.
* \param [in] sibling_id The id of the sibling computed, 0..3.
*/
void p8est_quadrant_sibling (const p8est_quadrant_t * q,
p8est_quadrant_t * r,
int sibling_id);
/** Compute the face neighbor of a quadrant.
* \param [in] q Input quadrant, must be valid.
* \param [in] face The face across which to generate the neighbor.
* \param [in,out] r Existing quadrant whose Morton index will be filled.
* \note \a q may point to the same quadrant as \a r.
*/
void p8est_quadrant_face_neighbor (const p8est_quadrant_t * q,
int face,
p8est_quadrant_t * r);
/** Compute the face neighbor of a quadrant, transforming across tree
* boundaries if necessary.
* \param [in] q Input quadrant, must be valid.
* \param [in] t Tree that contains \q.
* \param [in] face The face across which to generate the neighbor.
* \param [in,out] r Existing quadrant whose Morton index will be filled.
* By convention, if there is no tree across \face,
* \r has the same Morton index as \q.
* \param [in,out] nface if not NULL, set to the face of \r that neighbors
* \q. nface is encoded with orientation information
* in the same manner as the tree_to_face array in
* the p8est_connectivity_t struct.
* \param [in] conn The connectivity structure for the forest.
* \return Returns the tree that contains \r. By convention, if there is no
* tree across \face, then -1 is returned.
*/
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);
/** Get the smaller face neighbors of \a q.
*
* Gets the smaller face neighbors, which are half of the size assuming the
* 2-1 constant.
*
* The order of the \a n[i] is given in the Morton ordering.
*
* \param [in] q The quadrant whose face neighbors will be constructed.
* \param [in] face The face across which to generate the neighbors.
* \param [out] n[0]..n[3] Filled with the four smaller face neighbors.
* \param [out] nur[0]..nur[3] If not NULL, filled with smallest quadrants
* that fit in the upper right corners of \a n.
*/
void p8est_quadrant_half_face_neighbors (const p8est_quadrant_t
* q, int face,
p8est_quadrant_t n[],
p8est_quadrant_t
nur[]);
/** Create all possible face neighbors of \a q.
*
* Gets the face neighbors, possible assuming the 2-1 constraint.
* If the larger or smaller quadrants do not exist than they are returned
* as initialized by P4EST_QUADRANT_INIT.
*
* The order of \a n[0] through \a n[3] are given in Morton ordering.
*
* \param [in] q The quadrant whose face neighbors will be constructed.
* \param [in] face The face across which to generate the neighbors.
* \param [out] n[0]..n[3] Filled with the smaller possible face neighbors,
* which are half of the size if they exist
* or initialized to P4EST_QUADRANT_INIT.
* \param [out] n[4] Filled with the face neighbor, which is the same size.
* \param [out] n[5] Filled with the face neighbor, which is twice the size
* if it exists or initialized to P4EST_QUADRANT_INIT.
*/
void p8est_quadrant_all_face_neighbors (const p8est_quadrant_t
* q, int face,
p8est_quadrant_t n[]);
/** Compute the edge neighbor of a quadrant.
* \param [in] q Input quadrant, must be valid.
* \param [in] edge The edge across which to generate the neighbor.
* \param [in,out] r Existing quadrant whose Morton index will be filled.
* \note \a q may point to the same quadrant as \a r.
*/
void p8est_quadrant_edge_neighbor (const p8est_quadrant_t * q,
int edge,
p8est_quadrant_t * r);
/** Compute the edge neighbors of a quadrant, transforming across tree
* boundaries if necessary. Only computes neighbors that are not face
* neighbors.
* \param [in] q Input quadrant, must be valid.
* \param [in] t Tree that contains \q.
* \param [in] edge The edge across which to generate the neighbor.
* \param [in,out] quads An initialized but empty array where the edge
* neighbors will be placed.
* \param [in,out] treeids An initialized but empty array where the ids of the
* trees containing the edge neighbors will be placed.
* \param [in,out] nedges if not NULL, filled with the edges of \a quads that
* neighbor \q. the ints in \nedges are encoded with
* orientation informatin like the edge_to_edge array
* in the p8est_connectivity_t struct
* \param [in] conn The connectivity structure for the forest.
*/
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 corner neighbor of a quadrant.
* \param [in] q Input quadrant, must be valid.
* \param [in] corner The corner across which to generate the neighbor.
* \param [in,out] r Existing quadrant whose Morton index will be filled.
* \note \a q may point to the same quadrant as \a r.
*/
void p8est_quadrant_corner_neighbor (const p8est_quadrant_t *
q, int corner,
p8est_quadrant_t * r);
/** Compute the corner neighbors of a quadrant, transforming across tree
* boundaries if necessary. Only computes neighbors that are not face or edge
* neighbors.
* \param [in] q Input quadrant, must be valid.
* \param [in] t Tree that contains \q.
* \param [in] corner The corner across which to generate the neighbor.
* \param [in,out] quads An initialized but empty array where the corner
* neighbors will be placed.
* \param [in,out] treeids An initialized but empty array where the ids of the
* trees containing the corner neighbors will be placed.
* \param [in,out] ncorners if not NULL, filled with the corners of \a quads
* that neighbor \q.
* \param [in] conn The connectivity structure for the forest.
*/
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 half size corner neighbor of a quadrant.
*
* \param [in] q The quadrant whose corner neighbor will be constructed.
* \param [in] corner The corner across which to generate the neighbor.
* \param [out] r Morton index filled with the half size corner neighbor.
*/
void p8est_quadrant_half_corner_neighbor (const
p8est_quadrant_t * q,
int corner,
p8est_quadrant_t *
r);
/** Compute the corner node of a quadrant.
* \param [in] q Input quadrant, must be valid.
* \param [in] corner The corner across which to generate the neighbor.
* \param [in,out] r Node that will not be clamped inside.
* \note \a q may point to the same quadrant as \a r.
*/
void p8est_quadrant_corner_node (const p8est_quadrant_t * q,
int corner,
p8est_quadrant_t * r);
/** Compute the 8 children of a quadrant.
* \param [in] q Input quadrant.
* \param [in,out] c0 First computed child.
* \a q may point to the same quadrant as \a c0.
* \note The user_data of \a c0, c1, c2, c3, c4, c5, c6, c7 is never modified.
*/
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, array version.
* \param [in] q Input quadrant.
* \param [in,out] c The 8 computed children in z-order.
* q may point to the same quadrant as c[0].
* \note The user_data of c[i] is never modified.
*/
void p8est_quadrant_childrenv (const p8est_quadrant_t * q,
p8est_quadrant_t c[]);
/** Compute the 8 children of a quadrant, array version.
* \param [in] q Input quadrant.
* \param [in,out] c Pointers to the 8 computed children in z-order.
* q may point to the same quadrant as c[0].
* \note The user_data of c[i] is never modified.
*/
void p8est_quadrant_childrenpv (const p8est_quadrant_t * q,
p8est_quadrant_t * c[]);
/** Compute the first descendant of a quadrant on a given level.
* \param [in] q Input quadrant.
* \param [out] fd First descendant of \a q on level \a level.
* \param [in] level Level must be greater equal than q's level.
*/
void p8est_quadrant_first_descendant (const p8est_quadrant_t *
q, p8est_quadrant_t * fd,
int level);
/** Compute the last descendant of a quadrant on a given level.
* \param [in] q Input quadrant.
* \param [out] ld Last descendant of \a q on level \a level.
* \param [in] level Level must be greater equal than q's level.
*/
void p8est_quadrant_last_descendant (const p8est_quadrant_t *
q, p8est_quadrant_t * ld,
int level);
/** Compute the descendant of a quadrant touching a given corner.
* \param [in] q Input quadrant.
* \param [in,out] r Existing quadrant whose Morton index will be filled.
* Its user_data will be untouched.
* \param [in] c The corner of \a q that \a r touches.
* \param [in] level The size of \a r.
*/
void p8est_quadrant_corner_descendant (const p8est_quadrant_t *
q, p8est_quadrant_t * r,
int c, int level);
/** Computes the nearest common ancestor of two quadrants in the same tree.
* \param [in] q1 First input quadrant.
* \param [in] q2 Second input quadrant.
* \param [in,out] r Existing quadrant whose Morton index will be filled.
* Its user_data will be untouched.
* \note \a q1, \a q2, \a r may point to the same quadrant.
* The user_data of \a r is never modified.
*/
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.
* Descriptive, slower version of \a p8est_nearest_common_ancestor.
* For debugging and educationial purposes only.
*/
void p8est_nearest_common_ancestor_D (const p8est_quadrant_t *
q1,
const p8est_quadrant_t *
q2,
p8est_quadrant_t * r);
/** Transforms a quadrant/node across a face between trees.
* \param [in] q Input quadrant/non-clamped node.
* \param [in,out] r Quadrant/node whose Morton index will be filled.
* \param [in] ftransform This array holds 9 integers.
* [0]..[2] The coordinate axis sequence of the origin face.
* [3]..[5] The coordinate axis sequence of the target face.
* [6]..[8] Edge reverse flag for axes 0, 1; face code for 2.
* \note \a q and \q r may NOT point to the same quadrant structure.
*/
void p8est_quadrant_transform_face (const p8est_quadrant_t * q,
p8est_quadrant_t * r,
const int ftransform[]);
/** Checks if a quadrant touches an edge (diagonally inside or outside).
*/
int p8est_quadrant_touches_edge (const p8est_quadrant_t * q,
int edge, int inside);
/** Transforms a quadrant across an edge between trees.
* \param [in] q Input quadrant.
* \param [in,out] r Quadrant whose Morton index will be filled.
* \param [in] edge Edge index of the originating quadrant.
* \param [in] ei Edge information computed previously.
* \param [in] inside The quadrant will be placed inside or outside.
*/
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);
/** Shifts a quadrant until it touches the specified edge from the inside.
* If this shift is meant to recreate the effects of \a q on balancing across
* the edge, then \a r, \a rup, and \a rdown may all be necessary for that
* recreation.
* \param [in] q Valid input quadrant.
* \param [out] r Quadrant whose Morton index will be filled.
* This quadrant results from shifting \a q
* laterally towards the edge.
* \param [out] rup Quadrant whose Morton index will be filled (may
* be NULL). This quadrant results from shifting
* \a q diagonally towards \a edge's higher
* corner.
* \param [out] rdown Quadrant whose Morton index will be filled (may
* be NULL). This quadrant results from shifting
* \a q diagonally towards \a edge's lower corner.
* \param [in] edge Edge index.
*/
void p8est_quadrant_shift_edge (const p8est_quadrant_t * q,
p8est_quadrant_t * r,
p8est_quadrant_t * rup,
p8est_quadrant_t * rdown,
int edge);
/** Checks if a quadrant touches a corner (diagonally inside or outside).
*/
int p8est_quadrant_touches_corner (const p8est_quadrant_t * q,
int corner, int inside);
/** Move a quadrant inside or diagonally outside a corner position.
* \param [in,out] q This quadrant only requires a valid level.
* \param [in] icorner Number of the corner in 0..7.
* \param [int] inside Boolean flag for inside or diagonally outside.
*/
void p8est_quadrant_transform_corner (p8est_quadrant_t * r,
int corner, int inside);
/** Shifts a quadrant until it touches the specified corner from the inside.
* \param [in] q Valid input quadrant.
* \param [in,out] r Quadrant whose Morton index will be filled.
* \param [in] corner Corner index.
*/
void p8est_quadrant_shift_corner (const p8est_quadrant_t * q,
p8est_quadrant_t * r,
int corner);
/** Computes the linear position of a quadrant in a uniform grid.
* \param [in] quadrant Quadrant whose id will be computed.
* \return Returns the linear position of this quadrant on a grid.
* \note This is the inverse operation of p8est_quadrant_set_morton.
* The user_data of \a quadrant is never modified.
*/
uint64_t p8est_quadrant_linear_id (const p8est_quadrant_t *
quadrant, int level);
/** Set quadrant Morton indices based on linear position in uniform grid.
* \param [in,out] quadrant Quadrant whose Morton indices will be set.
* \param [in] id The linear position of this quadrant on a grid.
* \note This is the inverse operation of p8est_quadrant_linear_id.
* The user_data of \a quadrant is never modified.
*/
void p8est_quadrant_set_morton (p8est_quadrant_t * quadrant,
int level, uint64_t id);
SC_EXTERN_C_END;
#endif /* !P8EST_BITS_H */
|