arrayreadersmodule::readarray Interface Reference

Collaboration diagram for arrayreadersmodule::readarray:

Private Member Functions
subroutine	read_array_int1d (iu, iarr, aname, ndim, jj, iout, k)
subroutine	read_array_int2d (iu, iarr, aname, ndim, jj, ii, iout, k)
subroutine	read_array_int3d (iu, iarr, aname, ndim, ncol, nrow, nlay, iout, k1, k2)
subroutine	read_array_dbl1d (iu, darr, aname, ndim, jj, iout, k)
subroutine	read_array_dbl2d (iu, darr, aname, ndim, jj, ii, iout, k)
subroutine	read_array_dbl3d (iu, darr, aname, ndim, ncol, nrow, nlay, iout, k1, k2)
subroutine	read_array_dbl1d_layered (iu, darr, aname, ndim, ncol, nrow, nlay, nval, iout, k1, k2)
subroutine	read_array_int1d_layered (iu, iarr, aname, ndim, ncol, nrow, nlay, nval, iout, k1, k2)
subroutine	read_array_dbl3d_all (iu, darr, aname, ndim, nvals, iout)
subroutine	read_array_int3d_all (iu, iarr, aname, ndim, nvals, iout)

Detailed Description

Definition at line 20 of file ArrayReaders.f90.

Member Function/Subroutine Documentation

read_array_dbl1d()

subroutine arrayreadersmodule::readarray::read_array_dbl1d ( integer(i4b), intent(in)  iu, real(dp), dimension(jj), intent(inout)  darr, character(len=*), intent(in)  aname, integer(i4b), intent(in)  ndim, integer(i4b), intent(in)  jj, integer(i4b), intent(in)  iout, integer(i4b), intent(in)  k  )

private

Definition at line 312 of file ArrayReaders.f90.

    ! -- dummy
    integer(I4B), intent(in) :: iu, iout
    integer(I4B), intent(in) :: jj
    real(DP), dimension(jj), intent(inout) :: darr
    character(len=*), intent(in) :: aname
    integer(I4B), intent(in) :: ndim ! dis%ndim
    integer(I4B), intent(in) :: k ! layer number; 0 to not print
    ! -- local
    logical(LGP) :: isok
    integer(I4B) :: j, iclose, iprn, locat, ncpl, ndig
    real(DP) :: cnstnt
    logical :: prowcolnum
    character(len=100) :: prfmt
    integer(I4B) :: istat
    integer(I4B) :: nvalt, nval
    character(len=30) :: arrname
    character(len=MAXCHARLEN) :: ermsgr
    ! -- formats
2   format(/, 1x, a, ' = ', g14.7, ' FOR LAYER ', i0)
3   format(/, 1x, a, ' = ', g14.7)
    !
    ! -- Read array control record.
    call read_control_dbl(iu, iout, aname, locat, cnstnt, iclose, iprn)
    !
    ! -- Read or assign array data.
    if (locat == 0) then
      ! -- Assign constant
      do j = 1, jj
        darr(j) = cnstnt
      end do
      if (iout > 0) then
        if (k > 0) then
          write (iout, 2) trim(aname), cnstnt, k
        else
          write (iout, 3) trim(aname), cnstnt
        end if
      end if
    elseif (locat > 0) then
      ! -- Read data as text
      read (locat, *, iostat=istat, iomsg=ermsgr) (darr(j), j=1, jj)
      if (istat /= 0) then
        arrname = adjustl(aname)
        errmsg = "Error reading data for array '"// &
                 trim(adjustl(arrname))//"'. "//trim(adjustl(ermsgr))
        call store_error(errmsg)
        call store_error_unit(locat)
      end if
      do j = 1, jj
        darr(j) = darr(j) * cnstnt
      end do
      if (iclose == 1) then
        close (locat)
      end if
    else
      ! -- Read data as binary
      locat = -locat
      nvalt = 0
      do
        call read_binary_header(locat, iout, aname, nval)
        isok = check_binary_size(nval, nvalt, size(darr), aname, locat)
        if (isok .EQV. .false.) exit
        read (locat, iostat=istat, iomsg=ermsgr) &
          (darr(j), j=nvalt + 1, nvalt + nval)
        if (istat /= 0) then
          arrname = adjustl(aname)
          errmsg = "Error reading data for array '"// &
                   trim(adjustl(arrname))//"'. "//trim(adjustl(ermsgr))
          call store_error(errmsg)
          call store_error_unit(locat)
        end if
        nvalt = nvalt + nval
        if (nvalt == size(darr)) exit
      end do
      !
      ! -- multiply entire array by constant
      do j = 1, jj
        darr(j) = darr(j) * cnstnt
      end do
      !
      ! -- close the file
      if (iclose == 1) then
        close (locat)
      end if
    end if
    !
    ! -- Print array if requested.
    if (iprn >= 0 .and. locat /= 0) then
      prowcolnum = (ndim == 3)
      call build_format_dbl(iprn, prfmt, prowcolnum, ncpl, ndig)
      call print_array_dbl(darr, aname, iout, jj, 1, k, prfmt, ncpl, ndig, &
                           prowcolnum)
    end if
    !
    return

