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	lookup (this, name, ndim, typ, desc)
	Look up a variable and check its rank and type. More...

integer(i4b) function	read_int (this, name)
	Read an integer scalar from a grid file. More...

real(dp) function	read_dbl (this, name)
	Read a double precision scalar from a grid file. More...

integer(i4b) function, dimension(:), allocatable	read_int_1d (this, name)
	Read a 1D integer array from a grid file. More...

subroutine	read_int_1d_into (this, name, v)
	Read a 1D integer array into a preallocated array. More...

real(dp) function, dimension(:), allocatable	read_dbl_1d (this, name)
	Read a 1D double array from a grid file. More...

subroutine	read_dbl_1d_into (this, name, v)
	Read a 1D double array into a preallocated array. More...

character(len=:) function, allocatable	read_charstr (this, name)
	Read a character string from a grid file. More...

subroutine	read_charstr_into (this, name, 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	has_variable (this, name)
	Check whether the grid file contains a variable. More...

Variables
integer(i4b), parameter	typ_int = 1
	integer variable type More...

integer(i4b), parameter	typ_dbl = 2
	double precision variable type More...

integer(i4b), parameter	typ_chr = 3
	character variable type More...

Function/Subroutine Documentation

◆ finalize()

subroutine gridfilereadermodule::finalize ( class(gridfilereadertype) this )

Definition at line 73 of file GridFileReader.f90.

     class(GridFileReaderType) :: this
  
     close (this%inunit)
     call hash_table_da(this%idx)
     if (allocated(this%names)) deallocate (this%names)
     if (allocated(this%ndims)) deallocate (this%ndims)
     if (allocated(this%typs)) deallocate (this%typs)
     if (allocated(this%shp_start)) deallocate (this%shp_start)
     if (allocated(this%pos)) deallocate (this%pos)
     if (allocated(this%shp)) deallocate (this%shp)
  

Here is the call graph for this function:

◆ has_variable()

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

Definition at line 435 of file GridFileReader.f90.

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

◆ initialize()

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

Definition at line 61 of file GridFileReader.f90.

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

Here is the call graph for this function:

◆ lookup()

integer(i4b) function gridfilereadermodule::lookup	(	class(gridfilereadertype), intent(inout)	this,
		character(len=*), intent(in)	name,
		integer(i4b), intent(in)	ndim,
		integer(i4b), intent(in)	typ,
		character(len=*), intent(in)	desc
	)

Returns the variable's index. Terminates with an error if the variable does not exist or does not have the expected rank and type. Internal use only.

Parameters

[in]	ndim	expected number of dims
[in]	typ	expected type
[in]	desc	expected kind, for error messages

Definition at line 230 of file GridFileReader.f90.

     class(GridFileReaderType), intent(inout) :: this
     character(len=*), intent(in) :: name
     integer(I4B), intent(in) :: ndim !< expected number of dims
     integer(I4B), intent(in) :: typ !< expected type
     character(len=*), intent(in) :: desc !< expected kind, for error messages
     integer(I4B) :: ivar
  
     ivar = this%idx%get(name)
     if (ivar == 0) then
       write (errmsg, '(a)') 'Variable '//trim(name)//' not found'
       call store_error(errmsg, terminate=.true.)
     end if
     if (this%ndims(ivar) /= ndim .or. this%typs(ivar) /= typ) then
       write (errmsg, '(a)') 'Variable '//trim(name)//' is not '//desc
       call store_error(errmsg, terminate=.true.)
     end if

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)	name
	)

Allocates and returns a new character string containing the data.

Definition at line 365 of file GridFileReader.f90.

     class(GridFileReaderType), intent(inout) :: this
     character(len=*), intent(in) :: name
     character(len=:), allocatable :: charstr
     ! local
     integer(I4B) :: ivar, nvals
  
     ivar = this%lookup(name, 1, typ_chr, 'a character array')
     nvals = this%shp(this%shp_start(ivar))
     allocate (character(nvals) :: charstr)
     read (this%inunit, pos=this%pos(ivar)) charstr
     rewind(this%inunit)

◆ read_charstr_into()

