Reads non-decomposed data from a NetCDF file in Fortran. The get_var interface is provided as a simplified interface to read variables from a NetCDF format file. The variable is read on the root IO task and broadcast in its entirety to all tasks. More...

Functions/Subroutines
integer function	pionfget_mod::get_var1_text (File, varid, index, ival)
	Reads non-decomposed fields from a NetCDF file. More...

integer function	pionfget_mod::get_var1_vdesc_text (File, vardesc, index, ival)
	Writes data to a file. More...

integer function	pionfget_mod::get_vara_1d_int (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_2d_int (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_3d_int (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_4d_int (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_5d_int (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_1d_real (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_2d_real (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_3d_real (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_4d_real (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_5d_real (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_1d_double (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_2d_double (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_3d_double (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_4d_double (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_5d_double (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_1d_short (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_2d_short (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_3d_short (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_4d_short (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_5d_short (File, varid, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_1d_text (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_2d_text (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_3d_text (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_4d_text (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_5d_text (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_1d_real (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_2d_real (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_3d_real (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_4d_real (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_5d_real (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_1d_double (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_2d_double (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_3d_double (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_4d_double (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_5d_double (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_1d_int (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_2d_int (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_3d_int (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_4d_int (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_5d_int (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_1d_short (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_2d_short (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_3d_short (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_4d_short (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_vara_vdesc_5d_short (File, vardesc, start, count, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_var_0d_text (File, varid, ival)
	Gets data from a file. More...

integer function	pionfget_mod::get_var_vdesc_0d_text (File, vardesc, ival)
	Gets data from a file. More...

Detailed Description

Reads non-decomposed data from a NetCDF file in Fortran. The get_var interface is provided as a simplified interface to read variables from a NetCDF format file. The variable is read on the root IO task and broadcast in its entirety to all tasks.

Function/Subroutine Documentation

◆ get_var1_text()

integer function pionfget_mod::get_var1_text	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	index,
		character(len=*), intent(out)	ival
	)

Reads non-decomposed fields from a NetCDF file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
index	: a multidimensional index that specifies which value to get
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_var1_vdesc_text()

integer function pionfget_mod::get_var1_vdesc_text	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	index,
		character(len=*), intent(out)	ival
	)

Writes data to a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
index	: a multidimensional index that specifies which value to get
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_var_0d_text()

integer function pionfget_mod::get_var_0d_text	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		character(len=*), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_var_vdesc_0d_text()

integer function pionfget_mod::get_var_vdesc_0d_text	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		character(len=*), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_1d_double()

integer function pionfget_mod::get_vara_1d_double	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r8), dimension(:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_1d_int()

integer function pionfget_mod::get_vara_1d_int	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i4), dimension(:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_1d_real()

integer function pionfget_mod::get_vara_1d_real	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r4), dimension(:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_1d_short()

integer function pionfget_mod::get_vara_1d_short	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i2), dimension(:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_2d_double()

integer function pionfget_mod::get_vara_2d_double	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r8), dimension(:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_2d_int()

integer function pionfget_mod::get_vara_2d_int	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i4), dimension(:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_2d_real()

integer function pionfget_mod::get_vara_2d_real	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r4), dimension(:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_2d_short()

integer function pionfget_mod::get_vara_2d_short	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i2), dimension(:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_3d_double()

integer function pionfget_mod::get_vara_3d_double	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r8), dimension(:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_3d_int()

integer function pionfget_mod::get_vara_3d_int	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i4), dimension(:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_3d_real()

integer function pionfget_mod::get_vara_3d_real	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r4), dimension(:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_3d_short()

integer function pionfget_mod::get_vara_3d_short	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i2), dimension(:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_4d_double()

integer function pionfget_mod::get_vara_4d_double	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r8), dimension(:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_4d_int()

integer function pionfget_mod::get_vara_4d_int	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i4), dimension(:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_4d_real()

integer function pionfget_mod::get_vara_4d_real	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r4), dimension(:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_4d_short()

integer function pionfget_mod::get_vara_4d_short	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i2), dimension(:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_5d_double()

integer function pionfget_mod::get_vara_5d_double	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r8), dimension(:,:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_5d_int()

integer function pionfget_mod::get_vara_5d_int	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i4), dimension(:,:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_5d_real()

integer function pionfget_mod::get_vara_5d_real	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r4), dimension(:,:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_5d_short()

integer function pionfget_mod::get_vara_5d_short	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i2), dimension(:,:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
varid	: The netcdf variable identifier
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_1d_double()

integer function pionfget_mod::get_vara_vdesc_1d_double	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r8), dimension(:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_1d_int()

integer function pionfget_mod::get_vara_vdesc_1d_int	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i4), dimension(:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_1d_real()

integer function pionfget_mod::get_vara_vdesc_1d_real	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r4), dimension(:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_1d_short()

integer function pionfget_mod::get_vara_vdesc_1d_short	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i2), dimension(:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_1d_text()

integer function pionfget_mod::get_vara_vdesc_1d_text	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		character(len=*), dimension(:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_2d_double()

integer function pionfget_mod::get_vara_vdesc_2d_double	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r8), dimension(:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_2d_int()

integer function pionfget_mod::get_vara_vdesc_2d_int	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i4), dimension(:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_2d_real()

integer function pionfget_mod::get_vara_vdesc_2d_real	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r4), dimension(:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_2d_short()

integer function pionfget_mod::get_vara_vdesc_2d_short	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i2), dimension(:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_2d_text()

integer function pionfget_mod::get_vara_vdesc_2d_text	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		character(len=*), dimension(:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_3d_double()

integer function pionfget_mod::get_vara_vdesc_3d_double	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r8), dimension(:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_3d_int()

integer function pionfget_mod::get_vara_vdesc_3d_int	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i4), dimension(:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_3d_real()

integer function pionfget_mod::get_vara_vdesc_3d_real	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r4), dimension(:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_3d_short()

integer function pionfget_mod::get_vara_vdesc_3d_short	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i2), dimension(:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_3d_text()

integer function pionfget_mod::get_vara_vdesc_3d_text	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		character(len=*), dimension(:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_4d_double()

integer function pionfget_mod::get_vara_vdesc_4d_double	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r8), dimension(:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_4d_int()

integer function pionfget_mod::get_vara_vdesc_4d_int	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i4), dimension(:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_4d_real()

integer function pionfget_mod::get_vara_vdesc_4d_real	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r4), dimension(:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_4d_short()

integer function pionfget_mod::get_vara_vdesc_4d_short	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i2), dimension(:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_4d_text()

integer function pionfget_mod::get_vara_vdesc_4d_text	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		character(len=*), dimension(:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_5d_double()

integer function pionfget_mod::get_vara_vdesc_5d_double	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r8), dimension(:,:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_5d_int()

integer function pionfget_mod::get_vara_vdesc_5d_int	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i4), dimension(:,:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_5d_real()

integer function pionfget_mod::get_vara_vdesc_5d_real	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		real(r4), dimension(:,:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_5d_short()

integer function pionfget_mod::get_vara_vdesc_5d_short	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		integer(i2), dimension(:,:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

◆ get_vara_vdesc_5d_text()

integer function pionfget_mod::get_vara_vdesc_5d_text	(	type (file_desc_t), intent(in)	File,
		type(var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	count,
		character(len=*), dimension(:,:,:,:,:), intent(out)	ival
	)

Gets data from a file.

Parameters

File	file_desc_t
vardesc	var_desc_t
start	: A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values.
count	: A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything.
ival	: The value for the netcdf metadata

Return values

ierr	Error Return Codes

Functions/Subroutines

Detailed Description

Function/Subroutine Documentation

◆ get_var1_text()

◆ get_var1_vdesc_text()

◆ get_var_0d_text()

◆ get_var_vdesc_0d_text()

◆ get_vara_1d_double()

◆ get_vara_1d_int()

◆ get_vara_1d_real()

◆ get_vara_1d_short()

◆ get_vara_2d_double()

◆ get_vara_2d_int()

◆ get_vara_2d_real()

◆ get_vara_2d_short()

◆ get_vara_3d_double()

◆ get_vara_3d_int()

◆ get_vara_3d_real()

◆ get_vara_3d_short()

◆ get_vara_4d_double()

◆ get_vara_4d_int()

◆ get_vara_4d_real()

◆ get_vara_4d_short()

◆ get_vara_5d_double()

◆ get_vara_5d_int()

◆ get_vara_5d_real()

◆ get_vara_5d_short()

◆ get_vara_vdesc_1d_double()

◆ get_vara_vdesc_1d_int()

◆ get_vara_vdesc_1d_real()

◆ get_vara_vdesc_1d_short()

◆ get_vara_vdesc_1d_text()

◆ get_vara_vdesc_2d_double()

◆ get_vara_vdesc_2d_int()

◆ get_vara_vdesc_2d_real()

◆ get_vara_vdesc_2d_short()

◆ get_vara_vdesc_2d_text()

◆ get_vara_vdesc_3d_double()

◆ get_vara_vdesc_3d_int()

◆ get_vara_vdesc_3d_real()

◆ get_vara_vdesc_3d_short()

◆ get_vara_vdesc_3d_text()

◆ get_vara_vdesc_4d_double()

◆ get_vara_vdesc_4d_int()

◆ get_vara_vdesc_4d_real()

◆ get_vara_vdesc_4d_short()

◆ get_vara_vdesc_4d_text()

◆ get_vara_vdesc_5d_double()

◆ get_vara_vdesc_5d_int()

◆ get_vara_vdesc_5d_real()

◆ get_vara_vdesc_5d_short()

◆ get_vara_vdesc_5d_text()