mod_pio_netcdf::pio_netcdf_get_fvar Interface Reference

Public Member Functions
subroutine	pio_netcdf_get_fvar_0dp (ng, model, ncname, myvarname, a, piofile, start, total, broadcast, min_val, max_val)
subroutine	pio_netcdf_get_fvar_1dp (ng, model, ncname, myvarname, a, piofile, start, total, broadcast, min_val, max_val)
subroutine	pio_netcdf_get_fvar_2dp (ng, model, ncname, myvarname, a, piofile, start, total, broadcast, min_val, max_val)
subroutine	pio_netcdf_get_fvar_3dp (ng, model, ncname, myvarname, a, piofile, start, total, broadcast, min_val, max_val)
subroutine	pio_netcdf_get_fvar_0d (ng, model, ncname, myvarname, a, piofile, start, total, broadcast, min_val, max_val)
subroutine	pio_netcdf_get_fvar_1d (ng, model, ncname, myvarname, a, piofile, start, total, broadcast, min_val, max_val)
subroutine	pio_netcdf_get_fvar_2d (ng, model, ncname, myvarname, a, piofile, start, total, broadcast, min_val, max_val)
subroutine	pio_netcdf_get_fvar_3d (ng, model, ncname, myvarname, a, piofile, start, total, broadcast, min_val, max_val)
subroutine	pio_netcdf_get_fvar_4d (ng, model, ncname, myvarname, a, piofile, start, total, broadcast, min_val, max_val)

Detailed Description

Definition at line 52 of file mod_pio_netcdf.F.

Member Function/Subroutine Documentation

pio_netcdf_get_fvar_0d()

subroutine mod_pio_netcdf::pio_netcdf_get_fvar::pio_netcdf_get_fvar_0d	(	integer, intent(in)	ng,
		integer, intent(in)	model,
		character (len=*), intent(in)	ncname,
		character (len=*), intent(in)	myvarname,
		real(r8), intent(out)	a,
		type (file_desc_t), intent(in), optional	piofile,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	total,
		logical, intent(in), optional	broadcast,
		real(r8), intent(out), optional	min_val,
		real(r8), intent(out), optional	max_val )

Definition at line 3813 of file mod_pio_netcdf.F.

!
!=======================================================================
!                                                                      !
!  This routine reads requested floating-point scalar variable from    !
!  specified NetCDF file.                                              !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     ng           Nested grid number (integer)                        !
!     model        Calling model identifier (integer)                  !
!     ncname       NetCDF file name (string)                           !
!     myVarName    Variable name (string)                              !
!     pioFile      PIO file descriptor, TYPE(File_desc_t), OPTIONAL    !
!                    pioFile%fh         file handler                   !
!                    pioFile%iosystem   IO system descriptor (struct)  !
!     start        Starting index where the first of the data values   !
!                    will be read along each dimension (integer,       !
!                    OPTIONAL)                                         !
!     total        Number of data values to be read along each         !
!                    dimension (integer, OPTIONAL)                     !
!     broadcast    Switch to broadcast read values from root to all    !
!                    members of the communicator in distributed-       !
!                    memory applications (logical, OPTIONAL). It is    !
!                    ignored since PIO library broadcasts the values   !
!                    to all member in the group by default.            !
!                                                                      !
!  On Ouput:                                                           !
!                                                                      !
!     A            Read scalar variable (real)                         !
!     min_val      Read data minimum value (real, OPTIONAL)            !
!     max_val      Read data maximum value (real, OPTIONAL)            !
!                                                                      !
!  Examples:                                                           !
!                                                                      !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A)         !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A(1))      !
!                                                                      !
!=======================================================================
!
!  Imported variable declarations.
!
      logical, intent(in), optional :: broadcast
!
      integer, intent(in) :: ng, model
 
      integer, intent(in), optional :: start(:)
      integer, intent(in), optional :: total(:)
!
      character (len=*), intent(in) :: ncname
      character (len=*), intent(in) :: myVarName
!
      real(r8), intent(out), optional :: min_val
      real(r8), intent(out), optional :: max_val
 
      real(r8), intent(out) :: A
!
      TYPE (File_desc_t), intent(in), optional :: pioFile
!
!  Local variable declarations.
!
      integer :: status
!
      real(r8), dimension(1) :: my_A
!
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", pio_netcdf_get_fvar_0d"
!
      TYPE (File_desc_t) :: my_pioFile
      TYPE (Var_desc_t)  :: my_pioVar
!
!-----------------------------------------------------------------------
!  Read in a floating-point scalar variable.
!-----------------------------------------------------------------------
!
!  If file descriptor is not provided, open NetCDF for reading.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_open (ng, model, trim(ncname), 0, my_piofile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      ELSE
        my_piofile=piofile
      END IF
!
!  Read in variable.
!
      status=pio_inq_varid(my_piofile, trim(myvarname), my_piovar)
      IF (status.eq.pio_noerr) THEN
        IF (PRESENT(start).and.PRESENT(total)) THEN
          status=pio_get_var(my_piofile, my_piovar, start, total, my_a)
          a=my_a(1)
        ELSE
          status=pio_get_var(my_piofile, my_piovar, a)
        END IF
        IF (founderror(status, pio_noerr, __line__, myfile)) THEN
          IF (master) WRITE (stdout,10) trim(myvarname), trim(ncname),  &
     &                                  trim(sourcefile)
          exit_flag=2
          ioerror=status
        END IF
      ELSE
        IF (master) WRITE (stdout,20) trim(myvarname), trim(ncname),    &
     &                                trim(sourcefile)
        exit_flag=2
        ioerror=status
      END IF
!
!  Compute minimum and maximum values of read variable. Notice that
!  the same read value is assigned since a scalar variable was
!  processed.
!
      IF (PRESENT(min_val)) THEN
        min_val=a
      END IF
      IF (PRESENT(max_val)) THEN
        max_val=a
      END IF
!
!  If file descriptor is not provided, close input NetCDF file.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_close (ng, model, my_piofile, ncname, .false.)
      END IF
!
  10  FORMAT (/,' PIO_NETCDF_GET_FVAR_0D - error while reading ',       &
     &        'variable:',2x,a,/,26x,'in input file:',2x,a,             &
     &        /,26x,'call from:',2x,a)
  20  FORMAT (/,' PIO_NETCDF_GET_FVAR_0D - error while inquiring ',     &
     &        'descriptor for variable:',2x,a,/,26x,'in input file:',   &
     &        2x,a,/,26x,'call from:',2x,a)
!
      RETURN

References mod_scalars::exit_flag, strings_mod::founderror(), mod_iounits::ioerror, mod_parallel::master, mod_scalars::noerror, mod_pio_netcdf::pio_netcdf_close(), mod_pio_netcdf::pio_netcdf_open(), mod_iounits::sourcefile, and mod_iounits::stdout.

Here is the call graph for this function:

pio_netcdf_get_fvar_0dp()

subroutine mod_pio_netcdf::pio_netcdf_get_fvar::pio_netcdf_get_fvar_0dp	(	integer, intent(in)	ng,
		integer, intent(in)	model,
		character (len=*), intent(in)	ncname,
		character (len=*), intent(in)	myvarname,
		real(dp), intent(out)	a,
		type (file_desc_t), intent(in), optional	piofile,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	total,
		logical, intent(in), optional	broadcast,
		real(dp), intent(out), optional	min_val,
		real(dp), intent(out), optional	max_val )

Definition at line 3017 of file mod_pio_netcdf.F.

!
!=======================================================================
!                                                                      !
!  This routine reads requested double-precision scalar variable from  !
!  specified NetCDF file.                                              !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     ng           Nested grid number (integer)                        !
!     model        Calling model identifier (integer)                  !
!     ncname       NetCDF file name (string)                           !
!     myVarName    Variable name (string)                              !
!     pioFile      PIO file descriptor, TYPE(File_desc_t), OPTIONAL    !
!                    pioFile%fh         file handler                   !
!                    pioFile%iosystem   IO system descriptor (struct)  !
!     start        Starting index where the first of the data values   !
!                    will be read along each dimension (integer,       !
!                    OPTIONAL)                                         !
!     total        Number of data values to be read along each         !
!                    dimension (integer, OPTIONAL)                     !
!     broadcast    Switch to broadcast read values from root to all    !
!                    members of the communicator in distributed-       !
!                    memory applications (logical, OPTIONAL). It is    !
!                    ignored since PIO library broadcasts the values   !
!                    to all member in the group by default.            !
!                                                                      !
!  On Ouput:                                                           !
!                                                                      !
!     A            Read scalar variable (double precision)             !
!     min_val      Read data minimum value (double precision, OPTIONAL)!
!     max_val      Read data maximum value (double precision, OPTIONAL)!
!                                                                      !
!  Examples:                                                           !
!                                                                      !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A)         !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A(1))      !
!                                                                      !
!=======================================================================
!
!  Imported variable declarations.
!
      logical, intent(in), optional :: broadcast