Here is the call graph for this function:

read_array_dbl1d_layered()

subroutine arrayreadersmodule::readarray::read_array_dbl1d_layered ( integer(i4b), intent(in)  iu, real(dp), dimension(nval), intent(inout)  darr, character(len=*), intent(in)  aname, integer(i4b), intent(in)  ndim, integer(i4b), intent(in)  ncol, integer(i4b), intent(in)  nrow, integer(i4b), intent(in)  nlay, integer(i4b), intent(in)  nval, integer(i4b), intent(in)  iout, integer(i4b), intent(in)  k1, integer(i4b), intent(in)  k2  )

private

Definition at line 559 of file ArrayReaders.f90.

    ! -- dummy
    integer(I4B), intent(in) :: iu, iout
    integer(I4B), intent(in) :: ncol, nrow, nlay, nval
    real(DP), dimension(nval), intent(inout) :: darr
    character(len=*), intent(in) :: aname
    integer(I4B), intent(in) :: ndim ! dis%ndim
    integer(I4B), intent(in) :: k1, k2
    ! -- local
    !
    call read_array_dbl3d(iu, darr, aname, ndim, ncol, nrow, nlay, iout, k1, k2)
    !
    return

Here is the call graph for this function:

read_array_dbl2d()

subroutine arrayreadersmodule::readarray::read_array_dbl2d ( integer(i4b), intent(in)  iu, real(dp), dimension(jj, ii), intent(inout)  darr, character(len=*), intent(in)  aname, integer(i4b), intent(in)  ndim, integer(i4b), intent(in)  jj, integer(i4b), intent(in)  ii, integer(i4b), intent(in)  iout, integer(i4b), intent(in)  k  )

private

Definition at line 409 of file ArrayReaders.f90.

    ! -- dummy
    integer(I4B), intent(in) :: iu, iout
    integer(I4B), intent(in) :: jj, ii
    real(DP), dimension(jj, ii), intent(inout) :: darr
    character(len=*), intent(in) :: aname
    integer(I4B), intent(in) :: ndim ! dis%ndim
    integer(I4B), intent(in) :: k ! layer number; 0 to not print
    ! -- local
    logical(LGP) :: isok
    integer(I4B) :: i, iclose, iprn, j, locat, ncpl, ndig
    integer(I4B) :: nval
    real(DP) :: cnstnt
    logical :: prowcolnum
    character(len=100) :: prfmt
    integer(I4B) :: istat
    character(len=30) :: arrname
    character(len=MAXCHARLEN) :: ermsgr
    ! -- formats
