mirror/netcdf-c
2
0
Fork 0
mirror of https://github.com/Unidata/netcdf-c.git synced 2024-11-27 07:30:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

updated docs on nc_def_var_chunking to describe behavior of scalars

Browse Source
This commit is contained in:
Edward Hartnett 2020-02-26 09:16:30 -07:00
parent 418e428a05
commit 6fe489c8d5
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
libdispatch/dvar.c
View File

@ -474,7 +474,7 @@ nc_def_var_fletcher32(int ncid, int varid, int fletcher32)
The storage may be set to NC_CONTIGUOUS, NC_COMPACT, or NC_CHUNKED.
Contiguous storage means the variable is stored as one block of
data in the file.
data in the file. This is the default storage.
Compact storage means the variable is stored in the header record
of the file. This can have large performance benefits on HPC system
@ -496,8 +496,10 @@ nc_def_var_fletcher32(int ncid, int varid, int fletcher32)
before nc_enddef is called. Once the chunking parameters are set for a
variable, they cannot be changed.
Note that this does not work for scalar variables. Only non-scalar
variables can have chunking.
Note scalar variables may have a storage of NC_CONTIGUOUS or
NC_COMPACT. Attempts to set chunking on a scalare variable will be
ignored by the library (but no error code is returned). Only
non-scalar variables can have chunking.
@param ncid NetCDF ID, from a previous call to nc_open() or
nc_create().