Learn About a Variable

Learn variable name, ID, type, dimensions, compression, chunking in Fortran. More...

Functions/Subroutines
integer function	pio_nf::inquire_variable_desc (file, vardesc, name, xtype, ndims, dimids, natts)
	Variable description structure. More...
integer function	pio_nf::inquire_variable_vid (file, varid, name, xtype, ndims, dimids, natts)
integer function	pio_nf::inquire_variable_id (ncid, varid, name, xtype, ndims, dimids, natts)
integer function	pio_nf::inq_vardimid_desc (File, vardesc, dimids)
	File descriptor structure. More...
integer function	pio_nf::inq_vardimid_vid (File, varid, dimids)
integer function	pio_nf::inq_vardimid_id (ncid, varid, dimids)
integer function	pio_nf::inq_varndims_desc (File, vardesc, ndims)
	File descriptor structure. More...
integer function	pio_nf::inq_varndims_vid (File, varid, ndims)
integer function	pio_nf::inq_varndims_id (ncid, varid, ndims)
integer function	pio_nf::inq_vartype_desc (File, vardesc, type)
	File descriptor structure. More...
integer function	pio_nf::inq_vartype_vid (File, varid, type)
integer function	pio_nf::inq_vartype_id (ncid, varid, type)
integer function	pio_nf::inq_varnatts_desc (File, vardesc, natts)
	File descriptor structure. More...
integer function	pio_nf::inq_varnatts_vid (File, varid, natts)
integer function	pio_nf::inq_varnatts_id (ncid, varid, natts)
integer function	pio_nf::inq_var_deflate_desc (File, vardesc, shuffle, deflate, deflate_level)
	File descriptor structure. More...
integer function	pio_nf::inq_var_deflate_vid (File, varid, shuffle, deflate, deflate_level)
integer function	pio_nf::inq_var_deflate_id (ncid, varid, shuffle, deflate, deflate_level)
integer function	pio_nf::inq_var_chunking_desc (File, vardesc, storage, chunksizes)
	File descriptor structure. More...
integer function	pio_nf::inq_var_chunking_vid (File, varid, storage, chunksizes)
integer function	pio_nf::inq_var_chunking_id (ncid, varid, storage, chunksizes)
integer function	pio_nf::inq_varname_desc (File, vardesc, name)
	File descriptor structure. More...
integer function	pio_nf::inq_varname_vid (File, varid, name)
integer function	pio_nf::inq_varname_id (ncid, varid, name)
integer function	pio_nf::inq_varid_desc (File, name, vardesc)
	File descriptor structure. More...
integer function	pio_nf::inq_varid_vid (File, name, varid)
integer function	pio_nf::inq_varid_id (ncid, name, varid)

Detailed Description

Learn variable name, ID, type, dimensions, compression, chunking in Fortran.

Use the generic functions to call the underlying Fortran functions.

Generic Function	Function(s)
pio_inquire_variable()	inquire_variable_desc(), inquire_variable_vid(), inquire_variable_id()
pio_inq_varid()	inq_varid_desc(), inq_varid_vid(), inq_varid_id()
pio_inq_vartype()	inq_varname_desc(), inq_varname_vid(), inq_varname_id()
pio_inq_varndims()	inq_varndims_desc(), inq_varndims_vid(), inq_varndims_id()
pio_inq_vardimid()	inq_vardimid_desc(), inq_vardimid_vid(), inq_vardimid_id()
pio_inq_varnatts()	inq_varnatts_desc(), inq_varnatts_vid(), inq_varnatts_id()
pio_inq_var_deflate()	inq_var_deflate_desc(), inq_var_deflate_vid(), inq_var_deflate_id()
pio_inq_var_chunking()	inq_var_chunking_desc(), inq_var_chunking_vid(), inq_var_chunking_id()

Function/Subroutine Documentation

inq_var_chunking_desc()

integer function pio_nf::inq_var_chunking_desc	(	type (file_desc_t), intent(in)	File,
		type (var_desc_t), intent(in)	vardesc,
		integer, intent(out)	storage,
		integer (kind=pio_offset_kind), dimension(*), intent(out)	chunksizes
	)

File descriptor structure.

Gets metadata information for netcdf file.

Parameters

File	This structure holds information associated with each open file
vardesc	Variable description structure.
storage	0 for chunked, 1 for contiguous
chunksizes	Array of chunk sizes.

Return values

ierr	The error return code (see Error Handling for Fortran).

Author

Ed Hartnett

inq_var_chunking_id()

integer function pio_nf::inq_var_chunking_id	(	integer, intent(in)	ncid,
		integer, intent(in)	varid,
		integer, intent(out)	storage,
		integer (kind=pio_offset_kind), dimension(*), intent(out)	chunksizes
	)

