Enter the "define" mode of the file. More...

Functions/Subroutines
integer function	spio_def_file::pio_redef_fh (fh)
	Enter the "define" mode of a file. More...

integer function	spio_def_file::pio_redef_file (file)
	Enter the "define" mode of a file. More...

Detailed Description

Enter the "define" mode of the file.

This API can be used to re-enter the "define" mode for a file. The define mode is a setting for the file to define the meta-data associated with the data in the file (define the variables, dimensions, attributes etc). A file enters the "define" mode when its created or explicitly using the PIO_redef call. The user needs to end/exit the "define" mode to start writing data to the file.

If a file is opened, the user must explicitly enter the "define" mode using this API to add meta-data (define variables/dimensions/attributes). A user may re-enter the "define" mode multiple times but needs to exit the mode appropriately (PIO_enddef) each time. Note that if a file already contains data, adding more meta-data increases the size of the header and can potentially result in data movement (move the data section of the file to accomodate the new meta-data in the header) negatively impacting the I/O performance.

If a file is created by the user the file is already in the "define" mode, so users don't need to explicitly "enter" the define mode using this call.

The meta-data specified during the "define" mode is typically stored in the output file header section.

This API is a collective call (Although the library might internally choose to make progress on a single or small subset of MPI processes) on the I/O system associated with the file

Function/Subroutine Documentation

◆ pio_redef_fh()

integer function spio_def_file::pio_redef_fh ( integer, intent(in) fh )

Enter the "define" mode of a file.

Parameters

[in] fh The file id/handle.

Return values

ierr	: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_redef_file()

integer function spio_def_file::pio_redef_file ( type(file_desc_t), intent(in) file )