2   format(/, 1x, a, ' = ', g14.7, ' FOR LAYER ', i0)
3   format(/, 1x, a, ' = ', g14.7)
    !
    ! -- Read array control record.
    call read_control_dbl(iu, iout, aname, locat, cnstnt, iclose, iprn)
    !
    ! -- Read or assign array data.
    if (locat == 0) then
      ! -- Assign constant
      do i = 1, ii
        do j = 1, jj
          darr(j, i) = cnstnt
        end do
      end do
      if (iout > 0) then
        if (k > 0) then
          write (iout, 2) trim(aname), cnstnt, k
        else
          write (iout, 3) trim(aname), cnstnt
        end if
      end if
    elseif (locat > 0) then
      ! -- Read data as text
      do i = 1, ii
        read (locat, *, iostat=istat, iomsg=ermsgr) (darr(j, i), j=1, jj)
        if (istat /= 0) then
          arrname = adjustl(aname)
          errmsg = "Error reading data for array '"// &
                   trim(adjustl(arrname))//"'. "//trim(adjustl(ermsgr))
          call store_error(errmsg)
          call store_error_unit(locat)
        end if
        do j = 1, jj
          darr(j, i) = darr(j, i) * cnstnt
        end do
      end do
      if (iclose == 1) then
        close (locat)
      end if
    else
      ! -- Read data as binary
      locat = -locat
      call read_binary_header(locat, iout, aname, nval)
      isok = check_binary_size(nval, 0, size(darr), aname, locat)
      if (isok) then
        do i = 1, ii
          read (locat, iostat=istat, iomsg=ermsgr) (darr(j, i), j=1, jj)
          if (istat /= 0) then
            arrname = adjustl(aname)
            errmsg = "Error reading data for array '"// &
                     trim(adjustl(arrname))//"'. "//trim(adjustl(ermsgr))
            call store_error(errmsg)
            call store_error_unit(locat)
          end if
          do j = 1, jj
            darr(j, i) = darr(j, i) * cnstnt
          end do
        end do
      end if
      if (iclose == 1) then
        close (locat)
      end if
    end if
    !
    ! -- Print array if requested.
    if (iprn >= 0 .and. locat /= 0) then
      prowcolnum = (ndim == 3)
      call build_format_dbl(iprn, prfmt, prowcolnum, ncpl, ndig)
      call print_array_dbl(darr, aname, iout, jj, ii, k, prfmt, ncpl, &
                           ndig, prowcolnum)
    end if
    !
    return

Here is the call graph for this function:

read_array_dbl3d()

subroutine arrayreadersmodule::readarray::read_array_dbl3d ( integer(i4b), intent(in)  iu, real(dp), dimension(ncol, nrow, nlay), intent(inout)  darr, character(len=*), intent(in)  aname, integer(i4b), intent(in)  ndim, integer(i4b), intent(in)  ncol, integer(i4b), intent(in)  nrow, integer(i4b), intent(in)  nlay, integer(i4b), intent(in)  iout, integer(i4b), intent(in)  k1, integer(i4b), intent(in)  k2  )

private

Definition at line 503 of file ArrayReaders.f90.

! ******************************************************************************
! Read three-dimensional real array, consisting of one or more 2d arrays with
! array control records.
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    integer(I4B), intent(in) :: iu
    integer(I4B), intent(in) :: iout
    integer(I4B), intent(in) :: ndim
    integer(I4B), intent(in) :: ncol
    integer(I4B), intent(in) :: nrow
    integer(I4B), intent(in) :: nlay
    integer(I4B), intent(in) :: k1, k2
    real(DP), dimension(ncol, nrow, nlay), intent(inout) :: darr
    character(len=*), intent(in) :: aname
    ! -- local
    integer(I4B) :: k, kk
! ------------------------------------------------------------------------------
    !
    do k = k1, k2
      if (k <= 0) then
        kk = 1
      else
        kk = k
      end if
      call read_array_dbl2d(iu, darr(:, :, kk), aname, ndim, ncol, nrow, iout, k)
    end do
    !
    return

Here is the call graph for this function:

read_array_dbl3d_all()

subroutine arrayreadersmodule::readarray::read_array_dbl3d_all ( integer(i4b), intent(in)  iu, real(dp), dimension(nvals, 1, 1), intent(inout)  darr, character(len=*), intent(in)  aname, integer(i4b), intent(in)  ndim, integer(i4b), intent(in)  nvals, integer(i4b), intent(in)  iout  )

