/usr/share/doc/netcdf-doc/netcdf_f90-man.html is in netcdf-doc 1:4.1.3-7ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 | <!-- Creator : groff version 1.20.1 -->
<!-- CreationDate: Thu Jun 30 17:23:47 2011 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title>NETCDF</title>
</head>
<body>
<h1 align="center">NETCDF</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#LIBRARY VERSION">LIBRARY VERSION</a><br>
<a href="#ROUTINE DESCRIPTIONS">ROUTINE DESCRIPTIONS</a><br>
<a href="#COMMON ARGUMENT DESCRIPTIONS">COMMON ARGUMENT DESCRIPTIONS</a><br>
<a href="#VARIABLE PREFILLING">VARIABLE PREFILLING</a><br>
<a href="#MPP FUNCTION DESCRIPTIONS">MPP FUNCTION DESCRIPTIONS</a><br>
<a href="#ENVIRONMENT VARIABLES">ENVIRONMENT VARIABLES</a><br>
<a href="#MAILING-LISTS">MAILING-LISTS</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<hr>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">netcdf −
Unidata Network Common Data Form (netCDF) library, version 3
interface</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>use
netcdf</b></p>
<p style="margin-left:11%; margin-top: 1em"><b>Most
Systems:</b> <br>
f90 ... -lnetcdf</p>
<p style="margin-left:11%; margin-top: 1em"><b>CRAY PVP
Systems:</b> <br>
f90 -dp -i64 ... -lnetcdf</p>
<h2>LIBRARY VERSION
<a name="LIBRARY VERSION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">This document
describes version 3 of Unidata netCDF data-access interface
for the Fortran-90 programming language.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="47%">
<p style="margin-top: 1em"><b>character*80
nf90_inq_libvers()</b></p> </td>
<td width="42%">
</td></tr>
</table>
<p style="margin-left:22%;"><b>character(len=80) ::
nf90_inq_libvers</b></p>
<p style="margin-left:11%; margin-top: 1em">Returns a
string identifying the version of the netCDF library, and
when it was built, like: "3.1a of Aug 22 1996 12:57:47
$".</p>
<p style="margin-left:11%; margin-top: 1em">The RCS
<b>ident(1)</b> command will find a string like "$Id:
@(#) netcdf library version 3.1a of Sep 6 1996 15:56:26
$" in the library. The SCCS <b>what(1)</b> command will
find a string like "netcdf library version 3.1a of Aug
23 1996 16:07:40 $".</p>
<h2>ROUTINE DESCRIPTIONS
<a name="ROUTINE DESCRIPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">All netCDF
functions (except <b>nf90_inq_libvers()</b> and
<b>nf90_strerror()</b>) return an integer status. This
behavior replaces the <b>rcode</b> argument used in previous
versions of the library. If this returned status value is
not equal to <b>nf90_noerr</b> (zero), it indicates that an
error occurred. The possible status values are defined in
the module <b>netcdf</b>.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="44%">
<p style="margin-top: 1em"><b>function
nf90_strerror(</b><i>ncerr</i><b>)</b></p> </td>
<td width="45%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncerr
<br>
character(len=80) :: nf90_strerror</p>
<p style="margin-left:22%; margin-top: 1em">Returns a
string textual translation of the <i>ncerr</i> value, like
"Attribute or variable name contains illegal
characters" or "No such file or
directory".</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="60%">
<p style="margin-top: 1em"><b>function
nf90_create(</b><i>path</i><b>,</b> <i>cmode</i><b>,</b>
<i>ncid</i><b>)</b></p> </td>
<td width="29%">
</td></tr>
</table>
<p style="margin-left:22%;">character(len=*), intent(in) ::
path <br>
integer, intent(in) :: cmode <br>
integer, optional, intent(in) :: initialsize <br>
integer, optional, intent(inout) :: chunksize <br>
integer, intent(out) :: ncid <br>
integer :: nf90_create</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>nccre()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Creates a new
netCDF dataset at <i>path</i>, returning a netCDF ID in
<i>ncid</i>. The argument <i>cmode</i> may include the
bitwise-or of the following flags: <b>nf90_noclobber</b> to
protect existing datasets (default silently blows them
away), <b>nf90_share</b> for synchronous dataset updates
(default is to buffer accesses), and <b>nf90_lock</b> (not
yet implemented). When a netCDF dataset is created, is is
opened <b>nf90_write</b>. The new netCDF dataset is in
define mode.</p>
<p style="margin-left:22%; margin-top: 1em">The optional
argument <i>initialsize</i> sets the initial size of the
file at creation time.</p>
<p style="margin-left:22%; margin-top: 1em">See
<b>nf__open()</b> below for an explanation of the optional
<i>chunksize</i> argument.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="72%">
<p style="margin-top: 1em"><b>function
nf90_open(</b><i>path</i><b>,</b> <i>mode</i><b>,</b>
<i>ncid</i><b>,</b> <i>chunksize</i><b>)</b></p></td>
<td width="17%">
</td></tr>
</table>
<p style="margin-left:22%;">character(len=*), intent(in) ::
path <br>
integer, intent(in) :: mode <br>
integer, intent(out) :: ncid <br>
integer, optional, intent(inout) :: chunksize <br>
integer :: nf90_open</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>ncopn()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Opens a
existing netCDF dataset at <i>path</i> returning a netCDF ID
in <i>ncid</i>. As of NetCDF version 4.1, and if DAP support
was enabled when the library was built, the path may instead
specify a DAP URL (refer to the NetCDF user’s manual
for details).</p>
<p style="margin-left:22%; margin-top: 1em">The type of
access is described by the <i>mode</i> parameter, which may
include the bitwise-or of the following flags:
<b>nf90_write</b> for read-write access (default read-only),
<b>nf90_share</b> for synchronous dataset updates (default
is to buffer accesses), and <b>nf90_lock</b> (not yet
implemented).</p>
<p style="margin-left:22%; margin-top: 1em">The optional
argument referenced by <i>chunksize</i> controls a space
versus time tradeoff, memory allocated in the netcdf library
versus 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 <b>nf90_sizehint_default</b> causes the
library to choose a default. How the system choses the
default depends on the system. On many systems, the
"preferred I/O block size" is available from the
<b>stat()</b> system call, <b>struct stat</b> member
<b>st_blksize</b>. 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 chunksize
to 8192.</p>
<p style="margin-left:22%; margin-top: 1em">The chunksize
is a property of a given open netcdf descriptor <i>ncid</i>:
it is not a persistent property of the netcdf dataset.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="74%">
<p style="margin-top: 1em"><b>function
nf90_set_fill(</b><i>ncid</i><b>,</b>
<i>fillmode</i><b>,</b> <i>old_mode</i><b>)</b></p></td>
<td width="15%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid,
fillmode <br>
integer, intent(out) :: old_mode <br>
integer :: nf90_set_fill</p>
<p style="margin-left:22%; margin-top: 1em">Sets the
fill-mode for a netCDF dataset to optimize writes under some
circumstances. The fill-mode argument, <i>fillmode</i>, can
be either <b>nf90_fill</b> or <b>nf90_nofill</b>.
<b>nf90_fill</b> causes fill-values to be written into
non-record variables and into skipped-over records when
writing beyond the last valid record. <b>nf90_nofill</b>
suspends this behavior. The default behavior corresponds to
<b>nf90_fill</b>.</p>
<p style="margin-left:22%; margin-top: 1em">The previous
fill-mode value is return in <i>old_mode</i>.</p>
<p style="margin-left:22%; margin-top: 1em">The fill-mode
is a property of a given open netcdf descriptor <i>ncid</i>:
it is not a persistent property of the netcdf dataset.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="38%">
<p style="margin-top: 1em"><b>function
nf90_redef(</b><i>ncid</i><b>)</b></p> </td>
<td width="51%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid
<br>
integer :: nf90_redef</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>ncredf()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Puts an open
netCDF dataset into define mode, so dimensions, variables,
and attributes can be added or renamed and attributes can be
deleted.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p style="margin-top: 1em"><b>function
nf90_enddef(</b><i>ncid</i><b>,</b> <i>h_minfree</i><b>,</b>
<i>v_align</i><b>,</b> <i>v_minfree</i><b>,</b>
<i>r_align</i><b>)</b></p> </td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid
<br>
integer, optional, intent(in) :: h_minfree, v_align <br>
integer, optional, intent(in) :: v_minfree, r_align <br>
integer :: nf90_enddef</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>ncendf()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">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. Some data values
may be written as well, see "VARIABLE PREFILLING"
below. After a successful call, variable data can be read or
written to the dataset.</p>
<p style="margin-left:22%; margin-top: 1em">The optional
arguments are performance tuning parameters. They exposes
internals of the netcdf version 1 file format and may not be
available on future netcdf implementations.</p>
<p style="margin-left:22%; margin-top: 1em">The current
netcdf file format has three sections, the
"header" section, the data section for fixed size
variables, and the data section 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 two sections is contained in the
header. Typically, there is no space between the sections.
This causes copying overhead to accrue if one wishes to
change the size of the sections, 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 aligning sections in certain ways.</p>
<p style="margin-left:22%; margin-top: 1em">The minfree
parameters allow one to control costs of future calls to
<b>nf90_redef()</b>, <b>nf90_enddef()</b> by requesting that
<i>minfree</i> bytes be available at the end of the section.
The <i>h_minfree</i> parameter sets the pad at the end of
the "header" section. The <i>v_minfree</i>
parameter sets the pad at the end of the data section for
fixed size variables.</p>
<p style="margin-left:22%; margin-top: 1em">The align
parameters allow one to set the alignment of the beginning
of the corresponding sections. The beginning of the section
is rounded up to an index which is a multiple of the align
parameter. The flag value <b>nf90_align_chunk</b> tells the
library to use the chunksize (see above) as the align
parameter. The <i>v_align</i> parameter controls the
alignment of the beginning of the data section for fixed
size variables. The <i>r_align</i> parameter controls the
alignment of the beginning of the data section for variables
which have an unlimited dimension (record variables).</p>
<p style="margin-left:22%; margin-top: 1em">The file format
requires mod 4 alignment, so the align parameters are
silently rounded up to multiples of 4. The usual call,
<b>nf90_enddef(</b><i>ncid</i><b>)</b> is equivalent to
<b>nf__enddef(</b><i>ncid</i><b>, 0, 4, 0, 4)</b>.</p>
<p style="margin-left:22%; margin-top: 1em">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 section will always be copied with the
new variable added.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="37%">
<p style="margin-top: 1em"><b>function
nf90_sync(</b><i>ncid</i><b>)</b></p> </td>
<td width="52%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid
<br>
integer :: nf90_sync</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>ncsnc()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Unless the
<b>nf90_share</b> bit is set in <b>nf90_open()</b> or
<b>nf90_create()</b>, accesses to the underlying netCDF
dataset are buffered by the library. This function
synchronizes the state of the underlying dataset and the
library. This is done automatically by <b>nf90_close()</b>
and <b>nf90_enddef()</b>.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="38%">
<p style="margin-top: 1em"><b>function
nf90_abort(</b><i>ncid</i><b>)</b></p> </td>
<td width="51%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid
<br>
integer :: nf90_abort</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>ncabor()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">You don’t
need to call this function. This function is called
automatically by <b>nf90_close()</b> if the netCDF dataset
was in define mode and something goes wrong with the commit.
If the netCDF dataset isn’t in define mode, then this
function is equivalent to <b>nf90_close()</b>. If it is
called after <b>nf90_redef()</b>, but before
<b>nf90_enddef()</b>, the new definitions are not committed
and the dataset is closed. If it is called after
<b>nf90_create()</b> but before <b>nf90_enddef()</b>, the
dataset disappears.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="38%">
<p style="margin-top: 1em"><b>function
nf90_close(</b><i>ncid</i><b>)</b></p> </td>
<td width="51%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid
<br>
integer :: nf90_close</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>ncclos()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Closes an open
netCDF dataset. If the dataset is in define mode,
<b>nf90_enddef()</b> will be called before closing. After a
dataset is closed, its ID may be reassigned to another
dataset.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p style="margin-top: 1em"><b>function
nf90_inquire(</b><i>ncid</i><b>,</b> <i>ndims</i><b>,</b>
<i>nvars</i><b>,</b> <i>natts</i><b>,</b>
<i>unlimdimid</i><b>,</b> <i>nformat</i><b>)</b></p></td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid
<br>
integer, optional, intent(out) :: ndims, nvars <br>
integer, optional, intent(out) :: natts, unlimdimid <br>
integer, optional, intent(out) :: nformat <br>
integer :: nf90_inquire</p>
<p style="margin-left:22%; margin-top: 1em">Inquire about
an open netCDF dataset. <i>ncid</i> is the netCDF ID of the
open dataset. Upon successful return, <i>ndims</i> will
contain the number of dimensions defined for this netCDF
dataset, <i>nvars</i> will contain the number of variables,
<i>natts</i> will contain the number of attributes, and
<i>unlimdimid</i> will contain the dimension ID of the
unlimited dimension if one exists, or 0 otherwise.
<i>nformat</i> will contain the format version number,
rarely needed because the library detects the format version
and behaves appropriately.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="69%">
<p style="margin-top: 1em"><b>function
nf90_def_dim(</b><i>ncid</i><b>,</b> <i>name</i><b>,</b>
<i>len</i><b>,</b> <i>dimid</i><b>)</b></p></td>
<td width="20%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid
<br>
character(len=*), intent(in) :: name <br>
integer, intent(in) :: len <br>
integer, intent(out) :: dimid <br>
integer :: nf90_def_dim</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>ncddef()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Adds a new
dimension to an open netCDF dataset, which must be in define
mode. <i>name</i> is the dimension name. <i>len</i> is the
size of the new dimension or <b>nf90_unlimited</b> to define
the unlimited dimension. On return, <i>dimid</i> will
contain the dimension ID of the newly created dimension.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="64%">
<p style="margin-top: 1em"><b>function
nf90_inq_dimid(</b><i>ncid</i><b>,</b> <i>name</i><b>,</b>
<i>dimid</i><b>)</b></p> </td>
<td width="25%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid
<br>
character(len=*), intent(in) :: name <br>
integer, intent(out) :: dimid <br>
integer :: nf90_inq_dimid</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>ncdid()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Given an open
netCDF dataset and dimension name, returns the dimension ID
of the netCDF dimension in <i>dimid</i>.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="84%">
<p style="margin-top: 1em"><b>function
nf90_inquire_dimension(</b><i>ncid</i><b>,</b>
<i>dimid</i><b>,</b> <i>name</i><b>,</b>
<i>len</i><b>)</b></p> </td>
<td width="5%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid,
dimid <br>
character(len=*), optional, intent(out) :: name <br>
integer, optional, intent(out) :: len <br>
integer :: nf90_inquire_dimension</p>
<p style="margin-left:22%; margin-top: 1em">Inquire about a
dimension. <i>name</i> should be big enough
(<b>nf90_max_name</b>) to hold the dimension name as the
name will be copied into your storage. The length return
parameter, <i>len</i> will contain the size of the
dimension. For the unlimited dimension, the returned length
is the current maximum value used for writing into any of
the variables which use the dimension.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="66%">
<p style="margin-top: 1em"><b>function
nf90_rename_dim(</b><i>ncid</i><b>,</b> <i>dimid</i><b>,</b>
<i>name</i><b>)</b></p> </td>
<td width="23%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid
<br>
character(len=*), intent(in) :: name <br>
integer, intent(in) :: dimid <br>
integer :: nf90_rename_dim</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>ncdren()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Renames an
existing dimension 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 dimension to have the
same name as another dimension.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="84%">
<p style="margin-top: 1em"><b>function
nf90_def_var(</b><i>ncid</i><b>,</b> <i>name</i><b>,</b>
<i>xtype</i><b>,</b> <i>dimids</i><b>,</b>
<i>varid</i><b>)</b></p> </td>
<td width="5%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid
<br>
character(len=*), intent(in) :: name <br>
integer, intent(in) :: xtype <br>
integer, optional, dimension(:), intent(in) :: dimids <br>
integer :: nf90_def_var</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>ncvdef()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Adds a new
variable to a netCDF dataset. The netCDF must be in define
mode. <i>name</i> will be the name of the netCDF variable.
<i>xtype</i> is the external, netCDF type of the variable
and should be one of <b>nf90_byte</b>, <b>nf90_char</b>,
<b>nf90_short</b>, <b>nf90_int</b>, <b>nf90_float</b>, or
<b>nf90_double</b>, The optional <i>dimids</i> argument
contains the dimension ID-s of the domain of the netCDF
variable and, consequently, determines the rank of the
created variable: if <i>dimids</i> is omitted, then the
netCDF variable will be a scalar; if <i>dimids</i> is a
scalar, then the netCDF variable will be 1 dimensional; and
if <i>dimids</i> is a vector, then the netCDF variable will
have rank equal to the number of elements in <i>dimids</i>.
<i>varid</i> will be set to the netCDF variable ID.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="64%">
<p style="margin-top: 1em"><b>function
nf90_inq_varid(</b><i>ncid</i><b>,</b> <i>name</i><b>,</b>
<i>varid</i><b>)</b></p> </td>
<td width="25%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid
<br>
character(len=*), intent(in) :: name <br>
integer, intent(out) :: varid <br>
integer :: nf90_inq_varid</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>ncvid()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Returns the ID
of a netCDF variable in <i>varid</i> given an open netCDF
dataset and the name of the variable.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p style="margin-top: 1em"><b>function
nf90_inquire_variable(</b><i>ncid</i><b>,</b>
<i>varid</i><b>,</b> <i>name</i><b>,</b>
<i>xtype</i><b>,</b> <i>ndims</i><b>,</b>
<i>dimids</i><b>,</b> <i>natts</i><b>)</b></p></td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid,
varid <br>
character(len=*), optional, intent(out) :: name <br>
integer, optional, intent(out) :: xtype, ndims <br>
integer, dimension(*), optional, intent(out) :: dimids <br>
integer, optional, intent(out) :: natts <br>
integer :: nf90_inquire_variable</p>
<p style="margin-left:22%; margin-top: 1em">Inquire about a
netCDF variable in an open netCDF dataset, given its
variable ID. On return, <i>name</i> will contain the name of
the variable and should be capacious enough
(<b>nf90_max_name</b>). <i>xtype</i> will contain the
external, netCDF type of the variable. <i>ndims</i> will
contain the dimensionality of the netCDF variable: if the
variable is a scalar, then size(<i>ndims</i>) will be zero;
otherwise, size(<i>ndims</i>) will be the rank of the
variable and <i>ndims</i> will contain the dimension ID-s of
the netCDF dimensions that constitute the domain of the
variable. <i>natts</i> will contain the number of attributes
associated with the netCDF variable.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="66%">
<p style="margin-top: 1em"><b>function
nf90_rename_var(</b><i>ncid</i><b>,</b> <i>varid</i><b>,</b>
<i>name</i><b>)</b></p> </td>
<td width="23%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent9in) :: ncid,
varid <br>
character(len=*), intent(in) :: newname <br>
integer :: nf90_rename_var</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>ncvren()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Changes the
name of a netCDF variable. If the new name is longer than
the old name, the netCDF must be in define mode. You cannot
rename a variable to have the name of any existing
variable.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p style="margin-top: 1em"><b>function
nf90_put_var(</b><i>ncid</i><b>,</b> <i>varid</i><b>,</b>
<i>values</i><b>,</b> <i>start</i><b>,</b>
<i>stride</i><b>,</b> <i>imap</i><b>)</b></p></td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid,
varid <br>
<<whatever>>, intent(in) :: values <br>
integer, dimension(:), optional, intent(in) :: start <br>
integer, dimension(:), optional, intent(in) :: stride <br>
integer, dimension(:), optional, intent(in) :: imap <br>
integer :: nf90_put_var</p>
<p style="margin-left:22%; margin-top: 1em">(Replaces
<b>ncvpt()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Writes a value
or values to a netCDF variable. The netCDF dataset must be
open and in data mode. <i>values</i> contains the value(s)
what will be written to the netCDF variable identified by
<i>ncid</i> and <i>varid</i>; it may be a scalar or an array
and must be of type <b>character</b>,
<b>integer(kind=OneByteInt)</b>,
<b>integer(kind=TwoByteInt)</b>,
<b>integer(kind=FourByteInt)</b>,
<b>integer(kind=EightByteInt)</b>,
<b>real(kind=FourByteReal)</b>, or
<b>real(kind=EightByteReal)</b>. All values are converted to
the external type of the netCDF variable, if possible;
otherwise, an <b>nf90_erange</b> error is returned. The
optional argument <i>start</i> specifies the starting index
in the netCDF variable for writing for each dimension of the
netCDF variable. The optional argument <i>stride</i>
specifies the sampling stride (the interval between accessed
values in the netCDF variable) for each dimension of the
netCDF variable (see COMMON ARGUMENT DESCRIPTIONS below).
The optional argument <i>imap</i> specifies the in-memory
arrangement of the data values (see COMMON ARGUMENT
DESCRIPTIONS below).</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p style="margin-top: 1em"><b>function
nf90_get_var(</b><i>ncid</i><b>,</b> <i>varid</i><b>,</b>
<i>values</i><b>,</b> <i>start</i><b>,</b>
<i>stride</i><b>,</b> <i>imap</i><b>)</b></p></td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid,
varid <br>
<<whatever>>, intent(out) :: values <br>
integer, dimension(:), optional, intent(in) :: start <br>
integer, dimension(:), optional, intent(in) :: stride <br>
integer, dimension(:), optional, intent(in) :: imap <br>
integer :: nf90_get_var</p>
<p style="margin-left:22%; margin-top: 1em">(Replaces
<b>ncvgt()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Reads a value
or values from a netCDF variable. The netCDF dataset must be
open and in data mode. <i>values</i> will receive the
value(s) what will be read from the netCDF <br>
variable identified by <i>ncid</i> and <i>varid</i>; it may
be a scalar or an array and must be of type
<b>character</b>, <b>integer(kind=OneByteInt)</b>,
<b>integer(kind=TwoByteInt)</b>,
<b>integer(kind=FourByteInt)</b>,
<b>integer(kind=EightByteInt)</b>,
<b>real(kind=FourByteReal)</b>, or
<b>real(kind=EightByteReal)</b>. All values are converted
from the external type of the netCDF variable, if possible;
otherwise, an <b>nf90_erange</b> error is returned. The
optional argument <i>start</i> specifies the starting index
in the netCDF variable for reading for each dimension of the
netCDF variable. The optional argument <i>stride</i>
specifies the sampling stride (the interval between accessed
values in the netCDF variable) for each dimension of the
netCDF variable (see COMMON ARGUMENT DESCRIPTIONS below).
The optional argument <i>imap</i> specifies the in-memory
arrangement of the data values (see COMMON ARGUMENT
DESCRIPTIONS below).</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p style="margin-top: 1em"><b>function
nf90_inquire_attribute(</b><i>ncid</i><b>,</b>
<i>varid</i><b>,</b> <i>name</i><b>,</b>
<i>xtype</i><b>,</b> <i>len</i><b>,</b>
<i>attnum</i><b>)</b></p> </td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid,
varid <br>
character(len=*), intent(in) :: name <br>
integer, optional, intent(out) :: xtype, len, attnum <br>
integer :: nf90_inquire_attribute</p>
<p style="margin-left:22%; margin-top: 1em">Inquires about
the netCDF attribute named <i>name</i>, of variable
<i>varid</i>, in the open netCDF dataset <i>ncid</i>.
<i>xtype</i> will contain the external, netCDF type of the
variable. <i>len</i> will contain the number of elements in
the attribute. <i>attnum</i> will contain the attribute
number.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="80%">
<p style="margin-top: 1em"><b>function
nf90_inq_attname(</b><i>ncid</i><b>,</b>
<i>varid</i><b>,</b> <i>attnum</i><b>,</b>
<i>name</i><b>)</b></p> </td>
<td width="9%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid,
varid, attnum <br>
character(len=*), intent(out) :: name <br>
integer :: nf90_inq_attname</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>ncanam()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Gets the name
of an attribute, given its variable ID and attribute number.
This function is useful in generic applications that need to
get the names of all the attributes associated with a
variable because attributes are accessed by name rather than
number in all other attribute functions (the number of an
attribute is more volatile than the name because it can
change when other attributes of the same variable are
deleted). The attributes for each variable are numbered from
1 (the first attribute) to <i>natts</i>, where <i>natts</i>
is the number of attributes for the variable, as returned
from a call to <b>nf90_inquire_variable()</b>.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="74%">
<p style="margin-top: 1em"><b>function
nf90_put_att(</b><i>ncid</i><b>,</b> <i>varid</i><b>,</b>
<i>name</i><b>,</b> <i>values</i><b>)</b></p></td>
<td width="15%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid,
varid <br>
character(len=*), intent(in) :: name <br>
<<whatever>>, intent(in) :: values <br>
integer :: nf90_put_att</p>
<p style="margin-left:22%; margin-top: 1em">Unlike
variables, attributes do not have separate functions for
defining and writing values. This function defines a new
attribute with a value or changes the value of an existing
attribute. If the attribute is new, or if the space required
to store the attribute value is greater than before, the
netCDF dataset must be in define mode. <i>values</i>
contains the attribute values to be written; it may be a
scalar or a vector and must be of type <b>character</b>,
<b>integer(kind=OneByteInt)</b>,
<b>integer(kind=TwoByteInt)</b>,
<b>integer(kind=FourByteInt)</b>,
<b>integer(kind=EightByteInt)</b>,
<b>real(kind=FourByteReal)</b>, or
<b>real(kind=EightByteReal)</b>.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="77%">
<p style="margin-top: 1em"><b>function
nf90_get_att(</b><i>ncid</i><b>,</b> <i>varid</i><b>,</b>
<i>name</i><b>, fIvalues</b><i>)</i></p></td>
<td width="12%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid,
varid <br>
character(len=*), intent(in) :: name <br>
<<whatever>>, intent(out) :: values <br>
integer :: nf90_get_att</p>
<p style="margin-left:22%; margin-top: 1em">(Replaces
<b>ncagt()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Gets the
value(s) of a netCDF attribute, given its variable ID and
name. The values are returned in <i>values</i>, which must
be of type <b>character</b>,
<b>integer(kind=OneByteInt)</b>,
<b>integer(kind=TwoByteInt)</b>,
<b>integer(kind=FourByteInt)</b>,
<b>integer(kind=EightByteInt)</b>,
<b>real(kind=FourByteReal)</b>, or
<b>real(kind=EightByteReal)</b>. Converts from the external
type to the type of the receiving variable, if possible;
otherwise returns an <b>nf90_erange</b> error. All values of
the attribute are returned, so you must allocate enough
space to hold them. If you don’t know how much space
to reserve, call <b>nf90_inquire_attribute()</b> first to
find out the length of the attribute.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p style="margin-top: 1em"><b>function
nf90_copy_att(</b><i>ncid_in</i><b>,</b>
<i>varid_in</i><b>,</b> <i>name</i><b>,</b>
<i>ncid_out</i><b>,</b> <i>varid_out</i><b>)</b></p></td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid_in,
varid_in <br>
character(len=*), intent(in) :: name <br>
integer, intent(in) :: ncid_out, varid_out <br>
integer :: nf90_copy_att</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>ncacpy()</b> in version 2)</p>
<p style="margin-left:22%; margin-top: 1em">Copies an
attribute from one netCDF dataset to another. It can also be
used to copy an attribute from one variable to another
within the same netCDF dataset. <i>ncid_in</i> is the netCDF
ID of an input netCDF dataset from which the attribute will
be copied. <i>varid_in</i> is the ID of the variable in the
input netCDF dataset from which the attribute will be
copied, or <b>nf90_global</b> for a global attribute.
<i>name</i> is the name of the attribute in the input netCDF
dataset to be copied. <i>ncid_out</i> is the netCDF ID of
the output netCDF dataset to which the attribute will be
copied. It is permissible for the input and output netCDF
ID’s 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. <i>varid_out</i> is
the ID of the variable in the output netCDF dataset to which
the attribute will be copied, or <b>nf90_global</b> to copy
to a global attribute.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="80%">
<p style="margin-top: 1em"><b>function
nf90_rename_att(</b><i>ncid</i><b>,</b> <i>varid</i><b>,</b>
<i>name</i><b>,</b> <i>newname</i><b>)</b></p></td>
<td width="9%">
</td></tr>
</table>
<p style="margin-left:22%;">integer, intent(in) :: ncid,
varid <br>
character(len=*), intent(in) :: name, newname <br>
integer :: nf90_rename_att</p>
<p style="margin-left:22%; margin-top: 1em">(Corresponds to
<b>ncaren()</b></p>
<p style="margin-left:22%; margin-top: 1em">Changes the
name of an attribute. If the new name is longer than the
original name, the netCDF must be in define mode. You cannot
rename an attribute to have the same name as another
attribute of the same variable. <i>name</i> is the original
attribute name. <i>newname</i> is the new name to be
assigned to the specified attribute. If the new name is
longer than the old name, the netCDF dataset must be in
define mode.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="22%"></td>
<td width="61%">
<p style="margin-top: 1em"><b>function
nf90_del_att(</b><i>ncid</i><b>,</b> <i>varid</i><b>,</b>
<i>name</i><b>)</b></p> </td>
<td width="17%">
</td></tr>
</table>
<p style="margin-left:32%;">integer, intent(in) :: ncid,
varid <br>
character(len=*), intent(in) :: name <br>
integer :: nf90_del_att</p>
<p style="margin-left:32%; margin-top: 1em">(Corresponds to
<b>ncadel()</b> in version 2)</p>
<p style="margin-left:32%; margin-top: 1em">Deletes an
attribute from a netCDF dataset. The dataset must be in
define mode.</p>
<h2>COMMON ARGUMENT DESCRIPTIONS
<a name="COMMON ARGUMENT DESCRIPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">In this section
we define some common arguments which are used in the
"FUNCTION DESCRIPTIONS" section. <br>
integer <i>ncid</i></p>
<p style="margin-left:22%;">is the netCDF ID returned from
a previous, successful call to <b>nf90_open()</b> or
<b>nf90_create()</b></p>
<p style="margin-left:11%;">character(len=*)
<i>name</i></p>
<p style="margin-left:22%;">is the name of a dimension,
variable, or attribute. It shall begin with an alphabetic
character, followed by zero or more alphanumeric characters
including the underscore (‘_’) or hyphen
(‘-’). Case is significant. The maximum
allowable number of characters is <b>nf90_max_name</b>.
Names that begin with an underscore (‘_’) are
reserved for use by the netCDF interface.</p>
<p style="margin-left:11%;">integer <i>xtype</i></p>
<p style="margin-left:22%;">specifies the external data
type of a netCDF variable or attribute and is one of the
following: <b>nf90_byte</b>, <b>nf90_char</b>,
<b>nf90_short</b>, <b>nf90_int</b>, <b>nf90_float</b>, or
<b>nf90_double</b>. These are used to specify 8-bit
integers, characters, 16-bit integers, 32-bit integers,
32-bit IEEE floating point numbers, and 64-bit IEEE
floating-point numbers, respectively.</p>
<p style="margin-left:11%;">integer <i>dimids</i></p>
<p style="margin-left:22%;">is a vector of dimension
ID’s and defines the shape of a netCDF variable. The
size of the vector shall be greater than or equal to the
rank (i.e. the number of dimensions) of the variable
(<i>ndims</i>). The vector shall be ordered by the speed
with which a dimension varies: <i>dimids</i>(1) shall be the
dimension ID of the most rapidly varying dimension and
<i>dimids</i>(<i>ndims</i>) shall be the dimension ID of the
most slowly varying dimension. The maximum possible number
of dimensions for a variable is given by the symbolic
constant <b>nf90_max_var_dims</b>.</p>
<p style="margin-left:11%;">integer <i>dimid</i></p>
<p style="margin-left:22%;">is the ID of a netCDF
dimension. netCDF dimension ID’s are allocated
sequentially from the positive integers beginning with
1.</p>
<p style="margin-left:11%;">integer <i>ndims</i></p>
<p style="margin-left:22%;">is either the total number of
dimensions in a netCDF dataset or the rank (i.e. the number
of dimensions) of a netCDF variable. The value shall not be
negative or greater than the symbolic constant
<b>nf90_max_var_dims</b>.</p>
<p style="margin-left:11%;">integer <i>varid</i></p>
<p style="margin-left:22%;">is the ID of a netCDF variable
or (for the attribute-access functions) the symbolic
constant <b>nf90_global</b>, which is used to reference
global attributes. netCDF variable ID’s are allocated
sequentially from the positive integers beginning with
1.</p>
<p style="margin-left:11%;">integer <i>natts</i></p>
<p style="margin-left:22%;">is the number of global
attributes in a netCDF dataset for the <b>nf90_inquire()</b>
function or the number of attributes associated with a
netCDF variable for the <b>nf90_varinq()</b> function.</p>
<p style="margin-left:11%;">integer <i>start</i></p>
<p style="margin-left:22%;">specifies the starting point
for accessing a netCDF variable’s data values in terms
of the indicial coordinates of the corner of the array
section. The indices start at 1; thus, the first data value
of a variable is (1, 1, ..., 1). The size of the vector
shall be at least the rank of the associated netCDF variable
and its elements shall correspond, in order, to the
variable’s dimensions.</p>
<p style="margin-left:11%;">integer <i>stride</i></p>
<p style="margin-left:22%;">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 (<i>stride</i>(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.).</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">
<p><i>imap</i></p></td>
<td width="5%"></td>
<td width="78%">
<p>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
(<i>imap</i>(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 type-independent 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).</p></td></tr>
</table>
<h2>VARIABLE PREFILLING
<a name="VARIABLE PREFILLING"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">By default, the
netCDF interface sets the values of all newly-defined
variables of finite length (i.e. those that do not have an
unlimited, dimension) to the type-dependent fill-value
associated with each variable. This is done when
<b>nf90_enddef()</b> is called. The fill-value for a
variable may be changed from the default value by defining
the attribute ‘<b>_FillValue</b>’ for the
variable. This attribute must have the same type as the
variable and be of length one.</p>
<p style="margin-left:11%; margin-top: 1em">Variables with
an unlimited dimension are also prefilled, but on an
‘as needed’ basis. For example, if the first
write of such a variable is to position 5, then positions 1
through 4 (and no others) would be set to the fill-value at
the same time.</p>
<p style="margin-left:11%; margin-top: 1em">This default
prefilling of data values may be disabled by or’ing
the <b>nf90_nofill</b> flag into the mode parameter of
<b>nf90_open()</b> or <b>nf90_create()</b>, or, by calling
the function <b>nf90_set_fill()</b> with the argument
<b>nf90_nofill</b>. For variables that do not use the
unlimited dimension, this call must be made before
<b>nf90_enddef()</b>. For variables that use the unlimited
dimension, this call may be made at any time.</p>
<p style="margin-left:11%; margin-top: 1em">One can obtain
increased performance of the netCDF interface by using this
feature, but only at the expense of requiring the
application to set every single data value. The performance
enhancing behavior of this function is dependent on the
particulars of the implementation and dataset format. The
flag value controlled by <b>nf90_set_fill()</b> is per
netCDF ID, not per variable or per write. Allowing this to
change affects the degree to which a program can be
effectively parallelized. Given all of this, we state that
the use of this feature may not be available (or even
needed) in future releases. Programmers are cautioned
against heavy reliance upon this feature.</p>
<h2>MPP FUNCTION DESCRIPTIONS
<a name="MPP FUNCTION DESCRIPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Additional
functions for use on SGI/Cray MPP machines (_CRAYMPP). These
are used to set and inquire which PE is the base for MPP for
a particular netCDF. These are only relevant when using the
SGI/Cray ‘‘global’’ Flexible File
I/O layer and desire to have only a subset of PEs to open
the specific netCDF file. For technical reasons, these
functions are available on all platforms. On a platform
other than SGI/Cray MPP, it is as if only processor
available were processor 0.</p>
<p style="margin-left:11%; margin-top: 1em">To use this
feature, you need to specify a communicator group and call
<b>glio_group_mpi()</b> or <b>glio_group_shmem()</b> prior
to the netCDF <b>nf90_open()</b> and <b>nf90_create()</b>
calls.</p>
<p style="margin-left:11%; margin-top: 1em">Note that the
routines described below are Fortran-77 routines rather than
Fortran-90 routines (they have an "nf_" prefix
rather than an "nf90_" prefix).</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p style="margin-top: 1em"><b>integer function
nf__create_mp(character*(*)</b> <i>path</i><b>, integer</b>
<i>cmode</i><b>, integer</b> <i>initialsize</i><b>,
integer</b> <i>pe</i><b>, integer</b> <i>chunksize</i><b>,
integer</b> <i>ncid</i><b>)</b></p></td></tr>
</table>
<p style="margin-left:22%; margin-top: 1em">Like
<b>nf__create()</b> but allows the base PE to be set.</p>
<p style="margin-left:22%; margin-top: 1em">The argument
<i>pe</i> sets the base PE at creation time. In the MPP
environment, <b>nf__create()</b> and <b>nf90_create()</b>
set the base PE to processor zero by default.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="89%">
<p style="margin-top: 1em"><b>integer function
nf__open_mp(character*(*)</b> <i>path</i><b>, integer</b>
<i>mode</i><b>, integer</b> <i>pe</i><b>, integer</b>
<i>chunksize</i><b>, integer</b> <i>ncid</i><b>)</b></p></td></tr>
</table>
<p style="margin-left:22%; margin-top: 1em">Like
<b>nf__open()</b> but allows the base PE to be set. The
argument <i>pe</i> sets the base PE at creation time. In the
MPP environment, <b>nf__open()</b> and <b>nf90_open()</b>
set the base PE to processor zero by default.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="87%">
<p style="margin-top: 1em"><b>integer function
nf_inq_base_pe(integer</b> <i>ncid</i><b>, integer</b>
<i>pe</i><b>)</b></p> </td>
<td width="2%">
</td></tr>
</table>
<p style="margin-left:22%; margin-top: 1em">Inquires of the
netCDF dataset which PE is being used as the base for MPP
use. This is safe to use at any time.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="87%">
<p style="margin-top: 1em"><b>integer function
nf_set_base_pe(integer</b> <i>ncid</i><b>, integer</b>
<i>pe</i><b>)</b></p> </td>
<td width="2%">
</td></tr>
</table>
<p style="margin-left:22%; margin-top: 1em">Resets the base
PE for the netCDF dataset. Only perform this operation when
the affected communicator group synchronizes before and
after the call. This operation is very risky and should only
be contemplated under only the most extreme cases.</p>
<h2>ENVIRONMENT VARIABLES
<a name="ENVIRONMENT VARIABLES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>NETCDF_FFIOSPEC</b></p>
<p style="margin-left:17%;">Specifies the Flexible File I/O
buffers for netCDF I/O when executing under the UNICOS
operating system (the variable is ignored on other operating
systems). An appropriate specification can greatly increase
the efficiency of netCDF I/O -- to the extent that it can
actually surpass FORTRAN binary I/O. This environment
variable has been made a little more generalized, such that
other FFIO option specifications can now be added. The
default specification is <b>bufa:336:2</b>, unless a current
FFIO specification is in operation, which will be honored.
See UNICOS Flexible File I/O for more information.</p>
<h2>MAILING-LISTS
<a name="MAILING-LISTS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Both a mailing
list and a digest are available for discussion of the netCDF
interface and announcements about netCDF bugs, fixes, and
enhancements. To begin or change your subscription to either
the mailing-list or the digest, send one of the following in
the body (not the subject line) of an email message to
"majordomo@unidata.ucar.edu". Use your email
address in place of <i>jdoe@host.inst.domain</i>.</p>
<p style="margin-left:11%; margin-top: 1em">To subscribe to
the netCDF mailing list:</p>
<p style="margin-left:22%;"><b>subscribe netcdfgroup</b>
<i>jdoe@host.inst.domain</i></p>
<p style="margin-left:11%;">To unsubscribe from the netCDF
mailing list:</p>
<p style="margin-left:22%;"><b>unsubscribe netcdfgroup</b>
<i>jdoe@host.inst.domain</i></p>
<p style="margin-left:11%;">To subscribe to the netCDF
digest:</p>
<p style="margin-left:22%;"><b>subscribe netcdfdigest</b>
<i>jdoe@host.inst.domain</i></p>
<p style="margin-left:11%;">To unsubscribe from the netCDF
digest:</p>
<p style="margin-left:22%;"><b>unsubscribe netcdfdigest</b>
<i>jdoe@host.inst.domain</i></p>
<p style="margin-left:11%;">To retrieve the general
introductory information for the mailing list:</p>
<p style="margin-left:22%;"><b>info netcdfgroup</b></p>
<p style="margin-left:11%;">To get a synopsis of other
majordomo commands:</p>
<p style="margin-left:22%;"><b>help</b></p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>ncdump</b>(1),
<b>ncgen</b>(1), <b>netcdf</b>(3f).</p>
<p style="margin-left:11%; margin-top: 1em"><i>netCDF
User’s Guide</i>, published by the Unidata Program
Center, University Corporation for Atmospheric Research,
located in Boulder, Colorado.</p>
<hr>
</body>
</html>
|