netcdfcommonmodule Module Reference

This module contains the NetCDFCommonModule. More...

Functions/Subroutines
integer(i4b) function, public	nc_fopen (nc_fname, iout)
	Open netcdf file. More...
subroutine, public	nc_fclose (ncid, nc_fname)
	Close netcdf file. More...
subroutine, public	nf_verify (res, nc_fname)
	error check a netcdf-fortran interface call More...
integer(i4b) function, public	ixstp ()
	step index for timeseries data More...

Variables
integer(i4b), parameter, public	netcdf_max_dim = 6
integer(i4b), parameter, public	netcdf_attr_strlen = 80

Detailed Description

Common NetCDF interfaces and constants

Function/Subroutine Documentation

ixstp()

integer(i4b) function, public netcdfcommonmodule::ixstp

Definition at line 113 of file NetCDFCommon.f90.

    use tdismodule, only: kstp, kper, nstp
    integer(I4B) :: n, ixstp
    ixstp = kstp
    if (kper > 1) then
      do n = 1, kper - 1
        ixstp = ixstp + nstp(n)
      end do
    end if

Here is the caller graph for this function:

nc_fclose()

subroutine, public netcdfcommonmodule::nc_fclose	(	integer(i4b), intent(in)	ncid,
		character(len=*), intent(in)	nc_fname
	)

Definition at line 41 of file NetCDFCommon.f90.

    integer(I4B), intent(in) :: ncid
    character(len=*), intent(in) :: nc_fname
    ! close netcdf file
    call nf_verify(nf90_close(ncid), nc_fname)

Here is the call graph for this function:

Here is the caller graph for this function:

nc_fopen()

integer(i4b) function, public netcdfcommonmodule::nc_fopen	(	character(len=*), intent(in)	nc_fname,
		integer(i4b), intent(in)	iout
	)

Definition at line 29 of file NetCDFCommon.f90.

    character(len=*), intent(in) :: nc_fname
    integer(I4B), intent(in) :: iout
    integer(I4B) :: ncid
    ! initialize
    ncid = -1
    ! open netcdf file
    call nf_verify(nf90_open(nc_fname, nf90_nowrite, ncid), nc_fname)

Here is the call graph for this function:

Here is the caller graph for this function:

nf_verify()

subroutine, public netcdfcommonmodule::nf_verify	(	integer(i4b), intent(in)	res,
		character(len=*), intent(in)	nc_fname
	)

Definition at line 50 of file NetCDFCommon.f90.

    integer(I4B), intent(in) :: res
    character(len=*), intent(in) :: nc_fname
    character(len=LINELENGTH) :: errstr
 
    ! strings are set for a subset of errors
    ! but the exit status will always be reported
    if (res /= nf90_noerr) then
      !
      select case (res)
      case (-33) ! (NC_EBADID)
        errstr = 'Not a netcdf id'
      case (nf90_einval) ! (-36)
        errstr = 'Invalid Argument'
      case (nf90_eperm) ! (-37)
        errstr = 'Write to read only'
      case (-38) ! (NC_ENOTINDEFINE)
        errstr = 'Operation not allowed in data mode'
      case (-39) ! (NC_EINDEFINE)
        errstr = 'Operation not allowed in define mode'
      case (nf90_einvalcoords) ! (-40)
        errstr = 'Index exceeds dimension bound'
      case (nf90_enameinuse) ! (-42)
        errstr = 'String match to name in use'
      case (nf90_enotatt) ! (-43)
        errstr = 'Attribute not found'
      case (-45) ! (NC_EBADTYPE)
        errstr = 'Not a netcdf data type'
      case (nf90_ebaddim) ! (-46)
        errstr = 'Invalid dimension id or name'
      case (nf90_enotvar) ! (-49)
        errstr = 'Variable not found'
      case (nf90_enotnc) ! (-51)
        errstr = 'Not a netcdf file'
      case (nf90_echar) ! (-56)
        errstr = 'Attempt to convert between text & numbers'
      case (nf90_eedge) ! (-57)
        errstr = 'Edge+start exceeds dimension bound'
      case (nf90_estride) ! (-58)
        errstr = 'Illegal stride'
      case (nf90_ebadname) ! (-59)
        errstr = 'Attribute or variable name contains illegal characters'
      case (-127) ! (NC_EBADCHUNK)
        errstr = 'Bad chunksize.'
      case default
        errstr = ''
      end select
 
      if (errstr /= '') then
        write (errmsg, '(a,a,a,i0,a)') 'NetCDF library error [error="', &
          trim(errstr), '", exit code=', res, '].'
      else
        write (errmsg, '(a,i0,a)') 'NetCDF library error [exit code=', &
          res, '].'
      end if
 
      call store_error(errmsg)
      call store_error_filename(nc_fname)
    end if

Here is the call graph for this function:

Variable Documentation

netcdf_attr_strlen

integer(i4b), parameter, public netcdfcommonmodule::netcdf_attr_strlen = 80

Definition at line 23 of file NetCDFCommon.f90.

  integer(I4B), parameter :: NETCDF_ATTR_STRLEN = 80

netcdf_max_dim

integer(i4b), parameter, public netcdfcommonmodule::netcdf_max_dim = 6

Definition at line 22 of file NetCDFCommon.f90.

  integer(I4B), parameter :: NETCDF_MAX_DIM = 6