!
      integer, intent(in) :: ng, model
 
      integer, intent(in), optional :: start(:)
      integer, intent(in), optional :: total(:)
!
      character (len=*), intent(in) :: ncname
      character (len=*), intent(in) :: myVarName
!
      real(dp), intent(out), optional :: min_val
      real(dp), intent(out), optional :: max_val
 
      real(dp), intent(out) :: A
!
      TYPE (File_desc_t), intent(in), optional :: pioFile
!
!  Local variable declarations.
!
      integer :: status
!
      real(dp), dimension(1) :: my_A
!
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", pio_netcdf_get_fvar_0dp"
!
      TYPE (File_desc_t) :: my_pioFile
      TYPE (Var_desc_t)  :: my_pioVar
!
!-----------------------------------------------------------------------
!  Read in a double-precision scalar variable.
!-----------------------------------------------------------------------
!
!  If file descriptor is not provided, open NetCDF for reading.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_open (ng, model, trim(ncname), 0, my_piofile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      ELSE
        my_piofile=piofile
      END IF
!
!  Read in variable.
!
      status=pio_inq_varid(my_piofile, trim(myvarname), my_piovar)
      IF (status.eq.pio_noerr) THEN
        IF (PRESENT(start).and.PRESENT(total)) THEN
          status=pio_get_var(my_piofile, my_piovar, start, total, my_a)
          a=my_a(1)
        ELSE
          status=pio_get_var(my_piofile, my_piovar, a)
        END IF
        IF (founderror(status, pio_noerr, __line__, myfile)) THEN
          IF (master) WRITE (stdout,10) trim(myvarname), trim(ncname),  &
     &                                  trim(sourcefile)
          exit_flag=2
          ioerror=status
        END IF
      ELSE
        IF (master) WRITE (stdout,20) trim(myvarname), trim(ncname),    &
     &                                trim(sourcefile)
        exit_flag=2
        ioerror=status
      END IF
!
!  Compute minimum and maximum values of read variable. Notice that
!  the same read value is assigned since a scalar variable was
!  processed.
!
      IF (PRESENT(min_val)) THEN
        min_val=a
      END IF
      IF (PRESENT(max_val)) THEN
        max_val=a
      END IF
!
!  If file descriptor is not provided, close input NetCDF file.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_close (ng, model, my_piofile, ncname, .false.)
      END IF
!
  10  FORMAT (/,' PIO_NETCDF_GET_FVAR_0DP - error while reading ',      &
     &        'variable:',2x,a,/,27x,'in input file:',2x,a,             &
     &        /,27x,'call from:',2x,a)
  20  FORMAT (/,' PIO_NETCDF_GET_FVAR_0DP - error while inquiring ',    &
     &        'descriptor for variable:',2x,a,/,27x,'in input file:',   &
     &        2x,a,/,27x,'call from:',2x,a)
!
      RETURN

References mod_scalars::exit_flag, strings_mod::founderror(), mod_iounits::ioerror, mod_parallel::master, mod_scalars::noerror, mod_pio_netcdf::pio_netcdf_close(), mod_pio_netcdf::pio_netcdf_open(), mod_iounits::sourcefile, and mod_iounits::stdout.

Here is the call graph for this function:

pio_netcdf_get_fvar_1d()

subroutine mod_pio_netcdf::pio_netcdf_get_fvar::pio_netcdf_get_fvar_1d	(	integer, intent(in)	ng,
		integer, intent(in)	model,
		character (len=*), intent(in)	ncname,
		character (len=*), intent(in)	myvarname,
		real(r8), dimension(:), intent(out)	a,
		type (file_desc_t), intent(in), optional	piofile,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	total,
		logical, intent(in), optional	broadcast,
		real(r8), intent(out), optional	min_val,
		real(r8), intent(out), optional	max_val )

Definition at line 3949 of file mod_pio_netcdf.F.

!
!=======================================================================
!                                                                      !
!  This routine reads requested floating-point 1D-array variable from  !
!  specified NetCDF file.                                              !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     ng           Nested grid number (integer)                        !
!     model        Calling model identifier (integer)                  !
!     ncname       NetCDF file name (string)                           !
!     myVarName    Variable name (string)                              !
!     pioFile      PIO file descriptor, TYPE(File_desc_t), OPTIONAL    !
!                    pioFile%fh         file handler                   !
!                    pioFile%iosystem   IO system descriptor (struct)  !
!     start        Starting index where the first of the data values   !
!                    will be read along each dimension (integer,       !
!                    OPTIONAL)                                         !
!     total        Number of data values to be read along each         !
!                    dimension (integer, OPTIONAL)                     !
!                                                                      !
!     broadcast    Switch to broadcast read values from root to all    !
!                    members of the communicator in distributed-       !
!                    memory applications (logical, OPTIONAL). It is    !
!                    ignored since PIO library broadcasts the values   !
!                    to all member in the group by default.            !
!                                                                      !
!  On Ouput:                                                           !
!                                                                      !
!     A            Read 1D-array variable (real)                       !
!     min_val      Read data minimum value (real, OPTIONAL)            !
!     max_val      Read data maximum value (real, OPTIONAL)            !
!                                                                      !
!  Examples:                                                           !
!                                                                      !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A)         !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A(0:))     !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A(:,1))    !
!                                                                      !
!=======================================================================
!
!  Imported variable declarations.
!
      logical, intent(in), optional :: broadcast
!
      integer, intent(in) :: ng, model
 
      integer, intent(in), optional :: start(:)
      integer, intent(in), optional :: total(:)
!
      character (len=*), intent(in) :: ncname
      character (len=*), intent(in) :: myVarName
!
      real(r8), intent(out), optional :: min_val
      real(r8), intent(out), optional :: max_val
 
      real(r8), intent(out) :: A(:)
!
      TYPE (File_desc_t), intent(in), optional :: pioFile
!
!  Local variable declarations.
!
      logical, dimension(3) :: foundit
!
      integer :: i, status
 
      integer, dimension(1) :: Asize
!
      real(r8) :: Afactor, Aoffset, Aspval
 
      real(r8), parameter :: Aepsilon = 1.0e-8_r8
 
      real(r8), dimension(3) :: AttValue
!
      character (len=12), dimension(3) :: AttName
 
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", pio_netcdf_get_fvar_1d"
!
      TYPE (File_desc_t) :: my_pioFile
      TYPE (Var_desc_t)  :: my_pioVar
!
!-----------------------------------------------------------------------
!  Read in a floating-point 1D-array variable.
!-----------------------------------------------------------------------
!
      IF (PRESENT(start).and.PRESENT(total)) THEN
        asize(1)=1
        DO i=1,SIZE(total)              ! this logic is for the case
          asize(1)=asize(1)*total(i)    ! of reading multidimensional
        END DO                          ! data into a compact 1D array
      ELSE
        asize(1)=ubound(a, dim=1)
      END IF