Gets metadata information for netcdf file.

Author

Ed Hartnett

inq_var_chunking_vid()

integer function pio_nf::inq_var_chunking_vid	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, intent(out)	storage,
		integer (kind=pio_offset_kind), dimension(*), intent(out)	chunksizes
	)

Gets metadata information for netcdf file.

Author

Ed Hartnett

inq_var_deflate_desc()

integer function pio_nf::inq_var_deflate_desc	(	type (file_desc_t), intent(in)	File,
		type (var_desc_t), intent(in)	vardesc,
		integer, intent(out)	shuffle,
		integer, intent(out)	deflate,
		integer, intent(out)	deflate_level
	)

File descriptor structure.

Gets metadata information for netcdf file.

Parameters

File	This structure holds information associated with each open file
vardesc	Variable description structure.
shuffle	Value of shuffle
deflate	Status of deflate
deflate_level	Level of deflate

Return values

ierr	The error return code (see Error Handling for Fortran).

Author

Jim Edwards

inq_var_deflate_id()

integer function pio_nf::inq_var_deflate_id	(	integer, intent(in)	ncid,
		integer, intent(in)	varid,
		integer, intent(out)	shuffle,
		integer, intent(out)	deflate,
		integer, intent(out)	deflate_level
	)

Gets metadata information for netcdf file.

Author

Jim Edwards

inq_var_deflate_vid()

integer function pio_nf::inq_var_deflate_vid	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, intent(out)	shuffle,
		integer, intent(out)	deflate,
		integer, intent(out)	deflate_level
	)

Gets metadata information for netcdf file.

Author

Jim Edwards

inq_vardimid_desc()

integer function pio_nf::inq_vardimid_desc	(	type (file_desc_t), intent(in)	File,
		type (var_desc_t), intent(in)	vardesc,
		integer, dimension(:), intent(out)	dimids
	)

File descriptor structure.

Returns the dimids of the variable as an interger array.

Parameters

File	This structure holds information associated with each open file
vardesc	Variable description structure.
dimids	The dimension identifier returned by Define a Dimension

Return values

ierr	The error return code (see Error Handling for Fortran).

Author

Jim Edwards

inq_vardimid_id()

integer function pio_nf::inq_vardimid_id	(	integer, intent(in)	ncid,
		integer, intent(in)	varid,
		integer, dimension(:), intent(out)	dimids
	)

Returns the dimids of the variable as an interger array.

Author

Jim Edwards

inq_vardimid_vid()

integer function pio_nf::inq_vardimid_vid	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, dimension(:), intent(out)	dimids
	)

Returns the dimids of the variable as an interger array.

Author

Jim Edwards

inq_varid_desc()

integer function pio_nf::inq_varid_desc	(	type (file_desc_t), intent(in)	File,
		character(len=*), intent(in)	name,
		type (var_desc_t), intent(inout)	vardesc
	)

File descriptor structure.

Returns the ID of a netcdf variable given its name.

Parameters

File	This structure holds information associated with each open file
name	Name of the returned attribute
vardesc	Variable description structure.

Return values

ierr	The error return code (see Error Handling for Fortran).

Author

Jim Edwards

inq_varid_id()

integer function pio_nf::inq_varid_id	(	integer, intent(in)	ncid,
		character(len=*), intent(in)	name,
		integer, intent(out)	varid
	)

Returns the ID of a netcdf variable given its name.

Author

Jim Edwards

inq_varid_vid()

integer function pio_nf::inq_varid_vid	(	type (file_desc_t), intent(in)	File,
		character(len=*), intent(in)	name,
		integer, intent(out)	varid
	)

Returns the ID of a netcdf variable given its name.

Author

Jim Edwards

inq_varname_desc()

integer function pio_nf::inq_varname_desc	(	type (file_desc_t), intent(in)	File,
		type (var_desc_t), intent(in)	vardesc,
		character(len=*), intent(out)	name
	)

File descriptor structure.

Get the name associated with a variable.

Parameters

File	This structure holds information associated with each open file
vardesc	Variable description structure.
name	The name of the netcdf variable.

Return values

ierr	The error return code (see Error Handling for Fortran).

Author

Jim Edwards

inq_varname_id()

integer function pio_nf::inq_varname_id	(	integer, intent(in)	ncid,
		integer, intent(in)	varid,
		character(len=*), intent(out)	name
	)

Get the name associated with a variable.

Author

Jim Edwards

inq_varname_vid()

integer function pio_nf::inq_varname_vid	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		character(len=*), intent(out)	name
	)

Get the name associated with a variable.

Author

Jim Edwards

inq_varnatts_desc()

