/usr/include/deal.II/dofs/dof_accessor.h is in libdeal.ii-dev 6.3.1-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 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 | //---------------------------------------------------------------------------
// $Id: dof_accessor.h 21058 2010-05-03 22:15:00Z kanschat $
// Version: $Name$
//
// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 by the deal.II authors
//
// This file is subject to QPL and may not be distributed
// without copyright and license information. Please refer
// to the file deal.II/doc/license.html for the text and
// further information on this license.
//
//---------------------------------------------------------------------------
#ifndef __deal2__dof_accessor_h
#define __deal2__dof_accessor_h
#include <base/config.h>
#include <grid/tria_accessor.h>
#include <dofs/dof_handler.h>
#include <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;
namespace internal
{
namespace DoFCellAccessor
{
struct Implementation;
}
namespace DoFHandler
{
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 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, well, 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. From the
* second template argument we can deduce the dimensionality of the
* triangulation to which this object belongs as well as the dimensionality of
* the space in which it is embedded. The second argument also denotes the
* type of DoF handler we should work on. It can either be
* ::DoFHandler or hp::DoFHandler.
*
* Depending on whether the structural dimension of the object
* accessed equals the dimension on which the DoF handler object
* operates, this class is derived from CellAccessor or
* TriaAccessor. This means that, for example accessors to quads
* in 2d have access to all the mesh aspects of cells, whereas
* accessors to quads in 3d can only access things that make sense for
* faces.
*
*
* <h3>Usage</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>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
*/
template <int structdim, class DH>
class DoFAccessor : public internal::DoFAccessor::Inheritance<structdim, DH::dimension, DH::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=DH::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=DH::space_dimension;
/**
* Declare a typedef to the base
* class to make accessing some
* of the exception classes
* simpler.
*/
typedef
typename internal::DoFAccessor::Inheritance<structdim, dimension, space_dimension>::BaseClass
BaseClass;
/**
* Data type passed by the iterator class.
*/
typedef DH AccessorData;
/**
* @name Constructors
*/
/**
* @{
*/
/**
* Default constructor. Provides
* an accessor that can't be
* used.
*/
DoFAccessor ();
/**
* Constructor
*/
DoFAccessor (const Triangulation<DH::dimension,DH::space_dimension> *tria,
const int level,
const int index,
const DH *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 DH2>
DoFAccessor (const DoFAccessor<dim2, DH2> &);
/**
* @}
*/
/**
* Return a handle on the
* DoFHandler object which we
* are using.
*/
const DH &
get_dof_handler () const;
/**
* Copy operator.
*/
DoFAccessor<structdim,DH> &
operator = (const DoFAccessor<structdim,DH> &da);
/**
* Implement the copy operator needed
* for the iterator classes.
*/
void copy_from (const DoFAccessor<structdim, DH> &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, DH::dimension, DH::space_dimension> &da);
/**
* @name Accessing sub-objects
*/
/**
* @{
*/
/**
* Return an iterator pointing to
* the the @p c-th child.
*/
TriaIterator<DoFAccessor<structdim,DH> >
child (const unsigned int c) const;
/**
* Pointer to the @p ith line
* bounding this object.
*/
typename internal::DoFHandler::Iterators<DH>::line_iterator
line (const unsigned int i) const;
/**
* Pointer to the @p ith quad
* bounding this object.
*/
typename internal::DoFHandler::Iterators<DH>::quad_iterator
quad (const unsigned int i) const;
/**
* @}
*/
/**
* @name Accessing the DoF indices of this object
*/
/**
* @{
*/
/**
* Return the indices of the dofs of this
* object 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 most often
* used on active objects (edges,
* faces, cells). It can be used
* on non-active objects as well
* (i.e. objects that have
* children), but only if the
* finite element under
* consideration has degrees of
* freedom exclusively on
* vertices. Otherwise, the
* function doesn't make much
* sense, since for example
* inactive edges do not have
* degrees of freedom associated
* with them at all.
*
* 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<unsigned int> &dof_indices,
const unsigned int fe_index = DH::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().
*/
unsigned int vertex_dof_index (const unsigned int vertex,
const unsigned int i,
const unsigned int fe_index = DH::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().
*/
unsigned int dof_index (const unsigned int i,
const unsigned int fe_index = DH::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<DH::dimension,DH::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 active,
* but is refined. @ref GlossActive
*
* @ingroup Exceptions
*/
DeclException0 (ExcNotActive);
/**
* Exception
*
* @ingroup Exceptions
*/
DeclException0 (ExcCantCompareIterators);
protected:
/**
* Store the address of the DoFHandler object
* to be accessed.
*/
DH *dof_handler;
/**
* Compare for equality.
*/
bool operator == (const DoFAccessor &) const;
/**
* Compare for inequality.
*/
bool operator != (const DoFAccessor &) const;
/**
* Reset the DoF handler pointer.
*/
void set_dof_handler (DH *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 unsigned int index,
const unsigned int fe_index = DH::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 unsigned int index,
const unsigned int fe_index = DH::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 dim, int spacedim> friend class DoFHandler;
template <int dim, int spacedim> friend class hp::DoFHandler;
friend class internal::DoFHandler::Implementation;
friend class internal::hp::DoFHandler::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
*/
template <class DH>
class DoFCellAccessor : public DoFAccessor<DH::dimension,DH>
{
public:
/**
* Extract dimension from DH.
*/
static const unsigned int dim = DH::dimension;
/**
* Extract space dimension from DH.
*/
static const unsigned int spacedim = DH::space_dimension;
/**
* Declare the data type that
* this accessor class expects to
* get passed from the iterator
* classes.
*/
typedef typename DoFAccessor<DH::dimension,DH>::AccessorData AccessorData;
/**
* Declare a typedef to the base
* class to make accessing some
* of the exception classes
* simpler.
*/
typedef DoFAccessor<DH::dimension,DH> BaseClass;
/**
* Define the type of the
* container this is part of.
*/
typedef DH Container;
/**
* @name Constructors
*/
/**
* @{
*/
/**
* Constructor
*/
DoFCellAccessor (const Triangulation<DH::dimension,DH::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 DH2>
DoFCellAccessor (const DoFAccessor<dim2, DH2> &);
/**
* @}
*/
/**
* @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.
*/
typename internal::DoFHandler::Iterators<DH>::cell_iterator
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.
*/
typename internal::DoFHandler::Iterators<DH>::cell_iterator
child (const unsigned int) const;
/**
* Return an iterator to the @p ith face
* of this cell.
*
* This function is not implemented in
* 1D, and maps to DoFAccessor<2,
* dim>::line in 2D.
*/
typename internal::DoFHandler::Iterators<DH>::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).
*/
typename internal::DoFHandler::Iterators<DH>::cell_iterator
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. has no children; then,
* the returned value is the
* vector of nodal values on that
* cell. You could then 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.
*
* It is assumed that both
* vectors already have the right
* size beforehand.
*
* Unlike the get_dof_values()
* function, this function works
* on cells rather than to 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;
/**
* This, again, 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,
* 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
* afterwards.
*
* 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.
*
* Unlike the set_dof_values()
* function, this function is
* associated to cells rather
* than to lines, quads, and
* hexes, since interpolation is
* presently only provided for
* cells by the finite element
* objects.
*
* 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_by_interpolation (const Vector<number> &local_values,
OutputVector &values) 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
*/
/**
* @{
*/
/**
* Return the indices of the dofs of this
* quad 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.
*
* It is assumed that the vector already
* has the right size beforehand.
*
* This function reimplements the
* same function in the base
* class. The functions in the
* base classes are available for
* all geometric objects,
* i.e. even in 3d they can be
* used to access the dof indices
* of edges, for example. On the
* other hand, the most common
* case is clearly the use on
* cells, which is why we cache
* the array for each cell, but
* not edge. To retrieve the
* cached values, rather than
* collect the necessary
* information every time, this
* function overwrites the one in
* the base class.
*
* This function is most often
* used on active objects (edges,
* faces, cells). It can be used
* on non-active objects as well
* (i.e. objects that have
* children), but only if the
* finite element under
* consideration has degrees of
* freedom exclusively on
* vertices. Otherwise, the
* function doesn't make much
* sense, since for example
* inactive edges do not have
* degrees of freedom associated
* with them at all.
*/
void get_dof_indices (std::vector<unsigned int> &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.
*/
const FiniteElement<DH::dimension,DH::space_dimension> &
get_fe () const;
/**
* Returns the index inside the
* hp::FECollection of the FiniteElement
* used for this cell.
*/
unsigned int active_fe_index () const;
/**
* Sets the index of the FiniteElement used for
* this cell.
*/
void set_active_fe_index (const unsigned int i);
/**
* @}
*/
private:
/**
* Update the cache in which we
* store the dof indices of this
* cell.
*/
void update_cell_dof_indices_cache () const;
/**
* 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 class internal::DoFCellAccessor::Implementation;
};
DEAL_II_NAMESPACE_CLOSE
// include more templates
#include "dof_accessor.templates.h"
/*---------------------------- dof_iterator.h ---------------------------*/
#endif
/*---------------------------- dof_iterator.h ---------------------------*/
|