PIO_def_dim

Define a dimension. More...

Functions/Subroutines
integer function	spio_def_dim::pio_def_dim_file (file, dname, dlen, dimid)
	Define a dimension in a file. More...
integer function	spio_def_dim::pio_def_dim_file_offlen (file, dname, dlen, dimid)
	Define a multidimensional dimension in a file. More...
integer function	spio_def_dim::pio_def_dim_fh (fh, dname, dlen, dimid)
	Define a multidimensional dimension in a file. More...
integer function	spio_def_dim::pio_def_dim_fh_offlen (fh, dname, dlen, dimid)
	Define a multidimensional dimension in a file. More...

Detailed Description

Define a dimension.

This API can be used to define a variable dimension in a file. The dimensions are used to specify the variable dimensions when defining a variable. The dimensions can only be defined when the file is in the "define" mode

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_def_dim_fh()

integer function spio_def_dim::pio_def_dim_fh	(	integer, intent(in)	fh,
		character(len=*), intent(in)	dname,
		integer, intent(in)	dlen,
		integer, intent(out)	dimid
	)

Define a multidimensional dimension in a file.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[in]	dname	The name of the dimension
[in]	dlen	The length of the dimension
[out]	dimid	The id of the dimension is returned in this argument

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_def_dim_fh_offlen()

integer function spio_def_dim::pio_def_dim_fh_offlen	(	integer, intent(in)	fh,
		character(len=*), intent(in)	dname,
		integer(pio_offset_kind), intent(in)	dlen,
		integer, intent(out)	dimid
	)

Define a multidimensional dimension in a file.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[in]	dname	The name of the dimension
[in]	dlen	The length (KIND=PIO_OFFSET_KIND) of the dimension
[out]	dimid	The id of the dimension is returned in this argument

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_def_dim_file()

integer function spio_def_dim::pio_def_dim_file	(	type(file_desc_t), intent(in)	file,
		character(len=*), intent(in)	dname,
		integer, intent(in)	dlen,
		integer, intent(out)	dimid
	)

Define a dimension in a file.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[in]	dname	The name of the dimension
[in]	dlen	The length of the dimension
[out]	dimid	The id of the dimension is returned in this argument

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_def_dim_file_offlen()

integer function spio_def_dim::pio_def_dim_file_offlen	(	type(file_desc_t), intent(in)	file,
		character(len=*), intent(in)	dname,
		integer(pio_offset_kind), intent(in)	dlen,
		integer, intent(out)	dimid
	)

Define a multidimensional dimension in a file.

Parameters

[in]	file	The file handle. File descriptor structure. This structure holds information associated with each open file
[in]	dname	The name of the dimension
[in]	dlen	The length (KIND=PIO_OFFSET_KIND) of the dimension
[out]	dimid	The id of the dimension is returned in this argument

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)