Next: Dimensions, Previous: Use of the PnetCDF Library, Up: Top [Index]
This chapter presents the interfaces of the PnetCDF functions that deal with a netCDF file or the whole PnetCDF library.
A netCDF file that has not yet been opened can only be referred to by its file name. Once a netCDF dataset is opened, it is referred to by a netCDF ID, which is a small non-negative integer returned when you create or open the file. 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 opened netCDF files are distinct. A single netCDF file 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 file should permit writing. When an opened netCDF file is closed, the ID is no longer associated with a netCDF file.
Functions that deal with the PnetCDF library include:
The operations supported on a netCDF file as a single object are:
• Interface Descriptions: | What’s in the Function Documentation | |
• ncmpi_strerror: | Get error string from error code | |
• ncmpi_strerrno: | Get string name of an error code (1.8.0 and later) | |
• ncmpi_inq_libvers: | Get PnetCDF library version | |
• ncmpi_create: | Create a File | |
• ncmpi__create: | Create a File with Performance Tuning (not implemented) | |
• ncmpi_open: | Open a File | |
• ncmpi__open: | Open a File with Performance Tuning (not implemented) | |
• ncmpi_redef: | Put a File into Define Mode | |
• ncmpi_enddef: | Leave Define Mode | |
• ncmpi__enddef: | Leave Define Mode with Performance Tuning (1.5.0 and later) | |
• ncmpi_close: | Close a File | |
• ncmpi_inq Family: | Inquire about a File | |
• ncmpi_sync: | Synchronize a File to Disk | |
• ncmpi_abort: | Back Out of Recent Definitions | |
• ncmpi_set_fill: | Set Fill Mode for Writes (1.6.1 and later) | |
• ncmpi_set_default_format: | Change the default output format (1.6.1 and later) | |
• ncmpi_begin_indep_data: | Enter independent parallel data access mode | |
• ncmpi_end_indep_data: | Exit independent data mode | |
• ncmpi_inq_put_size: | Inquire the amount of data put to file so far (1.4.0 and later) | |
• ncmpi_inq_get_size: | Inquire the amount of data got from file so far (1.4.0 and later) | |
• ncmpi_inq_header_size: | Inquire the size of the file header (1.4.0 and later) | |
• ncmpi_inq_header_extent: | Inquire the file header extent (1.4.0 and later) | |
• ncmpi_sync_numrecs: | Synchronize the number of records (1.4.0 and later) | |
• ncmpi_delete: | Delete a file | |
• ncmpi_inq_file_info: | Obtain the MPI Info object that contains all the I/O hints currently used (1.5.0 and later) | |
• ncmpi_get_file_info: | Obtain the MPI Info object that contains all the I/O hints currently used (deprecated) | |
• ncmpi_inq_files_opened: | Reports the number of files that are currently opened (1.5.0 and later) |
Next: Dimensions, Previous: Use of the PnetCDF Library, Up: Top [Index]