PIO  2.5.4
Data Types | Functions/Subroutines
pio_nf.F90 File Reference
#include "config.h"
Include dependency graph for pio_nf.F90:

Functions/Subroutines

integer function pio_nf::inq_dimid_desc (File, name, dimid)
 File descriptor structure. More...
 
integer function pio_nf::set_fill_id (ncid, fillmode, old_mode)
 The error return code (see Error Handling for Fortran). More...
 
integer function pio_nf::set_fill_desc (File, fillmode, old_mode)
 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)
 
integer function pio_nf::inq_ndims_id (ncid, ndims)
 
integer function pio_nf::inq_nvars_id (ncid, nvars)
 
integer function pio_nf::inq_natts_id (ncid, natts)
 
integer function pio_nf::inq_unlimdim_desc (File, unlimdim)
 File descriptor structure. More...
 
integer function pio_nf::inq_unlimdim_id (ncid, unlimdim)
 
integer function pio_nf::inquire_desc (File, nDimensions, nVariables, nAttributes, unlimitedDimID)
 File descriptor structure. More...
 
integer function pio_nf::inquire_id (ncid, nDimensions, nVariables, nAttributes, unlimitedDimID)
 
integer function pio_nf::enddef_desc (File)
 File descriptor structure. More...
 
integer function pio_nf::enddef_id (ncid)
 
integer function pio_nf::redef_desc (File)
 File descriptor structure. More...
 
integer function pio_nf::set_log_level (log_level)
 The error return code (see Error Handling for Fortran). More...
 
integer function pio_nf::set_global_log_level (iosys, log_level)
 The error return code (see Error Handling for Fortran). More...
 
integer function pio_nf::strerror (errcode, errmsg)
 
integer function pio_nf::redef_id (ncid)
 
integer function pio_nf::def_dim_int_desc (File, name, len, dimid)
 File descriptor structure. More...
 
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)
 
integer function pio_nf::inq_attlen_desc (File, vardesc, name, len)
 File descriptor structure. More...
 
integer function pio_nf::inq_att_desc (File, vardesc, name, xtype, len)
 File descriptor structure. More...
 
integer function pio_nf::inq_attname_desc (File, vdesc, attnum, name)
 
integer function pio_nf::def_var_0d_desc (File, name, type, vardesc)
 File descriptor structure. More...
 
integer function pio_nf::def_var_deflate_id (file, varid, shuffle, deflate, deflate_level)
 
integer function pio_nf::def_var_deflate_desc (file, vardesc, shuffle, deflate, deflate_level)
 
integer function pio_nf::set_chunk_cache (iosysid, iotype, chunk_cache_size, chunk_cache_nelems, chunk_cache_preemption)
 
integer function pio_nf::get_chunk_cache (iosysid, iotype, chunk_cache_size, chunk_cache_nelems, chunk_cache_preemption)
 
integer function pio_nf::set_var_chunk_cache_id (file, varid, chunk_cache_size, chunk_cache_nelems, chunk_cache_preemption)
 
integer function pio_nf::set_var_chunk_cache_desc (file, vardesc, chunk_cache_size, chunk_cache_nelems, chunk_cache_preemption)
 

Detailed Description

Code to implement the classic netCDF Fortran API in PIO.

Author
Jim Edwards

Function/Subroutine Documentation

◆ def_var_deflate_desc()

integer function pio_nf::def_var_deflate_desc ( type (file_desc_t), intent(in)  file,
type (var_desc_t), intent(in)  vardesc,
integer, intent(in)  shuffle,
integer, intent(in)  deflate,
integer, intent(in)  deflate_level 
)

Changes compression settings for a netCDF-4/HDF5 variable.

Author
Ed Hartnett

◆ def_var_deflate_id()

integer function pio_nf::def_var_deflate_id ( type (file_desc_t), intent(in)  file,
integer, intent(in)  varid,
integer, intent(in)  shuffle,
integer, intent(in)  deflate,
integer, intent(in)  deflate_level 
)

Changes compression settings for a netCDF-4/HDF5 variable.

Author
Ed Hartnett

◆ get_chunk_cache()

integer function pio_nf::get_chunk_cache ( integer, intent(in)  iosysid,
integer, intent(in)  iotype,
integer(kind=pio_offset_kind), intent(out)  chunk_cache_size,
integer(kind=pio_offset_kind), intent(out)  chunk_cache_nelems,
real, intent(out)  chunk_cache_preemption 
)

Gets current settings for chunk cache (only relevant for netCDF4/HDF5 files).

Author
Ed Hartnett

◆ set_chunk_cache()

integer function pio_nf::set_chunk_cache ( integer, intent(in)  iosysid,
integer, intent(in)  iotype,
integer(kind=pio_offset_kind), intent(in)  chunk_cache_size,
integer(kind=pio_offset_kind), intent(in)  chunk_cache_nelems,
real, intent(in)  chunk_cache_preemption 
)

Changes chunk cache settings for netCDF-4/HDF5 files created after this call.

Author
Ed Hartnett

◆ set_fill_desc()

integer function pio_nf::set_fill_desc ( type(file_desc_t), intent(in)  File,
integer, intent(in)  fillmode,
integer, intent(out)  old_mode 
)

File descriptor structure.

Set the netcdf fill mode

Parameters
FileThis structure holds information associated with each open file
fillmodeDesired fill mode for the dataset, either PIO_NOFILL or PIO_FILL.
old_modeReturned current fill mode of the dataset before this call, either PIO_NOFILL or PIO_FILL.
Return values
ierrThe error return code (see Error Handling for Fortran).
Author
Jim Edwards

◆ set_fill_id()

integer function pio_nf::set_fill_id ( integer, intent(in)  ncid,
integer, intent(in)  fillmode,
integer, intent(out)  old_mode 
)

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

Set the netcdf fill mode

Parameters
ncidA netcdf file ID returned by Open a File or Create a File.
fillmodeDesired fill mode for the dataset, either PIO_NOFILL or PIO_FILL.
old_modeReturned current fill mode of the dataset before this call, either PIO_NOFILL or PIO_FILL.
Return values
ierr
Author
Jim Edwards

◆ set_var_chunk_cache_desc()

integer function pio_nf::set_var_chunk_cache_desc ( type (file_desc_t), intent(in)  file,
type (var_desc_t), intent(in)  vardesc,
integer(pio_offset_kind), intent(in)  chunk_cache_size,
integer(pio_offset_kind), intent(in)  chunk_cache_nelems,
real, intent(in)  chunk_cache_preemption 
)

Changes chunk cacne for a variable.

Author
Ed Hartnett

◆ set_var_chunk_cache_id()

integer function pio_nf::set_var_chunk_cache_id ( type (file_desc_t), intent(in)  file,
integer, intent(in)  varid,
integer(pio_offset_kind), intent(in)  chunk_cache_size,
integer(pio_offset_kind), intent(in)  chunk_cache_nelems,
real, intent(in)  chunk_cache_preemption 
)

Changes chunk cache settings for a variable in a netCDF-4/HDF5 file.

Author
Ed Hartnett