Learn About Dimension

Learn dimension name, ID, or length in Fortran. More...

Functions/Subroutines
integer function	pio_nf::inq_dimid_desc (File, name, dimid)
	File descriptor structure. More...
integer function	pio_nf::inq_dimid_id (ncid, name, dimid)
integer function	pio_nf::inquire_dimension_desc (file, dimid, name, len)
	The error return code (see Error Handling for Fortran). More...
integer function	pio_nf::inquire_dimension_id (ncid, dimid, name, len)
	The error return code (see Error Handling for Fortran). More...
integer function	pio_nf::inq_dimlen_desc (File, dimid, len)
	File descriptor structure. More...
integer function	pio_nf::inq_dimlen_desc_long (File, dimid, len)
integer function	pio_nf::inq_dimlen_id (ncid, dimid, len)
integer function	pio_nf::inq_dimlen_id_long (ncid, dimid, len)
integer function	pio_nf::inq_dimname_desc (File, dimid, name)
	File descriptor structure. More...
integer function	pio_nf::inq_dimname_id (ncid, dimid, name)

Detailed Description

Learn dimension name, ID, or length in Fortran.

Use the generic functions to call the underlying Fortran functions.

Generic Function	Function(s)
pio_inq_dimlen()	inq_dimlen_desc(), inq_dimlen_id(), inq_dimlen_desc_long(), inq_dimlen_id_long()
pio_inq_ndims()	inq_ndims_id()
pio_inq_dimid()	inq_dimid_desc(), inq_dimid_id()
pio_inq_dimname()	inq_dimname_desc(), inq_dimname_id()

Function/Subroutine Documentation

inq_dimid_desc()

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

File descriptor structure.

Returns the netcdf dimension id for the name.

Note

We do not want internal error checking for this function.

Parameters

File	This structure holds information associated with each open file
name	The name of the netcdf dimension.
dimid	The netcdf dimension id.

Return values

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

Author

Jim Edwards

inq_dimid_id()

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

Returns the netcdf dimension id for the name.

Author

Jim Edwards

inq_dimlen_desc()

integer function pio_nf::inq_dimlen_desc	(	type(file_desc_t), intent(in)	File,
		integer, intent(in)	dimid,
		integer, intent(out)	len
	)

File descriptor structure.

Get information about the length of a particular dimension in netcdf file.

Parameters

File	This structure holds information associated with each open file
dimid	The netcdf dimension ID.
len	The length of the dimesion.

Return values

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

Author

Jim Edwards

inq_dimlen_desc_long()

integer function pio_nf::inq_dimlen_desc_long	(	type(file_desc_t), intent(in)	File,
		integer, intent(in)	dimid,
		integer(pio_offset_kind), intent(out)	len
	)

Get information about the length of a particular dimension in netcdf file.

Author

Jim Edwards

inq_dimlen_id()

integer function pio_nf::inq_dimlen_id	(	integer, intent(in)	ncid,
		integer, intent(in)	dimid,
		integer, intent(out)	len
	)

Get information about the length of a particular dimension in netcdf file.

Author

Jim Edwards

inq_dimlen_id_long()

integer function pio_nf::inq_dimlen_id_long	(	integer, intent(in)	ncid,
		integer, intent(in)	dimid,
		integer(pio_offset_kind), intent(out)	len
	)

Get information about the length of a particular dimension in netcdf file.

Author

Jim Edwards

inq_dimname_desc()

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

File descriptor structure.

Get information about the name of of a dimension.

Parameters

File	This structure holds information associated with each open file
dimid	The netcdf dimension ID.
name	The name of the dimesion.

Return values

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

Author

Jim Edwards

inq_dimname_id()

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

Get information about the name of of a dimension.

Author

Jim Edwards

inquire_dimension_desc()

integer function pio_nf::inquire_dimension_desc	(	type(file_desc_t), intent(in)	file,
		integer, intent(in)	dimid,
		character (len = *), intent(out), optional	name,
		integer, intent(out), optional	len
	)

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

Get information about a particular dimension in netcdf file.

Parameters

file	A netcdf file descriptor returned by Open a File or Create a File.
dimid	The netcdf dimension ID.
name	The name of the dimension.
len	The length of the dimesions name.

Return values

ierr

Author

Jim Edwards

inquire_dimension_id()

integer function pio_nf::inquire_dimension_id	(	integer, intent(in)	ncid,
		integer, intent(in)	dimid,
		character (len = *), intent(out), optional	name,
		integer, intent(out), optional	len
	)

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

Get information about a particular dimension in netcdf file.

Parameters

ncid	A netcdf file ID returned by Open a File or Create a File.
dimid	The netcdf dimension ID.
name	The name of the dimension.
len	The length of the dimesions name.

Return values

ierr

Author

Jim Edwards