PIO_get_var

Read ("Get") a non-distributed array. More...

Functions/Subroutines
integer function	spio_get_var::pio_get_var1_text (file, varid, start, str)
	Read/get a string from a variable (character array) in a file at a specified index. More...
integer function	spio_get_var::pio_get_var1_int (file, varid, start, val)
	Read/Get one element/datum (int) from a variable in a file at a specified index. More...
integer function	spio_get_var::pio_get_var1_real (file, varid, start, val)
	Read/Get one element/datum (real) from a variable in a file at a specified index. More...
integer function	spio_get_var::pio_get_var1_double (file, varid, start, val)
	Read/Get one element/datum (double) from a variable in a file at a specified index. More...
integer function	spio_get_var::pio_get_var1_vdesc_text (file, vdesc, start, val)
	Read/Get one element/datum (text) from a variable in a file at a specified index. More...
integer function	spio_get_var::pio_get_var1_vdesc_int (file, vdesc, start, val)
	Read/Get one element/datum (int) from a variable in a file at a specified index. More...
integer function	spio_get_var::pio_get_var1_vdesc_real (file, vdesc, start, val)
	Read/Get one element/datum (real) from a variable in a file at a specified index. More...
integer function	spio_get_var::pio_get_var1_vdesc_double (file, vdesc, start, val)
	Read/Get one element/datum (double) from a variable in a file at a specified index. More...

Detailed Description

Read ("Get") a non-distributed array.

This API can be used to read non-distributed arrays from a file. These arrays have the same data across all the MPI processes in the I/O system (where the file was opened/created).

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

Function/Subroutine Documentation

pio_get_var1_double()

integer function spio_get_var::pio_get_var1_double	(	type(file_desc_t), intent(in)	file,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		real(r8), intent(out)	val
	)

Read/Get one element/datum (double) from a variable in a file at a specified index.

Parameters

[in]	file	The handle to the file. File descriptor structure. This structure holds information associated with each open file
[in]	varid	The id of the variable being written out
[in]	start	The variable index at which to read the element/datum. This argument is an array and the size of the array needs to be equal to the number of dimensions for the variable. Each element in the array corresponds to the index for the variable dimension (subscripts referring to where the value is being read from) The indices start from 1.
[out]	val	The value, $double, is read into this variable

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

integer function spio_get_var::pio_get_var1_int	(	type(file_desc_t), intent(in)	file,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer(i4), intent(out)	val
	)

Read/Get one element/datum (int) from a variable in a file at a specified index.

Parameters

[in]	file	The handle to the file. File descriptor structure. This structure holds information associated with each open file
[in]	varid	The id of the variable being written out
[in]	start	The variable index at which to read the element/datum. This argument is an array and the size of the array needs to be equal to the number of dimensions for the variable. Each element in the array corresponds to the index for the variable dimension (subscripts referring to where the value is being read from) The indices start from 1.
[out]	val	The value, $int, is read into this variable

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

integer function spio_get_var::pio_get_var1_real	(	type(file_desc_t), intent(in)	file,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		real(r4), intent(out)	val
	)

Read/Get one element/datum (real) from a variable in a file at a specified index.

Parameters

[in]	file	The handle to the file. File descriptor structure. This structure holds information associated with each open file
[in]	varid	The id of the variable being written out
[in]	start	The variable index at which to read the element/datum. This argument is an array and the size of the array needs to be equal to the number of dimensions for the variable. Each element in the array corresponds to the index for the variable dimension (subscripts referring to where the value is being read from) The indices start from 1.
[out]	val	The value, $real, is read into this variable

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

integer function spio_get_var::pio_get_var1_text	(	type(file_desc_t), intent(in)	file,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		character(len=*), intent(out)	str
	)

Read/get a string from a variable (character array) in a file at a specified index.

Parameters

[in]	file	The handle to the file. File descriptor structure. This structure holds information associated with each open file
[in]	varid	The id of the variable being read
[in]	start	The variable index at which to read the text string. This argument is an array and the size of the array needs to be equal to the number of dimensions for the variable. Each element in the array corresponds to the index for the variable dimension (subscripts referring to where the value is to be written) The indices start from 1.
[out]	str	The value, string, is read into 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_get_var1_vdesc_double()

integer function spio_get_var::pio_get_var1_vdesc_double	(	type(file_desc_t), intent(in)	file,
		type(var_desc_t), intent(in)	vdesc,
		integer, dimension(:), intent(in)	start,
		real(r8), intent(out)	val
	)

Read/Get one element/datum (double) from a variable in a file at a specified index.

Parameters

[in]	file	The handle to the file. File descriptor structure. This structure holds information associated with each open file
[in]	vdesc	The handle to the variable being written out. Variable description structure.
[in]	start	The variable index at which to read the element/datum. This argument is an array and the size of the array needs to be equal to the number of dimensions for the variable. Each element in the array corresponds to the index for the variable dimension (subscripts referring to where the value is being read from) The indices start from 1.
[in]	val	The value, $double, is read into 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_get_var1_vdesc_int()

integer function spio_get_var::pio_get_var1_vdesc_int	(	type(file_desc_t), intent(in)	file,
		type(var_desc_t), intent(in)	vdesc,
		integer, dimension(:), intent(in)	start,
		integer(i4), intent(out)	val
	)

Read/Get one element/datum (int) from a variable in a file at a specified index.

Parameters

[in]	file	The handle to the file. File descriptor structure. This structure holds information associated with each open file
[in]	vdesc	The handle to the variable being written out. Variable description structure.
[in]	start	The variable index at which to read the element/datum. This argument is an array and the size of the array needs to be equal to the number of dimensions for the variable. Each element in the array corresponds to the index for the variable dimension (subscripts referring to where the value is being read from) The indices start from 1.
[in]	val	The value, $int, is read into 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_get_var1_vdesc_real()

integer function spio_get_var::pio_get_var1_vdesc_real	(	type(file_desc_t), intent(in)	file,
		type(var_desc_t), intent(in)	vdesc,
		integer, dimension(:), intent(in)	start,
		real(r4), intent(out)	val
	)

Read/Get one element/datum (real) from a variable in a file at a specified index.

Parameters

[in]	file	The handle to the file. File descriptor structure. This structure holds information associated with each open file
[in]	vdesc	The handle to the variable being written out. Variable description structure.
[in]	start	The variable index at which to read the element/datum. This argument is an array and the size of the array needs to be equal to the number of dimensions for the variable. Each element in the array corresponds to the index for the variable dimension (subscripts referring to where the value is being read from) The indices start from 1.
[in]	val	The value, $real, is read into 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_get_var1_vdesc_text()

integer function spio_get_var::pio_get_var1_vdesc_text	(	type(file_desc_t), intent(in)	file,
		type(var_desc_t), intent(in)	vdesc,
		integer, dimension(:), intent(in)	start,
		character(len=*), intent(out)	val
	)

Read/Get one element/datum (text) from a variable in a file at a specified index.

Parameters

[in]	file	The handle to the file. File descriptor structure. This structure holds information associated with each open file
[in]	vdesc	The handle to the variable being written out. Variable description structure.
[in]	start	The variable index at which to read the element/datum. This argument is an array and the size of the array needs to be equal to the number of dimensions for the variable. Each element in the array corresponds to the index for the variable dimension (subscripts referring to where the value is being read from) The indices start from 1.
[in]	val	The value, $text, is read into 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)