/usr/include/hypre/HYPRE_parcsr_ls.h is in libhypre-dev 2.11.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 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 | /*BHEADER**********************************************************************
* Copyright (c) 2008, Lawrence Livermore National Security, LLC.
* Produced at the Lawrence Livermore National Laboratory.
* This file is part of HYPRE. See file COPYRIGHT for details.
*
* HYPRE is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License (as published by the Free
* Software Foundation) version 2.1 dated February 1999.
*
* $Revision$
***********************************************************************EHEADER*/
#ifndef HYPRE_PARCSR_LS_HEADER
#define HYPRE_PARCSR_LS_HEADER
#include "HYPRE_utilities.h"
#include "HYPRE_seq_mv.h"
#include "HYPRE_parcsr_mv.h"
#include "HYPRE_IJ_mv.h"
#ifdef __cplusplus
extern "C" {
#endif
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name ParCSR Solvers
*
* These solvers use matrix/vector storage schemes that are taylored
* for general sparse matrix systems.
*
* @memo Linear solvers for sparse matrix systems
**/
/*@{*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name ParCSR Solvers
**/
/*@{*/
struct hypre_Solver_struct;
/**
* The solver object.
**/
#ifndef HYPRE_SOLVER_STRUCT
#define HYPRE_SOLVER_STRUCT
struct hypre_Solver_struct;
typedef struct hypre_Solver_struct *HYPRE_Solver;
#endif
typedef HYPRE_Int (*HYPRE_PtrToParSolverFcn)(HYPRE_Solver,
HYPRE_ParCSRMatrix,
HYPRE_ParVector,
HYPRE_ParVector);
#ifndef HYPRE_MODIFYPC
#define HYPRE_MODIFYPC
typedef HYPRE_Int (*HYPRE_PtrToModifyPCFcn)(HYPRE_Solver,
HYPRE_Int,
HYPRE_Real);
#endif
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name ParCSR BoomerAMG Solver and Preconditioner
*
* Parallel unstructured algebraic multigrid solver and preconditioner
**/
/*@{*/
/**
* Create a solver object.
**/
HYPRE_Int HYPRE_BoomerAMGCreate(HYPRE_Solver *solver);
/**
* Destroy a solver object.
**/
HYPRE_Int HYPRE_BoomerAMGDestroy(HYPRE_Solver solver);
/**
* Set up the BoomerAMG solver or preconditioner.
* If used as a preconditioner, this function should be passed
* to the iterative solver {\tt SetPrecond} function.
*
* @param solver [IN] object to be set up.
* @param A [IN] ParCSR matrix used to construct the solver/preconditioner.
* @param b Ignored by this function.
* @param x Ignored by this function.
**/
HYPRE_Int HYPRE_BoomerAMGSetup(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
/**
* Solve the system or apply AMG as a preconditioner.
* If used as a preconditioner, this function should be passed
* to the iterative solver {\tt SetPrecond} function.
*
* @param solver [IN] solver or preconditioner object to be applied.
* @param A [IN] ParCSR matrix, matrix of the linear system to be solved
* @param b [IN] right hand side of the linear system to be solved
* @param x [OUT] approximated solution of the linear system to be solved
**/
HYPRE_Int HYPRE_BoomerAMGSolve(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
/**
* Solve the transpose system $A^T x = b$ or apply AMG as a preconditioner
* to the transpose system . Note that this function should only be used
* when preconditioning CGNR with BoomerAMG. It can only be used with
* Jacobi smoothing (relax_type 0 or 7) and without CF smoothing,
* i.e relax_order needs to be set to 0.
* If used as a preconditioner, this function should be passed
* to the iterative solver {\tt SetPrecond} function.
*
* @param solver [IN] solver or preconditioner object to be applied.
* @param A [IN] ParCSR matrix
* @param b [IN] right hand side of the linear system to be solved
* @param x [OUT] approximated solution of the linear system to be solved
**/
HYPRE_Int HYPRE_BoomerAMGSolveT(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
/**
* Returns the residual.
**/
HYPRE_Int HYPRE_BoomerAMGGetResidual(HYPRE_Solver solver,
HYPRE_ParVector *residual);
/**
* Returns the number of iterations taken.
**/
HYPRE_Int HYPRE_BoomerAMGGetNumIterations(HYPRE_Solver solver,
HYPRE_Int *num_iterations);
/**
* Returns the norm of the final relative residual.
**/
HYPRE_Int HYPRE_BoomerAMGGetFinalRelativeResidualNorm(HYPRE_Solver solver,
HYPRE_Real *rel_resid_norm);
/**
* (Optional) Sets the size of the system of PDEs, if using the systems version.
* The default is 1, i.e. a scalar system.
**/
HYPRE_Int HYPRE_BoomerAMGSetNumFunctions(HYPRE_Solver solver,
HYPRE_Int num_functions);
/**
* (Optional) Sets the mapping that assigns the function to each variable,
* if using the systems version. If no assignment is made and the number of
* functions is k > 1, the mapping generated is (0,1,...,k-1,0,1,...,k-1,...).
**/
HYPRE_Int HYPRE_BoomerAMGSetDofFunc(HYPRE_Solver solver,
HYPRE_Int *dof_func);
/**
* (Optional) Set the convergence tolerance, if BoomerAMG is used
* as a solver. If it is used as a preconditioner, it should be set to 0.
* The default is 1.e-7.
**/
HYPRE_Int HYPRE_BoomerAMGSetTol(HYPRE_Solver solver,
HYPRE_Real tol);
/**
* (Optional) Sets maximum number of iterations, if BoomerAMG is used
* as a solver. If it is used as a preconditioner, it should be set to 1.
* The default is 20.
**/
HYPRE_Int HYPRE_BoomerAMGSetMaxIter(HYPRE_Solver solver,
HYPRE_Int max_iter);
/**
* (Optional)
**/
HYPRE_Int HYPRE_BoomerAMGSetMinIter(HYPRE_Solver solver,
HYPRE_Int min_iter);
/**
* (Optional) Sets maximum size of coarsest grid.
* The default is 9.
**/
HYPRE_Int HYPRE_BoomerAMGSetMaxCoarseSize(HYPRE_Solver solver,
HYPRE_Int max_coarse_size);
/**
* (Optional) Sets minimum size of coarsest grid.
* The default is 1.
**/
HYPRE_Int HYPRE_BoomerAMGSetMinCoarseSize(HYPRE_Solver solver,
HYPRE_Int min_coarse_size);
/**
* (Optional) Sets maximum number of multigrid levels.
* The default is 25.
**/
HYPRE_Int HYPRE_BoomerAMGSetMaxLevels(HYPRE_Solver solver,
HYPRE_Int max_levels);
/**
* (Optional) Sets AMG strength threshold. The default is 0.25.
* For 2d Laplace operators, 0.25 is a good value, for 3d Laplace
* operators, 0.5 or 0.6 is a better value. For elasticity problems,
* a large strength threshold, such as 0.9, is often better.
**/
HYPRE_Int HYPRE_BoomerAMGSetStrongThreshold(HYPRE_Solver solver,
HYPRE_Real strong_threshold);
/**
* (Optional) Defines the largest strength threshold for which
* the strength matrix S uses the communication package of the operator A.
* If the strength threshold is larger than this values,
* a communication package is generated for S. This can save
* memory and decrease the amount of data that needs to be communicated,
* if S is substantially sparser than A.
* The default is 1.0.
**/
HYPRE_Int HYPRE_BoomerAMGSetSCommPkgSwitch(HYPRE_Solver solver,
HYPRE_Real S_commpkg_switch);
/**
* (Optional) Sets a parameter to modify the definition of strength for
* diagonal dominant portions of the matrix. The default is 0.9.
* If max\_row\_sum is 1, no checking for diagonally dominant rows is
* performed.
**/
HYPRE_Int HYPRE_BoomerAMGSetMaxRowSum(HYPRE_Solver solver,
HYPRE_Real max_row_sum);
/**
* (Optional) Defines which parallel coarsening algorithm is used.
* There are the following options for coarsen\_type:
*
* \begin{tabular}{|c|l|} \hline
* 0 & CLJP-coarsening (a parallel coarsening algorithm using independent sets. \\
* 1 & classical Ruge-Stueben coarsening on each processor, no boundary treatment (not recommended!) \\
* 3 & classical Ruge-Stueben coarsening on each processor, followed by a third pass, which adds coarse \\
* & points on the boundaries \\
* 6 & Falgout coarsening (uses 1 first, followed by CLJP using the interior coarse points \\
* & generated by 1 as its first independent set) \\
* 7 & CLJP-coarsening (using a fixed random vector, for debugging purposes only) \\
* 8 & PMIS-coarsening (a parallel coarsening algorithm using independent sets, generating \\
* & lower complexities than CLJP, might also lead to slower convergence) \\
* 9 & PMIS-coarsening (using a fixed random vector, for debugging purposes only) \\
* 10 & HMIS-coarsening (uses one pass Ruge-Stueben on each processor independently, followed \\
* & by PMIS using the interior C-points generated as its first independent set) \\
* 11 & one-pass Ruge-Stueben coarsening on each processor, no boundary treatment (not recommended!) \\
* 21 & CGC coarsening by M. Griebel, B. Metsch and A. Schweitzer \\
* 22 & CGC-E coarsening by M. Griebel, B. Metsch and A.Schweitzer \\
* \hline
* \end{tabular}
*
* The default is 6.
**/
HYPRE_Int HYPRE_BoomerAMGSetCoarsenType(HYPRE_Solver solver,
HYPRE_Int coarsen_type);
/**
* (Optional) Defines the non-Galerkin drop-tolerance
* for sparsifying coarse grid operators and thus reducing communication.
* Value specified here is set on all levels.
* This routine should be used before HYPRE_BoomerAMGSetLevelNonGalerkinTol, which
* then can be used to change individual levels if desired
**/
HYPRE_Int HYPRE_BoomerAMGSetNonGalerkinTol (HYPRE_Solver solver,
HYPRE_Real nongalerkin_tol);
/**
* (Optional) Defines the level specific non-Galerkin drop-tolerances
* for sparsifying coarse grid operators and thus reducing communication.
* A drop-tolerance of 0.0 means to skip doing non-Galerkin on that
* level. The maximum drop tolerance for a level is 1.0, although
* much smaller values such as 0.03 or 0.01 are recommended.
*
* Note that if the user wants to set a specific tolerance on all levels,
* HYPRE_BooemrAMGSetNonGalerkinTol should be used. Individual levels
* can then be changed using this routine.
*
* In general, it is safer to drop more aggressively on coarser levels.
* For instance, one could use 0.0 on the finest level, 0.01 on the second level and
* then using 0.05 on all remaining levels. The best way to achieve this is
* to set 0.05 on all levels with HYPRE_BoomerAMGSetNonGalerkinTol and then
* change the tolerance on level 0 to 0.0 and the tolerance on level 1 to 0.01
* with HYPRE_BoomerAMGSetLevelNonGalerkinTol.
* Like many AMG parameters, these drop tolerances can be tuned. It is also common
* to delay the start of the non-Galerkin process further to a later level than
* level 1.
*
* @param solver [IN] solver or preconditioner object to be applied.
* @param nongalerkin_tol [IN] level specific drop tolerance
* @param level [IN] level on which drop tolerance is used
**/
HYPRE_Int HYPRE_BoomerAMGSetLevelNonGalerkinTol (HYPRE_Solver solver,
HYPRE_Real nongalerkin_tol,
HYPRE_Int level);
/*
* (Optional) Defines the non-Galerkin drop-tolerance (old version)
**/
HYPRE_Int HYPRE_BoomerAMGSetNonGalerkTol (HYPRE_Solver solver,
HYPRE_Int nongalerk_num_tol,
HYPRE_Real *nongalerk_tol);
/**
* (Optional) Defines whether local or global measures are used.
**/
HYPRE_Int HYPRE_BoomerAMGSetMeasureType(HYPRE_Solver solver,
HYPRE_Int measure_type);
/**
* (Optional) Defines the number of levels of aggressive coarsening.
* The default is 0, i.e. no aggressive coarsening.
**/
HYPRE_Int HYPRE_BoomerAMGSetAggNumLevels(HYPRE_Solver solver,
HYPRE_Int agg_num_levels);
/**
* (Optional) Defines the degree of aggressive coarsening.
* The default is 1. Larger numbers lead to less aggressive
* coarsening.
**/
HYPRE_Int HYPRE_BoomerAMGSetNumPaths(HYPRE_Solver solver,
HYPRE_Int num_paths);
/**
* (optional) Defines the number of pathes for CGC-coarsening.
**/
HYPRE_Int HYPRE_BoomerAMGSetCGCIts (HYPRE_Solver solver,
HYPRE_Int its);
/**
* (Optional) Sets whether to use the nodal systems coarsening.
* Should be used for linear systems generated from systems of PDEs.
* The default is 0 (unknown-based coarsening,
* only coarsens within same function).
* For the remaining options a nodal matrix is generated by
* applying a norm to the nodal blocks and applying the coarsening
* algorithm to this matrix.
* \begin{tabular}{|c|l|} \hline
* 1 & Frobenius norm \\
* 2 & sum of absolute values of elements in each block \\
* 3 & largest element in each block (not absolute value)\\
* 4 & row-sum norm \\
* 6 & sum of all values in each block \\
* \hline
* \end{tabular}
**/
HYPRE_Int HYPRE_BoomerAMGSetNodal(HYPRE_Solver solver,
HYPRE_Int nodal);
/**
* (Optional) Sets whether to give special treatment to diagonal elements in
* the nodal systems version.
* The default is 0.
* If set to 1, the diagonal entry is set to the negative sum of all off
* diagonal entries.
* If set to 2, the signs of all diagonal entries are inverted.
*/
HYPRE_Int HYPRE_BoomerAMGSetNodalDiag(HYPRE_Solver solver,
HYPRE_Int nodal_diag);
/**
* (Optional) Defines which parallel interpolation operator is used.
* There are the following options for interp\_type:
*
* \begin{tabular}{|c|l|} \hline
* 0 & classical modified interpolation \\
* 1 & LS interpolation (for use with GSMG) \\
* 2 & classical modified interpolation for hyperbolic PDEs \\
* 3 & direct interpolation (with separation of weights) \\
* 4 & multipass interpolation \\
* 5 & multipass interpolation (with separation of weights) \\
* 6 & extended+i interpolation \\
* 7 & extended+i (if no common C neighbor) interpolation \\
* 8 & standard interpolation \\
* 9 & standard interpolation (with separation of weights) \\
* 10 & classical block interpolation (for use with nodal systems version only) \\
* 11 & classical block interpolation (for use with nodal systems version only) \\
* & with diagonalized diagonal blocks \\
* 12 & FF interpolation \\
* 13 & FF1 interpolation \\
* 14 & extended interpolation \\
* \hline
* \end{tabular}
*
* The default is 0.
**/
HYPRE_Int HYPRE_BoomerAMGSetInterpType(HYPRE_Solver solver,
HYPRE_Int interp_type);
/**
* (Optional) Defines a truncation factor for the interpolation.
* The default is 0.
**/
HYPRE_Int HYPRE_BoomerAMGSetTruncFactor(HYPRE_Solver solver,
HYPRE_Real trunc_factor);
/**
* (Optional) Defines the maximal number of elements per row for the interpolation.
* The default is 0.
**/
HYPRE_Int HYPRE_BoomerAMGSetPMaxElmts(HYPRE_Solver solver,
HYPRE_Int P_max_elmts);
/**
* (Optional) Defines whether separation of weights is used
* when defining strength for standard interpolation or
* multipass interpolation.
* Default: 0, i.e. no separation of weights used.
**/
HYPRE_Int HYPRE_BoomerAMGSetSepWeight(HYPRE_Solver solver,
HYPRE_Int sep_weight);
/**
* (Optional) Defines the interpolation used on levels of aggressive coarsening
* The default is 4, i.e. multipass interpolation.
* The following options exist:
*
* \begin{tabular}{|c|l|} \hline
* 1 & 2-stage extended+i interpolation \\
* 2 & 2-stage standard interpolation \\
* 3 & 2-stage extended interpolation \\
* 4 & multipass interpolation \\
* \hline
* \end{tabular}
**/
HYPRE_Int HYPRE_BoomerAMGSetAggInterpType(HYPRE_Solver solver,
HYPRE_Int agg_interp_type);
/**
* (Optional) Defines the truncation factor for the
* interpolation used for aggressive coarsening.
* The default is 0.
**/
HYPRE_Int HYPRE_BoomerAMGSetAggTruncFactor(HYPRE_Solver solver,
HYPRE_Real agg_trunc_factor);
/**
* (Optional) Defines the truncation factor for the
* matrices P1 and P2 which are used to build 2-stage interpolation.
* The default is 0.
**/
HYPRE_Int HYPRE_BoomerAMGSetAggP12TruncFactor(HYPRE_Solver solver,
HYPRE_Real agg_P12_trunc_factor);
/**
* (Optional) Defines the maximal number of elements per row for the
* interpolation used for aggressive coarsening.
* The default is 0.
**/
HYPRE_Int HYPRE_BoomerAMGSetAggPMaxElmts(HYPRE_Solver solver,
HYPRE_Int agg_P_max_elmts);
/**
* (Optional) Defines the maximal number of elements per row for the
* matrices P1 and P2 which are used to build 2-stage interpolation.
* The default is 0.
**/
HYPRE_Int HYPRE_BoomerAMGSetAggP12MaxElmts(HYPRE_Solver solver,
HYPRE_Int agg_P12_max_elmts);
/**
* (Optional) Allows the user to incorporate additional vectors
* into the interpolation for systems AMG, e.g. rigid body modes for
* linear elasticity problems.
* This can only be used in context with nodal coarsening and still
* requires the user to choose an interpolation.
**/
HYPRE_Int HYPRE_BoomerAMGSetInterpVectors (HYPRE_Solver solver ,
HYPRE_Int num_vectors ,
HYPRE_ParVector *interp_vectors );
/**
* (Optional) Defines the interpolation variant used for
* HYPRE_BoomerAMGSetInterpVectors:
* \begin{tabular}{|c|l|} \hline
* 1 & GM approach 1 \\
* 2 & GM approach 2 (to be preferred over 1) \\
* 3 & LN approach \\
* \hline
* \end{tabular}
**/
HYPRE_Int HYPRE_BoomerAMGSetInterpVecVariant (HYPRE_Solver solver,
HYPRE_Int var );
/**
* (Optional) Defines the maximal elements per row for Q, the additional
* columns added to the original interpolation matrix P, to reduce complexity.
* The default is no truncation.
**/
HYPRE_Int HYPRE_BoomerAMGSetInterpVecQMax (HYPRE_Solver solver,
HYPRE_Int q_max );
/**
* (Optional) Defines a truncation factor for Q, the additional
* columns added to the original interpolation matrix P, to reduce complexity.
* The default is no truncation.
**/
HYPRE_Int HYPRE_BoomerAMGSetInterpVecAbsQTrunc (HYPRE_Solver solver,
HYPRE_Real q_trunc );
/**
* (Optional) Specifies the use of GSMG - geometrically smooth
* coarsening and interpolation. Currently any nonzero value for
* gsmg will lead to the use of GSMG.
* The default is 0, i.e. (GSMG is not used)
**/
HYPRE_Int HYPRE_BoomerAMGSetGSMG(HYPRE_Solver solver,
HYPRE_Int gsmg);
/**
* (Optional) Defines the number of sample vectors used in GSMG
* or LS interpolation.
**/
HYPRE_Int HYPRE_BoomerAMGSetNumSamples(HYPRE_Solver solver,
HYPRE_Int num_samples);
/**
* (Optional) Defines the type of cycle.
* For a V-cycle, set cycle\_type to 1, for a W-cycle
* set cycle\_type to 2. The default is 1.
**/
HYPRE_Int HYPRE_BoomerAMGSetCycleType(HYPRE_Solver solver,
HYPRE_Int cycle_type);
/**
* (Optional) Defines use of an additive V(1,1)-cycle using the
* classical additive method starting at level 'addlvl'.
* The multiplicative approach is used on levels 0, ...'addlvl+1'.
* 'addlvl' needs to be > -1 for this to have an effect.
* Can only be used with weighted Jacobi and l1-Jacobi(default).
*
* Can only be used when AMG is used as a preconditioner !!!
**/
HYPRE_Int HYPRE_BoomerAMGSetAdditive(HYPRE_Solver solver,
HYPRE_Int addlvl);
/**
* (Optional) Defines use of an additive V(1,1)-cycle using the
* mult-additive method starting at level 'addlvl'.
* The multiplicative approach is used on levels 0, ...'addlvl+1'.
* 'addlvl' needs to be > -1 for this to have an effect.
* Can only be used with weighted Jacobi and l1-Jacobi(default).
*
* Can only be used when AMG is used as a preconditioner !!!
**/
HYPRE_Int HYPRE_BoomerAMGSetMultAdditive(HYPRE_Solver solver,
HYPRE_Int addlvl);
/**
* (Optional) Defines use of an additive V(1,1)-cycle using the
* simplified mult-additive method starting at level 'addlvl'.
* The multiplicative approach is used on levels 0, ...'addlvl+1'.
* 'addlvl' needs to be > -1 for this to have an effect.
* Can only be used with weighted Jacobi and l1-Jacobi(default).
*
* Can only be used when AMG is used as a preconditioner !!!
**/
HYPRE_Int HYPRE_BoomerAMGSetSimple(HYPRE_Solver solver,
HYPRE_Int addlvl);
/**
* (Optional) Defines the truncation factor for the
* smoothed interpolation used for mult-additive or simple method.
* The default is 0.
**/
HYPRE_Int HYPRE_BoomerAMGSetMultAddTruncFactor(HYPRE_Solver solver,
HYPRE_Real add_trunc_factor);
/**
* (Optional) Defines the maximal number of elements per row for the
* smoothed interpolation used for mult-additive or simple method.
* The default is 0.
**/
HYPRE_Int HYPRE_BoomerAMGSetMultAddPMaxElmts(HYPRE_Solver solver,
HYPRE_Int add_P_max_elmts);
/**
* (Optional) Sets maximal size for agglomeration or redundant coarse grid solve.
* When the system is smaller than this threshold, sequential AMG is used
* on process 0 or on all remaining active processes (if redundant = 1 ).
**/
HYPRE_Int HYPRE_BoomerAMGSetSeqThreshold(HYPRE_Solver solver,
HYPRE_Int seq_threshold);
/**
* (Optional) operates switch for redundancy. Needs to be used with
* HYPRE_BoomerAMGSetSeqThreshold. Default is 0, i.e. no redundancy.
**/
HYPRE_Int HYPRE_BoomerAMGSetRedundant(HYPRE_Solver solver,
HYPRE_Int redundant);
/*
* (Optional) Defines the number of sweeps for the fine and coarse grid,
* the up and down cycle.
*
* Note: This routine will be phased out!!!!
* Use HYPRE\_BoomerAMGSetNumSweeps or HYPRE\_BoomerAMGSetCycleNumSweeps instead.
**/
HYPRE_Int HYPRE_BoomerAMGSetNumGridSweeps(HYPRE_Solver solver,
HYPRE_Int *num_grid_sweeps);
/**
* (Optional) Sets the number of sweeps. On the finest level, the up and
* the down cycle the number of sweeps are set to num\_sweeps and on the
* coarsest level to 1. The default is 1.
**/
HYPRE_Int HYPRE_BoomerAMGSetNumSweeps(HYPRE_Solver solver,
HYPRE_Int num_sweeps);
/**
* (Optional) Sets the number of sweeps at a specified cycle.
* There are the following options for k:
*
* \begin{tabular}{|l|l|} \hline
* the down cycle & if k=1 \\
* the up cycle & if k=2 \\
* the coarsest level & if k=3.\\
* \hline
* \end{tabular}
**/
HYPRE_Int HYPRE_BoomerAMGSetCycleNumSweeps(HYPRE_Solver solver,
HYPRE_Int num_sweeps,
HYPRE_Int k);
/**
* (Optional) Defines which smoother is used on the fine and coarse grid,
* the up and down cycle.
*
* Note: This routine will be phased out!!!!
* Use HYPRE\_BoomerAMGSetRelaxType or HYPRE\_BoomerAMGSetCycleRelaxType instead.
**/
HYPRE_Int HYPRE_BoomerAMGSetGridRelaxType(HYPRE_Solver solver,
HYPRE_Int *grid_relax_type);
/**
* (Optional) Defines the smoother to be used. It uses the given
* smoother on the fine grid, the up and
* the down cycle and sets the solver on the coarsest level to Gaussian
* elimination (9). The default is Gauss-Seidel (3).
*
* There are the following options for relax\_type:
*
* \begin{tabular}{|c|l|} \hline
* 0 & Jacobi \\
* 1 & Gauss-Seidel, sequential (very slow!) \\
* 2 & Gauss-Seidel, interior points in parallel, boundary sequential (slow!) \\
* 3 & hybrid Gauss-Seidel or SOR, forward solve \\
* 4 & hybrid Gauss-Seidel or SOR, backward solve \\
* 5 & hybrid chaotic Gauss-Seidel (works only with OpenMP) \\
* 6 & hybrid symmetric Gauss-Seidel or SSOR \\
* 8 & $\ell_1$-scaled hybrid symmetric Gauss-Seidel\\
* 9 & Gaussian elimination (only on coarsest level) \\
* 15 & CG (warning - not a fixed smoother - may require FGMRES)\\
* 16 & Chebyshev\\
* 17 & FCF-Jacobi\\
* 18 & $\ell_1$-scaled jacobi\\
* \hline
* \end{tabular}
**/
HYPRE_Int HYPRE_BoomerAMGSetRelaxType(HYPRE_Solver solver,
HYPRE_Int relax_type);
/**
* (Optional) Defines the smoother at a given cycle.
* For options of relax\_type see
* description of HYPRE\_BoomerAMGSetRelaxType). Options for k are
*
* \begin{tabular}{|l|l|} \hline
* the down cycle & if k=1 \\
* the up cycle & if k=2 \\
* the coarsest level & if k=3. \\
* \hline
* \end{tabular}
**/
HYPRE_Int HYPRE_BoomerAMGSetCycleRelaxType(HYPRE_Solver solver,
HYPRE_Int relax_type,
HYPRE_Int k);
/**
* (Optional) Defines in which order the points are relaxed. There are
* the following options for
* relax\_order:
*
* \begin{tabular}{|c|l|} \hline
* 0 & the points are relaxed in natural or lexicographic
* order on each processor \\
* 1 & CF-relaxation is used, i.e on the fine grid and the down
* cycle the coarse points are relaxed first, \\
* & followed by the fine points; on the up cycle the F-points are relaxed
* first, followed by the C-points. \\
* & On the coarsest level, if an iterative scheme is used,
* the points are relaxed in lexicographic order. \\
* \hline
* \end{tabular}
*
* The default is 1 (CF-relaxation).
**/
HYPRE_Int HYPRE_BoomerAMGSetRelaxOrder(HYPRE_Solver solver,
HYPRE_Int relax_order);
/*
* (Optional) Defines in which order the points are relaxed.
*
* Note: This routine will be phased out!!!!
* Use HYPRE\_BoomerAMGSetRelaxOrder instead.
**/
HYPRE_Int HYPRE_BoomerAMGSetGridRelaxPoints(HYPRE_Solver solver,
HYPRE_Int **grid_relax_points);
/*
* (Optional) Defines the relaxation weight for smoothed Jacobi and hybrid SOR.
*
* Note: This routine will be phased out!!!!
* Use HYPRE\_BoomerAMGSetRelaxWt or HYPRE\_BoomerAMGSetLevelRelaxWt instead.
**/
HYPRE_Int HYPRE_BoomerAMGSetRelaxWeight(HYPRE_Solver solver,
HYPRE_Real *relax_weight);
/**
* (Optional) Defines the relaxation weight for smoothed Jacobi and hybrid SOR
* on all levels.
*
* \begin{tabular}{|l|l|} \hline
* relax\_weight > 0 & this assigns the given relaxation weight on all levels \\
* relax\_weight = 0 & the weight is determined on each level
* with the estimate $3 \over {4\|D^{-1/2}AD^{-1/2}\|}$,\\
* & where $D$ is the diagonal matrix of $A$ (this should only be used with Jacobi) \\
* relax\_weight = -k & the relaxation weight is determined with at most k CG steps
* on each level \\
* & this should only be used for symmetric positive definite problems) \\
* \hline
* \end{tabular}
*
* The default is 1.
**/
HYPRE_Int HYPRE_BoomerAMGSetRelaxWt(HYPRE_Solver solver,
HYPRE_Real relax_weight);
/**
* (Optional) Defines the relaxation weight for smoothed Jacobi and hybrid SOR
* on the user defined level. Note that the finest level is denoted 0, the
* next coarser level 1, etc. For nonpositive relax\_weight, the parameter is
* determined on the given level as described for HYPRE\_BoomerAMGSetRelaxWt.
* The default is 1.
**/
HYPRE_Int HYPRE_BoomerAMGSetLevelRelaxWt(HYPRE_Solver solver,
HYPRE_Real relax_weight,
HYPRE_Int level);
/**
* (Optional) Defines the outer relaxation weight for hybrid SOR.
* Note: This routine will be phased out!!!!
* Use HYPRE\_BoomerAMGSetOuterWt or HYPRE\_BoomerAMGSetLevelOuterWt instead.
**/
HYPRE_Int HYPRE_BoomerAMGSetOmega(HYPRE_Solver solver,
HYPRE_Real *omega);
/**
* (Optional) Defines the outer relaxation weight for hybrid SOR and SSOR
* on all levels.
*
* \begin{tabular}{|l|l|} \hline
* omega > 0 & this assigns the same outer relaxation weight omega on each level\\
* omega = -k & an outer relaxation weight is determined with at most k CG
* steps on each level \\
* & (this only makes sense for symmetric
* positive definite problems and smoothers, e.g. SSOR) \\
* \hline
* \end{tabular}
*
* The default is 1.
**/
HYPRE_Int HYPRE_BoomerAMGSetOuterWt(HYPRE_Solver solver,
HYPRE_Real omega);
/**
* (Optional) Defines the outer relaxation weight for hybrid SOR or SSOR
* on the user defined level. Note that the finest level is denoted 0, the
* next coarser level 1, etc. For nonpositive omega, the parameter is
* determined on the given level as described for HYPRE\_BoomerAMGSetOuterWt.
* The default is 1.
**/
HYPRE_Int HYPRE_BoomerAMGSetLevelOuterWt(HYPRE_Solver solver,
HYPRE_Real omega,
HYPRE_Int level);
/**
* (Optional) Defines the Order for Chebyshev smoother.
* The default is 2 (valid options are 1-4).
**/
HYPRE_Int HYPRE_BoomerAMGSetChebyOrder(HYPRE_Solver solver,
HYPRE_Int order);
/**
* (Optional) Fraction of the spectrum to use for the Chebyshev smoother.
* The default is .3 (i.e., damp on upper 30% of the spectrum).
**/
HYPRE_Int HYPRE_BoomerAMGSetChebyFraction (HYPRE_Solver solver,
HYPRE_Real ratio);
/**
* (Optional) Enables the use of more complex smoothers.
* The following options exist for smooth\_type:
*
* \begin{tabular}{|c|l|l|} \hline
* value & smoother & routines needed to set smoother parameters \\
* 6 & Schwarz smoothers & HYPRE\_BoomerAMGSetDomainType, HYPRE\_BoomerAMGSetOverlap, \\
* & & HYPRE\_BoomerAMGSetVariant, HYPRE\_BoomerAMGSetSchwarzRlxWeight \\
* 7 & Pilut & HYPRE\_BoomerAMGSetDropTol, HYPRE\_BoomerAMGSetMaxNzPerRow \\
* 8 & ParaSails & HYPRE\_BoomerAMGSetSym, HYPRE\_BoomerAMGSetLevel, \\
* & & HYPRE\_BoomerAMGSetFilter, HYPRE\_BoomerAMGSetThreshold \\
* 9 & Euclid & HYPRE\_BoomerAMGSetEuclidFile \\
* \hline
* \end{tabular}
*
* The default is 6. Also, if no smoother parameters are set via the routines mentioned in the table above,
* default values are used.
**/
HYPRE_Int HYPRE_BoomerAMGSetSmoothType(HYPRE_Solver solver,
HYPRE_Int smooth_type);
/**
* (Optional) Sets the number of levels for more complex smoothers.
* The smoothers,
* as defined by HYPRE\_BoomerAMGSetSmoothType, will be used
* on level 0 (the finest level) through level smooth\_num\_levels-1.
* The default is 0, i.e. no complex smoothers are used.
**/
HYPRE_Int HYPRE_BoomerAMGSetSmoothNumLevels(HYPRE_Solver solver,
HYPRE_Int smooth_num_levels);
/**
* (Optional) Sets the number of sweeps for more complex smoothers.
* The default is 1.
**/
HYPRE_Int HYPRE_BoomerAMGSetSmoothNumSweeps(HYPRE_Solver solver,
HYPRE_Int smooth_num_sweeps);
/**
* (Optional) Defines which variant of the Schwarz method is used.
* The following options exist for variant:
*
* \begin{tabular}{|c|l|} \hline
* 0 & hybrid multiplicative Schwarz method (no overlap across processor
* boundaries) \\
* 1 & hybrid additive Schwarz method (no overlap across processor
* boundaries) \\
* 2 & additive Schwarz method \\
* 3 & hybrid multiplicative Schwarz method (with overlap across processor
* boundaries) \\
* \hline
* \end{tabular}
*
* The default is 0.
**/
HYPRE_Int HYPRE_BoomerAMGSetVariant(HYPRE_Solver solver,
HYPRE_Int variant);
/**
* (Optional) Defines the overlap for the Schwarz method.
* The following options exist for overlap:
*
* \begin{tabular}{|c|l|} \hline
* 0 & no overlap \\
* 1 & minimal overlap (default) \\
* 2 & overlap generated by including all neighbors of domain boundaries \\
* \hline
* \end{tabular}
**/
HYPRE_Int HYPRE_BoomerAMGSetOverlap(HYPRE_Solver solver,
HYPRE_Int overlap);
/**
* (Optional) Defines the type of domain used for the Schwarz method.
* The following options exist for domain\_type:
*
* \begin{tabular}{|c|l|} \hline
* 0 & each point is a domain \\
* 1 & each node is a domain (only of interest in "systems" AMG) \\
* 2 & each domain is generated by agglomeration (default) \\
* \hline
* \end{tabular}
**/
HYPRE_Int HYPRE_BoomerAMGSetDomainType(HYPRE_Solver solver,
HYPRE_Int domain_type);
/**
* (Optional) Defines a smoothing parameter for the additive Schwarz method.
**/
HYPRE_Int HYPRE_BoomerAMGSetSchwarzRlxWeight(HYPRE_Solver solver,
HYPRE_Real schwarz_rlx_weight);
/**
* (Optional) Indicates that the aggregates may not be SPD for the Schwarz method.
* The following options exist for use\_nonsymm:
*
* \begin{tabular}{|c|l|} \hline
* 0 & assume SPD (default) \\
* 1 & assume non-symmetric \\
* \hline
* \end{tabular}
**/
HYPRE_Int HYPRE_BoomerAMGSetSchwarzUseNonSymm(HYPRE_Solver solver,
HYPRE_Int use_nonsymm);
/**
* (Optional) Defines symmetry for ParaSAILS.
* For further explanation see description of ParaSAILS.
**/
HYPRE_Int HYPRE_BoomerAMGSetSym(HYPRE_Solver solver,
HYPRE_Int sym);
/**
* (Optional) Defines number of levels for ParaSAILS.
* For further explanation see description of ParaSAILS.
**/
HYPRE_Int HYPRE_BoomerAMGSetLevel(HYPRE_Solver solver,
HYPRE_Int level);
/**
* (Optional) Defines threshold for ParaSAILS.
* For further explanation see description of ParaSAILS.
**/
HYPRE_Int HYPRE_BoomerAMGSetThreshold(HYPRE_Solver solver,
HYPRE_Real threshold);
/**
* (Optional) Defines filter for ParaSAILS.
* For further explanation see description of ParaSAILS.
**/
HYPRE_Int HYPRE_BoomerAMGSetFilter(HYPRE_Solver solver,
HYPRE_Real filter);
/**
* (Optional) Defines drop tolerance for PILUT.
* For further explanation see description of PILUT.
**/
HYPRE_Int HYPRE_BoomerAMGSetDropTol(HYPRE_Solver solver,
HYPRE_Real drop_tol);
/**
* (Optional) Defines maximal number of nonzeros for PILUT.
* For further explanation see description of PILUT.
**/
HYPRE_Int HYPRE_BoomerAMGSetMaxNzPerRow(HYPRE_Solver solver,
HYPRE_Int max_nz_per_row);
/**
* (Optional) Defines name of an input file for Euclid parameters.
* For further explanation see description of Euclid.
**/
HYPRE_Int HYPRE_BoomerAMGSetEuclidFile(HYPRE_Solver solver,
char *euclidfile);
/**
* (Optional) Defines number of levels for ILU(k) in Euclid.
* For further explanation see description of Euclid.
**/
HYPRE_Int HYPRE_BoomerAMGSetEuLevel(HYPRE_Solver solver,
HYPRE_Int eu_level);
/**
* (Optional) Defines filter for ILU(k) for Euclid.
* For further explanation see description of Euclid.
**/
HYPRE_Int HYPRE_BoomerAMGSetEuSparseA(HYPRE_Solver solver,
HYPRE_Real eu_sparse_A);
/**
* (Optional) Defines use of block jacobi ILUT for Euclid.
* For further explanation see description of Euclid.
**/
HYPRE_Int HYPRE_BoomerAMGSetEuBJ(HYPRE_Solver solver,
HYPRE_Int eu_bj);
/*
* (Optional)
**/
HYPRE_Int HYPRE_BoomerAMGSetRestriction(HYPRE_Solver solver,
HYPRE_Int restr_par);
/*
* (Optional) Name of file to which BoomerAMG will print;
* cf HYPRE\_BoomerAMGSetPrintLevel. (Presently this is ignored).
**/
HYPRE_Int HYPRE_BoomerAMGSetPrintFileName(HYPRE_Solver solver,
const char *print_file_name);
/**
* (Optional) Requests automatic printing of setup and solve information.
*
* \begin{tabular}{|c|l|} \hline
* 0 & no printout (default) \\
* 1 & print setup information \\
* 2 & print solve information \\
* 3 & print both setup and solve information \\
* \hline
* \end{tabular}
*
* Note, that if one desires to print information and uses BoomerAMG as a
* preconditioner, suggested print$\_$level is 1 to avoid excessive output,
* and use print$\_$level of solver for solve phase information.
**/
HYPRE_Int HYPRE_BoomerAMGSetPrintLevel(HYPRE_Solver solver,
HYPRE_Int print_level);
/**
* (Optional) Requests additional computations for diagnostic and similar
* data to be logged by the user. Default to 0 for do nothing. The latest
* residual will be available if logging > 1.
**/
HYPRE_Int HYPRE_BoomerAMGSetLogging(HYPRE_Solver solver,
HYPRE_Int logging);
/**
* (Optional)
**/
HYPRE_Int HYPRE_BoomerAMGSetDebugFlag(HYPRE_Solver solver,
HYPRE_Int debug_flag);
/**
* (Optional) This routine will be eliminated in the future.
**/
HYPRE_Int HYPRE_BoomerAMGInitGridRelaxation(HYPRE_Int **num_grid_sweeps_ptr,
HYPRE_Int **grid_relax_type_ptr,
HYPRE_Int ***grid_relax_points_ptr,
HYPRE_Int coarsen_type,
HYPRE_Real **relax_weights_ptr,
HYPRE_Int max_levels);
/**
* (Optional) If rap2 not equal 0, the triple matrix product RAP is
* replaced by two matrix products.
**/
HYPRE_Int HYPRE_BoomerAMGSetRAP2(HYPRE_Solver solver,
HYPRE_Int rap2);
/**
* (Optional) If set to 1, the local interpolation transposes will
* be saved to use more efficient matvecs instead of matvecTs
**/
HYPRE_Int HYPRE_BoomerAMGSetKeepTranspose(HYPRE_Solver solver,
HYPRE_Int keepTranspose);
/*
* HYPRE_BoomerAMGSetPlotGrids
**/
HYPRE_Int HYPRE_BoomerAMGSetPlotGrids (HYPRE_Solver solver,
HYPRE_Int plotgrids);
/*
* HYPRE_BoomerAMGSetPlotFilename
**/
HYPRE_Int HYPRE_BoomerAMGSetPlotFileName (HYPRE_Solver solver,
const char *plotfilename);
/*
* HYPRE_BoomerAMGSetCoordDim
**/
HYPRE_Int HYPRE_BoomerAMGSetCoordDim (HYPRE_Solver solver,
HYPRE_Int coorddim);
/*
* HYPRE_BoomerAMGSetCoordinates
**/
HYPRE_Int HYPRE_BoomerAMGSetCoordinates (HYPRE_Solver solver,
float *coordinates);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name ParCSR ParaSails Preconditioner
*
* Parallel sparse approximate inverse preconditioner for the
* ParCSR matrix format.
**/
/*@{*/
/**
* Create a ParaSails preconditioner.
**/
HYPRE_Int HYPRE_ParaSailsCreate(MPI_Comm comm,
HYPRE_Solver *solver);
/**
* Destroy a ParaSails preconditioner.
**/
HYPRE_Int HYPRE_ParaSailsDestroy(HYPRE_Solver solver);
/**
* Set up the ParaSails preconditioner. This function should be passed
* to the iterative solver {\tt SetPrecond} function.
*
* @param solver [IN] Preconditioner object to set up.
* @param A [IN] ParCSR matrix used to construct the preconditioner.
* @param b Ignored by this function.
* @param x Ignored by this function.
**/
HYPRE_Int HYPRE_ParaSailsSetup(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
/**
* Apply the ParaSails preconditioner. This function should be passed
* to the iterative solver {\tt SetPrecond} function.
*
* @param solver [IN] Preconditioner object to apply.
* @param A Ignored by this function.
* @param b [IN] Vector to precondition.
* @param x [OUT] Preconditioned vector.
**/
HYPRE_Int HYPRE_ParaSailsSolve(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
/**
* Set the threshold and levels parameter for the ParaSails
* preconditioner. The accuracy and cost of ParaSails are
* parameterized by these two parameters. Lower values of the
* threshold parameter and higher values of levels parameter
* lead to more accurate, but more expensive preconditioners.
*
* @param solver [IN] Preconditioner object for which to set parameters.
* @param thresh [IN] Value of threshold parameter, $0 \le$ thresh $\le 1$.
* The default value is 0.1.
* @param nlevels [IN] Value of levels parameter, $0 \le$ nlevels.
* The default value is 1.
**/
HYPRE_Int HYPRE_ParaSailsSetParams(HYPRE_Solver solver,
HYPRE_Real thresh,
HYPRE_Int nlevels);
/**
* Set the filter parameter for the
* ParaSails preconditioner.
*
* @param solver [IN] Preconditioner object for which to set filter parameter.
* @param filter [IN] Value of filter parameter. The filter parameter is
* used to drop small nonzeros in the preconditioner,
* to reduce the cost of applying the preconditioner.
* Values from 0.05 to 0.1 are recommended.
* The default value is 0.1.
**/
HYPRE_Int HYPRE_ParaSailsSetFilter(HYPRE_Solver solver,
HYPRE_Real filter);
/**
* Set the symmetry parameter for the
* ParaSails preconditioner.
*
* \begin{tabular}{|c|l|} \hline
* value & meaning \\ \hline
* 0 & nonsymmetric and/or indefinite problem, and nonsymmetric preconditioner\\
* 1 & SPD problem, and SPD (factored) preconditioner \\
* 2 & nonsymmetric, definite problem, and SPD (factored) preconditioner \\
* \hline
* \end{tabular}
*
* @param solver [IN] Preconditioner object for which to set symmetry parameter.
* @param sym [IN] Symmetry parameter.
**/
HYPRE_Int HYPRE_ParaSailsSetSym(HYPRE_Solver solver,
HYPRE_Int sym);
/**
* Set the load balance parameter for the
* ParaSails preconditioner.
*
* @param solver [IN] Preconditioner object for which to set the load balance
* parameter.
* @param loadbal [IN] Value of the load balance parameter,
* $0 \le$ loadbal $\le 1$. A zero value indicates that
* no load balance is attempted; a value of unity indicates
* that perfect load balance will be attempted. The
* recommended value is 0.9 to balance the overhead of
* data exchanges for load balancing. No load balancing
* is needed if the preconditioner is very sparse and
* fast to construct. The default value when this
* parameter is not set is 0.
**/
HYPRE_Int HYPRE_ParaSailsSetLoadbal(HYPRE_Solver solver,
HYPRE_Real loadbal);
/**
* Set the pattern reuse parameter for the
* ParaSails preconditioner.
*
* @param solver [IN] Preconditioner object for which to set the pattern reuse
* parameter.
* @param reuse [IN] Value of the pattern reuse parameter. A nonzero value
* indicates that the pattern of the preconditioner should
* be reused for subsequent constructions of the
* preconditioner. A zero value indicates that the
* preconditioner should be constructed from scratch.
* The default value when this parameter is not set is 0.
**/
HYPRE_Int HYPRE_ParaSailsSetReuse(HYPRE_Solver solver,
HYPRE_Int reuse);
/**
* Set the logging parameter for the
* ParaSails preconditioner.
*
* @param solver [IN] Preconditioner object for which to set the logging
* parameter.
* @param logging [IN] Value of the logging parameter. A nonzero value
* sends statistics of the setup procedure to stdout.
* The default value when this parameter is not set is 0.
**/
HYPRE_Int HYPRE_ParaSailsSetLogging(HYPRE_Solver solver,
HYPRE_Int logging);
/**
* Build IJ Matrix of the sparse approximate inverse (factor).
* This function explicitly creates the IJ Matrix corresponding to
* the sparse approximate inverse or the inverse factor.
* Example: HYPRE\_IJMatrix ij\_A;
* HYPRE\_ParaSailsBuildIJMatrix(solver, \&ij\_A);
*
* @param solver [IN] Preconditioner object.
* @param pij_A [OUT] Pointer to the IJ Matrix.
**/
HYPRE_Int HYPRE_ParaSailsBuildIJMatrix(HYPRE_Solver solver,
HYPRE_IJMatrix *pij_A);
/* ParCSRParaSails routines */
HYPRE_Int HYPRE_ParCSRParaSailsCreate(MPI_Comm comm,
HYPRE_Solver *solver);
HYPRE_Int HYPRE_ParCSRParaSailsDestroy(HYPRE_Solver solver);
HYPRE_Int HYPRE_ParCSRParaSailsSetup(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_ParCSRParaSailsSolve(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_ParCSRParaSailsSetParams(HYPRE_Solver solver,
HYPRE_Real thresh,
HYPRE_Int nlevels);
HYPRE_Int HYPRE_ParCSRParaSailsSetFilter(HYPRE_Solver solver,
HYPRE_Real filter);
HYPRE_Int HYPRE_ParCSRParaSailsSetSym(HYPRE_Solver solver,
HYPRE_Int sym);
HYPRE_Int HYPRE_ParCSRParaSailsSetLoadbal(HYPRE_Solver solver,
HYPRE_Real loadbal);
HYPRE_Int HYPRE_ParCSRParaSailsSetReuse(HYPRE_Solver solver,
HYPRE_Int reuse);
HYPRE_Int HYPRE_ParCSRParaSailsSetLogging(HYPRE_Solver solver,
HYPRE_Int logging);
/*@}*/
/*--------------------------------------------------------------------------*
*--------------------------------------------------------------------------*/
/**
* @name ParCSR Euclid Preconditioner
*
* MPI Parallel ILU preconditioner
*
* Options summary:
* \begin{center}
* \begin{tabular}{|l|c|l|}
* \hline
* Option & Default & Synopsis \\
* \hline
* -level & 1 & ILU($k$) factorization level \\ \hline
* -bj & 0 (false) & Use Block Jacobi ILU instead of PILU \\ \hline
* -eu\_stats & 0 (false) & Print internal timing and statistics \\ \hline
* -eu\_mem & 0 (false) & Print internal memory usage \\ \hline
* \end{tabular}
* \end{center}
*
**/
/*@{*/
/**
* Create a Euclid object.
**/
HYPRE_Int HYPRE_EuclidCreate(MPI_Comm comm,
HYPRE_Solver *solver);
/**
* Destroy a Euclid object.
**/
HYPRE_Int HYPRE_EuclidDestroy(HYPRE_Solver solver);
/**
* Set up the Euclid preconditioner. This function should be passed
* to the iterative solver {\tt SetPrecond} function.
*
* @param solver [IN] Preconditioner object to set up.
* @param A [IN] ParCSR matrix used to construct the preconditioner.
* @param b Ignored by this function.
* @param x Ignored by this function.
**/
HYPRE_Int HYPRE_EuclidSetup(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
/**
* Apply the Euclid preconditioner. This function should be passed
* to the iterative solver {\tt SetPrecond} function.
*
* @param solver [IN] Preconditioner object to apply.
* @param A Ignored by this function.
* @param b [IN] Vector to precondition.
* @param x [OUT] Preconditioned vector.
**/
HYPRE_Int HYPRE_EuclidSolve(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
/**
* Insert (name, value) pairs in Euclid's options database
* by passing Euclid the command line (or an array of strings).
* All Euclid options (e.g, level, drop-tolerance) are stored in
* this database.
* If a (name, value) pair already exists, this call updates the value.
* See also: HYPRE\_EuclidSetParamsFromFile.
*
* @param argc [IN] Length of argv array
* @param argv [IN] Array of strings
**/
HYPRE_Int HYPRE_EuclidSetParams(HYPRE_Solver solver,
HYPRE_Int argc,
char *argv[]);
/**
* Insert (name, value) pairs in Euclid's options database.
* Each line of the file should either begin with a ``\#,''
* indicating a comment line, or contain a (name value)
* pair, e.g: \\
*
* >cat optionsFile \\
* \#sample runtime parameter file \\
* -blockJacobi 3 \\
* -matFile /home/hysom/myfile.euclid \\
* -doSomething true \\
* -xx\_coeff -1.0
*
* See also: HYPRE\_EuclidSetParams.
*
* @param filename[IN] Pathname/filename to read
**/
HYPRE_Int HYPRE_EuclidSetParamsFromFile(HYPRE_Solver solver,
char *filename);
/**
* Set level k for ILU(k) factorization, default: 1
**/
HYPRE_Int HYPRE_EuclidSetLevel(HYPRE_Solver solver,
HYPRE_Int level);
/**
* Use block Jacobi ILU preconditioning instead of PILU
**/
HYPRE_Int HYPRE_EuclidSetBJ(HYPRE_Solver solver,
HYPRE_Int bj);
/**
* If eu\_stats not equal 0, a summary of runtime settings and
* timing information is printed to stdout.
**/
HYPRE_Int HYPRE_EuclidSetStats(HYPRE_Solver solver,
HYPRE_Int eu_stats);
/**
* If eu\_mem not equal 0, a summary of Euclid's memory usage
* is printed to stdout.
**/
HYPRE_Int HYPRE_EuclidSetMem(HYPRE_Solver solver,
HYPRE_Int eu_mem);
/**
* Defines a drop tolerance for ILU(k). Default: 0
* Use with HYPRE\_EuclidSetRowScale.
* Note that this can destroy symmetry in a matrix.
**/
HYPRE_Int HYPRE_EuclidSetSparseA(HYPRE_Solver solver,
HYPRE_Real sparse_A);
/**
* If row\_scale not equal 0, values are scaled prior to factorization
* so that largest value in any row is +1 or -1.
* Note that this can destroy symmetry in a matrix.
**/
HYPRE_Int HYPRE_EuclidSetRowScale(HYPRE_Solver solver,
HYPRE_Int row_scale);
/**
* uses ILUT and defines a drop tolerance relative to the largest
* absolute value of any entry in the row being factored.
**/
HYPRE_Int HYPRE_EuclidSetILUT(HYPRE_Solver solver,
HYPRE_Real drop_tol);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name ParCSR Pilut Preconditioner
**/
/*@{*/
/**
* Create a preconditioner object.
**/
HYPRE_Int HYPRE_ParCSRPilutCreate(MPI_Comm comm,
HYPRE_Solver *solver);
/**
* Destroy a preconditioner object.
**/
HYPRE_Int HYPRE_ParCSRPilutDestroy(HYPRE_Solver solver);
/**
**/
HYPRE_Int HYPRE_ParCSRPilutSetup(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
/**
* Precondition the system.
**/
HYPRE_Int HYPRE_ParCSRPilutSolve(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
/**
* (Optional) Set maximum number of iterations.
**/
HYPRE_Int HYPRE_ParCSRPilutSetMaxIter(HYPRE_Solver solver,
HYPRE_Int max_iter);
/**
* (Optional)
**/
HYPRE_Int HYPRE_ParCSRPilutSetDropTolerance(HYPRE_Solver solver,
HYPRE_Real tol);
/**
* (Optional)
**/
HYPRE_Int HYPRE_ParCSRPilutSetFactorRowSize(HYPRE_Solver solver,
HYPRE_Int size);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name ParCSR AMS Solver and Preconditioner
*
* Parallel auxiliary space Maxwell solver and preconditioner
**/
/*@{*/
/**
* Create an AMS solver object.
**/
HYPRE_Int HYPRE_AMSCreate(HYPRE_Solver *solver);
/**
* Destroy an AMS solver object.
**/
HYPRE_Int HYPRE_AMSDestroy(HYPRE_Solver solver);
/**
* Set up the AMS solver or preconditioner.
* If used as a preconditioner, this function should be passed
* to the iterative solver {\tt SetPrecond} function.
*
* @param solver [IN] object to be set up.
* @param A [IN] ParCSR matrix used to construct the solver/preconditioner.
* @param b Ignored by this function.
* @param x Ignored by this function.
**/
HYPRE_Int HYPRE_AMSSetup(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
/**
* Solve the system or apply AMS as a preconditioner.
* If used as a preconditioner, this function should be passed
* to the iterative solver {\tt SetPrecond} function.
*
* @param solver [IN] solver or preconditioner object to be applied.
* @param A [IN] ParCSR matrix, matrix of the linear system to be solved
* @param b [IN] right hand side of the linear system to be solved
* @param x [OUT] approximated solution of the linear system to be solved
**/
HYPRE_Int HYPRE_AMSSolve(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
/**
* (Optional) Sets the problem dimension (2 or 3). The default is 3.
**/
HYPRE_Int HYPRE_AMSSetDimension(HYPRE_Solver solver,
HYPRE_Int dim);
/**
* Sets the discrete gradient matrix $G$.
* This function should be called before HYPRE\_AMSSetup()!
**/
HYPRE_Int HYPRE_AMSSetDiscreteGradient(HYPRE_Solver solver,
HYPRE_ParCSRMatrix G);
/**
* Sets the $x$, $y$ and $z$ coordinates of the vertices in the mesh.
*
* Either HYPRE\_AMSSetCoordinateVectors() or HYPRE\_AMSSetEdgeConstantVectors()
* should be called before HYPRE\_AMSSetup()!
**/
HYPRE_Int HYPRE_AMSSetCoordinateVectors(HYPRE_Solver solver,
HYPRE_ParVector x,
HYPRE_ParVector y,
HYPRE_ParVector z);
/**
* Sets the vectors $Gx$, $Gy$ and $Gz$ which give the representations of
* the constant vector fields $(1,0,0)$, $(0,1,0)$ and $(0,0,1)$ in the
* edge element basis.
*
* Either HYPRE\_AMSSetCoordinateVectors() or HYPRE\_AMSSetEdgeConstantVectors()
* should be called before HYPRE\_AMSSetup()!
**/
HYPRE_Int HYPRE_AMSSetEdgeConstantVectors(HYPRE_Solver solver,
HYPRE_ParVector Gx,
HYPRE_ParVector Gy,
HYPRE_ParVector Gz);
/**
* (Optional) Set the (components of) the Nedelec interpolation matrix
* $\Pi = [ \Pi^x, \Pi^y, \Pi^z ]$.
*
* This function is generally intended to be used only for high-order Nedelec
* discretizations (in the lowest order case, $\Pi$ is constructed internally in
* AMS from the discreet gradient matrix and the coordinates of the vertices),
* though it can also be used in the lowest-order case or for other types of
* discretizations (e.g. ones based on the second family of Nedelec elements).
*
* By definition, $\Pi$ is the matrix representation of the linear operator that
* interpolates (high-order) vector nodal finite elements into the (high-order)
* Nedelec space. The component matrices are defined as $\Pi^x \varphi = \Pi
* (\varphi,0,0)$ and similarly for $\Pi^y$ and $\Pi^z$. Note that all these
* operators depend on the choice of the basis and degrees of freedom in the
* high-order spaces.
*
* The column numbering of Pi should be node-based, i.e. the $x$/$y$/$z$
* components of the first node (vertex or high-order dof) should be listed
* first, followed by the $x$/$y$/$z$ components of the second node and so on
* (see the documentation of HYPRE\_BoomerAMGSetDofFunc).
*
* If used, this function should be called before HYPRE\_AMSSetup() and there is
* no need to provide the vertex coordinates. Furthermore, only one of the sets
* $\{\Pi\}$ and $\{\Pi^x,\Pi^y,\Pi^z\}$ needs to be specified (though it is OK
* to provide both). If Pix is NULL, then scalar $\Pi$-based AMS cycles,
* i.e. those with cycle\_type > 10, will be unavailable. Similarly, AMS cycles
* based on monolithic $\Pi$ (cycle\_type < 10) require that Pi is not NULL.
**/
HYPRE_Int HYPRE_AMSSetInterpolations(HYPRE_Solver solver,
HYPRE_ParCSRMatrix Pi,
HYPRE_ParCSRMatrix Pix,
HYPRE_ParCSRMatrix Piy,
HYPRE_ParCSRMatrix Piz);
/**
* (Optional) Sets the matrix $A_\alpha$ corresponding to the Poisson
* problem with coefficient $\alpha$ (the curl-curl term coefficient in
* the Maxwell problem).
*
* If this function is called, the coarse space solver on the range
* of $\Pi^T$ is a block-diagonal version of $A_\Pi$. If this function is not
* called, the coarse space solver on the range of $\Pi^T$ is constructed
* as $\Pi^T A \Pi$ in HYPRE\_AMSSetup(). See the user's manual for more details.
**/
HYPRE_Int HYPRE_AMSSetAlphaPoissonMatrix(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A_alpha);
/**
* (Optional) Sets the matrix $A_\beta$ corresponding to the Poisson
* problem with coefficient $\beta$ (the mass term coefficient in the
* Maxwell problem).
*
* If not given, the Poisson matrix will be computed in HYPRE\_AMSSetup().
* If the given matrix is NULL, we assume that $\beta$ is identically $0$
* and use two-level (instead of three-level) methods. See the user's manual for more details.
**/
HYPRE_Int HYPRE_AMSSetBetaPoissonMatrix(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A_beta);
/**
* (Optional) Set the list of nodes which are interior to a zero-conductivity
* region. This way, a more robust solver is constructed, that can be iterated
* to lower tolerance levels. A node is interior if its entry in the array is
* 1.0. This function should be called before HYPRE\_AMSSetup()!
**/
HYPRE_Int HYPRE_AMSSetInteriorNodes(HYPRE_Solver solver,
HYPRE_ParVector interior_nodes);
/**
* (Optional) Set the frequency at which a projection onto the compatible
* subspace for problems with zero-conductivity regions is performed. The
* default value is 5.
**/
HYPRE_Int HYPRE_AMSSetProjectionFrequency(HYPRE_Solver solver,
HYPRE_Int projection_frequency);
/**
* (Optional) Sets maximum number of iterations, if AMS is used
* as a solver. To use AMS as a preconditioner, set the maximum
* number of iterations to $1$. The default is $20$.
**/
HYPRE_Int HYPRE_AMSSetMaxIter(HYPRE_Solver solver,
HYPRE_Int maxit);
/**
* (Optional) Set the convergence tolerance, if AMS is used
* as a solver. When using AMS as a preconditioner, set the tolerance
* to $0.0$. The default is $10^{-6}$.
**/
HYPRE_Int HYPRE_AMSSetTol(HYPRE_Solver solver,
HYPRE_Real tol);
/**
* (Optional) Choose which three-level solver to use. Possible values are:
*
* \begin{tabular}{|c|l|}
* \hline
* 1 & 3-level multiplicative solver (01210) \\
* 2 & 3-level additive solver (0+1+2) \\
* 3 & 3-level multiplicative solver (02120) \\
* 4 & 3-level additive solver (010+2) \\
* 5 & 3-level multiplicative solver (0102010) \\
* 6 & 3-level additive solver (1+020) \\
* 7 & 3-level multiplicative solver (0201020) \\
* 8 & 3-level additive solver (0(1+2)0) \\
* 11 & 5-level multiplicative solver (013454310) \\
* 12 & 5-level additive solver (0+1+3+4+5) \\
* 13 & 5-level multiplicative solver (034515430) \\
* 14 & 5-level additive solver (01(3+4+5)10) \\
* \hline
* \end{tabular}
*
* The default is $1$. See the user's manual for more details.
**/
HYPRE_Int HYPRE_AMSSetCycleType(HYPRE_Solver solver,
HYPRE_Int cycle_type);
/**
* (Optional) Control how much information is printed during the
* solution iterations.
* The default is $1$ (print residual norm at each step).
**/
HYPRE_Int HYPRE_AMSSetPrintLevel(HYPRE_Solver solver,
HYPRE_Int print_level);
/**
* (Optional) Sets relaxation parameters for $A$.
* The defaults are $2$, $1$, $1.0$, $1.0$.
*
* The available options for relax\_type are:
*
* \begin{tabular}{|c|l|} \hline
* 1 & $\ell_1$-scaled Jacobi \\
* 2 & $\ell_1$-scaled block symmetric Gauss-Seidel/SSOR \\
* 3 & Kaczmarz \\
* 4 & truncated version of $\ell_1$-scaled block symmetric Gauss-Seidel/SSOR \\
* 16 & Chebyshev \\
* \hline
* \end{tabular}
**/
HYPRE_Int HYPRE_AMSSetSmoothingOptions(HYPRE_Solver solver,
HYPRE_Int relax_type,
HYPRE_Int relax_times,
HYPRE_Real relax_weight,
HYPRE_Real omega);
/**
* (Optional) Sets AMG parameters for $B_\Pi$.
* The defaults are $10$, $1$, $3$, $0.25$, $0$, $0$. See the user's manual for more details.
**/
HYPRE_Int HYPRE_AMSSetAlphaAMGOptions(HYPRE_Solver solver,
HYPRE_Int alpha_coarsen_type,
HYPRE_Int alpha_agg_levels,
HYPRE_Int alpha_relax_type,
HYPRE_Real alpha_strength_threshold,
HYPRE_Int alpha_interp_type,
HYPRE_Int alpha_Pmax);
/**
* (Optional) Sets the coarsest level relaxation in the AMG solver for $B_\Pi$.
* The default is $8$ (l1-GS). Use $9$, $19$, $29$ or $99$ for a direct solver.
**/
HYPRE_Int HYPRE_AMSSetAlphaAMGCoarseRelaxType(HYPRE_Solver solver,
HYPRE_Int alpha_coarse_relax_type);
/**
* (Optional) Sets AMG parameters for $B_G$.
* The defaults are $10$, $1$, $3$, $0.25$, $0$, $0$. See the user's manual for more details.
**/
HYPRE_Int HYPRE_AMSSetBetaAMGOptions(HYPRE_Solver solver,
HYPRE_Int beta_coarsen_type,
HYPRE_Int beta_agg_levels,
HYPRE_Int beta_relax_type,
HYPRE_Real beta_strength_threshold,
HYPRE_Int beta_interp_type,
HYPRE_Int beta_Pmax);
/**
* (Optional) Sets the coarsest level relaxation in the AMG solver for $B_G$.
* The default is $8$ (l1-GS). Use $9$, $19$, $29$ or $99$ for a direct solver.
**/
HYPRE_Int HYPRE_AMSSetBetaAMGCoarseRelaxType(HYPRE_Solver solver,
HYPRE_Int beta_coarse_relax_type);
/**
* Returns the number of iterations taken.
**/
HYPRE_Int HYPRE_AMSGetNumIterations(HYPRE_Solver solver,
HYPRE_Int *num_iterations);
/**
* Returns the norm of the final relative residual.
**/
HYPRE_Int HYPRE_AMSGetFinalRelativeResidualNorm(HYPRE_Solver solver,
HYPRE_Real *rel_resid_norm);
/**
* For problems with zero-conductivity regions, project the vector onto the
* compatible subspace: $x = (I - G_0 (G_0^t G_0)^{-1} G_0^T) x$, where $G_0$ is
* the discrete gradient restricted to the interior nodes of the regions with
* zero conductivity. This ensures that x is orthogonal to the gradients in the
* range of $G_0$.
*
* This function is typically called after the solution iteration is complete,
* in order to facilitate the visualization of the computed field. Without it
* the values in the zero-conductivity regions contain kernel components.
**/
HYPRE_Int HYPRE_AMSProjectOutGradients(HYPRE_Solver solver,
HYPRE_ParVector x);
/**
* Construct and return the lowest-order discrete gradient matrix G using some
* edge and vertex information. We assume that edge\_vertex lists the edge
* vertices consecutively, and that the orientation of all edges is consistent.
*
* If edge\_orientation = 1, the edges are already oriented.
*
* If edge\_orientation = 2, the orientation of edge i depends only
* on the sign of edge\_vertex[2*i+1] - edge\_vertex[2*i].
**/
HYPRE_Int HYPRE_AMSConstructDiscreteGradient(HYPRE_ParCSRMatrix A,
HYPRE_ParVector x_coord,
HYPRE_Int *edge_vertex,
HYPRE_Int edge_orientation,
HYPRE_ParCSRMatrix *G);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name ParCSR ADS Solver and Preconditioner
*
* Parallel auxiliary space divergence solver and preconditioner
**/
/*@{*/
/**
* Create an ADS solver object.
**/
HYPRE_Int HYPRE_ADSCreate(HYPRE_Solver *solver);
/**
* Destroy an ADS solver object.
**/
HYPRE_Int HYPRE_ADSDestroy(HYPRE_Solver solver);
/**
* Set up the ADS solver or preconditioner.
* If used as a preconditioner, this function should be passed
* to the iterative solver {\tt SetPrecond} function.
*
* @param solver [IN] object to be set up.
* @param A [IN] ParCSR matrix used to construct the solver/preconditioner.
* @param b Ignored by this function.
* @param x Ignored by this function.
**/
HYPRE_Int HYPRE_ADSSetup(HYPRE_Solver solver ,
HYPRE_ParCSRMatrix A ,
HYPRE_ParVector b ,
HYPRE_ParVector x);
/**
* Solve the system or apply ADS as a preconditioner.
* If used as a preconditioner, this function should be passed
* to the iterative solver {\tt SetPrecond} function.
*
* @param solver [IN] solver or preconditioner object to be applied.
* @param A [IN] ParCSR matrix, matrix of the linear system to be solved
* @param b [IN] right hand side of the linear system to be solved
* @param x [OUT] approximated solution of the linear system to be solved
**/
HYPRE_Int HYPRE_ADSSolve(HYPRE_Solver solver ,
HYPRE_ParCSRMatrix A ,
HYPRE_ParVector b ,
HYPRE_ParVector x);
/**
* Sets the discrete curl matrix $C$.
* This function should be called before HYPRE\_ADSSetup()!
**/
HYPRE_Int HYPRE_ADSSetDiscreteCurl(HYPRE_Solver solver ,
HYPRE_ParCSRMatrix C);
/**
* Sets the discrete gradient matrix $G$.
* This function should be called before HYPRE\_ADSSetup()!
**/
HYPRE_Int HYPRE_ADSSetDiscreteGradient(HYPRE_Solver solver ,
HYPRE_ParCSRMatrix G);
/**
* Sets the $x$, $y$ and $z$ coordinates of the vertices in the mesh.
* This function should be called before HYPRE\_ADSSetup()!
**/
HYPRE_Int HYPRE_ADSSetCoordinateVectors(HYPRE_Solver solver ,
HYPRE_ParVector x ,
HYPRE_ParVector y ,
HYPRE_ParVector z);
/**
* (Optional) Set the (components of) the Raviart-Thomas ($\Pi_{RT}$) and the Nedelec
* ($\Pi_{ND}$) interpolation matrices.
*
* This function is generally intended to be used only for high-order $H(div)$
* discretizations (in the lowest order case, these matrices are constructed
* internally in ADS from the discreet gradient and curl matrices and the
* coordinates of the vertices), though it can also be used in the lowest-order
* case or for other types of discretizations.
*
* By definition, RT\_Pi and ND\_Pi are the matrix representations of the linear
* operators $\Pi_{RT}$ and $\Pi_{ND}$ that interpolate (high-order) vector
* nodal finite elements into the (high-order) Raviart-Thomas and Nedelec
* spaces. The component matrices are defined in both cases as $\Pi^x \varphi =
* \Pi (\varphi,0,0)$ and similarly for $\Pi^y$ and $\Pi^z$. Note that all these
* operators depend on the choice of the basis and degrees of freedom in the
* high-order spaces.
*
* The column numbering of RT\_Pi and ND\_Pi should be node-based, i.e. the
* $x$/$y$/$z$ components of the first node (vertex or high-order dof) should be
* listed first, followed by the $x$/$y$/$z$ components of the second node and
* so on (see the documentation of HYPRE\_BoomerAMGSetDofFunc).
*
* If used, this function should be called before hypre\_ADSSetup() and there is
* no need to provide the vertex coordinates. Furthermore, only one of the sets
* $\{\Pi_{RT}\}$ and $\{\Pi_{RT}^x,\Pi_{RT}^y,\Pi_{RT}^z\}$ needs to be
* specified (though it is OK to provide both). If RT\_Pix is NULL, then scalar
* $\Pi$-based ADS cycles, i.e. those with cycle\_type > 10, will be
* unavailable. Similarly, ADS cycles based on monolithic $\Pi$ (cycle\_type <
* 10) require that RT\_Pi is not NULL. The same restrictions hold for the sets
* $\{\Pi_{ND}\}$ and $\{\Pi_{ND}^x,\Pi_{ND}^y,\Pi_{ND}^z\}$ -- only one of them
* needs to be specified, and the availability of each enables different AMS
* cycle type options.
**/
HYPRE_Int HYPRE_ADSSetInterpolations(HYPRE_Solver solver,
HYPRE_ParCSRMatrix RT_Pi,
HYPRE_ParCSRMatrix RT_Pix,
HYPRE_ParCSRMatrix RT_Piy,
HYPRE_ParCSRMatrix RT_Piz,
HYPRE_ParCSRMatrix ND_Pi,
HYPRE_ParCSRMatrix ND_Pix,
HYPRE_ParCSRMatrix ND_Piy,
HYPRE_ParCSRMatrix ND_Piz);
/**
* (Optional) Sets maximum number of iterations, if ADS is used
* as a solver. To use ADS as a preconditioner, set the maximum
* number of iterations to $1$. The default is $20$.
**/
HYPRE_Int HYPRE_ADSSetMaxIter(HYPRE_Solver solver ,
HYPRE_Int maxit);
/**
* (Optional) Set the convergence tolerance, if ADS is used
* as a solver. When using ADS as a preconditioner, set the tolerance
* to $0.0$. The default is $10^{-6}$.
**/
HYPRE_Int HYPRE_ADSSetTol(HYPRE_Solver solver ,
HYPRE_Real tol);
/**
* (Optional) Choose which auxiliary-space solver to use. Possible values are:
*
* \begin{tabular}{|c|l|}
* \hline
* 1 & 3-level multiplicative solver (01210) \\
* 2 & 3-level additive solver (0+1+2) \\
* 3 & 3-level multiplicative solver (02120) \\
* 4 & 3-level additive solver (010+2) \\
* 5 & 3-level multiplicative solver (0102010) \\
* 6 & 3-level additive solver (1+020) \\
* 7 & 3-level multiplicative solver (0201020) \\
* 8 & 3-level additive solver (0(1+2)0) \\
* 11 & 5-level multiplicative solver (013454310) \\
* 12 & 5-level additive solver (0+1+3+4+5) \\
* 13 & 5-level multiplicative solver (034515430) \\
* 14 & 5-level additive solver (01(3+4+5)10) \\
* \hline
* \end{tabular}
*
* The default is $1$. See the user's manual for more details.
**/
HYPRE_Int HYPRE_ADSSetCycleType(HYPRE_Solver solver ,
HYPRE_Int cycle_type);
/**
* (Optional) Control how much information is printed during the
* solution iterations.
* The default is $1$ (print residual norm at each step).
**/
HYPRE_Int HYPRE_ADSSetPrintLevel(HYPRE_Solver solver ,
HYPRE_Int print_level);
/**
* (Optional) Sets relaxation parameters for $A$.
* The defaults are $2$, $1$, $1.0$, $1.0$.
*
* The available options for relax\_type are:
*
* \begin{tabular}{|c|l|} \hline
* 1 & $\ell_1$-scaled Jacobi \\
* 2 & $\ell_1$-scaled block symmetric Gauss-Seidel/SSOR \\
* 3 & Kaczmarz \\
* 4 & truncated version of $\ell_1$-scaled block symmetric Gauss-Seidel/SSOR \\
* 16 & Chebyshev \\
* \hline
* \end{tabular}
**/
HYPRE_Int HYPRE_ADSSetSmoothingOptions(HYPRE_Solver solver ,
HYPRE_Int relax_type ,
HYPRE_Int relax_times ,
HYPRE_Real relax_weight ,
HYPRE_Real omega);
/**
* (Optional) Sets parameters for Chebyshev relaxation.
* The defaults are $2$, $0.3$.
**/
HYPRE_Int HYPRE_ADSSetChebySmoothingOptions(HYPRE_Solver solver ,
HYPRE_Int cheby_order ,
HYPRE_Int cheby_fraction);
/**
* (Optional) Sets AMS parameters for $B_C$.
* The defaults are $11$, $10$, $1$, $3$, $0.25$, $0$, $0$.
* Note that cycle\_type should be greater than 10, unless the high-order
* interface of HYPRE\_ADSSetInterpolations is being used!
* See the user's manual for more details.
**/
HYPRE_Int HYPRE_ADSSetAMSOptions(HYPRE_Solver solver ,
HYPRE_Int cycle_type ,
HYPRE_Int coarsen_type ,
HYPRE_Int agg_levels ,
HYPRE_Int relax_type ,
HYPRE_Real strength_threshold ,
HYPRE_Int interp_type ,
HYPRE_Int Pmax);
/**
* (Optional) Sets AMG parameters for $B_\Pi$.
* The defaults are $10$, $1$, $3$, $0.25$, $0$, $0$. See the user's manual for more details.
**/
HYPRE_Int HYPRE_ADSSetAMGOptions(HYPRE_Solver solver ,
HYPRE_Int coarsen_type ,
HYPRE_Int agg_levels ,
HYPRE_Int relax_type ,
HYPRE_Real strength_threshold ,
HYPRE_Int interp_type ,
HYPRE_Int Pmax);
/**
* Returns the number of iterations taken.
**/
HYPRE_Int HYPRE_ADSGetNumIterations(HYPRE_Solver solver ,
HYPRE_Int *num_iterations);
/**
* Returns the norm of the final relative residual.
**/
HYPRE_Int HYPRE_ADSGetFinalRelativeResidualNorm(HYPRE_Solver solver ,
HYPRE_Real *rel_resid_norm);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name ParCSR PCG Solver
*
* These routines should be used in conjunction with the generic interface in
* \Ref{PCG Solver}.
**/
/*@{*/
/**
* Create a solver object.
**/
HYPRE_Int HYPRE_ParCSRPCGCreate(MPI_Comm comm,
HYPRE_Solver *solver);
/**
* Destroy a solver object.
**/
HYPRE_Int HYPRE_ParCSRPCGDestroy(HYPRE_Solver solver);
HYPRE_Int HYPRE_ParCSRPCGSetup(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_ParCSRPCGSolve(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_ParCSRPCGSetTol(HYPRE_Solver solver,
HYPRE_Real tol);
HYPRE_Int HYPRE_ParCSRPCGSetAbsoluteTol(HYPRE_Solver solver,
HYPRE_Real tol);
HYPRE_Int HYPRE_ParCSRPCGSetMaxIter(HYPRE_Solver solver,
HYPRE_Int max_iter);
/*
* RE-VISIT
**/
HYPRE_Int HYPRE_ParCSRPCGSetStopCrit(HYPRE_Solver solver,
HYPRE_Int stop_crit);
HYPRE_Int HYPRE_ParCSRPCGSetTwoNorm(HYPRE_Solver solver,
HYPRE_Int two_norm);
HYPRE_Int HYPRE_ParCSRPCGSetRelChange(HYPRE_Solver solver,
HYPRE_Int rel_change);
HYPRE_Int HYPRE_ParCSRPCGSetPrecond(HYPRE_Solver solver,
HYPRE_PtrToParSolverFcn precond,
HYPRE_PtrToParSolverFcn precond_setup,
HYPRE_Solver precond_solver);
HYPRE_Int HYPRE_ParCSRPCGGetPrecond(HYPRE_Solver solver,
HYPRE_Solver *precond_data);
HYPRE_Int HYPRE_ParCSRPCGSetLogging(HYPRE_Solver solver,
HYPRE_Int logging);
HYPRE_Int HYPRE_ParCSRPCGSetPrintLevel(HYPRE_Solver solver,
HYPRE_Int print_level);
HYPRE_Int HYPRE_ParCSRPCGGetNumIterations(HYPRE_Solver solver,
HYPRE_Int *num_iterations);
HYPRE_Int HYPRE_ParCSRPCGGetFinalRelativeResidualNorm(HYPRE_Solver solver,
HYPRE_Real *norm);
/**
* Setup routine for diagonal preconditioning.
**/
HYPRE_Int HYPRE_ParCSRDiagScaleSetup(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector y,
HYPRE_ParVector x);
/**
* Solve routine for diagonal preconditioning.
**/
HYPRE_Int HYPRE_ParCSRDiagScale(HYPRE_Solver solver,
HYPRE_ParCSRMatrix HA,
HYPRE_ParVector Hy,
HYPRE_ParVector Hx);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name ParCSR GMRES Solver
*
* These routines should be used in conjunction with the generic interface in
* \Ref{GMRES Solver}.
**/
/*@{*/
/**
* Create a solver object.
**/
HYPRE_Int HYPRE_ParCSRGMRESCreate(MPI_Comm comm,
HYPRE_Solver *solver);
/**
* Destroy a solver object.
**/
HYPRE_Int HYPRE_ParCSRGMRESDestroy(HYPRE_Solver solver);
HYPRE_Int HYPRE_ParCSRGMRESSetup(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_ParCSRGMRESSolve(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_ParCSRGMRESSetKDim(HYPRE_Solver solver,
HYPRE_Int k_dim);
HYPRE_Int HYPRE_ParCSRGMRESSetTol(HYPRE_Solver solver,
HYPRE_Real tol);
HYPRE_Int HYPRE_ParCSRGMRESSetAbsoluteTol(HYPRE_Solver solver,
HYPRE_Real a_tol);
/*
* RE-VISIT
**/
HYPRE_Int HYPRE_ParCSRGMRESSetMinIter(HYPRE_Solver solver,
HYPRE_Int min_iter);
HYPRE_Int HYPRE_ParCSRGMRESSetMaxIter(HYPRE_Solver solver,
HYPRE_Int max_iter);
/*
* Obsolete
**/
HYPRE_Int HYPRE_ParCSRGMRESSetStopCrit(HYPRE_Solver solver,
HYPRE_Int stop_crit);
HYPRE_Int HYPRE_ParCSRGMRESSetPrecond(HYPRE_Solver solver,
HYPRE_PtrToParSolverFcn precond,
HYPRE_PtrToParSolverFcn precond_setup,
HYPRE_Solver precond_solver);
HYPRE_Int HYPRE_ParCSRGMRESGetPrecond(HYPRE_Solver solver,
HYPRE_Solver *precond_data);
HYPRE_Int HYPRE_ParCSRGMRESSetLogging(HYPRE_Solver solver,
HYPRE_Int logging);
HYPRE_Int HYPRE_ParCSRGMRESSetPrintLevel(HYPRE_Solver solver,
HYPRE_Int print_level);
HYPRE_Int HYPRE_ParCSRGMRESGetNumIterations(HYPRE_Solver solver,
HYPRE_Int *num_iterations);
HYPRE_Int HYPRE_ParCSRGMRESGetFinalRelativeResidualNorm(HYPRE_Solver solver,
HYPRE_Real *norm);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name ParCSR FlexGMRES Solver
*
* These routines should be used in conjunction with the generic interface in
* \Ref{FlexGMRES Solver}.
**/
/*@{*/
/**
* Create a solver object.
**/
HYPRE_Int HYPRE_ParCSRFlexGMRESCreate(MPI_Comm comm,
HYPRE_Solver *solver);
/**
* Destroy a solver object.
**/
HYPRE_Int HYPRE_ParCSRFlexGMRESDestroy(HYPRE_Solver solver);
HYPRE_Int HYPRE_ParCSRFlexGMRESSetup(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_ParCSRFlexGMRESSolve(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_ParCSRFlexGMRESSetKDim(HYPRE_Solver solver,
HYPRE_Int k_dim);
HYPRE_Int HYPRE_ParCSRFlexGMRESSetTol(HYPRE_Solver solver,
HYPRE_Real tol);
HYPRE_Int HYPRE_ParCSRFlexGMRESSetAbsoluteTol(HYPRE_Solver solver,
HYPRE_Real a_tol);
/*
* RE-VISIT
**/
HYPRE_Int HYPRE_ParCSRFlexGMRESSetMinIter(HYPRE_Solver solver,
HYPRE_Int min_iter);
HYPRE_Int HYPRE_ParCSRFlexGMRESSetMaxIter(HYPRE_Solver solver,
HYPRE_Int max_iter);
HYPRE_Int HYPRE_ParCSRFlexGMRESSetPrecond(HYPRE_Solver solver,
HYPRE_PtrToParSolverFcn precond,
HYPRE_PtrToParSolverFcn precond_setup,
HYPRE_Solver precond_solver);
HYPRE_Int HYPRE_ParCSRFlexGMRESGetPrecond(HYPRE_Solver solver,
HYPRE_Solver *precond_data);
HYPRE_Int HYPRE_ParCSRFlexGMRESSetLogging(HYPRE_Solver solver,
HYPRE_Int logging);
HYPRE_Int HYPRE_ParCSRFlexGMRESSetPrintLevel(HYPRE_Solver solver,
HYPRE_Int print_level);
HYPRE_Int HYPRE_ParCSRFlexGMRESGetNumIterations(HYPRE_Solver solver,
HYPRE_Int *num_iterations);
HYPRE_Int HYPRE_ParCSRFlexGMRESGetFinalRelativeResidualNorm(HYPRE_Solver solver,
HYPRE_Real *norm);
HYPRE_Int HYPRE_ParCSRFlexGMRESSetModifyPC( HYPRE_Solver solver,
HYPRE_PtrToModifyPCFcn modify_pc);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name ParCSR LGMRES Solver
*
* These routines should be used in conjunction with the generic interface in
* \Ref{LGMRES Solver}.
**/
/*@{*/
/**
* Create a solver object.
**/
HYPRE_Int HYPRE_ParCSRLGMRESCreate(MPI_Comm comm,
HYPRE_Solver *solver);
/**
* Destroy a solver object.
**/
HYPRE_Int HYPRE_ParCSRLGMRESDestroy(HYPRE_Solver solver);
HYPRE_Int HYPRE_ParCSRLGMRESSetup(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_ParCSRLGMRESSolve(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_ParCSRLGMRESSetKDim(HYPRE_Solver solver,
HYPRE_Int k_dim);
HYPRE_Int HYPRE_ParCSRLGMRESSetAugDim(HYPRE_Solver solver,
HYPRE_Int aug_dim);
HYPRE_Int HYPRE_ParCSRLGMRESSetTol(HYPRE_Solver solver,
HYPRE_Real tol);
HYPRE_Int HYPRE_ParCSRLGMRESSetAbsoluteTol(HYPRE_Solver solver,
HYPRE_Real a_tol);
/*
* RE-VISIT
**/
HYPRE_Int HYPRE_ParCSRLGMRESSetMinIter(HYPRE_Solver solver,
HYPRE_Int min_iter);
HYPRE_Int HYPRE_ParCSRLGMRESSetMaxIter(HYPRE_Solver solver,
HYPRE_Int max_iter);
HYPRE_Int HYPRE_ParCSRLGMRESSetPrecond(HYPRE_Solver solver,
HYPRE_PtrToParSolverFcn precond,
HYPRE_PtrToParSolverFcn precond_setup,
HYPRE_Solver precond_solver);
HYPRE_Int HYPRE_ParCSRLGMRESGetPrecond(HYPRE_Solver solver,
HYPRE_Solver *precond_data);
HYPRE_Int HYPRE_ParCSRLGMRESSetLogging(HYPRE_Solver solver,
HYPRE_Int logging);
HYPRE_Int HYPRE_ParCSRLGMRESSetPrintLevel(HYPRE_Solver solver,
HYPRE_Int print_level);
HYPRE_Int HYPRE_ParCSRLGMRESGetNumIterations(HYPRE_Solver solver,
HYPRE_Int *num_iterations);
HYPRE_Int HYPRE_ParCSRLGMRESGetFinalRelativeResidualNorm(HYPRE_Solver solver,
HYPRE_Real *norm);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name ParCSR BiCGSTAB Solver
*
* These routines should be used in conjunction with the generic interface in
* \Ref{BiCGSTAB Solver}.
**/
/*@{*/
/**
* Create a solver object
**/
HYPRE_Int HYPRE_ParCSRBiCGSTABCreate(MPI_Comm comm,
HYPRE_Solver *solver);
/**
* Destroy a solver object.
**/
HYPRE_Int HYPRE_ParCSRBiCGSTABDestroy(HYPRE_Solver solver);
HYPRE_Int HYPRE_ParCSRBiCGSTABSetup(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_ParCSRBiCGSTABSolve(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_ParCSRBiCGSTABSetTol(HYPRE_Solver solver,
HYPRE_Real tol);
HYPRE_Int HYPRE_ParCSRBiCGSTABSetAbsoluteTol(HYPRE_Solver solver,
HYPRE_Real a_tol);
HYPRE_Int HYPRE_ParCSRBiCGSTABSetMinIter(HYPRE_Solver solver,
HYPRE_Int min_iter);
HYPRE_Int HYPRE_ParCSRBiCGSTABSetMaxIter(HYPRE_Solver solver,
HYPRE_Int max_iter);
HYPRE_Int HYPRE_ParCSRBiCGSTABSetStopCrit(HYPRE_Solver solver,
HYPRE_Int stop_crit);
HYPRE_Int HYPRE_ParCSRBiCGSTABSetPrecond(HYPRE_Solver solver,
HYPRE_PtrToParSolverFcn precond,
HYPRE_PtrToParSolverFcn precond_setup,
HYPRE_Solver precond_solver);
HYPRE_Int HYPRE_ParCSRBiCGSTABGetPrecond(HYPRE_Solver solver,
HYPRE_Solver *precond_data);
HYPRE_Int HYPRE_ParCSRBiCGSTABSetLogging(HYPRE_Solver solver,
HYPRE_Int logging);
HYPRE_Int HYPRE_ParCSRBiCGSTABSetPrintLevel(HYPRE_Solver solver,
HYPRE_Int print_level);
HYPRE_Int HYPRE_ParCSRBiCGSTABGetNumIterations(HYPRE_Solver solver,
HYPRE_Int *num_iterations);
HYPRE_Int HYPRE_ParCSRBiCGSTABGetFinalRelativeResidualNorm(HYPRE_Solver solver,
HYPRE_Real *norm);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/**
* @name ParCSR Hybrid Solver
**/
/*@{*/
/**
* Create solver object
**/
HYPRE_Int HYPRE_ParCSRHybridCreate(HYPRE_Solver *solver);
/**
* Destroy solver object
**/
HYPRE_Int HYPRE_ParCSRHybridDestroy(HYPRE_Solver solver);
/**
* Setup the hybrid solver
* @param solver [IN] object to be set up.
* @param A [IN] ParCSR matrix used to construct the solver/preconditioner.
* @param b Ignored by this function.
* @param x Ignored by this function.
**/
HYPRE_Int HYPRE_ParCSRHybridSetup(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
/**
* Solve linear system
* @param solver [IN] solver or preconditioner object to be applied.
* @param A [IN] ParCSR matrix, matrix of the linear system to be solved
* @param b [IN] right hand side of the linear system to be solved
* @param x [OUT] approximated solution of the linear system to be solved
**/
HYPRE_Int HYPRE_ParCSRHybridSolve(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
/**
* Set the convergence tolerance for the Krylov solver. The default is 1.e-7.
**/
HYPRE_Int HYPRE_ParCSRHybridSetTol(HYPRE_Solver solver,
HYPRE_Real tol);
/**
* Set the absolute convergence tolerance for the Krylov solver. The default is 0.
**/
HYPRE_Int HYPRE_ParCSRHybridSetAbsoluteTol(HYPRE_Solver solver,
HYPRE_Real tol);
/**
* Set the desired convergence factor
**/
HYPRE_Int HYPRE_ParCSRHybridSetConvergenceTol(HYPRE_Solver solver,
HYPRE_Real cf_tol);
/**
* Set the maximal number of iterations for the diagonally
* preconditioned solver
**/
HYPRE_Int HYPRE_ParCSRHybridSetDSCGMaxIter(HYPRE_Solver solver,
HYPRE_Int dscg_max_its);
/**
* Set the maximal number of iterations for the AMG
* preconditioned solver
**/
HYPRE_Int HYPRE_ParCSRHybridSetPCGMaxIter(HYPRE_Solver solver,
HYPRE_Int pcg_max_its);
/*
*
**/
HYPRE_Int HYPRE_ParCSRHybridSetSetupType(HYPRE_Solver solver,
HYPRE_Int setup_type);
/**
* Set the desired solver type. There are the following options:
* \begin{tabular}{l l}
* 1 & PCG (default) \\
* 2 & GMRES \\
* 3 & BiCGSTAB
* \end{tabular}
**/
HYPRE_Int HYPRE_ParCSRHybridSetSolverType(HYPRE_Solver solver,
HYPRE_Int solver_type);
/**
* Set the Krylov dimension for restarted GMRES.
* The default is 5.
**/
HYPRE_Int HYPRE_ParCSRHybridSetKDim(HYPRE_Solver solver,
HYPRE_Int k_dim);
/**
* Set the type of norm for PCG.
**/
HYPRE_Int HYPRE_ParCSRHybridSetTwoNorm(HYPRE_Solver solver,
HYPRE_Int two_norm);
/*
* RE-VISIT
**/
HYPRE_Int HYPRE_ParCSRHybridSetStopCrit(HYPRE_Solver solver,
HYPRE_Int stop_crit);
/*
*
**/
HYPRE_Int HYPRE_ParCSRHybridSetRelChange(HYPRE_Solver solver,
HYPRE_Int rel_change);
/**
* Set preconditioner if wanting to use one that is not set up by
* the hybrid solver.
**/
HYPRE_Int HYPRE_ParCSRHybridSetPrecond(HYPRE_Solver solver,
HYPRE_PtrToParSolverFcn precond,
HYPRE_PtrToParSolverFcn precond_setup,
HYPRE_Solver precond_solver);
/**
* Set logging parameter (default: 0, no logging).
**/
HYPRE_Int HYPRE_ParCSRHybridSetLogging(HYPRE_Solver solver,
HYPRE_Int logging);
/**
* Set print level (default: 0, no printing).
**/
HYPRE_Int HYPRE_ParCSRHybridSetPrintLevel(HYPRE_Solver solver,
HYPRE_Int print_level);
/**
* (Optional) Sets AMG strength threshold. The default is 0.25.
* For 2d Laplace operators, 0.25 is a good value, for 3d Laplace
* operators, 0.5 or 0.6 is a better value. For elasticity problems,
* a large strength threshold, such as 0.9, is often better.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetStrongThreshold(HYPRE_Solver solver,
HYPRE_Real strong_threshold);
/**
* (Optional) Sets a parameter to modify the definition of strength for
* diagonal dominant portions of the matrix. The default is 0.9.
* If max\_row\_sum is 1, no checking for diagonally dominant rows is
* performed.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetMaxRowSum(HYPRE_Solver solver,
HYPRE_Real max_row_sum);
/**
* (Optional) Defines a truncation factor for the interpolation.
* The default is 0.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetTruncFactor(HYPRE_Solver solver,
HYPRE_Real trunc_factor);
/**
* (Optional) Defines the maximal number of elements per row for the interpolation.
* The default is 0.
**/
HYPRE_Int HYPRE_ParCSRHybridSetPMaxElmts(HYPRE_Solver solver,
HYPRE_Int P_max_elmts);
/**
* (Optional) Defines the maximal number of levels used for AMG.
* The default is 25.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetMaxLevels(HYPRE_Solver solver,
HYPRE_Int max_levels);
/**
* (Optional) Defines whether local or global measures are used.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetMeasureType(HYPRE_Solver solver,
HYPRE_Int measure_type);
/**
* (Optional) Defines which parallel coarsening algorithm is used.
* There are the following options for coarsen\_type:
*
* \begin{tabular}{|c|l|} \hline
* 0 & CLJP-coarsening (a parallel coarsening algorithm using independent sets). \\
* 1 & classical Ruge-Stueben coarsening on each processor, no boundary treatment \\
* 3 & classical Ruge-Stueben coarsening on each processor, followed by a third \\
* & pass, which adds coarse points on the boundaries \\
* 6 & Falgout coarsening (uses 1 first, followed by CLJP using the interior coarse \\
* & points generated by 1 as its first independent set) \\
* 7 & CLJP-coarsening (using a fixed random vector, for debugging purposes only) \\
* 8 & PMIS-coarsening (a parallel coarsening algorithm using independent sets \\
* & with lower complexities than CLJP, might also lead to slower convergence) \\
* 9 & PMIS-coarsening (using a fixed random vector, for debugging purposes only) \\
* 10 & HMIS-coarsening (uses one pass Ruge-Stueben on each processor independently, \\
* & followed by PMIS using the interior C-points as its first independent set) \\
* 11 & one-pass Ruge-Stueben coarsening on each processor, no boundary treatment \\
* \hline
* \end{tabular}
*
* The default is 6.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetCoarsenType(HYPRE_Solver solver,
HYPRE_Int coarsen_type);
/*
* (Optional) Specifies which interpolation operator is used
* The default is modified ''classical" interpolation.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetInterpType(HYPRE_Solver solver,
HYPRE_Int interp_type);
/**
* (Optional) Defines the type of cycle.
* For a V-cycle, set cycle\_type to 1, for a W-cycle
* set cycle\_type to 2. The default is 1.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetCycleType(HYPRE_Solver solver,
HYPRE_Int cycle_type);
/*
*
**/
HYPRE_Int
HYPRE_ParCSRHybridSetGridRelaxType(HYPRE_Solver solver,
HYPRE_Int *grid_relax_type);
/*
*
**/
HYPRE_Int
HYPRE_ParCSRHybridSetGridRelaxPoints(HYPRE_Solver solver,
HYPRE_Int **grid_relax_points);
/**
* (Optional) Sets the number of sweeps. On the finest level, the up and
* the down cycle the number of sweeps are set to num\_sweeps and on the
* coarsest level to 1. The default is 1.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetNumSweeps(HYPRE_Solver solver,
HYPRE_Int num_sweeps);
/**
* (Optional) Sets the number of sweeps at a specified cycle.
* There are the following options for k:
*
* \begin{tabular}{|l|l|} \hline
* the down cycle & if k=1 \\
* the up cycle & if k=2 \\
* the coarsest level & if k=3.\\
* \hline
* \end{tabular}
**/
HYPRE_Int
HYPRE_ParCSRHybridSetCycleNumSweeps(HYPRE_Solver solver,
HYPRE_Int num_sweeps,
HYPRE_Int k);
/**
* (Optional) Defines the smoother to be used. It uses the given
* smoother on the fine grid, the up and
* the down cycle and sets the solver on the coarsest level to Gaussian
* elimination (9). The default is Gauss-Seidel (3).
*
* There are the following options for relax\_type:
*
* \begin{tabular}{|c|l|} \hline
* 0 & Jacobi \\
* 1 & Gauss-Seidel, sequential (very slow!) \\
* 2 & Gauss-Seidel, interior points in parallel, boundary sequential (slow!) \\
* 3 & hybrid Gauss-Seidel or SOR, forward solve \\
* 4 & hybrid Gauss-Seidel or SOR, backward solve \\
* 5 & hybrid chaotic Gauss-Seidel (works only with OpenMP) \\
* 6 & hybrid symmetric Gauss-Seidel or SSOR \\
* 9 & Gaussian elimination (only on coarsest level) \\
* \hline
* \end{tabular}
**/
HYPRE_Int
HYPRE_ParCSRHybridSetRelaxType(HYPRE_Solver solver,
HYPRE_Int relax_type);
/**
* (Optional) Defines the smoother at a given cycle.
* For options of relax\_type see
* description of HYPRE\_BoomerAMGSetRelaxType). Options for k are
*
* \begin{tabular}{|l|l|} \hline
* the down cycle & if k=1 \\
* the up cycle & if k=2 \\
* the coarsest level & if k=3. \\
* \hline
* \end{tabular}
**/
HYPRE_Int
HYPRE_ParCSRHybridSetCycleRelaxType(HYPRE_Solver solver,
HYPRE_Int relax_type,
HYPRE_Int k);
/**
* (Optional) Defines in which order the points are relaxed. There are
* the following options for
* relax\_order:
*
* \begin{tabular}{|c|l|} \hline
* 0 & the points are relaxed in natural or lexicographic
* order on each processor \\
* 1 & CF-relaxation is used, i.e on the fine grid and the down
* cycle the coarse points are relaxed first, \\
* & followed by the fine points; on the up cycle the F-points are relaxed
* first, followed by the C-points. \\
* & On the coarsest level, if an iterative scheme is used,
* the points are relaxed in lexicographic order. \\
* \hline
* \end{tabular}
*
* The default is 1 (CF-relaxation).
**/
HYPRE_Int
HYPRE_ParCSRHybridSetRelaxOrder(HYPRE_Solver solver,
HYPRE_Int relax_order);
/**
* (Optional) Defines the relaxation weight for smoothed Jacobi and hybrid SOR
* on all levels.
*
* \begin{tabular}{|l|l|} \hline
* relax\_weight > 0 & this assigns the given relaxation weight on all levels \\
* relax\_weight = 0 & the weight is determined on each level
* with the estimate $3 \over {4\|D^{-1/2}AD^{-1/2}\|}$,\\
* & where $D$ is the diagonal matrix of $A$ (this should only be used with Jacobi) \\
* relax\_weight = -k & the relaxation weight is determined with at most k CG steps
* on each level \\
* & this should only be used for symmetric positive definite problems) \\
* \hline
* \end{tabular}
*
* The default is 1.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetRelaxWt(HYPRE_Solver solver,
HYPRE_Real relax_wt);
/**
* (Optional) Defines the relaxation weight for smoothed Jacobi and hybrid SOR
* on the user defined level. Note that the finest level is denoted 0, the
* next coarser level 1, etc. For nonpositive relax\_weight, the parameter is
* determined on the given level as described for HYPRE\_BoomerAMGSetRelaxWt.
* The default is 1.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetLevelRelaxWt(HYPRE_Solver solver,
HYPRE_Real relax_wt,
HYPRE_Int level);
/**
* (Optional) Defines the outer relaxation weight for hybrid SOR and SSOR
* on all levels.
*
* \begin{tabular}{|l|l|} \hline
* omega > 0 & this assigns the same outer relaxation weight omega on each level\\
* omega = -k & an outer relaxation weight is determined with at most k CG
* steps on each level \\
* & (this only makes sense for symmetric
* positive definite problems and smoothers, e.g. SSOR) \\
* \hline
* \end{tabular}
*
* The default is 1.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetOuterWt(HYPRE_Solver solver,
HYPRE_Real outer_wt);
/**
* (Optional) Defines the outer relaxation weight for hybrid SOR or SSOR
* on the user defined level. Note that the finest level is denoted 0, the
* next coarser level 1, etc. For nonpositive omega, the parameter is
* determined on the given level as described for HYPRE\_BoomerAMGSetOuterWt.
* The default is 1.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetLevelOuterWt(HYPRE_Solver solver,
HYPRE_Real outer_wt,
HYPRE_Int level);
/**
* (Optional) Defines the maximal coarse grid size.
* The default is 9.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetMaxCoarseSize(HYPRE_Solver solver,
HYPRE_Int max_coarse_size);
/**
* (Optional) Defines the minimal coarse grid size.
* The default is 0.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetMinCoarseSize(HYPRE_Solver solver,
HYPRE_Int min_coarse_size);
/**
* (Optional) enables redundant coarse grid size. If the system size becomes
* smaller than seq_threshold, sequential AMG is used on all remaining processors.
* The default is 0.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetSeqThreshold(HYPRE_Solver solver,
HYPRE_Int seq_threshold);
/*
*
**/
HYPRE_Int
HYPRE_ParCSRHybridSetRelaxWeight(HYPRE_Solver solver,
HYPRE_Real *relax_weight);
/*
*
**/
HYPRE_Int
HYPRE_ParCSRHybridSetOmega(HYPRE_Solver solver,
HYPRE_Real *omega);
/**
* (Optional) Defines the number of levels of aggressive coarsening,
* starting with the finest level.
* The default is 0, i.e. no aggressive coarsening.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetAggNumLevels(HYPRE_Solver solver,
HYPRE_Int agg_num_levels);
/**
* (Optional) Defines the degree of aggressive coarsening.
* The default is 1, which leads to the most aggressive coarsening.
* Setting num$\_$paths to 2 will increase complexity somewhat,
* but can lead to better convergence.**/
HYPRE_Int
HYPRE_ParCSRHybridSetNumPaths(HYPRE_Solver solver,
HYPRE_Int num_paths);
/**
* (Optional) Sets the size of the system of PDEs, if using the systems version.
* The default is 1.
**/
HYPRE_Int
HYPRE_ParCSRHybridSetNumFunctions(HYPRE_Solver solver,
HYPRE_Int num_functions);
/**
* (Optional) Sets the mapping that assigns the function to each variable,
* if using the systems version. If no assignment is made and the number of
* functions is k > 1, the mapping generated is (0,1,...,k-1,0,1,...,k-1,...).
**/
HYPRE_Int
HYPRE_ParCSRHybridSetDofFunc(HYPRE_Solver solver,
HYPRE_Int *dof_func);
/**
* (Optional) Sets whether to use the nodal systems version.
* The default is 0 (the unknown based approach).
**/
HYPRE_Int
HYPRE_ParCSRHybridSetNodal(HYPRE_Solver solver,
HYPRE_Int nodal);
/**
* Retrieves the total number of iterations.
**/
HYPRE_Int HYPRE_ParCSRHybridGetNumIterations(HYPRE_Solver solver,
HYPRE_Int *num_its);
/**
* Retrieves the number of iterations used by the diagonally scaled solver.
**/
HYPRE_Int HYPRE_ParCSRHybridGetDSCGNumIterations(HYPRE_Solver solver,
HYPRE_Int *dscg_num_its);
/**
* Retrieves the number of iterations used by the AMG preconditioned solver.
**/
HYPRE_Int HYPRE_ParCSRHybridGetPCGNumIterations(HYPRE_Solver solver,
HYPRE_Int *pcg_num_its);
/**
* Retrieves the final relative residual norm.
**/
HYPRE_Int HYPRE_ParCSRHybridGetFinalRelativeResidualNorm(HYPRE_Solver solver,
HYPRE_Real *norm);
/* Is this a retired function? (RDF) */
HYPRE_Int
HYPRE_ParCSRHybridSetNumGridSweeps(HYPRE_Solver solver,
HYPRE_Int *num_grid_sweeps);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/*
* @name Schwarz Solver
**/
HYPRE_Int HYPRE_SchwarzCreate(HYPRE_Solver *solver);
HYPRE_Int HYPRE_SchwarzDestroy(HYPRE_Solver solver);
HYPRE_Int HYPRE_SchwarzSetup(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_SchwarzSolve(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_SchwarzSetVariant(HYPRE_Solver solver,
HYPRE_Int variant);
HYPRE_Int HYPRE_SchwarzSetOverlap(HYPRE_Solver solver,
HYPRE_Int overlap);
HYPRE_Int HYPRE_SchwarzSetDomainType(HYPRE_Solver solver,
HYPRE_Int domain_type);
HYPRE_Int HYPRE_SchwarzSetRelaxWeight(HYPRE_Solver solver,
HYPRE_Real relax_weight);
HYPRE_Int HYPRE_SchwarzSetDomainStructure(HYPRE_Solver solver,
HYPRE_CSRMatrix domain_structure);
HYPRE_Int HYPRE_SchwarzSetNumFunctions(HYPRE_Solver solver,
HYPRE_Int num_functions);
HYPRE_Int HYPRE_SchwarzSetDofFunc(HYPRE_Solver solver,
HYPRE_Int *dof_func);
HYPRE_Int HYPRE_SchwarzSetNonSymm(HYPRE_Solver solver,
HYPRE_Int use_nonsymm);
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/*
* @name ParCSR CGNR Solver
**/
HYPRE_Int HYPRE_ParCSRCGNRCreate(MPI_Comm comm,
HYPRE_Solver *solver);
HYPRE_Int HYPRE_ParCSRCGNRDestroy(HYPRE_Solver solver);
HYPRE_Int HYPRE_ParCSRCGNRSetup(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_ParCSRCGNRSolve(HYPRE_Solver solver,
HYPRE_ParCSRMatrix A,
HYPRE_ParVector b,
HYPRE_ParVector x);
HYPRE_Int HYPRE_ParCSRCGNRSetTol(HYPRE_Solver solver,
HYPRE_Real tol);
HYPRE_Int HYPRE_ParCSRCGNRSetMinIter(HYPRE_Solver solver,
HYPRE_Int min_iter);
HYPRE_Int HYPRE_ParCSRCGNRSetMaxIter(HYPRE_Solver solver,
HYPRE_Int max_iter);
HYPRE_Int HYPRE_ParCSRCGNRSetStopCrit(HYPRE_Solver solver,
HYPRE_Int stop_crit);
HYPRE_Int HYPRE_ParCSRCGNRSetPrecond(HYPRE_Solver solver,
HYPRE_PtrToParSolverFcn precond,
HYPRE_PtrToParSolverFcn precondT,
HYPRE_PtrToParSolverFcn precond_setup,
HYPRE_Solver precond_solver);
HYPRE_Int HYPRE_ParCSRCGNRGetPrecond(HYPRE_Solver solver,
HYPRE_Solver *precond_data);
HYPRE_Int HYPRE_ParCSRCGNRSetLogging(HYPRE_Solver solver,
HYPRE_Int logging);
HYPRE_Int HYPRE_ParCSRCGNRGetNumIterations(HYPRE_Solver solver,
HYPRE_Int *num_iterations);
HYPRE_Int HYPRE_ParCSRCGNRGetFinalRelativeResidualNorm(HYPRE_Solver solver,
HYPRE_Real *norm);
/*--------------------------------------------------------------------------
* Miscellaneous: These probably do not belong in the interface.
*--------------------------------------------------------------------------*/
HYPRE_ParCSRMatrix GenerateLaplacian(MPI_Comm comm,
HYPRE_Int nx,
HYPRE_Int ny,
HYPRE_Int nz,
HYPRE_Int P,
HYPRE_Int Q,
HYPRE_Int R,
HYPRE_Int p,
HYPRE_Int q,
HYPRE_Int r,
HYPRE_Real *value);
HYPRE_ParCSRMatrix GenerateLaplacian27pt(MPI_Comm comm,
HYPRE_Int nx,
HYPRE_Int ny,
HYPRE_Int nz,
HYPRE_Int P,
HYPRE_Int Q,
HYPRE_Int R,
HYPRE_Int p,
HYPRE_Int q,
HYPRE_Int r,
HYPRE_Real *value);
HYPRE_ParCSRMatrix GenerateLaplacian9pt(MPI_Comm comm,
HYPRE_Int nx,
HYPRE_Int ny,
HYPRE_Int P,
HYPRE_Int Q,
HYPRE_Int p,
HYPRE_Int q,
HYPRE_Real *value);
HYPRE_ParCSRMatrix GenerateDifConv(MPI_Comm comm,
HYPRE_Int nx,
HYPRE_Int ny,
HYPRE_Int nz,
HYPRE_Int P,
HYPRE_Int Q,
HYPRE_Int R,
HYPRE_Int p,
HYPRE_Int q,
HYPRE_Int r,
HYPRE_Real *value);
HYPRE_ParCSRMatrix
GenerateRotate7pt(MPI_Comm comm,
HYPRE_Int nx,
HYPRE_Int ny,
HYPRE_Int P,
HYPRE_Int Q,
HYPRE_Int p,
HYPRE_Int q,
HYPRE_Real alpha,
HYPRE_Real eps );
HYPRE_ParCSRMatrix
GenerateVarDifConv(MPI_Comm comm,
HYPRE_Int nx,
HYPRE_Int ny,
HYPRE_Int nz,
HYPRE_Int P,
HYPRE_Int Q,
HYPRE_Int R,
HYPRE_Int p,
HYPRE_Int q,
HYPRE_Int r,
HYPRE_Real eps,
HYPRE_ParVector *rhs_ptr);
float*
GenerateCoordinates(MPI_Comm comm,
HYPRE_Int nx,
HYPRE_Int ny,
HYPRE_Int nz,
HYPRE_Int P,
HYPRE_Int Q,
HYPRE_Int R,
HYPRE_Int p,
HYPRE_Int q,
HYPRE_Int r,
HYPRE_Int coorddim);
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/*
* (Optional) Switches on use of Jacobi interpolation after computing
* an original interpolation
**/
HYPRE_Int HYPRE_BoomerAMGSetPostInterpType(HYPRE_Solver solver,
HYPRE_Int post_interp_type);
/*
* (Optional) Sets a truncation threshold for Jacobi interpolation.
**/
HYPRE_Int HYPRE_BoomerAMGSetJacobiTruncThreshold(HYPRE_Solver solver,
HYPRE_Real jacobi_trunc_threshold);
/*
* (Optional) Defines the number of relaxation steps for CR
* The default is 2.
**/
HYPRE_Int HYPRE_BoomerAMGSetNumCRRelaxSteps(HYPRE_Solver solver,
HYPRE_Int num_CR_relax_steps);
/*
* (Optional) Defines convergence rate for CR
* The default is 0.7.
**/
HYPRE_Int HYPRE_BoomerAMGSetCRRate(HYPRE_Solver solver,
HYPRE_Real CR_rate);
/*
* (Optional) Defines strong threshold for CR
* The default is 0.0.
**/
HYPRE_Int HYPRE_BoomerAMGSetCRStrongTh(HYPRE_Solver solver,
HYPRE_Real CR_strong_th);
/*
* (Optional) Defines whether to use CG
**/
HYPRE_Int HYPRE_BoomerAMGSetCRUseCG(HYPRE_Solver solver,
HYPRE_Int CR_use_CG);
/*
* (Optional) Defines the Type of independent set algorithm used for CR
**/
HYPRE_Int HYPRE_BoomerAMGSetISType(HYPRE_Solver solver,
HYPRE_Int IS_type);
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/* These includes shouldn't be here. (RDF) */
#include "interpreter.h"
#include "HYPRE_MatvecFunctions.h"
/**
* @name ParCSR LOBPCG Eigensolver
*
* These routines should be used in conjunction with the generic interface in
* \Ref{LOBPCG Eigensolver}.
**/
/*@{*/
/**
* Load interface interpreter. Vector part loaded with hypre_ParKrylov
* functions and multivector part loaded with mv_TempMultiVector functions.
**/
HYPRE_Int
HYPRE_ParCSRSetupInterpreter(mv_InterfaceInterpreter *i);
/**
* Load Matvec interpreter with hypre_ParKrylov functions.
**/
HYPRE_Int
HYPRE_ParCSRSetupMatvec(HYPRE_MatvecFunctions *mv);
/* The next routines should not be here (lower-case prefix). (RDF) */
/*
* Print multivector to file.
**/
HYPRE_Int
hypre_ParCSRMultiVectorPrint(void *x_, const char *fileName);
/*
* Read multivector from file.
**/
void *
hypre_ParCSRMultiVectorRead(MPI_Comm comm, void *ii_, const char *fileName);
/*@}*/
/*--------------------------------------------------------------------------
*--------------------------------------------------------------------------*/
/*@}*/
#ifdef __cplusplus
}
#endif
#endif
|