integer function pio_nf::inq_varnatts_desc	(	type (file_desc_t), intent(in)	File,
		type (var_desc_t), intent(in)	vardesc,
		integer, intent(out)	natts
	)

File descriptor structure.

Gets metadata information for netcdf file.

Parameters

File	This structure holds information associated with each open file
vardesc	Variable description structure.
natts	The number of atts

Return values

ierr	The error return code (see Error Handling for Fortran).

Author

Jim Edwards

inq_varnatts_id()

integer function pio_nf::inq_varnatts_id	(	integer, intent(in)	ncid,
		integer, intent(in)	varid,
		integer, intent(out)	natts
	)

Gets metadata information for netcdf file.

Author

Jim Edwards

inq_varnatts_vid()

integer function pio_nf::inq_varnatts_vid	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, intent(out)	natts
	)

Gets metadata information for netcdf file.

Author

Jim Edwards

inq_varndims_desc()

integer function pio_nf::inq_varndims_desc	(	type (file_desc_t), intent(in)	File,
		type (var_desc_t), intent(in)	vardesc,
		integer, intent(out)	ndims
	)

File descriptor structure.

Gets the number of dimension associated with a netcdf variable.

Parameters

File	This structure holds information associated with each open file
vardesc	Variable description structure.
ndims	The number of dimensions for the variable

Return values

ierr	The error return code (see Error Handling for Fortran).

Author

Jim Edwards

inq_varndims_id()

integer function pio_nf::inq_varndims_id	(	integer, intent(in)	ncid,
		integer, intent(in)	varid,
		integer, intent(out)	ndims
	)

Gets the number of dimension associated with a netcdf variable.

Author

Jim Edwards

inq_varndims_vid()

integer function pio_nf::inq_varndims_vid	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, intent(out)	ndims
	)

Gets the number of dimension associated with a netcdf variable.

Author

Jim Edwards

inq_vartype_desc()

integer function pio_nf::inq_vartype_desc	(	type (file_desc_t), intent(in)	File,
		type (var_desc_t), intent(in)	vardesc,
		integer, intent(out)	type
	)

File descriptor structure.

Gets metadata information for netcdf file.

Parameters

File	This structure holds information associated with each open file
vardesc	Variable description structure.
type	The type of variable

Return values

ierr	The error return code (see Error Handling for Fortran).

Author

Jim Edwards

inq_vartype_id()

integer function pio_nf::inq_vartype_id	(	integer, intent(in)	ncid,
		integer, intent(in)	varid,
		integer, intent(out)	type
	)

Gets metadata information for netcdf file.

Author

Jim Edwards

inq_vartype_vid()

integer function pio_nf::inq_vartype_vid	(	type (file_desc_t), intent(in)	File,
		integer, intent(in)	varid,
		integer, intent(out)	type
	)

Gets metadata information for netcdf file.

Author

Jim Edwards

inquire_variable_desc()

integer function pio_nf::inquire_variable_desc	(	type(file_desc_t), intent(in)	file,
		type(var_desc_t), intent(in)	vardesc,
		character (len = *), intent(out), optional	name,
		integer, intent(out), optional	xtype,
		integer, intent(out), optional	ndims,
		integer, dimension(:), intent(out), optional	dimids,
		integer, intent(out), optional	natts
	)

Variable description structure.

Inquires if a NetCDF variable is present and returns its attributes.

Parameters

file	A netcdf file descriptor returned by Open a File or Create a File.
vardesc
name	The name of the variable
xtype	The type of the variable
ndims	The number of dimensions for the variable.
dimids	The dimension identifier returned by Define a Dimension
natts	Number of attributes associated with the variable

Return values

ierr	The error return code (see Error Handling for Fortran).

Author

Jim Edwards

inquire_variable_id()

integer function pio_nf::inquire_variable_id	(	integer, intent(in)	ncid,
		integer, intent(in)	varid,
		character (len = *), intent(out), optional	name,
		integer, intent(out), optional	xtype,
		integer, intent(out), optional	ndims,
		integer, dimension(:), intent(out), optional	dimids,
		integer, intent(out), optional	natts
	)

Inquires if a NetCDF variable is present and returns its attributes.

Author

Jim Edwards

inquire_variable_vid()

integer function pio_nf::inquire_variable_vid	(	type(file_desc_t), intent(in)	file,
		integer, intent(in)	varid,
		character (len = *), intent(out), optional	name,
		integer, intent(out), optional	xtype,
		integer, intent(out), optional	ndims,
		integer, dimension(:), intent(out), optional	dimids,
		integer, intent(out), optional	natts
	)

Inquires if a NetCDF variable is present and returns its attributes.

Author

Jim Edwards