private

Definition at line 537 of file ArrayReaders.f90.

! ******************************************************************************
! Read three-dimensional real array, consisting of one or more 2d arrays with
! array control records.
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    integer(I4B), intent(in) :: iu
    integer(I4B), intent(in) :: iout
    integer(I4B), intent(in) :: ndim
    integer(I4B), intent(in) :: nvals
    real(DP), dimension(nvals, 1, 1), intent(inout) :: darr
    character(len=*), intent(in) :: aname
    ! -- local
! ------------------------------------------------------------------------------
    !
    call read_array_dbl1d(iu, darr, aname, ndim, nvals, iout, 0)
    !
    return

Here is the call graph for this function:

read_array_int1d()

subroutine arrayreadersmodule::readarray::read_array_int1d ( integer(i4b), intent(in)  iu, integer(i4b), dimension(jj), intent(inout)  iarr, character(len=*), intent(in)  aname, integer(i4b), intent(in)  ndim, integer(i4b), intent(in)  jj, integer(i4b), intent(in)  iout, integer(i4b), intent(in)  k  )

private

Definition at line 52 of file ArrayReaders.f90.

    ! -- dummy
    integer(I4B), intent(in) :: iu, iout
    integer(I4B), intent(in) :: jj
    integer(I4B), dimension(jj), intent(inout) :: iarr
    character(len=*), intent(in) :: aname
    integer(I4B), intent(in) :: ndim ! dis%ndim
    integer(I4B), intent(in) :: k ! layer number; 0 to not print
    ! -- local
    logical(LGP) :: isok
    integer(I4B) :: iclose, iconst, iprn, j, locat, ncpl, ndig
    integer(I4B) :: nval, nvalt
    logical :: prowcolnum
    character(len=100) :: prfmt
    integer(I4B) :: istat
    character(len=30) :: arrname
    character(len=MAXCHARLEN) :: ermsgr
    ! -- formats
2   format(/, 1x, a, ' = ', i0, ' FOR LAYER ', i0)
3   format(/, 1x, a, ' = ', i0)
    !
    ! -- Read array control record.
    call read_control_int(iu, iout, aname, locat, iconst, iclose, iprn)
    !
    ! -- Read or assign array data.
    if (locat == 0) then
      ! -- Assign constant
      do j = 1, jj
        iarr(j) = iconst
      end do
      if (iout > 0) then
        if (k > 0) then
          write (iout, 2) trim(aname), iconst, k
        else
          write (iout, 3) trim(aname), iconst
        end if
      end if
    elseif (locat > 0) then
      ! -- Read data as text
      read (locat, *, iostat=istat, iomsg=ermsgr) (iarr(j), j=1, jj)
      if (istat /= 0) then
        arrname = adjustl(aname)
        errmsg = "Error reading data for array '"//trim(arrname)// &
                 "'. "//trim(adjustl(ermsgr))
        call store_error(errmsg)
        call store_error_unit(locat)
      end if
      do j = 1, jj
        iarr(j) = iarr(j) * iconst
      end do
      if (iclose == 1) then
        close (locat)
      end if
    else
      ! -- Read data as binary
      locat = -locat
      nvalt = 0
      do
        call read_binary_header(locat, iout, aname, nval)
        isok = check_binary_size(nval, nvalt, size(iarr), aname, locat)
        if (isok .EQV. .false.) exit
        read (locat, iostat=istat, iomsg=ermsgr) &
          (iarr(j), j=nvalt + 1, nvalt + nval)
        if (istat /= 0) then
          arrname = adjustl(aname)
          errmsg = "Error reading data for array '"//trim(arrname)// &
                   "'. "//trim(adjustl(ermsgr))
          call store_error(errmsg)
          call store_error_unit(locat)
        end if
        nvalt = nvalt + nval
        if (nvalt == size(iarr)) exit
      end do
      !
      ! -- multiply array by constant
      do j = 1, jj
        iarr(j) = iarr(j) * iconst
      end do
      !
      ! -- close the file
      if (iclose == 1) then
        close (locat)
      end if
    end if
    !
    ! -- Print array if requested.
    if (iprn >= 0 .and. locat /= 0) then
      prowcolnum = (ndim == 3)
      call build_format_int(iprn, prfmt, prowcolnum, ncpl, ndig)
      call print_array_int(iarr, aname, iout, jj, 1, k, prfmt, ncpl, ndig, &
                           prowcolnum)
    end if
    !
    return