subroutine gridfilereadermodule::read_charstr_into	(	class(gridfilereadertype), intent(inout)	this,
		character(len=*), intent(in)	name,
		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 384 of file GridFileReader.f90.

     class(GridFileReaderType), intent(inout) :: this
     character(len=*), intent(in) :: name
     character(len=:), allocatable, intent(inout) :: charstr
     ! local
     integer(I4B) :: ivar, nvals
  
     ivar = this%lookup(name, 1, typ_chr, 'a character array')
     nvals = this%shp(this%shp_start(ivar))
     if (allocated(charstr)) then
       if (len(charstr) /= nvals) deallocate (charstr)
     end if
     if (.not. allocated(charstr)) allocate (character(nvals) :: charstr)
     read (this%inunit, pos=this%pos(ivar)) charstr
     rewind(this%inunit)

◆ read_dbl()

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

Definition at line 263 of file GridFileReader.f90.

     class(GridFileReaderType), intent(inout) :: this
     character(len=*), intent(in) :: name
     real(DP) :: v
     ! local
     integer(I4B) :: ivar
  
     ivar = this%lookup(name, 0, typ_dbl, 'a double precision scalar')
     read (this%inunit, pos=this%pos(ivar)) v
     rewind(this%inunit)

◆ read_dbl_1d()

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

Allocates and returns a new array containing the data.

Definition at line 322 of file GridFileReader.f90.

     class(GridFileReaderType), intent(inout) :: this
     character(len=*), intent(in) :: name
     real(DP), allocatable :: v(:)
     ! local
     integer(I4B) :: ivar, nvals
  
     ivar = this%lookup(name, 1, typ_dbl, 'a 1D double array')
     nvals = this%shp(this%shp_start(ivar))
     allocate (v(nvals))
     read (this%inunit, pos=this%pos(ivar)) v
     rewind(this%inunit)

◆ read_dbl_1d_into()

subroutine gridfilereadermodule::read_dbl_1d_into	(	class(gridfilereadertype), intent(inout)	this,
		character(len=*), intent(in)	name,
		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 342 of file GridFileReader.f90.

     class(GridFileReaderType), intent(inout) :: this
     character(len=*), intent(in) :: name
     real(DP), dimension(:), intent(inout) :: v
     ! local
     integer(I4B) :: ivar, nvals
  
     ivar = this%lookup(name, 1, typ_dbl, 'a 1D double array')
     nvals = this%shp(this%shp_start(ivar))
     if (size(v) /= nvals) then
       write (errmsg, '(a,i0,a,i0)') &
         'Array size mismatch for '//trim(name)//': expected ', &
         nvals, ', got ', size(v)
       call store_error(errmsg, terminate=.true.)
     end if
     read (this%inunit, pos=this%pos(ivar)) 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 402 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 88 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 141 of file GridFileReader.f90.

     ! dummy
     class(GridFileReaderType) :: this
     ! local
     character(len=:), allocatable :: body
     character(len=:), allocatable :: line
     character(len=10) :: name, dtype
     real(DP) :: rval
     integer(I4B) :: i, lloc, istart, istop, ival
     integer(I4B) :: ivar, ndim, dim, ishp, nbytes
     integer(I8B) :: pos
  
     allocate (this%names(this%ntxt))
     allocate (this%ndims(this%ntxt))
     allocate (this%typs(this%ntxt))
     allocate (this%shp_start(this%ntxt))
     allocate (this%pos(this%ntxt))
     allocate (character(len=this%lentxt*this%ntxt) :: body)
     allocate (character(len=this%lentxt) :: line)
  
     read (this%inunit) body
     inquire (this%inunit, pos=pos)
     do ivar = 1, this%ntxt
       i = (ivar - 1) * this%lentxt + 1
       line = body(i:i + this%lentxt - 1)
  
       ! name
       lloc = 1
       call urword(line, lloc, istart, istop, 1, ival, rval, 0, 0)
       name = line(istart:istop)
       this%names(ivar) = name
       call this%idx%add(name, ivar)
  
       ! type
       call urword(line, lloc, istart, istop, 1, ival, rval, 0, 0)
       dtype = line(istart:istop)
       select case (dtype)
       case ("INTEGER")
         this%typs(ivar) = typ_int
         nbytes = 4
       case ("DOUBLE")
         this%typs(ivar) = typ_dbl
         nbytes = 8
       case ("CHARACTER")
         this%typs(ivar) = typ_chr
         nbytes = 1
       case default
         this%typs(ivar) = 0
         nbytes = 0
       end select
  
       ! 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
       this%ndims(ivar) = ndim
  
       ! shape
       this%shp_start(ivar) = 0
       if (ndim > 0) then
         ishp = size(this%shp)
         call expandarray(this%shp, increment=ndim)
         do dim = 1, ndim
           call urword(line, lloc, istart, istop, 2, ival, rval, 0, 0)
           this%shp(ishp + dim) = ival
         end do
         this%shp_start(ivar) = ishp + 1
       end if
  
       ! position
       this%pos(ivar) = pos
       if (ndim == 0) then
         pos = pos + nbytes
       else
         ishp = this%shp_start(ivar)
         pos = pos + product(int(this%shp(ishp:ishp + ndim - 1), i8b)) * nbytes
       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 95 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)	name
	)