!
!  If file descriptor is not provided, open NetCDF for reading.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_open (ng, model, trim(ncname), 0, my_piofile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      ELSE
        my_piofile=piofile
      END IF
!
!  Read in variable.
!
      status=pio_inq_varid(my_piofile, trim(myvarname), my_piovar)
      IF (status.eq.pio_noerr) THEN
        IF (PRESENT(start).and.PRESENT(total)) THEN
          status=pio_get_var(my_piofile, my_piovar, start, total, a)
        ELSE
          status=pio_get_var(my_piofile, my_piovar, a)
        END IF
        IF (founderror(status, pio_noerr, __line__, myfile)) THEN
          IF (master) WRITE (stdout,10) trim(myvarname), trim(ncname),  &
     &                                  trim(sourcefile)
          exit_flag=2
          ioerror=status
        END IF
      ELSE
        IF (master) WRITE (stdout,20) trim(myvarname), trim(ncname),    &
     &                                trim(sourcefile)
        exit_flag=2
        ioerror=status
      END IF
!
!  Check if the following attributes: "scale_factor", "add_offset", and
!  "_FillValue" are present in the input NetCDF variable:
!
!  If the "scale_value" attribute is present, the data is multiplied by
!  this factor after reading.
!  If the "add_offset" attribute is present, this value is added to the
!  data after reading.
!  If both "scale_factor" and "add_offset" attributes are present, the
!  data are first scaled before the offset is added.
!  If the "_FillValue" attribute is present, the data having this value
!  is treated as missing and it is replaced with zero. This feature it
!  is usually related with the land/sea masking.
!
      attname(1)='scale_factor'
      attname(2)='add_offset  '
      attname(3)='_FillValue  '
 
      CALL pio_netcdf_get_fatt (ng, model, ncname, my_piovar,           &
     &                          attname, attvalue, foundit,             &
     &                          piofile = my_piofile)
 
      IF (exit_flag.eq.noerror) THEN
        IF (.not.foundit(1)) THEN
          afactor=1.0_r8
        ELSE
          afactor=attvalue(1)
        END IF
 
        IF (.not.foundit(2)) THEN
          aoffset=0.0_r8
        ELSE
          aoffset=attvalue(2)
        END IF
 
        IF (.not.foundit(3)) THEN
          aspval=spval_check
        ELSE
          aspval=attvalue(3)
        END IF
 
        DO i=1,asize(1)                       ! zero out missing values
          IF ((foundit(3).and.(abs(a(i)-aspval).lt.aepsilon)).or.       &
     &        (.not.foundit(3).and.(abs(a(i)).ge.abs(aspval)))) THEN
            a(i)=0.0_r8
          END IF
        END DO
 
        IF (foundit(1)) THEN                  ! scale data
          DO i=1,asize(1)
            a(i)=afactor*a(i)
          END DO
        END IF
 
        IF (foundit(2)) THEN                  ! add data offset
          DO i=1,asize(1)
            a(i)=a(i)+aoffset
          END DO
        END IF
      END IF
!
!  Compute minimum and maximum values of read variable.
!
      IF (PRESENT(min_val)) THEN
        min_val=minval(a)
      END IF
      IF (PRESENT(max_val)) THEN
        max_val=maxval(a)
      END IF
!
!  If file descriptor is not provided, close input NetCDF file.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_close (ng, model, my_piofile, ncname, .false.)
      END IF
!
  10  FORMAT (/,' PIO_NETCDF_GET_FVAR_1D - error while reading ',       &
     &        'variable:',2x,a,/,26x,'in input file:',2x,a,             &
     &        /,26x,'call from:',2x,a)
  20  FORMAT (/,' PIO_NETCDF_GET_FVAR_1D - error while inquiring ',     &
     &        'descriptor for variable:',2x,a,/,26x,'in input file:',   &
     &        2x,a,/,26x,'call from:',2x,a)
!
      RETURN

References mod_scalars::exit_flag, strings_mod::founderror(), mod_iounits::ioerror, mod_parallel::master, mod_scalars::noerror, mod_pio_netcdf::pio_netcdf_close(), mod_pio_netcdf::pio_netcdf_open(), mod_iounits::sourcefile, mod_scalars::spval_check, and mod_iounits::stdout.

Here is the call graph for this function:

pio_netcdf_get_fvar_1dp()

subroutine mod_pio_netcdf::pio_netcdf_get_fvar::pio_netcdf_get_fvar_1dp	(	integer, intent(in)	ng,
		integer, intent(in)	model,
		character (len=*), intent(in)	ncname,
		character (len=*), intent(in)	myvarname,
		real(dp), dimension(:), intent(out)	a,
		type (file_desc_t), intent(in), optional	piofile,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	total,
		logical, intent(in), optional	broadcast,
		real(dp), intent(out), optional	min_val,
		real(dp), intent(out), optional	max_val )

Definition at line 3153 of file mod_pio_netcdf.F.

!
!=======================================================================
!                                                                      !
!  This routine reads requested double-precision 1D-array variable     !
!  from specified NetCDF file.                                         !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     ng           Nested grid number (integer)                        !
!     model        Calling model identifier (integer)                  !
!     ncname       NetCDF file name (string)                           !
!     myVarName    Variable name (string)                              !
!     pioFile      PIO file descriptor, TYPE(File_desc_t), OPTIONAL    !
!                    pioFile%fh         file handler                   !
!                    pioFile%iosystem   IO system descriptor (struct)  !
!     start        Starting index where the first of the data values   !
!                    will be read along each dimension (integer,       !
!                    OPTIONAL)                                         !
!     total        Number of data values to be read along each         !
!                    dimension (integer, OPTIONAL)                     !
!                                                                      !
!     broadcast    Switch to broadcast read values from root to all    !
!                    members of the communicator in distributed-       !
!                    memory applications (logical, OPTIONAL). It is    !
!                    ignored since PIO library broadcasts the values   !
!                    to all member in the group by default.            !
!                                                                      !
!  On Ouput:                                                           !
!                                                                      !
!     A            Read 1D-array variable (double precision)           !
!     min_val      Read data minimum value (double precision, OPTIONAL)!
!     max_val      Read data maximum value (double precision, OPTIONAL)!
!                                                                      !
!  Examples:                                                           !
!                                                                      !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A)         !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A(0:))     !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A(:,1))    !
!                                                                      !
!=======================================================================
!
!  Imported variable declarations.
!
      logical, intent(in), optional :: broadcast
!
      integer, intent(in) :: ng, model
 
      integer, intent(in), optional :: start(:)
      integer, intent(in), optional :: total(:)
!
      character (len=*), intent(in) :: ncname
      character (len=*), intent(in) :: myVarName
!
      real(dp), intent(out), optional :: min_val
      real(dp), intent(out), optional :: max_val
 
      real(dp), intent(out) :: A(:)
!
      TYPE (File_desc_t), intent(in), optional :: pioFile
!
!  Local variable declarations.
!
      logical, dimension(3) :: foundit
!
      integer :: i, status
 
      integer, dimension(1) :: Asize
!
      real(dp) :: Afactor, Aoffset, Aspval
 
      real(dp), parameter :: Aepsilon = 1.0e-8_r8
 
      real(dp), dimension(3) :: AttValue
!
      character (len=12), dimension(3) :: AttName
 
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", pio_netcdf_get_fvar_1dp"
!
      TYPE (File_desc_t) :: my_pioFile
      TYPE (Var_desc_t)  :: my_pioVar
!
!-----------------------------------------------------------------------
!  Read in a double-precision 1D-array variable.
!-----------------------------------------------------------------------
!
      IF (PRESENT(start).and.PRESENT(total)) THEN
        asize(1)=1
        DO i=1,SIZE(total)              ! this logic is for the case
          asize(1)=asize(1)*total(i)    ! of reading multidimensional
        END DO                          ! data into a compact 1D array
      ELSE
        asize(1)=ubound(a, dim=1)
      END IF
