/usr/include/deal.II/grid/tria_iterator.h is in libdeal.ii-dev 8.4.2-2+b1.
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 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 | // ---------------------------------------------------------------------
//
// Copyright (C) 1998 - 2016 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE at
// the top level of the deal.II distribution.
//
// ---------------------------------------------------------------------
#ifndef dealii__tria_iterator_h
#define dealii__tria_iterator_h
/*---------------------------- tria-iterator.h ---------------------------*/
#include <deal.II/base/config.h>
#include <deal.II/base/exceptions.h>
#include <deal.II/base/point.h>
#include <deal.II/grid/tria_iterator_base.h>
#include <iterator>
#include <ostream>
DEAL_II_NAMESPACE_OPEN
template <int dim, int spacedim> class Triangulation;
template <int, int, int> class TriaAccessorBase;
template <typename> class TriaRawIterator;
template <typename> class TriaIterator;
template <typename> class TriaActiveIterator;
// note: in non-debug mode, i.e. with optimizations, the file
// tria_iterator.templates.h is included at the end of this file.
// this includes a lot of templates and thus makes compilation
// slower, but at the same time allows for more aggressive
// inlining and thus faster code.
/**
* This class implements an iterator, analogous to those used in the standard
* library. It fulfills the requirements of a bidirectional iterator. See the
* C++ documentation for further details of iterator specification and usage.
*
*
* In addition to the standard interface, an iterator of this class provides a
* <tt>-@></tt> operator, i.e. you can write statements like
* @code
* i->set_refine_flag ();
* @endcode
*
* Iterators are used whenever a loop over all lines, quads, cells etc. is to
* be performed. These loops can then be coded like this:
* @code
* cell_iterator i = tria.begin();
* cell_iterator end = tria.end();
* for (; i!=end; ++i)
* if (cell->at_boundary())
* cell->set_refine_flag();
* @endcode
*
* Note the usage of <tt>++i</tt> instead of <tt>i++</tt> since this does not
* involve temporaries and copying. It is recommended to use a fixed value
* <tt>end</tt> inside the loop instead of <tt>tria.end()</tt>, since the
* creation and copying of these iterators is rather expensive compared to
* normal pointers.
*
* The objects pointed to are accessors, derived from TriaAccessorBase. Which
* kind of accessor is determined by the template argument <em>Accessor</em>.
* These accessors are not so much data structures as they are a collection of
* functions providing access to the data stored in Triangulation or
* DoFHandler objects. Using these accessors, the structure of these classes
* is hidden from the application program.
*
* <h3>Which iterator to use when</h3>
*
* @attention Application programs will rarely use TriaRawIterator, but rather
* one of the derived classes TriaIterator or TriaActiveIterator.
*
* <ul>
* <li> TriaRawIterator objects point to lines, cells, etc in the lists
* whether they are used or not (in the vectors, also <i>dead</i> objects are
* stored, since deletion in vectors is expensive and we also do not want to
* destroy the ordering induced by the numbering in the vectors). Therefore
* not all raw iterators point to valid objects.
*
* <li> The derived class TriaIterator selects the valid cells, that is, cells
* used somewhere in the triangulation hierarchy.
*
* <li> TriaActiveIterator objects which only loop over active cells.
* </ul>
*
* <h3>Purpose</h3>
*
* Iterators are not much slower than operating directly on the data
* structures, since they perform the loops that you had to handcode yourself
* anyway. Most iterator and accessor functions are inlined.
*
* The main functionality of iterators, resides in the <tt>++</tt> and
* <tt>--</tt> operators. These move the iterator forward or backward just as
* if it were a pointer into an array. Here, this operation is not so easy,
* since it may include skipping some elements and the transition between the
* triangulation levels. This is completely hidden from the user, though you
* can still create an iterator pointing to an arbitrary element. Actually,
* the operation of moving iterators back and forth is not done in the
* iterator classes, but rather in the accessor classes. Since these are
* passed as template arguments, you can write your own versions here to add
* more functionality.
*
* Furthermore, the iterators described here satisfy the requirement of input
* and bidirectional iterators as stated by the C++ standard. It is therefore
* possible to use the functions from the algorithm section of the C++
* standard, e.g., <em>count_if</em> (see the documentation for Triangulation
* for an example) and several others.
*
* <h3>Implementation</h3>
*
* The iterator class itself does not have much functionality. It only becomes
* useful when assigned an Accessor (the second template parameter), which
* really does the access to data. An Accessor has to fulfill some
* requirements:
*
* <ul>
* <li> It must have two members named <tt>present_level</tt> and
* <tt>present_index</tt> storing the address of the element in the
* triangulation presently pointed to. These data have to be accessible by all
* triangulation iterators listed above.
*
* <li> It must have a constructor which takes a Triangulation* and two
* unsigned integers, denoting the initial level and index, as well as a data
* object depending on its type.
*
* <li> For the TriaIterator and the TriaActiveIterator class, it must have a
* member function <tt>bool used()</tt>, for the latter a member function
* <tt>bool active()</tt>.
*
* <li> It must have void operators <tt>++</tt> and <tt>--</tt>.
*
* <li> It must declare a local <tt>typedef AccessorData</tt> which states the
* data type the accessor expects to get passed as fourth constructor
* argument. By declaring a local data type, the respective iterator class may
* type-safely enforce that data type to be one of its own constructor
* argument types. If an accessor class does not need additional data, this
* type shall be <tt>void</tt>.
* </ul>
*
* Then the iterator is able to do what it is supposed to. All of the
* necessary functions are implemented in the <tt>Accessor</tt> base class,
* but you may write your own version (non-virtual, since we use templates) to
* add functionality.
*
* The accessors provided by the library consists of two groups, determined by
* whether they access the data of Triangulation objects or
* DoFHandler/hp::DoFHandler objects. They are derived from TriaAccessor and
* DoFAccessor, respectively. Each group also has specialized accessors for
* cells (as opposed to faces and lines) that offer more functionality such as
* accessing neighbors.
*
* @attention It seems impossible to preserve constness of a triangulation
* through iterator usage. Thus, if you declare pointers to a <tt>const</tt>
* triangulation object, you should be well aware that you might involuntarily
* alter the data stored in the triangulation.
*
* @note More information on valid and invalid iterators can be found in the
* documentation of TriaAccessorBase, where the iterator states are checked
* and implemented.
*
*
* <h3>Past-the-end iterators</h3>
*
* There is a representation of past-the-end-pointers, denoted by special
* values of the member variables @p present_level and @p present_index: If
* <tt>present_level>=0</tt> and <tt>present_index>=0</tt>, then the object is
* valid (there is no check whether the triangulation really has that many
* levels or that many cells on the present level when we investigate the
* state of an iterator; however, in many places where an iterator is
* dereferenced we make this check); if <tt>present_level==-1</tt> and
* <tt>present_index==-1</tt>, then the iterator points past the end; in all
* other cases, the iterator is considered invalid. You can check this by
* calling the <tt>state()</tt> function.
*
* An iterator is also invalid, if the pointer pointing to the Triangulation
* object is invalid or zero.
*
* Finally, an iterator is invalid, if the element pointed to by @p
* present_level and @p present_index is not used, i.e. if the @p used flag is
* set to false.
*
* The last two checks are not made in <tt>state()</tt> since both cases
* should only occur upon uninitialized construction through @p memcpy and the
* like (the parent triangulation can only be set upon construction). If an
* iterator is constructed empty through the empty constructor,
* <tt>present_level==-2</tt> and <tt>present_index==-2</tt>. Thus, the
* iterator is invalid anyway, regardless of the state of the triangulation
* pointer and the state of the element pointed to.
*
* Past-the-end iterators may also be used to compare an iterator with the <i
* >before-the-start</i> value, when running backwards. There is no
* distinction between the iterators pointing past the two ends of a vector.
*
* By defining only one value to be past-the-end and making all other values
* invalid provides a second track of security: if we should have forgotten a
* check in the library when an iterator is incremented or decremented, we
* automatically convert the iterator from the allowed state "past-the-end" to
* the disallowed state "invalid" which increases the chance that some time
* earlier than for past-the-end iterators an exception is raised.
*
* @ref Triangulation
* @ingroup grid
* @ingroup Iterators
* @author Wolfgang Bangerth, 1998
* @author documentation update Guido Kanschat, 2004
*/
template <typename Accessor>
class TriaRawIterator : public std::iterator<std::bidirectional_iterator_tag,Accessor>
{
public:
/**
* Declare the type of the Accessor for use in the outside world. This way
* other functions can use the Accessor's type without knowledge of how the
* exact implementation actually is.
*/
typedef Accessor AccessorType;
/**
* Empty constructor. Such an object is not usable!
*/
TriaRawIterator ();
/**
* Copy constructor.
*/
TriaRawIterator (const TriaRawIterator &);
/**
* Construct an iterator from the given accessor; the given accessor needs
* not be of the same type as the accessor of this class is, but it needs to
* be convertible.
*
* Through this constructor, it is also possible to construct objects for
* derived iterators:
* @code
* DoFCellAccessor dof_accessor;
* Triangulation::active_cell_iterator cell
* = accessor;
* @endcode
*/
explicit TriaRawIterator (const Accessor &a);
/**
* Constructor. Assumes that the other accessor type is convertible to the
* current one.
*/
template <typename OtherAccessor>
explicit TriaRawIterator (const OtherAccessor &a);
/**
* Proper constructor, initialized with the triangulation, the level and
* index of the object pointed to. The last parameter is of a type declared
* by the accessor class.
*/
TriaRawIterator (const Triangulation<Accessor::dimension,Accessor::space_dimension> *parent,
const int level,
const int index,
const typename AccessorType::AccessorData *local_data = 0);
/**
* This is a conversion operator (constructor) which takes another iterator
* type and copies the data; this conversion works, if there is a conversion
* path from the @p OtherAccessor class to the @p Accessor class of this
* object. One such path would be derived class to base class, which for
* example may be used to get a Triangulation::raw_cell_iterator from a
* DoFHandler::raw_cell_iterator, since the DoFAccessor class is derived
* from the TriaAccessorBase class.
*/
template <typename OtherAccessor>
TriaRawIterator (const TriaRawIterator<OtherAccessor> &i);
/**
* Another conversion operator, where we use the pointers to the
* Triangulation from a TriaAccessorBase object, while the additional data
* is used according to the actual type of Accessor.
*/
TriaRawIterator (const TriaAccessorBase<Accessor::structure_dimension,Accessor::dimension,Accessor::space_dimension> &tria_accessor,
const typename Accessor::AccessorData *local_data);
/**
* Conversion constructor. Same as above with the difference that it
* converts from TriaIterator classes (not TriaRawIterator).
*/
template <typename OtherAccessor>
TriaRawIterator (const TriaIterator<OtherAccessor> &i);
/**
* Conversion constructor. Same as above with the difference that it
* converts from TriaActiveIterator classes (not TriaRawIterator).
*/
template <typename OtherAccessor>
TriaRawIterator (const TriaActiveIterator<OtherAccessor> &i);
/**
* @name Dereferencing
*/
/*@{*/
/**
* Dereferencing operator, returns a reference to an accessor. Usage is thus
* like <tt>(*i).index ();</tt>
*
* This function has to be specialized explicitly for the different @p
* Pointees, to allow an
* <tt>iterator<1,TriangulationLevel<1>::LinesData></tt> to point to
* <tt>tria->lines.cells[index]</tt> while for one dimension higher it has
* to point to <tt>tria->quads.cells[index]</tt>.
*
* You must not dereference invalid or past the end iterators.
*/
const Accessor &operator * () const;
/**
* Dereferencing operator, non-@p const version.
*/
Accessor &operator * ();
/**
* Dereferencing operator, returns a reference of the cell pointed to. Usage
* is thus like <tt>i->index ();</tt>
*
* There is a @p const and a non-@p const version.
*/
const Accessor *operator -> () const;
/**
* Dereferencing operator, non-@p const version.
*/
Accessor *operator -> ();
/**
* In order be able to assign end-iterators for different accessors to each
* other, we need an access function which returns the accessor regardless
* of its state.
*
* @warning This function should not be used in application programs. It is
* only intended for limited purposes inside the library and it makes
* debugging much harder.
*/
const Accessor &access_any () const;
/*@}*/
/**
* Assignment operator.
*/
TriaRawIterator &operator = (const TriaRawIterator &);
/**
* Assignment operator.
*/
// template <class OtherAccessor>
// TriaRawIterator & operator = (const TriaRawIterator<OtherAccessor>&);
/**
* Assignment operator.
*/
// template <class OtherAccessor>
// TriaRawIterator & operator = (const TriaIterator<OtherAccessor>&);
/**
* Assignment operator.
*/
// template <class OtherAccessor>
// TriaRawIterator & operator = (const TriaActiveIterator<OtherAccessor>&);
/**
* Compare for equality.
*/
bool operator == (const TriaRawIterator &) const;
/**
* Compare for inequality.
*/
bool operator != (const TriaRawIterator &) const;
/**
* Ordering relation for iterators.
*
* This relation attempts a total ordering of cells.
*
* The relation is defined as follows:
*
* For objects of <tt>Accessor::structure_dimension <
* Accessor::dimension</tt>, we simply compare the index of such an object.
* The ordering is lexicographic according to the following hierarchy (in
* the sense, that the next test is only applied if the previous was
* inconclusive):
*
* <ol>
* <li> The past-the-end iterator is always ordered last. Two past-the-end
* iterators rank the same, thus false is returned in that case.</li>
*
* <li> The level of the cell.</li>
* <li> The index of a cell inside the level.</li>
* </ol>
*
* @note The ordering is not consistent between different processor in a
* parallel::distributed::Triangulation because we rely on index(), which is
* likely not the same.
*/
bool operator < (const TriaRawIterator &) const;
/**
* Another comparison operator, implementing with the same ordering as
* #operator<.
*/
bool operator > (const TriaRawIterator &) const;
/**@name Advancement of iterators*/
/*@{*/
/**
* Prefix <tt>++</tt> operator: <tt>++iterator</tt>. This operator advances
* the iterator to the next element and returns a reference to
* <tt>*this</tt>.
*/
TriaRawIterator &operator ++ ();
/**
* Postfix <tt>++</tt> operator: <tt>iterator++</tt>. This operator advances
* the iterator to the next element, but returns an iterator to the element
* previously pointed to.
*
* Since this operation involves a temporary and a copy operation and since
* an @p iterator is quite a large object for a pointer, use the prefix
* operator <tt>++iterator</tt> whenever possible, especially in the header
* of for loops (<tt>for (; iterator!=end; ++iterator)</tt>) since there you
* normally never need the returned value.
*/
TriaRawIterator operator ++ (int);
/**
* Prefix @p -- operator: @p --iterator. This operator moves the iterator to
* the previous element and returns a reference to <tt>*this</tt>.
*/
TriaRawIterator &operator -- ();
/**
* Postfix @p -- operator: @p iterator--. This operator moves the iterator
* to the previous element, but returns an iterator to the element
* previously pointed to.
*
* The same applies as for the postfix operator++: If possible, avoid it by
* using the prefix operator form to avoid the use of a temporary variable.
*/
TriaRawIterator operator -- (int);
/*@}*/
/**
* Return the state of the iterator.
*/
IteratorState::IteratorStates state () const;
/**
* Print the iterator to a stream <code>out</code>. The format is
* <tt>level.index</tt>.
*/
template <class StreamType>
void print (StreamType &out) const;
/**
* Determine an estimate for the memory consumption (in bytes) of this
* object.
*/
std::size_t memory_consumption () const;
/**@name Exceptions*/
/*@{*/
/**
* Exception for TriaObjects with level, i.e. cells.
*/
DeclException1 (ExcDereferenceInvalidCell,
Accessor,
<< "You tried to dereference a cell iterator for which this "
<< "is not possible. More information on this iterator: "
<< "level=" << arg1.level()
<< ", index=" << arg1.index()
<< ", state="
<< (arg1.state() == IteratorState::valid ? "valid" :
(arg1.state() == IteratorState::past_the_end ?
"past_the_end" : "invalid")));
/**
* Exception for lower-dimensional TriaObjects without level, i.e. objects
* faces are constructed with.
*/
DeclException1 (ExcDereferenceInvalidObject,
Accessor,
<< "You tried to dereference an iterator for which this "
<< "is not possible. More information on this iterator: "
<< "index=" << arg1.index()
<< ", state="
<< (arg1.state() == IteratorState::valid ? "valid" :
(arg1.state() == IteratorState::past_the_end ?
"past_the_end" : "invalid")));
/**
* Exception
*/
DeclException0 (ExcAdvanceInvalidObject);
/**
* Exception
*/
DeclException0 (ExcInvalidComparison);
/*@}*/
protected:
/**
* Object holding the real data.
*/
Accessor accessor;
/**
* Make all other iterator class templates friends of this class. This is
* necessary for the implementation of conversion constructors.
*
* In fact, we would not need them to be friends if they were for different
* dimensions, but the compiler dislikes giving a fixed dimension and
* variable accessor since then it says that would be a partial
* specialization.
*/
template <typename SomeAccessor> friend class TriaRawIterator;
template <typename SomeAccessor> friend class TriaIterator;
template <typename SomeAccessor> friend class TriaActiveIterator;
};
/**
* This specialization of TriaRawIterator provides access only to the
* <em>used</em> lines, quads, cells, etc.
*
* @ingroup grid
* @ingroup Iterators
*/
template <typename Accessor>
class TriaIterator : public TriaRawIterator<Accessor>
{
public:
/**
* Empty constructor. Such an object is not usable!
*/
TriaIterator ();
/**
* Copy constructor.
*/
TriaIterator (const TriaIterator<Accessor> &);
/**
* Cross copy constructor from iterators pointing also to non-active
* objects.
*
* If the object pointed to is not past-the-end and is not used, the debug
* version raises an error!
*/
TriaIterator (const TriaRawIterator<Accessor> &);
/**
* Proper constructor, initialized with the triangulation, the level and
* index of the object pointed to. The last parameter is of a type declared
* by the accessor class.
*
* If the object pointed to is not past-the-end and is not used, the debug
* version raises an error!
*/
TriaIterator (const Triangulation<Accessor::dimension,Accessor::space_dimension> *parent,
const int level,
const int index,
const typename Accessor::AccessorData *local_data = 0);
/**
* Construct from an accessor of type OtherAccessor that is convertible to
* the type Accessor.
*/
template <typename OtherAccessor>
explicit TriaIterator (const OtherAccessor &a);
/**
* This is a conversion operator (constructor) which takes another iterator
* type and copies the data; this conversion works, if there is a conversion
* path from the @p OtherAccessor class to the @p Accessor class of this
* object. One such path would be derived class to base class, which for
* example may be used to get a Triangulation::cell_iterator from a
* DoFHandler::cell_iterator, since the DoFAccessor class is derived from
* the TriaAccessorBase class.
*/
template <typename OtherAccessor>
TriaIterator (const TriaIterator<OtherAccessor> &i);
/**
* Another conversion operator, where we use the pointers to the
* Triangulation from a TriaAccessorBase object, while the additional data
* is used according to the actual type of Accessor.
*/
TriaIterator (const TriaAccessorBase<Accessor::structure_dimension,Accessor::dimension,Accessor::space_dimension> &tria_accessor,
const typename Accessor::AccessorData *local_data);
/**
* Similar conversion operator to the above one, but does a check whether
* the iterator points to a used element, which is necessary for raw
* iterators.
*/
template <typename OtherAccessor>
TriaIterator (const TriaRawIterator<OtherAccessor> &i);
/**
* Similar conversion operator to the above one, but for conversion from
* active iterators.
*/
template <typename OtherAccessor>
TriaIterator (const TriaActiveIterator<OtherAccessor> &i);
/**
* Assignment operator.
*/
TriaIterator<Accessor> &
operator = (const TriaIterator<Accessor> &);
/**
* Cross assignment operator. This assignment is only valid if the given
* iterator points to a used element.
*/
TriaIterator<Accessor> &
operator = (const TriaRawIterator<Accessor> &);
/**
* Assignment operator. Requires, that Accessor can be copied from
* OtherAccessor.
*/
template <class OtherAccessor>
TriaIterator<Accessor> &
operator = (const TriaIterator<OtherAccessor> &);
/**
* Cross assignment operator. This assignment is only valid if the given
* iterator points to a used element. Requires, that Accessor can be copied
* from OtherAccessor.
*/
template <class OtherAccessor>
TriaIterator<Accessor> &
operator = (const TriaRawIterator<OtherAccessor> &);
/**@name Advancement of iterators*/
/*@{*/
/**
* Prefix <tt>++</tt> operator: <tt>++i</tt>. This operator advances the
* iterator to the next used element and returns a reference to
* <tt>*this</tt>.
*/
TriaIterator<Accessor> &operator ++ ();
/**
* Postfix <tt>++</tt> operator: <tt>i++</tt>. This operator advances the
* iterator to the next used element, but returns an iterator to the element
* previously pointed to. Since this involves a temporary and a copy
* operation and since an @p active_iterator is quite a large object for a
* pointer, use the prefix operator <tt>++i</tt> whenever possible,
* especially in the head of for loops (<tt>for (; i!=end; ++i)</tt>) since
* there you normally never need the returned value.
*/
TriaIterator<Accessor> operator ++ (int);
/**
* Prefix @p -- operator: @p --i. This operator advances the iterator to the
* previous used element and returns a reference to <tt>*this</tt>.
*/
TriaIterator<Accessor> &operator -- ();
/**
* Postfix @p -- operator: @p i--.
*/
TriaIterator<Accessor> operator -- (int);
/*@}*/
/**
* Exception
*/
DeclException0 (ExcAssignmentOfUnusedObject);
};
/**
* This specialization of TriaIterator provides access only to the
* <em>active</em> lines, quads, cells, etc. An active cell is a cell which is
* not refined and thus a cell on which calculations on the finest level are
* done.
*
* @ingroup grid
* @ingroup Iterators
*/
template <typename Accessor>
class TriaActiveIterator : public TriaIterator<Accessor>
{
public:
/**
* Empty constructor. Such an object is not usable!
*/
TriaActiveIterator ();
/**
* Copy constructor.
*/
TriaActiveIterator (const TriaActiveIterator<Accessor> &);
/**
* Cross copy constructor from iterators pointing also to non-active
* objects.
*
* If the object pointed to is not past-the-end and is not active, the debug
* version raises an error!
*/
TriaActiveIterator (const TriaRawIterator<Accessor> &);
/**
* Cross copy constructor from iterators pointing also to non-active
* objects.
*
* If the object pointed to is not past-the-end and is not active, the debug
* version raises an error!
*/
TriaActiveIterator (const TriaIterator<Accessor> &);
/**
* Proper constructor, initialized with the triangulation, the level and
* index of the object pointed to. The last parameter is of a type declared
* by the accessor class.
*
* If the object pointed to is not past-the-end and is not active, the debug
* version raises an error!
*/
TriaActiveIterator (const Triangulation<Accessor::dimension,Accessor::space_dimension> *parent,
const int level,
const int index,
const typename Accessor::AccessorData *local_data = 0);
/**
* This is a conversion operator (constructor) which takes another iterator
* type and copies the data; this conversion works, if there is a conversion
* path from the @p OtherAccessor class to the @p Accessor class of this
* object. One such path would be derived class to base class, which for
* example may be used to get a Triangulation::active_cell_iterator from a
* DoFHandler::active_cell_iterator, since the DoFAccessor class is derived
* from the TriaAccessorBase class.
*/
template <typename OtherAccessor>
TriaActiveIterator (const TriaActiveIterator<OtherAccessor> &i);
/**
* Another conversion operator, where we use the pointers to the
* Triangulation from a TriaAccessorBase object, while the additional data
* is used according to the actual type of Accessor.
*/
TriaActiveIterator (const TriaAccessorBase<Accessor::structure_dimension,Accessor::dimension,Accessor::space_dimension> &tria_accessor,
const typename Accessor::AccessorData *local_data);
/**
* Similar conversion operator to the above one, but does a check whether
* the iterator points to a used element, and is active, which is necessary
* for raw iterators. Since usual iterators are also raw iterators, this
* constructor works also for parameters of type
* <tt>TriaIterator<OtherAccessor></tt>.
*/
template <typename OtherAccessor>
TriaActiveIterator (const TriaRawIterator<OtherAccessor> &i);
/**
* Assignment operator.
*/
TriaActiveIterator<Accessor> &
operator = (const TriaActiveIterator<Accessor> &);
/**
* Cross assignment operator. This assignment is only valid if the given
* iterator points to an active element.
*/
TriaActiveIterator<Accessor> &
operator = (const TriaIterator<Accessor> &);
/**
* Cross assignment operator. This assignment is only valid if the given
* iterator points to an active element or past the end.
*/
TriaActiveIterator<Accessor> &
operator = (const TriaRawIterator<Accessor> &);
/**
* Assignment operator. Requires, that Accessor can be copied from
* OtherAccessor.
*/
template <class OtherAccessor>
TriaActiveIterator<Accessor> &
operator = (const TriaActiveIterator<OtherAccessor> &);
/**
* Cross assignment operator. This assignment is only valid if the given
* iterator points to an active element or past the end. Requires, that
* Accessor can be copied from OtherAccessor.
*/
template <class OtherAccessor>
TriaActiveIterator<Accessor> &
operator = (const TriaRawIterator<OtherAccessor> &);
/**
* Cross assignment operator. This assignment is only valid if the given
* iterator points to an active element. Requires, that Accessor can be
* copied from OtherAccessor.
*/
template <class OtherAccessor>
TriaActiveIterator<Accessor> &
operator = (const TriaIterator<OtherAccessor> &);
/**
* Prefix <tt>++</tt> operator: <tt>++i</tt>. This operator advances the
* iterator to the next active element and returns a reference to
* <tt>*this</tt>.
*/
TriaActiveIterator<Accessor> &operator ++ ();
/**@name Advancement of iterators*/
/*@{*/
/**
* Postfix <tt>++</tt> operator: <tt>i++</tt>. This operator advances the
* iterator to the next active element, but returns an iterator to the
* element previously pointed to. Since this involves a temporary and a copy
* operation and since an @p active_iterator is quite a large object for a
* pointer, use the prefix operator <tt>++i</tt> whenever possible,
* especially in the head of for loops (<tt>for (; i!=end; ++i)</tt>) since
* there you normally never need the returned value.
*/
TriaActiveIterator<Accessor> operator ++ (int);
/**
* Prefix @p -- operator: @p --i. This operator advances the iterator to the
* previous active element and returns a reference to <tt>*this</tt>.
*/
TriaActiveIterator<Accessor> &operator -- ();
/**
* Postfix @p -- operator: @p i--.
*/
TriaActiveIterator<Accessor> operator -- (int);
/*@}*/
/**
* Exception
*/
DeclException0 (ExcAssignmentOfInactiveObject);
};
/*----------------------- Inline functions -------------------*/
template <typename Accessor>
inline
TriaRawIterator<Accessor>::
TriaRawIterator (const Accessor &a)
:
accessor (a)
{}
template <typename Accessor>
template <typename OtherAccessor>
inline
TriaRawIterator<Accessor>::
TriaRawIterator (const OtherAccessor &a)
:
accessor (a)
{}
template <typename Accessor>
template <typename OtherAccessor>
inline
TriaRawIterator<Accessor>::
TriaRawIterator (const TriaRawIterator<OtherAccessor> &i)
:
accessor (i.accessor)
{}
template <typename Accessor>
template <typename OtherAccessor>
inline
TriaRawIterator<Accessor>::
TriaRawIterator (const TriaIterator<OtherAccessor> &i)
:
accessor (i.accessor)
{}
template <typename Accessor>
template <typename OtherAccessor>
inline
TriaRawIterator<Accessor>::
TriaRawIterator (const TriaActiveIterator<OtherAccessor> &i)
:
accessor (i.accessor)
{}
template <typename Accessor>
inline
const Accessor &
TriaRawIterator<Accessor>::operator * () const
{
Assert (Accessor::structure_dimension!=Accessor::dimension ||
state() == IteratorState::valid,
ExcDereferenceInvalidCell(accessor));
Assert (Accessor::structure_dimension==Accessor::dimension ||
state() == IteratorState::valid,
ExcDereferenceInvalidObject(accessor));
return accessor;
}
template <typename Accessor>
inline
Accessor &
TriaRawIterator<Accessor>::operator * ()
{
Assert (Accessor::structure_dimension!=Accessor::dimension ||
state() == IteratorState::valid,
ExcDereferenceInvalidCell(accessor));
Assert (Accessor::structure_dimension==Accessor::dimension ||
state() == IteratorState::valid,
ExcDereferenceInvalidObject(accessor));
return accessor;
}
template <typename Accessor>
inline
const Accessor &
TriaRawIterator<Accessor>::access_any () const
{
return accessor;
}
template <typename Accessor>
inline
const Accessor *
TriaRawIterator<Accessor>::operator -> () const
{
return &(this->operator* ());
}
template <typename Accessor>
inline
Accessor *
TriaRawIterator<Accessor>::operator -> ()
{
return &(this->operator* ());
}
template <typename Accessor>
inline
IteratorState::IteratorStates
TriaRawIterator<Accessor>::state () const
{
return accessor.state ();
}
template <typename Accessor>
inline
bool
TriaRawIterator<Accessor>::operator < (const TriaRawIterator<Accessor> &other) const
{
Assert (state() != IteratorState::invalid, ExcDereferenceInvalidObject(accessor));
Assert (other.state() != IteratorState::invalid, ExcDereferenceInvalidObject(other.accessor));
Assert (&accessor.get_triangulation() == &other.accessor.get_triangulation(),
ExcInvalidComparison());
// Deal with iterators past end
if (state()==IteratorState::past_the_end)
return false;
if (other.state()==IteratorState::past_the_end)
return true;
return ((**this) < (*other));
}
template <typename Accessor>
inline
bool
TriaRawIterator<Accessor>::operator > (const TriaRawIterator<Accessor> &other) const
{
return (other < *this);
}
template <typename Accessor>
inline
TriaRawIterator<Accessor> &
TriaRawIterator<Accessor>::operator ++ ()
{
Assert (state() == IteratorState::valid, ExcAdvanceInvalidObject());
++accessor;
return *this;
}
template <typename Accessor>
inline
TriaRawIterator<Accessor> &
TriaRawIterator<Accessor>::operator -- ()
{
Assert (state() == IteratorState::valid, ExcAdvanceInvalidObject());
--accessor;
return *this;
}
template <typename Accessor>
template <class StreamType>
inline
void
TriaRawIterator<Accessor>::print (StreamType &out) const
{
if (Accessor::structure_dimension==Accessor::dimension)
out << accessor.level() << "." << accessor.index();
else
out << accessor.index();
}
template <typename Accessor>
inline
std::size_t
TriaRawIterator<Accessor>::memory_consumption () const
{
return sizeof(TriaRawIterator<Accessor>);
}
template <typename Accessor>
template <typename OtherAccessor>
inline
TriaIterator<Accessor>::TriaIterator (const TriaIterator<OtherAccessor> &i)
:
TriaRawIterator<Accessor> (i.accessor)
{}
template <typename Accessor>
template <typename OtherAccessor>
inline
TriaIterator<Accessor>::TriaIterator (const TriaActiveIterator<OtherAccessor> &i)
:
TriaRawIterator<Accessor> (i.accessor)
{}
template <typename Accessor>
template <typename OtherAccessor>
inline
TriaIterator<Accessor>::TriaIterator (const TriaRawIterator<OtherAccessor> &i)
:
TriaRawIterator<Accessor> (i.accessor)
{
#ifdef DEBUG
// do this like this, because:
// if we write
// "Assert (IteratorState::past_the_end || used)"
// used() is called anyway, even if
// state==IteratorState::past_the_end, and will then
// throw the exception!
if (this->state() != IteratorState::past_the_end)
Assert (this->accessor.used(),
ExcAssignmentOfUnusedObject());
#endif
}
template <typename Accessor>
template <typename OtherAccessor>
TriaIterator<Accessor>::TriaIterator (const OtherAccessor &a)
:
TriaRawIterator<Accessor> (a)
{
#ifdef DEBUG
// do this like this, because:
// if we write
// "Assert (IteratorState::past_the_end || used)"
// used() is called anyway, even if
// state==IteratorState::past_the_end, and will then
// throw the exception!
if (this->state() != IteratorState::past_the_end)
Assert (this->accessor.used(),
ExcAssignmentOfUnusedObject());
#endif
}
template <typename Accessor>
template <typename OtherAccessor>
inline
TriaActiveIterator<Accessor>::TriaActiveIterator (const TriaActiveIterator<OtherAccessor> &i)
:
TriaIterator<Accessor> (i.accessor)
{}
template <typename Accessor>
template <typename OtherAccessor>
inline
TriaActiveIterator<Accessor>::TriaActiveIterator (const TriaRawIterator<OtherAccessor> &i)
:
TriaIterator<Accessor> (i)
{
#ifdef DEBUG
// do this like this, because:
// if we write
// "Assert (IteratorState::past_the_end || !has_children())"
// has_children() is called anyway, even if
// state==IteratorState::past_the_end, and will then
// throw the exception!
if (this->state() != IteratorState::past_the_end)
Assert (this->accessor.has_children()==false,
ExcAssignmentOfInactiveObject());
#endif
}
/**
* Print the address to which this iterator points to @p out. The address is
* given by the pair <tt>(level,index)</tt>, where @p index is an index
* relative to the level in which the object is that is pointed to.
*
* @author Wolfgang Bangerth, 1998
*/
template <typename Accessor>
inline
std::ostream &operator << (std::ostream &out,
const TriaRawIterator<Accessor> &i)
{
i.print(out);
return out;
}
/**
* Print the address to which this iterator points to @p out. The address is
* given by the pair <tt>(level,index)</tt>, where @p index is an index
* relative to the level in which the object is that is pointed to.
*
* @author Wolfgang Bangerth, 1998
*/
template <typename Accessor>
inline
std::ostream &operator << (std::ostream &out,
const TriaIterator<Accessor> &i)
{
i.print(out);
return out;
}
/**
* Print the address to which this iterator points to @p out. The address is
* given by the pair <tt>(level,index)</tt>, where @p index is an index
* relative to the level in which the object is that is pointed to.
*
* @author Wolfgang Bangerth, 1998
*/
template <typename Accessor>
inline
std::ostream &operator << (std::ostream &out,
const TriaActiveIterator<Accessor> &i)
{
i.print(out);
return out;
}
DEAL_II_NAMESPACE_CLOSE
// if in optimized mode: include more templates
#ifndef DEBUG
# include "tria_iterator.templates.h"
#endif
/*---------------------------- tria-iterator.h ---------------------------*/
#endif
/*---------------------------- tria-iterator.h ---------------------------*/
|