/usr/lib/petscdir/3.1/include/petscsys.h is in libpetsc3.1-dev 3.1.dfsg-11ubuntu1.
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 | /*
This is the main PETSc include file (for C and C++). It is included by all
other PETSc include files, so it almost never has to be specifically included.
*/
#if !defined(__PETSCSYS_H)
#define __PETSCSYS_H
/* ========================================================================== */
/*
petscconf.h is contained in ${PETSC_ARCH}/include/petscconf.h it is
found automatically by the compiler due to the -I${PETSC_DIR}/${PETSC_ARCH}/include
in the conf/variables definition of PETSC_INCLUDE
*/
#include "petscconf.h"
#include "petscfix.h"
/* ========================================================================== */
/*
This facilitates using C version of PETSc from C++ and
C++ version from C. Use --with-c-support --with-clanguage=c++ with config/configure.py for the latter)
*/
#if defined(PETSC_CLANGUAGE_CXX) && !defined(PETSC_USE_EXTERN_CXX) && !defined(__cplusplus)
#error "PETSc configured with --with-clanguage=c++ and NOT --with-c-support - it can be used only with a C++ compiler"
#endif
#if defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus)
#define PETSC_EXTERN_CXX_BEGIN extern "C" {
#define PETSC_EXTERN_CXX_END }
#else
#define PETSC_EXTERN_CXX_BEGIN
#define PETSC_EXTERN_CXX_END
#endif
/* ========================================================================== */
/*
Current PETSc version number and release date. Also listed in
Web page
src/docs/tex/manual/intro.tex,
src/docs/tex/manual/manual.tex.
src/docs/website/index.html.
*/
#include "petscversion.h"
#define PETSC_AUTHOR_INFO "\
The PETSc Team\n\
petsc-maint@mcs.anl.gov\n\
http://www.mcs.anl.gov/petsc/\n"
#if (PETSC_VERSION_RELEASE == 1)
#define PetscGetVersion(version,len) (PetscSNPrintf(version,len,"Petsc Release Version %d.%d.%d, Patch %d, ", \
PETSC_VERSION_MAJOR,PETSC_VERSION_MINOR, PETSC_VERSION_SUBMINOR, \
PETSC_VERSION_PATCH),PetscStrcat(version,PETSC_VERSION_PATCH_DATE))
#else
#define PetscGetVersion(version,len) (PetscSNPrintf(version,len,"Petsc Development"), \
PetscStrcat(version," HG revision: "),PetscStrcat(version,PETSC_VERSION_HG), \
PetscStrcat(version," HG Date: "),PetscStrcat(version,PETSC_VERSION_DATE_HG))
#endif
/*MC
PetscGetVersion - Gets the PETSc version information in a string.
Input Parameter:
. len - length of the string
Output Parameter:
. version - version string
Level: developer
Usage:
char version[256];
ierr = PetscGetVersion(version,256);CHKERRQ(ierr)
Fortran Note:
This routine is not supported in Fortran.
.seealso: PetscGetProgramName()
M*/
/* ========================================================================== */
/*
Currently cannot check formatting for PETSc print statements because we have our
own format %D and %G
*/
#undef PETSC_PRINTF_FORMAT_CHECK
#define PETSC_PRINTF_FORMAT_CHECK(a,b)
#undef PETSC_FPRINTF_FORMAT_CHECK
#define PETSC_FPRINTF_FORMAT_CHECK(a,b)
/*
Fixes for config/configure.py time choices which impact our interface. Currently only
calling conventions and extra compiler checking falls under this category.
*/
#if !defined(PETSC_STDCALL)
#define PETSC_STDCALL
#endif
#if !defined(PETSC_TEMPLATE)
#define PETSC_TEMPLATE
#endif
#if !defined(PETSC_HAVE_DLL_EXPORT)
#define PETSC_DLL_EXPORT
#define PETSC_DLL_IMPORT
#endif
#if !defined(PETSC_DLLEXPORT)
#define PETSC_DLLEXPORT
#endif
#if !defined(PETSCVEC_DLLEXPORT)
#define PETSCVEC_DLLEXPORT
#endif
#if !defined(PETSCMAT_DLLEXPORT)
#define PETSCMAT_DLLEXPORT
#endif
#if !defined(PETSCDM_DLLEXPORT)
#define PETSCDM_DLLEXPORT
#endif
#if !defined(PETSCKSP_DLLEXPORT)
#define PETSCKSP_DLLEXPORT
#endif
#if !defined(PETSCSNES_DLLEXPORT)
#define PETSCSNES_DLLEXPORT
#endif
#if !defined(PETSCTS_DLLEXPORT)
#define PETSCTS_DLLEXPORT
#endif
#if !defined(PETSCFORTRAN_DLLEXPORT)
#define PETSCFORTRAN_DLLEXPORT
#endif
/* ========================================================================== */
/*
Defines the interface to MPI allowing the use of all MPI functions.
PETSc does not use the C++ binding of MPI at ALL. The following flag
makes sure the C++ bindings are not included. The C++ bindings REQUIRE
putting mpi.h before ANY C++ include files, we cannot control this
with all PETSc users. Users who want to use the MPI C++ bindings can include
mpicxx.h directly in their code
*/
#define MPICH_SKIP_MPICXX 1
#define OMPI_SKIP_MPICXX 1
#include "mpi.h"
/*
Yuck, we need to put stdio.h AFTER mpi.h for MPICH2 with C++ compiler
see the top of mpicxx.h in the MPICH2 distribution.
The MPI STANDARD HAS TO BE CHANGED to prevent this nonsense.
*/
#include <stdio.h>
/* MSMPI on 32bit windows requires this yukky hack - that breaks MPI standard compliance */
#if !defined(MPIAPI)
#define MPIAPI
#endif
/*MC
PetscErrorCode - datatype used for return error code from all PETSc functions
Level: beginner
.seealso: CHKERRQ, SETERRQ
M*/
typedef int PetscErrorCode;
/*MC
PetscCookie - A unique id used to identify each PETSc object.
(internal integer in the data structure used for error
checking). These are all defined by an offset from the lowest
one, PETSC_SMALLEST_COOKIE.
Level: advanced
.seealso: PetscCookieRegister(), PetscLogEventRegister(), PetscHeaderCreate()
M*/
typedef int PetscCookie;
/*MC
PetscLogEvent - id used to identify PETSc or user events - primarily for logging
Level: intermediate
.seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStage
M*/
typedef int PetscLogEvent;
/*MC
PetscLogStage - id used to identify user stages of runs - for logging
Level: intermediate
.seealso: PetscLogStageRegister(), PetscLogStageBegin(), PetscLogStageEnd(), PetscLogEvent
M*/
typedef int PetscLogStage;
/*MC
PetscBLASInt - datatype used to represent 'int' parameters to BLAS/LAPACK functions.
Level: intermediate
Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but
standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt
.seealso: PetscMPIInt, PetscInt
M*/
typedef int PetscBLASInt;
/*MC
PetscMPIInt - datatype used to represent 'int' parameters to MPI functions.
Level: intermediate
Notes: usually this is the same as PetscInt, but if PETSc was built with --with-64-bit-indices but
standard C/Fortran integers are 32 bit then this is NOT the same as PetscInt
PetscBLASIntCheck(a) checks if the given PetscInt a will fit in a PetscBLASInt, if not it generates a
PETSC_ERR_ARG_OUTOFRANGE.
PetscBLASInt b = PetscBLASIntCast(a) checks if the given PetscInt a will fit in a PetscBLASInt, if not it
generates a PETSC_ERR_ARG_OUTOFRANGE
.seealso: PetscBLASInt, PetscInt
M*/
typedef int PetscMPIInt;
/*MC
PetscEnum - datatype used to pass enum types within PETSc functions.
Level: intermediate
PetscMPIIntCheck(a) checks if the given PetscInt a will fit in a PetscMPIInt, if not it generates a
PETSC_ERR_ARG_OUTOFRANGE.
PetscMPIInt b = PetscMPIIntCast(a) checks if the given PetscInt a will fit in a PetscMPIInt, if not it
generates a PETSC_ERR_ARG_OUTOFRANGE
.seealso: PetscOptionsGetEnum(), PetscOptionsEnum(), PetscBagRegisterEnum()
M*/
typedef enum { ENUM_DUMMY } PetscEnum;
/*MC
PetscInt - PETSc type that represents integer - used primarily to
represent size of objects. Its size can be configured with the option
--with-64-bit-indices - to be either 32bit or 64bit [default 32 bit ints]
Level: intermediate
.seealso: PetscScalar, PetscBLASInt, PetscMPIInt
M*/
#if defined(PETSC_USE_64BIT_INDICES)
typedef long long PetscInt;
#define MPIU_INT MPI_LONG_LONG_INT
#else
typedef int PetscInt;
#define MPIU_INT MPI_INT
#endif
/* add in MPIU type for size_t */
#if (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_INT)
#define MPIU_SIZE_T MPI_INT
#elif (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG)
#define MPIU_SIZE_T MPI_LONG
#elif (PETSC_SIZEOF_SIZE_T) == (PETSC_SIZEOF_LONG_LONG)
#define MPIU_SIZE_T MPI_LONG_LONG_INT
#else
#error "Unknown size for size_t! Send us a bugreport at petsc-maint@mcs.anl.gov"
#endif
/*
You can use PETSC_STDOUT as a replacement of stdout. You can also change
the value of PETSC_STDOUT to redirect all standard output elsewhere
*/
extern FILE* PETSC_STDOUT;
/*
You can use PETSC_STDERR as a replacement of stderr. You can also change
the value of PETSC_STDERR to redirect all standard error elsewhere
*/
extern FILE* PETSC_STDERR;
/*
PETSC_ZOPEFD is used to send data to the PETSc webpage. It can be used
in conjunction with PETSC_STDOUT, or by itself.
*/
extern FILE* PETSC_ZOPEFD;
#if !defined(PETSC_USE_EXTERN_CXX) && defined(__cplusplus)
/*MC
PetscPolymorphicSubroutine - allows defining a C++ polymorphic version of
a PETSc function that remove certain optional arguments for a simplier user interface
Synopsis:
PetscPolymorphicSubroutine(Functionname,(arguments of C++ function),(arguments of C function))
Not collective
Level: developer
Example:
PetscPolymorphicSubroutine(VecNorm,(Vec x,PetscReal *r),(x,NORM_2,r)) generates the new routine
PetscErrorCode VecNorm(Vec x,PetscReal *r) = VecNorm(x,NORM_2,r)
.seealso: PetscPolymorphicFunction()
M*/
#define PetscPolymorphicSubroutine(A,B,C) PETSC_STATIC_INLINE PetscErrorCode A B {return A C;}
/*MC
PetscPolymorphicScalar - allows defining a C++ polymorphic version of
a PETSc function that replaces a PetscScalar * argument with a PetscScalar argument
Synopsis:
PetscPolymorphicScalar(Functionname,(arguments of C++ function),(arguments of C function))
Not collective
Level: developer
Example:
PetscPolymorphicScalar(VecAXPY,(PetscScalar _val,Vec x,Vec y),(&_Val,x,y)) generates the new routine
PetscErrorCode VecAXPY(PetscScalar _val,Vec x,Vec y) = {PetscScalar _Val = _val; return VecAXPY(&_Val,x,y);}
.seealso: PetscPolymorphicFunction(),PetscPolymorphicSubroutine()
M*/
#define PetscPolymorphicScalar(A,B,C) PETSC_STATIC_INLINE PetscErrorCode A B {PetscScalar _Val = _val; return A C;}
/*MC
PetscPolymorphicFunction - allows defining a C++ polymorphic version of
a PETSc function that remove certain optional arguments for a simplier user interface
and returns the computed value (istead of an error code)
Synopsis:
PetscPolymorphicFunction(Functionname,(arguments of C++ function),(arguments of C function),return type,return variable name)
Not collective
Level: developer
Example:
PetscPolymorphicFunction(VecNorm,(Vec x,NormType t),(x,t,&r),PetscReal,r) generates the new routine
PetscReal VecNorm(Vec x,NormType t) = {PetscReal r; VecNorm(x,t,&r); return r;}
.seealso: PetscPolymorphicSubroutine()
M*/
#define PetscPolymorphicFunction(A,B,C,D,E) PETSC_STATIC_INLINE D A B {D E; A C;return E;}
#else
#define PetscPolymorphicSubroutine(A,B,C)
#define PetscPolymorphicScalar(A,B,C)
#define PetscPolymorphicFunction(A,B,C,D,E)
#endif
/*MC
PetscUnlikely - hints the compiler that the given condition is usually FALSE
Synopsis:
PetscTruth PetscUnlikely(PetscTruth cond)
Not Collective
Input Parameters:
. cond - condition or expression
Note: This returns the same truth value, it is only a hint to compilers that the resulting
branch is unlikely.
Level: advanced
.seealso: PetscLikely(), CHKERRQ
M*/
/*MC
PetscLikely - hints the compiler that the given condition is usually TRUE
Synopsis:
PetscTruth PetscUnlikely(PetscTruth cond)
Not Collective
Input Parameters:
. cond - condition or expression
Note: This returns the same truth value, it is only a hint to compilers that the resulting
branch is likely.
Level: advanced
.seealso: PetscUnlikely()
M*/
#if defined(PETSC_HAVE_BUILTIN_EXPECT)
# define PetscUnlikely(cond) __builtin_expect(!!(cond),0)
# define PetscLikely(cond) __builtin_expect(!!(cond),1)
#else
# define PetscUnlikely(cond) cond
# define PetscLikely(cond) cond
#endif
/*
Extern indicates a PETSc function defined elsewhere
*/
#if !defined(EXTERN)
#define EXTERN extern
#endif
/*
Defines some elementary mathematics functions and constants.
*/
#include "petscmath.h"
/*
Declare extern C stuff after including external header files
*/
PETSC_EXTERN_CXX_BEGIN
/*
Basic PETSc constants
*/
/*E
PetscTruth - Logical variable. Actually an integer
Level: beginner
E*/
typedef enum { PETSC_FALSE,PETSC_TRUE } PetscTruth;
extern const char *PetscTruths[];
/*MC
PETSC_FALSE - False value of PetscTruth
Level: beginner
Note: Zero integer
.seealso: PetscTruth, PETSC_TRUE
M*/
/*MC
PETSC_TRUE - True value of PetscTruth
Level: beginner
Note: Nonzero integer
.seealso: PetscTruth, PETSC_FALSE
M*/
/*MC
PETSC_YES - Alias for PETSC_TRUE
Level: beginner
Note: Zero integer
.seealso: PetscTruth, PETSC_TRUE, PETSC_FALSE, PETSC_NO
M*/
#define PETSC_YES PETSC_TRUE
/*MC
PETSC_NO - Alias for PETSC_FALSE
Level: beginner
Note: Nonzero integer
.seealso: PetscTruth, PETSC_TRUE, PETSC_FALSE, PETSC_YES
M*/
#define PETSC_NO PETSC_FALSE
/*MC
PETSC_NULL - standard way of passing in a null or array or pointer
Level: beginner
Notes: accepted by many PETSc functions to not set a parameter and instead use
some default
This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER,
PETSC_NULL_DOUBLE_PRECISION etc
.seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE
M*/
#define PETSC_NULL 0
/*MC
PETSC_DECIDE - standard way of passing in integer or floating point parameter
where you wish PETSc to use the default.
Level: beginner
.seealso: PETSC_NULL, PETSC_DEFAULT, PETSC_IGNORE, PETSC_DETERMINE
M*/
#define PETSC_DECIDE -1
/*MC
PETSC_DEFAULT - standard way of passing in integer or floating point parameter
where you wish PETSc to use the default.
Level: beginner
Fortran Notes: You need to use PETSC_DEFAULT_INTEGER or PETSC_DEFAULT_DOUBLE_PRECISION.
.seealso: PETSC_DECIDE, PETSC_NULL, PETSC_IGNORE, PETSC_DETERMINE
M*/
#define PETSC_DEFAULT -2
/*MC
PETSC_IGNORE - same as PETSC_NULL, means PETSc will ignore this argument
Level: beginner
Note: accepted by many PETSc functions to not set a parameter and instead use
some default
Fortran Notes: This macro does not exist in Fortran; you must use PETSC_NULL_INTEGER,
PETSC_NULL_DOUBLE_PRECISION etc
.seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_NULL, PETSC_DETERMINE
M*/
#define PETSC_IGNORE PETSC_NULL
/*MC
PETSC_DETERMINE - standard way of passing in integer or floating point parameter
where you wish PETSc to compute the required value.
Level: beginner
.seealso: PETSC_DECIDE, PETSC_DEFAULT, PETSC_IGNORE, PETSC_NULL, VecSetSizes()
M*/
#define PETSC_DETERMINE PETSC_DECIDE
/*MC
PETSC_COMM_WORLD - the equivalent of the MPI_COMM_WORLD communicator which represents
all the processs that PETSc knows about.
Level: beginner
Notes: By default PETSC_COMM_WORLD and MPI_COMM_WORLD are identical unless you wish to
run PETSc on ONLY a subset of MPI_COMM_WORLD. In that case create your new (smaller)
communicator, call it, say comm, and set PETSC_COMM_WORLD = comm BEFORE calling
PetscInitialize()
.seealso: PETSC_COMM_SELF
M*/
extern MPI_Comm PETSC_COMM_WORLD;
/*MC
PETSC_COMM_SELF - a duplicate of the MPI_COMM_SELF communicator which represents
the current process
Level: beginner
Notes: PETSC_COMM_SELF and MPI_COMM_SELF are equivalent.
.seealso: PETSC_COMM_WORLD
M*/
#define PETSC_COMM_SELF MPI_COMM_SELF
extern PETSC_DLLEXPORT PetscTruth PetscInitializeCalled;
extern PETSC_DLLEXPORT PetscTruth PetscFinalizeCalled;
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSetHelpVersionFunctions(PetscErrorCode (*)(MPI_Comm),PetscErrorCode (*)(MPI_Comm));
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscCommDuplicate(MPI_Comm,MPI_Comm*,int*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscCommDestroy(MPI_Comm*);
/*MC
PetscMalloc - Allocates memory
Synopsis:
PetscErrorCode PetscMalloc(size_t m,void **result)
Not Collective
Input Parameter:
. m - number of bytes to allocate
Output Parameter:
. result - memory allocated
Level: beginner
Notes: Memory is always allocated at least double aligned
If you request memory of zero size it will allocate no space and assign the pointer to 0; PetscFree() will
properly handle not freeing the null pointer.
.seealso: PetscFree(), PetscNew()
Concepts: memory allocation
M*/
#define PetscMalloc(a,b) ((a != 0) ? (*PetscTrMalloc)((a),__LINE__,__FUNCT__,__FILE__,__SDIR__,(void**)(b)) : (*(b) = 0,0) )
/*MC
PetscAddrAlign - Returns an address with PETSC_MEMALIGN alignment
Synopsis:
void *PetscAddrAlign(void *addr)
Not Collective
Input Parameters:
. addr - address to align (any pointer type)
Level: developer
.seealso: PetscMallocAlign()
Concepts: memory allocation
M*/
#if defined PETSC_UINTPTR_T
# define PetscAddrAlign(a) (void*)((((PETSC_UINTPTR_T)(a))+(PETSC_MEMALIGN-1)) & ~(PETSC_MEMALIGN-1))
#else
# define PetscAddrAlign(a) (void*)(a)
#endif
/*MC
PetscMalloc2 - Allocates 2 chunks of memory
Synopsis:
PetscErrorCode PetscMalloc2(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2)
Not Collective
Input Parameter:
+ m1 - number of elements to allocate in 1st chunk (may be zero)
. t1 - type of first memory elements
. m2 - number of elements to allocate in 2nd chunk (may be zero)
- t2 - type of second memory elements
Output Parameter:
+ r1 - memory allocated in first chunk
- r2 - memory allocated in second chunk
Level: developer
Notes: Memory of first chunk is always allocated at least double aligned
.seealso: PetscFree(), PetscNew(), PetscMalloc()
Concepts: memory allocation
M*/
#if defined(PETSC_USE_DEBUG)
#define PetscMalloc2(m1,t1,r1,m2,t2,r2) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2))
#else
#define PetscMalloc2(m1,t1,r1,m2,t2,r2) ((*(r2) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(PETSC_MEMALIGN-1),r1)) \
|| (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),0))
#endif
/*MC
PetscMalloc3 - Allocates 3 chunks of memory
Synopsis:
PetscErrorCode PetscMalloc3(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3)
Not Collective
Input Parameter:
+ m1 - number of elements to allocate in 1st chunk (may be zero)
. t1 - type of first memory elements
. m2 - number of elements to allocate in 2nd chunk (may be zero)
. t2 - type of second memory elements
. m3 - number of elements to allocate in 3rd chunk (may be zero)
- t3 - type of third memory elements
Output Parameter:
+ r1 - memory allocated in first chunk
. r2 - memory allocated in second chunk
- r3 - memory allocated in third chunk
Level: developer
Notes: Memory of first chunk is always allocated at least double aligned
.seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3()
Concepts: memory allocation
M*/
#if defined(PETSC_USE_DEBUG)
#define PetscMalloc3(m1,t1,r1,m2,t2,r2,m3,t3,r3) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3))
#else
#define PetscMalloc3(m1,t1,r1,m2,t2,r2,m3,t3,r3) ((*(r2) = 0,*(r3) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+2*(PETSC_MEMALIGN-1),r1)) \
|| (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),0))
#endif
/*MC
PetscMalloc4 - Allocates 4 chunks of memory
Synopsis:
PetscErrorCode PetscMalloc4(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4)
Not Collective
Input Parameter:
+ m1 - number of elements to allocate in 1st chunk (may be zero)
. t1 - type of first memory elements
. m2 - number of elements to allocate in 2nd chunk (may be zero)
. t2 - type of second memory elements
. m3 - number of elements to allocate in 3rd chunk (may be zero)
. t3 - type of third memory elements
. m4 - number of elements to allocate in 4th chunk (may be zero)
- t4 - type of fourth memory elements
Output Parameter:
+ r1 - memory allocated in first chunk
. r2 - memory allocated in second chunk
. r3 - memory allocated in third chunk
- r4 - memory allocated in fourth chunk
Level: developer
Notes: Memory of first chunk is always allocated at least double aligned
.seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4()
Concepts: memory allocation
M*/
#if defined(PETSC_USE_DEBUG)
#define PetscMalloc4(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4))
#else
#define PetscMalloc4(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4) \
((*(r2) = 0, *(r3) = 0, *(r4) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+3*(PETSC_MEMALIGN-1),r1)) \
|| (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),0))
#endif
/*MC
PetscMalloc5 - Allocates 5 chunks of memory
Synopsis:
PetscErrorCode PetscMalloc5(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4,size_t m5,type t5,void **r5)
Not Collective
Input Parameter:
+ m1 - number of elements to allocate in 1st chunk (may be zero)
. t1 - type of first memory elements
. m2 - number of elements to allocate in 2nd chunk (may be zero)
. t2 - type of second memory elements
. m3 - number of elements to allocate in 3rd chunk (may be zero)
. t3 - type of third memory elements
. m4 - number of elements to allocate in 4th chunk (may be zero)
. t4 - type of fourth memory elements
. m5 - number of elements to allocate in 5th chunk (may be zero)
- t5 - type of fifth memory elements
Output Parameter:
+ r1 - memory allocated in first chunk
. r2 - memory allocated in second chunk
. r3 - memory allocated in third chunk
. r4 - memory allocated in fourth chunk
- r5 - memory allocated in fifth chunk
Level: developer
Notes: Memory of first chunk is always allocated at least double aligned
.seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5()
Concepts: memory allocation
M*/
#if defined(PETSC_USE_DEBUG)
#define PetscMalloc5(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4) || PetscMalloc((m5)*sizeof(t5),r5))
#else
#define PetscMalloc5(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5) \
((*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+4*(PETSC_MEMALIGN-1),r1)) \
|| (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),*(r5) = (t5*)PetscAddrAlign(*(r4)+m4),0))
#endif
/*MC
PetscMalloc6 - Allocates 6 chunks of memory
Synopsis:
PetscErrorCode PetscMalloc6(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4,size_t m5,type t5,void **r5,size_t m6,type t6,void **r6)
Not Collective
Input Parameter:
+ m1 - number of elements to allocate in 1st chunk (may be zero)
. t1 - type of first memory elements
. m2 - number of elements to allocate in 2nd chunk (may be zero)
. t2 - type of second memory elements
. m3 - number of elements to allocate in 3rd chunk (may be zero)
. t3 - type of third memory elements
. m4 - number of elements to allocate in 4th chunk (may be zero)
. t4 - type of fourth memory elements
. m5 - number of elements to allocate in 5th chunk (may be zero)
. t5 - type of fifth memory elements
. m6 - number of elements to allocate in 6th chunk (may be zero)
- t6 - type of sixth memory elements
Output Parameter:
+ r1 - memory allocated in first chunk
. r2 - memory allocated in second chunk
. r3 - memory allocated in third chunk
. r4 - memory allocated in fourth chunk
. r5 - memory allocated in fifth chunk
- r6 - memory allocated in sixth chunk
Level: developer
Notes: Memory of first chunk is always allocated at least double aligned
.seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6()
Concepts: memory allocation
M*/
#if defined(PETSC_USE_DEBUG)
#define PetscMalloc6(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4) || PetscMalloc((m5)*sizeof(t5),r5) || PetscMalloc((m6)*sizeof(t6),r6))
#else
#define PetscMalloc6(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6) \
((*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+(m6)*sizeof(t6)+5*(PETSC_MEMALIGN-1),r1)) \
|| (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),*(r5) = (t5*)PetscAddrAlign(*(r4)+m4),*(r6) = (t6*)PetscAddrAlign(*(r5)+m5),0))
#endif
/*MC
PetscMalloc7 - Allocates 7 chunks of memory
Synopsis:
PetscErrorCode PetscMalloc7(size_t m1,type, t1,void **r1,size_t m2,type t2,void **r2,size_t m3,type t3,void **r3,size_t m4,type t4,void **r4,size_t m5,type t5,void **r5,size_t m6,type t6,void **r6,size_t m7,type t7,void **r7)
Not Collective
Input Parameter:
+ m1 - number of elements to allocate in 1st chunk (may be zero)
. t1 - type of first memory elements
. m2 - number of elements to allocate in 2nd chunk (may be zero)
. t2 - type of second memory elements
. m3 - number of elements to allocate in 3rd chunk (may be zero)
. t3 - type of third memory elements
. m4 - number of elements to allocate in 4th chunk (may be zero)
. t4 - type of fourth memory elements
. m5 - number of elements to allocate in 5th chunk (may be zero)
. t5 - type of fifth memory elements
. m6 - number of elements to allocate in 6th chunk (may be zero)
. t6 - type of sixth memory elements
. m7 - number of elements to allocate in 7th chunk (may be zero)
- t7 - type of sixth memory elements
Output Parameter:
+ r1 - memory allocated in first chunk
. r2 - memory allocated in second chunk
. r3 - memory allocated in third chunk
. r4 - memory allocated in fourth chunk
. r5 - memory allocated in fifth chunk
. r6 - memory allocated in sixth chunk
- r7 - memory allocated in seventh chunk
Level: developer
Notes: Memory of first chunk is always allocated at least double aligned
.seealso: PetscFree(), PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree3(), PetscFree4(), PetscFree5(), PetscFree6(), PetscFree7()
Concepts: memory allocation
M*/
#if defined(PETSC_USE_DEBUG)
#define PetscMalloc7(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6,m7,t7,r7) (PetscMalloc((m1)*sizeof(t1),r1) || PetscMalloc((m2)*sizeof(t2),r2) || PetscMalloc((m3)*sizeof(t3),r3) || PetscMalloc((m4)*sizeof(t4),r4) || PetscMalloc((m5)*sizeof(t5),r5) || PetscMalloc((m6)*sizeof(t6),r6) || PetscMalloc((m7)*sizeof(t7),r7))
#else
#define PetscMalloc7(m1,t1,r1,m2,t2,r2,m3,t3,r3,m4,t4,r4,m5,t5,r5,m6,t6,r6,m7,t7,r7) \
((*(r2) = 0, *(r3) = 0, *(r4) = 0,*(r5) = 0,*(r6) = 0,*(r7) = 0,PetscMalloc((m1)*sizeof(t1)+(m2)*sizeof(t2)+(m3)*sizeof(t3)+(m4)*sizeof(t4)+(m5)*sizeof(t5)+(m6)*sizeof(t6)+(m7)*sizeof(t7)+6*(PETSC_MEMALIGN-1),r1)) \
|| (*(r2) = (t2*)PetscAddrAlign(*(r1)+m1),*(r3) = (t3*)PetscAddrAlign(*(r2)+m2),*(r4) = (t4*)PetscAddrAlign(*(r3)+m3),*(r5) = (t5*)PetscAddrAlign(*(r4)+m4),*(r6) = (t6*)PetscAddrAlign(*(r5)+m5),*(r7) = (t7*)PetscAddrAlign(*(r6)+m6),0))
#endif
/*MC
PetscNew - Allocates memory of a particular type, zeros the memory!
Synopsis:
PetscErrorCode PetscNew(struct type,((type *))result)
Not Collective
Input Parameter:
. type - structure name of space to be allocated. Memory of size sizeof(type) is allocated
Output Parameter:
. result - memory allocated
Level: beginner
.seealso: PetscFree(), PetscMalloc()
Concepts: memory allocation
M*/
#define PetscNew(A,b) (PetscMalloc(sizeof(A),(b)) || PetscMemzero(*(b),sizeof(A)))
#define PetscNewLog(o,A,b) (PetscNew(A,b) || ((o) ? PetscLogObjectMemory(o,sizeof(A)) : 0))
/*MC
PetscFree - Frees memory
Synopsis:
PetscErrorCode PetscFree(void *memory)
Not Collective
Input Parameter:
. memory - memory to free (the pointer is ALWAYS set to 0 upon sucess)
Level: beginner
Notes: Memory must have been obtained with PetscNew() or PetscMalloc()
.seealso: PetscNew(), PetscMalloc(), PetscFreeVoid()
Concepts: memory allocation
M*/
#define PetscFree(a) ((a) ? ((*PetscTrFree)((void*)(a),__LINE__,__FUNCT__,__FILE__,__SDIR__) || ((a = 0),0)) : 0)
/*MC
PetscFreeVoid - Frees memory
Synopsis:
void PetscFreeVoid(void *memory)
Not Collective
Input Parameter:
. memory - memory to free
Level: beginner
Notes: This is different from PetscFree() in that no error code is returned
.seealso: PetscFree(), PetscNew(), PetscMalloc()
Concepts: memory allocation
M*/
#define PetscFreeVoid(a) ((*PetscTrFree)((a),__LINE__,__FUNCT__,__FILE__,__SDIR__),(a) = 0)
/*MC
PetscFree2 - Frees 2 chunks of memory obtained with PetscMalloc2()
Synopsis:
PetscErrorCode PetscFree2(void *memory1,void *memory2)
Not Collective
Input Parameter:
+ memory1 - memory to free
- memory2 - 2nd memory to free
Level: developer
Notes: Memory must have been obtained with PetscMalloc2()
.seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree()
Concepts: memory allocation
M*/
#if defined(PETSC_USE_DEBUG)
#define PetscFree2(m1,m2) (PetscFree(m2) || PetscFree(m1))
#else
#define PetscFree2(m1,m2) (PetscFree(m1))
#endif
/*MC
PetscFree3 - Frees 3 chunks of memory obtained with PetscMalloc3()
Synopsis:
PetscErrorCode PetscFree3(void *memory1,void *memory2,void *memory3)
Not Collective
Input Parameter:
+ memory1 - memory to free
. memory2 - 2nd memory to free
- memory3 - 3rd memory to free
Level: developer
Notes: Memory must have been obtained with PetscMalloc3()
.seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3()
Concepts: memory allocation
M*/
#if defined(PETSC_USE_DEBUG)
#define PetscFree3(m1,m2,m3) (PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
#else
#define PetscFree3(m1,m2,m3) (PetscFree(m1))
#endif
/*MC
PetscFree4 - Frees 4 chunks of memory obtained with PetscMalloc4()
Synopsis:
PetscErrorCode PetscFree4(void *m1,void *m2,void *m3,void *m4)
Not Collective
Input Parameter:
+ m1 - memory to free
. m2 - 2nd memory to free
. m3 - 3rd memory to free
- m4 - 4th memory to free
Level: developer
Notes: Memory must have been obtained with PetscMalloc4()
.seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4()
Concepts: memory allocation
M*/
#if defined(PETSC_USE_DEBUG)
#define PetscFree4(m1,m2,m3,m4) (PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
#else
#define PetscFree4(m1,m2,m3,m4) (PetscFree(m1))
#endif
/*MC
PetscFree5 - Frees 5 chunks of memory obtained with PetscMalloc5()
Synopsis:
PetscErrorCode PetscFree5(void *m1,void *m2,void *m3,void *m4,void *m5)
Not Collective
Input Parameter:
+ m1 - memory to free
. m2 - 2nd memory to free
. m3 - 3rd memory to free
. m4 - 4th memory to free
- m5 - 5th memory to free
Level: developer
Notes: Memory must have been obtained with PetscMalloc5()
.seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5()
Concepts: memory allocation
M*/
#if defined(PETSC_USE_DEBUG)
#define PetscFree5(m1,m2,m3,m4,m5) (PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
#else
#define PetscFree5(m1,m2,m3,m4,m5) (PetscFree(m1))
#endif
/*MC
PetscFree6 - Frees 6 chunks of memory obtained with PetscMalloc6()
Synopsis:
PetscErrorCode PetscFree6(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6)
Not Collective
Input Parameter:
+ m1 - memory to free
. m2 - 2nd memory to free
. m3 - 3rd memory to free
. m4 - 4th memory to free
. m5 - 5th memory to free
- m6 - 6th memory to free
Level: developer
Notes: Memory must have been obtained with PetscMalloc6()
.seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6()
Concepts: memory allocation
M*/
#if defined(PETSC_USE_DEBUG)
#define PetscFree6(m1,m2,m3,m4,m5,m6) (PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
#else
#define PetscFree6(m1,m2,m3,m4,m5,m6) (PetscFree(m1))
#endif
/*MC
PetscFree7 - Frees 7 chunks of memory obtained with PetscMalloc7()
Synopsis:
PetscErrorCode PetscFree7(void *m1,void *m2,void *m3,void *m4,void *m5,void *m6,void *m7)
Not Collective
Input Parameter:
+ m1 - memory to free
. m2 - 2nd memory to free
. m3 - 3rd memory to free
. m4 - 4th memory to free
. m5 - 5th memory to free
. m6 - 6th memory to free
- m7 - 7th memory to free
Level: developer
Notes: Memory must have been obtained with PetscMalloc7()
.seealso: PetscNew(), PetscMalloc(), PetscMalloc2(), PetscFree(), PetscMalloc3(), PetscMalloc4(), PetscMalloc5(), PetscMalloc6(),
PetscMalloc7()
Concepts: memory allocation
M*/
#if defined(PETSC_USE_DEBUG)
#define PetscFree7(m1,m2,m3,m4,m5,m6,m7) (PetscFree(m7) || PetscFree(m6) || PetscFree(m5) || PetscFree(m4) || PetscFree(m3) || PetscFree(m2) || PetscFree(m1))
#else
#define PetscFree7(m1,m2,m3,m4,m5,m6,m7) (PetscFree(m1))
#endif
EXTERN PETSC_DLLEXPORT PetscErrorCode (*PetscTrMalloc)(size_t,int,const char[],const char[],const char[],void**);
EXTERN PETSC_DLLEXPORT PetscErrorCode (*PetscTrFree)(void*,int,const char[],const char[],const char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocSet(PetscErrorCode (*)(size_t,int,const char[],const char[],const char[],void**),PetscErrorCode (*)(void*,int,const char[],const char[],const char[]));
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocClear(void);
/*
Routines for tracing memory corruption/bleeding with default PETSc
memory allocation
*/
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocDump(FILE *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocDumpLog(FILE *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocGetCurrentUsage(PetscLogDouble *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocGetMaximumUsage(PetscLogDouble *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocDebug(PetscTruth);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocValidate(int,const char[],const char[],const char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMallocSetDumpLog(void);
/*
Variable type where we stash PETSc object pointers in Fortran.
On most machines size(pointer) == sizeof(long) - except windows
where its sizeof(long long)
*/
#if (PETSC_SIZEOF_VOID_P) == (PETSC_SIZEOF_LONG)
#define PetscFortranAddr long
#elif (PETSC_SIZEOF_VOID_P) == (PETSC_SIZEOF_LONG_LONG)
#define PetscFortranAddr long long
#else
#error "Unknown size for PetscFortranAddr! Send us a bugreport at petsc-maint@mcs.anl.gov"
#endif
/*E
PetscDataType - Used for handling different basic data types.
Level: beginner
Developer comment: It would be nice if we could always just use MPI Datatypes, why can we not?
.seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscDataTypeToMPIDataType(),
PetscDataTypeGetSize()
E*/
typedef enum {PETSC_INT = 0,PETSC_DOUBLE = 1,PETSC_COMPLEX = 2, PETSC_LONG = 3 ,PETSC_SHORT = 4,PETSC_FLOAT = 5,
PETSC_CHAR = 6,PETSC_LOGICAL = 7,PETSC_ENUM = 8,PETSC_TRUTH=9, PETSC_LONG_DOUBLE = 10, PETSC_QD_DD = 11} PetscDataType;
extern const char *PetscDataTypes[];
#if defined(PETSC_USE_COMPLEX)
#define PETSC_SCALAR PETSC_COMPLEX
#else
#if defined(PETSC_USE_SCALAR_SINGLE)
#define PETSC_SCALAR PETSC_FLOAT
#elif defined(PETSC_USE_SCALAR_LONG_DOUBLE)
#define PETSC_SCALAR PETSC_LONG_DOUBLE
#elif defined(PETSC_USE_SCALAR_INT)
#define PETSC_SCALAR PETSC_INT
#elif defined(PETSC_USE_SCALAR_QD_DD)
#define PETSC_SCALAR PETSC_QD_DD
#else
#define PETSC_SCALAR PETSC_DOUBLE
#endif
#endif
#if defined(PETSC_USE_SCALAR_SINGLE)
#define PETSC_REAL PETSC_FLOAT
#elif defined(PETSC_USE_SCALAR_LONG_DOUBLE)
#define PETSC_REAL PETSC_LONG_DOUBLE
#elif defined(PETSC_USE_SCALAR_INT)
#define PETSC_REAL PETSC_INT
#elif defined(PETSC_USE_SCALAR_QD_DD)
#define PETSC_REAL PETSC_QD_DD
#else
#define PETSC_REAL PETSC_DOUBLE
#endif
#define PETSC_FORTRANADDR PETSC_LONG
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDataTypeToMPIDataType(PetscDataType,MPI_Datatype*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMPIDataTypeToPetscDataType(MPI_Datatype,PetscDataType*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDataTypeGetSize(PetscDataType,size_t*);
/*
Basic memory and string operations. These are usually simple wrappers
around the basic Unix system calls, but a few of them have additional
functionality and/or error checking.
*/
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBitMemcpy(void*,PetscInt,const void*,PetscInt,PetscInt,PetscDataType);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemmove(void*,void *,size_t);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemcmp(const void*,const void*,size_t,PetscTruth *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrlen(const char[],size_t*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcmp(const char[],const char[],PetscTruth *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrgrt(const char[],const char[],PetscTruth *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcasecmp(const char[],const char[],PetscTruth*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrncmp(const char[],const char[],size_t,PetscTruth*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcpy(char[],const char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrcat(char[],const char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrncat(char[],const char[],size_t);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrncpy(char[],const char[],size_t);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrchr(const char[],char,char *[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrtolower(char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrrchr(const char[],char,char *[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrstr(const char[],const char[],char *[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrrstr(const char[],const char[],char *[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrallocpy(const char[],char *[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStrreplace(MPI_Comm,const char[],char[],size_t);
#define PetscStrfree(a) ((a) ? PetscFree(a) : 0)
/*S
PetscToken - 'Token' used for managing tokenizing strings
Level: intermediate
.seealso: PetscTokenCreate(), PetscTokenFind(), PetscTokenDestroy()
S*/
typedef struct _p_PetscToken* PetscToken;
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTokenCreate(const char[],const char,PetscToken*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTokenFind(PetscToken,char *[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTokenDestroy(PetscToken);
/*
These are MPI operations for MPI_Allreduce() etc
*/
EXTERN PETSC_DLLEXPORT MPI_Op PetscMaxSum_Op;
#if defined(PETSC_USE_COMPLEX) && !defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
EXTERN PETSC_DLLEXPORT MPI_Op MPIU_SUM;
#else
#define MPIU_SUM MPI_SUM
#endif
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMaxSum(MPI_Comm,const PetscInt[],PetscInt*,PetscInt*);
/*S
PetscObject - any PETSc object, PetscViewer, Mat, Vec, KSP etc
Level: beginner
Note: This is the base class from which all objects appear.
.seealso: PetscObjectDestroy(), PetscObjectView(), PetscObjectGetName(), PetscObjectSetName(), PetscObjectReference(), PetscObjectDereferenc()
S*/
typedef struct _p_PetscObject* PetscObject;
/*S
PetscFList - Linked list of functions, possibly stored in dynamic libraries, accessed
by string name
Level: advanced
.seealso: PetscFListAdd(), PetscFListDestroy()
S*/
typedef struct _n_PetscFList *PetscFList;
/*E
PetscFileMode - Access mode for a file.
Level: beginner
FILE_MODE_READ - open a file at its beginning for reading
FILE_MODE_WRITE - open a file at its beginning for writing (will create if the file does not exist)
FILE_MODE_APPEND - open a file at end for writing
FILE_MODE_UPDATE - open a file for updating, meaning for reading and writing
FILE_MODE_APPEND_UPDATE - open a file for updating, meaning for reading and writing, at the end
.seealso: PetscViewerFileSetMode()
E*/
typedef enum {FILE_MODE_READ, FILE_MODE_WRITE, FILE_MODE_APPEND, FILE_MODE_UPDATE, FILE_MODE_APPEND_UPDATE} PetscFileMode;
#include "petscviewer.h"
#include "petscoptions.h"
#define PETSC_SMALLEST_COOKIE 1211211
extern PETSC_DLLEXPORT PetscCookie PETSC_LARGEST_COOKIE;
extern PETSC_DLLEXPORT PetscCookie PETSC_OBJECT_COOKIE;
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscCookieRegister(const char[],PetscCookie *);
/*
Routines that get memory usage information from the OS
*/
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemoryGetCurrentUsage(PetscLogDouble *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemoryGetMaximumUsage(PetscLogDouble *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemorySetGetMaximumUsage(void);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMemoryShowUsage(PetscViewer,const char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInfoAllow(PetscTruth,const char []);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetTime(PetscLogDouble*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetCPUTime(PetscLogDouble*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSleep(PetscReal);
/*
Initialization of PETSc
*/
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitialize(int*,char***,const char[],const char[]);
PetscPolymorphicSubroutine(PetscInitialize,(int *argc,char ***args),(argc,args,PETSC_NULL,PETSC_NULL))
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitializeNoArguments(void);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitialized(PetscTruth *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFinalized(PetscTruth *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFinalize(void);
EXTERN PetscErrorCode PetscInitializeFortran(void);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetArgs(int*,char ***);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetArguments(char ***);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFreeArguments(char **);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscEnd(void);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInitializePackage(const char[]);
extern MPI_Comm PETSC_COMM_LOCAL_WORLD;
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOpenMPMerge(PetscMPIInt,PetscErrorCode (*)(void*),void*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOpenMPSpawn(PetscMPIInt);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOpenMPFinalize(void);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOpenMPRun(MPI_Comm,PetscErrorCode (*)(MPI_Comm,void *),void*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOpenMPRunCtx(MPI_Comm,PetscErrorCode (*)(MPI_Comm,void*,void *),void*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOpenMPFree(MPI_Comm,void*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOpenMPMalloc(MPI_Comm,size_t,void**);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPythonInitialize(const char[],const char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPythonFinalize(void);
/*
These are so that in extern C code we can caste function pointers to non-extern C
function pointers. Since the regular C++ code expects its function pointers to be
C++.
*/
typedef void (**PetscVoidStarFunction)(void);
typedef void (*PetscVoidFunction)(void);
typedef PetscErrorCode (*PetscErrorCodeFunction)(void);
/*
PetscTryMethod - Queries an object for a method, if it exists then calls it.
These are intended to be used only inside PETSc functions.
*/
#define PetscTryMethod(obj,A,B,C) \
0;{ PetscErrorCode (*f)B, __ierr; \
__ierr = PetscObjectQueryFunction((PetscObject)obj,A,(PetscVoidStarFunction)&f);CHKERRQ(__ierr); \
if (f) {__ierr = (*f)C;CHKERRQ(__ierr);}\
}
#define PetscUseMethod(obj,A,B,C) \
0;{ PetscErrorCode (*f)B, __ierr; \
__ierr = PetscObjectQueryFunction((PetscObject)obj,A,(PetscVoidStarFunction)&f);CHKERRQ(__ierr); \
if (f) {__ierr = (*f)C;CHKERRQ(__ierr);}\
else {SETERRQ1(PETSC_ERR_SUP,"Cannot locate function %s in object",A);} \
}
/*
Functions that can act on any PETSc object.
*/
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectCreate(MPI_Comm,PetscObject*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectCreateGeneric(MPI_Comm, PetscCookie, const char [], PetscObject *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectDestroy(PetscObject);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetComm(PetscObject,MPI_Comm *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetCookie(PetscObject,PetscCookie *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetType(PetscObject,const char []);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetType(PetscObject,const char *[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetName(PetscObject,const char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetName(PetscObject,const char*[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetTabLevel(PetscObject,PetscInt);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetTabLevel(PetscObject,PetscInt*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectIncrementTabLevel(PetscObject,PetscObject,PetscInt);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectReference(PetscObject);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetReference(PetscObject,PetscInt*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectDereference(PetscObject);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetNewTag(PetscObject,PetscMPIInt *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectView(PetscObject,PetscViewer);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectCompose(PetscObject,const char[],PetscObject);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectQuery(PetscObject,const char[],PetscObject *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectComposeFunction(PetscObject,const char[],const char[],void (*)(void));
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetFromOptions(PetscObject);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetUp(PetscObject);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscCommGetNewTag(MPI_Comm,PetscMPIInt *);
/*MC
PetscObjectComposeFunctionDynamic - Associates a function with a given PETSc object.
Synopsis:
PetscErrorCode PetscObjectComposeFunctionDynamic(PetscObject obj,const char name[],const char fname[],void *ptr)
Collective on PetscObject
Input Parameters:
+ obj - the PETSc object; this must be cast with a (PetscObject), for example,
PetscObjectCompose((PetscObject)mat,...);
. name - name associated with the child function
. fname - name of the function
- ptr - function pointer (or PETSC_NULL if using dynamic libraries)
Level: advanced
Notes:
To remove a registered routine, pass in a PETSC_NULL rname and fnc().
PetscObjectComposeFunctionDynamic() can be used with any PETSc object (such as
Mat, Vec, KSP, SNES, etc.) or any user-provided object.
The composed function must be wrapped in a EXTERN_C_BEGIN/END for this to
work in C++/complex with dynamic link libraries (config/configure.py options --with-shared --with-dynamic)
enabled.
Concepts: objects^composing functions
Concepts: composing functions
Concepts: functions^querying
Concepts: objects^querying
Concepts: querying objects
.seealso: PetscObjectQueryFunction()
M*/
#if defined(PETSC_USE_DYNAMIC_LIBRARIES)
#define PetscObjectComposeFunctionDynamic(a,b,c,d) PetscObjectComposeFunction(a,b,c,0)
#else
#define PetscObjectComposeFunctionDynamic(a,b,c,d) PetscObjectComposeFunction(a,b,c,(PetscVoidFunction)(d))
#endif
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectQueryFunction(PetscObject,const char[],void (**)(void));
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectSetOptionsPrefix(PetscObject,const char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectAppendOptionsPrefix(PetscObject,const char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectPrependOptionsPrefix(PetscObject,const char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectGetOptionsPrefix(PetscObject,const char*[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectPublish(PetscObject);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectChangeTypeName(PetscObject,const char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectRegisterDestroy(PetscObject);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectRegisterDestroyAll(void);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscObjectName(PetscObject);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTypeCompare(PetscObject,const char[],PetscTruth*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRegisterFinalize(PetscErrorCode (*)(void));
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRegisterFinalizeAll(void);
/*
Defines PETSc error handling.
*/
#include "petscerror.h"
/*S
PetscOList - Linked list of PETSc objects, accessable by string name
Level: developer
Notes: Used by PetscObjectCompose() and PetscObjectQuery()
.seealso: PetscOListAdd(), PetscOListDestroy(), PetscOListFind(), PetscObjectCompose(), PetscObjectQuery()
S*/
typedef struct _n_PetscOList *PetscOList;
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListDestroy(PetscOList);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListFind(PetscOList,const char[],PetscObject*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListReverseFind(PetscOList,PetscObject,char**);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListAdd(PetscOList *,const char[],PetscObject);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOListDuplicate(PetscOList,PetscOList *);
/*
Dynamic library lists. Lists of names of routines in dynamic
link libraries that will be loaded as needed.
*/
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListAdd(PetscFList*,const char[],const char[],void (*)(void));
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListDestroy(PetscFList*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListFind(PetscFList,MPI_Comm,const char[],void (**)(void));
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListPrintTypes(MPI_Comm,FILE*,const char[],const char[],const char[],const char[],PetscFList,const char[]);
#if defined(PETSC_USE_DYNAMIC_LIBRARIES)
#define PetscFListAddDynamic(a,b,p,c) PetscFListAdd(a,b,p,0)
#else
#define PetscFListAddDynamic(a,b,p,c) PetscFListAdd(a,b,p,(void (*)(void))c)
#endif
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListDuplicate(PetscFList,PetscFList *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListView(PetscFList,PetscViewer);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListConcat(const char [],const char [],char []);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFListGet(PetscFList,char ***,int*);
/*S
PetscDLLibrary - Linked list of dynamics libraries to search for functions
Level: advanced
--with-shared --with-dynamic must be used with config/configure.py to use dynamic libraries
.seealso: PetscDLLibraryOpen()
S*/
typedef struct _n_PetscDLLibrary *PetscDLLibrary;
extern PETSC_DLLEXPORT PetscDLLibrary DLLibrariesLoaded;
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryAppend(MPI_Comm,PetscDLLibrary *,const char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryPrepend(MPI_Comm,PetscDLLibrary *,const char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibrarySym(MPI_Comm,PetscDLLibrary *,const char[],const char[],void **);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryPrintPath(PetscDLLibrary);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryRetrieve(MPI_Comm,const char[],char *,size_t,PetscTruth *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryOpen(MPI_Comm,const char[],PetscDLLibrary *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryClose(PetscDLLibrary);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscDLLibraryCCAAppend(MPI_Comm,PetscDLLibrary *,const char[]);
/*
Useful utility routines
*/
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSplitOwnership(MPI_Comm,PetscInt*,PetscInt*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSplitOwnershipBlock(MPI_Comm,PetscInt,PetscInt*,PetscInt*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSequentialPhaseBegin(MPI_Comm,PetscMPIInt);
PetscPolymorphicSubroutine(PetscSequentialPhaseBegin,(MPI_Comm comm),(comm,1))
PetscPolymorphicSubroutine(PetscSequentialPhaseBegin,(void),(PETSC_COMM_WORLD,1))
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSequentialPhaseEnd(MPI_Comm,PetscMPIInt);
PetscPolymorphicSubroutine(PetscSequentialPhaseEnd,(MPI_Comm comm),(comm,1))
PetscPolymorphicSubroutine(PetscSequentialPhaseEnd,(void),(PETSC_COMM_WORLD,1))
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBarrier(PetscObject);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscMPIDump(FILE*);
#define PetscNot(a) ((a) ? PETSC_FALSE : PETSC_TRUE)
/*
Defines basic graphics available from PETSc.
*/
#include "petscdraw.h"
/*
Defines the base data structures for all PETSc objects
*/
#include "private/petscimpl.h"
/*
Defines PETSc profiling.
*/
#include "petsclog.h"
/*
For locking, unlocking and destroying AMS memories associated with
PETSc objects. Not currently used.
*/
#define PetscPublishAll(v) 0
#define PetscObjectTakeAccess(obj) 0
#define PetscObjectGrantAccess(obj) 0
#define PetscObjectDepublish(obj) 0
/*
Simple PETSc parallel IO for ASCII printing
*/
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFixFilename(const char[],char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFOpen(MPI_Comm,const char[],const char[],FILE**);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFClose(MPI_Comm,FILE*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFPrintf(MPI_Comm,FILE*,const char[],...) PETSC_PRINTF_FORMAT_CHECK(3,4);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPrintf(MPI_Comm,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSNPrintf(char*,size_t,const char [],...);
/* These are used internally by PETSc ASCII IO routines*/
#include <stdarg.h>
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscVSNPrintf(char*,size_t,const char[],int*,va_list);
EXTERN PetscErrorCode PETSC_DLLEXPORT (*PetscVFPrintf)(FILE*,const char[],va_list);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscVFPrintfDefault(FILE*,const char[],va_list);
/*MC
PetscErrorPrintf - Prints error messages.
Synopsis:
PetscErrorCode (*PetscErrorPrintf)(const char format[],...);
Not Collective
Input Parameters:
. format - the usual printf() format string
Options Database Keys:
+ -error_output_stdout - cause error messages to be printed to stdout instead of the
(default) stderr
- -error_output_none to turn off all printing of error messages (does not change the way the
error is handled.)
Notes: Use
$ PetscErrorPrintf = PetscErrorPrintfNone; to turn off all printing of error messages (does not change the way the
$ error is handled.) and
$ PetscErrorPrintf = PetscErrorPrintfDefault; to turn it back on
Use
PETSC_STDERR = FILE* obtained from a file open etc. to have stderr printed to the file.
PETSC_STDOUT = FILE* obtained from a file open etc. to have stdout printed to the file.
Use
PetscPushErrorHandler() to provide your own error handler that determines what kind of messages to print
Level: developer
Fortran Note:
This routine is not supported in Fortran.
Concepts: error messages^printing
Concepts: printing^error messages
.seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscHelpPrintf(), PetscPrintf(), PetscErrorHandlerPush()
M*/
EXTERN PETSC_DLLEXPORT PetscErrorCode (*PetscErrorPrintf)(const char[],...);
/*MC
PetscHelpPrintf - Prints help messages.
Synopsis:
PetscErrorCode (*PetscHelpPrintf)(const char format[],...);
Not Collective
Input Parameters:
. format - the usual printf() format string
Level: developer
Fortran Note:
This routine is not supported in Fortran.
Concepts: help messages^printing
Concepts: printing^help messages
.seealso: PetscFPrintf(), PetscSynchronizedPrintf(), PetscErrorPrintf()
M*/
EXTERN PETSC_DLLEXPORT PetscErrorCode (*PetscHelpPrintf)(MPI_Comm,const char[],...);
EXTERN PetscErrorCode PetscErrorPrintfDefault(const char [],...);
EXTERN PetscErrorCode PetscErrorPrintfNone(const char [],...);
EXTERN PetscErrorCode PetscHelpPrintfDefault(MPI_Comm,const char [],...);
#if defined(PETSC_HAVE_POPEN)
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPOpen(MPI_Comm,const char[],const char[],const char[],FILE **);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPClose(MPI_Comm,FILE*);
#endif
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedPrintf(MPI_Comm,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedFPrintf(MPI_Comm,FILE*,const char[],...) PETSC_PRINTF_FORMAT_CHECK(3,4);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedFlush(MPI_Comm);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSynchronizedFGets(MPI_Comm,FILE*,size_t,char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStartMatlab(MPI_Comm,const char[],const char[],FILE**);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStartJava(MPI_Comm,const char[],const char[],FILE**);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetPetscDir(const char*[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPopUpSelect(MPI_Comm,const char*,const char*,int,const char**,int*);
/*S
PetscContainer - Simple PETSc object that contains a pointer to any required data
Level: advanced
.seealso: PetscObject, PetscContainerCreate()
S*/
extern PetscCookie PETSC_DLLEXPORT PETSC_CONTAINER_COOKIE;
typedef struct _p_PetscContainer* PetscContainer;
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscContainerGetPointer(PetscContainer,void **);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscContainerSetPointer(PetscContainer,void *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscContainerDestroy(PetscContainer);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscContainerCreate(MPI_Comm,PetscContainer *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscContainerSetUserDestroy(PetscContainer, PetscErrorCode (*)(void*));
/*
For use in debuggers
*/
extern PETSC_DLLEXPORT PetscMPIInt PetscGlobalRank;
extern PETSC_DLLEXPORT PetscMPIInt PetscGlobalSize;
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscIntView(PetscInt,const PetscInt[],PetscViewer);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRealView(PetscInt,const PetscReal[],PetscViewer);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscScalarView(PetscInt,const PetscScalar[],PetscViewer);
#if defined(PETSC_HAVE_MEMORY_H)
#include <memory.h>
#endif
#if defined(PETSC_HAVE_STDLIB_H)
#include <stdlib.h>
#endif
#if defined(PETSC_HAVE_STRINGS_H)
#include <strings.h>
#endif
#if defined(PETSC_HAVE_STRING_H)
#include <string.h>
#endif
#if defined(PETSC_HAVE_XMMINTRIN_H)
#include <xmmintrin.h>
#endif
#if defined(PETSC_HAVE_STDINT_H)
#include <stdint.h>
#endif
/*@C
PetscMemcpy - Copies n bytes, beginning at location b, to the space
beginning at location a. The two memory regions CANNOT overlap, use
PetscMemmove() in that case.
Not Collective
Input Parameters:
+ b - pointer to initial memory space
- n - length (in bytes) of space to copy
Output Parameter:
. a - pointer to copy space
Level: intermediate
Compile Option:
PETSC_PREFER_DCOPY_FOR_MEMCPY will cause the BLAS dcopy() routine to be used
for memory copies on double precision values.
PETSC_PREFER_COPY_FOR_MEMCPY will cause C code to be used
for memory copies on double precision values.
PETSC_PREFER_FORTRAN_FORMEMCPY will cause Fortran code to be used
for memory copies on double precision values.
Note:
This routine is analogous to memcpy().
Concepts: memory^copying
Concepts: copying^memory
.seealso: PetscMemmove()
@*/
PETSC_STATIC_INLINE PetscErrorCode PETSC_DLLEXPORT PetscMemcpy(void *a,const void *b,size_t n)
{
#if defined(PETSC_USE_DEBUG)
unsigned long al = (unsigned long) a,bl = (unsigned long) b;
unsigned long nl = (unsigned long) n;
if (n > 0 && !b) SETERRQ(PETSC_ERR_ARG_NULL,"Trying to copy from a null pointer");
if (n > 0 && !a) SETERRQ(PETSC_ERR_ARG_NULL,"Trying to copy to a null pointer");
#endif
PetscFunctionBegin;
if (a != b) {
#if defined(PETSC_USE_DEBUG)
if ((al > bl && (al - bl) < nl) || (bl - al) < nl) {
SETERRQ3(PETSC_ERR_ARG_INCOMP,"Memory regions overlap: either use PetscMemmov()\n\
or make sure your copy regions and lengths are correct. \n\
Length (bytes) %ld first address %ld second address %ld",nl,al,bl);
}
#endif
#if (defined(PETSC_PREFER_DCOPY_FOR_MEMCPY) || defined(PETSC_PREFER_COPY_FOR_MEMCPY) || defined(PETSC_PREFER_FORTRAN_FORMEMCPY))
if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
size_t len = n/sizeof(PetscScalar);
#if defined(PETSC_PREFER_DCOPY_FOR_MEMCPY)
PetscBLASInt one = 1,blen = PetscBLASIntCast(len);
BLAScopy_(&blen,(PetscScalar *)b,&one,(PetscScalar *)a,&one);
#elif defined(PETSC_PREFER_FORTRAN_FORMEMCPY)
fortrancopy_(&len,(PetscScalar*)b,(PetscScalar*)a);
#else
size_t i;
PetscScalar *x = (PetscScalar*)b, *y = (PetscScalar*)a;
for (i=0; i<len; i++) y[i] = x[i];
#endif
} else {
memcpy((char*)(a),(char*)(b),n);
}
#elif defined(PETSC_HAVE__INTEL_FAST_MEMCPY)
_intel_fast_memcpy((char*)(a),(char*)(b),n);
#else
memcpy((char*)(a),(char*)(b),n);
#endif
}
PetscFunctionReturn(0);
}
/*@C
PetscMemzero - Zeros the specified memory.
Not Collective
Input Parameters:
+ a - pointer to beginning memory location
- n - length (in bytes) of memory to initialize
Level: intermediate
Compile Option:
PETSC_PREFER_BZERO - on certain machines (the IBM RS6000) the bzero() routine happens
to be faster than the memset() routine. This flag causes the bzero() routine to be used.
Concepts: memory^zeroing
Concepts: zeroing^memory
.seealso: PetscMemcpy()
@*/
PETSC_STATIC_INLINE PetscErrorCode PETSC_DLLEXPORT PetscMemzero(void *a,size_t n)
{
if (n > 0) {
#if defined(PETSC_USE_DEBUG)
if (!a) SETERRQ(PETSC_ERR_ARG_NULL,"Trying to zero at a null pointer");
#endif
#if defined(PETSC_PREFER_ZERO_FOR_MEMZERO)
if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
size_t i,len = n/sizeof(PetscScalar);
PetscScalar *x = (PetscScalar*)a;
for (i=0; i<len; i++) x[i] = 0.0;
} else {
#elif defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
if (!(((long) a) % sizeof(PetscScalar)) && !(n % sizeof(PetscScalar))) {
PetscInt len = n/sizeof(PetscScalar);
fortranzero_(&len,(PetscScalar*)a);
} else {
#endif
#if defined(PETSC_PREFER_BZERO)
bzero((char *)a,n);
#elif defined (PETSC_HAVE__INTEL_FAST_MEMSET)
_intel_fast_memset((char*)a,0,n);
#else
memset((char*)a,0,n);
#endif
#if defined(PETSC_PREFER_ZERO_FOR_MEMZERO) || defined(PETSC_PREFER_FORTRAN_FOR_MEMZERO)
}
#endif
}
return 0;
}
/*MC
PetscPrefetchBlock - Prefetches a block of memory
Synopsis:
void PetscPrefetchBlock(const anytype *a,size_t n,int rw,int t)
Not Collective
Input Parameters:
+ a - pointer to first element to fetch (any type but usually PetscInt or PetscScalar)
. n - number of elements to fetch
. rw - 1 if the memory will be written to, otherwise 0 (ignored by many processors)
- t - temporal locality (0,1,2,3), see note
Level: developer
Notes:
The last two arguments (rw and t) must be compile-time constants.
There are four levels of temporal locality (not all architectures distinguish)
+ 0 - Non-temporal. Prefetches directly to L1, evicts to memory (skips higher level cache unless it was already there when prefetched).
. 1 - Temporal with respect to high-level cache only. Only prefetches to high-level cache (not L1), kept at high levels after eviction from L1.
. 2 - Same as 1, but keep in mid-level cache. (On most systems, 1 and 2 are equivalent.)
- 3 - Fetch to all levels of cache and evict to the closest level. Use this when the memory will be reused regularly despite necessary eviction from L1.
This function does nothing on architectures that do not support prefetch and never errors (even if passed an invalid
address).
Concepts: memory
M*/
#define PetscPrefetchBlock(a,n,rw,t) do { \
const char *_p = (const char*)(a),*_end = (const char*)((a)+(n)); \
for ( ; _p < _end; _p += PETSC_LEVEL1_DCACHE_LINESIZE) PETSC_Prefetch(_p,(rw),(t)); \
} while (0)
/*
Allows accessing Matlab Engine
*/
#include "petscmatlab.h"
/*
Determine if some of the kernel computation routines use
Fortran (rather than C) for the numerical calculations. On some machines
and compilers (like complex numbers) the Fortran version of the routines
is faster than the C/C++ versions. The flag --with-fortran-kernels
should be used with config/configure.py to turn these on.
*/
#if defined(PETSC_USE_FORTRAN_KERNELS)
#if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCRL)
#define PETSC_USE_FORTRAN_KERNEL_MULTCRL
#endif
#if !defined(PETSC_USE_FORTRAN_KERNEL_MULTCSRPERM)
#define PETSC_USE_FORTRAN_KERNEL_MULTCSRPERM
#endif
#if !defined(PETSC_USE_FORTRAN_KERNEL_MULTAIJ)
#define PETSC_USE_FORTRAN_KERNEL_MULTAIJ
#endif
#if !defined(PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ)
#define PETSC_USE_FORTRAN_KERNEL_MULTTRANSPOSEAIJ
#endif
#if !defined(PETSC_USE_FORTRAN_KERNEL_NORM)
#define PETSC_USE_FORTRAN_KERNEL_NORM
#endif
#if !defined(PETSC_USE_FORTRAN_KERNEL_MAXPY)
#define PETSC_USE_FORTRAN_KERNEL_MAXPY
#endif
#if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ)
#define PETSC_USE_FORTRAN_KERNEL_SOLVEAIJ
#endif
#if !defined(PETSC_USE_FORTRAN_KERNEL_RELAXAIJ)
#define PETSC_USE_FORTRAN_KERNEL_RELAXAIJ
#endif
#if !defined(PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ)
#define PETSC_USE_FORTRAN_KERNEL_SOLVEBAIJ
#endif
#if !defined(PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ)
#define PETSC_USE_FORTRAN_KERNEL_MULTADDAIJ
#endif
#if !defined(PETSC_USE_FORTRAN_KERNEL_MDOT)
#define PETSC_USE_FORTRAN_KERNEL_MDOT
#endif
#if !defined(PETSC_USE_FORTRAN_KERNEL_XTIMESY)
#define PETSC_USE_FORTRAN_KERNEL_XTIMESY
#endif
#if !defined(PETSC_USE_FORTRAN_KERNEL_AYPX)
#define PETSC_USE_FORTRAN_KERNEL_AYPX
#endif
#if !defined(PETSC_USE_FORTRAN_KERNEL_WAXPY)
#define PETSC_USE_FORTRAN_KERNEL_WAXPY
#endif
#endif
/*
Macros for indicating code that should be compiled with a C interface,
rather than a C++ interface. Any routines that are dynamically loaded
(such as the PCCreate_XXX() routines) must be wrapped so that the name
mangler does not change the functions symbol name. This just hides the
ugly extern "C" {} wrappers.
*/
#if defined(__cplusplus)
#define EXTERN_C_BEGIN extern "C" {
#define EXTERN_C_END }
#else
#define EXTERN_C_BEGIN
#define EXTERN_C_END
#endif
/* --------------------------------------------------------------------*/
/*MC
MPI_Comm - the basic object used by MPI to determine which processes are involved in a
communication
Level: beginner
Note: This manual page is a place-holder because MPICH does not have a manual page for MPI_Comm
.seealso: PETSC_COMM_WORLD, PETSC_COMM_SELF
M*/
/*MC
PetscScalar - PETSc type that represents either a double precision real number, a double precision
complex number, a single precision real number, a long double or an int - if the code is configured
with --with-scalar-type=real,complex --with-precision=single,double,longdouble,int,matsingle
Level: beginner
.seealso: PetscReal, PassiveReal, PassiveScalar, MPIU_SCALAR, PetscInt
M*/
/*MC
PetscReal - PETSc type that represents a real number version of PetscScalar
Level: beginner
.seealso: PetscScalar, PassiveReal, PassiveScalar
M*/
/*MC
PassiveScalar - PETSc type that represents a PetscScalar
Level: beginner
This is the same as a PetscScalar except in code that is automatically differentiated it is
treated as a constant (not an indendent or dependent variable)
.seealso: PetscReal, PassiveReal, PetscScalar
M*/
/*MC
PassiveReal - PETSc type that represents a PetscReal
Level: beginner
This is the same as a PetscReal except in code that is automatically differentiated it is
treated as a constant (not an indendent or dependent variable)
.seealso: PetscScalar, PetscReal, PassiveScalar
M*/
/*MC
MPIU_SCALAR - MPI datatype corresponding to PetscScalar
Level: beginner
Note: In MPI calls that require an MPI datatype that matches a PetscScalar or array of PetscScalars
pass this value
.seealso: PetscReal, PassiveReal, PassiveScalar, PetscScalar, MPIU_INT
M*/
#if defined(PETSC_HAVE_MPIIO)
#if !defined(PETSC_WORDS_BIGENDIAN)
extern PetscErrorCode MPIU_File_write_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
extern PetscErrorCode MPIU_File_read_all(MPI_File,void*,PetscMPIInt,MPI_Datatype,MPI_Status*);
#else
#define MPIU_File_write_all(a,b,c,d,e) MPI_File_write_all(a,b,c,d,e)
#define MPIU_File_read_all(a,b,c,d,e) MPI_File_read_all(a,b,c,d,e)
#endif
#endif
/* the following petsc_static_inline require petscerror.h */
/* Limit MPI to 32-bits */
#define PETSC_MPI_INT_MAX 2147483647
#define PETSC_MPI_INT_MIN -2147483647
/* Limit BLAS to 32-bits */
#define PETSC_BLAS_INT_MAX 2147483647
#define PETSC_BLAS_INT_MIN -2147483647
/* On 32 bit systems HDF5 is limited by size of integer, because hsize_t is defined as size_t */
#define PETSC_HDF5_INT_MAX 2147483647
#define PETSC_HDF5_INT_MIN -2147483647
#if defined(PETSC_USE_64BIT_INDICES)
#define PetscMPIIntCheck(a) if ((a) > PETSC_MPI_INT_MAX) SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Message too long for MPI")
#define PetscBLASIntCheck(a) if ((a) > PETSC_BLAS_INT_MAX) SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Array too long for BLAS/LAPACK")
#define PetscMPIIntCast(a) (a);PetscMPIIntCheck(a)
#define PetscBLASIntCast(a) (a);PetscBLASIntCheck(a)
#if (PETSC_SIZEOF_SIZE_T == 4)
#define PetscHDF5IntCheck(a) if ((a) > PETSC_HDF5_INT_MAX) SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Array too long for HDF5")
#define PetscHDF5IntCast(a) (a);PetscHDF5IntCheck(a)
#else
#define PetscHDF5IntCheck(a)
#define PetscHDF5IntCast(a) a
#endif
#else
#define PetscMPIIntCheck(a)
#define PetscBLASIntCheck(a)
#define PetscHDF5IntCheck(a)
#define PetscMPIIntCast(a) a
#define PetscBLASIntCast(a) a
#define PetscHDF5IntCast(a) a
#endif
/*
The IBM include files define hz, here we hide it so that it may be used
as a regular user variable.
*/
#if defined(hz)
#undef hz
#endif
/* For arrays that contain filenames or paths */
#if defined(PETSC_HAVE_LIMITS_H)
#include <limits.h>
#endif
#if defined(PETSC_HAVE_SYS_PARAM_H)
#include <sys/param.h>
#endif
#if defined(PETSC_HAVE_SYS_TYPES_H)
#include <sys/types.h>
#endif
#if defined(MAXPATHLEN)
# define PETSC_MAX_PATH_LEN MAXPATHLEN
#elif defined(MAX_PATH)
# define PETSC_MAX_PATH_LEN MAX_PATH
#elif defined(_MAX_PATH)
# define PETSC_MAX_PATH_LEN _MAX_PATH
#else
# define PETSC_MAX_PATH_LEN 4096
#endif
/* Special support for C++ */
#include "petscsys.hh"
/*MC
UsingFortran - Fortran can be used with PETSc in four distinct approaches
$ 1) classic Fortran 77 style
$#include "finclude/petscXXX.h" to work with material from the XXX component of PETSc
$ XXX variablename
$ You cannot use this approach if you wish to use the Fortran 90 specific PETSc routines
$ which end in F90; such as VecGetArrayF90()
$
$ 2) classic Fortran 90 style
$#include "finclude/petscXXX.h"
$#include "finclude/petscXXX.h90" to work with material from the XXX component of PETSc
$ XXX variablename
$
$ 3) Using Fortran modules
$#include "finclude/petscXXXdef.h"
$ use petscXXXX
$ XXX variablename
$
$ 4) Use Fortran modules and Fortran data types for PETSc types
$#include "finclude/petscXXXdef.h"
$ use petscXXXX
$ type(XXX) variablename
$ To use this approach you must config/configure.py PETSc with the additional
$ option --with-fortran-datatypes You cannot use the type(XXX) declaration approach without using Fortran modules
Finally if you absolutely do not want to use any #include you can use either
$ 3a) skip the #include BUT you cannot use any PETSc data type names like Vec, Mat, PetscInt, PetscErrorCode etc
$ and you must declare the variables as integer, for example
$ integer variablename
$
$ 4a) skip the #include, you use the object types like type(Vec) type(Mat) but cannot use the data type
$ names like PetscErrorCode, PetscInt etc. again for those you must use integer
We recommend either 2 or 3. Approaches 2 and 3 provide type checking for most PETSc function calls; 4 has type checking
for only a few PETSc functions.
Fortran type checking with interfaces is strick, this means you cannot pass a scalar value when an array value
is expected (even though it is legal Fortran). For example when setting a single value in a matrix with MatSetValues()
you cannot have something like
$ PetscInt row,col
$ PetscScalar val
$ ...
$ call MatSetValues(mat,1,row,1,col,val,INSERT_VALUES,ierr)
You must instead have
$ PetscInt row(1),col(1)
$ PetscScalar val(1)
$ ...
$ call MatSetValues(mat,1,row,1,col,val,INSERT_VALUES,ierr)
See the example src/vec/vec/examples/tutorials/ex20f90.F90 for an example that can use all four approaches
Developer Notes: The finclude/petscXXXdef.h contain all the #defines (would be typedefs in C code) these
automatically include their predecessors; for example finclude/petscvecdef.h includes finclude/petscisdef.h
The finclude/petscXXXX.h contain all the parameter statements for that package. These automatically include
their finclude/petscXXXdef.h file but DO NOT automatically include their predecessors; for example
finclude/petscvec.h does NOT automatically include finclude/petscis.h
The finclude/ftn-custom/petscXXXdef.h90 are not intended to be used directly in code, they define the
Fortran data type type(XXX) (for example type(Vec)) when PETSc is config/configure.py with the --with-fortran-datatypes option.
The finclude/ftn-custom/petscXXX.h90 (not included directly by code) contain interface definitions for
the PETSc Fortran stubs that have different bindings then their C version (for example VecGetArrayF90).
The finclude/ftn-auto/petscXXX.h90 (not included directly by code) contain interface definitions generated
automatically by "make allfortranstubs".
The finclude/petscXXX.h90 includes the custom finclude/ftn-custom/petscXXX.h90 and if config/configure.py
was run with --with-fortran-interfaces it also includes the finclude/ftn-auto/petscXXX.h90 These DO NOT automatically
include their predecessors
Level: beginner
M*/
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetArchType(char[],size_t);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetHostName(char[],size_t);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetUserName(char[],size_t);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetProgramName(char[],size_t);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSetProgramName(const char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetDate(char[],size_t);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSortInt(PetscInt,PetscInt[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSortIntWithPermutation(PetscInt,const PetscInt[],PetscInt[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSortStrWithPermutation(PetscInt,const char*[],PetscInt[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSortIntWithArray(PetscInt,PetscInt[],PetscInt[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSortMPIIntWithArray(PetscMPIInt,PetscMPIInt[],PetscMPIInt[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSortIntWithScalarArray(PetscInt,PetscInt[],PetscScalar[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSortReal(PetscInt,PetscReal[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSortRealWithPermutation(PetscInt,const PetscReal[],PetscInt[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSortSplit(PetscInt,PetscInt,PetscScalar[],PetscInt[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSortSplitReal(PetscInt,PetscInt,PetscReal[],PetscInt[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSetDisplay(void);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetDisplay(char[],size_t);
/*E
PetscRandomType - String with the name of a PETSc randomizer
with an optional dynamic library name, for example
http://www.mcs.anl.gov/petsc/lib.a:myrandcreate()
Level: beginner
Notes: to use the SPRNG you must have config/configure.py PETSc
with the option --download-sprng
.seealso: PetscRandomSetType(), PetscRandom
E*/
#define PetscRandomType char*
#define PETSCRAND "rand"
#define PETSCRAND48 "rand48"
#define PETSCSPRNG "sprng"
/* Logging support */
extern PETSC_DLLEXPORT PetscCookie PETSC_RANDOM_COOKIE;
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomInitializePackage(const char[]);
/*S
PetscRandom - Abstract PETSc object that manages generating random numbers
Level: intermediate
Concepts: random numbers
.seealso: PetscRandomCreate(), PetscRandomGetValue(), PetscRandomType
S*/
typedef struct _p_PetscRandom* PetscRandom;
/* Dynamic creation and loading functions */
extern PetscFList PetscRandomList;
extern PetscTruth PetscRandomRegisterAllCalled;
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomRegisterAll(const char []);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomRegister(const char[],const char[],const char[],PetscErrorCode (*)(PetscRandom));
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomRegisterDestroy(void);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomSetType(PetscRandom, const PetscRandomType);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomSetFromOptions(PetscRandom);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomGetType(PetscRandom, const PetscRandomType*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomViewFromOptions(PetscRandom,char*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomView(PetscRandom,PetscViewer);
/*MC
PetscRandomRegisterDynamic - Adds a new PetscRandom component implementation
Synopsis:
PetscErrorCode PetscRandomRegisterDynamic(const char *name, const char *path, const char *func_name, PetscErrorCode (*create_func)(PetscRandom))
Not Collective
Input Parameters:
+ name - The name of a new user-defined creation routine
. path - The path (either absolute or relative) of the library containing this routine
. func_name - The name of routine to create method context
- create_func - The creation routine itself
Notes:
PetscRandomRegisterDynamic() may be called multiple times to add several user-defined randome number generators
If dynamic libraries are used, then the fourth input argument (routine_create) is ignored.
Sample usage:
.vb
PetscRandomRegisterDynamic("my_rand","/home/username/my_lib/lib/libO/solaris/libmy.a", "MyPetscRandomtorCreate", MyPetscRandomtorCreate);
.ve
Then, your random type can be chosen with the procedural interface via
.vb
PetscRandomCreate(MPI_Comm, PetscRandom *);
PetscRandomSetType(PetscRandom,"my_random_name");
.ve
or at runtime via the option
.vb
-random_type my_random_name
.ve
Notes: $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
For an example of the code needed to interface your own random number generator see
src/sys/random/impls/rand/rand.c
Level: advanced
.keywords: PetscRandom, register
.seealso: PetscRandomRegisterAll(), PetscRandomRegisterDestroy(), PetscRandomRegister()
M*/
#if defined(PETSC_USE_DYNAMIC_LIBRARIES)
#define PetscRandomRegisterDynamic(a,b,c,d) PetscRandomRegister(a,b,c,0)
#else
#define PetscRandomRegisterDynamic(a,b,c,d) PetscRandomRegister(a,b,c,d)
#endif
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomCreate(MPI_Comm,PetscRandom*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomGetValue(PetscRandom,PetscScalar*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomGetValueReal(PetscRandom,PetscReal*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomGetInterval(PetscRandom,PetscScalar*,PetscScalar*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomSetInterval(PetscRandom,PetscScalar,PetscScalar);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomSetSeed(PetscRandom,unsigned long);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomGetSeed(PetscRandom,unsigned long *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomSeed(PetscRandom);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscRandomDestroy(PetscRandom);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetFullPath(const char[],char[],size_t);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetRelativePath(const char[],char[],size_t);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetWorkingDirectory(char[],size_t);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetRealPath(const char[],char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetHomeDirectory(char[],size_t);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTestFile(const char[],char,PetscTruth*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscTestDirectory(const char[],char,PetscTruth*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBinaryRead(int,void*,PetscInt,PetscDataType);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBinarySynchronizedRead(MPI_Comm,int,void*,PetscInt,PetscDataType);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBinarySynchronizedWrite(MPI_Comm,int,void*,PetscInt,PetscDataType,PetscTruth);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBinaryWrite(int,void*,PetscInt,PetscDataType,PetscTruth);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBinaryOpen(const char[],PetscFileMode,int *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBinaryClose(int);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSharedTmp(MPI_Comm,PetscTruth *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSharedWorkingDirectory(MPI_Comm,PetscTruth *);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetTmp(MPI_Comm,char[],size_t);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscFileRetrieve(MPI_Comm,const char[],char[],size_t,PetscTruth*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLs(MPI_Comm,const char[],char[],size_t,PetscTruth*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscOpenSocket(char*,int,int*);
/*
In binary files variables are stored using the following lengths,
regardless of how they are stored in memory on any one particular
machine. Use these rather then sizeof() in computing sizes for
PetscBinarySeek().
*/
#define PETSC_BINARY_INT_SIZE (32/8)
#define PETSC_BINARY_FLOAT_SIZE (32/8)
#define PETSC_BINARY_CHAR_SIZE (8/8)
#define PETSC_BINARY_SHORT_SIZE (16/8)
#define PETSC_BINARY_DOUBLE_SIZE (64/8)
#define PETSC_BINARY_SCALAR_SIZE sizeof(PetscScalar)
/*E
PetscBinarySeekType - argument to PetscBinarySeek()
Level: advanced
.seealso: PetscBinarySeek(), PetscBinarySynchronizedSeek()
E*/
typedef enum {PETSC_BINARY_SEEK_SET = 0,PETSC_BINARY_SEEK_CUR = 1,PETSC_BINARY_SEEK_END = 2} PetscBinarySeekType;
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBinarySeek(int,off_t,PetscBinarySeekType,off_t*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscBinarySynchronizedSeek(MPI_Comm,int,off_t,PetscBinarySeekType,off_t*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSetDebugTerminal(const char[]);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSetDebugger(const char[],PetscTruth);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSetDefaultDebugger(void);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSetDebuggerFromString(char*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscAttachDebugger(void);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscStopForDebugger(void);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGatherNumberOfMessages(MPI_Comm,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt*);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGatherMessageLengths(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGatherMessageLengths2(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscMPIInt**,PetscMPIInt**,PetscMPIInt**);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPostIrecvInt(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscInt***,MPI_Request**);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscPostIrecvScalar(MPI_Comm,PetscMPIInt,PetscMPIInt,const PetscMPIInt[],const PetscMPIInt[],PetscScalar***,MPI_Request**);
EXTERN PetscErrorCode PETSC_DLLEXPORT PetscSSEIsEnabled(MPI_Comm,PetscTruth *,PetscTruth *);
/*E
InsertMode - Whether entries are inserted or added into vectors or matrices
Level: beginner
.seealso: VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(),
MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd()
E*/
typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES} InsertMode;
/*MC
INSERT_VALUES - Put a value into a vector or matrix, overwrites any previous value
Level: beginner
.seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), ADD_VALUES,
MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES
M*/
/*MC
ADD_VALUES - Adds a value into a vector or matrix, if there previously was no value, just puts the
value into that location
Level: beginner
.seealso: InsertMode, VecSetValues(), MatSetValues(), VecSetValue(), VecSetValuesBlocked(),
VecSetValuesLocal(), VecSetValuesBlockedLocal(), MatSetValuesBlocked(), INSERT_VALUES,
MatSetValuesBlockedLocal(), MatSetValuesLocal(), VecScatterBegin(), VecScatterEnd(), MAX_VALUES
M*/
/*MC
MAX_VALUES - Puts the maximum of the scattered/gathered value and the current value into each location
Level: beginner
.seealso: InsertMode, VecScatterBegin(), VecScatterEnd(), ADD_VALUES, INSERT_VALUES
M*/
/*E
ScatterMode - Determines the direction of a scatter
Level: beginner
.seealso: VecScatter, VecScatterBegin(), VecScatterEnd()
E*/
typedef enum {SCATTER_FORWARD=0, SCATTER_REVERSE=1, SCATTER_FORWARD_LOCAL=2, SCATTER_REVERSE_LOCAL=3, SCATTER_LOCAL=2} ScatterMode;
/*MC
SCATTER_FORWARD - Scatters the values as dictated by the VecScatterCreate() call
Level: beginner
.seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_REVERSE, SCATTER_FORWARD_LOCAL,
SCATTER_REVERSE_LOCAL
M*/
/*MC
SCATTER_REVERSE - Moves the values in the opposite direction then the directions indicated in
in the VecScatterCreate()
Level: beginner
.seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_FORWARD, SCATTER_FORWARD_LOCAL,
SCATTER_REVERSE_LOCAL
M*/
/*MC
SCATTER_FORWARD_LOCAL - Scatters the values as dictated by the VecScatterCreate() call except NO parallel communication
is done. Any variables that have be moved between processes are ignored
Level: developer
.seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_REVERSE, SCATTER_FORWARD,
SCATTER_REVERSE_LOCAL
M*/
/*MC
SCATTER_REVERSE_LOCAL - Moves the values in the opposite direction then the directions indicated in
in the VecScatterCreate() except NO parallel communication
is done. Any variables that have be moved between processes are ignored
Level: developer
.seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_FORWARD, SCATTER_FORWARD_LOCAL,
SCATTER_REVERSE
M*/
/*S
PetscSubcomm - Context of MPI subcommunicators, used by PCREDUNDANT
Level: advanced
Concepts: communicator, create
S*/
typedef struct _n_PetscSubcomm* PetscSubcomm;
struct _n_PetscSubcomm {
MPI_Comm parent; /* parent communicator */
MPI_Comm dupparent; /* duplicate parent communicator, under which the processors of this subcomm have contiguous rank */
MPI_Comm comm; /* this communicator */
PetscInt n; /* num of subcommunicators under the parent communicator */
PetscInt color; /* color of processors belong to this communicator */
};
EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscSubcommCreate(MPI_Comm,PetscInt,PetscSubcomm*);
EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscSubcommDestroy(PetscSubcomm);
PETSC_EXTERN_CXX_END
#endif
|