!
!  If file descriptor is not provided, open NetCDF for reading.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_open (ng, model, trim(ncname), 0, my_piofile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      ELSE
        my_piofile=piofile
      END IF
!
!  Read in variable.
!
      status=pio_inq_varid(my_piofile, trim(myvarname), my_piovar)
      IF (status.eq.pio_noerr) THEN
        IF (PRESENT(start).and.PRESENT(total)) THEN
          status=pio_get_var(my_piofile, my_piovar, start, total, a)
        ELSE
          status=pio_get_var(my_piofile, my_piovar, a)
        END IF
        IF (founderror(status, pio_noerr, __line__, myfile)) THEN
          IF (master) WRITE (stdout,10) trim(myvarname), trim(ncname),  &
     &                                  trim(sourcefile)
          exit_flag=2
          ioerror=status
        END IF
      ELSE
        IF (master) WRITE (stdout,20) trim(myvarname), trim(ncname),    &
     &                                trim(sourcefile)
        exit_flag=2
        ioerror=status
      END IF
!
!  Check if the following attributes: "scale_factor", "add_offset", and
!  "_FillValue" are present in the input NetCDF variable:
!
!  If the "scale_value" attribute is present, the data is multiplied by
!  this factor after reading.
!  If the "add_offset" attribute is present, this value is added to the
!  data after reading.
!  If both "scale_factor" and "add_offset" attributes are present, the
!  data are first scaled before the offset is added.
!  If the "_FillValue" attribute is present, the data having this value
!  is treated as missing and it is replaced with zero. This feature it
!  is usually related with the land/sea masking.
!
      attname(1)='scale_factor'
      attname(2)='add_offset  '
      attname(3)='_FillValue  '
 
      CALL pio_netcdf_get_fatt (ng, model, ncname, my_piovar,           &
     &                          attname, attvalue, foundit,             &
     &                          piofile = my_piofile)
 
      IF (exit_flag.eq.noerror) THEN
        IF (.not.foundit(1)) THEN
          afactor=1.0_dp
        ELSE
          afactor=attvalue(1)
        END IF
 
        IF (.not.foundit(2)) THEN
          aoffset=0.0_dp
        ELSE
          aoffset=attvalue(2)
        END IF
 
        IF (.not.foundit(3)) THEN
          aspval=spval_check
        ELSE
          aspval=attvalue(3)
        END IF
 
        DO i=1,asize(1)                       ! zero out missing values
          IF ((foundit(3).and.(abs(a(i)-aspval).lt.aepsilon)).or.       &
     &        (.not.foundit(3).and.(abs(a(i)).ge.abs(aspval)))) THEN
            a(i)=0.0_dp
          END IF
        END DO
 
        IF (foundit(1)) THEN                  ! scale data
          DO i=1,asize(1)
            a(i)=afactor*a(i)
          END DO
        END IF
 
        IF (foundit(2)) THEN                  ! add data offset
          DO i=1,asize(1)
            a(i)=a(i)+aoffset
          END DO
        END IF
      END IF
!
!  Compute minimum and maximum values of read variable.
!
      IF (PRESENT(min_val)) THEN
        min_val=minval(a)
      END IF
      IF (PRESENT(max_val)) THEN
        max_val=maxval(a)
      END IF
!
!  If file descriptor is not provided, close input NetCDF file.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_close (ng, model, my_piofile, ncname, .false.)
      END IF
!
  10  FORMAT (/,' PIO_NETCDF_GET_FVAR_1DP - error while reading ',      &
     &        'variable:',2x,a,/,27x,'in input file:',2x,a,             &
     &        /,27x,'call from:',2x,a)
  20  FORMAT (/,' PIO_NETCDF_GET_FVAR_1DP - error while inquiring ',    &
     &        'descriptor for variable:',2x,a,/,27x,'in input file:',   &
     &        2x,a,/,27x,'call from:',2x,a)
!
      RETURN

References mod_scalars::exit_flag, strings_mod::founderror(), mod_iounits::ioerror, mod_parallel::master, mod_scalars::noerror, mod_pio_netcdf::pio_netcdf_close(), mod_pio_netcdf::pio_netcdf_open(), mod_iounits::sourcefile, mod_scalars::spval_check, and mod_iounits::stdout.

Here is the call graph for this function:

pio_netcdf_get_fvar_2d()

subroutine mod_pio_netcdf::pio_netcdf_get_fvar::pio_netcdf_get_fvar_2d	(	integer, intent(in)	ng,
		integer, intent(in)	model,
		character (len=*), intent(in)	ncname,
		character (len=*), intent(in)	myvarname,
		real(r8), dimension(:,:), intent(out)	a,
		type (file_desc_t), intent(in), optional	piofile,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	total,
		logical, intent(in), optional	broadcast,
		real(r8), intent(out), optional	min_val,
		real(r8), intent(out), optional	max_val )

Definition at line 4163 of file mod_pio_netcdf.F.

!
!=======================================================================
!                                                                      !
!  This routine reads requested floating-point 2D-array variable from  !
!  specified NetCDF file.                                              !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     ng           Nested grid number (integer)                        !
!     model        Calling model identifier (integer)                  !
!     ncname       NetCDF file name (string)                           !
!     myVarName    Variable name (string)                              !
!     pioFile      PIO file descriptor, TYPE(File_desc_t), OPTIONAL    !
!                    pioFile%fh         file handler                   !
!                    pioFile%iosystem   IO system descriptor (struct)  !
!     start        Starting index where the first of the data values   !
!                    will be read along each dimension (integer,       !
!                    OPTIONAL)                                         !
!     total        Number of data values to be read along each         !
!                    dimension (integer, OPTIONAL)                     !
!     broadcast    Switch to broadcast read values from root to all    !
!                    members of the communicator in distributed-       !
!                    memory applications (logical, OPTIONAL). It is    !
!                    ignored since PIO library broadcasts the values   !
!                    to all member in the group by default.            !
!                                                                      !
!  On Ouput:                                                           !
!                                                                      !
!     A            Read 2D-array variable (real)                       !
!     min_val      Read data minimum value (real, OPTIONAL)            !
!     max_val      Read data maximum value (real, OPTIONAL)            !
!                                                                      !
!  Examples:                                                           !
!                                                                      !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A)         !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A(0:,:))   !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A(0:,0:))  !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A(:,:,1))  !
!                                                                      !
!=======================================================================
!
!  Imported variable declarations.
!
      logical, intent(in), optional :: broadcast
!
      integer, intent(in) :: ng, model
 
      integer, intent(in), optional :: start(:)
      integer, intent(in), optional :: total(:)
!
      character (len=*), intent(in) :: ncname
      character (len=*), intent(in) :: myVarName
!
      real(r8), intent(out), optional :: min_val
      real(r8), intent(out), optional :: max_val
 
      real(r8), intent(out) :: A(:,:)
!
      TYPE (File_desc_t), intent(in), optional :: pioFile
!
!  Local variable declarations.
!
      logical, dimension(3) :: foundit
!
      integer :: i, j, status
 
      integer, dimension(2) :: Asize
!
      real(r8) :: Afactor, Aoffset, Aspval
 
      real(r8), parameter :: Aepsilon = 1.0e-8_r8
 
      real(r8), dimension(3) :: AttValue
!
      character (len=12), dimension(3) :: AttName
 
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", pio_netcdf_get_fvar_2d"
!
      TYPE (File_desc_t) :: my_pioFile
      TYPE (Var_desc_t)  :: my_pioVar
!
!-----------------------------------------------------------------------
!  Read in a floating-point 2D-array variable.
!-----------------------------------------------------------------------
!
      IF (PRESENT(start).and.PRESENT(total)) THEN
        asize(1)=total(1)
        asize(2)=total(2)
      ELSE
        asize(1)=ubound(a, dim=1)
        asize(2)=ubound(a, dim=2)
      END IF
