/usr/include/deal.II/lac/block_sparsity_pattern.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 | //---------------------------------------------------------------------------
// $Id: block_sparsity_pattern.h 21358 2010-06-24 23:38:14Z bangerth $
// Version: $Name$
//
// Copyright (C) 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__block_sparsity_pattern_h
#define __deal2__block_sparsity_pattern_h
#include <base/config.h>
#include <base/exceptions.h>
#include <base/table.h>
#include <base/subscriptor.h>
#include <base/smartpointer.h>
#include <lac/sparsity_pattern.h>
#include <lac/trilinos_sparsity_pattern.h>
#include <lac/compressed_sparsity_pattern.h>
#include <lac/compressed_set_sparsity_pattern.h>
#include <lac/compressed_simple_sparsity_pattern.h>
#include <lac/block_indices.h>
DEAL_II_NAMESPACE_OPEN
template <typename number> class BlockSparseMatrix;
class BlockSparsityPattern;
class BlockCompressedSparsityPattern;
class BlockCompressedSimpleSparsityPattern;
class BlockCompressedSetSparsityPattern;
#ifdef DEAL_II_USE_TRILINOS
namespace TrilinosWrappers
{
class BlockSparsityPattern;
}
#endif
/*! @addtogroup Sparsity
*@{
*/
/**
* This is the base class for block versions of the sparsity pattern and
* compressed sparsity pattern classes. It has not much functionality, but
* only administrates an array of sparsity pattern objects and delegates work
* to them. It has mostly the same interface as has the SparsityPattern,
* CompressedSparsityPattern, and CompressedSetSparsityPattern classes, and
* simply transforms calls to its member functions to calls to the respective
* member functions of the member sparsity patterns.
*
* The largest difference between the SparsityPattern and
* CompressedSparsityPattern classes and this class is that
* mostly, the matrices have different properties and you will want to
* work on the blocks making up the matrix rather than the whole
* matrix. You can access the different blocks using the
* <tt>block(row,col)</tt> function.
*
* Attention: this object is not automatically notified if the size of
* one of its subobjects' size is changed. After you initialize the
* sizes of the subobjects, you will therefore have to call the
* <tt>collect_sizes()</tt> function of this class! Note that, of course, all
* sub-matrices in a (block-)row have to have the same number of rows, and
* that all sub-matrices in a (block-)column have to have the same number of
* columns.
*
* You will in general not want to use this class, but one of the
* derived classes.
*
* @see @ref GlossBlockLA "Block (linear algebra)"
* @author Wolfgang Bangerth, 2000, 2001
*/
template <class SparsityPatternBase>
class BlockSparsityPatternBase : public Subscriptor
{
public:
/**
* Define a value which is used
* to indicate that a certain
* value in the @p colnums array
* is unused, i.e. does not
* represent a certain column
* number index.
*
* This value is only an alias to
* the respective value of the
* SparsityPattern class.
*/
static const unsigned int invalid_entry = SparsityPattern::invalid_entry;
/**
* Initialize the matrix empty,
* that is with no memory
* allocated. This is useful if
* you want such objects as
* member variables in other
* classes. You can make the
* structure usable by calling
* the reinit() function.
*/
BlockSparsityPatternBase ();
/**
* Initialize the matrix with the
* given number of block rows and
* columns. The blocks themselves
* are still empty, and you have
* to call collect_sizes() after
* you assign them sizes.
*/
BlockSparsityPatternBase (const unsigned int n_block_rows,
const unsigned int n_block_columns);
/**
* Copy constructor. This
* constructor is only allowed to
* be called if the sparsity pattern to be
* copied is empty, i.e. there
* are no block allocated at
* present. This is for the same
* reason as for the
* SparsityPattern, see there
* for the details.
*/
BlockSparsityPatternBase (const BlockSparsityPatternBase &bsp);
/**
* Destructor.
*/
~BlockSparsityPatternBase ();
/**
* Resize the matrix, by setting
* the number of block rows and
* columns. This deletes all
* blocks and replaces them by
* unitialized ones, i.e. ones
* for which also the sizes are
* not yet set. You have to do
* that by calling the reinit()
* functions of the blocks
* themselves. Do not forget to
* call collect_sizes() after
* that on this object.
*
* The reason that you have to
* set sizes of the blocks
* yourself is that the sizes may
* be varying, the maximum number
* of elements per row may be
* varying, etc. It is simpler
* not to reproduce the interface
* of the SparsityPattern
* class here but rather let the
* user call whatever function
* she desires.
*/
void reinit (const unsigned int n_block_rows,
const unsigned int n_block_columns);
/**
* Copy operator. For this the
* same holds as for the copy
* constructor: it is declared,
* defined and fine to be called,
* but the latter only for empty
* objects.
*/
BlockSparsityPatternBase & operator = (const BlockSparsityPatternBase &);
/**
* This function collects the
* sizes of the sub-objects and
* stores them in internal
* arrays, in order to be able to
* relay global indices into the
* matrix to indices into the
* subobjects. You *must* call
* this function each time after
* you have changed the size of
* the sub-objects.
*/
void collect_sizes ();
/**
* Access the block with the
* given coordinates.
*/
SparsityPatternBase &
block (const unsigned int row,
const unsigned int column);
/**
* Access the block with the
* given coordinates. Version for
* constant objects.
*/
const SparsityPatternBase &
block (const unsigned int row,
const unsigned int column) const;
/**
* Grant access to the object
* describing the distribution of
* row indices to the individual
* blocks.
*/
const BlockIndices &
get_row_indices () const;
/**
* Grant access to the object
* describing the distribution of
* column indices to the individual
* blocks.
*/
const BlockIndices &
get_column_indices () const;
/**
* This function compresses the
* sparsity structures that this
* object represents. It simply
* calls @p compress for all
* sub-objects.
*/
void compress ();
/**
* Return the number of blocks in a
* column.
*/
unsigned int n_block_rows () const;
/**
* Return the number of blocks in a
* row.
*/
unsigned int n_block_cols () const;
/**
* Return whether the object is
* empty. It is empty if no
* memory is allocated, which is
* the same as that both
* dimensions are zero. This
* function is just the
* concatenation of the
* respective call to all
* sub-matrices.
*/
bool empty () const;
/**
* Return the maximum number of
* entries per row. It returns
* the maximal number of entries
* per row accumulated over all
* blocks in a row, and the
* maximum over all rows.
*/
unsigned int max_entries_per_row () const;
/**
* Add a nonzero entry to the matrix.
* This function may only be called
* for non-compressed sparsity patterns.
*
* If the entry already exists, nothing
* bad happens.
*
* This function simply finds out
* to which block <tt>(i,j)</tt> belongs
* and then relays to that block.
*/
void add (const unsigned int i, const unsigned int j);
/**
* Add several nonzero entries to the
* specified matrix row. This function
* may only be called for
* non-compressed sparsity patterns.
*
* If some of the entries already
* exist, nothing bad happens.
*
* This function simply finds out to
* which blocks <tt>(row,col)</tt> for
* <tt>col</tt> in the iterator range
* belong and then relays to those
* blocks.
*/
template <typename ForwardIterator>
void add_entries (const unsigned int row,
ForwardIterator begin,
ForwardIterator end,
const bool indices_are_sorted = false);
/**
* Return number of rows of this
* matrix, which equals the
* dimension of the image
* space. It is the sum of rows
* of the (block-)rows of
* sub-matrices.
*/
unsigned int n_rows () const;
/**
* Return number of columns of
* this matrix, which equals the
* dimension of the range
* space. It is the sum of
* columns of the (block-)columns
* of sub-matrices.
*/
unsigned int n_cols () const;
/**
* Check if a value at a certain
* position may be non-zero.
*/
bool exists (const unsigned int i, const unsigned int j) const;
/**
* Number of entries in a
* specific row, added up over
* all the blocks that form this
* row.
*/
unsigned int row_length (const unsigned int row) const;
/**
* Return the number of nonzero
* elements of this
* matrix. Actually, it returns
* the number of entries in the
* sparsity pattern; if any of
* the entries should happen to
* be zero, it is counted anyway.
*
* This function may only be
* called if the matrix struct is
* compressed. It does not make
* too much sense otherwise
* anyway.
*
* In the present context, it is
* the sum of the values as
* returned by the sub-objects.
*/
unsigned int n_nonzero_elements () const;
/**
* Print the sparsity of the
* matrix. The output consists of
* one line per row of the format
* <tt>[i,j1,j2,j3,...]</tt>. <i>i</i>
* is the row number and
* <i>jn</i> are the allocated
* columns in this row.
*/
void print (std::ostream &out) const;
/**
* Print the sparsity of the matrix
* in a format that <tt>gnuplot</tt> understands
* and which can be used to plot the
* sparsity pattern in a graphical
* way. This is the same functionality
* implemented for usual sparsity
* patterns, see @ref SparsityPattern.
*/
void print_gnuplot (std::ostream &out) const;
/** @addtogroup Exceptions
* @{ */
/**
* Exception
*/
DeclException4 (ExcIncompatibleRowNumbers,
int, int, int, int,
<< "The blocks [" << arg1 << ',' << arg2 << "] and ["
<< arg3 << ',' << arg4 << "] have differing row numbers.");
/**
* Exception
*/
DeclException4 (ExcIncompatibleColNumbers,
int, int, int, int,
<< "The blocks [" << arg1 << ',' << arg2 << "] and ["
<< arg3 << ',' << arg4 << "] have differing column numbers.");
/**
* Exception
*/
DeclException2 (ExcIncompatibleSizes,
int, int,
<< "The number of blocks " << arg1 << " and " << arg2
<< " are different.");
/**
* Exception
*/
DeclException0 (ExcInvalidConstructorCall);
//@}
protected:
/**
* Number of block rows.
*/
unsigned int rows;
/**
* Number of block columns.
*/
unsigned int columns;
/**
* Array of sparsity patterns.
*/
Table<2,SmartPointer<SparsityPatternBase, BlockSparsityPatternBase<SparsityPatternBase> > > sub_objects;
/**
* Object storing and managing
* the transformation of row
* indices to indices of the
* sub-objects.
*/
BlockIndices row_indices;
/**
* Object storing and managing
* the transformation of column
* indices to indices of the
* sub-objects.
*/
BlockIndices column_indices;
private:
/**
* Temporary vector for counting the
* elements written into the
* individual blocks when doing a
* collective add or set.
*/
std::vector<unsigned int> counter_within_block;
/**
* Temporary vector for column
* indices on each block when writing
* local to global data on each
* sparse matrix.
*/
std::vector<std::vector<unsigned int> > block_column_indices;
/**
* Make the block sparse matrix a
* friend, so that it can use our
* #row_indices and
* #column_indices objects.
*/
template <typename number>
friend class BlockSparseMatrix;
};
/**
* This class extends the base class to implement an array of sparsity
* patterns that can be used by block sparse matrix objects. It only
* adds a few additional member functions, but the main interface
* stems from the base class, see there for more information.
*
* This class is an example of the "static" type of @ref Sparsity.
*
* @author Wolfgang Bangerth, 2000, 2001
*/
class BlockSparsityPattern : public BlockSparsityPatternBase<SparsityPattern>
{
public:
/**
* Initialize the matrix empty,
* that is with no memory
* allocated. This is useful if
* you want such objects as
* member variables in other
* classes. You can make the
* structure usable by calling
* the reinit() function.
*/
BlockSparsityPattern ();
/**
* Initialize the matrix with the
* given number of block rows and
* columns. The blocks themselves
* are still empty, and you have
* to call collect_sizes() after
* you assign them sizes.
*/
BlockSparsityPattern (const unsigned int n_rows,
const unsigned int n_columns);
/**
* Forwarding to
* BlockSparsityPatternBase::reinit().
*/
void reinit (const unsigned int n_block_rows,
const unsigned int n_block_columns);
/**
* Initialize the pattern with
* two BlockIndices for the block
* structures of matrix rows and
* columns as well as a row
* length vector in the format
* produced by DoFTools.
*/
void reinit (const BlockIndices& row_indices,
const BlockIndices& col_indices,
const std::vector<std::vector<unsigned int> >& row_lengths);
/**
* Return whether the structure
* is compressed or not,
* i.e. whether all sub-matrices
* are compressed.
*/
bool is_compressed () const;
/**
* Determine an estimate for the
* memory consumption (in bytes)
* of this object.
*/
unsigned int memory_consumption () const;
/**
* Copy data from an object of
* type
* BlockCompressedSparsityPattern,
* i.e. resize this object to the
* size of the given argument,
* and copy over the contents of
* each of the
* subobjects. Previous content
* of this object is lost.
*/
void copy_from (const BlockCompressedSparsityPattern &csp);
/**
* Copy data from an object of
* type
* BlockCompressedSetSparsityPattern,
* i.e. resize this object to the
* size of the given argument,
* and copy over the contents of
* each of the
* subobjects. Previous content
* of this object is lost.
*/
void copy_from (const BlockCompressedSetSparsityPattern &csp);
/**
* Copy data from an object of
* type
* BlockCompressedSimpleSparsityPattern,
* i.e. resize this object to the
* size of the given argument,
* and copy over the contents of
* each of the
* subobjects. Previous content
* of this object is lost.
*/
void copy_from (const BlockCompressedSimpleSparsityPattern &csp);
};
/**
* This class extends the base class to implement an array of compressed
* sparsity patterns that can be used to initialize objects of type
* BlockSparsityPattern. It does not add additional member functions, but
* rather acts as a @p typedef to introduce the name of this class, without
* requiring the user to specify the templated name of the base class. For
* information on the interface of this class refer to the base class. The
* individual blocks are based on the CompressedSparsityPattern class.
*
* This class is an example of the "dynamic" type of @ref Sparsity.
*
* <b>Note:</b>
* There are several, exchangeable variations of this class, see @ref Sparsity,
* section 'Dynamic block sparsity patterns' for more information.
*
* <b>Note:</b> This class used to be called
* CompressedBlockSparsityPattern. However, since it's a block wrapper around
* the CompressedSparsityPattern class, this is a misnomer and the class has
* been renamed.
*
* <h3>Example</h3>
*
* Usage of this class is very similar to CompressedSparsityPattern,
* but since the use of block indices causes some additional
* complications, we give a short example.
*
* @dontinclude compressed_block_sparsity_pattern.cc
*
* After the the DoFHandler <tt>dof</tt> and the ConstraintMatrix
* <tt>constraints</tt> have been set up with a system element, we
* must count the degrees of freedom in each matrix block:
*
* @skipline dofs_per_block
* @until count
*
* Now, we are ready to set up the BlockCompressedSparsityPattern.
*
* @until collect
*
* It is filled as if it were a normal pattern
*
* @until condense
*
* In the end, it is copied to a normal BlockSparsityPattern for later
* use.
*
* @until copy
*
* @author Wolfgang Bangerth, 2000, 2001, Guido Kanschat, 2006, 2007
*/
class BlockCompressedSparsityPattern : public BlockSparsityPatternBase<CompressedSparsityPattern>
{
public:
/**
* Initialize the matrix empty,
* that is with no memory
* allocated. This is useful if
* you want such objects as
* member variables in other
* classes. You can make the
* structure usable by calling
* the reinit() function.
*/
BlockCompressedSparsityPattern ();
/**
* Initialize the matrix with the
* given number of block rows and
* columns. The blocks themselves
* are still empty, and you have
* to call collect_sizes() after
* you assign them sizes.
*/
BlockCompressedSparsityPattern (const unsigned int n_rows,
const unsigned int n_columns);
/**
* Initialize the pattern with
* two BlockIndices for the block
* structures of matrix rows and
* columns. This function is
* equivalent to calling the
* previous constructor with the
* length of the two index vector
* and then entering the index
* values.
*/
BlockCompressedSparsityPattern (const std::vector<unsigned int>& row_block_sizes,
const std::vector<unsigned int>& col_block_sizes);
/**
* Initialize the pattern with
* two BlockIndices for the block
* structures of matrix rows and
* columns.
*/
BlockCompressedSparsityPattern (const BlockIndices& row_indices,
const BlockIndices& col_indices);
/**
* Resize the matrix to a tensor
* product of matrices with
* dimensions defined by the
* arguments.
*
* The matrix will have as many
* block rows and columns as
* there are entries in the two
* arguments. The block at
* position (<i>i,j</i>) will
* have the dimensions
* <tt>row_block_sizes[i]</tt>
* times <tt>col_block_sizes[j]</tt>.
*/
void reinit (const std::vector< unsigned int > &row_block_sizes,
const std::vector< unsigned int > &col_block_sizes);
/**
* Resize the matrix to a tensor
* product of matrices with
* dimensions defined by the
* arguments. The two
* BlockIndices objects must be
* initialized and the sparsity
* pattern will have the
* same block structure afterwards.
*/
void reinit (const BlockIndices& row_indices, const BlockIndices& col_indices);
/**
* Allow the use of the reinit
* functions of the base class as
* well.
*/
using BlockSparsityPatternBase<CompressedSparsityPattern>::reinit;
};
/**
* A typdef to preserve the old name CompressedBlockSparsityPattern even after
* we changed the naming of the class to BlockCompressedSparsityPattern. The
* old name is now deprecated and user codes should use the name
* BlockCompressedSparsityPattern instead.
*
* @deprecated
*/
typedef BlockCompressedSparsityPattern CompressedBlockSparsityPattern;
/**
* This class extends the base class to implement an array of compressed
* sparsity patterns that can be used to initialize objects of type
* BlockSparsityPattern. It is used in the same way as the
* BlockCompressedSparsityPattern except that it builds upon the
* CompressedSetSparsityPattern instead of the CompressedSparsityPattern. See
* the documentation of the BlockCompressedSparsityPattern for examples.
*
* This class is an example of the "dynamic" type of @ref Sparsity.
*
* <b>Note:</b>
* There are several, exchangeable variations of this class, see @ref Sparsity,
* section 'Dynamic block sparsity patterns' for more information.
*
* @author Wolfgang Bangerth, 2007
*/
class BlockCompressedSetSparsityPattern : public BlockSparsityPatternBase<CompressedSetSparsityPattern>
{
public:
/**
* Initialize the matrix empty,
* that is with no memory
* allocated. This is useful if
* you want such objects as
* member variables in other
* classes. You can make the
* structure usable by calling
* the reinit() function.
*/
BlockCompressedSetSparsityPattern ();
/**
* Initialize the matrix with the
* given number of block rows and
* columns. The blocks themselves
* are still empty, and you have
* to call collect_sizes() after
* you assign them sizes.
*/
BlockCompressedSetSparsityPattern (const unsigned int n_rows,
const unsigned int n_columns);
/**
* Initialize the pattern with
* two BlockIndices for the block
* structures of matrix rows and
* columns. This function is
* equivalent to calling the
* previous constructor with the
* length of the two index vector
* and then entering the index
* values.
*/
BlockCompressedSetSparsityPattern (const std::vector<unsigned int>& row_block_sizes,
const std::vector<unsigned int>& col_block_sizes);
/**
* Initialize the pattern with
* two BlockIndices for the block
* structures of matrix rows and
* columns.
*/
BlockCompressedSetSparsityPattern (const BlockIndices& row_indices,
const BlockIndices& col_indices);
/**
* Resize the matrix to a tensor
* product of matrices with
* dimensions defined by the
* arguments.
*
* The matrix will have as many
* block rows and columns as
* there are entries in the two
* arguments. The block at
* position (<i>i,j</i>) will
* have the dimensions
* <tt>row_block_sizes[i]</tt>
* times <tt>col_block_sizes[j]</tt>.
*/
void reinit (const std::vector< unsigned int > &row_block_sizes,
const std::vector< unsigned int > &col_block_sizes);
/**
* Resize the matrix to a tensor
* product of matrices with
* dimensions defined by the
* arguments. The two
* BlockIndices objects must be
* initialized and the sparsity
* pattern will have the
* same block structure afterwards.
*/
void reinit (const BlockIndices& row_indices, const BlockIndices& col_indices);
/**
* Allow the use of the reinit
* functions of the base class as
* well.
*/
using BlockSparsityPatternBase<CompressedSetSparsityPattern>::reinit;
};
/**
* This class extends the base class to implement an array of compressed
* sparsity patterns that can be used to initialize objects of type
* BlockSparsityPattern. It is used in the same way as the
* BlockCompressedSparsityPattern except that it builds upon the
* CompressedSimpleSparsityPattern instead of the CompressedSparsityPattern. See
* the documentation of the BlockCompressedSparsityPattern for examples.
*
* This class is an example of the "dynamic" type of @ref Sparsity.
*
* <b>Note:</b>
* There are several, exchangeable variations of this class, see @ref Sparsity,
* section 'Dynamic block sparsity patterns' for more information.
*
* This class is used in step-22 and step-31.
*
* @author Timo Heister, 2008
*/
class BlockCompressedSimpleSparsityPattern : public BlockSparsityPatternBase<CompressedSimpleSparsityPattern>
{
public:
/**
* Initialize the matrix empty,
* that is with no memory
* allocated. This is useful if
* you want such objects as
* member variables in other
* classes. You can make the
* structure usable by calling
* the reinit() function.
*/
BlockCompressedSimpleSparsityPattern ();
/**
* Initialize the matrix with the
* given number of block rows and
* columns. The blocks themselves
* are still empty, and you have
* to call collect_sizes() after
* you assign them sizes.
*/
BlockCompressedSimpleSparsityPattern (const unsigned int n_rows,
const unsigned int n_columns);
/**
* Initialize the pattern with
* two BlockIndices for the block
* structures of matrix rows and
* columns. This function is
* equivalent to calling the
* previous constructor with the
* length of the two index vector
* and then entering the index
* values.
*/
BlockCompressedSimpleSparsityPattern (const std::vector<unsigned int>& row_block_sizes,
const std::vector<unsigned int>& col_block_sizes);
/**
* Resize the matrix to a tensor
* product of matrices with
* dimensions defined by the
* arguments.
*
* The matrix will have as many
* block rows and columns as
* there are entries in the two
* arguments. The block at
* position (<i>i,j</i>) will
* have the dimensions
* <tt>row_block_sizes[i]</tt>
* times <tt>col_block_sizes[j]</tt>.
*/
void reinit (const std::vector< unsigned int > &row_block_sizes,
const std::vector< unsigned int > &col_block_sizes);
/**
* Allow the use of the reinit
* functions of the base class as
* well.
*/
using BlockSparsityPatternBase<CompressedSimpleSparsityPattern>::reinit;
};
#ifdef DEAL_II_USE_TRILINOS
/**
* This class extends the base class to implement an array of Trilinos
* sparsity patterns that can be used to initialize Trilinos block sparse
* matrices that can be distributed among different processors. It is used
* in the same way as the BlockSparsityPattern except that it builds upon
* the TrilinosWrappers::SparsityPattern instead of the
* dealii::SparsityPattern. See the documentation of the
* BlockSparsityPattern for examples.
*
* This class is has properties of the "dynamic" type of @ref Sparsity (in
* the sense that it can extend the memory if too little elements were
* allocated), but otherwise is more like the basic deal.II SparsityPattern
* (in the sense that the method compress() needs to be called before the
* pattern can be used).
*
* @author Martin Kronbichler, 2008, 2009
*/
namespace TrilinosWrappers
{
class BlockSparsityPattern :
public dealii::BlockSparsityPatternBase<SparsityPattern>
{
public:
/**
* Initialize the matrix empty,
* that is with no memory
* allocated. This is useful if
* you want such objects as
* member variables in other
* classes. You can make the
* structure usable by calling
* the reinit() function.
*/
BlockSparsityPattern ();
/**
* Initialize the matrix with the
* given number of block rows and
* columns. The blocks themselves
* are still empty, and you have
* to call collect_sizes() after
* you assign them sizes.
*/
BlockSparsityPattern (const unsigned int n_rows,
const unsigned int n_columns);
/**
* Initialize the pattern with
* two BlockIndices for the block
* structures of matrix rows and
* columns. This function is
* equivalent to calling the
* previous constructor with the
* length of the two index vector
* and then entering the index
* values.
*/
BlockSparsityPattern (const std::vector<unsigned int>& row_block_sizes,
const std::vector<unsigned int>& col_block_sizes);
/**
* Initialize the pattern with an array
* Epetra_Map that specifies both rows
* and columns of the matrix (so the
* final matrix will be a square
* matrix), where the Epetra_Map
* specifies the parallel distribution
* of the degrees of freedom on the
* individual block. This function is
* equivalent to calling the second
* constructor with the length of the
* mapping vector and then entering the
* index values.
*/
BlockSparsityPattern (const std::vector<Epetra_Map>& parallel_partitioning);
/**
* Initialize the pattern with an array
* of index sets that specifies both
* rows and columns of the matrix (so
* the final matrix will be a square
* matrix), where the IndexSet
* specifies the parallel distribution
* of the degrees of freedom on the
* individual block. This function is
* equivalent to calling the second
* constructor with the length of the
* mapping vector and then entering the
* index values.
*/
BlockSparsityPattern (const std::vector<IndexSet>& parallel_partitioning,
const MPI_Comm &communicator = MPI_COMM_WORLD);
/**
* Resize the matrix to a tensor
* product of matrices with
* dimensions defined by the
* arguments.
*
* The matrix will have as many
* block rows and columns as
* there are entries in the two
* arguments. The block at
* position (<i>i,j</i>) will
* have the dimensions
* <tt>row_block_sizes[i]</tt>
* times <tt>col_block_sizes[j]</tt>.
*/
void reinit (const std::vector< unsigned int > &row_block_sizes,
const std::vector< unsigned int > &col_block_sizes);
/**
* Resize the matrix to a square tensor
* product of matrices with parallel
* distribution according to the
* specifications in the array of
* Epetra_Maps.
*/
void reinit (const std::vector<Epetra_Map>& parallel_partitioning);
/**
* Resize the matrix to a square tensor
* product of matrices with parallel
* distribution according to the
* specifications in the array of
* Epetra_Maps.
*/
void reinit (const std::vector<IndexSet>& parallel_partitioning,
const MPI_Comm & communicator = MPI_COMM_WORLD);
/**
* Allow the use of the reinit
* functions of the base class as
* well.
*/
using BlockSparsityPatternBase<SparsityPattern>::reinit;
};
}
#endif
/*@}*/
/*---------------------- Template functions -----------------------------------*/
template <class SparsityPatternBase>
inline
SparsityPatternBase &
BlockSparsityPatternBase<SparsityPatternBase>::block (const unsigned int row,
const unsigned int column)
{
Assert (row<rows, ExcIndexRange(row,0,rows));
Assert (column<columns, ExcIndexRange(column,0,columns));
return *sub_objects[row][column];
}
template <class SparsityPatternBase>
inline
const SparsityPatternBase &
BlockSparsityPatternBase<SparsityPatternBase>::block (const unsigned int row,
const unsigned int column) const
{
Assert (row<rows, ExcIndexRange(row,0,rows));
Assert (column<columns, ExcIndexRange(column,0,columns));
return *sub_objects[row][column];
}
template <class SparsityPatternBase>
inline
const BlockIndices &
BlockSparsityPatternBase<SparsityPatternBase>::get_row_indices () const
{
return row_indices;
}
template <class SparsityPatternBase>
inline
const BlockIndices &
BlockSparsityPatternBase<SparsityPatternBase>::get_column_indices () const
{
return column_indices;
}
template <class SparsityPatternBase>
inline
void
BlockSparsityPatternBase<SparsityPatternBase>::add (const unsigned int i,
const unsigned int j)
{
// if you get an error here, are
// you sure you called
// <tt>collect_sizes()</tt> before?
const std::pair<unsigned int,unsigned int>
row_index = row_indices.global_to_local (i),
col_index = column_indices.global_to_local (j);
sub_objects[row_index.first][col_index.first]->add (row_index.second,
col_index.second);
}
template <class SparsityPatternBase>
template <typename ForwardIterator>
void
BlockSparsityPatternBase<SparsityPatternBase>::add_entries (const unsigned int row,
ForwardIterator begin,
ForwardIterator end,
const bool indices_are_sorted)
{
// Resize scratch arrays
if (block_column_indices.size() < this->n_block_cols())
{
block_column_indices.resize (this->n_block_cols());
counter_within_block.resize (this->n_block_cols());
}
const unsigned int n_cols = static_cast<unsigned int>(end - begin);
// Resize sub-arrays to n_cols. This
// is a bit wasteful, but we resize
// only a few times (then the maximum
// row length won't increase that
// much any more). At least we know
// that all arrays are going to be of
// the same size, so we can check
// whether the size of one is large
// enough before actually going
// through all of them.
if (block_column_indices[0].size() < n_cols)
for (unsigned int i=0; i<this->n_block_cols(); ++i)
block_column_indices[i].resize(n_cols);
// Reset the number of added elements
// in each block to zero.
for (unsigned int i=0; i<this->n_block_cols(); ++i)
counter_within_block[i] = 0;
// Go through the column indices to
// find out which portions of the
// values should be set in which
// block of the matrix. We need to
// touch all the data, since we can't
// be sure that the data of one block
// is stored contiguously (in fact,
// indices will be intermixed when it
// comes from an element matrix).
for (ForwardIterator it = begin; it != end; ++it)
{
const unsigned int col = *it;
const std::pair<unsigned int, unsigned int>
col_index = this->column_indices.global_to_local(col);
const unsigned int local_index = counter_within_block[col_index.first]++;
block_column_indices[col_index.first][local_index] = col_index.second;
}
#ifdef DEBUG
// If in debug mode, do a check whether
// the right length has been obtained.
unsigned int length = 0;
for (unsigned int i=0; i<this->n_block_cols(); ++i)
length += counter_within_block[i];
Assert (length == n_cols, ExcInternalError());
#endif
// Now we found out about where the
// individual columns should start and
// where we should start reading out
// data. Now let's write the data into
// the individual blocks!
const std::pair<unsigned int,unsigned int>
row_index = this->row_indices.global_to_local (row);
for (unsigned int block_col=0; block_col<n_block_cols(); ++block_col)
{
if (counter_within_block[block_col] == 0)
continue;
sub_objects[row_index.first][block_col]->
add_entries (row_index.second,
block_column_indices[block_col].begin(),
block_column_indices[block_col].begin()+counter_within_block[block_col],
indices_are_sorted);
}
}
template <class SparsityPatternBase>
inline
bool
BlockSparsityPatternBase<SparsityPatternBase>::exists (const unsigned int i,
const unsigned int j) const
{
// if you get an error here, are
// you sure you called
// <tt>collect_sizes()</tt> before?
const std::pair<unsigned int,unsigned int>
row_index = row_indices.global_to_local (i),
col_index = column_indices.global_to_local (j);
return sub_objects[row_index.first][col_index.first]->exists (row_index.second,
col_index.second);
}
template <class SparsityPatternBase>
inline
unsigned int
BlockSparsityPatternBase<SparsityPatternBase>::
row_length (const unsigned int row) const
{
const std::pair<unsigned int,unsigned int>
row_index = row_indices.global_to_local (row);
unsigned int c = 0;
for (unsigned int b=0; b<rows; ++b)
c += sub_objects[row_index.first][b]->row_length (row_index.second);
return c;
}
template <class SparsityPatternBase>
inline
unsigned int
BlockSparsityPatternBase<SparsityPatternBase>::n_block_cols () const
{
return columns;
}
template <class SparsityPatternBase>
inline
unsigned int
BlockSparsityPatternBase<SparsityPatternBase>::n_block_rows () const
{
return rows;
}
inline
void
BlockSparsityPattern::reinit (
const unsigned int n_block_rows,
const unsigned int n_block_columns)
{
BlockSparsityPatternBase<SparsityPattern>::reinit (
n_block_rows, n_block_columns);
}
DEAL_II_NAMESPACE_CLOSE
#endif
|