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
|
/* -----------------------------------------------------------------------------
* Programmer(s): David J. Gardner @ LLNL
* -----------------------------------------------------------------------------
* SUNDIALS Copyright Start
* Copyright (c) 2002-2022, Lawrence Livermore National Security
* and Southern Methodist University.
* All rights reserved.
*
* See the top-level LICENSE and NOTICE files for details.
*
* SPDX-License-Identifier: BSD-3-Clause
* SUNDIALS Copyright End
* -----------------------------------------------------------------------------
* Example problem:
*
* The following test simulates a simple anisotropic 2D heat equation,
*
* u_t = kx u_xx + ky u_yy + b,
*
* for t in [0, 1] and (x,y) in [0, 1]^2, with initial conditions
*
* u(0,x,y) = sin^2(pi x) sin^2(pi y),
*
* stationary boundary conditions
*
* u_t(t,0,y) = u_t(t,1,y) = u_t(t,x,0) = u_t(t,x,1) = 0,
*
* and the heat source
*
* b(t,x,y) = -2 pi sin^2(pi x) sin^2(pi y) sin(pi t) cos(pi t)
* - kx 2 pi^2 (cos^2(pi x) - sin^2(pi x)) sin^2(pi y) cos^2(pi t)
* - ky 2 pi^2 (cos^2(pi y) - sin^2(pi y)) sin^2(pi x) cos^2(pi t).
*
* Under this setup, the problem has the analytical solution
*
* u(t,x,y) = sin^2(pi x) sin^2(pi y) cos^2(pi t).
*
* The spatial derivatives are computed using second-order centered differences,
* with the data distributed over nx * ny points on a uniform spatial grid. The
* problem is solved using the XBraid multigrid reduction in time library paired
* with a diagonally implicit Runge-Kutta method from the ARKode ARKStep module
* using an inexact Newton method paired with the PCG or SPGMR linear solver
* using hypre's PFMG preconditioner. Several command line options are available
* to change the problem parameters and ARKStep settings. Use the flag --help
* for more information.
* ---------------------------------------------------------------------------*/
#include <cstdio>
#include <iostream>
#include <iomanip>
#include <fstream>
#include <sstream>
#include <limits>
#include <cmath>
#include "arkode/arkode_arkstep.h" // access to ARKStep
#include "nvector/nvector_parallel.h" // access to the MPI N_Vector
#include "sunlinsol/sunlinsol_pcg.h" // access to PCG SUNLinearSolver
#include "sunlinsol/sunlinsol_spgmr.h" // access to SPGMR SUNLinearSolver
#include "HYPRE_struct_ls.h" // HYPRE structured grid solver interface
#include "mpi.h" // MPI header file
#include "braid.h" // access to XBraid
#include "arkode/arkode_xbraid.h" // access to ARKStep + XBraid interface
// Macros for problem constants
#define PI RCONST(3.141592653589793238462643383279502884197169)
#define ZERO RCONST(0.0)
#define ONE RCONST(1.0)
#define TWO RCONST(2.0)
#define EIGHT RCONST(8.0)
// Macro to access (x,y) location in 1D NVector array
#define IDX(x,y,n) ((n)*(y)+(x))
using namespace std;
// -----------------------------------------------------------------------------
// User data structure
// -----------------------------------------------------------------------------
struct UserData
{
// SUNDIALS simulation context
SUNContext ctx;
// Diffusion coefficients in the x and y directions
realtype kx;
realtype ky;
// Enable/disable forcing
bool forcing;
// Final time
realtype tf;
// Upper bounds in x and y directions
realtype xu;
realtype yu;
// Global number of nodes in the x and y directions
sunindextype nx;
sunindextype ny;
// Global total number of nodes
sunindextype nodes;
// Mesh spacing in the x and y directions
realtype dx;
realtype dy;
// Local number of nodes in the x and y directions
sunindextype nx_loc;
sunindextype ny_loc;
// Overall number of local nodes
sunindextype nodes_loc;
// Global x and y indices of this subdomain
sunindextype is; // x starting index
sunindextype ie; // x ending index
sunindextype js; // y starting index
sunindextype je; // y ending index
// MPI variables
MPI_Comm comm_w; // world communicator
MPI_Comm comm_t; // communicator in time
MPI_Comm comm_x; // communicator in space
MPI_Comm comm_c; // Cartesian communicator in space
int nprocs_w; // total number of MPI processes in Comm world
int npx; // number of MPI processes in the x-direction
int npy; // number of MPI processes in the y-direction
int npt; // number of MPI processes in time
int myid_w; // process ID in space and time
int myid_c; // process ID in Cartesian communicator
// Flags denoting if this process has a neighbor
bool HaveNbrW;
bool HaveNbrE;
bool HaveNbrS;
bool HaveNbrN;
// Neighbor IDs for exchange
int ipW;
int ipE;
int ipS;
int ipN;
// Receive buffers for neighbor exchange
realtype *Wrecv;
realtype *Erecv;
realtype *Srecv;
realtype *Nrecv;
// Receive requests for neighbor exchange
MPI_Request reqRW;
MPI_Request reqRE;
MPI_Request reqRS;
MPI_Request reqRN;
// Send buffers for neighbor exchange
realtype *Wsend;
realtype *Esend;
realtype *Ssend;
realtype *Nsend;
// Send requests for neighor exchange
MPI_Request reqSW;
MPI_Request reqSE;
MPI_Request reqSS;
MPI_Request reqSN;
// Integrator settings
realtype rtol; // relative tolerance
realtype atol; // absolute tolerance
int order; // ARKode method order
bool linear; // enable/disable linearly implicit option
bool diagnostics; // output diagnostics
// Linear solver and preconditioner settings
bool pcg; // use PCG (true) or GMRES (false)
bool prec; // preconditioner on/off
bool matvec; // use hypre matrix-vector product
bool lsinfo; // output residual history
int liniters; // number of linear iterations
int msbp; // max number of steps between preconditioner setups
realtype epslin; // linear solver tolerance factor
// hypre objects
HYPRE_StructGrid grid;
HYPRE_StructStencil stencil;
HYPRE_StructMatrix Jmatrix;
HYPRE_StructMatrix Amatrix;
HYPRE_StructVector bvec;
HYPRE_StructVector xvec;
HYPRE_StructVector vvec;
HYPRE_StructVector Jvvec;
HYPRE_StructSolver precond;
// hypre grid extents
HYPRE_Int ilower[2];
HYPRE_Int iupper[2];
// hypre workspace
HYPRE_Int nwork;
HYPRE_Real *work;
// hypre counters
HYPRE_Int pfmg_its;
// hypre PFMG settings (hypre defaults)
HYPRE_Int pfmg_relax; // type of relaxation:
// 0 - Jacobi
// 1 - Weighted Jacobi
// 2 - symmetric R/B Gauss-Seidel (*)
// 3 - nonsymmetric R/B Gauss-Seidel
HYPRE_Int pfmg_nrelax; // number of pre and post relaxation sweeps (2)
// Ouput variables
int output; // output level
int nout; // number of output times
ofstream uout; // output file stream
ofstream eout; // error file stream
N_Vector e; // error vector
// Timing variables
bool timing; // print timings
double evolvetime;
double rhstime;
double matfilltime;
double jvtime;
double psetuptime;
double psolvetime;
double exchangetime;
double accesstime;
// XBraid settings
realtype x_tol; // Xbraid stopping tolerance
int x_nt; // number of fine grid time points
int x_skip; // skip all work on first down cycle
int x_max_levels; // max number of levels
int x_min_coarse; // min possible coarse gird size
int x_nrelax; // number of CF relaxation sweeps on all levels
int x_nrelax0; // number of CF relaxation sweeps on level 0
int x_tnorm; // temporal stopping norm
int x_cfactor; // coarsening factor
int x_cfactor0; // coarsening factor on level 0
int x_max_iter; // max number of interations
int x_storage; // Full storage on levels >= storage
int x_print_level; // xbraid output level
int x_access_level; // access level
int x_rfactor_limit; // refinement factor limit
int x_rfactor_fail; // refinement factor on solver failure
int x_max_refine; // max number of refinements
bool x_fmg; // true = FMG cycle, false = V cycle
bool x_refine; // enable refinement with XBraid
bool x_initseq; // initialize with sequential solution
bool x_reltol; // use relative tolerance
bool x_init_u0; // initialize solution to initial condition
};
// -----------------------------------------------------------------------------
// Functions provided to XBraid
// -----------------------------------------------------------------------------
int MyInit(braid_App app, realtype t, braid_Vector *u_ptr);
int MyAccess(braid_App app, braid_Vector u, braid_AccessStatus astatus);
// -----------------------------------------------------------------------------
// Functions provided to the SUNDIALS integrator
// -----------------------------------------------------------------------------
// ODE right hand side function
static int f(realtype t, N_Vector u, N_Vector f, void *user_data);
// Jacobian-vector product function
static int JTimes(N_Vector v, N_Vector Jv, realtype t, N_Vector y, N_Vector fy,
void *user_data, N_Vector tmp);
// Preconditioner setup and solve functions
static int PSetup(realtype t, N_Vector u, N_Vector f, booleantype jok,
booleantype *jcurPtr, realtype gamma, void *user_data);
static int PSolve(realtype t, N_Vector u, N_Vector f, N_Vector r,
N_Vector z, realtype gamma, realtype delta, int lr,
void *user_data);
// -----------------------------------------------------------------------------
// Helper functions
// -----------------------------------------------------------------------------
// Setup the parallel decomposition
static int SetupDecomp(MPI_Comm comm_w, UserData *udata);
// Perform neighbor exchange
static int PostRecv(UserData *udata);
static int SendData(N_Vector y, UserData *udata);
static int WaitRecv(UserData *udata);
// Create hypre objects
static int SetupHypre(UserData *udata);
// Fill Jacobian and A = I - gamma * J
static int Jac(UserData *udata);
static int ScaleAddI(UserData *udata, realtype gamma);
// -----------------------------------------------------------------------------
// UserData and input functions
// -----------------------------------------------------------------------------
// Set the default values in the UserData structure
static int InitUserData(UserData *udata, SUNContext ctx);
// Free memory allocated within UserData
static int FreeUserData(UserData *udata);
// Read the command line inputs and set UserData values
static int ReadInputs(int *argc, char ***argv, UserData *udata, bool outproc);
// -----------------------------------------------------------------------------
// Output and utility functions
// -----------------------------------------------------------------------------
// Compute the true solution
static int Solution(realtype t, N_Vector u, UserData *udata);
// Compute the solution error solution
static int SolutionError(realtype t, N_Vector u, N_Vector e, UserData *udata);
// Print the command line options
static void InputHelp();
// Print some UserData information
static int PrintUserData(UserData *udata);
// Print integration statistics
static int OutputStats(void *arkode_mem, UserData *udata);
// Print integration timing
static int OutputTiming(UserData *udata);
// Check function return values
static int check_flag(void *flagvalue, const string funcname, int opt);
// -----------------------------------------------------------------------------
// Main Program
// -----------------------------------------------------------------------------
int main(int argc, char* argv[])
{
int flag; // reusable error-checking flag
UserData *udata = NULL; // user data structure
N_Vector u = NULL; // vector for storing solution
SUNLinearSolver LS = NULL; // linear solver memory structure
void *arkode_mem = NULL; // ARKODE memory structure
FILE *diagfp = NULL; // diagnostics output file
braid_Core core = NULL; // XBraid memory structure
braid_App app = NULL; // ARKode + XBraid interface structure
// Timing variables
double t1 = 0.0;
double t2 = 0.0;
// MPI variables
MPI_Comm comm_w = MPI_COMM_WORLD; // MPI communicator
int myid; // MPI process ID
// Initialize MPI
flag = MPI_Init(&argc, &argv);
if (check_flag(&flag, "MPI_Init", 1)) return 1;
flag = MPI_Comm_rank(comm_w, &myid);
if (check_flag(&flag, "MPI_Comm_rank", 1)) return 1;
// Create the SUNDIALS context object for this simulation
SUNContext ctx;
flag = SUNContext_Create(&comm_w, &ctx);
if (check_flag(&flag, "SUNContext_Create", 1)) return 1;
// Set output process flag
bool outproc = (myid == 0);
// ------------------------------------------
// Setup UserData and parallel decomposition
// ------------------------------------------
// Allocate and initialize user data structure with default values. The
// defaults may be overwritten by command line inputs in ReadInputs below.
udata = new UserData;
flag = InitUserData(udata, ctx);
if (check_flag(&flag, "InitUserData", 1)) return 1;
// Parse command line inputs
flag = ReadInputs(&argc, &argv, udata, outproc);
if (flag != 0) return 1;
// Setup parallel decomposition
flag = SetupDecomp(comm_w, udata);
if (check_flag(&flag, "SetupDecomp", 1)) return 1;
// Output problem setup/options
if (outproc)
{
flag = PrintUserData(udata);
if (check_flag(&flag, "PrintUserData", 1)) return 1;
// Open diagnostics output file
if ((udata->diagnostics || udata->lsinfo) && udata->myid_c == 0)
{
stringstream fname;
fname << "diagnostics." << setfill('0') << setw(5) << udata->myid_w
<< ".txt";
const std::string tmp = fname.str();
diagfp = fopen(tmp.c_str(), "w");
if (check_flag((void *) diagfp, "fopen", 0)) return 1;
}
}
// ------------------------
// Create parallel vectors
// ------------------------
// Create vector for solution
u = N_VNew_Parallel(udata->comm_c, udata->nodes_loc, udata->nodes, ctx);
if (check_flag((void *) u, "N_VNew_Parallel", 0)) return 1;
// Set initial condition
flag = Solution(ZERO, u, udata);
if (check_flag(&flag, "Solution", 1)) return 1;
// Create vector for error
udata->e = N_VClone(u);
if (check_flag((void *) (udata->e), "N_VClone", 0)) return 1;
// ---------------------
// Create linear solver
// ---------------------
// Create linear solver
int prectype = (udata->prec) ? SUN_PREC_RIGHT : SUN_PREC_NONE;
if (udata->pcg)
{
LS = SUNLinSol_PCG(u, prectype, udata->liniters, ctx);
if (check_flag((void *) LS, "SUNLinSol_PCG", 0)) return 1;
if (udata->lsinfo && outproc)
{
flag = SUNLinSolSetPrintLevel_PCG(LS, 1);
if (check_flag(&flag, "SUNLinSolSetPrintLevel_PCG", 1)) return(1);
flag = SUNLinSolSetInfoFile_PCG(LS, diagfp);
if (check_flag(&flag, "SUNLinSolSetInfoFile_PCG", 1)) return(1);
}
}
else
{
LS = SUNLinSol_SPGMR(u, prectype, udata->liniters, ctx);
if (check_flag((void *) LS, "SUNLinSol_SPGMR", 0)) return 1;
if (udata->lsinfo && outproc)
{
flag = SUNLinSolSetPrintLevel_SPGMR(LS, 1);
if (check_flag(&flag, "SUNLinSolSetPrintLevel_SPGMR", 1)) return(1);
flag = SUNLinSolSetInfoFile_SPGMR(LS, diagfp);
if (check_flag(&flag, "SUNLinSolSetInfoFile_SPGMR", 1)) return(1);
}
}
// ---------------------
// Create hypre objects
// ---------------------
if (udata->prec || udata->matvec)
{
flag = SetupHypre(udata);
if (check_flag(&flag, "SetupHypre", 1)) return 1;
}
// --------------
// Setup ARKStep
// --------------
// Create integrator
arkode_mem = ARKStepCreate(NULL, f, ZERO, u, ctx);
if (check_flag((void *) arkode_mem, "ARKStepCreate", 0)) return 1;
// Specify tolerances
flag = ARKStepSStolerances(arkode_mem, udata->rtol, udata->atol);
if (check_flag(&flag, "ARKStepSStolerances", 1)) return 1;
// Attach user data
flag = ARKStepSetUserData(arkode_mem, (void *) udata);
if (check_flag(&flag, "ARKStepSetUserData", 1)) return 1;
// Attach linear solver
flag = ARKStepSetLinearSolver(arkode_mem, LS, NULL);
if (check_flag(&flag, "ARKStepSetLinearSolver", 1)) return 1;
if (udata->matvec)
{
// Attach Jacobian-vector product function
flag = ARKStepSetJacTimes(arkode_mem, NULL, JTimes);
if (check_flag(&flag, "ARKStepSetJacTimes", 1)) return 1;
}
if (udata->prec)
{
// Attach preconditioner
flag = ARKStepSetPreconditioner(arkode_mem, PSetup, PSolve);
if (check_flag(&flag, "ARKStepSetPreconditioner", 1)) return 1;
// Set linear solver setup frequency (update preconditioner)
flag = ARKStepSetLSetupFrequency(arkode_mem, udata->msbp);
if (check_flag(&flag, "ARKStepSetLSetupFrequency", 1)) return 1;
}
// Set linear solver tolerance factor
flag = ARKStepSetEpsLin(arkode_mem, udata->epslin);
if (check_flag(&flag, "ARKStepSetEpsLin", 1)) return 1;
// Select method order
if (udata->order > 1)
{
// Use an ARKode provided table
flag = ARKStepSetOrder(arkode_mem, udata->order);
if (check_flag(&flag, "ARKStepSetOrder", 1)) return 1;
}
else
{
// Use implicit Euler (XBraid temporal refinement must be disabled)
realtype c[1], A[1], b[1];
ARKodeButcherTable B = NULL;
// Create implicit Euler Butcher table
c[0] = A[0] = b[0] = ONE;
B = ARKodeButcherTable_Create(1, 1, 0, c, A, b, NULL);
if (check_flag((void*) B, "ARKodeButcherTable_Create", 0)) return 1;
// Attach the Butcher table
flag = ARKStepSetTables(arkode_mem, 1, 0, B, NULL);
if (check_flag(&flag, "ARKStepSetTables", 1)) return 1;
// Free the Butcher table
ARKodeButcherTable_Free(B);
}
// Specify linearly implicit non-time-dependent RHS
if (udata->linear)
{
flag = ARKStepSetLinear(arkode_mem, 0);
if (check_flag(&flag, "ARKStepSetLinear", 1)) return 1;
}
// Set adaptive stepping (XBraid with temporal refinement) options
if (udata->x_refine)
{
// Use I controller
flag = ARKStepSetAdaptivityMethod(arkode_mem, ARK_ADAPT_I, 1, 0, NULL);
if (check_flag(&flag, "ARKStepSetAdaptivityMethod", 1)) return 1;
// Set the step size reduction factor limit (1 / refinement factor limit)
flag = ARKStepSetMinReduction(arkode_mem, ONE / udata->x_rfactor_limit);
if (check_flag(&flag, "ARKStepSetMinReduction", 1)) return 1;
// Set the failed solve step size reduction factor (1 / refinement factor)
flag = ARKStepSetMaxCFailGrowth(arkode_mem, ONE / udata->x_rfactor_fail);
if (check_flag(&flag, "ARKStepSetMaxCFailGrowth", 1)) return 1;
}
// Set diagnostics output file
if (udata->diagnostics && udata->myid_c == 0)
{
flag = ARKStepSetDiagnostics(arkode_mem, diagfp);
if (check_flag(&flag, "ARKStepSetDiagnostics", 1)) return 1;
}
// ------------------------
// Create XBraid interface
// ------------------------
// Create the ARKStep + XBraid interface
flag = ARKBraid_Create(arkode_mem, &app);
if (check_flag(&flag, "ARKBraid_Create", 1)) return 1;
// Override the default initialization function
flag = ARKBraid_SetInitFn(app, MyInit);
if (check_flag(&flag, "ARKBraid_SetInitFn", 1)) return 1;
// Override the default access function
flag = ARKBraid_SetAccessFn(app, MyAccess);
if (check_flag(&flag, "ARKBraid_SetAccesFn", 1)) return 1;
// Initialize the ARKStep + XBraid interface
flag = ARKBraid_BraidInit(comm_w, udata->comm_t, ZERO, udata->tf,
udata->x_nt, app, &core);
if (check_flag(&flag, "ARKBraid_BraidInit", 1)) return 1;
// ----------------------
// Set XBraid parameters
// ----------------------
flag = braid_SetTemporalNorm(core, udata->x_tnorm);
if (check_flag(&flag, "braid_SetTemporalNorm", 1)) return 1;
if (udata->x_reltol)
{
flag = braid_SetRelTol(core, udata->x_tol);
if (check_flag(&flag, "braid_SetRelTol", 1)) return 1;
}
else
{
// Since we are using the Euclidean 2-norm in space, scale the tolerance so
// it approximates to L2-norm.
realtype tolfactor;
if (udata->x_tnorm == 3)
{
// Infinity norm in time
tolfactor = sqrt(udata->nx * udata->ny);
}
else
{
// 2-norm in time
tolfactor = sqrt(udata->nx * udata->nx * udata->x_nt);
}
flag = braid_SetAbsTol(core, udata->x_tol * tolfactor);
if (check_flag(&flag, "braid_SetAbsTol", 1)) return 1;
}
flag = braid_SetSkip(core, udata->x_skip);
if (check_flag(&flag, "braid_SetSkip", 1)) return 1;
flag = braid_SetMaxLevels( core, udata->x_max_levels );
if (check_flag(&flag, "braid_SetMaxLevels", 1)) return 1;
flag = braid_SetMinCoarse( core, udata->x_min_coarse );
if (check_flag(&flag, "braid_SetMinCoarse", 1)) return 1;
flag = braid_SetNRelax(core, -1, udata->x_nrelax);
if (check_flag(&flag, "braid_SetNRelax", 1)) return 1;
if (udata->x_nrelax0 > -1)
{
flag = braid_SetNRelax(core, 0, udata->x_nrelax0);
if (check_flag(&flag, "braid_SetNRelax", 1)) return 1;
}
flag = braid_SetCFactor(core, -1, udata->x_cfactor);
if (check_flag(&flag, "braid_SetCFactor", 1)) return 1;
if (udata->x_cfactor0 > 0)
{
flag = braid_SetCFactor(core, 0, udata->x_cfactor0);
if (check_flag(&flag, "braid_SetCFactor", 1)) return 1;
}
flag = braid_SetMaxIter(core, udata->x_max_iter);
if (check_flag(&flag, "braid_SetMaxIter", 1)) return 1;
if (udata->x_fmg)
{
// Use F-cycles
flag = braid_SetFMG(core);
if (check_flag(&flag, "braid_SetFMG", 1)) return 1;
}
flag = braid_SetPrintLevel(core, udata->x_print_level);
if (check_flag(&flag, "braid_SetPrintLevel", 1)) return 1;
flag = braid_SetAccessLevel(core, udata->x_access_level);
if (check_flag(&flag, "braid_SetAccessLevel", 1)) return 1;
if (udata->x_initseq) {
flag = braid_SetSeqSoln(core, 1);
if (check_flag(&flag, "braid_SetSeqSoln", 1)) return 1;
}
// Temporal refinement
if (udata->x_refine)
{
// Enable refinement
flag = braid_SetRefine(core, 1);
if (check_flag(&flag, "braid_SetRefine", 1)) return 1;
// Set maximum number of refinements
flag = braid_SetMaxRefinements(core, udata->x_max_refine);
if (check_flag(&flag, "braid_SetMaxRefinements", 1)) return 1;
// Use F-cycles
flag = braid_SetFMG(core);
if (check_flag(&flag, "braid_SetFMG", 1)) return 1;
// Increase max levels after refinement
flag = braid_SetIncrMaxLevels(core);
if (check_flag(&flag, "braid_SetIncrMaxLevels", 1)) return 1;
}
// -----------------
// "Loop" over time
// -----------------
// Start timer
t1 = MPI_Wtime();
// Evolve in time
flag = braid_Drive(core);
if (check_flag(&flag, "braid_Drive", 1)) return 1;
// Stop timer
t2 = MPI_Wtime();
// Update timer
udata->evolvetime += t2 - t1;
// --------------
// Final outputs
// --------------
// Print final integrator stats
if (udata->output > 0)
{
if (outproc) cout << "Final max integrator statistics:" << endl;
flag = OutputStats(arkode_mem, udata);
if (check_flag(&flag, "OutputStats", 1)) return 1;
}
// Print timing
if (udata->timing)
{
flag = OutputTiming(udata);
if (check_flag(&flag, "OutputTiming", 1)) return 1;
}
// --------------------
// Clean up and return
// --------------------
if ((udata->diagnostics || udata->lsinfo) && udata->myid_c == 0) fclose(diagfp);
ARKStepFree(&arkode_mem); // Free integrator memory
SUNLinSolFree(LS); // Free linear solver
N_VDestroy(u); // Free vectors
FreeUserData(udata); // Free user data
delete udata;
braid_Destroy(core); // Free braid memory
ARKBraid_Free(&app); // Free interface memory
SUNContext_Free(&ctx); // Free context
flag = MPI_Finalize(); // Finalize MPI
return 0;
}
// -----------------------------------------------------------------------------
// Setup the parallel decomposition
// -----------------------------------------------------------------------------
static int SetupDecomp(MPI_Comm comm_w, UserData *udata)
{
int flag;
// Check that this has not been called before
if (udata->Erecv != NULL || udata->Wrecv != NULL ||
udata->Srecv != NULL || udata->Nrecv != NULL)
{
cerr << "SetupDecomp error: parallel decomposition already set up" << endl;
return -1;
}
// Get the number of processes
flag = MPI_Comm_size(comm_w, &(udata->nprocs_w));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Comm_size = " << flag << endl;
return -1;
}
// Check the processor grid
if ((udata->npx * udata->npy * udata->npt) != udata->nprocs_w)
{
cerr << "Error: npx * npy != nproc" << endl;
return -1;
}
// Store global communicator
udata->comm_w = comm_w;
// Get global process ID
flag = MPI_Comm_rank(comm_w, &(udata->myid_w));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Comm_rank" << endl;
return -1;
}
// Create communicators for time and space
braid_SplitCommworld(&comm_w, (udata->npx)*(udata->npy),
&(udata->comm_x), &(udata->comm_t));
// Set up 2D Cartesian communicator
int dims[2];
dims[0] = udata->npx;
dims[1] = udata->npy;
int periods[2];
periods[0] = 0;
periods[1] = 0;
flag = MPI_Cart_create(udata->comm_x, 2, dims, periods, 0, &(udata->comm_c));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Cart_create = " << flag << endl;
return -1;
}
// Get my rank in the new Cartesian communicator
flag = MPI_Comm_rank(udata->comm_c, &(udata->myid_c));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Comm_rank = " << flag << endl;
return -1;
}
// Get dimension of the Cartesian communicator and my coordinates
int coords[2];
flag = MPI_Cart_get(udata->comm_c, 2, dims, periods, coords);
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Cart_get = " << flag << endl;
return -1;
}
// Determine local extents in x-direction
int idx = coords[0];
sunindextype qx = udata->nx / dims[0];
sunindextype rx = udata->nx % dims[0];
udata->is = qx * idx + (idx < rx ? idx : rx);
udata->ie = udata->is + qx - 1 + (idx < rx ? 1 : 0);
// Sanity check
if (udata->ie > (udata->nx - 1))
{
cerr << "Error ie > nx - 1" << endl;
return -1;
}
// Determine local extents in y-direction
int idy = coords[1];
sunindextype qy = udata->ny / dims[1];
sunindextype ry = udata->ny % dims[1];
udata->js = qy * idy + (idy < ry ? idy : ry);
udata->je = udata->js + qy - 1 + (idy < ry ? 1 : 0);
// Sanity check
if (udata->je > (udata->ny - 1))
{
cerr << "Error je > ny - 1" << endl;
return -1;
}
// Number of local nodes
udata->nx_loc = (udata->ie) - (udata->is) + 1;
udata->ny_loc = (udata->je) - (udata->js) + 1;
// Initialize global and local vector lengths
udata->nodes = udata->nx * udata->ny;
udata->nodes_loc = udata->nx_loc * udata->ny_loc;
// Determine if this proc has neighbors
udata->HaveNbrW = (udata->is != 0);
udata->HaveNbrE = (udata->ie != udata->nx-1);
udata->HaveNbrS = (udata->js != 0);
udata->HaveNbrN = (udata->je != udata->ny-1);
// Allocate exchange buffers if necessary
if (udata->HaveNbrW)
{
udata->Wrecv = new realtype[udata->ny_loc];
udata->Wsend = new realtype[udata->ny_loc];
}
if (udata->HaveNbrE)
{
udata->Erecv = new realtype[udata->ny_loc];
udata->Esend = new realtype[udata->ny_loc];
}
if (udata->HaveNbrS)
{
udata->Srecv = new realtype[udata->nx_loc];
udata->Ssend = new realtype[udata->nx_loc];
}
if (udata->HaveNbrN)
{
udata->Nrecv = new realtype[udata->nx_loc];
udata->Nsend = new realtype[udata->nx_loc];
}
// MPI neighborhood information
int nbcoords[2];
// West neighbor
if (udata->HaveNbrW)
{
nbcoords[0] = coords[0]-1;
nbcoords[1] = coords[1];
flag = MPI_Cart_rank(udata->comm_c, nbcoords, &(udata->ipW));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Cart_rank = " << flag << endl;
return -1;
}
}
// East neighbor
if (udata->HaveNbrE)
{
nbcoords[0] = coords[0]+1;
nbcoords[1] = coords[1];
flag = MPI_Cart_rank(udata->comm_c, nbcoords, &(udata->ipE));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Cart_rank = " << flag << endl;
return -1;
}
}
// South neighbor
if (udata->HaveNbrS)
{
nbcoords[0] = coords[0];
nbcoords[1] = coords[1]-1;
flag = MPI_Cart_rank(udata->comm_c, nbcoords, &(udata->ipS));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Cart_rank = " << flag << endl;
return -1;
}
}
// North neighbor
if (udata->HaveNbrN)
{
nbcoords[0] = coords[0];
nbcoords[1] = coords[1]+1;
flag = MPI_Cart_rank(udata->comm_c, nbcoords, &(udata->ipN));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Cart_rank = " << flag << endl;
return -1;
}
}
// Return success
return 0;
}
// -----------------------------------------------------------------------------
// Functions provided to XBraid
// -----------------------------------------------------------------------------
// Create and initialize vectors
int MyInit(braid_App app, realtype t, braid_Vector *u_ptr)
{
int flag;
void *user_data;
UserData *udata;
// Get user data pointer
ARKBraid_GetUserData(app, &user_data);
udata = static_cast<UserData*>(user_data);
// Create new vector
N_Vector y = N_VNew_Parallel(udata->comm_c, udata->nodes_loc, udata->nodes,
udata->ctx);
flag = SUNBraidVector_New(y, u_ptr);
if (flag != 0) return 1;
// Set initial solution at all time points
if (t == ZERO)
{
flag = Solution(t, y, udata);
if (flag != 0) return 1;
}
else
{
N_VConst(ZERO, y);
}
return 0;
}
// Access XBraid and current vector
int MyAccess(braid_App app, braid_Vector u, braid_AccessStatus astatus)
{
int flag; // return flag
int iter; // current iteration number
int level; // current level
int done; // has XBraid finished
realtype t; // current time
void *user_data;
UserData *udata;
// Start timer
double t1 = MPI_Wtime();
// Get user data pointer
ARKBraid_GetUserData(app, &user_data);
udata = static_cast<UserData*>(user_data);
// Get current time, iteration, level, and status
braid_AccessStatusGetTILD(astatus, &t, &iter, &level, &done);
// Output on fine level when XBraid has finished
if (level == 0 && done)
{
// Get current time index and number of fine grid points
int index;
int ntpts;
braid_AccessStatusGetTIndex(astatus, &index);
braid_AccessStatusGetNTPoints(astatus, &ntpts);
// Extract NVector
N_Vector y = NULL;
flag = SUNBraidVector_GetNVector(u, &y);
if (flag != 0) return 1;
// Write visualization files
if (udata->output == 2)
{
// Get output frequency (ensure the final time is output)
int qout = ntpts / udata->nout;
int rout = ntpts % udata->nout;
int nout = (rout > 0) ? udata->nout + 2 : udata->nout + 1;
// File name for output streams
stringstream fname;
// Output problem information
if (index == 0)
{
// Each processor outputs subdomain information
fname << "heat2d_info."
<< setfill('0') << setw(5) << udata->myid_c << ".txt";
ofstream dout;
dout.open(fname.str());
dout << "xu " << udata->xu << endl;
dout << "yu " << udata->yu << endl;
dout << "nx " << udata->nx << endl;
dout << "ny " << udata->ny << endl;
dout << "px " << udata->npx << endl;
dout << "py " << udata->npy << endl;
dout << "pt " << udata->npt << endl;
dout << "np " << udata->nprocs_w << endl;
dout << "is " << udata->is << endl;
dout << "ie " << udata->ie << endl;
dout << "js " << udata->js << endl;
dout << "je " << udata->je << endl;
dout << "nt " << nout << endl;
dout.close();
}
// Output solution and error
if (!(index % qout) || index == ntpts)
{
// Open output streams
fname.str("");
fname.clear();
fname << "heat2d_solution."
<< setfill('0') << setw(5) << udata->myid_c
<< setfill('0') << setw(6) << index / qout << ".txt";
udata->uout.open(fname.str());
udata->uout << scientific;
udata->uout << setprecision(numeric_limits<realtype>::digits10);
fname.str("");
fname.clear();
fname << "heat2d_error."
<< setfill('0') << setw(5) << udata->myid_c
<< setfill('0') << setw(6) << index / qout << ".txt";
udata->eout.open(fname.str());
udata->eout << scientific;
udata->eout << setprecision(numeric_limits<realtype>::digits10);
// Compute the error
flag = SolutionError(t, y, udata->e, udata);
if (check_flag(&flag, "SolutionError", 1)) return 1;
// Output solution to disk
realtype *yarray = N_VGetArrayPointer(y);
if (check_flag((void *) yarray, "N_VGetArrayPointer", 0)) return -1;
udata->uout << t << " ";
for (sunindextype i = 0; i < udata->nodes_loc; i++)
{
udata->uout << yarray[i] << " ";
}
udata->uout << endl;
// Output error to disk
realtype *earray = N_VGetArrayPointer(udata->e);
if (check_flag((void *) earray, "N_VGetArrayPointer", 0)) return -1;
udata->eout << t << " ";
for (sunindextype i = 0; i < udata->nodes_loc; i++)
{
udata->eout << earray[i] << " ";
}
udata->eout << endl;
// Close output streams
udata->uout.close();
udata->eout.close();
}
}
// Output final error
if (index == ntpts)
{
// Compute the max error
flag = SolutionError(t, y, udata->e, udata);
if (check_flag(&flag, "SolutionError", 1)) return 1;
realtype maxerr = N_VMaxNorm(udata->e);
if (udata->myid_c == 0)
{
cout << scientific;
cout << setprecision(numeric_limits<realtype>::digits10);
cout << " Max error = " << maxerr << endl << endl;
}
}
}
// Stop timer
double t2 = MPI_Wtime();
// Update timing
udata->accesstime = t2 - t1;
return 0;
}
// -----------------------------------------------------------------------------
// Functions called by the integrator
// -----------------------------------------------------------------------------
// f routine to compute the ODE RHS function f(t,y).
static int f(realtype t, N_Vector u, N_Vector f, void *user_data)
{
int flag;
sunindextype i, j;
// Start timer
double t1 = MPI_Wtime();
// Access problem data
UserData *udata = (UserData *) user_data;
// Open exchange receives
flag = PostRecv(udata);
if (check_flag(&flag, "PostRecv", 1)) return -1;
// Send exchange data
flag = SendData(u, udata);
if (check_flag(&flag, "SendData", 1)) return -1;
// Shortcuts to local number of nodes
sunindextype nx_loc = udata->nx_loc;
sunindextype ny_loc = udata->ny_loc;
// Determine iteration range excluding the overall domain boundary
sunindextype istart = (udata->HaveNbrW) ? 0 : 1;
sunindextype iend = (udata->HaveNbrE) ? nx_loc : nx_loc - 1;
sunindextype jstart = (udata->HaveNbrS) ? 0 : 1;
sunindextype jend = (udata->HaveNbrN) ? ny_loc : ny_loc - 1;
// Constants for computing diffusion term
realtype cx = udata->kx / (udata->dx * udata->dx);
realtype cy = udata->ky / (udata->dy * udata->dy);
realtype cc = -TWO * (cx + cy);
// Access data arrays
realtype *uarray = N_VGetArrayPointer(u);
if (check_flag((void *) uarray, "N_VGetArrayPointer", 0)) return -1;
realtype *farray = N_VGetArrayPointer(f);
if (check_flag((void *) farray, "N_VGetArrayPointer", 0)) return -1;
// Initialize rhs vector to zero (handles boundary conditions)
N_VConst(ZERO, f);
// Iterate over subdomain and compute rhs forcing term
if (udata->forcing)
{
realtype x, y;
realtype sin_sqr_x, sin_sqr_y;
realtype cos_sqr_x, cos_sqr_y;
realtype bx = (udata->kx) * TWO * PI * PI;
realtype by = (udata->ky) * TWO * PI * PI;
realtype sin_t_cos_t = sin(PI * t) * cos(PI * t);
realtype cos_sqr_t = cos(PI * t) * cos(PI * t);
for (j = jstart; j < jend; j++)
{
for (i = istart; i < iend; i++)
{
x = (udata->is + i) * udata->dx;
y = (udata->js + j) * udata->dy;
sin_sqr_x = sin(PI * x) * sin(PI * x);
sin_sqr_y = sin(PI * y) * sin(PI * y);
cos_sqr_x = cos(PI * x) * cos(PI * x);
cos_sqr_y = cos(PI * y) * cos(PI * y);
farray[IDX(i,j,nx_loc)] =
-TWO * PI * sin_sqr_x * sin_sqr_y * sin_t_cos_t
-bx * (cos_sqr_x - sin_sqr_x) * sin_sqr_y * cos_sqr_t
-by * (cos_sqr_y - sin_sqr_y) * sin_sqr_x * cos_sqr_t;
}
}
}
// Iterate over subdomain interior and add rhs diffusion term
for (j = 1; j < ny_loc - 1; j++)
{
for (i = 1; i < nx_loc - 1; i++)
{
farray[IDX(i,j,nx_loc)] +=
cc * uarray[IDX(i,j,nx_loc)]
+ cx * (uarray[IDX(i-1,j,nx_loc)] + uarray[IDX(i+1,j,nx_loc)])
+ cy * (uarray[IDX(i,j-1,nx_loc)] + uarray[IDX(i,j+1,nx_loc)]);
}
}
// Wait for exchange receives
flag = WaitRecv(udata);
if (check_flag(&flag, "WaitRecv", 1)) return -1;
// Iterate over subdomain boundaries and add rhs diffusion term
realtype *Warray = udata->Wrecv;
realtype *Earray = udata->Erecv;
realtype *Sarray = udata->Srecv;
realtype *Narray = udata->Nrecv;
// West face (updates south-west and north-west corners if necessary)
if (udata->HaveNbrW)
{
i = 0;
if (udata->HaveNbrS) // South-West corner
{
j = 0;
farray[IDX(i,j,nx_loc)] +=
cc * uarray[IDX(i,j,nx_loc)]
+ cx * (Warray[j] + uarray[IDX(i+1,j,nx_loc)])
+ cy * (Sarray[i] + uarray[IDX(i,j+1,nx_loc)]);
}
for (j = 1; j < ny_loc - 1; j++)
{
farray[IDX(i,j,nx_loc)] +=
cc * uarray[IDX(i,j,nx_loc)]
+ cx * (Warray[j] + uarray[IDX(i+1,j,nx_loc)])
+ cy * (uarray[IDX(i,j-1,nx_loc)] + uarray[IDX(i,j+1,nx_loc)]);
}
if (udata->HaveNbrN) // North-West corner
{
j = ny_loc - 1;
farray[IDX(i,j,nx_loc)] +=
cc * uarray[IDX(i,j,nx_loc)]
+ cx * (Warray[j] + uarray[IDX(i+1,j,nx_loc)])
+ cy * (uarray[IDX(i,j-1,nx_loc)] + Narray[i]);
}
}
// East face (updates south-east and north-east corners if necessary)
if (udata->HaveNbrE)
{
i = nx_loc - 1;
if (udata->HaveNbrS) // South-East corner
{
j = 0;
farray[IDX(i,j,nx_loc)] +=
cc * uarray[IDX(i,j,nx_loc)]
+ cx * (uarray[IDX(i-1,j,nx_loc)] + Earray[j])
+ cy * (Sarray[i] + uarray[IDX(i,j+1,nx_loc)]);
}
for (j = 1; j < ny_loc - 1; j++)
{
farray[IDX(i,j,nx_loc)] +=
cc * uarray[IDX(i,j,nx_loc)]
+ cx * (uarray[IDX(i-1,j,nx_loc)] + Earray[j])
+ cy * (uarray[IDX(i,j-1,nx_loc)] + uarray[IDX(i,j+1,nx_loc)]);
}
if (udata->HaveNbrN) // North-East corner
{
j = ny_loc - 1;
farray[IDX(i,j,nx_loc)] +=
cc * uarray[IDX(i,j,nx_loc)]
+ cx * (uarray[IDX(i-1,j,nx_loc)] + Earray[j])
+ cy * (uarray[IDX(i,j-1,nx_loc)] + Narray[i]);
}
}
// South face (excludes corners)
if (udata->HaveNbrS)
{
j = 0;
for (i = 1; i < nx_loc - 1; i++)
{
farray[IDX(i,j,nx_loc)] +=
cc * uarray[IDX(i,j,nx_loc)]
+ cx * (uarray[IDX(i-1,j,nx_loc)] + uarray[IDX(i+1,j,nx_loc)])
+ cy * (Sarray[i] + uarray[IDX(i,j+1,nx_loc)]);
}
}
// North face (excludes corners)
if (udata->HaveNbrN)
{
j = udata->ny_loc - 1;
for (i = 1; i < nx_loc - 1; i++)
{
farray[IDX(i,j,nx_loc)] +=
cc * uarray[IDX(i,j,nx_loc)]
+ cx * (uarray[IDX(i-1,j,nx_loc)] + uarray[IDX(i+1,j,nx_loc)])
+ cy * (uarray[IDX(i,j-1,nx_loc)] + Narray[i]);
}
}
// Stop timer
double t2 = MPI_Wtime();
// Update timer
udata->rhstime += t2 - t1;
// Return success
return 0;
}
// Jacobian-vector product function
static int JTimes(N_Vector v, N_Vector Jv, realtype t, N_Vector y, N_Vector fy,
void *user_data, N_Vector tmp)
{
int flag;
// Start timer
double t1 = MPI_Wtime();
// Access problem data
UserData *udata = (UserData *) user_data;
// Insert input N_Vector entries into HYPRE vector and assemble
flag = HYPRE_StructVectorSetBoxValues(udata->vvec,
udata->ilower, udata->iupper,
N_VGetArrayPointer(v));
if (flag != 0) return -1;
flag = HYPRE_StructVectorAssemble(udata->vvec);
if (flag != 0) return -1;
// Initialize output HYPRE vector and assemble
flag = HYPRE_StructVectorSetConstantValues(udata->Jvvec, ZERO);
if (flag != 0) return -1;
flag = HYPRE_StructVectorAssemble(udata->Jvvec);
if (flag != 0) return -1;
// Compute the matrix-vector product
flag = HYPRE_StructMatrixMatvec(ONE,
udata->Jmatrix,
udata->vvec,
ZERO,
udata->Jvvec);
if (flag != 0) return -1;
// Extract matrix-vector product values
flag = HYPRE_StructVectorGetBoxValues(udata->Jvvec,
udata->ilower, udata->iupper,
N_VGetArrayPointer(Jv));
if (flag != 0) return -1;
// Stop timer
double t2 = MPI_Wtime();
// Update timer
udata->jvtime += t2 - t1;
// Return success
return 0;
}
// Preconditioner setup routine
static int PSetup(realtype t, N_Vector u, N_Vector f, booleantype jok,
booleantype *jcurPtr, realtype gamma, void *user_data)
{
int flag;
// Start timer
double t1 = MPI_Wtime();
// Access problem data
UserData *udata = (UserData *) user_data;
// Fill matrix A = I - gamma * J
flag = ScaleAddI(udata, gamma);
if (flag != 0) return -1;
// Assemble matrix
flag = HYPRE_StructMatrixAssemble(udata->Amatrix);
if (flag != 0) return -1;
// Indicate that the jacobian is current
*jcurPtr = SUNTRUE;
// -----------
// Setup PFMG
// -----------
// Set rhs/solution vectors as all zero for now
flag = HYPRE_StructVectorSetConstantValues(udata->bvec, ZERO);
if (flag != 0) return -1;
flag = HYPRE_StructVectorAssemble(udata->bvec);
if (flag != 0) return -1;
flag = HYPRE_StructVectorSetConstantValues(udata->xvec, ZERO);
if (flag != 0) return -1;
flag = HYPRE_StructVectorAssemble(udata->xvec);
if (flag != 0) return -1;
// Free the existing preconditioner if necessary
if (udata->precond) HYPRE_StructPFMGDestroy(udata->precond);
// Create the new preconditioner
flag = HYPRE_StructPFMGCreate(udata->comm_c, &(udata->precond));
if (flag != 0) return -1;
// Signal that the inital guess is zero
flag = HYPRE_StructPFMGSetZeroGuess(udata->precond);
if (flag != 0) return -1;
// tol <= 0.0 means do the max number of iterations
flag = HYPRE_StructPFMGSetTol(udata->precond, ZERO);
if (flag != 0) return -1;
// Use one v-cycle
flag = HYPRE_StructPFMGSetMaxIter(udata->precond, 1);
if (flag != 0) return -1;
// Use non-Galerkin corase grid operator
flag = HYPRE_StructPFMGSetRAPType(udata->precond, 1);
if (flag != 0) return -1;
// Set the relaxation type
flag = HYPRE_StructPFMGSetRelaxType(udata->precond, udata->pfmg_relax);
if (flag != 0) return -1;
// Set the number of pre and post relaxation sweeps
flag = HYPRE_StructPFMGSetNumPreRelax(udata->precond, udata->pfmg_nrelax);
if (flag != 0) return -1;
flag = HYPRE_StructPFMGSetNumPostRelax(udata->precond, udata->pfmg_nrelax);
if (flag != 0) return -1;
// Set up the solver
flag = HYPRE_StructPFMGSetup(udata->precond, udata->Amatrix,
udata->bvec, udata->xvec);
if (flag != 0) return -1;
// Stop timer
double t2 = MPI_Wtime();
// Update timer
udata->psetuptime += t2 - t1;
// Return success
return 0;
}
// Preconditioner solve routine for Pz = r
static int PSolve(realtype t, N_Vector u, N_Vector f, N_Vector r,
N_Vector z, realtype gamma, realtype delta, int lr,
void *user_data)
{
int flag;
// Start timer
double t1 = MPI_Wtime();
// Access user_data structure
UserData *udata = (UserData *) user_data;
// Insert rhs N_Vector entries into HYPRE vector b and assemble
flag = HYPRE_StructVectorSetBoxValues(udata->bvec,
udata->ilower, udata->iupper,
N_VGetArrayPointer(r));
if (flag != 0) return -1;
flag = HYPRE_StructVectorAssemble(udata->bvec);
if (flag != 0) return -1;
// Set the initial guess into HYPRE vector x and assemble
flag = HYPRE_StructVectorSetConstantValues(udata->xvec, ZERO);
if (flag != 0) return -1;
flag = HYPRE_StructVectorAssemble(udata->xvec);
if (flag != 0) return -1;
// Solve the linear system
flag = HYPRE_StructPFMGSolve(udata->precond, udata->Amatrix,
udata->bvec, udata->xvec);
// If a convergence error occured, clear the error and continue. For any
// other error return with a recoverable error.
if (flag == HYPRE_ERROR_CONV) HYPRE_ClearError(HYPRE_ERROR_CONV);
else if (flag != 0) return 1;
// Update precond statistics
HYPRE_Int itmp;
flag = HYPRE_StructPFMGGetNumIterations(udata->precond, &itmp);
if (flag != 0) return -1;
udata->pfmg_its += itmp;
// Extract solution values
flag = HYPRE_StructVectorGetBoxValues(udata->xvec,
udata->ilower, udata->iupper,
N_VGetArrayPointer(z));
if (flag != 0) return -1;
// Stop timer
double t2 = MPI_Wtime();
// Update timer
udata->psolvetime += t2 - t1;
// Return success
return 0;
}
// -----------------------------------------------------------------------------
// Preconditioner helper functions
// -----------------------------------------------------------------------------
// Create hypre objects
static int SetupHypre(UserData *udata)
{
int flag, result;
// Check input
if (udata == NULL) return -1;
// Check if the grid or stencil have been created
if ((udata->grid != NULL || udata->stencil != NULL))
{
cerr << "SetupHypre error: grid or stencil already exists" << endl;
return -1;
}
// Check for valid 2D Cartesian MPI communicator
flag = MPI_Topo_test(udata->comm_c, &result);
if ((flag != MPI_SUCCESS) || (result != MPI_CART))
{
cerr << "SetupHypre error: communicator is not Cartesian" << endl;
return -1;
}
flag = MPI_Cartdim_get(udata->comm_c, &result);
if ((flag != MPI_SUCCESS) || (result != 2))
{
cerr << "SetupHypre error: communicator is not 2D" << endl;
return -1;
}
// -----
// Grid
// -----
// Create 2D grid object
flag = HYPRE_StructGridCreate(udata->comm_c, 2, &(udata->grid));
if (flag != 0) { FreeUserData(udata); return -1; }
// Set grid extents (lower left and upper right corners)
udata->ilower[0] = udata->is;
udata->ilower[1] = udata->js;
udata->iupper[0] = udata->ie;
udata->iupper[1] = udata->je;
flag = HYPRE_StructGridSetExtents(udata->grid, udata->ilower, udata->iupper);
if (flag != 0) { FreeUserData(udata); return -1; }
// Assemble the grid
flag = HYPRE_StructGridAssemble(udata->grid);
if (flag != 0) { FreeUserData(udata); return -1; }
// --------
// Stencil
// --------
// Create the 2D 5 point stencil object
flag = HYPRE_StructStencilCreate(2, 5, &(udata->stencil));
if (flag != 0) { FreeUserData(udata); return -1; }
// Set the stencil entries (center, left, right, bottom, top)
HYPRE_Int offsets[5][2] = {{0,0}, {-1,0}, {1,0}, {0,-1}, {0,1}};
for (int entry = 0; entry < 5; entry++)
{
flag = HYPRE_StructStencilSetElement(udata->stencil, entry, offsets[entry]);
if (flag != 0) { FreeUserData(udata); return -1; }
}
// -----------
// Work array
// -----------
udata->nwork = 5 * udata->nodes_loc;
udata->work = NULL;
udata->work = new HYPRE_Real[udata->nwork];
if (udata->work == NULL) { FreeUserData(udata); return -1; }
// ---------
// x vector
// ---------
flag = HYPRE_StructVectorCreate(udata->comm_c, udata->grid, &(udata->xvec));
if (flag != 0) { FreeUserData(udata); return -1; }
flag = HYPRE_StructVectorInitialize(udata->xvec);
if (flag != 0) { FreeUserData(udata); return -1; }
// ---------
// b vector
// ---------
flag = HYPRE_StructVectorCreate(udata->comm_c, udata->grid, &(udata->bvec));
if (flag != 0) { FreeUserData(udata); return -1; }
flag = HYPRE_StructVectorInitialize(udata->bvec);
if (flag != 0) { FreeUserData(udata); return -1; }
if (udata->matvec)
{
// ---------
// v vector
// ---------
flag = HYPRE_StructVectorCreate(udata->comm_c, udata->grid, &(udata->vvec));
if (flag != 0) { FreeUserData(udata); return -1; }
flag = HYPRE_StructVectorInitialize(udata->vvec);
if (flag != 0) { FreeUserData(udata); return -1; }
// ----------
// Jv vector
// ----------
flag = HYPRE_StructVectorCreate(udata->comm_c, udata->grid, &(udata->Jvvec));
if (flag != 0) { FreeUserData(udata); return -1; }
flag = HYPRE_StructVectorInitialize(udata->Jvvec);
if (flag != 0) { FreeUserData(udata); return -1; }
}
// ---------
// J matrix
// ---------
flag = HYPRE_StructMatrixCreate(udata->comm_c, udata->grid, udata->stencil,
&(udata->Jmatrix));
if (flag != 0) { FreeUserData(udata); return -1; }
flag = HYPRE_StructMatrixInitialize(udata->Jmatrix);
if (flag != 0) { FreeUserData(udata); return -1; }
// ---------
// A matrix
// ---------
flag = HYPRE_StructMatrixCreate(udata->comm_c, udata->grid, udata->stencil,
&(udata->Amatrix));
if (flag != 0) { FreeUserData(udata); return -1; }
flag = HYPRE_StructMatrixInitialize(udata->Amatrix);
if (flag != 0) { FreeUserData(udata); return -1; }
// --------------------
// PFMG preconditioner
// --------------------
// Note a new PFMG preconditioner must be created and attached each time the
// linear system is updated. As such it is constructed in the preconditioner
// setup function (if enabled).
udata->precond = NULL;
// --------------
// Fill Jacobian
// --------------
if (udata->prec || udata->matvec)
{
flag = Jac(udata);
if (flag != 0) { FreeUserData(udata); return -1; }
flag = HYPRE_StructMatrixAssemble(udata->Jmatrix);
if (flag != 0) { FreeUserData(udata); return -1; }
}
return 0;
}
// Jac function to compute the ODE RHS function Jacobian, (df/dy)(t,y).
static int Jac(UserData *udata)
{
// Shortcuts to hypre matrix and grid extents, work array, etc.
HYPRE_StructMatrix Jmatrix = udata->Jmatrix;
HYPRE_Int ilower[2];
HYPRE_Int iupper[2];
ilower[0] = udata->ilower[0];
ilower[1] = udata->ilower[1];
iupper[0] = udata->iupper[0];
iupper[1] = udata->iupper[1];
HYPRE_Int nwork = udata->nwork;
HYPRE_Real *work = udata->work;
sunindextype nx_loc = udata->nx_loc;
sunindextype ny_loc = udata->ny_loc;
// Matrix stencil: center, left, right, bottom, top
HYPRE_Int entries[5] = {0, 1, 2, 3, 4};
HYPRE_Int entry[1];
// Grid extents for setting boundary entries
HYPRE_Int bc_ilower[2];
HYPRE_Int bc_iupper[2];
// Loop counters
HYPRE_Int idx, ix, iy;
// hypre return flag
int flag;
// ----------
// Compute J
// ----------
// Start timer
double t1 = MPI_Wtime();
// Only do work if the box is non-zero in size
if ((ilower[0] <= iupper[0]) &&
(ilower[1] <= iupper[1]))
{
// Jacobian values
realtype cx = udata->kx / (udata->dx * udata->dx);
realtype cy = udata->ky / (udata->dy * udata->dy);
realtype cc = -TWO * (cx + cy);
// --------------------------------
// Set matrix values for all nodes
// --------------------------------
// Set the matrix interior entries (center, left, right, bottom, top)
idx = 0;
for (iy = 0; iy < ny_loc; iy++)
{
for (ix = 0; ix < nx_loc; ix++)
{
work[idx] = cc;
work[idx + 1] = cx;
work[idx + 2] = cx;
work[idx + 3] = cy;
work[idx + 4] = cy;
idx += 5;
}
}
// Modify the matrix
flag = HYPRE_StructMatrixSetBoxValues(Jmatrix,
ilower, iupper,
5, entries, work);
if (flag != 0) return -1;
// ----------------------------------------
// Correct matrix values at boundary nodes
// ----------------------------------------
// Set the matrix boundary entries (center, left, right, bottom, top)
if (ilower[1] == 0 ||
iupper[1] == (udata->ny - 1) ||
ilower[0] == 0 ||
iupper[0] == (udata->nx - 1))
{
idx = 0;
for (iy = 0; iy < ny_loc; iy++)
{
for (ix = 0; ix < nx_loc; ix++)
{
work[idx] = ONE;
work[idx + 1] = ZERO;
work[idx + 2] = ZERO;
work[idx + 3] = ZERO;
work[idx + 4] = ZERO;
idx += 5;
}
}
}
// Set cells on western boundary
if (ilower[0] == 0)
{
// Grid cell on south-west corner
bc_ilower[0] = ilower[0];
bc_ilower[1] = ilower[1];
// Grid cell on north-west corner
bc_iupper[0] = ilower[0];
bc_iupper[1] = iupper[1];
// Only do work if the box is non-zero in size
if ((bc_ilower[0] <= bc_iupper[0]) && (bc_ilower[1] <= bc_iupper[1]))
{
// Modify the matrix
flag = HYPRE_StructMatrixSetBoxValues(Jmatrix,
bc_ilower, bc_iupper,
5, entries, work);
if (flag != 0) return -1;
}
}
// Set cells on eastern boundary
if (iupper[0] == (udata->nx - 1))
{
// Grid cell on south-east corner
bc_ilower[0] = iupper[0];
bc_ilower[1] = ilower[1];
// Grid cell on north-east corner
bc_iupper[0] = iupper[0];
bc_iupper[1] = iupper[1];
// Only do work if the box is non-zero in size
if ((bc_ilower[0] <= bc_iupper[0]) && (bc_ilower[1] <= bc_iupper[1]))
{
// Modify the matrix
flag = HYPRE_StructMatrixSetBoxValues(Jmatrix,
bc_ilower, bc_iupper,
5, entries, work);
if (flag != 0) return -1;
}
}
// Correct cells on southern boundary
if (ilower[1] == 0)
{
// Grid cell on south-west corner
bc_ilower[0] = ilower[0];
bc_ilower[1] = ilower[1];
// Grid cell on south-east corner
bc_iupper[0] = iupper[0];
bc_iupper[1] = ilower[1];
// Only do work if the box is non-zero in size
if ((bc_ilower[0] <= bc_iupper[0]) && (bc_ilower[1] <= bc_iupper[1]))
{
// Modify the matrix
flag = HYPRE_StructMatrixSetBoxValues(Jmatrix,
bc_ilower, bc_iupper,
5, entries, work);
if (flag != 0) return -1;
}
}
// Set cells on northern boundary
if (iupper[1] == (udata->ny - 1))
{
// Grid cell on north-west corner
bc_ilower[0] = ilower[0];
bc_ilower[1] = iupper[1];
// Grid cell on north-east corner
bc_iupper[0] = iupper[0];
bc_iupper[1] = iupper[1];
// Only do work if the box is non-zero in size
if ((bc_ilower[0] <= bc_iupper[0]) && (bc_ilower[1] <= bc_iupper[1]))
{
// Modify the matrix
flag = HYPRE_StructMatrixSetBoxValues(Jmatrix,
bc_ilower, bc_iupper,
5, entries, work);
if (flag != 0) return -1;
}
}
// -----------------------------------------------------------
// Remove connections between the interior and boundary nodes
// -----------------------------------------------------------
// Zero out work array
for (ix = 0; ix < nwork; ix++)
{
work[ix] = ZERO;
}
// Second column of nodes (depends on western boundary)
if ((ilower[0] <= 1) && (iupper[0] >= 1))
{
// Remove western dependency
entry[0] = 1;
// Grid cell on south-west corner
bc_ilower[0] = 1;
bc_ilower[1] = ilower[1];
// Grid cell on north-west corner
bc_iupper[0] = 1;
bc_iupper[1] = iupper[1];
// Only do work if the box is non-zero in size
if ((bc_ilower[0] <= bc_iupper[0]) && (bc_ilower[1] <= bc_iupper[1]))
{
// Modify the matrix
flag = HYPRE_StructMatrixSetBoxValues(Jmatrix,
bc_ilower, bc_iupper,
1, entry, work);
if (flag != 0) return -1;
}
}
// Next to last column (depends on eastern boundary)
if ((ilower[0] <= (udata->nx - 2)) &&
(iupper[0] >= (udata->nx - 2)))
{
// Remove eastern dependency
entry[0] = 2;
// Grid cell on south-east corner
bc_ilower[0] = udata->nx - 2;
bc_ilower[1] = ilower[1];
// Grid cell on north-east corner
bc_iupper[0] = udata->nx - 2;
bc_iupper[1] = iupper[1];
// Only do work if the box is non-zero in size
if ((bc_ilower[0] <= bc_iupper[0]) && (bc_ilower[1] <= bc_iupper[1]))
{
// Modify the matrix
flag = HYPRE_StructMatrixSetBoxValues(Jmatrix,
bc_ilower, bc_iupper,
1, entry, work);
if (flag != 0) return -1;
}
}
// Second row of nodes (depends on southern boundary)
if ((ilower[1] <= 1) && (iupper[1] >= 1))
{
// Remove southern dependency
entry[0] = 3;
// Grid cell on south-west corner
bc_ilower[0] = ilower[0];
bc_ilower[1] = 1;
// Grid cell on south-east corner
bc_iupper[0] = iupper[0];
bc_iupper[1] = 1;
// Only do work if the box is non-zero in size
if ((bc_ilower[0] <= bc_iupper[0]) && (bc_ilower[1] <= bc_iupper[1]))
{
// Modify the matrix
flag = HYPRE_StructMatrixSetBoxValues(Jmatrix,
bc_ilower, bc_iupper,
1, entry, work);
if (flag != 0) return -1;
}
}
// Next to last row of nodes (depends on northern boundary)
if ((ilower[1] <= (udata->ny - 2)) &&
(iupper[1] >= (udata->ny - 2)))
{
// Remove northern dependency
entry[0] = 4;
// Grid cell on north-west corner
bc_ilower[0] = ilower[0];
bc_ilower[1] = udata->ny - 2;
// Grid cell on north-east corner
bc_iupper[0] = iupper[0];
bc_iupper[1] = udata->ny - 2;
// Only do work if the box is non-zero in size
if ((bc_ilower[0] <= bc_iupper[0]) && (bc_ilower[1] <= bc_iupper[1]))
{
// Modify the matrix
flag = HYPRE_StructMatrixSetBoxValues(Jmatrix,
bc_ilower, bc_iupper,
1, entry, work);
if (flag != 0) return -1;
}
}
}
// The matrix is assembled matrix in hypre setup
// Stop timer
double t2 = MPI_Wtime();
// Update timer
udata->matfilltime += t2 - t1;
// Return success
return 0;
}
// Fill A = I - gamma * J matrix
static int ScaleAddI(UserData *udata, realtype gamma)
{
int flag;
// Variable shortcuts
HYPRE_Int ilower[2];
HYPRE_Int iupper[2];
ilower[0] = udata->ilower[0];
ilower[1] = udata->ilower[1];
iupper[0] = udata->iupper[0];
iupper[1] = udata->iupper[1];
HYPRE_Int nwork = udata->nwork;
HYPRE_Real *work = udata->work;
// Matrix stencil: center, left, right, bottom, top
HYPRE_Int entries[5] = {0, 1, 2, 3, 4};
// Copy all matrix values into work array from J
flag = HYPRE_StructMatrixGetBoxValues(udata->Jmatrix,
ilower, iupper,
5, entries, work);
if (flag != 0) return(flag);
// Scale work array by c
for (HYPRE_Int i = 0; i < nwork; i++)
work[i] *= -gamma;
// Insert scaled values into A
flag = HYPRE_StructMatrixSetBoxValues(udata->Amatrix,
ilower, iupper,
5, entries, work);
if (flag != 0) return(flag);
// Set first 1/5 of work array to 1
for (HYPRE_Int i = 0; i < nwork/5; i++)
work[i] = ONE;
// Add values to the diagonal of A
HYPRE_Int entry[1] = {0};
flag = HYPRE_StructMatrixAddToBoxValues(udata->Amatrix,
ilower, iupper,
1, entry, work);
if (flag != 0) return(flag);
// Return success
return 0;
}
// -----------------------------------------------------------------------------
// RHS helper functions
// -----------------------------------------------------------------------------
// Post exchange receives
static int PostRecv(UserData *udata)
{
int flag;
// Start timer
double t1 = MPI_Wtime();
// Open Irecv buffers
if (udata->HaveNbrW)
{
flag = MPI_Irecv(udata->Wrecv, (int) udata->ny_loc, MPI_SUNREALTYPE,
udata->ipW, MPI_ANY_TAG, udata->comm_c, &(udata->reqRW));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Irecv = " << flag << endl;
return -1;
}
}
if (udata->HaveNbrE)
{
flag = MPI_Irecv(udata->Erecv, (int) udata->ny_loc, MPI_SUNREALTYPE,
udata->ipE, MPI_ANY_TAG, udata->comm_c, &(udata->reqRE));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Irecv = " << flag << endl;
return -1;
}
}
if (udata->HaveNbrS)
{
flag = MPI_Irecv(udata->Srecv, (int) udata->nx_loc, MPI_SUNREALTYPE,
udata->ipS, MPI_ANY_TAG, udata->comm_c, &(udata->reqRS));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Irecv = " << flag << endl;
return -1;
}
}
if (udata->HaveNbrN)
{
flag = MPI_Irecv(udata->Nrecv, (int) udata->nx_loc, MPI_SUNREALTYPE,
udata->ipN, MPI_ANY_TAG, udata->comm_c, &(udata->reqRN));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Irecv = " << flag << endl;
return -1;
}
}
// Stop timer
double t2 = MPI_Wtime();
// Update timer
udata->exchangetime += t2 - t1;
// Return success
return 0;
}
// Send exchange data
static int SendData(N_Vector y, UserData *udata)
{
int flag, i;
sunindextype ny_loc = udata->ny_loc;
sunindextype nx_loc = udata->nx_loc;
// Start timer
double t1 = MPI_Wtime();
// Access data array
realtype *Y = N_VGetArrayPointer(y);
if (check_flag((void *) Y, "N_VGetArrayPointer", 0)) return -1;
// Send data
if (udata->HaveNbrW)
{
for (i = 0; i < ny_loc; i++) udata->Wsend[i] = Y[IDX(0,i,nx_loc)];
flag = MPI_Isend(udata->Wsend, (int) udata->ny_loc, MPI_SUNREALTYPE,
udata->ipW, 0, udata->comm_c, &(udata->reqSW));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Isend = " << flag << endl;
return -1;
}
}
if (udata->HaveNbrE)
{
for (i = 0; i < ny_loc; i++) udata->Esend[i] = Y[IDX(nx_loc-1,i,nx_loc)];
flag = MPI_Isend(udata->Esend, (int) udata->ny_loc, MPI_SUNREALTYPE,
udata->ipE, 1, udata->comm_c, &(udata->reqSE));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Isend = " << flag << endl;
return -1;
}
}
if (udata->HaveNbrS)
{
for (i = 0; i < nx_loc; i++) udata->Ssend[i] = Y[IDX(i,0,nx_loc)];
flag = MPI_Isend(udata->Ssend, (int) udata->nx_loc, MPI_SUNREALTYPE,
udata->ipS, 2, udata->comm_c, &(udata->reqSS));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Isend = " << flag << endl;
return -1;
}
}
if (udata->HaveNbrN)
{
for (i = 0; i < nx_loc; i++) udata->Nsend[i] = Y[IDX(i,ny_loc-1,nx_loc)];
flag = MPI_Isend(udata->Nsend, (int) udata->nx_loc, MPI_SUNREALTYPE,
udata->ipN, 3, udata->comm_c, &(udata->reqSN));
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Isend = " << flag << endl;
return -1;
}
}
// Stop timer
double t2 = MPI_Wtime();
// Update timer
udata->exchangetime += t2 - t1;
// Return success
return 0;
}
// Wait for exchange data
static int WaitRecv(UserData *udata)
{
// Local variables
int flag;
MPI_Status stat;
// Start timer
double t1 = MPI_Wtime();
// Wait for messages to finish
if (udata->HaveNbrW)
{
flag = MPI_Wait(&(udata->reqRW), &stat);
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Wait = " << flag << endl;
return -1;
}
flag = MPI_Wait(&(udata->reqSW), &stat);
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Wait = " << flag << endl;
return -1;
}
}
if (udata->HaveNbrE)
{
flag = MPI_Wait(&(udata->reqRE), &stat);
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Wait = " << flag << endl;
return -1;
}
flag = MPI_Wait(&(udata->reqSE), &stat);
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Wait = " << flag << endl;
return -1;
}
}
if (udata->HaveNbrS)
{
flag = MPI_Wait(&(udata->reqRS), &stat);
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Wait = " << flag << endl;
return -1;
}
flag = MPI_Wait(&(udata->reqSS), &stat);
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Wait = " << flag << endl;
return -1;
}
}
if (udata->HaveNbrN)
{
flag = MPI_Wait(&(udata->reqRN), &stat);
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Wait = " << flag << endl;
return -1;
}
flag = MPI_Wait(&(udata->reqSN), &stat);
if (flag != MPI_SUCCESS)
{
cerr << "Error in MPI_Wait = " << flag << endl;
return -1;
}
}
// Stop timer
double t2 = MPI_Wtime();
// Update timer
udata->exchangetime += t2 - t1;
// Return success
return 0;
}
// -----------------------------------------------------------------------------
// UserData and input functions
// -----------------------------------------------------------------------------
// Initialize memory allocated within Userdata
static int InitUserData(UserData *udata, SUNContext ctx)
{
// SUNDIALS simulation context
udata->ctx = ctx;
// Diffusion coefficient
udata->kx = ONE;
udata->ky = ONE;
// Enable forcing
udata->forcing = true;
// Final time
udata->tf = ONE;
// Upper bounds in x and y directions
udata->xu = ONE;
udata->yu = ONE;
// Global number of nodes in the x and y directions
udata->nx = 32;
udata->ny = 32;
udata->nodes = udata->nx * udata->ny;
// Mesh spacing in the x and y directions
udata->dx = udata->xu / (udata->nx - 1);
udata->dy = udata->yu / (udata->ny - 1);
// Locals number of nodes in the x and y directions (set in SetupDecomp)
udata->nx_loc = 0;
udata->ny_loc = 0;
udata->nodes_loc = 0;
// Global indices of this subdomain (set in SetupDecomp)
udata->is = 0;
udata->ie = 0;
udata->js = 0;
udata->je = 0;
// MPI variables (set in SetupDecomp)
udata->comm_w = MPI_COMM_NULL;
udata->comm_t = MPI_COMM_NULL;
udata->comm_x = MPI_COMM_NULL;
udata->comm_c = MPI_COMM_NULL;
udata->nprocs_w = 1;
udata->npx = 1;
udata->npy = 1;
udata->npt = 1;
udata->myid_w = 0;
udata->myid_c = 0;
// Flags denoting neighbors (set in SetupDecomp)
udata->HaveNbrW = true;
udata->HaveNbrE = true;
udata->HaveNbrS = true;
udata->HaveNbrN = true;
// Exchange receive buffers (allocated in SetupDecomp)
udata->Erecv = NULL;
udata->Wrecv = NULL;
udata->Nrecv = NULL;
udata->Srecv = NULL;
// Exchange send buffers (allocated in SetupDecomp)
udata->Esend = NULL;
udata->Wsend = NULL;
udata->Nsend = NULL;
udata->Ssend = NULL;
// Neighbors IDs (set in SetupDecomp)
udata->ipW = -1;
udata->ipE = -1;
udata->ipS = -1;
udata->ipN = -1;
// Integrator settings
udata->rtol = RCONST(1.e-5); // relative tolerance
udata->atol = RCONST(1.e-10); // absolute tolerance
udata->order = 3; // method order
udata->linear = true; // linearly implicit problem
udata->diagnostics = false; // output diagnostics
// Linear solver and preconditioner options
udata->pcg = true; // use PCG (true) or GMRES (false)
udata->prec = true; // enable preconditioning
udata->matvec = false; // use hypre matrix-vector product
udata->lsinfo = false; // output residual history
udata->liniters = 100; // max linear iterations
udata->msbp = 0; // use default (20 steps)
udata->epslin = ZERO; // use default (0.05)
// hypre objects
udata->grid = NULL;
udata->stencil = NULL;
udata->Jmatrix = NULL;
udata->Amatrix = NULL;
udata->bvec = NULL;
udata->xvec = NULL;
udata->vvec = NULL;
udata->Jvvec = NULL;
udata->precond = NULL;
// hypre grid extents
udata->ilower[0] = 0;
udata->ilower[1] = 0;
udata->iupper[0] = 0;
udata->iupper[1] = 0;
// hypre workspace
udata->nwork = 0;
udata->work = NULL;
// hypre counters
udata->pfmg_its = 0;
// hypre PFMG settings
udata->pfmg_relax = 2;
udata->pfmg_nrelax = 2;
// Output variables
udata->output = 1; // 0 = no output, 1 = stats output, 2 = output to disk
udata->nout = 20; // Number of output times
udata->e = NULL;
// Timing variables
udata->timing = false;
udata->evolvetime = 0.0;
udata->rhstime = 0.0;
udata->matfilltime = 0.0;
udata->jvtime = 0.0;
udata->psetuptime = 0.0;
udata->psolvetime = 0.0;
udata->exchangetime = 0.0;
udata->accesstime = 0.0;
// Xbraid
udata->x_tol = 1.0e-6;
udata->x_nt = 300;
udata->x_skip = 1;
udata->x_max_levels = 15;
udata->x_min_coarse = 3;
udata->x_nrelax = 1;
udata->x_nrelax0 = -1;
udata->x_tnorm = 2;
udata->x_cfactor = 2;
udata->x_cfactor0 = -1;
udata->x_max_iter = 100;
udata->x_storage = -1;
udata->x_print_level = 1;
udata->x_access_level = 1;
udata->x_rfactor_limit = 10;
udata->x_rfactor_fail = 4;
udata->x_max_refine = 8;
udata->x_fmg = false;
udata->x_refine = false;
udata->x_initseq = false;
udata->x_reltol = false;
udata->x_init_u0 = false;
// Return success
return 0;
}
// Free memory allocated within Userdata
static int FreeUserData(UserData *udata)
{
// Free exchange buffers
if (udata->Wrecv != NULL) delete[] udata->Wrecv;
if (udata->Wsend != NULL) delete[] udata->Wsend;
if (udata->Erecv != NULL) delete[] udata->Erecv;
if (udata->Esend != NULL) delete[] udata->Esend;
if (udata->Srecv != NULL) delete[] udata->Srecv;
if (udata->Ssend != NULL) delete[] udata->Ssend;
if (udata->Nrecv != NULL) delete[] udata->Nrecv;
if (udata->Nsend != NULL) delete[] udata->Nsend;
// Free hypre preconditioner data
if (udata->grid != NULL) HYPRE_StructGridDestroy(udata->grid);
if (udata->stencil != NULL) HYPRE_StructStencilDestroy(udata->stencil);
if (udata->Jmatrix != NULL) HYPRE_StructMatrixDestroy(udata->Jmatrix);
if (udata->Amatrix != NULL) HYPRE_StructMatrixDestroy(udata->Amatrix);
if (udata->bvec != NULL) HYPRE_StructVectorDestroy(udata->bvec);
if (udata->xvec != NULL) HYPRE_StructVectorDestroy(udata->xvec);
if (udata->vvec != NULL) HYPRE_StructVectorDestroy(udata->vvec);
if (udata->Jvvec != NULL) HYPRE_StructVectorDestroy(udata->Jvvec);
if (udata->precond != NULL) HYPRE_StructPFMGDestroy(udata->precond);
if (udata->work != NULL) delete[] udata->work;
// Free MPI Cartesian communicator
if (udata->comm_c != MPI_COMM_NULL)
MPI_Comm_free(&(udata->comm_c));
// Free MPI space and time communicators
if (udata->comm_t != MPI_COMM_NULL)
MPI_Comm_free(&(udata->comm_t));
if (udata->comm_x != MPI_COMM_NULL)
MPI_Comm_free(&(udata->comm_x));
// Free error vector
if (udata->e)
{
N_VDestroy(udata->e);
udata->e = NULL;
}
// Return success
return 0;
}
// Read command line inputs
static int ReadInputs(int *argc, char ***argv, UserData *udata, bool outproc)
{
// Check for input args
int arg_idx = 1;
while (arg_idx < (*argc))
{
string arg = (*argv)[arg_idx++];
// Mesh points
if (arg == "--mesh")
{
udata->nx = stoi((*argv)[arg_idx++]);
udata->ny = stoi((*argv)[arg_idx++]);
}
// MPI processes
else if (arg == "--np")
{
udata->npx = stoi((*argv)[arg_idx++]);
udata->npy = stoi((*argv)[arg_idx++]);
udata->npt = stoi((*argv)[arg_idx++]);
}
// Domain upper bounds
else if (arg == "--domain")
{
udata->xu = stoi((*argv)[arg_idx++]);
udata->yu = stoi((*argv)[arg_idx++]);
}
// Diffusion parameters
else if (arg == "--k")
{
udata->kx = stod((*argv)[arg_idx++]);
udata->ky = stod((*argv)[arg_idx++]);
}
// Disable forcing
else if (arg == "--noforcing")
{
udata->forcing = false;
}
// Temporal domain settings
else if (arg == "--tf")
{
udata->tf = stod((*argv)[arg_idx++]);
}
// Integrator settings
else if (arg == "--rtol")
{
udata->rtol = stod((*argv)[arg_idx++]);
}
else if (arg == "--atol")
{
udata->atol = stod((*argv)[arg_idx++]);
}
else if (arg == "--order")
{
udata->order = stoi((*argv)[arg_idx++]);
}
else if (arg == "--nonlinear")
{
udata->linear = false;
}
else if (arg == "--diagnostics")
{
udata->diagnostics = true;
}
// Linear solver settings
else if (arg == "--gmres")
{
udata->pcg = false;
}
else if (arg == "--matvec")
{
udata->matvec = true;
}
else if (arg == "--lsinfo")
{
udata->lsinfo = true;
}
else if (arg == "--liniters")
{
udata->liniters = stoi((*argv)[arg_idx++]);
}
else if (arg == "--epslin")
{
udata->epslin = stod((*argv)[arg_idx++]);
}
// Preconditioner settings
else if (arg == "--noprec")
{
udata->prec = false;
}
else if (arg == "--msbp")
{
udata->msbp = stoi((*argv)[arg_idx++]);
}
// PFMG settings
else if (arg == "--pfmg_relax")
{
udata->pfmg_relax = stoi((*argv)[arg_idx++]);
}
else if (arg == "--pfmg_nrelax")
{
udata->pfmg_nrelax = stoi((*argv)[arg_idx++]);
}
// XBraid settings
else if (arg == "--x_tol")
{
udata->x_tol = stod((*argv)[arg_idx++]);
}
else if (arg == "--x_nt")
{
udata->x_nt = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_skip")
{
udata->x_skip = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_max_levels")
{
udata->x_max_levels = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_min_coarse")
{
udata->x_min_coarse = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_nrelax")
{
udata->x_nrelax = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_nrelax0")
{
udata->x_nrelax0 = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_tnorm")
{
udata->x_tnorm = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_cfactor")
{
udata->x_cfactor = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_cfactor0")
{
udata->x_cfactor0 = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_max_iter")
{
udata->x_max_iter = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_storage")
{
udata->x_storage = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_print_level")
{
udata->x_print_level = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_access_level")
{
udata->x_access_level = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_rfactor_limit")
{
udata->x_rfactor_limit = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_rfactor_fail")
{
udata->x_rfactor_fail = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_max_refine")
{
udata->x_max_refine = stoi((*argv)[arg_idx++]);
}
else if (arg == "--x_fmg")
{
udata->x_fmg = true;
}
else if (arg == "--x_refine")
{
udata->x_refine = true;
}
else if (arg == "--x_initseq")
{
udata->x_initseq = true;
}
else if (arg == "--x_reltol")
{
udata->x_reltol = true;
}
else if (arg == "--x_init_u0")
{
udata->x_init_u0 = true;
}
// Output settings
else if (arg == "--output")
{
udata->output = stoi((*argv)[arg_idx++]);
}
else if (arg == "--nout")
{
udata->nout = stoi((*argv)[arg_idx++]);
}
else if (arg == "--timing")
{
udata->timing = true;
}
// Help
else if (arg == "--help")
{
if (outproc) InputHelp();
return -1;
}
// Unknown input
else
{
if (outproc)
{
cerr << "ERROR: Invalid input " << arg << endl;
InputHelp();
}
return -1;
}
}
// Recompute total number of nodes
udata->nodes = udata->nx * udata->ny;
// Recompute x and y mesh spacing
udata->dx = (udata->xu) / (udata->nx - 1);
udata->dy = (udata->yu) / (udata->ny - 1);
// If the method order is 1 the XBraid refinement must be disabled
if (udata->order == 1 && !(udata->x_refine))
{
cerr << "ERROR: Method order 1 requires fixed time stepping" << endl;
return -1;
}
// Return success
return 0;
}
// -----------------------------------------------------------------------------
// Output and utility functions
// -----------------------------------------------------------------------------
// Compute the exact solution
static int Solution(realtype t, N_Vector u, UserData *udata)
{
realtype x, y;
realtype cos_sqr_t;
realtype sin_sqr_x, sin_sqr_y;
// Constants for computing solution
cos_sqr_t = cos(PI * t) * cos(PI * t);
// Initialize u to zero (handles boundary conditions)
N_VConst(ZERO, u);
// Iterative over domain interior
sunindextype istart = (udata->HaveNbrW) ? 0 : 1;
sunindextype iend = (udata->HaveNbrE) ? udata->nx_loc : udata->nx_loc - 1;
sunindextype jstart = (udata->HaveNbrS) ? 0 : 1;
sunindextype jend = (udata->HaveNbrN) ? udata->ny_loc : udata->ny_loc - 1;
realtype *uarray = N_VGetArrayPointer(u);
if (check_flag((void *) uarray, "N_VGetArrayPointer", 0)) return -1;
for (sunindextype j = jstart; j < jend; j++)
{
for (sunindextype i = istart; i < iend; i++)
{
x = (udata->is + i) * udata->dx;
y = (udata->js + j) * udata->dy;
sin_sqr_x = sin(PI * x) * sin(PI * x);
sin_sqr_y = sin(PI * y) * sin(PI * y);
uarray[IDX(i,j,udata->nx_loc)] = sin_sqr_x * sin_sqr_y * cos_sqr_t;
}
}
return 0;
}
// Compute the solution error
static int SolutionError(realtype t, N_Vector u, N_Vector e, UserData *udata)
{
// Compute true solution
int flag = Solution(t, e, udata);
if (flag != 0) return -1;
// Compute absolute error
N_VLinearSum(ONE, u, -ONE, e, e);
N_VAbs(e, e);
return 0;
}
// Print command line options
static void InputHelp()
{
cout << endl;
cout << "Command line options:" << endl;
cout << " --mesh <nx> <ny> : mesh points in the x and y directions" << endl;
cout << " --np <npx> <npy> <npt> : number of MPI processes in space and timethe x and y" << endl;
cout << " --domain <xu> <yu> : domain upper bound in the x and y direction" << endl;
cout << " --k <kx> <ky> : diffusion coefficients" << endl;
cout << " --noforcing : disable forcing term" << endl;
cout << " --tf <time> : final time" << endl;
cout << " --rtol <rtol> : relative tolerance" << endl;
cout << " --atol <atol> : absoltue tolerance" << endl;
cout << " --nonlinear : disable linearly implicit flag" << endl;
cout << " --order <ord> : method order" << endl;
cout << " --diagnostics : output diagnostics" << endl;
cout << " --gmres : use GMRES linear solver" << endl;
cout << " --matvec : use hypre matrix-vector product" << endl;
cout << " --lsinfo : output residual history" << endl;
cout << " --liniters <iters> : max number of iterations" << endl;
cout << " --epslin <factor> : linear tolerance factor" << endl;
cout << " --noprec : disable preconditioner" << endl;
cout << " --msbp <steps> : max steps between prec setups" << endl;
cout << " --pfmg_relax <types> : relaxtion type in PFMG" << endl;
cout << " --pfmg_nrelax <iters> : pre/post relaxtion sweeps in PFMG" << endl;
cout << " --x_tol <tol> : XBraid stopping tolerance" << endl;
cout << " --x_nt <nt> : Initial number of time grid values" << endl;
cout << " --x_skip <0,1> : Skip all work on first down cycle" << endl;
cout << " --x_max_levels <max> : Max number of multigrid levels " << endl;
cout << " --x_min_coarse <size> : Minimum coarse grid size" << endl;
cout << " --x_nrelax <num> : Number of relaxation sweeps" << endl;
cout << " --x_nrelax0 <num> : Number of relaxation sweeps on level 0" << endl;
cout << " --x_tnorm <1,2,3> : Choice of temporal norm " << endl;
cout << " --x_cfactor <fac> : Coarsening factor" << endl;
cout << " --x_cfactor0 <fac> : Coarsening factor on level 0" << endl;
cout << " --x_max_iter <max> : Max number of multigrid iterations" << endl;
cout << " --x_storage <lev> : Full storage on levels >= <lev>" << endl;
cout << " --x_print_level <lev> : Set print level" << endl;
cout << " --x_access_level <lev> : Set access level" << endl;
cout << " --x_rfactor_limit <fac> : Max refinement factor" << endl;
cout << " --x_rfactor_fail <fac> : Solver failure refinement factor" << endl;
cout << " --x_max_refine <max> : Max number of grid refinements" << endl;
cout << " --x_fmg : Use FMG (F-cycles)" << endl;
cout << " --x_refine : Enable temporal refinement" << endl;
cout << " --x_initseq : Initialize with sequential solution (debug)" << endl;
cout << " --x_reltol : Use relative stopping tolerance" << endl;
cout << " --x_init_u0 : Initialize all times with u0" << endl;
cout << " --output <level> : output level" << endl;
cout << " --nout <nout> : number of outputs" << endl;
cout << " --timing : print timing data" << endl;
cout << " --help : print this message and exit" << endl;
}
// Print user data
static int PrintUserData(UserData *udata)
{
cout << endl;
cout << "2D Heat PDE test problem:" << endl;
cout << " --------------------------------- " << endl;
cout << " nprocs = " << udata->nprocs_w << endl;
cout << " npx = " << udata->npx << endl;
cout << " npy = " << udata->npy << endl;
cout << " npt = " << udata->npt << endl;
cout << " --------------------------------- " << endl;
cout << " kx = " << udata->kx << endl;
cout << " ky = " << udata->ky << endl;
cout << " forcing = " << udata->forcing << endl;
cout << " tf = " << udata->tf << endl;
cout << " xu = " << udata->xu << endl;
cout << " yu = " << udata->yu << endl;
cout << " nx = " << udata->nx << endl;
cout << " ny = " << udata->ny << endl;
cout << " nxl (proc 0) = " << udata->nx_loc << endl;
cout << " nyl (proc 0) = " << udata->ny_loc << endl;
cout << " dx = " << udata->dx << endl;
cout << " dy = " << udata->dy << endl;
cout << " --------------------------------- " << endl;
cout << " rtol = " << udata->rtol << endl;
cout << " atol = " << udata->atol << endl;
cout << " order = " << udata->order << endl;
cout << " linear = " << udata->linear << endl;
cout << " --------------------------------- " << endl;
if (udata->pcg)
{
cout << " linear solver = PCG" << endl;
}
else
{
cout << " linear solver = GMRES" << endl;
}
cout << " lin iters = " << udata->liniters << endl;
cout << " matvec = " << udata->matvec << endl;
cout << " eps lin = " << udata->epslin << endl;
cout << " prec = " << udata->prec << endl;
cout << " msbp = " << udata->msbp << endl;
cout << " pfmg_relax = " << udata->pfmg_relax << endl;
cout << " pfmg_nrelax = " << udata->pfmg_nrelax << endl;
cout << " --------------------------------- " << endl;
cout << " nt = " << udata->x_nt << endl;
cout << " xtol = " << udata->x_tol << endl;
cout << " refine = " << udata->x_refine << endl;
cout << " rfactor limit = " << udata->x_rfactor_limit << endl;
cout << " rfactor fail = " << udata->x_rfactor_fail << endl;
cout << " init seq = " << udata->x_initseq << endl;
cout << " print level = " << udata->x_print_level << endl;
cout << " access level = " << udata->x_access_level << endl;
cout << " --------------------------------- " << endl;
cout << " output = " << udata->output << endl;
cout << " --------------------------------- " << endl;
cout << endl;
return 0;
}
// Print integrator statistics
static int OutputStats(void *arkode_mem, UserData* udata)
{
int flag;
bool outproc = (udata->myid_w == 0);
// Get integrator and solver stats
long int nst, nst_a, netf, nfe, nfi, nni, ncfn, nli, nlcf, nsetups, nfi_ls, nJv;
flag = ARKStepGetNumSteps(arkode_mem, &nst);
if (check_flag(&flag, "ARKStepGetNumSteps", 1)) return -1;
flag = ARKStepGetNumStepAttempts(arkode_mem, &nst_a);
if (check_flag(&flag, "ARKStepGetNumStepAttempts", 1)) return -1;
flag = ARKStepGetNumErrTestFails(arkode_mem, &netf);
if (check_flag(&flag, "ARKStepGetNumErrTestFails", 1)) return -1;
flag = ARKStepGetNumRhsEvals(arkode_mem, &nfe, &nfi);
if (check_flag(&flag, "ARKStepGetNumRhsEvals", 1)) return -1;
flag = ARKStepGetNumNonlinSolvIters(arkode_mem, &nni);
if (check_flag(&flag, "ARKStepGetNumNonlinSolvIters", 1)) return -1;
flag = ARKStepGetNumNonlinSolvConvFails(arkode_mem, &ncfn);
if (check_flag(&flag, "ARKStepGetNumNonlinSolvConvFails", 1)) return -1;
flag = ARKStepGetNumLinIters(arkode_mem, &nli);
if (check_flag(&flag, "ARKStepGetNumLinIters", 1)) return -1;
flag = ARKStepGetNumLinConvFails(arkode_mem, &nlcf);
if (check_flag(&flag, "ARKStepGetNumLinConvFails", 1)) return -1;
flag = ARKStepGetNumLinSolvSetups(arkode_mem, &nsetups);
if (check_flag(&flag, "ARKStepGetNumLinSolvSetups", 1)) return -1;
flag = ARKStepGetNumLinRhsEvals(arkode_mem, &nfi_ls);
if (check_flag(&flag, "ARKStepGetNumLinRhsEvals", 1)) return -1;
flag = ARKStepGetNumJtimesEvals(arkode_mem, &nJv);
if (check_flag(&flag, "ARKStepGetNumJtimesEvals", 1)) return -1;
// Reduce stats across time
MPI_Allreduce(MPI_IN_PLACE, &nst, 1, MPI_LONG, MPI_MAX, udata->comm_w);
MPI_Allreduce(MPI_IN_PLACE, &nst_a, 1, MPI_LONG, MPI_MAX, udata->comm_w);
MPI_Allreduce(MPI_IN_PLACE, &netf, 1, MPI_LONG, MPI_MAX, udata->comm_w);
MPI_Allreduce(MPI_IN_PLACE, &nfi, 1, MPI_LONG, MPI_MAX, udata->comm_w);
MPI_Allreduce(MPI_IN_PLACE, &nni, 1, MPI_LONG, MPI_MAX, udata->comm_w);
MPI_Allreduce(MPI_IN_PLACE, &ncfn, 1, MPI_LONG, MPI_MAX, udata->comm_w);
MPI_Allreduce(MPI_IN_PLACE, &nli, 1, MPI_LONG, MPI_MAX, udata->comm_w);
MPI_Allreduce(MPI_IN_PLACE, &nlcf, 1, MPI_LONG, MPI_MAX, udata->comm_w);
MPI_Allreduce(MPI_IN_PLACE, &nsetups, 1, MPI_LONG, MPI_MAX, udata->comm_w);
MPI_Allreduce(MPI_IN_PLACE, &nfi_ls, 1, MPI_LONG, MPI_MAX, udata->comm_w);
MPI_Allreduce(MPI_IN_PLACE, &nJv, 1, MPI_LONG, MPI_MAX, udata->comm_w);
if (outproc)
{
cout << fixed;
cout << setprecision(6);
cout << " Steps = " << nst << endl;
cout << " Step attempts = " << nst_a << endl;
cout << " Error test fails = " << netf << endl;
cout << " RHS evals = " << nfi << endl;
cout << " NLS iters = " << nni << endl;
cout << " NLS fails = " << ncfn << endl;
cout << " LS iters = " << nli << endl;
cout << " LS fails = " << nlcf << endl;
cout << " LS setups = " << nsetups << endl;
cout << " LS RHS evals = " << nfi_ls << endl;
cout << " Jv products = " << nJv << endl;
cout << endl;
// Compute average nls iters per step attempt and ls iters per nls iter
realtype avgnli = (realtype) nni / (realtype) nst_a;
realtype avgli = (realtype) nli / (realtype) nni;
cout << " Avg NLS iters per step attempt = " << avgnli << endl;
cout << " Avg LS iters per NLS iter = " << avgli << endl;
cout << endl;
}
// Get preconditioner stats
if (udata->prec)
{
long int npe, nps;
flag = ARKStepGetNumPrecEvals(arkode_mem, &npe);
if (check_flag(&flag, "ARKStepGetNumPrecEvals", 1)) return -1;
flag = ARKStepGetNumPrecSolves(arkode_mem, &nps);
if (check_flag(&flag, "ARKStepGetNumPrecSolves", 1)) return -1;
MPI_Allreduce(MPI_IN_PLACE, &npe, 1, MPI_LONG, MPI_MAX, udata->comm_w);
MPI_Allreduce(MPI_IN_PLACE, &nps, 1, MPI_LONG, MPI_MAX, udata->comm_w);
MPI_Allreduce(MPI_IN_PLACE, &(udata->pfmg_its), 1, MPI_INT, MPI_MAX,
udata->comm_w);
if (outproc)
{
cout << " Preconditioner setups = " << npe << endl;
cout << " Preconditioner solves = " << nps << endl;
cout << " PFMG iters = " << udata->pfmg_its << endl;
cout << endl;
}
}
return 0;
}
static int OutputTiming(UserData *udata)
{
bool outproc = (udata->myid_w == 0);
if (outproc)
{
cout << scientific;
cout << setprecision(6);
}
double maxtime = 0.0;
MPI_Reduce(&(udata->evolvetime), &maxtime, 1, MPI_DOUBLE, MPI_MAX, 0,
udata->comm_w);
if (outproc)
{
cout << " Evolve time = " << maxtime << " sec" << endl;
}
MPI_Reduce(&(udata->rhstime), &maxtime, 1, MPI_DOUBLE, MPI_MAX, 0,
udata->comm_w);
if (outproc)
{
cout << " RHS time = " << maxtime << " sec" << endl;
}
MPI_Reduce(&(udata->exchangetime), &maxtime, 1, MPI_DOUBLE, MPI_MAX, 0,
udata->comm_w);
if (outproc)
{
cout << " Exchange time = " << maxtime << " sec" << endl;
cout << endl;
}
if (udata->matvec)
{
MPI_Reduce(&(udata->jvtime), &maxtime, 1, MPI_DOUBLE, MPI_MAX, 0,
udata->comm_w);
if (outproc)
{
cout << " Jv time = " << maxtime << " sec" << endl;
}
}
if (udata->prec)
{
MPI_Reduce(&(udata->matfilltime), &maxtime, 1, MPI_DOUBLE, MPI_MAX, 0,
udata->comm_w);
if (outproc)
{
cout << " MatFill time = " << maxtime << " sec" << endl;
}
MPI_Reduce(&(udata->psetuptime), &maxtime, 1, MPI_DOUBLE, MPI_MAX, 0,
udata->comm_w);
if (outproc)
{
cout << " PSetup time = " << maxtime << " sec" << endl;
}
MPI_Reduce(&(udata->psolvetime), &maxtime, 1, MPI_DOUBLE, MPI_MAX, 0,
udata->comm_w);
if (outproc)
{
cout << " PSolve time = " << maxtime << " sec" << endl;
cout << endl;
}
}
MPI_Reduce(&(udata->accesstime), &maxtime, 1, MPI_DOUBLE, MPI_MAX, 0,
udata->comm_w);
if (outproc)
{
cout << " Access time = " << maxtime << " sec" << endl;
cout << endl;
}
return 0;
}
// Check function return value
static int check_flag(void *flagvalue, const string funcname, int opt)
{
// Check if the function returned a NULL pointer
if (opt == 0)
{
if (flagvalue == NULL)
{
cerr << endl << "ERROR: " << funcname << " returned NULL pointer" << endl
<< endl;
return 1;
}
}
// Check the function return flag value
else if (opt == 1 || opt == 2)
{
int errflag = *((int *) flagvalue);
if ((opt == 1 && errflag < 0) || (opt == 2 && errflag != 0))
{
cerr << endl << "ERROR: " << funcname << " returned with flag = "
<< errflag << endl << endl;
return 1;
}
}
else
{
cerr << endl << "ERROR: check_flag called with an invalid option value"
<< endl;
return 1;
}
return 0;
}
//---- end of file ----
|