!
!  If file descriptor is not provided, open NetCDF for reading.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_open (ng, model, trim(ncname), 0, my_piofile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      ELSE
        my_piofile=piofile
      END IF
!
!  Read in variable.
!
      status=pio_inq_varid(my_piofile, trim(myvarname), my_piovar)
      IF (status.eq.pio_noerr) THEN
        IF (PRESENT(start).and.PRESENT(total)) THEN
          status=pio_get_var(my_piofile, my_piovar, start, total, a)
        ELSE
          status=pio_get_var(my_piofile, my_piovar, a)
        END IF
        IF (founderror(status, pio_noerr, __line__, myfile)) THEN
          IF (master) WRITE (stdout,10) trim(myvarname), trim(ncname),  &
     &                                  trim(sourcefile)
          exit_flag=2
          ioerror=status
        END IF
      ELSE
        IF (master) WRITE (stdout,20) trim(myvarname), trim(ncname),    &
     &                                trim(sourcefile)
        exit_flag=2
        ioerror=status
      END IF
!
!  Check if the following attributes: "scale_factor", "add_offset", and
!  "_FillValue" are present in the input NetCDF variable:
!
!  If the "scale_value" attribute is present, the data is multiplied by
!  this factor after reading.
!  If the "add_offset" attribute is present, this value is added to the
!  data after reading.
!  If both "scale_factor" and "add_offset" attributes are present, the
!  data are first scaled before the offset is added.
!  If the "_FillValue" attribute is present, the data having this value
!  is treated as missing and it is replaced with zero. This feature it
!  is usually related with the land/sea masking.
!
      attname(1)='scale_factor'
      attname(2)='add_offset  '
      attname(3)='_FillValue  '
 
      CALL pio_netcdf_get_fatt (ng, model, ncname, my_piovar,           &
     &                          attname, attvalue, foundit,             &
     &                          piofile = my_piofile)
 
      IF (exit_flag.eq.noerror) THEN
        IF (.not.foundit(1)) THEN
          afactor=1.0_r8
        ELSE
          afactor=attvalue(1)
        END IF
 
        IF (.not.foundit(2)) THEN
          aoffset=0.0_r8
        ELSE
          aoffset=attvalue(2)
        END IF
 
        IF (.not.foundit(3)) THEN
          aspval=spval_check
        ELSE
          aspval=attvalue(3)
        END IF
 
        DO j=1,asize(2)                       ! zero out missing values
          DO i=1,asize(1)
            IF ((foundit(3).and.(abs(a(i,j)-aspval).lt.aepsilon)).or.   &
     &          (.not.foundit(3).and.(abs(a(i,j)).ge.abs(aspval)))) THEN
              a(i,j)=0.0_r8
            END IF
          END DO
        END DO
 
        IF (foundit(1)) THEN                  ! scale data
          DO j=1,asize(2)
            DO i=1,asize(1)
              a(i,j)=afactor*a(i,j)
            END DO
          END DO
        END IF
 
        IF (foundit(2)) THEN                  ! add data offset
          DO j=1,asize(2)
            DO i=1,asize(1)
              a(i,j)=a(i,j)+aoffset
            END DO
          END DO
        END IF
      END IF
!
!  Compute minimum and maximum values of read variable.
!
      IF (PRESENT(min_val)) THEN
        min_val=minval(a)
      END IF
      IF (PRESENT(max_val)) THEN
        max_val=maxval(a)
      END IF
!
!  If file descriptor is not provided, close input NetCDF file.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_close (ng, model, my_piofile, ncname, .false.)
      END IF
!
  10  FORMAT (/,' PIO_NETCDF_GET_FVAR_2D - error while reading ',       &
     &        'variable:',2x,a,/,26x,'in input file:',2x,a,             &
     &        /,26x,'call from:',2x,a)
  20  FORMAT (/,' PIO_NETCDF_GET_FVAR_2D - error while inquiring ',     &
     &        'descriptor for variable:',2x,a,/,26x,'in input file:',   &
     &        2x,a,/,26x,'call from:',2x,a)
!
      RETURN

References mod_scalars::exit_flag, strings_mod::founderror(), mod_iounits::ioerror, mod_parallel::master, mod_scalars::noerror, mod_pio_netcdf::pio_netcdf_close(), mod_pio_netcdf::pio_netcdf_open(), mod_iounits::sourcefile, mod_scalars::spval_check, and mod_iounits::stdout.

Here is the call graph for this function:

pio_netcdf_get_fvar_2dp()

subroutine mod_pio_netcdf::pio_netcdf_get_fvar::pio_netcdf_get_fvar_2dp	(	integer, intent(in)	ng,
		integer, intent(in)	model,
		character (len=*), intent(in)	ncname,
		character (len=*), intent(in)	myvarname,
		real(dp), dimension(:,:), intent(out)	a,
		type (file_desc_t), intent(in), optional	piofile,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	total,
		logical, intent(in), optional	broadcast,
		real(dp), intent(out), optional	min_val,
		real(dp), intent(out), optional	max_val )

Definition at line 3367 of file mod_pio_netcdf.F.

!
!=======================================================================
!                                                                      !
!  This routine reads requested double-precision 2D-array variable     !
!  from specified NetCDF file.                                         !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     ng           Nested grid number (integer)                        !
!     model        Calling model identifier (integer)                  !
!     ncname       NetCDF file name (string)                           !
!     myVarName    Variable name (string)                              !
!     pioFile      PIO file descriptor, TYPE(File_desc_t), OPTIONAL    !
!                    pioFile%fh         file handler                   !
!                    pioFile%iosystem   IO system descriptor (struct)  !
!     start        Starting index where the first of the data values   !
!                    will be read along each dimension (integer,       !
!                    OPTIONAL)                                         !
!     total        Number of data values to be read along each         !
!                    dimension (integer, OPTIONAL)                     !
!     broadcast    Switch to broadcast read values from root to all    !
!                    members of the communicator in distributed-       !
!                    memory applications (logical, OPTIONAL). It is    !
!                    ignored since PIO library broadcasts the values   !
!                    to all member in the group by default.            !
!                                                                      !
!  On Ouput:                                                           !
!                                                                      !
!     A            Read 2D-array variable (real)                       !
!     min_val      Read data minimum value (real, OPTIONAL)            !
!     max_val      Read data maximum value (real, OPTIONAL)            !
!                                                                      !
!  Examples:                                                           !
!                                                                      !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A)         !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A(0:,:))   !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A(0:,0:))  !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A(:,:,1))  !
!                                                                      !
!=======================================================================
!
!  Imported variable declarations.
!
      logical, intent(in), optional :: broadcast
!
      integer, intent(in) :: ng, model
 
      integer, intent(in), optional :: start(:)
      integer, intent(in), optional :: total(:)
!
      character (len=*), intent(in) :: ncname
      character (len=*), intent(in) :: myVarName
!
      real(dp), intent(out), optional :: min_val
      real(dp), intent(out), optional :: max_val
 
      real(dp), intent(out) :: A(:,:)
!
      TYPE (File_desc_t), intent(in), optional :: pioFile
!
!  Local variable declarations.
!
      logical, dimension(3) :: foundit
!
      integer :: i, j, status
 
      integer, dimension(2) :: Asize
!
      real(dp) :: Afactor, Aoffset, Aspval
 
      real(dp), parameter :: Aepsilon = 1.0e-8_r8
 
      real(dp), dimension(3) :: AttValue
!
      character (len=12), dimension(3) :: AttName
 
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", pio_netcdf_get_fvar_2dp"
!
      TYPE (File_desc_t) :: my_pioFile
      TYPE (Var_desc_t)  :: my_pioVar
!
!-----------------------------------------------------------------------
!  Read in a floating-point 2D-array variable.
!-----------------------------------------------------------------------
!
      IF (PRESENT(start).and.PRESENT(total)) THEN
        asize(1)=total(1)
        asize(2)=total(2)
      ELSE
        asize(1)=ubound(a, dim=1)
        asize(2)=ubound(a, dim=2)
      END IF
!
!  If file descriptor is not provided, open NetCDF for reading.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_open (ng, model, trim(ncname), 0, my_piofile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      ELSE
        my_piofile=piofile
      END IF
!
!  Read in variable.
!
      status=pio_inq_varid(my_piofile, trim(myvarname), my_piovar)
      IF (status.eq.pio_noerr) THEN
        IF (PRESENT(start).and.PRESENT(total)) THEN
          status=pio_get_var(my_piofile, my_piovar, start, total, a)
        ELSE
          status=pio_get_var(my_piofile, my_piovar, a)
        END IF
        IF (founderror(status, pio_noerr, __line__, myfile)) THEN
          IF (master) WRITE (stdout,10) trim(myvarname), trim(ncname),  &
     &                                  trim(sourcefile)
          exit_flag=2
          ioerror=status
        END IF
      ELSE
        IF (master) WRITE (stdout,20) trim(myvarname), trim(ncname),    &
     &                                trim(sourcefile)
        exit_flag=2
        ioerror=status
      END IF
!
!  Check if the following attributes: "scale_factor", "add_offset", and
!  "_FillValue" are present in the input NetCDF variable:
!
!  If the "scale_value" attribute is present, the data is multiplied by
!  this factor after reading.
!  If the "add_offset" attribute is present, this value is added to the
!  data after reading.
!  If both "scale_factor" and "add_offset" attributes are present, the
!  data are first scaled before the offset is added.
!  If the "_FillValue" attribute is present, the data having this value
!  is treated as missing and it is replaced with zero. This feature it
!  is usually related with the land/sea masking.
!
      attname(1)='scale_factor'
      attname(2)='add_offset  '
      attname(3)='_FillValue  '
 
      CALL pio_netcdf_get_fatt (ng, model, ncname, my_piovar,           &
     &                          attname, attvalue, foundit,             &
     &                          piofile = my_piofile)
 
      IF (exit_flag.eq.noerror) THEN
        IF (.not.foundit(1)) THEN
          afactor=1.0_r8
        ELSE
          afactor=attvalue(1)
        END IF
 
        IF (.not.foundit(2)) THEN
          aoffset=0.0_r8
        ELSE
          aoffset=attvalue(2)
        END IF
 
        IF (.not.foundit(3)) THEN
          aspval=spval_check
        ELSE
          aspval=attvalue(3)
        END IF
 
        DO j=1,asize(2)                       ! zero out missing values
          DO i=1,asize(1)
            IF ((foundit(3).and.(abs(a(i,j)-aspval).lt.aepsilon)).or.   &
     &          (.not.foundit(3).and.(abs(a(i,j)).ge.abs(aspval)))) THEN
              a(i,j)=0.0_r8
            END IF
          END DO
        END DO
 
        IF (foundit(1)) THEN                  ! scale data
          DO j=1,asize(2)
            DO i=1,asize(1)
              a(i,j)=afactor*a(i,j)
            END DO
          END DO
        END IF
 
        IF (foundit(2)) THEN                  ! add data offset
          DO j=1,asize(2)
            DO i=1,asize(1)
              a(i,j)=a(i,j)+aoffset
            END DO
          END DO
        END IF
      END IF
!
!  Compute minimum and maximum values of read variable.
!
      IF (PRESENT(min_val)) THEN
        min_val=minval(a)
      END IF
      IF (PRESENT(max_val)) THEN
        max_val=maxval(a)
      END IF
!
!  If file descriptor is not provided, close input NetCDF file.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_close (ng, model, my_piofile, ncname, .false.)
      END IF
!
  10  FORMAT (/,' PIO_NETCDF_GET_FVAR_2DP - error while reading ',      &
     &        'variable:',2x,a,/,27x,'in input file:',2x,a,             &
     &        /,27x,'call from:',2x,a)
  20  FORMAT (/,' PIO_NETCDF_GET_FVAR_2DP0 - error while inquiring ',   &
     &        'descriptor for variable:',2x,a,/,27x,'in input file:',   &
     &        2x,a,/,27x,'call from:',2x,a)
!
      RETURN

References mod_scalars::exit_flag, strings_mod::founderror(), mod_iounits::ioerror, mod_parallel::master, mod_scalars::noerror, mod_pio_netcdf::pio_netcdf_close(), mod_pio_netcdf::pio_netcdf_open(), mod_iounits::sourcefile, mod_scalars::spval_check, and mod_iounits::stdout.

Here is the call graph for this function:

pio_netcdf_get_fvar_3d()

subroutine mod_pio_netcdf::pio_netcdf_get_fvar::pio_netcdf_get_fvar_3d	(	integer, intent(in)	ng,
		integer, intent(in)	model,
		character (len=*), intent(in)	ncname,
		character (len=*), intent(in)	myvarname,
		real(r8), dimension(:,:,:), intent(out)	a,
		type (file_desc_t), intent(in), optional	piofile,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	total,
		logical, intent(in), optional	broadcast,
		real(r8), intent(out), optional	min_val,
		real(r8), intent(out), optional	max_val )

Definition at line 4382 of file mod_pio_netcdf.F.

!
!=======================================================================
!                                                                      !
!  This routine reads requested floating-point 3D-array variable from  !
!  specified NetCDF file.                                              !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     ng           Nested grid number (integer)                        !
!     model        Calling model identifier (integer)                  !
!     ncname       NetCDF file name (string)                           !
!     myVarName    Variable name (string)                              !
!     pioFile      PIO file descriptor, TYPE(File_desc_t), OPTIONAL    !
!                    pioFile%fh         file handler                   !
!                    pioFile%iosystem   IO system descriptor (struct)  !
!     start        Starting index where the first of the data values   !
!                    will be read along each dimension (integer,       !
!                    OPTIONAL)                                         !
!     total        Number of data values to be read along each         !
!                    dimension (integer, OPTIONAL)                     !
!     broadcast    Switch to broadcast read values from root to all    !
!                    members of the communicator in distributed-       !
!                    memory applications (logical, OPTIONAL). It is    !
!                    ignored since PIO library broadcasts the values   !
!                    to all member in the group by default.            !
!                                                                      !
!  On Ouput:                                                           !
!                                                                      !
!     A            Read 3D-array variable (real)                       !
!     min_val      Read data minimum value (real, OPTIONAL)            !
!     max_val      Read data maximum value (real, OPTIONAL)            !
!                                                                      !
!  Examples:                                                           !
!                                                                      !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A)         !
!                                                                      !
!=======================================================================
!
!  Imported variable declarations.
!
      logical, intent(in), optional :: broadcast
