From 1a1925d449efe8fbfc783eacc02f18a2c163d7ee Mon Sep 17 00:00:00 2001 From: Ed Hartnett Date: Thu, 30 May 2019 06:26:50 -0600 Subject: [PATCH] more docs work --- src/flib/pio_nf.F90 | 1228 +++++++++++++++++++------------------- src/flib/pio_support.F90 | 2 + 2 files changed, 619 insertions(+), 611 deletions(-) diff --git a/src/flib/pio_nf.F90 b/src/flib/pio_nf.F90 index 064741d6993..843c88bccd2 100644 --- a/src/flib/pio_nf.F90 +++ b/src/flib/pio_nf.F90 @@ -1,3 +1,8 @@ +!> +!! @file +!! Code to implement the classic netCDF Fortran API in PIO. +!! @author Jim Edwards +!< module pio_nf #ifdef TIMING use perf_mod , only : t_startf, t_stopf ! _EXTERNAL @@ -39,7 +44,7 @@ module pio_nf pio_redef , & pio_set_log_level , & pio_strerror -! pio_copy_att to be done + ! pio_copy_att to be done interface pio_def_var module procedure & @@ -47,78 +52,78 @@ module pio_nf def_var_md_desc , & def_var_0d_id , & def_var_md_id - end interface + end interface pio_def_var interface pio_def_var_deflate module procedure & def_var_deflate_desc , & def_var_deflate_id - end interface + end interface pio_def_var_deflate interface pio_def_var_chunking module procedure & def_var_chunking - end interface + end interface pio_def_var_chunking interface pio_inq_attname module procedure & inq_attname_desc , & inq_attname_vid , & inq_attname_id - end interface + end interface pio_inq_attname interface pio_inq_att module procedure & inq_att_desc , & inq_att_vid , & inq_att_id - end interface + end interface pio_inq_att interface pio_inq_attlen module procedure & inq_attlen_desc , & inq_attlen_vid , & inq_attlen_id - end interface + end interface pio_inq_attlen interface pio_inq_varid module procedure & inq_varid_desc , & inq_varid_vid , & inq_varid_id - end interface + end interface pio_inq_varid interface pio_inq_varname module procedure & inq_varname_desc , & inq_varname_vid , & inq_varname_id - end interface + end interface pio_inq_varname interface pio_inq_vartype module procedure & inq_vartype_desc , & inq_vartype_vid , & inq_vartype_id - end interface + end interface pio_inq_vartype interface pio_inq_varndims module procedure & inq_varndims_desc , & inq_varndims_vid , & inq_varndims_id - end interface + end interface pio_inq_varndims interface pio_inq_vardimid module procedure & inq_vardimid_desc , & inq_vardimid_vid , & inq_vardimid_id - end interface + end interface pio_inq_vardimid interface pio_inq_varnatts module procedure & inq_varnatts_desc , & inq_varnatts_vid , & inq_varnatts_id - end interface + end interface pio_inq_varnatts interface pio_inq_var_deflate module procedure & inq_var_deflate_desc , & inq_var_deflate_vid , & inq_var_deflate_id - end interface + end interface pio_inq_var_deflate interface pio_inquire_dimension module procedure & inquire_dimension_desc , & @@ -130,7 +135,7 @@ module pio_nf inquire_variable_desc , & inquire_variable_vid , & inquire_variable_id - end interface + end interface pio_inquire_variable interface pio_def_dim module procedure & @@ -138,45 +143,45 @@ module pio_nf def_dim_id , & def_dim_int_desc , & def_dim_int_id - end interface + end interface pio_def_dim interface pio_inq_dimlen module procedure & inq_dimlen_desc , & inq_dimlen_id , & inq_dimlen_desc_long , & inq_dimlen_id_long - end interface + end interface pio_inq_dimlen interface pio_inq_ndims module procedure & inq_ndims_desc , & inq_ndims_id - end interface + end interface pio_inq_ndims interface pio_inq_dimid module procedure & inq_dimid_desc , & inq_dimid_id - end interface + end interface pio_inq_dimid interface pio_inq_dimname module procedure & inq_dimname_desc , & inq_dimname_id - end interface + end interface pio_inq_dimname interface pio_inq_nvars module procedure & inq_nvars_desc , & inq_nvars_id - end interface + end interface pio_inq_nvars interface pio_inq_natts module procedure & inq_natts_desc , & inq_natts_id - end interface + end interface pio_inq_natts interface pio_inq_unlimdim module procedure & inq_unlimdim_desc , & inq_unlimdim_id - end interface + end interface pio_inq_unlimdim interface pio_enddef module procedure & @@ -188,7 +193,7 @@ module pio_nf module procedure & redef_desc , & redef_id - end interface + end interface pio_redef interface pio_set_log_level module procedure & @@ -204,58 +209,58 @@ module pio_nf module procedure & inquire_desc , & inquire_id - end interface + end interface pio_inquire interface pio_set_chunk_cache module procedure & set_chunk_cache - end interface + end interface pio_set_chunk_cache interface pio_get_chunk_cache module procedure & get_chunk_cache - end interface + end interface pio_get_chunk_cache interface pio_set_var_chunk_cache module procedure & set_var_chunk_cache_desc , & set_var_chunk_cache_id - end interface + end interface pio_set_var_chunk_cache interface pio_get_var_chunk_cache module procedure & get_var_chunk_cache_desc , & get_var_chunk_cache_id - end interface + end interface pio_get_var_chunk_cache contains -!> -!! @defgroup PIO_inq_dimid PIO_inq_dimid -!< -!> -!! @public -!! @ingroup PIO_inq_dimid -!! @brief Returns the netcdf dimension id for the name. -!! @details -!! @param File @copydoc file_desc_t -!! @param name : The name of the netcdf dimension. -!! @param dimid : The netcdf dimension id. -!! @retval ierr @copydoc error_return -!! -!! Note that we do not want internal error checking for this function. -!< + !> + !! @defgroup PIO_inq_dimid PIO_inq_dimid + !< + !> + !! @ingroup PIO_inq_dimid + !! Returns the netcdf dimension id for the name. + !! + !! @note We do not want internal error checking for this function. + !! + !! @param File @copydoc file_desc_t + !! @param name : The name of the netcdf dimension. + !! @param dimid : The netcdf dimension id. + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inq_dimid_desc(File ,name,dimid) result(ierr) type (File_desc_t) , intent(in) :: File character(len=*) , intent(in) :: name integer , intent(out) :: dimid !dimension ID ierr = inq_dimid_id(file%fh ,name,dimid) end function inq_dimid_desc -!> -!! @public -!! @ingroup PIO_inq_dimid -!! @brief Returns the netcdf dimension id for the name. -!< + !> + !! @ingroup PIO_inq_dimid + !! Returns the netcdf dimension id for the name. + !! @author Jim Edwards + !< integer function inq_dimid_id(ncid ,name,dimid) result(ierr) integer , intent(in) :: ncid character(len=*) , intent(in) :: name @@ -273,20 +278,20 @@ end function PIOc_inq_dimid dimid=dimid+1 end function inq_dimid_id -!> -!! @defgroup PIO_inquire_dimension PIO_inquire_dimension -!< -!> -!! @public -!! @ingroup PIO_inquire_dimension -!! @brief Get information about a particular dimension in netcdf file -!! @details -!! @param file : A netcdf file descriptor returned by \ref PIO_openfile or \ref PIO_createfile. -!! @param dimid : The netcdf dimension ID. -!! @param name : The name of the dimension. -!! @param len : The length of the dimesions name. -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inquire_dimension PIO_inquire_dimension + !< + !> + !! @ingroup PIO_inquire_dimension + !! Get information about a particular dimension in netcdf file. + !! @details + !! @param file : A netcdf file descriptor returned by \ref PIO_openfile or \ref PIO_createfile. + !! @param dimid : The netcdf dimension ID. + !! @param name : The name of the dimension. + !! @param len : The length of the dimesions name. + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inquire_dimension_desc(file , dimid, name, len) result(ierr) type(file_desc_T) , intent(in) :: file integer , intent( in) :: dimid @@ -294,11 +299,11 @@ integer function inquire_dimension_desc(file , dimid, name, len) re integer , optional, intent(out) :: len ierr = Inquire_dimension_id(file%fh , dimid, name, len) end function inquire_dimension_desc -!> -!! @public -!! @ingroup PIO_inquire_dimension -!! @brief Get information about a particular dimension in netcdf file -!< + !> + !! @ingroup PIO_inquire_dimension + !! Get information about a particular dimension in netcdf file. + !! @author Jim Edwards + !< integer function inquire_dimension_id(ncid , dimid, name, len) result(ierr) integer , intent(in) :: ncid integer , intent( in) :: dimid @@ -314,41 +319,41 @@ integer function inquire_dimension_id(ncid , dimid, name, len) re end function inquire_dimension_id -!> -!! @defgroup PIO_inq_dimlen PIO_inq_dimlen -!< -!> -!! @public -!! @ingroup PIO_inq_dimlen -!! @brief Get information about the length of a particular dimension in netcdf file -!! @details -!! @param File @copydoc file_desc_t -!! @param dimid : The netcdf dimension ID. -!! @param len : The length of the dimesion. -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inq_dimlen PIO_inq_dimlen + !< + !> + !! @ingroup PIO_inq_dimlen + !! Get information about the length of a particular dimension in netcdf file. + !! @details + !! @param File @copydoc file_desc_t + !! @param dimid : The netcdf dimension ID. + !! @param len : The length of the dimesion. + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inq_dimlen_desc(File , dimid, len) result(ierr) type(file_desc_t) , intent(in) :: File integer , intent(in) :: dimid integer , intent(out) :: len ierr = inq_dimlen_id(file%fh ,dimid,len) end function inq_dimlen_desc -!> -!! @public -!! @ingroup PIO_inq_dimlen -!! @brief Get information about the length of a particular dimension in netcdf file -!< + !> + !! @ingroup PIO_inq_dimlen + !! Get information about the length of a particular dimension in netcdf file. + !! @author Jim Edwards + !< integer function inq_dimlen_desc_long(File , dimid, len) result(ierr) type(file_desc_t) , intent(in) :: File integer , intent(in) :: dimid integer(PIO_OFFSET_KIND) , intent(out) :: len ierr = inq_dimlen_id_long(file%fh ,dimid,len) end function inq_dimlen_desc_long -!> -!! @public -!! @ingroup PIO_inq_dimlen -!! @brief Get information about the length of a particular dimension in netcdf file -!< + !> + !! @ingroup PIO_inq_dimlen + !! Get information about the length of a particular dimension in netcdf file. + !! @author Jim Edwards + !< integer function inq_dimlen_id(ncid , dimid, len) result(ierr) integer , intent(in) :: ncid integer , intent(in) :: dimid @@ -357,11 +362,11 @@ integer function inq_dimlen_id(ncid , dimid, len) result(i ierr = inq_dimlen_id_long(ncid ,dimid,llen) len = int(llen) end function inq_dimlen_id -!> -!! @public -!! @ingroup PIO_inq_dimlen -!! @brief Get information about the length of a particular dimension in netcdf file -!< + !> + !! @ingroup PIO_inq_dimlen + !! Get information about the length of a particular dimension in netcdf file. + !! @author Jim Edwards + !< integer function inq_dimlen_id_long(ncid , dimid, len) result(ierr) integer , intent(in) :: ncid integer , intent(in) :: dimid @@ -380,30 +385,30 @@ end function PIOc_inq_dimlen end function inq_dimlen_id_long -!> -!! @defgroup PIO_inq_dimname PIO_inq_dimname -!< -!> -!! @public -!! @ingroup PIO_inq_dimname -!! @brief Get information about the name of of a dimension. -!! @details -!! @param File @copydoc file_desc_t -!! @param dimid : The netcdf dimension ID. -!! @param name : The name of the dimesion. -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inq_dimname PIO_inq_dimname + !< + !> + !! @ingroup PIO_inq_dimname + !! Get information about the name of of a dimension. + !! @details + !! @param File @copydoc file_desc_t + !! @param dimid : The netcdf dimension ID. + !! @param name : The name of the dimesion. + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inq_dimname_desc(File , dimid, name) result(ierr) type(file_desc_t) , intent(in) :: File integer , intent(in) :: dimid character(len=*) , intent(out) :: name ierr = inq_dimname_id(file%fh ,dimid,name) end function inq_dimname_desc -!> -!! @public -!! @ingroup PIO_inq_dimname -!! @brief Get information about the name of of a dimension. -!< + !> + !! @ingroup PIO_inq_dimname + !! Get information about the name of of a dimension. + !! @author Jim Edwards + !< integer function inq_dimname_id(ncid , dimid, name) result(ierr) integer , intent(in) :: ncid integer , intent(in) :: dimid @@ -425,28 +430,28 @@ end function PIOc_inq_dimname end function inq_dimname_id -!> -!! @defgroup PIO_inq_ndims PIO_inq_ndims -!< -!> -!! @public -!! @ingroup PIO_inq_ndims -!! @brief Get information about the number of dimensions of a file or group. -!! @details -!! @param File @copydoc file_desc_t -!! @param ndims : The number of dimensions in the file. -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inq_ndims PIO_inq_ndims + !< + !> + !! @ingroup PIO_inq_ndims + !! Get information about the number of dimensions of a file or group. + !! @details + !! @param File @copydoc file_desc_t + !! @param ndims : The number of dimensions in the file. + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inq_ndims_desc(File , ndims) result(ierr) type (File_desc_t) , intent(inout) :: File integer , intent(out) :: ndims ierr = inq_ndims_id(file%fh , ndims) end function inq_ndims_desc -!> -!! @public -!! @ingroup PIO_inq_ndims -!! @brief Get information about the number of dimensions of a file or group. -!< + !> + !! @ingroup PIO_inq_ndims + !! Get information about the number of dimensions of a file or group. + !! @author Jim Edwards + !< integer function inq_ndims_id(ncid , ndims) result(ierr) integer , intent(in) :: ncid integer , intent(out) :: ndims @@ -461,28 +466,28 @@ end function PIOc_inq_ndims ierr = PIOc_inq_ndims(ncid ,ndims) end function inq_ndims_id -!> -!! @defgroup PIO_inq_nvars PIO_inq_nvars -!< -!> -!! @public -!! @ingroup PIO_inq_nvars -!! @brief Get information about the number of variables in a file or group. -!! @details -!! @param File @copydoc file_desc_t -!! @param nvars : The number of variables in the file. -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inq_nvars PIO_inq_nvars + !< + !> + !! @ingroup PIO_inq_nvars + !! Get information about the number of variables in a file or group. + !! @details + !! @param File @copydoc file_desc_t + !! @param nvars : The number of variables in the file. + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inq_nvars_desc(File , nvars) result(ierr) type (File_desc_t) , intent(inout) :: File integer , intent(out) :: nvars ierr = inq_nvars_id(file%fh , nvars) end function inq_nvars_desc -!> -!! @public -!! @ingroup PIO_inq_nvars -!! @brief Get information about the number of variables in a file or group. -!< + !> + !! @ingroup PIO_inq_nvars + !! Get information about the number of variables in a file or group. + !! @author Jim Edwards + !< integer function inq_nvars_id(ncid , nvars) result(ierr) integer , intent(in) :: ncid integer , intent(out) :: nvars @@ -497,28 +502,28 @@ end function PIOc_inq_nvars ierr = PIOc_inq_nvars(ncid ,nvars) end function inq_nvars_id -!> -!! @defgroup PIO_inq_natts PIO_inq_natts -!< -!> -!! @public -!! @ingroup PIO_inq_natts -!! @brief Get information about the number of global attributes in a file or group. -!! @details -!! @param File @copydoc file_desc_t -!! @param natts : The number of attributes in the file. -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inq_natts PIO_inq_natts + !< + !> + !! @ingroup PIO_inq_natts + !! Get information about the number of global attributes in a file or group. + !! @details + !! @param File @copydoc file_desc_t + !! @param natts : The number of attributes in the file. + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inq_natts_desc(File , natts) result(ierr) type (File_desc_t) , intent(inout) :: File integer , intent(out) :: natts ierr = inq_natts_id(file%fh , natts) end function inq_natts_desc -!> -!! @public -!! @ingroup PIO_inq_natts -!! @brief Get information about the number of global attributes in a file or group. -!< + !> + !! @ingroup PIO_inq_natts + !! Get information about the number of global attributes in a file or group. + !! @author Jim Edwards + !< integer function inq_natts_id(ncid , natts) result(ierr) integer , intent(in) :: ncid integer , intent(out) :: natts @@ -533,28 +538,28 @@ end function PIOc_inq_natts ierr = PIOc_inq_natts(ncid ,natts) end function inq_natts_id -!> -!! @defgroup PIO_inq_unlimdim PIO_inq_unlimdim -!< -!> -!! @public -!! @ingroup PIO_inq_unlimdm -!! @brief Get information about the unlimited dimension in a file. -!! @details -!! @param File @copydoc file_desc_t -!! @param unlimdim : Pointer to the unlimted dimension. If no unlimited dimension, this will be -1. -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inq_unlimdim PIO_inq_unlimdim + !< + !> + !! @ingroup PIO_inq_unlimdm + !! Get information about the unlimited dimension in a file. + !! @details + !! @param File @copydoc file_desc_t + !! @param unlimdim : Pointer to the unlimted dimension. If no unlimited dimension, this will be -1. + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inq_unlimdim_desc(File , unlimdim) result(ierr) type (File_desc_t) , intent(inout) :: File integer , intent(out) :: unlimdim ierr = inq_unlimdim_id(file%fh , unlimdim) end function inq_unlimdim_desc -!> -!! @public -!! @ingroup PIO_inq_unlimdm -!! @brief Get information about the unlimited dimension in a file. -!< + !> + !! @ingroup PIO_inq_unlimdm + !! Get information about the unlimited dimension in a file. + !! @author Jim Edwards + !< integer function inq_unlimdim_id(ncid ,unlimdim) result(ierr) integer , intent(in) :: ncid integer , intent(out) :: unlimdim @@ -570,21 +575,21 @@ end function PIOc_inq_unlimdim if(unlimdim>=0) unlimdim=unlimdim+1 end function inq_unlimdim_id -!> -!! @defgroup PIO_inquire PIO_inquire -!< -!> -!! @public -!! @ingroup PIO_inquire -!! @brief Gets metadata information for netcdf file. -!! @details -!! @param File @copydoc file_desc_t -!! @param nDimensions : Number of dimensions defined for the netcdf file -!! @param nVariables : Number of variables defined for the netcdf file -!! @param nAttributes : Number of attributes defined for the netcdf file -!! @param unlimitedDimID : the Unlimited dimension ID -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inquire PIO_inquire + !< + !> + !! @ingroup PIO_inquire + !! Gets metadata information for netcdf file. + !! @details + !! @param File @copydoc file_desc_t + !! @param nDimensions : Number of dimensions defined for the netcdf file + !! @param nVariables : Number of variables defined for the netcdf file + !! @param nAttributes : Number of attributes defined for the netcdf file + !! @param unlimitedDimID : the Unlimited dimension ID + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inquire_desc(File ,nDimensions,nVariables,nAttributes,unlimitedDimID) result(ierr) type (File_desc_t) , intent(in) :: File @@ -596,11 +601,11 @@ integer function inquire_desc(File ,nDimensions,nVariable ierr = inquire_id(file%fh ,ndimensions,nvariables,nattributes,unlimitedDimID) end function inquire_desc -!> -!! @public -!! @ingroup PIO_inquire -!! @brief Gets metadata information for netcdf file. -!< + !> + !! @ingroup PIO_inquire + !! Gets metadata information for netcdf file. + !! @author Jim Edwards + !< integer function inquire_id(ncid ,nDimensions,nVariables,nAttributes,unlimitedDimID) result(ierr) integer ,intent(in) :: ncid integer , optional, intent(out) :: & @@ -615,26 +620,26 @@ integer function inquire_id(ncid ,nDimensions,nVariable if(present(unlimitedDimID)) ierr = inq_unlimdim_id(ncid ,unlimitedDimID) end function inquire_id -!> -!! @defgroup PIO_enddef PIO_enddef -!< -!> -!! @public -!! @ingroup PIO_enddef -!! @brief Exits netcdf define mode. -!! @details -!! @param File @copydoc file_desc_t -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_enddef PIO_enddef + !< + !> + !! @ingroup PIO_enddef + !! Exits netcdf define mode. + !! @details + !! @param File @copydoc file_desc_t + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function enddef_desc(File) result(ierr) type (File_desc_t) , intent(inout) :: File ierr = enddef_id(file%fh) end function enddef_desc -!> -!! @public -!! @ingroup PIO_enddef -!! @brief Wrapper for the C function \ref PIOc_enddef . -!< + !> + !! @ingroup PIO_enddef + !! Wrapper for the C function \ref PIOc_enddef . + !! @author Jim Edwards + !< integer function enddef_id(ncid) result(ierr) integer ,intent(in) :: ncid interface @@ -646,33 +651,34 @@ end function PIOc_enddef end interface ierr = PIOc_enddef(ncid) end function enddef_id -!> -!! @defgroup PIO_redef PIO_redef -!< -!> -!! @public -!! @ingroup PIO_redef -!! @brief Exits netcdf define mode. -!! @details -!! @param File @copydoc file_desc_t -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_redef PIO_redef + !< + !> + !! @ingroup PIO_redef + !! Exits netcdf define mode. + !! @details + !! @param File @copydoc file_desc_t + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function redef_desc(File) result(ierr) type (File_desc_t) , intent(inout) :: File ierr = redef_id(file%fh) end function redef_desc -!> -!! @defgroup PIO_set_log_level -!< -!> -!! @ingroup PIO_set_log_level -!! Sets the logging level. Only takes effect if PIO was built with -!! PIO_ENABLE_LOGGING=On -!! -!! @param log_level the logging level. -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_set_log_level + !< + !> + !! @ingroup PIO_set_log_level + !! Sets the logging level. Only takes effect if PIO was built with + !! PIO_ENABLE_LOGGING=On + !! + !! @param log_level the logging level. + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function set_log_level(log_level) result(ierr) integer, intent(in) :: log_level interface @@ -694,6 +700,7 @@ end function set_log_level !! !! @param errcode the error code !! @retval a description of the error + !! @author Jim Edwards !< integer function strerror(errcode, errmsg) result(ierr) integer, intent(in) :: errcode @@ -712,11 +719,11 @@ end function PIOc_strerror end function strerror -!> -!! @public -!! @ingroup PIO_redef -!! @brief Wrapper for the C function \ref PIOc_redef . -!< + !> + !! @ingroup PIO_redef + !! Wrapper for the C function \ref PIOc_redef . + !! @author Jim Edwards + !< integer function redef_id(ncid) result(ierr) integer, intent(in) :: ncid interface @@ -729,20 +736,20 @@ end function PIOc_redef ierr = PIOc_redef(ncid) end function redef_id -!> -!! @defgroup PIO_def_dim PIO_def_dim -!! @brief A set of functions to define dimensions and their attributes in NetCDF files. -!< -!> -!! @public -!! @ingroup PIO_def_dim -!! @brief Defines the netcdf dimension. -!! @details -!! @param File @copydoc file_desc_t -!! @param name : The name of the dimension to define -!! @param len : The size of the dimension -!! @param dimid : The dimension identifier -!< + !> + !! @defgroup PIO_def_dim PIO_def_dim + !! A set of functions to define dimensions and their attributes in NetCDF files. + !< + !> + !! @ingroup PIO_def_dim + !! Defines the netcdf dimension. + !! @details + !! @param File @copydoc file_desc_t + !! @param name : The name of the dimension to define + !! @param len : The size of the dimension + !! @param dimid : The dimension identifier + !! @author Jim Edwards + !< integer function def_dim_int_desc(File ,name,len,dimid) result(ierr) type (File_desc_t) , intent(in) :: File @@ -752,11 +759,11 @@ integer function def_dim_int_desc(File ,name,len,dimid) resul ierr = def_dim_id(file%fh ,name,int(len,pio_offset_kind),dimid) end function def_dim_int_desc -!> -!! @public -!! @ingroup PIO_def_dim -!! @brief Defines the netcdf dimension. -!< + !> + !! @ingroup PIO_def_dim + !! Defines the netcdf dimension. + !! @author Jim Edwards + !< integer function def_dim_int_id(ncid ,name,len,dimid) result(ierr) integer , intent(in) :: ncid character(len=*) , intent(in) :: name @@ -765,11 +772,11 @@ integer function def_dim_int_id(ncid ,name,len,dimid) resul ierr = def_dim_id(ncid ,name,int(len,pio_offset_kind),dimid) end function def_dim_int_id -!> -!! @public -!! @ingroup PIO_def_dim -!! @brief Defines the netcdf dimension. -!< + !> + !! @ingroup PIO_def_dim + !! Defines the netcdf dimension. + !! @author Jim Edwards + !< integer function def_dim_desc(File ,name,len,dimid) result(ierr) type (File_desc_t) , intent(in) :: File @@ -779,11 +786,11 @@ integer function def_dim_desc(File ,name,len,dimid) resul ierr = def_dim_id(file%fh ,name,len,dimid) end function def_dim_desc -!> -!! @public -!! @ingroup PIO_def_dim -!! @brief Defines the netcdf dimension. -!< + !> + !! @ingroup PIO_def_dim + !! Defines the netcdf dimension. + !! @author Jim Edwards + !< integer function def_dim_id(ncid ,name,len,dimid) result(ierr) integer , intent(in) :: ncid character(len=*) , intent(in) :: name @@ -805,23 +812,23 @@ end function PIOc_def_dim end function def_dim_id -!> -!! @defgroup PIO_inquire_variable PIO_inquire_variable -!< -!> -!! @public -!! @ingroup PIO_inquire_variable -!! @brief Inquires if a NetCDF variable is present and returns its attributes -!! @details -!! @param file : A netcdf file descriptor returned by \ref PIO_openfile or \ref PIO_createfile. -!! @param vardesc @copydoc var_desc_t -!! @param name : The name of the variable -!! @param xtype : The type of the variable -!! @param ndims : The number of dimensions for the variable. -!! @param dimids : The dimension identifier returned by \ref PIO_def_dim -!! @param natts : Number of attributes associated with the variable -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inquire_variable PIO_inquire_variable + !< + !> + !! @ingroup PIO_inquire_variable + !! Inquires if a NetCDF variable is present and returns its attributes. + !! @details + !! @param file : A netcdf file descriptor returned by \ref PIO_openfile or \ref PIO_createfile. + !! @param vardesc @copydoc var_desc_t + !! @param name : The name of the variable + !! @param xtype : The type of the variable + !! @param ndims : The number of dimensions for the variable. + !! @param dimids : The dimension identifier returned by \ref PIO_def_dim + !! @param natts : Number of attributes associated with the variable + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inquire_variable_desc(file , vardesc, name, xtype, ndims, dimids, natts) result(ierr) type(file_desc_t) , intent(in) :: file type(var_desc_t) , intent( in) :: vardesc @@ -832,11 +839,11 @@ integer function inquire_variable_desc(file , vardesc, name, xtype ierr = pio_inquire_variable(file%fh ,vardesc%varid,name,xtype,ndims,dimids,natts) end function inquire_variable_desc -!> -!! @public -!! @ingroup PIO_inquire_variable -!! @brief Inquires if a NetCDF variable is present and returns its attributes -!< + !> + !! @ingroup PIO_inquire_variable + !! Inquires if a NetCDF variable is present and returns its attributes. + !! @author Jim Edwards + !< integer function inquire_variable_vid(file , varid, name, xtype, ndims, dimids, natts) result(ierr) type(file_desc_t) , intent(in) :: file integer , intent( in) :: varid @@ -847,11 +854,11 @@ integer function inquire_variable_vid(file , varid, name, xtype, ierr = pio_inquire_variable(file%fh ,varid,name,xtype,ndims,dimids,natts) end function inquire_variable_vid -!> -!! @public -!! @ingroup PIO_inquire_variable -!! @brief Inquires if a NetCDF variable is present and returns its attributes -!< + !> + !! @ingroup PIO_inquire_variable + !! Inquires if a NetCDF variable is present and returns its attributes. + !! @author Jim Edwards + !< integer function inquire_variable_id(ncid , varid, name, xtype, ndims, dimids, natts) result(ierr) integer , intent( in) :: ncid integer , intent( in) :: varid @@ -867,19 +874,19 @@ integer function inquire_variable_id(ncid , varid, name, xtype, if(present(xtype)) ierr = pio_inq_vartype(ncid , varid, xtype) end function inquire_variable_id -!> -!! @defgroup PIO_inq_vardimid PIO_inq_vardimid -!< -!> -!! @public -!! @ingroup PIO_inq_vardimid -!! @brief returns the dimids of the variable as an interger array -!! @details -!! @param File @copydoc file_desc_t -!! @param vardesc @copydoc var_desc_t -!! @param dimids : The dimension identifier returned by \ref PIO_def_dim -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inq_vardimid PIO_inq_vardimid + !< + !> + !! @ingroup PIO_inq_vardimid + !! returns the dimids of the variable as an interger array. + !! @details + !! @param File @copydoc file_desc_t + !! @param vardesc @copydoc var_desc_t + !! @param dimids : The dimension identifier returned by \ref PIO_def_dim + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inq_vardimid_desc(File ,vardesc,dimids) result(ierr) type (File_desc_t) , intent(in) :: File @@ -889,11 +896,11 @@ integer function inq_vardimid_desc(File ,vardesc,dimids) resul ierr = pio_inq_vardimid(File%fh , vardesc%varid, dimids) end function inq_vardimid_desc -!> -!! @public -!! @ingroup PIO_inq_vardimid -!! @brief returns the dimids of the variable as an interger array -!< + !> + !! @ingroup PIO_inq_vardimid + !! returns the dimids of the variable as an interger array. + !! @author Jim Edwards + !< integer function inq_vardimid_vid(File ,varid,dimids) result(ierr) type (File_desc_t) , intent(in) :: File @@ -903,11 +910,11 @@ integer function inq_vardimid_vid(File ,varid,dimids) result( ierr = pio_inq_vardimid(File%fh , varid, dimids) end function inq_vardimid_vid -!> -!! @public -!! @ingroup PIO_inq_vardimid -!! @brief returns the dimids of the variable as an interger array -!< + !> + !! @ingroup PIO_inq_vardimid + !! returns the dimids of the variable as an interger array. + !! @author Jim Edwards + !< integer function inq_vardimid_id(ncid ,varid,dimids) result(ierr) integer , intent(in) :: ncid integer , intent(in) :: varid @@ -935,19 +942,19 @@ end function PIOc_inq_vardimid end function inq_vardimid_id -!> -!! @defgroup PIO_inq_varndims PIO_inq_varndims -!< -!> -!! @public -!! @ingroup PIO_inq_varndims -!! @brief Gets the number of dimension associated with a netcdf variable -!! @details -!! @param File @copydoc file_desc_t -!! @param vardesc @copydoc var_desc_t -!! @param ndims : The number of dimensions for the variable -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inq_varndims PIO_inq_varndims + !< + !> + !! @ingroup PIO_inq_varndims + !! Gets the number of dimension associated with a netcdf variable. + !! @details + !! @param File @copydoc file_desc_t + !! @param vardesc @copydoc var_desc_t + !! @param ndims : The number of dimensions for the variable + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inq_varndims_desc(File ,vardesc,ndims) result(ierr) type (File_desc_t) , intent(in) :: File @@ -956,11 +963,11 @@ integer function inq_varndims_desc(File ,vardesc,ndims) result ierr = pio_inq_varndims(File%fh , vardesc%varid, ndims) end function inq_varndims_desc -!> -!! @public -!! @ingroup PIO_inq_varndims -!! @brief Gets the number of dimension associated with a netcdf variable -!< + !> + !! @ingroup PIO_inq_varndims + !! Gets the number of dimension associated with a netcdf variable. + !! @author Jim Edwards + !< integer function inq_varndims_vid(File ,varid,ndims) result(ierr) type (File_desc_t) , intent(in) :: File @@ -969,11 +976,11 @@ integer function inq_varndims_vid(File ,varid,ndims) result(i ierr = pio_inq_varndims(File%fh , varid, ndims) end function inq_varndims_vid -!> -!! @public -!! @ingroup PIO_inq_varndims -!! @brief Gets the number of dimension associated with a netcdf variable -!< + !> + !! @ingroup PIO_inq_varndims + !! Gets the number of dimension associated with a netcdf variable. + !! @author Jim Edwards + !< integer function inq_varndims_id(ncid ,varid,ndims) result(ierr) integer , intent(in) :: ncid integer , intent(in) :: varid @@ -990,19 +997,19 @@ end function PIOc_inq_varndims ierr = PIOc_inq_varndims(ncid ,varid-1,ndims) end function inq_varndims_id -!> -!! @defgroup PIO_inq_vartype PIO_inq_vartype -!< -!> -!! @public -!! @ingroup PIO_inq_vartype -!! @brief Gets metadata information for netcdf file. -!! @details -!! @param File @copydoc file_desc_t -!! @param vardesc @copydoc var_desc_t -!! @param type : The type of variable -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inq_vartype PIO_inq_vartype + !< + !> + !! @ingroup PIO_inq_vartype + !! Gets metadata information for netcdf file. + !! @details + !! @param File @copydoc file_desc_t + !! @param vardesc @copydoc var_desc_t + !! @param type : The type of variable + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inq_vartype_desc(File ,vardesc,type) result(ierr) type (File_desc_t) , intent(in) :: File @@ -1011,11 +1018,11 @@ integer function inq_vartype_desc(File ,vardesc,type) result( ierr = pio_inq_vartype(File%fh , vardesc%varid, type) end function inq_vartype_desc -!> -!! @public -!! @ingroup PIO_inq_vartype -!! @brief Gets metadata information for netcdf file. -!< + !> + !! @ingroup PIO_inq_vartype + !! Gets metadata information for netcdf file. + !! @author Jim Edwards + !< integer function inq_vartype_vid(File ,varid,type) result(ierr) type (File_desc_t) , intent(in) :: File @@ -1024,11 +1031,11 @@ integer function inq_vartype_vid(File ,varid,type) result(ie ierr = pio_inq_vartype(File%fh , varid, type) end function inq_vartype_vid -!> -!! @public -!! @ingroup PIO_inq_vartype -!! @brief Gets metadata information for netcdf file. -!< + !> + !! @ingroup PIO_inq_vartype + !! Gets metadata information for netcdf file. + !! @author Jim Edwards + !< integer function inq_vartype_id(ncid ,varid,type) result(ierr) integer , intent(in) :: ncid integer , intent(in) :: varid @@ -1047,19 +1054,19 @@ end function PIOc_inq_vartype ierr = PIOc_inq_vartype(ncid ,varid-1,type) end function inq_vartype_id -!> -!! @defgroup PIO_inq_varnatts PIO_inq_varnatts -!< -!> -!! @public -!! @ingroup PIO_inq_varnatts -!! @brief Gets metadata information for netcdf file. -!! @details -!! @param File @copydoc file_desc_t -!! @param vardesc @copydoc var_desc_t -!! @param natts : The number of atts -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inq_varnatts PIO_inq_varnatts + !< + !> + !! @ingroup PIO_inq_varnatts + !! Gets metadata information for netcdf file. + !! @details + !! @param File @copydoc file_desc_t + !! @param vardesc @copydoc var_desc_t + !! @param natts : The number of atts + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inq_varnatts_desc(File ,vardesc,natts) result(ierr) type (File_desc_t) , intent(in) :: File @@ -1068,11 +1075,11 @@ integer function inq_varnatts_desc(File ,vardesc,natts) result ierr = pio_inq_varnatts(File%fh , vardesc%varid,natts) end function inq_varnatts_desc -!> -!! @public -!! @ingroup PIO_inq_varnatts -!! @brief Gets metadata information for netcdf file. -!< + !> + !! @ingroup PIO_inq_varnatts + !! Gets metadata information for netcdf file. + !! @author Jim Edwards + !< integer function inq_varnatts_vid(File ,varid,natts) result(ierr) type (File_desc_t) , intent(in) :: File @@ -1081,11 +1088,11 @@ integer function inq_varnatts_vid(File ,varid,natts) result(i ierr = pio_inq_varnatts(File%fh , varid, natts) end function inq_varnatts_vid -!> -!! @public -!! @ingroup PIO_inq_varnatts -!! @brief Gets metadata information for netcdf file. -!< + !> + !! @ingroup PIO_inq_varnatts + !! Gets metadata information for netcdf file. + !! @author Jim Edwards + !< integer function inq_varnatts_id(ncid ,varid,natts) result(ierr) integer , intent(in) :: ncid integer , intent(in) :: varid @@ -1104,21 +1111,21 @@ end function PIOc_inq_varnatts ierr = PIOc_inq_varnatts(ncid ,varid-1,natts) end function inq_varnatts_id -!> -!! @defgroup PIO_inq_var_deflate PIO_inq_var_deflate -!< -!> -!! @public -!! @ingroup PIO_inq_var_deflate -!! @brief Gets metadata information for netcdf file. -!! @details -!! @param File @copydoc file_desc_t -!! @param vardesc @copydoc var_desc_t -!! @param shuffle : Value of shuffle -!! @param deflate : Status of deflate -!! @param deflate_level : Level of deflate -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inq_var_deflate PIO_inq_var_deflate + !< + !> + !! @ingroup PIO_inq_var_deflate + !! Gets metadata information for netcdf file. + !! @details + !! @param File @copydoc file_desc_t + !! @param vardesc @copydoc var_desc_t + !! @param shuffle : Value of shuffle + !! @param deflate : Status of deflate + !! @param deflate_level : Level of deflate + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inq_var_deflate_desc(File, vardesc, shuffle, deflate, & deflate_level) result(ierr) @@ -1131,11 +1138,11 @@ integer function inq_var_deflate_desc(File, vardesc, shuffle, deflate, & ierr = pio_inq_var_deflate(File%fh, vardesc%varid, shuffle, deflate, deflate_level) end function inq_var_deflate_desc -!> -!! @public -!! @ingroup PIO_inq_var_deflate -!! @brief Gets metadata information for netcdf file. -!< + !> + !! @ingroup PIO_inq_var_deflate + !! Gets metadata information for netcdf file. + !! @author Jim Edwards + !< integer function inq_var_deflate_vid(File, varid, shuffle, deflate, deflate_level) result(ierr) type (File_desc_t), intent(in) :: File @@ -1147,11 +1154,11 @@ integer function inq_var_deflate_vid(File, varid, shuffle, deflate, deflate_leve ierr = pio_inq_var_deflate(File%fh, varid, shuffle, deflate, deflate_level) end function inq_var_deflate_vid -!> -!! @public -!! @ingroup PIO_inq_var_deflate -!! @brief Gets metadata information for netcdf file. -!< + !> + !! @ingroup PIO_inq_var_deflate + !! Gets metadata information for netcdf file. + !! @author Jim Edwards + !< integer function inq_var_deflate_id(ncid, varid, shuffle, deflate, & deflate_level) result(ierr) integer, intent(in) :: ncid @@ -1175,19 +1182,19 @@ end function PIOc_inq_var_deflate ierr = PIOc_inq_var_deflate(ncid, varid-1, shuffle, deflate, deflate_level) end function inq_var_deflate_id -!> -!! @defgroup PIO_inq_varname -!< -!> -!! @public -!! @ingroup PIO_inq_varname -!! @brief Get the name associated with a variable -!! @details -!! @param File @copydoc file_desc_t -!! @param vardesc @copydoc var_desc_t -!! @param name : The name of the netcdf variable. -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inq_varname + !< + !> + !! @ingroup PIO_inq_varname + !! Get the name associated with a variable. + !! @details + !! @param File @copydoc file_desc_t + !! @param vardesc @copydoc var_desc_t + !! @param name : The name of the netcdf variable. + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inq_varname_desc(File ,vardesc,name) result(ierr) type (File_desc_t) , intent(in) :: File @@ -1197,11 +1204,11 @@ integer function inq_varname_desc(File ,vardesc,name) result( ierr = pio_inq_varname(file%fh ,vardesc%varid,name) end function inq_varname_desc -!> -!! @public -!! @ingroup PIO_inq_varname -!! @brief Get the name associated with a variable -!< + !> + !! @ingroup PIO_inq_varname + !! Get the name associated with a variable. + !! @author Jim Edwards + !< integer function inq_varname_vid(File ,varid,name) result(ierr) type (File_desc_t) , intent(in) :: File @@ -1211,11 +1218,11 @@ integer function inq_varname_vid(File ,varid,name) result(ie ierr = pio_inq_varname(file%fh ,varid,name) end function inq_varname_vid -!> -!! @public -!! @ingroup PIO_inq_varname -!! @brief Get the name associated with a variable -!< + !> + !! @ingroup PIO_inq_varname + !! Get the name associated with a variable. + !! @author Jim Edwards + !< integer function inq_varname_id(ncid ,varid,name) result(ierr) integer ,intent(in) :: ncid integer , intent(in) :: varid @@ -1236,19 +1243,19 @@ end function PIOc_inq_varname end function inq_varname_id -!> -!! @defgroup PIO_inq_varid -!< -!> -!! @public -!! @ingroup PIO_inq_varid -!! @brief Returns the ID of a netcdf variable given its name -!! @details -!! @param File @copydoc file_desc_t -!! @param name : Name of the returned attribute -!! @param vardesc @copydoc var_desc_t -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inq_varid + !< + !> + !! @ingroup PIO_inq_varid + !! Returns the ID of a netcdf variable given its name. + !! @details + !! @param File @copydoc file_desc_t + !! @param name : Name of the returned attribute + !! @param vardesc @copydoc var_desc_t + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inq_varid_desc(File,name,vardesc) result(ierr) type (File_desc_t), intent(in) :: File @@ -1257,11 +1264,11 @@ integer function inq_varid_desc(File,name,vardesc) result(ierr) ierr = pio_inq_varid(File%fh, name, vardesc%varid) end function inq_varid_desc -!> -!! @public -!! @ingroup PIO_inq_varid -!! @brief Returns the ID of a netcdf variable given its name -!< + !> + !! @ingroup PIO_inq_varid + !! Returns the ID of a netcdf variable given its name. + !! @author Jim Edwards + !< integer function inq_varid_vid(File,name,varid) result(ierr) type (File_desc_t), intent(in) :: File @@ -1270,11 +1277,11 @@ integer function inq_varid_vid(File,name,varid) result(ierr) ierr = pio_inq_varid(File%fh, name, varid) end function inq_varid_vid -!> -!! @public -!! @ingroup PIO_inq_varid -!! @brief Returns the ID of a netcdf variable given its name -!< + !> + !! @ingroup PIO_inq_varid + !! Returns the ID of a netcdf variable given its name. + !! @author Jim Edwards + !< integer function inq_varid_id(ncid,name,varid) result(ierr) integer, intent(in) :: ncid @@ -1296,20 +1303,20 @@ end function PIOc_inq_varid varid = varid+1 end function inq_varid_id -!> -!! @defgroup PIO_inq_attlen -!< -!> -!! @public -!! @ingroup PIO_inq_attlen -!! @brief Gets the attribute length -!! @details -!! @param File @copydoc file_desc_t -!! @param vardesc @copydoc var_desc_t -!! @param name : name of attribute -!! @param len : Length of attribute -!! @retval ierr @copydoc error_return -!> + !> + !! @defgroup PIO_inq_attlen + !< + !> + !! @ingroup PIO_inq_attlen + !! Gets the attribute length. + !! @details + !! @param File @copydoc file_desc_t + !! @param vardesc @copydoc var_desc_t + !! @param name : name of attribute + !! @param len : Length of attribute + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !> integer function inq_attlen_desc(File,vardesc,name,len) result(ierr) type (File_desc_t), intent(inout) :: File @@ -1320,11 +1327,11 @@ integer function inq_attlen_desc(File,vardesc,name,len) result(ierr) ierr = pio_inq_attlen(file%fh, vardesc%varid, name, len) end function inq_attlen_desc -!> -!! @public -!! @ingroup PIO_inq_attlen -!! @brief Gets the attribute length -!< + !> + !! @ingroup PIO_inq_attlen + !! Gets the attribute length. + !! @author Jim Edwards + !< integer function inq_attlen_vid(File,varid,name,len) result(ierr) type (File_desc_t), intent(inout) :: File @@ -1335,11 +1342,10 @@ integer function inq_attlen_vid(File,varid,name,len) result(ierr) ierr = pio_inq_attlen(file%fh, varid, name, len) end function inq_attlen_vid -!> -!! @public -!! @ingroup PIO_inq_attlen -!! @brief Gets the attribute length -!< + !> + !! @ingroup PIO_inq_attlen + !! Gets the attribute length. + !< integer function inq_attlen_id(ncid,varid,name,len) result(ierr) integer, intent(in) :: ncid integer, intent(in) :: varid @@ -1360,21 +1366,21 @@ end function PIOc_inq_attlen end function inq_attlen_id -!> -!! @defgroup PIO_inq_att PIO_inq_att -!< -!> -!! @public -!! @ingroup PIO_inq_att -!! @brief Gets information about attributes -!! @details -!! @param File @copydoc file_desc_t -!! @param vardesc @copydoc var_desc_t -!! @param name : Name of the attribute -!! @param xtype : The type of attribute -!! @param len : The length of the attribute -!! @retval ierr @copydoc error_return -!< + !> + !! @defgroup PIO_inq_att PIO_inq_att + !< + !> + !! @ingroup PIO_inq_att + !! Gets information about attributes. + !! @details + !! @param File @copydoc file_desc_t + !! @param vardesc @copydoc var_desc_t + !! @param name : Name of the attribute + !! @param xtype : The type of attribute + !! @param len : The length of the attribute + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function inq_att_desc(File,vardesc,name,xtype,len) result(ierr) type (File_desc_t), intent(inout) :: File @@ -1386,11 +1392,11 @@ integer function inq_att_desc(File,vardesc,name,xtype,len) result(ierr) ierr = pio_inq_att(file%fh, vardesc%varid, name, xtype, len) end function inq_att_desc -!> -!! @public -!! @ingroup PIO_inq_att -!! @brief Gets information about attributes -!< + !> + !! @ingroup PIO_inq_att + !! Gets information about attributes. + !! @author Jim Edwards + !< integer function inq_att_vid(File,varid,name,xtype,len) result(ierr) type (File_desc_t), intent(in) :: File @@ -1402,11 +1408,11 @@ integer function inq_att_vid(File,varid,name,xtype,len) result(ierr) ierr = pio_inq_att(file%fh, varid, name, xtype, len) end function inq_att_vid -!> -!! @public -!! @ingroup PIO_inq_att -!! @brief Gets information about attributes -!< + !> + !! @ingroup PIO_inq_att + !! Gets information about attributes. + !! @author Jim Edwards + !< integer function inq_att_id(ncid,varid,name,xtype,len) result(ierr) integer, intent(in) :: ncid @@ -1435,14 +1441,14 @@ end function PIOc_inq_att if(present(xtype)) xtype = ixtype end function inq_att_id -!> -!! @defgroup PIO_inq_attname -!< -!> -!! @public -!! @ingroup PIO_inq_attname -!! @brief Gets the name of an attribute -!< + !> + !! @defgroup PIO_inq_attname + !< + !> + !! @ingroup PIO_inq_attname + !! Gets the name of an attribute. + !! @author Jim Edwards + !< integer function inq_attname_desc(File,vdesc,attnum,name) result(ierr) type (File_desc_t), intent(inout) :: File type (var_desc_t), intent(in) :: vdesc @@ -1452,11 +1458,11 @@ integer function inq_attname_desc(File,vdesc,attnum,name) result(ierr) ierr = inq_attname_id(file%fh,vdesc%varid,attnum,name) end function inq_attname_desc -!> -!! @public -!! @ingroup PIO_inq_attname -!! @brief Gets the name of an attribute -!< + !> + !! @ingroup PIO_inq_attname + !! Gets the name of an attribute. + !! @author Jim Edwards + !< integer function inq_attname_vid(File,varid,attnum,name) result(ierr) type (File_desc_t), intent(inout) :: File integer, intent(in) :: varid @@ -1466,11 +1472,11 @@ integer function inq_attname_vid(File,varid,attnum,name) result(ierr) ierr = inq_attname_id(file%fh,varid,attnum,name) end function inq_attname_vid -!> -!! @public -!! @ingroup PIO_inq_attname -!! @brief Gets the name of an attribute -!< + !> + !! @ingroup PIO_inq_attname + !! Gets the name of an attribute. + !! @author Jim Edwards + !< integer function inq_attname_id(ncid,varid,attnum,name) result(ierr) integer, intent(in) :: ncid integer, intent(in) :: varid @@ -1494,21 +1500,21 @@ end function PIOc_inq_attname end function inq_attname_id -!> -!! @defgroup PIO_def_var PIO_def_var -!< + !> + !! @defgroup PIO_def_var PIO_def_var + !< -!> -!! @public -!! @ingroup PIO_def_var -!! @brief Defines a netcdf variable -!! @details -!! @param File @copydoc file_desc_t -!! @param name : The name of the variable to define -!! @param type : The type of variable -!! @param vardesc @copydoc var_desc_t -!! @retval ierr @copydoc error_return -!< + !> + !! @ingroup PIO_def_var + !! Defines a netcdf variable. + !! @details + !! @param File @copydoc file_desc_t + !! @param name : The name of the variable to define + !! @param type : The type of variable + !! @param vardesc @copydoc var_desc_t + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function def_var_0d_desc(File,name,type,vardesc) result(ierr) type (File_desc_t), intent(in) :: File @@ -1520,11 +1526,11 @@ integer function def_var_0d_desc(File,name,type,vardesc) result(ierr) ierr = def_var_md_id(File%fh,name,type,dimids,vardesc%varid) end function def_var_0d_desc -!> -!! @public -!! @ingroup PIO_def_var -!! @brief Defines a netcdf variable -!< + !> + !! @ingroup PIO_def_var + !! Defines a netcdf variable. + !! @author Jim Edwards + !< integer function def_var_0d_id(ncid,name,type,varid) result(ierr) integer,intent(in) :: ncid @@ -1537,18 +1543,18 @@ integer function def_var_0d_id(ncid,name,type,varid) result(ierr) end function def_var_0d_id -!> -!! @public -!! @ingroup PIO_def_var -!! @brief Defines the a netcdf variable -!! @details -!! @param File @copydoc file_desc_t -!! @param name : The name of the variable to define -!! @param type : The type of variable -!! @param dimids : The dimension identifier returned by \ref PIO_def_dim -!! @param vardesc @copydoc var_desc_t -!! @retval ierr @copydoc error_return -!< + !> + !! @ingroup PIO_def_var + !! Defines the a netcdf variable. + !! @details + !! @param File @copydoc file_desc_t + !! @param name : The name of the variable to define + !! @param type : The type of variable + !! @param dimids : The dimension identifier returned by \ref PIO_def_dim + !! @param vardesc @copydoc var_desc_t + !! @retval ierr @copydoc error_return + !! @author Jim Edwards + !< integer function def_var_md_desc(File,name,type,dimids,vardesc) result(ierr) type (File_desc_t), intent(in) :: File character(len=*), intent(in) :: name @@ -1558,11 +1564,11 @@ integer function def_var_md_desc(File,name,type,dimids,vardesc) result(ierr) ierr = def_var_md_id(file%fh,name,type,dimids,vardesc%varid) end function def_var_md_desc -!> -!! @public -!! @ingroup PIO_def_var -!! @brief Defines a netcdf variable -!< + !> + !! @ingroup PIO_def_var + !! Defines a netcdf variable. + !! @author Jim Edwards + !< integer function def_var_md_id(ncid,name,type,dimids,varid) result(ierr) integer,intent(in) :: ncid character(len=*), intent(in) :: name @@ -1592,11 +1598,11 @@ end function PIOc_def_var varid = varid+1 end function def_var_md_id -!> -!! @public -!! @ingroup PIO_def_var_deflate -!! @brief Changes compression settings for a netCDF-4/HDF5 variable. -!< + !> + !! @ingroup PIO_def_var_deflate + !! Changes compression settings for a netCDF-4/HDF5 variable. + !! @author Ed Hartnett + !< integer function def_var_deflate_id(file, varid, shuffle, deflate, deflate_level) & result(ierr) type (File_desc_t), intent(in) :: file @@ -1620,11 +1626,11 @@ end function PIOc_def_var_deflate ierr = PIOc_def_var_deflate(file%fh, varid-1, shuffle, deflate, deflate_level) end function def_var_deflate_id -!> -!! @public -!! @ingroup PIO_def_var_deflate -!! @brief Changes compression settings for a netCDF-4/HDF5 variable. -!< + !> + !! @ingroup PIO_def_var_deflate + !! Changes compression settings for a netCDF-4/HDF5 variable. + !! @author Ed Hartnett + !< integer function def_var_deflate_desc(file, vardesc, shuffle, deflate, deflate_level) & result(ierr) type (File_desc_t), intent(in) :: file @@ -1636,11 +1642,11 @@ integer function def_var_deflate_desc(file, vardesc, shuffle, deflate, deflate_l ierr = def_var_deflate_id(file, vardesc%varid, shuffle, deflate, deflate_level) end function def_var_deflate_desc -!> -!! @public -!! @ingroup PIO_def_var_chunking -!! @brief Changes chunking settings for a netCDF-4/HDF5 variable. -!< + !> + !! @ingroup PIO_def_var_chunking + !! Changes chunking settings for a netCDF-4/HDF5 variable. + !! @author Ed Hartnett + !< integer function def_var_chunking(file, vardesc, storage, chunksizes) result(ierr) type (File_desc_t), intent(in) :: file type (var_desc_t), intent(in) :: vardesc @@ -1667,11 +1673,11 @@ end function PIOc_def_var_chunking ierr = PIOc_def_var_chunking(file%fh, vardesc%varid-1, storage, cchunksizes) end function def_var_chunking -!> -!! @public -!! @ingroup PIO_set_chunk_cache -!! @brief Changes chunk cache settings for netCDF-4/HDF5 files created after this call. -!< + !> + !! @ingroup PIO_set_chunk_cache + !! Changes chunk cache settings for netCDF-4/HDF5 files created after this call. + !! @author Ed Hartnett + !< integer function set_chunk_cache(iosysid, iotype, chunk_cache_size, chunk_cache_nelems, & chunk_cache_preemption) result(ierr) integer, intent(in) :: iosysid @@ -1697,11 +1703,11 @@ end function PIOc_set_chunk_cache chunk_cache_preemption) end function set_chunk_cache -!> -!! @public -!! @ingroup PIO_get_chunk_cache -!! @brief Gets current settings for chunk cache (only relevant for netCDF4/HDF5 files.) -!< + !> + !! @ingroup PIO_get_chunk_cache + !! Gets current settings for chunk cache (only relevant for netCDF4/HDF5 files). + !! @author Ed Hartnett + !< integer function get_chunk_cache(iosysid, iotype, chunk_cache_size, chunk_cache_nelems, & chunk_cache_preemption) result(ierr) integer, intent(in) :: iosysid @@ -1727,11 +1733,11 @@ end function PIOc_get_chunk_cache chunk_cache_preemption) end function get_chunk_cache -!> -!! @public -!! @ingroup PIO_set_var_chunk_cache -!! @brief Changes chunk cache settings for a variable in a netCDF-4/HDF5 file. -!< + !> + !! @ingroup PIO_set_var_chunk_cache + !! Changes chunk cache settings for a variable in a netCDF-4/HDF5 file. + !! @author Ed Hartnett + !< integer function set_var_chunk_cache_id(file, varid, chunk_cache_size, & chunk_cache_nelems, chunk_cache_preemption) result(ierr) type (File_desc_t), intent(in) :: file @@ -1758,10 +1764,10 @@ end function PIOc_set_var_chunk_cache end function set_var_chunk_cache_id !> -!! @public -!! @ingroup PIO_set_var_chunk_cache -!! @brief Changes chunk cacne for a variable. -!< + !! @ingroup PIO_set_var_chunk_cache + !! Changes chunk cacne for a variable. + !! @author Ed Hartnett + !< integer function set_var_chunk_cache_desc(file, vardesc, chunk_cache_size, & chunk_cache_nelems, chunk_cache_preemption) result(ierr) type (File_desc_t), intent(in) :: file @@ -1774,11 +1780,11 @@ integer function set_var_chunk_cache_desc(file, vardesc, chunk_cache_size, & chunk_cache_nelems, chunk_cache_preemption) end function set_var_chunk_cache_desc -!> -!! @public -!! @ingroup PIO_get_var_chunk_cache -!! @brief Get the chunk cache settings for a variable. -!< + !> + !! @ingroup PIO_get_var_chunk_cache + !! Get the chunk cache settings for a variable. + !! @author Ed Hartnett + !< integer function get_var_chunk_cache_desc(file, vardesc, chunk_cache_size, & chunk_cache_nelems, chunk_cache_preemption) result(ierr) type (File_desc_t), intent(in) :: file @@ -1791,11 +1797,11 @@ integer function get_var_chunk_cache_desc(file, vardesc, chunk_cache_size, & chunk_cache_nelems, chunk_cache_preemption) end function get_var_chunk_cache_desc -!> -!! @public -!! @ingroup PIO_get_var_chunk_cache -!! @brief Get the chunk cache settings for a variable. -!< + !> + !! @ingroup PIO_get_var_chunk_cache + !! Get the chunk cache settings for a variable. + !! @author Ed Hartnett + !< integer function get_var_chunk_cache_id(file, varid, chunk_cache_size, & chunk_cache_nelems, chunk_cache_preemption) result(ierr) type (File_desc_t), intent(in) :: file diff --git a/src/flib/pio_support.F90 b/src/flib/pio_support.F90 index 841ca241c0c..bb038148895 100644 --- a/src/flib/pio_support.F90 +++ b/src/flib/pio_support.F90 @@ -52,6 +52,7 @@ end subroutine replace_c_null !! @param line Line number where it is called. !! @param msg,msg2,msg3,ival1,ival2,ival3,mpirank : Optional !! argument for error messages. + !! @author Jim Edwards !< subroutine piodie (file,line, msg, ival1, msg2, ival2, msg3, ival3, mpirank) implicit none @@ -109,6 +110,7 @@ end subroutine piodie !! @param errcode MPI error code !! @param file The file where the error message originated. !! @param line The line number where the error message originated. + !! @author Jim Edwards !< subroutine CheckMPIreturn(locmesg, errcode, file, line)