/usr/include/deal.II/dofs/dof_accessor.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 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 | // ---------------------------------------------------------------------
//
// 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__dof_accessor_h
#define dealii__dof_accessor_h
#include <deal.II/base/config.h>
#include <deal.II/grid/tria_accessor.h>
#include <deal.II/dofs/dof_handler.h>
#include <deal.II/hp/dof_handler.h>
#include <vector>
DEAL_II_NAMESPACE_OPEN
template <typename number> class FullMatrix;
template <typename number> class SparseMatrix;
template <typename number> class Vector;
class ConstraintMatrix;
template <typename Accessor> class TriaRawIterator;
template <int, int> class FiniteElement;
namespace internal
{
namespace DoFCellAccessor
{
struct Implementation;
}
namespace DoFHandler
{
struct Implementation;
namespace Policy
{
struct Implementation;
}
}
namespace hp
{
namespace DoFHandler
{
struct Implementation;
}
}
}
// note: the file dof_accessor.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.
namespace internal
{
namespace DoFAccessor
{
/**
* This is a switch class which only declares a @p typedef. It is meant to
* determine which class a DoFAccessor class is to be derived from. By
* default, <tt>DoFAccessor@<structdim,dim,spacedim@></tt> derives from
* the typedef in the general
* <tt>Inheritance@<structdim,dim,spacedim@></tt> class, which is
* <tt>TriaAccessor@<structdim,dim,spacedim@></tt>, but if
* <tt>structdim==dim</tt>, then the specialization
* <tt>Inheritance@<dim,dim,spacedim@></tt> is used which declares its
* local type to be <tt>CellAccessor@<dim,spacedim@></tt>. Therefore, the
* inheritance is automatically chosen to be from CellAccessor if the
* object under consideration has full dimension, i.e. constitutes a cell.
*
* @ingroup dofs
* @ingroup Accessors
* @author Wolfgang Bangerth, 1999
*/
template <int structdim, int dim, int spacedim>
struct Inheritance
{
/**
* Declaration of the @p typedef. See the full documentation for more
* information.
*/
typedef dealii::TriaAccessor<structdim,dim,spacedim> BaseClass;
};
/**
* This is the specialization of the general template used for the case
* where an object has full dimension, i.e. is a cell. See the general
* template for more details.
*/
template <int dim, int spacedim>
struct Inheritance<dim,dim,spacedim>
{
/**
* Declaration of the @p typedef. See the full documentation for more
* information.
*/
typedef dealii::CellAccessor<dim,spacedim> BaseClass;
};
}
}
/* -------------------------------------------------------------------------- */
/**
* A class that gives access to the degrees of freedom stored in a DoFHandler
* or hp::DoFHandler object. Accessors are used to access the data that
* pertains to edges, faces, and cells of a triangulation. The concept is
* explained in more detail in connection to
* @ref Iterators.
*
* This class follows mainly the route laid out by the accessor library
* declared in the triangulation library (TriaAccessor). It enables the user
* to access the degrees of freedom on lines, quads, or hexes. The first
* template argument of this class determines the dimensionality of the object
* under consideration: 1 for lines, 2 for quads, and 3 for hexes. The second
* argument denotes the type of DoF handler we should work on. It can either
* be ::DoFHandler or hp::DoFHandler. From the second template argument we
* also deduce the dimension of the Triangulation this object refers to as
* well as the dimension of the space into which it is embedded. Finally, the
* template argument <code>level_dof_access</code> governs the behavior of the
* function get_active_or_mg_dof_indices(). See the section on Generic loops
* below.
*
* <h3>Typedefs</h3>
*
* Usage is best to happen through the typedefs to the various kinds of
* iterators provided by the DoFHandler and hp::DoFHandler classes, since they
* are more secure to changes in the class naming and template interface as
* well as providing easier typing (much less complicated names!).
*
* <h3>Generic loops and the third template argument</h3>
*
* Many loops look very similar, whether they operate on the active dofs of
* the active cells of the Triangulation or on the level dofs of a single
* level or the whole grid hierarchy. In order to use polymorphism in such
* loops, they access degrees of freedom through the function
* get_active_or_mg_dof_indices(), which changes behavior according to the
* third template argument. If the argument is false, then the active dofs of
* active cells are accessed. If it is true, the level dofs are used.
* DoFHandler has functions, for instance begin() and begin_mg(), which return
* either type or the other. Additionally, they can be cast into each other,
* in case this is needed, since they access the same data.
*
* It is highly recommended to use the function get_active_or_mg_dof_indices()
* in generic loops in lieu of get_dof_indices() or get_mg_dof_indices().
*
* <h3>Inheritance</h3>
*
* If the structural dimension given by the first template argument equals the
* dimension of the DoFHandler (given as the second template argument), then
* we are obviously dealing with cells, rather than lower-dimensional objects.
* In that case, inheritance is from CellAccessor, to provide access to all
* the cell specific information afforded by that class. Otherwise, i.e. for
* lower-dimensional objects, inheritance is from TriaAccessor.
*
* There is a DoFCellAccessor class that provides the equivalent to the
* CellAccessor class.
*
* @ingroup dofs
* @ingroup Accessors
* @author Wolfgang Bangerth, 1998, 2006, 2008, Timo Heister, Guido Kanschat,
* 2012, 2013
*/
template <int structdim, typename DoFHandlerType, bool level_dof_access>
class DoFAccessor : public dealii::internal::DoFAccessor::Inheritance<structdim, DoFHandlerType::dimension, DoFHandlerType::space_dimension>::BaseClass
{
public:
/**
* A static variable that allows users of this class to discover the value
* of the second template argument.
*/
static const unsigned int dimension=DoFHandlerType::dimension;
/**
* A static variable that allows users of this class to discover the value
* of the third template argument.
*/
static const unsigned int space_dimension=DoFHandlerType::space_dimension;
/**
* Declare a typedef to the base class to make accessing some of the
* exception classes simpler.
*/
typedef
typename dealii::internal::DoFAccessor::Inheritance<structdim, dimension, space_dimension>::BaseClass
BaseClass;
/**
* Data type passed by the iterator class.
*/
typedef DoFHandlerType AccessorData;
/**
* @name Constructors
*/
/**
* @{
*/
/**
* Default constructor. Provides an accessor that can't be used.
*/
DoFAccessor ();
/**
* Constructor
*/
DoFAccessor (const Triangulation<DoFHandlerType::dimension,DoFHandlerType::space_dimension> *tria,
const int level,
const int index,
const DoFHandlerType *local_data);
/**
* Conversion constructor. This constructor exists to make certain
* constructs simpler to write in dimension independent code. For example,
* it allows assigning a face iterator to a line iterator, an operation that
* is useful in 2d but doesn't make any sense in 3d. The constructor here
* exists for the purpose of making the code conform to C++ but it will
* unconditionally abort; in other words, assigning a face iterator to a
* line iterator is better put into an if-statement that checks that the
* dimension is two, and assign to a quad iterator in 3d (an operator that,
* without this constructor would be illegal if we happen to compile for
* 2d).
*/
template <int structdim2, int dim2, int spacedim2>
DoFAccessor (const InvalidAccessor<structdim2,dim2,spacedim2> &);
/**
* Another conversion operator between objects that don't make sense, just
* like the previous one.
*/
template <int dim2, class DoFHandlerType2, bool level_dof_access2>
DoFAccessor (const DoFAccessor<dim2, DoFHandlerType2, level_dof_access2> &);
/**
* Copy constructor allowing to switch level access and active access.
*/
template <bool level_dof_access2>
DoFAccessor(const DoFAccessor<structdim, DoFHandlerType, level_dof_access2> &);
/**
* @}
*/
/**
* Return a handle on the DoFHandler object which we are using.
*/
const DoFHandlerType &
get_dof_handler () const;
/**
* Implement the copy operator needed for the iterator classes.
*/
template <bool level_dof_access2>
void copy_from (const DoFAccessor<structdim, DoFHandlerType, level_dof_access2> &a);
/**
* Copy operator used by the iterator class. Keeps the previously set dof
* handler, but sets the object coordinates of the TriaAccessor.
*/
void copy_from (const TriaAccessorBase<structdim, DoFHandlerType::dimension, DoFHandlerType::space_dimension> &da);
/**
* Tell the caller whether get_active_or_mg_dof_indices() accesses active or
* level dofs.
*/
static bool is_level_cell();
/**
* @name Accessing sub-objects
*/
/**
* @{
*/
/**
* Return an iterator pointing to the @p c-th child.
*/
TriaIterator<DoFAccessor<structdim,DoFHandlerType, level_dof_access> >
child (const unsigned int c) const;
/**
* Pointer to the @p ith line bounding this object. If the current object is
* a line itself, then the only valid index is @p i equals to zero, and the
* function returns an iterator to itself.
*/
typename dealii::internal::DoFHandler::Iterators<DoFHandlerType, level_dof_access>::line_iterator
line (const unsigned int i) const;
/**
* Pointer to the @p ith quad bounding this object. If the current object is
* a quad itself, then the only valid index is @p i equals to zero, and the
* function returns an iterator to itself.
*/
typename dealii::internal::DoFHandler::Iterators<DoFHandlerType, level_dof_access>::quad_iterator
quad (const unsigned int i) const;
/**
* @}
*/
/**
* @name Accessing the DoF indices of this object
*/
/**
* @{
*/
/**
* Return the <i>global</i> indices of the degrees of freedom located on
* this object in the standard ordering defined by the finite element (i.e.,
* dofs on vertex 0, dofs on vertex 1, etc, dofs on line 0, dofs on line 1,
* etc, dofs on quad 0, etc.) This function is only available on
* <i>active</i> objects (see
* @ref GlossActive "this glossary entry").
*
* The cells needs to be an active cell (and not artificial in a parallel
* distributed computation).
*
* The vector has to have the right size before being passed to this
* function.
*
* The last argument denotes the finite element index. For the standard
* ::DoFHandler class, this value must be equal to its default value since
* that class only supports the same finite element on all cells anyway.
*
* However, for hp objects (i.e. the hp::DoFHandler class), different finite
* element objects may be used on different cells. On faces between two
* cells, as well as vertices, there may therefore be two sets of degrees of
* freedom, one for each of the finite elements used on the adjacent cells.
* In order to specify which set of degrees of freedom to work on, the last
* argument is used to disambiguate. Finally, if this function is called for
* a cell object, there can only be a single set of degrees of freedom, and
* fe_index has to match the result of active_fe_index().
*
* For cells, there is only a single possible finite element index (namely
* the one for that cell, returned by <code>cell-@>active_fe_index</code>.
* Consequently, the derived DoFCellAccessor class has an overloaded version
* of this function that calls the present function with
* <code>cell-@>active_fe_index</code> as last argument.
*
*/
void get_dof_indices (std::vector<types::global_dof_index> &dof_indices,
const unsigned int fe_index = DoFHandlerType::default_fe_index) const;
/**
* Return the global multilevel indices of the degrees of freedom that live
* on the current object with respect to the given level within the
* multigrid hierarchy. The indices refer to the local numbering for the
* level this line lives on.
*/
void get_mg_dof_indices (const int level,
std::vector<types::global_dof_index> &dof_indices,
const unsigned int fe_index = DoFHandlerType::default_fe_index) const;
/**
* Sets the level DoF indices that are returned by get_mg_dof_indices.
*/
void set_mg_dof_indices (const int level,
const std::vector<types::global_dof_index> &dof_indices,
const unsigned int fe_index = DoFHandlerType::default_fe_index);
/**
* Global DoF index of the <i>i</i> degree associated with the @p vertexth
* vertex of the present cell.
*
* The last argument denotes the finite element index. For the standard
* ::DoFHandler class, this value must be equal to its default value since
* that class only supports the same finite element on all cells anyway.
*
* However, for hp objects (i.e. the hp::DoFHandler class), different finite
* element objects may be used on different cells. On faces between two
* cells, as well as vertices, there may therefore be two sets of degrees of
* freedom, one for each of the finite elements used on the adjacent cells.
* In order to specify which set of degrees of freedom to work on, the last
* argument is used to disambiguate. Finally, if this function is called for
* a cell object, there can only be a single set of degrees of freedom, and
* fe_index has to match the result of active_fe_index().
*/
types::global_dof_index vertex_dof_index
(const unsigned int vertex,
const unsigned int i,
const unsigned int fe_index = DoFHandlerType::default_fe_index) const;
/**
* Returns the global DoF index of the <code>i</code>th degree of freedom
* associated with the <code>vertex</code>th vertex on level @p level. Also
* see vertex_dof_index().
*/
types::global_dof_index mg_vertex_dof_index
(const int level,
const unsigned int vertex,
const unsigned int i,
const unsigned int fe_index = DoFHandlerType::default_fe_index) const;
/**
* Index of the <i>i</i>th degree of freedom of this object.
*
* The last argument denotes the finite element index. For the standard
* ::DoFHandler class, this value must be equal to its default value since
* that class only supports the same finite element on all cells anyway.
*
* However, for hp objects (i.e. the hp::DoFHandler class), different finite
* element objects may be used on different cells. On faces between two
* cells, as well as vertices, there may therefore be two sets of degrees of
* freedom, one for each of the finite elements used on the adjacent cells.
* In order to specify which set of degrees of freedom to work on, the last
* argument is used to disambiguate. Finally, if this function is called for
* a cell object, there can only be a single set of degrees of freedom, and
* fe_index has to match the result of active_fe_index().
*
* @note While the get_dof_indices() function returns an array that contains
* the indices of all degrees of freedom that somehow live on this object
* (i.e. on the vertices, edges or interior of this object), the current
* dof_index() function only considers the DoFs that really belong to this
* particular object's interior. In other words, as an example, if the
* current object refers to a quad (a cell in 2d, a face in 3d) and the
* finite element associated with it is a bilinear one, then the
* get_dof_indices() will return an array of size 4 while dof_index() will
* produce an exception because no degrees are defined in the interior of
* the face.
*/
types::global_dof_index dof_index
(const unsigned int i,
const unsigned int fe_index = DoFHandlerType::default_fe_index) const;
/**
* Returns the dof_index on the given level. Also see dof_index.
*/
types::global_dof_index mg_dof_index (const int level, const unsigned int i) const;
/**
* @}
*/
/**
* @name Accessing the finite element associated with this object
*/
/**
* @{
*/
/**
* Return the number of finite elements that are active on a given object.
*
* For non-hp DoFHandler objects, the answer is of course always one.
* However, for hp::DoFHandler objects, this isn't the case: If this is a
* cell, the answer is of course one. If it is a face, the answer may be one
* or two, depending on whether the two adjacent cells use the same finite
* element or not. If it is an edge in 3d, the possible return value may be
* one or any other value larger than that.
*/
unsigned int
n_active_fe_indices () const;
/**
* Return the @p n-th active fe index on this object. For cells and all non-
* hp objects, there is only a single active fe index, so the argument must
* be equal to zero. For lower-dimensional hp objects, there are
* n_active_fe_indices() active finite elements, and this function can be
* queried for their indices.
*/
unsigned int
nth_active_fe_index (const unsigned int n) const;
/**
* Return true if the finite element with given index is active on the
* present object. For non-hp DoF accessors, this is of course the case only
* if @p fe_index equals zero. For cells, it is the case if @p fe_index
* equals active_fe_index() of this cell. For faces and other lower-
* dimensional objects, there may be more than one @p fe_index that are
* active on any given object (see n_active_fe_indices()).
*/
bool
fe_index_is_active (const unsigned int fe_index) const;
/**
* Return a reference to the finite element used on this object with the
* given @p fe_index. @p fe_index must be used on this object, i.e.
* <code>fe_index_is_active(fe_index)</code> must return true.
*/
const FiniteElement<DoFHandlerType::dimension,DoFHandlerType::space_dimension> &
get_fe (const unsigned int fe_index) const;
/**
* @}
*/
/**
* Exceptions for child classes
*
* @ingroup Exceptions
*/
DeclException0 (ExcInvalidObject);
/**
* Exception
*
* @ingroup Exceptions
*/
DeclException0 (ExcVectorNotEmpty);
/**
* Exception
*
* @ingroup Exceptions
*/
DeclException0 (ExcVectorDoesNotMatch);
/**
* Exception
*
* @ingroup Exceptions
*/
DeclException0 (ExcMatrixDoesNotMatch);
/**
* A function has been called for a cell which should be
* @ref GlossActive "active",
* but is refined.
*
* @ingroup Exceptions
*/
DeclException0 (ExcNotActive);
/**
* Exception
*
* @ingroup Exceptions
*/
DeclException0 (ExcCantCompareIterators);
protected:
/**
* Store the address of the DoFHandler object to be accessed.
*/
DoFHandlerType *dof_handler;
public:
/**
* Compare for equality. Return <tt>true</tt> if the two accessors refer to
* the same object.
*
* The template parameters of this function allow for a comparison of very
* different objects. Therefore, some of them are disabled. Namely, if the
* dimension, or the dof handler of the two objects differ, an exception is
* generated. It can be expected that this is an unwanted comparison.
*
* The template parameter <tt>level_dof_access2</tt> is ignored, such that
* an iterator with level access can be equal to one with access to the
* active degrees of freedom.
*/
template <int dim2, class DoFHandlerType2, bool level_dof_access2>
bool operator == (const DoFAccessor<dim2,DoFHandlerType2,level_dof_access2> &) const;
/**
* Compare for inequality. The boolean not of operator==().
*/
template <int dim2, class DoFHandlerType2, bool level_dof_access2>
bool operator != (const DoFAccessor<dim2,DoFHandlerType2,level_dof_access2> &) const;
protected:
/**
* Reset the DoF handler pointer.
*/
void set_dof_handler (DoFHandlerType *dh);
/**
* Set the index of the <i>i</i>th degree of freedom of this object to @p
* index.
*
* The last argument denotes the finite element index. For the standard
* ::DoFHandler class, this value must be equal to its default value since
* that class only supports the same finite element on all cells anyway.
*
* However, for hp objects (i.e. the hp::DoFHandler class), different finite
* element objects may be used on different cells. On faces between two
* cells, as well as vertices, there may therefore be two sets of degrees of
* freedom, one for each of the finite elements used on the adjacent cells.
* In order to specify which set of degrees of freedom to work on, the last
* argument is used to disambiguate. Finally, if this function is called for
* a cell object, there can only be a single set of degrees of freedom, and
* fe_index has to match the result of active_fe_index().
*/
void set_dof_index
(const unsigned int i,
const types::global_dof_index index,
const unsigned int fe_index = DoFHandlerType::default_fe_index) const;
void set_mg_dof_index (const int level, const unsigned int i, const types::global_dof_index index) const;
/**
* Set the global index of the <i>i</i> degree on the @p vertex-th vertex of
* the present cell to @p index.
*
* The last argument denotes the finite element index. For the standard
* ::DoFHandler class, this value must be equal to its default value since
* that class only supports the same finite element on all cells anyway.
*
* However, for hp objects (i.e. the hp::DoFHandler class), different finite
* element objects may be used on different cells. On faces between two
* cells, as well as vertices, there may therefore be two sets of degrees of
* freedom, one for each of the finite elements used on the adjacent cells.
* In order to specify which set of degrees of freedom to work on, the last
* argument is used to disambiguate. Finally, if this function is called for
* a cell object, there can only be a single set of degrees of freedom, and
* fe_index has to match the result of active_fe_index().
*/
void set_vertex_dof_index
(const unsigned int vertex,
const unsigned int i,
const types::global_dof_index index,
const unsigned int fe_index = DoFHandlerType::default_fe_index) const;
void set_mg_vertex_dof_index
(const int level,
const unsigned int vertex,
const unsigned int i,
const types::global_dof_index index,
const unsigned int fe_index = DoFHandlerType::default_fe_index) const;
/**
* Iterator classes need to be friends because they need to access
* operator== and operator!=.
*/
template <typename> friend class TriaRawIterator;
template <int, class, bool> friend class DoFAccessor;
private:
/**
* Copy operator. This is normally used in a context like <tt>iterator a,b;
* *a=*b;</tt>. Presumably, the intent here is to copy the object pointed to
* by @p b to the object pointed to by @p a. However, the result of
* dereferencing an iterator is not an object but an accessor; consequently,
* this operation is not useful for iterators on triangulations. We declare
* this function here private, thus it may not be used from outside.
* Furthermore it is not implemented and will give a linker error if used
* anyway.
*/
DoFAccessor<structdim,DoFHandlerType, level_dof_access> &
operator = (const DoFAccessor<structdim,DoFHandlerType, level_dof_access> &da);
/**
* Make the DoFHandler class a friend so that it can call the set_xxx()
* functions.
*/
template <int dim, int spacedim> friend class DoFHandler;
template <int dim, int spacedim> friend class hp::DoFHandler;
friend struct dealii::internal::DoFHandler::Policy::Implementation;
friend struct dealii::internal::DoFHandler::Implementation;
friend struct dealii::internal::hp::DoFHandler::Implementation;
friend struct dealii::internal::DoFCellAccessor::Implementation;
friend struct dealii::internal::DoFAccessor::Implementation;
};
/**
* Specialization of the general DoFAccessor class template for the case of
* zero-dimensional objects (a vertex) that are the face of a one-dimensional
* cell in spacedim space dimensions. Since vertices function differently than
* general faces, this class does a few things differently than the general
* template, but the interface should look the same.
*
* @author Wolfgang Bangerth, 2010
*/
template <template <int, int> class DoFHandlerType, int spacedim, bool level_dof_access>
class DoFAccessor<0,DoFHandlerType<1,spacedim>, level_dof_access> : public TriaAccessor<0,1,spacedim>
{
public:
/**
* A static variable that allows users of this class to discover the value
* of the second template argument.
*/
static const unsigned int dimension=1;
/**
* A static variable that allows users of this class to discover the value
* of the third template argument.
*/
static const unsigned int space_dimension=spacedim;
/**
* Declare a typedef to the base class to make accessing some of the
* exception classes simpler.
*/
typedef TriaAccessor<0,1,spacedim> BaseClass;
/**
* Data type passed by the iterator class.
*/
typedef DoFHandlerType<1,spacedim> AccessorData;
/**
* @name Constructors
*/
/**
* @{
*/
/**
* Default constructor. Provides an accessor that can't be used.
*/
DoFAccessor ();
/**
* Constructor to be used if the object here refers to a vertex of a one-
* dimensional triangulation, i.e. a face of the triangulation.
*
* Since there is no mapping from vertices to cells, an accessor object for
* a point has no way to figure out whether it is at the boundary of the
* domain or not. Consequently, the second argument must be passed by the
* object that generates this accessor -- e.g. a 1d cell that can figure out
* whether its left or right vertex are at the boundary.
*
* The third argument is the global index of the vertex we point to.
*
* The fourth argument is a pointer to the DoFHandler object.
*
* This iterator can only be called for one-dimensional triangulations.
*/
DoFAccessor (const Triangulation<1,spacedim> *tria,
const typename TriaAccessor<0,1,spacedim>::VertexKind vertex_kind,
const unsigned int vertex_index,
const DoFHandlerType<1,spacedim> *dof_handler);
/**
* Constructor. This constructor exists in order to maintain interface
* compatibility with the other accessor classes. However, it doesn't do
* anything useful here and so may not actually be called.
*/
DoFAccessor (const Triangulation<1,spacedim> *,
const int = 0,
const int = 0,
const DoFHandlerType<1,spacedim> *dof_handler = 0);
/**
* Conversion constructor. This constructor exists to make certain
* constructs simpler to write in dimension independent code. For example,
* it allows assigning a face iterator to a line iterator, an operation that
* is useful in 2d but doesn't make any sense in 3d. The constructor here
* exists for the purpose of making the code conform to C++ but it will
* unconditionally abort; in other words, assigning a face iterator to a
* line iterator is better put into an if-statement that checks that the
* dimension is two, and assign to a quad iterator in 3d (an operator that,
* without this constructor would be illegal if we happen to compile for
* 2d).
*/
template <int structdim2, int dim2, int spacedim2>
DoFAccessor (const InvalidAccessor<structdim2,dim2,spacedim2> &);
/**
* Another conversion operator between objects that don't make sense, just
* like the previous one.
*/
template <int dim2, class DoFHandlerType2, bool level_dof_access2>
DoFAccessor (const DoFAccessor<dim2, DoFHandlerType2, level_dof_access2> &);
/**
* @}
*/
/**
* Return a handle on the DoFHandler object which we are using.
*/
const DoFHandlerType<1,spacedim> &
get_dof_handler () const;
/**
* Copy operator.
*/
DoFAccessor<0,DoFHandlerType<1,spacedim>, level_dof_access> &
operator = (const DoFAccessor<0,DoFHandlerType<1,spacedim>, level_dof_access> &da);
/**
* Implement the copy operator needed for the iterator classes.
*/
template <bool level_dof_access2>
void copy_from (const DoFAccessor<0, DoFHandlerType<1,spacedim>, level_dof_access2> &a);
/**
* Copy operator used by the iterator class. Keeps the previously set dof
* handler, but sets the object coordinates of the TriaAccessor.
*/
void copy_from (const TriaAccessorBase<0, 1, spacedim> &da);
/**
* @name Accessing sub-objects
*/
/**
* @{
*/
/**
* Return an invalid iterator of a type that represents pointing to a child
* of the current object. The object is invalid because points (as
* represented by the current class) do not have children.
*/
TriaIterator<DoFAccessor<0,DoFHandlerType<1,spacedim>, level_dof_access > >
child (const unsigned int c) const;
/**
* Pointer to the @p ith line bounding this object. If the current object is
* a line itself, then the only valid index is @p i equals to zero, and the
* function returns an iterator to itself.
*/
typename dealii::internal::DoFHandler::Iterators<DoFHandlerType<1,spacedim>, level_dof_access>::line_iterator
line (const unsigned int i) const;
/**
* Pointer to the @p ith quad bounding this object. If the current object is
* a quad itself, then the only valid index is @p i equals to zero, and the
* function returns an iterator to itself.
*/
typename dealii::internal::DoFHandler::Iterators<DoFHandlerType<1,spacedim>, level_dof_access>::quad_iterator
quad (const unsigned int i) const;
/**
* @}
*/
/**
* @name Accessing the DoF indices of this object
*/
/**
* @{
*/
/**
* Return the <i>global</i> indices of the degrees of freedom located on
* this object in the standard ordering defined by the finite element (i.e.,
* dofs on vertex 0, dofs on vertex 1, etc, dofs on line 0, dofs on line 1,
* etc, dofs on quad 0, etc.) This function is only available on
* <i>active</i> objects (see
* @ref GlossActive "this glossary entry").
*
* The cells needs to be an active cell (and not artificial in a parallel
* distributed computation).
*
* The vector has to have the right size before being passed to this
* function.
*
* The last argument denotes the finite element index. For the standard
* ::DoFHandler class, this value must be equal to its default value since
* that class only supports the same finite element on all cells anyway.
*
* However, for hp objects (i.e. the hp::DoFHandler class), different finite
* element objects may be used on different cells. On faces between two
* cells, as well as vertices, there may therefore be two sets of degrees of
* freedom, one for each of the finite elements used on the adjacent cells.
* In order to specify which set of degrees of freedom to work on, the last
* argument is used to disambiguate. Finally, if this function is called for
* a cell object, there can only be a single set of degrees of freedom, and
* fe_index has to match the result of active_fe_index().
*
* For cells, there is only a single possible finite element index (namely
* the one for that cell, returned by <code>cell-@>active_fe_index</code>.
* Consequently, the derived DoFCellAccessor class has an overloaded version
* of this function that calls the present function with
* <code>cell-@>active_fe_index</code> as last argument.
*/
void get_dof_indices (std::vector<types::global_dof_index> &dof_indices,
const unsigned int fe_index = AccessorData::default_fe_index) const;
/**
* Global DoF index of the <i>i</i> degree associated with the @p vertexth
* vertex of the present cell.
*
* The last argument denotes the finite element index. For the standard
* ::DoFHandler class, this value must be equal to its default value since
* that class only supports the same finite element on all cells anyway.
*
* However, for hp objects (i.e. the hp::DoFHandler class), different finite
* element objects may be used on different cells. On faces between two
* cells, as well as vertices, there may therefore be two sets of degrees of
* freedom, one for each of the finite elements used on the adjacent cells.
* In order to specify which set of degrees of freedom to work on, the last
* argument is used to disambiguate. Finally, if this function is called for
* a cell object, there can only be a single set of degrees of freedom, and
* fe_index has to match the result of active_fe_index().
*/
types::global_dof_index vertex_dof_index (const unsigned int vertex,
const unsigned int i,
const unsigned int fe_index = AccessorData::default_fe_index) const;
/**
* Index of the <i>i</i>th degree of freedom of this object.
*
* The last argument denotes the finite element index. For the standard
* ::DoFHandler class, this value must be equal to its default value since
* that class only supports the same finite element on all cells anyway.
*
* However, for hp objects (i.e. the hp::DoFHandler class), different finite
* element objects may be used on different cells. On faces between two
* cells, as well as vertices, there may therefore be two sets of degrees of
* freedom, one for each of the finite elements used on the adjacent cells.
* In order to specify which set of degrees of freedom to work on, the last
* argument is used to disambiguate. Finally, if this function is called for
* a cell object, there can only be a single set of degrees of freedom, and
* fe_index has to match the result of active_fe_index().
*
* @note While the get_dof_indices() function returns an array that contains
* the indices of all degrees of freedom that somehow live on this object
* (i.e. on the vertices, edges or interior of this object), the current
* dof_index() function only considers the DoFs that really belong to this
* particular object's interior. In other words, as an example, if the
* current object refers to a quad (a cell in 2d, a face in 3d) and the
* finite element associated with it is a bilinear one, then the
* get_dof_indices() will return an array of size 4 while dof_index() will
* produce an exception because no degrees are defined in the interior of
* the face.
*/
types::global_dof_index dof_index (const unsigned int i,
const unsigned int fe_index = AccessorData::default_fe_index) const;
/**
* @}
*/
/**
* @name Accessing the finite element associated with this object
*/
/**
* @{
*/
/**
* Return the number of finite elements that are active on a given object.
*
* For non-hp DoFHandler objects, the answer is of course always one.
* However, for hp::DoFHandler objects, this isn't the case: If this is a
* cell, the answer is of course one. If it is a face, the answer may be one
* or two, depending on whether the two adjacent cells use the same finite
* element or not. If it is an edge in 3d, the possible return value may be
* one or any other value larger than that.
*/
unsigned int
n_active_fe_indices () const;
/**
* Return the @p n-th active fe index on this object. For cells and all non-
* hp objects, there is only a single active fe index, so the argument must
* be equal to zero. For lower-dimensional hp objects, there are
* n_active_fe_indices() active finite elements, and this function can be
* queried for their indices.
*/
unsigned int
nth_active_fe_index (const unsigned int n) const;
/**
* Return true if the finite element with given index is active on the
* present object. For non-hp DoF accessors, this is of course the case only
* if @p fe_index equals zero. For cells, it is the case if @p fe_index
* equals active_fe_index() of this cell. For faces and other lower-
* dimensional objects, there may be more than one @p fe_index that are
* active on any given object (see n_active_fe_indices()).
*/
bool
fe_index_is_active (const unsigned int fe_index) const;
/**
* Return a reference to the finite element used on this object with the
* given @p fe_index. @p fe_index must be used on this object, i.e.
* <code>fe_index_is_active(fe_index)</code> must return true.
*/
const FiniteElement<DoFHandlerType<1,spacedim>::dimension,DoFHandlerType<1,spacedim>::space_dimension> &
get_fe (const unsigned int fe_index) const;
/**
* @}
*/
/**
* Exceptions for child classes
*
* @ingroup Exceptions
*/
DeclException0 (ExcInvalidObject);
/**
* Exception
*
* @ingroup Exceptions
*/
DeclException0 (ExcVectorNotEmpty);
/**
* Exception
*
* @ingroup Exceptions
*/
DeclException0 (ExcVectorDoesNotMatch);
/**
* Exception
*
* @ingroup Exceptions
*/
DeclException0 (ExcMatrixDoesNotMatch);
/**
* A function has been called for a cell which should be
* @ref GlossActive "active",
* but is refined.
*
* @ingroup Exceptions
*/
DeclException0 (ExcNotActive);
/**
* Exception
*
* @ingroup Exceptions
*/
DeclException0 (ExcCantCompareIterators);
protected:
/**
* Store the address of the DoFHandler object to be accessed.
*/
DoFHandlerType<1,spacedim> *dof_handler;
/**
* Compare for equality.
*/
template <int dim2, class DoFHandlerType2, bool level_dof_access2>
bool operator == (const DoFAccessor<dim2,DoFHandlerType2,level_dof_access2> &) const;
/**
* Compare for inequality.
*/
template <int dim2, class DoFHandlerType2, bool level_dof_access2>
bool operator != (const DoFAccessor<dim2,DoFHandlerType2,level_dof_access2> &) const;
/**
* Reset the DoF handler pointer.
*/
void set_dof_handler (DoFHandlerType<1,spacedim> *dh);
/**
* Set the index of the <i>i</i>th degree of freedom of this object to @p
* index.
*
* The last argument denotes the finite element index. For the standard
* ::DoFHandler class, this value must be equal to its default value since
* that class only supports the same finite element on all cells anyway.
*
* However, for hp objects (i.e. the hp::DoFHandler class), different finite
* element objects may be used on different cells. On faces between two
* cells, as well as vertices, there may therefore be two sets of degrees of
* freedom, one for each of the finite elements used on the adjacent cells.
* In order to specify which set of degrees of freedom to work on, the last
* argument is used to disambiguate. Finally, if this function is called for
* a cell object, there can only be a single set of degrees of freedom, and
* fe_index has to match the result of active_fe_index().
*/
void set_dof_index (const unsigned int i,
const types::global_dof_index index,
const unsigned int fe_index = AccessorData::default_fe_index) const;
/**
* Set the global index of the <i>i</i> degree on the @p vertex-th vertex of
* the present cell to @p index.
*
* The last argument denotes the finite element index. For the standard
* ::DoFHandler class, this value must be equal to its default value since
* that class only supports the same finite element on all cells anyway.
*
* However, for hp objects (i.e. the hp::DoFHandler class), different finite
* element objects may be used on different cells. On faces between two
* cells, as well as vertices, there may therefore be two sets of degrees of
* freedom, one for each of the finite elements used on the adjacent cells.
* In order to specify which set of degrees of freedom to work on, the last
* argument is used to disambiguate. Finally, if this function is called for
* a cell object, there can only be a single set of degrees of freedom, and
* fe_index has to match the result of active_fe_index().
*/
void set_vertex_dof_index (const unsigned int vertex,
const unsigned int i,
const types::global_dof_index index,
const unsigned int fe_index = AccessorData::default_fe_index) const;
/**
* Iterator classes need to be friends because they need to access
* operator== and operator!=.
*/
template <typename> friend class TriaRawIterator;
/**
* Make the DoFHandler class a friend so that it can call the set_xxx()
* functions.
*/
template <int, int> friend class DoFHandler;
template <int, int> friend class hp::DoFHandler;
friend struct dealii::internal::DoFHandler::Policy::Implementation;
friend struct dealii::internal::DoFHandler::Implementation;
friend struct dealii::internal::hp::DoFHandler::Implementation;
friend struct dealii::internal::DoFCellAccessor::Implementation;
};
/* -------------------------------------------------------------------------- */
/**
* Grant access to the degrees of freedom on a cell.
*
* Note that since for the class we derive from, i.e.
* <tt>DoFAccessor<dim></tt>, the two template parameters are equal, the base
* class is actually derived from CellAccessor, which makes the functions of
* this class available to the DoFCellAccessor class as well.
*
* @ingroup dofs
* @ingroup Accessors
* @author Wolfgang Bangerth, 1998, Timo Heister, Guido Kanschat, 2012
*/
template <typename DoFHandlerType, bool level_dof_access>
class DoFCellAccessor : public DoFAccessor<DoFHandlerType::dimension,DoFHandlerType, level_dof_access>
{
public:
/**
* Extract dimension from DoFHandlerType.
*/
static const unsigned int dim = DoFHandlerType::dimension;
/**
* Extract space dimension from DoFHandlerType.
*/
static const unsigned int spacedim = DoFHandlerType::space_dimension;
/**
* Data type passed by the iterator class.
*/
typedef DoFHandlerType AccessorData;
/**
* Declare a typedef to the base class to make accessing some of the
* exception classes simpler.
*/
typedef DoFAccessor<DoFHandlerType::dimension,DoFHandlerType, level_dof_access> BaseClass;
/**
* Define the type of the container this is part of.
*/
typedef DoFHandlerType Container;
/**
* A type for an iterator over the faces of a cell. This is what the face()
* function returns.
*/
typedef
TriaIterator<DoFAccessor<DoFHandlerType::dimension-1, DoFHandlerType, level_dof_access> >
face_iterator;
/**
* @name Constructors and initialization
*/
/**
* @{
*/
/**
* Constructor
*/
DoFCellAccessor (const Triangulation<DoFHandlerType::dimension,DoFHandlerType::space_dimension> *tria,
const int level,
const int index,
const AccessorData *local_data);
/**
* Conversion constructor. This constructor exists to make certain
* constructs simpler to write in dimension independent code. For example,
* it allows assigning a face iterator to a line iterator, an operation that
* is useful in 2d but doesn't make any sense in 3d. The constructor here
* exists for the purpose of making the code conform to C++ but it will
* unconditionally abort; in other words, assigning a face iterator to a
* line iterator is better put into an if-statement that checks that the
* dimension is two, and assign to a quad iterator in 3d (an operator that,
* without this constructor would be illegal if we happen to compile for
* 2d).
*/
template <int structdim2, int dim2, int spacedim2>
DoFCellAccessor (const InvalidAccessor<structdim2,dim2,spacedim2> &);
/**
* Another conversion operator between objects that don't make sense, just
* like the previous one.
*/
template <int dim2, class DoFHandlerType2, bool level_dof_access2>
explicit
DoFCellAccessor (const DoFAccessor<dim2, DoFHandlerType2, level_dof_access2> &);
/**
* @}
*/
/**
* Return the parent of this cell as a DoF cell iterator. If the parent does
* not exist (i.e., if the object is at the coarsest level of the mesh
* hierarchy), an exception is generated.
*
* This function is needed since the parent function of the base class
* CellAccessor returns a triangulation cell accessor without access to the
* DoF data.
*/
TriaIterator<DoFCellAccessor<DoFHandlerType, level_dof_access> >
parent () const;
/**
* @name Accessing sub-objects and neighbors
*/
/**
* @{
*/
/**
* Return the @p ith neighbor as a DoF cell iterator. This function is
* needed since the neighbor function of the base class returns a cell
* accessor without access to the DoF data.
*/
TriaIterator<DoFCellAccessor<DoFHandlerType, level_dof_access> >
neighbor (const unsigned int) const;
/**
* Return the @p ith child as a DoF cell iterator. This function is needed
* since the child function of the base class returns a cell accessor
* without access to the DoF data.
*/
TriaIterator<DoFCellAccessor<DoFHandlerType, level_dof_access> >
child (const unsigned int) const;
/**
* Return an iterator to the @p ith face of this cell.
*
* This function is not implemented in 1D, and returns DoFAccessor::line in
* 2D and DoFAccessor::quad in 3d.
*/
face_iterator
face (const unsigned int i) const;
/**
* Return the result of the @p neighbor_child_on_subface function of the
* base class, but convert it so that one can also access the DoF data (the
* function in the base class only returns an iterator with access to the
* triangulation data).
*/
TriaIterator<DoFCellAccessor<DoFHandlerType, level_dof_access> >
neighbor_child_on_subface (const unsigned int face_no,
const unsigned int subface_no) const;
/**
* @}
*/
/**
* @name Extracting values from global vectors
*/
/**
* @{
*/
/**
* Return the values of the given vector restricted to the dofs of this cell
* in the standard ordering: dofs on vertex 0, dofs on vertex 1, etc, dofs
* on line 0, dofs on line 1, etc, dofs on quad 0, etc.
*
* The vector has to have the right size before being passed to this
* function. This function is only callable for active cells.
*
* The input vector may be either a <tt>Vector<float></tt>, Vector<double>,
* or a BlockVector<double>, or a PETSc or Trilinos vector if deal.II is
* compiled to support these libraries. It is in the responsibility of the
* caller to assure that the types of the numbers stored in input and output
* vectors are compatible and with similar accuracy.
*/
template <class InputVector, typename number>
void get_dof_values (const InputVector &values,
Vector<number> &local_values) const;
/**
* Return the values of the given vector restricted to the dofs of this cell
* in the standard ordering: dofs on vertex 0, dofs on vertex 1, etc, dofs
* on line 0, dofs on line 1, etc, dofs on quad 0, etc.
*
* The vector has to have the right size before being passed to this
* function. This function is only callable for active cells.
*
* The input vector may be either a <tt>Vector<float></tt>, Vector<double>,
* or a BlockVector<double>, or a PETSc or Trilinos vector if deal.II is
* compiled to support these libraries. It is in the responsibility of the
* caller to assure that the types of the numbers stored in input and output
* vectors are compatible and with similar accuracy.
*/
template <class InputVector, typename ForwardIterator>
void get_dof_values (const InputVector &values,
ForwardIterator local_values_begin,
ForwardIterator local_values_end) const;
/**
* Return the values of the given vector restricted to the dofs of this cell
* in the standard ordering: dofs on vertex 0, dofs on vertex 1, etc, dofs
* on line 0, dofs on line 1, etc, dofs on quad 0, etc.
*
* The vector has to have the right size before being passed to this
* function. This function is only callable for active cells.
*
* The input vector may be either a <tt>Vector<float></tt>, Vector<double>,
* or a BlockVector<double>, or a PETSc or Trilinos vector if deal.II is
* compiled to support these libraries. It is in the responsibility of the
* caller to assure that the types of the numbers stored in input and output
* vectors are compatible and with similar accuracy. The ConstraintMatrix
* passed as an argument to this function makes sure that constraints are
* correctly distributed when the dof values are calculated.
*/
template <class InputVector, typename ForwardIterator>
void get_dof_values (const ConstraintMatrix &constraints,
const InputVector &values,
ForwardIterator local_values_begin,
ForwardIterator local_values_end) const;
/**
* This function is the counterpart to get_dof_values(): it takes a vector
* of values for the degrees of freedom of the cell pointed to by this
* iterator and writes these values into the global data vector @p values.
* This function is only callable for active cells.
*
* Note that for continuous finite elements, calling this function affects
* the dof values on neighboring cells as well. It may also violate
* continuity requirements for hanging nodes, if neighboring cells are less
* refined than the present one. These requirements are not taken care of
* and must be enforced by the user afterwards.
*
* The vector has to have the right size before being passed to this
* function.
*
* The output vector may be either a Vector<float>, Vector<double>, or a
* BlockVector<double>, or a PETSc vector if deal.II is compiled to support
* these libraries. It is in the responsibility of the caller to assure that
* the types of the numbers stored in input and output vectors are
* compatible and with similar accuracy.
*/
template <class OutputVector, typename number>
void set_dof_values (const Vector<number> &local_values,
OutputVector &values) const;
/**
* Return the interpolation of the given finite element function to the
* present cell. In the simplest case, the cell is a terminal one, i.e., it
* has no children; then, the returned value is the vector of nodal values
* on that cell. You could as well get the desired values through the @p
* get_dof_values function. In the other case, when the cell has children,
* we use the restriction matrices provided by the finite element class to
* compute the interpolation from the children to the present cell.
*
* If the cell is part of a hp::DoFHandler object, cells only have an
* associated finite element space if they are active. However, this
* function is supposed to also provide information on inactive cells with
* children. Consequently, it carries a third argument that can be used in
* the hp context that denotes the finite element space we are supposed to
* interpolate onto. If the cell is active, this function then obtains the
* finite element function from the <code>values</code> vector on this cell
* and interpolates it onto the space described by the
* <code>fe_index</code>th element of the hp::FECollection associated with
* the hp::DoFHandler of which this cell is a part of. If the cell is not
* active, then we first perform this interpolation on all of its terminal
* children and then interpolate this function down to the cell requested
* keeping the function space the same.
*
* It is assumed that both input vectors already have the right size
* beforehand.
*
* @note Unlike the get_dof_values() function, this function is only
* available on cells, rather than on lines, quads, and hexes, since
* interpolation is presently only provided for cells by the finite element
* classes.
*/
template <class InputVector, typename number>
void get_interpolated_dof_values (const InputVector &values,
Vector<number> &interpolated_values,
const unsigned int fe_index
= DoFHandlerType::default_fe_index) const;
/**
* This function is the counterpart to get_interpolated_dof_values(): you
* specify the dof values on a cell and these are interpolated to the
* children of the present cell and set on the terminal cells.
*
* In principle, it works as follows: if the cell pointed to by this object
* is terminal (i.e., has no children), then the dof values are set in the
* global data vector by calling the set_dof_values() function; otherwise,
* the values are prolonged to each of the children and this function is
* called for each of them.
*
* Using the get_interpolated_dof_values() and this function, you can
* compute the interpolation of a finite element function to a coarser grid
* by first getting the interpolated solution on a cell of the coarse grid
* and afterwards redistributing it using this function.
*
* Note that for continuous finite elements, calling this function affects
* the dof values on neighboring cells as well. It may also violate
* continuity requirements for hanging nodes, if neighboring cells are less
* refined than the present one, or if their children are less refined than
* the children of this cell. These requirements are not taken care of and
* must be enforced by the user afterward.
*
* If the cell is part of a hp::DoFHandler object, cells only have an
* associated finite element space if they are active. However, this
* function is supposed to also work on inactive cells with children.
* Consequently, it carries a third argument that can be used in the hp
* context that denotes the finite element space we are supposed to
* interpret the input vector of this function in. If the cell is active,
* this function then interpolates the input vector interpreted as an
* element of the space described by the <code>fe_index</code>th element of
* the hp::FECollection associated with the hp::DoFHandler of which this
* cell is a part of, and interpolates it into the space that is associated
* with this cell. On the other hand, if the cell is not active, then we
* first perform this interpolation from this cell to its children using the
* given <code>fe_index</code> until we end up on an active cell, at which
* point we follow the procedure outlined at the beginning of the paragraph.
*
* It is assumed that both vectors already have the right size beforehand.
* This function relies on the existence of a natural interpolation property
* of finite element spaces of a cell to its children, denoted by the
* prolongation matrices of finite element classes. For some elements, the
* spaces on coarse and fine grids are not nested, in which case the
* interpolation to a child is not the identity; refer to the documentation
* of the respective finite element class for a description of what the
* prolongation matrices represent in this case.
*
* @note Unlike the get_dof_values() function, this function is only
* available on cells, rather than on lines, quads, and hexes, since
* interpolation is presently only provided for cells by the finite element
* classes.
*/
template <class OutputVector, typename number>
void set_dof_values_by_interpolation (const Vector<number> &local_values,
OutputVector &values,
const unsigned int fe_index
= DoFHandlerType::default_fe_index) const;
/**
* Distribute a local (cell based) vector to a global one by mapping the
* local numbering of the degrees of freedom to the global one and entering
* the local values into the global vector.
*
* The elements are <em>added</em> up to the elements in the global vector,
* rather than just set, since this is usually what one wants.
*/
template <typename number, typename OutputVector>
void
distribute_local_to_global (const Vector<number> &local_source,
OutputVector &global_destination) const;
/**
* Distribute a local (cell based) vector in iterator format to a global one
* by mapping the local numbering of the degrees of freedom to the global
* one and entering the local values into the global vector.
*
* The elements are <em>added</em> up to the elements in the global vector,
* rather than just set, since this is usually what one wants.
*/
template <typename ForwardIterator, typename OutputVector>
void
distribute_local_to_global (ForwardIterator local_source_begin,
ForwardIterator local_source_end,
OutputVector &global_destination) const;
/**
* Distribute a local (cell based) vector in iterator format to a global one
* by mapping the local numbering of the degrees of freedom to the global
* one and entering the local values into the global vector.
*
* The elements are <em>added</em> up to the elements in the global vector,
* rather than just set, since this is usually what one wants. Moreover, the
* ConstraintMatrix passed to this function makes sure that also constraints
* are eliminated in this process.
*/
template <typename ForwardIterator, typename OutputVector>
void
distribute_local_to_global (const ConstraintMatrix &constraints,
ForwardIterator local_source_begin,
ForwardIterator local_source_end,
OutputVector &global_destination) const;
/**
* This function does much the same as the
* <tt>distribute_local_to_global(Vector,Vector)</tt> function, but operates
* on matrices instead of vectors. If the matrix type is a sparse matrix
* then it is supposed to have non-zero entry slots where required.
*/
template <typename number, typename OutputMatrix>
void
distribute_local_to_global (const FullMatrix<number> &local_source,
OutputMatrix &global_destination) const;
/**
* This function does what the two <tt>distribute_local_to_global</tt>
* functions with vector and matrix argument do, but all at once.
*/
template <typename number, typename OutputMatrix, typename OutputVector>
void
distribute_local_to_global (const FullMatrix<number> &local_matrix,
const Vector<number> &local_vector,
OutputMatrix &global_matrix,
OutputVector &global_vector) const;
/**
* @}
*/
/**
* @name Accessing the DoF indices of this object
*/
/**
* @{
*/
/**
* Obtain the global indices of the local degrees of freedom on this cell.
*
* If this object accesses a level cell (indicated by the third template
* argument or #is_level_cell), then return the result of
* get_mg_dof_indices(), else return get_dof_indices().
*
* You will get a level_cell_iterator when calling begin_mg() and a normal
* one otherwise.
*
* Examples for this use are in the implementation of DoFRenumbering.
*/
void get_active_or_mg_dof_indices (std::vector<types::global_dof_index> &dof_indices) const;
/**
* Return the <i>global</i> indices of the degrees of freedom located on
* this object in the standard ordering defined by the finite element (i.e.,
* dofs on vertex 0, dofs on vertex 1, etc, dofs on line 0, dofs on line 1,
* etc, dofs on quad 0, etc.) This function is only available on
* <i>active</i> objects (see
* @ref GlossActive "this glossary entry").
*
* @param[out] dof_indices The vector into which the indices will be
* written. It has to have the right size (namely,
* <code>fe.dofs_per_cell</code>, <code>fe.dofs_per_face</code>, or
* <code>fe.dofs_per_line</code>, depending on which kind of object this
* function is called) before being passed to this function.
*
* This function reimplements the same function in the base class. In
* contrast to the function in the base class, we do not need the
* <code>fe_index</code> here because there is always a unique finite
* element index on cells.
*
* This is a function which requires that the cell is active.
*
* Also see get_active_or_mg_dof_indices().
*
* @note In many places in the tutorial and elsewhere in the library, the
* argument to this function is called <code>local_dof_indices</code> by
* convention. The name is not meant to indicate the <i>local</i> numbers of
* degrees of freedom (which are always between zero and
* <code>fe.dofs_per_cell</code>) but instead that the returned values are
* the <i>global</i> indices of those degrees of freedom that are located
* locally on the current cell.
*
* @deprecated Currently, this function can also be called for non-active
* cells, if all degrees of freedom of the FiniteElement are located in
* vertices. This functionality will vanish in a future release.
*/
void get_dof_indices (std::vector<types::global_dof_index> &dof_indices) const;
/**
* @deprecated Use get_active_or_mg_dof_indices() with level_cell_iterator
* returned from begin_mg().
*
* Retrieve the global indices of the degrees of freedom on this cell in the
* level vector associated to the level of the cell.
*/
void get_mg_dof_indices (std::vector<types::global_dof_index> &dof_indices) const;
/**
* @}
*/
/**
* @name Accessing the finite element associated with this object
*/
/**
* @{
*/
/**
* Return the finite element that is used on the cell pointed to by this
* iterator. For non-hp DoF handlers, this is of course always the same
* element, independent of the cell we are presently on, but for hp DoF
* handlers, this may change from cell to cell.
*
* @note Since degrees of freedoms only exist on active cells for
* hp::DoFHandler (i.e., there is currently no implementation of multilevel
* hp::DoFHandler objects), it does not make sense to query the finite
* element on non-active cells since they do not have finite element spaces
* associated with them without having any degrees of freedom. Consequently,
* this function will produce an exception when called on non-active cells.
*/
const FiniteElement<DoFHandlerType::dimension,DoFHandlerType::space_dimension> &
get_fe () const;
/**
* Returns the index inside the hp::FECollection of the FiniteElement used
* for this cell. This function is only useful if the DoF handler object
* associated with the current cell is an hp::DoFHandler.
*
* @note Since degrees of freedoms only exist on active cells for
* hp::DoFHandler (i.e., there is currently no implementation of multilevel
* hp::DoFHandler objects), it does not make sense to query active FE
* indices on non-active cells since they do not have finite element spaces
* associated with them without having any degrees of freedom. Consequently,
* this function will produce an exception when called on non-active cells.
*/
unsigned int active_fe_index () const;
/**
* Sets the index of the FiniteElement used for this cell. This determines
* which element in an hp::FECollection to use. This function is only useful
* if the DoF handler object associated with the current cell is an
* hp::DoFHandler.
*
* @note Since degrees of freedoms only exist on active cells for
* hp::DoFHandler (i.e., there is currently no implementation of multilevel
* hp::DoFHandler objects), it does not make sense to assign active FE
* indices to non-active cells since they do not have finite element spaces
* associated with them without having any degrees of freedom. Consequently,
* this function will produce an exception when called on non-active cells.
*/
void set_active_fe_index (const unsigned int i);
/**
* @}
*/
/**
* Set the DoF indices of this cell to the given values. This function
* bypasses the DoF cache, if one exists for the given DoF handler class.
*/
void set_dof_indices (const std::vector<types::global_dof_index> &dof_indices);
/**
* Set the Level DoF indices of this cell to the given values.
*/
void set_mg_dof_indices (const std::vector<types::global_dof_index> &dof_indices);
/**
* Update the cache in which we store the dof indices of this cell.
*/
void update_cell_dof_indices_cache () const;
private:
/**
* Copy operator. This is normally used in a context like <tt>iterator a,b;
* *a=*b;</tt>. Presumably, the intent here is to copy the object pointed to
* by @p b to the object pointed to by @p a. However, the result of
* dereferencing an iterator is not an object but an accessor; consequently,
* this operation is not useful for iterators on triangulations. We declare
* this function here private, thus it may not be used from outside.
* Furthermore it is not implemented and will give a linker error if used
* anyway.
*/
DoFCellAccessor<DoFHandlerType, level_dof_access> &
operator = (const DoFCellAccessor<DoFHandlerType, level_dof_access> &da);
/**
* Make the DoFHandler class a friend so that it can call the
* update_cell_dof_indices_cache() function
*/
template <int dim, int spacedim> friend class DoFHandler;
friend struct dealii::internal::DoFCellAccessor::Implementation;
};
template <int sd, typename DoFHandlerType, bool level_dof_access>
inline
bool
DoFAccessor<sd, DoFHandlerType, level_dof_access>::is_level_cell()
{
return level_dof_access;
}
DEAL_II_NAMESPACE_CLOSE
// include more templates
#include "dof_accessor.templates.h"
#endif
|