!
      integer, intent(in) :: ng, model
 
      integer, intent(in), optional :: start(:)
      integer, intent(in), optional :: total(:)
!
      character (len=*), intent(in) :: ncname
      character (len=*), intent(in) :: myVarName
!
      real(r8), intent(out), optional :: min_val
      real(r8), intent(out), optional :: max_val
 
      real(r8), intent(out) :: A(:,:,:)
!
      TYPE (File_desc_t), intent(in), optional :: pioFile
!
!  Local variable declarations.
!
      logical, dimension(3) :: foundit
!
      integer :: i, j, k, status
 
      integer, dimension(3) :: Asize
!
      real(r8) :: Afactor, Aoffset, Aspval
 
      real(r8), parameter :: Aepsilon = 1.0e-8_r8
 
      real(r8), dimension(3) :: AttValue
!
      character (len=12), dimension(3) :: AttName
 
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", pio_netcdf_get_fvar_3d"
!
      TYPE (File_desc_t) :: my_pioFile
      TYPE (Var_desc_t)  :: my_pioVar
!
!-----------------------------------------------------------------------
!  Read in a floating-point 2D-array variable.
!-----------------------------------------------------------------------
!
      IF (PRESENT(start).and.PRESENT(total)) THEN
        asize(1)=total(1)
        asize(2)=total(2)
        asize(3)=total(3)
      ELSE
        asize(1)=ubound(a, dim=1)
        asize(2)=ubound(a, dim=2)
        asize(3)=ubound(a, dim=3)
      END IF
!
!  If file descriptor is not provided, open NetCDF for reading.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_open (ng, model, trim(ncname), 0, my_piofile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      ELSE
        my_piofile=piofile
      END IF
!
!  Read in variable.
!
      status=pio_inq_varid(my_piofile, trim(myvarname), my_piovar)
      IF (status.eq.pio_noerr) THEN
        IF (PRESENT(start).and.PRESENT(total)) THEN
          status=pio_get_var(my_piofile, my_piovar, start, total, a)
        ELSE
          status=pio_get_var(my_piofile, my_piovar, a)
        END IF
        IF (founderror(status, pio_noerr, __line__, myfile)) THEN
          IF (master) WRITE (stdout,10) trim(myvarname), trim(ncname),  &
     &                                  trim(sourcefile)
          exit_flag=2
          ioerror=status
        END IF
      ELSE
        IF (master) WRITE (stdout,20) trim(myvarname), trim(ncname),    &
     &                                trim(sourcefile)
        exit_flag=2
        ioerror=status
      END IF
!
!  Check if the following attributes: "scale_factor", "add_offset", and
!  "_FillValue" are present in the input NetCDF variable:
!
!  If the "scale_value" attribute is present, the data is multiplied by
!  this factor after reading.
!  If the "add_offset" attribute is present, this value is added to the
!  data after reading.
!  If both "scale_factor" and "add_offset" attributes are present, the
!  data are first scaled before the offset is added.
!  If the "_FillValue" attribute is present, the data having this value
!  is treated as missing and it is replaced with zero. This feature it
!  is usually related with the land/sea masking.
!
      attname(1)='scale_factor'
      attname(2)='add_offset  '
      attname(3)='_FillValue  '
 
      CALL pio_netcdf_get_fatt (ng, model, ncname, my_piovar,           &
     &                          attname, attvalue, foundit,             &
     &                          piofile = my_piofile)
 
      IF (exit_flag.eq.noerror) THEN
        IF (.not.foundit(1)) THEN
          afactor=1.0_r8
        ELSE
          afactor=attvalue(1)
        END IF
 
        IF (.not.foundit(2)) THEN
          aoffset=0.0_r8
        ELSE
          aoffset=attvalue(2)
        END IF
 
        IF (.not.foundit(3)) THEN
          aspval=spval_check
        ELSE
          aspval=attvalue(3)
        END IF
 
        DO k=1,asize(3)                       ! zero out missing values
          DO j=1,asize(2)
            DO i=1,asize(1)
              IF ((foundit(3).and.                                      &
     &             (abs(a(i,j,k)-aspval).lt.aepsilon)).or.              &
     &            (.not.foundit(3).and.                                 &
     &             (abs(a(i,j,k)).ge.abs(aspval)))) THEN
                a(i,j,k)=0.0_r8
              END IF
            END DO
          END DO
        END DO
 
        IF (foundit(1)) THEN                  ! scale data
          DO k=1,asize(3)
            DO j=1,asize(2)
              DO i=1,asize(1)
                a(i,j,k)=afactor*a(i,j,k)
              END DO
            END DO
          END DO
        END IF
 
        IF (foundit(2)) THEN                  ! add data offset
          DO k=1,asize(3)
            DO j=1,asize(2)
              DO i=1,asize(1)
                a(i,j,k)=a(i,j,k)+aoffset
              END DO
            END DO
          END DO
        END IF
      END IF
!
!  Compute minimum and maximum values of read variable.
!
      IF (PRESENT(min_val)) THEN
        min_val=minval(a)
      END IF
      IF (PRESENT(max_val)) THEN
        max_val=maxval(a)
      END IF
!
!  If file descriptor is not provided, close input NetCDF file.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_close (ng, model, my_piofile, ncname, .false.)
      END IF
!
  10  FORMAT (/,' PIO_NETCDF_GET_FVAR_3D - error while reading ',       &
     &        'variable:',2x,a,/,26x,'in input file:',2x,a,             &
     &        /,26x,'call from:',2x,a)
  20  FORMAT (/,' PIO_NETCDF_GET_FVAR_3D - error while inquiring ',     &
     &        'descriptor for variable:',2x,a,/,26x,'in input file:',   &
     &        2x,a,/,26x,'call from:',2x,a)
!
      RETURN

References mod_scalars::exit_flag, strings_mod::founderror(), mod_iounits::ioerror, mod_parallel::master, mod_scalars::noerror, mod_pio_netcdf::pio_netcdf_close(), mod_pio_netcdf::pio_netcdf_open(), mod_iounits::sourcefile, mod_scalars::spval_check, and mod_iounits::stdout.

Here is the call graph for this function:

pio_netcdf_get_fvar_3dp()

subroutine mod_pio_netcdf::pio_netcdf_get_fvar::pio_netcdf_get_fvar_3dp	(	integer, intent(in)	ng,
		integer, intent(in)	model,
		character (len=*), intent(in)	ncname,
		character (len=*), intent(in)	myvarname,
		real(dp), dimension(:,:,:), intent(out)	a,
		type (file_desc_t), intent(in), optional	piofile,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	total,
		logical, intent(in), optional	broadcast,
		real(dp), intent(out), optional	min_val,
		real(dp), intent(out), optional	max_val )

Definition at line 3586 of file mod_pio_netcdf.F.

!
!=======================================================================
!                                                                      !
!  This routine reads requested double-precision 3D-array variable     !
!  from specified NetCDF file.                                         !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     ng           Nested grid number (integer)                        !
!     model        Calling model identifier (integer)                  !
!     ncname       NetCDF file name (string)                           !
!     myVarName    Variable name (string)                              !
!     pioFile      PIO file descriptor, TYPE(File_desc_t), OPTIONAL    !
!                    pioFile%fh         file handler                   !
!                    pioFile%iosystem   IO system descriptor (struct)  !
!     start        Starting index where the first of the data values   !
!                    will be read along each dimension (integer,       !
!                    OPTIONAL)                                         !
!     total        Number of data values to be read along each         !
!                    dimension (integer, OPTIONAL)                     !
!     broadcast    Switch to broadcast read values from root to all    !
!                    members of the communicator in distributed-       !
!                    memory applications (logical, OPTIONAL). It is    !
!                    ignored since PIO library broadcasts the values   !
!                    to all member in the group by default.            !
!                                                                      !
!  On Ouput:                                                           !
!                                                                      !
!     A            Read 3D-array variable (real)                       !
!     min_val      Read data minimum value (real, OPTIONAL)            !
!     max_val      Read data maximum value (real, OPTIONAL)            !
!                                                                      !
!  Examples:                                                           !
!                                                                      !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A)         !
!                                                                      !
!=======================================================================
!
!  Imported variable declarations.
!
      logical, intent(in), optional :: broadcast
