/usr/lib/python2.7/dist-packages/dolfin/cpp/la.py is in python-dolfin 2016.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 | # This file was automatically generated by SWIG (http://www.swig.org).
# Version 3.0.10
#
# Do not make changes to this file unless you know what you are doing--modify
# the SWIG interface file instead.
from sys import version_info as _swig_python_version_info
if _swig_python_version_info >= (3, 0, 0):
new_instancemethod = lambda func, inst, cls: _la.SWIG_PyInstanceMethod_New(func)
else:
from new import instancemethod as new_instancemethod
if _swig_python_version_info >= (2, 7, 0):
def swig_import_helper():
import importlib
pkg = __name__.rpartition('.')[0]
mname = '.'.join((pkg, '_la')).lstrip('.')
try:
return importlib.import_module(mname)
except ImportError:
return importlib.import_module('_la')
_la = swig_import_helper()
del swig_import_helper
elif _swig_python_version_info >= (2, 6, 0):
def swig_import_helper():
from os.path import dirname
import imp
fp = None
try:
fp, pathname, description = imp.find_module('_la', [dirname(__file__)])
except ImportError:
import _la
return _la
if fp is not None:
try:
_mod = imp.load_module('_la', fp, pathname, description)
finally:
fp.close()
return _mod
_la = swig_import_helper()
del swig_import_helper
else:
import _la
del _swig_python_version_info
try:
_swig_property = property
except NameError:
pass # Python < 2.2 doesn't have 'property'.
try:
import builtins as __builtin__
except ImportError:
import __builtin__
def _swig_setattr_nondynamic(self, class_type, name, value, static=1):
if (name == "thisown"):
return self.this.own(value)
if (name == "this"):
if type(value).__name__ == 'SwigPyObject':
self.__dict__[name] = value
return
method = class_type.__swig_setmethods__.get(name, None)
if method:
return method(self, value)
if (not static):
object.__setattr__(self, name, value)
else:
raise AttributeError("You cannot add attributes to %s" % self)
def _swig_setattr(self, class_type, name, value):
return _swig_setattr_nondynamic(self, class_type, name, value, 0)
def _swig_getattr(self, class_type, name):
if (name == "thisown"):
return self.this.own()
method = class_type.__swig_getmethods__.get(name, None)
if method:
return method(self)
raise AttributeError("'%s' object has no attribute '%s'" % (class_type.__name__, name))
def _swig_repr(self):
try:
strthis = "proxy of " + self.this.__repr__()
except __builtin__.Exception:
strthis = ""
return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
def _swig_setattr_nondynamic_method(set):
def set_attr(self, name, value):
if (name == "thisown"):
return self.this.own(value)
if hasattr(self, name) or (name == "this"):
set(self, name, value)
else:
raise AttributeError("You cannot add attributes to %s" % self)
return set_attr
try:
import weakref
weakref_proxy = weakref.proxy
except __builtin__.Exception:
weakref_proxy = lambda x: x
SHARED_PTR_DISOWN = _la.SHARED_PTR_DISOWN
def _attach_base_to_numpy_array(obj, owner):
return _la._attach_base_to_numpy_array(obj, owner)
_attach_base_to_numpy_array = _la._attach_base_to_numpy_array
def dolfin_swigversion():
return _la.dolfin_swigversion()
dolfin_swigversion = _la.dolfin_swigversion
def dolfin_pythonversion():
return _la.dolfin_pythonversion()
dolfin_pythonversion = _la.dolfin_pythonversion
tmp = hex(dolfin_swigversion())
__swigversion__ = "%d.%d.%d"%(tuple(map(int, [tmp[-5], tmp[-3], tmp[-2:]])))
tmp = hex(dolfin_pythonversion())
__pythonversion__ = "%d.%d.%d"%(tuple(map(lambda x: int(x,16), [tmp[2], tmp[3:5], tmp[5:7]])))
del tmp, dolfin_pythonversion, dolfin_swigversion
def has_petsc4py():
return _la.has_petsc4py()
has_petsc4py = _la.has_petsc4py
def has_slepc4py():
return _la.has_slepc4py()
has_slepc4py = _la.has_slepc4py
UFC_VERSION_MAJOR = _la.UFC_VERSION_MAJOR
UFC_VERSION_MINOR = _la.UFC_VERSION_MINOR
UFC_VERSION_MAINTENANCE = _la.UFC_VERSION_MAINTENANCE
UFC_VERSION_RELEASE = _la.UFC_VERSION_RELEASE
ufc_shape_interval = _la.ufc_shape_interval
ufc_shape_triangle = _la.ufc_shape_triangle
ufc_shape_quadrilateral = _la.ufc_shape_quadrilateral
ufc_shape_tetrahedron = _la.ufc_shape_tetrahedron
ufc_shape_hexahedron = _la.ufc_shape_hexahedron
class ufc_cell(object):
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined")
__repr__ = _swig_repr
__swig_destroy__ = _la.delete_ufc_cell
cell_shape = _swig_property(_la.ufc_cell_cell_shape_get, _la.ufc_cell_cell_shape_set)
topological_dimension = _swig_property(_la.ufc_cell_topological_dimension_get, _la.ufc_cell_topological_dimension_set)
geometric_dimension = _swig_property(_la.ufc_cell_geometric_dimension_get, _la.ufc_cell_geometric_dimension_set)
index = _swig_property(_la.ufc_cell_index_get, _la.ufc_cell_index_set)
local_facet = _swig_property(_la.ufc_cell_local_facet_get, _la.ufc_cell_local_facet_set)
mesh_identifier = _swig_property(_la.ufc_cell_mesh_identifier_get, _la.ufc_cell_mesh_identifier_set)
ufc_cell_swigregister = _la.ufc_cell_swigregister
ufc_cell_swigregister(ufc_cell)
cvar = _la.cvar
UFC_VERSION = cvar.UFC_VERSION
class ufc_function(object):
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined - class is abstract")
__repr__ = _swig_repr
__swig_destroy__ = _la.delete_ufc_function
ufc_function_swigregister = _la.ufc_function_swigregister
ufc_function_swigregister(ufc_function)
class ufc_finite_element(object):
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined - class is abstract")
__repr__ = _swig_repr
__swig_destroy__ = _la.delete_ufc_finite_element
ufc_finite_element_swigregister = _la.ufc_finite_element_swigregister
ufc_finite_element_swigregister(ufc_finite_element)
class ufc_dofmap(object):
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined - class is abstract")
__repr__ = _swig_repr
__swig_destroy__ = _la.delete_ufc_dofmap
ufc_dofmap_swigregister = _la.ufc_dofmap_swigregister
ufc_dofmap_swigregister(ufc_dofmap)
class ufc_coordinate_mapping(object):
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined - class is abstract")
__repr__ = _swig_repr
__swig_destroy__ = _la.delete_ufc_coordinate_mapping
ufc_coordinate_mapping_swigregister = _la.ufc_coordinate_mapping_swigregister
ufc_coordinate_mapping_swigregister(ufc_coordinate_mapping)
class ufc_form(object):
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined - class is abstract")
__repr__ = _swig_repr
__swig_destroy__ = _la.delete_ufc_form
ufc_form_swigregister = _la.ufc_form_swigregister
ufc_form_swigregister(ufc_form)
def make_ufc_finite_element(*args):
return _la.make_ufc_finite_element(*args)
make_ufc_finite_element = _la.make_ufc_finite_element
def make_ufc_dofmap(*args):
return _la.make_ufc_dofmap(*args)
make_ufc_dofmap = _la.make_ufc_dofmap
def make_ufc_coordinate_mapping(*args):
return _la.make_ufc_coordinate_mapping(*args)
make_ufc_coordinate_mapping = _la.make_ufc_coordinate_mapping
def make_ufc_form(*args):
return _la.make_ufc_form(*args)
make_ufc_form = _la.make_ufc_form
import common
class LinearAlgebraObject(common.Variable):
"""
This is a common base class for all DOLFIN linear algebra
objects. In particular, it provides casting mechanisms between
different types.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined - class is abstract")
__repr__ = _swig_repr
def shared_instance(self, *args):
"""
**Overloaded versions**
* shared_instance\ ()
Return concrete shared ptr instance / unwrap (const version)
* shared_instance\ ()
Return concrete shared ptr instance / unwrap (non-const version)
"""
return _la.LinearAlgebraObject_shared_instance(self, *args)
def mpi_comm(self):
"""
Return MPI communicator
"""
return _la.LinearAlgebraObject_mpi_comm(self)
__swig_destroy__ = _la.delete_LinearAlgebraObject
LinearAlgebraObject.shared_instance = new_instancemethod(_la.LinearAlgebraObject_shared_instance, None, LinearAlgebraObject)
LinearAlgebraObject.mpi_comm = new_instancemethod(_la.LinearAlgebraObject_mpi_comm, None, LinearAlgebraObject)
LinearAlgebraObject_swigregister = _la.LinearAlgebraObject_swigregister
LinearAlgebraObject_swigregister(LinearAlgebraObject)
class GenericLinearOperator(LinearAlgebraObject):
"""
This class defines a common interface for linear operators,
including actual matrices (class :py:class:`GenericMatrix`) and linear
operators only defined in terms of their action on vectors.
This class is used internally by DOLFIN to define a class
hierarchy of backend independent linear operators and solvers.
Users should not interface to this class directly but instead
use the :py:class:`LinearOperator` class.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined - class is abstract")
__repr__ = _swig_repr
__swig_destroy__ = _la.delete_GenericLinearOperator
def size(self, dim):
"""
Return size of given dimension
"""
return _la.GenericLinearOperator_size(self, dim)
def mult(self, x, y):
"""
Compute matrix-vector product y = Ax
"""
return _la.GenericLinearOperator_mult(self, x, y)
GenericLinearOperator.size = new_instancemethod(_la.GenericLinearOperator_size, None, GenericLinearOperator)
GenericLinearOperator.mult = new_instancemethod(_la.GenericLinearOperator_mult, None, GenericLinearOperator)
GenericLinearOperator_swigregister = _la.GenericLinearOperator_swigregister
GenericLinearOperator_swigregister(GenericLinearOperator)
class GenericTensor(LinearAlgebraObject):
"""
This class defines a common interface for arbitrary rank tensors.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined - class is abstract")
__repr__ = _swig_repr
__swig_destroy__ = _la.delete_GenericTensor
def init(self, tensor_layout):
"""
Initialize zero tensor using tensor layout
"""
return _la.GenericTensor_init(self, tensor_layout)
def empty(self):
"""
Return true if empty
"""
return _la.GenericTensor_empty(self)
def rank(self):
"""
Return tensor rank (number of dimensions)
"""
return _la.GenericTensor_rank(self)
def size(self, dim):
"""
Return size of given dimension
"""
return _la.GenericTensor_size(self, dim)
def local_range(self, dim):
"""
Return local ownership range
"""
return _la.GenericTensor_local_range(self, dim)
def set_local(self, block, num_rows, rows):
"""
Set block of values using local indices
"""
return _la.GenericTensor_set_local(self, block, num_rows, rows)
def add(self, block, rows):
"""
**Overloaded versions**
* add\ (block, rows)
Add block of values using global indices
* add\ (block, num_rows, rows)
Add block of values using global indices
"""
return _la.GenericTensor_add(self, block, rows)
def add_local(self, *args):
"""
**Overloaded versions**
* add_local\ (block, rows)
Add block of values using local indices
* add_local\ (block, num_rows, rows)
Add block of values using local indices
"""
return _la.GenericTensor_add_local(self, *args)
def zero(self):
"""
Set all entries to zero and keep any sparse structure
"""
return _la.GenericTensor_zero(self)
def apply(self, mode):
"""
Finalize assembly of tensor
"""
return _la.GenericTensor_apply(self, mode)
def factory(self):
"""
Return linear algebra backend factory
"""
return _la.GenericTensor_factory(self)
GenericTensor.init = new_instancemethod(_la.GenericTensor_init, None, GenericTensor)
GenericTensor.empty = new_instancemethod(_la.GenericTensor_empty, None, GenericTensor)
GenericTensor.rank = new_instancemethod(_la.GenericTensor_rank, None, GenericTensor)
GenericTensor.size = new_instancemethod(_la.GenericTensor_size, None, GenericTensor)
GenericTensor.local_range = new_instancemethod(_la.GenericTensor_local_range, None, GenericTensor)
GenericTensor.set_local = new_instancemethod(_la.GenericTensor_set_local, None, GenericTensor)
GenericTensor.add = new_instancemethod(_la.GenericTensor_add, None, GenericTensor)
GenericTensor.add_local = new_instancemethod(_la.GenericTensor_add_local, None, GenericTensor)
GenericTensor.zero = new_instancemethod(_la.GenericTensor_zero, None, GenericTensor)
GenericTensor.apply = new_instancemethod(_la.GenericTensor_apply, None, GenericTensor)
GenericTensor.factory = new_instancemethod(_la.GenericTensor_factory, None, GenericTensor)
GenericTensor_swigregister = _la.GenericTensor_swigregister
GenericTensor_swigregister(GenericTensor)
class GenericMatrix(GenericTensor, GenericLinearOperator):
"""
This class defines a common interface for matrices.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined - class is abstract")
__repr__ = _swig_repr
__swig_destroy__ = _la.delete_GenericMatrix
def nnz(self):
"""
Return number of non-zero entries in matrix (collective)
"""
return _la.GenericMatrix_nnz(self)
def copy(self):
"""
Return copy of matrix
"""
return _la.GenericMatrix_copy(self)
def init_vector(self, z, dim):
"""
Initialize vector z to be compatible with the matrix-vector
product y = Ax. In the parallel case, both size and layout are
important.
*Arguments*
dim (int)
The dimension (axis): dim = 0 --> z = y, dim = 1 --> z = x
"""
return _la.GenericMatrix_init_vector(self, z, dim)
def get(self, block, m, n):
"""
**Overloaded versions**
* get\ (block, num_rows, rows)
Get block of values
* get\ (block, m, rows, n, cols)
Get block of values
"""
return _la.GenericMatrix_get(self, block, m, n)
def set(self, block, m, n):
"""
**Overloaded versions**
* set\ (block, num_rows, rows)
Set block of values using global indices
* set\ (block, m, rows, n, cols)
Set block of values using global indices
"""
return _la.GenericMatrix_set(self, block, m, n)
def set_local(self, *args):
"""
**Overloaded versions**
* set_local\ (block, num_rows, rows)
Set block of values using local indices
* set_local\ (block, m, rows, n, cols)
Set block of values using local indices
"""
return _la.GenericMatrix_set_local(self, *args)
def add(self, *args):
"""
**Overloaded versions**
* add\ (block, num_rows, rows)
Add block of values using global indices
* add\ (block, rows)
Add block of values using global indices
* add\ (block, m, rows, n, cols)
Add block of values using global indices
"""
return _la.GenericMatrix_add(self, *args)
def add_local(self, *args):
"""
**Overloaded versions**
* add_local\ (block, num_rows, rows)
Add block of values using local indices
* add_local\ (block, rows)
Add block of values using local indices
* add_local\ (block, m, rows, n, cols)
Add block of values using local indices
"""
return _la.GenericMatrix_add_local(self, *args)
def axpy(self, a, A, same_nonzero_pattern):
"""
Add multiple of given matrix (AXPY operation)
"""
return _la.GenericMatrix_axpy(self, a, A, same_nonzero_pattern)
def norm(self, norm_type):
"""
Return norm of matrix
"""
return _la.GenericMatrix_norm(self, norm_type)
def getrow(self, row):
"""
Get non-zero values of given row (global index) on local process
"""
return _la.GenericMatrix_getrow(self, row)
def setrow(self, row, columns, values):
"""
Set values for given row (global index) on local process
"""
return _la.GenericMatrix_setrow(self, row, columns, values)
def zero(self, *args):
"""
**Overloaded versions**
* zero\ ()
Set all entries to zero and keep any sparse structure
* zero\ (m, rows)
Set given rows (global row indices) to zero
"""
return _la.GenericMatrix_zero(self, *args)
def zero_local(self, m):
"""
Set given rows (local row indices) to zero
"""
return _la.GenericMatrix_zero_local(self, m)
def ident(self, m):
"""
Set given rows (global row indices) to identity matrix
"""
return _la.GenericMatrix_ident(self, m)
def ident_local(self, m):
"""
Set given rows (local row indices) to identity matrix
"""
return _la.GenericMatrix_ident_local(self, m)
def transpmult(self, x, y):
"""
Matrix-vector product, y = A^T x. The y vector must either be
zero-sized or have correct size and parallel layout.
"""
return _la.GenericMatrix_transpmult(self, x, y)
def get_diagonal(self, x):
"""
Get diagonal of a matrix
"""
return _la.GenericMatrix_get_diagonal(self, x)
def set_diagonal(self, x):
"""
Set diagonal of a matrix
"""
return _la.GenericMatrix_set_diagonal(self, x)
def is_symmetric(self, tol):
"""
Test if matrix is symmetric
"""
return _la.GenericMatrix_is_symmetric(self, tol)
def assign(self, x):
"""
Assignment operator
"""
return _la.GenericMatrix_assign(self, x)
def ident_zeros(self):
"""
Insert one on the diagonal for all zero rows
"""
return _la.GenericMatrix_ident_zeros(self)
def _scale(self, a):
"""Missing docstring"""
return _la.GenericMatrix__scale(self, a)
def __is_compatible(self,other):
"Returns True if self, and other are compatible Vectors"
if not isinstance(other,GenericMatrix):
return False
self_type = get_tensor_type(self)
return self_type == get_tensor_type(other)
def array(self):
"Return a numpy array representation of Matrix"
from numpy import zeros
m_range = self.local_range(0);
A = zeros((m_range[1] - m_range[0], self.size(1)))
for i, row in enumerate(range(*m_range)):
column, values = self.getrow(row)
A[i, column] = values
return A
# FIXME: Getting matrix entries need to be carefully examined, especially
# for parallel objects.
"""
def __getitem__(self,indices):
from numpy import ndarray
from types import SliceType
if not (isinstance(indices, tuple) and len(indices) == 2):
raise TypeError("expected two indices")
if not all(isinstance(ind, (int, SliceType, list, ndarray)) for ind in indices):
raise TypeError("an int, slice, list or numpy array as indices")
if isinstance(indices[0], int):
if isinstance(indices[1], int):
return _get_matrix_single_item(self,indices[0],indices[1])
return as_backend_type(_get_matrix_sub_vector(self,indices[0], indices[1], True))
elif isinstance(indices[1],int):
return as_backend_type(_get_matrix_sub_vector(self,indices[1], indices[0], False))
else:
same_indices = id(indices[0]) == id(indices[1])
if not same_indices and ( type(indices[0]) == type(indices[1]) ):
if isinstance(indices[0],(list,SliceType)):
same_indices = indices[0] == indices[1]
else:
same_indices = (indices[0] == indices[1]).all()
if same_indices:
return as_backend_type(_get_matrix_sub_matrix(self, indices[0], None))
else:
return as_backend_type(_get_matrix_sub_matrix(self, indices[0], indices[1]))
def __setitem__(self, indices, values):
from numpy import ndarray, isscalar
from types import SliceType
if not (isinstance(indices, tuple) and len(indices) == 2):
raise TypeError("expected two indices")
if not all(isinstance(ind, (int, SliceType, list, ndarray)) for ind in indices):
raise TypeError("an int, slice, list or numpy array as indices")
if isinstance(indices[0], int):
if isinstance(indices[1], int):
if not isscalar(values):
raise TypeError("expected scalar for single value assigment")
_set_matrix_single_item(self, indices[0], indices[1], values)
else:
raise NotImplementedError
if isinstance(values,GenericVector):
_set_matrix_items_vector(self, indices[0], indices[1], values, True)
elif isinstance(values,ndarray):
_set_matrix_items_array_of_float(self, indices[0], indices[1], values, True)
else:
raise TypeError("expected a GenericVector or numpy array of float")
elif isinstance(indices[1], int):
raise NotImplementedError
if isinstance(values, GenericVector):
_set_matrix_items_vector(self, indices[1], indices[0], values, False)
elif isinstance(values, ndarray):
_set_matrix_items_array_of_float(self, indices[1], indices[0], values, False)
else:
raise TypeError("expected a GenericVector or numpy array of float")
else:
raise NotImplementedError
same_indices = id(indices[0]) == id(indices[1])
if not same_indices and ( type(indices[0]) == type(indices[1]) ):
if isinstance(indices[0], (list, SliceType)):
same_indices = indices[0] == indices[1]
else:
same_indices = (indices[0] == indices[1]).all()
if same_indices:
if isinstance(values,GenericMatrix):
_set_matrix_items_matrix(self, indices[0], None, values)
elif isinstance(values, ndarray) and len(values.shape)==2:
_set_matrix_items_array_of_float(self, indices[0], None, values)
else:
raise TypeError("expected a GenericMatrix or 2D numpy array of float")
else:
if isinstance(values,GenericMatrix):
_set_matrix_items_matrix(self, indices[0], indices[1], values)
elif isinstance(values,ndarray) and len(values.shape) == 2:
_set_matrix_items_array_of_float(self, indices[0], indices[1], values)
else:
raise TypeError("expected a GenericMatrix or 2D numpy array of float")
"""
def __add__(self,other):
"""x.__add__(y) <==> x+y"""
if self.__is_compatible(other):
ret = self.copy()
ret.axpy(1.0, other, False)
return ret
return NotImplemented
def __sub__(self,other):
"""x.__sub__(y) <==> x-y"""
if self.__is_compatible(other):
ret = self.copy()
ret.axpy(-1.0, other, False)
return ret
return NotImplemented
def __mul__(self,other):
"""x.__mul__(y) <==> x*y"""
from numpy import ndarray, isscalar
if isscalar(other):
ret = self.copy()
ret._scale(other)
return ret
elif isinstance(other,GenericVector):
matrix_type = get_tensor_type(self)
vector_type = get_tensor_type(other)
if vector_type not in _matrix_vector_mul_map[matrix_type]:
raise TypeError("Provide a Vector which can be as_backend_typeed to ''"%vector_type.__name__)
if type(other) == Vector:
ret = Vector()
else:
ret = vector_type()
self.mult(other, ret)
return ret
elif isinstance(other, ndarray):
if len(other.shape) != 1:
raise ValueError("Provide an 1D NumPy array")
vec_size = other.shape[0]
if vec_size != self.size(1):
raise ValueError("Provide a NumPy array with length %d"%self.size(1))
vec_type = _matrix_vector_mul_map[get_tensor_type(self)][0]
vec = vec_type()
vec.init(self.mpi_comm(), vec_size)
vec.set_local(other)
vec.apply("insert")
result_vec = vec.copy()
self.mult(vec, result_vec)
#ret = other.copy()
#result_vec.get_local(ret)
#return ret
return result_vec.get_local()
return NotImplemented
def __div__(self,other):
"""x.__div__(y) <==> x/y"""
from numpy import isscalar
if isscalar(other):
ret = self.copy()
ret._scale(1.0/other)
return ret
return NotImplemented
def __truediv__(self,other):
"""x.__div__(y) <==> x/y"""
from numpy import isscalar
if isscalar(other):
ret = self.copy()
ret._scale(1.0/other)
return ret
return NotImplemented
def __radd__(self,other):
"""x.__radd__(y) <==> y+x"""
return self.__add__(other)
def __rsub__(self, other):
"""x.__rsub__(y) <==> y-x"""
ret = self.__sub__(other)
ret.__imul__(-1.0)
return ret
def __rmul__(self,other):
"""x.__rmul__(y) <==> y*x"""
from numpy import isscalar
if isscalar(other):
ret = self.copy()
ret._scale(other)
return ret
return NotImplemented
def __rdiv__(self,other):
"""x.__rdiv__(y) <==> y/x"""
return NotImplemented
def __iadd__(self,other):
"""x.__iadd__(y) <==> x+y"""
if self.__is_compatible(other):
self.axpy(1.0, other, False)
return self
return NotImplemented
def __isub__(self,other):
"""x.__isub__(y) <==> x-y"""
if self.__is_compatible(other):
self.axpy(-1.0, other, False)
return self
return NotImplemented
def __imul__(self,other):
"""x.__imul__(y) <==> x*y"""
from numpy import isscalar
if isscalar(other):
self._scale(other)
return self
return NotImplemented
def __idiv__(self,other):
"""x.__idiv__(y) <==> x/y"""
from numpy import isscalar
if isscalar(other):
self._scale(1.0 / other)
return self
return NotImplemented
def __itruediv__(self,other):
"""x.__idiv__(y) <==> x/y"""
from numpy import isscalar
if isscalar(other):
self._scale(1.0 / other)
return self
return NotImplemented
GenericMatrix.nnz = new_instancemethod(_la.GenericMatrix_nnz, None, GenericMatrix)
GenericMatrix.copy = new_instancemethod(_la.GenericMatrix_copy, None, GenericMatrix)
GenericMatrix.init_vector = new_instancemethod(_la.GenericMatrix_init_vector, None, GenericMatrix)
GenericMatrix.get = new_instancemethod(_la.GenericMatrix_get, None, GenericMatrix)
GenericMatrix.set = new_instancemethod(_la.GenericMatrix_set, None, GenericMatrix)
GenericMatrix.set_local = new_instancemethod(_la.GenericMatrix_set_local, None, GenericMatrix)
GenericMatrix.add = new_instancemethod(_la.GenericMatrix_add, None, GenericMatrix)
GenericMatrix.add_local = new_instancemethod(_la.GenericMatrix_add_local, None, GenericMatrix)
GenericMatrix.axpy = new_instancemethod(_la.GenericMatrix_axpy, None, GenericMatrix)
GenericMatrix.norm = new_instancemethod(_la.GenericMatrix_norm, None, GenericMatrix)
GenericMatrix.getrow = new_instancemethod(_la.GenericMatrix_getrow, None, GenericMatrix)
GenericMatrix.setrow = new_instancemethod(_la.GenericMatrix_setrow, None, GenericMatrix)
GenericMatrix.zero = new_instancemethod(_la.GenericMatrix_zero, None, GenericMatrix)
GenericMatrix.zero_local = new_instancemethod(_la.GenericMatrix_zero_local, None, GenericMatrix)
GenericMatrix.ident = new_instancemethod(_la.GenericMatrix_ident, None, GenericMatrix)
GenericMatrix.ident_local = new_instancemethod(_la.GenericMatrix_ident_local, None, GenericMatrix)
GenericMatrix.transpmult = new_instancemethod(_la.GenericMatrix_transpmult, None, GenericMatrix)
GenericMatrix.get_diagonal = new_instancemethod(_la.GenericMatrix_get_diagonal, None, GenericMatrix)
GenericMatrix.set_diagonal = new_instancemethod(_la.GenericMatrix_set_diagonal, None, GenericMatrix)
GenericMatrix.is_symmetric = new_instancemethod(_la.GenericMatrix_is_symmetric, None, GenericMatrix)
GenericMatrix.assign = new_instancemethod(_la.GenericMatrix_assign, None, GenericMatrix)
GenericMatrix.ident_zeros = new_instancemethod(_la.GenericMatrix_ident_zeros, None, GenericMatrix)
GenericMatrix._scale = new_instancemethod(_la.GenericMatrix__scale, None, GenericMatrix)
GenericMatrix_swigregister = _la.GenericMatrix_swigregister
GenericMatrix_swigregister(GenericMatrix)
class GenericVector(GenericTensor):
"""
This class defines a common interface for vectors.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined - class is abstract")
__repr__ = _swig_repr
__swig_destroy__ = _la.delete_GenericVector
def copy(self):
"""
Return copy of vector
"""
return _la.GenericVector_copy(self)
def init(self, *args):
"""
**Overloaded versions**
* init\ (tensor_layout)
Initialize zero tensor using sparsity pattern
FIXME: This needs to be implemented on backend side! Remove it!
* init\ (comm, N)
Initialize vector to global size N
* init\ (comm, range)
Initialize vector with given local ownership range
* init\ (comm, range, local_to_global_map, ghost_indices)
Initialise vector with given ownership range and with ghost
values
FIXME: Reimplement using init(const TensorLayout&) and deprecate
"""
return _la.GenericVector_init(self, *args)
def size(self, *args):
"""
**Overloaded versions**
* size\ (dim)
Return size of given dimension
* size\ ()
Return global size of vector
"""
return _la.GenericVector_size(self, *args)
def local_size(self):
"""
Return local size of vector
"""
return _la.GenericVector_local_size(self)
def local_range(self, *args):
"""
**Overloaded versions**
* local_range\ (dim)
Return local ownership range
* local_range\ ()
Return local ownership range of a vector
"""
return _la.GenericVector_local_range(self, *args)
def owns_index(self, i):
"""
Determine whether global vector index is owned by this process
"""
return _la.GenericVector_owns_index(self, i)
def add(self, *args):
"""
**Overloaded versions**
* add\ (block, num_rows, rows)
Add block of values using global indices
* add\ (block, rows)
Add block of values using global indices
* add\ (block, m, rows)
Add block of values using global indices
"""
return _la.GenericVector_add(self, *args)
def get_local(self, *args):
"""
**Overloaded versions**
* get_local\ (block, num_rows, rows)
Get block of values using local indices
* get_local\ (block, m, rows)
Get block of values using local indices (values must all live
on the local process, ghost are accessible)
* get_local\ (values)
Get all values on local process
"""
return _la.GenericVector_get_local(self, *args)
def set_local(self, *args):
"""
**Overloaded versions**
* set_local\ (block, num_rows, rows)
Set block of values using local indices
* set_local\ (block, m, rows)
Set block of values using local indices
* set_local\ (values)
Set all values on local process
"""
return _la.GenericVector_set_local(self, *args)
def add_local(self, *args):
"""
**Overloaded versions**
* add_local\ (block, num_rows, rows)
Add block of values using local indices
* add_local\ (block, rows)
Add block of values using local indices
* add_local\ (block, m, rows)
Add block of values using local indices
* add_local\ (values)
Add values to each entry on local process
"""
return _la.GenericVector_add_local(self, *args)
def gather(self, *args):
"""
**Overloaded versions**
* gather\ (x, indices)
Gather entries into local vector x
* gather\ (x, indices)
Gather entries into x
"""
return _la.GenericVector_gather(self, *args)
def gather_on_zero(self):
"""
Gather all entries into x on process 0
"""
return _la.GenericVector_gather_on_zero(self)
def axpy(self, a, x):
"""
Add multiple of given vector (AXPY operation)
"""
return _la.GenericVector_axpy(self, a, x)
def abs(self):
"""
Replace all entries in the vector by their absolute values
"""
return _la.GenericVector_abs(self)
def inner(self, x):
"""
Return inner product with given vector
"""
return _la.GenericVector_inner(self, x)
def norm(self, norm_type):
"""
Return norm of vector
"""
return _la.GenericVector_norm(self, norm_type)
def min(self):
"""
Return minimum value of vector
"""
return _la.GenericVector_min(self)
def max(self):
"""
Return maximum value of vector
"""
return _la.GenericVector_max(self)
def sum(self, *args):
"""
**Overloaded versions**
* sum\ ()
Return sum of vector
* sum\ (rows)
Return sum of selected rows in vector. Repeated entries are
only summed once.
"""
return _la.GenericVector_sum(self, *args)
def _assign(self, *args):
"""
**Overloaded versions**
* operator=\ (x)
Assignment operator
* operator=\ (a)
Assignment operator
"""
return _la.GenericVector__assign(self, *args)
def _scale(self, a):
"""Missing docstring"""
return _la.GenericVector__scale(self, a)
def _vec_mul(self, other):
"""Missing docstring"""
return _la.GenericVector__vec_mul(self, other)
def __in_parallel(self):
first, last = self.local_range()
return first > 0 or len(self) > last
def __is_compatible(self, other):
"Returns True if self, and other are compatible Vectors"
if not isinstance(other, GenericVector):
return False
self_type = get_tensor_type(self)
return self_type == get_tensor_type(other)
def array(self):
"Return a numpy array representation of the local part of a Vector"
return self.get_local()
def __contains__(self, value):
from numpy import isscalar
if isscalar(value):
return value in self.get_local()
return NotImplemented
def __gt__(self, value):
from numpy import isscalar
if isscalar(value):
return self.get_local() > value
if isinstance(value, GenericVector):
return self.get_local() > value.get_local()
return NotImplemented
def __ge__(self, value):
from numpy import isscalar
if isscalar(value):
return self.get_local() >= value
if isinstance(value, GenericVector):
return self.get_local() >= value.get_local()
return NotImplemented
def __lt__(self, value):
from numpy import isscalar
if isscalar(value):
return self.get_local() < value
if isinstance(value, GenericVector):
return self.get_local() < value.get_local()
return NotImplemented
def __le__(self, value):
from numpy import isscalar
if isscalar(value):
return self.get_local() <= value
if isinstance(value, GenericVector):
return self.get_local() <= value.get_local()
return NotImplemented
def __eq__(self, value):
from numpy import isscalar
if isscalar(value):
return self.get_local() == value
if isinstance(value, GenericVector):
return self.get_local() == value.get_local()
return NotImplemented
def __neq__(self, value):
from numpy import isscalar
if isscalar(value):
return self.get_local() != value
if isinstance(value, GenericVector):
return self.get_local() != value.get_local()
return NotImplemented
def __neg__(self):
ret = self.copy()
ret *= -1
return ret
def __delitem__(self,i):
raise ValueError("cannot delete Vector elements")
def __delslice__(self,i,j):
raise ValueError("cannot delete Vector elements")
def __setslice__(self, i, j, values):
from numpy import ndarray, arange
if i == 0 and (j >= len(self) or j == -1): # slice == whole
from numpy import isscalar
# No test for equal lengths because this is checked by DOLFIN in _assign
if isinstance(values, GenericVector) or isscalar(values):
self._assign(values)
return
elif isinstance(values, ndarray):
indices = arange(self.local_size(), dtype=la_index_dtype())
self[indices] = values
return
raise IndexError("can only set full slices v[:]")
def __getslice__(self, i, j):
if i == 0 and (j >= len(self) or j == -1):
return self.copy()
raise IndexError("can only return full slices v[:]")
def _check_indices(self, indices):
from numpy import asarray, ndarray
# Only accpect list and ndarrays
if not isinstance(indices, (ndarray, list)):
raise TypeError("expected an int or a list or numpy array of "\
"integers or a boolean numpy array as indices.")
# If boolean array
elif isinstance(indices, ndarray) and indices.dtype==bool:
indices = indices.nonzero()[0]
# Convert to correct indextypes
if isinstance(indices, ndarray):
# For some obscure reason we need to compare the char
# attribute of the dtype to be able to differentiate
# between correct dtypes. And to get the char attribute we
# need to instantiate the bloody dtype and then access the
# fraking dtype of the dtype, which can be asked for its
# char...
if indices.dtype.char != la_index_dtype()().dtype.char:
indices = indices.astype(la_index_dtype())
else:
indices = asarray(indices, dtype=la_index_dtype())
# Check range
# FIXME: What should local_size mean?
if not ((0<=indices).all() and (indices<self.local_size()).all()):
raise IndexError("expected indices to be in [0..{}]".format(\
self.local_size()))
return indices
def __getitem__(self, indices):
"""Return values corresponding to the given local indices"""
from numpy import ndarray, integer, long, array, zeros, float_
# If indices is a slice
if isinstance(indices, slice):
if not (indices.start is None and indices.stop is None and \
indices.step is None):
raise IndexError("can only return full slices v[:]")
return self.__getslice__(0, len(self))
elif isinstance(indices, (int, integer, long)):
indices = array([indices], dtype=la_index_dtype())
indices = self._check_indices(indices)
values = zeros(len(indices), dtype=float_)
if len(values)>0:
self.get_local(values, indices)
return values
def __setitem__(self, indices, values):
"""Set values corresponding to the given local indices
This method is collective and user need to take care when this
method is called, preventing MPI-deadlocks.
"""
from numpy import asarray, ndarray, array, integer, isscalar, long, float_, ones
try:
# If indices is a slice
if isinstance(indices, slice):
if not (indices.start is None and indices.stop is None and \
indices.step is None):
raise IndexError("can only set full slices v[:]")
self.__setslice__(0, len(self), values)
return
# If indices is a single integer
elif isinstance(indices, (int, integer, long)):
if isscalar(values):
indices = array([indices], dtype=la_index_dtype())
else:
raise TypeError("provide a scalar to set single item")
# Check indices
indices = self._check_indices(indices)
# Check passed values and convert scalar to ndarray of that value
if isscalar(values):
vec_values = ones(len(indices), dtype=float_)
vec_values *= values
values = vec_values
elif isinstance(values, GenericVector):
values = values.get_local()
elif isinstance(values, ndarray):
values = asarray(values, dtype=float_)
else:
raise TypeError("provide a scalar, GenericVector or numpy array of "\
"float to set items in Vector")
if len(values) != len(indices):
raise IndexError("expected same size of indices and values")
# If values passed.
if len(values) > 0:
self.set_local(values, indices)
finally:
# Always call apply insert to avoid MPI dead locks if one or more
# ranks fails
self.apply("insert")
def __len__(self):
return self.size()
def __iter__(self):
for i in range(self.size()):
yield self[i]
def __add__(self, other):
"""x.__add__(y) <==> x+y"""
from numpy import isscalar
if isscalar(other):
ret = self.copy()
ret._iadd_scalar(other)
return ret
elif self.__is_compatible(other):
ret = self.copy()
ret.axpy(1.0, other)
return ret
return NotImplemented
def __sub__(self, other):
"""x.__sub__(y) <==> x-y"""
from numpy import isscalar
if isscalar(other):
ret = self.copy()
ret._iadd_scalar(-other)
return ret
elif self.__is_compatible(other):
ret = self.copy()
ret.axpy(-1.0, other)
return ret
return NotImplemented
def __mul__(self, other):
"""x.__mul__(y) <==> x*y"""
from numpy import isscalar
if isscalar(other):
ret = self.copy()
ret._scale(other)
return ret
if isinstance(other,GenericVector):
ret = self.copy()
ret._vec_mul(other)
return ret
return NotImplemented
def __div__(self,other):
"""x.__div__(y) <==> x/y"""
from numpy import isscalar
if isscalar(other):
ret = self.copy()
ret._scale(1.0 / other)
return ret
return NotImplemented
def __truediv__(self,other):
"""x.__div__(y) <==> x/y"""
from numpy import isscalar
if isscalar(other):
ret = self.copy()
ret._scale(1.0 / other)
return ret
return NotImplemented
def __radd__(self,other):
"""x.__radd__(y) <==> y+x"""
return self.__add__(other)
def __rsub__(self, other):
"""x.__rsub__(y) <==> y-x"""
ret = self.__sub__(other)
ret.__imul__(-1.0)
return ret
def __rmul__(self, other):
"""x.__rmul__(y) <==> y*x"""
from numpy import isscalar
if isscalar(other):
ret = self.copy()
ret._scale(other)
return ret
return NotImplemented
def __rdiv__(self, other):
"""x.__rdiv__(y) <==> y/x"""
return NotImplemented
def __iadd__(self, other):
"""x.__iadd__(y) <==> x+y"""
from numpy import isscalar
if isscalar(other):
self._iadd_scalar(other)
return self
elif self.__is_compatible(other):
self.axpy(1.0, other)
return self
return NotImplemented
def __isub__(self, other):
"""x.__isub__(y) <==> x-y"""
from numpy import isscalar
if isscalar(other):
self._iadd_scalar(-other)
return self
elif self.__is_compatible(other):
self.axpy(-1.0, other)
return self
return NotImplemented
def __imul__(self, other):
"""x.__imul__(y) <==> x*y"""
from numpy import isscalar
if isscalar(other):
self._scale(other)
return self
if isinstance(other, GenericVector):
self._vec_mul(other)
return self
return NotImplemented
def __idiv__(self, other):
"""x.__idiv__(y) <==> x/y"""
from numpy import isscalar
if isscalar(other):
self._scale(1.0 / other)
return self
return NotImplemented
def __itruediv__(self, other):
"""x.__idiv__(y) <==> x/y"""
from numpy import isscalar
if isscalar(other):
self._scale(1.0 / other)
return self
return NotImplemented
def __iter__(self):
return iter(self.array())
GenericVector.copy = new_instancemethod(_la.GenericVector_copy, None, GenericVector)
GenericVector.init = new_instancemethod(_la.GenericVector_init, None, GenericVector)
GenericVector.size = new_instancemethod(_la.GenericVector_size, None, GenericVector)
GenericVector.local_size = new_instancemethod(_la.GenericVector_local_size, None, GenericVector)
GenericVector.local_range = new_instancemethod(_la.GenericVector_local_range, None, GenericVector)
GenericVector.owns_index = new_instancemethod(_la.GenericVector_owns_index, None, GenericVector)
GenericVector.add = new_instancemethod(_la.GenericVector_add, None, GenericVector)
GenericVector.get_local = new_instancemethod(_la.GenericVector_get_local, None, GenericVector)
GenericVector.set_local = new_instancemethod(_la.GenericVector_set_local, None, GenericVector)
GenericVector.add_local = new_instancemethod(_la.GenericVector_add_local, None, GenericVector)
GenericVector.gather = new_instancemethod(_la.GenericVector_gather, None, GenericVector)
GenericVector.gather_on_zero = new_instancemethod(_la.GenericVector_gather_on_zero, None, GenericVector)
GenericVector.axpy = new_instancemethod(_la.GenericVector_axpy, None, GenericVector)
GenericVector.abs = new_instancemethod(_la.GenericVector_abs, None, GenericVector)
GenericVector.inner = new_instancemethod(_la.GenericVector_inner, None, GenericVector)
GenericVector.norm = new_instancemethod(_la.GenericVector_norm, None, GenericVector)
GenericVector.min = new_instancemethod(_la.GenericVector_min, None, GenericVector)
GenericVector.max = new_instancemethod(_la.GenericVector_max, None, GenericVector)
GenericVector.sum = new_instancemethod(_la.GenericVector_sum, None, GenericVector)
GenericVector._assign = new_instancemethod(_la.GenericVector__assign, None, GenericVector)
GenericVector._iadd_scalar = new_instancemethod(_la.GenericVector__iadd_scalar, None, GenericVector)
GenericVector._scale = new_instancemethod(_la.GenericVector__scale, None, GenericVector)
GenericVector._vec_mul = new_instancemethod(_la.GenericVector__vec_mul, None, GenericVector)
GenericVector_swigregister = _la.GenericVector_swigregister
GenericVector_swigregister(GenericVector)
class VectorSpaceBasis(object):
"""
This class defines a basis for vector spaces,
typically used for expressing nullspaces, transpose nullspaces
and near nullspaces of singular operators
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, basis):
"""
Constructor
"""
_la.VectorSpaceBasis_swiginit(self, _la.new_VectorSpaceBasis(basis))
__swig_destroy__ = _la.delete_VectorSpaceBasis
def orthonormalize(self, tol=1.0e-10):
"""
Apply the Gram-Schmidt process to orthonormalize the
basis. Throws an error if a (near) linear dependency is
detected. Error is thrown if <x_i, x_i> < tol.
"""
return _la.VectorSpaceBasis_orthonormalize(self, tol)
def is_orthonormal(self, tol=1.0e-10):
"""
Test if basis is orthonormal
"""
return _la.VectorSpaceBasis_is_orthonormal(self, tol)
def is_orthogonal(self, tol=1.0e-10):
"""
Test if basis is orthogonal
"""
return _la.VectorSpaceBasis_is_orthogonal(self, tol)
def orthogonalize(self, x):
"""
Orthogonalize x with respect to basis
"""
return _la.VectorSpaceBasis_orthogonalize(self, x)
def dim(self):
"""
Number of vectors in the basis
"""
return _la.VectorSpaceBasis_dim(self)
def _sub(self, i):
"""
Get a particular basis vector
"""
return _la.VectorSpaceBasis__sub(self, i)
VectorSpaceBasis.orthonormalize = new_instancemethod(_la.VectorSpaceBasis_orthonormalize, None, VectorSpaceBasis)
VectorSpaceBasis.is_orthonormal = new_instancemethod(_la.VectorSpaceBasis_is_orthonormal, None, VectorSpaceBasis)
VectorSpaceBasis.is_orthogonal = new_instancemethod(_la.VectorSpaceBasis_is_orthogonal, None, VectorSpaceBasis)
VectorSpaceBasis.orthogonalize = new_instancemethod(_la.VectorSpaceBasis_orthogonalize, None, VectorSpaceBasis)
VectorSpaceBasis.dim = new_instancemethod(_la.VectorSpaceBasis_dim, None, VectorSpaceBasis)
VectorSpaceBasis._sub = new_instancemethod(_la.VectorSpaceBasis__sub, None, VectorSpaceBasis)
VectorSpaceBasis_swigregister = _la.VectorSpaceBasis_swigregister
VectorSpaceBasis_swigregister(VectorSpaceBasis)
class GenericLinearSolver(common.Variable):
"""
This class provides a general solver for linear systems Ax = b.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined - class is abstract")
__repr__ = _swig_repr
def set_operator(self, A):
"""
Set operator (matrix)
"""
return _la.GenericLinearSolver_set_operator(self, A)
def set_operators(self, A, P):
"""
Set operator (matrix) and preconditioner matrix
"""
return _la.GenericLinearSolver_set_operators(self, A, P)
def solve(self, *args):
"""
**Overloaded versions**
* solve\ (A, x, b)
Solve linear system Ax = b
* solve\ (x, b)
Solve linear system Ax = b
"""
return _la.GenericLinearSolver_solve(self, *args)
def solve_transpose(self, *args):
"""
**Overloaded versions**
* solve_transpose\ (A, x, b)
Solve linear system A^Tx = b
* solve_transpose\ (x, b)
Solve linear system A^Tx = b
"""
return _la.GenericLinearSolver_solve_transpose(self, *args)
def parameter_type(self):
"""
Return parameter type: "krylov_solver" or "lu_solver"
"""
return _la.GenericLinearSolver_parameter_type(self)
def update_parameters(self, parameters):
"""
Update solver parameters (useful for LinearSolver wrapper)
"""
return _la.GenericLinearSolver_update_parameters(self, parameters)
__swig_destroy__ = _la.delete_GenericLinearSolver
GenericLinearSolver.set_operator = new_instancemethod(_la.GenericLinearSolver_set_operator, None, GenericLinearSolver)
GenericLinearSolver.set_operators = new_instancemethod(_la.GenericLinearSolver_set_operators, None, GenericLinearSolver)
GenericLinearSolver.solve = new_instancemethod(_la.GenericLinearSolver_solve, None, GenericLinearSolver)
GenericLinearSolver.solve_transpose = new_instancemethod(_la.GenericLinearSolver_solve_transpose, None, GenericLinearSolver)
GenericLinearSolver.parameter_type = new_instancemethod(_la.GenericLinearSolver_parameter_type, None, GenericLinearSolver)
GenericLinearSolver.update_parameters = new_instancemethod(_la.GenericLinearSolver_update_parameters, None, GenericLinearSolver)
GenericLinearSolver_swigregister = _la.GenericLinearSolver_swigregister
GenericLinearSolver_swigregister(GenericLinearSolver)
class GenericLUSolver(GenericLinearSolver):
"""
This a base class for LU solvers
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined - class is abstract")
__repr__ = _swig_repr
def solve(self, *args):
"""
**Overloaded versions**
* solve\ (x, b)
Solve linear system Ax = b
* solve\ (A, x, b)
Solve linear system Ax = b
"""
return _la.GenericLUSolver_solve(self, *args)
def solve_transpose(self, *args):
"""
**Overloaded versions**
* solve_transpose\ (x, b)
Solve linear system A^Tx = b
* solve_transpose\ (A, x, b)
Solve linear system A^Tx = b
"""
return _la.GenericLUSolver_solve_transpose(self, *args)
__swig_destroy__ = _la.delete_GenericLUSolver
GenericLUSolver.solve = new_instancemethod(_la.GenericLUSolver_solve, None, GenericLUSolver)
GenericLUSolver.solve_transpose = new_instancemethod(_la.GenericLUSolver_solve_transpose, None, GenericLUSolver)
GenericLUSolver_swigregister = _la.GenericLUSolver_swigregister
GenericLUSolver_swigregister(GenericLUSolver)
class PETScOptions(object):
"""
These class provides static functions that permit users to set
and retrieve PETSc options via the PETSc option/parameter
system. The option must not be prefixed by '-', e.g.
PETScOptions::set("mat_mumps_icntl_14", 40);
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def set(*args):
"""
**Overloaded versions**
* set\ (option)
Set PETSc option that takes no value
* set\ (option, value)
Set PETSc boolean option
* set\ (option, value)
Set PETSc integer option
* set\ (option, value)
Set PETSc double option
* set\ (option, value)
Set PETSc string option
* set\ (option, value)
Genetic function for setting PETSc option
"""
return _la.PETScOptions_set(*args)
set = staticmethod(set)
def clear(option):
"""
Clear PETSc option
"""
return _la.PETScOptions_clear(option)
clear = staticmethod(clear)
def __init__(self):
_la.PETScOptions_swiginit(self, _la.new_PETScOptions())
__swig_destroy__ = _la.delete_PETScOptions
PETScOptions_swigregister = _la.PETScOptions_swigregister
PETScOptions_swigregister(PETScOptions)
def PETScOptions_set(*args):
"""
**Overloaded versions**
* set\ (option)
Set PETSc option that takes no value
* set\ (option, value)
Set PETSc boolean option
* set\ (option, value)
Set PETSc integer option
* set\ (option, value)
Set PETSc double option
* set\ (option, value)
Set PETSc string option
* set\ (option, value)
Genetic function for setting PETSc option
"""
return _la.PETScOptions_set(*args)
def PETScOptions_clear(option):
"""
Clear PETSc option
"""
return _la.PETScOptions_clear(option)
class PETScObject(object):
"""
This class calls SubSystemsManager to initialise PETSc.
All PETSc objects must be derived from this class.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self):
"""
Constructor. Ensures that PETSc has been initialised.
"""
_la.PETScObject_swiginit(self, _la.new_PETScObject())
__swig_destroy__ = _la.delete_PETScObject
def petsc_error(error_code, filename, petsc_function):
"""
Print error message for PETSc calls that return an error
"""
return _la.PETScObject_petsc_error(error_code, filename, petsc_function)
petsc_error = staticmethod(petsc_error)
PETScObject_swigregister = _la.PETScObject_swigregister
PETScObject_swigregister(PETScObject)
def PETScObject_petsc_error(error_code, filename, petsc_function):
"""
Print error message for PETSc calls that return an error
"""
return _la.PETScObject_petsc_error(error_code, filename, petsc_function)
class PETScBaseMatrix(PETScObject, common.Variable):
"""
This class is a base class for matrices that can be used in
PETScKrylovSolver.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined - class is abstract")
__repr__ = _swig_repr
__swig_destroy__ = _la.delete_PETScBaseMatrix
def size(self, *args):
"""
**Overloaded versions**
* size\ (dim)
Return number of rows (dim = 0) or columns (dim = 1)
* size\ ()
Return number of rows and columns (num_rows, num_cols). PETSc
returns -1 if size has not been set.
"""
return _la.PETScBaseMatrix_size(self, *args)
def local_range(self, dim):
"""
Return local range along dimension dim
"""
return _la.PETScBaseMatrix_local_range(self, dim)
def init_vector(self, z, dim):
"""
Initialize vector to be compatible with the matrix-vector product
y = Ax. In the parallel case, both size and layout are
important.
*Arguments*
dim (int)
The dimension (axis): dim = 0 --> z = y, dim = 1 --> z = x
"""
return _la.PETScBaseMatrix_init_vector(self, z, dim)
def mpi_comm(self):
"""
Return the MPI communicator
"""
return _la.PETScBaseMatrix_mpi_comm(self)
def mat(self):
"""Return petsc4py representation of PETSc Mat"""
return _la.PETScBaseMatrix_mat(self)
PETScBaseMatrix.size = new_instancemethod(_la.PETScBaseMatrix_size, None, PETScBaseMatrix)
PETScBaseMatrix.local_range = new_instancemethod(_la.PETScBaseMatrix_local_range, None, PETScBaseMatrix)
PETScBaseMatrix.init_vector = new_instancemethod(_la.PETScBaseMatrix_init_vector, None, PETScBaseMatrix)
PETScBaseMatrix.mpi_comm = new_instancemethod(_la.PETScBaseMatrix_mpi_comm, None, PETScBaseMatrix)
PETScBaseMatrix.mat = new_instancemethod(_la.PETScBaseMatrix_mat, None, PETScBaseMatrix)
PETScBaseMatrix_swigregister = _la.PETScBaseMatrix_swigregister
PETScBaseMatrix_swigregister(PETScBaseMatrix)
class EigenMatrix(GenericMatrix):
"""
This class provides a sparse matrix class based on Eigen. It is
a simple wrapper for Eigen::SparseMatrix implementing the
GenericMatrix interface.
The interface is intentionally simple. For advanced usage,
access the underlying Eigen matrix and use the standard Eigen
interface which is documented at http://eigen.tuxfamily.org
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* EigenMatrix\ ()
Create empty matrix
* EigenMatrix\ (M, N)
Create M x N matrix
* EigenMatrix\ (A)
Copy constructor
"""
_la.EigenMatrix_swiginit(self, _la.new_EigenMatrix(*args))
__swig_destroy__ = _la.delete_EigenMatrix
def resize(self, M, N):
"""
Resize matrix to M x N
"""
return _la.EigenMatrix_resize(self, M, N)
def zero(self, *args):
"""
**Overloaded versions**
* zero\ ()
Set all entries to zero and keep any sparse structure
* zero\ (m, rows)
Set given rows (global row indices) to zero
"""
return _la.EigenMatrix_zero(self, *args)
def mat(self, *args):
"""
**Overloaded versions**
* mat\ ()
Return reference to Eigen matrix (const version)
* mat\ ()
Return reference to Eigen matrix (non-const version)
"""
return _la.EigenMatrix_mat(self, *args)
def compress(self):
"""
Compress matrix (eliminate all zeros from a sparse matrix)
"""
return _la.EigenMatrix_compress(self)
def assign(self, *args):
"""
**Overloaded versions**
* operator=\ (A)
Assignment operator
* operator=\ (A)
Assignment operator
"""
return _la.EigenMatrix_assign(self, *args)
def _data(self):
"""Missing docstring"""
return _la.EigenMatrix__data(self)
def data(self, deepcopy=True):
"""
Return arrays to underlaying compresssed row/column storage data
This method is only available for the Eigen linear algebra backend.
*Arguments*
deepcopy
Return a copy of the data. If set to False a reference
to the Matrix need to be kept, otherwise the data will be
destroyed together with the destruction of the Matrix
"""
rows, cols, values = self._data()
if deepcopy:
rows, cols, values = rows.astype(int), cols.astype(int), values.copy()
else:
_attach_base_to_numpy_array(rows, self)
_attach_base_to_numpy_array(cols, self)
_attach_base_to_numpy_array(values, self)
return rows, cols, values
def sparray(self):
"Return a scipy.sparse representation of Matrix"
from scipy.sparse import csr_matrix
data = self.data(deepcopy=True)
C = csr_matrix((data[2], data[1], data[0]))
return C
EigenMatrix.resize = new_instancemethod(_la.EigenMatrix_resize, None, EigenMatrix)
EigenMatrix.zero = new_instancemethod(_la.EigenMatrix_zero, None, EigenMatrix)
EigenMatrix.mat = new_instancemethod(_la.EigenMatrix_mat, None, EigenMatrix)
EigenMatrix.compress = new_instancemethod(_la.EigenMatrix_compress, None, EigenMatrix)
EigenMatrix.assign = new_instancemethod(_la.EigenMatrix_assign, None, EigenMatrix)
EigenMatrix._data = new_instancemethod(_la.EigenMatrix__data, None, EigenMatrix)
EigenMatrix_swigregister = _la.EigenMatrix_swigregister
EigenMatrix_swigregister(EigenMatrix)
class PETScMatrix(GenericMatrix, PETScBaseMatrix):
"""
This class provides a simple matrix class based on PETSc.
It is a wrapper for a PETSc matrix pointer (Mat)
implementing the GenericMatrix interface.
The interface is intentionally simple. For advanced usage,
access the PETSc Mat pointer using the function mat() and
use the standard PETSc interface.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* PETScMatrix\ ()
Create empty matrix (on MPI_COMM_WORLD)
* PETScMatrix\ (comm)
Create empty matrix
* PETScMatrix\ (A)
Create a wrapper around a PETSc Mat pointer. The Mat object
should have been created, e.g. via PETSc MatrCreate.
* PETScMatrix\ (A)
Copy constructor
"""
_la.PETScMatrix_swiginit(self, _la.new_PETScMatrix(*args))
__swig_destroy__ = _la.delete_PETScMatrix
def mpi_comm(self):
"""
Return MPI communicator
"""
return _la.PETScMatrix_mpi_comm(self)
def zero(self, *args):
"""
**Overloaded versions**
* zero\ ()
Set all entries to zero and keep any sparse structure
* zero\ (m, rows)
Set given rows (global row indices) to zero
"""
return _la.PETScMatrix_zero(self, *args)
def set_options_prefix(self, options_prefix):
"""
Sets the prefix used by PETSc when searching the options
database
"""
return _la.PETScMatrix_set_options_prefix(self, options_prefix)
def get_options_prefix(self):
"""
Returns the prefix used by PETSc when searching the options
database
"""
return _la.PETScMatrix_get_options_prefix(self)
def set_from_options(self):
"""
Call PETSc function MatSetFromOptions on the PETSc Mat object
"""
return _la.PETScMatrix_set_from_options(self)
def assign(self, *args):
"""
**Overloaded versions**
* operator=\ (A)
Assignment operator
* operator=\ (A)
Assignment operator
"""
return _la.PETScMatrix_assign(self, *args)
def set_nullspace(self, nullspace):
"""
Attach nullspace to matrix (typically used by Krylov solvers
when solving singular systems)
"""
return _la.PETScMatrix_set_nullspace(self, nullspace)
def set_near_nullspace(self, nullspace):
"""
Attach near nullspace to matrix (used by preconditioners, such
as smoothed aggregation algerbraic multigrid)
"""
return _la.PETScMatrix_set_near_nullspace(self, nullspace)
def binary_dump(self, file_name):
"""
Dump matrix to PETSc binary format
"""
return _la.PETScMatrix_binary_dump(self, file_name)
PETScMatrix.mpi_comm = new_instancemethod(_la.PETScMatrix_mpi_comm, None, PETScMatrix)
PETScMatrix.zero = new_instancemethod(_la.PETScMatrix_zero, None, PETScMatrix)
PETScMatrix.set_options_prefix = new_instancemethod(_la.PETScMatrix_set_options_prefix, None, PETScMatrix)
PETScMatrix.get_options_prefix = new_instancemethod(_la.PETScMatrix_get_options_prefix, None, PETScMatrix)
PETScMatrix.set_from_options = new_instancemethod(_la.PETScMatrix_set_from_options, None, PETScMatrix)
PETScMatrix.assign = new_instancemethod(_la.PETScMatrix_assign, None, PETScMatrix)
PETScMatrix.set_nullspace = new_instancemethod(_la.PETScMatrix_set_nullspace, None, PETScMatrix)
PETScMatrix.set_near_nullspace = new_instancemethod(_la.PETScMatrix_set_near_nullspace, None, PETScMatrix)
PETScMatrix.binary_dump = new_instancemethod(_la.PETScMatrix_binary_dump, None, PETScMatrix)
PETScMatrix_swigregister = _la.PETScMatrix_swigregister
PETScMatrix_swigregister(PETScMatrix)
class PETScLinearOperator(PETScBaseMatrix, GenericLinearOperator):
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, comm):
"""
Constructor
"""
if self.__class__ == PETScLinearOperator:
_self = None
else:
_self = self
_la.PETScLinearOperator_swiginit(self, _la.new_PETScLinearOperator(_self, comm))
def size(self, dim):
"""
Return size of given dimension
"""
return _la.PETScLinearOperator_size(self, dim)
def mult(self, x, y):
"""
Compute matrix-vector product y = Ax
"""
return _la.PETScLinearOperator_mult(self, x, y)
def mpi_comm(self):
"""
Return MPI communicator
"""
return _la.PETScLinearOperator_mpi_comm(self)
__swig_destroy__ = _la.delete_PETScLinearOperator
def __disown__(self):
self.this.disown()
_la.disown_PETScLinearOperator(self)
return weakref_proxy(self)
PETScLinearOperator.size = new_instancemethod(_la.PETScLinearOperator_size, None, PETScLinearOperator)
PETScLinearOperator.mult = new_instancemethod(_la.PETScLinearOperator_mult, None, PETScLinearOperator)
PETScLinearOperator.mpi_comm = new_instancemethod(_la.PETScLinearOperator_mpi_comm, None, PETScLinearOperator)
PETScLinearOperator.init_layout = new_instancemethod(_la.PETScLinearOperator_init_layout, None, PETScLinearOperator)
PETScLinearOperator_swigregister = _la.PETScLinearOperator_swigregister
PETScLinearOperator_swigregister(PETScLinearOperator)
class PETScPreconditioner(PETScObject, common.Variable):
"""
This class is a wrapper for configuring PETSc
preconditioners. It does not own a preconditioner. It can take a
PETScKrylovSolver and set the preconditioner type and
parameters.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
set_type = staticmethod(_la.PETScPreconditioner_set_type)
def __init__(self, *args):
"""
Create a particular preconditioner object
"""
_la.PETScPreconditioner_swiginit(self, _la.new_PETScPreconditioner(*args))
__swig_destroy__ = _la.delete_PETScPreconditioner
def set(self, solver):
"""
Set the preconditioner type and parameters
"""
return _la.PETScPreconditioner_set(self, solver)
def set_coordinates(self, x, dim):
"""
Set the coordinates of the operator (matrix) rows and
geometric dimension d. This is can be used by required for
certain preconditioners, e.g. ML. The input for this function
can be generated using GenericDofMap::tabulate_all_dofs.
"""
return _la.PETScPreconditioner_set_coordinates(self, x, dim)
def preconditioners():
"""
Return a list of available preconditioners
"""
return _la.PETScPreconditioner_preconditioners()
preconditioners = staticmethod(preconditioners)
PETScPreconditioner.set = new_instancemethod(_la.PETScPreconditioner_set, None, PETScPreconditioner)
PETScPreconditioner.set_coordinates = new_instancemethod(_la.PETScPreconditioner_set_coordinates, None, PETScPreconditioner)
PETScPreconditioner.set_fieldsplit = new_instancemethod(_la.PETScPreconditioner_set_fieldsplit, None, PETScPreconditioner)
PETScPreconditioner_swigregister = _la.PETScPreconditioner_swigregister
PETScPreconditioner_swigregister(PETScPreconditioner)
def PETScPreconditioner_set_type(solver, type):
return _la.PETScPreconditioner_set_type(solver, type)
PETScPreconditioner_set_type = _la.PETScPreconditioner_set_type
def PETScPreconditioner_preconditioners():
"""
Return a list of available preconditioners
"""
return _la.PETScPreconditioner_preconditioners()
class EigenKrylovSolver(GenericLinearSolver):
"""
This class implements Krylov methods for linear systems of the
form Ax = b. It is a wrapper for the Krylov solvers of Eigen.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
Create Krylov solver for a particular method and names
preconditioner
"""
_la.EigenKrylovSolver_swiginit(self, _la.new_EigenKrylovSolver(*args))
__swig_destroy__ = _la.delete_EigenKrylovSolver
def set_operator(self, *args):
"""
**Overloaded versions**
* set_operator\ (A)
Set operator (matrix)
* set_operator\ (A)
Set operator (matrix)
"""
return _la.EigenKrylovSolver_set_operator(self, *args)
def set_operators(self, *args):
"""
**Overloaded versions**
* set_operators\ (A, P)
Set operator (matrix) and preconditioner matrix
* set_operators\ (A, P)
Set operator (matrix) and preconditioner matrix
"""
return _la.EigenKrylovSolver_set_operators(self, *args)
def get_operator(self):
"""
Get operator (matrix)
"""
return _la.EigenKrylovSolver_get_operator(self)
def solve(self, *args):
"""
**Overloaded versions**
* solve\ (x, b)
Solve linear system Ax = b and return number of iterations
* solve\ (x, b)
Solve linear system Ax = b and return number of iterations
* solve\ (A, x, b)
Solve linear system Ax = b and return number of iterations
* solve\ (A, x, b)
Solve linear system Ax = b and return number of iterations
"""
return _la.EigenKrylovSolver_solve(self, *args)
def methods():
"""
Return a list of available solver methods
"""
return _la.EigenKrylovSolver_methods()
methods = staticmethod(methods)
def preconditioners():
"""
Return a list of available preconditioners
"""
return _la.EigenKrylovSolver_preconditioners()
preconditioners = staticmethod(preconditioners)
def default_parameters():
"""
Default parameter values
"""
return _la.EigenKrylovSolver_default_parameters()
default_parameters = staticmethod(default_parameters)
EigenKrylovSolver.set_operator = new_instancemethod(_la.EigenKrylovSolver_set_operator, None, EigenKrylovSolver)
EigenKrylovSolver.set_operators = new_instancemethod(_la.EigenKrylovSolver_set_operators, None, EigenKrylovSolver)
EigenKrylovSolver.get_operator = new_instancemethod(_la.EigenKrylovSolver_get_operator, None, EigenKrylovSolver)
EigenKrylovSolver.solve = new_instancemethod(_la.EigenKrylovSolver_solve, None, EigenKrylovSolver)
EigenKrylovSolver_swigregister = _la.EigenKrylovSolver_swigregister
EigenKrylovSolver_swigregister(EigenKrylovSolver)
def EigenKrylovSolver_methods():
"""
Return a list of available solver methods
"""
return _la.EigenKrylovSolver_methods()
def EigenKrylovSolver_preconditioners():
"""
Return a list of available preconditioners
"""
return _la.EigenKrylovSolver_preconditioners()
def EigenKrylovSolver_default_parameters():
"""
Default parameter values
"""
return _la.EigenKrylovSolver_default_parameters()
class EigenLUSolver(GenericLUSolver):
"""
This class implements the direct solution (LU factorization) for
linear systems of the form Ax = b.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* EigenLUSolver\ (method="default")
Constructor
* EigenLUSolver\ (A, method="default")
Constructor
"""
_la.EigenLUSolver_swiginit(self, _la.new_EigenLUSolver(*args))
__swig_destroy__ = _la.delete_EigenLUSolver
def set_operator(self, *args):
"""
**Overloaded versions**
* set_operator\ (A)
Set operator (matrix)
* set_operator\ (A)
Set operator (matrix)
"""
return _la.EigenLUSolver_set_operator(self, *args)
def get_operator(self):
"""
Get operator (matrix)
"""
return _la.EigenLUSolver_get_operator(self)
def solve(self, *args):
"""
**Overloaded versions**
* solve\ (x, b)
Solve linear system Ax = b
* solve\ (x, b, transpose)
Solve linear system Ax = b
* solve\ (A, x, b)
Solve linear system Ax = b
* solve\ (A, x, b)
Solve linear system Ax = b
"""
return _la.EigenLUSolver_solve(self, *args)
def solve_transpose(self, *args):
"""
**Overloaded versions**
* solve_transpose\ (x, b)
Solve linear system A^Tx = b
* solve_transpose\ (A, x, b)
Solve linear system A^Tx = b
* solve_transpose\ (A, x, b)
Solve linear system A^Tx = b
"""
return _la.EigenLUSolver_solve_transpose(self, *args)
def methods():
"""
Return a list of available solver methods
"""
return _la.EigenLUSolver_methods()
methods = staticmethod(methods)
def default_parameters():
"""
Default parameter values
"""
return _la.EigenLUSolver_default_parameters()
default_parameters = staticmethod(default_parameters)
EigenLUSolver.set_operator = new_instancemethod(_la.EigenLUSolver_set_operator, None, EigenLUSolver)
EigenLUSolver.get_operator = new_instancemethod(_la.EigenLUSolver_get_operator, None, EigenLUSolver)
EigenLUSolver.solve = new_instancemethod(_la.EigenLUSolver_solve, None, EigenLUSolver)
EigenLUSolver.solve_transpose = new_instancemethod(_la.EigenLUSolver_solve_transpose, None, EigenLUSolver)
EigenLUSolver_swigregister = _la.EigenLUSolver_swigregister
EigenLUSolver_swigregister(EigenLUSolver)
def EigenLUSolver_methods():
"""
Return a list of available solver methods
"""
return _la.EigenLUSolver_methods()
def EigenLUSolver_default_parameters():
"""
Default parameter values
"""
return _la.EigenLUSolver_default_parameters()
class PETScKrylovSolver(GenericLinearSolver, PETScObject):
"""
This class implements Krylov methods for linear systems of the
form Ax = b. It is a wrapper for the Krylov solvers of PETSc.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
norm_type_none = _la.PETScKrylovSolver_norm_type_none
norm_type_default_norm = _la.PETScKrylovSolver_norm_type_default_norm
norm_type_preconditioned = _la.PETScKrylovSolver_norm_type_preconditioned
norm_type_unpreconditioned = _la.PETScKrylovSolver_norm_type_unpreconditioned
norm_type_natural = _la.PETScKrylovSolver_norm_type_natural
def __init__(self, *args):
"""
**Overloaded versions**
* PETScKrylovSolver\ (comm, method="default", preconditioner="default")
Create Krylov solver for a particular method and named
preconditioner
* PETScKrylovSolver\ (method="default", preconditioner="default")
Create Krylov solver for a particular method and named
preconditioner
* PETScKrylovSolver\ (comm, method, preconditioner)
Create Krylov solver for a particular method and
PETScPreconditioner (shared_ptr version)
* PETScKrylovSolver\ (method, preconditioner)
Create Krylov solver for a particular method and
PETScPreconditioner (shared_ptr version)
* PETScKrylovSolver\ (comm, method, preconditioner)
Create Krylov solver for a particular method and
PETScPreconditioner (shared_ptr version)
* PETScKrylovSolver\ (method, preconditioner)
Create Krylov solver for a particular method and
PETScPreconditioner (shared_ptr version)
* PETScKrylovSolver\ (ksp)
Create solver wrapper of a PETSc KSP object
"""
_la.PETScKrylovSolver_swiginit(self, _la.new_PETScKrylovSolver(*args))
__swig_destroy__ = _la.delete_PETScKrylovSolver
def solve(self, *args):
"""
**Overloaded versions**
* solve\ (x, b)
Solve linear system Ax = b and return number of iterations
* solve\ (x, b)
Solve linear system Ax = b and return number of iterations
* solve\ (A, x, b)
Solve linear system Ax = b and return number of iterations
"""
return _la.PETScKrylovSolver_solve(self, *args)
def set_nonzero_guess(self, nonzero_guess):
"""
Use nonzero intial guess for solution function
(nonzero_guess=true, the solution vector x will not be zeroed
before the solver starts)
"""
return _la.PETScKrylovSolver_set_nonzero_guess(self, nonzero_guess)
def set_reuse_preconditioner(self, reuse_pc):
"""
Reuse preconditioner if true, even if matrix operator changes
(by default preconditioner will be re-built if the matrix
changes)
"""
return _la.PETScKrylovSolver_set_reuse_preconditioner(self, reuse_pc)
def set_tolerances(self, relative, absolute, diverged, max_iter):
"""
Set tolerances (relative residual, alsolute residial, maximum
number of iterations)
"""
return _la.PETScKrylovSolver_set_tolerances(self, relative, absolute, diverged, max_iter)
def set_norm_type(self, type):
"""
Set norm type used in convergence testing - not all solvers
types support all norm types
"""
return _la.PETScKrylovSolver_set_norm_type(self, type)
def get_norm_type(self):
"""
Get norm type used in convergence testing
"""
return _la.PETScKrylovSolver_get_norm_type(self)
def monitor(self, monitor_convergence):
"""
Monitor residual at each iteration
"""
return _la.PETScKrylovSolver_monitor(self, monitor_convergence)
def set_options_prefix(self, options_prefix):
"""
Sets the prefix used by PETSc when searching the PETSc options
database
"""
return _la.PETScKrylovSolver_set_options_prefix(self, options_prefix)
def get_options_prefix(self):
"""
Returns the prefix used by PETSc when searching the PETSc
options database
"""
return _la.PETScKrylovSolver_get_options_prefix(self)
def set_from_options(self):
"""
Set options from PETSc options database
"""
return _la.PETScKrylovSolver_set_from_options(self)
def mpi_comm(self):
"""
Return MPI communicator
"""
return _la.PETScKrylovSolver_mpi_comm(self)
def methods():
"""
Return a list of available solver methods
"""
return _la.PETScKrylovSolver_methods()
methods = staticmethod(methods)
def preconditioners():
"""
Return a list of available named preconditioners
"""
return _la.PETScKrylovSolver_preconditioners()
preconditioners = staticmethod(preconditioners)
def default_parameters():
"""
Default parameter values
"""
return _la.PETScKrylovSolver_default_parameters()
default_parameters = staticmethod(default_parameters)
def ksp(self):
"""Return petsc4py representation of PETSc KSP solver"""
return _la.PETScKrylovSolver_ksp(self)
PETScKrylovSolver.solve = new_instancemethod(_la.PETScKrylovSolver_solve, None, PETScKrylovSolver)
PETScKrylovSolver.set_nonzero_guess = new_instancemethod(_la.PETScKrylovSolver_set_nonzero_guess, None, PETScKrylovSolver)
PETScKrylovSolver.set_reuse_preconditioner = new_instancemethod(_la.PETScKrylovSolver_set_reuse_preconditioner, None, PETScKrylovSolver)
PETScKrylovSolver.set_tolerances = new_instancemethod(_la.PETScKrylovSolver_set_tolerances, None, PETScKrylovSolver)
PETScKrylovSolver.set_norm_type = new_instancemethod(_la.PETScKrylovSolver_set_norm_type, None, PETScKrylovSolver)
PETScKrylovSolver.get_norm_type = new_instancemethod(_la.PETScKrylovSolver_get_norm_type, None, PETScKrylovSolver)
PETScKrylovSolver.monitor = new_instancemethod(_la.PETScKrylovSolver_monitor, None, PETScKrylovSolver)
PETScKrylovSolver.set_options_prefix = new_instancemethod(_la.PETScKrylovSolver_set_options_prefix, None, PETScKrylovSolver)
PETScKrylovSolver.get_options_prefix = new_instancemethod(_la.PETScKrylovSolver_get_options_prefix, None, PETScKrylovSolver)
PETScKrylovSolver.set_from_options = new_instancemethod(_la.PETScKrylovSolver_set_from_options, None, PETScKrylovSolver)
PETScKrylovSolver.mpi_comm = new_instancemethod(_la.PETScKrylovSolver_mpi_comm, None, PETScKrylovSolver)
PETScKrylovSolver.ksp = new_instancemethod(_la.PETScKrylovSolver_ksp, None, PETScKrylovSolver)
PETScKrylovSolver_swigregister = _la.PETScKrylovSolver_swigregister
PETScKrylovSolver_swigregister(PETScKrylovSolver)
def PETScKrylovSolver_methods():
"""
Return a list of available solver methods
"""
return _la.PETScKrylovSolver_methods()
def PETScKrylovSolver_preconditioners():
"""
Return a list of available named preconditioners
"""
return _la.PETScKrylovSolver_preconditioners()
def PETScKrylovSolver_default_parameters():
"""
Default parameter values
"""
return _la.PETScKrylovSolver_default_parameters()
class PETScLUSolver(GenericLUSolver, PETScObject):
"""
This class implements the direct solution (LU factorization) for
linear systems of the form Ax = b. It is a wrapper for the LU
solver of PETSc.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* PETScLUSolver\ (comm, method="default")
Constructor
* PETScLUSolver\ (method="default")
Constructor
* PETScLUSolver\ (comm, A, method="default")
Constructor
* PETScLUSolver\ (A, method="default")
Constructor
"""
_la.PETScLUSolver_swiginit(self, _la.new_PETScLUSolver(*args))
__swig_destroy__ = _la.delete_PETScLUSolver
def set_operator(self, *args):
"""
**Overloaded versions**
* set_operator\ (A)
Set operator (matrix)
* set_operator\ (A)
Set operator (matrix)
"""
return _la.PETScLUSolver_set_operator(self, *args)
def get_operator(self):
"""
Get operator (matrix)
"""
return _la.PETScLUSolver_get_operator(self)
def solve(self, *args):
"""
**Overloaded versions**
* solve\ (x, b)
Solve linear system Ax = b
* solve\ (x, b, transpose)
Solve linear system Ax = b
* solve\ (A, x, b)
Solve linear system Ax = b
* solve\ (A, x, b)
Solve linear system Ax = b
"""
return _la.PETScLUSolver_solve(self, *args)
def solve_transpose(self, *args):
"""
**Overloaded versions**
* solve_transpose\ (x, b)
Solve linear system A^Tx = b
* solve_transpose\ (A, x, b)
Solve linear system A^Tx = b
* solve_transpose\ (A, x, b)
Solve linear system A^Tx = b
"""
return _la.PETScLUSolver_solve_transpose(self, *args)
def set_options_prefix(self, options_prefix):
"""
Sets the prefix used by PETSc when searching the options
database
"""
return _la.PETScLUSolver_set_options_prefix(self, options_prefix)
def get_options_prefix(self):
"""
Returns the prefix used by PETSc when searching the options
database
"""
return _la.PETScLUSolver_get_options_prefix(self)
def set_from_options(self):
"""
Set options from the PETSc options database
"""
return _la.PETScLUSolver_set_from_options(self)
def mpi_comm(self):
"""
Returns the MPI communicator
"""
return _la.PETScLUSolver_mpi_comm(self)
def methods():
"""
Return a list of available solver methods
"""
return _la.PETScLUSolver_methods()
methods = staticmethod(methods)
def default_parameters():
"""
Default parameter values
"""
return _la.PETScLUSolver_default_parameters()
default_parameters = staticmethod(default_parameters)
def ksp(self):
"""Return petsc4py representation of PETSc LU solver"""
return _la.PETScLUSolver_ksp(self)
PETScLUSolver.set_operator = new_instancemethod(_la.PETScLUSolver_set_operator, None, PETScLUSolver)
PETScLUSolver.get_operator = new_instancemethod(_la.PETScLUSolver_get_operator, None, PETScLUSolver)
PETScLUSolver.solve = new_instancemethod(_la.PETScLUSolver_solve, None, PETScLUSolver)
PETScLUSolver.solve_transpose = new_instancemethod(_la.PETScLUSolver_solve_transpose, None, PETScLUSolver)
PETScLUSolver.set_options_prefix = new_instancemethod(_la.PETScLUSolver_set_options_prefix, None, PETScLUSolver)
PETScLUSolver.get_options_prefix = new_instancemethod(_la.PETScLUSolver_get_options_prefix, None, PETScLUSolver)
PETScLUSolver.set_from_options = new_instancemethod(_la.PETScLUSolver_set_from_options, None, PETScLUSolver)
PETScLUSolver.mpi_comm = new_instancemethod(_la.PETScLUSolver_mpi_comm, None, PETScLUSolver)
PETScLUSolver.ksp = new_instancemethod(_la.PETScLUSolver_ksp, None, PETScLUSolver)
PETScLUSolver_swigregister = _la.PETScLUSolver_swigregister
PETScLUSolver_swigregister(PETScLUSolver)
def PETScLUSolver_methods():
"""
Return a list of available solver methods
"""
return _la.PETScLUSolver_methods()
def PETScLUSolver_default_parameters():
"""
Default parameter values
"""
return _la.PETScLUSolver_default_parameters()
class CoordinateMatrix(object):
"""
Coordinate sparse matrix.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, A, symmetric, base_one):
"""
Constructor
"""
_la.CoordinateMatrix_swiginit(self, _la.new_CoordinateMatrix(A, symmetric, base_one))
__swig_destroy__ = _la.delete_CoordinateMatrix
def norm(self, norm_type):
"""
Return norm of matrix
"""
return _la.CoordinateMatrix_norm(self, norm_type)
CoordinateMatrix.size = new_instancemethod(_la.CoordinateMatrix_size, None, CoordinateMatrix)
CoordinateMatrix.rows = new_instancemethod(_la.CoordinateMatrix_rows, None, CoordinateMatrix)
CoordinateMatrix.columns = new_instancemethod(_la.CoordinateMatrix_columns, None, CoordinateMatrix)
CoordinateMatrix.values = new_instancemethod(_la.CoordinateMatrix_values, None, CoordinateMatrix)
CoordinateMatrix.norm = new_instancemethod(_la.CoordinateMatrix_norm, None, CoordinateMatrix)
CoordinateMatrix.mpi_comm = new_instancemethod(_la.CoordinateMatrix_mpi_comm, None, CoordinateMatrix)
CoordinateMatrix.base_one = new_instancemethod(_la.CoordinateMatrix_base_one, None, CoordinateMatrix)
CoordinateMatrix_swigregister = _la.CoordinateMatrix_swigregister
CoordinateMatrix_swigregister(CoordinateMatrix)
class EigenVector(GenericVector):
"""
This class provides a simple vector class based on Eigen.
It is a simple wrapper for a Eigen vector implementing the
GenericVector interface.
The interface is intentionally simple. For advanced usage,
access the underlying Eigen vector and use the standard Eigen
interface which is documented at http://eigen.tuxfamily.org
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* EigenVector\ ()
Create empty vector (on MPI_COMM_SELF)
* EigenVector\ (comm)
Create empty vector
* EigenVector\ (comm, N)
Create vector of size N
* EigenVector\ (x)
Copy constructor
* EigenVector\ (x)
Construct vector from an Eigen shared_ptr
"""
_la.EigenVector_swiginit(self, _la.new_EigenVector(*args))
__swig_destroy__ = _la.delete_EigenVector
def init(self, *args):
"""
**Overloaded versions**
* init\ (tensor_layout)
Initialize zero tensor using sparsity pattern
FIXME: This needs to be implemented on backend side! Remove it!
* init\ (comm, N)
Initialize vector to global size N
* init\ (comm, range)
Initialize vector with given local ownership range
* init\ (comm, range, local_to_global_map, ghost_indices)
Initialise vector with given ownership range and with ghost
values
FIXME: Reimplement using init(const TensorLayout&) and deprecate
"""
return _la.EigenVector_init(self, *args)
def get_local(self, *args):
"""
**Overloaded versions**
* get_local\ (block, m, rows)
Get block of values using local indices
* get_local\ (values)
Get all values on local process
"""
return _la.EigenVector_get_local(self, *args)
def set_local(self, *args):
"""
**Overloaded versions**
* set_local\ (block, m, rows)
Set block of values using local indices
* set_local\ (values)
Set all values on local process
"""
return _la.EigenVector_set_local(self, *args)
def add_local(self, *args):
"""
**Overloaded versions**
* add_local\ (block, m, rows)
Add block of values using local indices
* add_local\ (values)
Add values to each entry on local process
"""
return _la.EigenVector_add_local(self, *args)
def gather(self, *args):
"""
**Overloaded versions**
* gather\ (x, indices)
Gather entries into local vector x
* gather\ (x, indices)
Gather entries into x
"""
return _la.EigenVector_gather(self, *args)
def sum(self, *args):
"""
**Overloaded versions**
* sum\ ()
Return sum of values of vector
* sum\ (rows)
Return sum of selected rows in vector. Repeated entries are
only summed once.
"""
return _la.EigenVector_sum(self, *args)
def resize(self, N):
"""
Resize vector to size N
"""
return _la.EigenVector_resize(self, N)
def vec(self, *args):
"""
**Overloaded versions**
* vec\ ()
Return reference to Eigen vector (const version)
* vec\ ()
Return reference to Eigen vector (non-const version)
"""
return _la.EigenVector_vec(self, *args)
def _assign(self, *args):
"""
**Overloaded versions**
* operator=\ (x)
Assignment operator
* operator=\ (a)
Assignment operator
* operator=\ (x)
Assignment operator
"""
return _la.EigenVector__assign(self, *args)
def _data(self):
"""Missing docstring"""
return _la.EigenVector__data(self)
def data(self, deepcopy=True):
"""
Return an array to underlaying data
This method is only available for the Eigen linear algebra
backend.
*Arguments*
deepcopy
Return a copy of the data. If set to False a reference
to the Matrix need to be kept, otherwise the data will be
destroyed together with the destruction of the Matrix
"""
ret = self._data()
if deepcopy:
ret = ret.copy()
else:
_attach_base_to_numpy_array(ret, self)
return ret
EigenVector.init = new_instancemethod(_la.EigenVector_init, None, EigenVector)
EigenVector.get_local = new_instancemethod(_la.EigenVector_get_local, None, EigenVector)
EigenVector.set_local = new_instancemethod(_la.EigenVector_set_local, None, EigenVector)
EigenVector.add_local = new_instancemethod(_la.EigenVector_add_local, None, EigenVector)
EigenVector.gather = new_instancemethod(_la.EigenVector_gather, None, EigenVector)
EigenVector.sum = new_instancemethod(_la.EigenVector_sum, None, EigenVector)
EigenVector.resize = new_instancemethod(_la.EigenVector_resize, None, EigenVector)
EigenVector.vec = new_instancemethod(_la.EigenVector_vec, None, EigenVector)
EigenVector._assign = new_instancemethod(_la.EigenVector__assign, None, EigenVector)
EigenVector._data = new_instancemethod(_la.EigenVector__data, None, EigenVector)
EigenVector_swigregister = _la.EigenVector_swigregister
EigenVector_swigregister(EigenVector)
class PETScVector(GenericVector, PETScObject):
"""
This class provides a simple vector class based on PETSc.
It is a simple wrapper for a PETSc vector pointer (Vec)
implementing the GenericVector interface.
The interface is intentionally simple. For advanced usage,
access the PETSc Vec pointer using the function vec() and
use the standard PETSc interface.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* PETScVector\ ()
Create empty vector (on MPI_COMM_WORLD)
* PETScVector\ (comm)
Create empty vector on an MPI communicator
* PETScVector\ (comm, N)
Create vector of size N
* PETScVector\ (sparsity_pattern)
Create vector
* PETScVector\ (x)
Copy constructor
* PETScVector\ (x)
Create vector wrapper of PETSc Vec pointer. The reference
counter of the Vec will be increased, and decreased upon
destruction of this object.
"""
_la.PETScVector_swiginit(self, _la.new_PETScVector(*args))
__swig_destroy__ = _la.delete_PETScVector
def init(self, *args):
"""
**Overloaded versions**
* init\ (tensor_layout)
Initialize zero tensor using sparsity pattern
FIXME: This needs to be implemented on backend side! Remove it!
* init\ (comm, N)
Initialize vector to global size N
* init\ (comm, range)
Initialize vector with given local ownership range
* init\ (comm, range, local_to_global_map, ghost_indices)
Initialise vector with given ownership range and with ghost
values
FIXME: Reimplement using init(const TensorLayout&) and deprecate
"""
return _la.PETScVector_init(self, *args)
def get_local(self, *args):
"""
**Overloaded versions**
* get_local\ (block, m, rows)
Get block of values using local indices
* get_local\ (values)
Get all values on local process
"""
return _la.PETScVector_get_local(self, *args)
def set_local(self, *args):
"""
**Overloaded versions**
* set_local\ (block, m, rows)
Set block of values using local indices
* set_local\ (values)
Set all values on local process
"""
return _la.PETScVector_set_local(self, *args)
def add_local(self, *args):
"""
**Overloaded versions**
* add_local\ (block, m, rows)
Add block of values using local indices
* add_local\ (values)
Add values to each entry on local process
"""
return _la.PETScVector_add_local(self, *args)
def gather(self, *args):
"""
**Overloaded versions**
* gather\ (y, indices)
Gather vector entries into a local vector
* gather\ (x, indices)
Gather entries into x
"""
return _la.PETScVector_gather(self, *args)
def sum(self, *args):
"""
**Overloaded versions**
* sum\ ()
Return sum of values of vector
* sum\ (rows)
Return sum of selected rows in vector
"""
return _la.PETScVector_sum(self, *args)
def set_options_prefix(self, options_prefix):
"""
Sets the prefix used by PETSc when searching the options
database
"""
return _la.PETScVector_set_options_prefix(self, options_prefix)
def get_options_prefix(self):
"""
Returns the prefix used by PETSc when searching the options
database
"""
return _la.PETScVector_get_options_prefix(self)
def set_from_options(self):
"""
Call PETSc function VecSetFromOptions on the underlying Vec
object
"""
return _la.PETScVector_set_from_options(self)
def _assign(self, *args):
"""
**Overloaded versions**
* operator=\ (x)
Assignment operator
* operator=\ (a)
Assignment operator
* operator=\ (x)
Assignment operator
"""
return _la.PETScVector__assign(self, *args)
def reset(self, vec):
"""
Switch underlying PETSc object. Intended for internal library
usage.
"""
return _la.PETScVector_reset(self, vec)
def vec(self):
"""Return petsc4py representation of PETSc Vec"""
return _la.PETScVector_vec(self)
PETScVector.init = new_instancemethod(_la.PETScVector_init, None, PETScVector)
PETScVector.get_local = new_instancemethod(_la.PETScVector_get_local, None, PETScVector)
PETScVector.set_local = new_instancemethod(_la.PETScVector_set_local, None, PETScVector)
PETScVector.add_local = new_instancemethod(_la.PETScVector_add_local, None, PETScVector)
PETScVector.gather = new_instancemethod(_la.PETScVector_gather, None, PETScVector)
PETScVector.sum = new_instancemethod(_la.PETScVector_sum, None, PETScVector)
PETScVector.update_ghost_values = new_instancemethod(_la.PETScVector_update_ghost_values, None, PETScVector)
PETScVector.set_options_prefix = new_instancemethod(_la.PETScVector_set_options_prefix, None, PETScVector)
PETScVector.get_options_prefix = new_instancemethod(_la.PETScVector_get_options_prefix, None, PETScVector)
PETScVector.set_from_options = new_instancemethod(_la.PETScVector_set_from_options, None, PETScVector)
PETScVector._assign = new_instancemethod(_la.PETScVector__assign, None, PETScVector)
PETScVector.reset = new_instancemethod(_la.PETScVector_reset, None, PETScVector)
PETScVector.vec = new_instancemethod(_la.PETScVector_vec, None, PETScVector)
PETScVector_swigregister = _la.PETScVector_swigregister
PETScVector_swigregister(PETScVector)
class TensorLayout(common.Variable):
"""
This class described the size and possibly the sparsity of a
(sparse) tensor. It is used by the linear algebra backends to
initialise tensors.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
Sparsity_SPARSE = _la.TensorLayout_Sparsity_SPARSE
Sparsity_DENSE = _la.TensorLayout_Sparsity_DENSE
Ghosts_GHOSTED = _la.TensorLayout_Ghosts_GHOSTED
Ghosts_UNGHOSTED = _la.TensorLayout_Ghosts_UNGHOSTED
def __init__(self, *args):
"""
**Overloaded versions**
* TensorLayout\ (primary_dim, sparsity_pattern)
Create empty tensor layout
* TensorLayout\ (mpi_comm, index_maps, primary_dim, sparsity_pattern, ghosted)
Create a tensor layout
"""
_la.TensorLayout_swiginit(self, _la.new_TensorLayout(*args))
def init(self, mpi_comm, index_maps, ghosted):
"""
Initialize tensor layout
"""
return _la.TensorLayout_init(self, mpi_comm, index_maps, ghosted)
def rank(self):
"""
Return rank
"""
return _la.TensorLayout_rank(self)
def size(self, i):
"""
Return global size for dimension i (size of tensor, includes
non-zeroes)
"""
return _la.TensorLayout_size(self, i)
def local_range(self, dim):
"""
Return local range for dimension dim
"""
return _la.TensorLayout_local_range(self, dim)
def sparsity_pattern(self, *args):
"""
**Overloaded versions**
* sparsity_pattern\ ()
Return sparsity pattern (possibly null)
* sparsity_pattern\ ()
Return sparsity pattern (possibly null), const version
"""
return _la.TensorLayout_sparsity_pattern(self, *args)
primary_dim = _swig_property(_la.TensorLayout_primary_dim_get)
def mpi_comm(self):
"""
Return MPI communicator
"""
return _la.TensorLayout_mpi_comm(self)
def index_map(self, i):
"""
Return IndexMap for dimension
"""
return _la.TensorLayout_index_map(self, i)
def is_ghosted(self):
"""
Require ghosts
"""
return _la.TensorLayout_is_ghosted(self)
__swig_destroy__ = _la.delete_TensorLayout
TensorLayout.init = new_instancemethod(_la.TensorLayout_init, None, TensorLayout)
TensorLayout.rank = new_instancemethod(_la.TensorLayout_rank, None, TensorLayout)
TensorLayout.size = new_instancemethod(_la.TensorLayout_size, None, TensorLayout)
TensorLayout.local_range = new_instancemethod(_la.TensorLayout_local_range, None, TensorLayout)
TensorLayout.sparsity_pattern = new_instancemethod(_la.TensorLayout_sparsity_pattern, None, TensorLayout)
TensorLayout.mpi_comm = new_instancemethod(_la.TensorLayout_mpi_comm, None, TensorLayout)
TensorLayout.index_map = new_instancemethod(_la.TensorLayout_index_map, None, TensorLayout)
TensorLayout.is_ghosted = new_instancemethod(_la.TensorLayout_is_ghosted, None, TensorLayout)
TensorLayout_swigregister = _la.TensorLayout_swigregister
TensorLayout_swigregister(TensorLayout)
class SparsityPattern(object):
"""
This class implements a sparsity pattern data structure. It is
used by most linear algebra backends.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
Type_sorted = _la.SparsityPattern_Type_sorted
Type_unsorted = _la.SparsityPattern_Type_unsorted
def __init__(self, *args):
"""
**Overloaded versions**
* SparsityPattern\ (primary_dim)
Create empty sparsity pattern
* SparsityPattern\ (mpi_comm, index_maps, primary_dim)
Create sparsity pattern for a generic tensor
"""
_la.SparsityPattern_swiginit(self, _la.new_SparsityPattern(*args))
def init(self, mpi_comm, index_maps):
"""
Initialize sparsity pattern for a generic tensor
"""
return _la.SparsityPattern_init(self, mpi_comm, index_maps)
def insert_global(self, *args):
"""
**Overloaded versions**
* insert_global\ (i, j)
Insert a global entry - will be fixed by apply()
* insert_global\ (entries)
Insert non-zero entries using global indices
"""
return _la.SparsityPattern_insert_global(self, *args)
def insert_local(self, entries):
"""
Insert non-zero entries using local (process-wise) indices
"""
return _la.SparsityPattern_insert_local(self, entries)
def insert_full_rows_local(self, rows):
"""
Insert full rows (or columns, according to primary dimension)
using local (process-wise) indices. This must be called before
any other sparse insertion occurs to avoid quadratic complexity
of dense rows insertion
"""
return _la.SparsityPattern_insert_full_rows_local(self, rows)
def rank(self):
"""
Return rank
"""
return _la.SparsityPattern_rank(self)
def primary_dim(self):
"""
Return primary dimension (e.g., 0=row partition, 1=column
partition)
"""
return _la.SparsityPattern_primary_dim(self)
def local_range(self, dim):
"""
Return local range for dimension dim
"""
return _la.SparsityPattern_local_range(self, dim)
def num_nonzeros(self):
"""
Return number of local nonzeros
"""
return _la.SparsityPattern_num_nonzeros(self)
def num_nonzeros_diagonal(self):
"""
Fill array with number of nonzeros for diagonal block in
local_range for dimension 0. For matrices, fill array with
number of nonzeros per local row for diagonal block
"""
return _la.SparsityPattern_num_nonzeros_diagonal(self)
def num_nonzeros_off_diagonal(self):
"""
Fill array with number of nonzeros for off-diagonal block in
local_range for dimension 0. For matrices, fill array with
number of nonzeros per local row for off-diagonal block. If
there is no off-diagonal pattern, the vector is resized to
zero-length
"""
return _la.SparsityPattern_num_nonzeros_off_diagonal(self)
def num_local_nonzeros(self):
"""
Fill vector with number of nonzeros in local_range for
dimension 0
"""
return _la.SparsityPattern_num_local_nonzeros(self)
def apply(self):
"""
Finalize sparsity pattern
"""
return _la.SparsityPattern_apply(self)
def str(self, verbose):
"""
Return informal string representation (pretty-print)
"""
return _la.SparsityPattern_str(self, verbose)
__swig_destroy__ = _la.delete_SparsityPattern
SparsityPattern.init = new_instancemethod(_la.SparsityPattern_init, None, SparsityPattern)
SparsityPattern.insert_global = new_instancemethod(_la.SparsityPattern_insert_global, None, SparsityPattern)
SparsityPattern.insert_local = new_instancemethod(_la.SparsityPattern_insert_local, None, SparsityPattern)
SparsityPattern.insert_full_rows_local = new_instancemethod(_la.SparsityPattern_insert_full_rows_local, None, SparsityPattern)
SparsityPattern.rank = new_instancemethod(_la.SparsityPattern_rank, None, SparsityPattern)
SparsityPattern.primary_dim = new_instancemethod(_la.SparsityPattern_primary_dim, None, SparsityPattern)
SparsityPattern.local_range = new_instancemethod(_la.SparsityPattern_local_range, None, SparsityPattern)
SparsityPattern.num_nonzeros = new_instancemethod(_la.SparsityPattern_num_nonzeros, None, SparsityPattern)
SparsityPattern.num_nonzeros_diagonal = new_instancemethod(_la.SparsityPattern_num_nonzeros_diagonal, None, SparsityPattern)
SparsityPattern.num_nonzeros_off_diagonal = new_instancemethod(_la.SparsityPattern_num_nonzeros_off_diagonal, None, SparsityPattern)
SparsityPattern.num_local_nonzeros = new_instancemethod(_la.SparsityPattern_num_local_nonzeros, None, SparsityPattern)
SparsityPattern.apply = new_instancemethod(_la.SparsityPattern_apply, None, SparsityPattern)
SparsityPattern.mpi_comm = new_instancemethod(_la.SparsityPattern_mpi_comm, None, SparsityPattern)
SparsityPattern.str = new_instancemethod(_la.SparsityPattern_str, None, SparsityPattern)
SparsityPattern_swigregister = _la.SparsityPattern_swigregister
SparsityPattern_swigregister(SparsityPattern)
class IndexMap(object):
"""
This class represents the distribution index arrays across
processes. An index array is a contiguous collection of N+1
indices [0, 1, . . ., N] that are distributed across processes M
processes. On a given process, the IndexMap stores a portion of
the index set using local indices [0, 1, . . . , n], and a map
from the local indices to a unique global index.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
MapSize_ALL = _la.IndexMap_MapSize_ALL
MapSize_OWNED = _la.IndexMap_MapSize_OWNED
MapSize_UNOWNED = _la.IndexMap_MapSize_UNOWNED
MapSize_GLOBAL = _la.IndexMap_MapSize_GLOBAL
def __init__(self, *args):
_la.IndexMap_swiginit(self, _la.new_IndexMap(*args))
__swig_destroy__ = _la.delete_IndexMap
IndexMap.init = new_instancemethod(_la.IndexMap_init, None, IndexMap)
IndexMap.local_range = new_instancemethod(_la.IndexMap_local_range, None, IndexMap)
IndexMap.size = new_instancemethod(_la.IndexMap_size, None, IndexMap)
IndexMap.local_to_global_unowned = new_instancemethod(_la.IndexMap_local_to_global_unowned, None, IndexMap)
IndexMap.local_to_global = new_instancemethod(_la.IndexMap_local_to_global, None, IndexMap)
IndexMap.set_local_to_global = new_instancemethod(_la.IndexMap_set_local_to_global, None, IndexMap)
IndexMap.off_process_owner = new_instancemethod(_la.IndexMap_off_process_owner, None, IndexMap)
IndexMap.block_size = new_instancemethod(_la.IndexMap_block_size, None, IndexMap)
IndexMap.mpi_comm = new_instancemethod(_la.IndexMap_mpi_comm, None, IndexMap)
IndexMap_swigregister = _la.IndexMap_swigregister
IndexMap_swigregister(IndexMap)
class GenericLinearAlgebraFactory(object):
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined - class is abstract")
__repr__ = _swig_repr
__swig_destroy__ = _la.delete_GenericLinearAlgebraFactory
def create_matrix(self, comm):
"""
Create empty matrix
"""
return _la.GenericLinearAlgebraFactory_create_matrix(self, comm)
def create_vector(self, comm):
"""
Create empty vector
"""
return _la.GenericLinearAlgebraFactory_create_vector(self, comm)
def create_layout(self, rank):
"""
Create empty tensor layout
"""
return _la.GenericLinearAlgebraFactory_create_layout(self, rank)
def create_linear_operator(self, comm):
"""
Create empty linear operator
"""
return _la.GenericLinearAlgebraFactory_create_linear_operator(self, comm)
def create_lu_solver(self, comm, method):
"""
Create LU solver
"""
return _la.GenericLinearAlgebraFactory_create_lu_solver(self, comm, method)
def create_krylov_solver(self, comm, method, preconditioner):
"""
Create Krylov solver
"""
return _la.GenericLinearAlgebraFactory_create_krylov_solver(self, comm, method, preconditioner)
def lu_solver_methods(self):
"""
Return a list of available LU solver methods. This function
should be overloaded by subclass if non-empty.
"""
return _la.GenericLinearAlgebraFactory_lu_solver_methods(self)
def krylov_solver_methods(self):
"""
Return a list of available Krylov solver methods. This
function should be overloaded by subclass if non-empty.
"""
return _la.GenericLinearAlgebraFactory_krylov_solver_methods(self)
def krylov_solver_preconditioners(self):
"""
Return a list of available preconditioners.
This function should be overloaded by subclass if non-empty.
"""
return _la.GenericLinearAlgebraFactory_krylov_solver_preconditioners(self)
GenericLinearAlgebraFactory.create_matrix = new_instancemethod(_la.GenericLinearAlgebraFactory_create_matrix, None, GenericLinearAlgebraFactory)
GenericLinearAlgebraFactory.create_vector = new_instancemethod(_la.GenericLinearAlgebraFactory_create_vector, None, GenericLinearAlgebraFactory)
GenericLinearAlgebraFactory.create_layout = new_instancemethod(_la.GenericLinearAlgebraFactory_create_layout, None, GenericLinearAlgebraFactory)
GenericLinearAlgebraFactory.create_linear_operator = new_instancemethod(_la.GenericLinearAlgebraFactory_create_linear_operator, None, GenericLinearAlgebraFactory)
GenericLinearAlgebraFactory.create_lu_solver = new_instancemethod(_la.GenericLinearAlgebraFactory_create_lu_solver, None, GenericLinearAlgebraFactory)
GenericLinearAlgebraFactory.create_krylov_solver = new_instancemethod(_la.GenericLinearAlgebraFactory_create_krylov_solver, None, GenericLinearAlgebraFactory)
GenericLinearAlgebraFactory.lu_solver_methods = new_instancemethod(_la.GenericLinearAlgebraFactory_lu_solver_methods, None, GenericLinearAlgebraFactory)
GenericLinearAlgebraFactory.krylov_solver_methods = new_instancemethod(_la.GenericLinearAlgebraFactory_krylov_solver_methods, None, GenericLinearAlgebraFactory)
GenericLinearAlgebraFactory.krylov_solver_preconditioners = new_instancemethod(_la.GenericLinearAlgebraFactory_krylov_solver_preconditioners, None, GenericLinearAlgebraFactory)
GenericLinearAlgebraFactory_swigregister = _la.GenericLinearAlgebraFactory_swigregister
GenericLinearAlgebraFactory_swigregister(GenericLinearAlgebraFactory)
class DefaultFactory(GenericLinearAlgebraFactory):
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self):
"""
Constructor
"""
_la.DefaultFactory_swiginit(self, _la.new_DefaultFactory())
__swig_destroy__ = _la.delete_DefaultFactory
def factory():
"""
Return instance of default backend
"""
return _la.DefaultFactory_factory()
factory = staticmethod(factory)
DefaultFactory_swigregister = _la.DefaultFactory_swigregister
DefaultFactory_swigregister(DefaultFactory)
def DefaultFactory_factory():
"""
Return instance of default backend
"""
return _la.DefaultFactory_factory()
class EigenFactory(GenericLinearAlgebraFactory):
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined")
__repr__ = _swig_repr
__swig_destroy__ = _la.delete_EigenFactory
def instance():
"""
Return singleton instance
"""
return _la.EigenFactory_instance()
instance = staticmethod(instance)
EigenFactory_swigregister = _la.EigenFactory_swigregister
EigenFactory_swigregister(EigenFactory)
def EigenFactory_instance():
"""
Return singleton instance
"""
return _la.EigenFactory_instance()
class PETScUserPreconditioner(PETScObject):
"""
This class specifies the interface for user-defined Krylov
method PETScPreconditioners. A user wishing to implement her own
PETScPreconditioner needs only supply a function that approximately
solves the linear system given a right-hand side.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self):
"""
Constructor
"""
if self.__class__ == PETScUserPreconditioner:
_self = None
else:
_self = self
_la.PETScUserPreconditioner_swiginit(self, _la.new_PETScUserPreconditioner(_self, ))
__swig_destroy__ = _la.delete_PETScUserPreconditioner
setup = staticmethod(_la.PETScUserPreconditioner_setup)
def solve(self, x, b):
"""
Solve linear system approximately for given right-hand side b
"""
return _la.PETScUserPreconditioner_solve(self, x, b)
def __disown__(self):
self.this.disown()
_la.disown_PETScUserPreconditioner(self)
return weakref_proxy(self)
PETScUserPreconditioner.solve = new_instancemethod(_la.PETScUserPreconditioner_solve, None, PETScUserPreconditioner)
PETScUserPreconditioner_swigregister = _la.PETScUserPreconditioner_swigregister
PETScUserPreconditioner_swigregister(PETScUserPreconditioner)
def PETScUserPreconditioner_setup(ksp, pc):
return _la.PETScUserPreconditioner_setup(ksp, pc)
PETScUserPreconditioner_setup = _la.PETScUserPreconditioner_setup
class PETScFactory(GenericLinearAlgebraFactory):
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
def __init__(self, *args, **kwargs):
raise AttributeError("No constructor defined")
__repr__ = _swig_repr
__swig_destroy__ = _la.delete_PETScFactory
def instance():
"""
Return singleton instance
"""
return _la.PETScFactory_instance()
instance = staticmethod(instance)
PETScFactory_swigregister = _la.PETScFactory_swigregister
PETScFactory_swigregister(PETScFactory)
def PETScFactory_instance():
"""
Return singleton instance
"""
return _la.PETScFactory_instance()
class SLEPcEigenSolver(common.Variable, PETScObject):
"""
This class provides an eigenvalue solver for PETSc matrices. It
is a wrapper for the SLEPc eigenvalue solver.
The following parameters may be specified to control the solver.
1. "spectrum"
This parameter controls which part of the spectrum to compute.
Possible values are
"largest magnitude" (eigenvalues with largest magnitude)
"smallest magnitude" (eigenvalues with smallest magnitude)
"largest real" (eigenvalues with largest double part)
"smallest real" (eigenvalues with smallest double part)
"largest imaginary" (eigenvalues with largest imaginary part)
"smallest imaginary" (eigenvalues with smallest imaginary part)
"target magnitude" (eigenvalues closest to target in magnitude)
"target real" (eigenvalues closest to target in real part)
"target imaginary" (eigenvalues closest to target in imaginary part)
2. "solver"
This parameter controls which algorithm is used by SLEPc.
Possible values are
"power" (power iteration)
"subspace" (subspace iteration)
"arnoldi" (Arnoldi)
"lanczos" (Lanczos)
"krylov-schur" (Krylov-Schur)
"lapack" (LAPACK, all values, direct, small systems only)
"arpack" (ARPACK)
3. "tolerance"
This parameter controls the tolerance used by SLEPc. Possible
values are positive double numbers.
4. "maximum_iterations"
This parameter controls the maximum number of iterations used by SLEPc.
Possible values are positive integers.
Note that both the tolerance and the number of iterations must be
specified if either one is specified.
5. "problem_type"
This parameter can be used to give extra information about the
type of the eigenvalue problem. Some solver types require this
extra piece of information. Possible values are:
"hermitian" (Hermitian)
"non_hermitian" (Non-Hermitian)
"gen_hermitian" (Generalized Hermitian)
"gen_non_hermitian" (Generalized Non-Hermitian)
"pos_gen_non_hermitian" (Generalized Non-Hermitian with positive semidefinite B)
6. "spectral_transform"
This parameter controls the application of a spectral
transform. A spectral transform can be used to enhance the
convergence of the eigensolver and in particular to only compute
eigenvalues in the interior of the spectrum. Possible values
are:
"shift-and-invert" (A shift-and-invert transform)
Note that if a spectral transform is given, then also a non-zero
spectral shift parameter has to be provided.
The default is no spectral transform.
7. "spectral_shift"
This parameter controls the spectral shift used by the spectral
transform and must be provided if a spectral transform is
given. The possible values are real numbers.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* SLEPcEigenSolver\ (comm)
Create eigenvalue solver
* SLEPcEigenSolver\ (eps)
Create eigenvalue solver from EPS object
* SLEPcEigenSolver\ (A)
Create eigenvalue solver for Ax = \lambda
* SLEPcEigenSolver\ (comm, A)
Create eigenvalue solver for Ax = \lambda x
* SLEPcEigenSolver\ (A, B)
Create eigenvalue solver for Ax = \lambda x on MPI_COMM_WORLD
* SLEPcEigenSolver\ (comm, A, B)
Create eigenvalue solver for Ax = \lambda x
"""
_la.SLEPcEigenSolver_swiginit(self, _la.new_SLEPcEigenSolver(*args))
__swig_destroy__ = _la.delete_SLEPcEigenSolver
def set_operators(self, A, B):
"""
Set opeartors (B may be nullptr for regular eigenvalues
problems)
"""
return _la.SLEPcEigenSolver_set_operators(self, A, B)
def solve(self, *args):
"""
**Overloaded versions**
* solve\ ()
Compute all eigenpairs of the matrix A (solve Ax = \lambda x)
* solve\ (n)
Compute the n first eigenpairs of the matrix A (solve Ax = \lambda x)
"""
return _la.SLEPcEigenSolver_solve(self, *args)
def get_iteration_number(self):
"""
Get the number of iterations used by the solver
"""
return _la.SLEPcEigenSolver_get_iteration_number(self)
def get_number_converged(self):
"""
Get the number of converged eigenvalues
"""
return _la.SLEPcEigenSolver_get_number_converged(self)
def set_deflation_space(self, deflation_space):
"""
Set deflation space
"""
return _la.SLEPcEigenSolver_set_deflation_space(self, deflation_space)
def set_options_prefix(self, options_prefix):
"""
Sets the prefix used by PETSc when searching the PETSc options
database
"""
return _la.SLEPcEigenSolver_set_options_prefix(self, options_prefix)
def get_options_prefix(self):
"""
Returns the prefix used by PETSc when searching the PETSc
options database
"""
return _la.SLEPcEigenSolver_get_options_prefix(self)
def default_parameters():
"""
Default parameter values
"""
return _la.SLEPcEigenSolver_default_parameters()
default_parameters = staticmethod(default_parameters)
def _get_eigenvalue(self, i):
"""Missing docstring"""
return _la.SLEPcEigenSolver__get_eigenvalue(self, i)
def _get_eigenpair(self, r, c, i):
"""Missing docstring"""
return _la.SLEPcEigenSolver__get_eigenpair(self, r, c, i)
def get_eigenpair(self, i = 0, r_vec = None, c_vec = None,):
"""Gets the i-th solution of the eigenproblem"""
r_vec = r_vec or PETScVector()
c_vec = c_vec or PETScVector()
lr, lc = self._get_eigenpair(r_vec, c_vec, i)
return lr, lc, r_vec, c_vec
def get_eigenvalue(self, i = 0):
"""Gets the i-th eigenvalue of the eigenproblem"""
return self._get_eigenvalue(i)
def eps(self):
"""Return slepc4py representation of SLEPc EPS"""
return _la.SLEPcEigenSolver_eps(self)
SLEPcEigenSolver.set_operators = new_instancemethod(_la.SLEPcEigenSolver_set_operators, None, SLEPcEigenSolver)
SLEPcEigenSolver.solve = new_instancemethod(_la.SLEPcEigenSolver_solve, None, SLEPcEigenSolver)
SLEPcEigenSolver.get_iteration_number = new_instancemethod(_la.SLEPcEigenSolver_get_iteration_number, None, SLEPcEigenSolver)
SLEPcEigenSolver.get_number_converged = new_instancemethod(_la.SLEPcEigenSolver_get_number_converged, None, SLEPcEigenSolver)
SLEPcEigenSolver.set_deflation_space = new_instancemethod(_la.SLEPcEigenSolver_set_deflation_space, None, SLEPcEigenSolver)
SLEPcEigenSolver.set_options_prefix = new_instancemethod(_la.SLEPcEigenSolver_set_options_prefix, None, SLEPcEigenSolver)
SLEPcEigenSolver.get_options_prefix = new_instancemethod(_la.SLEPcEigenSolver_get_options_prefix, None, SLEPcEigenSolver)
SLEPcEigenSolver._get_eigenvalue = new_instancemethod(_la.SLEPcEigenSolver__get_eigenvalue, None, SLEPcEigenSolver)
SLEPcEigenSolver._get_eigenpair = new_instancemethod(_la.SLEPcEigenSolver__get_eigenpair, None, SLEPcEigenSolver)
SLEPcEigenSolver.eps = new_instancemethod(_la.SLEPcEigenSolver_eps, None, SLEPcEigenSolver)
SLEPcEigenSolver_swigregister = _la.SLEPcEigenSolver_swigregister
SLEPcEigenSolver_swigregister(SLEPcEigenSolver)
def SLEPcEigenSolver_default_parameters():
"""
Default parameter values
"""
return _la.SLEPcEigenSolver_default_parameters()
class Vector(GenericVector):
"""
This class provides the default DOLFIN vector class,
based on the default DOLFIN linear algebra backend.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* Vector\ (comm=MPI_COMM_WORLD)
Create empty vector
* Vector\ (comm, N)
Create vector of size N
* Vector\ (x)
Copy constructor
* Vector\ (x)
Create a Vector from a GenericVector
"""
_la.Vector_swiginit(self, _la.new_Vector(*args))
def init(self, *args):
"""
**Overloaded versions**
* init\ (tensor_layout)
Initialize zero tensor using sparsity pattern
FIXME: This needs to be implemented on backend side! Remove it!
* init\ (comm, N)
Initialize vector to global size N
* init\ (comm, range)
Initialize vector with given local ownership range
* init\ (comm, range, local_to_global_map, ghost_indices)
Initialise vector with given ownership range and with ghost
values
FIXME: Reimplement using init(const TensorLayout&) and deprecate
"""
return _la.Vector_init(self, *args)
def get_local(self, *args):
"""
**Overloaded versions**
* get_local\ (block, m, rows)
Get block of values using local indices (values must all live
on the local process)
* get_local\ (values)
Get all values on local process
"""
return _la.Vector_get_local(self, *args)
def set_local(self, *args):
"""
**Overloaded versions**
* set_local\ (block, m, rows)
Set block of values using local indices
* set_local\ (values)
Set all values on local process
"""
return _la.Vector_set_local(self, *args)
def add_local(self, *args):
"""
**Overloaded versions**
* add_local\ (block, m, rows)
Add block of values using local indices
* add_local\ (values)
Add values to each entry on local process
"""
return _la.Vector_add_local(self, *args)
def gather(self, *args):
"""
**Overloaded versions**
* gather\ (x, indices)
Gather entries into local vector x
* gather\ (x, indices)
Gather entries into x
"""
return _la.Vector_gather(self, *args)
def sum(self, *args):
"""
Return sum of values of vector
"""
return _la.Vector_sum(self, *args)
def shared_instance(self, *args):
"""
**Overloaded versions**
* shared_instance\ ()
Return concrete shared ptr instance / unwrap (const version)
* shared_instance\ ()
Return concrete shared ptr instance / unwrap (non-const version)
"""
return _la.Vector_shared_instance(self, *args)
def _assign(self, *args):
"""
**Overloaded versions**
* operator=\ (x)
Assignment operator
* operator=\ (a)
Assignment operator
* operator=\ (x)
Assignment operator
"""
return _la.Vector__assign(self, *args)
__swig_destroy__ = _la.delete_Vector
Vector.init = new_instancemethod(_la.Vector_init, None, Vector)
Vector.get_local = new_instancemethod(_la.Vector_get_local, None, Vector)
Vector.set_local = new_instancemethod(_la.Vector_set_local, None, Vector)
Vector.add_local = new_instancemethod(_la.Vector_add_local, None, Vector)
Vector.gather = new_instancemethod(_la.Vector_gather, None, Vector)
Vector.sum = new_instancemethod(_la.Vector_sum, None, Vector)
Vector.shared_instance = new_instancemethod(_la.Vector_shared_instance, None, Vector)
Vector._assign = new_instancemethod(_la.Vector__assign, None, Vector)
Vector_swigregister = _la.Vector_swigregister
Vector_swigregister(Vector)
class Matrix(GenericMatrix):
"""
This class provides the default DOLFIN matrix class,
based on the default DOLFIN linear algebra backend.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* Matrix\ (comm=MPI_COMM_WORLD)
Create empty matrix
* Matrix\ (A)
Copy constructor
* Matrix\ (A)
Create a Vector from a GenericVector
"""
_la.Matrix_swiginit(self, _la.new_Matrix(*args))
__swig_destroy__ = _la.delete_Matrix
def zero(self, *args):
"""
**Overloaded versions**
* zero\ ()
Set all entries to zero and keep any sparse structure
* zero\ (m, rows)
Set given rows to zero
"""
return _la.Matrix_zero(self, *args)
def shared_instance(self, *args):
"""
**Overloaded versions**
* shared_instance\ ()
Return concrete shared ptr instance / unwrap (const version)
* shared_instance\ ()
Return concrete shared ptr instance / unwrap (non-const version)
"""
return _la.Matrix_shared_instance(self, *args)
def assign(self, *args):
"""
**Overloaded versions**
* operator=\ (A)
Assignment operator
* operator=\ (A)
Assignment operator
"""
return _la.Matrix_assign(self, *args)
Matrix.zero = new_instancemethod(_la.Matrix_zero, None, Matrix)
Matrix.shared_instance = new_instancemethod(_la.Matrix_shared_instance, None, Matrix)
Matrix.assign = new_instancemethod(_la.Matrix_assign, None, Matrix)
Matrix_swigregister = _la.Matrix_swigregister
Matrix_swigregister(Matrix)
class Scalar(GenericTensor):
"""
This class represents a real-valued scalar quantity and
implements the GenericTensor interface for scalars.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* Scalar\ ()
Create zero scalar
* Scalar\ (comm)
Create zero scalar
"""
_la.Scalar_swiginit(self, _la.new_Scalar(*args))
__swig_destroy__ = _la.delete_Scalar
def add_local(self, *args):
"""
**Overloaded versions**
* add_local\ (block, num_rows, rows)
Add block of values using local indices
* add_local\ (block, rows)
Add block of values using local indices
"""
return _la.Scalar_add_local(self, *args)
def copy(self):
"""
Return copy of scalar
"""
return _la.Scalar_copy(self)
def get_scalar_value(self):
"""
Get final value (assumes prior apply(), not part of
GenericTensor interface)
"""
return _la.Scalar_get_scalar_value(self)
def add_local_value(self, value):
"""
Add to local increment (added for testing, remove if we add a
better way from python)
"""
return _la.Scalar_add_local_value(self, value)
Scalar.add_local = new_instancemethod(_la.Scalar_add_local, None, Scalar)
Scalar.copy = new_instancemethod(_la.Scalar_copy, None, Scalar)
Scalar.get_scalar_value = new_instancemethod(_la.Scalar_get_scalar_value, None, Scalar)
Scalar.add_local_value = new_instancemethod(_la.Scalar_add_local_value, None, Scalar)
Scalar_swigregister = _la.Scalar_swigregister
Scalar_swigregister(Scalar)
class LinearSolver(GenericLinearSolver):
"""
This class provides a general solver for linear systems Ax = b.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* LinearSolver\ (method="default", preconditioner="default")
Create linear solver
* LinearSolver\ (comm, method="default", preconditioner="default")
Create linear solver
"""
_la.LinearSolver_swiginit(self, _la.new_LinearSolver(*args))
__swig_destroy__ = _la.delete_LinearSolver
def solve(self, *args):
"""
**Overloaded versions**
* solve\ (A, x, b)
Solve linear system Ax = b
* solve\ (x, b)
Solve linear system Ax = b
"""
return _la.LinearSolver_solve(self, *args)
def default_parameters():
"""
Default parameter values
"""
return _la.LinearSolver_default_parameters()
default_parameters = staticmethod(default_parameters)
LinearSolver.solve = new_instancemethod(_la.LinearSolver_solve, None, LinearSolver)
LinearSolver_swigregister = _la.LinearSolver_swigregister
LinearSolver_swigregister(LinearSolver)
def LinearSolver_default_parameters():
"""
Default parameter values
"""
return _la.LinearSolver_default_parameters()
class KrylovSolver(GenericLinearSolver):
"""
This class defines an interface for a Krylov solver. The
appropriate solver is chosen on the basis of the matrix/vector
type.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* KrylovSolver\ (comm, method="default", preconditioner="default")
Constructor
* KrylovSolver\ (method="default", preconditioner="default")
Constructor
* KrylovSolver\ (comm, A, method="default", preconditioner="default")
Constructor
* KrylovSolver\ (A, method="default", preconditioner="default")
Constructor
"""
_la.KrylovSolver_swiginit(self, _la.new_KrylovSolver(*args))
__swig_destroy__ = _la.delete_KrylovSolver
def solve(self, *args):
"""
**Overloaded versions**
* solve\ (x, b)
Solve linear system Ax = b
* solve\ (A, x, b)
Solve linear system Ax = b
"""
return _la.KrylovSolver_solve(self, *args)
def default_parameters():
"""
Default parameter values
"""
return _la.KrylovSolver_default_parameters()
default_parameters = staticmethod(default_parameters)
KrylovSolver.solve = new_instancemethod(_la.KrylovSolver_solve, None, KrylovSolver)
KrylovSolver_swigregister = _la.KrylovSolver_swigregister
KrylovSolver_swigregister(KrylovSolver)
def KrylovSolver_default_parameters():
"""
Default parameter values
"""
return _la.KrylovSolver_default_parameters()
class LUSolver(GenericLUSolver):
"""
LU solver for the built-in LA backends.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* LUSolver\ (comm, "default")
Constructor
* LUSolver\ ("default")
Constructor
* LUSolver\ (comm, A, method="default")
Constructor
* LUSolver\ (A, method="default")
Constructor
"""
_la.LUSolver_swiginit(self, _la.new_LUSolver(*args))
__swig_destroy__ = _la.delete_LUSolver
def solve(self, *args):
"""
**Overloaded versions**
* solve\ (x, b)
Solve linear system Ax = b
* solve\ (A, x, b)
Solve linear system
"""
return _la.LUSolver_solve(self, *args)
def solve_transpose(self, *args):
"""
**Overloaded versions**
* solve_transpose\ (x, b)
Solve linear system A^Tx = b
* solve_transpose\ (A, x, b)
Solve linear system
"""
return _la.LUSolver_solve_transpose(self, *args)
def default_parameters():
"""
Default parameter values
"""
return _la.LUSolver_default_parameters()
default_parameters = staticmethod(default_parameters)
LUSolver.solve = new_instancemethod(_la.LUSolver_solve, None, LUSolver)
LUSolver.solve_transpose = new_instancemethod(_la.LUSolver_solve_transpose, None, LUSolver)
LUSolver_swigregister = _la.LUSolver_swigregister
LUSolver_swigregister(LUSolver)
def LUSolver_default_parameters():
"""
Default parameter values
"""
return _la.LUSolver_default_parameters()
def la_solve(*args):
"""
Solve linear system Ax = b
"""
return _la.la_solve(*args)
def list_linear_algebra_backends():
"""
List available linear algebra backends
"""
return _la.list_linear_algebra_backends()
def list_linear_solver_methods():
"""
List available solver methods for current linear algebra backend
"""
return _la.list_linear_solver_methods()
def list_lu_solver_methods():
"""
List available LU methods for current linear algebra backend
"""
return _la.list_lu_solver_methods()
def list_krylov_solver_methods():
"""
List available Krylov methods for current linear algebra backend
"""
return _la.list_krylov_solver_methods()
def list_krylov_solver_preconditioners():
"""
List available preconditioners for current linear algebra
backend
"""
return _la.list_krylov_solver_preconditioners()
def has_linear_algebra_backend(backend):
return _la.has_linear_algebra_backend(backend)
has_linear_algebra_backend = _la.has_linear_algebra_backend
def has_lu_solver_method(method):
"""
Return true if LU method for the current linear algebra backend is
available
"""
return _la.has_lu_solver_method(method)
def has_krylov_solver_method(method):
"""
Return true if Krylov method for the current linear algebra
backend is available
"""
return _la.has_krylov_solver_method(method)
def has_krylov_solver_preconditioner(preconditioner):
"""
Return true if Preconditioner for the current linear algebra
backend is available
"""
return _la.has_krylov_solver_preconditioner(preconditioner)
def linear_algebra_backends():
"""
Return available linear algebra backends
"""
return _la.linear_algebra_backends()
def linear_solver_methods():
"""
Return a list of available solver methods for current linear
algebra backend
"""
return _la.linear_solver_methods()
def lu_solver_methods():
"""
Return a list of available LU methods for current linear algebra
backend
"""
return _la.lu_solver_methods()
def krylov_solver_methods():
"""
Return a list of available Krylov methods for current linear
algebra backend
"""
return _la.krylov_solver_methods()
def krylov_solver_preconditioners():
"""
Return a list of available preconditioners for current linear
algebra backend
"""
return _la.krylov_solver_preconditioners()
def residual(A, x, b):
"""
Compute residual ||Ax - b||
"""
return _la.residual(A, x, b)
def normalize(*args):
"""
Normalize vector according to given normalization type
"""
return _la.normalize(*args)
def in_nullspace(*args):
"""
Check whether a vector space basis is in the nullspace of a
given operator. The string option 'type' can be "right" for the
right nullspace (Ax=0) or "left" for the left nullspace (A^Tx =
0). To test the left nullspace, A must also be of type
GenericMatrix.
"""
return _la.in_nullspace(*args)
class BlockVector(object):
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, n=0):
"""
Constructor
"""
_la.BlockVector_swiginit(self, _la.new_BlockVector(n))
__swig_destroy__ = _la.delete_BlockVector
def copy(self):
"""
Return copy of tensor
"""
return _la.BlockVector_copy(self)
def set_block(self, i, v):
"""
Set function
"""
return _la.BlockVector_set_block(self, i, v)
def get_block(self, *args):
"""
**Overloaded versions**
* get_block\ (i)
Get sub-vector (const)
* get_block\ ()
Get sub-vector (non-const)
"""
return _la.BlockVector_get_block(self, *args)
def axpy(self, a, x):
"""
Add multiple of given vector (AXPY operation)
"""
return _la.BlockVector_axpy(self, a, x)
def inner(self, x):
"""
Return inner product with given vector
"""
return _la.BlockVector_inner(self, x)
def norm(self, norm_type):
"""
Return norm of vector
"""
return _la.BlockVector_norm(self, norm_type)
def min(self):
"""
Return minimum value of vector
"""
return _la.BlockVector_min(self)
def max(self):
"""
Return maximum value of vector
"""
return _la.BlockVector_max(self)
def __imul__(self, a):
"""
Multiply vector by given number
"""
return _la.BlockVector___imul__(self, a)
def __idiv__(self, a):
"""
Divide vector by given number
"""
return _la.BlockVector___idiv__(self, a)
def __iadd__(self, x):
"""
Add given vector
"""
return _la.BlockVector___iadd__(self, x)
def __isub__(self, x):
"""
Subtract given vector
"""
return _la.BlockVector___isub__(self, x)
def empty(self):
"""
Return true if empty
"""
return _la.BlockVector_empty(self)
def size(self):
"""
Number of vectors
"""
return _la.BlockVector_size(self)
def str(self, verbose):
"""
Return informal string representation (pretty-print)
"""
return _la.BlockVector_str(self, verbose)
def __getitem__(self, i):
return self.get_block(i)
def __setitem__(self, i, m):
if not hasattr(self, "_items"):
self._items = {}
self._items[i] = m
self.set_block(i, m)
def __add__(self, v):
a = self.copy()
a += v
return a
def __sub__(self, v):
a = self.copy()
a -= v
return a
def __mul__(self, v):
a = self.copy()
a *= v
return a
def __rmul__(self, v):
return self.__mul__(v)
BlockVector.copy = new_instancemethod(_la.BlockVector_copy, None, BlockVector)
BlockVector.set_block = new_instancemethod(_la.BlockVector_set_block, None, BlockVector)
BlockVector.get_block = new_instancemethod(_la.BlockVector_get_block, None, BlockVector)
BlockVector.axpy = new_instancemethod(_la.BlockVector_axpy, None, BlockVector)
BlockVector.inner = new_instancemethod(_la.BlockVector_inner, None, BlockVector)
BlockVector.norm = new_instancemethod(_la.BlockVector_norm, None, BlockVector)
BlockVector.min = new_instancemethod(_la.BlockVector_min, None, BlockVector)
BlockVector.max = new_instancemethod(_la.BlockVector_max, None, BlockVector)
BlockVector.__imul__ = new_instancemethod(_la.BlockVector___imul__, None, BlockVector)
BlockVector.__idiv__ = new_instancemethod(_la.BlockVector___idiv__, None, BlockVector)
BlockVector.__iadd__ = new_instancemethod(_la.BlockVector___iadd__, None, BlockVector)
BlockVector.__isub__ = new_instancemethod(_la.BlockVector___isub__, None, BlockVector)
BlockVector.empty = new_instancemethod(_la.BlockVector_empty, None, BlockVector)
BlockVector.size = new_instancemethod(_la.BlockVector_size, None, BlockVector)
BlockVector.str = new_instancemethod(_la.BlockVector_str, None, BlockVector)
BlockVector_swigregister = _la.BlockVector_swigregister
BlockVector_swigregister(BlockVector)
class BlockMatrix(object):
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, m=0, n=0):
_la.BlockMatrix_swiginit(self, _la.new_BlockMatrix(m, n))
__swig_destroy__ = _la.delete_BlockMatrix
def set_block(self, i, j, m):
"""
Set block
"""
return _la.BlockMatrix_set_block(self, i, j, m)
def get_block(self, *args):
"""
**Overloaded versions**
* get_block\ (i, j)
Get block (const version)
* get_block\ (i, j)
Get block
"""
return _la.BlockMatrix_get_block(self, *args)
def size(self, dim):
"""
Return size of given dimension
"""
return _la.BlockMatrix_size(self, dim)
def zero(self):
"""
Set all entries to zero and keep any sparse structure
"""
return _la.BlockMatrix_zero(self)
def apply(self, mode):
"""
Finalize assembly of tensor
"""
return _la.BlockMatrix_apply(self, mode)
def str(self, verbose):
"""
Return informal string representation (pretty-print)
"""
return _la.BlockMatrix_str(self, verbose)
def mult(self, x, y, transposed=False):
"""
Matrix-vector product, y = Ax
"""
return _la.BlockMatrix_mult(self, x, y, transposed)
def schur_approximation(self, symmetry=True):
"""
Create a crude explicit Schur approximation of S = D - C A^-1
B of (A B; C D) If symmetry != 0, then the caller promises
that B = symmetry * transpose(C).
"""
return _la.BlockMatrix_schur_approximation(self, symmetry)
def __mul__(self, other):
v = BlockVector(self.size(0))
self.mult(other, v)
return v
def __getitem__(self, t):
i,j = t
return self.get_block(i, j)
def __setitem__(self, t, m):
if not hasattr(self, "_items"):
self._items = {}
self._items[t] = m
i,j = t
self.set_block(i, j, m)
BlockMatrix.set_block = new_instancemethod(_la.BlockMatrix_set_block, None, BlockMatrix)
BlockMatrix.get_block = new_instancemethod(_la.BlockMatrix_get_block, None, BlockMatrix)
BlockMatrix.size = new_instancemethod(_la.BlockMatrix_size, None, BlockMatrix)
BlockMatrix.zero = new_instancemethod(_la.BlockMatrix_zero, None, BlockMatrix)
BlockMatrix.apply = new_instancemethod(_la.BlockMatrix_apply, None, BlockMatrix)
BlockMatrix.str = new_instancemethod(_la.BlockMatrix_str, None, BlockMatrix)
BlockMatrix.mult = new_instancemethod(_la.BlockMatrix_mult, None, BlockMatrix)
BlockMatrix.schur_approximation = new_instancemethod(_la.BlockMatrix_schur_approximation, None, BlockMatrix)
BlockMatrix_swigregister = _la.BlockMatrix_swigregister
BlockMatrix_swigregister(BlockMatrix)
class LinearOperator(GenericLinearOperator):
"""
This class defines an interface for linear operators defined
only in terms of their action (matrix-vector product) and can be
used for matrix-free solution of linear systems. The linear
algebra backend is decided at run-time based on the present
value of the "linear_algebra_backend" parameter.
To define a linear operator, users need to inherit from this
class and overload the function mult(x, y) which defines the
action of the matrix on the vector x as y = Ax.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
Create linear operator
"""
if self.__class__ == LinearOperator:
_self = None
else:
_self = self
_la.LinearOperator_swiginit(self, _la.new_LinearOperator(_self, *args))
__swig_destroy__ = _la.delete_LinearOperator
def size(self, dim):
"""
Return size of given dimension
"""
return _la.LinearOperator_size(self, dim)
def mult(self, x, y):
"""
Compute matrix-vector product y = Ax
"""
return _la.LinearOperator_mult(self, x, y)
def mpi_comm(self):
"""
Return the MPI communicator
"""
return _la.LinearOperator_mpi_comm(self)
def str(self, verbose):
"""
Return informal string representation (pretty-print)
"""
return _la.LinearOperator_str(self, verbose)
def shared_instance(self, *args):
"""
**Overloaded versions**
* shared_instance\ ()
Return concrete instance / unwrap (const shared pointer version)
* shared_instance\ ()
Return concrete instance / unwrap (shared pointer version)
"""
return _la.LinearOperator_shared_instance(self, *args)
def __disown__(self):
self.this.disown()
_la.disown_LinearOperator(self)
return weakref_proxy(self)
LinearOperator.size = new_instancemethod(_la.LinearOperator_size, None, LinearOperator)
LinearOperator.mult = new_instancemethod(_la.LinearOperator_mult, None, LinearOperator)
LinearOperator.mpi_comm = new_instancemethod(_la.LinearOperator_mpi_comm, None, LinearOperator)
LinearOperator.str = new_instancemethod(_la.LinearOperator_str, None, LinearOperator)
LinearOperator.shared_instance = new_instancemethod(_la.LinearOperator_shared_instance, None, LinearOperator)
LinearOperator.init_layout = new_instancemethod(_la.LinearOperator_init_layout, None, LinearOperator)
LinearOperator_swigregister = _la.LinearOperator_swigregister
LinearOperator_swigregister(LinearOperator)
def la_index_dtype():
"Return the numpy dtype equivalent to the type of la_index"
from numpy import intc, int64
return intc if common.sizeof_la_index() == 4 else int64
_has_type_map = {}
_as_backend_type_map = {}
# A map with matrix types as keys and list of possible vector types as values
_matrix_vector_mul_map = {}
def _has_type_EigenVector(tensor):
return _la._has_type_EigenVector(tensor)
_has_type_EigenVector = _la._has_type_EigenVector
def _as_backend_type_EigenVector(tensor):
return _la._as_backend_type_EigenVector(tensor)
_as_backend_type_EigenVector = _la._as_backend_type_EigenVector
_has_type_map[EigenVector] = _has_type_EigenVector
_as_backend_type_map[EigenVector] = _as_backend_type_EigenVector
def _has_type_EigenMatrix(tensor):
return _la._has_type_EigenMatrix(tensor)
_has_type_EigenMatrix = _la._has_type_EigenMatrix
def _as_backend_type_EigenMatrix(tensor):
return _la._as_backend_type_EigenMatrix(tensor)
_as_backend_type_EigenMatrix = _la._as_backend_type_EigenMatrix
_has_type_map[EigenMatrix] = _has_type_EigenMatrix
_as_backend_type_map[EigenMatrix] = _as_backend_type_EigenMatrix
_matrix_vector_mul_map[EigenMatrix] = [EigenVector]
def _has_type_PETScVector(tensor):
return _la._has_type_PETScVector(tensor)
_has_type_PETScVector = _la._has_type_PETScVector
def _as_backend_type_PETScVector(tensor):
return _la._as_backend_type_PETScVector(tensor)
_as_backend_type_PETScVector = _la._as_backend_type_PETScVector
_has_type_map[PETScVector] = _has_type_PETScVector
_as_backend_type_map[PETScVector] = _as_backend_type_PETScVector
def _has_type_PETScMatrix(tensor):
return _la._has_type_PETScMatrix(tensor)
_has_type_PETScMatrix = _la._has_type_PETScMatrix
def _as_backend_type_PETScMatrix(tensor):
return _la._as_backend_type_PETScMatrix(tensor)
_as_backend_type_PETScMatrix = _la._as_backend_type_PETScMatrix
_has_type_map[PETScMatrix] = _has_type_PETScMatrix
_as_backend_type_map[PETScMatrix] = _as_backend_type_PETScMatrix
def _has_type_PETScLinearOperator(tensor):
return _la._has_type_PETScLinearOperator(tensor)
_has_type_PETScLinearOperator = _la._has_type_PETScLinearOperator
def _as_backend_type_PETScLinearOperator(tensor):
return _la._as_backend_type_PETScLinearOperator(tensor)
_as_backend_type_PETScLinearOperator = _la._as_backend_type_PETScLinearOperator
_has_type_map[PETScLinearOperator] = _has_type_PETScLinearOperator
_as_backend_type_map[PETScLinearOperator] = _as_backend_type_PETScLinearOperator
_matrix_vector_mul_map[PETScMatrix] = [PETScVector]
_matrix_vector_mul_map[PETScLinearOperator] = [PETScVector]
def get_tensor_type(tensor):
"Return the concrete subclass of tensor."
for k, v in _has_type_map.items():
if v(tensor):
return k
common.dolfin_error("dolfin/swig/la/post.i",
"extract backend type for %s" % type(tensor).__name__,
"Unable to get tensor type in Python layer")
def has_type(tensor, subclass):
"Return wether tensor is of the given subclass."
global _has_type_map
assert _has_type_map
assert subclass in _has_type_map
return bool(_has_type_map[subclass](tensor))
def as_backend_type(tensor, subclass=None):
"Cast tensor to the given subclass, passing the wrong class is an error."
global _as_backend_type_map
assert _as_backend_type_map
if subclass is None:
subclass = get_tensor_type(tensor)
assert subclass in _as_backend_type_map
ret = _as_backend_type_map[subclass](tensor)
# Store the tensor to avoid garbage collection
ret._org_upcasted_tensor = tensor
return ret
class NonlinearProblem(object):
"""
This is a base class for nonlinear problems which can return the
nonlinear function F(u) and its Jacobian J = dF(u)/du.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self):
"""
Constructor
"""
if self.__class__ == NonlinearProblem:
_self = None
else:
_self = self
_la.NonlinearProblem_swiginit(self, _la.new_NonlinearProblem(_self, ))
__swig_destroy__ = _la.delete_NonlinearProblem
def form(self, A, b, x):
"""
Function called by Newton solver before requesting F or J.
This can be used to compute F and J together
"""
return _la.NonlinearProblem_form(self, A, b, x)
def F(self, b, x):
"""
Compute F at current point x
"""
return _la.NonlinearProblem_F(self, b, x)
def J(self, A, x):
"""
Compute J = F' at current point x
"""
return _la.NonlinearProblem_J(self, A, x)
def __disown__(self):
self.this.disown()
_la.disown_NonlinearProblem(self)
return weakref_proxy(self)
NonlinearProblem.form = new_instancemethod(_la.NonlinearProblem_form, None, NonlinearProblem)
NonlinearProblem.F = new_instancemethod(_la.NonlinearProblem_F, None, NonlinearProblem)
NonlinearProblem.J = new_instancemethod(_la.NonlinearProblem_J, None, NonlinearProblem)
NonlinearProblem_swigregister = _la.NonlinearProblem_swigregister
NonlinearProblem_swigregister(NonlinearProblem)
class NewtonSolver(common.Variable):
"""
This class defines a Newton solver for nonlinear systems of
equations of the form :math:`F(x) = 0`.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* NewtonSolver\ (comm=MPI_COMM_WORLD)
Create nonlinear solver
* NewtonSolver\ (comm, solver, factory)
Create nonlinear solver using provided linear solver
*Arguments*
comm (:py:class:`MPI`)
The MPI communicator.
solver (:py:class:`GenericLinearSolver`)
The linear solver.
factory (:py:class:`GenericLinearAlgebraFactory`)
The factory.
"""
if self.__class__ == NewtonSolver:
_self = None
else:
_self = self
_la.NewtonSolver_swiginit(self, _la.new_NewtonSolver(_self, *args))
__swig_destroy__ = _la.delete_NewtonSolver
def solve(self, nonlinear_function, x):
"""
Solve abstract nonlinear problem :math:`F(x) = 0` for given
:math:`F` and Jacobian :math:`\dfrac{\partial F}{\partial x}`.
*Arguments*
nonlinear_function (:py:class:`NonlinearProblem`)
The nonlinear problem.
x (:py:class:`GenericVector`)
The vector.
*Returns*
(int, bool)
Pair of number of Newton iterations, and whether
iteration converged)
"""
return _la.NewtonSolver_solve(self, nonlinear_function, x)
def iteration(self):
"""
Return Newton iteration number
*Returns*
int
The iteration number.
"""
return _la.NewtonSolver_iteration(self)
def residual(self):
"""
Return current residual
*Returns*
float
Current residual.
"""
return _la.NewtonSolver_residual(self)
def relative_residual(self):
"""
Return current relative residual
*Returns*
float
Current relative residual.
"""
return _la.NewtonSolver_relative_residual(self)
def linear_solver(self):
"""
Return the linear solver
*Returns*
:py:class:`GenericLinearSolver`
The linear solver.
"""
return _la.NewtonSolver_linear_solver(self)
def default_parameters():
"""
Default parameter values
*Returns*
:py:class:`Parameters`
Parameter values.
"""
return _la.NewtonSolver_default_parameters()
default_parameters = staticmethod(default_parameters)
def converged(self, r, nonlinear_problem, iteration):
"""
Convergence test. It may be overloaded using virtual inheritance and
this base criterion may be called from derived, both in C++ and Python.
*Arguments*
r (:py:class:`GenericVector`)
Residual for criterion evaluation.
nonlinear_problem (:py:class:`NonlinearProblem`)
The nonlinear problem.
iteration (int)
Newton iteration number.
*Returns*
bool
Whether convergence occured.
"""
return _la.NewtonSolver_converged(self, r, nonlinear_problem, iteration)
def __disown__(self):
self.this.disown()
_la.disown_NewtonSolver(self)
return weakref_proxy(self)
NewtonSolver.solve = new_instancemethod(_la.NewtonSolver_solve, None, NewtonSolver)
NewtonSolver.iteration = new_instancemethod(_la.NewtonSolver_iteration, None, NewtonSolver)
NewtonSolver.residual = new_instancemethod(_la.NewtonSolver_residual, None, NewtonSolver)
NewtonSolver.relative_residual = new_instancemethod(_la.NewtonSolver_relative_residual, None, NewtonSolver)
NewtonSolver.linear_solver = new_instancemethod(_la.NewtonSolver_linear_solver, None, NewtonSolver)
NewtonSolver.converged = new_instancemethod(_la.NewtonSolver_converged, None, NewtonSolver)
NewtonSolver_swigregister = _la.NewtonSolver_swigregister
NewtonSolver_swigregister(NewtonSolver)
def NewtonSolver_default_parameters():
"""
Default parameter values
*Returns*
:py:class:`Parameters`
Parameter values.
"""
return _la.NewtonSolver_default_parameters()
class OptimisationProblem(NonlinearProblem):
"""
This is a base class for nonlinear optimisation problems which
return the real-valued objective function :math:`f(x)`, its
gradient :math:`F(x) = f'(x)` and its Hessian :math:`J(x) =
f''(x)`
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self):
"""
Constructor
"""
if self.__class__ == OptimisationProblem:
_self = None
else:
_self = self
_la.OptimisationProblem_swiginit(self, _la.new_OptimisationProblem(_self, ))
__swig_destroy__ = _la.delete_OptimisationProblem
def f(self, x):
"""
Compute the objective function :math:`f(x)`
"""
return _la.OptimisationProblem_f(self, x)
def form(self, A, b, x):
"""
Compute the Hessian :math:`J(x)=f''(x)` and the gradient
:math:`F(x)=f'(x)`
"""
return _la.OptimisationProblem_form(self, A, b, x)
def F(self, b, x):
"""
Compute the gradient :math:`F(x) = f'(x)`
"""
return _la.OptimisationProblem_F(self, b, x)
def J(self, A, x):
"""
Compute the Hessian :math:`J(x) = f''(x)`
"""
return _la.OptimisationProblem_J(self, A, x)
def __disown__(self):
self.this.disown()
_la.disown_OptimisationProblem(self)
return weakref_proxy(self)
OptimisationProblem.f = new_instancemethod(_la.OptimisationProblem_f, None, OptimisationProblem)
OptimisationProblem.form = new_instancemethod(_la.OptimisationProblem_form, None, OptimisationProblem)
OptimisationProblem.F = new_instancemethod(_la.OptimisationProblem_F, None, OptimisationProblem)
OptimisationProblem.J = new_instancemethod(_la.OptimisationProblem_J, None, OptimisationProblem)
OptimisationProblem_swigregister = _la.OptimisationProblem_swigregister
OptimisationProblem_swigregister(OptimisationProblem)
class PETScSNESSolver(PETScObject):
"""
This class implements methods for solving nonlinear systems via
PETSc's SNES interface. It includes line search and trust region
techniques for globalising the convergence of the nonlinear
iteration.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* PETScSNESSolver\ (comm)
Create SNES solver
* PETScSNESSolver\ (nls_type="default")
Create SNES solver for a particular method
"""
_la.PETScSNESSolver_swiginit(self, _la.new_PETScSNESSolver(*args))
__swig_destroy__ = _la.delete_PETScSNESSolver
def solve(self, *args):
"""
**Overloaded versions**
* solve\ (nonlinear_problem, x, lb, ub)
Solve a nonlinear variational inequality with bound constraints
*Arguments*
nonlinear_function (:py:class:`NonlinearProblem`)
The nonlinear problem.
x (:py:class:`GenericVector`)
The vector.
lb (:py:class:`GenericVector`)
The lower bound.
ub (:py:class:`GenericVector`)
The upper bound.
*Returns*
(int, bool)
Pair of number of Newton iterations, and whether
iteration converged)
* solve\ (nonlinear_function, x)
Solve abstract nonlinear problem :math:`F(x) = 0` for given
:math:`F` and Jacobian :math:`\dfrac{\partial F}{\partial x}`.
*Arguments*
nonlinear_function (:py:class:`NonlinearProblem`)
The nonlinear problem.
x (:py:class:`GenericVector`)
The vector.
*Returns*
(int, bool)
Pair of number of Newton iterations, and whether
iteration converged)
"""
return _la.PETScSNESSolver_solve(self, *args)
def init(self, nonlinear_problem, x):
"""
Set up the SNES object, but don't do anything yet, in case the
user wants to access the SNES object directly
"""
return _la.PETScSNESSolver_init(self, nonlinear_problem, x)
def set_from_options(self):
"""
Set options from the PETSc options database
"""
return _la.PETScSNESSolver_set_from_options(self)
def set_options_prefix(self, options_prefix):
"""
Sets the prefix used by PETSc when searching the PETSc options
database
"""
return _la.PETScSNESSolver_set_options_prefix(self, options_prefix)
def get_options_prefix(self):
"""
Returns the prefix used by PETSc when searching the PETSc
options database
"""
return _la.PETScSNESSolver_get_options_prefix(self)
def mpi_comm(self):
"""
Return the MPI communicator
"""
return _la.PETScSNESSolver_mpi_comm(self)
def methods():
"""
Return a list of available solver methods
"""
return _la.PETScSNESSolver_methods()
methods = staticmethod(methods)
def default_parameters():
"""
Default parameter values
"""
return _la.PETScSNESSolver_default_parameters()
default_parameters = staticmethod(default_parameters)
parameters = _swig_property(_la.PETScSNESSolver_parameters_get, _la.PETScSNESSolver_parameters_set)
def snes(self):
"""Return petsc4py representation of PETSc SNES solver"""
return _la.PETScSNESSolver_snes(self)
PETScSNESSolver.solve = new_instancemethod(_la.PETScSNESSolver_solve, None, PETScSNESSolver)
PETScSNESSolver.init = new_instancemethod(_la.PETScSNESSolver_init, None, PETScSNESSolver)
PETScSNESSolver.set_from_options = new_instancemethod(_la.PETScSNESSolver_set_from_options, None, PETScSNESSolver)
PETScSNESSolver.set_options_prefix = new_instancemethod(_la.PETScSNESSolver_set_options_prefix, None, PETScSNESSolver)
PETScSNESSolver.get_options_prefix = new_instancemethod(_la.PETScSNESSolver_get_options_prefix, None, PETScSNESSolver)
PETScSNESSolver.mpi_comm = new_instancemethod(_la.PETScSNESSolver_mpi_comm, None, PETScSNESSolver)
PETScSNESSolver.snes = new_instancemethod(_la.PETScSNESSolver_snes, None, PETScSNESSolver)
PETScSNESSolver_swigregister = _la.PETScSNESSolver_swigregister
PETScSNESSolver_swigregister(PETScSNESSolver)
def PETScSNESSolver_methods():
"""
Return a list of available solver methods
"""
return _la.PETScSNESSolver_methods()
def PETScSNESSolver_default_parameters():
"""
Default parameter values
"""
return _la.PETScSNESSolver_default_parameters()
class PETScTAOSolver(PETScObject):
"""
This class implements methods for solving nonlinear optimisation
problems via PETSc TAO solver. It supports unconstrained as well
as bound-constrained minimisation problem
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* PETScTAOSolver\ (comm)
Create TAO solver
* PETScTAOSolver\ (tao_type="default", ksp_type="default", pc_type="default")
Create TAO solver for a particular method
"""
_la.PETScTAOSolver_swiginit(self, _la.new_PETScTAOSolver(*args))
__swig_destroy__ = _la.delete_PETScTAOSolver
def solve(self, *args):
"""
**Overloaded versions**
* solve\ (optimisation_problem, x, lb, ub)
Solve a nonlinear bound-constrained optimisation problem
*Arguments*
optimisation_problem (:py:class:`OptimisationProblem`)
The nonlinear optimisation problem.
x (:py:class:`GenericVector`)
The solution vector (initial guess).
lb (:py:class:`GenericVector`)
The lower bound.
ub (:py:class:`GenericVector`)
The upper bound.
*Returns*
(int, bool)
Pair of number of iterations, and whether
iteration converged
* solve\ (optimisation_problem, x)
Solve a nonlinear unconstrained minimisation problem
*Arguments*
optimisation_problem (:py:class:`OptimisationProblem`)
The nonlinear optimisation problem.
x (:py:class:`GenericVector`)
The solution vector (initial guess).
*Returns*
(int, bool)
Pair of number of iterations, and whether
iteration converged
* solve\ (optimisation_problem, x, lb, ub)
Solve a nonlinear bound-constrained minimisation problem
*Arguments*
optimisation_problem (:py:class:`OptimisationProblem`)
The nonlinear optimisation problem.
x (:py:class:`PETScVector`)
The solution vector (initial guess).
lb (:py:class:`PETScVector`)
The lower bound.
ub (:py:class:`PETScVector`)
The upper bound.
*Returns*
(int, bool)
Pair of number of iterations, and whether
iteration converged
"""
return _la.PETScTAOSolver_solve(self, *args)
def methods():
"""
Return a list of available solver methods
"""
return _la.PETScTAOSolver_methods()
methods = staticmethod(methods)
def default_parameters():
"""
Default parameter values
"""
return _la.PETScTAOSolver_default_parameters()
default_parameters = staticmethod(default_parameters)
parameters = _swig_property(_la.PETScTAOSolver_parameters_get, _la.PETScTAOSolver_parameters_set)
def init(self, *args):
"""
**Overloaded versions**
* init\ (optimisation_problem, x, lb, ub)
Initialise the TAO solver for a bound-constrained minimisation
problem, in case the user wants to access the TAO object
directly
* init\ (optimisation_problem, x)
Initialise the TAO solver for an unconstrained minimisation
problem, in case the user wants to access the TAO object
directly
"""
return _la.PETScTAOSolver_init(self, *args)
def tao(self):
"""Return petsc4py representation of PETSc TAO solver"""
return _la.PETScTAOSolver_tao(self)
PETScTAOSolver.solve = new_instancemethod(_la.PETScTAOSolver_solve, None, PETScTAOSolver)
PETScTAOSolver.init = new_instancemethod(_la.PETScTAOSolver_init, None, PETScTAOSolver)
PETScTAOSolver.tao = new_instancemethod(_la.PETScTAOSolver_tao, None, PETScTAOSolver)
PETScTAOSolver_swigregister = _la.PETScTAOSolver_swigregister
PETScTAOSolver_swigregister(PETScTAOSolver)
def PETScTAOSolver_methods():
"""
Return a list of available solver methods
"""
return _la.PETScTAOSolver_methods()
def PETScTAOSolver_default_parameters():
"""
Default parameter values
"""
return _la.PETScTAOSolver_default_parameters()
class TAOLinearBoundSolver(common.Variable, PETScObject):
"""
This class provides a bound constrained solver for a
linear variational inequality defined by a matrix A and a vector b.
It solves the problem:
Find :math:`x_l\leq x\leq x_u` such that
:math:`(Ax-b)\cdot (y-x)\geq 0,\; orall x_l\leq y\leq x_u`
It is a wrapper for the TAO bound constrained solver.
*Example*
.. note::
No example code available for this function.
"""
thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
def __init__(self, *args):
"""
**Overloaded versions**
* TAOLinearBoundSolver\ (comm)
Create TAO bound constrained solver
* TAOLinearBoundSolver\ ("default", "default", "default")
Create TAO bound constrained solver
"""
_la.TAOLinearBoundSolver_swiginit(self, _la.new_TAOLinearBoundSolver(*args))
__swig_destroy__ = _la.delete_TAOLinearBoundSolver
def solve(self, *args):
"""
**Overloaded versions**
* solve\ (A, x, b, xl, xu)
Solve the linear variational inequality defined by A and b
with xl =< x <= xu
* solve\ (A, x, b, xl, xu)
Solve the linear variational inequality defined by A and b
with xl =< x <= xu
"""
return _la.TAOLinearBoundSolver_solve(self, *args)
def set_ksp(self, *args):
"""
Set PETSC Krylov Solver (ksp) used by TAO
"""
return _la.TAOLinearBoundSolver_set_ksp(self, *args)
def methods():
"""
Return a list of available Tao solver methods
"""
return _la.TAOLinearBoundSolver_methods()
methods = staticmethod(methods)
def krylov_solvers():
"""
Return a list of available krylov solvers
"""
return _la.TAOLinearBoundSolver_krylov_solvers()
krylov_solvers = staticmethod(krylov_solvers)
def preconditioners():
"""
Return a list of available preconditioners
"""
return _la.TAOLinearBoundSolver_preconditioners()
preconditioners = staticmethod(preconditioners)
def default_parameters():
"""
Default parameter values
"""
return _la.TAOLinearBoundSolver_default_parameters()
default_parameters = staticmethod(default_parameters)
TAOLinearBoundSolver.solve = new_instancemethod(_la.TAOLinearBoundSolver_solve, None, TAOLinearBoundSolver)
TAOLinearBoundSolver.set_solver = new_instancemethod(_la.TAOLinearBoundSolver_set_solver, None, TAOLinearBoundSolver)
TAOLinearBoundSolver.set_ksp = new_instancemethod(_la.TAOLinearBoundSolver_set_ksp, None, TAOLinearBoundSolver)
TAOLinearBoundSolver.tao = new_instancemethod(_la.TAOLinearBoundSolver_tao, None, TAOLinearBoundSolver)
TAOLinearBoundSolver.get_matrix = new_instancemethod(_la.TAOLinearBoundSolver_get_matrix, None, TAOLinearBoundSolver)
TAOLinearBoundSolver.get_vector = new_instancemethod(_la.TAOLinearBoundSolver_get_vector, None, TAOLinearBoundSolver)
TAOLinearBoundSolver_swigregister = _la.TAOLinearBoundSolver_swigregister
TAOLinearBoundSolver_swigregister(TAOLinearBoundSolver)
def TAOLinearBoundSolver_methods():
"""
Return a list of available Tao solver methods
"""
return _la.TAOLinearBoundSolver_methods()
def TAOLinearBoundSolver_krylov_solvers():
"""
Return a list of available krylov solvers
"""
return _la.TAOLinearBoundSolver_krylov_solvers()
def TAOLinearBoundSolver_preconditioners():
"""
Return a list of available preconditioners
"""
return _la.TAOLinearBoundSolver_preconditioners()
def TAOLinearBoundSolver_default_parameters():
"""
Default parameter values
"""
return _la.TAOLinearBoundSolver_default_parameters()
|