/usr/include/deal.II/grid/grid_reordering.h is in libdeal.ii-dev 6.3.1-1.1.
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 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 | //---------------------------------------------------------------------------
// $Id: grid_reordering.h 18958 2009-06-24 14:54:25Z bangerth $
// Version: $Name$
//
// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by the deal.II authors
//
// This file is subject to QPL and may not be distributed
// without copyright and license information. Please refer
// to the file deal.II/doc/license.html for the text and
// further information on this license.
//
//---------------------------------------------------------------------------
#ifndef __deal2__grid_reordering_h
#define __deal2__grid_reordering_h
#include <base/config.h>
#include <grid/tria.h>
#include <vector>
DEAL_II_NAMESPACE_OPEN
/**
* This class reorders the vertices of cells such that they meet the standard
* requirements of the Triangulation class when creating grids, i.e. all lines
* have a unique orientation with respect to all neighboring cells. This class
* is mainly used when reading in grids from files and converting them to
* deal.II triangulations.
*
* Note: In contrast to the rest of the deal.II library this class
* uses the old deal.II numbering scheme, which was used up to deal.II
* version 5.2. That is, the vertex and face ordering in 2d is assumed
* to be
* @verbatim
* 2
* 3--->---2
* | |
* 3^ ^1
* | |
* 0--->---1
* 0
* @endverbatim
* the vertices in 3d:
* @verbatim
* 7-------6 7-------6
* /| | / /|
* / | | / / |
* / | | / / |
* 3 | | 3-------2 |
* | 4-------5 | | 5
* | / / | | /
* | / / | | /
* |/ / | |/
* 0-------1 0-------1
* @endverbatim
* and the faces in 3d:
* @verbatim
* *-------* *-------*
* /| | / /|
* / | 1 | / 4 / |
* / | | / / |
* * | | *-------* |
* | 5 *-------* | | 3 *
* | / / | | /
* | / 2 / | 0 | /
* |/ / | |/
* *-------* *-------*
* @endverbatim
*
* After calling the GridReordering::reorder_cells() function the
* CellData is still in this old numbering scheme. Hence, for creating
* a Triangulation based on the resulting CellData the
* Triangulation::create_triangulation_compatibility() (and not the
* Triangulation::create_triangulation()) function must be used. For
* a typical use of the reorder_cells() function see the
* implementation of the GridIn <tt>::read_*()</tt> functions.
*
*
* <h3>Statement of problems</h3>
*
* Triangulations in deal.II have a special structure, in that there
* are not only cells, but also faces, and in 3d also edges, that are
* objects of their own right. Faces and edges have unique
* orientations, and they have a specified orientation also with
* respect to the cells that are adjacent. Thus, a line that separates
* two cells in two space dimensions does not only have a direction,
* but it must also have a well-defined orientation with respect to
* the other lines bounding the two quadrilaterals adjacent to the
* first line. Likewise definitions hold for three dimensional cells
* and the objects (lines, quads) that separate them.
*
* For example, in two dimensions, a quad consists of four lines which
* have a direction, which is by definition as follows:
* @verbatim
* 3-->--2
* | |
* ^ ^
* | |
* 0-->--1
* @endverbatim
* Now, two adjacent cells must have a vertex numbering such that the direction
* of the common side is the same. For example, the following two quads
* @verbatim
* 3---4---5
* | | |
* 0---1---2
* @endverbatim
* may be characterised by the vertex numbers <tt>(0 1 4 3)</tt> and
* <tt>(1 2 5 4)</tt>, since the middle line would get the direction <tt>1->4</tt>
* when viewed from both cells. The numbering <tt>(0 1 4 3)</tt> and
* <tt>(5 4 1 2)</tt> would not be allowed, since the left quad would give the
* common line the direction <tt>1->4</tt>, while the right one would want
* to use <tt>4->1</tt>, leading to an ambiguity.
*
* As a sidenote, we remark that if one adopts the idea that having
* directions of faces is useful, then the orientation of the four
* faces of a cell as shown above is almost necessary. In particular,
* it is not possible to orient them such that they represent a
* (counter-)clockwise sense, since then we couldn't already find a
* valid orientation of the following patch of three cells:
* @verbatim
* o
* / \
* o o
* | \ / |
* | o |
* | | |
* o---o---o
* @endverbatim
* (The reader is asked to try to find a conforming choice of line
* directions; it will soon be obvious that there can't exists such a
* thing, even if we allow that there might be cells with clockwise
* and counterclockwise orientation of the lines at the same time.)
*
* One might argue that the definition of unique directions for faces
* and edges, and the definition of directions relative to the cells
* they bound, is a misfeature of deal.II. In fact, it makes reading
* in grids created by mesh generators rather difficult, as they
* usually don't follow these conventions when generating their
* output. On the other hand, there are good reasons to introduce such
* conventions, as they can make programming much simpler in many
* cases, leading to an increase in speed of some computations as one
* can avoid expensive checks in many places because the orientation
* of faces is known by assumption that it is guaranteed by the
* triangulation.
*
* The purpose of this class is now to find an ordering for a given
* set of cells such that the generated triangulation satisfies all
* the requirements stated above. To this end, we will first show some
* examples why this is a difficult problem, and then develop
* algorithms that finds such a reordering. Note that the algorithm
* operates on a set of CellData objects that are used to
* describe a mesh to the triangulation class. These objects are, for
* example, generated by the GridIn class, when reading in grids
* from input files.
*
* As a last question for this first section: is it guaranteed that
* such orientations of faces always exist for a given subdivision of
* a domain into cells? The linear complexity algorithm described
* below for 2d also proves that the answer is yes for 2d. For 3d, the
* answer is no (which also underlines that using such orientations
* might be an -- unfortunately uncurable -- misfeature of deal.II). A
* simple counter-example in 3d illustrates this: take a string of 3d
* cells and bend it together to a torus. Since opposing lines in a
* cell need to have the same direction, there is a simple ordering
* for them, for example all lines radially outward, tangentially
* clockwise, and axially upward. However, if before joining the two
* ends of the string of cells, the string is twisted by 180 degrees,
* then no such orientation is possible any more, as can easily be
* checked. In effect, some meshes could not be used in deal.II.
* In order to overcome this problem, the <code>face_rotation</code>,
* <code>face_flip</code> and <code>line_orientation</code> flags have
* been introduced. With these, it is possible to treat all purely hexahedral
* meshes. However, in order to reduce the effect of possible bugs, it should
* still be tried to reorder a grid. Only if this procedure fails, the original
* connectivity information should be used.
*
*
* <h3>Examples of problems</h3>
*
* As noted, reordering the vertex lists of cells such that the
* resulting grid is not a trivial problem. In particular, it is often
* not sufficient to only look at the neighborhood of a cell that
* cannot be added to a set of other cells without violating the
* requirements stated above. We will show two examples where this is
* obvious.
*
* The first such example is the following, which we will call the
* ``four cells at the end'' because of the four cells that close of
* the right end of a row of three vertical cells each (in the
* following picture we only show one such column of three cells at
* the left, but we will indicate what happens if we prolong this
* list):
* @verbatim
* 9---10-----11
* | | / |
* 6---7---8 |
* | | | |
* 3---4---5 |
* | | \ |
* 0---1------2
* @endverbatim
* Assume that you had numbered the vertices in the cells at the left boundary
* in a way, that the following line directions are induced:
* @verbatim
* 9->-10-----11
* ^ ^ / |
* 6->-7---8 |
* ^ ^ | |
* 3->-4---5 |
* ^ ^ \ |
* 0->-1------2
* @endverbatim
* (This could for example be done by using the indices <tt>(0 1 4 3)</tt>, <tt>(3 4 7 6)</tt>,
* <tt>(6 7 10 9)</tt> for the three cells). Now, you will not find a way of giving
* indices for the right cells, without introducing either ambiguity for
* one line or other, or without violating that within each cells, there must be
* one vertex from which both lines are directed away and the opposite one to
* which both adjacent lines point to.
*
* The solution in this case is to renumber one of the three left cells, e.g.
* by reverting the sense of the line between vertices 7 and 10 by numbering
* the top left cell by <tt>(9 6 7 10)</tt>:
* @verbatim
* 9->-10-----11
* v v / |
* 6->-7---8 |
* ^ ^ | |
* 3->-4---5 |
* ^ ^ \ |
* 0->-1------2
* @endverbatim
*
* The point here is the following: assume we wanted to prolong the grid to
* the left like this:
* @verbatim
* o---o---o---o---o------o
* | | | | | / |
* o---o---o---o---o---o |
* | | | | | | |
* o---o---o---o---o---o |
* | | | | | \ |
* o---o---o---o---o------o
* @endverbatim
* Then we run into the same problem as above if we order the cells at
* the left uniformly, thus forcing us to revert the ordering of one
* cell (the one which we could order as <tt>(9 6 7 10)</tt>
* above). However, since opposite lines have to have the same
* direction, this in turn would force us to rotate the cell left of
* it, and then the one left to that, and so on until we reach the
* left end of the grid. This is therefore an example we we have to
* track back right until the first column of three cells to find a
* consistent ordering, if we had initially ordered them uniformly.
*
* As a second example, consider the following simple grid, where the
* order in which the cells are numbered is important:
* @verbatim
* 3-----2-----o-----o ... o-----7-----6
* | | | | | | |
* | 0 | N | N-1 | ... | 2 | 1 |
* | | | | | | |
* 0-----1-----o-----o ... o-----4-----5
* @endverbatim
* We have here only indicated the numbers of the vertices that are
* relevant. Assume that the user had given the cells 0 and 1 by the
* vertex indices <tt>0 1 2 3</tt> and <tt>6 7 4 5</tt>. Then, if we follow this
* orientation, the grid after creating the lines for these two cells
* would look like this:
* @verbatim
* 3-->--2-----o-----o ... o-----7--<--6
* | | | | | | |
* ^ 0 ^ N | N-1 | ... | 2 v 1 v
* | | | | | | |
* 0-->--1-----o-----o ... o-----4--<--5
* @endverbatim
* Now, since opposite lines must point in the same direction, we can
* only add the cells 2 through N-1 to cells 1 such that all vertical
* lines point down. Then, however, we cannot add cell N in any
* direction, as it would have two opposite lines that do not point in
* the same direction. We would have to rotate either cell 0 or 1 in
* order to be able to add all the other cells such that the
* requirements of deal.II triangulations are met.
*
* These two examples demonstrate that if we have added a certain
* number of cells in some orientation of faces and can't add the next
* one without introducing faces that had already been added in another
* direction, then it might not be sufficient to only rotate cells in
* the neighborhood of the the cell that we failed to add. It might be
* necessary to go back a long way and rotate cells that have been
* entered long ago.
*
*
* <h3>Solution</h3>
*
* From the examples above, it is obvious that if we encounter a cell
* that cannot be added to the cells which have already been entered,
* we can not usually point to a cell that is the culprit and that
* must be entered in a different oreintation. Furthermore, even if we
* knew which cell, there might be large number of cells that would
* then cease to fit into the grid and which we would have to find a
* different orientation as well (in the second example above, if we
* rotated cell 1, then we would have to rotate the cells 1 through
* N-1 as well).
*
* A brute force approach to this problem is the following: if
* cell N can't be added, then try to rotate cell N-1. If we can't
* rotate cell N-1 any more, then try to rotate cell N-2 and try to
* add cell N with all orientations of cell N-1. And so
* on. Algorithmically, we can visualize this by a tree structure,
* where node N has as many children as there are possible
* orientations of node N+1 (in two space dimensions, there are four
* orientations in which each cell can be constructed from its four
* vertices; for example, if the vertex indicaes are <tt>(0 1 2 3)</tt>,
* then the four possibilities would be <tt>(0 1 2 3)</tt>, <tt>(1 2 3 0)</tt>,
* <tt>(2 3 0 1)</tt>, and <tt>(3 0 1 2)</tt>). When adding one cell after the
* other, we traverse this tree in a depth-first (pre-order)
* fashion. When we encounter that one path from the root (cell 0) to
* a leaf (the last cell) is not allowed (i.e. that the orientations
* of the cells which are encoded in the path through the tree does
* not lead to a valid triangulation), we have to track back and try
* another path through the tree.
*
* In practice, of course, we do not follow each path to a final node
* and then find out whether a path leads to a valid triangulation,
* but rather use an inductive argument: if for all previously added
* cells the triangulation is a valid one, then we can find out
* whether a path through the tree can yield a valid triangulation by
* checking whether entering the present cell would introduce any
* faces that have a nonunique direction; if that is so, then we can
* stop following all paths below this point and track back
* immediately.
*
* Nevertheless, it is already obvious that the tree has <tt>4**N</tt>
* leaves in two space dimensions, since each of the N cells can be
* added in four orientations. Most of these nodes can be discarded
* rapidly, since firstly the orientation of the first cell is
* irrelevant, and secondly if we add one cell that has a neighbor
* that has already been added, then there are already only two
* possible orientations left, so the total number of checks we have
* to make until we find a valid way is significantly smaller than
* <tt>4**N</tt>. However, the algorithm is still exponential in time and
* linear in memory (we only have to store the information for the
* present path in form of a stack of orientations of cells that have
* already been added).
*
* In fact, the two examples above show that the exponential estimate
* is not a pessimized one: we indeed have to track back to one of the
* very first cells there to find a way to add all cells in a
* consistent fashion.
*
* This discouraging situation is greatly improved by the fact that we
* have an alternative algorithm for 2d that is always linear in
* runtime (discovered and implemented by Michael Anderson of TICAM,
* University of Texas, in 2003), and that for 3d we can find an
* algorithm that in practice is usually only roughly linear in time
* and memory. We will describe these algorithms in the following.
*
*
* <h3>The 2d linear complexity algorithm</h3>
*
* The algorithm uses the fact that opposite faces of a cell need to
* have the same orientation. So you start with one arbitrary line,
* choose an orientation. Then the orientation of the opposite face is
* already fixed. Then go to the two cells across the two faces we
* have fixed: for them, one face is fixed, so we can also fix the
* opposite face. Go on with doing so. Eventually, we have done this
* for a string of cells. Then take one of the non-fixed faces of a
* cell which has already two fixed faces and do all this again.
*
* In more detail, the algorithm is best illustrated using an
* example. We consider the mesh below:
* @verbatim
* 9------10-------11
* | | /|
* | | / |
* | | / |
* 6------7-----8 |
* | | | |
* | | | |
* | | | |
* 3------4-----5 |
* | | \ |
* | | \ |
* | | \|
* 0------1---------2
* @endverbatim
* First a cell is chosen ( (0,1,4,3) in this case). A single side of the cell
* is oriented arbitrarily (3->4). This choice of orientation is then propogated
* through the mesh, across sides and elements. (0->1), (6->7) and (9->10).
* The involves edge-hopping and face hopping, giving a path through the mesh
* shown in dots.
* @verbatim
* 9-->--10-------11
* | . | /|
* | . | / |
* | . | / |
* 6-->--7-----8 |
* | . | | |
* | . | | |
* | . | | |
* 3-->--4-----5 |
* | . | \ |
* | X | \ |
* | . | \|
* 0-->--1---------2
* @endverbatim
* This is then repeated for the other sides of the chosen element, orienting
* more sides of the mesh.
* @verbatim
* 9-->--10-------11
* | | /|
* v.....v.......V |
* | | /. |
* 6-->--7-----8 . |
* | | | . |
* | | | . |
* | | | . |
* 3-->--4-----5 . |
* | | \. |
* ^..X..^.......^ |
* | | \|
* 0-->--1---------2
* @endverbatim
* Once an element has been completely oriented it need not be considered
* further. These elements are filled with o's in the diagrams. We then move
* to the next element.
* @verbatim
* 9-->--10->-----11
* | ooo | . /|
* v ooo v . V |
* | ooo | . / |
* 6-->--7-->--8 |
* | | . | |
* | | . | |
* | | . | |
* 3-->--4-->--5 |
* | ooo | . \ |
* ^ ooo ^ X ^ |
* | ooo | . \|
* 0-->--1-->------2
* @endverbatim
* Repeating this gives
* @verbatim
* 9-->--10->-----11
* | ooo | oooooo /|
* v ooo v ooooo V |
* | ooo | oooo / |
* 6-->--7-->--8 |
* | | | |
* ^.....^..X..^...^
* | | | |
* 3-->--4-->--5 |
* | ooo | oooo \ |
* ^ ooo ^ ooooo ^ |
* | ooo | oooooo \|
* 0-->--1-->------2
* @endverbatim
* and the final oriented mesh is
* @verbatim
* 9-->--10->-----11
* | | /|
* v v V |
* | | / |
* 6-->--7-->--8 |
* | | | |
* ^ ^ ^ ^
* | | | |
* 3-->--4-->--5 |
* | | \ |
* ^ ^ ^ |
* | | \|
* 0-->--1-->-------2
* @endverbatim
* It is obvious that this algorithm has linear run-time, since it
* only ever touches each face exactly once.
*
* The algorithm just described is implemented in a specialization of this
* class for the 2d case. A similar, but slightly more complex algorithm is
* implemented in a specialization for 3d. It using sheets instead of strings
* of cells to work on. If a grid is orientable, then the algorithm is able to
* do its work in linear time; if it is not orientable, then it aborts in
* linear time as well. Both algorithms are described in a paper by Agelek,
* Anderson, Bangerth and Barth, see the publications page of the deal.II
* library.
*
*
* <h3>For the curious</h3>
*
* Prior to the implementation of the algorithms developed by Michael Anderson
* and described above, we used a branch-and-cut algorithm initially
* implemented in 2000 by Wolfgang Bangerth. Although it is no longer used
* here is how it works, and why it doesn't always work for large meshes since
* its run-time can exponential in bad cases.
*
* The first observation is that although there are counterexamples,
* problems are usually local. For example, in the second example
* mentioned above, if we had numbered the cells in a way that
* neighboring cells have similar cell numbers, then the amount of
* backtracking needed is greatly reduced. Therefore, in the
* implementation of the algorithm, the first step is to renumber the
* cells in a Cuthill-McKee fashion: start with the cell with the
* least number of neighbors and assign to it the cell number
* zero. Then find all neighbors of this cell and assign to them
* consecutive further numbers. Then find their neighbors that have
* not yet been numbered and assign to them numbers, and so
* on. Graphically, this represents finding zones of cells
* consecutively further away from the initial cells and number them
* in this front-marching way. This already greatly improves locality
* of problems and consequently reduced the necessary amount of
* backtracking.
*
* The second point is that we can use some methods to prune the tree,
* which usually lead to a valid orientation of all cells very
* quickly.
*
* The first such method is based on the observation that if we
* fail to insert one cell with number N, then this may not be due to
* cell N-1 unless N-1 is a direct neighbor of N. The reason is
* abvious: the chosen orientation of cell M could only affect the
* possibilities to add cell N if either it were a direct neighbor or
* if there were a sequence of cells that were added after M and that
* connected cells M and N. Clearly, for M=N-1, the latter cannot be
* the case. Conversely, if we fail to add cell N, then it is not
* necessary to track back to cell N-1, but we can track back to the
* neighbor of N with the largest cell index and which has already
* been added.
*
* Unfortunately, this method can fail to yield a valid path through
* the tree if not applied with care. Consider the following
* situation, initially extracted from a mesh of 950 cells generated
* automatically by the program BAMG (this program usually generates
* meshes that are quite badly balanced, often have many -- sometimes
* 10 or more -- neighbors of one vertex, and exposed several problems
* in the initial algorithm; note also that the example is in 2d where
* we now have the much better algorithm described above, but the same
* observations also apply to 3d):
* @verbatim
* 13----------14----15
* | \ | |
* | \ 4 | 5 |
* | \ | |
* | 12-----10----11
* | | | |
* | | | 7 |
* | | | |
* | 3 | 8-----9
* | | | |
* | | | 6 |
* | | | |
* 4-----5-----6-----7
* | | | |
* | 2 | 1 | 0 |
* | | | |
* 0-----1-----2-----3
* @endverbatim
* Note that there is a hole in the middle. Assume now that the user
* described the first cell 0 by the vertex numbers <tt>2 3 7 6</tt>, and
* cell 5 by <tt>15 14 10 11</tt>, and assume that cells 1, 2, 3, and 4 are
* numbered such that 5 can be added in initial rotation. All other
* cells are numbered in the usual way, i.e. starting at the bottom
* left and counting counterclockwise. Given this description of
* cells, the algorithm will start with cell zero and add one cell
* after the other, up until the sixth one. Then the situation will be
* the following:
* @verbatim
* 13----->---14--<--15
* | \ | |
* | > 4 v 5 v
* | \ | |
* | 12->--10--<--11
* | | | |
* ^ | | 7 |
* | | | |
* | 3 ^ 8-->--9
* | | | |
* | | ^ 6 ^
* | | | |
* 4-->--5-->--6-->--7
* | | | |
* ^ 2 ^ 1 ^ 0 ^
* | | | |
* 0-->--1-->--2-->--3
* @endverbatim
* Coming now to cell 7, we see that the two opposite lines at its top
* and bottom have different directions; we will therefore find no
* orientation of cell 7 in which it can be added without violation of
* the consistency of the triangulation. According to the rule stated
* above, we track back to the neighbor with greatest index, which is
* cell 6, but since its bottom line is to the right, its top line
* must be to the right as well, so we won't be able to find an
* orientation of cell 6 such that 7 will fit into the
* triangulation. Then, if we have finished all possible orientations
* of cell 6, we track back to the neighbor of 6 with the largest
* index and which has been added already. This would be cell
* 0. However, we know that the orientation of cell 0 can't be
* important, so we conclude that there is no possible way to orient
* all the lines of the given cells such that they satisfy the
* requirements if deal.II triangulations. We know that this can't be,
* so it results in an exception be thrown.
*
* The bottom line of this example is that when we looked at all
* possible orientations of cell 6, we couldn't find one such that
* cell 7 could be added, and then decided to track back to cell 0. We
* did not even attempt to turn cell 5, after which it would be simple
* to add cell 7. Thus, the algorithm described above has to be
* modified: we are only allowed to track back to that neighbor that
* has already been added, with the largest cell index, if we fail to
* add a cell in any orientation. If we track back further because we
* have exhausted all possible orientations but could add the cell
* (i.e. we track back since another cell, further down the road
* couldn't be added, irrespective of the orientation of the cell
* which we are presently considering), then we are not allowed to
* track back to one of its neighbors, but have to track back only one
* cell index.
*
* The second method to prune the tree is that usually we cannot add a
* new cell since the orientation of one of its neighbors that have
* already been added is wrong. Thus, if we may try to rotate one of
* the neighbors (of course making sure that rotating that neighbor
* does not violate the consistency of the triangulation) in order to
* allow the present cell to be added.
*
* While the first method could be explained in terms of backtracking
* in the tree of orientations more than one step at once, turning a
* neighbor means jumping to a totally different place in the
* tree. For both methods, one can find arguments that they will never
* miss a path that is valid and only skip paths that are invalid
* anyway.
*
* These two methods have proven extremely efficient. We have been
* able to read very large grids (several ten thousands of cells)
* without the need to track back much. In particular, the time to find
* an ordering of the cells was found to be mostly linear in the
* number of cells, and the time to reorder them is usually much
* smaller (for example by one order of magnitude) than the time
* needed to read the data from a file, and also to actually generate
* the triangulation from this data using the
* Triangulation::create_triangulation() function.
*
* @ingroup grid
* @author Wolfgang Bangerth, 2000, Michael Anderson 2003, Ralf Hartmann 2005
*/
template <int dim, int spacedim=dim>
class GridReordering
{
public:
/**
* This is the main function,
* doing what is announced in
* the general documentation of
* this class for dim=2 and 3
* and doing nothing for dim=1.
*
* If a consistent reordering is not
* possible in dim=3, the original
* connectivity data is restored.
*/
static void reorder_cells (std::vector<CellData<dim> > &original_cells);
/**
* Grids generated by grid
* generators may have an
* orientation of cells which is
* the inverse of the orientation
* required by deal.II.
*
* In 2d and 3d this function checks
* whether all cells have
* negative or positive
* measure/volume. In the former
* case, all cells are inverted.
* It does nothing in 1d.
*
* The invertion of cells might
* also work when only a subset
* of all cells have negative
* volume. However, grids
* consisting of a mixture of
* negative and positiv oriented
* cells are very likely to be
* broken. Therefore, an
* exception is thrown, in case
* cells are not uniformly
* oriented.
*
* Note, that this function
* should be called before
* reorder_cells().
*/
static void invert_all_cells_of_negative_grid(
const std::vector<Point<spacedim> > &all_vertices,
std::vector<CellData<dim> > &original_cells);
};
// declaration of explicit specializations
template<>
void
GridReordering<2>::reorder_cells (std::vector<CellData<2> > &original_cells);
template<>
void
GridReordering<2,3>::reorder_cells (std::vector<CellData<2> > &original_cells);
template<>
void
GridReordering<3>::reorder_cells (std::vector<CellData<3> > &original_cells);
template<>
void
GridReordering<2>::invert_all_cells_of_negative_grid(const std::vector<Point<2> > &all_vertices,
std::vector<CellData<2> > &cells);
template<>
void
GridReordering<2,3>::invert_all_cells_of_negative_grid(const std::vector<Point<3> > &all_vertices,
std::vector<CellData<2> > &cells);
template<>
void
GridReordering<3>::invert_all_cells_of_negative_grid(const std::vector<Point<3> > &all_vertices,
std::vector<CellData<3> > &cells);
DEAL_II_NAMESPACE_CLOSE
#endif
|