gridfilereadermodule Module Reference

Data Types
type	gridfilereadertype

Functions/Subroutines
subroutine	initialize (this, iu)
	@Brief Initialize the grid file reader. More...
subroutine	finalize (this)
	Finalize the grid file reader. More...
subroutine	read_header (this)
	Read the file's self-describing header. Internal use only. More...
subroutine	read_header_meta (this)
	Read self-describing metadata (first four lines). Internal use only. More...
subroutine	read_header_body (this)
	Read the header body section (text following first. More...
integer(i4b) function	read_int (this, key)
	Read an integer scalar from a grid file. More...
real(dp) function	read_dbl (this, key)
	Read a double precision scalar from a grid file. More...
integer(i4b) function, dimension(:), allocatable	read_int_1d (this, key)
	Read a 1D integer array from a grid file. More...
subroutine	read_int_1d_into (this, key, v)
	Read a 1D integer array into a preallocated array. More...
real(dp) function, dimension(:), allocatable	read_dbl_1d (this, key)
	Read a 1D double array from a grid file. More...
subroutine	read_dbl_1d_into (this, key, v)
	Read a 1D double array into a preallocated array. More...
character(len=:) function, allocatable	read_charstr (this, key)
	Read a character string from a grid file. More...
subroutine	read_charstr_into (this, key, charstr)
	Read a character string into a preallocated string. More...
integer(i4b) function, dimension(:), allocatable	read_grid_shape (this)
	Read the grid shape from a grid file. More...
logical(lgp) function, allocatable	has_variable (this, key)

Function/Subroutine Documentation

finalize()

subroutine gridfilereadermodule::finalize

(

class(gridfilereadertype)

this

)

Definition at line 70 of file GridFileReader.f90.

    class(GridFileReaderType) :: this
 
    close (this%inunit)
    call hash_table_da(this%dim)
    call hash_table_da(this%pos)
    call hash_table_da(this%typ)
    call hash_table_da(this%shp_idx)
    deallocate (this%shp)
 

Here is the call graph for this function:

has_variable()

logical(lgp) function, allocatable gridfilereadermodule::has_variable	(	class(gridfilereadertype)	this,
		character(len=*), intent(in)	key
	)

Definition at line 514 of file GridFileReader.f90.

    class(GridFileReaderType) :: this
    character(len=*), intent(in) :: key
    logical(LGP), allocatable :: has
 
    has = this%dim%get(key) /= 0

initialize()

subroutine gridfilereadermodule::initialize	(	class(gridfilereadertype)	this,
		integer(i4b), intent(in)	iu
	)

Definition at line 55 of file GridFileReader.f90.

    class(GridFileReaderType) :: this
    integer(I4B), intent(in) :: iu
 
    this%inunit = iu
    call hash_table_cr(this%dim)
    call hash_table_cr(this%pos)
    call hash_table_cr(this%typ)
    call hash_table_cr(this%shp_idx)
    allocate (this%shp(0))
    call this%read_header()
 

Here is the call graph for this function:

read_charstr()

character(len=:) function, allocatable gridfilereadermodule::read_charstr	(	class(gridfilereadertype), intent(inout)	this,
		character(len=*), intent(in)	key
	)

Allocates and returns a new character string containing the data.

Definition at line 415 of file GridFileReader.f90.

    class(GridFileReaderType), intent(inout) :: this
    character(len=*), intent(in) :: key
    character(len=:), allocatable :: charstr
    ! local
    integer(I4B) :: idx, ndim, nvals, pos, typ
    character(len=:), allocatable :: msg
 
    msg = 'Variable '//trim(key)//' is not a character array'
    ndim = this%dim%get(key)
    if (ndim /= 1) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    typ = this%typ%get(key)
    if (typ /= 3) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    idx = this%shp_idx%get(key)
    pos = this%pos%get(key)
    nvals = this%shp(idx)
    allocate (character(nvals) :: charstr)
    read (this%inunit, pos=pos) charstr
    rewind(this%inunit)

Here is the call graph for this function:

read_charstr_into()

subroutine gridfilereadermodule::read_charstr_into	(	class(gridfilereadertype), intent(inout)	this,
		character(len=*), intent(in)	key,
		character(len=:), intent(inout), allocatable	charstr
	)

Populates a preallocated character string. If the string is not allocated or is the wrong length, it will be (re)allocated to the correct length.

Definition at line 446 of file GridFileReader.f90.

    class(GridFileReaderType), intent(inout) :: this
    character(len=*), intent(in) :: key
    character(len=:), allocatable, intent(inout) :: charstr
    ! local
    integer(I4B) :: idx, ndim, nvals, pos, typ
    character(len=:), allocatable :: msg
 
    msg = 'Variable '//trim(key)//' is not a character array'
    ndim = this%dim%get(key)
    if (ndim /= 1) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    typ = this%typ%get(key)
    if (typ /= 3) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    idx = this%shp_idx%get(key)
    pos = this%pos%get(key)
    nvals = this%shp(idx)
    ! reallocate if not allocated or wrong length
    if (allocated(charstr)) then
      if (len(charstr) /= nvals) then
        deallocate (charstr)
        allocate (character(nvals) :: charstr)
      end if
    else
      allocate (character(nvals) :: charstr)
    end if
    read (this%inunit, pos=pos) charstr
    rewind(this%inunit)

Here is the call graph for this function:

read_dbl()

real(dp) function gridfilereadermodule::read_dbl	(	class(gridfilereadertype), intent(inout)	this,
		character(len=*), intent(in)	key
	)

Definition at line 247 of file GridFileReader.f90.

    class(GridFileReaderType), intent(inout) :: this
    character(len=*), intent(in) :: key
    real(DP) :: v
    ! local
    integer(I4B) :: ndim, pos, typ
    character(len=:), allocatable :: msg
 
    msg = 'Variable '//trim(key)//' is not a double precision scalar'
    ndim = this%dim%get(key)
    if (ndim /= 0) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    typ = this%typ%get(key)
    if (typ /= 2) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    pos = this%pos%get(key)
    read (this%inunit, pos=pos) v
    rewind(this%inunit)
 

Here is the call graph for this function:

read_dbl_1d()

real(dp) function, dimension(:), allocatable gridfilereadermodule::read_dbl_1d	(	class(gridfilereadertype), intent(inout)	this,
		character(len=*), intent(in)	key
	)

Allocates and returns a new array containing the data.

Definition at line 345 of file GridFileReader.f90.

    class(GridFileReaderType), intent(inout) :: this
    character(len=*), intent(in) :: key
    real(DP), allocatable :: v(:)
    ! local
    integer(I4B) :: idx, ndim, nvals, pos, typ
    character(len=:), allocatable :: msg
 
    msg = 'Variable '//trim(key)//' is not a 1D double array'
    ndim = this%dim%get(key)
    if (ndim /= 1) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    typ = this%typ%get(key)
    if (typ /= 2) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    idx = this%shp_idx%get(key)
    pos = this%pos%get(key)
    nvals = this%shp(idx)
    allocate (v(nvals))
    read (this%inunit, pos=pos) v
    rewind(this%inunit)
 

Here is the call graph for this function:

read_dbl_1d_into()

subroutine gridfilereadermodule::read_dbl_1d_into	(	class(gridfilereadertype), intent(inout)	this,
		character(len=*), intent(in)	key,
		real(dp), dimension(:), intent(inout)	v
	)

Populates a preallocated array. Array must already be allocated to the correct size. This version is compatible with both allocatable arrays and memory-manager-allocated pointer targets.

Definition at line 378 of file GridFileReader.f90.

    class(GridFileReaderType), intent(inout) :: this
    character(len=*), intent(in) :: key
    real(DP), dimension(:), intent(inout) :: v
    ! local
    integer(I4B) :: idx, ndim, nvals, pos, typ
    character(len=:), allocatable :: msg
 
    msg = 'Variable '//trim(key)//' is not a 1D double array'
    ndim = this%dim%get(key)
    if (ndim /= 1) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    typ = this%typ%get(key)
    if (typ /= 2) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    idx = this%shp_idx%get(key)
    pos = this%pos%get(key)
    nvals = this%shp(idx)
    ! verify array is correct size
    if (size(v) /= nvals) then
      write (errmsg, '(a,i0,a,i0)') &
        'Array size mismatch for '//trim(key)//': expected ', &
        nvals, ', got ', size(v)
      call store_error(errmsg, terminate=.true.)
    end if
    read (this%inunit, pos=pos) v
    rewind(this%inunit)
 

Here is the call graph for this function:

read_grid_shape()

integer(i4b) function, dimension(:), allocatable gridfilereadermodule::read_grid_shape

(

class(gridfilereadertype)

this

)

Definition at line 482 of file GridFileReader.f90.

    ! dummy
    class(GridFileReaderType) :: this
    integer(I4B), allocatable :: v(:)
 
    select case (this%grid_type)
    case ("DIS")
      allocate (v(3))
      v(1) = this%read_int("NLAY")
      v(2) = this%read_int("NROW")
      v(3) = this%read_int("NCOL")
    case ("DISV")
      allocate (v(2))
      v(1) = this%read_int("NLAY")
      v(2) = this%read_int("NCPL")
    case ("DISU")
      allocate (v(1))
      v(1) = this%read_int("NODES")
    case ("DIS2D")
      allocate (v(2))
      v(1) = this%read_int("NROW")
      v(2) = this%read_int("NCOL")
    case ("DISV2D")
      allocate (v(1))
      v(1) = this%read_int("NODES")
    case ("DISV1D")
      allocate (v(1))
      v(1) = this%read_int("NCELLS")
    end select
 

read_header()

subroutine gridfilereadermodule::read_header

(

class(gridfilereadertype)

this

)

Definition at line 83 of file GridFileReader.f90.

    class(GridFileReaderType) :: this
    call this%read_header_meta()
    call this%read_header_body()

read_header_body()

subroutine gridfilereadermodule::read_header_body

(

class(gridfilereadertype)

this

)

Definition at line 136 of file GridFileReader.f90.

    ! dummy
    class(GridFileReaderType) :: this
    ! local
    character(len=:), allocatable :: body
    character(len=:), allocatable :: line
    character(len=10) :: key, dtype
    real(DP) :: rval
    integer(I4B) :: i, lloc, istart, istop, ival, pos
    integer(I4B) :: nvars, ndim, dim, ishp
    integer(I4B), allocatable :: shp(:)
 
    allocate (this%keys(this%ntxt))
    allocate (character(len=this%lentxt*this%ntxt) :: body)
    allocate (character(len=this%lentxt) :: line)
 
    nvars = 0
    read (this%inunit) body
    inquire (this%inunit, pos=pos)
    do i = 1, this%lentxt * this%ntxt, this%lentxt
      line = body(i:i + this%lentxt - 1)
      lloc = 1
 
      ! key
      lloc = 1
      call urword(line, lloc, istart, istop, 1, ival, rval, 0, 0)
      key = line(istart:istop)
      nvars = nvars + 1
      this%keys(nvars) = key
 
      ! type
      call urword(line, lloc, istart, istop, 1, ival, rval, 0, 0)
      dtype = line(istart:istop)
      if (dtype == "INTEGER") then
        call this%typ%add(key, 1)
      else if (dtype == "DOUBLE") then
        call this%typ%add(key, 2)
      else if (dtype == "CHARACTER") then
        call this%typ%add(key, 3)
      end if
 
      ! dims
      call urword(line, lloc, istart, istop, 0, ival, rval, 0, 0)
      call urword(line, lloc, istart, istop, 2, ival, rval, 0, 0)
      ndim = ival
      call this%dim%add(key, ndim)
 
      ! shape
      if (allocated(shp)) deallocate (shp)
      allocate (shp(ndim))
      if (ndim > 0) then
        do dim = 1, ndim
          call urword(line, lloc, istart, istop, 2, ival, rval, 0, 0)
          shp(dim) = ival
        end do
        ishp = size(this%shp)
        call expandarray(this%shp, increment=ndim)
        this%shp(ishp + 1:ishp + ndim) = shp
        call this%shp_idx%add(key, ishp + 1)
      end if
 
      ! position
      call this%pos%add(key, pos)
      if (ndim == 0) then
        if (dtype == "INTEGER") then
          pos = pos + 4
        else if (dtype == "DOUBLE") then
          pos = pos + 8
        end if
      else
        if (dtype == "INTEGER") then
          pos = pos + (product(shp) * 4)
        else if (dtype == "DOUBLE") then
          pos = pos + (product(shp) * 8)
        else if (dtype == "CHARACTER") then
          pos = pos + (product(shp) * 8)
        end if
      end if
    end do
 
    rewind(this%inunit)
 

Here is the call graph for this function:

read_header_meta()

subroutine gridfilereadermodule::read_header_meta

(

class(gridfilereadertype)

this

)

Definition at line 90 of file GridFileReader.f90.

    ! dummy
    class(GridFileReaderType) :: this
    ! local
    character(len=50) :: line
    integer(I4B) :: lloc, istart, istop
    integer(I4B) :: ival
    real(DP) :: rval
 
    ! grid type
    read (this%inunit) line
    lloc = 1
    call urword(line, lloc, istart, istop, 1, ival, rval, 0, 0)
    if (line(istart:istop) /= 'GRID') then
      call store_error('Binary grid file must begin with "GRID". '//&
                       &'Found: '//line(istart:istop))
      call store_error_unit(this%inunit)
    end if
    call urword(line, lloc, istart, istop, 1, ival, rval, 0, 0)
    this%grid_type = line(istart:istop)
 
    ! version
    read (this%inunit) line
    lloc = 1
    call urword(line, lloc, istart, istop, 0, ival, rval, 0, 0)
    call urword(line, lloc, istart, istop, 2, ival, rval, 0, 0)
    this%version = ival
 
    ! ntxt
    read (this%inunit) line
    lloc = 1
    call urword(line, lloc, istart, istop, 0, ival, rval, 0, 0)
    call urword(line, lloc, istart, istop, 2, ival, rval, 0, 0)
    this%ntxt = ival
 
    ! lentxt
    read (this%inunit) line
    lloc = 1
    call urword(line, lloc, istart, istop, 0, ival, rval, 0, 0)
    call urword(line, lloc, istart, istop, 2, ival, rval, 0, 0)
    this%lentxt = ival
 

Here is the call graph for this function:

read_int()

integer(i4b) function gridfilereadermodule::read_int	(	class(gridfilereadertype), intent(inout)	this,
		character(len=*), intent(in)	key
	)

Definition at line 221 of file GridFileReader.f90.

    class(GridFileReaderType), intent(inout) :: this
    character(len=*), intent(in) :: key
    integer(I4B) :: v
    ! local
    integer(I4B) :: ndim, pos, typ
    character(len=:), allocatable :: msg
 
    msg = 'Variable '//trim(key)//' is not an integer scalar'
    ndim = this%dim%get(key)
    if (ndim /= 0) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    typ = this%typ%get(key)
    if (typ /= 1) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    pos = this%pos%get(key)
    read (this%inunit, pos=pos) v
    rewind(this%inunit)
 

Here is the call graph for this function:

read_int_1d()

integer(i4b) function, dimension(:), allocatable gridfilereadermodule::read_int_1d	(	class(gridfilereadertype), intent(inout)	this,
		character(len=*), intent(in)	key
	)

Allocates and returns a new array containing the data.

Definition at line 275 of file GridFileReader.f90.

    class(GridFileReaderType), intent(inout) :: this
    character(len=*), intent(in) :: key
    integer(I4B), allocatable :: v(:)
    ! local
    integer(I4B) :: idx, ndim, nvals, pos, typ
    character(len=:), allocatable :: msg
 
    msg = 'Variable '//trim(key)//' is not a 1D integer array'
    ndim = this%dim%get(key)
    if (ndim /= 1) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    typ = this%typ%get(key)
    if (typ /= 1) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    idx = this%shp_idx%get(key)
    pos = this%pos%get(key)
    nvals = this%shp(idx)
    allocate (v(nvals))
    read (this%inunit, pos=pos) v
    rewind(this%inunit)
 

Here is the call graph for this function:

read_int_1d_into()

subroutine gridfilereadermodule::read_int_1d_into	(	class(gridfilereadertype), intent(inout)	this,
		character(len=*), intent(in)	key,
		integer(i4b), dimension(:), intent(inout)	v
	)

Populates a preallocated array. Array must already be allocated to the correct size. This version is compatible with both allocatable arrays and memory-manager-allocated pointer targets.

Definition at line 308 of file GridFileReader.f90.

    class(GridFileReaderType), intent(inout) :: this
    character(len=*), intent(in) :: key
    integer(I4B), dimension(:), intent(inout) :: v
    ! local
    integer(I4B) :: idx, ndim, nvals, pos, typ
    character(len=:), allocatable :: msg
 
    msg = 'Variable '//trim(key)//' is not a 1D integer array'
    ndim = this%dim%get(key)
    if (ndim /= 1) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    typ = this%typ%get(key)
    if (typ /= 1) then
      write (errmsg, '(a)') msg
      call store_error(errmsg, terminate=.true.)
    end if
    idx = this%shp_idx%get(key)
    pos = this%pos%get(key)
    nvals = this%shp(idx)
    ! verify array is correct size
    if (size(v) /= nvals) then
      write (errmsg, '(a,i0,a,i0)') &
        'Array size mismatch for '//trim(key)//': expected ', &
        nvals, ', got ', size(v)
      call store_error(errmsg, terminate=.true.)
    end if
    read (this%inunit, pos=pos) v
    rewind(this%inunit)
 

Here is the call graph for this function: