/usr/include/trilinos/Tpetra_Map_def.hpp is in libtrilinos-tpetra-dev 12.10.1-3.
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 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 | // @HEADER
// ***********************************************************************
//
// Tpetra: Templated Linear Algebra Services Package
// Copyright (2008) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
// @HEADER
/// \file Tpetra_Map_def.hpp
///
/// Implementation of the methods of Tpetra::Map, and of related
/// nonmember constructors for Tpetra::Map.
#ifndef TPETRA_MAP_DEF_HPP
#define TPETRA_MAP_DEF_HPP
#include "Tpetra_Directory.hpp" // must include for implicit instantiation to work
#include "Tpetra_Details_FixedHashTable.hpp"
#include "Tpetra_Details_gathervPrint.hpp"
#include "Tpetra_Util.hpp"
#include "Teuchos_as.hpp"
#include <stdexcept>
namespace Tpetra {
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Map<LocalOrdinal,GlobalOrdinal,Node>::
Map () :
comm_ (new Teuchos::SerialComm<int> ()),
node_ (defaultArgNode<Node> ()),
indexBase_ (0),
numGlobalElements_ (0),
numLocalElements_ (0),
minMyGID_ (Tpetra::Details::OrdinalTraits<GlobalOrdinal>::invalid ()),
maxMyGID_ (Tpetra::Details::OrdinalTraits<GlobalOrdinal>::invalid ()),
minAllGID_ (Tpetra::Details::OrdinalTraits<GlobalOrdinal>::invalid ()),
maxAllGID_ (Tpetra::Details::OrdinalTraits<GlobalOrdinal>::invalid ()),
firstContiguousGID_ (Tpetra::Details::OrdinalTraits<GlobalOrdinal>::invalid ()),
lastContiguousGID_ (Tpetra::Details::OrdinalTraits<GlobalOrdinal>::invalid ()),
uniform_ (false), // trivially
contiguous_ (false),
distributed_ (false), // no communicator yet
directory_ (new Directory<LocalOrdinal, GlobalOrdinal, Node> ())
{}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Map<LocalOrdinal,GlobalOrdinal,Node>::
Map (global_size_t numGlobalElements,
GlobalOrdinal indexBase,
const Teuchos::RCP<const Teuchos::Comm<int> > &comm,
LocalGlobal lOrG,
const Teuchos::RCP<Node> &node) :
comm_ (comm),
node_ (node),
uniform_ (true),
directory_ (new Directory<LocalOrdinal, GlobalOrdinal, Node> ())
{
using Teuchos::as;
using Teuchos::broadcast;
using Teuchos::outArg;
using Teuchos::reduceAll;
using Teuchos::REDUCE_MIN;
using Teuchos::REDUCE_MAX;
using Teuchos::typeName;
typedef GlobalOrdinal GO;
typedef global_size_t GST;
const GST GSTI = Tpetra::Details::OrdinalTraits<GST>::invalid ();
// Make sure that Kokkos has been initialized (Github Issue #513).
TEUCHOS_TEST_FOR_EXCEPTION
(! execution_space::is_initialized (), std::runtime_error,
"Tpetra::Map constructor: The Kokkos execution space has not been "
"initialized. Please initialize it before creating a Map.")
#ifdef HAVE_TPETRA_DEBUG
// In debug mode only, check whether numGlobalElements and
// indexBase are the same over all processes in the communicator.
{
GST proc0NumGlobalElements = numGlobalElements;
broadcast<int, GST> (*comm_, 0, outArg (proc0NumGlobalElements));
GST minNumGlobalElements = numGlobalElements;
GST maxNumGlobalElements = numGlobalElements;
reduceAll<int, GST> (*comm, REDUCE_MIN, numGlobalElements, outArg (minNumGlobalElements));
reduceAll<int, GST> (*comm, REDUCE_MAX, numGlobalElements, outArg (maxNumGlobalElements));
TEUCHOS_TEST_FOR_EXCEPTION(
minNumGlobalElements != maxNumGlobalElements || numGlobalElements != minNumGlobalElements,
std::invalid_argument,
"Tpetra::Map constructor: All processes must provide the same number "
"of global elements. Process 0 set numGlobalElements = "
<< proc0NumGlobalElements << ". The calling process "
<< comm->getRank () << " set numGlobalElements = " << numGlobalElements
<< ". The min and max values over all processes are "
<< minNumGlobalElements << " resp. " << maxNumGlobalElements << ".");
GO proc0IndexBase = indexBase;
broadcast<int, GO> (*comm_, 0, outArg (proc0IndexBase));
GO minIndexBase = indexBase;
GO maxIndexBase = indexBase;
reduceAll<int, GO> (*comm, REDUCE_MIN, indexBase, outArg (minIndexBase));
reduceAll<int, GO> (*comm, REDUCE_MAX, indexBase, outArg (maxIndexBase));
TEUCHOS_TEST_FOR_EXCEPTION(
minIndexBase != maxIndexBase || indexBase != minIndexBase,
std::invalid_argument,
"Tpetra::Map constructor: "
"All processes must provide the same indexBase argument. "
"Process 0 set indexBase = " << proc0IndexBase << ". The calling "
"process " << comm->getRank () << " set indexBase = " << indexBase
<< ". The min and max values over all processes are "
<< minIndexBase << " resp. " << maxIndexBase << ".");
}
#endif // HAVE_TPETRA_DEBUG
// Distribute the elements across the processes in the given
// communicator so that global IDs (GIDs) are
//
// - Nonoverlapping (only one process owns each GID)
// - Contiguous (the sequence of GIDs is nondecreasing, and no two
// adjacent GIDs differ by more than one)
// - As evenly distributed as possible (the numbers of GIDs on two
// different processes do not differ by more than one)
// All processes have the same numGlobalElements, but we still
// need to check that it is valid. numGlobalElements must be
// positive and not the "invalid" value (GSTI).
//
// This comparison looks funny, but it avoids compiler warnings
// for comparing unsigned integers (numGlobalElements_in is a
// GST, which is unsigned) while still working if we
// later decide to make GST signed.
TEUCHOS_TEST_FOR_EXCEPTION(
(numGlobalElements < 1 && numGlobalElements != 0),
std::invalid_argument,
"Tpetra::Map constructor: numGlobalElements (= "
<< numGlobalElements << ") must be nonnegative.");
TEUCHOS_TEST_FOR_EXCEPTION(
numGlobalElements == GSTI, std::invalid_argument,
"Tpetra::Map constructor: You provided numGlobalElements = Teuchos::"
"OrdinalTraits<Tpetra::global_size_t>::invalid(). This version of the "
"constructor requires a valid value of numGlobalElements. You "
"probably mistook this constructor for the \"contiguous nonuniform\" "
"constructor, which can compute the global number of elements for you "
"if you set numGlobalElements to that value.");
size_t numLocalElements = 0; // will set below
if (lOrG == GloballyDistributed) {
// Compute numLocalElements:
//
// If numGlobalElements == numProcs * B + remainder,
// then Proc r gets B+1 elements if r < remainder,
// and B elements if r >= remainder.
//
// This strategy is valid for any value of numGlobalElements and
// numProcs, including the following border cases:
// - numProcs == 1
// - numLocalElements < numProcs
//
// In the former case, remainder == 0 && numGlobalElements ==
// numLocalElements. In the latter case, remainder ==
// numGlobalElements && numLocalElements is either 0 or 1.
const GST numProcs = static_cast<GST> (comm_->getSize ());
const GST myRank = static_cast<GST> (comm_->getRank ());
const GST quotient = numGlobalElements / numProcs;
const GST remainder = numGlobalElements - quotient * numProcs;
GO startIndex;
if (myRank < remainder) {
numLocalElements = static_cast<size_t> (1) + static_cast<size_t> (quotient);
// myRank was originally an int, so it should never overflow
// reasonable GO types.
startIndex = as<GO> (myRank) * as<GO> (numLocalElements);
} else {
numLocalElements = as<size_t> (quotient);
startIndex = as<GO> (myRank) * as<GO> (numLocalElements) +
as<GO> (remainder);
}
minMyGID_ = indexBase + startIndex;
maxMyGID_ = indexBase + startIndex + numLocalElements - 1;
minAllGID_ = indexBase;
maxAllGID_ = indexBase + numGlobalElements - 1;
distributed_ = (numProcs > 1);
}
else { // lOrG == LocallyReplicated
numLocalElements = as<size_t> (numGlobalElements);
minMyGID_ = indexBase;
maxMyGID_ = indexBase + numGlobalElements - 1;
distributed_ = false;
}
minAllGID_ = indexBase;
maxAllGID_ = indexBase + numGlobalElements - 1;
indexBase_ = indexBase;
numGlobalElements_ = numGlobalElements;
numLocalElements_ = numLocalElements;
firstContiguousGID_ = minMyGID_;
lastContiguousGID_ = maxMyGID_;
contiguous_ = true;
// Create the Directory on demand in getRemoteIndexList().
//setupDirectory ();
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Map<LocalOrdinal,GlobalOrdinal,Node>::
Map (global_size_t numGlobalElements,
size_t numLocalElements,
GlobalOrdinal indexBase,
const Teuchos::RCP<const Teuchos::Comm<int> > &comm,
const Teuchos::RCP<Node> &node) :
comm_ (comm),
node_ (node),
uniform_ (false),
directory_ (new Directory<LocalOrdinal, GlobalOrdinal, Node> ())
{
using Teuchos::as;
using Teuchos::broadcast;
using Teuchos::outArg;
using Teuchos::reduceAll;
using Teuchos::REDUCE_MIN;
using Teuchos::REDUCE_MAX;
using Teuchos::REDUCE_SUM;
using Teuchos::scan;
typedef GlobalOrdinal GO;
typedef global_size_t GST;
const GST GSTI = Tpetra::Details::OrdinalTraits<GST>::invalid ();
// Make sure that Kokkos has been initialized (Github Issue #513).
TEUCHOS_TEST_FOR_EXCEPTION
(! execution_space::is_initialized (), std::runtime_error,
"Tpetra::Map constructor: The Kokkos execution space has not been "
"initialized. Please initialize it before creating a Map.")
#ifdef HAVE_TPETRA_DEBUG
// Global sum of numLocalElements over all processes.
// Keep this for later debug checks.
const GST debugGlobalSum =
initialNonuniformDebugCheck (numGlobalElements, numLocalElements,
indexBase, comm);
#endif // HAVE_TPETRA_DEBUG
// Distribute the elements across the nodes so that they are
// - non-overlapping
// - contiguous
// This differs from the first Map constructor (that only takes a
// global number of elements) in that the user has specified the
// number of local elements, so that the elements are not
// (necessarily) evenly distributed over the processes.
// Compute my local offset. This is an inclusive scan, so to get
// the final offset, we subtract off the input.
GO scanResult = 0;
scan<int, GO> (*comm, REDUCE_SUM, numLocalElements, outArg (scanResult));
const GO myOffset = scanResult - numLocalElements;
if (numGlobalElements != GSTI) {
numGlobalElements_ = numGlobalElements; // Use the user's value.
} else {
// Inclusive scan means that the last process has the final sum.
// Rather than doing a reduceAll to get the sum of
// numLocalElements, we can just have the last process broadcast
// its result. That saves us a round of log(numProcs) messages.
const int numProcs = comm->getSize ();
GST globalSum = scanResult;
if (numProcs > 1) {
broadcast (*comm, numProcs - 1, outArg (globalSum));
}
numGlobalElements_ = globalSum;
#ifdef HAVE_TPETRA_DEBUG
// No need for an all-reduce here; both come from collectives.
TEUCHOS_TEST_FOR_EXCEPTION(
globalSum != debugGlobalSum, std::logic_error,
"Tpetra::Map constructor (contiguous nonuniform): "
"globalSum = " << globalSum << " != debugGlobalSum = " << debugGlobalSum
<< ". Please report this bug to the Tpetra developers.");
#endif // HAVE_TPETRA_DEBUG
}
numLocalElements_ = numLocalElements;
indexBase_ = indexBase;
minAllGID_ = indexBase;
// numGlobalElements might be GSTI; use numGlobalElements_;
maxAllGID_ = indexBase + numGlobalElements_ - 1;
minMyGID_ = indexBase + myOffset;
maxMyGID_ = indexBase + myOffset + numLocalElements - 1;
firstContiguousGID_ = minMyGID_;
lastContiguousGID_ = maxMyGID_;
contiguous_ = true;
distributed_ = checkIsDist ();
// Create the Directory on demand in getRemoteIndexList().
//setupDirectory ();
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
global_size_t
Map<LocalOrdinal,GlobalOrdinal,Node>::
initialNonuniformDebugCheck (const global_size_t numGlobalElements,
const size_t numLocalElements,
const GlobalOrdinal indexBase,
const Teuchos::RCP<const Teuchos::Comm<int> >& comm) const
{
#ifdef HAVE_TPETRA_DEBUG
using Teuchos::broadcast;
using Teuchos::outArg;
using Teuchos::ptr;
using Teuchos::REDUCE_MAX;
using Teuchos::REDUCE_MIN;
using Teuchos::REDUCE_SUM;
using Teuchos::reduceAll;
typedef GlobalOrdinal GO;
typedef global_size_t GST;
const GST GSTI = Tpetra::Details::OrdinalTraits<GST>::invalid ();
// The user has specified the distribution of indices over the
// processes. The distribution is not necessarily contiguous or
// equally shared over the processes.
//
// We assume that the number of local elements can be stored in a
// size_t. The instance member numLocalElements_ is a size_t, so
// this variable and that should have the same type.
GST debugGlobalSum = 0; // Will be global sum of numLocalElements
reduceAll<int, GST> (*comm, REDUCE_SUM, static_cast<GST> (numLocalElements),
outArg (debugGlobalSum));
// In debug mode only, check whether numGlobalElements and
// indexBase are the same over all processes in the communicator.
{
GST proc0NumGlobalElements = numGlobalElements;
broadcast<int, GST> (*comm_, 0, outArg (proc0NumGlobalElements));
GST minNumGlobalElements = numGlobalElements;
GST maxNumGlobalElements = numGlobalElements;
reduceAll<int, GST> (*comm, REDUCE_MIN, numGlobalElements,
outArg (minNumGlobalElements));
reduceAll<int, GST> (*comm, REDUCE_MAX, numGlobalElements,
outArg (maxNumGlobalElements));
TEUCHOS_TEST_FOR_EXCEPTION(
minNumGlobalElements != maxNumGlobalElements ||
numGlobalElements != minNumGlobalElements,
std::invalid_argument,
"Tpetra::Map constructor: All processes must provide the same number "
"of global elements. This is true even if that argument is Teuchos::"
"OrdinalTraits<global_size_t>::invalid() to signal that the Map should "
"compute the global number of elements. Process 0 set numGlobalElements"
" = " << proc0NumGlobalElements << ". The calling process "
<< comm->getRank () << " set numGlobalElements = " << numGlobalElements
<< ". The min and max values over all processes are "
<< minNumGlobalElements << " resp. " << maxNumGlobalElements << ".");
GO proc0IndexBase = indexBase;
broadcast<int, GO> (*comm_, 0, outArg (proc0IndexBase));
GO minIndexBase = indexBase;
GO maxIndexBase = indexBase;
reduceAll<int, GO> (*comm, REDUCE_MIN, indexBase, outArg (minIndexBase));
reduceAll<int, GO> (*comm, REDUCE_MAX, indexBase, outArg (maxIndexBase));
TEUCHOS_TEST_FOR_EXCEPTION(
minIndexBase != maxIndexBase || indexBase != minIndexBase,
std::invalid_argument,
"Tpetra::Map constructor: "
"All processes must provide the same indexBase argument. "
"Process 0 set indexBase = " << proc0IndexBase << ". The calling "
"process " << comm->getRank () << " set indexBase = " << indexBase
<< ". The min and max values over all processes are "
<< minIndexBase << " resp. " << maxIndexBase << ".");
// Make sure that the sum of numLocalElements over all processes
// equals numGlobalElements.
TEUCHOS_TEST_FOR_EXCEPTION
(numGlobalElements != GSTI && debugGlobalSum != numGlobalElements,
std::invalid_argument, "Tpetra::Map constructor: The sum of each "
"process' number of indices over all processes, " << debugGlobalSum
<< " != numGlobalElements = " << numGlobalElements << ". If you "
"would like this constructor to compute numGlobalElements for you, "
"you may set numGlobalElements = "
"Teuchos::OrdinalTraits<Tpetra::global_size_t>::invalid() on input. "
"Please note that this is NOT necessarily -1.");
}
return debugGlobalSum;
#else
return static_cast<global_size_t> (0);
#endif // HAVE_TPETRA_DEBUG
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
void
Map<LocalOrdinal,GlobalOrdinal,Node>::
initWithNonownedHostIndexList (const global_size_t numGlobalElements,
const Kokkos::View<const GlobalOrdinal*,
Kokkos::LayoutLeft,
Kokkos::HostSpace,
Kokkos::MemoryUnmanaged>& entryList_host,
const GlobalOrdinal indexBase,
const Teuchos::RCP<const Teuchos::Comm<int> >& comm)
{
using Kokkos::LayoutLeft;
using Kokkos::subview;
using Kokkos::View;
using Teuchos::as;
using Teuchos::broadcast;
using Teuchos::outArg;
using Teuchos::ptr;
using Teuchos::REDUCE_MAX;
using Teuchos::REDUCE_MIN;
using Teuchos::REDUCE_SUM;
using Teuchos::reduceAll;
typedef LocalOrdinal LO;
typedef GlobalOrdinal GO;
typedef global_size_t GST;
const GST GSTI = Tpetra::Details::OrdinalTraits<GST>::invalid ();
// Make sure that Kokkos has been initialized (Github Issue #513).
TEUCHOS_TEST_FOR_EXCEPTION
(! execution_space::is_initialized (), std::runtime_error,
"Tpetra::Map constructor: The Kokkos execution space has not been "
"initialized. Please initialize it before creating a Map.")
// The user has specified the distribution of indices over the
// processes, via the input array of global indices on each
// process. The distribution is not necessarily contiguous or
// equally shared over the processes.
// The length of the input array on this process is the number of
// local indices to associate with this process, even though the
// input array contains global indices. We assume that the number
// of local indices on a process can be stored in a size_t;
// numLocalElements_ is a size_t, so this variable and that should
// have the same type.
const size_t numLocalElements = static_cast<size_t> (entryList_host.size ());
initialNonuniformDebugCheck (numGlobalElements, numLocalElements,
indexBase, comm);
// NOTE (mfh 20 Feb 2013, 10 Oct 2016) In some sense, this global
// reduction is redundant, since the directory Map will have to do
// the same thing. Thus, we could do the scan and broadcast for
// the directory Map here, and give the computed offsets to the
// directory Map's constructor. However, a reduction costs less
// than a scan and broadcast, so this still saves time if users of
// this Map don't ever need the Directory (i.e., if they never
// call getRemoteIndexList on this Map).
if (numGlobalElements != GSTI) {
numGlobalElements_ = numGlobalElements; // Use the user's value.
}
else { // The user wants us to compute the sum.
reduceAll<int, GST> (*comm, REDUCE_SUM,
static_cast<GST> (numLocalElements),
outArg (numGlobalElements_));
}
// mfh 20 Feb 2013: We've never quite done the right thing for
// duplicate GIDs here. Duplicate GIDs have always been counted
// distinctly in numLocalElements_, and thus should get a
// different LID. However, we've always used std::map or a hash
// table for the GID -> LID lookup table, so distinct GIDs always
// map to the same LID. Furthermore, the order of the input GID
// list matters, so it's not desirable to sort for determining
// uniqueness.
//
// I've chosen for now to write this code as if the input GID list
// contains no duplicates. If this is not desired, we could use
// the lookup table itself to determine uniqueness: If we haven't
// seen the GID before, it gets a new LID and it's added to the
// LID -> GID and GID -> LID tables. If we have seen the GID
// before, it doesn't get added to either table. I would
// implement this, but it would cost more to do the double lookups
// in the table (one to check, and one to insert).
//
// More importantly, since we build the GID -> LID table in (a
// thread-) parallel (way), the order in which duplicate GIDs may
// get inserted is not defined. This would make the assignment of
// LID to GID nondeterministic.
numLocalElements_ = numLocalElements;
indexBase_ = indexBase;
minMyGID_ = indexBase_;
maxMyGID_ = indexBase_;
// NOTE (mfh 27 May 2015): While finding the initial contiguous
// GID range requires looking at all the GIDs in the range,
// dismissing an interval of GIDs only requires looking at the
// first and last GIDs. Thus, we could do binary search backwards
// from the end in order to catch the common case of a contiguous
// interval followed by noncontiguous entries. On the other hand,
// we could just expose this case explicitly as yet another Map
// constructor, and avoid the trouble of detecting it.
if (numLocalElements_ > 0) {
// Find contiguous GID range, with the restriction that the
// beginning of the range starts with the first entry. While
// doing so, fill in the LID -> GID table.
View<GO*, LayoutLeft, device_type> lgMap ("lgMap", numLocalElements_);
auto lgMap_host = Kokkos::create_mirror_view (lgMap);
// The input array entryList_host is already on host, so we
// don't need to take a host view of it.
// auto entryList_host = Kokkos::create_mirror_view (entryList);
// Kokkos::deep_copy (entryList_host, entryList);
firstContiguousGID_ = entryList_host[0];
lastContiguousGID_ = firstContiguousGID_+1;
// FIXME (mfh 23 Sep 2015) We need to copy the input GIDs
// anyway, so we have to look at them all. The logical way to
// find the first noncontiguous entry would thus be to "reduce,"
// where the local reduction result is whether entryList[i] + 1
// == entryList[i+1].
lgMap_host[0] = firstContiguousGID_;
size_t i = 1;
for ( ; i < numLocalElements_; ++i) {
const GO curGid = entryList_host[i];
const LO curLid = as<LO> (i);
if (lastContiguousGID_ != curGid) break;
// Add the entry to the LID->GID table only after we know that
// the current GID is in the initial contiguous sequence, so
// that we don't repeat adding it in the first iteration of
// the loop below over the remaining noncontiguous GIDs.
lgMap_host[curLid] = curGid;
++lastContiguousGID_;
}
--lastContiguousGID_;
// [firstContiguousGID_, lastContigousGID_] is the initial
// sequence of contiguous GIDs. We can start the min and max
// GID using this range.
minMyGID_ = firstContiguousGID_;
maxMyGID_ = lastContiguousGID_;
// Compute the GID -> LID lookup table, _not_ including the
// initial sequence of contiguous GIDs.
{
const std::pair<size_t, size_t> ncRange (i, entryList_host.dimension_0 ());
auto nonContigGids_host = subview (entryList_host, ncRange);
TEUCHOS_TEST_FOR_EXCEPTION
(static_cast<size_t> (nonContigGids_host.dimension_0 ()) !=
static_cast<size_t> (entryList_host.dimension_0 () - i),
std::logic_error, "Tpetra::Map noncontiguous constructor: "
"nonContigGids_host.dimension_0() = "
<< nonContigGids_host.dimension_0 ()
<< " != entryList_host.dimension_0() - i = "
<< (entryList_host.dimension_0 () - i) << " = "
<< entryList_host.dimension_0 () << " - " << i
<< ". Please report this bug to the Tpetra developers.");
// FixedHashTable's constructor expects an owned device View,
// so we must deep-copy the subview of the input indices.
View<GO*, LayoutLeft, device_type>
nonContigGids ("nonContigGids", nonContigGids_host.size ());
Kokkos::deep_copy (nonContigGids, nonContigGids_host);
glMap_ = global_to_local_table_type (nonContigGids,
firstContiguousGID_,
lastContiguousGID_,
static_cast<LO> (i));
}
// FIXME (mfh 10 Oct 2016) When we construct the global-to-local
// table above, we have to look at all the (noncontiguous) input
// indices anyway. Thus, why not have the constructor compute
// and return the min and max?
for ( ; i < numLocalElements_; ++i) {
const GO curGid = entryList_host[i];
const LO curLid = as<LO> (i);
lgMap_host[curLid] = curGid; // LID -> GID table
// While iterating through entryList, we compute its
// (process-local) min and max elements.
if (curGid < minMyGID_) {
minMyGID_ = curGid;
}
if (curGid > maxMyGID_) {
maxMyGID_ = curGid;
}
}
// We filled lgMap on host above; now sync back to device.
Kokkos::deep_copy (lgMap, lgMap_host);
// "Commit" the local-to-global lookup table we filled in above.
lgMap_ = lgMap;
// We've already created this, so use it.
lgMapHost_ = lgMap_host;
}
else {
// This insures tests for GIDs in the range
// [firstContiguousGID_, lastContiguousGID_] fail for processes
// with no local elements.
firstContiguousGID_ = indexBase_+1;
lastContiguousGID_ = indexBase_;
// glMap_ was default constructed, so it's already empty.
}
// Compute the min and max of all processes' GIDs. If
// numLocalElements_ == 0 on this process, minMyGID_ and maxMyGID_
// are both indexBase_. This is wrong, but fixing it would
// require either a fancy sparse all-reduce, or a custom reduction
// operator that ignores invalid values ("invalid" means
// Tpetra::Details::OrdinalTraits<GO>::invalid()).
//
// Also, while we're at it, use the same all-reduce to figure out
// if the Map is distributed. "Distributed" means that there is
// at least one process with a number of local elements less than
// the number of global elements.
//
// We're computing the min and max of all processes' GIDs using a
// single MAX all-reduce, because min(x,y) = -max(-x,-y) (when x
// and y are signed). (This lets us combine the min and max into
// a single all-reduce.) If each process sets localDist=1 if its
// number of local elements is strictly less than the number of
// global elements, and localDist=0 otherwise, then a MAX
// all-reduce on localDist tells us if the Map is distributed (1
// if yes, 0 if no). Thus, we can append localDist onto the end
// of the data and get the global result from the all-reduce.
if (std::numeric_limits<GO>::is_signed) {
// Does my process NOT own all the elements?
const GO localDist =
(as<GST> (numLocalElements_) < numGlobalElements_) ? 1 : 0;
GO minMaxInput[3];
minMaxInput[0] = -minMyGID_;
minMaxInput[1] = maxMyGID_;
minMaxInput[2] = localDist;
GO minMaxOutput[3];
minMaxOutput[0] = 0;
minMaxOutput[1] = 0;
minMaxOutput[2] = 0;
reduceAll<int, GO> (*comm, REDUCE_MAX, 3, minMaxInput, minMaxOutput);
minAllGID_ = -minMaxOutput[0];
maxAllGID_ = minMaxOutput[1];
const GO globalDist = minMaxOutput[2];
distributed_ = (comm_->getSize () > 1 && globalDist == 1);
}
else { // unsigned; use two reductions
// This is always correct, no matter the signedness of GO.
reduceAll<int, GO> (*comm_, REDUCE_MIN, minMyGID_, outArg (minAllGID_));
reduceAll<int, GO> (*comm_, REDUCE_MAX, maxMyGID_, outArg (maxAllGID_));
distributed_ = checkIsDist ();
}
contiguous_ = false; // "Contiguous" is conservative.
TEUCHOS_TEST_FOR_EXCEPTION(
minAllGID_ < indexBase_,
std::invalid_argument,
"Tpetra::Map constructor (noncontiguous): "
"Minimum global ID = " << minAllGID_ << " over all process(es) is "
"less than the given indexBase = " << indexBase_ << ".");
// Create the Directory on demand in getRemoteIndexList().
//setupDirectory ();
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Map<LocalOrdinal,GlobalOrdinal,Node>::
Map (const global_size_t numGlobalElements,
const GlobalOrdinal indexList[],
const LocalOrdinal indexListSize,
const GlobalOrdinal indexBase,
const Teuchos::RCP<const Teuchos::Comm<int> >& comm) :
comm_ (comm),
node_ (defaultArgNode<Node> ()),
uniform_ (false),
directory_ (new Directory<LocalOrdinal, GlobalOrdinal, Node> ())
{
// Make sure that Kokkos has been initialized (Github Issue #513).
TEUCHOS_TEST_FOR_EXCEPTION
(! execution_space::is_initialized (), std::runtime_error,
"Tpetra::Map constructor: The Kokkos execution space has not been "
"initialized. Please initialize it before creating a Map.")
// Not quite sure if I trust all code to behave correctly if the
// pointer is nonnull but the array length is nonzero, so I'll
// make sure the raw pointer is null if the length is zero.
const GlobalOrdinal* const indsRaw = indexListSize == 0 ? NULL : indexList;
Kokkos::View<const GlobalOrdinal*,
Kokkos::LayoutLeft,
Kokkos::HostSpace,
Kokkos::MemoryUnmanaged> inds (indsRaw, indexListSize);
initWithNonownedHostIndexList (numGlobalElements, inds, indexBase, comm);
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Map<LocalOrdinal,GlobalOrdinal,Node>::
Map (const global_size_t numGlobalElements,
const Teuchos::ArrayView<const GlobalOrdinal>& entryList,
const GlobalOrdinal indexBase,
const Teuchos::RCP<const Teuchos::Comm<int> >& comm,
const Teuchos::RCP<Node>& node) :
comm_ (comm),
node_ (node),
uniform_ (false),
directory_ (new Directory<LocalOrdinal, GlobalOrdinal, Node> ())
{
// Make sure that Kokkos has been initialized (Github Issue #513).
TEUCHOS_TEST_FOR_EXCEPTION
(! execution_space::is_initialized (), std::runtime_error,
"Tpetra::Map constructor: The Kokkos execution space has not been "
"initialized. Please initialize it before creating a Map.")
const size_t numLclInds = static_cast<size_t> (entryList.size ());
// Not quite sure if I trust both ArrayView and View to behave
// correctly if the pointer is nonnull but the array length is
// nonzero, so I'll make sure it's null if the length is zero.
const GlobalOrdinal* const indsRaw =
numLclInds == 0 ? NULL : entryList.getRawPtr ();
Kokkos::View<const GlobalOrdinal*,
Kokkos::LayoutLeft,
Kokkos::HostSpace,
Kokkos::MemoryUnmanaged> inds (indsRaw, numLclInds);
initWithNonownedHostIndexList (numGlobalElements, inds, indexBase, comm);
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Map<LocalOrdinal,GlobalOrdinal,Node>::
Map (const global_size_t numGlobalElements,
const Kokkos::View<const GlobalOrdinal*, device_type>& entryList,
const GlobalOrdinal indexBase,
const Teuchos::RCP<const Teuchos::Comm<int> >& comm) :
comm_ (comm),
node_ (defaultArgNode<Node> ()),
uniform_ (false),
directory_ (new Directory<LocalOrdinal, GlobalOrdinal, Node> ())
{
using Kokkos::LayoutLeft;
using Kokkos::subview;
using Kokkos::View;
using Teuchos::arcp;
using Teuchos::ArrayView;
using Teuchos::as;
using Teuchos::broadcast;
using Teuchos::outArg;
using Teuchos::ptr;
using Teuchos::REDUCE_MAX;
using Teuchos::REDUCE_MIN;
using Teuchos::REDUCE_SUM;
using Teuchos::reduceAll;
using Teuchos::typeName;
typedef LocalOrdinal LO;
typedef GlobalOrdinal GO;
typedef global_size_t GST;
const GST GSTI = Tpetra::Details::OrdinalTraits<GST>::invalid ();
// Make sure that Kokkos has been initialized (Github Issue #513).
TEUCHOS_TEST_FOR_EXCEPTION
(! execution_space::is_initialized (), std::runtime_error,
"Tpetra::Map constructor: The Kokkos execution space has not been "
"initialized. Please initialize it before creating a Map.")
// The user has specified the distribution of indices over the
// processes, via the input array of global indices on each
// process. The distribution is not necessarily contiguous or
// equally shared over the processes.
// The length of the input array on this process is the number of
// local indices to associate with this process, even though the
// input array contains global indices. We assume that the number
// of local indices on a process can be stored in a size_t;
// numLocalElements_ is a size_t, so this variable and that should
// have the same type.
const size_t numLocalElements = static_cast<size_t> (entryList.size ());
initialNonuniformDebugCheck (numGlobalElements, numLocalElements,
indexBase, comm);
// NOTE (mfh 20 Feb 2013, 10 Oct 2016) In some sense, this global
// reduction is redundant, since the directory Map will have to do
// the same thing. Thus, we could do the scan and broadcast for
// the directory Map here, and give the computed offsets to the
// directory Map's constructor. However, a reduction costs less
// than a scan and broadcast, so this still saves time if users of
// this Map don't ever need the Directory (i.e., if they never
// call getRemoteIndexList on this Map).
if (numGlobalElements != GSTI) {
numGlobalElements_ = numGlobalElements; // Use the user's value.
}
else { // The user wants us to compute the sum.
reduceAll<int, GST> (*comm, REDUCE_SUM,
static_cast<GST> (numLocalElements),
outArg (numGlobalElements_));
}
// mfh 20 Feb 2013: We've never quite done the right thing for
// duplicate GIDs here. Duplicate GIDs have always been counted
// distinctly in numLocalElements_, and thus should get a
// different LID. However, we've always used std::map or a hash
// table for the GID -> LID lookup table, so distinct GIDs always
// map to the same LID. Furthermore, the order of the input GID
// list matters, so it's not desirable to sort for determining
// uniqueness.
//
// I've chosen for now to write this code as if the input GID list
// contains no duplicates. If this is not desired, we could use
// the lookup table itself to determine uniqueness: If we haven't
// seen the GID before, it gets a new LID and it's added to the
// LID -> GID and GID -> LID tables. If we have seen the GID
// before, it doesn't get added to either table. I would
// implement this, but it would cost more to do the double lookups
// in the table (one to check, and one to insert).
//
// More importantly, since we build the GID -> LID table in (a
// thread-) parallel (way), the order in which duplicate GIDs may
// get inserted is not defined. This would make the assignment of
// LID to GID nondeterministic.
numLocalElements_ = numLocalElements;
indexBase_ = indexBase;
minMyGID_ = indexBase_;
maxMyGID_ = indexBase_;
// NOTE (mfh 27 May 2015): While finding the initial contiguous
// GID range requires looking at all the GIDs in the range,
// dismissing an interval of GIDs only requires looking at the
// first and last GIDs. Thus, we could do binary search backwards
// from the end in order to catch the common case of a contiguous
// interval followed by noncontiguous entries. On the other hand,
// we could just expose this case explicitly as yet another Map
// constructor, and avoid the trouble of detecting it.
if (numLocalElements_ > 0) {
// Find contiguous GID range, with the restriction that the
// beginning of the range starts with the first entry. While
// doing so, fill in the LID -> GID table.
View<GO*, LayoutLeft, device_type> lgMap ("lgMap", numLocalElements_);
auto lgMap_host = Kokkos::create_mirror_view (lgMap);
// Creating the mirror view is trivial, and the deep_copy is a
// no-op, if entryList is on host already.
auto entryList_host = Kokkos::create_mirror_view (entryList);
Kokkos::deep_copy (entryList_host, entryList);
firstContiguousGID_ = entryList_host[0];
lastContiguousGID_ = firstContiguousGID_+1;
// FIXME (mfh 23 Sep 2015) We need to copy the input GIDs
// anyway, so we have to look at them all. The logical way to
// find the first noncontiguous entry would thus be to "reduce,"
// where the local reduction result is whether entryList[i] + 1
// == entryList[i+1].
lgMap_host[0] = firstContiguousGID_;
size_t i = 1;
for ( ; i < numLocalElements_; ++i) {
const GO curGid = entryList_host[i];
const LO curLid = as<LO> (i);
if (lastContiguousGID_ != curGid) break;
// Add the entry to the LID->GID table only after we know that
// the current GID is in the initial contiguous sequence, so
// that we don't repeat adding it in the first iteration of
// the loop below over the remaining noncontiguous GIDs.
lgMap_host[curLid] = curGid;
++lastContiguousGID_;
}
--lastContiguousGID_;
// [firstContiguousGID_, lastContigousGID_] is the initial
// sequence of contiguous GIDs. We can start the min and max
// GID using this range.
minMyGID_ = firstContiguousGID_;
maxMyGID_ = lastContiguousGID_;
// Compute the GID -> LID lookup table, _not_ including the
// initial sequence of contiguous GIDs.
{
const std::pair<size_t, size_t> ncRange (i, entryList.dimension_0 ());
auto nonContigGids = subview (entryList, ncRange);
TEUCHOS_TEST_FOR_EXCEPTION
(static_cast<size_t> (nonContigGids.dimension_0 ()) !=
static_cast<size_t> (entryList.dimension_0 () - i),
std::logic_error, "Tpetra::Map noncontiguous constructor: "
"nonContigGids.dimension_0() = "
<< nonContigGids.dimension_0 ()
<< " != entryList.dimension_0() - i = "
<< (entryList.dimension_0 () - i) << " = "
<< entryList.dimension_0 () << " - " << i
<< ". Please report this bug to the Tpetra developers.");
glMap_ = global_to_local_table_type (nonContigGids,
firstContiguousGID_,
lastContiguousGID_,
static_cast<LO> (i));
}
// FIXME (mfh 10 Oct 2016) When we construct the global-to-local
// table above, we have to look at all the (noncontiguous) input
// indices anyway. Thus, why not have the constructor compute
// and return the min and max?
for ( ; i < numLocalElements_; ++i) {
const GO curGid = entryList_host[i];
const LO curLid = static_cast<LO> (i);
lgMap_host[curLid] = curGid; // LID -> GID table
// While iterating through entryList, we compute its
// (process-local) min and max elements.
if (curGid < minMyGID_) {
minMyGID_ = curGid;
}
if (curGid > maxMyGID_) {
maxMyGID_ = curGid;
}
}
// We filled lgMap on host above; now sync back to device.
Kokkos::deep_copy (lgMap, lgMap_host);
// "Commit" the local-to-global lookup table we filled in above.
lgMap_ = lgMap;
// We've already created this, so use it.
lgMapHost_ = lgMap_host;
}
else {
// This insures tests for GIDs in the range
// [firstContiguousGID_, lastContiguousGID_] fail for processes
// with no local elements.
firstContiguousGID_ = indexBase_+1;
lastContiguousGID_ = indexBase_;
// glMap_ was default constructed, so it's already empty.
}
// Compute the min and max of all processes' GIDs. If
// numLocalElements_ == 0 on this process, minMyGID_ and maxMyGID_
// are both indexBase_. This is wrong, but fixing it would
// require either a fancy sparse all-reduce, or a custom reduction
// operator that ignores invalid values ("invalid" means
// Tpetra::Details::OrdinalTraits<GO>::invalid()).
//
// Also, while we're at it, use the same all-reduce to figure out
// if the Map is distributed. "Distributed" means that there is
// at least one process with a number of local elements less than
// the number of global elements.
//
// We're computing the min and max of all processes' GIDs using a
// single MAX all-reduce, because min(x,y) = -max(-x,-y) (when x
// and y are signed). (This lets us combine the min and max into
// a single all-reduce.) If each process sets localDist=1 if its
// number of local elements is strictly less than the number of
// global elements, and localDist=0 otherwise, then a MAX
// all-reduce on localDist tells us if the Map is distributed (1
// if yes, 0 if no). Thus, we can append localDist onto the end
// of the data and get the global result from the all-reduce.
if (std::numeric_limits<GO>::is_signed) {
// Does my process NOT own all the elements?
const GO localDist =
(as<GST> (numLocalElements_) < numGlobalElements_) ? 1 : 0;
GO minMaxInput[3];
minMaxInput[0] = -minMyGID_;
minMaxInput[1] = maxMyGID_;
minMaxInput[2] = localDist;
GO minMaxOutput[3];
minMaxOutput[0] = 0;
minMaxOutput[1] = 0;
minMaxOutput[2] = 0;
reduceAll<int, GO> (*comm, REDUCE_MAX, 3, minMaxInput, minMaxOutput);
minAllGID_ = -minMaxOutput[0];
maxAllGID_ = minMaxOutput[1];
const GO globalDist = minMaxOutput[2];
distributed_ = (comm_->getSize () > 1 && globalDist == 1);
}
else { // unsigned; use two reductions
// This is always correct, no matter the signedness of GO.
reduceAll<int, GO> (*comm_, REDUCE_MIN, minMyGID_, outArg (minAllGID_));
reduceAll<int, GO> (*comm_, REDUCE_MAX, maxMyGID_, outArg (maxAllGID_));
distributed_ = checkIsDist ();
}
contiguous_ = false; // "Contiguous" is conservative.
TEUCHOS_TEST_FOR_EXCEPTION(
minAllGID_ < indexBase_,
std::invalid_argument,
"Tpetra::Map constructor (noncontiguous): "
"Minimum global ID = " << minAllGID_ << " over all process(es) is "
"less than the given indexBase = " << indexBase_ << ".");
// Create the Directory on demand in getRemoteIndexList().
//setupDirectory ();
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Map<LocalOrdinal,GlobalOrdinal,Node>::~Map ()
{}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
bool
Map<LocalOrdinal,GlobalOrdinal,Node>::isOneToOne () const
{
TEUCHOS_TEST_FOR_EXCEPTION(
getComm ().is_null (), std::logic_error, "Tpetra::Map::isOneToOne: "
"getComm() returns null. Please report this bug to the Tpetra "
"developers.");
// This is a collective operation, if it hasn't been called before.
setupDirectory ();
return directory_->isOneToOne (*this);
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
LocalOrdinal
Map<LocalOrdinal,GlobalOrdinal,Node>::
getLocalElement (GlobalOrdinal globalIndex) const
{
if (isContiguous ()) {
if (globalIndex < getMinGlobalIndex () ||
globalIndex > getMaxGlobalIndex ()) {
return Tpetra::Details::OrdinalTraits<LocalOrdinal>::invalid ();
}
return static_cast<LocalOrdinal> (globalIndex - getMinGlobalIndex ());
}
else if (globalIndex >= firstContiguousGID_ &&
globalIndex <= lastContiguousGID_) {
return static_cast<LocalOrdinal> (globalIndex - firstContiguousGID_);
}
else {
// If the given global index is not in the table, this returns
// the same value as OrdinalTraits<LocalOrdinal>::invalid().
return glMap_.get (globalIndex);
}
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
GlobalOrdinal
Map<LocalOrdinal,GlobalOrdinal,Node>::
getGlobalElement (LocalOrdinal localIndex) const
{
if (localIndex < getMinLocalIndex () || localIndex > getMaxLocalIndex ()) {
return Tpetra::Details::OrdinalTraits<GlobalOrdinal>::invalid ();
}
if (isContiguous ()) {
return getMinGlobalIndex () + localIndex;
}
else {
// This is a host Kokkos::View access, with no RCP or ArrayRCP
// involvement. As a result, it is thread safe.
//
// lgMapHost_ is a host pointer; this does NOT assume UVM.
return lgMapHost_[localIndex];
}
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
bool
Map<LocalOrdinal,GlobalOrdinal,Node>::
isNodeLocalElement (LocalOrdinal localIndex) const
{
if (localIndex < getMinLocalIndex () || localIndex > getMaxLocalIndex ()) {
return false;
} else {
return true;
}
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
bool
Map<LocalOrdinal,GlobalOrdinal,Node>::
isNodeGlobalElement (GlobalOrdinal globalIndex) const {
return this->getLocalElement (globalIndex) !=
Tpetra::Details::OrdinalTraits<LocalOrdinal>::invalid ();
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
bool Map<LocalOrdinal,GlobalOrdinal,Node>::isUniform () const {
return uniform_;
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
bool Map<LocalOrdinal,GlobalOrdinal,Node>::isContiguous () const {
return contiguous_;
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
typename Map<LocalOrdinal,GlobalOrdinal,Node>::local_map_type
Map<LocalOrdinal,GlobalOrdinal,Node>::
getLocalMap () const
{
return local_map_type (glMap_, lgMap_, getIndexBase (),
getMinGlobalIndex (), getMaxGlobalIndex (),
firstContiguousGID_, lastContiguousGID_,
getNodeNumElements (), isContiguous ());
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
bool
Map<LocalOrdinal,GlobalOrdinal,Node>::
isCompatible (const Map<LocalOrdinal,GlobalOrdinal,Node> &map) const
{
using Teuchos::outArg;
using Teuchos::REDUCE_MIN;
using Teuchos::reduceAll;
//
// Tests that avoid the Boolean all-reduce below by using
// globally consistent quantities.
//
if (this == &map) {
// Pointer equality on one process always implies pointer
// equality on all processes, since Map is immutable.
return true;
}
else if (getComm ()->getSize () != map.getComm ()->getSize ()) {
// The two communicators have different numbers of processes.
// It's not correct to call isCompatible() in that case. This
// may result in the all-reduce hanging below.
return false;
}
else if (getGlobalNumElements () != map.getGlobalNumElements ()) {
// Two Maps are definitely NOT compatible if they have different
// global numbers of indices.
return false;
}
else if (isContiguous () && isUniform () &&
map.isContiguous () && map.isUniform ()) {
// Contiguous uniform Maps with the same number of processes in
// their communicators, and with the same global numbers of
// indices, are always compatible.
return true;
}
else if (! isContiguous () && ! map.isContiguous () &&
lgMap_.dimension_0 () != 0 && map.lgMap_.dimension_0 () != 0 &&
lgMap_.ptr_on_device () == map.lgMap_.ptr_on_device ()) {
// Noncontiguous Maps whose global index lists are nonempty and
// have the same pointer must be the same (and therefore
// contiguous).
//
// Nonempty is important. For example, consider a communicator
// with two processes, and two Maps that share this
// communicator, with zero global indices on the first process,
// and different nonzero numbers of global indices on the second
// process. In that case, on the first process, the pointers
// would both be NULL.
return true;
}
TEUCHOS_TEST_FOR_EXCEPTION(
getGlobalNumElements () != map.getGlobalNumElements (), std::logic_error,
"Tpetra::Map::isCompatible: There's a bug in this method. We've already "
"checked that this condition is true above, but it's false here. "
"Please report this bug to the Tpetra developers.");
// Do both Maps have the same number of indices on each process?
const int locallyCompat =
(getNodeNumElements () == map.getNodeNumElements ()) ? 1 : 0;
int globallyCompat = 0;
reduceAll<int, int> (*comm_, REDUCE_MIN, locallyCompat, outArg (globallyCompat));
return (globallyCompat == 1);
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
bool
Map<LocalOrdinal,GlobalOrdinal,Node>::
locallySameAs (const Map<LocalOrdinal, GlobalOrdinal, Node>& map) const
{
using Teuchos::ArrayView;
typedef GlobalOrdinal GO;
typedef typename ArrayView<const GO>::size_type size_type;
// If both Maps are contiguous, we can compare their GID ranges
// easily by looking at the min and max GID on this process.
// Otherwise, we'll compare their GID lists. If only one Map is
// contiguous, then we only have to call getNodeElementList() on
// the noncontiguous Map. (It's best to avoid calling it on a
// contiguous Map, since it results in unnecessary storage that
// persists for the lifetime of the Map.)
if (this == &map) {
// Pointer equality on one process always implies pointer
// equality on all processes, since Map is immutable.
return true;
}
else if (getNodeNumElements () != map.getNodeNumElements ()) {
return false;
}
else if (getMinGlobalIndex () != map.getMinGlobalIndex () ||
getMaxGlobalIndex () != map.getMaxGlobalIndex ()) {
return false;
}
else {
if (isContiguous ()) {
if (map.isContiguous ()) {
return true; // min and max match, so the ranges match.
}
else { // *this is contiguous, but map is not contiguous
TEUCHOS_TEST_FOR_EXCEPTION(
! this->isContiguous () || map.isContiguous (), std::logic_error,
"Tpetra::Map::locallySameAs: BUG");
ArrayView<const GO> rhsElts = map.getNodeElementList ();
const GO minLhsGid = this->getMinGlobalIndex ();
const size_type numRhsElts = rhsElts.size ();
for (size_type k = 0; k < numRhsElts; ++k) {
const GO curLhsGid = minLhsGid + static_cast<GO> (k);
if (curLhsGid != rhsElts[k]) {
return false; // stop on first mismatch
}
}
return true;
}
}
else if (map.isContiguous ()) { // *this is not contiguous, but map is
TEUCHOS_TEST_FOR_EXCEPTION(
this->isContiguous () || ! map.isContiguous (), std::logic_error,
"Tpetra::Map::locallySameAs: BUG");
ArrayView<const GO> lhsElts = this->getNodeElementList ();
const GO minRhsGid = map.getMinGlobalIndex ();
const size_type numLhsElts = lhsElts.size ();
for (size_type k = 0; k < numLhsElts; ++k) {
const GO curRhsGid = minRhsGid + static_cast<GO> (k);
if (curRhsGid != lhsElts[k]) {
return false; // stop on first mismatch
}
}
return true;
}
else if (this->lgMap_.ptr_on_device () == map.lgMap_.ptr_on_device ()) {
// Pointers to LID->GID "map" (actually just an array) are the
// same, and the number of GIDs are the same.
return this->getNodeNumElements () == map.getNodeNumElements ();
}
else { // we actually have to compare the GIDs
if (this->getNodeNumElements () != map.getNodeNumElements ()) {
return false; // We already checked above, but check just in case
}
else {
ArrayView<const GO> lhsElts = getNodeElementList ();
ArrayView<const GO> rhsElts = map.getNodeElementList ();
// std::equal requires that the latter range is as large as
// the former. We know the ranges have equal length, because
// they have the same number of local entries.
return std::equal (lhsElts.begin (), lhsElts.end (), rhsElts.begin ());
}
}
}
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
bool
Map<LocalOrdinal,GlobalOrdinal,Node>::
isSameAs (const Map<LocalOrdinal,GlobalOrdinal,Node> &map) const
{
using Teuchos::outArg;
using Teuchos::REDUCE_MIN;
using Teuchos::reduceAll;
//
// Tests that avoid the Boolean all-reduce below by using
// globally consistent quantities.
//
if (this == &map) {
// Pointer equality on one process always implies pointer
// equality on all processes, since Map is immutable.
return true;
}
else if (getComm ()->getSize () != map.getComm ()->getSize ()) {
// The two communicators have different numbers of processes.
// It's not correct to call isSameAs() in that case. This
// may result in the all-reduce hanging below.
return false;
}
else if (getGlobalNumElements () != map.getGlobalNumElements ()) {
// Two Maps are definitely NOT the same if they have different
// global numbers of indices.
return false;
}
else if (getMinAllGlobalIndex () != map.getMinAllGlobalIndex () ||
getMaxAllGlobalIndex () != map.getMaxAllGlobalIndex () ||
getIndexBase () != map.getIndexBase ()) {
// If the global min or max global index doesn't match, or if
// the index base doesn't match, then the Maps aren't the same.
return false;
}
else if (isDistributed () != map.isDistributed ()) {
// One Map is distributed and the other is not, which means that
// the Maps aren't the same.
return false;
}
else if (isContiguous () && isUniform () &&
map.isContiguous () && map.isUniform ()) {
// Contiguous uniform Maps with the same number of processes in
// their communicators, with the same global numbers of indices,
// and with matching index bases and ranges, must be the same.
return true;
}
// The two communicators must have the same number of processes,
// with process ranks occurring in the same order. This uses
// MPI_COMM_COMPARE. The MPI 3.1 standard (Section 6.4) says:
// "Operations that access communicators are local and their
// execution does not require interprocess communication."
// However, just to be sure, I'll put this call after the above
// tests that don't communicate.
if (! Details::congruent (*comm_, * (map.getComm ()))) {
return false;
}
// If we get this far, we need to check local properties and then
// communicate local sameness across all processes.
const int isSame_lcl = locallySameAs (map) ? 1 : 0;
// Return true if and only if all processes report local sameness.
int isSame_gbl = 0;
reduceAll<int, int> (*comm_, REDUCE_MIN, isSame_lcl, outArg (isSame_gbl));
return isSame_gbl == 1;
}
namespace { // (anonymous)
template <class LO, class GO, class DT>
class FillLgMap {
public:
FillLgMap (const Kokkos::View<GO*, DT>& lgMap,
const GO startGid) :
lgMap_ (lgMap), startGid_ (startGid)
{
Kokkos::RangePolicy<LO, typename DT::execution_space>
range (static_cast<LO> (0), static_cast<LO> (lgMap.size ()));
Kokkos::parallel_for (range, *this);
}
KOKKOS_INLINE_FUNCTION void operator () (const LO& lid) const {
lgMap_(lid) = startGid_ + static_cast<GO> (lid);
}
private:
const Kokkos::View<GO*, DT> lgMap_;
const GO startGid_;
};
} // namespace (anonymous)
template <class LocalOrdinal, class GlobalOrdinal, class Node>
typename Map<LocalOrdinal,GlobalOrdinal,Node>::global_indices_array_type
Map<LocalOrdinal,GlobalOrdinal,Node>::getMyGlobalIndices () const
{
typedef LocalOrdinal LO;
typedef GlobalOrdinal GO;
typedef device_type DT;
typedef decltype (lgMap_) const_lg_view_type;
typedef typename const_lg_view_type::non_const_type lg_view_type;
// If the local-to-global mapping doesn't exist yet, and if we
// have local entries, then create and fill the local-to-global
// mapping.
const bool needToCreateLocalToGlobalMapping =
lgMap_.dimension_0 () == 0 && numLocalElements_ > 0;
if (needToCreateLocalToGlobalMapping) {
#ifdef HAVE_TEUCHOS_DEBUG
// The local-to-global mapping should have been set up already
// for a noncontiguous map.
TEUCHOS_TEST_FOR_EXCEPTION( ! isContiguous(), std::logic_error,
"Tpetra::Map::getNodeElementList: The local-to-global mapping (lgMap_) "
"should have been set up already for a noncontiguous Map. Please report"
" this bug to the Tpetra team.");
#endif // HAVE_TEUCHOS_DEBUG
const LO numElts = static_cast<LO> (getNodeNumElements ());
lg_view_type lgMap ("lgMap", numElts);
FillLgMap<LO, GO, DT> fillIt (lgMap, minMyGID_);
auto lgMapHost = Kokkos::create_mirror_view (lgMap);
Kokkos::deep_copy (lgMapHost, lgMap);
// "Commit" the local-to-global lookup table we filled in above.
lgMap_ = lgMap;
lgMapHost_ = lgMapHost;
}
return lgMap_;
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::ArrayView<const GlobalOrdinal>
Map<LocalOrdinal,GlobalOrdinal,Node>::getNodeElementList () const
{
typedef GlobalOrdinal GO; // convenient abbreviation
// If the local-to-global mapping doesn't exist yet, and if we
// have local entries, then create and fill the local-to-global
// mapping.
(void) this->getMyGlobalIndices ();
// This does NOT assume UVM; lgMapHost_ is a host pointer.
const GO* lgMapHostRawPtr = lgMapHost_.ptr_on_device ();
// The third argument forces ArrayView not to try to track memory
// in a debug build. We have to use it because the memory does
// not belong to a Teuchos memory management class.
return Teuchos::ArrayView<const GO> (lgMapHostRawPtr,
lgMapHost_.dimension_0 (),
Teuchos::RCP_DISABLE_NODE_LOOKUP);
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
bool Map<LocalOrdinal,GlobalOrdinal,Node>::isDistributed() const {
return distributed_;
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
std::string Map<LocalOrdinal,GlobalOrdinal,Node>::description() const {
using Teuchos::TypeNameTraits;
std::ostringstream os;
os << "Tpetra::Map: {"
<< "LocalOrdinalType: " << TypeNameTraits<LocalOrdinal>::name ()
<< ", GlobalOrdinalType: " << TypeNameTraits<GlobalOrdinal>::name ()
<< ", NodeType: " << TypeNameTraits<Node>::name ();
if (this->getObjectLabel () != "") {
os << ", Label: \"" << this->getObjectLabel () << "\"";
}
os << ", Global number of entries: " << getGlobalNumElements ()
<< ", Number of processes: " << getComm ()->getSize ()
<< ", Uniform: " << (isUniform () ? "true" : "false")
<< ", Contiguous: " << (isContiguous () ? "true" : "false")
<< ", Distributed: " << (isDistributed () ? "true" : "false")
<< "}";
return os.str ();
}
/// \brief Print the calling process' verbose describe() information
/// to the given output string.
///
/// This is an implementation detail of describe().
template <class LocalOrdinal, class GlobalOrdinal, class Node>
std::string
Map<LocalOrdinal,GlobalOrdinal,Node>::
localDescribeToString (const Teuchos::EVerbosityLevel vl) const
{
typedef LocalOrdinal LO;
using std::endl;
// This preserves current behavior of Map.
if (vl < Teuchos::VERB_HIGH) {
return std::string ();
}
auto outStringP = Teuchos::rcp (new std::ostringstream ());
Teuchos::RCP<Teuchos::FancyOStream> outp =
Teuchos::getFancyOStream (outStringP);
Teuchos::FancyOStream& out = *outp;
auto comm = this->getComm ();
const int myRank = comm->getRank ();
const int numProcs = comm->getSize ();
out << "Process " << myRank << " of " << numProcs << ":" << endl;
Teuchos::OSTab tab1 (out);
const LO numEnt = static_cast<LO> (this->getNodeNumElements ());
out << "My number of entries: " << numEnt << endl
<< "My minimum global index: " << this->getMinGlobalIndex () << endl
<< "My maximum global index: " << this->getMaxGlobalIndex () << endl;
if (vl == Teuchos::VERB_EXTREME) {
out << "My global indices: [";
const LO minLclInd = this->getMinLocalIndex ();
for (LO k = 0; k < numEnt; ++k) {
out << minLclInd + this->getGlobalElement (k);
if (k + 1 < numEnt) {
out << ", ";
}
}
out << "]" << endl;
}
out.flush (); // make sure the ostringstream got everything
return outStringP->str ();
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
void
Map<LocalOrdinal,GlobalOrdinal,Node>::
describe (Teuchos::FancyOStream &out,
const Teuchos::EVerbosityLevel verbLevel) const
{
using Teuchos::TypeNameTraits;
using Teuchos::VERB_DEFAULT;
using Teuchos::VERB_NONE;
using Teuchos::VERB_LOW;
using Teuchos::VERB_HIGH;
using std::endl;
typedef LocalOrdinal LO;
typedef GlobalOrdinal GO;
const Teuchos::EVerbosityLevel vl =
(verbLevel == VERB_DEFAULT) ? VERB_LOW : verbLevel;
if (vl == VERB_NONE) {
return; // don't print anything
}
// If this Map's Comm is null, then the Map does not participate
// in collective operations with the other processes. In that
// case, it is not even legal to call this method. The reasonable
// thing to do in that case is nothing.
auto comm = this->getComm ();
if (comm.is_null ()) {
return;
}
const int myRank = comm->getRank ();
const int numProcs = comm->getSize ();
// Only Process 0 should touch the output stream, but this method
// in general may need to do communication. Thus, we may need to
// preserve the current tab level across multiple "if (myRank ==
// 0) { ... }" inner scopes. This is why we sometimes create
// OSTab instances by pointer, instead of by value. We only need
// to create them by pointer if the tab level must persist through
// multiple inner scopes.
Teuchos::RCP<Teuchos::OSTab> tab0, tab1;
if (myRank == 0) {
// At every verbosity level but VERB_NONE, Process 0 prints.
// By convention, describe() always begins with a tab before
// printing.
tab0 = Teuchos::rcp (new Teuchos::OSTab (out));
out << "\"Tpetra::Map\":" << endl;
tab1 = Teuchos::rcp (new Teuchos::OSTab (out));
{
out << "Template parameters:" << endl;
Teuchos::OSTab tab2 (out);
out << "LocalOrdinal: " << TypeNameTraits<LO>::name () << endl
<< "GlobalOrdinal: " << TypeNameTraits<GO>::name () << endl
<< "Node: " << TypeNameTraits<Node>::name () << endl;
}
const std::string label = this->getObjectLabel ();
if (label != "") {
out << "Label: \"" << label << "\"" << endl;
}
out << "Global number of entries: " << getGlobalNumElements () << endl
<< "Minimum global index: " << getMinAllGlobalIndex () << endl
<< "Maximum global index: " << getMaxAllGlobalIndex () << endl
<< "Index base: " << getIndexBase () << endl
<< "Number of processes: " << numProcs << endl
<< "Uniform: " << (isUniform () ? "true" : "false") << endl
<< "Contiguous: " << (isContiguous () ? "true" : "false") << endl
<< "Distributed: " << (isDistributed () ? "true" : "false") << endl;
}
// This is collective over the Map's communicator.
if (vl >= VERB_HIGH) { // VERB_HIGH or VERB_EXTREME
const std::string lclStr = this->localDescribeToString (vl);
Tpetra::Details::gathervPrint (out, lclStr, *comm);
}
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >
Map<LocalOrdinal, GlobalOrdinal, Node>::
replaceCommWithSubset (const Teuchos::RCP<const Teuchos::Comm<int> >& newComm) const
{
using Teuchos::RCP;
using Teuchos::rcp;
typedef global_size_t GST;
typedef LocalOrdinal LO;
typedef GlobalOrdinal GO;
typedef Map<LO, GO, Node> map_type;
// mfh 26 Mar 2013: The lazy way to do this is simply to recreate
// the Map by calling its ordinary public constructor, using the
// original Map's data. This only involves O(1) all-reduces over
// the new communicator, which in the common case only includes a
// small number of processes.
// Create the Map to return.
if (newComm.is_null () || newComm->getSize () < 1) {
return Teuchos::null; // my process does not participate in the new Map
}
else if (newComm->getSize () == 1) {
// The case where the new communicator has only one process is
// easy. We don't have to communicate to get all the
// information we need. Use the default comm to create the new
// Map, then fill in all the fields directly.
RCP<map_type> newMap (new map_type ());
newMap->comm_ = newComm;
newMap->node_ = this->node_;
// mfh 07 Oct 2016: Preserve original behavior, even though the
// original index base may no longer be the globally min global
// index. See #616 for why this doesn't matter so much anymore.
newMap->indexBase_ = this->indexBase_;
newMap->numGlobalElements_ = this->numLocalElements_;
newMap->numLocalElements_ = this->numLocalElements_;
newMap->minMyGID_ = this->minMyGID_;
newMap->maxMyGID_ = this->maxMyGID_;
newMap->minAllGID_ = this->minMyGID_;
newMap->maxAllGID_ = this->maxMyGID_;
newMap->firstContiguousGID_ = this->firstContiguousGID_;
newMap->lastContiguousGID_ = this->lastContiguousGID_;
// Since the new communicator has only one process, neither
// uniformity nor contiguity have changed.
newMap->uniform_ = this->uniform_;
newMap->contiguous_ = this->contiguous_;
// The new communicator only has one process, so the new Map is
// not distributed.
newMap->distributed_ = false;
newMap->lgMap_ = this->lgMap_;
newMap->lgMapHost_ = this->lgMapHost_;
newMap->glMap_ = this->glMap_;
// It's OK not to initialize the new Map's Directory.
// This is initialized lazily, on first call to getRemoteIndexList.
return newMap;
}
else { // newComm->getSize() != 1
// Even if the original Map is contiguous, the new Map might not
// be, especially if the excluded processes have ranks != 0 or
// newComm->getSize()-1. The common case for this method is to
// exclude many (possibly even all but one) processes, so it
// likely doesn't pay to do the global communication (over the
// original communicator) to figure out whether we can optimize
// the result Map. Thus, we just set up the result Map as
// noncontiguous.
//
// TODO (mfh 07 Oct 2016) We don't actually need to reconstruct
// the global-to-local table, etc. Optimize this code path to
// avoid unnecessary local work.
// Make Map (re)compute the global number of elements.
const GST RECOMPUTE = Tpetra::Details::OrdinalTraits<GST>::invalid ();
// TODO (mfh 07 Oct 2016) If we use any Map constructor, we have
// to use the noncontiguous Map constructor, since the new Map
// might not be contiguous. Even if the old Map was contiguous,
// some process in the "middle" might have been excluded. If we
// want to avoid local work, we either have to do the setup by
// hand, or write a new Map constructor.
#if 1
// The disabled code here throws the following exception in
// Map's replaceCommWithSubset test:
//
// Throw test that evaluated to true: static_cast<unsigned long long> (numKeys) > static_cast<unsigned long long> (::Kokkos::Details::ArithTraits<ValueType>::max ())
// 10:
// 10: Tpetra::Details::FixedHashTable: The number of keys -3 is greater than the maximum representable ValueType value 2147483647. This means that it is not possible to use this constructor.
// 10: Process 3: origComm->replaceCommWithSubset(subsetComm) threw an exception: /scratch/prj/Trilinos/Trilinos/packages/tpetra/core/src/Tpetra_Details_FixedHashTable_def.hpp:1044:
auto lgMap = this->getMyGlobalIndices ();
typedef typename std::decay<decltype (lgMap.dimension_0 ()) >::type size_type;
const size_type lclNumInds =
static_cast<size_type> (this->getNodeNumElements ());
using Teuchos::TypeNameTraits;
TEUCHOS_TEST_FOR_EXCEPTION
(lgMap.dimension_0 () != lclNumInds, std::logic_error,
"Tpetra::Map::replaceCommWithSubset: Result of getMyGlobalIndices() "
"has length " << lgMap.dimension_0 () << " (of type " <<
TypeNameTraits<size_type>::name () << ") != this->getNodeNumElements()"
" = " << this->getNodeNumElements () << ". The latter, upon being "
"cast to size_type = " << TypeNameTraits<size_type>::name () << ", "
"becomes " << lclNumInds << ". Please report this bug to the Tpetra "
"developers.");
#else
Teuchos::ArrayView<const GO> lgMap = this->getNodeElementList ();
#endif // 1
const GO indexBase = this->getIndexBase ();
return rcp (new map_type (RECOMPUTE, lgMap, indexBase, newComm));
}
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >
Map<LocalOrdinal, GlobalOrdinal, Node>::
removeEmptyProcesses () const
{
using Teuchos::Comm;
using Teuchos::null;
using Teuchos::outArg;
using Teuchos::RCP;
using Teuchos::rcp;
using Teuchos::REDUCE_MIN;
using Teuchos::reduceAll;
// Create the new communicator. split() returns a valid
// communicator on all processes. On processes where color == 0,
// ignore the result. Passing key == 0 tells MPI to order the
// processes in the new communicator by their rank in the old
// communicator.
const int color = (numLocalElements_ == 0) ? 0 : 1;
// MPI_Comm_split must be called collectively over the original
// communicator. We can't just call it on processes with color
// one, even though we will ignore its result on processes with
// color zero.
RCP<const Comm<int> > newComm = comm_->split (color, 0);
if (color == 0) {
newComm = null;
}
// Create the Map to return.
if (newComm.is_null ()) {
return null; // my process does not participate in the new Map
} else {
// The default constructor that's useful for clone() above is
// also useful here.
RCP<Map> map = rcp (new Map ());
map->comm_ = newComm;
map->indexBase_ = indexBase_;
map->numGlobalElements_ = numGlobalElements_;
map->numLocalElements_ = numLocalElements_;
map->minMyGID_ = minMyGID_;
map->maxMyGID_ = maxMyGID_;
map->minAllGID_ = minAllGID_;
map->maxAllGID_ = maxAllGID_;
map->firstContiguousGID_= firstContiguousGID_;
map->lastContiguousGID_ = lastContiguousGID_;
// Uniformity and contiguity have not changed. The directory
// has changed, but we've taken care of that above.
map->uniform_ = uniform_;
map->contiguous_ = contiguous_;
// If the original Map was NOT distributed, then the new Map
// cannot be distributed.
//
// If the number of processes in the new communicator is 1, then
// the new Map is not distributed.
//
// Otherwise, we have to check the new Map using an all-reduce
// (over the new communicator). For example, the original Map
// may have had some processes with zero elements, and all other
// processes with the same number of elements as in the whole
// Map. That Map is technically distributed, because of the
// processes with zero elements. Removing those processes would
// make the new Map locally replicated.
if (! distributed_ || newComm->getSize () == 1) {
map->distributed_ = false;
} else {
const int iOwnAllGids = (numLocalElements_ == numGlobalElements_) ? 1 : 0;
int allProcsOwnAllGids = 0;
reduceAll<int, int> (*newComm, REDUCE_MIN, iOwnAllGids, outArg (allProcsOwnAllGids));
map->distributed_ = (allProcsOwnAllGids == 1) ? false : true;
}
map->lgMap_ = lgMap_;
map->lgMapHost_ = lgMapHost_;
map->glMap_ = glMap_;
map->node_ = node_;
// Map's default constructor creates an uninitialized Directory.
// The Directory will be initialized on demand in
// getRemoteIndexList().
//
// FIXME (mfh 26 Mar 2013) It should be possible to "filter" the
// directory more efficiently than just recreating it. If
// directory recreation proves a bottleneck, we can always
// revisit this. On the other hand, Directory creation is only
// collective over the new, presumably much smaller
// communicator, so it may not be worth the effort to optimize.
return map;
}
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
void
Map<LocalOrdinal,GlobalOrdinal,Node>::setupDirectory () const
{
TEUCHOS_TEST_FOR_EXCEPTION(
directory_.is_null (), std::logic_error, "Tpetra::Map::setupDirectory: "
"The Directory is null. "
"Please report this bug to the Tpetra developers.");
// Only create the Directory if it hasn't been created yet.
// This is a collective operation.
if (! directory_->initialized ()) {
directory_->initialize (*this);
}
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
LookupStatus
Map<LocalOrdinal,GlobalOrdinal,Node>::
getRemoteIndexList (const Teuchos::ArrayView<const GlobalOrdinal>& GIDs,
const Teuchos::ArrayView<int>& PIDs,
const Teuchos::ArrayView<LocalOrdinal>& LIDs) const
{
using Tpetra::Details::OrdinalTraits;
typedef Teuchos::ArrayView<int>::size_type size_type;
// Empty Maps (i.e., containing no indices on any processes in the
// Map's communicator) are perfectly valid. In that case, if the
// input GID list is nonempty, we fill the output arrays with
// invalid values, and return IDNotPresent to notify the caller.
// It's perfectly valid to give getRemoteIndexList GIDs that the
// Map doesn't own. SubmapImport test 2 needs this functionality.
if (getGlobalNumElements () == 0) {
if (GIDs.size () == 0) {
return AllIDsPresent; // trivially
} else {
for (size_type k = 0; k < PIDs.size (); ++k) {
PIDs[k] = OrdinalTraits<int>::invalid ();
}
for (size_type k = 0; k < LIDs.size (); ++k) {
LIDs[k] = OrdinalTraits<LocalOrdinal>::invalid ();
}
return IDNotPresent;
}
}
// getRemoteIndexList must be called collectively, and Directory
// initialization is collective too, so it's OK to initialize the
// Directory on demand.
setupDirectory ();
return directory_->getDirectoryEntries (*this, GIDs, PIDs, LIDs);
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
LookupStatus
Map<LocalOrdinal,GlobalOrdinal,Node>::
getRemoteIndexList (const Teuchos::ArrayView<const GlobalOrdinal> & GIDs,
const Teuchos::ArrayView<int> & PIDs) const
{
if (getGlobalNumElements () == 0) {
if (GIDs.size () == 0) {
return AllIDsPresent; // trivially
} else {
// The Map contains no indices, so all output PIDs are invalid.
for (Teuchos::ArrayView<int>::size_type k = 0; k < PIDs.size (); ++k) {
PIDs[k] = Tpetra::Details::OrdinalTraits<int>::invalid ();
}
return IDNotPresent;
}
}
// getRemoteIndexList must be called collectively, and Directory
// initialization is collective too, so it's OK to initialize the
// Directory on demand.
setupDirectory ();
return directory_->getDirectoryEntries (*this, GIDs, PIDs);
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP<const Teuchos::Comm<int> >
Map<LocalOrdinal,GlobalOrdinal,Node>::getComm () const {
return comm_;
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP<Node>
Map<LocalOrdinal,GlobalOrdinal,Node>::getNode () const {
return node_;
}
template <class LocalOrdinal,class GlobalOrdinal, class Node>
bool Map<LocalOrdinal,GlobalOrdinal,Node>::checkIsDist() const {
using Teuchos::as;
using Teuchos::outArg;
using Teuchos::REDUCE_MIN;
using Teuchos::reduceAll;
bool global = false;
if (comm_->getSize () > 1) {
// The communicator has more than one process, but that doesn't
// necessarily mean the Map is distributed.
int localRep = 0;
if (numGlobalElements_ == as<global_size_t> (numLocalElements_)) {
// The number of local elements on this process equals the
// number of global elements.
//
// NOTE (mfh 22 Nov 2011) Does this still work if there were
// duplicates in the global ID list on input (the third Map
// constructor), so that the number of local elements (which
// are not duplicated) on this process could be less than the
// number of global elements, even if this process owns all
// the elements?
localRep = 1;
}
int allLocalRep;
reduceAll<int, int> (*comm_, REDUCE_MIN, localRep, outArg (allLocalRep));
if (allLocalRep != 1) {
// At least one process does not own all the elements.
// This makes the Map a distributed Map.
global = true;
}
}
// If the communicator has only one process, then the Map is not
// distributed.
return global;
}
namespace Details {
template <class LocalOrdinal,class GlobalOrdinal, class Node>
bool
isLocallyFitted (const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node>& map1,
const Tpetra::Map<LocalOrdinal, GlobalOrdinal, Node>& map2)
{
using Teuchos::ArrayView;
typedef GlobalOrdinal GO; // a handy abbreviation
typedef typename ArrayView<const GO>::size_type size_type;
bool fitted = true;
if (&map1 == &map2) {
fitted = true;
}
else if (map1.isContiguous () && map2.isContiguous () &&
map1.getMinGlobalIndex () == map2.getMinGlobalIndex () &&
map1.getMaxGlobalIndex () <= map2.getMaxGlobalIndex ()) {
// Special case where both Maps are contiguous.
fitted = true;
}
else {
ArrayView<const GO> inds_map2 = map2.getNodeElementList ();
const size_type numInds_map1 =
static_cast<size_type> (map1.getNodeNumElements ());
if (map1.isContiguous ()) {
// Avoid calling getNodeElementList() on the always one-to-one
// Map, if it is contiguous (a common case). When called on a
// contiguous Map, getNodeElementList() causes allocation of
// an array that sticks around, even though the array isn't
// needed. (The Map is contiguous, so you can compute the
// entries; you don't need to store them.)
if (numInds_map1 > inds_map2.size ()) {
// There are fewer indices in map1 on this process than in
// map2. This case might be impossible.
fitted = false;
}
else {
// Do all the map1 indices match the initial map2 indices?
const GO minInd_map1 = map1.getMinGlobalIndex ();
for (size_type k = 0; k < numInds_map1; ++k) {
const GO inds_map1_k = static_cast<GO> (k) + minInd_map1;
if (inds_map1_k != inds_map2[k]) {
fitted = false;
break;
}
}
}
}
else { // map1 is not contiguous.
// Get index lists from both Maps, and compare their indices.
ArrayView<const GO> inds_map1 = map1.getNodeElementList ();
if (numInds_map1 > inds_map2.size ()) {
// There are fewer indices in map1 on this process than in
// map2. This case might be impossible.
fitted = false;
}
else {
// Do all the map1 indices match those in map2?
for (size_type k = 0; k < numInds_map1; ++k) {
if (inds_map1[k] != inds_map2[k]) {
fitted = false;
break;
}
}
}
}
}
return fitted;
}
} // namespace Details
} // namespace Tpetra
template <class LocalOrdinal, class GlobalOrdinal>
Teuchos::RCP< const Tpetra::Map<LocalOrdinal,GlobalOrdinal> >
Tpetra::createLocalMap (const size_t numElements,
const Teuchos::RCP<const Teuchos::Comm<int> >& comm)
{
typedef LocalOrdinal LO;
typedef GlobalOrdinal GO;
typedef typename ::Tpetra::Map<LO, GO>::node_type NT;
return createLocalMapWithNode<LO, GO, NT> (numElements, comm);
}
template <class LocalOrdinal, class GlobalOrdinal>
Teuchos::RCP< const Tpetra::Map<LocalOrdinal,GlobalOrdinal> >
Tpetra::createUniformContigMap (const global_size_t numElements,
const Teuchos::RCP<const Teuchos::Comm<int> >& comm)
{
typedef LocalOrdinal LO;
typedef GlobalOrdinal GO;
typedef typename ::Tpetra::Map<LO, GO>::node_type NT;
return createUniformContigMapWithNode<LO, GO, NT> (numElements, comm);
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP< const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
Tpetra::createUniformContigMapWithNode (const global_size_t numElements,
const Teuchos::RCP<const Teuchos::Comm<int> >& comm,
const Teuchos::RCP<Node>& node)
{
using Teuchos::rcp;
typedef Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> map_type;
const GlobalOrdinal indexBase = static_cast<GlobalOrdinal> (0);
if (node.is_null ()) {
return rcp (new map_type (numElements, indexBase, comm, GloballyDistributed));
}
else {
return rcp (new map_type (numElements, indexBase, comm, GloballyDistributed, node));
}
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP< const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
Tpetra::createLocalMapWithNode (const size_t numElements,
const Teuchos::RCP<const Teuchos::Comm<int> >& comm,
const Teuchos::RCP<Node>& node)
{
using Tpetra::global_size_t;
using Teuchos::rcp;
typedef Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> map_type;
const GlobalOrdinal indexBase = static_cast<GlobalOrdinal> (0);
const global_size_t globalNumElts = static_cast<global_size_t> (numElements);
if (node.is_null ()) {
return rcp (new map_type (globalNumElts, indexBase, comm, LocallyReplicated));
}
else {
return rcp (new map_type (globalNumElts, indexBase, comm, LocallyReplicated, node));
}
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP< const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
Tpetra::createContigMapWithNode (const Tpetra::global_size_t numElements,
const size_t localNumElements,
const Teuchos::RCP<const Teuchos::Comm<int> >& comm,
const Teuchos::RCP<Node>& node)
{
using Teuchos::rcp;
typedef Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> map_type;
const GlobalOrdinal indexBase = static_cast<GlobalOrdinal> (0);
return rcp (new map_type (numElements, localNumElements, indexBase, comm, node));
}
template <class LocalOrdinal, class GlobalOrdinal>
Teuchos::RCP< const Tpetra::Map<LocalOrdinal,GlobalOrdinal> >
Tpetra::createContigMap (const Tpetra::global_size_t numElements,
const size_t localNumElements,
const Teuchos::RCP<const Teuchos::Comm<int> >& comm)
{
typedef LocalOrdinal LO;
typedef GlobalOrdinal GO;
typedef typename Tpetra::Map<LocalOrdinal, GlobalOrdinal>::node_type NT;
return Tpetra::createContigMapWithNode<LO, GO, NT> (numElements, localNumElements, comm);
}
template <class LocalOrdinal, class GlobalOrdinal>
Teuchos::RCP< const Tpetra::Map<LocalOrdinal,GlobalOrdinal> >
Tpetra::createNonContigMap(const Teuchos::ArrayView<const GlobalOrdinal>& elementList,
const Teuchos::RCP<const Teuchos::Comm<int> >& comm)
{
typedef LocalOrdinal LO;
typedef GlobalOrdinal GO;
typedef typename Tpetra::Map<LocalOrdinal, GlobalOrdinal>::node_type NT;
return Tpetra::createNonContigMapWithNode<LO, GO, NT> (elementList, comm);
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP< const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
Tpetra::createNonContigMapWithNode (const Teuchos::ArrayView<const GlobalOrdinal>& elementList,
const Teuchos::RCP<const Teuchos::Comm<int> >& comm,
const Teuchos::RCP<Node>& node)
{
using Teuchos::rcp;
typedef Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> map_type;
typedef Tpetra::global_size_t GST;
const GST INV = Tpetra::Details::OrdinalTraits<GST>::invalid ();
// FIXME (mfh 22 Jul 2016) This is what I found here, but maybe this
// shouldn't be zero, given that the index base is supposed to equal
// the globally min global index?
const GlobalOrdinal indexBase = 0;
if (node.is_null ()) {
return rcp (new map_type (INV, elementList, indexBase, comm));
}
else {
return rcp (new map_type (INV, elementList, indexBase, comm, node));
}
}
template <class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP< const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
Tpetra::createWeightedContigMapWithNode (const int myWeight,
const Tpetra::global_size_t numElements,
const Teuchos::RCP<const Teuchos::Comm<int> >& comm,
const Teuchos::RCP<Node>& node)
{
Teuchos::RCP< Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > map;
int sumOfWeights, elemsLeft, localNumElements;
const int numImages = comm->getSize();
const int myImageID = comm->getRank();
Teuchos::reduceAll<int>(*comm,Teuchos::REDUCE_SUM,myWeight,Teuchos::outArg(sumOfWeights));
const double myShare = ((double)myWeight) / ((double)sumOfWeights);
localNumElements = (int)std::floor( myShare * ((double)numElements) );
// std::cout << "numElements: " << numElements << " myWeight: " << myWeight << " sumOfWeights: " << sumOfWeights << " myShare: " << myShare << std::endl;
Teuchos::reduceAll<int>(*comm,Teuchos::REDUCE_SUM,localNumElements,Teuchos::outArg(elemsLeft));
elemsLeft = numElements - elemsLeft;
// std::cout << "(before) localNumElements: " << localNumElements << " elemsLeft: " << elemsLeft << std::endl;
// i think this is true. just test it for now.
TEUCHOS_TEST_FOR_EXCEPT(elemsLeft < -numImages || numImages < elemsLeft);
if (elemsLeft < 0) {
// last elemsLeft nodes lose an element
if (myImageID >= numImages-elemsLeft) --localNumElements;
}
else if (elemsLeft > 0) {
// first elemsLeft nodes gain an element
if (myImageID < elemsLeft) ++localNumElements;
}
// std::cout << "(after) localNumElements: " << localNumElements << std::endl;
return createContigMapWithNode<LocalOrdinal,GlobalOrdinal,Node>(numElements,localNumElements,comm,node);
}
template<class LO, class GO, class NT>
Teuchos::RCP<const Tpetra::Map<LO, GO, NT> >
Tpetra::createOneToOne (const Teuchos::RCP<const Tpetra::Map<LO, GO, NT> >& M)
{
using Teuchos::Array;
using Teuchos::ArrayView;
using Teuchos::as;
using Teuchos::rcp;
typedef Tpetra::Map<LO, GO, NT> map_type;
typedef global_size_t GST;
const GST GINV = Tpetra::Details::OrdinalTraits<GST>::invalid ();
const int myRank = M->getComm ()->getRank ();
// Bypasses for special cases where either M is known to be
// one-to-one, or the one-to-one version of M is easy to compute.
// This is why we take M as an RCP, not as a const reference -- so
// that we can return M itself if it is 1-to-1.
if (! M->isDistributed ()) {
// For a locally replicated Map, we assume that users want to push
// all the GIDs to Process 0.
// mfh 05 Nov 2013: getGlobalNumElements() does indeed return what
// you think it should return, in this special case of a locally
// replicated contiguous Map.
const GST numGlobalEntries = M->getGlobalNumElements ();
if (M->isContiguous ()) {
const size_t numLocalEntries =
(myRank == 0) ? as<size_t> (numGlobalEntries) : static_cast<size_t> (0);
return rcp (new map_type (numGlobalEntries, numLocalEntries,
M->getIndexBase (), M->getComm (),
M->getNode ()));
}
else {
ArrayView<const GO> myGids =
(myRank == 0) ? M->getNodeElementList () : Teuchos::null;
return rcp (new map_type (GINV, myGids (), M->getIndexBase (),
M->getComm (), M->getNode ()));
}
}
else if (M->isContiguous ()) {
// Contiguous, distributed Maps are one-to-one by construction.
// (Locally replicated Maps can be contiguous.)
return M;
}
else {
Tpetra::Directory<LO, GO, NT> directory;
const size_t numMyElems = M->getNodeNumElements ();
ArrayView<const GO> myElems = M->getNodeElementList ();
Array<int> owner_procs_vec (numMyElems);
directory.getDirectoryEntries (*M, myElems, owner_procs_vec ());
Array<GO> myOwned_vec (numMyElems);
size_t numMyOwnedElems = 0;
for (size_t i = 0; i < numMyElems; ++i) {
const GO GID = myElems[i];
const int owner = owner_procs_vec[i];
if (myRank == owner) {
myOwned_vec[numMyOwnedElems++] = GID;
}
}
myOwned_vec.resize (numMyOwnedElems);
return rcp (new map_type (GINV, myOwned_vec (), M->getIndexBase (),
M->getComm (), M->getNode ()));
}
}
template<class LocalOrdinal, class GlobalOrdinal, class Node>
Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
Tpetra::createOneToOne (const Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > &M,
const Tpetra::Details::TieBreak<LocalOrdinal,GlobalOrdinal> & tie_break)
{
using Teuchos::Array;
using Teuchos::ArrayView;
using Teuchos::rcp;
typedef LocalOrdinal LO;
typedef GlobalOrdinal GO;
typedef Tpetra::Map<LO,GO,Node> map_type;
int myID = M->getComm()->getRank();
// FIXME (mfh 20 Feb 2013) We should have a bypass for contiguous
// Maps (which are 1-to-1 by construction).
//Based off Epetra's one to one.
Tpetra::Directory<LO, GO, Node> directory;
directory.initialize (*M, tie_break);
size_t numMyElems = M->getNodeNumElements ();
ArrayView<const GO> myElems = M->getNodeElementList ();
Array<int> owner_procs_vec (numMyElems);
directory.getDirectoryEntries (*M, myElems, owner_procs_vec ());
Array<GO> myOwned_vec (numMyElems);
size_t numMyOwnedElems = 0;
for (size_t i = 0; i < numMyElems; ++i) {
GO GID = myElems[i];
int owner = owner_procs_vec[i];
if (myID == owner) {
myOwned_vec[numMyOwnedElems++] = GID;
}
}
myOwned_vec.resize (numMyOwnedElems);
// FIXME (mfh 08 May 2014) The above Directory should be perfectly
// valid for the new Map. Why can't we reuse it?
const global_size_t GINV =
Tpetra::Details::OrdinalTraits<global_size_t>::invalid ();
return rcp (new map_type (GINV, myOwned_vec (), M->getIndexBase (),
M->getComm (), M->getNode ()));
}
//
// Explicit instantiation macro
//
// Must be expanded from within the Tpetra namespace!
//
//! Explicit instantiation macro supporting the Map class. Instantiates the class and the non-member constructors.
#define TPETRA_MAP_INSTANT(LO,GO,NODE) \
\
template class Map< LO , GO , NODE >; \
\
template Teuchos::RCP< const Map<LO,GO,NODE> > \
createLocalMapWithNode<LO,GO,NODE> (const size_t numElements, \
const Teuchos::RCP< const Teuchos::Comm< int > >& comm, \
const Teuchos::RCP< NODE >& node); \
\
template Teuchos::RCP< const Map<LO,GO,NODE> > \
createContigMapWithNode<LO,GO,NODE> (const global_size_t numElements, \
const size_t localNumElements, \
const Teuchos::RCP< const Teuchos::Comm< int > >& comm, \
const Teuchos::RCP< NODE > &node); \
\
template Teuchos::RCP< const Map<LO,GO,NODE> > \
createNonContigMapWithNode(const Teuchos::ArrayView<const GO> &elementList, \
const Teuchos::RCP<const Teuchos::Comm<int> > &comm, \
const Teuchos::RCP<NODE> &node); \
\
template Teuchos::RCP< const Map<LO,GO,NODE> > \
createUniformContigMapWithNode<LO,GO,NODE> (const global_size_t numElements, \
const Teuchos::RCP< const Teuchos::Comm< int > >& comm, \
const Teuchos::RCP< NODE > &node); \
\
template Teuchos::RCP< const Map<LO,GO,NODE> > \
createWeightedContigMapWithNode<LO,GO,NODE> (const int thisNodeWeight, \
const global_size_t numElements, \
const Teuchos::RCP< const Teuchos::Comm< int > >& comm, \
const Teuchos::RCP< NODE >& node); \
\
template Teuchos::RCP<const Map<LO,GO,NODE> > \
createOneToOne (const Teuchos::RCP<const Map<LO,GO,NODE> >& M); \
\
template Teuchos::RCP<const Map<LO,GO,NODE> > \
createOneToOne (const Teuchos::RCP<const Map<LO,GO,NODE> >& M, \
const Tpetra::Details::TieBreak<LO,GO>& tie_break); \
\
template bool \
Details::isLocallyFitted (const Tpetra::Map<LO, GO, NODE>& map1, \
const Tpetra::Map<LO, GO, NODE>& map2);
//! Explicit instantiation macro supporting the Map class, on the default node for specified ordinals.
#define TPETRA_MAP_INSTANT_DEFAULTNODE(LO,GO) \
template Teuchos::RCP< const Map<LO,GO> > \
createLocalMap<LO,GO>( const size_t, const Teuchos::RCP< const Teuchos::Comm< int > > &); \
\
template Teuchos::RCP< const Map<LO,GO> > \
createContigMap<LO,GO>( global_size_t, size_t, \
const Teuchos::RCP< const Teuchos::Comm< int > > &); \
\
template Teuchos::RCP< const Map<LO,GO> > \
createNonContigMap(const Teuchos::ArrayView<const GO> &, \
const Teuchos::RCP<const Teuchos::Comm<int> > &); \
\
template Teuchos::RCP< const Map<LO,GO> > \
createUniformContigMap<LO,GO>( const global_size_t, \
const Teuchos::RCP< const Teuchos::Comm< int > > &); \
#endif // TPETRA_MAP_DEF_HPP
|