Definition at line 250 of file GridFileReader.f90.

     class(GridFileReaderType), intent(inout) :: this
     character(len=*), intent(in) :: name
     integer(I4B) :: v
     ! local
     integer(I4B) :: ivar
  
     ivar = this%lookup(name, 0, typ_int, 'an integer scalar')
     read (this%inunit, pos=this%pos(ivar)) v
     rewind(this%inunit)

◆ read_int_1d()

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

Allocates and returns a new array containing the data.

Definition at line 279 of file GridFileReader.f90.

     class(GridFileReaderType), intent(inout) :: this
     character(len=*), intent(in) :: name
     integer(I4B), allocatable :: v(:)
     ! local
     integer(I4B) :: ivar, nvals
  
     ivar = this%lookup(name, 1, typ_int, 'a 1D integer array')
     nvals = this%shp(this%shp_start(ivar))
     allocate (v(nvals))
     read (this%inunit, pos=this%pos(ivar)) v
     rewind(this%inunit)

◆ read_int_1d_into()

subroutine gridfilereadermodule::read_int_1d_into	(	class(gridfilereadertype), intent(inout)	this,
		character(len=*), intent(in)	name,
		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 299 of file GridFileReader.f90.

     class(GridFileReaderType), intent(inout) :: this
     character(len=*), intent(in) :: name
     integer(I4B), dimension(:), intent(inout) :: v
     ! local
     integer(I4B) :: ivar, nvals
  
     ivar = this%lookup(name, 1, typ_int, 'a 1D integer array')
     nvals = this%shp(this%shp_start(ivar))
     if (size(v) /= nvals) then
       write (errmsg, '(a,i0,a,i0)') &
         'Array size mismatch for '//trim(name)//': expected ', &
         nvals, ', got ', size(v)
       call store_error(errmsg, terminate=.true.)
     end if
     read (this%inunit, pos=this%pos(ivar)) v
     rewind(this%inunit)

Here is the call graph for this function:

Variable Documentation

◆ typ_chr

integer(i4b), parameter gridfilereadermodule::typ_chr = 3

Definition at line 17 of file GridFileReader.f90.

17 integer(I4B), parameter :: TYP_CHR = 3 !< character variable type

◆ typ_dbl

integer(i4b), parameter gridfilereadermodule::typ_dbl = 2

Definition at line 16 of file GridFileReader.f90.

16 integer(I4B), parameter :: TYP_DBL = 2 !< double precision variable type

◆ typ_int

integer(i4b), parameter gridfilereadermodule::typ_int = 1

Definition at line 15 of file GridFileReader.f90.

15 integer(I4B), parameter :: TYP_INT = 1 !< integer variable type

Data Types

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ finalize()

◆ has_variable()

◆ initialize()

◆ lookup()

◆ read_charstr()

◆ read_charstr_into()

◆ read_dbl()

◆ read_dbl_1d()

◆ read_dbl_1d_into()

◆ read_grid_shape()

◆ read_header()

◆ read_header_body()

◆ read_header_meta()

◆ read_int()

◆ read_int_1d()

◆ read_int_1d_into()

Variable Documentation

◆ typ_chr

◆ typ_dbl

◆ typ_int