Here is the call graph for this function:

read_array_int1d_layered()

subroutine arrayreadersmodule::readarray::read_array_int1d_layered ( integer(i4b), intent(in)  iu, integer(i4b), dimension(nval), intent(inout)  iarr, character(len=*), intent(in)  aname, integer(i4b), intent(in)  ndim, integer(i4b), intent(in)  ncol, integer(i4b), intent(in)  nrow, integer(i4b), intent(in)  nlay, integer(i4b), intent(in)  nval, integer(i4b), intent(in)  iout, integer(i4b), intent(in)  k1, integer(i4b), intent(in)  k2  )

private

Definition at line 294 of file ArrayReaders.f90.

    ! -- dummy
    integer(I4B), intent(in) :: iu, iout
    integer(I4B), intent(in) :: ncol, nrow, nlay, nval
    integer(I4B), dimension(nval), intent(inout) :: iarr
    character(len=*), intent(in) :: aname
    integer(I4B), intent(in) :: ndim ! dis%ndim
    integer(I4B), intent(in) :: k1, k2
    ! -- local
    !
    call read_array_int3d(iu, iarr, aname, ndim, ncol, nrow, nlay, iout, k1, k2)
    !
    return

Here is the call graph for this function:

read_array_int2d()

subroutine arrayreadersmodule::readarray::read_array_int2d ( integer(i4b), intent(in)  iu, integer(i4b), dimension(jj, ii), intent(inout)  iarr, character(len=*), intent(in)  aname, integer(i4b), intent(in)  ndim, integer(i4b), intent(in)  jj, integer(i4b), intent(in)  ii, integer(i4b), intent(in)  iout, integer(i4b), intent(in)  k  )

private

Definition at line 148 of file ArrayReaders.f90.

    ! -- dummy
    integer(I4B), intent(in) :: iu, iout
    integer(I4B), intent(in) :: jj, ii
    integer(I4B), dimension(jj, ii), intent(inout) :: iarr
    character(len=*), intent(in) :: aname
    integer(I4B), intent(in) :: ndim ! dis%ndim
    integer(I4B), intent(in) :: k ! layer number; 0 to not print
    ! -- local
    logical(LGP) :: isok
    integer(I4B) :: i, iclose, iconst, iprn, j, locat, ncpl, ndig
    integer(I4B) :: nval
    logical :: prowcolnum
    character(len=100) :: prfmt
    integer(I4B) :: istat
    character(len=30) :: arrname
    character(len=MAXCHARLEN) :: ermsgr
    ! -- formats