!
      integer, intent(in) :: ng, model
 
      integer, intent(in), optional :: start(:)
      integer, intent(in), optional :: total(:)
!
      character (len=*), intent(in) :: ncname
      character (len=*), intent(in) :: myVarName
!
      real(dp), intent(out), optional :: min_val
      real(dp), intent(out), optional :: max_val
 
      real(dp), intent(out) :: A(:,:,:)
!
      TYPE (File_desc_t), intent(in), optional :: pioFile
!
!  Local variable declarations.
!
      logical, dimension(3) :: foundit
!
      integer :: i, j, k, status
 
      integer, dimension(3) :: Asize
!
      real(dp) :: Afactor, Aoffset, Aspval
 
      real(dp), parameter :: Aepsilon = 1.0e-8_r8
 
      real(dp), dimension(3) :: AttValue
!
      character (len=12), dimension(3) :: AttName
 
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", pio_netcdf_get_fvar_3dp"
!
      TYPE (File_desc_t) :: my_pioFile
      TYPE (Var_desc_t)  :: my_pioVar
!
!-----------------------------------------------------------------------
!  Read in a floating-point 2D-array variable.
!-----------------------------------------------------------------------
!
      IF (PRESENT(start).and.PRESENT(total)) THEN
        asize(1)=total(1)
        asize(2)=total(2)
        asize(3)=total(3)
      ELSE
        asize(1)=ubound(a, dim=1)
        asize(2)=ubound(a, dim=2)
        asize(3)=ubound(a, dim=3)
      END IF
