1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034
|
The NetCDF Fortran 77 Interface Guide {#nc_f77_interface_guide}
=====================================
[TOC]
This document describes the FORTRAN-77 interface to the netCDF library.
1 Use of the NetCDF Library {#f77_Use_of_the_NetCDF_Library}
=============================
You can use the netCDF library without knowing about all of the netCDF
interface. If you are creating a netCDF dataset, only a handful of
routines are required to define the necessary dimensions, variables, and
attributes, and to write the data to the netCDF dataset. (Even less are
needed if you use the ncgen utility to create the dataset before runninga program using netCDF library calls to write data. See
section ‘ncgen’ in The NetCDF Users
Guide.) Similarly, if you are writing software to access data stored in
a particular netCDF object, only a smallbset of the netCDF library is
required to open the netCDF dataset and access the data. Authors of
generic applications that access arbitrary netCDF datasets need to be
familiar with more of the netCDF library.
In this we provide templates of common sequences of netCDF calls
needed for common uses. For clarity we present only the names of
routines; omit declarations and error checking; omit the type-specific
suffixes of routine names for variables and attributes; indent
statements that are typically invoked multiple times; and use ... to
represent arbitrary sequences of other statements. Full parameter lists
are described in laters.
1.1 Creating a NetCDF Dataset {#f77_Creating_a_NetCDF_Dataset}
-----------------------------
Here is a typical sequence of netCDF calls used to create a new netCDF
dataset:
NF_CREATE ! create netCDF dataset: enter define mode
...
NF_DEF_DIM ! define dimensions: from name and length
...
NF_DEF_VAR ! define variables: from name, type, dims
...
NF_PUT_ATT ! assign attribute values
...
NF_ENDDEF ! end definitions: leave define mode
...
NF_PUT_VAR ! provide values for variable
...
NF_CLOSE ! close: save new netCDF dataset
Only one call is needed to create a netCDF dataset, at which point you
will be in the first of two netCDF modes. When accessing an open netCDF
dataset, it is either in define mode or data mode. In define mode, you
can create dimensions, variables, and new attributes, but you cannot
read or write variable data. In data mode, you can access data and
change existing attributes, but you are not permitted to create new
dimensions, variables, or attributes.
One call to NF\_DEF\_DIM is needed for each dimension created.
Similarly, one call to NF\_DEF\_VAR is needed for each variable
creation, and one call to a member of the NF\_PUT\_ATT family is needed
for each attribute defined and assigned a value. To leave define mode
and enter data mode, call NF\_ENDDEF.
Once in data mode, you can add new data to variables, change old values,
and change values of existing attributes (so long as the attribute
changes do not require more storage space). Single values may be written
to a netCDF variable with one of the members of the NF\_PUT\_VAR1
family, depending on what type of data you have to write. All the values
of a variable may be written at once with one of the members of the
NF\_PUT\_VAR family. Arrays or array crosss of a variable may be
written using members of the NF\_PUT\_VARA family. Subsampled array
sections may be written using members of the NF\_PUT\_VARS family.
Mapped arrays may be written using members of the NF\_PUT\_VARM
family. (Subsampled and mapped access are general forms of data access
that are explained later.)
Finally, you should explicitly close all netCDF datasets that have been
opened for writing by calling NF\_CLOSE. By default, access to the file
system is buffered by the netCDF library. If a program terminates
abnormally with netCDF datasets open for writing, your most recent
modifications may be lost. This default buffering of data is disabled by
setting the NF\_SHARE flag when opening the dataset. But even if this
flag is set, changes to attribute values or changes made in define mode
are not written out until NF\_SYNC or NF\_CLOSE is called.
1.2 Reading a NetCDF Dataset with Known Names {#f77_Reading_a_NetCDF_Dataset_with_Known_Names}
---------------------------------------------
Here we consider the case where you know the names of not only the
netCDF datasets, but also the names of their dimensions, variables, and
attributes. (Otherwise you would have to do "inquire" calls.) The order
of typical C calls to read data from those variables in a netCDF dataset
is:
NF_OPEN ! open existing netCDF dataset
...
NF_INQ_DIMID ! get dimension IDs
...
NF_INQ_VARID ! get variable IDs
...
NF_GET_ATT ! get attribute values
...
NF_GET_VAR ! get values of variables
...
NF_CLOSE ! close netCDF dataset
First, a single call opens the netCDF dataset, given the dataset name,
and returns a netCDF ID that is used to refer to the open netCDF dataset
in allbsequent calls.
Next, a call to NF\_INQ\_DIMID for each dimension of interest gets the
dimension ID from the dimension name. Similarly, each required variable
ID is determined from its name by a call to NF\_INQ\_VARID.Once variable
IDs are known, variable attribute values can be retrieved using the
netCDF ID, the variable ID, and the desired attribute name as input to a
member of the NF\_GET\_ATT family (typically NF\_GET\_ATT\_TEXT or
NF\_GET\_ATT\_DOUBLE) for each desired attribute. Variable data values
can be directly accessed from the netCDF dataset with calls to members
of the NF\_GET\_VAR1 family for single values, the NF\_GET\_VAR family
for entire variables, or various other members of the NF\_GET\_VARA,
NF\_GET\_VARS, or NF\_GET\_VARM families for array,bsampled or mapped
access.
Finally, the netCDF dataset is closed with NF\_CLOSE. There is no need
to close a dataset open only for reading.
1.3 Reading a netCDF Dataset with Unknown Names {#f77_Reading_a_netCDF_Dataset_with_Unknown_Names}
-----------------------------------------------
It is possible to write programs (e.g., generic software) which doch
things as processing every variable, without needing to know in advance
the names of these variables. Similarly, the names of dimensions and
attributes may be unknown.
Names and other information about netCDF objects may be obtained from
netCDF datasets by calling inquire functions. These return information
about a whole netCDF dataset, a dimension, a variable, or an attribute.
The following template illustrates how they are used:
NF_OPEN ! open existing netCDF dataset
...
NF_INQ ! find out what is in it
...
NF_INQ_DIM ! get dimension names, lengths
...
NF_INQ_VAR ! get variable names, types, shapes
...
NF_INQ_ATTNAME ! get attribute names
...
NF_INQ_ATT ! get attribute values
...
NF_GET_ATT ! get attribute values
...
NF_GET_VAR ! get values of variables
...
NF_CLOSE ! close netCDF dataset
As in the previous example, a single call opens the existing netCDF
dataset, returning a netCDF ID. This netCDF ID is given to the NF\_INQ
routine, which returns the number of dimensions, the number of
variables, the number of global attributes, and the ID of the unlimited
dimension, if there is one.
All the inquire functions are inexpensive to use and require no I/O,
since the information they provide is stored in memory when a netCDF
dataset is first opened.
Dimension IDs use consecutive integers, beginning at 1. Also dimensions,
once created, cannot be deleted. Therefore, knowing the number of
dimension IDs in a netCDF dataset means knowing all the dimension IDs:
they are the integers 1, 2, 3, ... up to the number of dimensions. For
each dimension ID, a call to the inquire function NF\_INQ\_DIM returns
the dimension name and length.
Variable IDs are also assigned from consecutive integers 1, 2, 3, ... up
to the number of variables. These can be used in NF\_INQ\_VAR calls to
find out the names, types, shapes, and the number of attributes assigned
to each variable.
Once the number of attributes for a variable is known,ccessive calls
to NF\_INQ\_ATTNAME return the name for each attribute given the netCDF
ID, variable ID, and attribute number. Armed with the attribute name, a
call to NF\_INQ\_ATT returns its type and length. Given the type and
length, you can allocate enough space to hold the attribute values. Then
a call to a member of the NF\_GET\_ATT family returns the attribute
values.
Once the IDs and shapes of netCDF variables are known, data values can
be accessed by calling a member of the NF\_GET\_VAR1 family for single
values, or members of the NF\_GET\_VAR, NF\_GET\_VARA, NF\_GET\_VARS, or
NF\_GET\_VARM for various kinds of array access.
1.4 Adding New Dimensions, Variables, Attributes {#f77_Adding_New_Dimensions__Variables__Attributes}
------------------------------------------------
An existing netCDF dataset can be extensively altered. New dimensions,
variables, and attributes can be added or existing ones renamed, and
existing attributes can be deleted. Existing dimensions, variables, and
attributes can be renamed. The following code template lists a typical
sequence of calls to add new netCDF components to an existing dataset:
NF_OPEN ! open existing netCDF dataset
...
NF_REDEF ! put it into define mode
...
NF_DEF_DIM ! define additional dimensions (if any)
...
NF_DEF_VAR ! define additional variables (if any)
...
NF_PUT_ATT ! define other attributes (if any)
...
NF_ENDDEF ! check definitions, leave define mode
...
NF_PUT_VAR ! provide new variable values
...
NF_CLOSE ! close netCDF dataset
A netCDF dataset is first opened by the NF\_OPEN call. This call puts
the open dataset in data mode, which means existing data values can be
accessed and changed, existing attributes can be changed (so long as
they do not grow), but nothing can be added. To add new netCDF
dimensions, variables, or attributes you must enter define mode, by
calling NF\_REDEF.In define mode, call NF\_DEF\_DIM to define new
dimensions, NF\_DEF\_VAR to define new variables, and a member of the
NF\_PUT\_ATT family to assign new attributes to variables or enlarge old
attributes.
You can leave define mode and reenter data mode, checking all the new
definitions for consistency and committing the changes to disk, by
calling NF\_ENDDEF. If you do not wish to reenter data mode, just call
NF\_CLOSE, which will have the effect of first calling NF\_ENDDEF.
Until the NF\_ENDDEF call, you may back out of all the redefinitions
made in define mode and restore the previous state of the netCDF dataset
by calling NF\_ABORT. You may also use the NF\_ABORT call to restore the
netCDF dataset to a consistent state if the call to NF\_ENDDEF fails. If
you have called NF\_CLOSE from definition mode and the implied call to
NF\_ENDDEF fails, NF\_ABORT will automatically be called to close the
netCDF dataset and leave it in its previous consistent state (before you
entered define mode).
At most one process should have a netCDF dataset open for writing at one
time. The library is designed to provide limitedpport for multiple
concurrent readers with one writer, via disciplined use of the NF\_SYNC
function and the NF\_SHARE flag. If a writer makes changes in define
mode,ch as the addition of new variables, dimensions, or attributes,
some means external to the library is necessary to prevent readers from
making concurrent accesses and to inform readers to call NF\_SYNC before
the next access.
1.5 Error Handling {#f77_Error_Handling_1_5}
------------------
The netCDF library provides the facilities needed to handle errors in a
flexible way. Each netCDF function returns an integer status value. If
the returned status value indicates an error, you may handle it in any
way desired, from printing an associated error message and exiting to
ignoring the error indication and proceeding (not recommended!). For
simplicity, the examples in this guide check the error status and call a
separate function to handle any errors.
The NF\_STRERROR function is available to convert a returned integer
error status into an error message string.
Occasionally, low-level I/O errors may occur in a layer below the netCDF
library. For example, if a write operation causes you to exceed disk
quotas or to attempt to write to a device that is no longer available,
you may get an error from a layer below the netCDF library, but the
rlting write error will still be reflected in the returned status
value.
1.6 Compiling and Linking with the NetCDF Library {#f77_Compiling_and_Linking_with_the_NetCDF_Library}
-------------------------------------------------
Details of how to compile and link a program that uses the netCDF C or
FORTRAN interfaces differ, depending on the operating system, the
available compilers, and where the netCDF library and include files are
installed. Nevertheless, we provide here examples of how to compile and
link a program that uses the netCDF library on a Unix platform, so that
you can adjust these examples to fit your installation.
Every FORTRAN file that references netCDF functions or constants must
contain an appropriate INCLUDE statement before the first
reference:
INCLUDE 'netcdf.inc'
Unless the netcdf.inc file is installed in a standard directory where
the FORTRAN compiler always looks, you must use the -I option when
invoking the compiler, to specify a directory where netcdf.inc is
installed, for example:
f77 -c -I/usr/local/include myprogram.f
Unless the netCDF library is installed in a standard directory where the
linker always looks, you must use the -L and -l options to link an
object file that uses the netCDF library. Since version 4.1.3, the
netCDF Fortran library (named ‘libnetcdff’) is distinct from the netCDF
C library (named ‘libnetcdf’), but depends on it. If it is installed as
a shared library, you need only use ‘-lnetcdff’ to specify the Fortran
library for linking.
For example, if installed as a shared library, use something like:
f77 -o myprogram myprogram.o -L/usr/local/lib -lnetcdff
If installed as a static library, you will at least need to mention the
netCDF C library and perhaps other libraries,ch as hdf5 or curl,
depending on how the C library was built. For example:
f77 -o myprogram myprogram.o -L/usr/local/lib -lnetcdff -lnetcdf
Use of the nf-config utility program, installed as part of the
netcdf-fortran software, provides an easier way to compile and link,
without needing to know the details of where the library has been
installed, or whether it is installed as a shared or static library.
To see all the options for ‘nf-config’, invoke it with the ‘–help’
argument.
Here’s an example of how you could use ‘nf-config’ to compile and link a
Fortran program in one step:
f77 myprogram.f -o myprogram `nf-config --fflags --flibs`
If it is installed on your system, you could also use the ‘pkg-config’
utility to compile and link Fortran programs with the netCDF libraries.
This is especially useful in Makefiles, to ilate them from changes to
library versions and dependencies. Here is an example of how you could
compile and link a Fortran program with netCDF libraries using
pkg-config:
export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig
f77 myprogram.f -o myprogram `pkg-config --cflags --libs netcdf-fortran`
where here ‘–cflags’ means compiler flags and ‘libs’ requests that the
approriate libraries be linked in.
2. Datasets {#f77_Datasets}
===========
2.1 Datasets Introduction {#f77_Datasets_Introduction}
-------------------------
This presents the interfaces of the netCDF functions that deal
with a netCDF dataset or the whole netCDF library.
A netCDF dataset that has not yet been opened can only be referred to by
its dataset name. Once a netCDF dataset is opened, it is referred to by
a netCDF ID, which is a small nonnegative integer returned when you
create or open the dataset. A netCDF ID is much like a file descriptor
in C or a logical unit number in FORTRAN. In any single program, the
netCDF IDs of distinct open netCDF datasets are distinct. A single
netCDF dataset may be opened multiple times and will then have multiple
distinct netCDF IDs; however at most one of the open instances of a
single netCDF dataset should permit writing. When an open netCDF dataset
is closed, the ID is no longer associated with a netCDF dataset.
Functions that deal with the netCDF library include:
- Get version of library.
- Get error message corresponding to a returned error code.
The operationspported on a netCDF dataset as a single object are:
- Create, given dataset name and whether to overwrite or not.
- Open for access, given dataset name and read or write intent.
- Put into define mode, to add dimensions, variables, or attributes.
- Take out of define mode, checking consistency of additions.
- Close, writing to disk if required.
- Inquire about the number of dimensions, number of variables, number
of global attributes, and ID of the unlimited dimension, if any.
- Synchronize to disk to makere it is current.
- Set and unset nofill mode for optimized sequential writes.
- After ammary of conventions used in describing the netCDF
interfaces, the rest of this presents a detailed description
of the interfaces for these operations.
2.2 NetCDF Library Interface Descriptions {#f77_NetCDF_Library_Interface_Descriptions}
-----------------------------------------
Each interface description for a particular netCDF function in this and
laters contains:
- a description of the purpose of the function;
- a FORTRAN function prototype that presents the type and order of the
formal parameters to the function;
- a description of each formal parameter in the C interface;
- a list of possible error conditions; and
- an example of a FORTRAN program fragment calling the netCDF function
(and perhaps other netCDF functions).
The examples follow a simple convention for error handling, always
checking the error status returned from each netCDF function call and
calling a handle\_error function in case an error was detected. For an
example ofch a function, see Section 5.2 "Get error message
corresponding to error status: nf\_strerror".
2.3 NF_STRERROR {#f77_NF_STRERROR}
----------------
The function NF\_STRERROR returns a static reference to an error message
string corresponding to an integer netCDF error status or to a system
error number, prmably returned by a previous call to some other
netCDF function. The list of netCDF error status codes is available in
the appropriate include file for each language binding.
### Usage
~~~
CHARACTER*80 FUNCTION NF_STRERROR(INTEGER NCERR)
~~~
`NCERR`
: An error status that might have been returned from a previous call
to some netCDF function.
### Errors
If you provide an invalid integer error status that does not correspond
to any netCDF error message or or to any system error message (as
understood by the system strerror function), NF\_STRERROR returns a
string indicating that there is noch error status.
### Example
Here is an example of a simple error handling function that uses
NF\_STRERROR to print the error message corresponding to the netCDF
error status returned from any netCDF function call and then exit:
~~~
INCLUDE 'netcdf.inc'
...
SUBROUTINE HANDLE_ERR(STATUS)
INTEGER STATUS
IF (STATUS .NE. NF_NOERR) THEN
PRINT *, NF_STRERROR(STATUS)
STOP 'Stopped'
ENDIF
END
~~~
2.4 Get netCDF library version: NF_INQ_LIBVERS {#f77_Get_netCDF_library_version_NF_INQ_LIBVERS}
------------------------------------------------
The function NF\_INQ\_LIBVERS returns a string identifying the version
of the netCDF library, and when it was built.
### Usage
~~~
CHARACTER*80 FUNCTION NF_INQ_LIBVERS()
~~~
### Errors
This function takes no arguments, and thus no errors are possible in its
invocation.
### Example
Here is an example using nf\_inq\_libvers to print the version of the
netCDF library with which the program is linked:
~~~
INCLUDE 'netcdf.inc'
...
PRINT *, NF_INQ_LIBVERS()
~~~
2.5 NF_CREATE {#f77_NF_CREATE}
--------------
This function creates a new netCDF dataset, returning a netCDF ID that
can sequently be used to refer to the netCDF dataset in other netCDF
function calls. The new netCDF dataset opened for write access and
placed in define mode, ready for you to add dimensions, variables, and
attributes.
A creation mode flag specifies whether to overwrite any existing dataset
with the same name and whether access to the dataset is shared.
### Usage
~~~
INTEGER FUNCTION NF_CREATE (CHARACTER*(*) PATH, INTEGER CMODE,
INTEGER ncid)
~~~
`PATH`: The file name of the new netCDF dataset.
`CMODE`: The creation mode flag. The following flags are available:
NF\_NOCLOBBER, NF\_SHARE, NF\_64BIT\_OFFSET, NF\_NETCDF4 and
NF\_CLASSIC\_MODEL. You can combine the affect of multiple flags in
a single argument by using the bitwise OR operator. For example, to
specify both NF\_NOCLOBBER and NF\_SHARE, you could provide the
argument OR(NF\_NOCLOBBER, NF\_SHARE).
A zero value (defined for convenience as NF_CLOBBER) specifies the
default behavior: overwrite any existing dataset with the same file
name and buffer and cache accesses for efficiency. The dataset will
be in netCDF classic format. See 'NetCDF Classic Format Limitations'
in The NetCDF Users Guide.
Setting NF\_NOCLOBBER means you do not want to clobber (overwrite)
an existing dataset; an error (NF_EEXIST) is returned if the
specified dataset already exists.
The NF\_SHARE flag is appropriate when one process may be writing
the dataset and one or more other processes reading the dataset
concurrently; it means that dataset accesses are not buffered and
caching is limited. Since the buffering scheme is optimized for
sequential access, programs that do not access data sequentially may
see some performance improvement by setting the NF\_SHARE flag. This
only applied to classic and 64-bit offset format files.
Setting NF\_64BIT\_OFFSET causes netCDF to create a 64-bit offset
format file, instead of a netCDF classic format file. The 64-bit
offset format imposes far fewer restrictions on very large (i.e.
over 2 GB) data files. See [(netcdf)Large File
Support](netcdf.html#Large-File-Support) ‘Large File
Support’ in The NetCDF Users Guide.
Setting NF\_NETCDF4 causes netCDF to create a netCDF-4/HDF5 format
file. Oring NF\_CLASSIC\_MODEL with NF\_NETCDF4 causes the netCDF
library to create a netCDF-4/HDF5 data file, with the netCDF classic
model enforced - none of the new features of the netCDF-4 data model
may be usedinch a file, for example groups and user-defined
types.
`ncid`
: Returned netCDF ID.
### Errors
NF\_CREATE returns the value NF\_NOERR if no errors occurred. Possible
causes of errors include:
- Passing a dataset name that includes a directory that does not
exist.
- Specifying a dataset name of a file that exists and also specifying
NF\_NOCLOBBER.
- Specifying a meaningless value for the creation mode.
- Attempting to create a netCDF dataset in a directory where you don’t
have permission to create files.
### Example
In this example we create a netCDF dataset named foo.nc; we want the
dataset to be created in the current directory only if a dataset with
that name does not already exist:
~~~
INCLUDE 'netcdf.inc'
...
INTEGER NCID, STATUS
...
STATUS = NF_CREATE('foo.nc', NF_NOCLOBBER, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
~~~
2.6 NF__CREATE {#f77_F__CREATE}
----------------
This function is a variant of NF\_CREATE, NF\_\_CREATE (note the double
underscore) allows users to specify two tuning parameters for the file
that it is creating. These tuning parameters are not written to the data
file, they are only used for so long as the file remains open after an
NF\_\_CREATE.
This function creates a new netCDF dataset, returning a netCDF ID that
canbsequently be used to refer to the netCDF dataset in other netCDF
function calls. The new netCDF dataset opened for write access and
placed in define mode, ready for you to add dimensions, variables, and
attributes.
A creation mode flag specifies whether to overwrite any existing dataset
with the same name and whether access to the dataset is shared.
### Usage
~~~
INTEGER FUNCTION NF__CREATE (CHARACTER*(*) PATH, INTEGER CMODE, INTEGER INITIALSZ,
INTEGER BUFRSIZEHINT, INTEGER ncid)
~~~
`PATH`
: The file name of the new netCDF dataset.
`CMODE`
: The creation mode flag. The following flags are available:
NF\_NOCLOBBER, NF\_SHARE, NF\_64BIT\_OFFSET, NF\_NETCDF4, and
NF\_CLASSIC\_MODEL.
Setting NF\_NOCLOBBER means you do not want to clobber (overwrite)
an existing dataset; an error (NF\_EEXIST) is returned if the
specified dataset already exists.
The NF\_SHARE flag is appropriate when one process may be writing
the dataset and one or more other processes reading the dataset
concurrently; it means that dataset accesses are not buffered and
caching is limited. Since the buffering scheme is optimized for
sequential access, programs that do not access data sequentially may
see some performance improvement by setting the NF\_SHARE flag. This
flag has no effect with netCDF-4/HDF5 files.
Setting NF\_64BIT\_OFFSET causes netCDF to create a 64-bit offset
format file, instead of a netCDF classic format file. The 64-bit
offset format imposes far fewer restrictions on very large (i.e.
over 2 GB) data files. See [(netcdf)Large File
Support](netcdf.html#Large-File-Support) ‘Large File
Support’ in The NetCDF Users Guide.
Setting NF\_CLASSIC\_MODEL causes netCDF to enforce the classic data
model in this file. (This only has effect for netCDF-4/HDF5 files,
as classic and 64-bit offset files always use the classic model.)
When used with NF\_NETCDF4, this flag eres that the rlting
netCDF-4/HDF5 file may never contain any new constructs from the
enhanced data model. That is, it cannot contain groups, user defined
types, multiple unlimited dimensions, or new atomic types. The
advantage of this restriction is thatch files are guarenteed to
work with existing netCDF software.
A zero value (defined for convenience as NF\_CLOBBER) specifies the
default behavior: overwrite any existing dataset with the same file
name and buffer and cache accesses for efficiency. The dataset will
be in netCDF classic format. See [(netcdf)NetCDF Classic Format
Limitations](netcdf.html#NetCDF-Classic-Format-Limitations)
‘NetCDF Classic Format Limitations’ in The NetCDF Users Guide.
`INITIALSZ`
: This parameter sets the initial size of the file at creation time.
`BUFRSIZEHINT`
: The argument referenced by BUFRSIZEHINT controls a space ves time
tradeoff, memory allocated in the netcdf library ves number of
system calls.
Because of internal requirements, the value may not be set to
exactly the value requested. The actual value chosen is returned by
reference.
Using the value NF\_SIZEHINT\_DEFAULT causes the library to choose a
default. How the system chooses the default depends on the system.
On many systems, the "preferred I/O block size" is available from
the stat() system call, struct stat member st\_blksize. If this is
available it is used. Lacking that, twice the system pagesize is
used.
Lacking a call to discover the system pagesize, we just set default
bufrsize to 8192.
The BUFRSIZE is a property of a given open netcdf descriptor ncid,
it is not a persistent property of the netcdf dataset.
`ncid`
: Returned netCDF ID.
### Errors
NF\_\_CREATE returns the value NF\_NOERR if no errors occurred. Possible
causes of errors include:
- Passing a dataset name that includes a directory that does not
exist.
- Specifying a dataset name of a file that exists and also specifying
NF\_NOCLOBBER.
- Specifying a meaningless value for the creation mode.
- Attempting to create a netCDF dataset in a directory where you don’t
have permission to create files.
### Example
In this example we create a netCDF dataset named foo.nc; we want the
dataset to be created in the current directory only if a dataset with
that name does not already exist:
~~~
INCLUDE 'netcdf.inc'
...
INTEGER NCID, STATUS, INITIALSZ, BUFRSIZEHINT
...
INITIALSZ = 2048
BUFRSIZEHINT = 1024
STATUS = NF__CREATE('foo.nc', NF_NOCLOBBER, INITIALSZ, BUFRSIZEHINT, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
~~~
2.7 NF_CREATE_PAR {#f77_NF_CREATE_PAR}
-------------------
This function is a variant of nf\_create, nf\_create\_par allows users
to open a file on a MPI/IO or MPI/Posix parallel file system.
The parallel parameters are not written to the data file, they are only
used for so long as the file remains open after an nf\_create\_par.
This function is only available if the netCDF library was built with
parallel I/O.
This function creates a new netCDF dataset, returning a netCDF ID that
canbsequently be used to refer to the netCDF dataset in other netCDF
function calls. The new netCDF dataset opened for write access and
placed in define mode, ready for you to add dimensions, variables, and
attributes.
When a netCDF-4 file is created for parallel access, independent
operations are the default. To use collective access on a variable, See
section [Change between Collective and Independent Parallel Access:
NF\_VAR\_PAR\_ACCESS](#NF_005fVAR_005fPAR_005fACCESS).
### Usage
~~~
INTEGER FUNCTION NF_CREATE_PAR(CHARACTER*(*) PATH, INTEGER CMODE,
INTEGER MPI_COMM, INTEGER MPI_INFO,
INTEGER ncid)
~~~
`PATH`
: The file name of the new netCDF dataset.
`CMODE`
: The creation mode flag. The following flags are available:
NF\_NOCLOBBER, NF\_NETCDF4 and NF\_CLASSIC\_MODEL. You can combine
the affect of multiple flags in a single argument by using the
bitwise OR operator. For example, to specify both NF\_NOCLOBBER and
NF\_NETCDF4, you could provide the argument OR(NF\_NOCLOBBER,
NF\_NETCDF4).
Setting NF\_NETCDF4 causes netCDF to create a netCDF-4/HDF5 format
file. Oring NF\_CLASSIC\_MODEL with NF\_NETCDF4 causes the netCDF
library to create a netCDF-4/HDF5 data file, with the netCDF classic
model enforced - none of the new features of the netCDF-4 data model
may be usedinch a file, for example groups and user-defined
types.
Only netCDF-4/HDF5 files may be used with parallel I/O.
`MPI_COMM`
: The MPI communicator.
`MPI_INFO`
: The MPI info.
`ncid`
: Returned netCDF ID.
### Errors
NF\_CREATE returns the value NF\_NOERR if no errors occurred. Possible
causes of errors include:
- Passing a dataset name that includes a directory that does not
exist.
- Specifying a dataset name of a file that exists and also specifying
NF\_NOCLOBBER.
- Specifying a meaningless value for the creation mode.
- Attempting to create a netCDF dataset in a directory where you don’t
have permission to create files.
### Example
This example is from test program nf\_test/ftst\_parallel.F.
~~~
! Create the netCDF file.
mode_flag = IOR(nf_netcdf4, nf_classic_model)
retval = nf_create_par(FILE_NAME, mode_flag, MPI_COMM_WORLD,
$ MPI_INFO_NULL, ncid)
if (retval .ne. nf_noerr) stop 2
~~~
2.8 NF_OPEN {#f77_NF_OPEN_}
------------
The function NF\_OPEN opens an existing netCDF dataset for access.
### Usage
~~~
INTEGER FUNCTION NF_OPEN(CHARACTER*(*) PATH, INTEGER OMODE, INTEGER ncid)
~~~
`PATH`
: File name for netCDF dataset to be opened. This may be an OPeNDAP
URL if DAPpport is enabled.
`OMODE`
: A zero value (or NF\_NOWRITE) specifies: open the dataset with
read-only access, buffering and caching accesses for efficiency.
Otherwise, the creation mode is NF\_WRITE, NF\_SHARE, or
OR(NF\_WRITE, NF\_SHARE). Setting the NF\_WRITE flag opens the
dataset with read-write access. ("Writing" means any kind of change
to the dataset, including appending or changing data, adding or
renaming dimensions, variables, and attributes, or deleting
attributes.) The NF\_SHARE flag is appropriate when one process may
be writing the dataset and one or more other processes reading the
dataset concurrently; it means that dataset accesses are not
buffered and caching is limited. Since the buffering scheme is
optimized for sequential access, programs that do not access data
sequentially may see some performance improvement by setting the
NF\_SHARE flag.
`ncid`
: Returned netCDF ID.
### Errors
NF\_OPEN returns the value NF\_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
- The specified netCDF dataset does not exist.
- A meaningless mode was specified.
### Example
Here is an example using NF\_OPEN to open an existing netCDF dataset
named foo.nc for read-only, non-shared access:
~~~
INCLUDE 'netcdf.inc'
...
INTEGER NCID, STATUS
...
STATUS = NF_OPEN('foo.nc', 0, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
~~~
2.9 NF__OPEN {#NF__OPEN_}
--------------
The function NF\_OPEN opens an existing netCDF dataset for access, with
a performance tuning parameter.
### Usage
~~~
INTEGER FUNCTION NF_OPEN(CHARACTER*(*) PATH, INTEGER OMODE, INTEGER
BUFRSIZEHINT, INTEGER ncid)
~~~
`PATH`
: File name for netCDF dataset to be opened.
`OMODE`
: A zero value (or NF\_NOWRITE) specifies: open the dataset with
read-only access, buffering and caching accesses for efficiency
Otherwise, the creation mode is NF\_WRITE, NF\_SHARE, or
OR(NF\_WRITE,NF\_SHARE). Setting the NF\_WRITE flag opens the
dataset with read-write access. ("Writing" means any kind of change
to the dataset, including appending or changing data, adding or
renaming dimensions, variables, and attributes, or deleting
attributes.) The NF\_SHARE flag is appropriate when one process may
be writing the dataset and one or more other processes reading the
dataset concurrently; it means that dataset accesses are not
buffered and caching is limited. Since the buffering scheme is
optimized for sequential access, programs that do not access data
sequentially may see some performance improvement by setting the
NF\_SHARE flag.
`BUFRSIZEHINT`
: This argument controls a space ves time tradeoff, memory
allocated in the netcdf library ves number of system calls.
Because of internal requirements, the value may not be set to
exactly the value requested. The actual value chosen is returned by
reference.
Using the value NF\_SIZEHINT\_DEFAULT causes the library to choose a
default. How the system chooses the default depends on the system.
On many systems, the "preferred I/O block size" is available from
the stat() system call, struct stat member st\_blksize. If this is
available it is used. Lacking that, twice the system pagesize is
used.
Lacking a call to discover the system pagesize, we just set default
bufrsize to 8192.
The bufrsize is a property of a given open netcdf descriptor ncid,
it is not a persistent property of the netcdf dataset.
`ncid`
: Returned netCDF ID.
### Errors
NF\_\_OPEN returns the value NF\_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
- The specified netCDF dataset does not exist.
- A meaningless mode was specified.
### Example
Here is an example using NF\_\_OPEN to open an existing netCDF dataset
named foo.nc for read-only, non-shared access:
~~~
INCLUDE 'netcdf.inc'
...
INTEGER NCID, STATUS, BUFRSIZEHINT
...
BUFRSIZEHINT = 1024
STATUS = NF_OPEN('foo.nc', 0, BUFRSIZEHINT, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
~~~
2.10 NF_OPEN_PAR {#f77_NF_OPEN_PAR}
------------------
This function opens a netCDF-4 dataset for parallel access.
This function is only available if the netCDF library was built with a
HDF5 library for which –enable-parallel was used, and which was linked
(like HDF5) to MPI libraries.
This opens the file using either MPI-IO or MPI-POSIX. The file must be a
netCDF-4 file. (That is, it must have been created using NF\_NETCDF4 in
the creation mode).
This function is only available if netCDF-4 was build with a version of
the HDF5 library which was built with –enable-parallel.
Before either HDF5 or netCDF-4 can be installed withpport for
parallel programming, and MPI layer must also be installed on the
machine, and ally a parallel file system.
NetCDF-4 exposes the parallel access functionality of HDF5. For more
information about what is required to install and use the parallel
access functions, see the HDF5 web site.
When a netCDF-4 file is opened for parallel access, collective
operations are the default. To use independent access on a variable, See
section [Change between Collective and Independent Parallel Access:
NF\_VAR\_PAR\_ACCESS](#NF_005fVAR_005fPAR_005fACCESS).
Usage
-----
~~~
INTEGER FUNCTION NF_OPEN_PAR(CHARACTER*(*) PATH, INTEGER OMODE,
INTEGER MPI_COMM, INTEGER MPI_INFO,
INTEGER ncid)
~~~
`PATH`
: File name for netCDF dataset to be opened.
`OMODE`
: A zero value (or NF\_NOWRITE) specifies: open the dataset with
read-only access.
Otherwise, the mode may be NF\_WRITE. Setting the NF\_WRITE flag
opens the dataset with read-write access. ("Writing" means any kind
of change to the dataset, including appending or changing data,
adding or renaming dimensions, variables, and attributes, or
deleting attributes.)
Setting NF\_NETCDF4 is not necessary (or allowed). The file type is
detected automatically.
`MPI_COMM`
: The MPI communicator.
`MPI_INFO`
: The MPI info.
`ncid`
: Returned netCDF ID.
Errors
------
NF\_OPEN returns the value NF\_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
- The specified netCDF dataset does not exist.
- A meaningless mode was specified.
- Not a netCDF-4 file.
Example
-------
This example is from the test program nf\_test/ftst\_parallel.F.
~~~~
! Reopen the file.
retval = nf_open_par(FILE_NAME, nf_nowrite, MPI_COMM_WORLD,
$ MPI_INFO_NULL, ncid)
if (retval .ne. nf_noerr) stop 2
~~~~
2.11 NF_REDEF {#f77_NF-REDEF}
--------------
The function NF\_REDEF puts an open netCDF dataset into define mode, so
dimensions, variables, and attributes can be added or renamed and
attributes can be deleted.
Usage
-----
INTEGER FUNCTION NF_REDEF(INTEGER NCID)
`NCID`
: netCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
Errors
------
NF\_REDEF returns the value NF\_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
- The specified netCDF dataset is already in define mode.
- The specified netCDF dataset was opened for read-only.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_REDEF to open an existing netCDF dataset
named foo.nc and put it into define mode:
~~~~
INCLUDE 'netcdf.inc'
...
INTEGER NCID, STATUS
...
STATUS = NF_OPEN('foo.nc', NF_WRITE, NCID) ! open dataset
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_REDEF(NCID) ! put in define mode
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
~~~~
2.12 NF_ENDDEF {#f77_NF-ENDDEF}
---------------
The function NF\_ENDDEF takes an open netCDF dataset out of define mode.
The changes made to the netCDF dataset while it was in define mode are
checked and committed to disk if no problems occurred. Non-record
variables may be initialized to a "fill value" as well (see
[NF\_SET\_FILL](#NF_005fSET_005fFILL)). The netCDF dataset is then
placed in data mode, so variable data can be read or written.
This call may involve copying data under some circumstances. See
[(netcdf)File Structure and
Performance](netcdf.html#File-Structure-and-Performance) ‘File
Structure and Performance’ in NetCDF Users’ Guide.
Usage
-----
INTEGER FUNCTION NF_ENDDEF(INTEGER NCID)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
Errors
------
NF\_ENDDEF returns the value NF\_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
- The specified netCDF dataset is not in define mode.
- The specified netCDF ID does not refer to an open netCDF dataset.
The size of one or more variables exceed the size constraints for
whichever variant of the file format is in use). See [(netcdf)Large
File Support](netcdf.html#Large-File-Support) ‘Large File
Support’ in The NetCDF Users Guide.
Example
-------
Here is an example using NF\_ENDDEF to finish the definitions of a new
netCDF dataset named foo.nc and put it into data mode:
~~~~
INCLUDE 'netcdf.inc'
...
INTEGER NCID, STATUS
...
STATUS = NF_CREATE('foo.nc', NF_NOCLOBBER, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
... ! create dimensions, variables, attributes
STATUS = NF_ENDDEF(NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
~~~~
2.13 NF__ENDDEF {#f77_NF__ENDDEF}
-----------------
The function NF\_\_ENDDEF takes an open netCDF dataset out of define
mode. The changes made to the netCDF dataset while it was in define mode
are checked and committed to disk if no problems occurred. Non-record
variables may be initialized to a "fill value" as well (see
[NF\_SET\_FILL](#NF_005fSET_005fFILL)). The netCDF dataset is then
placed in data mode, so variable data can be read or written.
This call may involve copying data under some circumstances. See
[(netcdf)File Structure and
Performance](netcdf.html#File-Structure-and-Performance) ‘File
Structure and Performance’ in NetCDF Users’ Guide.
This function ames specific characteristics of the netcdf version 1
and version 2 file formats. Users should use nf\_enddef in most
circumstances. Although this function will be available in future netCDF
implementations, it may not continue to have any effect on performance.
The current netcdf file format has threes, the "header",
the data for fixed size variables, and the data for
variables which have an unlimited dimension (record variables).
The header begins at the beginning of the file. The index (offset) of
the beginning of the other twos is contained in the header.
Typically, there is no space between thes. This causes copying
overhead to accrue if one wishes to change the size of thes, as
may happen when changing names of things, text attribute values, adding
attributes or adding variables. Also, for buffered i/o, there may be
advantages to alignings in certain ways.
The minfree parameters allow one to control costs of future calls to
nf\_redef, nf\_enddef by requesting that minfree bytes be available at
the end of the.
The align parameters allow one to set the alignment of the beginning of
the correspondings. The beginning of the is rounded up
to an index which is a multiple of the align parameter. The flag value
ALIGN\_CHUNK tells the library to use the bufrsize (see above) as the
align parameter.
The file format requires mod 4 alignment, so the align parameters are
silently rounded up to multiples of 4. The al call,
nf_enddef(ncid);
is equivalent to
nf_enddef(ncid, 0, 4, 0, 4);
The file format does not contain a "record size" value, this is
calculated from the sizes of the record variables. This unfortunate fact
prevents us from providing minfree and alignment control of the
"records" in a netcdf file. If you add a variable which has an unlimited
dimension, the third will always be copied with the new variable
added.
Usage
-----
INTEGER FUNCTION NF_ENDDEF(INTEGER NCID, INTEGER H_MINFREE, INTEGER V_ALIGN,
INTEGER V_MINFREE, INTEGER R_ALIGN)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`H_MINFREE`
: Sets the pad at the end of the "header".
`V_ALIGN`
: Controls the alignment of the beginning of the data for
fixed size variables.
`V_MINFREE`
: Sets the pad at the end of the data for fixed size
variables.
`R_ALIGN`
: Controls the alignment of the beginning of the data for
variables which have an unlimited dimension (record variables).
Errors
------
NF\_\_ENDDEF returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The specified netCDF dataset is not in define mode.
- The specified netCDF ID does not refer to an open netCDF dataset.
- The size of one or more variables exceed the size constraints for
whichever variant of the file format is in use). See [(netcdf)Large
File Support](netcdf.html#Large-File-Support) ‘Large File
Support’ in The NetCDF Users Guide.
Example
-------
Here is an example using NF\_\_ENDDEF to finish the definitions of a new
netCDF dataset named foo.nc and put it into data mode:
~~~~
INCLUDE 'netcdf.inc'
...
INTEGER NCID, STATUS, H_MINFREE, V_ALIGN, V_MINFREE, R_ALIGN
...
STATUS = NF_CREATE('foo.nc', NF_NOCLOBBER, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
... ! create dimensions, variables, attributes
H_MINFREE = 512
V_ALIGN = 512
V_MINFREE = 512
R_ALIGN = 512
STATUS = NF_ENDDEF(NCID, H_MINFREE, V_ALIGN, V_MINFREE, R_ALIGN)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
~~~~
2.14 NF_CLOSE {#f77_NF-CLOSE}
--------------
The function NF\_CLOSE closes an open netCDF dataset. If the dataset is
in define mode, NF\_ENDDEF will be called before closing. (In this case,
if NF\_ENDDEF returns an error, NF\_ABORT will automatically be called
to restore the dataset to the consistent state before define mode was
last entered.) After an open netCDF dataset is closed, its netCDF ID may
be reassigned to the next netCDF dataset that is opened or created.
Usage
-----
INTEGER FUNCTION NF_CLOSE(INTEGER NCID)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
Errors
------
NF\_CLOSE returns the value NF\_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
- Define mode was entered and the automatic call made to NF\_ENDDEF
failed.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_CLOSE to finish the definitions of a new
netCDF dataset named foo.nc and release its netCDF ID:
INCLUDE 'netcdf.inc'
...
INTEGER NCID, STATUS
...
STATUS = NF_CREATE('foo.nc', NF_NOCLOBBER, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
... ! create dimensions, variables, attributes
STATUS = NF_CLOSE(NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
2.15 NF_INQ Family {#f77_NF-INQ-Family}
-------------------
Members of the NF\_INQ family of functions return information about an
open netCDF dataset, given its netCDF ID. Dataset inquire functions may
be called from either define mode or data mode. The first function,
NF\_INQ, returns values for the number of dimensions, the number of
variables, the number of global attributes, and the dimension ID of the
dimension defined with unlimited length, if any. The other functions in
the family each return just one of these items of information.
For FORTRAN, these functions include NF\_INQ, NF\_INQ\_NDIMS,
NF\_INQ\_NVARS, NF\_INQ\_NATTS, and NF\_INQ\_UNLIMDIM. An additional
function, NF\_INQ\_FORMAT, returns the (rarely needed) format version.
No I/O is performed when these functions are called, since the required
information is available in memory for each open netCDF dataset.
Usage
-----
INTEGER FUNCTION NF_INQ (INTEGER NCID, INTEGER ndims,
INTEGER nvars,INTEGER ngatts,
INTEGER unlimdimid)
INTEGER FUNCTION NF_INQ_NDIMS (INTEGER NCID, INTEGER ndims)
INTEGER FUNCTION NF_INQ_NVARS (INTEGER NCID, INTEGER nvars)
INTEGER FUNCTION NF_INQ_NATTS (INTEGER NCID, INTEGER ngatts)
INTEGER FUNCTION NF_INQ_UNLIMDIM (INTEGER NCID, INTEGER unlimdimid)
INTEGER FUNCTION NF_INQ_FORMAT (INTEGER NCID, INTEGER format)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`ndims`
: Returned number of dimensions defined for this netCDF dataset.
`nvars`
: Returned number of variables defined for this netCDF dataset.
`ngatts`
: Returned number of global attributes defined for this netCDF
dataset.
`unlimdimid`
: Returned ID of the unlimited dimension, if there is one for this
netCDF dataset. If no unlimited length dimension has been defined,
-1 is returned.
`format`
: Returned format version, one of NF\_FORMAT\_CLASSIC,
NF\_FORMAT\_64BIT, NF\_FORMAT\_NETCDF4,
NF\_FORMAT\_NETCDF4\_CLASSIC.
Errors
------
All members of the NF\_INQ family return the value NF\_NOERR if no
errors occurred. Otherwise, the returned status indicates an error.
Possible causes of errors include:
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_INQ to find out about a netCDF dataset
named foo.nc:
~~~~
INCLUDE 'netcdf.inc'
...
INTEGER STATUS, NCID, NDIMS, NVARS, NGATTS, UNLIMDIMID
...
STATUS = NF_OPEN('foo.nc', NF_NOWRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ(NCID, NDIMS, NVARS, NGATTS, UNLIMDIMID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
~~~~
2.16 NF_SYNC {#f77_NF-SYNC}
-------------
The function NF\_SYNC offers a way to synchronize the disk copy of a
netCDF dataset with in-memory buffers. There are two reasons you might
want to synchronize after writes:
- To minimize data loss in case of abnormal termination, or
- To make data available to other processes for reading immediately
after it is written. But note that a process that already had the
dataset open for reading would not see the number of records
increase when the writing process calls NF\_SYNC; to accomplish
this, the reading process must call NF\_SYNC.
This function is backward-compatible with previous versions of the
netCDF library. The intent was to allow sharing of a netCDF dataset
among multiple readers and one writer, by having the writer call
NF\_SYNC after writing and the readers call NF\_SYNC before each read.
For a writer, this flushes buffers to disk. For a reader, it makesre
that the next read will be from disk rather than from previously cached
buffers, so that the reader will see changes made by the writing process
(e.g., the number of records written) without having to close and reopen
the dataset. If you are only accessing a small amount of data, it can be
expensive in computer resources to always synchronize to disk after
every write, since you are giving up the benefits of buffering.
An easier way to accomplish sharing (and what is now recommended) is to
have the writer and readers open the dataset with the NF\_SHARE flag,
and then it will not be necessary to call NF\_SYNC at all. However, the
NF\_SYNC function still provides finer granularity than the NF\_SHARE
flag, if only a few netCDF accesses need to be synchronized among
processes.
It is important to note that changes to the ancillary data,ch as
attribute values, are not propagated automatically by use of the
NF\_SHARE flag. Use of the NF\_SYNC function is still required for this
purpose.
Sharing datasets when the writer enters define mode to change the data
schema requires extra care. In previous releases, after the writer left
define mode, the readers were left looking at an old copy of the
dataset, since the changes were made to a new copy. The only way readers
could see the changes was by closing and reopening the dataset. Now the
changes are made in place, but readers have no knowledge that their
internal tables are now inconsistent with the new dataset schema. If
netCDF datasets are shared across redefinition, some mechanism external
to the netCDF library must be provided that prevents access by readers
during redefinition and causes the readers to call NF\_SYNC before any
subsequent access.
When calling NF\_SYNC, the netCDF dataset must be in data mode. A netCDF
dataset in define mode is synchronized to disk only when NF\_ENDDEF is
called. A process that is reading a netCDF dataset that another process
is writing may call NF\_SYNC to get updated with the changes made to the
data by the writing process (e.g., the number of records written),
without having to close and reopen the dataset.
Data is automatically synchronized to disk when a netCDF dataset is
closed, or whenever you leave define mode.
Usage
-----
INTEGER FUNCTION NF_SYNC(INTEGER NCID)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
Errors
------
NF\_SYNC returns the value NF\_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
- The netCDF dataset is in define mode.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_SYNC to synchronize the disk writes of a
netCDF dataset named foo.nc:
INCLUDE 'netcdf.inc'
...
INTEGER STATUS, NCID
...
STATUS = NF_OPEN('foo.nc', NF_WRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
! write data or change attributes
...
STATUS = NF_SYNC(NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
2.17 NF_ABORT {#f77_NF-ABORT}
--------------
You no longer need to call this function, since it is called
automatically by NF\_CLOSE in case the dataset is in define mode and
something goes wrong with committing the changes. The function NF\_ABORT
just closes the netCDF dataset, if not in define mode. If the dataset is
being created and is still in define mode, the dataset is deleted. If
define mode was entered by a call to NF\_REDEF, the netCDF dataset is
restored to its state before definition mode was entered and the dataset
is closed.
Usage
-----
INTEGER FUNCTION NF_ABORT(INTEGER NCID)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
Errors
------
NF\_ABORT returns the value NF\_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
- When called from define mode while creating a netCDF dataset,
deletion of the dataset failed.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_ABORT to back out of redefinitions of a
dataset named foo.nc:
~~~~
INCLUDE 'netcdf.inc'
...
INTEGER STATUS, NCID, LATID
...
STATUS = NF_OPEN('foo.nc', NF_WRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_REDEF(NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_DEF_DIM(NCID, 'LAT', 18, LATID)
IF (STATUS .NE. NF_NOERR) THEN ! dimension definition failed
CALL HANDLE_ERR(STATUS)
STATUS = NF_ABORT(NCID) ! abort redefinitions
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
ENDIF
...
~~~~
2.18 NF_SET_FILL {#f77_NF-SET-FILL}
------------------
This function is intended for advanced usage, to optimize writes under
some circumstances described below. The function NF\_SET\_FILL sets the
fill mode for a netCDF dataset open for writing and returns the current
fill mode in a return parameter. The fill mode can be specified as
either NF\_FILL or NF\_NOFILL. The default behavior corresponding to
NF\_FILL is that data is pre-filled with fill values, that is fill
values are written when you create non-record variables or when you
write a value beyond data that has not yet been written. This makes it
possible to detect attempts to read data before it was written. See
section [Fill Values](#Fill-Values), for more information on the use of
fill values. See [(netcdf)Attribute
Conventions](netcdf.html#Attribute-Conventions) ‘Attribute
Conventions’ in The NetCDF Users Guide, for information about how to
define your own fill values.
The behavior corresponding to NF\_NOFILL overrides the default behavior
of prefilling data with fill values. This can be used to enhance
performance, because it avoids the duplicate writes that occur when the
netCDF library writes fill values that are later overwritten with data.
A value indicating which mode the netCDF dataset was already in is
returned. You can use this value to temporarily change the fill mode of
an open netCDF dataset and then restore it to the previous mode.
After you turn on NF\_NOFILL mode for an open netCDF dataset, you must
be certain to write valid data in all the positions that will later be
read. Note that nofill mode is only a transient property of a netCDF
dataset open for writing: if you close and reopen the dataset, it will
revert to the default behavior. You can also revert to the default
behavior by calling NF\_SET\_FILL again to explicitly set the fill mode
to NF\_FILL.
There are three situations where it is advantageous to set nofill mode:
1. Creating and initializing a netCDF dataset. In this case, you should
set nofill mode before calling NF\_ENDDEF and then write completely
all non-record variables and the initial records of all the record
variables you want to initialize.
2. Extending an existing record-oriented netCDF dataset. Set nofill
mode after opening the dataset for writing, then append the
additional records to the dataset completely, leaving no intervening
unwritten records.
3. Adding new variables that you are going to initialize to an existing
netCDF dataset. Set nofill mode before calling NF\_ENDDEF then write
all the new variables completely.
If the netCDF dataset has an unlimited dimension and the last record was
written while in nofill mode, then the dataset may be shorter than if
nofill mode was not set, but this will be completely transparent if you
access the data only through the netCDF interfaces.
The use of this feature may not be available (or even needed) in future
releases. Programmers are cautioned against heavy reliance upon this
feature.
Usage
-----
INTEGER FUNCTION NF_SET_FILL(INTEGER NCID, INTEGER FILLMODE,
INTEGER old_mode)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`FILLMODE`
: Desired fill mode for the dataset, either NF\_NOFILL or NF\_FILL.
`old_mode`
: Returned current fill mode of the dataset before this call, either
NF\_NOFILL or NF\_FILL.
Errors
------
NF\_SET\_FILL returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The specified netCDF ID does not refer to an open netCDF dataset.
- The specified netCDF ID refers to a dataset open for read-only
access.
- The fill mode argument is neither NF\_NOFILL nor NF\_FILL..
Example
-------
Here is an example using NF\_SET\_FILL to set nofill mode forbsequent
writes of a netCDF dataset named foo.nc:
~~~~
INCLUDE 'netcdf.inc'
...
INTEGER NCID, STATUS, OMODE
...
STATUS = NF_OPEN('foo.nc', NF_WRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
! write data with default prefilling behavior
...
STATUS = NF_SET_FILL(NCID, NF_NOFILL, OMODE)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
! write data with no prefilling
...
~~~~
2.19 NF_SET_DEFAULT_FORMAT {#f77_NF-SET-DEFAULT-FORMAT}
-----------------------------
This function is intended for advanced users.
In version 3.6, netCDF introduced a new data format, the first change in
the underlying binary data format since the netCDF interface was
released. The new format, 64-bit offset format, was introduced to
greatly relax the limitations on creating very large files.
In version 4.0, another new binary format was introduced: netCDF-4/HDF5.
Users are warned that creating files in the 64-bit offset format makes
them unreadable by the netCDF library prior to version 3.6.0, and
creating files in netcdf-4/HDF5 format makes them unreadable by the
netCDF library prior to version 4.0. For reasons of compatibility, users
should continue to create files in netCDF classic format.
Users who do want to use 64-bit offset or netCDF-4/HDF5 format files can
create them directory from NF\_CREATE, using the proper cmode flag. (see
section [NF\_CREATE](#NF_005fCREATE)).
The function NF\_SET\_DEFAULT\_FORMAT allows the user to change the
format of the netCDF file to be created by future calls to NF\_CREATE
without changing the cmode flag.
This allows the user to convert a program to use the new formats without
changing all calls the NF\_CREATE.
Once the default format is set, all future created files will be in the
desired format.
Constants are provided in the netcdf.inc file to be used with this
function: nf\_format\_classic, nf\_format\_64bit, nf\_format\_netcdf4
and nf\_format\_netcdf4\_classic.
Usage
-----
INTEGER FUNCTION NF_SET_DEFAULT_FORMAT(INTEGER FORMAT, INTEGER OLD_FORMT)
`FORMAT`
: Either nf\_format\_classic, nf\_format\_64bit, nf\_format\_netcdf4
or nf\_format\_netcdf4\_classic.
`OLD_FORMAT`
: The default format at the time the function is called is returned
here.
Errors
------
The following error codes may be returned by this function:
- An NF\_EINVAL error is returned if an invalid default format is
specified.
Example
-------
INCLUDE 'netcdf.inc'
...
INTEGER STATUS, OLD_FORMAT
...
STATUS = NF_SET_DEFAULT_FORMAT(nf_format_64bit, OLD_FORMAT)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
2.20 Set HDF5 Chunk Cache for Future File Opens/Creates: NF_SET_CHUNK_CACHE {#f77_Set-HDF5-Chunk}
------------------------------------------------------------------------------
This function changes the chunk cache settings in the HDF5 library. The
settings apply forbsequent file opens/creates. This function does not
change the chunk cache settings of already open files.
This affects the per-file chunk cache which the HDF5 layer maintains.
The chunk cache size can be tuned for better performance.
For more information, see the documentation for the H5Pset\_cache()
function in the HDF5 library at the HDF5 website:
[http://hdfgroup.org/HDF5/](http://hdfgroup.org/HDF5/).
Usage
-----
INTEGER NF_SET_CHUNK_CACHE(INTEGER SIZE, INTEGER NELEMS, INTEGER PREEMPTION);
`SIZE`
: The total size of the raw data chunk cache in MegaBytes.
`NELEMS`
: The number slots in the per-variable chunk cache (should be a prime
number larger than the number of chunks in the cache).
`PREEMPTION`
: The preemtion value must be between 0 and 100 inclusive and
indicates how much chunks that have been fully read are favored for
preemption. A value of zero means fully read chunks are treated no
differently than other chunks (the preemption is strictly LRU) while
a value of 100 means fully read chunks are always preempted before
other chunks.
Return Codes
------------
`NF_NOERR`
: No error.
`NF_EINVAL`
: Parameters size and nelems must be non-zero positive integers, and
preemption must be between zero and 100 (inclusive). An NF\_EINVAL
will be returned otherwise.
2.21 Get the HDF5 Chunk Cache Settings for Future File Opens/Creates: NF_GET_CHUNK_CACHE {#f77_NF-GET-CHUNK-CACHE}
-------------------------------------------------------------------------------------------
This function gets the chunk cache settings for the HDF5 library. The
settings apply forbsequent file opens/creates.
This affects the per-file chunk cache which the HDF5 layer maintains.
The chunk cache size can be tuned for better performance.
For more information, see the documentation for the H5Pget\_cache()
function in the HDF5 library at the HDF5 website:
[http://hdfgroup.org/HDF5/](http://hdfgroup.org/HDF5/).
Usage
-----
INTEGER NC_GET_CHUNK_CACHE(INTEGER SIZE, INTEGER NELEMS, INTEGER PREEMPTION);
`SIZE`
: The total size of the raw data chunk cache will be put here.
`NELEMS`
: The number of chunk slots in the raw data chunk cache hash table
will be put here.
`PREEMPTION`
: The preemption will be put here. The preemtion value is between 0
and 100 inclusive and indicates how much chunks that have been fully
read are favored for preemption. A value of zero means fully read
chunks are treated no differently than other chunks (the preemption
is strictly LRU) while a value of 100 means fully read chunks are
always preempted before other chunks.
Return Codes
------------
`NC_NOERR`
: No error.
3. Groups {#f77_Groups}
=========
NetCDF-4 addedpport for hierarchical groups within netCDF datasets.
Groups are identified with a ncid, which identifies both the open file,
and the group within that file. When a file is opened with NF\_OPEN or
NF\_CREATE, the ncid for the root group of that file is provided. Using
that as a starting point, users can add new groups, or list and navigate
existing groups.
All netCDF calls take a ncid which determines where the call will take
its action. For example, the NF\_DEF\_VAR function takes a ncid as its
first parameter. It will create a variable in whichever group its ncid
refers to. Use the root ncid provided by NF\_CREATE or NF\_OPEN to
create a variable in the root group. Or use NF\_DEF\_GRP to create a
group and use its ncid to define a variable in the new group.
Variable are only visible in the group in which they are defined. The
same applies to attributes. “Global” attributes are defined in whichever
group is refered to by the ncid.
Dimensions are visible in their groups, and all child groups.
Group operations are only permitted on netCDF-4 files - that is, files
created with the HDF5 flag in nf\_create. (see
[NF\_CREATE](#NF_005fCREATE)). Groups are not compatible with the netCDF
classic data model, so files created with the NF\_CLASSIC\_MODEL file
cannot contain groups (except the root group).
3.1 Find a Group ID: NF_INQ_NCID {#f77_NF-INQ-NCID}
----------------------------------
Given an ncid and group name (NULL or "" gets root group), return ncid
of the named group.
Usage
-----
INTEGER FUNCTION NF_INQ_NCID(INTEGER NCID, CHARACTER*(*) NAME, INTEGER GRPID)
`NCID`
: The group id for this operation.
`NAME`
: A character array that holds the name of the desired group. Must be
less then NF\_MAX\_NAME.
`GRPID`
: The ID of the group will go here.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see [NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/ftst\_groups.F.
C Check getting the group by name
retval = nf_inq_ncid(ncid, group_name, grpid_in)
if (retval .ne. nf_noerr) call handle_err(retval)
3.2 Get a List of Groups in a Group: NF_INQ_GRPS {#f77_NF-INQ-GRPS}
--------------------------------------------------
Given a location id, return the number of groups it contains, and an
array of their ncids.
Usage
-----
INTEGER FUNCTION NF_INQ_GRPS(INTEGER NCID, INTEGER NUMGRPS, INTEGER NCIDS)
`NCID`
: The group id for this operation.
`NUMGRPS`
: An integer which will get number of groups in this group.
`NCIDS`
: An array of ints which will receive the IDs of all the groups in
this group.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see [NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/ftst\_groups.F.
C What groups are there from the root group?
retval = nf_inq_grps(ncid, ngroups_in, grpids)
if (retval .ne. nf_noerr) call handle_err(retval)
3.3 Find all the Variables in a Group: NF_INQ_VARIDS {#f77_NF-INQ-VARIDS}
------------------------------------------------------
Find all varids for a location.
Usage
-----
INTEGER FUNCTION NF_INQ_VARIDS(INTEGER NCID, INTEGERS VARIDS)
`NCID`
: The group id for this operation.
`VARIDS`
: An already allocated array to store the list of varids. Use
nf\_inq\_nvars to find out how many variables there are. (see
[NF\_INQ Family](#NF_005fINQ-Family)).
Errors
------
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see [NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/ftst\_groups.F.
C Check varids inbgroup.
retval = nf_inq_varidsbgrp_in, nvars, varids_in)
if (retval .ne. nf_noerr) call handle_err(retval)
3.4 Find all Dimensions Visible in a Group: NF_INQ_DIMIDS {#f77_NF-INQ-DIMIDS}
-----------------------------------------------------------
Find all dimids for a location. This finds all dimensions in a group, or
any of its parents.
Usage
-----
INTEGER FUNCTION NF_INQ_DIMIDS(INTEGER NCID, INTEGER NDIMS, INTEGER DIMIDS, INTEGER INCLUDE_PARENTS)
`NCID`
: The group id for this operation.
`NDIMS`
: Returned number of dimensions for this location. If INCLUDE\_PARENTS
is non-zero, number of dimensions visible from this group, which
includes dimensions in parent groups.
`DIMIDS`
: An array of ints when the dimids of the visible dimensions will be
stashed. Use nf\_inq\_ndims to find out how many dims are visible
from this group. (see [NF\_INQ Family](#NF_005fINQ-Family)).
`INCLUDE_PARENTS`
: If zero, only the group specified by NCID will be searched for
dimensions. Otherwise parent groups will be searched too.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see [NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/ftst\_groups.F.
C Check dimids inbgroup.
retval = nf_inq_dimidsbgrp_in, ndims, dimids_in, 0)
if (retval .ne. nf_noerr) call handle_err(retval)
if (ndims .ne. 2 .or. dimids_in(1) .ne. dimids(1) .or.
& dimids_in(2) .ne. dimids(2)) stop 2
3.5 Find the Length of a Group’s Name: NF_INQ_GRPNAME_LE {#f77_NF-INQ-GRPNAME-LE}
------------------------------------------------------------
Given ncid, find length of the full name. (Root group is named "/", with
length 1.)
Usage
-----
INTEGER FUNCTION NF_INQ_GRPNAME_LEN(INTEGER NCID, INTEGER LEN)
`NCID`
: The group id for this operation.
`LEN`
: An integer where the length will be placed.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see [NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/ftst\_groups.F.
C Check the length of the full name.
retval = nf_inq_grpname_len(grpids(1), full_name_len)
if (retval .ne. nf_noerr) call handle_err(retval)
3.6 Find a Group’s Name: NF_INQ_GRPNAME {#f77_NF-INQ-GRPNAME}
-----------------------------------------
Given ncid, find relative name of group. (Root group is named "/").
The name provided by this function is relative to the parent group. For
a full path name for the group is, with all parent groups included,
separated with a forward slash (as in Unix directory names) See
[Find a Group’s Full Name:
NF\_INQ\_GRPNAME\_FULL](#NF_005fINQ_005fGRPNAME_005fFULL).
Usage
-----
INTEGER FUNCTION NF_INQ_GRPNAME(INTEGER NCID, CHARACTER*(*) NAME)
`NCID`
The group id for this operation.
`NAME`
The name of the group will be copied to this character array. The name
will be less than NF\_MAX\_NAME in length.
``
Errors
------
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see [NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/ftst\_groups.F.
C Check the name of the root group.
retval = nf_inq_grpname(ncid, name_in)
if (retval .ne. nf_noerr) call handle_err(retval)
if (name_in(1:1) .ne. '/') stop 2
3.7 Find a Group’s Full Name: NF_INQ_GRPNAME_FULL {#f77_NF-INQ-GRPNAME-FULL}
----------------------------------------------------
Given ncid, find complete name of group. (Root group is named "/").
The name provided by this function is a full path name for the group is,
with all parent groups included, separated with a forward slash (as in
Unix directory names). For a name relative to the parent group See
section [Find a Group’s Name:
NF\_INQ\_GRPNAME](#NF_005fINQ_005fGRPNAME).
To find the length of the full name See [Find the Length of a
Group’s Name: NF\_INQ\_GRPNAME\_LEN](#NF_005fINQ_005fGRPNAME_005fLEN).
Usage
-----
INTEGER FUNCTION NF_INQ_GRPNAME_FULL(INTEGER NCID, INTEGER LEN, CHARACTER*(*) NAME)
`NCID`
: The group id for this operation.
`LEN`
: The length of the full group name will go here.
`NAME`
: The name of the group will be copied to this character array.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see [NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/ftst\_groups.F.
C Check the full name.
retval = nf_inq_grpname_full(grpids(1), full_name_len, name_in2)
if (retval .ne. nf_noerr) call handle_err(retval)
3.8 Find a Group’s Parent: NF_INQ_GRP_PARENT {#f77_NF-INQ-GRP-PARENT}
-----------------------------------------------
Given ncid, find the ncid of the parent group.
When used with the root group, this function returns the NF\_ENOGRP
error (since the root group has no parent.)
Usage
-----
INTEGER FUNCTION NF_INQ_GRP_PARENT(INTEGER NCID, INTEGER PARENT_NCID)
`NCID`
: The group id.
`PARENT_NCID`
: The ncid of the parent group will be copied here.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_ENOGRP`
: No parent group found (i.e. this is the root group).
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see [NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/ftst\_groups.F.
C Check the parent ncid.
retval = nf_inq_grp_parent(grpids(1), grpid_in)
if (retval .ne. nf_noerr) call handle_err(retval)
3.9 Find a Group by Name: NF_INQ_GRP_NCID {#f77_NF-INQ-GRP-NCID}
--------------------------------------------
Given a group name an an ncid, find the ncid of the group id.
Usage
-----
INTEGER FUNCTION NF_INQ_GRP_NCID(INTEGER NCID, CHARACTER GRP_NAME, INTEGER GRP_NCID)
`NCID`
: The group id to look in.
`GRP_NAME`
: The name of the group that should be found.
`GRP_NCID`
: This will get the group id, if it is found.
Return Codes
------------
The following return codes may be returned by this function.
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_EINVAL`
: No name provided or name longer than NF\_MAX\_NAME.
`NF_ENOGRP`
: Named group not found.
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see [NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/ftst\_types3.F.
C Go to a child group and find the id of our type.
retval = nf_inq_grp_ncid(ncid, group_name,b_grpid)
if (retval .ne. nf_noerr) call handle_err(retval)
3.10 Find a Group by its Fully-qualified Name: NF_INQ_GRP_FULL_NCID {#f77_NF-INQ-GRP-FULL-NCID}
-----------------------------------------------------------------------
Given a fully qualified group name an an ncid, find the ncid of the
group id.
Usage
-----
INTEGER FUNCTION NF_INQ_GRP_FULL_NCID(INTEGER NCID, CHARACTER FULL_NAME, INTEGER GRP_NCID)
`NCID`
: The group id to look in.
`FULL_NAME`
: The fully-qualified group name.
`GRP_NCID`
: This will get the group id, if it is found.
Return Codes
------------
The following return codes may be returned by this function.
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_EINVAL`
: No name provided or name longer than NF\_MAX\_NAME.
`NF_ENOGRP`
: Named group not found.
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see [NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/ftst\_groups.F.
C Check the full name of the root group (also "/").
retval = nf_inq_grpname_full(ncid, full_name_len, name_in)
if (retval .ne. nf_noerr) call handle_err(retval)
3.11 Create a New Group: NF_DEF_GRP {#f77_NF-DEF-GRP}
-------------------------------------
Create a group. Its location id is returned in new\_ncid.
Usage
-----
INTEGER FUNCTION NF_DEF_GRP(INTEGER PARENT_NCID, CHARACTER*(*) NAME,
INTEGER NEW_NCID)
`PARENT_NCID`
: The group id of the parent group.
`NAME`
: The name of the new group, which must be different from the name of
any variable within the same parent group.
`NEW_NCID`
: The ncid of the new group will be placed there.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_ENAMEINUSE`
: That name is in use. Group names must be unique within a group.
`NF_EMAXNAME`
: Name exceed max length NF\_MAX\_NAME.
`NF_EBADNAME`
: Name contains illegal characters.
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see [NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
`NF_EPERM`
: Attempt to write to a read-only file.
`NF_ENOTINDEFINE`
: Not in define mode.
Example
-------
In this exampe rom nf\_test/ftst\_groups.F, a groups is reated, and then
ab-group is created in that group.
C Create the netCDF file.
retval = nf_create(file_name, NF_NETCDF4, ncid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Create a group and abgroup.
retval = nf_def_grp(ncid, group_name, grpid)
if (retval .ne. nf_noerr) call handle_err(retval)
retval = nf_def_grp(grpid,b_group_name,b_grpid)
if (retval .ne. nf_noerr) call handle_err(retval)
4. Dimensions {#f77_Dimensions}
=============
4.1 Dimensions Introduction {#f77_Dimensions-Introduction}
---------------------------
Dimensions for a netCDF dataset are defined when it is created, while
the netCDF dataset is in define mode. Additional dimensions may be added
later by reentering define mode. A netCDF dimension has a name and a
length. At most one dimension in a netCDF dataset can have the unlimited
length, which means variables using this dimension can grow along this
dimension.
There is aggested limit (100) to the number of dimensions that can be
defined in a single netCDF dataset. The limit is the value of the
predefined macro NF\_MAX\_DIMS. The purpose of the limit is to make
writing generic applications simpler. They need only provide an array of
NF\_MAX\_DIMS dimensions to handle any netCDF dataset. The
implementation of the netCDF library does not enforce this advisory
maximum, so it is possible to use more dimensions, if necessary, but
netCDF utilities that ame the advisory maximums may not be able to
handle the rlting netCDF datasets.
Ordinarily, the name and length of a dimension are fixed when the
dimension is first defined. The name may be changed later, but the
length of a dimension (other than the unlimited dimension) cannot be
changed without copying all the data to a new netCDF dataset with a
redefined dimension length.
A netCDF dimension in an open netCDF dataset is referred to by a small
integer called a dimension ID. In the FORTRAN interface, dimension IDs
are 1, 2, 3, ..., in the order in which the dimensions were defined.
Operationspported on dimensions are:
- Create a dimension, given its name and length.
- Get a dimension ID from its name.
- Get a dimension’s name and length from its ID.
- Rename a dimension.
4.2 NF_DEF_DIM {#f77_NF-DEF-DIM}
----------------
The function NF\_DEF\_DIM adds a new dimension to an open netCDF dataset
in define mode. It returns (as an argument) a dimension ID, given the
netCDF ID, the dimension name, and the dimension length. At most one
unlimited length dimension, called the record dimension, may be defined
for each netCDF dataset.
Usage
-----
INTEGER FUNCTION NF_DEF_DIM (INTEGER NCID, CHARACTER*(*) NAME,
INTEGER LEN, INTEGER dimid)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`NAME`
: Dimension name.
`LEN`
: Length of dimension; that is, number of values for this dimension as
an index to variables that use it. This should be either a positive
integer or the predefined constant NF\_UNLIMITED.
`dimid`
: Returned dimension ID.
Errors
------
NF\_DEF\_DIM returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The netCDF dataset is not in definition mode.
- The specified dimension name is the name of another existing
dimension.
- The specified length is not greater than zero.
- The specified length is unlimited, but there is already an unlimited
length dimension defined for this netCDF dataset.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_DEF\_DIM to create a dimension named lat of
length 18 and a unlimited dimension named rec in a new netCDF dataset
named foo.nc:
INCLUDE 'netcdf.inc'
...
INTEGER STATUS, NCID, LATID, RECID
...
STATUS = NF_CREATE('foo.nc', NF_NOCLOBBER, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_DEF_DIM(NCID, 'lat', 18, LATID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_DEF_DIM(NCID, 'rec', NF_UNLIMITED, RECID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
4.3 NF_INQ_DIMID {#f77_NF-INQ-DIMID}
------------------
The function NF\_INQ\_DIMID returns (as an argument) the ID of a netCDF
dimension, given the name of the dimension. If ndims is the number of
dimensions defined for a netCDF dataset, each dimension has an ID
between 1 and ndims.
Usage
-----
INTEGER FUNCTION NF_INQ_DIMID (INTEGER NCID, CHARACTER*(*) NAME,
INTEGER dimid)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`NAME`
: Dimension name.
`dimid`
: Returned dimension ID.
Errors
------
NF\_INQ\_DIMID returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The name that was specified is not the name of a dimension in the
netCDF dataset.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_INQ\_DIMID to determine the dimension ID of
a dimension named lat, amed to have been defined previously in an
existing netCDF dataset named foo.nc:
INCLUDE 'netcdf.inc'
...
INTEGER STATUS, NCID, LATID
...
STATUS = NF_OPEN('foo.nc', NF_NOWRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_DIMID(NCID, 'lat', LATID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
4.4 NF_INQ_DIM Family {#f77_NF-INQ-DIM-Family}
-----------------------
This family of functions returns information about a netCDF dimension.
Information about a dimension includes its name and its length. The
length for the unlimited dimension, if any, is the number of records
written so far.
The functions in this family include NF\_INQ\_DIM, NF\_INQ\_DIMNAME, and
NF\_INQ\_DIMLEN. The function NF\_INQ\_DIM returns all the information
about a dimension; the other functions each return just one item of
information.
Usage
-----
INTEGER FUNCTION NF_INQ_DIM (INTEGER NCID, INTEGER DIMID,
CHARACTER*(*) name, INTEGER len)
INTEGER FUNCTION NF_INQ_DIMNAME (INTEGER NCID, INTEGER DIMID,
CHARACTER*(*) name)
INTEGER FUNCTION NF_INQ_DIMLEN (INTEGER NCID, INTEGER DIMID,
INTEGER len)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`DIMID`
: Dimension ID, from a previous call to NF\_INQ\_DIMID or
NF\_DEF\_DIM.
`NAME`
: Returned dimension name. The caller must allocate space for the
returned name. The maximum possible length, in characters, of a
dimension name is given by the predefined constant NF\_MAX\_NAME.
`len`
: Returned length of dimension. For the unlimited dimension, this is
the current maximum value used for writing any variables with this
dimension, that is the maximum record number.
Errors
------
These functions return the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The dimension ID is invalid for the specified netCDF dataset.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_INQ\_DIM to determine the length of a
dimension named lat, and the name and current maximum length of the
unlimited dimension for an existing netCDF dataset named foo.nc:
INCLUDE 'netcdf.inc'
...
INTEGER STATUS, NCID, LATID, LATLEN, RECID, NRECS
CHARACTER*(NF_MAX_NAME) LATNAM, RECNAM
...
STATUS = NF_OPEN('foo.nc', NF_NOWRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
! get ID of unlimited dimension
STATUS = NF_INQ_UNLIMDIM(NCID, RECID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_DIMID(NCID, 'lat', LATID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
! get lat length
STATUS = NF_INQ_DIMLEN(NCID, LATID, LATLEN)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
! get unlimited dimension name and current length
STATUS = NF_INQ_DIM(NCID, RECID, RECNAME, NRECS)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
4.5 NF_RENAME_DIM {#f77_NF-RENAME-DIM}
-------------------
The function NF\_RENAME\_DIM renames an existing dimension in a netCDF
dataset open for writing. If the new name is longer than the old name,
the netCDF dataset must be in define mode. You cannot rename a dimension
to have the same name as another dimension.
Usage
-----
INTEGER FUNCTION NF_RENAME_DIM (INTEGER NCID, INTEGER DIMID,
CHARACTER*(*) NAME)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`DIMID`
: Dimension ID, from a previous call to NF\_INQ\_DIMID or
NF\_DEF\_DIM.
`NAME`
: New dimension name.
Errors
------
NF\_RENAME\_DIM returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The new name is the name of another dimension.
- The dimension ID is invalid for the specified netCDF dataset.
- The specified netCDF ID does not refer to an open netCDF dataset.
- The new name is longer than the old name and the netCDF dataset is
not in define mode.
Example
-------
Here is an example using NF\_RENAME\_DIM to rename the dimension lat to
latitude in an existing netCDF dataset named foo.nc:
INCLUDE 'netcdf.inc'
...
INTEGER STATUS, NCID, LATID
...
STATUS = NF_OPEN('foo.nc', NF_WRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
! put in define mode to rename dimension
STATUS = NF_REDEF(NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_INQ_DIMID(NCID, 'lat', LATID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_RENAME_DIM(NCID, LATID, 'latitude')
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
! leave define mode
STATUS = NF_ENDDEF(NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
5. User Defined Data Types {#f77_User-Defined-Data-Types}
==========================
5.1 User Defined Types Introduction {#f77_User-Defined-Types-Introduction}
-----------------------------------
NetCDF-4 has added support for four different user defined data types.
`compound type`
: Like a C struct, a compound type is a collection of types, including
other user defined types, in one package.
`variable length array type`
: The variable length array may be used to store ragged arrays.
`opaque type`
: This type has only a size per element, and no other type
information.
`enum type`
: Like an enumeration in C, this type lets you assign text values to
integer values, and store the integer values.
Users may construct user defined type with the various NF\_DEF\_\*
functions described in this. They may learn about user defined
types by using the NF\_INQ\_ functions defined in this.
Once types are constructed, define variables of the new type with
NF\_DEF\_VAR (see [Create a Variable:
`NF_DEF_VAR`](#NF_005fDEF_005fVAR)). Write to them with NF\_PUT\_VAR1,
NF\_PUT\_VAR, NF\_PUT\_VARA, or NF\_PUT\_VARS (see
[Variables](#Variables)). Read data of user-defined type with
NF\_GET\_VAR1, NF\_GET\_VAR, NF\_GET\_VARA, or NF\_GET\_VARS (see
section [Variables](#Variables)).
Create attributes of the new type with NF\_PUT\_ATT (see
[NF\_PUT\_ATT\_ type](#NF_005fPUT_005fATT_005f-type)). Read attributes
of the new type with NF\_GET\_ATT (see [NF\_GET\_ATT\_
type](#NF_005fGET_005fATT_005f-type)).
5.2 Learn the IDs of All Types in Group: NF_INQ_TYPEIDS {#f77_NF-INQ-TYPEIDS}
---------------------------------------------------------
Learn the number of types defined in a group, and their IDs.
Usage
-----
INTEGER FUNCTION NF_INQ_TYPEIDS(INTEGER NCID, INTEGER NTYPES,
INTEGER TYPEIDS)
`NCID`
: The group id.
`NTYPES`
: A pointer to int which will get the number of types defined in the
group. If NULL, ignored.
`TYPEIDS`
: A pointer to an int array which will get the typeids. If NULL,
ignored.
Errors
------
`NF_NOERR`
: No error.
`NF_BADID`
: Bad ncid.
Example
-------
The following example is from the test program nf\_test/ftst\_vars3.F.
retval = nf_inq_typeids(ncid, num_types, typeids)
if (retval .ne. nf_noerr) call handle_err(retval)
5.3 Find a Typeid from Group and Name: NF_INQ_TYPEID {#f77_NF-INQ-TYPEID}
------------------------------------------------------
Given a group ID and a type name, find the ID of the type. If the type
is not found in the group, then the parents are searched. If still not
found, the entire file is searched.
Usage
-----
INTEGER FUNCTION NF_INQ_TYPEID(INTEGER NCID, CHARACTER NAME, NF_TYPE TYPEIDP)
`NCID`
: The group id.
`NAME`
: The name of a type.
`TYPEIDP`
: The typeid of the named type (if found).
Errors
------
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad ncid.
`NF_EBADTYPE`
: Can’t find type.
Example
-------
The following example is from nf\_test/ftst\_types3.F:
C Go to a child group and find the id of our type.
retval = nf_inq_grp_ncid(ncid, group_name,b_grpid)
if (retval .ne. nf_noerr) call handle_err(retval)
retval = nf_inq_typeidb_grpid, type_name, typeid_in)
if (retval .ne. nf_noerr) call handle_err(retval)
5.4 Learn About a User Defined Type: NF_INQ_TYPE {#f77_NF-INQ-TYPE}
--------------------------------------------------
Given an ncid and a typeid, get the information about a type. This
function will work on any type, including atomic and any user defined
type, whether compound, opaque, enumeration, or variable length array.
For even more information about a user defined type [Learn About a User
Defined Type: NF\_INQ\_USER\_TYPE](#NF_005fINQ_005fUSER_005fTYPE).
Usage
-----
INTEGER FUNCTION NF_INQ_TYPE(INTEGER NCID, INTEGER XTYPE,
CHARACTER*(*) NAME, INTEGER SIZE)
`NCID`
: The ncid for the group containing the type (ignored for atomic
types).
`XTYPE`
: The typeid for this type, as returned by NF\_DEF\_COMPOUND,
NF\_DEF\_OPAQUE, NF\_DEF\_ENUM, NF\_DEF\_VLEN, or NF\_INQ\_VAR, or
as found in netcdf.inc in the list of atomic types (NF\_CHAR,
NF\_INT, etc.).
`NAME`
: The name of the user defined type will be copied here. It will be
NF\_MAX\_NAME bytes or less. For atomic types, the type name from
CDL will be given.
`SIZEP`
: The (in-memory) size of the type (in bytes) will be copied here.
VLEN type size is the size of one vlen sturture (i.e. the sice of
nc\_vlen\_t). String size is returned as the size of one C character
pointer.
Return Codes
------------
`NF_NOERR`
: No error.
`NF_EBADTYPEID`
: Bad typeid.
`NF_ENOTNC4`
: Seeking a user-defined type in a netCDF-3 file.
`NF_ESTRICTNC3`
: Seeking a user-defined type in a netCDF-4 file for which classic
model has been turned on.
`NF_EBADGRPID`
: Bad group ID in ncid.
`NF_EBADID`
: Type ID not found.
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from the test program nf\_test/ftst\_vars3.F, and it
uses all the possible inquiry functions on an enum type.
C Check the enum type.
retval = NF_INQ_TYPEIDS(ncid, num_types, typeids)
if (retval .ne. nf_noerr) call handle_err(retval)
if (num_types .ne. MAX_TYPES) stop 2
retval = nf_inq_enum(ncid, typeids(1), type_name, base_type,
& base_size, num_members)
if (retval .ne. nf_noerr) call handle_err(retval)
if (base_type .ne. NF_INT .or. num_members .ne. 2) stop 2
retval = nf_inq_enum_member(ncid, typeids(1), 1, member_name,
& member_value)
if (retval .ne. nf_noerr) call handle_err(retval)
if (member_name(1:len(one_name)) .ne. one_name) stop 2
5.5 Learn About a User Defined Type: NF_INQ_USER_TYPE {#f77_NF-INQ-USER-TYPE}
--------------------------------------------------------
Given an ncid and a typeid, get the information about a user defined
type. This function will work on any user defined type, whether
compound, opaque, enumeration, or variable length array.
Usage
-----
INTEGER FUNCTION NF_INQ_USER_TYPE(INTEGER NCID, INTEGER XTYPE,
CHARACTER*(*) NAME, INTEGER SIZE, INTEGER BASE_NF_TYPE,
INTEGER NFIELDS, INTEGER CLASS)
`NCID`
: The ncid for the group containing the user defined type.
`XTYPE`
: The typeid for this type, as returned by NF\_DEF\_COMPOUND,
NF\_DEF\_OPAQUE, NF\_DEF\_ENUM, NF\_DEF\_VLEN, or NF\_INQ\_VAR.
`NAME`
: The name of the user defined type will be copied here. It will be
NF\_MAX\_NAME bytes or less.
`SIZE`
: The (in-memory) size of the user defined type will be copied here.
`BASE_NF_TYPE`
: The base typeid will be copied here for vlen and enum types.
`NFIELDS`
: The number of fields will be copied here for enum and compound
types.
`CLASS`
: The class of the user defined type, NF\_VLEN, NF\_OPAQUE, NF\_ENUM,
or NF\_COMPOUND, will be copied here.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADTYPEID`
: Bad typeid.
`NF_EBADFIELDID`
: Bad fieldid.
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/ftst\_types2.F.
C Check the type.
retval = nf_inq_user_type(ncid, typeids(1), name_in, size_in,
& base_type_in, nfields_in, class_in)
if (retval .ne. nf_noerr) call handle_err(retval)
5.6 Compound Types Introduction {#f77_Compound-Types-Introduction}
-------------------------------
NetCDF-4 addedpport for compound types, which allow users to
construct a new type - a combination of other types, like a C struct.
Compound types are notpported in classic or 64-bit offset format
files.
To write data in a compound type, first use nf\_def\_compound to create
the type, multiple calls to nf\_insert\_compound to add to the compound
type, and then write data with the appropriate nf\_put\_var1,
nf\_put\_vara, nf\_put\_vars, or nf\_put\_varm call.
To read data written in a compound type, you must know its structure.
Use the NF\_INQ\_COMPOUND functions to learn about the compound type.
In Fortran a character buffer must be used for the compound data. The
user must read the data from within that buffer in the same way that the
C compiler which compiled netCDF would store the structure.
The use of compound types introduces challenges and portability ies
for Fortran users.
### 5.6.1 Creating a Compound Type: NF_DEF_COMPOUND {#f77_NF-DEF-COMPOUND}
Create a compound type. Provide an ncid, a name, and a total size (in
bytes) of one element of the completed compound type.
After calling this function, fill out the type with repeated calls to
NF\_INSERT\_COMPOUND (see [Inserting a Field into a Compound
Type: NF\_INSERT\_COMPOUND](#NF_005fINSERT_005fCOMPOUND)). Call
NF\_INSERT\_COMPOUND once for each field you wish to insert into the
compound type.
Note that there does not seem to be a way to readch types into
structures in Fortran 90 (and there are no structures in Fortran 77).
Fortran users may use character buffers to read and write compound
types.
Usage
-----
INTEGER FUNCTION NF_DEF_COMPOUND(INTEGER NCID, INTEGER SIZE,
CHARACTER*(*) NAME, INTEGER TYPEIDP)
`NCID`
: The groupid where this compound type will be created.
`SIZE`
: The size, in bytes, of the compound type.
`NAME`
: The name of the new compound type.
`TYPEIDP`
: The typeid of the new type will be placed here.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_ENAMEINUSE`
: That name is in use. Compound type names must be unique in the data
file.
`NF_EMAXNAME`
: Name exceeds max length NF\_MAX\_NAME.
`NF_EBADNAME`
: Name contains illegal characters.
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag NF\_NETCDF4. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
`NF_EPERM`
: Attempt to write to a read-only file.
`NF_ENOTINDEFINE`
: Not in define mode.
Example
-------
This example is from nf\_test/ftst\_types2.F.
C Define a compound type.
retval = nf_def_compound(ncid, cmp_size, type_name,
& cmp_typeid)
if (retval .ne. nf_noerr) call handle_err(retval)
### 5.6.2 Inserting a Field into a Compound Type: NF_INSERT_COMPOUND {#f77_NF-INSERT-COMPOUND}
Insert a named field into a compound type.
Usage
-----
INTEGER FUNTION NF_INSERT_COMPOUND(INTEGER TYPEID, CHARACTER*(*) NAME, INTEGER OFFSET,
INTEGER FIELD_TYPEID)
`TYPEID`
: The typeid for this compound type, as returned by NF\_DEF\_COMPOUND,
or NF\_INQ\_VAR.
`NAME`
: The name of the new field.
`OFFSET`
: Offset in byte from the beginning of the compound type for this
field.
`FIELD_TYPEID`
: The type of the field to be inserted.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_ENAMEINUSE`
: That name is in use. Field names must be unique within a compound
type.
`NF_EMAXNAME`
: Name exceed max length NF\_MAX\_NAME.
`NF_EBADNAME`
: Name contains illegal characters.
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag NF\_NETCDF4. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
`NF_ENOTINDEFINE`
: Not in define mode.
Example
-------
This example is from nf\_test/ftst\_types.F.
C Define a compound type.
retval = nf_def_compound(ncid, WIND_T_SIZE, type_name,
& wind_typeid)
if (retval .ne. nf_noerr) call handle_err(retval)
retval = nf_insert_compound(ncid, wind_typeid, u_name, 0, NF_INT)
if (retval .ne. nf_noerr) call handle_err(retval)
retval = nf_insert_compound(ncid, wind_typeid, v_name, 4, NF_INT)
if (retval .ne. nf_noerr) call handle_err(retval)
### 5.6.3 Inserting an Array Field into a Compound Type: NF_INSERT_ARRAY_COMPOUND {#f77_NF-INSERT-ARRAY-COMPOUND}
Insert a named array field into a compound type.
Usage
-----
INTEGER FUNCTION NF_INSERT_ARRAY_COMPOUND(INTEGER NCID, INTEGER XTYPE,
CHARACTER*(*) NAME, INTEGER OFFSET, INTEGER FIELD_TYPEID,
INTEGER NDIMS, INTEGER DIM_SIZES)
`NCID`
: The ID of the file that contains the array type and the compound
type.
`XTYPE`
: The typeid for this compound type, as returned by nf\_def\_compound,
or nf\_inq\_var.
`NAME`
: The name of the new field.
`OFFSET`
: Offset in byte from the beginning of the compound type for this
field.
`FIELD_TYPEID`
: The base type of the array to be inserted.
`NDIMS`
: The number of dimensions for the array to be inserted.
`DIM_SIZES`
: An array containing the sizes of each dimension.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_ENAMEINUSE`
: That name is in use. Field names must be unique within a compound
type.
`NF_EMAXNAME`
: Name exceed max length NF\_MAX\_NAME.
`NF_EBADNAME`
: Name contains illegal characters.
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag NF\_NETCDF4. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
`NF_ENOTINDEFINE`
: Not in define mode.
`NF_ETYPEDEFINED`
: Attempt to change type that has already been committed. The first
time the file leaves define mode, all defined types are committed,
and can’t be changed. If you wish to add an array to a compound
type, you must do so before the compound type is committed.
Example
-------
This example is from nf\_test/ftst\_types2.F.
C Define a compound type.
retval = nf_def_compound(ncid, cmp_size, type_name,
& cmp_typeid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Include an array.
dim_sizes(1) = NX
dim_sizes(2) = NY
retval = nf_insert_array_compound(ncid, cmp_typeid, ary_name, 0,
& NF_INT, NDIMS, dim_sizes)
if (retval .ne. nf_noerr) call handle_err(retval)
### 5.6.4 Learn About a Compound Type: NF_INQ_COMPOUND {#f77_NF-INQ-COMPOUND}
Get the number of fields, length in bytes, and name of a compound type.
In addtion to the NF\_INQ\_COMPOUND function, three additional functions
are provided which get only the name, size, and number of fields.
Usage
-----
INTEGER FUNCTION NF_INQ_COMPOUND(INTEGER NCID, INTEGER XTYPE,
CHARACTER*(*) NAME, INTEGER SIZEP, INTEGER NFIELDSP)
INTEGER FUNCTION NF_INQ_COMPOUND_NAME(INTEGER NCID, INTEGER XTYPE,
CHARACTER*(*) NAME)
INTEGER FUNCTION NF_INQ_COMPOUND_SIZE(INTEGER NCID, INTEGER XTYPE,
INTEGER SIZEP)
INTEGER FUNCTION NF_INQ_COMPOUND_NFIELDS(INTEGER NCID, INTEGER XTYPE,
INTEGER NFIELDSP)
`NCID`
: The ID of any group in the file that contains the compound type.
`XTYPE`
: The typeid for this compound type, as returned by NF\_DEF\_COMPOUND,
or NF\_INQ\_VAR.
`NAME`
: Character array which will get the name of the compound type. It
will have a maximum length of NF\_MAX\_NAME.
`SIZEP`
: The size of the compound type in bytes will be put here.
`NFIELDSP`
: The number of fields in the compound type will be placed here.
Return Codes
------------
`NF_NOERR`
: No error.
`NF_EBADID`
: Couldn’t find this ncid.
`NF_ENOTNC4`
: Not a netCDF-4/HDF5 file.
`NF_ESTRICTNC3`
: A netCDF-4/HDF5 file, but with CLASSIC\_MODEL. No user defined types
are allowed in the classic model.
`NF_EBADTYPE`
: This type not a compound type.
`NF_EBADTYPEID`
: Bad type id.
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/ftst\_types.F.
C Check it differently.
retval = nf_inq_compound(ncid, typeids(1), name_in, size_in,
& nfields_in)
if (retval .ne. nf_noerr) call handle_err(retval)
if (name_in(1:len(type_name)) .ne. type_name .or.
& size_in .ne. WIND_T_SIZE .or. nfields_in .ne. 2) stop 2
C Check it one piece at a time.
retval = nf_inq_compound_nfields(ncid, typeids(1), nfields_in)
if (retval .ne. nf_noerr) call handle_err(retval)
if (nfields_in .ne. 2) stop 2
retval = nf_inq_compound_size(ncid, typeids(1), size_in)
if (retval .ne. nf_noerr) call handle_err(retval)
if (size_in .ne. WIND_T_SIZE) stop 2
retval = nf_inq_compound_name(ncid, typeids(1), name_in)
if (retval .ne. nf_noerr) call handle_err(retval)
if (name_in(1:len(type_name)) .ne. type_name) stop 2
### 5.6.5 Learn About a Field of a Compound Type: NF_INQ_COMPOUND_FIELD {#f77_NF-INQ-COMPOUND-FIELD}
Get information about one of the fields of a compound type.
Usage
-----
INTEGER FUNCTION NF_INQ_COMPOUND_FIELD(INTEGER NCID, INTEGER XTYPE,
INTEGER FIELDID, CHARACTER*(*) NAME, INTEGER OFFSETP,
INTEGER FIELD_TYPEIDP, INTEGER NDIMSP, INTEGER DIM_SIZESP)
INTEGER FUNCTION NF_INQ_COMPOUND_FIELDNAME(INTEGER TYPEID,
INTEGER FIELDID, CHARACTER*(*) NAME)
INTEGER FUNCTION NF_INQ_COMPOUND_FIELDINDEX(INTEGER TYPEID,
CHARACTER*(*) NAME, INTEGER FIELDIDP)
INTEGER FUNCTION NF_INQ_COMPOUND_FIELDOFFSET(INTEGER TYPEID,
INTEGER FIELDID, INTEGER OFFSETP)
INTEGER FUNCTION NF_INQ_COMPOUND_FIELDTYPE(INTEGER TYPEID,
INTEGER FIELDID, INTEGER FIELD_TYPEIDP)
INTEGER FUNCTION NF_INQ_COMPOUND_FIELDNDIMS(INTEGER NCID,
INTEGER XTYPE, INTEGER FIELDID, INTEGER NDIMSP)
INTEGER FUNCTION NF_INQ_COMPOUND_FIELDDIM_SIZES(INTEGER NCID,
INTEGER XTYPE, INTEGER FIELDID, INTEGER DIM_SIZES)
`NCID`
: The groupid where this compound type exists.
`XTYPE`
: The typeid for this compound type, as returned by NF\_DEF\_COMPOUND,
or NF\_INQ\_VAR.
`FIELDID`
: A one-based index number specifying a field in the compound type.
`NAME`
: A character array which will get the name of the field. The name
will be NF\_MAX\_NAME characters, at most.
`OFFSETP`
: An integer which will get the offset of the field.
`FIELD_TYPEID`
: An integer which will get the typeid of the field.
`NDIMSP`
: An integer which will get the number of dimensions of the field.
`DIM_SIZESP`
: An integer array which will get the dimension sizes of the field.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADTYPEID`
: Bad type id.
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/fst\_types.F.
~~~~
C Check the first field of the compound type.
retval = nf_inq_compound_field(ncid, typeids(1), 1, name_in,
& offset_in, field_typeid_in, ndims_in, dim_sizes_in)
if (retval .ne. nf_noerr) call handle_err(retval)
if (name_in(1:len(u_name)) .ne. u_name .or. offset_in .ne. 0 .or.
& field_typeid_in .ne. NF_INT .or. ndims_in .ne. 0) stop 2
retval = nf_inq_compound_fieldname(ncid, typeids(1), 1, name_in)
if (retval .ne. nf_noerr) call handle_err(retval)
if (name_in(1:len(u_name)) .ne. u_name) stop 2
retval = nf_inq_compound_fieldoffset(ncid, typeids(1), 1,
& offset_in)
if (retval .ne. nf_noerr) call handle_err(retval)
if (offset_in .ne. 0) stop 2
retval = nf_inq_compound_fieldtype(ncid, typeids(1), 1,
& field_typeid_in)
if (retval .ne. nf_noerr) call handle_err(retval)
if (field_typeid_in .ne. NF_INT) stop 2
retval = nf_inq_compound_fieldndims(ncid, typeids(1), 1,
& ndims_in)
if (retval .ne. nf_noerr) call handle_err(retval)
if (ndims_in .ne. 0) stop 2
~~~~
5.7 Variable Length Array Introduction
--------------------------------------
NetCDF-4 addedpport for a variable length array type. This is not
supported in classic or 64-bit offset files, or in netCDF-4 files which
were created with the NF\_CLASSIC\_MODEL flag.
A variable length array is represented in C as a structure from HDF5,
the nf\_vlen\_t structure. It contains a len member, which contains the
length of that array, and a pointer to the array.
So an array of VLEN in C is an array of nc\_vlen\_t structures. The only
way to handle this in Fortran is with a character buffer sized correctly
for the platform.
The extra access functions NF\_GET\_VLEN\_ELEMENT and
NF\_PUT\_VLEN\_ELEMENT to get and put one VLEN element. (That is, one
array of variable length.) When calling the put, the data are not copied
from the source. When calling the get the data are copied from VLEN
allocated memory, which must still be freed (see below).
VLEN arrays are handled differently with respect to allocation of
memory. Generally, when reading data, it is up to the user to malloc
(andbsequently free) the memory needed to hold the data. It is up to
the user to ere that enough memory is allocated.
With VLENs, this is impossible. The user cannot know the size of an
array of VLEN until after reading the array. Therefore when reading VLEN
arrays, the netCDF library will allocate the memory for the data within
each VLEN.
It is up to the user, however, to eventually free this memory. This is
not just a matter of one call to free, with the pointer to the array of
VLENs; each VLEN contains a pointer which must be freed.
Compression is permitted but may not be effective for VLEN data, because
the compression is applied to the nc\_vlen\_t structures, rather than
the actual data.
### 5.7.1 Define a Variable Length Array (VLEN): NF\_DEF\_VLEN
Use this function to define a variable length array type.
Usage
-----
INTEGER FUNCTION NF_DEF_VLEN(INTEGER NCID, CHARACTER*(*) NAME,
INTEGER BASE_TYPEID, INTEGER XTYPEP)
`NCID`
: The ncid of the file to create the VLEN type in.
`NAME`
: A name for the VLEN type.
`BASE_TYPEID`
: The typeid of the base type of the VLEN. For example, for a VLEN of
shorts, the base type is NF\_SHORT. This can be a user defined type.
`XTYPEP`
: The typeid of the new VLEN type will be set here.
Errors
------
`NF_NOERR`
: No error.
`NF_EMAXNAME`
: NF\_MAX\_NAME exceeded.
`NF_ENAMEINUSE`
: Name is already in use.
`NF_EBADNAME`
: Attribute or variable name contains illegal characters.
`NF_EBADID`
: ncid invalid.
`NF_EBADGRPID`
: Group ID part of ncid was invalid.
`NF_EINVAL`
: Size is invalid.
`NF_ENOMEM`
: Out of memory.
Example
-------
This example is from nf\_test/ftst\_vars4.F.
C Create the vlen type.
retval = nf_def_vlen(ncid, vlen_type_name, nf_int, vlen_typeid)
if (retval .ne. nf_noerr) call handle_err(retval)
### 5.7.2 Learning about a Variable Length Array (VLEN) Type: NF\_INQ\_VLEN
Use this type to learn about a vlen.
Usage
-----
INTEGER FUNCTION NF_INQ_VLEN(INTEGER NCID, INTEGER XTYPE,
CHARACTER*(*) NAME, INTEGER DATUM_SIZEP, INTEGER
BASE_NF_TYPEP)
`NCID`
: The ncid of the file that contains the VLEN type.
`XTYPE`
: The type of the VLEN to inquire about.
`NAME`
: The name of the VLEN type. The name will be NF\_MAX\_NAME characters
or less.
`DATUM_SIZEP`
: A pointer to a size\_t, this will get the size of one element of
this vlen.
`BASE_NF_TYPEP`
: An integer that will get the type of the VLEN base type. (In other
words, what type is this a VLEN of?)
Errors
------
`NF_NOERR`
: No error.
`NF_EBADTYPE`
: Can’t find the typeid.
`NF_EBADID`
: ncid invalid.
`NF_EBADGRPID`
: Group ID part of ncid was invalid.
Example
-------
This example is from nf\_test/ftst\_vars4.F.
C Use nf_inq_vlen and makere we get the same answers as we did
C with nf_inq_user_type.
retval = nf_inq_vlen(ncid, typeids(1), type_name, base_size,
& base_type)
if (retval .ne. nf_noerr) call handle_err(retval)
### 5.7.3 Releasing Memory for a Variable Length Array (VLEN) Type: NF\_FREE\_VLEN
When a VLEN is read into user memory from the file, the HDF5 library
performs memory allocations for each of the variable length arrays
contained within the VLEN structure. This memory must be freed by the
user to avoid memory leaks.
This violates the normal netCDF expectation that the user is responsible
for all memory allocation. But, with VLEN arrays, the underlying HDF5
library allocates the memory for the user, and the user is responsible
for deallocating that memory.
Usage
-----
INTEGER FUNCTION NF_FREE_VLEN(CHARACTER VL);
`VL`
: The variable length array structure which is to be freed.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADTYPE`
: Can’t find the typeid.
Example
-------
### 5.7.4 Set a Variable Length Array with NF\_PUT\_VLEN\_ELEMENT
Use this to set the element of the (potentially) n-dimensional array of
VLEN. That is, this sets the data in one variable length array.
Usage
-----
INTEGER FUNCTION NF_PUT_VLEN_ELEMENT(INTEGER NCID, INTEGER XTYPE,
CHARACTER*(*) VLEN_ELEMENT, INTEGER LEN, DATA)
`NCID`
: The ncid of the file that contains the VLEN type.
`XTYPE`
: The type of the VLEN.
`VLEN_ELEMENT`
: The VLEN element to be set.
`LEN`
: The number of entries in this array.
`DATA`
: The data to be stored. Must match the base type of this VLEN.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADTYPE`
: Can’t find the typeid.
`NF_EBADID`
: ncid invalid.
`NF_EBADGRPID`
: Group ID part of ncid was invalid.
Example
-------
This example is from nf\_test/ftst\_vars4.F.
C Set up the vlen with this helper function, since F77 can't deal
C with pointers.
retval = nf_put_vlen_element(ncid, vlen_typeid, vlen,
& vlen_len, data1)
if (retval .ne. nf_noerr) call handle_err(retval)
### 5.7.5 Set a Variable Length Array with NF\_GET\_VLEN\_ELEMENT
Use this to set the element of the (potentially) n-dimensional array of
VLEN. That is, this sets the data in one variable length array.
Usage
-----
INTEGER FUNCTION NF_GET_VLEN_ELEMENT(INTEGER NCID, INTEGER XTYPE,
CHARACTER*(*) VLEN_ELEMENT, INTEGER LEN, DATA)
`NCID`
: The ncid of the file that contains the VLEN type.
`XTYPE`
: The type of the VLEN.
`VLEN_ELEMENT`
: The VLEN element to be set.
`LEN`
: This will be set to the number of entries in this array.
`DATA`
: The data will be copied here. Sufficient storage must be available
or bad things will happen to you.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADTYPE`
: Can’t find the typeid.
`NF_EBADID`
: ncid invalid.
`NF_EBADGRPID`
: Group ID part of ncid was invalid.
Example
-------
This example is from nf\_test/ftst\_vars4.F.
C Read the vlen attribute.
retval = nf_get_att(ncid, NF_GLOBAL, 'att1', vlen_in)
if (retval .ne. nf_noerr) call handle_err(retval)
C Get the data from the vlen we just read.
retval = nf_get_vlen_element(ncid, vlen_typeid, vlen_in,
& vlen_len_in, data1_in)
if (retval .ne. nf_noerr) call handle_err(retval)
5.8 Opaque Type Introduction
----------------------------
NetCDF-4 addedpport for the opaque type. This is notpported in
classic or 64-bit offset files.
The opaque type is a type which is a collection of objects of a known
size. (And each object is the same size). Nothing is known to netCDF
about the contents of these blobs of data, except their size in bytes,
and the name of the type.
To use an opaque type, first define it with [Creating Opaque Types:
NF\_DEF\_OPAQUE](#NF_005fDEF_005fOPAQUE). If encountering an enum type
in a new data file, use [Learn About an Opaque Type:
NF\_INQ\_OPAQUE](#NF_005fINQ_005fOPAQUE) to learn its name and size.
### 5.8.1 Creating Opaque Types: NF\_DEF\_OPAQUE
Create an opaque type. Provide a size and a name.
Usage
-----
INTEGER FUNCTION NF_DEF_OPAQUE(INTEGER NCID, INTEGER SIZE,
CHARACTER*(*) NAME, INTEGER TYPEIDP)
`NCID`
: The groupid where the type will be created. The type may be used
anywhere in the file, no matter what group it is in.
`SIZE`
: The size of each opaque object.
`NAME`
: The name for this type. Must be shorter than NF\_MAX\_NAME.
`TYPEIDP`
: Pointer where the new typeid for this type is returned. Use this
typeid when defining variables of this type with [Create a Variable:
`NF_DEF_VAR`](#NF_005fDEF_005fVAR).
Errors
------
`NF_NOERR`
: No error.
`NF_EBADTYPEID`
: Bad typeid.
`NF_EBADFIELDID`
: Bad fieldid.
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/ftst\_vars3.F.
C Create the opaque type.
retval = nf_def_opaque(ncid, opaque_size, opaque_type_name,
& opaque_typeid)
if (retval .ne. nf_noerr) call handle_err(retval)
### 5.8.2 Learn About an Opaque Type: NF\_INQ\_OPAQUE
Given a typeid, get the information about an opaque type.
Usage
-----
INTEGER FUNCTION NF_INQ_OPAQUE(INTEGER NCID, INTEGER XTYPE,
CHARACTER*(*) NAME, INTEGER SIZEP)
`NCID`
: The ncid for the group containing the opaque type.
`XTYPE`
: The typeid for this opaque type, as returned by NF\_DEF\_COMPOUND,
or NF\_INQ\_VAR.
`NAME`
: The name of the opaque type will be copied here. It will be
NF\_MAX\_NAME bytes or less.
`SIZEP`
: The size of the opaque type will be copied here.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADTYPEID`
: Bad typeid.
`NF_EBADFIELDID`
: Bad fieldid.
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/ftst\_vars3.F.
C Use nf_inq_opaque and makere we get the same answers as we did
C with nf_inq_user_type.
retval = nf_inq_opaque(ncid, typeids(2), type_name, base_size)
if (retval .ne. nf_noerr) call handle_err(retval)
5.9 Enum Type Introduction
--------------------------
NetCDF-4 addedpport for the enum type. This is notpported in
classic or 64-bit offset files.
### 5.9.1 Creating a Enum Type: NF\_DEF\_ENUM
Create an enum type. Provide an ncid, a name, and a base integer type.
After calling this function, fill out the type with repeated calls to
NF\_INSERT\_ENUM (see [Inserting a Field into a Enum Type:
NF\_INSERT\_ENUM](#NF_005fINSERT_005fENUM)). Call NF\_INSERT\_ENUM once
for each value you wish to make part of the enumeration.
Usage
-----
INTEGER FUNCTION NF_DEF_ENUM(INTEGER NCID, INTEGER BASE_TYPEID,
CHARACTER*(*) NAME, INTEGER TYPEIDP)
`NCID`
: The groupid where this compound type will be created.
`BASE_TYPEID`
: The base integer type for this enum. Must be one of: NF\_BYTE,
NF\_UBYTE, NF\_SHORT, NF\_USHORT, NF\_INT, NF\_UINT, NF\_INT64,
NF\_UINT64.
`NAME`
: The name of the new enum type.
`TYPEIDP`
: The typeid of the new type will be placed here.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_ENAMEINUSE`
: That name is in use. Compound type names must be unique in the data
file.
`NF_EMAXNAME`
: Name exceeds max length NF\_MAX\_NAME.
`NF_EBADNAME`
: Name contains illegal characters.
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag NF\_NETCDF4. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
`NF_EPERM`
: Attempt to write to a read-only file.
`NF_ENOTINDEFINE`
: Not in define mode.
This example is from nf\_test/ftst\_vars3.F.
C Create the enum type.
retval = nf_def_enum(ncid, NF_INT, enum_type_name, enum_typeid)
if (retval .ne. nf_noerr) call handle_err(retval)
### 5.9.2 Inserting a Field into a Enum Type: NF\_INSERT\_ENUM
Insert a named member into a enum type.
Usage
-----
INTEGER FUNCTION NF_INSERT_ENUM(INTEGER NCID, INTEGER XTYPE,
CHARACTER IDENTIFIER, INTEGER VALUE)
`NCID`
: The ncid of the group which contains the type.
`TYPEID`
: The typeid for this enum type, as returned by nf\_def\_enum, or
nf\_inq\_var.
`IDENTIFIER`
: The identifier of the new member.
`VALUE`
: The value that is to be associated with this member.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADID`
: Bad group id.
`NF_ENAMEINUSE`
: That name is in use. Field names must be unique within a enum type.
`NF_EMAXNAME`
: Name exceed max length NF\_MAX\_NAME.
`NF_EBADNAME`
: Name contains illegal characters.
`NF_ENOTNC4`
: Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag NF\_NETCDF4. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see
[NF\_OPEN](#NF_005fOPEN)).
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
`NF_ENOTINDEFINE`
: Not in define mode.
Example
-------
This example is from nf\_test/ftst\_vars3.F.
one = 1
zero = 0
retval = nf_insert_enum(ncid, enum_typeid, zero_name, zero)
if (retval .ne. nf_noerr) call handle_err(retval)
retval = nf_insert_enum(ncid, enum_typeid, one_name, one)
if (retval .ne. nf_noerr) call handle_err(retval)
### 5.9.3 Learn About a Enum Type: NF\_INQ\_ENUM
Get information about a user-defined enumeration type.
Usage
-----
INTEGER FUNCTION NF_INQ_ENUM(INTEGER NCID, INTEGER XTYPE,
CHARACTER*(*) NAME, INTEGER BASE_NF_TYPE, INTEGER BASE_SIZE,
INTEGER NUM_MEMBERS)
`NCID`
: The group ID of the group which holds the enum type.
`XTYPE`
: The typeid for this enum type, as returned by NF\_DEF\_ENUM, or
NF\_INQ\_VAR.
`NAME`
: Character array which will get the name. It will have a maximum
length of NF\_MAX\_NAME.
`BASE_NF_TYPE`
: An integer which will get the base integer type of this enum.
`BASE_SIZE`
: An integer which will get the size (in bytes) of the base integer
type of this enum.
`NUM_MEMBERS`
: An integer which will get the number of members defined for this
enumeration type.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADTYPEID`
: Bad type id.
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
In this example from nf\_test/ftst\_vars3.F, an enum type is created and
then examined:
retval = nf_inq_enum(ncid, typeids(1), type_name, base_type,
& base_size, num_members)
if (retval .ne. nf_noerr) call handle_err(retval)
if (base_type .ne. NF_INT .or. num_members .ne. 2) stop 2
### 5.9.4 Learn the Name of a Enum Type: nf\_inq\_enum\_member
Get information about a member of an enum type.
Usage
-----
INTEGER FUNCTION NF_INQ_ENUM_MEMBER(INTEGER NCID, INTEGER XTYPE,
INTEGER IDX, CHARACTER*(*) NAME, INTEGER VALUE)
`NCID`
: The groupid where this enum type exists.
`XTYPE`
: The typeid for this enum type.
`IDX`
: The one-based index number for the member of interest.
`NAME`
: A character array which will get the name of the member. It will
have a maximum length of NF\_MAX\_NAME.
`VALUE`
: An integer that will get the value associated with this member.
Errors
------
`NF_NOERR`
: No error.
`NF_EBADTYPEID`
: Bad type id.
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
Example
-------
This example is from nf\_test/ftst\_vars3.F:
C Check the members of the enum type.
retval = nf_inq_enum_member(ncid, typeids(1), 1, member_name,
& member_value)
if (retval .ne. nf_noerr) call handle_err(retval)
if (member_name(1:len(zero_name)) .ne. zero_name .or.
& member_value .ne. 0) stop 2
retval = nf_inq_enum_member(ncid, typeids(1), 2, member_name,
& member_value)
if (retval .ne. nf_noerr) call handle_err(retval)
if (member_name(1:len(one_name)) .ne. one_name .or.
& member_value .ne. 1) stop 2
### 5.9.5 Learn the Name of a Enum Type: NF\_INQ\_ENUM\_IDENT
Get the name which is associated with an enum member value.
This is similar to NF\_INQ\_ENUM\_MEMBER, but instead of using the index
of the member, you use the value of the member.
Usage
-----
INTEGER FUNCTION NF_INQ_ENUM_IDENT(INTEGER NCID, INTEGER XTYPE,
INTEGER VALUE, CHARACTER*(*) IDENTIFIER)
`NCID`
: The groupid where this enum type exists.
`XTYPE`
: The typeid for this enum type.
`VALUE`
: The value for which an identifier is sought.
`IDENTIFIER`
: A character array that will get the identifier. It will have a
maximum length of NF\_MAX\_NAME.
Return Code
-----------
`NF_NOERR`
: No error.
`NF_EBADTYPEID`
: Bad type id, or not an enum type.
`NF_EHDFERR`
: An error was reported by the HDF5 layer.
`NF_EINVAL`
: The value was not found in the enum.
Example
-------
In this example from nf\_test/ftst\_vars3.F, the values for 0 and 1 are
checked in an enum.
retval = nf_inq_enum_ident(ncid, typeids(1), 0, member_name)
if (retval .ne. nf_noerr) call handle_err(retval)
if (member_name(1:len(zero_name)) .ne. zero_name) stop 2
retval = nf_inq_enum_ident(ncid, typeids(1), 1, member_name)
if (retval .ne. nf_noerr) call handle_err(retval)
if (member_name(1:len(one_name)) .ne. one_name) stop 2
6. Variables
============
6.1 Variables Introduction
--------------------------
Variables for a netCDF dataset are defined when the dataset is created,
while the netCDF dataset is in define mode. Other variables may be added
later by reentering define mode. A netCDF variable has a name, a type,
and a shape, which are specified when it is defined. A variable may also
have values, which are established later in data mode.
Ordinarily, the name, type, and shape are fixed when the variable is
first defined. The name may be changed, but the type and shape of a
variable cannot be changed. However, a variable defined in terms of the
unlimited dimension can grow without bound in that dimension.
A netCDF variable in an open netCDF dataset is referred to by a small
integer called a variable ID.
Variable IDs reflect the order in which variables were defined within a
netCDF dataset. Variable IDs are 1, 2, 3,..., in the order in which the
variables were defined. A function is available for getting the variable
ID from the variable name and vice-versa.
Attributes (see [Attributes](#Attributes)) may be associated with a
variable to specifych properties as units.
Operationspported on variables are:
- Create a variable, given its name, data type, and shape.
- Get a variable ID from its name.
- Get a variable’s name, data type, shape, and number of attributes
from its ID.
- Put a data value into a variable, given variable ID, indices, and
value.
- Put an array of values into a variable, given variable ID, corner
indices, edge lengths, and a block of values.
- Put absampled or mapped array of values into a variable,
given variable ID, corner indices, edge lengths, stride vector,
index mapping vector, and a block of values.
- Get a data value from a variable, given variable ID and indices.
- Get an array of values from a variable, given variable ID, corner
indices, and edge lengths.
- Get absampled or mapped array of values from a variable,
given variable ID, corner indices, edge lengths, stride vector, and
index mapping vector.
- Rename a variable.
6.2 Language Types Corresponding to netCDF external data types
--------------------------------------------------------------
The following table gives the netCDF external data types and the
corresponding type constants for defining variables in the FORTRAN
interface:
-------- ---------------------- ------
Type FORTRAN API Mnemonic Bits
byte NF\_BYTE 8
char NF\_CHAR 8
short NF\_SHORT 16
int NF\_INT 32
float NF\_FLOAT 32
double NF\_DOUBLE 64
-------- ---------------------- ------
The first column gives the netCDF external data type, which is the same
as the CDL data type. The next column gives the corresponding FORTRAN
parameter for use in netCDF functions (the parameters are defined in the
netCDF FORTRAN include-file netcdf.inc). The last column gives the
number of bits used in the external representation of values of the
corresponding type.
Note that there are no netCDF types corresponding to 64-bit integers or
to characters wider than 8 bits in the current version of the netCDF
library.
6.3 Create a Variable: `NF_DEF_VAR`
-----------------------------------
The function NF\_DEF\_VAR adds a new variable to an open netCDF dataset
in define mode. It returns (as an argument) a variable ID, given the
netCDF ID, the variable name, the variable type, the number of
dimensions, and a list of the dimension IDs.
Usage
-----
INTEGER FUNCTION NF_DEF_VAR(INTEGER NCID, CHARACTER*(*) NAME,
INTEGER XTYPE, INTEGER NVDIMS,
INTEGER VDIMS(*), INTEGER varid)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`NAME`
: Variable name.
`XTYPE`
: One of the set of predefined netCDF external data types. The type of
this parameter, NF\_TYPE, is defined in the netCDF header file. The
valid netCDF external data types are NF\_BYTE, NF\_CHAR, NF\_SHORT,
NF\_INT, NF\_FLOAT, and NF\_DOUBLE. If the file is a NetCDF-4/HDF5
file, the additional types NF\_UBYTE, NF\_USHORT, NF\_UINT,
NF\_INT64, NF\_UINT64, and NF\_STRING may be used, as well as a user
defined type ID.
`NVDIMS`
: Number of dimensions for the variable. For example, 2 specifies a
matrix, 1 specifies a vector, and 0 means the variable is a scalar
with no dimensions. Must not be negative or greater than the
predefined constant NF\_MAX\_VAR\_DIMS.
`VDIMS`
: Vector of ndims dimension IDs corresponding to the variable
dimensions. If the ID of the unlimited dimension is included, it
must be first. This argument is ignored if ndims is 0. For expanded
model netCDF4/HDF5 files, there may be any number of unlimited
dimensions, and they may be used in any element of the dimids array.
`varid`
: Returned variable ID.
Errors
------
NF\_DEF\_VAR returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The netCDF dataset is not in define mode.
- The specified variable name is the name of another existing
variable.
- The specified type is not a valid netCDF type.
- The specified number of dimensions is negative or more than the
constant NF\_MAX\_VAR\_DIMS, the maximum number of dimensions
permitted for a netCDF variable.
- One or more of the dimension IDs in the list of dimensions is not a
valid dimension ID for the netCDF dataset.
- The number of variables would exceed the constant NF\_MAX\_VARS, the
maximum number of variables permitted in a netCDF dataset.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_DEF\_VAR to create a variable named rh of
type double with three dimensions, time, lat, and lon in a new netCDF
dataset named foo.nc:
INCLUDE 'netcdf.inc'
...
INTEGER STATUS, NCID
INTEGER LATDIM, LONDIM, TIMDIM ! dimension IDs
INTEGER RHID ! variable ID
INTEGER RHDIMS(3) ! variable shape
...
STATUS = NF_CREATE ('foo.nc', NF_NOCLOBBER, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
! define dimensions
STATUS = NF_DEF_DIM(NCID, 'lat', 5, LATDIM)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_DEF_DIM(NCID, 'lon', 10, LONDIM)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_DEF_DIM(NCID, 'time', NF_UNLIMITED, TIMDIM)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
! define variable
RHDIMS(1) = LONDIM
RHDIMS(2) = LATDIM
RHDIMS(3) = TIMDIM
STATUS = NF_DEF_VAR (NCID, 'rh', NF_DOUBLE, 3, RHDIMS, RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
6.4 Define Chunking Parameters for a Variable: `NF_DEF_VAR_CHUNKING`
--------------------------------------------------------------------
The function NF\_DEF\_VAR\_CHUNKING sets the storage parameters for a
variable in a netCDF-4 file. Storage may be either chunked,
contiguous, or compact.
Variables that make use of one or more unlimited dimensions,
compression, or checms must use chunking. Such variables are created
with default chunk sizes of 1 for each unlimited dimension and the
dimension length for other dimensions, except that if the rlting
chunks are too large, the default chunk sizes for non-record dimensions
are reduced.
The total size of a chunk must be less than 4 GiB. That is, the product
of all chunksizes and the size of the data (or the size of nc\_vlen\_t
for VLEN types) must be less than 4 GiB.
This function may only be called after the variable is defined, but
before nc\_enddef is called. Once the chunking parameters are set for a
variable, they cannot be changed. This function can be used to change
the default chunking for record, compressed, or checmmed variables
before nc\_enddef is called.
Note that you cannot set chunking for scalar variables. Only non-scalar
variables can have chunking.
Compact storage may be used on fixed-size variables with a total data
size of 64 MB or less. Compact storage allows for fast read times on
HPC systems.
Usage
-----
NF_DEF_VAR_CHUNKING(INTEGER NCID, INTEGER VARID, INTEGER STORAGE, INTEGER CHUNKSIZES)
`ncid`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`varid`
: Variable ID.
`storage`
: If NF\_CONTIGUOUS, then contiguous storage is used for this
variable. Variables with compression, shuffle filter, checms, or
one or more unlimited dimensions cannot use contiguous storage. If
contiguous storage is turned on, the chunksizes parameter is
ignored.
If NF\_CHUNKED, then chunked storage is used for this variable.
Chunk sizes may be specified with the chunksizes parameter. Default
sizes will be used if chunking is required and this function is not
called.
By default contiguous storage is used for fix-sized variables when
conpression, chunking, checms, or endianness control are not
used.
`chunksizes`
: An array of chunk sizes. The array must have the one chunksize for
each dimension in the variable. If contiguous storage is used, then
the chunksizes parameter is ignored.
Errors
------
NF\_DEF\_VAR\_CHUNKING returns the value NF\_NOERR if no errors
occurred. Otherwise, the returned status indicates an error.
Possible return codes include:
`NF_NOERR`
: No error.
`NF_BADID`
: Bad ncid.
`NF_EINVAL`
: Invalid input. This can occur when the user attempts to set
contiguous storage for a variable with compression or checms, or
one or more unlimited dimensions.
`NF_ENOTNC4`
: Not a netCDF-4 file.
`NF_ENOTVAR`
: Can’t find this variable.
`NF_ELATEDEF`
: This variable has already been thebject of a NF\_ENDDEF call. In
netCDF-4 files NF\_ENDDEF will be called automatically for any data
read or write. Once enddef has been called, it is impossible to set
the chunking for a variable.
`NF_ENOTINDEFINE`
: Not in define mode. This is returned for netCDF classic or 64-bit
offset files, or for netCDF-4 files, when they were been created
with NF\_STRICT\_NC3 flag. (see
[NF\_CREATE](#NF_005fCREATE)).
`NF_ESTRICTNC3`
: Trying to create a var some place other than the root group in a
netCDF file with NF\_STRICT\_NC3 turned on.
Example
-------
In this example from nf\_test/ftst\_vars.F, a file is created, two
dimensions and a variable are defined, and the chunksizes of the data
are set to the size of the data (that is, data will be written in one
chunk).
C Create the netCDF file.
retval = nf_create(FILE_NAME, NF_NETCDF4, ncid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Define the dimensions.
retval = nf_def_dim(ncid, "x", NX, x_dimid)
if (retval .ne. nf_noerr) call handle_err(retval)
retval = nf_def_dim(ncid, "y", NY, y_dimid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Define the variable.
dimids(1) = y_dimid
dimids(2) = x_dimid
retval = NF_DEF_VAR(ncid, "data", NF_INT, NDIMS, dimids, varid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Turn on chunking.
chunks(1) = NY
chunks(2) = NX
retval = NF_DEF_VAR_chunking(ncid, varid, NF_CHUNKED, chunks)
if (retval .ne. nf_noerr) call handle_err(retval)
6.5 Learn About Chunking Parameters for a Variable: `NF_INQ_VAR_CHUNKING`
-------------------------------------------------------------------------
The function NF\_INQ\_VAR\_CHUNKING returns the chunking settings for a
variable in a netCDF-4 file.
Usage
-----
NF_INQ_VAR_CHUNKING(INTEGER NCID, INTEGER VARID, INTEGER STORAGE, INTEGER CHUNKSIZES);
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`STORAGE`
: On return, set to NF\_CONTIGUOUS if this variable uses contiguous
storage, NF\_CHUNKED if it uses chunked storage, NF\_COMPACT if it uses
compact storage.
`CHUNKSIZES`
: An array of chunk sizes. The length of CHUNKSIZES must be the same
as the number of dimensions of the variable.
Errors
------
NF\_INQ\_VAR\_CHUNKING returns the value NF\_NOERR if no errors
occurred. Otherwise, the returned status indicates an error.
Possible return codes include:
`NF_NOERR`
: No error.
`NF_BADID`
: Bad ncid.
`NF_ENOTNC4`
: Not a netCDF-4 file.
`NF_ENOTVAR`
: Can’t find this variable.
Example
-------
In this example from nf\_test/ftst\_vars.F, a variable with chunked
storage is checked to ere that the chunksizes are set to expected
values.
C Is everything set that ispposed to be?
retval = nf_inq_var_chunking(ncid, varid, storage, chunks_in)
if (retval .ne. nf_noerr) call handle_err(retval)
if (storage .ne. NF_CHUNKED) stop 2
if (chunks(1) .ne. chunks_in(1)) stop 2
if (chunks(2) .ne. chunks_in(2)) stop 2
6.6 Set HDF5 Chunk Cache for a Variable: NF\_SET\_VAR\_CHUNK\_CACHE
-------------------------------------------------------------------
This function changes the chunk cache settings for a variable. The
change in cache size happens immediately. This is a property of the open
file - it does not persist the next time you open the file.
For more information, see the documentation for the H5Pset\_cache()
function in the HDF5 library at the HDF5 website:
[http://hdfgroup.org/HDF5/](http://hdfgroup.org/HDF5/).
Usage
-----
NF_SET_VAR_CHUNK_CACHE(INTEGER NCID, INTEGER VARID, INTEGER SIZE, INTEGER NELEMS,
INTEGER PREEMPTION);
`NCID`
: NetCDF ID, from a previous call to nc\_open or nc\_create.
`VARID`
: Variable ID.
`SIZE`
: The total size of the raw data chunk cache, in megabytes. This
should be big enough to hold multiple chunks of data. (Note that the
C API uses bytes, but the Fortran APIs uses megabytes to avoid
numbers that can’t fit in 4-byte integers.)
`NELEMS`
: The number of chunk slots in the raw data chunk cache hash table.
This should be a prime number larger than the number of chunks that
will be in the cache.
`PREEMPTION`
: The preemption value must be between 0 and 100 inclusive and
indicates the degreee to which chunks that have been fully read are
favored for kicking out of the chunk cache, when needed. A value of
zero means fully read chunks are treated no differently than other
chunks (the preemption is strictly Least Recently Used) while a
value of 100 means fully read chunks are always preempted before
other chunks. (The C API uses a float between 0 and 1 for this
value).
Return Codes
------------
`NF_NOERR`
: No error.
`NF_EINVAL`
: Preemption must be between zero and 100 (inclusive).
Example
-------
This example is from nf\_test/ftst\_vars2.F:
include 'netcdf.inc'
...
C These will be used to set the per-variable chunk cache.
integer CACHE_SIZE, CACHE_NELEMS, CACHE_PREEMPTION
parameter (CACHE_SIZE = 8, CACHE_NELEMS = 571)
parameter (CACHE_PREEMPTION = 42)
...
C Set variable caches.
retval = nf_set_var_chunk_cache(ncid, varid(i), CACHE_SIZE,
& CACHE_NELEMS, CACHE_PREEMPTION)
if (retval .ne. nf_noerr) call handle_err(retval)
6.7 Get the HDF5 Chunk Cache Settings for a variable: NF\_GET\_VAR\_CHUNK\_CACHE
--------------------------------------------------------------------------------
This function gets the current chunk cache settings for a variable in a
netCDF-4/HDF5 file.
For more information, see the documentation for the H5Pget\_cache()
function in the HDF5 library at the HDF5 website:
[http://hdfgroup.org/HDF5/](http://hdfgroup.org/HDF5/).
Usage
-----
INTEGER NF_GET_VAR_CHUNK_CACHE(INTEGER NCID, INTEGER VARID, INTEGER SIZE, INTEGER NELEMS,
INTEGER PREEMPTION);
`ncid`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`varid`
: Variable ID.
`sizep`
: The total size of the raw data chunk cache, in megabytes, will be
put here.
`nelemsp`
: The number of chunk slots in the raw data chunk cache hash table
will be put here.
`preemptionp`
: The preemption will be put here. The preemtion value is between 0
and 100 inclusive and indicates how much chunks that have been fully
read are favored for preemption. A value of zero means fully read
chunks are treated no differently than other chunks (the preemption
is strictly LRU) while a value of 100 means fully read chunks are
always preempted before other chunks.
Return Codes
------------
`NC_NOERR`
: No error.
Example
-------
This example is from nf\_test/ftst\_vars2.c:
include 'netcdf.inc'
...
C These will be used to set the per-variable chunk cache.
integer CACHE_SIZE, CACHE_NELEMS, CACHE_PREEMPTION
parameter (CACHE_SIZE = 8, CACHE_NELEMS = 571)
parameter (CACHE_PREEMPTION = 42)
C These will be used to check the setting of the per-variable chunk
C cache.
integer cache_size_in, cache_nelems_in, cache_preemption_in
...
retval = nf_get_var_chunk_cache(ncid, varid(i), cache_size_in,
& cache_nelems_in, cache_preemption_in)
if (retval .ne. nf_noerr) call handle_err(retval)
if (cache_size_in .ne. CACHE_SIZE .or. cache_nelems_in .ne.
& CACHE_NELEMS .or. cache_preemption .ne. CACHE_PREEMPTION)
& stop 8
6.8 Define Fill Parameters for a Variable: `nf_def_var_fill`
------------------------------------------------------------
The function NF\_DEF\_VAR\_FILL sets the fill parameters for a variable
in a netCDF-4 file.
This function must be called after the variable is defined, but before
NF\_ENDDEF is called.
Usage
-----
NF_DEF_VAR_FILL(INTEGER NCID, INTEGER VARID, INTEGER NO_FILL, FILL_VALUE);
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`NO_FILL`
: Set to non-zero value to set no\_fill mode on a variable. When this
mode is on, fill values will not be written for the variable. This
is helpful in high performance applications. For netCDF-4/HDF5 files
(whether classic model or not), this may only be changed after the
variable is defined, but before it is committed to disk (i.e. before
the first NF\_ENDDEF after the NF\_DEF\_VAR.) For classic and 64-bit
offset file, the no\_fill mode may be turned on and off at any time.
`FILL_VALUE`
: A value which will be used as the fill value for the variable. Must
be the same type as the variable. This will be written to a
\_FillValue attribute, created for this purpose. If NULL, this
argument will be ignored.
Return Codes
------------
`NF_NOERR`
: No error.
`NF_BADID`
: Bad ncid.
`NF_ENOTNC4`
: Not a netCDF-4 file.
`NF_ENOTVAR`
: Can’t find this variable.
`NF_ELATEDEF`
: This variable has already been thebject of a NF\_ENDDEF call. In
netCDF-4 files NF\_ENDDEF will be called automatically for any data
read or write. Once enddef has been called, it is impossible to set
the fill for a variable.
`NF_ENOTINDEFINE`
: Not in define mode. This is returned for netCDF classic or 64-bit
offset files, or for netCDF-4 files, when they were been created
with NF\_STRICT\_NC3 flag. (see
[NF\_CREATE](#NF_005fCREATE)).
`NF_EPERM`
: Attempt to create object in read-only file.
Example
-------
6.9 Learn About Fill Parameters for a Variable: `NF_INQ_VAR_FILL`
-----------------------------------------------------------------
The function NF\_INQ\_VAR\_FILL returns the fill settings for a variable
in a netCDF-4 file.
Usage
-----
NF_INQ_VAR_FILL(INTEGER NCID, INTEGER VARID, INTEGER NO_FILL, FILL_VALUE)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`NO_FILL`
: An integer which will get a 1 if no\_fill mode is set for this
variable, and a zero if it is not set
`FILL_VALUE`
: This will get the fill value for this variable. This parameter will
be ignored if it is NULL.
Return Codes
------------
`NF_NOERR`
: No error.
`NF_BADID`
: Bad ncid.
`NF_ENOTNC4`
: Not a netCDF-4 file.
`NF_ENOTVAR`
: Can’t find this variable.
Example
-------
6.10 Define Compression Parameters for a Variable: `NF_DEF_VAR_DEFLATE`
-----------------------------------------------------------------------
The function NF\_DEF\_VAR\_DEFLATE sets the deflate parameters for a
variable in a netCDF-4 file.
When using parallel I/O for writing data, deflate cannot be used. This
is because the compression makes it impossible for the HDF5 library to
exactly map the data to disk location.
(Deflated data can be read with parallel I/O).
NF\_DEF\_VAR\_DEFLATE must be called after the variable is defined, but
before NF\_ENDDEF is called.
Usage
-----
NF_DEF_VAR_DEFLATE(INTEGER NCID, INTEGER VARID, INTEGER SHUFFLE, INTEGER DEFLATE,
INTEGER DEFLATE_LEVEL);
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`SHUFFLE`
: If non-zero, turn on the shuffle filter.
`DEFLATE`
: If non-zero, turn on the deflate filter at the level specified by
the deflate\_level parameter.
`DEFLATE_LEVEL`
: Must be between 0 (no deflate, the default) and 9 (slowest, but
“best” deflate).
If set to zero, no deflation takes place and the def\_var\_deflate
call is ignored. This is slightly different from HDF5 handing of 0
deflate, which turns on the filter but makes only trivial changes to
the data.
Informal testing at NetCDF World Headquartersggests that there is
little to be gained (with the limited set of test data used here),
in setting the deflate level above 2 or 3.
Errors
------
NF\_DEF\_VAR\_DEFLATE returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error.
Possible return codes include:
`NF_NOERR`
: No error.
`NF_BADID`
: Bad ncid.
`NF_ENOTNC4`
: Not a netCDF-4 file.
`NF_ENOTVAR`
: Can’t find this variable.
`NF_ELATEDEF`
: This variable has already been thebject of a NF\_ENDDEF call. In
netCDF-4 files NF\_ENDDEF will be called automatically for any data
read or write. Once enddef has been called, it is impossible to set
the deflate for a variable.
`NF_ENOTINDEFINE`
: Not in define mode. This is returned for netCDF classic or 64-bit
offset files, or for netCDF-4 files, when they were been created
with NF\_STRICT\_NC3 flag. (see
[NF\_CREATE](#NF_005fCREATE)).
`NF_EPERM`
: Attempt to create object in read-only file.
`NF_EINVAL`
: Invalid deflate\_level. The deflate level must be between 0 and 9,
inclusive.
Example
-------
In this example from nf\_test/ftst\_vars.F, a file is created with two
dimensions and one variable. Chunking, deflate, and the fletcher32
filter are turned on. The deflate level is set to 4 below.
C Create the netCDF file.
retval = nf_create(FILE_NAME, NF_NETCDF4, ncid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Define the dimensions.
retval = nf_def_dim(ncid, "x", NX, x_dimid)
if (retval .ne. nf_noerr) call handle_err(retval)
retval = nf_def_dim(ncid, "y", NY, y_dimid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Define the variable.
dimids(1) = y_dimid
dimids(2) = x_dimid
retval = NF_DEF_VAR(ncid, "data", NF_INT, NDIMS, dimids, varid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Turn on chunking.
chunks(1) = NY
chunks(2) = NX
retval = NF_DEF_VAR_CHUNKING(ncid, varid, NF_CHUNKED, chunks)
if (retval .ne. nf_noerr) call handle_err(retval)
C Turn on deflate compression, fletcher32 checm.
retval = NF_DEF_VAR_deflate(ncid, varid, 0, 1, 4)
if (retval .ne. nf_noerr) call handle_err(retval)
retval = NF_DEF_VAR_FLETCHER32(ncid, varid, NF_FLETCHER32)
if (retval .ne. nf_noerr) call handle_err(retval)
6.11 Learn About Deflate Parameters for a Variable: `NF_INQ_VAR_DEFLATE`
------------------------------------------------------------------------
The function NF\_INQ\_VAR\_DEFLATE returns the deflate settings for a
variable in a netCDF-4 file.
It is not necessary to know the deflate settings to read the variable.
(Deflate is completely transparent to readers of the data).
Usage
-----
NF_INQ_VAR_DEFLATE(INTEGER NCID, INTEGER VARID, INTEGER SHUFFLE,
INTEGER DEFLATE, INTEGER DEFLATE_LEVEL);
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`SHUFFLE`
: NF\_INQ\_VAR\_DEFLATE will set this to a 1 if the shuffle filter is
turned on for this variable, and a 0 otherwise.
`DEFLATE`
: NF\_INQ\_VAR\_DEFLATE will set this to a 1 if the deflate filter is
turned on for this variable, and a 0 otherwise.
`DEFLATE_LEVEL`
: NF\_INQ\_VAR\_DEFLATE function will write the deflate\_level here,
if deflate is in use.
Errors
------
NF\_INQ\_VAR\_DEFLATE returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error.
Possible return codes include:
`NF_NOERR`
: No error.
`NF_BADID`
: Bad ncid.
`NF_ENOTNC4`
: Not a netCDF-4 file.
`NF_ENOTVAR`
: Can’t find this variable.
Example
-------
In this example code from nf\_test/ftst\_vars.F, a file with a variable
using deflate is opened, and the deflate level checked.
C Is everything set that ispposed to be?
retval = nf_inq_var_deflate(ncid, varid, shuffle, deflate,
+ deflate_level)
if (retval .ne. nf_noerr) call handle_err(retval)
if (shuffle .ne. 0 .or. deflate .ne. 1 .or.
+ deflate_level .ne. 4) stop 2
6.12 Learn About Szip Parameters for a Variable: `NF_INQ_VAR_SZIP`
------------------------------------------------------------------
The function NF\_INQ\_VAR\_SZIP returns the szip settings for a variable
in a netCDF-4 file.
It is not necessary to know the szip settings to read the variable.
(Szip is completely transparent to readers of the data). But an
Szip compatible library must be installed.
Usage
-----
NF_INQ_VAR_SZIP(INTEGER NCID, INTEGER VARID, INTEGER OPTION_MASK,
PIXELS_PER_BLOCK);
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`OPTION_MASK`
: This will be set to the option\_mask value.
`PIXELS_PER_BLOCK`
: The number of bits per pixel will be put here.
Errors
------
NF\_INQ\_VAR\_SZIP returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error.
Possible return codes include:
`NF_NOERR`
: No error.
`NF_BADID`
: Bad ncid.
`NF_ENOTNC4`
: Not a netCDF-4 file.
`NF_ENOTVAR`
: Can’t find this variable.
6.13 Define Checm Parameters for a Variable: `NF_DEF_VAR_FLETCHER32`
-----------------------------------------------------------------------
The function NF\_DEF\_VAR\_FLETCHER32 sets the checm property for a
variable in a netCDF-4 file.
This function may only be called after the variable is defined, but
before NF\_ENDDEF is called.
Usage
-----
NF_DEF_VAR_FLETCHER32(INTEGER NCID, INTEGER VARID, INTEGER CHECKSUM);
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`CHECKSUM`
: If this is NF\_FLETCHER32, fletcher32 checms will be turned on
for this variable.
Errors
------
NF\_DEF\_VAR\_FLETCHER32 returns the value NF\_NOERR if no errors
occurred. Otherwise, the returned status indicates an error.
Possible return codes include:
`NF_NOERR`
: No error.
`NF_BADID`
: Bad ncid.
`NF_ENOTNC4`
: Not a netCDF-4 file.
`NF_ENOTVAR`
: Can’t find this variable.
`NF_ELATEDEF`
: This variable has already been thebject of a NF\_ENDDEF call. In
netCDF-4 files NF\_ENDDEF will be called automatically for any data
read or write. Once enddef has been called, it is impossible to set
the checm property for a variable.
`NF_ENOTINDEFINE`
: Not in define mode. This is returned for netCDF classic or 64-bit
offset files, or for netCDF-4 files, when they were been created
with NF\_STRICT\_NC3 flag. (see
[NF\_CREATE](#NF_005fCREATE)).
`NF_EPERM`
: Attempt to create object in read-only file.
Example
-------
In this example from nf\_test/ftst\_vars.F, the variable in a file has
the Fletcher32 checm filter turned on.
C Create the netCDF file.
retval = nf_create(FILE_NAME, NF_NETCDF4, ncid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Define the dimensions.
retval = nf_def_dim(ncid, "x", NX, x_dimid)
if (retval .ne. nf_noerr) call handle_err(retval)
retval = nf_def_dim(ncid, "y", NY, y_dimid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Define the variable.
dimids(1) = y_dimid
dimids(2) = x_dimid
retval = NF_DEF_VAR(ncid, "data", NF_INT, NDIMS, dimids, varid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Turn on chunking.
chunks(1) = NY
chunks(2) = NX
retval = NF_DEF_VAR_CHUNKING(ncid, varid, NF_CHUNKED, chunks)
if (retval .ne. nf_noerr) call handle_err(retval)
C Turn on deflate compression, fletcher32 checms.
retval = NF_DEF_VAR_DEFLATE(ncid, varid, 0, 1, 4)
if (retval .ne. nf_noerr) call handle_err(retval)
retval = NF_DEF_VAR_FLETCHER32(ncid, varid, NF_FLETCHER32)
if (retval .ne. nf_noerr) call handle_err(retval)
6.14 Learn About Checm Parameters for a Variable: `NF_INQ_VAR_FLETCHER32`
----------------------------------------------------------------------------
The function NF\_INQ\_VAR\_FLETCHER32 returns the checm settings for
a variable in a netCDF-4 file.
Usage
-----
NF_INQ_VAR_FLETCHER32(INTEGER NCID, INTEGER VARID, INTEGER CHECKSUM);
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`CHECKSUM`
: NF\_INQ\_VAR\_FLETCHER32 will set this to NF\_FLETCHER32 if the
fletcher32 filter is turned on for this variable, and NF\_NOCHECKSUM
if it is not.
Errors
------
NF\_INQ\_VAR\_FLETCHER32 returns the value NF\_NOERR if no errors
occurred. Otherwise, the returned status indicates an error.
Possible return codes include:
`NF_NOERR`
: No error.
`NF_BADID`
: Bad ncid.
`NF_ENOTNC4`
: Not a netCDF-4 file.
`NF_ENOTVAR`
: Can’t find this variable.
Example
-------
In this example from nf\_test/ftst\_vars.F the checm filter is
checked for a file. Since it was turned on for this variable, the
checm variable is set to NF\_FLETCHER32.
retval = nf_inq_var_fletcher32(ncid, varid, checm)
if (retval .ne. nf_noerr) call handle_err(retval)
if (checm .ne. NF_FLETCHER32) stop 2
6.15 Define Endianness of a Variable: `NF_DEF_VAR_ENDIAN`
---------------------------------------------------------
The function NF\_DEF\_VAR\_ENDIAN sets the endianness for a variable in
a netCDF-4 file.
This function must be called after the variable is defined, but before
NF\_ENDDEF is called.
By default, netCDF-4 variables are in native endianness. That is, they
are big-endian on a big-endian machine, and little-endian on a little
endian machine.
In some cases a user might wish to change from native endianness to
either big or little-endianness. This function allows them to do that.
Usage
-----
NF_DEF_VAR_ENDIAN(INTEGER NCID, INTEGER VARID, INTEGER ENDIAN)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`ENDIAN`
: Set to NF\_ENDIAN\_NATIVE for native endianness. (This is the
default). Set to NF\_ENDIAN\_LITTLE for little endian, or
NF\_ENDIAN\_BIG for big endian.
Errors
------
NF\_DEF\_VAR\_ENDIAN returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error.
Possible return codes include:
`NF_NOERR`
: No error.
`NF_BADID`
: Bad ncid.
`NF_ENOTNC4`
: Not a netCDF-4 file.
`NF_ENOTVAR`
: Can’t find this variable.
`NF_ELATEDEF`
: This variable has already been thebject of a NF\_ENDDEF call. In
netCDF-4 files NF\_ENDDEF will be called automatically for any data
read or write. Once enddef has been called, it is impossible to set
the endianness of a variable.
`NF_ENOTINDEFINE`
: Not in define mode. This is returned for netCDF classic or 64-bit
offset files, or for netCDF-4 files, when they were been created
with NF\_STRICT\_NC3 flag, and the file is not in define mode. (see
[NF\_CREATE](#NF_005fCREATE)).
`NF_EPERM`
: Attempt to create object in read-only file.
Example
-------
In this example from nf\_test/ftst\_vars.c, a file is created with one
variable, and its endianness is set to NF\_ENDIAN\_BIG.
C Create the netCDF file.
retval = nf_create(FILE_NAME, NF_NETCDF4, ncid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Define the dimensions.
retval = nf_def_dim(ncid, "x", NX, x_dimid)
if (retval .ne. nf_noerr) call handle_err(retval)
retval = nf_def_dim(ncid, "y", NY, y_dimid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Define the variable.
dimids(1) = y_dimid
dimids(2) = x_dimid
retval = NF_DEF_VAR(ncid, "data", NF_INT, NDIMS, dimids, varid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Turn on chunking.
chunks(1) = NY
chunks(2) = NX
retval = NF_DEF_VAR_chunking(ncid, varid, 0, chunks)
if (retval .ne. nf_noerr) call handle_err(retval)
C Set variable to big-endian (default is whatever is native to
C writing machine).
retval = NF_DEF_VAR_endian(ncid, varid, NF_ENDIAN_BIG)
if (retval .ne. nf_noerr) call handle_err(retval)
6.16 Learn About Endian Parameters for a Variable: `NF_INQ_VAR_ENDIAN`
----------------------------------------------------------------------
The function NF\_INQ\_VAR\_ENDIAN returns the endianness settings for a
variable in a netCDF-4 file.
Usage
-----
NF_INQ_VAR_ENDIAN(INTEGER NCID, INTEGER VARID, INTEGER ENDIAN)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`ENDIAN`
: NF\_INQ\_VAR\_ENDIAN will set this to NF\_ENDIAN\_LITTLE if this
variable is stored in little-endian format, NF\_ENDIAN\_BIG if it is
stored in big-endian format, and NF\_ENDIAN\_NATIVE if the
endianness is not set, and the variable is not created yet.
Errors
------
NF\_INQ\_VAR\_ENDIAN returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error.
Possible return codes include:
`NF_NOERR`
: No error.
`NF_BADID`
: Bad ncid.
`NF_ENOTNC4`
: Not a netCDF-4 file.
`NF_ENOTVAR`
: Can’t find this variable.
Example
-------
In this example from nf\_test/ftst\_vars.F, the endianness of a variable
is checked to makere it is NF\_ENDIAN\_BIG.
retval = nf_inq_var_endian(ncid, varid, endianness)
if (retval .ne. nf_noerr) call handle_err(retval)
if (endianness .ne. NF_ENDIAN_BIG) stop 2
6.17 Define Filter for a Variable: `NF_DEF_VAR_FILTER`
---------------------------------------------------------
The function NF\_DEF\_VAR\_FILTER sets a filter (i.e. compression filter)
for a variable in a netCDF-4 file.
This function must be called after the variable is defined, but before
NF\_ENDDEF is called.
In order to use a custom filter (other than zip or szip), it is necessary
to install the custom filter into some directory and then to specify
the path to that directory by setting the environment variable named
__HDF5_PLUGIN_PATH__. For details, see the netcdf-c library documentation
for filters: https://www.unidata.ucar.edu/software/netcdf/docs/.
Usage
-----
NF_DEF_VAR_FILTER(INTEGER NCID, INTEGER VARID, INTEGER FILTERID, INTEGER NPARAMS, INTEGER PARAMS(*))
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`FILTERID`
: Filter ID.
`NPARAMS`
: Number of parameters expected by the filter.
`PARAMS`
: A vector of integers representing the parameters to the Filter.
Errors
------
NF\_DEF\_VAR\_FILTER returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error.
Possible return codes include:
`NF_NOERR`
: No error.
`NF_BADID`
: Bad ncid.
`NF_ENOTNC4`
: Not a netCDF-4 file.
`NF_ENOTVAR`
: Can’t find this variable.
`NF_ELATEDEF`
: This variable has already been thebject of a NF\_ENDDEF call. In
netCDF-4 files NF\_ENDDEF will be called automatically for any data
read or write. Once enddef has been called, it is impossible to set
the filterness of a variable.
`NF_ENOTINDEFINE`
: Not in define mode. This is returned for netCDF classic or 64-bit
offset files, or for netCDF-4 files, when they were been created
with NF\_STRICT\_NC3 flag, and the file is not in define mode. (see
[NF\_CREATE](#NF_005fCREATE)).
`NF_EFILTER`
: Some kind of error in defining the filter: bad id or parameters or filter library non-existent
Example
-------
In this example from nf\_test/ftst\_vars.c, a file is created with one
variable, and its filter is set to filter id 307 (bzip).
INTEGER(1) params
C Create the netCDF file.
retval = nf_create(FILE_NAME, NF_NETCDF4, ncid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Define the dimensions.
retval = nf_def_dim(ncid, "x", NX, x_dimid)
if (retval .ne. nf_noerr) call handle_err(retval)
retval = nf_def_dim(ncid, "y", NY, y_dimid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Define the variable.
dimids(1) = y_dimid
dimids(2) = x_dimid
retval = NF_DEF_VAR(ncid, "data", NF_INT, NDIMS, dimids, varid)
if (retval .ne. nf_noerr) call handle_err(retval)
C Turn on chunking.
chunks(1) = NY
chunks(2) = NX
retval = NF_DEF_VAR_chunking(ncid, varid, 0, chunks)
if (retval .ne. nf_noerr) call handle_err(retval)
C Set variable filter
retval = NF_DEF_VAR_filter(ncid, varid, 307, 1, params)
if (retval .ne. nf_noerr) call handle_err(retval)
6.18 Learn About Filter Parameters for a Variable: `NF_INQ_VAR_FILTER`
----------------------------------------------------------------------
The function NF\_INQ\_VAR\_FILTER returns the filter settings for a
variable in a netCDF-4 file.
Usage
-----
NF_INQ_VAR_FILTER(INTEGER NCID, INTEGER VARID, INTEGER FILTERID, INTEGER NPARAMS, INTEGER PARAMS(*))
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`FILTERID`
: Filter ID.
`NPARAMS`
: Number of parameters required by the filter.
`PARAMS`
: Parameter values used by the filter.
Errors
------
NF\_INQ\_VAR\_FILTER returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error.
Possible return codes include:
`NF_NOERR`
: No error.
`NF_BADID`
: Bad ncid.
`NF_ENOTNC4`
: Not a netCDF-4 file.
`NF_ENOTVAR`
: Can’t find this variable.
`NF_EFILTER`
: Some kind of error in defining the filter: bad id or parameters or filter library non-existent
Example
-------
In this example from nf\_test/ftst\_vars.F, the filter for a variable
is checked.
integer params(1)
integer filterid, nparams
retval = nf_inq_var_filter(ncid, varid, filterid, nparams, params)
if (retval .ne. nf_noerr) call handle_err(retval)
if (filterid .ne. 307) call handle_err(NF_EFILTER)
if (nparams .ne. 1) call handle_err(NF_EFILTER)
6.19 Get a Variable ID from Its Name: NF\_INQ\_VARID
----------------------------------------------------
The function NF\_INQ\_VARID returns the ID of a netCDF variable, given
its name.
Usage
-----
INTEGER FUNCTION NF_INQ_VARID(INTEGER NCID, CHARACTER*(*) NAME,
INTEGER varid)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`NAME`
: Variable name for which ID is desired.
`varid`
: Returned variable ID.
Errors
------
NF\_INQ\_VARID returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The specified variable name is not a valid name for a variable in
the specified netCDF dataset.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_INQ\_VARID to find out the ID of a variable
named rh in an existing netCDF dataset named foo.nc:
INCLUDE 'netcdf.inc'
...
INTEGER STATUS, NCID, RHID
...
STATUS = NF_OPEN ('foo.nc', NF_NOWRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID (NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
6.20 Get Information about a Variable from Its ID: NF\_INQ\_VAR family
----------------------------------------------------------------------
A family of functions that returns information about a netCDF variable,
given its ID. Information about a variable includes its name, type,
number of dimensions, a list of dimension IDs describing the shape of
the variable, and the number of variable attributes that have been
assigned to the variable.
The function NF\_INQ\_VAR returns all the information about a netCDF
variable, given its ID. The other functions each return just one item of
information about a variable.
These other functions include NF\_INQ\_VARNAME, NF\_INQ\_VARTYPE,
NF\_INQ\_VARNDIMS, NF\_INQ\_VARDIMID, and NF\_INQ\_VARNATTS.
Usage
-----
INTEGER FUNCTION NF_INQ_VAR (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) name, INTEGER xtype,
INTEGER ndims, INTEGER dimids(*),
INTEGER natts)
INTEGER FUNCTION NF_INQ_VARNAME (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) name)
INTEGER FUNCTION NF_INQ_VARTYPE (INTEGER NCID, INTEGER VARID,
INTEGER xtype)
INTEGER FUNCTION NF_INQ_VARNDIMS (INTEGER NCID, INTEGER VARID,
INTEGER ndims)
INTEGER FUNCTION NF_INQ_VARDIMID (INTEGER NCID, INTEGER VARID,
INTEGER dimids(*))
INTEGER FUNCTION NF_INQ_VARNATTS (INTEGER NCID, INTEGER VARID,
INTEGER natts)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`NAME`
: Returned variable name. The caller must allocate space for the
returned name. The maximum possible length, in characters, of a
variable name is given by the predefined constant NF\_MAX\_NAME.
`xtype`
: Returned variable type, one of the set of predefined netCDF external
data types. The type of this parameter, NF\_TYPE, is defined in the
netCDF header file. The valid netCDF external data types are
NF\_BYTE, NF\_CHAR, NF\_SHORT, NF\_INT, NF\_FLOAT, AND NF\_DOUBLE.
`ndims`
: Returned number of dimensions the variable was defined as using. For
example, 2 indicates a matrix, 1 indicates a vector, and 0 means the
variable is a scalar with no dimensions.
`dimids`
: Returned vector of \*ndimsp dimension IDs corresponding to the
variable dimensions. The caller must allocate enough space for a
vector of at least \*ndimsp integers to be returned. The maximum
possible number of dimensions for a variable is given by the
predefined constant NF\_MAX\_VAR\_DIMS.
`natts`
: Returned number of variable attributes assigned to this variable.
These functions return the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The variable ID is invalid for the specified netCDF dataset.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_INQ\_VAR to find out about a variable named
rh in an existing netCDF dataset named foo.nc:
INCLUDE 'netcdf.inc'
...
INTEGER STATUS, NCID
INTEGER RHID ! variable ID
CHARACTER*31 RHNAME ! variable name
INTEGER RHTYPE ! variable type
INTEGER RHN ! number of dimensions
INTEGER RHDIMS(NF_MAX_VAR_DIMS) ! variable shape
INTEGER RHNATT ! number of attributes
...
STATUS = NF_OPEN ('foo.nc', NF_NOWRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID (NCID, 'rh', RHID) ! get ID
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_INQ_VAR (NCID, RHID, RHNAME, RHTYPE, RHN, RHDIMS, RHNATT)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
6.21 Write a Single Data Value: NF\_PUT\_VAR1\_ type
----------------------------------------------------
The functions NF\_PUT\_VAR1\_type (for various types) put a single data
value of the specified type into a variable of an open netCDF dataset
that is in data mode. Inputs are the netCDF ID, the variable ID, an
index that specifies which value to add or alter, and the data value.
The value is converted to the external data type of the variable, if
necessary.
Usage
-----
INTEGER FUNCTION NF_PUT_VAR1_TEXT(INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), CHARACTER CHVAL)
INTEGER FUNCTION NF_PUT_VAR1_INT1(INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), INTEGER*1 I1VAL)
INTEGER FUNCTION NF_PUT_VAR1_INT2(INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), INTEGER*2 I2VAL)
INTEGER FUNCTION NF_PUT_VAR1_INT (INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), INTEGER IVAL)
INTEGER FUNCTION NF_PUT_VAR1_INT64(INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), INTEGER*8 I8VAL)
INTEGER FUNCTION NF_PUT_VAR1_REAL(INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), REAL RVAL)
INTEGER FUNCTION NF_PUT_VAR1_DOUBLE(INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), DOUBLE DVAL)
INTEGER FUNCTION NF_PUT_VAR1(INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), *)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`INDEX`
: The index of the data value to be written. The indices are relative
to 1, so for example, the first data value of a two-dimensional
variable would have index (1,1). The elements of index must
correspond to the variable’s dimensions. Hence, if the variable uses
the unlimited dimension, the last index would correspond to the
record number.
`CHVAL`\
`I1VAL`\
`I2VAL`\
`IVAL`\
`I8VAL`\
`RVAL`\
`DVAL`
: Pointer to the data value to be written. If the type of data values
differs from the netCDF variable type, type conversion will occur.
See [(netcdf)Type Conversion](netcdf.html#Type-Conversion)
‘Type Conversion’ in The NetCDF Users Guide.
Errors
------
NF\_PUT\_VAR1\_ type returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The variable ID is invalid for the specified netCDF dataset.
- The specified indices were out of range for the rank of the
specified variable. For example, a negative index or an index that
is larger than the corresponding dimension length will cause an
error.
- The specified value is out of the range of values representable by
the external data type of the variable.
- The specified netCDF is in define mode rather than data mode.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_PUT\_VAR1\_DOUBLE to set the (4,3,2)
element of the variable named rh to 0.5 in an existing netCDF dataset
named foo.nc. For simplicity in this example, we ame that we know
that rh is dimensioned with lon, lat, and time, so we want to set the
value of rh that corresponds to the fourth lon value, the third lat
value, and the second time value:
INCLUDE 'netcdf.inc'
...
INTEGER STATUS ! error status
INTEGER NCID
INTEGER RHID ! variable ID
INTEGER RHINDX(3) ! where to put value
DATA RHINDX /4, 3, 2/
...
STATUS = NF_OPEN ('foo.nc', NF_WRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID (NCID, 'rh', RHID) ! get ID
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_PUT_VAR1_DOUBLE (NCID, RHID, RHINDX, 0.5)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
6.22 Write an Entire Variable: NF\_PUT\_VAR\_ type
--------------------------------------------------
The NF\_PUT\_VAR\_ type family of functions write all the values of a
variable into a netCDF variable of an open netCDF dataset. This is the
simplest interface to use for writing a value in a scalar variable or
whenever all the values of a multidimensional variable can all be
written at once. The values to be written are associated with the netCDF
variable by aming that the last dimension of the netCDF variable
varies fastest in the C interface. The values are converted to the
external data type of the variable, if necessary.
Take care when using the simplest forms of this interface with record
variables (variables that use the NF\_UNLIMITED dimension) when you
don’t specify how many records are to be written. If you try to write
all the values of a record variable into a netCDF file that has no
record data yet (hence has 0 records), nothing will be written.
Similarly, if you try to write all the values of a record variable from
an array but there are more records in the file than you ame, more
in-memory data will be accessed than you expect, which may cause a
segmentation violation. To avoidch problems, it is better to use the
NF\_PUT\_VARA\_type interfaces for variables that use the NF\_UNLIMITED
dimension. See [Write an Array of Values: NF\_PUT\_VARA\_
type](#NF_005fPUT_005fVARA_005f-type).
Usage
-----
INTEGER FUNCTION NF_PUT_VAR_TEXT (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) TEXT)
INTEGER FUNCTION NF_PUT_VAR_INT1 (INTEGER NCID, INTEGER VARID,
INTEGER*1 I1VALS(*))
INTEGER FUNCTION NF_PUT_VAR_INT2 (INTEGER NCID, INTEGER VARID,
INTEGER*2 I2VALS(*))
INTEGER FUNCTION NF_PUT_VAR_INT (INTEGER NCID, INTEGER VARID,
INTEGER IVALS(*))
INTEGER FUNCTION NF_PUT_VAR_INT64 (INTEGER NCID, INTEGER VARID,
INTEGER*8 I8VALS(*))
INTEGER FUNCTION NF_PUT_VAR_REAL (INTEGER NCID, INTEGER VARID,
REAL RVALS(*))
INTEGER FUNCTION NF_PUT_VAR_DOUBLE(INTEGER NCID, INTEGER VARID,
DOUBLE DVALS(*))
INTEGER FUNCTION NF_PUT_VAR (INTEGER NCID, INTEGER VARID,
VALS(*))
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`TEXT`\
`I1VALS`\
`I2VALS`\
`IVALS`\
`I8VALS`\
`RVALS`\
`DVALS`\
`VALS`
: The block of data values to be written. The data should be of the
type appropriate for the function called. You cannot put CHARACTER
data into a numeric variable or numeric data into a text variable.
For numeric data, if the type of data differs from the netCDF
variable type, type conversion will occur (see [(netcdf)Type
Conversion](netcdf.html#Type-Conversion) ‘Type Conversion’
in The NetCDF Users Guide). The order in which the data will be
written into the specified variable is with the first dimension
varying fastest (like the ordinary FORTRAN convention).
Errors
------
Members of the NF\_PUT\_VAR\_ type family return the value NF\_NOERR if
no errors occurred. Otherwise, the returned status indicates an error.
Possible causes of errors include:
- The variable ID is invalid for the specified netCDF dataset.
- One or more of the specified values are out of the range of values
representable by the external data type of the variable.
- One or more of the specified values are out of the range of values
representable by the external data type of the variable.
- The specified netCDF dataset is in define mode rather than data
mode.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_PUT\_VAR\_DOUBLE to add or change all the
values of the variable named rh to 0.5 in an existing netCDF dataset
named foo.nc. For simplicity in this example, we ame that we know
that rh is dimensioned with lon and lat, and that there are ten lon
values and five lat values.
INCLUDE 'netcdf.inc'
...
PARAMETER (LATS=5, LONS=10) ! dimension lengths
INTEGER STATUS, NCID
INTEGER RHID ! variable ID
DOUBLE RHVALS(LONS, LATS)
...
STATUS = NF_OPEN ('foo.nc', NF_WRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID (NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
DO 10 ILON = 1, LONS
DO 10 ILAT = 1, LATS
RHVALS(ILON, ILAT) = 0.5
10 CONTINUE
STATUS = NF_PUT_var_DOUBLE (NCID, RHID, RHVALS)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
6.23 Write an Array of Values: NF\_PUT\_VARA\_ type
---------------------------------------------------
The function NF\_PUT\_VARA\_ type writes values into a netCDF variable
of an open netCDF dataset. The part of the netCDF variable to write is
specified by giving a corner and a vector of edge lengths that refer to
an array of the netCDF variable. The values to be written are
associated with the netCDF variable by aming that the first dimension
of the netCDF variable varies fastest in the FORTRAN interface. The
netCDF dataset must be in data mode.
Usage
-----
INTEGER FUNCTION NF_PUT_VARA_TEXT(INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
CHARACTER*(*) TEXT)
INTEGER FUNCTION NF_PUT_VARA_INT1(INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER*1 I1VALS(*))
INTEGER FUNCTION NF_PUT_VARA_INT2(INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER*2 I2VALS(*))
INTEGER FUNCTION NF_PUT_VARA_INT (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER IVALS(*))
INTEGER FUNCTION NF_PUT_VARA_INT64(INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER*8 I8VALS(*))
INTEGER FUNCTION NF_PUT_VARA_REAL(INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
REAL RVALS(*))
INTEGER FUNCTION NF_PUT_VARA_DOUBLE(INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
DOUBLE DVALS(*))
INTEGER FUNCTION NF_PUT_VARA (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
VALS(*))
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`START`
: A vector of integers specifying the index in the variable where the
first of the data values will be written. The indices are relative
to 1, so for example, the first data value of a variable would have
index (1, 1, ..., 1). The length of START must be the same as the
number of dimensions of the specified variable. The elements of
START must correspond to the variable’s dimensions in order. Hence,
if the variable is a record variable, the last index would
correspond to the starting record number for writing the data
values.
`COUNT`
: A vector of integers specifying the edge lengths along each
dimension of the block of data values to written. To write a single
value, for example, specify COUNT as (1, 1, ..., 1). The length of
COUNT is the number of dimensions of the specified variable. The
elements of COUNT correspond to the variable’s dimensions. Hence, if
the variable is a record variable, the last element of COUNT
corresponds to a count of the number of records to write.
Note: setting any element of the count array to zero causes the
function to exit without error, and without doing anything.
`TEXT`\
`I1VALS`\
`I2VALS`\
`IVALS`\
`I8VALS`\
`RVALS`\
`DVALS`\
`VALS`
: The block of data values to be written. The data should be of the
type appropriate for the function called. You cannot put CHARACTER
data into a numeric variable or numeric data into a text variable.
For numeric data, if the type of data differs from the netCDF
variable type, type conversion will occur (see [(netcdf)Type
Conversion](netcdf.html#Type-Conversion) ‘Type Conversion’
in The NetCDF Users Guide).
Errors
------
NF\_PUT\_VARA\_ type returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The variable ID is invalid for the specified netCDF dataset.
- The specified corner indices were out of range for the rank of the
specified variable. For example, a negative index, or an index that
is larger than the corresponding dimension length will cause an
error.
- The specified edge lengths added to the specified corner would have
referenced data out of range for the rank of the specified variable.
For example, an edge length that is larger than the corresponding
dimension length minus the corner index will cause an error.
- One or more of the specified values are out of the range of values
representable by the external data type of the variable.
- The specified netCDF dataset is in define mode rather than data
mode.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_PUT\_VARA\_DOUBLE to add or change all the
values of the variable named rh to 0.5 in an existing netCDF dataset
named foo.nc. For simplicity in this example, we ame that we know
that rh is dimensioned with time, lat, and lon, and that there are three
time values, five lat values, and ten lon values.
INCLUDE 'netcdf.inc'
...
PARAMETER (NDIMS=3) ! number of dimensions
PARAMETER (TIMES=3, LATS=5, LONS=10) ! dimension lengths
INTEGER STATUS, NCID, TIMES
INTEGER RHID ! variable ID
INTEGER START(NDIMS), COUNT(NDIMS)
DOUBLE RHVALS(LONS, LATS, TIMES)
DATA START /1, 1, 1/ ! start at first value
DATA COUNT /LONS, LATS, TIMES/
...
STATUS = NF_OPEN ('foo.nc', NF_WRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID (NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
DO 10 ILON = 1, LONS
DO 10 ILAT = 1, LATS
DO 10 ITIME = 1, TIMES
RHVALS(ILON, ILAT, ITIME) = 0.5
10 CONTINUE
STATUS = NF_PUT_VARA_DOUBLE (NCID, RHID, START, COUNT, RHVALS)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
6.24 NF\_PUT\_VARS\_ type
-------------------------
Each member of the family of functions NF\_PUT\_VARS\_ type writes a
subsampled (strided) array of values into a netCDF variable of
an open netCDF dataset. Thebsampled array is specified by
giving a corner, a vector of counts, and a stride vector. The netCDF
dataset must be in data mode.
Usage
-----
INTEGER FUNCTION NF_PUT_VARS_TEXT (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*),CHARACTER*(*) TEXT)
INTEGER FUNCTION NF_PUT_VARS_INT1 (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*),INTEGER*1 I1VALS(*))
INTEGER FUNCTION NF_PUT_VARS_INT2 (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*),INTEGER*2 I2VALS(*))
INTEGER FUNCTION NF_PUT_VARS_INT (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER IVALS(*))
INTEGER FUNCTION NF_PUT_VARS_INT64 (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER*8 I8VALS(*))
INTEGER FUNCTION NF_PUT_VARS_REAL (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), REAL RVALS(*))
INTEGER FUNCTION NF_PUT_VARS_DOUBLE(INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), DOUBLE DVALS(*))
INTEGER FUNCTION NF_PUT_VARS (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), VALS(*))
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`START`
: A vector of integers specifying the index in the variable where the
first of the data values will be written. The indices are relative
to 1, so for example, the first data value of a variable would have
index (1, 1, ..., 1). The elements of START correspond, in order, to
the variable’s dimensions. Hence, if the variable is a record
variable, the last index would correspond to the starting record
number for writing the data values.
`COUNT`
: A vector of integers specifying the number of indices selected along
each dimension. To write a single value, for example, specify COUNT
as (1, 1, ..., 1). The elements of COUNT correspond, in order, to
the variable’s dimensions. Hence, if the variable is a record
variable, the last element of COUNT corresponds to a count of the
number of records to write.
Note: setting any element of the count array to zero causes the
function to exit without error, and without doing anything.
`STRIDE`
: A vector of integers that specifies the sampling interval along each
dimension of the netCDF variable. The elements of the stride vector
correspond, in order, to the netCDF variable’s dimensions (STRIDE(1)
gives the sampling interval along the most rapidly varying dimension
of the netCDF variable). Sampling intervals are specified in
type-independent units of elements (a value of 1 selects consecutive
elements of the netCDF variable along the corresponding dimension, a
value of 2 selects every other element, etc.).
`TEXT`\
`I1VALS`\
`I2VALS`\
`IVALS`\
`I8VALS`\
`RVALS`\
`DVALS`\
`VALS`
: The block of data values to be written. The data should be of the
type appropriate for the function called. You cannot put CHARACTER
data into a numeric variable or numeric data into a text variable.
For numeric data, if the type of data differs from the netCDF
variable type, type conversion will occur (see [(netcdf)Type
Conversion](netcdf.html#Type-Conversion) ‘Type Conversion’
in The NetCDF Users Guide).
Errors
------
NF\_PUT\_VARS\_ type returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The variable ID is invalid for the specified netCDF dataset.
- The specified start, count and stride generate an index which is out
of range.
- One or more of the specified values are out of the range of values
representable by the external data type of the variable.
- The specified netCDF is in define mode rather than data mode.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example of using NF\_PUT\_VARS\_REAL to write – from an
internal array – every other point of a netCDF variable named rh which
is described by the FORTRAN declaration REAL RH(6,4) (note the size of
the dimensions):
INCLUDE 'netcdf.inc'
...
PARAMETER (NDIM=2) ! rank of netCDF variable
INTEGER NCID ! netCDF dataset ID
INTEGER STATUS ! return code
INTEGER RHID ! variable ID
INTEGER START(NDIM) ! netCDF variable start point
INTEGER COUNT(NDIM) ! size of internal array
INTEGER STRIDE(NDIM) ! netCDF variablebsampling intervals
REAL RH(3,2) ! notebsampled sizes for netCDF variable
! dimensions
DATA START /1, 1/ ! start at first netCDF variable value
DATA COUNT /3, 2/ ! size of internal array: entire bsampled)
! netCDF variable
DATA STRIDE /2, 2/ ! access every other netCDF element
...
STATUS = NF_OPEN('foo.nc', NF_WRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID(NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_PUT_VARS_REAL(NCID, RHID, START, COUNT, STRIDE, RH)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
6.25 NF\_PUT\_VARM\_ type
-------------------------
The NF\_PUT\_VARM\_ type family of functions writes a mapped array
section of values into a netCDF variable of an open netCDF dataset. The
mapped array is specified by giving a corner, a vector of
counts, a stride vector, and an index mapping vector. The index mapping
vector is a vector of integers that specifies the mapping between the
dimensions of a netCDF variable and the in-memory structure of the
internal data array. No amptions are made about the ordering or
length of the dimensions of the data array. The netCDF dataset must be
in data mode.
Usage
-----
INTEGER FUNCTION NF_PUT_VARM_TEXT (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER IMAP(*),
CHARACTER*(*) TEXT)
INTEGER FUNCTION NF_PUT_VARM_INT1 (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER IMAP(*),
INTEGER*1 I1VALS(*))
INTEGER FUNCTION NF_PUT_VARM_INT2 (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER IMAP(*),
INTEGER*2 I2VALS(*))
INTEGER FUNCTION NF_PUT_VARM_INT (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER IMAP(*),
INTEGER IVALS(*))
INTEGER FUNCTION NF_PUT_VARM_INT64 (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER IMAP(*),
INTEGER*8 I8VALS(*))
INTEGER FUNCTION NF_PUT_VARM_REAL (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER IMAP(*),
REAL RVALS(*))
INTEGER FUNCTION NF_PUT_VARM_DOUBLE(INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER IMAP(*),
DOUBLE DVALS(*))
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`START`
: A vector of integers specifying the index in the variable where the
first of the data values will be written. The indices are relative
to 1, so for example, the first data value of a variable would have
index (1, 1, ..., 1). The elements of START correspond, in order, to
the variable’s dimensions. Hence, if the variable is a record
variable, the last index would correspond to the starting record
number for writing the data values.
`COUNT`
: A vector of integers specifying the number of indices selected along
each dimension. To write a single value, for example, specify COUNT
as (1, 1, ..., 1). The elements of COUNT correspond, in order, to
the variable’s dimensions. Hence, if the variable is a record
variable, the last element of COUNT corresponds to a count of the
number of records to write.
Note: setting any element of the count array to zero causes the
function to exit without error, and without doing anything.
`STRIDE`
: A vector of integers that specifies the sampling interval along each
dimension of the netCDF variable. The elements of the stride vector
correspond, in order, to the netCDF variable’s dimensions (STRIDE(1)
gives the sampling interval along the most rapidly varying dimension
of the netCDF variable). Sampling intervals are specified in
type-independent units of elements (a value of 1 selects consecutive
elements of the netCDF variable along the corresponding dimension, a
value of 2 selects every other element, etc.).
`IMAP`
: A vector of integers that specifies the mapping between the
dimensions of a netCDF variable and the in-memory structure of the
internal data array. The elements of the index mapping vector
correspond, in order, to the netCDF variable’s dimensions (IMAP(1)
gives the distance between elements of the internal array
corresponding to the most rapidly varying dimension of the netCDF
variable). Distances between elements are specified in units of
elements (the distance between internal elements that occupy
adjacent memory locations is 1 and not the element’s byte-length as
in netCDF 2).
`TEXT`\
`I1VALS`\
`I2VALS`\
`IVALS`\
`I8VALS`\
`RVALS`\
`DVALS`
: The data values to be written. The data should be of the type
appropriate for the function called. You cannot put CHARACTER data
into a numeric variable or numeric data into a text variable. For
numeric data, if the type of data differs from the netCDF variable
type, type conversion will occur (see [(netcdf)Type
Conversion](netcdf.html#Type-Conversion) ‘Type Conversion’
in The NetCDF Users Guide).
Errors
------
NF\_PUT\_VARM\_ type returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The variable ID is invalid for the specified netCDF dataset.
- The specified START, COUNT, and STRIDE generate an index which is
out of range. Note that no error checking is possible on the imap
vector.
- One or more of the specified values are out of the range of values
representable by the external data type of the variable.
- The specified netCDF is in define mode rather than data mode.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
The following IMAP vector maps in the trivial way a 2x3x4 netCDF
variable and an internal array of the same shape:
REAL A(2,3,4) ! same shape as netCDF variable
INTEGER IMAP(3)
DATA IMAP /1, 2, 6/ ! netCDF dimension inter-element distance
! ---------------- ----------------------
! most rapidly varying 1
! intermediate 2 (=IMAP(1)*2)
! most slowly varying 6 (=IMAP(2)*3)
Using the IMAP vector above with NF\_PUT\_VARM\_REAL obtains the same
rlt as simply using NF\_PUT\_VAR\_REAL.
Here is an example of using NF\_PUT\_VARM\_REAL to write – from a
transposed, internal array – a netCDF variable named rh which is
described by the FORTRAN declaration REAL RH(4,6) (note the size and
order of the dimensions):
INCLUDE 'netcdf.inc'
...
PARAMETER (NDIM=2) ! rank of netCDF variable
INTEGER NCID ! netCDF ID
INTEGER STATUS ! return code
INTEGER RHID ! variable ID
INTEGER START(NDIM) ! netCDF variable start point
INTEGER COUNT(NDIM) ! size of internal array
INTEGER STRIDE(NDIM) ! netCDF variablebsampling intervals
INTEGER IMAP(NDIM) ! internal array inter-element distances
REAL RH(6,4) ! note transposition of netCDF variable dimensions
DATA START /1, 1/ ! start at first netCDF variable element
DATA COUNT /4, 6/ ! entire netCDF variable; order corresponds
! to netCDF variable -- not internal array
DATA STRIDE /1, 1/ ! sample every netCDF element
DATA IMAP /6, 1/ ! would be /1, 4/ if not transposing
STATUS = NF_OPEN('foo.nc', NF_WRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID(NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_PUT_VARM_REAL(NCID, RHID, START, COUNT, STRIDE, IMAP, RH)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
Here is another example of using NF\_PUT\_VARM\_REAL to write – from a
transposed, internal array – absample of the same netCDF variable, by
writing every other point of the netCDF variable:
INCLUDE 'netcdf.inc'
...
PARAMETER (NDIM=2) ! rank of netCDF variable
INTEGER NCID ! netCDF dataset ID
INTEGER STATUS ! return code
INTEGER RHID ! variable ID
INTEGER START(NDIM) ! netCDF variable start point
INTEGER COUNT(NDIM) ! size of internal array
INTEGER STRIDE(NDIM) ! netCDF variablebsampling intervals
INTEGER IMAP(NDIM) ! internal array inter-element distances
REAL RH(3,2) ! note transposition of bsampled) dimensions
DATA START /1, 1/ ! start at first netCDF variable value
DATA COUNT /2, 3/ ! order of bsampled) dimensions corresponds
! to netCDF variable -- not internal array
DATA STRIDE /2, 2/ ! sample every other netCDF element
DATA IMAP /3, 1/ ! would be `1, 2' if not transposing
...
STATUS = NF_OPEN('foo.nc', NF_WRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID(NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_PUT_VARM_REAL(NCID, RHID, START, COUNT, STRIDE, IMAP, RH)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
6.26 NF\_GET\_VAR1\_ type
-------------------------
The functions NF\_GET\_VAR1\_ type get a single data value from a
variable of an open netCDF dataset that is in data mode. Inputs are the
netCDF ID, the variable ID, a multidimensional index that specifies
which value to get, and the address of a location into which the data
value will be read. The value is converted from the external data type
of the variable, if necessary.
Usage
-----
INTEGER FUNCTION NF_GET_VAR1_TEXT(INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), CHARACTER CHVAL)
INTEGER FUNCTION NF_GET_VAR1_INT1(INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), INTEGER*1 I1VAL)
INTEGER FUNCTION NF_GET_VAR1_INT2(INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), INTEGER*2 I2VAL)
INTEGER FUNCTION NF_GET_VAR1_INT (INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), INTEGER IVAL)
INTEGER FUNCTION NF_GET_VAR1_INT64 (INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), INTEGER*8 I8VAL)
INTEGER FUNCTION NF_GET_VAR1_REAL(INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), REAL RVAL)
INTEGER FUNCTION NF_GET_VAR1_DOUBLE(INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), DOUBLE DVAL)
INTEGER FUNCTION NF_GET_VAR1(INTEGER NCID, INTEGER VARID,
INTEGER INDEX(*), VAL)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`INDEX`
: The index of the data value to be read. The indices are relative to
1, so for example, the first data value of a two-dimensional
variable has index (1,1). The elements of index correspond to the
variable’s dimensions. Hence, if the variable is a record variable,
the last index is the record number.
`CHVAL`\
`I1VAL`\
`I2VAL`\
`IVAL`\
`I8VAL`\
`RVAL`\
`DVAL`\
`VAL`
: The location into which the data value will be read. You cannot get
CHARACTER data from a numeric variable or numeric data from a
character variable. For numeric data, if the type of data differs
from the netCDF variable type, type conversion will occur. (see
[(netcdf)Type Conversion](netcdf.html#Type-Conversion) ‘Type
Conversion’ in The NetCDF Users Guide).
Errors
------
NF\_GET\_VAR1\_ type returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The variable ID is invalid for the specified netCDF dataset.
- The specified indices were out of range for the rank of the
specified variable. For example, a negative index or an index that
is larger than the corresponding dimension length will cause an
error.
- The value is out of the range of values representable by the desired
data type.
- The specified netCDF is in define mode rather than data mode.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_GET\_VAR1\_DOUBLE to get the (4,3,2)
element of the variable named rh in an existing netCDF dataset named
foo.nc. For simplicity in this example, we ame that we know that rh
is dimensioned with lon, lat, and time, so we want to get the value of
rh that corresponds to the fourth lon value, the third lat value, and
the second time value:
INCLUDE 'netcdf.inc'
...
INTEGER STATUS, NCID
INTEGER RHID ! variable ID
INTEGER RHINDX(3) ! where to get value
DOUBLE PRECISION RHVAL ! put it here
DATA RHINDX /4, 3, 2/
...
STATUS = NF_OPEN ('foo.nc', NF_NOWRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID (NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_GET_VAR1_DOUBLE (NCID, RHID, RHINDX, RHVAL)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
6.27 NF\_GET\_VAR\_ type
------------------------
The members of the NF\_GET\_VAR\_ type family of functions read all the
values from a netCDF variable of an open netCDF dataset. This is the
simplest interface to use for reading the value of a scalar variable or
when all the values of a multidimensional variable can be read at once.
The values are read into consecutive locations with the first dimension
varying fastest. The netCDF dataset must be in data mode.
Take care when using the simplest forms of this interface with record
variables (variables that use the NF\_UNLIMITED dimension) when you
don’t specify how many records are to be read. If you try to read all
the values of a record variable into an array but there are more records
in the file than you ame, more data will be read than you expect,
which may cause a segmentation violation. To avoidch problems, it is
better to use the NF\_GET\_VARA\_type interfaces for variables that use
the NF\_UNLIMITED dimension. See [NF\_GET\_VARA\_
type](#NF_005fGET_005fVARA_005f-type).
Usage
-----
INTEGER FUNCTION NF_GET_VAR_TEXT (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) text)
INTEGER FUNCTION NF_GET_VAR_INT1 (INTEGER NCID, INTEGER VARID,
INTEGER*1 i1vals(*))
INTEGER FUNCTION NF_GET_VAR_INT2 (INTEGER NCID, INTEGER VARID,
INTEGER*2 i2vals(*))
INTEGER FUNCTION NF_GET_VAR_INT (INTEGER NCID, INTEGER VARID,
INTEGER ivals(*))
INTEGER FUNCTION NF_GET_VAR_INT64 (INTEGER NCID, INTEGER VARID,
INTEGER*8 i8vals(*))
INTEGER FUNCTION NF_GET_VAR_REAL (INTEGER NCID, INTEGER VARID,
REAL rvals(*))
INTEGER FUNCTION NF_GET_VAR_DOUBLE(INTEGER NCID, INTEGER VARID,
DOUBLE dvals(*))
INTEGER FUNCTION NF_GET_VAR (INTEGER NCID, INTEGER VARID,
vals(*))
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`TEXT`\
`I1VALS`\
`I2VALS`\
`IVALS`\
`I8VALS`\
`RVALS`\
`DVALS`\
`VALS`
: The block of data values to be read. The data should be of the type
appropriate for the function called. You cannot read CHARACTER data
from a numeric variable or numeric data from a text variable. For
numeric data, if the type of data differs from the netCDF variable
type, type conversion will occur (see [(netcdf)Type
Conversion](netcdf.html#Type-Conversion) ‘Type Conversion’
in The NetCDF Users Guide).
Errors
------
NF\_GET\_VAR\_ type returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The variable ID is invalid for the specified netCDF dataset.
- One or more of the values are out of the range of values
representable by the desired type.
- The specified netCDF is in define mode rather than data mode.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_GET\_VAR\_DOUBLE to read all the values of
the variable named rh from an existing netCDF dataset named foo.nc. For
simplicity in this example, we ame that we know that rh is
dimensioned with lon and lat, and that there are ten lon values and five
lat values.
INCLUDE 'netcdf.inc'
...
PARAMETER (LATS=5, LONS=10) ! dimension lengths
INTEGER STATUS, NCID
INTEGER RHID ! variable ID
DOUBLE RHVALS(LONS, LATS)
...
STATUS = NF_OPEN ('foo.nc', NF_NOWRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID (NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_GET_VAR_DOUBLE (NCID, RHID, RHVALS)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
6.28 NF\_GET\_VARA\_ type
-------------------------
The members of the NF\_GET\_VARA\_ type family of functions read an
array of values from a netCDF variable of an open netCDF dataset. The
array is specified by giving a corner and a vector of edge lengths. The
values are read into consecutive locations with the first dimension
varying fastest. The netCDF dataset must be in data mode.
Usage
-----
INTEGER FUNCTION NF_GET_VARA_TEXT(INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
CHARACTER*(*) text)
INTEGER FUNCTION NF_GET_VARA_INT1(INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER*1 i1vals(*))
INTEGER FUNCTION NF_GET_VARA_INT2(INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER*2 i2vals(*))
INTEGER FUNCTION NF_GET_VARA_INT (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER ivals(*))
INTEGER FUNCTION NF_GET_VARA_INT64 (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER*8 i8vals(*))
INTEGER FUNCTION NF_GET_VARA_REAL(INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
REAL rvals(*))
INTEGER FUNCTION NF_GET_VARA_DOUBLE(INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
DOUBLE dvals(*))
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`START`
: A vector of integers specifying the index in the variable where the
first of the data values will be read. The indices are relative to
1, so for example, the first data value of a variable would have
index (1, 1, ..., 1). The length of START must be the same as the
number of dimensions of the specified variable. The elements of
START correspond, in order, to the variable’s dimensions. Hence, if
the variable is a record variable, the last index would correspond
to the starting record number for reading the data values.
`COUNT`
: A vector of integers specifying the edge lengths along each
dimension of the block of data values to be read. To read a single
value, for example, specify COUNT as (1, 1, ..., 1). The length of
COUNT is the number of dimensions of the specified variable. The
elements of COUNT correspond, in order, to the variable’s
dimensions. Hence, if the variable is a record variable, the last
element of COUNT corresponds to a count of the number of records to
read.
Note: setting any element of the count array to zero causes the
function to exit without error, and without doing anything.
`text`\
`i1vals`\
`i2vals`\
`ivals`\
`i8vals`\
`rvals`\
`dvals`
: The block of data values to be read. The data should be of the type
appropriate for the function called. You cannot read CHARACTER data
from a numeric variable or numeric data from a text variable. For
numeric data, if the type of data differs from the netCDF variable
type, type conversion will occur (see [(netcdf)Type
Conversion](netcdf.html#Type-Conversion) ‘Type Conversion’
in The NetCDF Users Guide).
Errors
------
NF\_GET\_VARA\_ type returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The variable ID is invalid for the specified netCDF dataset.
- The specified corner indices were out of range for the rank of the
specified variable. For example, a negative index or an index that
is larger than the corresponding dimension length will cause an
error.
- The specified edge lengths added to the specified corner would have
referenced data out of range for the rank of the specified variable.
For example, an edge length that is larger than the corresponding
dimension length minus the corner index will cause an error.
- One or more of the values are out of the range of values
representable by the desired type.
- The specified netCDF is in define mode rather than data mode.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_GET\_VARA\_DOUBLE to read all the values of
the variable named rh from an existing netCDF dataset named foo.nc. For
simplicity in this example, we ame that we know that rh is
dimensioned with lon, lat, and time, and that there are ten lon values,
five lat values, and three time values.
INCLUDE 'netcdf.inc'
...
PARAMETER (NDIMS=3) ! number of dimensions
PARAMETER (TIMES=3, LATS=5, LONS=10) ! dimension lengths
INTEGER STATUS, NCID
INTEGER RHID ! variable ID
INTEGER START(NDIMS), COUNT(NDIMS)
DOUBLE RHVALS(LONS, LATS, TIMES)
DATA START /1, 1, 1/ ! start at first value
DATA COUNT /LONS, LATS, TIMES/ ! get all the values
...
STATUS = NF_OPEN ('foo.nc', NF_NOWRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID (NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_GET_VARA_DOUBLE (NCID, RHID, START, COUNT, RHVALS)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
6.29 NF\_GET\_VARS\_ type
-------------------------
The NF\_GET\_VARS\_ type family of functions read absampled (strided)
array of values from a netCDF variable of an open netCDF
dataset. Thebsampled array is specified by giving a corner, a
vector of edge lengths, and a stride vector. The values are read with
the first dimension of the netCDF variable varying fastest. The netCDF
dataset must be in data mode.
Usage
-----
INTEGER FUNCTION NF_GET_VARS_TEXT (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*),CHARACTER*(*) text)
INTEGER FUNCTION NF_GET_VARS_INT1 (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*),INTEGER*1 i1vals(*))
INTEGER FUNCTION NF_GET_VARS_INT2 (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*),INTEGER*2 i2vals(*))
INTEGER FUNCTION NF_GET_VARS_INT (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER ivals(*))
INTEGER FUNCTION NF_GET_VARS_INT64 (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER*8 i8vals(*))
INTEGER FUNCTION NF_GET_VARS_REAL (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), REAL rvals(*))
INTEGER FUNCTION NF_GET_VARS_DOUBLE(INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), DOUBLE dvals(*))
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`START`
: A vector of integers specifying the index in the variable from which
the first of the data values will be read. The indices are relative
to 1, so for example, the first data value of a variable would have
index (1, 1, ..., 1). The elements of START correspond, in order, to
the variable’s dimensions. Hence, if the variable is a record
variable, the last index would correspond to the starting record
number for reading the data values.
`COUNT`
: A vector of integers specifying the number of indices selected along
each dimension. To read a single value, for example, specify COUNT
as (1, 1, ..., 1). The elements of COUNT correspond, in order, to
the variable’s dimensions. Hence, if the variable is a record
variable, the last element of COUNT corresponds to a count of the
number of records to read.
Note: setting any element of the count array to zero causes the
function to exit without error, and without doing anything.
`STRIDE`
: A vector of integers specifying, for each dimension, the interval
between selected indices or the value 0. The elements of the vector
correspond, in order, to the variable’s dimensions. A value of 1
accesses adjacent values of the netCDF variable in the corresponding
dimension; a value of 2 accesses every other value of the netCDF
variable in the corresponding dimension; and so on. A 0 argument is
treated as (1, 1, ..., 1).
`text`\
`i1vals`\
`i2vals`\
`ivals`\
`i8vals`\
`rvals`\
`dvals`
: The block of data values to be read. The data should be of the type
appropriate for the function called. You cannot read CHARACTER data
from a numeric variable or numeric data from a text variable. For
numeric data, if the type of data differs from the netCDF variable
type, type conversion will occur (see [(netcdf)Type
Conversion](netcdf.html#Type-Conversion) ‘Type Conversion’
in The NetCDF Users Guide).
Errors
------
NF\_GET\_VARS\_ type returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The variable ID is invalid for the specified netCDF dataset.
- The specified start, count and stride generate an index which is out
of range.
- One or more of the values are out of the range of values
representable by the desired type.
- The specified netCDF is in define mode rather than data mode.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_GET\_VARS\_DOUBLE to read every other value
in each dimension of the variable named rh from an existing netCDF
dataset named foo.nc. Values are assigned, using the same dimensional
strides, to a 2-parameter array. For simplicity in this example, we
ame that we know that rh is dimensioned with lon, lat, and time, and
that there are ten lon values, five lat values, and three time values.
INCLUDE 'netcdf.inc'
...
PARAMETER (NDIMS=3) ! number of dimensions
PARAMETER (TIMES=3, LATS=5, LONS=10) ! dimension lengths
INTEGER STATUS, NCID
INTEGER RHID ! variable ID
INTEGER START(NDIMS), COUNT(NDIMS), STRIDE(NDIMS)
DOUBLE DATA(LONS, LATS, TIMES)
DATA START /1, 1, 1/ ! start at first value
DATA COUNT /LONS, LATS, TIMES/
DATA STRIDE /2, 2, 2/
...
STATUS = NF_OPEN ('foo.nc', NF_NOWRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID (NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_GET_VARS_DOUBLE(NCID,RHID,START,COUNT,STRIDE,DATA(1,1,1))
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
6.30 NF\_GET\_VARM\_ type
-------------------------
The NF\_GET\_VARM\_ type family of functions reads a mapped array
section of values from a netCDF variable of an open netCDF dataset. The
mapped array is specified by giving a corner, a vector of edge
lengths, a stride vector, and an index mapping vector. The index mapping
vector is a vector of integers that specifies the mapping between the
dimensions of a netCDF variable and the in-memory structure of the
internal data array. No amptions are made about the ordering or
length of the dimensions of the data array. The netCDF dataset must be
in data mode.
Usage
-----
INTEGER FUNCTION NF_GET_VARM_TEXT (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER IMAP(*),
CHARACTER*(*) text)
INTEGER FUNCTION NF_GET_VARM_INT1 (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER IMAP(*),
INTEGER*1 i1vals(*))
INTEGER FUNCTION NF_GET_VARM_INT2 (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER IMAP(*),
INTEGER*2 i2vals(*))
INTEGER FUNCTION NF_GET_VARM_INT (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER IMAP(*),
INTEGER ivals(*))
INTEGER FUNCTION NF_GET_VARM_INT64 (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER IMAP(*),
INTEGER*8 i8vals(*))
INTEGER FUNCTION NF_GET_VARM_REAL (INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER IMAP(*),
REAL rvals(*))
INTEGER FUNCTION NF_GET_VARM_DOUBLE(INTEGER NCID, INTEGER VARID,
INTEGER START(*), INTEGER COUNT(*),
INTEGER STRIDE(*), INTEGER IMAP(*),
DOUBLE dvals(*))
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`START`
: A vector of integers specifying the index in the variable from which
the first of the data values will be read. The indices are relative
to 1, so for example, the first data value of a variable would have
index (1, 1, ..., 1). The elements of START correspond, in order, to
the variable’s dimensions. Hence, if the variable is a record
variable, the last index would correspond to the starting record
number for reading the data values.
`COUNT`
: A vector of integers specifying the number of indices selected along
each dimension. To read a single value, for example, specify COUNT
as (1, 1, ..., 1). The elements of COUNT correspond, in order, to
the variable’s dimensions. Hence, if the variable is a record
variable, the last element of COUNT corresponds to a count of the
number of records to read.
Note: setting any element of the count array to zero causes the
function to exit without error, and without doing anything.
`STRIDE`
: A vector of integers specifying, for each dimension, the interval
between selected indices or the value 0. The elements of the vector
correspond, in order, to the variable’s dimensions. A value of 1
accesses adjacent values of the netCDF variable in the corresponding
dimension; a value of 2 accesses every other value of the netCDF
variable in the corresponding dimension; and so on. A 0 argument is
treated as (1, 1, ..., 1).
`IMAP`
: A vector of integers that specifies the mapping between the
dimensions of a netCDF variable and the in-memory structure of the
internal data array. IMAP(1) gives the distance between elements of
the internal array corresponding to the most rapidly varying
dimension of the netCDF variable. IMAP(N) (where N is the rank of
the netCDF variable) gives the distance between elements of the
internal array corresponding to the most slowly varying dimension of
the netCDF variable. Intervening IMAP elements correspond to other
dimensions of the netCDF variable in the obvious way. Distances
between elements are specified in units of elements (the distance
between internal elements that occupy adjacent memory locations is 1
and not the element’s byte-length as in netCDF 2).
`text`\
`i1vals`\
`i2vals`\
`ivals`\
`i8vals`\
`rvals`\
`dvals`
: The block of data values to be read. The data should be of the type
appropriate for the function called. You cannot read CHARACTER data
from a numeric variable or numeric data from a text variable. For
numeric data, if the type of data differs from the netCDF variable
type, type conversion will occur (see [(netcdf)Type
Conversion](netcdf.html#Type-Conversion) ‘Type Conversion’
in The NetCDF Users Guide).
Errors
------
NF\_GET\_VARM\_ type returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The variable ID is invalid for the specified netCDF dataset.
- The specified START, COUNT, and STRIDE generate an index which is
out of range. Note that no error checking is possible on the imap
vector.
- One or more of the values are out of the range of values
representable by the desired type.
- The specified netCDF is in define mode rather than data mode.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
The following IMAP vector maps in the trivial way a 2x3x4 netCDF
variable and an internal array of the same shape:
REAL A(2,3,4) ! same shape as netCDF variable
INTEGER IMAP(3)
DATA IMAP /1, 2, 6/ ! netCDF dimension inter-element distance
! ---------------- ----------------------
! most rapidly varying 1
! intermediate 2 (=IMAP(1)*2)
! most slowly varying 6 (=IMAP(2)*3)
Using the IMAP vector above with NF\_GET\_VARM\_REAL obtains the same
rlt as simply using NF\_GET\_VAR\_REAL.
Here is an example of using NF\_GET\_VARM\_REAL to transpose a netCDF
variable named rh which is described by the FORTRAN declaration REAL
RH(4,6) (note the size and order of the dimensions):
INCLUDE 'netcdf.inc'
...
PARAMETER (NDIM=2) ! rank of netCDF variable
INTEGER NCID ! netCDF dataset ID
INTEGER STATUS ! return code
INTEGER RHID ! variable ID
INTEGER START(NDIM) ! netCDF variable start point
INTEGER COUNT(NDIM) ! size of internal array
INTEGER STRIDE(NDIM) ! netCDF variablebsampling intervals
INTEGER IMAP(NDIM) ! internal array inter-element distances
REAL RH(6,4) ! note transposition of netCDF variable dimensions
DATA START /1, 1/ ! start at first netCDF variable element
DATA COUNT /4, 6/ ! entire netCDF variable; order corresponds
! to netCDF variable -- not internal array
DATA STRIDE /1, 1/ ! sample every netCDF element
DATA IMAP /6, 1/ ! would be /1, 4/ if not transposing
...
STATUS = NF_OPEN('foo.nc', NF_NOWRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID(NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_GET_VARM_REAL(NCID, RHID, START, COUNT, STRIDE, IMAP, RH)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
Here is another example of using NF\_GET\_VARM\_REAL to simultaneously
transpose andbsample the same netCDF variable, by accessing every
other point of the netCDF variable:
INCLUDE 'netcdf.inc'
...
PARAMETER (NDIM=2) ! rank of netCDF variable
INTEGER NCID ! netCDF dataset ID
INTEGER STATUS ! return code
INTEGER RHID ! variable ID
INTEGER START(NDIM) ! netCDF variable start point
INTEGER COUNT(NDIM) ! size of internal array
INTEGER STRIDE(NDIM) ! netCDF variablebsampling intervals
INTEGER IMAP(NDIM) ! internal array inter-element distances
REAL RH(3,2) ! note transposition of bsampled) dimensions
DATA START /1, 1/ ! start at first netCDF variable value
DATA COUNT /2, 3/ ! order of bsampled) dimensions corresponds
! to netCDF variable -- not internal array
DATA STRIDE /2, 2/ ! sample every other netCDF element
DATA IMAP /3, 1/ ! would be `1, 2' if not transposing
...
STATUS = NF_OPEN('foo.nc', NF_NOWRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID(NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_GET_VARM_REAL(NCID, RHID, START, COUNT, STRIDE, IMAP, RH)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
6.31 Reading and Writing Character String Values
------------------------------------------------
Character strings are not a primitive netCDF external data type, in part
because FORTRAN does notpport the abstraction of variable-length
character strings (the FORTRAN LEN function returns the static length of
a character string, not its dynamic length). As a rlt, a character
string cannot be written or read as a single object in the netCDF
interface. Instead, a character string must be treated as an array of
characters, and array access must be used to read and write character
strings as variable data in netCDF datasets. Furthermore,
variable-length strings are notpported by the netCDF interface except
by convention; for example, you may treat a zero byte as terminating a
character string, but you must explicitly specify the length of strings
to be read from and written to netCDF variables.
Character strings as attribute values are easier to use, since the
strings are treated as a single unit for access. However, the value of a
character-string attribute is still an array of characters with an
explicit length that must be specified when the attribute is defined.
When you define a variable that will have character-string values, use a
character-position dimension as the most quickly varying dimension for
the variable (the first dimension for the variable in FORTRAN). The
length of the character-position dimension will be the maximum string
length of any value to be stored in the character-string variable. Space
for maximum-length strings will be allocated in the disk representation
of character-string variables whether you use the space or not. If two
or more variables have the same maximum length, the same
character-position dimension may be used in defining the variable
shapes.
To write a character-string value into a character-string variable, use
either entire variable access or array access. The latter requires that
you specify both a corner and a vector of edge lengths. The
character-position dimension at the corner should be one for FORTRAN. If
the length of the string to be written is n, then the vector of edge
lengths will specify n in the character-position dimension, and one for
all the other dimensions:(n, 1, 1, ..., 1).
In FORTRAN, fixed-length strings may be written to a netCDF dataset
without a terminating character, to save space. Variable-length strings
should follow the C convention of writing strings with a terminating
zero byte so that the intended length of the string can be determined
when it is later read by either C or FORTRAN programs.
The FORTRAN interface for reading and writing strings requires the use
of different functions for accessing string values and numeric values,
because standard FORTRAN does not permit the same formal parameter to be
used for both character values and numeric values. An additional
argument, specifying the declared length of the character string passed
as a value, is required for NF\_PUT\_VARA\_TEXT and NF\_GET\_VARA\_TEXT.
The actual length of the string is specified as the value of the
edge-length vector corresponding to the character-position dimension.
Here is an example that defines a record variable, tx, for character
strings and stores a character-string value into the third record using
NF\_PUT\_VARA\_TEXT. In this example, we ame the string variable and
data are to be added to an existing netCDF dataset named foo.nc that
already has an unlimited record dimension time.
INCLUDE 'netcdf.inc'
...
INTEGER TDIMS, TXLEN
PARAMETER (TDIMS=2) ! number of TX dimensions
PARAMETER (TXLEN = 15) ! length of example string
INTEGER NCID
INTEGER CHID ! char position dimension id
INTEGER TIMEID ! record dimension id
INTEGER TXID ! variable ID
INTEGER TXDIMS(TDIMS) ! variable shape
INTEGER TSTART(TDIMS), TCOUNT(TDIMS)
CHARACTER*40 TXVAL ! max length 40
DATA TXVAL /'example string'/
...
TXVAL(TXLEN:TXLEN) = CHAR(0) ! null terminate
...
STATUS = NF_OPEN('foo.nc', NF_WRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_REDEF(NCID) ! enter define mode
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
! define character-position dimension for strings of max length 40
STATUS = NF_DEF_DIM(NCID, "chid", 40, CHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
! define a character-string variable
TXDIMS(1) = CHID ! character-position dimension first
TXDIMS(2) = TIMEID
STATUS = NF_DEF_VAR(NCID, "tx", NF_CHAR, TDIMS, TXDIMS, TXID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_ENDDEF(NCID) ! leave define mode
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
! write txval into tx netCDF variable in record 3
TSTART(1) = 1 ! start at beginning of variable
TSTART(2) = 3 ! record number to write
TCOUNT(1) = TXLEN ! number of chars to write
TCOUNT(2) = 1 ! only write one record
STATUS = NF_PUT_VARA_TEXT (NCID, TXID, TSTART, TCOUNT, TXVAL)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
6.32 Fill Values
----------------
What happens when you try to read a value that was never written in an
open netCDF dataset? You might expect that this should always be an
error, and that you should get an error message or an error status
returned. You do get an error if you try to read data from a netCDF
dataset that is not open for reading, if the variable ID is invalid for
the specified netCDF dataset, or if the specified indices are not
properly within the range defined by the dimension lengths of the
specified variable. Otherwise, reading a value that was not written
returns a special fill value used to fill in any undefined values when a
netCDF variable is first written.
You may ignore fill values and use the entire range of a netCDF external
data type, but in this case you should makere you write all data
values before reading them. If you know you will be writing all the data
before reading it, you can specify that no prefilling of variables with
fill values will occur by calling NF\_SET\_FILL before writing. This may
provide a significant performance gain for netCDF writes.
The variable attribute \_FillValue may be used to specify the fill value
for a variable. Their are default fill values for each type, defined in
the include file netcdf.inc: NF\_FILL\_CHAR, NF\_FILL\_INT1 (same as
NF\_FILL\_BYTE), NF\_FILL\_INT2 (same as NF\_FILL\_SHORT),
NF\_FILL\_INT, NF\_FILL\_REAL (same as NF\_FILL\_FLOAT), and
NF\_FILL\_DOUBLE.
The netCDF byte and character types have different default fill values.
The default fill value for characters is the zero byte, a useful value
for detecting the end of variable-length C character strings. If you
need a fill value for a byte variable, it is recommended that you
explicitly define an appropriate \_FillValue attribute, as generic
utilitiesch as ncdump will not ame a default fill value for byte
variables.
Type conversion for fill values is identical to type conversion for
other values: attempting to convert a value from one type to another
type that can’t represent the value rlts in a range error. Such
errors may occur on writing or reading values from a larger type ch
as double) to a smaller type ch as float), if the fill value for the
larger type cannot be represented in the smaller type.
6.33 NF\_RENAME\_VAR
--------------------
The function NF\_RENAME\_VAR changes the name of a netCDF variable in an
open netCDF dataset. If the new name is longer than the old name, the
netCDF dataset must be in define mode. You cannot rename a variable to
have the name of any existing variable.
Usage
-----
INTEGER FUNCTION NF_RENAME_VAR (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NEWNAM)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID.
`NAME`
: New name for the specified variable.
Errors
------
NF\_RENAME\_VAR returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The new name is in use as the name of another variable.
- The variable ID is invalid for the specified netCDF dataset.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_RENAME\_VAR to rename the variable rh to
rel\_hum in an existing netCDF dataset named foo.nc:
INCLUDE 'netcdf.inc'
...
INTEGER STATUS, NCID
INTEGER RHID ! variable ID
...
STATUS = NF_OPEN ('foo.nc', NF_WRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_REDEF (NCID) ! enter definition mode
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_INQ_VARID (NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_RENAME_VAR (NCID, RHID, 'rel_hum')
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_ENDDEF (NCID) ! leave definition mode
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
6.34 Change between Collective and Independent Parallel Access: NF\_VAR\_PAR\_ACCESS
------------------------------------------------------------------------------------
The function NF\_VAR\_PAR\_ACCESS changes whether read/write operations
on a parallel file system are performed collectively or independently
(the default) on the variable. This function can only be called if the
file was created with NF\_CREATE\_PAR (see
[NF\_CREATE\_PAR](#NF_005fCREATE_005fPAR)) or opened with NF\_OPEN\_PAR
(see [NF\_OPEN\_PAR](#NF_005fOPEN_005fPAR)).
This function is only available if the netCDF library was built with a
HDF5 library for which –enable-parallel was used, and which was linked
(like HDF5) to MPI libraries.
Calling this function affects only the open file - information about
whether a variable is to be accessed collectively or independently is
not written to the data file. Every time you open a file on a parallel
file system, all variables default to independent operations. The change
a variable to collective lasts only as long as that file is open.
The variable can be changed from collective to independent, and back, as
often as desired.
Usage
-----
INTEGER NF_VAR_PAR_ACCESS(INTEGER NCID, INTEGER VARID, INTEGER ACCESS);
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN\_PAR (see
[NF\_OPEN\_PAR](#NF_005fOPEN_005fPAR)) or NF\_CREATE\_PAR (see
[NF\_CREATE\_PAR](#NF_005fCREATE_005fPAR)).
`varid`
: Variable ID.
`access`
: NF\_INDEPENDENT to set this variable to independent operations.
NF\_COLLECTIVE to set it to collective operations.
Return Values
-------------
`NF_NOERR`
: No error.
`NF_ENOTVAR`
: No variable found.
`NF_ENOTNC4`
: Not a netCDF-4 file.
`NF_NOPAR`
: File not opened for parallel access.
Example
-------
This example comes from test program nf\_test/ftst\_parallel.F. For this
test to be run, netCDF must have been built with a parallel-enabled
HDF5, and –enable-parallel-tests must have been used when configuring
netcdf.
retval = nf_var_par_access(ncid, varid, nf_collective)
if (retval .ne. nf_noerr) stop 2
7. Attributes
=============
7.1 Attributes Introduction
---------------------------
Attributes may be associated with each netCDF variable to specifych
properties as units, special values, maximum and minimum valid values,
scaling factors, and offsets. Attributes for a netCDF dataset are
defined when the dataset is first created, while the netCDF dataset is
in define mode. Additional attributes may be added later by reentering
define mode. A netCDF attribute has a netCDF variable to which it is
assigned, a name, a type, a length, and a sequence of one or more
values. An attribute is designated by its variable ID and name. When an
attribute name is not known, it may be designated by its variable ID and
number in order to determine its name, using the function
NF\_INQ\_ATTNAME.
The attributes associated with a variable are typically defined
immediately after the variable is created, while still in define mode.
The data type, length, and value of an attribute may be changed even
when in data mode, as long as the changed attribute requires no more
space than the attribute as originally defined.
It is also possible to have attributes that are not associated with any
variable. These are called global attributes and are identified by using
NF\_GLOBAL as a variable pseudo-ID. Global attributes are ally
related to the netCDF dataset as a whole and may be used for purposes
such as providing a title or processing history for a netCDF dataset.
Attributes are much more useful when they follow established community
conventions. See [(netcdf)Attribute
Conventions](netcdf.html#Attribute-Conventions) ‘Attribute
Conventions’ in The NetCDF Users Guide.
Operationspported on attributes are:
- Create an attribute, given its variable ID, name, data type, length,
and value.
- Get attribute’s data type and length from its variable ID and name.
- Get attribute’s value from its variable ID and name.
- Copy attribute from one netCDF variable to another.
- Get name of attribute from its number.
- Rename an attribute.
- Delete an attribute.
7.2 NF\_PUT\_ATT\_ type
-----------------------
The function NF\_PUT\_ATT\_ type adds or changes a variable attribute or
global attribute of an open netCDF dataset. If this attribute is new, or
if the space required to store the attribute is greater than before, the
netCDF dataset must be in define mode.
Usage
-----
Although it’s possible to create attributes of all types, text and
double attributes are adequate for most purposes.
INTEGER FUNCTION NF_PUT_ATT_TEXT (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME, INTEGER LEN,
CHARACTER*(*) TEXT)
INTEGER FUNCTION NF_PUT_ATT_INT1 (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME, INTEGER XTYPE,
LEN, INTEGER*1 I1VALS(*))
INTEGER FUNCTION NF_PUT_ATT_INT2 (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME, INTEGER XTYPE,
LEN, INTEGER*2 I2VALS(*))
INTEGER FUNCTION NF_PUT_ATT_INT (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME, INTEGER XTYPE,
LEN, INTEGER IVALS(*))
INTEGER FUNCTION NF_PUT_ATT_INT64 (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME, INTEGER XTYPE,
LEN, INTEGER*8 I8VALS(*))
INTEGER FUNCTION NF_PUT_ATT_REAL (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME, INTEGER XTYPE,
LEN, REAL RVALS(*))
INTEGER FUNCTION NF_PUT_ATT_DOUBLE(INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME, INTEGER XTYPE,
LEN, DOUBLE DVALS(*))
INTEGER FUNCTION NF_PUT_ATT (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME, INTEGER XTYPE,
LEN, * VALS(*))
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID of the variable to which the attribute will be assigned
or NF\_GLOBAL for a global attribute.
`NAME`
: Attribute name. Attribute name conventions are amed by some
netCDF generic applications, e.g., ‘units’ as the name for a string
attribute that gives the units for a netCDF variable. See
[(netcdf)Attribute Conventions](netcdf.html#Attribute-Conventions)
‘Attribute Conventions’ in The NetCDF Users Guide.
`XTYPE`
: One of the set of predefined netCDF external data types. The type of
this parameter, NF\_TYPE, is defined in the netCDF header file. The
valid netCDF external data types are NF\_BYTE, NF\_CHAR, NF\_SHORT,
NF\_INT, NF\_FLOAT, and NF\_DOUBLE. Although it’s possible to create
attributes of all types, NF\_CHAR and NF\_DOUBLE attributes are
adequate for most purposes.
`LEN`
: Number of values provided for the attribute.
`TEXT`\
`I1VALS`\
`I2VALS`\
`IVALS`\
`I8VALS`\
`RVALS`\
`DVALS`\
`VALS`
: An array of LEN attribute values. The data should be of a type
appropriate for the function called. You cannot write CHARACTER data
into a numeric attribute or numeric data into a text attribute. For
numeric data, if the type of data differs from the attribute type,
type conversion will occur See [(netcdf)Type
Conversion](netcdf.html#Type-Conversion) ‘Type Conversion’
in The NetCDF Users Guide.
Errors
------
NF\_PUT\_ATT\_ type returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The variable ID is invalid for the specified netCDF dataset.
- The specified netCDF type is invalid.
- The specified length is negative.
- The specified open netCDF dataset is in data mode and the specified
attribute would expand.
- The specified open netCDF dataset is in data mode and the specified
attribute does not already exist.
- The specified netCDF ID does not refer to an open netCDF dataset.
- The number of attributes for this variable exceeds NF\_MAX\_ATTRS.
Example
-------
Here is an example using NF\_PUT\_ATT\_DOUBLE to add a variable
attribute named valid\_range for a netCDF variable named rh and a global
attribute named title to an existing netCDF dataset named foo.nc:
INCLUDE 'netcdf.inc'
...
INTEGER STATUS, NCID
INTEGER RHID ! variable ID
DOUBLE RHRNGE(2)
DATA RHRNGE /0.0D0, 100.0D0/
...
STATUS = NF_OPEN ('foo.nc', NF_WRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_REDEF (NCID) ! enter define mode
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_INQ_VARID (NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_PUT_ATT_DOUBLE (NCID, RHID, 'valid_range', NF_DOUBLE, &
2, RHRNGE)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_PUT_ATT_TEXT (NCID, NF_GLOBAL, 'title', 19,
'example netCDF dataset')
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_ENDDEF (NCID) ! leave define mode
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
7.3 NF\_INQ\_ATT Family
-----------------------
This family of functions returns information about a netCDF attribute.
All but one of these functions require the variable ID and attribute
name; the exception is NF\_INQ\_ATTNAME. Information about an attribute
includes its type, length, name, and number. See the NF\_GET\_ATT family
for getting attribute values.
The function NF\_INQ\_ATTNAME gets the name of an attribute, given its
variable ID and number. This function is useful in generic applications
that need to get the names of all the attributes associated with a
variable, since attributes are accessed by name rather than number in
all other attribute functions. The number of an attribute is more
volatile than the name, since it can change when other attributes of the
same variable are deleted. This is why an attribute number is not called
an attribute ID.
The function NF\_INQ\_ATT returns the attribute’s type and length. The
other functions each return just one item of information about an
attribute.
Usage
-----
INTEGER FUNCTION NF_INQ_ATT (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME, INTEGER xtype,
INTEGER len)
INTEGER FUNCTION NF_INQ_ATTTYPE(INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME, INTEGER xtype)
INTEGER FUNCTION NF_INQ_ATTLEN (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME, INTEGER len)
INTEGER FUNCTION NF_INQ_ATTNAME(INTEGER NCID, INTEGER VARID,
INTEGER ATTNUM, CHARACTER*(*) name)
INTEGER FUNCTION NF_INQ_ATTID (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME, INTEGER attnum)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID of the attribute’s variable, or NF\_GLOBAL for a global
attribute.
`NAME`
: Attribute name. For NF\_INQ\_ATTNAME, this is a pointer to the
location for the returned attribute name.
`xtype`
: Returned attribute type, one of the set of predefined netCDF
external data types. The valid netCDF external data types are
NF\_BYTE, NF\_CHAR, NF\_SHORT, NF\_INT, NF\_FLOAT, and NF\_DOUBLE.
`len`
: Returned number of values currently stored in the attribute. For a
string-valued attribute, this is the number of characters in the
string.
`attnum`
: For NF\_INQ\_ATTNAME, the input attribute number; for
NF\_INQ\_ATTID, the returned attribute number. The attributes for
each variable are numbered from 1 (the first attribute) to NATTS,
where NATTS is the number of attributes for the variable, as
returned from a call to NF\_INQ\_VARNATTS.
(If you already know an attribute name, knowing its number is not
very useful, because accessing information about an attribute
requires its name.)
Errors
------
Each function returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The variable ID is invalid for the specified netCDF dataset.
- The specified attribute does not exist.
- The specified netCDF ID does not refer to an open netCDF dataset.
- For NF\_INQ\_ATTNAME, the specified attribute number is negative or
more than the number of attributes defined for the specified
variable.
Example
-------
Here is an example using NF\_INQ\_ATT to find out the type and length of
a variable attribute named valid\_range for a netCDF variable named rh
and a global attribute named title in an existing netCDF dataset named
foo.nc:
INCLUDE 'netcdf.inc'
...
INTEGER STATUS, NCID
INTEGER RHID ! variable ID
INTEGER VRLEN, TLEN ! attribute lengths
...
STATUS = NF_OPEN ('foo.nc', NF_NOWRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID (NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_ATTLEN (NCID, RHID, 'valid_range', VRLEN)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_INQ_ATTLEN (NCID, NF_GLOBAL, 'title', TLEN)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
7.4 NF\_GET\_ATT\_ type
-----------------------
Members of the NF\_GET\_ATT\_ type family of functions get the value(s)
of a netCDF attribute, given its variable ID and name.
Usage
-----
INTEGER FUNCTION NF_GET_ATT_TEXT (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME,
CHARACTER*(*) text)
INTEGER FUNCTION NF_GET_ATT_INT1 (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME,
INTEGER*1 i1vals(*))
INTEGER FUNCTION NF_GET_ATT_INT2 (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME,
INTEGER*2 i2vals(*))
INTEGER FUNCTION NF_GET_ATT_INT (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME,
INTEGER ivals(*))
INTEGER FUNCTION NF_GET_ATT_INT64 (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME,
INTEGER*8 i8vals(*))
INTEGER FUNCTION NF_GET_ATT_REAL (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME,
REAL rvals(*))
INTEGER FUNCTION NF_GET_ATT_DOUBLE (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME,
DOUBLE dvals(*))
INTEGER FUNCTION NF_GET_ATT (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME, * vals(*))
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: Variable ID of the attribute’s variable, or NF\_GLOBAL for a global
attribute.
`NAME`
: Attribute name.
`TEXT`\
`I1VALS`\
`I2VALS`\
`IVALS`\
`I8VALS`\
`RVALS`\
`DVALS`\
`VALS`
: Returned attribute values. All elements of the vector of attribute
values are returned, so you must provide enough space to hold them.
If you don’t know how much space to reserve, call NF\_INQ\_ATTLEN
first to find out the length of the attribute. You cannot read
character data from a numeric variable or numeric data from a text
variable. For numeric data, if the type of data differs from the
netCDF variable type, type conversion will occur. See [(netcdf)Type
Conversion](netcdf.html#Type-Conversion) ‘Type Conversion’
in The The NetCDF Users Guide.
Errors
------
NF\_GET\_ATT\_ type returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The variable ID is invalid for the specified netCDF dataset.
- The specified attribute does not exist.
- The specified netCDF ID does not refer to an open netCDF dataset.
- One or more of the attribute values are out of the range of values
representable by the desired type.
Example
-------
Here is an example using NF\_GET\_ATT\_DOUBLE to determine the values of
a variable attribute named valid\_range for a netCDF variable named rh
and a global attribute named title in an existing netCDF dataset named
foo.nc. In this example, it is amed that we don’t know how many
values will be returned, but that we do know the types of the
attributes. Hence, to allocate enough space to store them, we must first
inquire about the length of the attributes.
INCLUDE 'netcdf.inc'
...
PARAMETER (MVRLEN=3) ! max number of "valid_range" values
PARAMETER (MTLEN=80) ! max length of "title" attribute
INTEGER STATUS, NCID
INTEGER RHID ! variable ID
INTEGER VRLEN, TLEN ! attribute lengths
DOUBLE PRECISION VRVAL(MVRLEN) ! vr attribute values
CHARACTER*80 TITLE ! title attribute values
...
STATUS = NF_OPEN ('foo.nc', NF_WRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID (NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
! find out attribute lengths, to makere we have enough space
STATUS = NF_INQ_ATTLEN (NCID, RHID, 'valid_range', VRLEN)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_INQ_ATTLEN (NCID, NF_GLOBAL, 'title', TLEN)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
! get attribute values, if not too big
IF (VRLEN .GT. MVRLEN) THEN
WRITE (*,*) 'valid_range attribute too big!'
CALL EXIT
ELSE
STATUS = NF_GET_ATT_DOUBLE (NCID, RHID, 'valid_range', VRVAL)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
ENDIF
IF (TLEN .GT. MTLEN) THEN
WRITE (*,*) 'title attribute too big!'
CALL EXIT
ELSE
STATUS = NF_GET_ATT_TEXT (NCID, NF_GLOBAL, 'title', TITLE)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
ENDIF
7.5 NF\_COPY\_ATT
-----------------
The function NF\_COPY\_ATT copies an attribute from one open netCDF
dataset to another. It can also be used to copy an attribute from one
variable to another within the same netCDF.
If used to copy an attribute of user-defined type, then that
user-defined type must already be defined in the target file. In the
case of user-defined attributes, enddef/redef is called for ncid\_in and
ncid\_out if they are in define mode. (This is the ere that all
user-defined types are committed to the file(s) before the copy is
attempted.)
Usage
-----
INTEGER FUNCTION NF_COPY_ATT (INTEGER NCID_IN, INTEGER VARID_IN,
CHARACTER*(*) NAME, INTEGER NCID_OUT,
INTEGER VARID_OUT)
`NCID_IN`
: The netCDF ID of an input netCDF dataset from which the attribute
will be copied, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID_IN`
: ID of the variable in the input netCDF dataset from which the
attribute will be copied, or NF\_GLOBAL for a global attribute.
`NAME`
: Name of the attribute in the input netCDF dataset to be copied.
`NCID_OUT`
: The netCDF ID of the output netCDF dataset to which the attribute
will be copied, from a previous call to NF\_OPEN or NF\_CREATE. It
is permissible for the input and output netCDF IDs to be the same.
The output netCDF dataset should be in define mode if the attribute
to be copied does not already exist for the target variable, or if
it would cause an existing target attribute to grow.
`VARID_OUT`
: ID of the variable in the output netCDF dataset to which the
attribute will be copied, or NF\_GLOBAL to copy to a global
attribute.
Errors
------
NF\_COPY\_ATT returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The input or output variable ID is invalid for the specified netCDF
dataset.
- The specified attribute does not exist.
- The output netCDF is not in define mode and the attribute is new for
the output dataset is larger than the existing attribute.
- The input or output netCDF ID does not refer to an open netCDF
dataset.
Example
-------
Here is an example using NF\_COPY\_ATT to copy the variable attribute
units from the variable rh in an existing netCDF dataset named foo.nc to
the variable avgrh in another existing netCDF dataset named bar.nc,
aming that the variable avgrh already exists, but does not yet have a
units attribute:
INCLUDE 'netcdf.inc'
...
INTEGER STATUS ! error status
INTEGER NCID1, NCID2 ! netCDF IDs
INTEGER RHID, AVRHID ! variable IDs
...
STATUS = NF_OPEN ('foo.nc', NF_NOWRITE, NCID1)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_OPEN ('bar.nc', NF_WRITE, NCID2)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID (NCID1, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_INQ_VARID (NCID2, 'avgrh', AVRHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_REDEF (NCID2) ! enter define mode
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
! copy variable attribute from "rh" to "avgrh"
STATUS = NF_COPY_ATT (NCID1, RHID, 'units', NCID2, AVRHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_ENDDEF (NCID2) ! leave define mode
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
7.6 NF\_RENAME\_ATT
-------------------
The function NF\_RENAME\_ATT changes the name of an attribute. If the
new name is longer than the original name, the netCDF dataset must be in
define mode. You cannot rename an attribute to have the same name as
another attribute of the same variable.
Usage
-----
INTEGER FUNCTION NF_RENAME_ATT (INTEGER NCID, INTEGER VARID,
CHARACTER*(*) NAME,
CHARACTER*(*) NEWNAME)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE
`VARID`
: ID of the attribute’s variable, or NF\_GLOBAL for a global attribute
`NAME`
: The current attribute name.
`NEWNAME`
: The new name to be assigned to the specified attribute. If the new
name is longer than the current name, the netCDF dataset must be in
define mode.
Errors
------
NF\_RENAME\_ATT returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The specified variable ID is not valid.
- The new attribute name is already in use for another attribute of
the specified variable.
- The specified netCDF dataset is in data mode and the new name is
longer than the old name.
- The specified attribute does not exist.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_RENAME\_ATT to rename the variable
attribute units to Units for a variable rh in an existing netCDF dataset
named foo.nc:
INCLUDE "netcdf.inc"
...
INTEGER STATUS ! error status
INTEGER NCID ! netCDF ID
INTEGER RHID ! variable ID
...
STATUS = NF_OPEN ("foo.nc", NF_NOWRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID (NCID, "rh", RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
! rename attribute
STATUS = NF_RENAME_ATT (NCID, RHID, "units", "Units")
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
7.7 NF\_DEL\_ATT
----------------
The function NF\_DEL\_ATT deletes a netCDF attribute from an open netCDF
dataset. The netCDF dataset must be in define mode.
Usage
-----
INTEGER FUNCTION NF\_DEL\_ATT (INTEGER NCID, INTEGER VARID,
CHARACTER\*(\*) NAME)
`NCID`
: NetCDF ID, from a previous call to NF\_OPEN or NF\_CREATE.
`VARID`
: ID of the attribute’s variable, or NF\_GLOBAL for a global
attribute.
`NAME`
: The name of the attribute to be deleted.
Errors
------
NF\_DEL\_ATT returns the value NF\_NOERR if no errors occurred.
Otherwise, the returned status indicates an error. Possible causes of
errors include:
- The specified variable ID is not valid.
- The specified netCDF dataset is in data mode.
- The specified attribute does not exist.
- The specified netCDF ID does not refer to an open netCDF dataset.
Example
-------
Here is an example using NF\_DEL\_ATT to delete the variable attribute
Units for a variable rh in an existing netCDF dataset named foo.nc:
INCLUDE 'netcdf.inc'
...
INTEGER STATUS ! error status
INTEGER NCID ! netCDF ID
INTEGER RHID ! variable ID
...
STATUS = NF_OPEN ('foo.nc', NF_WRITE, NCID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
STATUS = NF_INQ_VARID (NCID, 'rh', RHID)
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
...
! delete attribute
STATUS = NF_REDEF (NCID) ! enter define mode
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_DEL_ATT (NCID, RHID, 'Units')
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
STATUS = NF_ENDDEF (NCID) ! leave define mode
IF (STATUS .NE. NF_NOERR) CALL HANDLE_ERR(STATUS)
A. NetCDF 2 to NetCDF 3 Fortran 77 Transition Guide {#f77_nc2_to_nc3_transition_guide}
===================================================
A.1 Overview of FORTRAN interface changes {#f77_overview_of_interface_changes}
-----------------------------------------
NetCDF version 3 includes a complete rewrite of the netCDF library. It
is about twice as fast as the previous version. The netCDF file format
is unchanged, so files written with version 3 can be read with version 2
code and vice versa.
The core library is now written in ANSI C. You must have an ANSI C
compiler to compile this version. The FORTRAN interface is layered on
top of the C interface using a different technique than was used in
netCDF-2.
Rewriting the library offered an opportunity to implement improved C and
FORTRAN interfaces that provide some significant benefits:
- type safety, by eliminating the need to use type punning in
arguments;
- automatic type conversions, by eliminating the undesirable coupling
between the language-independent external netCDF types (NF\_BYTE,
..., NF\_DOUBLE) and language-dependent internal data types (INT\*1,
..., DOUBLE PRECISION);
- pport for future enhancements, by eliminating obstacles to the
clean addition ofpport for packed data and multithreading;
- more standard error behavior, by uniformly communicating an error
status back to the calling program in the return value of each
function.
It is not necessary to rewrite programs that use the version 2 FORTRAN
interface, because the netCDF-3 library includes a backward
compatibility interface thatpports all the old functions, globals,
and behavior. We are hoping that the benefits of the new interface will
be an incentive to use it in new netCDF applications. It is possible to
convert old applications to the new interface incrementally, replacing
netCDF-2 calls with the corresponding netCDF-3 calls one at a time.
Other changes in the implementation of netCDF rlt in improved
portability, maintainability, and performance on most platforms. A clean
separation between I/O and type layers facilitates platform-specific
optimizations. The new library no longer uses a vendor-provided XDR
library, which simplifies linking programs that use netCDF and speeds up
data access significantly in most cases.
A.2 The New FORTRAN Interface {#f77_new_fortran_interface}
-----------------------------
First, here’s an example of FORTRAN code that uses the netCDF-2
interface:
! Use a buffer big enough for values of any type
DOUBLE PRECISION DBUF(NDATA)
REAL RBUF(NDATA)
...
EQUIVALENCE (RBUF, DBUF), ...
INT XTYPE ! to hold the actual type of the data
INT STATUS ! for error status
! Get the actual data type
CALL NCVINQ(NCID, VARID, ...,XTYPE, ...)
...
! Get the data
CALL NCVGT(NCID, VARID, START, COUNT, DBUF, STATUS)
IF(STATUS .NE. NCNOERR) THEN
PRINT *, 'Cannot get data, error code =', STATUS
! Deal with error
...
ENDIF
IF (XTYPE .EQ. NCDOUBLE) THEN
CALL DANALYZE(DBUF)
ELSEIF (XTYPE .EQ. NCFLOAT) THEN
CALL RANALYZE(RBUF)
...
ENDIF
Here’s how you might handle this with the new netCDF-3 FORTRAN
interface:
! I want to use doubles for my analysis
DOUBLE PRECISION DBUF(NDATA)
INT STATUS
! So I use a function that gets the data as doubles.
STATUS = NF_GET_VARA_DOUBLE(NCID, VARID, START, COUNT, DBUF)
IF(STATUS .NE. NF_NOERR) THEN
PRINT *, 'Cannot get data, ', NF_STRERROR(STATUS)
! Deal with error
...
ENDIF
CALL DANALYZE(DBUF)
The example above illustrates changes in function names, data type
conversion, and error handling, discussed in detail in thes
below.
A.3 Function Naming Conventions {#f77_function_naming_conventions}
-------------------------------
The netCDF-3 Fortran 77 library employs a naming convention intended to
make netCDF programs more readable. For example, the name of the
function to rename a variable is now NF\_RENAME\_VAR instead of the
previous NCVREN.
All netCDF-3 FORTRAN function names begin with the NF\_ prefix. The
second part of the name is a verb, like GET, PUT, INQ (for inquire), or
OPEN. The third part of the name is typically the object of the verb:
for example DIM, VAR, or ATT for functions dealing with dimensions,
variables, or attributes. To distinguish the various I/O operations for
variables, a single character modifier is appended to VAR:
- VAR entire variable access
- VAR1 single value access
- VARA array or array access
- VARS strided access to absample of values
- VARM mapped access to values not contiguous in memory
At the end of the name for variable and attribute functions, there is a
component indicating the type of the final argument: TEXT, INT1, INT2,
INT, REAL, or DOUBLE. This part of the function name indicates the type
of the data container you are using in your program: character string,
1-byte integer, and so on.
Also, all PARAMETER names in the public FORTRAN interface begin with the
prefix NF\_. For example, the PARAMETER which was formerly MAXNCNAM is
now NF\_MAX\_NAME, and the former FILFLOAT is now NF\_FILL\_FLOAT.
As previously mentioned, all the old names are stillpported for
backward compatibility.
A.4 Type Conversion {#f77_type_conversion}
-------------------
With the new interface, users need not be aware of the external type of
numeric variables, since automatic conversion to or from any desired
numeric type is now available. You can use this feature to simplify
code, by making it independent of external types. The elimination of
type punning prevents some kinds of type errors that could occur with
the previous interface. Programs may be made more robust with the new
interface, because they need not be changed to accommodate a change to
the external type of a variable.
If conversion to or from an external numeric type is necessary, it is
handled by the library. This automatic conversion and separation of
external data representation from internal data types will become even
more important in netCDF version 4, when new external types will be
added for packed data for which there is no natural corresponding
internal type, for example, arrays of 11-bit values.
Converting from one numeric type to another may rlt in an error if
the target type is not capable of representing the converted value. (In
netCDF-2,ch overflows can only happen in the XDR layer.) For example,
a REAL may not be able to hold data stored externally as an NF\_DOUBLE
(an IEEE floating-point number). When accessing an array of values, an
NF\_ERANGE error is returned if one or more values are out of the range
of representable values, but other values are converted properly.
Note that mere loss of precision in type conversion does not return an
error. Thus, if you read double precision values into an INTEGER, for
example, no error rlts unless the magnitude of the double precision
value exceeds the representable range of INTEGERs on your platform.
Similarly, if you read a large integer into a REAL incapable of
representing all the bits of the integer in its mantissa, this loss
There are two new functions in netCDF-3 that don’t correspond to any
netCDF-2 functions: NF\_INQ\_LIBVERS and NF\_STRERROR. The version ation
The previous implementation returned an error when the same dimension
was used more than once in specifying the shape of a variable in
ncvardef. This restriction is relaxed in the netCDF-3 implementation,
because an autocorrelation matrix is a good example where using the same
dimension twice makes sense.
In the new interface, units for the IMAP argument to the NF\_PUT\_VARM
and NF\_GET\_VARM families of functions are now in terms of the number
of data elements of the desired internal type, not in terms of bytes as
in the netCDF version-2 mapped access interfaces.
Following is a table of netCDF-2 function names and names of the
corresponding netCDF-3 functions. For parameter lists of netCDF-2
functions, see the netCDF-2 User’s Guide.
`NCABOR`
: NF\_ABORT
`NCACPY`
: NF\_COPY\_ATT
`NCADEL`
: NF\_DEL\_ATT
`NCAGT`
: NF\_GET\_ATT\_DOUBLE, NF\_GET\_ATT\_REAL, NF\_GET\_ATT\_INT,
NF\_GET\_ATT\_INT1, NF\_GET\_ATT\_INT2
`NCAGTC`
: NF\_GET\_ATT\_TEXT
`NCAINQ`
: NF\_INQ\_ATT, NF\_INQ\_ATTID, NF\_INQ\_ATTLEN, NF\_INQ\_ATTTYPE
`NCANAM`
: NF\_INQ\_ATTNAME
`NCAPT`
: NF\_PUT\_ATT\_DOUBLE, NF\_PUT\_ATT\_REAL, NF\_PUT\_ATT\_INT,
NF\_PUT\_ATT\_INT1NF\_PUT
B. Summary of FORTRAN 77 Interface {#f77_interface_summary}
==================================
Input parameters are in upper case, output parameters are in lower case.
The FORTRAN types of all the parameters are listed alphabetically by
parameter name below the function declarations.
~~~~
CHARACTER*80 FUNCTION NF_INQ_LIBVERS()
CHARACTER*80 FUNCTION NF_STRERROR (NCERR)
INTEGER FUNCTION NF_CREATE (PATH, CMODE, ncid)
INTEGER FUNCTION NF_OPEN (PATH, MODE, ncid)
INTEGER FUNCTION NF_SET_FILL (NCID, FILLMODE, old_mode)
INTEGER FUNCTION NF_REDEF (NCID)
INTEGER FUNCTION NF_ENDDEF (NCID)
INTEGER FUNCTION NF_SYNC (NCID)
INTEGER FUNCTION NF_ABORT (NCID)
INTEGER FUNCTION NF_CLOSE (NCID)
INTEGER FUNCTION NF_INQ (NCID, ndims, nvars, ngatts,
unlimdimid)
INTEGER FUNCTION NF_INQ_NDIMS (NCID, ndims)
INTEGER FUNCTION NF_INQ_NVARS (NCID, nvars)
INTEGER FUNCTION NF_INQ_NATTS (NCID, ngatts)
INTEGER FUNCTION NF_INQ_UNLIMDIM (NCID, unlimdimid)
INTEGER FUNCTION NF_DEF_DIM (NCID, NAME, LEN, dimid)
INTEGER FUNCTION NF_INQ_DIMID (NCID, NAME, dimid)
INTEGER FUNCTION NF_INQ_DIM (NCID, DIMID, name, len)
INTEGER FUNCTION NF_INQ_DIMNAME (NCID, DIMID, name)
INTEGER FUNCTION NF_INQ_DIMLEN (NCID, DIMID, len)
INTEGER FUNCTION NF_RENAME_DIM (NCID, DIMID, NAME)
INTEGER FUNCTION NF_DEF_VAR (NCID, NAME, XTYPE, NDIMS, DIMIDS,
varid)
INTEGER FUNCTION NF_INQ_VAR (NCID, VARID, name, xtype, ndims,
dimids, natts)
INTEGER FUNCTION NF_INQ_VARID (NCID, NAME, varid)
INTEGER FUNCTION NF_INQ_VARNAME (NCID, VARID, name)
INTEGER FUNCTION NF_INQ_VARTYPE (NCID, VARID, xtype)
INTEGER FUNCTION NF_INQ_VARNDIMS (NCID, VARID, ndims)
INTEGER FUNCTION NF_INQ_VARDIMID (NCID, VARID, DIMIDS)
INTEGER FUNCTION NF_INQ_VARNATTS (NCID, VARID, natts)
INTEGER FUNCTION NF_RENAME_VAR (NCID, VARID, NAME)
INTEGER FUNCTION NF_PUT_VAR_TEXT (NCID, VARID, TEXT)
INTEGER FUNCTION NF_GET_VAR_TEXT (NCID, VARID, text)
INTEGER FUNCTION NF_PUT_VAR_INT1 (NCID, VARID, I1VAL)
INTEGER FUNCTION NF_GET_VAR_INT1 (NCID, VARID, i1val)
INTEGER FUNCTION NF_PUT_VAR_INT2 (NCID, VARID, I2VAL)
INTEGER FUNCTION NF_GET_VAR_INT2 (NCID, VARID, i2val)
INTEGER FUNCTION NF_PUT_VAR_INT (NCID, VARID, IVAL)
INTEGER FUNCTION NF_GET_VAR_INT (NCID, VARID, ival)
INTEGER FUNCTION NF_PUT_VAR_INT64 (NCID, VARID, I8VAL)
INTEGER FUNCTION NF_GET_VAR_INT64 (NCID, VARID, i8val)
INTEGER FUNCTION NF_PUT_VAR_REAL (NCID, VARID, RVAL)
INTEGER FUNCTION NF_GET_VAR_REAL (NCID, VARID, rval)
INTEGER FUNCTION NF_PUT_VAR_DOUBLE (NCID, VARID, DVAL)
INTEGER FUNCTION NF_GET_VAR_DOUBLE (NCID, VARID, dval)
INTEGER FUNCTION NF_PUT_VAR1_TEXT (NCID, VARID, INDEX, TEXT)
INTEGER FUNCTION NF_GET_VAR1_TEXT (NCID, VARID, INDEX, text)
INTEGER FUNCTION NF_PUT_VAR1_INT1 (NCID, VARID, INDEX, I1VAL)
INTEGER FUNCTION NF_GET_VAR1_INT1 (NCID, VARID, INDEX, i1val)
INTEGER FUNCTION NF_PUT_VAR1_INT2 (NCID, VARID, INDEX, I2VAL)
INTEGER FUNCTION NF_GET_VAR1_INT2 (NCID, VARID, INDEX, i2val)
INTEGER FUNCTION NF_PUT_VAR1_INT (NCID, VARID, INDEX, IVAL)
INTEGER FUNCTION NF_GET_VAR1_INT (NCID, VARID, INDEX, ival)
INTEGER FUNCTION NF_PUT_VAR1_INT64 (NCID, VARID, INDEX, I8VAL)
INTEGER FUNCTION NF_GET_VAR1_INT64 (NCID, VARID, INDEX, i8val)
INTEGER FUNCTION NF_PUT_VAR1_REAL (NCID, VARID, INDEX, RVAL)
INTEGER FUNCTION NF_GET_VAR1_REAL (NCID, VARID, INDEX, rval)
INTEGER FUNCTION NF_PUT_VAR1_DOUBLE(NCID, VARID, INDEX, DVAL)
INTEGER FUNCTION NF_GET_VAR1_DOUBLE(NCID, VARID, INDEX, dval)
INTEGER FUNCTION NF_PUT_VARA_TEXT (NCID, VARID, START, COUNT, TEXT)
INTEGER FUNCTION NF_GET_VARA_TEXT (NCID, VARID, START, COUNT, text)
INTEGER FUNCTION NF_PUT_VARA_INT1 (NCID, VARID, START, COUNT, I1VALS)
INTEGER FUNCTION NF_GET_VARA_INT1 (NCID, VARID, START, COUNT, i1vals)
INTEGER FUNCTION NF_PUT_VARA_INT2 (NCID, VARID, START, COUNT, I2VALS)
INTEGER FUNCTION NF_GET_VARA_INT2 (NCID, VARID, START, COUNT, i2vals)
INTEGER FUNCTION NF_PUT_VARA_INT (NCID, VARID, START, COUNT, IVALS)
INTEGER FUNCTION NF_GET_VARA_INT (NCID, VARID, START, COUNT, ivals)
INTEGER FUNCTION NF_PUT_VARA_INT64 (NCID, VARID, START, COUNT, I8VALS)
INTEGER FUNCTION NF_GET_VARA_INT64 (NCID, VARID, START, COUNT, i8vals)
INTEGER FUNCTION NF_PUT_VARA_REAL (NCID, VARID, START, COUNT, RVALS)
INTEGER FUNCTION NF_GET_VARA_REAL (NCID, VARID, START, COUNT, rvals)
INTEGER FUNCTION NF_PUT_VARA_DOUBLE(NCID, VARID, START, COUNT, DVALS)
INTEGER FUNCTION NF_GET_VARA_DOUBLE(NCID, VARID, START, COUNT, dvals)
INTEGER FUNCTION NF_PUT_VARS_TEXT (NCID, VARID, START, COUNT, STRIDE,
TEXT)
INTEGER FUNCTION NF_GET_VARS_TEXT (NCID, VARID, START, COUNT, STRIDE,
text)
INTEGER FUNCTION NF_PUT_VARS_INT1 (NCID, VARID, START, COUNT, STRIDE,
I1VALS)
INTEGER FUNCTION NF_GET_VARS_INT1 (NCID, VARID, START, COUNT, STRIDE,
i1vals)
INTEGER FUNCTION NF_PUT_VARS_INT2 (NCID, VARID, START, COUNT, STRIDE,
I2VALS)
INTEGER FUNCTION NF_GET_VARS_INT2 (NCID, VARID, START, COUNT, STRIDE,
i2vals)
INTEGER FUNCTION NF_PUT_VARS_INT (NCID, VARID, START, COUNT, STRIDE,
IVALS)
INTEGER FUNCTION NF_GET_VARS_INT (NCID, VARID, START, COUNT, STRIDE,
ivals)
INTEGER FUNCTION NF_PUT_VARS_INT64 (NCID, VARID, START, COUNT, STRIDE,
I8VALS)
INTEGER FUNCTION NF_GET_VARS_INT64 (NCID, VARID, START, COUNT, STRIDE,
i8vals)
INTEGER FUNCTION NF_PUT_VARS_REAL (NCID, VARID, START, COUNT, STRIDE,
RVALS)
INTEGER FUNCTION NF_GET_VARS_REAL (NCID, VARID, START, COUNT, STRIDE,
rvals)
INTEGER FUNCTION NF_PUT_VARS_DOUBLE(NCID, VARID, START, COUNT, STRIDE,
DVALS)
INTEGER FUNCTION NF_GET_VARS_DOUBLE(NCID, VARID, START, COUNT, STRIDE,
dvals)
INTEGER FUNCTION NF_PUT_VARM_TEXT (NCID, VARID, START, COUNT, STRIDE,
IMAP, TEXT)
INTEGER FUNCTION NF_GET_VARM_TEXT (NCID, VARID, START, COUNT, STRIDE,
IMAP, text)
INTEGER FUNCTION NF_PUT_VARM_INT1 (NCID, VARID, START, COUNT, STRIDE,
IMAP, I1VALS)
INTEGER FUNCTION NF_GET_VARM_INT1 (NCID, VARID, START, COUNT, STRIDE,
IMAP, i1vals)
INTEGER FUNCTION NF_PUT_VARM_INT2 (NCID, VARID, START, COUNT, STRIDE,
IMAP, I2VALS)
INTEGER FUNCTION NF_GET_VARM_INT2 (NCID, VARID, START, COUNT, STRIDE,
IMAP, i2vals)
INTEGER FUNCTION NF_PUT_VARM_INT (NCID, VARID, START, COUNT, STRIDE,
IMAP, IVALS)
INTEGER FUNCTION NF_GET_VARM_INT (NCID, VARID, START, COUNT, STRIDE,
IMAP, ivals)
INTEGER FUNCTION NF_PUT_VARM_INT64 (NCID, VARID, START, COUNT, STRIDE,
IMAP, I8VALS)
INTEGER FUNCTION NF_GET_VARM_INT64 (NCID, VARID, START, COUNT, STRIDE,
IMAP, i8vals)
INTEGER FUNCTION NF_PUT_VARM_REAL (NCID, VARID, START, COUNT, STRIDE,
IMAP, RVALS)
INTEGER FUNCTION NF_GET_VARM_REAL (NCID, VARID, START, COUNT, STRIDE,
IMAP, rvals)
INTEGER FUNCTION NF_PUT_VARM_DOUBLE(NCID, VARID, START, COUNT, STRIDE,
IMAP, DVALS)
INTEGER FUNCTION NF_GET_VARM_DOUBLE(NCID, VARID, START, COUNT, STRIDE,
IMAP, dvals)
INTEGER FUNCTION NF_INQ_ATT (NCID, VARID, NAME, xtype, len)
INTEGER FUNCTION NF_INQ_ATTID (NCID, VARID, NAME, attnum)
INTEGER FUNCTION NF_INQ_ATTTYPE (NCID, VARID, NAME, xtype)
INTEGER FUNCTION NF_INQ_ATTLEN (NCID, VARID, NAME, len)
INTEGER FUNCTION NF_INQ_ATTNAME (NCID, VARID, ATTNUM, name)
INTEGER FUNCTION NF_COPY_ATT (NCID_IN, VARID_IN, NAME,
NCID_OUT, VARID_OUT)
INTEGER FUNCTION NF_RENAME_ATT (NCID, VARID, CURNAME, NEWNAME)
INTEGER FUNCTION NF_DEL_ATT (NCID, VARID, NAME)
INTEGER FUNCTION NF_PUT_ATT_TEXT (NCID, VARID, NAME, LEN, TEXT)
INTEGER FUNCTION NF_GET_ATT_TEXT (NCID, VARID, NAME, text)
INTEGER FUNCTION NF_PUT_ATT_INT1 (NCID, VARID, NAME, XTYPE, LEN,
I1VALS)
INTEGER FUNCTION NF_GET_ATT_INT1 (NCID, VARID, NAME, i1vals)
INTEGER FUNCTION NF_PUT_ATT_INT2 (NCID, VARID, NAME, XTYPE, LEN,
I2VALS)
INTEGER FUNCTION NF_GET_ATT_INT2 (NCID, VARID, NAME, i2vals)
INTEGER FUNCTION NF_PUT_ATT_INT (NCID, VARID, NAME, XTYPE, LEN,
IVALS)
INTEGER FUNCTION NF_GET_ATT_INT (NCID, VARID, NAME, ivals)
INTEGER FUNCTION NF_PUT_ATT_INT64 (NCID, VARID, NAME, XTYPE, LEN,
I8VALS)
INTEGER FUNCTION NF_GET_ATT_INT64 (NCID, VARID, NAME, i8vals)
INTEGER FUNCTION NF_PUT_ATT_REAL (NCID, VARID, NAME, XTYPE, LEN,
RVALS)
INTEGER FUNCTION NF_GET_ATT_REAL (NCID, VARID, NAME, rvals)
INTEGER FUNCTION NF_PUT_ATT_DOUBLE (NCID, VARID, NAME, XTYPE, LEN,
DVALS)
INTEGER FUNCTION NF_GET_ATT_DOUBLE (NCID, VARID, NAME, dvals)
INTEGER ATTNUM ! attribute number
INTEGER attnum ! returned attribute number
INTEGER CMODE ! NF_NOCLOBBER, NF_SHARE flags expression
INTEGER COUNT ! array of edge lengths of block of values
CHARACTER(*) CURNAME ! current name (before renaming)
INTEGER DIMID ! dimension ID
INTEGER dimid ! returned dimension ID
INTEGER DIMIDS ! list of dimension IDs
INTEGER dimids ! list of returned dimension IDs
DOUBLEPRECISION DVAL ! single data value
DOUBLEPRECISION dval ! returned single data value
DOUBLEPRECISION DVALS ! array of data values
DOUBLEPRECISION dvals ! array of returned data values
INTEGER FILLMODE ! NF_NOFILL or NF_FILL, for setting fill mode
INTEGER*1 I1VAL ! single data value
INTEGER*1 I1val ! returned single data value
INTEGER*1 I1VALS ! array of data values
INTEGER*1 i1vals ! array of returned data values
INTEGER*2 I2VAL ! single data value
INTEGER*2 i2val ! returned single data value
INTEGER*2 I2VALS ! array of data values
INTEGER*2 i2vals ! array of returned data values
INTEGER IMAP ! index mapping vector
INTEGER INDEX ! variable array index vector
INTEGER IVAL ! single data value
INTEGER ival ! returned single data value
INTEGER IVALS ! array of data values
INTEGER ivals ! array of returned data values
INTEGER*8 I8VAL ! single data value
INTEGER*8 i8val ! returned single data value
INTEGER*8 I8VALS ! array of data values
INTEGER*8 i8vals ! array of returned data values
INTEGER LEN ! dimension or attribute length
INTEGER len ! returned dimension or attribute length
INTEGER MODE ! open mode, one of NF_WRITE or NF_NOWRITE
CHARACTER(*) NAME ! dimension, variable, or attribute name
CHARACTER(*) name ! returned dim, var, or att name
INTEGER natts ! returned number of attributes
INTEGER NCERR ! error returned from NF_xxx function call
INTEGER NCID ! netCDF ID of an open netCDF dataset
INTEGER ncid ! returned netCDF ID
INTEGER NCID_IN ! netCDF ID of open source netCDF dataset
INTEGER NCID_OUT ! netCDF ID of open destination netCDF dataset
INTEGER NDIMS ! number of dimensions
INTEGER ndims ! returned number of dimensions
CHARACTER(*) NEWNAME ! new name for dim, var, or att
INTEGER ngatts ! returned number of global attributes
INTEGER nvars ! returned number of variables
INTEGER old_mode ! previous fill mode, NF_NOFILL or NF_FILL,
CHARACTER(*) PATH ! name of netCDF dataset
REAL RVAL ! single data value
REAL rval ! returned single data value
REAL RVALS ! array of data values
REAL rvals ! array of returned data values
INTEGER START ! variable array indices of first value
INTEGER STRIDE ! variable array dimensional strides
CHARACTER(*) TEXT ! input text value
CHARACTER(*) text ! returned text value
INTEGER unlimdimid ! returned ID of unlimited dimension
INTEGER VARID ! variable ID
INTEGER varid ! returned variable ID
INTEGER VARID_IN ! variable ID
INTEGER VARID_OUT ! variable ID
INTEGER XTYPE ! external type: NF_BYTE, NF_CHAR, ... ,
INTEGER xtype ! returned external type
~~~~
|