2   format(/, 1x, a, ' = ', i0, ' FOR LAYER ', i0)
3   format(/, 1x, a, ' = ', i0)
    !
    ! -- Read array control record.
    call read_control_int(iu, iout, aname, locat, iconst, iclose, iprn)
    !
    ! -- Read or assign array data.
    if (locat == 0) then
      ! -- Assign constant
      do i = 1, ii
        do j = 1, jj
          iarr(j, i) = iconst
        end do
      end do
      if (iout > 0) then
        if (k > 0) then
          write (iout, 2) trim(aname), iconst, k
        else
          write (iout, 3) trim(aname), iconst
        end if
      end if
    elseif (locat > 0) then
      ! -- Read data as text
      do i = 1, ii
        read (locat, *, iostat=istat, iomsg=ermsgr) (iarr(j, i), j=1, jj)
        if (istat /= 0) then
          arrname = adjustl(aname)
          errmsg = "Error reading data for array '"//trim(arrname)// &
                   "'. "//trim(adjustl(ermsgr))
          call store_error(errmsg)
          call store_error_unit(locat)
        end if
        do j = 1, jj
          iarr(j, i) = iarr(j, i) * iconst
        end do
      end do
      if (iclose == 1) then
        close (locat)
      end if
    else
      ! -- Read data as binary
      locat = -locat
      call read_binary_header(locat, iout, aname, nval)
      isok = check_binary_size(nval, 0, size(iarr), aname, locat)
      if (isok) then
        do i = 1, ii
          read (locat, iostat=istat, iomsg=ermsgr) (iarr(j, i), j=1, jj)
          if (istat /= 0) then
            arrname = adjustl(aname)
            errmsg = "Error reading data for array '"//trim(arrname)// &
                     "'. "//trim(adjustl(ermsgr))
            call store_error(errmsg)
            call store_error_unit(locat)
          end if
          do j = 1, jj
            iarr(j, i) = iarr(j, i) * iconst
          end do
        end do
      end if
      if (iclose == 1) then
        close (locat)
      end if
    end if
    !
    ! -- Print array if requested.
    if (iprn >= 0 .and. locat /= 0) then
      prowcolnum = (ndim == 3)
      call build_format_int(iprn, prfmt, prowcolnum, ncpl, ndig)
      call print_array_int(iarr, aname, iout, jj, ii, k, prfmt, ncpl, &
                           ndig, prowcolnum)
    end if
    !
    return

Here is the call graph for this function:

read_array_int3d()

subroutine arrayreadersmodule::readarray::read_array_int3d ( integer(i4b), intent(in)  iu, integer(i4b), dimension(ncol, nrow, nlay), intent(inout)  iarr, character(len=*), intent(in)  aname, integer(i4b), intent(in)  ndim, integer(i4b), intent(in)  ncol, integer(i4b), intent(in)  nrow, integer(i4b), intent(in)  nlay, integer(i4b), intent(in)  iout, integer(i4b), intent(in)  k1, integer(i4b), intent(in)  k2  )

private

Definition at line 241 of file ArrayReaders.f90.

! ******************************************************************************
! Read three-dimensional integer array, consisting of one or more 2d arrays with
! array control records.
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    integer(I4B), intent(in) :: iu
    integer(I4B), intent(in) :: iout
    integer(I4B), intent(in) :: ndim
    integer(I4B), intent(in) :: ncol
    integer(I4B), intent(in) :: nrow
    integer(I4B), intent(in) :: nlay
    integer(I4B), intent(in) :: k1, k2
    integer(I4B), dimension(ncol, nrow, nlay), intent(inout) :: iarr
    character(len=*), intent(in) :: aname
    ! -- local
    integer(I4B) :: k, kk
! ------------------------------------------------------------------------------
    do k = k1, k2
      if (k <= 0) then
        kk = 1
      else
        kk = k
      end if
      call read_array_int2d(iu, iarr(:, :, kk), aname, ndim, ncol, nrow, iout, k)
    end do
    return

Here is the call graph for this function:

read_array_int3d_all()

subroutine arrayreadersmodule::readarray::read_array_int3d_all ( integer(i4b), intent(in)  iu, integer(i4b), dimension(nvals, 1, 1), intent(inout)  iarr, character(len=*), intent(in)  aname, integer(i4b), intent(in)  ndim, integer(i4b), intent(in)  nvals, integer(i4b), intent(in)  iout  )

private

Definition at line 273 of file ArrayReaders.f90.

! ******************************************************************************
! Read three-dimensional integer array, all at once.
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    integer(I4B), intent(in) :: iu
    integer(I4B), intent(in) :: iout
    integer(I4B), intent(in) :: ndim
    integer(I4B), intent(in) :: nvals
    integer(I4B), dimension(nvals, 1, 1), intent(inout) :: iarr
    character(len=*), intent(in) :: aname
    ! -- local
! ------------------------------------------------------------------------------
    !
    call read_array_int1d(iu, iarr, aname, ndim, nvals, iout, 0)
    !
    return

Here is the call graph for this function:

---

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

• /home/runner/work/modflow6/modflow6/src/Utilities/ArrayReaders.f90