!
!  If file descriptor is not provided, open NetCDF for reading.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_open (ng, model, trim(ncname), 0, my_piofile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      ELSE
        my_piofile=piofile
      END IF
!
!  Read in variable.
!
      status=pio_inq_varid(my_piofile, trim(myvarname), my_piovar)
      IF (status.eq.pio_noerr) THEN
        IF (PRESENT(start).and.PRESENT(total)) THEN
          status=pio_get_var(my_piofile, my_piovar, start, total, a)
        ELSE
          status=pio_get_var(my_piofile, my_piovar, a)
        END IF
        IF (founderror(status, pio_noerr, __line__, myfile)) THEN
          IF (master) WRITE (stdout,10) trim(myvarname), trim(ncname),  &
     &                                  trim(sourcefile)
          exit_flag=2
          ioerror=status
        END IF
      ELSE
        IF (master) WRITE (stdout,20) trim(myvarname), trim(ncname),    &
     &                                trim(sourcefile)
        exit_flag=2
        ioerror=status
      END IF
!
!  Check if the following attributes: "scale_factor", "add_offset", and
!  "_FillValue" are present in the input NetCDF variable:
!
!  If the "scale_value" attribute is present, the data is multiplied by
!  this factor after reading.
!  If the "add_offset" attribute is present, this value is added to the
!  data after reading.
!  If both "scale_factor" and "add_offset" attributes are present, the
!  data are first scaled before the offset is added.
!  If the "_FillValue" attribute is present, the data having this value
!  is treated as missing and it is replaced with zero. This feature it
!  is usually related with the land/sea masking.
!
      attname(1)='scale_factor'
      attname(2)='add_offset  '
      attname(3)='_FillValue  '
 
      CALL pio_netcdf_get_fatt (ng, model, ncname, my_piovar,           &
     &                          attname, attvalue, foundit,             &
     &                          piofile = my_piofile)
 
      IF (exit_flag.eq.noerror) THEN
        IF (.not.foundit(1)) THEN
          afactor=1.0_r8
        ELSE
          afactor=attvalue(1)
        END IF
 
        IF (.not.foundit(2)) THEN
          aoffset=0.0_r8
        ELSE
          aoffset=attvalue(2)
        END IF
 
        IF (.not.foundit(3)) THEN
          aspval=spval_check
        ELSE
          aspval=attvalue(3)
        END IF
 
        DO k=1,asize(3)                       ! zero out missing values
          DO j=1,asize(2)
            DO i=1,asize(1)
              IF ((foundit(3).and.                                      &
     &             (abs(a(i,j,k)-aspval).lt.aepsilon)).or.              &
     &            (.not.foundit(3).and.                                 &
     &             (abs(a(i,j,k)).ge.abs(aspval)))) THEN
                a(i,j,k)=0.0_r8
              END IF
            END DO
          END DO
        END DO
 
        IF (foundit(1)) THEN                  ! scale data
          DO k=1,asize(3)
            DO j=1,asize(2)
              DO i=1,asize(1)
                a(i,j,k)=afactor*a(i,j,k)
              END DO
            END DO
          END DO
        END IF
 
        IF (foundit(2)) THEN                  ! add data offset
          DO k=1,asize(3)
            DO j=1,asize(2)
              DO i=1,asize(1)
                a(i,j,k)=a(i,j,k)+aoffset
              END DO
            END DO
          END DO
        END IF
      END IF
!
!  Compute minimum and maximum values of read variable.
!
      IF (PRESENT(min_val)) THEN
        min_val=minval(a)
      END IF
      IF (PRESENT(max_val)) THEN
        max_val=maxval(a)
      END IF
!
!  If file descriptor is not provided, close input NetCDF file.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_close (ng, model, my_piofile, ncname, .false.)
      END IF
!
  10  FORMAT (/,' PIO_NETCDF_GET_FVAR_3DP - error while reading ',      &
     &        'variable:',2x,a,/,27x,'in input file:',2x,a,             &
     &        /,27x,'call from:',2x,a)
  20  FORMAT (/,' PIO_NETCDF_GET_FVAR_3DP - error while inquiring ',    &
     &        'descriptor for variable:',2x,a,/,27x,'in input file:',   &
     &        2x,a,/,27x,'call from:',2x,a)
!
      RETURN

References mod_scalars::exit_flag, strings_mod::founderror(), mod_iounits::ioerror, mod_parallel::master, mod_scalars::noerror, mod_pio_netcdf::pio_netcdf_close(), mod_pio_netcdf::pio_netcdf_open(), mod_iounits::sourcefile, mod_scalars::spval_check, and mod_iounits::stdout.

Here is the call graph for this function:

pio_netcdf_get_fvar_4d()

subroutine mod_pio_netcdf::pio_netcdf_get_fvar::pio_netcdf_get_fvar_4d	(	integer, intent(in)	ng,
		integer, intent(in)	model,
		character (len=*), intent(in)	ncname,
		character (len=*), intent(in)	myvarname,
		real(r8), dimension(:,:,:,:), intent(out)	a,
		type (file_desc_t), intent(in), optional	piofile,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	total,
		logical, intent(in), optional	broadcast,
		real(r8), intent(out), optional	min_val,
		real(r8), intent(out), optional	max_val )

Definition at line 4608 of file mod_pio_netcdf.F.

!
!=======================================================================
!                                                                      !
!  This routine reads requested floating-point 4D-array variable from  !
!  specified NetCDF file.                                              !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     ng           Nested grid number (integer)                        !
!     model        Calling model identifier (integer)                  !
!     ncname       NetCDF file name (string)                           !
!     myVarName    Variable name (string)                              !
!     pioFile      PIO file descriptor, TYPE(File_desc_t), OPTIONAL    !
!                    pioFile%fh         file handler                   !
!                    pioFile%iosystem   IO system descriptor (struct)  !
!     start        Starting index where the first of the data values   !
!                    will be read along each dimension (integer,       !
!                    OPTIONAL)                                         !
!     total        Number of data values to be read along each         !
!                    dimension (integer, OPTIONAL)                     !
!     broadcast    Switch to broadcast read values from root to all    !
!                    members of the communicator in distributed-       !
!                    memory applications (logical, OPTIONAL,           !
!                    default=TRUE)                                     !
!                                                                      !
!  On Ouput:                                                           !
!                                                                      !
!     A            Read 4D-array variable (real)                       !
!     min_val      Read data minimum value (real, OPTIONAL)            !
!     max_val      Read data maximum value (real, OPTIONAL)            !
!                                                                      !
!  Examples:                                                           !
!                                                                      !
!    CALL pio_netcdf_get_fvar (ng, iNLM, 'f.nc', 'VarName', A)         !
!                                                                      !
!=======================================================================
!
!  Imported variable declarations.
!
      logical, intent(in), optional :: broadcast
!
      integer, intent(in) :: ng, model
 
      integer, intent(in), optional :: start(:)
      integer, intent(in), optional :: total(:)
!
      character (len=*), intent(in) :: ncname
      character (len=*), intent(in) :: myVarName
!
      real(r8), intent(out), optional :: min_val
      real(r8), intent(out), optional :: max_val
 
      real(r8), intent(out) :: A(:,:,:,:)
!
      TYPE (File_desc_t), intent(in), optional :: pioFile
!
!  Local variable declarations.
!
      logical, dimension(3) :: foundit
!
      integer :: i, j, k, l, status
 
      integer, dimension(4) :: Asize
!
      real(r8) :: Afactor, Aoffset, Aspval
 
      real(r8), parameter :: Aepsilon = 1.0e-8_r8
 
      real(r8), dimension(3) :: AttValue
!
      character (len=12), dimension(3) :: AttName
 
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", pio_netcdf_get_fvar_4d"
!
      TYPE (File_desc_t) :: my_pioFile
      TYPE (Var_desc_t)  :: my_pioVar
!
!-----------------------------------------------------------------------
!  Read in a floating-point 2D-array variable.
!-----------------------------------------------------------------------
!
      IF (PRESENT(start).and.PRESENT(total)) THEN
        asize(1)=total(1)
        asize(2)=total(2)
        asize(3)=total(3)
        asize(4)=total(4)
      ELSE
        asize(1)=ubound(a, dim=1)
        asize(2)=ubound(a, dim=2)
        asize(3)=ubound(a, dim=3)
        asize(4)=ubound(a, dim=4)
      END IF
!
!  If file descriptor is not provided, open NetCDF for reading.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_open (ng, model, trim(ncname), 0, my_piofile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      ELSE
        my_piofile=piofile
      END IF
!
!  Read in variable.
!
      status=pio_inq_varid(my_piofile, trim(myvarname), my_piovar)
      IF (status.eq.pio_noerr) THEN
        IF (PRESENT(start).and.PRESENT(total)) THEN
          status=pio_get_var(my_piofile, my_piovar, start, total, a)
        ELSE
          status=pio_get_var(my_piofile, my_piovar, a)
        END IF
        IF (founderror(status, pio_noerr, __line__, myfile)) THEN
          IF (master) WRITE (stdout,10) trim(myvarname), trim(ncname),  &
     &                                  trim(sourcefile)
          exit_flag=2
          ioerror=status
        END IF
      ELSE
        IF (master) WRITE (stdout,20) trim(myvarname), trim(ncname),    &
     &                                trim(sourcefile)
        exit_flag=2
        ioerror=status
      END IF
!
!  Check if the following attributes: "scale_factor", "add_offset", and
!  "_FillValue" are present in the input NetCDF variable:
!
!  If the "scale_value" attribute is present, the data is multiplied by
!  this factor after reading.
!  If the "add_offset" attribute is present, this value is added to the
!  data after reading.
!  If both "scale_factor" and "add_offset" attributes are present, the
!  data are first scaled before the offset is added.
!  If the "_FillValue" attribute is present, the data having this value
!  is treated as missing and it is replaced with zero. This feature it
!  is usually related with the land/sea masking.
!
      attname(1)='scale_factor'
      attname(2)='add_offset  '
      attname(3)='_FillValue  '
 
      CALL pio_netcdf_get_fatt (ng, model, ncname, my_piovar,           &
     &                          attname, attvalue, foundit,             &
     &                          piofile = my_piofile)
 
      IF (exit_flag.eq.noerror) THEN
        IF (.not.foundit(1)) THEN
          afactor=1.0_r8
        ELSE
          afactor=attvalue(1)
        END IF
 
        IF (.not.foundit(2)) THEN
          aoffset=0.0_r8
        ELSE
          aoffset=attvalue(2)
        END IF
 
        IF (.not.foundit(3)) THEN
          aspval=spval_check
        ELSE
          aspval=attvalue(3)
        END IF
 
        DO l=1,asize(4)                       ! zero out missing values
          DO k=1,asize(3)
            DO j=1,asize(2)
              DO i=1,asize(1)
                IF ((foundit(3).and.                                    &
     &               (abs(a(i,j,k,l)-aspval).lt.aepsilon)).or.          &
     &              (.not.foundit(3).and.                               &
     &               (abs(a(i,j,k,l)).ge.abs(aspval)))) THEN
                  a(i,j,k,l)=0.0_r8
                END IF
              END DO
            END DO
          END DO
        END DO
 
        IF (foundit(1)) THEN                  ! scale data
          DO l=1,asize(4)
            DO k=1,asize(3)
              DO j=1,asize(2)
                DO i=1,asize(1)
                  a(i,j,k,l)=afactor*a(i,j,k,l)
                END DO
              END DO
            END DO
          END DO
        END IF
 
        IF (foundit(2)) THEN                  ! add data offset
          DO l=1,asize(4)
            DO k=1,asize(3)
              DO j=1,asize(2)
                DO i=1,asize(1)
                  a(i,j,k,l)=a(i,j,k,l)+aoffset
                END DO
              END DO
            END DO
          END DO
        END IF
      END IF
!
!  Compute minimum and maximum values of read variable.
!
      IF (PRESENT(min_val)) THEN
        min_val=minval(a)
      END IF
      IF (PRESENT(max_val)) THEN
        max_val=maxval(a)
      END IF
!
!  If file descriptor is not provided, close input NetCDF file.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_close (ng, model, my_piofile, ncname, .false.)
      END IF
!
  10  FORMAT (/,' PIO_NETCDF_GET_FVAR_4D - error while reading ',       &
     &        'variable:',2x,a,/,26x,'in input file:',2x,a,             &
     &        /,26x,'call from:',2x,a)
  20  FORMAT (/,' PIO_NETCDF_GET_FVAR_4D - error while inquiring ',     &
     &        'descriptor for variable:',2x,a,/,26x,'in input file:',   &
     &        2x,a,/,26x,'call from:',2x,a)
!
      RETURN

References mod_scalars::exit_flag, strings_mod::founderror(), mod_iounits::ioerror, mod_parallel::master, mod_scalars::noerror, mod_pio_netcdf::pio_netcdf_close(), mod_pio_netcdf::pio_netcdf_open(), mod_iounits::sourcefile, mod_scalars::spval_check, and mod_iounits::stdout.

Here is the call graph for this function:

---

The documentation for this interface was generated from the following file:

• ROMS/Modules/mod_pio_netcdf.F