SCORPIO  1.7.0
Data Types | Functions/Subroutines
spio_get_var Module Reference

Functions/Subroutines

integer function 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 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 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 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 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 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 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 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...
 
integer function pio_get_vara_1d_text (file, varid, start, cnt, val)
 Function to read/get specified number of strings from a variable in a file at a specified index. More...
 
integer function pio_get_vara_2d_text (file, varid, start, cnt, val)
 Function to read/get specified number of strings from a variable in a file at a specified index. More...
 
integer function pio_get_vara_3d_text (file, varid, start, cnt, val)
 Function to read/get specified number of strings from a variable in a file at a specified index. More...
 
integer function pio_get_vara_4d_text (file, varid, start, cnt, val)
 Function to read/get specified number of strings from a variable in a file at a specified index. More...
 
integer function pio_get_vara_5d_text (file, varid, start, cnt, val)
 Function to read/get specified number of strings from a variable in a file at a specified index. More...
 
integer function pio_get_vara_1d_int (file, varid, start, cnt, val)
 Function to read/get specified number of elements ($int) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_2d_int (file, varid, start, cnt, val)
 Function to read/get specified number of elements ($int) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_3d_int (file, varid, start, cnt, val)
 Function to read/get specified number of elements ($int) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_4d_int (file, varid, start, cnt, val)
 Function to read/get specified number of elements ($int) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_5d_int (file, varid, start, cnt, val)
 Function to read/get specified number of elements ($int) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_1d_real (file, varid, start, cnt, val)
 Function to read/get specified number of elements ($real) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_2d_real (file, varid, start, cnt, val)
 Function to read/get specified number of elements ($real) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_3d_real (file, varid, start, cnt, val)
 Function to read/get specified number of elements ($real) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_4d_real (file, varid, start, cnt, val)
 Function to read/get specified number of elements ($real) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_5d_real (file, varid, start, cnt, val)
 Function to read/get specified number of elements ($real) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_1d_double (file, varid, start, cnt, val)
 Function to read/get specified number of elements ($double) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_2d_double (file, varid, start, cnt, val)
 Function to read/get specified number of elements ($double) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_3d_double (file, varid, start, cnt, val)
 Function to read/get specified number of elements ($double) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_4d_double (file, varid, start, cnt, val)
 Function to read/get specified number of elements ($double) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_5d_double (file, varid, start, cnt, val)
 Function to read/get specified number of elements ($double) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_1d_text (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($text) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_2d_text (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($text) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_3d_text (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($text) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_4d_text (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($text) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_5d_text (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($text) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_1d_real (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($real) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_2d_real (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($real) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_3d_real (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($real) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_4d_real (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($real) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_5d_real (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($real) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_1d_double (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($double) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_2d_double (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($double) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_3d_double (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($double) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_4d_double (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($double) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_5d_double (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($double) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_1d_int (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($int) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_2d_int (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($int) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_3d_int (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($int) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_4d_int (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($int) from a variable in a file at a specified index. More...
 
integer function pio_get_vara_vdesc_5d_int (file, vdesc, start, cnt, val)
 Function to read/get specified number of elements ($int) from a variable in a file at a specified index. More...
 
integer function pio_get_var_0d_text (file, varid, val)
 Function to read/get strings from a variable. More...
 
integer function pio_get_var_1d_text (file, varid, val)
 Function to read/get strings from a variable. More...
 
integer function pio_get_var_2d_text (file, varid, val)
 Function to read/get strings from a variable. More...
 
integer function pio_get_var_3d_text (file, varid, val)
 Function to read/get strings from a variable. More...
 
integer function pio_get_var_4d_text (file, varid, val)
 Function to read/get strings from a variable. More...
 
integer function pio_get_var_5d_text (file, varid, val)
 Function to read/get strings from a variable. More...
 
integer function pio_get_var_0d_int (file, varid, val)
 Function to read/get all elements to a scalar variable. More...
 
integer function pio_get_var_0d_real (file, varid, val)
 Function to read/get all elements to a scalar variable. More...
 
integer function pio_get_var_0d_double (file, varid, val)
 Function to read/get all elements to a scalar variable. More...
 
integer function pio_get_var_1d_int (file, varid, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_2d_int (file, varid, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_3d_int (file, varid, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_4d_int (file, varid, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_5d_int (file, varid, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_1d_real (file, varid, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_2d_real (file, varid, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_3d_real (file, varid, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_4d_real (file, varid, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_5d_real (file, varid, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_1d_double (file, varid, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_2d_double (file, varid, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_3d_double (file, varid, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_4d_double (file, varid, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_5d_double (file, varid, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_0d_text (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_1d_text (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_2d_text (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_3d_text (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_4d_text (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_5d_text (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_0d_int (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_1d_int (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_2d_int (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_3d_int (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_4d_int (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_5d_int (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_0d_real (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_1d_real (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_2d_real (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_3d_real (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_4d_real (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_5d_real (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_0d_double (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_1d_double (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_2d_double (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_3d_double (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_4d_double (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 
integer function pio_get_var_vdesc_5d_double (file, vdesc, val)
 Function to read/get all elements from a variable. More...
 

Function/Subroutine Documentation

◆ pio_get_var_0d_double()

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

Function to read/get all elements to a scalar variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe value is read into this argument/variable.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_0d_int()

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

Function to read/get all elements to a scalar variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe value is read into this argument/variable.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_0d_real()

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

Function to read/get all elements to a scalar variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe value is read into this argument/variable.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_0d_text()

integer function spio_get_var::pio_get_var_0d_text ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), intent(out)  val 
)

Function to read/get strings from a variable.

The entire variable is written out in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of strings are read into this argument. The array of strings need to contain the same number of characters as defined by the variable dimensions (The lowest dimension of the variable is the length of each individual string)
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_1d_double()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of elements are read into this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_1d_int()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of elements are read into this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_1d_real()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of elements are read into this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_1d_text()

integer function spio_get_var::pio_get_var_1d_text ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), dimension(:), intent(out)  val 
)

Function to read/get strings from a variable.

The entire variable is written out in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of strings are read into this argument. The array of strings need to contain the same number of characters as defined by the variable dimensions (The lowest dimension of the variable is the length of each individual string)
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_2d_double()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of elements are read into this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_2d_int()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of elements are read into this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_2d_real()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of elements are read into this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_2d_text()

integer function spio_get_var::pio_get_var_2d_text ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), dimension(:,:), intent(out)  val 
)

Function to read/get strings from a variable.

The entire variable is written out in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of strings are read into this argument. The array of strings need to contain the same number of characters as defined by the variable dimensions (The lowest dimension of the variable is the length of each individual string)
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_3d_double()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of elements are read into this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_3d_int()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of elements are read into this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_3d_real()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of elements are read into this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_3d_text()

integer function spio_get_var::pio_get_var_3d_text ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), dimension(:,:,:), intent(out)  val 
)

Function to read/get strings from a variable.

The entire variable is written out in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of strings are read into this argument. The array of strings need to contain the same number of characters as defined by the variable dimensions (The lowest dimension of the variable is the length of each individual string)
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_4d_double()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of elements are read into this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_4d_int()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of elements are read into this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_4d_real()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of elements are read into this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_4d_text()

integer function spio_get_var::pio_get_var_4d_text ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), dimension(:,:,:,:), intent(out)  val 
)

Function to read/get strings from a variable.

The entire variable is written out in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of strings are read into this argument. The array of strings need to contain the same number of characters as defined by the variable dimensions (The lowest dimension of the variable is the length of each individual string)
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_5d_double()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of elements are read into this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_5d_int()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of elements are read into this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_5d_real()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of elements are read into this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_5d_text()

integer function spio_get_var::pio_get_var_5d_text ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), dimension(:,:,:,:,:), intent(out)  val 
)

Function to read/get strings from a variable.

The entire variable is written out in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[out]valThe array of strings are read into this argument. The array of strings need to contain the same number of characters as defined by the variable dimensions (The lowest dimension of the variable is the length of each individual string)
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_0d_double()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_0d_int()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_0d_real()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_0d_text()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_1d_double()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_1d_int()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_1d_real()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_1d_text()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_2d_double()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_2d_int()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_2d_real()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_2d_text()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_3d_double()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_3d_int()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_3d_real()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_3d_text()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_4d_double()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_4d_int()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_4d_real()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_4d_text()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_5d_double()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_5d_int()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_5d_real()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_var_vdesc_5d_text()

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

Function to read/get all elements from a variable.

The entire variable is read in a single call.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[out]valThe array of elements are read in to this argument. The array of elements need to contain the same number of elements as defined by the variable dimensions.
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_1d_double()

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

Function to read/get specified number of elements ($double) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_1d_int()

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

Function to read/get specified number of elements ($int) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_1d_real()

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

Function to read/get specified number of elements ($real) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_1d_text()

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

Function to read/get specified number of strings from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first character is read from. 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 starting index for the variable dimension The start indices start from 1.
[in]cntThe number (count) of chars read. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension read from the variable
[out]valThe value is read into the array of strings provided in this argument. The strings are read from the variable at index, start, specified above. The array needs to contain MAX(1, PRODUCT(cnt(2:VAR_NDIMS))) strings such that each string has at least cnt(1) characters to store the strings read from the variable
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_2d_double()

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

Function to read/get specified number of elements ($double) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_2d_int()

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

Function to read/get specified number of elements ($int) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_2d_real()

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

Function to read/get specified number of elements ($real) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_2d_text()

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

Function to read/get specified number of strings from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first character is read from. 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 starting index for the variable dimension The start indices start from 1.
[in]cntThe number (count) of chars read. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension read from the variable
[out]valThe value is read into the array of strings provided in this argument. The strings are read from the variable at index, start, specified above. The array needs to contain MAX(1, PRODUCT(cnt(2:VAR_NDIMS))) strings such that each string has at least cnt(1) characters to store the strings read from the variable
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_3d_double()

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

Function to read/get specified number of elements ($double) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_3d_int()

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

Function to read/get specified number of elements ($int) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_3d_real()

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

Function to read/get specified number of elements ($real) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_3d_text()

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

Function to read/get specified number of strings from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first character is read from. 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 starting index for the variable dimension The start indices start from 1.
[in]cntThe number (count) of chars read. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension read from the variable
[out]valThe value is read into the array of strings provided in this argument. The strings are read from the variable at index, start, specified above. The array needs to contain MAX(1, PRODUCT(cnt(2:VAR_NDIMS))) strings such that each string has at least cnt(1) characters to store the strings read from the variable
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_4d_double()

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

Function to read/get specified number of elements ($double) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_4d_int()

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

Function to read/get specified number of elements ($int) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_4d_real()

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

Function to read/get specified number of elements ($real) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_4d_text()

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

Function to read/get specified number of strings from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first character is read from. 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 starting index for the variable dimension The start indices start from 1.
[in]cntThe number (count) of chars read. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension read from the variable
[out]valThe value is read into the array of strings provided in this argument. The strings are read from the variable at index, start, specified above. The array needs to contain MAX(1, PRODUCT(cnt(2:VAR_NDIMS))) strings such that each string has at least cnt(1) characters to store the strings read from the variable
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_5d_double()

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

Function to read/get specified number of elements ($double) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_5d_int()

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

Function to read/get specified number of elements ($int) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_5d_real()

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

Function to read/get specified number of elements ($real) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_5d_text()

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

Function to read/get specified number of strings from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]varidThe handle/id of the variable
[in]startThe variable index at which the first character is read from. 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 starting index for the variable dimension The start indices start from 1.
[in]cntThe number (count) of chars read. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension read from the variable
[out]valThe value is read into the array of strings provided in this argument. The strings are read from the variable at index, start, specified above. The array needs to contain MAX(1, PRODUCT(cnt(2:VAR_NDIMS))) strings such that each string has at least cnt(1) characters to store the strings read from the variable
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_1d_double()

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

Function to read/get specified number of elements ($double) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_1d_int()

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

Function to read/get specified number of elements ($int) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_1d_real()

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

Function to read/get specified number of elements ($real) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_1d_text()

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

Function to read/get specified number of elements ($text) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_2d_double()

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

Function to read/get specified number of elements ($double) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_2d_int()

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

Function to read/get specified number of elements ($int) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_2d_real()

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

Function to read/get specified number of elements ($real) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_2d_text()

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

Function to read/get specified number of elements ($text) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_3d_double()

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

Function to read/get specified number of elements ($double) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_3d_int()

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

Function to read/get specified number of elements ($int) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_3d_real()

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

Function to read/get specified number of elements ($real) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_3d_text()

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

Function to read/get specified number of elements ($text) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_4d_double()

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

Function to read/get specified number of elements ($double) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_4d_int()

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

Function to read/get specified number of elements ($int) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_4d_real()

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

Function to read/get specified number of elements ($real) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_4d_text()

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

Function to read/get specified number of elements ($text) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_5d_double()

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

Function to read/get specified number of elements ($double) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_5d_int()

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

Function to read/get specified number of elements ($int) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_5d_real()

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

Function to read/get specified number of elements ($real) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise

◆ pio_get_vara_vdesc_5d_text()

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

Function to read/get specified number of elements ($text) from a variable in a file at a specified index.

Parameters
[in]fileThe handle to the file with the variable. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]startThe variable index at which the first element/datum is read. The remaining elements (the number of elements is determined by the cnt array), if any, in val is read from subsequent elements in the variable. 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 starting index for the variable dimension (subscripts referring to where the first value is read) The indices start from 1.
[in]cntThe number of elements read from the variable. This argument is an array and the size of the array needs to be equal to the number of dimensions of the variable. Each element in the array corresponds to the number of elements of that variable dimension being read
[out]valThe array of values is read into this argument. The values are read from the variable at the index, cstart, specified above. The array needs to contain at least PRODUCT(cnt) elements for storing the values that are being read
Returns
PIO_NOERR on success, an error code otherwise