/usr/include/deal.II/lac/parallel_vector.h is in libdeal.ii-dev 8.1.0-6ubuntu1.
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 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 | // ---------------------------------------------------------------------
// $Id: parallel_vector.h 31932 2013-12-08 02:15:54Z heister $
//
// Copyright (C) 2011 - 2013 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 __deal2__parallel_vector_h
#define __deal2__parallel_vector_h
#include <deal.II/base/config.h>
#include <deal.II/base/index_set.h>
#include <deal.II/base/mpi.h>
#include <deal.II/base/template_constraints.h>
#include <deal.II/base/types.h>
#include <deal.II/base/utilities.h>
#include <deal.II/base/memory_consumption.h>
#include <deal.II/base/partitioner.h>
#include <deal.II/base/thread_management.h>
#include <deal.II/lac/vector_view.h>
#include <cstring>
DEAL_II_NAMESPACE_OPEN
namespace parallel
{
namespace distributed
{
template <typename Number> class BlockVector;
/*! @addtogroup Vectors
*@{
*/
/**
* Implementation of a parallel vector class. The design of this class is
* similar to the standard ::dealii::Vector class in deal.II, with the
* exception that storage is distributed with MPI.
*
* The vector is designed for the following scheme of parallel partitioning:
* - The indices held by individual processes (locally owned part) in the
* MPI parallelization form a contiguous range
* <code>[my_first_index,my_last_index)</code>.
* - Ghost indices residing on arbitrary positions of other processors are
* allowed. It is in general more efficient if ghost indices are
* clustered, since they are stored as a set of intervals. The
* communication pattern of the ghost indices is determined when calling
* the function <code>reinit (locally_owned, ghost_indices,
* communicator)</code>, and retained until the partitioning is changed
* again. This allows for efficient parallel communication of indices. In
* particular, it stores the communication pattern, rather than having
* to compute it again for every communication.
* - Besides the usual global access operator () it is also possible to
* access vector entries in the local index space with the function @p
* local_element(). Locally owned indices are placed first, [0,
* local_size()), and then all ghost indices follow after them
* contiguously, [local_size(), local_size()+n_ghost_entries()).
*
* Functions related to parallel functionality:
* - The function <code>compress()</code> goes through the data associated
* with ghost indices and communicates it to the owner process, which can
* then add/set it to the correct position. This can be used e.g. after
* having run an assembly routine involving ghosts that fill this vector.
* - The <code>update_ghost_values()</code> function imports the data from
* the owning processor to the ghost indices in order to provide read
* access to the data associated with ghosts.
* - It is possible to split the above functions into two phases, where
* the first initiates the communication and the second one finishes
* it. These functions can be used to overlap communication with
* computations in other parts of the code.
* - Of course, reduction operations (like norms) make use of collective
* all-to-all MPI communications.
*
* This vector can take two different states with respect to ghost
* elements:
* - After creation and whenever zero_out_ghosts() is called (or
* <code>operator = (0.)</code>), the vector does only allow writing
* into ghost elements but not reading from ghost elements.
* - After a call to update_ghost_values(), the vector does not allow
* writing into ghost elements but only reading from them. This is in
* order to avoid undesired ghost data artifacts when calling compress()
* after modifying some vector entries.
* The current statues of the ghost entries (read mode or write mode) can
* be queried by the method has_ghost_elements(), which returns
* <code>true</code> exactly when ghost elements have been updated and
* <code>false</code> otherwise, irrespective of the actual number of
* ghost entries in the vector layout (for that information, use
* n_ghost_entries() instead).
*
* @author Katharina Kormann, Martin Kronbichler, 2010, 2011
*/
template <typename Number>
class Vector : public Subscriptor
{
public:
/**
* Declare standard types used in all containers. These types parallel
* those in the <tt>C++</tt> standard libraries <tt>vector<...></tt>
* class.
*/
typedef Number value_type;
typedef value_type *pointer;
typedef const value_type *const_pointer;
typedef value_type *iterator;
typedef const value_type *const_iterator;
typedef value_type &reference;
typedef const value_type &const_reference;
typedef types::global_dof_index size_type;
typedef typename numbers::NumberTraits<Number>::real_type real_type;
/**
* A variable that indicates whether this vector
* supports distributed data storage. If true, then
* this vector also needs an appropriate compress()
* function that allows communicating recent set or
* add operations to individual elements to be communicated
* to other processors.
*
* For the current class, the variable equals
* true, since it does support parallel data storage.
*/
static const bool supports_distributed_data = true;
/**
* @name 1: Basic Object-handling
*/
//@{
/**
* Empty constructor.
*/
Vector ();
/**
* Copy constructor. Uses the parallel partitioning of @p in_vector.
*/
Vector (const Vector<Number> &in_vector);
/**
* Constructs a parallel vector of the given global size without any
* actual parallel distribution.
*/
Vector (const size_type size);
/**
* Constructs a parallel vector. The local range is specified by @p
* locally_owned_set (note that this must be a contiguous interval,
* multiple intervals are not possible). The IndexSet @p ghost_indices
* specifies ghost indices, i.e., indices which one might need to read
* data from or accumulate data from. It is allowed that the set of
* ghost indices also contains the local range, but it does not need to.
*
* This function involves global communication, so it should only be
* called once for a given layout. Use the constructor with
* Vector<Number> argument to create additional vectors with the same
* parallel layout.
*/
Vector (const IndexSet &local_range,
const IndexSet &ghost_indices,
const MPI_Comm communicator);
/**
* Same constructor as above but without any ghost indices.
*/
Vector (const IndexSet &local_range,
const MPI_Comm communicator);
/**
* Create the vector based on the parallel partitioning described in @p
* partitioner. The input argument is a shared pointer, which store the
* partitioner data only once and share it between several vectors with
* the same layout.
*/
Vector (const std_cxx1x::shared_ptr<const Utilities::MPI::Partitioner> &partitioner);
/**
* Destructor.
*/
~Vector ();
/**
* Sets the global size of the vector to @p size without any actual
* parallel distribution.
*/
void reinit (const size_type size,
const bool fast = false);
/**
* Uses the parallel layout of the input vector @p in_vector and
* allocates memory for this vector. Recommended initialization function
* when several vectors with the same layout should be created.
*
* If the flag @p fast is set to false, the memory will be initialized
* with zero, otherwise the memory will be untouched (and the user must
* make sure to fill it with reasonable data before using it).
*/
template <typename Number2>
void reinit(const Vector<Number2> &in_vector,
const bool fast = false);
/**
* Initialize the vector. The local range is specified by @p
* locally_owned_set (note that this must be a contiguous interval,
* multiple intervals are not possible). The IndexSet @p ghost_indices
* specifies ghost indices, i.e., indices which one might need to read
* data from or accumulate data from. It is allowed that the set of
* ghost indices also contains the local range, but it does not need to.
*
* This function involves global communication, so it should only be
* called once for a given layout. Use the @p reinit function with
* Vector<Number> argument to create additional vectors with the same
* parallel layout.
*/
void reinit (const IndexSet &local_range,
const IndexSet &ghost_indices,
const MPI_Comm communicator);
/**
* Same as above, but without ghost entries.
*/
void reinit (const IndexSet &local_range,
const MPI_Comm communicator);
/**
* Initialize the vector given to the parallel partitioning described in
* @p partitioner. The input argument is a shared pointer, which store
* the partitioner data only once and share it between several vectors
* with the same layout.
*/
void reinit (const std_cxx1x::shared_ptr<const Utilities::MPI::Partitioner> &partitioner);
/**
* Swap the contents of this vector and the other vector @p v. One could
* do this operation with a temporary variable and copying over the data
* elements, but this function is significantly more efficient since it
* only swaps the pointers to the data of the two vectors and therefore
* does not need to allocate temporary storage and move data around.
*
* This function is analog to the the @p swap function of all C++
* standard containers. Also, there is a global function
* <tt>swap(u,v)</tt> that simply calls <tt>u.swap(v)</tt>, again in
* analogy to standard functions.
*
* This function is virtual in order to allow for derived classes to
* handle memory separately.
*/
void swap (Vector<Number> &v);
/**
* Assigns the vector to the parallel partitioning of the input vector
* @p in_vector, and copies all the data.
*/
Vector<Number> &
operator = (const Vector<Number> &in_vector);
/**
* Assigns the vector to the parallel partitioning of the input vector
* @p in_vector, and copies all the data.
*/
template <typename Number2>
Vector<Number> &
operator = (const Vector<Number2> &in_vector);
/**
* This method copies the local range from another vector with the same
* local range, but possibly different layout of ghost indices.
*/
void copy_from (const Vector<Number> &in_vector,
const bool call_update_ghost_values = false);
/**
* Sets all elements of the vector to the scalar @p s. If the scalar is
* zero, also ghost elements are set to zero, otherwise they remain
* unchanged.
*/
Vector<Number> &operator = (const Number s);
/**
* This function copies the data that has accumulated in the data buffer
* for ghost indices to the owning processor. For the meaning of the
* argument @p operation, see the entry on @ref GlossCompress
* "Compressing distributed vectors and matrices" in the glossary.
*
* There are two variants for this function. If called with argument @p
* VectorOperation::add adds all the data accumulated in ghost elements
* to the respective elements on the owning processor and clears the
* ghost array afterwards. If called with argument @p
* VectorOperation::insert, a set operation is performed. Since setting
* elements in a vector with ghost elements is ambiguous (as one can set
* both the element on the ghost site as well as the owning site), this
* operation makes the assumption that all data is set correctly on the
* owning processor. Upon call of compress(VectorOperation::insert), all
* ghost entries are therefore simply zeroed out (using
* zero_ghost_values()). In debug mode, a check is performed that makes
* sure that the data set is actually consistent between processors,
* i.e., whenever a non-zero ghost element is found, it is compared to
* the value on the owning processor and an exception is thrown if these
* elements do not agree.
*
*/
void compress (::dealii::VectorOperation::values operation);
/**
* @deprecated: use compress(VectorOperation::values) instead.
*/
void compress () DEAL_II_DEPRECATED;
/**
* Fills the data field for ghost indices with the values stored in the
* respective positions of the owning processor. This function is needed
* before reading from ghosts. The function is @p const even though
* ghost data is changed. This is needed to allow functions with a @p
* const vector to perform the data exchange without creating
* temporaries.
*
* After calling this method, write access to ghost elements of the
* vector is forbidden and an exception is thrown. Only read access to
* ghost elements is allowed in this state. Note that all subsequent
* operations on this vector, like global vector addition, etc., will
* also update the ghost values by a call to this method after the
* operation. However, global reduction operations like norms or the
* inner product will always ignore ghost elements in order to avoid
* counting the ghost data more than once. To allow writing to ghost
* elements again, call zero_out_ghosts().
*/
void update_ghost_values () const;
/**
* Initiates communication for the @p compress() function with
* non-blocking communication. This function does not wait for the
* transfer to finish, in order to allow for other computations during
* the time it takes until all data arrives.
*
* Before the data is actually exchanged, the function must be followed
* by a call to @p compress_finish().
*
* In case this function is called for more than one vector before @p
* compress_finish() is invoked, it is mandatory to specify a unique
* communication channel to each such call, in order to avoid several
* messages with the same ID that will corrupt this operation.
*/
void compress_start (const unsigned int communication_channel = 0,
::dealii::VectorOperation::values operation = VectorOperation::add);
/**
* For all requests that have been initiated in compress_start, wait for
* the communication to finish. Once it is finished, add or set the data
* (depending on the flag operation) to the respective positions in the
* owning processor, and clear the contents in the ghost data
* fields. The meaning of this argument is the same as in
* compress().
*
* This function should be called exactly once per vector after calling
* compress_start, otherwise the result is undefined. In particular, it
* is not well-defined to call compress_start on the same vector again
* before compress_finished has been called. However, there is no
* warning to prevent this situation.
*
* Must follow a call to the @p compress_start function.
*/
void compress_finish (::dealii::VectorOperation::values operation);
/**
* @deprecated: use compress_finish(VectorOperation::values) instead.
*/
void compress_finish (const bool add_ghost_data = true) DEAL_II_DEPRECATED;
/**
* Initiates communication for the @p update_ghost_values() function
* with non-blocking communication. This function does not wait for the
* transfer to finish, in order to allow for other computations during
* the time it takes until all data arrives.
*
* Before the data is actually exchanged, the function must be followed
* by a call to @p update_ghost_values_finish().
*
* In case this function is called for more than one vector before @p
* update_ghost_values_finish() is invoked, it is mandatory to specify a
* unique communication channel to each such call, in order to avoid
* several messages with the same ID that will corrupt this operation.
*/
void update_ghost_values_start (const unsigned int communication_channel = 0) const;
/**
* For all requests that have been started in update_ghost_values_start,
* wait for the communication to finish.
*
* Must follow a call to the @p update_ghost_values_start function
* before reading data from ghost indices.
*/
void update_ghost_values_finish () const;
/**
* This method zeros the entries on ghost dofs, but does not touch
* locally owned DoFs.
*
* After calling this method, read access to ghost elements of the
* vector is forbidden and an exception is thrown. Only write access to
* ghost elements is allowed in this state.
*/
void zero_out_ghosts ();
/**
* Returns whether the vector currently is in a state where ghost values
* can be read or not. This is the same functionality as other parallel
* vectors have. If this method returns false, this only means that
* read-access to ghost elements is prohibited whereas write access is
* still possible (to those entries specified as ghosts during
* initialization), not that there are no ghost elements at all.
*/
bool has_ghost_elements() const;
/**
* Return whether the vector contains only elements with value
* zero. This function is mainly for internal consistency checks and
* should seldom be used when not in debug mode since it uses quite some
* time.
*/
bool all_zero () const;
/**
* Return @p true if the vector has no negative entries, i.e. all
* entries are zero or positive. This function is used, for example, to
* check whether refinement indicators are really all positive (or
* zero).
*
* The function obviously only makes sense if the template argument of
* this class is a real type. If it is a complex type, then an exception
* is thrown.
*/
bool is_non_negative () const;
/**
* Checks for equality of the two vectors.
*/
template <typename Number2>
bool operator == (const Vector<Number2> &v) const;
/**
* Checks for inequality of the two vectors.
*/
template <typename Number2>
bool operator != (const Vector<Number2> &v) const;
/**
* Perform the inner product of two vectors.
*/
template <typename Number2>
Number operator * (const Vector<Number2> &V) const;
/**
* Computes the square of the l<sub>2</sub> norm of the vector (i.e.,
* the sum of the squares of all entries among all processors).
*/
real_type norm_sqr () const;
/**
* Computes the mean value of all the entries in the vector.
*/
Number mean_value () const;
/**
* Returns the l<sub>1</sub> norm of the vector (i.e., the sum of the
* absolute values of all entries among all processors).
*/
real_type l1_norm () const;
/**
* Returns the l<sub>2</sub> norm of the vector (i.e., square root of
* the sum of the square of all entries among all processors).
*/
real_type l2_norm () const;
/**
* Returns the l<sub>p</sub> norm with real @p p of the vector (i.e.,
* the pth root of sum of the pth power of all entries among all
* processors).
*/
real_type lp_norm (const real_type p) const;
/**
* Returns the maximum norm of the vector (i.e., maximum absolute value
* among all entries among all processors).
*/
real_type linfty_norm () const;
/**
* Returns the global size of the vector, equal to the sum of the number
* of locally owned indices among all the processors.
*/
size_type size () const;
/**
* Returns the local size of the vector, i.e., the number of indices
* owned locally.
*/
size_type local_size() const;
/**
* Returns the half-open interval that specifies the locally owned range
* of the vector. Note that <code>local_size() == local_range().second -
* local_range().first</code>.
*/
std::pair<size_type, size_type> local_range () const;
/**
* Returns true if the given global index is in the local range of this
* processor.
*/
bool in_local_range (const size_type global_index) const;
/**
* Return an index set that describes which elements of this vector
* are owned by the current processor. Note that this index set does
* not include elements this vector may store locally as ghost
* elements but that are in fact owned by another processor.
* As a consequence, the index sets returned on different
* processors if this is a distributed vector will form disjoint
* sets that add up to the complete index set.
* Obviously, if a vector is created on only one processor, then
* the result would satisfy
* @code
* vec.locally_owned_elements() == complete_index_set (vec.size())
* @endcode
*/
IndexSet locally_owned_elements () const;
/**
* Returns the number of ghost elements present on the vector.
*/
size_type n_ghost_entries () const;
/**
* Return an index set that describes which elements of this vector are
* not owned by the current processor but can be written into or read
* from locally (ghost elements).
*/
const IndexSet &ghost_elements() const;
/**
* Returns whether the given global index is a ghost index on the
* present processor. Returns false for indices that are owned locally
* and for indices not present at all.
*/
bool is_ghost_entry (const types::global_dof_index global_index) const;
/**
* Make the @p Vector class a bit like the <tt>vector<></tt> class of
* the C++ standard library by returning iterators to the start and end
* of the <i>locally owned</i> elements of this vector.
*
* It holds that end() - begin() == local_size().
*/
iterator begin ();
/**
* Return constant iterator to the start of the locally owned elements
* of the vector.
*/
const_iterator begin () const;
/**
* Return an iterator pointing to the element past the end of the array
* of locally owned entries.
*/
iterator end ();
/**
* Return a constant iterator pointing to the element past the end of
* the array of the locally owned entries.
*/
const_iterator end () const;
//@}
/**
* @name 2: Data-Access
*/
//@{
/**
* Read access to the data in the position corresponding to @p
* global_index. The index must be either in the local range of the
* vector or be specified as a ghost index at construction.
*
* Performance: <tt>O(1)</tt> for locally owned elements that represent
* a contiguous range and <tt>O(log(n<sub>ranges</sub>))</tt> for ghost
* elements (quite fast, but slower than local_element()).
*/
Number operator () (const size_type global_index) const;
/**
* Read and write access to the data in the position corresponding to @p
* global_index. The index must be either in the local range of the
* vector or be specified as a ghost index at construction.
*
* Performance: <tt>O(1)</tt> for locally owned elements that represent
* a contiguous range and <tt>O(log(n<sub>ranges</sub>))</tt> for ghost
* elements (quite fast, but slower than local_element()).
*/
Number &operator () (const size_type global_index);
/**
* Read access to the data in the position corresponding to @p
* global_index. The index must be either in the local range of the
* vector or be specified as a ghost index at construction.
*
* This function does the same thing as operator().
*/
Number operator [] (const size_type global_index) const;
/**
* Read and write access to the data in the position corresponding to @p
* global_index. The index must be either in the local range of the
* vector or be specified as a ghost index at construction.
*
* This function does the same thing as operator().
*/
Number &operator [] (const size_type global_index);
/**
* A collective get operation: instead
* of getting individual elements of a
* vector, this function allows to get
* a whole set of elements at once. The
* indices of the elements to be read
* are stated in the first argument,
* the corresponding values are returned in the
* second.
*/
template <typename OtherNumber>
void extract_subvector_to (const std::vector<size_type> &indices,
std::vector<OtherNumber> &values) const;
/**
* Just as the above, but with pointers.
* Useful in minimizing copying of data around.
*/
template <typename ForwardIterator, typename OutputIterator>
void extract_subvector_to (ForwardIterator indices_begin,
const ForwardIterator indices_end,
OutputIterator values_begin) const;
/**
* Read access to the data field specified by @p local_index. Locally
* owned indices can be accessed with indices
* <code>[0,local_size)</code>, and ghost indices with indices
* <code>[local_size,local_size+ n_ghost_entries]</code>.
*
* Performance: Direct array access (fast).
*/
Number local_element (const size_type local_index) const;
/**
* Read and write access to the data field specified by @p
* local_index. Locally owned indices can be accessed with indices
* <code>[0,local_size)</code>, and ghost indices with indices
* <code>[local_size,local_size+n_ghosts]</code>.
*
* Performance: Direct array access (fast).
*/
Number &local_element (const size_type local_index);
//@}
/**
* @name 3: Modification of vectors
*/
//@{
/**
* Add the given vector to the present one.
*/
Vector<Number> &operator += (const Vector<Number> &V);
/**
* Subtract the given vector from the present one.
*/
Vector<Number> &operator -= (const Vector<Number> &V);
/**
* A collective add operation: This funnction adds a whole set of values
* stored in @p values to the vector components specified by @p indices.
*/
template <typename OtherNumber>
void add (const std::vector<size_type> &indices,
const std::vector<OtherNumber> &values);
/**
* This is a second collective add operation. As a difference, this
* function takes a deal.II vector of values.
*/
template <typename OtherNumber>
void add (const std::vector<size_type> &indices,
const ::dealii::Vector<OtherNumber> &values);
/**
* Take an address where <tt>n_elements</tt> are stored contiguously and
* add them into the vector. Handles all cases which are not covered by
* the other two <tt>add()</tt> functions above.
*/
template <typename OtherNumber>
void add (const size_type n_elements,
const size_type *indices,
const OtherNumber *values);
/**
* Addition of @p s to all components. Note that @p s is a scalar and
* not a vector.
*/
void add (const Number s);
/**
* Simple vector addition, equal to the <tt>operator +=</tt>.
*/
void add (const Vector<Number> &V);
/**
* Simple addition of a multiple of a vector, i.e. <tt>*this +=
* a*V</tt>.
*/
void add (const Number a, const Vector<Number> &V);
/**
* Multiple addition of scaled vectors, i.e. <tt>*this += a*V+b*W</tt>.
*/
void add (const Number a, const Vector<Number> &V,
const Number b, const Vector<Number> &W);
/**
* Scaling and simple vector addition, i.e. <tt>*this =
* s*(*this)+V</tt>.
*/
void sadd (const Number s,
const Vector<Number> &V);
/**
* Scaling and simple addition, i.e. <tt>*this = s*(*this)+a*V</tt>.
*/
void sadd (const Number s,
const Number a,
const Vector<Number> &V);
/**
* Scaling and multiple addition.
*/
void sadd (const Number s,
const Number a,
const Vector<Number> &V,
const Number b,
const Vector<Number> &W);
/**
* Scaling and multiple addition. <tt>*this = s*(*this)+a*V + b*W +
* c*X</tt>.
*/
void sadd (const Number s,
const Number a,
const Vector<Number> &V,
const Number b,
const Vector<Number> &W,
const Number c,
const Vector<Number> &X);
/**
* Scale each element of the vector by the given factor.
*
* @deprecated This function is deprecated and will be removed in a
* future version. Use <tt>operator *=</tt> and <tt>operator /=</tt>
* instead.
*/
void scale (const Number factor) DEAL_II_DEPRECATED;
/**
* Scale each element of the vector by a constant value.
*/
Vector<Number> &operator *= (const Number factor);
/**
* Scale each element of the vector by the inverse of the given value.
*/
Vector<Number> &operator /= (const Number factor);
/**
* Scale each element of this vector by the corresponding element in the
* argument. This function is mostly meant to simulate multiplication
* (and immediate re-assignment) by a diagonal scaling matrix.
*/
void scale (const Vector<Number> &scaling_factors);
/**
* Scale each element of this vector by the corresponding element in the
* argument. This function is mostly meant to simulate multiplication
* (and immediate re-assignment) by a diagonal scaling matrix.
*/
template <typename Number2>
void scale (const Vector<Number2> &scaling_factors);
/**
* Assignment <tt>*this = a*u</tt>.
*/
void equ (const Number a, const Vector<Number> &u);
/**
* Assignment <tt>*this = a*u</tt>.
*/
template <typename Number2>
void equ (const Number a, const Vector<Number2> &u);
/**
* Assignment <tt>*this = a*u + b*v</tt>.
*/
void equ (const Number a, const Vector<Number> &u,
const Number b, const Vector<Number> &v);
/**
* Assignment <tt>*this = a*u + b*v + b*w</tt>.
*/
void equ (const Number a, const Vector<Number> &u,
const Number b, const Vector<Number> &v,
const Number c, const Vector<Number> &w);
/**
* Compute the elementwise ratio of the two given vectors, that is let
* <tt>this[i] = a[i]/b[i]</tt>. This is useful for example if you want
* to compute the cellwise ratio of true to estimated error.
*
* This vector is appropriately scaled to hold the result.
*
* If any of the <tt>b[i]</tt> is zero, the result is undefined. No
* attempt is made to catch such situations.
*/
void ratio (const Vector<Number> &a,
const Vector<Number> &b);
//@}
/**
* @name 4: Mixed stuff
*/
//@{
/**
* Return a reference to the MPI communicator object in use with this
* vector.
*/
const MPI_Comm &get_mpi_communicator () const;
/**
* Checks whether the given partitioner is compatible with the
* partitioner used for this vector. Two partitioners are compatible if
* the have the same local size and the same ghost indices. They do not
* necessarily need to be the same data field. This is a local operation
* only, i.e., if only some processors decide that the partitioning is
* not compatible, only these processors will return @p false, whereas
* the other processors will return @p true.
*/
bool
partitioners_are_compatible (const Utilities::MPI::Partitioner &part) const;
/**
* Prints the vector to the output stream @p out.
*/
void print (std::ostream &out,
const unsigned int precision = 3,
const bool scientific = true,
const bool across = true) const;
/**
* Returns the memory consumption of this class in bytes.
*/
std::size_t memory_consumption () const;
//@}
private:
/**
* Local part of all_zero().
*/
bool all_zero_local () const;
/**
* Local part of is_non_negative().
*/
bool is_non_negative_local () const;
/**
* Local part of operator==.
*/
template <typename Number2>
bool vectors_equal_local (const Vector<Number2> &v) const;
/**
* Local part of the inner product of two vectors.
*/
template <typename Number2>
Number inner_product_local (const Vector<Number2> &V) const;
/**
* Local part of norm_sqr().
*/
real_type norm_sqr_local () const;
/**
* Local part of mean_value().
*/
Number mean_value_local () const;
/**
* Local part of l1_norm().
*/
real_type l1_norm_local () const;
/**
* Local part of lp_norm().
*/
real_type lp_norm_local (const real_type p) const;
/**
* Local part of linfty_norm().
*/
real_type linfty_norm_local () const;
/**
* Shared pointer to store the parallel partitioning information. This
* information can be shared between several vectors that have the same
* partitioning.
*/
std_cxx1x::shared_ptr<const Utilities::MPI::Partitioner> partitioner;
/**
* The size that is currently allocated in the val array.
*/
size_type allocated_size;
/**
* Pointer to the array of local elements of this vector.
*/
Number *val;
/**
* Temporary storage that holds the data that is sent to this processor
* in @p compress() or sent from this processor in @p
* update_ghost_values.
*/
mutable Number *import_data;
/**
* Stores whether the vector currently allows for reading ghost elements
* or not. Note that this is to ensure consistent ghost data and does
* not indicate whether the vector actually can store ghost elements. In
* particular, when assembling a vector we do not allow reading
* elements, only writing them.
*/
mutable bool vector_is_ghosted;
/**
* Provide this class with all functionality of ::dealii::Vector by
* creating a VectorView object.
*/
VectorView<Number> vector_view;
#ifdef DEAL_II_WITH_MPI
/**
* A vector that collects all requests from @p compress()
* operations. This class uses persistent MPI communicators, i.e., the
* communication channels are stored during successive calls to a given
* function. This reduces the overhead involved with setting up the MPI
* machinery, but it does not remove the need for a receive operation to
* be posted before the data can actually be sent.
*/
std::vector<MPI_Request> compress_requests;
/**
* A vector that collects all requests from @p update_ghost_values()
* operations. This class uses persistent MPI communicators.
*/
mutable std::vector<MPI_Request> update_ghost_values_requests;
#endif
/**
* A lock that makes sure that the @p compress and @p
* update_ghost_values functions give reasonable results also when used
* with several threads.
*/
mutable Threads::Mutex mutex;
/**
* A helper function that clears the compress_requests and
* update_ghost_values_requests field. Used in reinit functions.
*/
void clear_mpi_requests ();
/**
* A helper function that is used to resize the val array.
*/
void resize_val (const size_type new_allocated_size);
/*
* Make all other vector types friends.
*/
template <typename Number2> friend class Vector;
/**
* Make BlockVector type friends.
*/
template <typename Number2> friend class BlockVector;
};
/*@}*/
/*----------------------- Inline functions ----------------------------------*/
#ifndef DOXYGEN
template <typename Number>
inline
Vector<Number>::Vector ()
:
partitioner (new Utilities::MPI::Partitioner()),
allocated_size (0),
val (0),
import_data (0),
vector_is_ghosted (false),
vector_view (0, static_cast<Number *>(0))
{}
template <typename Number>
inline
Vector<Number>::Vector (const Vector<Number> &v)
:
Subscriptor(),
allocated_size (0),
val (0),
import_data (0),
vector_is_ghosted (false),
vector_view (0, static_cast<Number *>(0))
{
reinit (v, true);
vector_view = v.vector_view;
}
template <typename Number>
inline
Vector<Number>::Vector (const IndexSet &local_range,
const IndexSet &ghost_indices,
const MPI_Comm communicator)
:
allocated_size (0),
val (0),
import_data (0),
vector_is_ghosted (false),
vector_view (0, static_cast<Number *>(0))
{
reinit (local_range, ghost_indices, communicator);
}
template <typename Number>
inline
Vector<Number>::Vector (const IndexSet &local_range,
const MPI_Comm communicator)
:
allocated_size (0),
val (0),
import_data (0),
vector_is_ghosted (false),
vector_view (0, static_cast<Number *>(0))
{
IndexSet ghost_indices(local_range.size());
reinit (local_range, ghost_indices, communicator);
}
template <typename Number>
inline
Vector<Number>::Vector (const size_type size)
:
allocated_size (0),
val (0),
import_data (0),
vector_is_ghosted (false),
vector_view (0, static_cast<Number *>(0))
{
reinit (size, false);
}
template <typename Number>
inline
Vector<Number>::
Vector (const std_cxx1x::shared_ptr<const Utilities::MPI::Partitioner> &partitioner)
:
allocated_size (0),
val (0),
import_data (0),
vector_is_ghosted (false),
vector_view (0, static_cast<Number *>(0))
{
reinit (partitioner);
}
template <typename Number>
inline
Vector<Number>::~Vector ()
{
if (val != 0)
delete[] val;
val = 0;
if (import_data != 0)
delete[] import_data;
import_data = 0;
clear_mpi_requests();
}
template <typename Number>
inline
Vector<Number> &
Vector<Number>::operator = (const Vector<Number> &c)
{
Assert (c.partitioner.get() != 0, ExcNotInitialized());
// we update ghost values whenever one of the input or output vector
// already held ghost values or when we import data from a vector with
// the same local range but different ghost layout
bool must_update_ghost_values = true;
// check whether the two vectors use the same parallel partitioner. if
// not, check if all local ranges are the same (that way, we can
// exchange data between different parallel layouts)
if (partitioner.get() == 0)
reinit (c, true);
else if (partitioner.get() != c.partitioner.get())
{
size_type local_ranges_different_loc = (local_range() !=
c.local_range());
if ((partitioner->n_mpi_processes() > 1 &&
Utilities::MPI::max(local_ranges_different_loc,
partitioner->get_communicator()) != 0)
||
local_ranges_different_loc)
reinit (c, true);
}
else
must_update_ghost_values = vector_is_ghosted || c.vector_is_ghosted;
vector_view = c.vector_view;
if (must_update_ghost_values)
update_ghost_values();
return *this;
}
template <typename Number>
template <typename Number2>
inline
Vector<Number> &
Vector<Number>::operator = (const Vector<Number2> &c)
{
Assert (c.partitioner.get() != 0, ExcNotInitialized());
// check whether the two vectors use the same parallel partitioner. if
// not, check if all local ranges are the same (that way, we can
// exchange data between different parallel layouts)
if (partitioner.get() == 0)
reinit (c, true);
else if (partitioner.get() != c.partitioner.get())
{
size_type local_ranges_different_loc = (local_range() !=
c.local_range());
if ((partitioner->n_mpi_processes() > 1 &&
Utilities::MPI::max(local_ranges_different_loc,
partitioner->get_communicator()) != 0)
||
local_ranges_different_loc)
reinit (c, true);
}
vector_view.reinit (partitioner->local_size(), val);
if (partitioner->local_size())
vector_view.equ (1., c.vector_view);
if (vector_is_ghosted || c.vector_is_ghosted)
update_ghost_values();
return *this;
}
template <typename Number>
inline
void
Vector<Number>::compress (::dealii::VectorOperation::values operation)
{
compress_start (0, operation);
compress_finish(operation);
}
template <typename Number>
inline
void
Vector<Number>::compress ()
{
compress(VectorOperation::unknown);
}
template <typename Number>
inline
void
Vector<Number>::compress_finish (const bool add_value)
{
if (add_value)
compress_finish(VectorOperation::add);
else
compress_finish(VectorOperation::insert);
}
template <typename Number>
inline
void
Vector<Number>::update_ghost_values () const
{
update_ghost_values_start ();
update_ghost_values_finish ();
}
template <typename Number>
inline
void
Vector<Number>::zero_out_ghosts ()
{
std::fill_n (&val[partitioner->local_size()],
partitioner->n_ghost_indices(),
Number());
vector_is_ghosted = false;
}
template <typename Number>
inline
bool
Vector<Number>::has_ghost_elements () const
{
return vector_is_ghosted;
}
template <typename Number>
inline
bool
Vector<Number>::all_zero_local () const
{
return partitioner->local_size()>0 ? vector_view.all_zero () : true;
}
template <typename Number>
inline
bool
Vector<Number>::all_zero () const
{
// use int instead of bool. in order to make global reduction operations
// work also when MPI_Init was not called, only call MPI_Allreduce
// commands when there is more than one processor (note that reinit()
// functions handle this case correctly through the job_supports_mpi()
// query). this is the same in all the functions below
int local_result = -static_cast<int>(all_zero_local());
if (partitioner->n_mpi_processes() > 1)
return -Utilities::MPI::max(local_result,
partitioner->get_communicator());
else
return -local_result;
}
template <typename Number>
inline
bool
Vector<Number>::is_non_negative_local () const
{
return partitioner->local_size()>0 ? vector_view.is_non_negative () : true;
}
template <typename Number>
inline
bool
Vector<Number>::is_non_negative () const
{
int local_result = -static_cast<int>(is_non_negative_local());
if (partitioner->n_mpi_processes() > 1)
return -Utilities::MPI::max(local_result,
partitioner->get_communicator());
else
return -local_result;
}
template <typename Number>
template <typename Number2>
inline
bool
Vector<Number>::vectors_equal_local (const Vector<Number2> &v) const
{
return partitioner->local_size()>0 ?
vector_view.template operator == <Number2>(v.vector_view)
: true;
}
template <typename Number>
template <typename Number2>
inline
bool
Vector<Number>::operator == (const Vector<Number2> &v) const
{
// MPI does not support bools, so use unsigned int instead. Two vectors
// are equal if the check for non-equal fails on all processors
unsigned int local_result = static_cast<int>(!vectors_equal_local(v));
unsigned int result =
partitioner->n_mpi_processes() > 1
?
Utilities::MPI::max(local_result, partitioner->get_communicator())
:
local_result;
return result==0;
}
template <typename Number>
template <typename Number2>
inline
bool
Vector<Number>::operator != (const Vector<Number2> &v) const
{
return !(operator == (v));
}
template <typename Number>
template <typename Number2>
inline
Number
Vector<Number>::inner_product_local(const Vector<Number2> &V) const
{
// on some processors, the size might be zero, which is not allowed by
// the dealii::Vector class. Therefore, insert a check here
return (partitioner->local_size()>0 ?
vector_view.operator* (V.vector_view)
: Number());
}
template <typename Number>
template <typename Number2>
inline
Number
Vector<Number>::operator * (const Vector<Number2> &V) const
{
Number local_result = inner_product_local(V);
if (partitioner->n_mpi_processes() > 1)
return Utilities::MPI::sum (local_result,
partitioner->get_communicator());
else
return local_result;
}
template <typename Number>
inline
typename Vector<Number>::real_type
Vector<Number>::norm_sqr_local () const
{
return partitioner->local_size()>0 ? vector_view.norm_sqr() : real_type();
}
template <typename Number>
inline
typename Vector<Number>::real_type
Vector<Number>::norm_sqr () const
{
real_type local_result = norm_sqr_local();
if (partitioner->n_mpi_processes() > 1)
return Utilities::MPI::sum(local_result,
partitioner->get_communicator());
else
return local_result;
}
template <typename Number>
inline
Number
Vector<Number>::mean_value_local () const
{
Assert (partitioner->size()!=0, ExcEmptyObject());
return (partitioner->local_size() ?
vector_view.mean_value()
: Number());
}
template <typename Number>
inline
Number
Vector<Number>::mean_value () const
{
Number local_result = mean_value_local();
if (partitioner->n_mpi_processes() > 1)
return Utilities::MPI::sum (local_result *
(real_type)partitioner->local_size(),
partitioner->get_communicator())
/(real_type)partitioner->size();
else
return local_result;
}
template <typename Number>
inline
typename Vector<Number>::real_type
Vector<Number>::l1_norm_local () const
{
return partitioner->local_size() ? vector_view.l1_norm() : real_type();
}
template <typename Number>
inline
typename Vector<Number>::real_type
Vector<Number>::l1_norm () const
{
real_type local_result = l1_norm_local();
if (partitioner->n_mpi_processes() > 1)
return Utilities::MPI::sum(local_result,
partitioner->get_communicator());
else
return local_result;
}
template <typename Number>
inline
typename Vector<Number>::real_type
Vector<Number>::l2_norm () const
{
return std::sqrt(norm_sqr());
}
template <typename Number>
inline
typename Vector<Number>::real_type
Vector<Number>::lp_norm_local (const real_type p) const
{
return partitioner->local_size() ? vector_view.lp_norm(p) : real_type();
}
template <typename Number>
inline
typename Vector<Number>::real_type
Vector<Number>::lp_norm (const real_type p) const
{
const real_type local_result = lp_norm_local(p);
if (partitioner->n_mpi_processes() > 1)
return std::pow (Utilities::MPI::sum(std::pow(local_result,p),
partitioner->get_communicator()),
static_cast<real_type>(1.0/p));
else
return local_result;
}
template <typename Number>
inline
typename Vector<Number>::real_type
Vector<Number>::linfty_norm_local () const
{
return partitioner->local_size() ? vector_view.linfty_norm() : real_type();
}
template <typename Number>
inline
typename Vector<Number>::real_type
Vector<Number>::linfty_norm () const
{
const real_type local_result = linfty_norm_local();
if (partitioner->n_mpi_processes() > 1)
return Utilities::MPI::max (local_result,
partitioner->get_communicator());
else
return local_result;
}
template <typename Number>
inline
typename Vector<Number>::size_type
Vector<Number>::size () const
{
return partitioner->size();
}
template <typename Number>
inline
typename Vector<Number>::size_type
Vector<Number>::local_size () const
{
return partitioner->local_size();
}
template <typename Number>
inline
std::pair<typename Vector<Number>::size_type,
typename Vector<Number>::size_type>
Vector<Number>::local_range () const
{
return partitioner->local_range();
}
template <typename Number>
inline
bool
Vector<Number>::in_local_range
(const size_type global_index) const
{
return partitioner->in_local_range (global_index);
}
template <typename Number>
inline
IndexSet
Vector<Number>::locally_owned_elements() const
{
IndexSet is (size());
is.add_range (local_range().first, local_range().second);
return is;
}
template <typename Number>
inline
typename Vector<Number>::size_type
Vector<Number>::n_ghost_entries () const
{
return partitioner->n_ghost_indices();
}
template <typename Number>
inline
const IndexSet &
Vector<Number>::ghost_elements() const
{
return partitioner->ghost_indices();
}
template <typename Number>
inline
bool
Vector<Number>::is_ghost_entry (const size_type global_index) const
{
return partitioner->is_ghost_entry (global_index);
}
template <typename Number>
inline
typename Vector<Number>::iterator
Vector<Number>::begin ()
{
return vector_view.begin();
}
template <typename Number>
inline
typename Vector<Number>::const_iterator
Vector<Number>::begin () const
{
return vector_view.begin();
}
template <typename Number>
inline
typename Vector<Number>::iterator
Vector<Number>::end ()
{
return vector_view.end();
}
template <typename Number>
inline
typename Vector<Number>::const_iterator
Vector<Number>::end () const
{
return vector_view.end();
}
template <typename Number>
inline
Number
Vector<Number>::operator() (const size_type global_index) const
{
// do not allow reading a vector which is not in ghost mode
Assert (in_local_range (global_index) || vector_is_ghosted == true,
ExcMessage("You tried to read a ghost element of this vector, "
"but it has not imported its ghost values."));
return val[partitioner->global_to_local(global_index)];
}
template <typename Number>
inline
Number &
Vector<Number>::operator() (const size_type global_index)
{
// we would like to prevent reading ghosts from a vector that does not
// have them imported, but this is not possible because we might be in a
// part of the code where the vector has enabled ghosts but is non-const
// (then, the compiler picks this method according to the C++ rule book
// even if a human would pick the const method when this subsequent use
// is just a read)
return val[partitioner->global_to_local (global_index)];
}
template <typename Number>
inline
Number
Vector<Number>::operator[] (const size_type global_index) const
{
return operator()(global_index);
}
template <typename Number>
inline
Number &
Vector<Number>::operator[] (const size_type global_index)
{
return operator()(global_index);
}
template <typename Number>
template <typename OtherNumber>
inline
void Vector<Number>::extract_subvector_to (const std::vector<size_type> &indices,
std::vector<OtherNumber> &values) const
{
for (size_type i = 0; i < indices.size(); ++i)
values[i] = operator()(indices[i]);
}
template <typename Number>
template <typename ForwardIterator, typename OutputIterator>
inline
void Vector<Number>::extract_subvector_to (ForwardIterator indices_begin,
const ForwardIterator indices_end,
OutputIterator values_begin) const
{
while (indices_begin != indices_end)
{
*values_begin = operator()(*indices_begin);
indices_begin++;
values_begin++;
}
}
template <typename Number>
inline
Number
Vector<Number>::local_element (const size_type local_index) const
{
AssertIndexRange (local_index,
partitioner->local_size()+
partitioner->n_ghost_indices());
// do not allow reading a vector which is not in ghost mode
Assert (local_index < local_size() || vector_is_ghosted == true,
ExcMessage("You tried to read a ghost element of this vector, "
"but it has not imported its ghost values."));
return val[local_index];
}
template <typename Number>
inline
Number &
Vector<Number>::local_element (const size_type local_index)
{
AssertIndexRange (local_index,
partitioner->local_size()+
partitioner->n_ghost_indices());
return val[local_index];
}
template <typename Number>
inline
Vector<Number> &
Vector<Number>::operator = (const Number s)
{
// if we call Vector::operator=0, we want to zero out all the entries
// plus ghosts.
if (partitioner->local_size() > 0)
vector_view.dealii::template Vector<Number>::operator= (s);
if (s==Number())
zero_out_ghosts();
return *this;
}
template <typename Number>
inline
Vector<Number> &
Vector<Number>::operator += (const Vector<Number> &v)
{
AssertDimension (local_size(), v.local_size());
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size()>0)
vector_view += v.vector_view;
if (vector_is_ghosted)
update_ghost_values();
return *this;
}
template <typename Number>
inline
Vector<Number> &
Vector<Number>::operator -= (const Vector<Number> &v)
{
AssertDimension (local_size(), v.local_size());
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size()>0)
vector_view -= v.vector_view;
if (vector_is_ghosted)
update_ghost_values();
return *this;
}
template <typename Number>
template <typename OtherNumber>
inline
void
Vector<Number>::add (const std::vector<size_type> &indices,
const std::vector<OtherNumber> &values)
{
AssertDimension (indices.size(), values.size());
add (indices.size(), &indices[0], &values[0]);
}
template <typename Number>
template <typename OtherNumber>
inline
void
Vector<Number>::add (const std::vector<size_type> &indices,
const ::dealii::Vector<OtherNumber> &values)
{
AssertDimension (indices.size(), values.size());
add (indices.size(), &indices[0], values.begin());
}
template <typename Number>
template <typename OtherNumber>
inline
void
Vector<Number>::add (const size_type n_indices,
const size_type *indices,
const OtherNumber *values)
{
for (size_type i=0; i<n_indices; ++i)
{
Assert (numbers::is_finite(values[i]),
ExcMessage("The given value is not finite but either infinite or Not A Number (NaN)"));
this->operator()(indices[i]) += values[i];
}
}
template <typename Number>
inline
void
Vector<Number>::add (const Number a)
{
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size())
vector_view.add (a);
if (vector_is_ghosted)
update_ghost_values();
}
template <typename Number>
inline
void
Vector<Number>::add (const Vector<Number> &v)
{
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size())
vector_view.add (v.vector_view);
if (vector_is_ghosted)
update_ghost_values();
}
template <typename Number>
inline
void
Vector<Number>::add (const Number a,
const Vector<Number> &v)
{
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size())
vector_view.add (a, v.vector_view);
if (vector_is_ghosted)
update_ghost_values();
}
template <typename Number>
inline
void
Vector<Number>::add (const Number a,
const Vector<Number> &v,
const Number b,
const Vector<Number> &w)
{
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size())
vector_view.add (a, v.vector_view, b, w.vector_view);
if (vector_is_ghosted)
update_ghost_values();
}
template <typename Number>
inline
void
Vector<Number>::sadd (const Number x,
const Vector<Number> &v)
{
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size())
vector_view.sadd (x, v.vector_view);
if (vector_is_ghosted)
update_ghost_values();
}
template <typename Number>
inline
void
Vector<Number>::sadd (const Number x,
const Number a,
const Vector<Number> &v)
{
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size())
vector_view.sadd (x, a, v.vector_view);
if (vector_is_ghosted)
update_ghost_values();
}
template <typename Number>
inline
void
Vector<Number>::sadd (const Number x,
const Number a,
const Vector<Number> &v,
const Number b,
const Vector<Number> &w)
{
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size())
vector_view.sadd (x, a, v.vector_view, b, w.vector_view);
if (vector_is_ghosted)
update_ghost_values();
}
template <typename Number>
inline
void
Vector<Number>::sadd (const Number s,
const Number a,
const Vector<Number> &v,
const Number b,
const Vector<Number> &w,
const Number c,
const Vector<Number> &x)
{
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size())
vector_view.sadd (s, a, v.vector_view, b, w.vector_view,
c, x.vector_view);
if (vector_is_ghosted)
update_ghost_values();
}
template <typename Number>
inline
void
Vector<Number>::scale (const Number factor)
{
operator *=(factor);
}
template <typename Number>
inline
Vector<Number> &
Vector<Number>::operator *= (const Number factor)
{
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size())
vector_view *= factor;
if (vector_is_ghosted)
update_ghost_values();
return *this;
}
template <typename Number>
inline
Vector<Number> &
Vector<Number>::operator /= (const Number factor)
{
operator *= (1./factor);
return *this;
}
template <typename Number>
inline
void
Vector<Number>::scale (const Vector<Number> &scaling_factors)
{
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size())
vector_view.scale (scaling_factors.vector_view);
if (vector_is_ghosted)
update_ghost_values();
}
template <typename Number>
template <typename Number2>
inline
void
Vector<Number>::scale (const Vector<Number2> &scaling_factors)
{
if (local_size())
vector_view.template scale<Number2> (scaling_factors.vector_view);
if (vector_is_ghosted)
update_ghost_values();
}
template <typename Number>
inline
void
Vector<Number>::equ (const Number a,
const Vector<Number> &v)
{
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size())
vector_view.equ (a, v.vector_view);
if (vector_is_ghosted)
update_ghost_values();
}
template <typename Number>
template <typename Number2>
inline
void
Vector<Number>::equ (const Number a,
const Vector<Number2> &v)
{
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size())
vector_view.equ (a, v.vector_view);
if (vector_is_ghosted)
update_ghost_values();
}
template <typename Number>
inline
void
Vector<Number>::equ (const Number a,
const Vector<Number> &v,
const Number b,
const Vector<Number> &w)
{
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size())
vector_view.equ (a, v.vector_view, b, w.vector_view);
if (vector_is_ghosted)
update_ghost_values();
}
template <typename Number>
inline
void
Vector<Number>::equ (const Number a,
const Vector<Number> &v,
const Number b,
const Vector<Number> &w,
const Number c,
const Vector<Number> &x)
{
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size())
vector_view.equ (a, v.vector_view, b, w.vector_view,
c, x.vector_view);
if (vector_is_ghosted)
update_ghost_values();
}
template <typename Number>
inline
void
Vector<Number>::ratio (const Vector<Number> &a,
const Vector<Number> &b)
{
// dealii::Vector does not allow empty fields but this might happen on
// some processors for parallel implementation
if (local_size())
vector_view.ratio (a.vector_view, b.vector_view);
if (vector_is_ghosted)
update_ghost_values();
}
template <typename Number>
inline
const MPI_Comm &
Vector<Number>::get_mpi_communicator() const
{
return partitioner->get_communicator();
}
template <typename Number>
inline
bool
Vector<Number>::partitioners_are_compatible
(const Utilities::MPI::Partitioner &part) const
{
return partitioner->is_compatible (part);
}
#endif // ifndef DOXYGEN
} // end of namespace distributed
} // end of namespace parallel
/**
* Global function @p swap which overloads the default implementation
* of the C++ standard library which uses a temporary object. The
* function simply exchanges the data of the two vectors.
*
* @relates Vector
* @author Katharina Kormann, Martin Kronbichler, 2011
*/
template <typename Number>
inline
void swap (parallel::distributed::Vector<Number> &u,
parallel::distributed::Vector<Number> &v)
{
u.swap (v);
}
DEAL_II_NAMESPACE_CLOSE
#endif
|