/usr/include/ug/gm.h is in libug-dev 3.12.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 | // -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
/*! \file gm.h
* \ingroup gm
*/
/******************************************************************************/
/* */
/* File: gm.h */
/* */
/* Purpose: grid manager header file (the heart of ug) */
/* */
/* Author: Peter Bastian, Klaus Johannsen */
/* */
/* Institut fuer Computeranwendungen III */
/* Universitaet Stuttgart */
/* Pfaffenwaldring 27 */
/* 70569 Stuttgart */
/* email: ug@ica3.uni-stuttgart.de */
/* */
/* blockvector data structure: */
/* Christian Wrobel */
/* Institut fuer Computeranwendungen III */
/* Universitaet Stuttgart */
/* Pfaffenwaldring 27 */
/* 70569 Stuttgart */
/* email: ug@ica3.uni-stuttgart.de */
/* */
/* History: 09.03.92 begin, ug version 2.0 (as ugtypes2.h) */
/* 13.12.94 begin, ug version 3.0 */
/* 27.09.95 blockvector implemented (Christian Wrobel) */
/* */
/* Remarks: */
/* */
/* */
/******************************************************************************/
/****************************************************************************/
/* */
/* auto include mechanism and other include files */
/* */
/****************************************************************************/
#ifndef __GM__
#define __GM__
#include <climits>
#include <cassert>
#include <cstdlib>
#include <ctime>
#include <cmath>
#include "ugtypes.h"
#include "heaps.h"
#include "ugenv.h"
#include "misc.h"
#include "debug.h"
#include "domain.h"
#include "pargm.h"
#include "cw.h"
#include "namespace.h"
#include "dimension.h"
/****************************************************************************/
/* */
/* consistency of commandline defines */
/* */
/****************************************************************************/
#ifdef __TWODIM__
#ifdef Sideon
#error **** two dimensional case cannot have side data ****
#endif
#endif
/****************************************************************************/
/* */
/* derive additional switches from commandline specified basic switches */
/* */
/****************************************************************************/
#ifdef ModelP
#define MODEL "PARALLEL"
#else
#define MODEL "SEQUENTIAL"
#endif
#undef __GRAPE_TRUE__
#ifdef _GRAPE
#define __GRAPE_TRUE__
#endif
#ifdef _GRAPE
#define GRAPE_SUPPORT "ON"
#else
#define GRAPE_SUPPORT "OFF"
#endif
#ifdef _NETGEN
#define NETGEN_SUPPORT "ON"
#else
#define NETGEN_SUPPORT "OFF"
#endif
#ifdef Debug
#define DEBUG_MODE "ON"
#else
#define DEBUG_MODE "OFF"
#endif
START_UGDIM_NAMESPACE
/****************************************************************************/
/* */
/* "hard" switches for interpolation matrix and block-vectors */
/* */
/****************************************************************************/
/** \brief Define to have matrices > 4KB (control word too small, adds integer to matrix struct) */
#define __XXL_MSIZE__
/** \brief If pointer between element/centernode is stored */
#undef __CENTERNODE__
/** \brief If interpolation matrix is stored */
#define __INTERPOLATION_MATRIX__
/** \brief If block vector descriptors are used*/
#define __BLOCK_VECTOR_DESC__
/* define USE_FAMG to use the frequencyfiltering algebraic multigrid in np/famglib */
/*#define USE_FAMG*/
#ifdef ModelP
/* This ensures that for each master node-vector all matrix-neighbors in link depth 2 are
at leat as a copy on the same processor and all connections are copied (even for ghosts) */
/*#define __OVERLAP2__*/
#endif
/* if periodic boundaries are used */
/* #define __PERIODIC_BOUNDARY__ */
/****************************************************************************/
/* */
/* defines in the following order */
/* */
/* compile time constants defining static data size (i.e. arrays) */
/* other constants */
/* macros */
/* */
/****************************************************************************/
/* Necessary for most C runtime libraries */
#undef DOMAIN
/** @name Some size parameters */
/*@{*/
/** \brief maximal space dimension */
#define DIM_MAX 3
/** \brief maximal dimension of boundary surface*/
#define DIM_OF_BND_MAX 2
/** \brief maximum depth of triangulation */
#define MAXLEVEL 32
/** \brief use 5 bits for object identification */
#define MAXOBJECTS 32
/** \brief max number of elements in selection */
#define MAXSELECTION 100
/*@}*/
/** @name Some size macros for allocation purposes */
/*@{*/
/** \brief max number of sides of an elem */
#define MAX_SIDES_OF_ELEM 6
/** \brief max number of edges of an element*/
#define MAX_EDGES_OF_ELEM 12
/** \brief max number of corners of an eleme*/
#define MAX_CORNERS_OF_ELEM 8
/** \brief max number of edges of a side */
#define MAX_EDGES_OF_SIDE 4
/** \brief max number of edges meeting in co*/
#define MAX_EDGES_OF_CORNER 4
/** \brief max number of corners of a side */
#define MAX_CORNERS_OF_SIDE 4
/** \brief an edge has always two corners.. */
#define MAX_CORNERS_OF_EDGE 2
/** \brief two sides have one edge in common*/
#define MAX_SIDES_OF_EDGE 2
/** \brief max number of sons of an element */
enum {MAX_SONS = 30};
/** \brief max number of nodes on elem side */
#define MAX_SIDE_NODES 9
/** \brief max number of son edges of edge */
#define MAX_SON_EDGES 2
/** \brief max #fine sides touching a coarse*/
#define MAX_SIDES_TOUCHING 10
/** \todo Please doc me! */
#define MAX_ELEM_VECTORS (MAX_CORNERS_OF_ELEM+MAX_EDGES_OF_ELEM+1+MAX_SIDES_OF_ELEM)
/** \brief max number of doubles in a vector or matrix mod 32 */
#define MAX_NDOF_MOD_32 256
/** \brief max number of doubles in a vector or matrix */
#define MAX_NDOF 32*MAX_NDOF_MOD_32
/*@}*/
/****************************************************************************/
/* */
/* defines for algebra */
/* */
/****************************************************************************/
/** \brief Number of different data types */
#define MAXVOBJECTS 4
/** \brief max number of abstract vector types */
#define MAXVECTORS 4
#if (MAXVECTORS<MAXVOBJECTS)
#error *** MAXVECTORS must not be smaller than MAXVOBJECTS ***
#endif
/** \brief to indicate type not defined */
#define NOVTYPE -1
/** \brief max number of geometric domain parts */
#define MAXDOMPARTS 4
/** \brief transforms type into bitpattern */
#define BITWISE_TYPE(t) (1<<(t))
/* derived sizes for algebra */
/** \brief max number of diff. matrix types */
#define MAXMATRICES MAXVECTORS*MAXVECTORS
/** \brief max number of diff. connections */
#define MAXCONNECTIONS (MAXMATRICES + MAXVECTORS)
/** \todo Please doc me! */
#define MATRIXTYPE(rt,ct) ((rt)*MAXVECTORS+(ct))
/** \todo Please doc me! */
#define DIAGMATRIXTYPE(rt) (MAXMATRICES+rt)
/** \brief Type of geometric entity which a certain vector is attached to */
enum VectorType {NODEVEC, /**< Vector associated to a node */
EDGEVEC, /**< Vector associated to an edge */
ELEMVEC, /**< Vector associated to an element */
SIDEVEC /**< Vector associated to an element side */
};
/** @name Some constants for abstract vector type names */
/*@{*/
/** \todo Please doc me! */
#define FROM_VTNAME '0'
/** \todo Please doc me! */
#define TO_VTNAME 'z'
/** \todo Please doc me! */
#define MAXVTNAMES (1+TO_VTNAME-FROM_VTNAME)
/*@}*/
/** @name Constants for blockvector description (BVD) */
/*@{*/
/** \brief number for "there is no blockvector"; largest number of type BLOCKNUMBER */
#define NO_BLOCKVECTOR ((BLOCKNUMBER) ~0)
/** \brief largest admissible blockvector number */
#define MAX_BV_NUMBER (NO_BLOCKVECTOR - 1)
/** \brief largest admissible blockvector level number */
#define MAX_BV_LEVEL UCHAR_MAX
/** \brief Maximum number
of entries in a BVD; NOTE: the actual available
number of entries depends on the range of each entry */
#define BVD_MAX_ENTRIES (sizeof(BVD_ENTRY_TYPE)*CHAR_BIT)
/*@}*/
/** @name Constants for BLOCKVECTOR */
/*@{*/
/** \brief symbolic value for BVDOWNTYPE */
enum {BVDOWNTYPEVECTOR,
BVDOWNTYPEBV,
BVDOWNTYPEDIAG};
/** \brief symbolic value for BVTVTYPE */
enum {BV1DTV,
BV2DTV};
enum {BVNOORIENTATION, /**< No special orientation for BVORIENTATION */
BVHORIZONTAL, /**< Vectors form a horizontal line for BVORIENTATION */
BVVERTICAL /**< Vectors form a vertical line for BVORIENTATION */
};
/*@}*/
/****************************************************************************/
/* */
/* various defines */
/* */
/****************************************************************************/
/** 0 = OK as usual */
/** @name result codes of user supplied functions*/
/*@{*/
/** \brief coordinate out of range */
#define OUT_OF_RANGE 1
/** \brief configProblem could not init problem */
#define CANNOT_INIT_PROBLEM 1
/** \brief Use of GSTATUS (for grids), use power of 2 */
enum {GSTATUS_BDF = 1,
GSTATUS_INTERPOLATE = 2,
GSTATUS_ASSEMBLED = 4,
GSTATUS_ORDERED = 8};
/*@}*/
/** \brief Selection mode */
enum {nodeSelection=1, /**< Objects selected are nodes */
elementSelection=2, /**< Objects selected are elements */
vectorSelection=3 /**< Objects selected are vectors */
};
/** \brief Possible values for rule in MarkForRefinement */
enum RefinementRule
{NO_REFINEMENT = 0,
COPY = 1,
RED = 2,
BLUE = 3,
COARSE = 4,
#ifdef __TWODIM__
BISECTION_1 = 5,
BISECTION_2_Q = 6,
BISECTION_2_T1 = 7,
BISECTION_2_T2 = 8,
BISECTION_3 = 9
#endif
#ifdef __THREEDIM__
TETRA_RED_HEX = 5,
PRISM_BISECT_1_2 = 9,
PRISM_QUADSECT = 7,
PRISM_BISECT_HEX0 = 5,
PRISM_BISECT_HEX1 = 8,
PRISM_BISECT_HEX2 = 6,
PRISM_ROTATE_LEFT = 10,
PRISM_ROTATE_RGHT = 11,
PRISM_QUADSECT_HEXPRI0 = 14,
PRISM_RED_HEX = 15,
PRISM_BISECT_0_1, /* No explicit numbers. Maybe they are not necessary? */
PRISM_BISECT_0_2,
PRISM_BISECT_0_3,
HEX_BISECT_0_1 = 5,
HEX_BISECT_0_2 = 6,
HEX_BISECT_0_3 = 7,
HEX_TRISECT_0 = 8,
HEX_TRISECT_5 = 9,
HEX_QUADSECT_0 = 12,
HEX_QUADSECT_1 = 13,
HEX_QUADSECT_2 = 14,
HEX_BISECT_HEXPRI0 = 15,
HEX_BISECT_HEXPRI1 = 16
#endif
};
/** \brief Values for element class */
enum MarkClass {NO_CLASS,
YELLOW_CLASS,
GREEN_CLASS,
RED_CLASS,
SWITCH_CLASS};
/** \brief Values for node types (relative to the father element of the vertex) */
enum NodeType {CORNER_NODE,
MID_NODE,
SIDE_NODE,
CENTER_NODE,
LEVEL_0_NODE};
/** @name Macros for the multigrid user data space management */
/*@{*/
#define OFFSET_IN_MGUD(id) (GetMGUDBlockDescriptor(id)->offset)
#define IS_MGUDBLOCK_DEF(id) (GetMGUDBlockDescriptor(id)!=NULL)
/*@}*/
/* REMARK: TOPNODE no more available since 970411
because of problems in parallelisation
to use it in serial version uncomment define
#define TOPNODE(p) ((p)->iv.topnode)
*/
/** \brief Modes for LexOrderVectorsInGrid */
enum {OV_CARTES,
OV_POLAR};
/****************************************************************************/
/* */
/* format definition data structure */
/* */
/****************************************************************************/
/*----------- general typedefs ---------------------------------------------*/
/** @name General typedefs */
/*@{*/
typedef DOUBLE DOUBLE_VECTOR[DIM];
typedef DOUBLE DOUBLE_VECTOR_2D[2];
typedef DOUBLE DOUBLE_VECTOR_3D[3];
/*@}*/
/*----------- typedef for functions ----------------------------------------*/
/** \brief Print user data --> string
* @param pointer to user data
* @param Prefix for each line
* @param resulting string
*/
typedef INT (*ConversionProcPtr)(void *, const char *, char *);
/** \brief Tagged print user data --> string
*
*/
typedef INT (*TaggedConversionProcPtr)(INT, /**< Tag for data identification */
void *, /**< Pointer to user data */
const char *, /**< Prefix for each line */
char * /**< Resulting string */
);
/*----------- definition of structs ----------------------------------------*/
/* struct documentation is in gm.doc */
struct format {
/** \brief fields for environment variable */
NS_PREFIX ENVDIR d;
/* variables of format */
/** \brief size of vertex user data struc. in bytes*/
INT sVertex;
/** \brief size of mg user data structure in bytes */
INT sMultiGrid;
/** \brief number of doubles in vectors */
INT VectorSizes[MAXVECTORS];
/** \brief a single char for abstract type name */
char VTypeNames[MAXVECTORS];
/** \brief number of doubles in matrices */
INT MatrixSizes[MAXCONNECTIONS];
#ifdef __INTERPOLATION_MATRIX__
/** \brief number of doubles in matrices */
INT IMatrixSizes[MAXMATRICES];
#endif
/** \brief depth of connection for matrices */
INT ConnectionDepth[MAXCONNECTIONS];
/** \todo Please doc me! */
INT elementdata;
/** \todo Please doc me! */
INT nodeelementlist;
/** \todo Please doc me! */
INT nodedata;
/** \brief print user data to string */
ConversionProcPtr PrintVertex;
/** \todo Please doc me! */
ConversionProcPtr PrintGrid;
/** \todo Please doc me! */
ConversionProcPtr PrintMultigrid;
/** \todo Please doc me!
*
* tag indicates VTYPE
*/
TaggedConversionProcPtr PrintVector;
/** \todo Please doc me!
*
* tag indicates MTP
*/
TaggedConversionProcPtr PrintMatrix;
/* table connecting parts, objects and types */
/** \brief (part,obj) --> vtype, -1 if not defined */
INT po2t[MAXDOMPARTS][MAXVOBJECTS];
/* derived components */
/** \brief maximal connection depth */
INT MaxConnectionDepth;
/** \brief geometrical depth corresponding */
INT NeighborhoodDepth;
/* algebraic con with depth 1 */
/* both derived from ConnectionDepth */
/** \brief type --> part, bitwise, not unique */
INT t2p[MAXVECTORS];
/** \brief type --> object, bitwise, not unique */
INT t2o[MAXVECTORS];
/* both derived from po2t */
/** \brief type --> type name */
char t2n[MAXVECTORS];
/** \brief type name --> type */
INT n2t[MAXVTNAMES];
/** \brief 0 if vector not needed for geom object */
INT OTypeUsed[MAXVOBJECTS];
/** \brief largest part used */
INT MaxPart;
/* both derived from po2t */
/** \brief largest type used */
INT MaxType;
/* derived from VectorSizes */
};
typedef struct {
/** \brief Abstract type is described here
*
* description only complete with po2t info
*/
int tp;
/** \brief A single char as name of abstract type */
char name;
/* \brief Data size in bytes */
int size;
} VectorDescriptor ;
typedef struct {
/** \brief This connection goes from position 'from' */
int from;
/** \brief to position 'to' */
int to;
/** \brief 1 if diagonal, 0 if not */
int diag;
/** \brief Number of bytes per connection */
int size;
/** \brief Size of interpolation matrices */
int isize;
/** \brief Connect with depth in dual graph */
int depth;
} MatrixDescriptor ;
/****************************************************************************/
/* */
/* matrix/vector/blockvector data structure */
/* */
/****************************************************************************/
/* data structure for BlockvectorDescription */
typedef UINT BVD_ENTRY_TYPE; /**< Memory providing storage for level numbers */
typedef UINT BLOCKNUMBER; /**< Valid numbers are 0..MAX_BV_NUMBER */
typedef unsigned char BLOCKLEVEL; /**< Valid levels are 0..MAX_BV_LEVEL */
/** \brief Describes how a struct of type blockvector_description is to be interpreted */
struct blockvector_description_format
{
/** \brief Bits per block number entry */
INT bits;
/** \brief Maximum number of entries */
BLOCKLEVEL max_level;
/** \brief level_mask[i] = mask entries for levels 0..i */
BVD_ENTRY_TYPE level_mask[BVD_MAX_ENTRIES];
/** \brief neg_digit_mask[i] = masks out entry for level i */
BVD_ENTRY_TYPE neg_digit_mask[BVD_MAX_ENTRIES];
};
typedef struct blockvector_description_format BV_DESC_FORMAT;
/** \brief Describes the position of a blockvector in a hierarchy of blockvectors */
struct blockvector_description
{
/** \brief Sequence of block levels according to a certain blockvector_description_format */
BVD_ENTRY_TYPE entry;
/** \brief Levels 0..current-1 currently valid */
BLOCKLEVEL current;
/** \brief Level 'read' is next to be read */
BLOCKLEVEL read;
};
typedef struct blockvector_description BV_DESC;
/* Struct documentation in gm.doc */
struct vector {
/** \brief object identification, various flags */
UINT control;
/** \brief associated object */
union geom_object *object;
#ifdef ModelP
/** \todo Please doc me! */
DDD_HEADER ddd;
#endif
/** \brief double linked list of vectors */
struct vector *pred,*succ;
/** \brief ordering of unknowns */
UINT index;
#ifdef FOR_DUNE
#ifndef ModelP // Dune uses ddd.gid for ids in parallel
/** \brief A unique and persistent, but not necessarily consecutive index
Used to implement face ids for Dune.
*/
INT id;
#endif
#endif
/** \brief used bitwise to skip unknowns */
UINT skip;
/** \brief implements matrix */
struct matrix *start;
#ifdef __BLOCK_VECTOR_DESC__
/** \brief membership to the blockvector levels */
BV_DESC block_descr;
#endif
#ifdef __INTERPOLATION_MATRIX__
/** \brief implements interpolation matrix */
struct matrix *istart;
#endif
/** \brief User data */
DOUBLE value[1];
};
typedef struct vector VECTOR;
/* Struct documentation in gm.doc */
struct matrix {
/** \brief object identification, various flags */
UINT control;
#ifdef __XXL_MSIZE__
/** \brief for people needing large matrices */
UINT xxl_msize;
#endif
/** \brief row list */
struct matrix *next;
/** \brief destination vector */
struct vector *vect;
/** \brief User data */
DOUBLE value[1];
};
typedef struct matrix MATRIX;
typedef struct matrix CONNECTION;
/* Struct documentation in gm.doc */
struct blockvector
{
/** \brief Object identification, various flags */
UINT control;
/** \brief Logical blockvector number */
BLOCKNUMBER number;
/** \brief Realize doubly linked list of blockvectors */
struct blockvector *pred,*succ;
/** \brief Start vector of this blockvector */
VECTOR *first_vec;
/** \brief Last vector of this blockvector */
VECTOR *last_vec;
/** \brief Number of covered VECTORs */
INT vec_number;
/** \brief Pointer to any data */
void *user_data;
/** \brief Start of blockvector list on next level*/
struct blockvector *first_son;
/** \brief End of blockvector list on next level */
struct blockvector *last_son;
};
typedef struct blockvector BLOCKVECTOR;
/****************************************************************************/
/* */
/* unstructured grid data structures */
/* */
/****************************************************************************/
/*----------- typedef for functions ----------------------------------------*/
/*----------- definition of structs ----------------------------------------*/
/** \brief Inner vertex data structure */
struct ivertex {
/** \brief Object identification, various flags */
UINT control;
/** \brief Unique id used for load/store */
INT id;
/** \brief Vertex position */
DOUBLE x[DIM];
/** \brief Local coordinates in father element */
DOUBLE xi[DIM];
#ifdef FOR_DUNE
/* When UG is used as part of the DUNE numerics system we need
a few more indices per node */
/** \brief An index hat is unique and consecutive per level.
Controlled by DUNE */
int leafIndex;
#endif
#ifdef ModelP
/** \todo Please doc me! */
DDD_HEADER ddd;
#endif
/* pointers */
/** \brief Doubly linked list of vertices */
union vertex *pred,*succ;
/** \brief Associated user data structure */
void *data;
/** \brief Father element */
union element *father;
#ifdef TOPNODE
/** \brief Highest node where defect is valid
\todo REMARK: TOPNODE no more available since 970411
because of problems in parallelisation
to use it in serial version uncomment define TOPNODE */
struct node *topnode;
#endif
};
/** \brief Boundary vertex data structure */
struct bvertex {
/* variables */
/** \brief Object identification, various flags */
UINT control;
/** \brief Unique id used for load/store */
INT id;
/** \brief Vertex position */
DOUBLE x[DIM];
/** \brief Local coordinates in father element */
DOUBLE xi[DIM];
#ifdef FOR_DUNE
/* When UG is used as part of the DUNE numerics system we need
a few more indices per node */
/** \brief An index hat is unique and consecutive per level.
Controlled by DUNE */
int leafIndex;
#endif
#ifdef ModelP
/** \brief Information about the parallelization of this object */
DDD_HEADER ddd;
#endif
/* pointers */
/** \brief Doubly linked list of vertices */
union vertex *pred,*succ;
/** \brief Associated user data structure */
void *data;
/** \brief Father element */
union element *father;
#ifdef TOPNODE
/** \brief Highest node where defect is valid
\todo REMARK: TOPNODE no more available since 970411
because of problems in parallelisation
to use it in serial version uncomment define TOPNODE */
struct node *topnode;
#endif
/** \brief Pointer to boundary point decriptor */
BNDP *bndp;
};
/** \brief Only used to define pointer to vertex */
union vertex {
struct ivertex iv;
struct bvertex bv;
};
/** \brief A simply linked list of elements */
struct elementlist {
union element *el;
struct elementlist *next;
};
/** \brief Level-dependent part of a vertex */
struct node {
/** \brief Object identification, various flags */
UINT control;
/** \brief Unique id used for load/store */
INT id;
#ifdef FOR_DUNE
/* When UG is used as part of the DUNE numerics system we need
a few more indices per node */
/** \brief An index hat is unique and consecutive per level.
Controlled by DUNE */
int levelIndex;
/** \brief Information if this node is on the leaf. */
bool isLeaf;
#ifdef ModelP
/** \brief Per-node message buffer used by Dune for dynamic load-balancing */
char* message_buffer;
#endif
#endif
#ifdef ModelP
/** \brief Information about the parallelization of this object */
DDD_HEADER ddd;
#endif
/* pointers */
/** \brief Doubly linked list of nodes per level*/
struct node *pred,*succ;
/** \brief List of links */
struct link *start;
/** \brief Node or edge on coarser level (NULL if none) */
union geom_object *father;
/** \brief Node on finer level (NULL if none) */
struct node *son;
/** \brief Corresponding vertex structure */
union vertex *myvertex;
/** \brief Associated vector
*
* WARNING: the allocation of the vector pointer depends on the format */
VECTOR *vector;
/** \brief Associated data pointer
*
* WARNING: The allocation of the data pointer depends on the format */
void *data;
};
/** \todo Please doc me! */
struct link {
/** \brief object identification, various flags */
UINT control;
/** \brief ptr to next link */
struct link *next;
/** \brief ptr to neighbor node */
struct node *nbnode;
/** \brief ptr to neighboring elem */
#if defined(__TWODIM__)
union element *elem;
#endif
};
/** \brief Undirected edge of the grid graph */
struct edge {
/* variables */
/* two links */
struct link links[2];
#ifdef FOR_DUNE
/* When UG is used as part of the DUNE numerics system we need
place to store codim dim-1 indices */
/** \brief An index hat is unique and consecutive per level.
Controlled by DUNE */
int levelIndex;
/** \brief An index hat is unique and consecutive on the grid surface.
Controlled by DUNE */
int leafIndex;
/** \brief A unique and persistent, but not necessarily consecutive index */
INT id;
#endif
#ifdef ModelP
/** Bookkeeping information for DDD */
DDD_HEADER ddd;
#endif
/** \brief Pointer to mid node on next finer grid */
struct node *midnode;
/** \brief associated vector
*
* WARNING: the allocation of the vector pointer depends on the format */
VECTOR *vector;
};
/** \brief A generic grid element
No difference between inner and boundary elements
*/
struct generic_element {
/** \brief object identification, various flags */
UINT control;
/** \brief unique id used for load/store */
INT id;
/** \brief additional flags for elements */
UINT flag;
/** \brief to store NodeOrder for hexahedrons */
INT property;
#ifdef FOR_DUNE
/* When UG is used as part of the DUNE numerics system we need
a few more indices per element */
/** \brief An index hat is unique and consecutive per level.
Controlled by DUNE */
int levelIndex;
/** \brief An index hat is unique and consecutive on the grid surface.
Controlled by DUNE */
int leafIndex;
#ifdef ModelP
/** \brief Per-node message buffer used by Dune for dynamic load-balancing */
char* message_buffer;
#endif
#endif
#ifdef ModelP
/** \brief Information about the parallelization of this object */
DDD_HEADER ddd;
/** \brief Stores partition information */
INT lb1;
#endif
/** \brief double linked list of elements */
union element *pred, *succ;
#ifdef __CENTERNODE__
/** \brief Pointer to center node */
struct node *centernode;
#endif
/** \brief Element specific part of variable length array managed by ug */
void *refs[1];
};
/** \brief A triangle element in a 2d grid
\implements generic_element
*/
struct triangle {
/** \brief Object identification, various flags */
UINT control;
/** \brief Unique id used for load/store */
INT id;
/** \brief Additional flags for elements */
UINT flag;
/** \brief Even more property bits */
INT property;
#ifdef FOR_DUNE
/* When UG is used as part of the DUNE numerics system we need
a few more indices per element */
/** \brief An index hat is unique and consecutive per level.
Controlled by DUNE */
int levelIndex;
/** \brief An index hat is unique and consecutive on the grid surface.
Controlled by DUNE */
int leafIndex;
#ifdef ModelP
/** \brief Per-node message buffer used by Dune for dynamic load-balancing */
char* message_buffer;
#endif
#endif
#ifdef ModelP
/** \brief Information about the parallelization of this object */
DDD_HEADER ddd;
/** \brief stores partition information */
INT lb1;
#endif
/** \brief Realize a doubly linked list of elements */
union element *pred, *succ;
#ifdef __CENTERNODE__
/** \brief Pointer to the center node */
struct node *centernode;
#endif
/** \brief Corners of this element */
struct node *n[3];
/** \brief Father element on next-coarser grid */
union element *father;
#ifdef ModelP
/** \brief Element tree */
union element *sons[2];
#else
/** \brief Element tree */
union element *sons[1];
#endif
/** \brief The neighboring elements */
union element *nb[3];
/** \brief Associated vector
WARNING: the allocation of the vector pointer depends on the format
void *ptr[4] would be possible too:
if there are no element vectors, the sides will be ptr[0],ptr[1],ptr[2]
Use the macros to find the correct address! */
VECTOR *vector;
/** \brief Only on the boundary, NULL if interior side */
BNDS *bnds[3];
/* \brief Associated data pointer
WARNING: the allocation of the data pointer depends on the format */
void *data;
};
/** \brief A quadrilateral element in a 2d grid
\implements generic_element
*/
struct quadrilateral {
/** \brief object identification, various flags */
UINT control;
/** \brief unique id used for load/store */
INT id;
/** \brief additional flags for elements */
UINT flag;
/** \brief Even more flags */
INT property;
#ifdef FOR_DUNE
/* When UG is used as part of the DUNE numerics system we need
a few more indices per element */
/** \brief An index hat is unique and consecutive per level.
Controlled by DUNE */
int levelIndex;
/** \brief An index hat is unique and consecutive on the grid surface.
Controlled by DUNE */
int leafIndex;
#ifdef ModelP
/** \brief Per-node message buffer used by Dune for dynamic load-balancing */
char* message_buffer;
#endif
#endif
#ifdef ModelP
/** \brief Information about the parallelization of this object */
DDD_HEADER ddd;
/** \brief stores partition information */
INT lb1;
#endif
/** \brief doubly linked list of elements */
union element *pred, *succ;
#ifdef __CENTERNODE__
/** \brief pointer to center node */
struct node *centernode;
#endif
/** \brief corners of that element */
struct node *n[4];
/** \brief father element on coarser grid */
union element *father;
#ifdef ModelP
/** \brief Element tree */
union element *sons[2];
#else
/** \brief Element tree */
union element *sons[1];
#endif
/** \brief The neighbor elements */
union element *nb[4];
/** \brief Associated vector
WARNING: the allocation of the vector pointer depends on the format
void *ptr[5] would be possible too:
if there are no element vectors, the sides will be ptr[0],ptr[1], ..
Use the macros to find the correct address!
*/
VECTOR *vector;
/** \brief only on bnd, NULL if interior side */
BNDS *bnds[4];
/** \brief Associated data pointer
WARNING: the allocation of the data pointer depends on the format */
void *data;
};
/** \brief A tetrahedral element in a 3d grid
\implements generic_element
*/
struct tetrahedron {
/** \brief object identification, various flags */
UINT control;
/** \brief Unique id used for load/store */
INT id;
/** \brief Additional flags */
UINT flag;
/** \brief Even more flags */
INT property;
#ifdef FOR_DUNE
/* When UG is used as part of the DUNE numerics system we need
a few more indices per element */
/** \brief An index hat is unique and consecutive per level.
Controlled by DUNE */
int levelIndex;
/** \brief An index hat is unique and consecutive on the grid surface.
Controlled by DUNE */
int leafIndex;
#ifdef ModelP
/** \brief Per-node message buffer used by Dune for dynamic load-balancing */
char* message_buffer;
#endif
#endif
#ifdef ModelP
/** \brief Information about the parallelization of this element */
DDD_HEADER ddd;
/** \brief Stores partition information */
INT lb1;
#endif
/* pointers */
/** \brief Realize a double linked list of elements */
union element *pred, *succ;
#ifdef __CENTERNODE__
/** \brief Pointer to the center node */
struct node *centernode;
#endif
/** \brief Corners of this element */
struct node *n[4];
/** \brief Father element on coarser grid */
union element *father;
#ifdef ModelP
/** \brief Element tree */
union element *sons[2]; /* element tree */
#else
/** \brief Element tree */
union element *sons[1];
#endif
/** \brief The neighboring elements */
union element *nb[4];
/** \brief Associated vector
WARNING: the allocation of the vector pointer depends on the format
void *ptr[9] would be possible too:
if there are no element vectors, the sides will be ptr[0],ptr[1], ..
Use the macros to find the correct address! */
VECTOR *vector;
/** \brief Associated vector for sides */
VECTOR *sidevector[4];
/** \brief The boundary segments, NULL if interior side */
BNDS *bnds[4];
/** \brief Associated data pointer
WARNING: the allocation of the data pointer depends on the format */
void *data;
};
/** \brief A pyramid element in a 3d grid
\implements generic_element
*/
struct pyramid {
/** \brief object identification, various flags */
UINT control;
/** \brief Unique id used for load/store */
INT id;
/** \brief Additional flags for elements */
UINT flag;
/** \brief Even more flags */
INT property;
#ifdef FOR_DUNE
/* When UG is used as part of the DUNE numerics system we need
a few more indices per element */
/** \brief An index hat is unique and consecutive per level.
Controlled by DUNE */
int levelIndex;
/** \brief An index hat is unique and consecutive on the grid surface.
Controlled by DUNE */
int leafIndex;
#ifdef ModelP
/** \brief Per-node message buffer used by Dune for dynamic load-balancing */
char* message_buffer;
#endif
#endif
#ifdef ModelP
/** \brief Information about the parallelization of this element */
DDD_HEADER ddd;
/** \brief Stores partition information */
INT lb1;
#endif
/* pointers */
/** \brief Realize a doubly linked list of elements */
union element *pred, *succ;
#ifdef __CENTERNODE__
/** \brief Pointer to center node */
struct node *centernode;
#endif
/** \brief Corners of this element */
struct node *n[5];
/** \brief Father element on coarser grid */
union element *father;
#ifdef ModelP
/** \brief Element tree */
union element *sons[2];
#else
/** \brief Element tree */
union element *sons[1];
#endif
/** \brief The neighbor elements */
union element *nb[5];
/** \brief Associated vector
WARNING: the allocation of the vector pointer depends on the format
void *ptr[11] would be possible too:
if there are no element vectors, the sides will be ptr[0],ptr[1], ..
Use the macros to find the correct address! */
VECTOR *vector;
/** \brief Associated vector for sides */
VECTOR *sidevector[5];
/** \brief The boundary segments, NULL if interior side */
BNDS *bnds[5];
/** \brief Associated data pointer
WARNING: the allocation of the data pointer depends on the format */
void *data;
};
/** \brief A prism element in a 3d grid
\implements generic_element
*/
struct prism {
/** \brief object identification, various flags */
UINT control;
/** \brief Unique id used for load/store */
INT id;
/** \brief Additional flags for this element */
UINT flag;
/** \brief Even more flags */
INT property;
#ifdef FOR_DUNE
/* When UG is used as part of the DUNE numerics system we need
a few more indices per element */
/** \brief An index hat is unique and consecutive per level.
Controlled by DUNE */
int levelIndex;
/** \brief An index hat is unique and consecutive on the grid surface.
Controlled by DUNE */
int leafIndex;
#ifdef ModelP
/** \brief Per-node message buffer used by Dune for dynamic load-balancing */
char* message_buffer;
#endif
#endif
#ifdef ModelP
/** \brief Information about the parallelization of this element */
DDD_HEADER ddd;
/** \brief Stores partition information */
INT lb1;
#endif
/* pointers */
/** \brief Realize doubly linked list */
union element *pred, *succ;
#ifdef __CENTERNODE__
/** \brief Pointer to center node */
struct node *centernode;
#endif
/** \brief Corners of this element */
struct node *n[6];
/** \brief Father element on next coarser grid */
union element *father;
#ifdef ModelP
/** \brief Element tree */
union element *sons[2];
#else
/** \brief Element tree */
union element *sons[1];
#endif
/** \brief Neighbor elements */
union element *nb[5];
/** \brief Associated vector
WARNING: the allocation of the vector pointer depends on the format
void *ptr[11] would be possible too:
if there are no element vectors, the sides will be ptr[0],ptr[1], ...
Use the macros to find the correct address!
*/
VECTOR *vector;
/** \brief Associated vectors for sides */
VECTOR *sidevector[5];
/** \brief Boundary segments, NULL if interior side */
BNDS *bnds[5];
/** \brief Associated data pointer
WARNING: the allocation of the data pointer depends on the format */
void *data;
};
/** \brief A hexahedral element in a 3d grid
\implements generic_element
*/
struct hexahedron {
/** \brief object identification, various flags */
UINT control;
/** \brief Unique id used for load/store */
INT id;
/** \brief Additional flags for this element */
UINT flag;
/** \brief Even more flags */
INT property;
#ifdef FOR_DUNE
/* When UG is used as part of the DUNE numerics system we need
a few more indices per element */
/** \brief An index hat is unique and consecutive per level.
Controlled by DUNE */
int levelIndex;
/** \brief An index hat is unique and consecutive on the grid surface.
Controlled by DUNE */
int leafIndex;
#ifdef ModelP
/** \brief Per-node message buffer used by Dune for dynamic load-balancing */
char* message_buffer;
#endif
#endif
#ifdef ModelP
/** \brief Information about the parallelization of this element */
DDD_HEADER ddd;
/** \brief Stores partition information */
INT lb1;
#endif
/** \brief Realize doubly linked list of elements on one grid level */
union element *pred, *succ;
#ifdef __CENTERNODE__
/** \brief Pointer to center node */
struct node *centernode;
#endif
/** \brief Corners of this element */
struct node *n[8];
/** \brief Father element on coarser grid */
union element *father;
#ifdef ModelP
/** \brief Element tree */
union element *sons[2];
#else
/** \brief Element tree */
union element *sons[1];
#endif
/** \brief The neighboring elements */
union element *nb[6];
/** \brief Associated vector
WARNING: the allocation of the vector pointer depends on the format
void *ptr[13] would be possible too:
if there are no element vectors, the sides will be ptr[0],ptr[1], ...
Use the macros to find the correct address!
*/
VECTOR *vector;
/** \brief Associated vectors for sides */
VECTOR *sidevector[6];
/** \brief Boundary segments, NULL if interior side */
BNDS *bnds[6];
/** \brief Associated data pointer
WARNING: the allocation of the data pointer depends on the format */
void *data;
} ;
/** \brief Objects that can hold an element */
union element {
struct generic_element ge;
#ifdef __TWODIM__
struct triangle tr;
struct quadrilateral qu;
#endif
#ifdef __THREEDIM__
struct tetrahedron te;
struct pyramid py;
struct prism pr;
struct hexahedron he;
#endif
};
/** \brief Objects that can hold a vector */
union geom_object {
struct node nd;
struct edge ed;
union element el;
};
/** \brief Objects that can be selected */
union selection_object {
struct node nd;
union element el;
struct vector ve;
};
/** \brief Objects that can have a key */
union object_with_key {
struct node nd;
union element el;
struct vector ve;
union vertex vertex;
struct edge edge;
};
typedef struct
{
UINT VecReserv[MAXVECTORS][MAX_NDOF_MOD_32];
UINT MatReserv[MAXCONNECTIONS][MAX_NDOF_MOD_32];
/** \todo Is this used anywhere? */
UINT VecConsistentStatus[MAXMATRICES][MAX_NDOF_MOD_32];
/** \todo Is this used anywhere? */
UINT VecCollectStatus[MAXMATRICES][MAX_NDOF_MOD_32];
} DATA_STATUS;
struct grid {
/** \brief Object identification, various flags */
UINT control;
/** \brief level + 32; needed for control word check not detecting HEAPFAULT */
INT attribut;
/** \brief A word storing status information. This can be used also by the
problem class, e.g. to store whether the grid level is assembled or not. */
INT status;
/** \brief Level within the multigrid structure */
INT level;
/** \brief Number of vertices */
INT nVert[NS_DIM_PREFIX MAX_PRIOS];
/** \brief Number of nodes on this grid level */
INT nNode[NS_DIM_PREFIX MAX_PRIOS];
/** \brief Number of elements on this grid level */
INT nElem[NS_DIM_PREFIX MAX_PRIOS];
/** \brief Number of edges on this grid level */
INT nEdge;
/** \brief Number of vectors on this grid level */
INT nVector[NS_DIM_PREFIX MAX_PRIOS];
/** \brief Number of connections on this grid level */
INT nCon;
#ifdef __INTERPOLATION_MATRIX__
/** \brief Number of interpolation matrices */
INT nIMat;
#endif
DATA_STATUS data_status; /* memory management for vectors|matrix */
/* status for consistent and collect */
/* pointers */
union element *elements[NS_DIM_PREFIX ELEMENT_LISTPARTS]; /* pointer to first element*/
union element *lastelement[NS_DIM_PREFIX ELEMENT_LISTPARTS]; /*pointer to last element*/
union vertex *vertices[NS_DIM_PREFIX VERTEX_LISTPARTS]; /* pointer to first vertex */
union vertex *lastvertex[NS_DIM_PREFIX VERTEX_LISTPARTS]; /* pointer to last vertex */
struct node *firstNode[NS_DIM_PREFIX NODE_LISTPARTS]; /* pointer to first node */
struct node *lastNode[NS_DIM_PREFIX NODE_LISTPARTS]; /* pointer to last node */
VECTOR *firstVector[NS_DIM_PREFIX VECTOR_LISTPARTS]; /* pointer to first vector */
VECTOR *lastVector[NS_DIM_PREFIX VECTOR_LISTPARTS]; /* pointer to last vector */
/** \brief Pointer to the first blockvector
Valid only if the BLOCKVECTOR mechanism is used, otherwise they are NULL. */
BLOCKVECTOR *firstblockvector;
/** \brief Pointer to the last blockvector
Valid only if the BLOCKVECTOR mechanism is used, otherwise they are NULL. */
BLOCKVECTOR *lastblockvector;
struct grid *coarser, *finer; /* coarser and finer grids */
struct multigrid *mg; /* corresponding multigrid structure */
};
struct multigrid {
/** \brief env item */
NS_PREFIX ENVDIR v;
/** \brief Multigrid status word */
INT status;
/** \brief used for identification */
INT magic_cookie;
/** \brief is bottom memory temp allocated?
This field is really only necessary when DYNAMIC_MEMORY_ALLOCMODEL is set.
However, as struct declarations should not depend on settings in config.h
we leave in the field anyways. It's just four bytes per multigrid.
*/
INT bottomtmpmem;
/** \brief count objects in that multigrid */
INT vertIdCounter;
/** \brief count objects in that multigrid */
INT nodeIdCounter;
/** \brief count objects in that multigrid */
INT elemIdCounter;
#ifdef FOR_DUNE
/** \brief count objects in that multigrid */
INT edgeIdCounter;
#ifndef ModelP
/** \brief Count vector objects in that multigrid */
INT vectorIdCounter;
#endif
#endif
/** \brief depth of the element tree */
INT topLevel;
/** \brief level we are working on */
INT currentLevel;
/** \brief last level with complete surface */
INT fullrefineLevel;
/** \brief bottom level for AMG */
INT bottomLevel;
/** \brief pointer to BndValProblem */
BVP *theBVP;
/** \brief description of BVP-properties */
BVP_DESC theBVPD;
/** \brief pointer to format definitions */
struct format *theFormat;
/** \brief associated heap structure */
NS_PREFIX HEAP *theHeap;
/** \brief max nb of properties used in elements*/
INT nProperty;
/** \brief memory management for vectors|matrix
* status for consistent and collect */
DATA_STATUS data_status;
/* pointers */
/** \brief pointers to the grids */
struct grid *amggrids[MAXLEVEL];
/** \brief pointers to the grids */
struct grid *grids[MAXLEVEL];
/* NodeElementPointerArray used for an O(n) InsertElement */
/** \brief pointer to the node element blocks */
union element ***ndelemptrarray;
/* selection */
/** \brief number of selected objects */
INT NbOfSelections;
/** \brief selectionmode (see above) */
INT SelectionMode;
/** \brief pointer to selec obj*/
union selection_object *Selection[MAXSELECTION];
/* user data */
/** \brief general user data space */
void *GenData;
/** \brief user heap */
NS_PREFIX HEAP *UserHeap;
/** \brief general purpose pointer */
void *genpurp;
/* i/o handling */
/** \brief 1 if multigrid saved */
INT saved;
/** \brief filename if saved */
char filename[NS_PREFIX NAMESIZE];
/** \brief coarse grid complete */
INT CoarseGridFixed;
/** \brief coarse grid MarkKey for SIMPLE_HEAP Mark/Release */
INT MarkKey;
};
/****************************************************************************/
/* */
/* typedef for structs */
/* */
/****************************************************************************/
/* geometrical part */
typedef struct format FORMAT;
typedef union vertex VERTEX;
typedef struct elementlist ELEMENTLIST;
typedef struct node NODE;
typedef union element ELEMENT;
typedef struct link LINK;
typedef struct edge EDGE;
typedef union geom_object GEOM_OBJECT;
typedef union selection_object SELECTION_OBJECT;
typedef struct grid GRID;
typedef struct multigrid MULTIGRID;
typedef union object_with_key KEY_OBJECT;
/****************************************************************************/
/* */
/* structs for evaluation functions */
/* */
/****************************************************************************/
/*----------- typedef for functions ----------------------------------------*/
typedef INT (*PreprocessingProcPtr)(const char *, MULTIGRID *);
typedef DOUBLE (*ElementEvalProcPtr)(const ELEMENT *,const DOUBLE **,DOUBLE *);
typedef void (*ElementVectorProcPtr)(const ELEMENT *,const DOUBLE **,DOUBLE *,DOUBLE *);
typedef DOUBLE (*MatrixEvalProcPtr)(const MATRIX *);
/*----------- definition of structs ----------------------------------------*/
struct elementvalues {
/** \brief Fields for environment list variable */
NS_PREFIX ENVVAR v;
/** \brief Prepare eval values */
PreprocessingProcPtr PreprocessProc;
/** \brief Pointer to corresponding function */
ElementEvalProcPtr EvalProc;
};
struct elementvector {
/** \brief Fields for environment list variable */
NS_PREFIX ENVVAR v;
/** \brief Prepare eval values */
PreprocessingProcPtr PreprocessProc;
/** \brief Pointer to corresponding function */
ElementVectorProcPtr EvalProc;
/** \brief Dimension of result vector */
int dimension;
};
struct matrixvalues {
/** \brief Fields for enironment list variable */
NS_PREFIX ENVVAR v;
/** \brief Prepare eval values */
PreprocessingProcPtr PreprocessProc;
/** \brief Pointer to corresponding function */
MatrixEvalProcPtr EvalProc;
};
typedef struct elementvalues EVALUES ;
typedef struct elementvector EVECTOR ;
typedef struct matrixvalues MVALUES ;
/****************************************************************************/
/* */
/* algebraic dependency for vector ordering */
/* */
/****************************************************************************/
typedef INT (*DependencyProcPtr)(GRID *, const char *);
struct AlgebraicDependency {
/* fields for enironment list variable */
NS_PREFIX ENVVAR v;
DependencyProcPtr DependencyProc; /* pointer to dependency function */
};
typedef struct AlgebraicDependency ALG_DEP;
/****************************************************************************/
/* */
/* periodic boundary info */
/* */
/****************************************************************************/
#ifdef __PERIODIC_BOUNDARY__
/* node counter for periodic vector */
#define PVCOUNT(p) VINDEX(p)
#define SETPVCOUNT(p,n) (VINDEX(p)=(n))
/* maximal count of periodic objects */
#define MAX_PERIODIC_OBJ DIM+1
typedef INT (* PeriodicBoundaryInfoProcPtr)(
VERTEX *vtx, /* vertex, for which to examine boundary */
INT *n, /* number of periodic boundaries of vertex */
INT *periodic_ids, /* n ids of periodic boundaries */
DOUBLE_VECTOR own_coord, /* own coord from vertex */
DOUBLE_VECTOR *periodic_coords /* n coords of periodic boundaries */
);
INT SetPeriodicBoundaryInfoProcPtr (PeriodicBoundaryInfoProcPtr PBI);
INT GetPeriodicBoundaryInfoProcPtr (PeriodicBoundaryInfoProcPtr *PBI);
#endif
/****************************************************************************/
/* */
/* find cut for vector ordering */
/* */
/****************************************************************************/
typedef VECTOR *(*FindCutProcPtr)(GRID *, VECTOR *, INT *);
typedef struct {
/* fields for enironment list variable */
NS_PREFIX ENVVAR v;
FindCutProcPtr FindCutProc; /* pointer to find cut function */
} FIND_CUT;
/****************************************************************************/
/* */
/* dynamic management of control words */
/* */
/****************************************************************************/
/** @name status of control word */
/*@{*/
#define CW_FREE 0
#define CW_USED 1
/*@}*/
/** @name Status of control entry */
/*@{*/
#define CE_FREE 0
#define CE_USED 1
#define CE_LOCKED 1
/*@}*/
/** @name Initializer macros for control entry and word predefines */
/*@{*/
#define CW_INIT(used,cw,objs) {used, STR(cw), cw ## CW, cw ## OFFSET,objs}
#define CW_INIT_UNUSED {CW_FREE,0,0,0}
#define CE_INIT(mode,cw,ce,objs) {mode, STR(ce), cw ## CW, ce ## CE, ce ## SHIFT, ce ## LEN, objs}
#define CE_INIT_UNUSED {CE_FREE, 0, 0, 0, 0, 0, 0}
/*@}*/
/* general query macros */
/* dynamic control words */
/*#define _DEBUG_CW_*/
#if (defined _DEBUG_CW_) && \
!(defined __COMPILE_CW__) /* to avoid infinite recursion during ReadCW */
/* map cw read/write to functions */
#define CW_READ(p,ce) ReadCW(p,ce)
#define CW_READ_STATIC(p,s,t) ReadCW(p,s ## CE)
#define CW_WRITE(p,ce,n) WriteCW(p,ce,n)
#define CW_WRITE_STATIC(p,s,t,n) WriteCW(p,s ## CE,n)
#else /* _DEBUG_CW_ */
#define ControlWord(p,ce) (((UINT *)(p))[control_entries[ce].offset_in_object])
#ifndef __T3E__
#define CW_READ(p,ce) ((ControlWord(p,ce) & control_entries[ce].mask)>>control_entries[ce].offset_in_word)
#endif
/* very special hack */
#ifdef __T3E__
#define CW_READ(p,ce) ((int)((ControlWord(p,ce) & control_entries[ce].mask)>>control_entries[ce].offset_in_word) )
#endif
#define CW_WRITE(p,ce,n) ControlWord(p,ce) = (ControlWord(p,ce)&control_entries[ce].xor_mask)|(((n)<<control_entries[ce].offset_in_word)&control_entries[ce].mask)
/* static control words */
#define StaticControlWord(p,t) (((UINT *)(p))[t ## OFFSET])
#define StaticControlWordMask(s) ((POW2(s ## LEN) - 1) << s ## SHIFT)
#ifndef __T3E__
#define CW_READ_STATIC(p,s,t) \
((StaticControlWord(p,t) & StaticControlWordMask(s)) >> s ## SHIFT)
#endif
/* very special hack */
#ifdef __T3E__
#define CW_READ_STATIC(p,s,t) \
((int) ((StaticControlWord(p,t) & StaticControlWordMask(s)) >> s ## SHIFT))
#endif
#define CW_WRITE_STATIC(p,s,t,n) \
StaticControlWord(p,t) = \
(StaticControlWord(p,t) & (~StaticControlWordMask(s))) | \
(((n) << s ## SHIFT) & StaticControlWordMask(s))
#endif /* _DEBUG_CW_ */
/** \brief Enumeration list of all control words of gm.h */
enum GM_CW {
VECTOR_CW,
MATRIX_CW,
BLOCKVECTOR_CW,
VERTEX_CW,
NODE_CW,
LINK_CW,
EDGE_CW,
ELEMENT_CW,
FLAG_CW,
PROPERTY_CW,
GRID_CW,
GRID_STATUS_CW,
MULTIGRID_STATUS_CW,
GM_N_CW
};
/** \brief Enumeration list of all control entry of gm.h */
enum GM_CE {
VTYPE_CE,
VOTYPE_CE,
VPART_CE,
VCOUNT_CE,
VECTORSIDE_CE,
VCLASS_CE,
VDATATYPE_CE,
VNCLASS_CE,
VNEW_CE,
VCCUT_CE,
VCCOARSE_CE,
NEW_DEFECT_CE,
VACTIVE_CE,
FINE_GRID_DOF_CE,
MOFFSET_CE,
MROOTTYPE_CE,
MDESTTYPE_CE,
MDIAG_CE,
MSIZE_CE,
MNEW_CE,
CEXTRA_CE,
MDOWN_CE,
MUP_CE,
MLOWER_CE,
MUPPER_CE,
MACTIVE_CE,
BVDOWNTYPE_CE,
BVLEVEL_CE,
BVTVTYPE_CE,
BVORIENTATION_CE,
OBJ_CE,
USED_CE,
TAG_CE,
LEVEL_CE,
THEFLAG_CE,
MOVE_CE,
MOVED_CE,
ONEDGE_CE,
ONSIDE_CE,
ONNBSIDE_CE,
NOOFNODE_CE,
NSUBDOM_CE,
NTYPE_CE,
NPROP_CE,
MODIFIED_CE,
NCLASS_CE,
NNCLASS_CE,
LOFFSET_CE,
NO_OF_ELEM_CE,
AUXEDGE_CE,
EDGENEW_CE,
EDSUBDOM_CE,
ECLASS_CE,
NSONS_CE,
NEWEL_CE,
SUBDOMAIN_CE,
NODEORD_CE,
PROP_CE,
#ifdef ModelP
XFERVECTOR_CE,
XFERMATX_CE,
#endif
GM_N_CE
};
enum LV_MODIFIERS {
LV_SKIP = (1<<0), /* print skip flags in vector */
LV_VO_INFO = (1<<1), /* vector object related info */
LV_POS = (1<<2) /* position vector */
};
enum LV_ID_TYPES {
LV_ID,
LV_GID,
LV_KEY
};
#define LV_MOD_DEFAULT (LV_POS | LV_VO_INFO)
/****************************************************************************/
/* */
/* Macro definitions for algebra structures */
/* */
/* */
/* Use of the control word: */
/* */
/* macro name|bits |V|M|use */
/* */
/* all objects: */
/* */
/* vectors: */
/* VOTYPE |0 - 1 |*| | node-,edge-,side- or elemvector */
/* VCFLAG |3 |*| | flag for general use */
/* VCUSED |4 |*| | flag for general use */
/* VCOUNT |5-6 |*| | The number of elements that reference */
/* the vector (if it is a side vector) */
/* VECTORSIDE|7 - 9 |*| | nb of side the side vect corr. to (in object elem)*/
/* VCLASS |11-12 |*| | class of v. (3: if corr. to red/green elem) */
/* (2: if corr. to first algebraic nb.) */
/* (1: if corr. to second algebraic nb.) */
/* VDATATYPE |13-16 |*| | data type used bitwise */
/* VNCLASS |17-18 |*| | type of elem on finer grid the v. lies geom. in: */
/* 0: no elem on finer grid */
/* 1: elem of 'second alg. nbhood' only */
/* 2: elem of 'first alg. nbhood' only */
/* 3: red or green elem */
/* VNEW |19 |*| | 1 if vector is new */
/* VCNEW |20 |*| | 1 if vector has a new connection */
/* VACTIVE |24 |*| | 1 if vector is active inside a smoother */
/* VCCUT |26 |*| | */
/* VTYPE |27-28 |*| | abstract vector type */
/* VPART |29-30 |*| | domain part */
/* VCCOARSE |31 |*| | indicate algebraic part of VECTOR-MATRIX graph */
/* */
/* matrices: */
/* MOFFSET |0 | |*| 0 if first matrix in connection else 1 */
/* MROOTTYPE |1 - 2 | |*| VTYPE of root vector */
/* MDESTTYPE |3 - 4 | |*| VTYPE of destination vector */
/* MDIAG |5 | |*| 1 if diagonal matrix element */
/* MNEW |6 | |*| ??? */
/* CEXTRA |7 | |*| 1 if is extra connection */
/* MDOWN |8 | |*| ??? */
/* MUP |9 | |*| ??? */
/* MLOWER |10 | |*| 1 if matrix belongs to lower triangular part */
/* MUPPER |11 | |*| 1 if matrix belongs to upper triangular part */
/* UG_MSIZE |12-25 | |*| size of the matrix in bytes */
/* MUSED |12 | |*| general purpose flag */
/* MNEW |28 | |*| 1 if matrix/connection is new */
/* */
/* Use of the control word in 'BLOCKVECTOR': */
/* BVDOWNTYPE 0 BVDOWNTYPEVECTOR if the down component points to a vector, */
/* BVDOWNTYPEBV if it points to a further blockvector (son) */
/* */
/****************************************************************************/
/****************************************************************************/
/* */
/* general macros */
/* */
/****************************************************************************/
/* macros to calculate from a coordinate (2D/3D) a hopefully unique ID */
#define SIGNIFICANT_DIGITS(d,exp_ptr) (ceil(frexp((d),(exp_ptr))*1e5))
/* the idea to calculate from a 2d/3D position a (hopefully) unique key:
add the weighted significant digits of the coordinates; the weights
may not have a common divisor to ensure uniqueness of the result;
take from this again the sigificant digits */
#ifdef __TWODIM__
#define COORDINATE_TO_KEY(coord,dummy_int_ptr) ((INT)(SIGNIFICANT_DIGITS((SIGNIFICANT_DIGITS((coord)[0],(dummy_int_ptr))*1.246509423749342 + \
SIGNIFICANT_DIGITS((coord)[1],(dummy_int_ptr))*PI)\
, (dummy_int_ptr))))
#endif
#ifdef __THREEDIM__
#define COORDINATE_TO_KEY(coord,dummy_int_ptr) ((INT)(SIGNIFICANT_DIGITS((SIGNIFICANT_DIGITS((coord)[0],(dummy_int_ptr))*1.246509423749342 + \
SIGNIFICANT_DIGITS((coord)[1],(dummy_int_ptr))*PI + \
SIGNIFICANT_DIGITS((coord)[2],(dummy_int_ptr))*0.76453456834568356936598)\
, (dummy_int_ptr))))
#endif
/****************************************************************************/
/* */
/* macros for VECTORs */
/* */
/****************************************************************************/
/* control word offset */
#define VECTOR_OFFSET 0
/* predefined control word entries */
#define VOTYPE_SHIFT 0
#define VOTYPE_LEN 2
#define VOTYPE(p) CW_READ_STATIC(p,VOTYPE_,VECTOR_)
#define SETVOTYPE(p,n) CW_WRITE_STATIC(p,VOTYPE_,VECTOR_,n)
#if (MAXVOBJECTS > POW2(VOTYPE_LEN))
#error *** VOTYPE_LEN too small ***
#endif
#define VTYPE_SHIFT 2
#define VTYPE_LEN 2
#define VTYPE(p) (enum VectorType)CW_READ_STATIC(p,VTYPE_,VECTOR_)
#define SETVTYPE(p,n) CW_WRITE_STATIC(p,VTYPE_,VECTOR_,n)
#if (MAXVTYPES > POW2(VTYPE_LEN))
#error *** VTYPE_LEN too small ***
#endif
#define VDATATYPE_SHIFT 4
#define VDATATYPE_LEN 4
#define VDATATYPE(p) CW_READ_STATIC(p,VDATATYPE_,VECTOR_)
#define SETVDATATYPE(p,n) CW_WRITE_STATIC(p,VDATATYPE_,VECTOR_,n)
#if (MAXVTYPES > VDATATYPE_LEN)
#error *** VDATATYPE_LEN too small ***
#endif
#define VCLASS_SHIFT 8
#define VCLASS_LEN 2
#define VCLASS(p) CW_READ_STATIC(p,VCLASS_,VECTOR_)
#define SETVCLASS(p,n) CW_WRITE_STATIC(p,VCLASS_,VECTOR_,n)
#define VNCLASS_SHIFT 10
#define VNCLASS_LEN 2
#define VNCLASS(p) CW_READ_STATIC(p,VNCLASS_,VECTOR_)
#define SETVNCLASS(p,n) CW_WRITE_STATIC(p,VNCLASS_,VECTOR_,n)
#define VNEW_SHIFT 12
#define VNEW_LEN 1
#define VNEW(p) CW_READ_STATIC(p,VNEW_,VECTOR_)
#define SETVNEW(p,n) CW_WRITE_STATIC(p,VNEW_,VECTOR_,n)
#define VCCUT_SHIFT 13
#define VCCUT_LEN 1
#define VCCUT(p) CW_READ_STATIC(p,VCCUT_,VECTOR_)
#define SETVCCUT(p,n) CW_WRITE_STATIC(p,VCCUT_,VECTOR_,n)
#define VCOUNT_SHIFT 14
#define VCOUNT_LEN 2
#define VCOUNT(p) CW_READ_STATIC(p,VCOUNT_,VECTOR_)
#define SETVCOUNT(p,n) CW_WRITE_STATIC(p,VCOUNT_,VECTOR_,n)
#define VECTORSIDE_SHIFT 16
#define VECTORSIDE_LEN 3
#define VECTORSIDE(p) CW_READ_STATIC(p,VECTORSIDE_,VECTOR_)
#define SETVECTORSIDE(p,n) CW_WRITE_STATIC(p,VECTORSIDE_,VECTOR_,n)
#define VCCOARSE_SHIFT 19
#define VCCOARSE_LEN 1
#define VCCOARSE(p) CW_READ_STATIC(p,VCCOARSE_,VECTOR_)
#define SETVCCOARSE(p,n) CW_WRITE_STATIC(p,VCCOARSE_,VECTOR_,n)
#define FINE_GRID_DOF_SHIFT 20
#define FINE_GRID_DOF_LEN 1
#define FINE_GRID_DOF(p) CW_READ_STATIC(p,FINE_GRID_DOF_,VECTOR_)
#define SETFINE_GRID_DOF(p,n) CW_WRITE_STATIC(p,FINE_GRID_DOF_,VECTOR_,n)
#define NEW_DEFECT_SHIFT 21
#define NEW_DEFECT_LEN 1
#define NEW_DEFECT(p) CW_READ_STATIC(p,NEW_DEFECT_,VECTOR_)
#define SETNEW_DEFECT(p,n) CW_WRITE_STATIC(p,NEW_DEFECT_,VECTOR_,n)
#ifdef ModelP
#define XFERVECTOR_SHIFT 20
#define XFERVECTOR_LEN 2
#define XFERVECTOR(p) CW_READ(p,XFERVECTOR_CE)
#define SETXFERVECTOR(p,n) CW_WRITE(p,XFERVECTOR_CE,n)
#endif /* ModelP */
#define VPART_SHIFT 22
#define VPART_LEN 2
#define VPART(p) CW_READ_STATIC(p,VPART_,VECTOR_)
#define SETVPART(p,n) CW_WRITE_STATIC(p,VPART_,VECTOR_,n)
#if (MAXDOMPARTS > POW2(VPART_LEN))
#error *** VPART_LEN too small ***
#endif
#define VACTIVE_SHIFT 24
#define VACTIVE_LEN 1
#define VACTIVE(p) CW_READ_STATIC(p,VACTIVE_,VECTOR_)
#define SETVACTIVE(p,n) CW_WRITE_STATIC(p,VACTIVE_,VECTOR_,n)
#define VCFLAG(p) THEFLAG(p)
#define SETVCFLAG(p,n) SETTHEFLAG(p,n)
#define VCUSED(p) USED(p)
#define SETVCUSED(p,n) SETUSED(p,n)
#define VOBJECT(v) ((v)->object)
#ifdef ModelP
#define PPREDVC(p,v) (((v)==PRIO_FIRSTVECTOR(p,PrioMaster)) ? \
PRIO_LASTVECTOR(p,PrioBorder) : (v)->pred)
#else
#define PPREDVC(p,v) ((v)->pred)
#endif
#define PREDVC(v) ((v)->pred)
#define SUCCVC(v) ((v)->succ)
#define VINDEX(v) ((v)->index)
#define V_IN_DATATYPE(v,dt) (VDATATYPE(v) & (dt))
#define VSKIPME(v,n) ((((v)->skip)>>n) & 1)
#define VVECSKIP(v,n) ((((v)->skip)>>n) & 15)
#define VFULLSKIP(v,n) (VVECSKIP(v,n)==15)
#define SETVSKIPME(v,n) (((v)->skip=n))
#define VECSKIP(v) ((v)->skip)
#define VECSKIPBIT(v,n) (((v)->skip) & (1<<n))
#define SETVECSKIPBIT(v,n) (v)->skip = ((v)->skip & (~(1<<n))) | (1<<n)
#define VSTART(v) ((v)->start)
#ifdef __INTERPOLATION_MATRIX__
#define VISTART(v) ((v)->istart)
#endif
#define VVALUE(v,n) ((v)->value[n])
#define VVALUEPTR(v,n) (&((v)->value[n]))
#define VMYNODE(v) ((NODE*)((v)->object))
#define VMYEDGE(v) ((EDGE*)((v)->object))
#define VMYELEMENT(v) ((ELEMENT*)((v)->object))
#define VUP(p) LoWrd(VINDEX(p))
#define SETVUP(p,n) SetLoWrd(VINDEX(p),n)
#define VDOWN(p) HiWrd(VINDEX(p))
#define SETVDOWN(p,n) SetHiWrd(VINDEX(p),n)
#ifdef __BLOCK_VECTOR_DESC__
#define VBVD(v) ((v)->block_descr)
#define VMATCH(v,bvd,bvdf) BVD_IS_SUB_BLOCK( &(v)->block_descr, bvd, bvdf )
#endif
/* user for nodes, edges and elements */
#define CAST_NVECTOR(p) NVECTOR(p)
#define CAST_EDVECTOR(p) EDVECTOR(p)
#define CAST_SVECTOR(p,i) SVECTOR(p,i)
#define CAST_EVECTOR(p) EVECTOR(p)
/****************************************************************************/
/* */
/* macros for MATRIXs */
/* */
/****************************************************************************/
/* control word offset */
#define MATRIX_OFFSET 0
#define MOFFSET_SHIFT 0
#define MOFFSET_LEN 1
#define MOFFSET(p) CW_READ_STATIC(p,MOFFSET_,MATRIX_)
#define SETMOFFSET(p,n) CW_WRITE_STATIC(p,MOFFSET_,MATRIX_,n)
#define MROOTTYPE_SHIFT 1
#define MROOTTYPE_LEN 2
#define MROOTTYPE(p) CW_READ_STATIC(p,MROOTTYPE_,MATRIX_)
#define SETMROOTTYPE(p,n) CW_WRITE_STATIC(p,MROOTTYPE_,MATRIX_,n)
#if (MAXVTYPES > POW2(MROOTTYPE_LEN))
#error *** MROOTTYPE_LEN too small ***
#endif
#define MDESTTYPE_SHIFT 3
#define MDESTTYPE_LEN 2
#define MDESTTYPE(p) CW_READ_STATIC(p,MDESTTYPE_,MATRIX_)
#define SETMDESTTYPE(p,n) CW_WRITE_STATIC(p,MDESTTYPE_,MATRIX_,n)
#if (MAXVTYPES > POW2(MDESTTYPE_LEN))
#error *** MDESTTYPE_LEN too small ***
#endif
#define MDIAG_SHIFT 5
#define MDIAG_LEN 1
#define MDIAG(p) CW_READ_STATIC(p,MDIAG_,MATRIX_)
#define SETMDIAG(p,n) CW_WRITE_STATIC(p,MDIAG_,MATRIX_,n)
#define MNEW_SHIFT 6
#define MNEW_LEN 1
#define MNEW(p) CW_READ_STATIC(p,MNEW_,MATRIX_)
#define SETMNEW(p,n) CW_WRITE_STATIC(p,MNEW_,MATRIX_,n)
#define CEXTRA_SHIFT 7
#define CEXTRA_LEN 1
#define CEXTRA(p) CW_READ_STATIC(p,CEXTRA_,MATRIX_)
#define SETCEXTRA(p,n) CW_WRITE_STATIC(p,CEXTRA_,MATRIX_,n)
#define MDOWN_SHIFT 8
#define MDOWN_LEN 1
#define MDOWN(p) CW_READ_STATIC(p,MDOWN_,MATRIX_)
#define SETMDOWN(p,n) CW_WRITE_STATIC(p,MDOWN_,MATRIX_,n)
#define MUP_SHIFT 9
#define MUP_LEN 1
#define MUP(p) CW_READ_STATIC(p,MUP_,MATRIX_)
#define SETMUP(p,n) CW_WRITE_STATIC(p,MUP_,MATRIX_,n)
#define MLOWER_SHIFT 10
#define MLOWER_LEN 1
#define MLOWER(p) CW_READ_STATIC(p,MLOWER_,MATRIX_)
#define SETMLOWER(p,n) CW_WRITE_STATIC(p,MLOWER_,MATRIX_,n)
#define MUPPER_SHIFT 11
#define MUPPER_LEN 1
#define MUPPER(p) CW_READ_STATIC(p,MUPPER_,MATRIX_)
#define SETMUPPER(p,n) CW_WRITE_STATIC(p,MUPPER_,MATRIX_,n)
#define MACTIVE_SHIFT 12
#define MACTIVE_LEN 1
#define MACTIVE(p) CW_READ_STATIC(p,MACTIVE_,MATRIX_)
#define SETMACTIVE(p,n) CW_WRITE_STATIC(p,MACTIVE_,MATRIX_,n)
#define MSIZE_SHIFT 13
#define MSIZE_LEN 12
#ifndef __XXL_MSIZE__
#define MSIZEMAX (POW2(MSIZE_LEN)-1)
#define UG_MSIZE(p) (CW_READ(p,MSIZE_CE)+sizeof(MATRIX)-sizeof(DOUBLE))
#define SETMSIZE(p,n) CW_WRITE(p,MSIZE_CE,(n-sizeof(MATRIX)+sizeof(DOUBLE)))
#else
#define MSIZEMAX 10000000
#define UG_MSIZE(p) ((p)->xxl_msize)
#define SETMSIZE(p,n) (p)->xxl_msize = (n)
#endif
#define MTYPE(p) (MDIAG(p) ? (MAXMATRICES+MROOTTYPE(p)) : (MROOTTYPE(p)*MAXVECTORS+MDESTTYPE(p)))
#define MUSED(p) USED(p)
#define SETMUSED(p,n) SETUSED(p,n)
#ifdef ModelP
#define XFERMATX_SHIFT 25
#define XFERMATX_LEN 2
#define XFERMATX(p) CW_READ(p,XFERMATX_CE)
#define SETXFERMATX(p,n) CW_WRITE(p,XFERMATX_CE,n)
#endif
#define MINC(m) ((MATRIX*)(((char *)(m))+UG_MSIZE(m)))
#define MDEC(m) ((MATRIX*)(((char *)(m))-UG_MSIZE(m)))
#define MNEXT(m) ((m)->next)
#define MDEST(m) ((m)->vect)
#define MADJ(m) ((MDIAG(m)) ? (m) : ((MOFFSET(m)) ? (MDEC(m)) : (MINC(m))))
#define MROOT(m) MDEST(MADJ(m))
#define MMYCON(m) ((MOFFSET(m)) ? (MDEC(m)) : (m))
#define MVALUE(m,n) ((m)->value[n])
#define MVALUEPTR(m,n) (&((m)->value[n]))
#define MDESTINDEX(m) ((m)->vect->index)
#define MSTRONG(p) (MDOWN(p) && MUP(p))
/****************************************************************************/
/* */
/* macros for CONNECTIONs */
/* */
/****************************************************************************/
#define CMATRIX0(m) (m)
#define CMATRIX1(m) ((MDIAG(m)) ? (NULL) : (MINC(m)))
#define SETCUSED(c,n) {SETMUSED(CMATRIX0(c),n); SETMUSED(MADJ(CMATRIX0(c)),n);}
/****************************************************************************/
/* */
/* macros for struct blockvector_description (BV_DESC) */
/* */
/****************************************************************************/
/* access to members of struct blockvector_description (BV_DESC) */
#define BVD_NR_ENTRIES(bvd) ((bvd)->current)
/* macros for blockvectordescription */
#define BVD_INIT(bvd) ((bvd)->current=0)
/* sequential access operations on struct blockvector_description (BV_DESC) */
#define BVD_PUSH_ENTRY(bvd,bnr,bvdf) PushEntry( (bvd), (bnr), (bvdf) )
#define BVD_DISCARD_LAST_ENTRY(bvd) {assert(BVD_NR_ENTRIES(bvd)>0);BVD_NR_ENTRIES(bvd)--;}
#define BVD_INC_LAST_ENTRY(bvd,incr,bvdf) ((bvd)->entry = (((((bvd)->entry >> ((bvdf)->bits * (BVD_NR_ENTRIES(bvd)-1))) + (incr)) & ((bvdf)->level_mask[0])) << ((bvdf)->bits * (BVD_NR_ENTRIES(bvd)-1))) | ((bvd)->entry & (bvdf)->neg_digit_mask[BVD_NR_ENTRIES(bvd)-1]))
#define BVD_DEC_LAST_ENTRY(bvd,decr,bvdf) ((bvd)->entry = (((((bvd)->entry >> ((bvdf)->bits * (BVD_NR_ENTRIES(bvd)-1))) - (decr)) & ((bvdf)->level_mask[0])) << ((bvdf)->bits * (BVD_NR_ENTRIES(bvd)-1))) | ((bvd)->entry & (bvdf)->neg_digit_mask[BVD_NR_ENTRIES(bvd)-1]))
#define BVD_INIT_SEQ_READ(bvd) ((bvd)->read = 0)
#define BVD_READ_NEXT_ENTRY(bvd,bvdf) ( ((bvd)->read<BVD_NR_ENTRIES(bvd)) ? BVD_GET_ENTRY((bvd),(bvd)->read++,(bvdf)) : NO_BLOCKVECTOR )
/* random access operations on struct blockvector_description (BV_DESC) */
#define BVD_SET_ENTRY(bvd,level,bnr,bvdf) ( (bvd)->entry = ( ((bvd)->entry & (bvdf)->neg_digit_mask[(level)]) | ( (bnr) << ( (bvdf)->bits*(level) ) ) ) )
#define BVD_GET_ENTRY(bvd,level,bvdf) ( ((bvd)->entry >> ((bvdf)->bits * (level))) & (bvdf)->level_mask[0] )
#define BVD_IS_SUB_BLOCK(bvd_a,bvd_b,bvdf) ( (BVD_NR_ENTRIES(bvd_a) >= BVD_NR_ENTRIES(bvd_b)) && (((bvd_a)->entry & (((bvdf)->level_mask[BVD_NR_ENTRIES(bvd_b)-1]))) == ((((bvd_b)->entry & (bvdf)->level_mask[BVD_NR_ENTRIES(bvd_b)-1])))))
/****************************************************************************/
/* */
/* macros for BLOCKVECTOR */
/* */
/****************************************************************************/
/* control word offset */
#define BLOCKVECTOR_OFFSET 0
#define BVDOWNTYPE_SHIFT 0
#define BVDOWNTYPE_LEN 2
#define BVDOWNTYPE(bv) CW_READ_STATIC(bv,BVDOWNTYPE_,BLOCKVECTOR_)
#define SETBVDOWNTYPE(bv,n) CW_WRITE_STATIC(bv,BVDOWNTYPE_,BLOCKVECTOR_,n)
#define BVLEVEL_SHIFT 2
#define BVLEVEL_LEN 4
#define BVLEVEL(bv) CW_READ_STATIC(bv,BVLEVEL_,BLOCKVECTOR_)
#define SETBVLEVEL(bv,n) CW_WRITE_STATIC(bv,BVLEVEL_,BLOCKVECTOR_,n)
#define BVTVTYPE_SHIFT 6
#define BVTVTYPE_LEN 1
#define BVTVTYPE(bv) CW_READ_STATIC(bv,BVTVTYPE_,BLOCKVECTOR_)
#define SETBVTVTYPE(bv,n) CW_WRITE_STATIC(bv,BVTVTYPE_,BLOCKVECTOR_,n)
#define BVORIENTATION_SHIFT 7
#define BVORIENTATION_LEN 2
#define BVORIENTATION(bv) CW_READ_STATIC(bv,BVORIENTATION_,BLOCKVECTOR_)
#define SETBVORIENTATION(bv,n) CW_WRITE_STATIC(bv,BVORIENTATION_,BLOCKVECTOR_,n)
/* access to members of struct blockvector */
#define BVNUMBER(bv) ((bv)->number)
#define BVUSERDATA(bv) ((bv)->user_data)
#define BVPRED(bv) ((bv)->pred)
#define BVSUCC(bv) ((bv)->succ)
#define BVFIRSTVECTOR(bv) ((bv)->first_vec)
#define BVLASTVECTOR(bv) ((bv)->last_vec)
#define BVENDVECTOR(bv) (BVSUCC(BVLASTVECTOR(bv)))
#define BVNUMBEROFVECTORS(bv) ((bv)->vec_number)
#define BVDOWNVECTOR(bv) ((bv)->first_vec)
#define BVDOWNBV(bv) ((bv)->first_son)
#define BVDOWNBVLAST(bv) ((bv)->last_son)
#define BVDOWNBVEND(bv) (BVSUCC(BVDOWNBVLAST(bv)))
#define BV_GEN_F 0
#define BV_GEN_L 1
#define BV_GEN_C 2
#define SETBV_GC(bv,flc,cyc) (BVNUMBER(bv)=3*(cyc)+(flc))
#define BV_IS_GC(bv,gen,cyc) (BVNUMBER(bv)%3==(gen) && BVNUMBER(bv)/3==(cyc))
#define BV_GEN(bv) (BVNUMBER(bv)%3) /* gen.: FLC */
#define BV_CYC(bv) (BVNUMBER(bv)/3) /* nb. of cycle */
#define SET_ORD_GCL(n,flc,cyc,line) {SetLoWrd(n,3*(cyc)+(flc)); SetHiWrd(n,line);}
#define ORD_GEN(n) (LoWrd(n)%3) /* gen.: FLC */
#define ORD_CYC(n) (LoWrd(n)/3) /* nb. of cycle */
#define ORD_LIN(n) HiWrd(n)
/* operations on struct block */
#define BV_IS_EMPTY(bv) (BVNUMBEROFVECTORS(bv)==0)
#define BV_IS_LEAF_BV(bv) (BVDOWNTYPE(bv)==BVDOWNTYPEVECTOR)
#define BV_IS_DIAG_BV(bv) (BVDOWNTYPE(bv)==BVDOWNTYPEDIAG)
/****************************************************************************/
/* */
/* Macro definitions for geometric objects */
/* */
/* */
/* Use of the control word: */
/* */
/* macro name|bits |V|N|L|E|V|M| use */
/* C */
/* all objects: */
/* TAG |18-20 | | | |*| | |general purpose tag field */
/* LEVEL |21-25 |*|*| |*| | |level of a node/element (imp. for copies) */
/* THEFLAG |26 |*|*|*|*| | |general purp., leave them as you found 'em*/
/* USED |27 |*|*|*|*| | |object visited, leave them as you found 'em*/
/* OBJT |28-31 |*|*|*|*| | |object type identification */
/* */
/* vertices: */
/* MOVED |0 |*| | | | | |boundary vertex not lying on edge midpoint */
/* MOVE |1-2 |*| | | | | |vertex can be moved on a 0(1,2,3) dim subsp*/
/* ONEDGE |3 - 6 |*| | | | | |no. of edge in father element */
/* ONSIDE |3 - 5 |*| | | | | |no. of side in father element */
/* ONNBSIDE |6 - 8 |*| | | | | |no. of side in the neigbor of the father */
/* NOOFNODE |9 -13 |*| | | | | |??? */
/* */
/* nodes: */
/* NSUBDOM |0-3 | |*| | | | |subdomain id */
/* MODIFIED |6 | |*| | | | |1 if node must be assembled */
/* N_OUTFLOW |0-7 | */
/* N_INFLOW |8-15 | */
/* */
/* links and edges: */
/* LOFFSET |0 | | |*| | | |position of link in links array */
/* EDGENEW |1 | | |*| | | |status of edge */
/* NOOFELEM |2-8 | | |*| | | |nb. of elem. the edge is part of */
/* AUXEDGE |9 | */
/* EDSUBDOM |12-17 | | | |*| | |subdomain of edge if inner edge, 0 else */
/* */
/* elements: */
/* ECLASS |8-9 | | | |*| | |element class from enumeration type */
/* NSONS |10-13 | | | |*| | |number of sons */
/* NEWEL |14 | | | |*| | |element just created */
/* VSIDES |11-14 | | | |*| | |viewable sides */
/* NORDER |15-19 | | | |*| | |view position order of the nodes */
/* CUTMODE |26-27 | | | |*| | |elem intersects cutplane or... */
/* */
/****************************************************************************/
/* object identification */
enum GM_OBJECTS {
MGOBJ, /*!< Multigrid object */
IVOBJ, /*!< Inner vertex */
BVOBJ, /*!< Boundary vertex */
IEOBJ, /*!< Inner element */
BEOBJ, /*!< Boundary element */
EDOBJ, /*!< Edge object */
NDOBJ, /*!< Node object */
GROBJ, /*!< Grid object */
/* object numbers for algebra */
VEOBJ, /*!< Vector object */
MAOBJ, /*!< Matrix object */
BLOCKVOBJ, /*!< Blockvector object */
NPREDEFOBJ, /*!< Number of predefined objects */
NOOBJ = -1 /*!< No object */
};
#define LIOBJ EDOBJ /* link and edge are identified */
#define COOBJ MAOBJ /* connection and matrix are identified */
/****************************************************************************/
/* */
/* general macros */
/* */
/****************************************************************************/
/* control word offset */
#define GENERAL_CW NODE_CW /* any of the geom objects */
#define GENERAL_OFFSET 0
#define OBJ_SHIFT 28
#define OBJ_LEN 4
#define OBJT(p) (enum GM_OBJECTS)CW_READ_STATIC(p,OBJ_,GENERAL_)
#define SETOBJT(p,n) CW_WRITE_STATIC(p,OBJ_,GENERAL_,n)
#define OBJT_MAX (POW2(OBJ_LEN)-1)
#define USED_SHIFT 27
#define USED_LEN 1
#define USED(p) CW_READ_STATIC(p,USED_,GENERAL_)
#define SETUSED(p,n) CW_WRITE_STATIC(p,USED_,GENERAL_,n)
#define THEFLAG_SHIFT 26
#define THEFLAG_LEN 1
#define THEFLAG(p) CW_READ_STATIC(p,THEFLAG_,GENERAL_)
#define SETTHEFLAG(p,n) CW_WRITE_STATIC(p,THEFLAG_,GENERAL_,n)
#define LEVEL_SHIFT 21
#define LEVEL_LEN 5
#define LEVEL(p) CW_READ_STATIC(p,LEVEL_,GENERAL_)
#define SETLEVEL(p,n) CW_WRITE_STATIC(p,LEVEL_,GENERAL_,n)
#define TAG_SHIFT 18
#define TAG_LEN 3
#define TAG(p) CW_READ_STATIC(p,TAG_,GENERAL_)
#define SETTAG(p,n) CW_WRITE_STATIC(p,TAG_,GENERAL_,n)
#define REF2TAG(n) (reference2tag[n])
#define CTRL(p) (*((UINT *)(p)))
#define ID(p) (((INT *)(p))[1])
/****************************************************************************/
/* */
/* macros for vertices */
/* */
/****************************************************************************/
/* control word offset */
#define VERTEX_OFFSET 0
#define MOVE_SHIFT 1
#define MOVE_LEN 2
#define MOVE(p) CW_READ_STATIC(p,MOVE_,VERTEX_)
#define SETMOVE(p,n) CW_WRITE_STATIC(p,MOVE_,VERTEX_,n)
#define MOVED_SHIFT 0
#define MOVED_LEN 1
#define MOVED(p) CW_READ_STATIC(p,MOVED_,VERTEX_)
#define SETMOVED(p,n) CW_WRITE_STATIC(p,MOVED_,VERTEX_,n)
#define ONEDGE_SHIFT 3
#define ONEDGE_LEN 4
#define ONEDGE(p) CW_READ_STATIC(p,ONEDGE_,VERTEX_)
#define SETONEDGE(p,n) CW_WRITE_STATIC(p,ONEDGE_,VERTEX_,n)
/* the following two overlap with ONEDGE */
#define ONSIDE_SHIFT 3
#define ONSIDE_LEN 3
#define ONSIDE(p) CW_READ_STATIC(p,ONSIDE_,VERTEX_)
#define SETONSIDE(p,n) CW_WRITE_STATIC(p,ONSIDE_,VERTEX_,n)
#define ONNBSIDE_SHIFT 6
#define ONNBSIDE_LEN 3
#define ONNBSIDE(p) CW_READ_STATIC(p,ONNBSIDE_,VERTEX_)
#define SETONNBSIDE(p,n) CW_WRITE_STATIC(p,ONNBSIDE_,VERTEX_,n)
#define NOOFNODE_SHIFT 9
#define NOOFNODE_LEN 5
#define NOOFNODEMAX POW2(NOOFNODE_LEN)
#if (MAXLEVEL > NOOFNODEMAX)
#error **** set NOOFNODEMAX/_LEN appropriate to MAXLEVEL: 2^NOOFNODE_LEN = NOOFNODEMAX >= MAXLEVEL ****
#endif
#define NOOFNODE(p) CW_READ_STATIC(p,NOOFNODE_,VERTEX_)
#define SETNOOFNODE(p,n) CW_WRITE_STATIC(p,NOOFNODE_,VERTEX_,n)
#define INCNOOFNODE(p) SETNOOFNODE(p,NOOFNODE(p)+1)
#define DECNOOFNODE(p) SETNOOFNODE(p,NOOFNODE(p)-1)
#define PREDV(p) ((p)->iv.pred)
#define SUCCV(p) ((p)->iv.succ)
#define CVECT(p) ((p)->iv.x)
#define XC(p) ((p)->iv.x[0])
#define YC(p) ((p)->iv.x[1])
#define ZC(p) ((p)->iv.x[2])
#define LCVECT(p) ((p)->iv.xi)
#define XI(p) ((p)->iv.xi[0])
#define ETA(p) ((p)->iv.xi[1])
#define NU(p) ((p)->iv.xi[2])
#define VDATA(p) ((p)->iv.data)
#define VFATHER(p) ((p)->iv.father)
/* for boundary vertices */
#define V_BNDP(p) ((p)->bv.bndp)
/* parallel macros */
#ifdef ModelP
#define PARHDRV(p) (&((p)->iv.ddd))
#endif /* ModelP */
/****************************************************************************/
/* */
/* macros for nodes */
/* */
/****************************************************************************/
/* control word offset */
#define NODE_OFFSET 0
#define NTYPE_SHIFT 0
#define NTYPE_LEN 3
#define NTYPE(p) CW_READ_STATIC(p,NTYPE_,NODE_)
#define SETNTYPE(p,n) CW_WRITE_STATIC(p,NTYPE_,NODE_,n)
#define NSUBDOM_SHIFT 3
#define NSUBDOM_LEN 6
#define NSUBDOM(p) CW_READ_STATIC(p,NSUBDOM_,NODE_)
#define SETNSUBDOM(p,n) CW_WRITE_STATIC(p,NSUBDOM_,NODE_,n)
#define NPROP_SHIFT 11
#define NPROP_LEN 4
#define NPROP(p) CW_READ_STATIC(p,NPROP_,NODE_)
#define SETNPROP(p,n) CW_WRITE_STATIC(p,NPROP_,NODE_,n)
#define MODIFIED_SHIFT 15
#define MODIFIED_LEN 1
#define MODIFIED(p) CW_READ_STATIC(p,MODIFIED_,NODE_)
#define SETMODIFIED(p,n) CW_WRITE_STATIC(p,MODIFIED_,NODE_,n)
#define NCLASS_SHIFT 16
#define NCLASS_LEN 2
#define NCLASS(p) CW_READ_STATIC(p,NCLASS_,NODE_)
#define SETNCLASS(p,n) CW_WRITE_STATIC(p,NCLASS_,NODE_,n)
#define NNCLASS_SHIFT 18
#define NNCLASS_LEN 2
#define NNCLASS(p) CW_READ_STATIC(p,NNCLASS_,NODE_)
#define SETNNCLASS(p,n) CW_WRITE_STATIC(p,NNCLASS_,NODE_,n)
#if defined ModelP && defined __OVERLAP2__
#define NO_DELETE_OVERLAP2_LEN 1
#define NO_DELETE_OVERLAP2(p) CW_READ(p,ce_NO_DELETE_OVERLAP2)
#define SETNO_DELETE_OVERLAP2(p,n) CW_WRITE(p,ce_NO_DELETE_OVERLAP2,n)
#endif
#define PREDN(p) ((p)->pred)
#define SUCCN(p) ((p)->succ)
#define START(p) ((p)->start)
#define NFATHER(p) ((NODE*)(p)->father)
#define SETNFATHER(p,n) ((p)->father = n)
#define NFATHEREDGE(p) ((EDGE*)(p)->father)
/*
#define NFATHER(p) ((NTYPE(p) == CORNER_NODE) ? (p)->father : NULL)
#define NFATHEREDGE(p) ((NTYPE(p) == MID_NODE) ? (EDGE *)(p)->father : NULL)
#define SETNFATHEREDGE(p,e) ((p)->father = (NODE *) (e))
*/
#define CORNERTYPE(p) (NTYPE(p) == CORNER_NODE)
#define MIDTYPE(p) (NTYPE(p) == MID_NODE)
#define SIDETYPE(p) (NTYPE(p) == SIDE_NODE)
#define CENTERTYPE(p) (NTYPE(p) == CENTER_NODE)
#define SONNODE(p) ((p)->son)
#define MYVERTEX(p) ((p)->myvertex)
#define NDATA(p) ((p)->data)
#define NVECTOR(p) ((p)->vector)
#define NODE_ELEMENT_LIST(p) ((ELEMENTLIST *)(p)->data)
#define ELEMENT_PTR(p) ((p)->el)
/****************************************************************************/
/* */
/* macros for links */
/* */
/****************************************************************************/
/* CAUTION: the controlword of LINK0 and its edge are identical (AVOID overlapping of flags) */
/* control word offset */
#define LINK_OFFSET 0
#define LOFFSET_SHIFT 0
#define LOFFSET_LEN 1
#define LOFFSET(p) CW_READ(p,LOFFSET_CE)
#define SETLOFFSET(p,n) CW_WRITE(p,LOFFSET_CE,n)
#define NBNODE(p) ((p)->nbnode)
#define NEXT(p) ((p)->next)
#define LDATA(p) ((p)->matelem)
#define MATELEM(p) ((p)->matelem) /* can be used for node and link */
#define MYEDGE(p) ((EDGE *)((p)-LOFFSET(p)))
#define REVERSE(p) ((p)+(1-LOFFSET(p)*2))
#if defined(__TWODIM__)
#define LELEM(p) ((p)->elem)
#define SET_LELEM(p,e) ((p)->elem = (e))
#endif
/****************************************************************************/
/* */
/* macros for edges */
/* */
/****************************************************************************/
/* control word offset */
#define EDGE_OFFSET 0
#define NO_OF_ELEM_SHIFT 2
#define NO_OF_ELEM_LEN 7
#define NO_OF_ELEM_MAX 128
#define NO_OF_ELEM(p) CW_READ(p,NO_OF_ELEM_CE)
#define SET_NO_OF_ELEM(p,n) CW_WRITE(p,NO_OF_ELEM_CE,n)
#define INC_NO_OF_ELEM(p) SET_NO_OF_ELEM(p,NO_OF_ELEM(p)+1)
#define DEC_NO_OF_ELEM(p) SET_NO_OF_ELEM(p,NO_OF_ELEM(p)-1)
#define AUXEDGE_SHIFT 9
#define AUXEDGE_LEN 1
#define AUXEDGE(p) CW_READ(p,AUXEDGE_CE)
#define SETAUXEDGE(p,n) CW_WRITE(p,AUXEDGE_CE,n)
#define EDGENEW_SHIFT 1
#define EDGENEW_LEN 1
#define EDGENEW(p) CW_READ(p,EDGENEW_CE)
#define SETEDGENEW(p,n) CW_WRITE(p,EDGENEW_CE,n)
/* boundary edges will be indicated by a subdomain id of 0 */
#define EDSUBDOM_SHIFT 12
#define EDSUBDOM_LEN 6
#define EDSUBDOM(p) CW_READ(p,EDSUBDOM_CE)
#define SETEDSUBDOM(p,n) CW_WRITE(p,EDSUBDOM_CE,n)
#define LINK0(p) (&((p)->links[0]))
#define LINK1(p) (&((p)->links[1]))
#define MIDNODE(p) ((p)->midnode)
#define EDDATA(p) ((p)->data)
#define EDVECTOR(p) ((p)->vector)
/****************************************************************************/
/* */
/* macros for elements */
/* */
/****************************************************************************/
enum {TRIANGLE = 3,
QUADRILATERAL = 4};
enum {TETRAHEDRON = 4,
PYRAMID = 5,
PRISM = 6,
HEXAHEDRON = 7};
/* control word offsets */
#define ELEMENT_OFFSET 0
#define FLAG_OFFSET 2
#define PROPERTY_OFFSET 3
/* macros for control word */
#define ECLASS_SHIFT 8
#define ECLASS_LEN 2
#define ECLASS(p) CW_READ(p,ECLASS_CE)
#define SETECLASS(p,n) CW_WRITE(p,ECLASS_CE,n)
#define NSONS_SHIFT 10
#define NSONS_LEN 5
#define NSONS(p) CW_READ(p,NSONS_CE)
#define SETNSONS(p,n) CW_WRITE(p,NSONS_CE,n)
#define NEWEL_SHIFT 17
#define NEWEL_LEN 1
#define NEWEL(p) CW_READ(p,NEWEL_CE)
#define SETNEWEL(p,n) CW_WRITE(p,NEWEL_CE,n)
/* macros for flag word */
/* are obviously all for internal use */
/* the property field */
#define SUBDOMAIN_SHIFT 24
#define SUBDOMAIN_LEN 6
#define SUBDOMAIN(p) CW_READ(p,SUBDOMAIN_CE)
#define SETSUBDOMAIN(p,n) CW_WRITE(p,SUBDOMAIN_CE,n)
#define NODEORD_SHIFT 0
#define NODEORD_LEN 24
#define NODEORD(p) CW_READ(p,NODEORD_CE)
#define SETNODEORD(p,n) CW_WRITE(p,NODEORD_CE,n)
#define PROP_SHIFT 30
#define PROP_LEN 2
#define PROP(p) CW_READ(p,PROP_CE)
#define SETPROP(p,n) CW_WRITE(p,PROP_CE,n)
/* parallel macros */
#ifdef ModelP
#define PARTITION(p) ((p)->ge.lb1)
#define PARHDRE(p) (&((p)->ge.ddd))
#endif
/*******************************/
/* the general element concept */
/*******************************/
/** \brief This structure contains all topological properties
of an element and more ..
*/
typedef struct {
INT tag; /**< Element type to be defined */
/* the following parameters determine size of refs array in element */
INT max_sons_of_elem; /**< Max number of sons for this type */
INT sides_of_elem; /**< How many sides ? */
INT corners_of_elem; /**< How many corners ? */
/* local geometric description of the element */
DOUBLE_VECTOR local_corner[MAX_CORNERS_OF_ELEM]; /**< Local coordinates of the corners of the element */
/* more size parameters */
INT edges_of_elem; /**< How many edges ? */
INT edges_of_side[MAX_SIDES_OF_ELEM]; /**< Number of edges for each side */
INT corners_of_side[MAX_SIDES_OF_ELEM]; /**< Number of corners for each side */
INT corners_of_edge; /**< Is always 2 ! */
/* index computations */
/* Within each element sides, edges, corners are numbered in some way. */
/* Within each side the edges and corners are numbered, within the edge the */
/* corners are numbered. The following arrays map the local numbers within */
/* the side or edge to the numbering within the element. */
INT edge_of_side[MAX_SIDES_OF_ELEM][MAX_EDGES_OF_SIDE];
INT corner_of_side[MAX_SIDES_OF_ELEM][MAX_CORNERS_OF_SIDE];
INT corner_of_edge[MAX_EDGES_OF_ELEM][MAX_CORNERS_OF_EDGE];
/* the following parameters are derived from data above */
INT mapped_inner_objt; /* tag to objt mapping for free list*/
INT mapped_bnd_objt; /* tag to objt mapping for free list*/
INT inner_size, bnd_size; /* size in bytes used for alloc */
INT edge_with_corners[MAX_CORNERS_OF_ELEM][MAX_CORNERS_OF_ELEM];
INT side_with_edge[MAX_EDGES_OF_ELEM][MAX_SIDES_OF_EDGE];
INT corner_of_side_inv[MAX_SIDES_OF_ELEM][MAX_CORNERS_OF_ELEM];
INT edges_of_corner[MAX_CORNERS_OF_ELEM][MAX_EDGES_OF_ELEM];
INT corner_of_oppedge[MAX_EDGES_OF_ELEM][MAX_CORNERS_OF_EDGE];
INT corner_opp_to_side[MAX_SIDES_OF_ELEM];
INT opposite_edge[MAX_EDGES_OF_ELEM];
INT side_opp_to_corner[MAX_CORNERS_OF_ELEM];
INT edge_of_corner[MAX_CORNERS_OF_ELEM][MAX_EDGES_OF_ELEM];
INT edge_of_two_sides[MAX_SIDES_OF_ELEM][MAX_SIDES_OF_ELEM];
/* ... the refinement rules should be placed here later */
} GENERAL_ELEMENT;
END_UGDIM_NAMESPACE
/** \todo move this to include section, when other general element stuff is separated */
#include "elements.h"
START_UGDIM_NAMESPACE
/****************************************************************************/
/* */
/* macros for element descriptors */
/* */
/****************************************************************************/
/** @name Macros to access element descriptors by element pointers */
/*@{*/
#define SIDES_OF_ELEM(p) (element_descriptors[TAG(p)]->sides_of_elem)
#define EDGES_OF_ELEM(p) (element_descriptors[TAG(p)]->edges_of_elem)
#define CORNERS_OF_ELEM(p) (element_descriptors[TAG(p)]->corners_of_elem)
#define LOCAL_COORD_OF_ELEM(p,c) (element_descriptors[TAG(p)]->local_corner[(c)])
#define SONS_OF_ELEM(p) (element_descriptors[TAG(p)]->max_sons_of_elem) /* this is the number of pointers ! */
#define EDGES_OF_SIDE(p,i) (element_descriptors[TAG(p)]->edges_of_side[(i)])
#define CORNERS_OF_SIDE(p,i) (element_descriptors[TAG(p)]->corners_of_side[(i)])
#define CORNERS_OF_EDGE 2
#define EDGE_OF_SIDE(p,s,e) (element_descriptors[TAG(p)]->edge_of_side[(s)][(e)])
#define EDGE_OF_TWO_SIDES(p,s,t) (element_descriptors[TAG(p)]->edge_of_two_sides[(s)][(t)])
#define CORNER_OF_SIDE(p,s,c) (element_descriptors[TAG(p)]->corner_of_side[(s)][(c)])
#define CORNER_OF_EDGE(p,e,c) (element_descriptors[TAG(p)]->corner_of_edge[(e)][(c)])
#define EDGE_WITH_CORNERS(p,c0,c1) (element_descriptors[TAG(p)]->edge_with_corners[(c0)][(c1)])
#define SIDE_WITH_EDGE(p,e,k) (element_descriptors[TAG(p)]->side_with_edge[(e)][(k)])
#define CORNER_OF_SIDE_INV(p,s,c) (element_descriptors[TAG(p)]->corner_of_side_inv[(s)][(c)])
#define EDGES_OF_CORNER(p,c,k) (element_descriptors[TAG(p)]->edges_of_corner[(c)][(k)])
#define CORNER_OF_OPPEDGE(p,e,c) (element_descriptors[TAG(p)]->corner_of_oppedge[(e)][(c)])
#define CORNER_OPP_TO_SIDE(p,s) (element_descriptors[TAG(p)]->corner_opp_to_side[(s)])
#define OPPOSITE_EDGE(p,e) (element_descriptors[TAG(p)]->opposite_edge[(e)])
#define SIDE_OPP_TO_CORNER(p,c) (element_descriptors[TAG(p)]->side_opp_to_corner[(c)])
#define EDGE_OF_CORNER(p,c,e) (element_descriptors[TAG(p)]->edge_of_corner[(c)][(e)])
#define CTRL2(p) ((p)->ge.flag)
#define FLAG(p) ((p)->ge.flag)
#define SUCCE(p) ((p)->ge.succ)
#define PREDE(p) ((p)->ge.pred)
#ifdef __CENTERNODE__
#define CENTERNODE(p) ((p)->ge.centernode)
#endif
#define CORNER(p,i) ((NODE *) (p)->ge.refs[n_offset[TAG(p)]+(i)])
#define EFATHER(p) ((ELEMENT *) (p)->ge.refs[father_offset[TAG(p)]])
#define SON(p,i) ((ELEMENT *) (p)->ge.refs[sons_offset[TAG(p)]+(i)])
/** \todo NbElem is declared in ugm.h, but never defined.
We need a clean solution. */
/*
#if defined(__TWODIM__)
#define NBELEM(p,i) NbElem((p),(i))
#else
*/
#define NBELEM(p,i) ((ELEMENT *) (p)->ge.refs[nb_offset[TAG(p)]+(i)])
/*
#endif
*/
#define ELEM_BNDS(p,i) ((BNDS *) (p)->ge.refs[side_offset[TAG(p)]+(i)])
#define EVECTOR(p) ((VECTOR *) (p)->ge.refs[evector_offset[TAG(p)]])
#define SVECTOR(p,i) ((VECTOR *) (p)->ge.refs[svector_offset[TAG(p)]+(i)])
#define EDATA(p) ((void *) (p)->ge.refs[data_offset[TAG(p)]])
#define SIDE_ON_BND(p,i) (ELEM_BNDS(p,i) != NULL)
#define INNER_SIDE(p,i) (ELEM_BNDS(p,i) == NULL)
#define INNER_BOUNDARY(p,i) (InnerBoundary(p,i))
/* TODO: replace by function call */
#ifdef __TWODIM__
#define EDGE_ON_BND(p,i) (ELEM_BNDS(p,i) != NULL)
#endif
#ifdef __THREEDIM__
#define EDGE_ON_BND(p,i) (SIDE_ON_BND(p,SIDE_WITH_EDGE(p,i,0)) || \
SIDE_ON_BND(p,SIDE_WITH_EDGE(p,i,1)))
#endif
/*@}*/
/* use the following macros to assign values, since definition */
/* above is no proper lvalue. */
#ifdef __CENTERNODE__
#define SET_CENTERNODE(p,q) ((p)->ge.centernode = q)
#endif
#define SET_CORNER(p,i,q) ((p)->ge.refs[n_offset[TAG(p)]+(i)] = q)
#define SET_EFATHER(p,q) ((p)->ge.refs[father_offset[TAG(p)]] = q)
#define SET_SON(p,i,q) ((p)->ge.refs[sons_offset[TAG(p)]+(i)] = q)
/** \todo Set_NbElem is declared in ugm.h, but never defined.
We need a clean solution. */
/*
#if defined(__TWODIM__)
#define SET_NBELEM(p,i,q) Set_NbElem((p),(i),(q))
#else
*/
#define SET_NBELEM(p,i,q) ((p)->ge.refs[nb_offset[TAG(p)]+(i)] = q)
/*
#endif
*/
#if defined(__TWODIM__)
#define VOID_NBELEM(p,i) NBELEM(p,i)
#else
#define VOID_NBELEM(p,i) ((p)->ge.refs[nb_offset[TAG(p)]+(i)])
#endif
#define SET_BNDS(p,i,q) ((p)->ge.refs[side_offset[TAG(p)]+(i)] = q)
#define SET_EVECTOR(p,q) ((p)->ge.refs[evector_offset[TAG(p)]] = q)
#define SET_SVECTOR(p,i,q) ((p)->ge.refs[svector_offset[TAG(p)]+(i)] = q)
#define SET_EDATA(p,q) ((p)->ge.refs[data_offset[TAG(p)]] = q)
#define SideBndCond(t,side,l,v,type) BNDS_BndCond(ELEM_BNDS(t,side),l,NULL,v,type)
#define Vertex_BndCond(p,w,i,v,t) BNDP_BndCond(V_BNDP(p),w,i,NULL,v,t)
/** @name Macros to access corner pointers directly */
/*@{*/
#define CORNER_OF_EDGE_PTR(e,i,j) (CORNER(e,CORNER_OF_EDGE(e,i,j)))
#define CORNER_OF_SIDE_PTR(e,i,j) (CORNER(e,CORNER_OF_SIDE(e,i,j)))
/*@}*/
/** @name Macros to access element descriptors by element tags */
/*@{*/
#define INNER_SIZE_TAG(t) (element_descriptors[t]->inner_size)
#define BND_SIZE_TAG(t) (element_descriptors[t]->bnd_size)
#define MAPPED_INNER_OBJT_TAG(t) (element_descriptors[t]->mapped_inner_objt)
#define MAPPED_BND_OBJT_TAG(t) (element_descriptors[t]->mapped_bnd_objt)
#define SIDES_OF_TAG(t) (element_descriptors[t]->sides_of_elem)
#define EDGES_OF_TAG(t) (element_descriptors[t]->edges_of_elem)
#define CORNERS_OF_TAG(t) (element_descriptors[t]->corners_of_elem)
#define LOCAL_COORD_OF_TAG(t,c) (element_descriptors[t]->local_corner[(c)])
#define SONS_OF_TAG(t) (element_descriptors[t]->max_sons_of_elem) /* this is the number of pointers ! */
#define EDGES_OF_SIDE_TAG(t,i) (element_descriptors[t]->edges_of_side[(i)])
#define CORNERS_OF_SIDE_TAG(t,i) (element_descriptors[t]->corners_of_side[(i)])
#define EDGE_OF_SIDE_TAG(t,s,e) (element_descriptors[t]->edge_of_side[(s)][(e)])
#define EDGE_OF_TWO_SIDES_TAG(t,s,u) (element_descriptors[t]->edge_of_two_sides[(s)][(u)])
#define CORNER_OF_SIDE_TAG(t,s,c) (element_descriptors[t]->corner_of_side[(s)][(c)])
#define CORNER_OF_EDGE_TAG(t,e,c) (element_descriptors[t]->corner_of_edge[(e)][(c)])
#define EDGE_WITH_CORNERS_TAG(t,c0,c1) (element_descriptors[t]->edge_with_corners[(c0)][(c1)])
#define SIDE_WITH_EDGE_TAG(t,e,k) (element_descriptors[t]->side_with_edge[(e)][(k)])
#define CORNER_OF_SIDE_INV_TAG(t,s,c) (element_descriptors[t]->corner_of_side_inv[(s)][(c)])
#define EDGES_OF_CORNER_TAG(t,c,k) (element_descriptors[t]->edges_of_corner[(c)][(k)])
#define CORNER_OF_OPPEDGE_TAG(t,e,c) (element_descriptors[t]->corner_of_oppedge[(e)][(c)])
#define CORNER_OPP_TO_SIDE_TAG(t,s) (element_descriptors[t]->corner_opp_to_side[(s)])
#define OPPOSITE_EDGE_TAG(t,e) (element_descriptors[t]->opposite_edge[(e)])
#define SIDE_OPP_TO_CORNER_TAG(t,c) (element_descriptors[t]->side_opp_to_corner[(c)])
#define EDGE_OF_CORNER_TAG(t,c,e) (element_descriptors[t]->edge_of_corner[(c)][(e)])
/*@}*/
/** @name Macros to access reference descriptors by number of element corners */
/*@{*/
#define SIDES_OF_REF(n) (reference_descriptors[n]->sides_of_elem)
#define EDGES_OF_REF(n) (reference_descriptors[n]->edges_of_elem)
#define CORNERS_OF_REF(n) (reference_descriptors[n]->corners_of_elem)
#define LOCAL_COORD_OF_REF(n,c) (reference_descriptors[n]->local_corner[(c)])
#define EDGES_OF_SIDE_REF(n,i) (reference_descriptors[n]->edges_of_side[(i)])
#define CORNERS_OF_SIDE_REF(n,i) (reference_descriptors[n]->corners_of_side[(i)])
#define EDGE_OF_SIDE_REF(n,s,e) (reference_descriptors[n]->edge_of_side[(s)][(e)])
#define EDGE_OF_TWO_SIDES_REF(n,s,t) (reference_descriptors[n]->edge_of_two_sides[(s)][(t)])
#define CORNER_OF_SIDE_REF(n,s,c) (reference_descriptors[n]->corner_of_side[(s)][(c)])
#define CORNER_OF_EDGE_REF(n,e,c) (reference_descriptors[n]->corner_of_edge[(e)][(c)])
#define EDGE_WITH_CORNERS_REF(n,c0,c1) (reference_descriptors[n]->edge_with_corners[(c0)][(c1)])
#define SIDE_WITH_EDGE_REF(n,e,k) (reference_descriptors[n]->side_with_edge[(e)][(k)])
#define CORNER_OF_SIDE_INV_REF(n,s,c) (reference_descriptors[n]->corner_of_side_inv[(s)][(c)])
#define EDGES_OF_CORNER_REF(n,c,k) (reference_descriptors[n]->edges_of_corner[(c)][(k)])
#define CORNER_OF_OPPEDGE_REF(n,e,c) (reference_descriptors[n]->corner_of_oppedge[(e)][(c)])
#define CORNER_OPP_TO_SIDE_REF(n,s) (reference_descriptors[n]->corner_opp_to_side[(s)])
#define OPPOSITE_EDGE_REF(n,e) (reference_descriptors[n]->opposite_edge[(e)])
#define SIDE_OPP_TO_CORNER_REF(n,c) (reference_descriptors[n]->side_opp_to_corner[(c)])
#define EDGE_OF_CORNER_REF(n,c,e) (reference_descriptors[n]->edge_of_corner[(c)][(e)])
/*@}*/
/****************************************************************************/
/* */
/* macros for grids */
/* */
/****************************************************************************/
/* control word offset */
#define GRID_OFFSET 0
#define GRID_STATUS_OFFSET 1
#define GLEVEL(p) ((p)->level)
#define GATTR(p) ((p)->attribut)
#define GFORMAT(p) MGFORMAT(MYMG(p))
#define SETGLOBALGSTATUS(p) ((p)->status=~0)
#define GSTATUS(p,n) ((p)->status&(n))
#define RESETGSTATUS(p,n) ((p)->status&=~(n))
#ifdef ModelP
#define PFIRSTELEMENT(p) ((LISTPART_FIRSTELEMENT(p,0)!=NULL) ?\
(LISTPART_FIRSTELEMENT(p,0)) : (FIRSTELEMENT(p)))
#define PRIO_FIRSTELEMENT(p,prio) ((p)->elements[PRIO2LISTPART(ELEMENT_LIST,prio)])
#define LISTPART_FIRSTELEMENT(p,part) ((p)->elements[part])
#define FIRSTELEMENT(p) ((p)->elements[PRIO2LISTPART(ELEMENT_LIST,PrioMaster)])
#define PLASTELEMENT(p) LASTELEMENT(p)
#define PRIO_LASTELEMENT(p,prio) ((p)->lastelement[PRIO2LISTPART(ELEMENT_LIST,prio)])
#define LISTPART_LASTELEMENT(p,part) ((p)->lastelement[part])
#define LASTELEMENT(p) ((p)->lastelement[PRIO2LISTPART(ELEMENT_LIST,PrioMaster)])
#else
#define FIRSTELEMENT(p) ((p)->elements[0])
#define PFIRSTELEMENT(p) FIRSTELEMENT(p)
#define LASTELEMENT(p) ((p)->lastelement[0])
#define PLASTELEMENT(p) LASTELEMENT(p)
#endif
#ifdef ModelP
#define PFIRSTVERTEX(p) ((LISTPART_FIRSTVERTEX(p,0)!=NULL) ?\
(LISTPART_FIRSTVERTEX(p,0)) :\
((LISTPART_FIRSTVERTEX(p,1)!=NULL) ?\
(LISTPART_FIRSTVERTEX(p,1)) : (FIRSTVERTEX(p))))
#define PRIO_FIRSTVERTEX(p,prio) ((p)->vertices[PRIO2LISTPART(VERTEX_LIST,prio)])
#define LISTPART_FIRSTVERTEX(p,part) ((p)->vertices[part])
#define FIRSTVERTEX(p) (((p)->vertices[PRIO2LISTPART(VERTEX_LIST,\
PrioBorder)]!=NULL) ?\
(p)->vertices[PRIO2LISTPART(VERTEX_LIST,PrioBorder)] :\
(p)->vertices[PRIO2LISTPART(VERTEX_LIST,PrioMaster)])
#define SFIRSTVERTEX(p) (p)->vertices[PRIO2LISTPART(VERTEX_LIST,PrioMaster)]
#define PLASTVERTEX(p) LASTVERTEX(p)
#define PRIO_LASTVERTEX(p,prio) ((p)->lastvertex[PRIO2LISTPART(VERTEX_LIST,prio)])
#define LISTPART_LASTVERTEX(p,part) ((p)->lastvertex[part])
#define LASTVERTEX(p) ((p)->lastvertex[PRIO2LISTPART(VERTEX_LIST,PrioMaster)])
#else
#define FIRSTVERTEX(p) ((p)->vertices[0])
#define PFIRSTVERTEX(p) FIRSTVERTEX(p)
#define SFIRSTVERTEX(p) FIRSTVERTEX(p)
#define LASTVERTEX(p) ((p)->lastvertex[0])
#define PLASTVERTEX(p) LASTVERTEX(p)
#endif
#define FIRSTELEMSIDE(p) ((p)->sides)
#ifdef ModelP
#define PFIRSTNODE(p) ((LISTPART_FIRSTNODE(p,0)!=NULL) ?\
(LISTPART_FIRSTNODE(p,0)) :\
((LISTPART_FIRSTNODE(p,1)!=NULL) ?\
(LISTPART_FIRSTNODE(p,1)) : (FIRSTNODE(p))))
#define PRIO_FIRSTNODE(p,prio) ((p)->firstNode[PRIO2LISTPART(NODE_LIST,prio)])
#define LISTPART_FIRSTNODE(p,part) ((p)->firstNode[part])
#define FIRSTNODE(p) (((p)->firstNode[PRIO2LISTPART(NODE_LIST,\
PrioBorder)]!=NULL) ?\
(p)->firstNode[PRIO2LISTPART(NODE_LIST,PrioBorder)] :\
(p)->firstNode[PRIO2LISTPART(NODE_LIST,PrioMaster)])
#define SFIRSTNODE(p) (p)->firstNode[PRIO2LISTPART(NODE_LIST,PrioMaster)]
#define PLASTNODE(p) LASTNODE(p)
#define PRIO_LASTNODE(p,prio) ((p)->lastNode[PRIO2LISTPART(NODE_LIST,prio)])
#define LISTPART_LASTNODE(p,part) ((p)->lastNode[part])
#define LASTNODE(p) ((p)->lastNode[PRIO2LISTPART(NODE_LIST,PrioMaster)])
#else
#define FIRSTNODE(p) ((p)->firstNode[0])
#define PFIRSTNODE(p) FIRSTNODE(p)
#define SFIRSTNODE(p) FIRSTNODE(p)
#define LASTNODE(p) ((p)->lastNode[0])
#define PLASTNODE(p) LASTNODE(p)
#endif
#ifdef ModelP
#define PFIRSTVECTOR(p) ((LISTPART_FIRSTVECTOR(p,0)!=NULL) ?\
(LISTPART_FIRSTVECTOR(p,0)) :\
((LISTPART_FIRSTVECTOR(p,1)!=NULL) ?\
(LISTPART_FIRSTVECTOR(p,1)) : (FIRSTVECTOR(p))))
#define PRIO_FIRSTVECTOR(p,prio) ((p)->firstVector[PRIO2LISTPART(VECTOR_LIST,prio)])
#define LISTPART_FIRSTVECTOR(p,part) ((p)->firstVector[part])
#define FIRSTVECTOR(p) (((p)->firstVector[PRIO2LISTPART(VECTOR_LIST,\
PrioBorder)]!=NULL) ?\
(p)->firstVector[PRIO2LISTPART(VECTOR_LIST,PrioBorder)] :\
(p)->firstVector[PRIO2LISTPART(VECTOR_LIST,PrioMaster)])
#define SFIRSTVECTOR(p) (p)->firstVector[PRIO2LISTPART(VECTOR_LIST,PrioMaster)]
#define PLASTVECTOR(p) LASTVECTOR(p)
#define PRIO_LASTVECTOR(p,prio) ((p)->lastVector[PRIO2LISTPART(VECTOR_LIST,prio)])
#define LISTPART_LASTVECTOR(p,part) ((p)->lastVector[part])
#define LASTVECTOR(p) ((p)->lastVector[PRIO2LISTPART(VECTOR_LIST,PrioMaster)])
#else
#define FIRSTVECTOR(p) ((p)->firstVector[0])
#define PFIRSTVECTOR(p) FIRSTVECTOR(p)
#define SFIRSTVECTOR(p) FIRSTVECTOR(p)
#define LASTVECTOR(p) ((p)->lastVector[0])
#define PLASTVECTOR(p) LASTVECTOR(p)
#endif
#define GFIRSTBV(p) ((p)->firstblockvector)
#define GLASTBV(p) ((p)->lastblockvector)
#define UPGRID(p) ((p)->finer)
#define DOWNGRID(p) ((p)->coarser)
#define MYMG(p) ((p)->mg)
#define NV(p) ((p)->nVert[0])
#define NN(p) ((p)->nNode[0])
#define NT(p) ((p)->nElem[0])
#define NVEC(p) ((p)->nVector[0])
#ifdef ModelP
#define NV_PRIO(p,prio) ((p)->nVert[prio])
#define NN_PRIO(p,prio) ((p)->nNode[prio])
#define NT_PRIO(p,prio) ((p)->nElem[prio])
#define NVEC_PRIO(p,prio) ((p)->nVector[prio])
#endif
#define NE(p) ((p)->nEdge)
#define NS(p) ((p)->nSide)
#define NC(p) ((p)->nCon)
#define VEC_DEF_IN_OBJ_OF_GRID(p,tp) (GFORMAT(p)->OTypeUsed[(tp)]>0)
#define NIMAT(p) ((p)->nIMat)
#define NELIST_DEF_IN_GRID(p) (GFORMAT(p)->nodeelementlist)
#define EDATA_DEF_IN_GRID(p) (GFORMAT(p)->elementdata)
#define NDATA_DEF_IN_GRID(p) (GFORMAT(p)->nodedata)
#define GRID_ATTR(g) ((unsigned char) (GLEVEL(g)+32))
#define ATTR_TO_GLEVEL(i) (i-32)
/****************************************************************************/
/* */
/* macros for multigrids */
/* */
/****************************************************************************/
/* control word offset */
#define MULTIGRID_STATUS_OFFSET ((sizeof(ENVDIR))/sizeof(UINT))
#define MGSTATUS(p) ((p)->status)
#define RESETMGSTATUS(p) {(p)->status=0; (p)->magic_cookie = (int)time(NULL); (p)->saved=0;}
#define MG_MAGIC_COOKIE(p) ((p)->magic_cookie)
#define VIDCNT(p) ((p)->vertIdCounter)
#define NIDCNT(p) ((p)->nodeIdCounter)
#define EIDCNT(p) ((p)->elemIdCounter)
#define TOPLEVEL(p) ((p)->topLevel)
#define BOTTOMLEVEL(p) ((p)->bottomLevel)
#define CURRENTLEVEL(p) ((p)->currentLevel)
#define FULLREFINELEVEL(p) ((p)->fullrefineLevel)
#define MGFORMAT(p) ((p)->theFormat)
#define DATAFORMAT(p) MGFORMAT(p)
#define MG_BVP(p) ((p)->theBVP)
#define MG_BVPD(p) (&((p)->theBVPD))
#define MGBNDSEGDESC(p,i) (&((p)->segments[i]))
#define MGVERTEX(p,k) ((p)->corners[k])
#define MGNOOFCORNERS(p) ((p)->numOfCorners)
#define MGHEAP(p) ((p)->theHeap)
#define MG_NPROPERTY(p) ((p)->nProperty)
#define GRID_ON_LEVEL(p,i) ((p)->grids[i])
/* macros for the NodeElementsBlockArray . . . */
#define ELEMS_OF_NODE_MAX 150
#define NDELEM_BLKS_MAX 100
#define NO_NODES_OF_BLK 1000
#define MGNDELEMPTRARRAY(p) ((p)->ndelemptrarray)
#define MGNDELEMBLK(p,i) (*(((p)->ndelemptrarray)+i))
#define MGNDELEMOFFS(i,o) (i*ELEMS_OF_NODE_MAX+o)
#define MGNDELEMBLKENTRY(p,b,i) (*((*(((p)->ndelemptrarray)+b))+i))
/* . . . macros for the NodeElementsBlockArray */
#define SELECTIONSIZE(p) ((p)->NbOfSelections)
#define SELECTIONMODE(p) ((p)->SelectionMode)
#define SELECTIONOBJECT(p,i) ((p)->Selection[(((i)<MAXSELECTION) ? (i) : (MAXSELECTION-1))])
#define MGNAME(p) ((p)->v.name)
#define MG_USER_HEAP(p) ((p)->UserHeap)
#define GEN_MGUD(p) ((p)->GenData)
#define GEN_MGUD_ADR(p,o) ((void *)(((char *)((p)->GenData))+(o)))
#define VEC_DEF_IN_OBJ_OF_MG(p,tp) (MGFORMAT(p)->OTypeUsed[(tp)]>0)
#define NELIST_DEF_IN_MG(p) (MGFORMAT(p)->nodeelementlist)
#define EDATA_DEF_IN_MG(p) (MGFORMAT(p)->elementdata)
#define NDATA_DEF_IN_MG(p) (MGFORMAT(p)->nodedata)
#define MG_GENPURP(p) ((p)->genpurp)
#define MG_SAVED(p) ((p)->saved)
#define MG_FILENAME(p) ((p)->filename)
#define MG_COARSE_FIXED(p) ((p)->CoarseGridFixed)
#define MG_MARK_KEY(p) ((p)->MarkKey)
/****************************************************************************/
/* */
/* macros for formats */
/* */
/****************************************************************************/
#define FMT_ELEM_DATA(f) ((f)->elementdata)
#define FMT_NODE_DATA(f) ((f)->nodedata)
#define FMT_NODE_ELEM_LIST(f) ((f)->nodeelementlist)
#define FMT_S_VERTEX(f) ((f)->sVertex)
#define FMT_S_MG(f) ((f)->sMultiGrid)
#define FMT_S_VEC_TP(f,t) ((f)->VectorSizes[t])
#define FMT_VTYPE_NAME(f,t) ((f)->VTypeNames[t])
#define FMT_S_MAT_TP(f,t) ((f)->MatrixSizes[t])
#define FMT_S_MATPTR(f) ((f)->MatrixSizes)
#define FMT_S_IMAT_TP(f,t) ((f)->IMatrixSizes[t])
#define FMT_CONN_DEPTH_TP(f,t) ((f)->ConnectionDepth[t])
#define FMT_CONN_DEPTH_PTR(f) ((f)->ConnectionDepth)
#define FMT_CONN_DEPTH_MAX(f) ((f)->MaxConnectionDepth)
#define FMT_NB_DEPTH(f) ((f)->NeighborhoodDepth)
#define FMT_PR_VERTEX(f) ((f)->PrintVertex)
#define FMT_PR_GRID(f) ((f)->PrintGrid)
#define FMT_PR_MG(f) ((f)->PrintMultigrid)
#define FMT_PR_VEC(f) ((f)->PrintVector)
#define FMT_PR_MAT(f) ((f)->PrintMatrix)
#define FMT_PO2T(f,p,o) ((f)->po2t[p][o])
#define FMT_T2P(f,t) ((f)->t2p[t])
#define FMT_TYPE_IN_PART(f,t,o) ((f)->t2p[o] & (1<<o))
#define FMT_T2O(f,o) ((f)->t2o[o])
#define FMT_TYPE_USES_OBJ(f,t,o) ((f)->t2o[o] & (1<<o))
#define FMT_USES_OBJ(f,o) ((f)->OTypeUsed[o])
#define FMT_MAX_PART(f) ((f)->MaxPart)
#define FMT_MAX_TYPE(f) ((f)->MaxType)
#define FMT_N2T(f,c) (((c)<FROM_VTNAME) ? NOVTYPE : ((c)>TO_VTNAME) ? NOVTYPE : (f)->n2t[(c)-FROM_VTNAME])
#define FMT_SET_N2T(f,c,t) ((f)->n2t[(c)-FROM_VTNAME] = t)
#define FMT_T2N(f,t) (((f)->t2n[t]))
/** \brief Constants for USED flags of objects */
enum {MG_ELEMUSED = 1,
MG_NODEUSED = 2,
MG_EDGEUSED = 4,
MG_VERTEXUSED = 8,
MG_VECTORUSED = 16,
MG_MATRIXUSED = 32};
/****************************************************************************/
/* */
/* declaration of exported global variables */
/* */
/****************************************************************************/
/* predefined blockvector description formats */
extern const BV_DESC_FORMAT DH_bvdf; /* bvdf for domain halfening */
extern const BV_DESC_FORMAT one_level_bvdf; /* bvdf for only 1 blocklevel */
extern const BV_DESC_FORMAT two_level_bvdf; /* bvdf for 2 blocklevels */
extern const BV_DESC_FORMAT three_level_bvdf; /* bvdf for 3 blocklevels */
#if defined ModelP && defined __OVERLAP2__
extern INT ce_NO_DELETE_OVERLAP2;
#endif
/****************************************************************************/
/* */
/* interface functions for module grid manager */
/* */
/****************************************************************************/
/** \brief Return values for functions returning an INT. The usual rule is: 0 ok, >0 error */
enum {GM_OK = 0,
GM_ERROR = 1,
GM_FILEOPEN_ERROR = 2,
GM_RULE_WITH_ORIENTATION = 3,
GM_RULE_WITHOUT_ORIENTATION = 4,
GM_OUT_OF_MEM = 5,
GM_OUT_OF_RANGE = 6,
GM_NOT_FOUND = 7,
GM_INCONSISTENCY = 8,
GM_COARSE_NOT_FIXED = 9,
GM_FATAL = 999};
/** @name Some constants passed as parameters */
/*@{*/
enum {GM_KEEP_BOUNDARY_NODES,
GM_MOVE_BOUNDARY_NODES,
GM_REFINE_TRULY_LOCAL,
GM_COPY_ALL,
GM_REFINE_NOT_CLOSED};
enum {GM_REFINE_PARALLEL, GM_REFINE_SEQUENTIAL};
enum {GM_REFINE_NOHEAPTEST, GM_REFINE_HEAPTEST};
enum {GM_FCFCLL = 1,
GM_FFCCLL = 2,
GM_FFLLCC = 3,
GM_FFLCLC = 4,
GM_CCFFLL = 5};
enum {GM_LOV_BEGIN = 1,
GM_LOV_END = 2};
enum {GM_GEN_FIRST, GM_GEN_LAST, GM_GEN_CUT};
enum {GM_ALL_LEVELS = 1,
GM_CURRENT_LEVEL = 2};
enum {GM_ORDER_IN_COLS, GM_ORDER_IN_ROWS};
enum {GM_PUT_AT_BEGIN = 1, /*!< put skip vectors at begin of the list */
GM_PUT_AT_END = 2 /*!< put skip vectors at end of the list */
};
#define GM_TAKE_SKIP (1<<0)
#define GM_TAKE_NONSKIP (1<<1)
/*@}*/
/* get/set current multigrid, loop through multigrids */
MULTIGRID *MakeMGItem (const char *name);
MULTIGRID *GetMultigrid (const char *name);
MULTIGRID *GetFirstMultigrid (void);
MULTIGRID *GetNextMultigrid (const MULTIGRID *theMG);
/* format definition */
FORMAT *GetFormat (const char *name);
FORMAT *GetFirstFormat (void);
FORMAT *GetNextFormat (FORMAT * fmt);
INT ChangeToFormatDir (const char *name);
INT DeleteFormat (const char *name);
FORMAT *CreateFormat (char *name, INT sVertex, INT sMultiGrid,
ConversionProcPtr PrintVertex,
ConversionProcPtr PrintGrid,
ConversionProcPtr PrintMultigrid,
TaggedConversionProcPtr PrintVector,
TaggedConversionProcPtr PrintMatrix,
INT nvDesc, VectorDescriptor *vDesc,
INT nmDesc, MatrixDescriptor *mDesc,
SHORT ImatTypes[],
INT po2t[MAXDOMPARTS][MAXVOBJECTS],
INT nodeelementlist, INT edata, INT ndata);
/* create, saving and disposing a multigrid structure */
MULTIGRID *CreateMultiGrid (char *MultigridName, char *BndValProblem,
const char *format, NS_PREFIX MEM heapSize,
INT optimizedIE, INT insertMesh);
MULTIGRID *OpenMGFromDataFile(MULTIGRID *theMG, INT number, char *type,
char *DataFileName, NS_PREFIX MEM heapSize);
MULTIGRID *LoadMultiGrid (const char *MultigridName, const char *name, const char *type,
const char *BndValProblem, const char *format,
unsigned long heapSize,INT force,INT optimizedIE, INT autosave);
INT SaveMultiGrid (MULTIGRID *theMG, const char *name, const char *type, const char *comment, INT autosave, INT rename);
INT DisposeGrid (GRID *theGrid);
INT DisposeMultiGrid (MULTIGRID *theMG);
INT DisposeAMGLevels (MULTIGRID *theMG);
INT Collapse (MULTIGRID *theMG);
#ifdef __TWODIM__
INT SaveCnomGridAndValues (MULTIGRID *theMG, char *FileName, char *plotprocName, char *tagName);
#endif
/* coarse grid manipulations */
NODE *InsertInnerNode (GRID *theGrid, const DOUBLE *pos);
NODE *InsertBoundaryNode (GRID *theGrid, BNDP *bndp);
INT DeleteNodeWithID (GRID *theGrid, INT id);
INT DeleteNode (GRID *theGrid, NODE *theNode);
ELEMENT *InsertElementFromIDs (GRID *theGrid, INT n, INT *idList, INT *bnds_flag);
ELEMENT *InsertElement (GRID *theGrid, INT n, NODE **NodeList, ELEMENT **ElemList, INT *NbgSdList, INT *bnds_flag);
INT InsertMesh (MULTIGRID *theMG, MESH *theMesh);
INT DeleteElementWithID (MULTIGRID *theMG, INT id);
INT DeleteElement (MULTIGRID *theMG, ELEMENT *theElement);
/* refinement */
/** \todo !!! should be moved to rm.h [Thimo] */
INT EstimateHere (const ELEMENT *theElement);
INT MarkForRefinement (ELEMENT *theElement, enum RefinementRule rule, INT data);
INT MarkForRefinementX (ELEMENT *theElement,
INT fl, INT tl, enum RefinementRule rule, INT data);
INT GetRefinementMark (ELEMENT *theElement, INT *rule, void *data);
INT GetRefinementMarkType (ELEMENT *theElement);
INT AdaptMultiGrid (MULTIGRID *theMG, INT flag, INT seq, INT mgtest);
INT TestRefineInfo (MULTIGRID *theMG);
INT SetRefineInfo (MULTIGRID *theMG);
INT ClearMarksOnLevel (GRID *theGrid, INT ClearType);
NODE *GetFineNodeOnEdge (const ELEMENT *theElement, INT side);
/* moving nodes */
INT GetMidNodeParam (NODE * theNode, DOUBLE *lambda);
INT GetCenterNodeParam (NODE * theNode, DOUBLE *lambda);
#ifdef __THREEDIM__
NODE GetSideNodeParam (NODE * theNode, DOUBLE *lambda);
INT GetSideIDFromScratch (ELEMENT *theElement, NODE *theNode);
#endif
INT MoveMidNode (MULTIGRID *theMG, NODE *theNode, DOUBLE lambda, INT update);
INT MoveBndMidNode (MULTIGRID *theMG, VERTEX *theVertex);
INT MoveCenterNode (MULTIGRID *theMG, NODE *theNode, DOUBLE *lambda);
#ifdef __THREEDIM__
INT MoveSideNode (MULTIGRID *theMG, NODE *theNode, DOUBLE *lambda);
#endif
INT MoveNode (MULTIGRID *theMG, NODE *theNode, DOUBLE *newPos, INT update);
INT MoveFreeBoundaryVertex (MULTIGRID *theMG, VERTEX *vert, const DOUBLE *newPos);
INT SetVertexGlobalAndLocal (VERTEX *vert, const DOUBLE *global, const DOUBLE *local);
INT FinishMovingFreeBoundaryVertices (MULTIGRID *theMG);
INT SmoothMultiGrid (MULTIGRID *theMG, INT niter, INT bdryFlag);
INT SmoothGrid (MULTIGRID *theMG, INT fl, INT tl, const DOUBLE LimitLocDis, const INT bnd_num, const INT *bnd, const INT option);
INT SmoothGridReset (MULTIGRID *theMG, INT fl, INT tl);
/* handling struct blockvector_description_format (BV_DESC_FORMAT) */
INT InitBVDF ( BV_DESC_FORMAT *bvdf, BLOCKNUMBER max_blocks );
/* handling struct blockvector_description (BV_DESC) */
INT PushEntry ( BV_DESC *bvd, BLOCKNUMBER bnr, const BV_DESC_FORMAT *bvdf );
/* functions to create a BLOCKVECTOR structure for a regular rectangular grid */
INT CreateBVStripe2D ( GRID *grid, INT vectors, INT vectors_per_stripe );
INT CreateBVStripe3D ( GRID *grid, INT inner_vectors, INT stripes_per_plane, INT vectors_per_stripe );
INT CreateBVDomainHalfening ( GRID *grid, INT side, INT leaf_size );
/* general functions for BLOCKVECTOR */
INT CreateBlockvector ( GRID *theGrid, BLOCKVECTOR **BVHandle );
INT CreateBlockvector_l0 ( GRID *theGrid, BLOCKVECTOR **BVHandle, BLOCKVECTOR *insertBV, INT after);
INT DisposeBlockvector ( GRID *theGrid, BLOCKVECTOR *bv );
void FreeAllBV ( GRID *grid );
void SetLevelnumberBV ( BLOCKVECTOR *bv, INT level );
/* algebraic connections */
CONNECTION *CreateExtraConnection (GRID *theGrid, VECTOR *from, VECTOR *to);
INT DisposeExtraConnections (GRID *theGrid);
INT DisposeConnectionsInGrid (GRID *theGrid);
MATRIX *GetMatrix (const VECTOR *FromVector, const VECTOR *ToVector);
MATRIX *GetOrderedMatrix (const VECTOR *FromVector, const VECTOR *ToVector);
CONNECTION *GetConnection (const VECTOR *FromVector, const VECTOR *ToVector);
#ifdef __INTERPOLATION_MATRIX__
MATRIX *GetIMatrix (VECTOR *FineVector, VECTOR *CoarseVector);
MATRIX *CreateIMatrix (GRID *theGrid, VECTOR *fvec, VECTOR *cvec);
INT DisposeIMatrixList (GRID *theGrid, VECTOR *theVector);
INT DisposeIMatricesInGrid (GRID *theGrid);
INT DisposeIMatricesInMultiGrid (MULTIGRID *theMG);
#endif
INT GetAllVectorsOfElement (GRID *theGrid, ELEMENT *theElement,
VECTOR **vec);
/* searching */
NODE *FindNodeFromId (const GRID *theGrid, INT id);
NODE *FindNodeFromPosition (const GRID *theGrid, const DOUBLE *pos, const DOUBLE *tol);
VECTOR *FindVectorFromPosition (GRID *theGrid, DOUBLE *pos, DOUBLE *tol);
VECTOR *FindVectorFromIndex (GRID *theGrid, INT index);
ELEMENT *FindElementFromId (GRID *theGrid, INT id);
ELEMENT *FindElementFromPosition(GRID *theGrid, DOUBLE *pos);
ELEMENT *FindElementOnSurface (MULTIGRID *theMG, DOUBLE *global);
ELEMENT *FindElementOnSurfaceCached (MULTIGRID *theMG, DOUBLE *global);
ELEMENT *NeighbourElement (ELEMENT *t, INT side);
INT InnerBoundary (ELEMENT *t, INT side);
BLOCKVECTOR *FindBV (const GRID *grid, const BV_DESC *bvd, const BV_DESC_FORMAT *bvdf );
/* list */
void ListMultiGridHeader (const INT longformat);
void ListMultiGrid (const MULTIGRID *theMG, const INT isCurrent, const INT longformat);
INT MultiGridStatus (const MULTIGRID *theMG, INT gridflag, INT greenflag, INT lbflag, INT verbose);
void ListGrids (const MULTIGRID *theMG);
void ListNode (const MULTIGRID *theMG, const NODE *theNode, INT dataopt, INT bopt, INT nbopt, INT vopt);
void ListNodeSelection (MULTIGRID *theMG, INT dataopt, INT bopt, INT nbopt, INT vopt);
void ListNodeRange (MULTIGRID *theMG, INT from, INT to, INT idopt, INT dataopt, INT bopt, INT nbopt, INT vopt);
void ListElement (const MULTIGRID *theMG, const ELEMENT *theElement, INT dataopt, INT bopt, INT nbopt, INT vopt);
void ListElementSelection (const MULTIGRID *theMG, INT dataopt, INT bopt, INT nbopt, INT vopt);
void ListElementRange (const MULTIGRID *theMG, INT from, INT to, INT idopt, INT dataopt, INT bopt, INT nbopt, INT vopt, INT lopt);
void ListVector (const MULTIGRID *theMG, const VECTOR *theVector, INT matrixopt, INT dataopt, INT modifiers);
void ListVectorSelection (const MULTIGRID *theMG, INT matrixopt, INT dataopt, INT modifiers);
void ListVectorOfElementSelection(const MULTIGRID *theMG, INT matrixopt, INT dataopt, INT modifiers);
void ListVectorRange (const MULTIGRID *theMG, INT fl, INT tl, INT from, INT to, INT idopt, INT matrixopt, INT dataopt, INT datatypes, INT modifiers);
/* query */
LINK *GetLink (const NODE *from, const NODE *to);
EDGE *GetSonEdge (const EDGE *theEdge);
INT GetSonEdges (const EDGE *theEdge, EDGE *SonEdges[MAX_SON_EDGES]);
EDGE *GetFatherEdge (const EDGE *theEdge);
#ifdef __THREEDIM__
EDGE *FatherEdge (NODE **SideNodes, INT ncorners, NODE **Nodes, EDGE *theEdge);
#endif
EDGE *GetEdge (const NODE *from, const NODE *to);
INT GetSons (const ELEMENT *theElement, ELEMENT *SonList[MAX_SONS]);
#ifdef ModelP
INT GetAllSons (const ELEMENT *theElement, ELEMENT *SonList[MAX_SONS]);
#endif
INT VectorPosition (const VECTOR *theVector, DOUBLE *position);
INT VectorInElement (ELEMENT *theElement, VECTOR *theVector);
INT MinMaxAngle (const ELEMENT *theElement, DOUBLE *amin, DOUBLE *amax);
/* check */
#ifndef ModelP
INT CheckGrid (GRID *theGrid, INT checkgeom, INT checkalgebra, INT checklists);
#else
INT CheckGrid (GRID *theGrid, INT checkgeom, INT checkalgebra, INT checklists, INT checkif);
#endif
INT CheckLists (GRID *theGrid);
INT CheckSubdomains (MULTIGRID *theMG);
/* selection */
void ClearSelection (MULTIGRID *theMG);
INT AddNodeToSelection (MULTIGRID *theMG, NODE *theNode);
INT IsNodeSelected (MULTIGRID *theMG, NODE *theNode);
INT AddElementToSelection (MULTIGRID *theMG, ELEMENT *theElement);
INT IsElementSelected (const MULTIGRID *theMG, const ELEMENT *theElement);
INT AddVectorToSelection (MULTIGRID *theMG, VECTOR *theVector);
INT IsVectorSelected (const MULTIGRID *theMG, const VECTOR *theVector);
INT RemoveNodeFromSelection (MULTIGRID *theMG, NODE *theNode);
INT RemoveElementFromSelection(MULTIGRID *theMG, ELEMENT *theElement);
INT RemoveVectorFromSelection(MULTIGRID *theMG, VECTOR *theVector);
/* multigrid user data space management (using the heaps.c block heap management) */
INT AllocateControlEntry (INT cw_id, INT length, INT *ce_id);
INT FreeControlEntry (INT ce_id);
void ListCWofObject (const void *obj, INT offset);
void ListAllCWsOfObject (const void *obj);
void ListAllCWsOfAllObjectTypes (PrintfProcPtr myprintf);
UINT ReadCW (const void *obj, INT ce);
void WriteCW (void *obj, INT ce, INT n);
void ResetCEstatistics (void);
void PrintCEstatistics (void);
INT DefineMGUDBlock (NS_PREFIX BLOCK_ID id, NS_PREFIX MEM size);
INT FreeMGUDBlock (NS_PREFIX BLOCK_ID id);
NS_PREFIX BLOCK_DESC *GetMGUDBlockDescriptor (NS_PREFIX BLOCK_ID id);
/* ordering of degrees of freedom */
ALG_DEP *CreateAlgebraicDependency (const char *name, DependencyProcPtr DependencyProc);
FIND_CUT *CreateFindCutProc (const char *name, FindCutProcPtr FindCutProc);
INT LexOrderVectorsInGrid (GRID *theGrid, INT mode, const INT *order, const INT *sign, INT which, INT SpecSkipVecs, INT AlsoOrderMatrices);
INT OrderVectors (MULTIGRID *theMG, INT levels, INT mode, INT PutSkipFirst, INT SkipPat, const char *dependency, const char *dep_options, const char *findcut);
INT ShellOrderVectors (GRID *theGrid, VECTOR *seed);
INT PrepareForLineorderVectors (GRID *theGrid);
INT MarkBeginEndForLineorderVectors (ELEMENT *elem, INT dt, INT ot, const INT *mark);
INT LineOrderVectors (MULTIGRID *theMG, INT levels, const char *dependency, const char *dep_options, const char *findcut, INT verboselevel);
INT RevertVecOrder (GRID *theGrid);
/* functions for evaluation-fct management */
INT InitEvalProc (void);
EVALUES *CreateElementValueEvalProc (const char *name, PreprocessingProcPtr PreProc, ElementEvalProcPtr EvalProc);
EVECTOR *CreateElementVectorEvalProc (const char *name, PreprocessingProcPtr PreProc, ElementVectorProcPtr EvalProc, INT d);
MVALUES *CreateMatrixValueEvalProc (const char *name, PreprocessingProcPtr PreProc, MatrixEvalProcPtr EvalProc);
EVALUES *CreateElementValueEvalProcFromCoeffProc (const char *name, CoeffProcPtr CoeffProc);
EVECTOR *CreateElementVectorEvalProcFromCoeffProc (const char *name, CoeffProcPtr CoeffProc, INT d);
EVALUES *GetElementValueEvalProc (const char *name);
EVECTOR *GetElementVectorEvalProc (const char *name);
MVALUES *GetMatrixValueEvalProc (const char *name);
EVALUES *GetFirstElementValueEvalProc (void);
EVALUES *GetNextElementValueEvalProc (EVALUES *EvalProc);
EVECTOR *GetFirstElementVectorEvalProc (void);
EVECTOR *GetNextElementVectorEvalProc (EVECTOR *EvecProc);
/* miscellaneous */
INT RenumberMultiGrid (MULTIGRID *theMG, INT *nboe, INT *nioe, INT *nbov, INT *niov, NODE ***vid_n, INT *foid, INT *non, INT MarkKey);
INT OrderNodesInGrid (GRID *theGrid, const INT *order, const INT *sign, INT AlsoOrderLinks);
INT PutAtEndOfList (GRID *theGrid, INT cnt, ELEMENT **elemList);
INT MGSetVectorClasses (MULTIGRID *theMG);
INT SetEdgeSubdomainFromElements (GRID *theGrid);
INT SetSubdomainIDfromBndInfo (MULTIGRID *theMG);
INT FixCoarseGrid (MULTIGRID *theMG);
INT ClearMultiGridUsedFlags (MULTIGRID *theMG, INT FromLevel, INT ToLevel, INT mask);
void CalculateCenterOfMass (ELEMENT *theElement, DOUBLE_VECTOR center_of_mass);
INT KeyForObject (KEY_OBJECT *obj);
/** \todo remove the following functions after the code will never need any debugging */
char *PrintElementInfo (ELEMENT *theElement,INT full);
END_UGDIM_NAMESPACE
#endif
|