Functions/Subroutines
subroutine, public	openfile (iu, iout, fname, ftype, fmtarg_opt, accarg_opt, filstat_opt, mode_opt)
	Open a file. More...

subroutine	freeunitnumber (iu)
	Assign a free unopened unit number. More...

integer(i4b) function, public	getunit ()
	Get a free unit number. More...

subroutine, public	assign_iounit (iounit, errunit, description)
	@ brief assign io unit number More...

subroutine, public	upcase (word)
	Convert to upper case. More...

subroutine, public	lowcase (word)
	Convert to lower case. More...

subroutine, public	append_processor_id (name, proc_id)
	Append processor id to a string. More...

subroutine, public	uwword (line, icol, ilen, ncode, c, n, r, fmt, alignment, sep)
	Create a formatted line. More...

subroutine, public	urword (line, icol, istart, istop, ncode, n, r, iout, in)
	Extract a word from a string. More...

subroutine, public	ulstlb (iout, label, caux, ncaux, naux)
	Print a label for a list. More...

subroutine, public	ubdsv4 (kstp, kper, text, naux, auxtxt, ibdchn, ncol, nrow, nlay, nlist, iout, delt, pertim, totim)
	Write header records for cell-by-cell flow terms for one component of flow plus auxiliary data using a list structure. More...

subroutine, public	ubdsvb (ibdchn, icrl, q, val, nvl, naux, laux)
	Write one value of cell-by-cell flow plus auxiliary data using a list structure. More...

subroutine, public	ucolno (nlbl1, nlbl2, nspace, ncpl, ndig, iout)
	Output column numbers above a matrix printout. More...

subroutine, public	ulaprw (buf, text, kstp, kper, ncol, nrow, ilay, iprn, iout)
	Print 1 layer array. More...

subroutine, public	ulasav (buf, text, kstp, kper, pertim, totim, ncol, nrow, ilay, ichn)
	Save 1 layer array on disk. More...

subroutine, public	ubdsv1 (kstp, kper, text, ibdchn, buff, ncol, nrow, nlay, iout, delt, pertim, totim)
	Record cell-by-cell flow terms for one component of flow as a 3-D array with extra record to indicate delt, pertim, and totim. More...

subroutine, public	ubdsv06 (kstp, kper, text, modelnam1, paknam1, modelnam2, paknam2, ibdchn, naux, auxtxt, ncol, nrow, nlay, nlist, iout, delt, pertim, totim)
	Write header records for cell-by-cell flow terms for one component of flow. More...

subroutine, public	ubdsvc (ibdchn, n, q, naux, aux)
	Write one value of cell-by-cell flow using a list structure. More...

subroutine, public	ubdsvd (ibdchn, n, n2, q, naux, aux)
	Write one value of cell-by-cell flow using a list structure. More...

logical function, public	same_word (word1, word2)
	Perform a case-insensitive comparison of two words. More...

character(len=max(len_trim(str), width)) function, public	str_pad_left (str, width)
	Function for string manipulation. More...

subroutine, public	unitinquire (iu)

subroutine, public	parseline (line, nwords, words, inunit, filename)
	Parse a line into words. More...

subroutine, public	ulaprufw (ncol, nrow, kstp, kper, ilay, iout, buf, text, userfmt, nvalues, nwidth, editdesc)
	Print 1 layer array with user formatting in wrap format. More...

character(len=:) function, allocatable, public	read_line (iu, eof)
	This function reads a line of arbitrary length and returns it. More...

subroutine, public	getfilefrompath (pathname, filename)

subroutine, public	extract_idnum_or_bndname (line, icol, istart, istop, idnum, bndname)
	Starting at position icol, define string as line(istart:istop). More...

subroutine, public	urdaux (naux, inunit, iout, lloc, istart, istop, auxname, line, text)
	Read auxiliary variables from an input line. More...

subroutine, public	print_format (linein, cdatafmp, editdesc, nvaluesp, nwidthp, inunit)
	Define the print or save format. More...

subroutine, public	buildfixedformat (nvalsp, nwidp, ndig, outfmt, prowcolnum)
	Build a fixed format for printing or saving a real array. More...

subroutine, public	buildfloatformat (nvalsp, nwidp, ndig, editdesc, outfmt, prowcolnum)
	Build a floating-point format for printing or saving a real array. More...

subroutine, public	buildintformat (nvalsp, nwidp, outfmt, prowcolnum)
	Build a format for printing or saving an integer array. More...

integer(i4b) function, public	get_nwords (line)
	Get the number of words in a string. More...

subroutine, public	fseek_stream (iu, offset, whence, status)
	Move the file pointer. More...

subroutine, public	u9rdcom (iin, iout, line, ierr)
	Read until non-comment line found and then return line. More...

subroutine	get_line (lun, line, iostat)
	Read an unlimited length line from unit number lun into a deferred- length character string (line). More...

Function/Subroutine Documentation

◆ append_processor_id()

subroutine, public inputoutputmodule::append_processor_id	(	character(len=linelength), intent(inout)	name,
		integer(i4b), intent(in)	proc_id
	)

Subroutine to append the processor id to a string before the file extension (extension is the string after the last '.' in the string. If there is no '.' in the string the processor id is appended to the end of the string.

Parameters

[in,out]	name	file name
[in]	proc_id	processor id

Definition at line 250 of file InputOutput.f90.

     ! -- dummy
     character(len=LINELENGTH), intent(inout) :: name !< file name
     integer(I4B), intent(in) :: proc_id !< processor id
     ! -- local
     character(len=LINELENGTH) :: name_local
     character(len=LINELENGTH) :: name_processor
     character(len=LINELENGTH) :: extension_local
     integer(I4B) :: ipos0
     integer(I4B) :: ipos1
     !
     name_local = name
     call lowcase(name_local)
     ipos0 = index(name_local, ".", back=.true.)
     ipos1 = len_trim(name)
     if (ipos0 > 0) then
       write (extension_local, '(a)') name(ipos0:ipos1)
     else
       ipos0 = ipos1
       extension_local = ''
     end if
     write (name_processor, '(a,a,i0,a)') &
       name(1:ipos0 - 1), '.p', proc_id, trim(adjustl(extension_local))
     name = name_processor

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assign_iounit()

subroutine, public inputoutputmodule::assign_iounit	(	integer(i4b), intent(inout)	iounit,
		integer(i4b), intent(in)	errunit,
		character(len=*), intent(in)	description
	)

Generic method to assign io unit number to unassigned integer variable (initialized less than or equal to 0). Assigns a valid number if unassigned, otherwise sets a terminating error.

Parameters

[in,out]	iounit	iounit variable
[in]	errunit	input file inunit for error assignment
[in]	description	usage description for iounit

Definition at line 184 of file InputOutput.f90.

     integer(I4B), intent(inout) :: iounit !< iounit variable
     integer(I4B), intent(in) :: errunit !< input file inunit for error assignment
     character(len=*), intent(in) :: description !< usage description for iounit
     if (iounit > 0) then
       write (errmsg, '(a,1x,i0)') &
         trim(description)//' already assigned at unit: ', iounit
       call store_error(errmsg)
       call store_error_unit(errunit)
     end if
     iounit = getunit()

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildfixedformat()

subroutine, public inputoutputmodule::buildfixedformat	(	integer(i4b), intent(in)	nvalsp,
		integer(i4b), intent(in)	nwidp,
		integer(i4b), intent(in)	ndig,
		character(len=*), intent(inout)	outfmt,
		logical, intent(in), optional	prowcolnum
	)

Definition at line 1524 of file InputOutput.f90.

     implicit none
     ! -- dummy
     integer(I4B), intent(in) :: nvalsp, nwidp, ndig
     character(len=*), intent(inout) :: outfmt
     logical, intent(in), optional :: prowcolnum ! default true
     ! -- local
     character(len=8) :: cvalues, cwidth, cdigits
     character(len=60) :: ufmt
     logical :: prowcolnumlocal
     ! -- formats
     character(len=*), parameter :: fmtndig = "(i8)"
     !
     if (present(prowcolnum)) then
       prowcolnumlocal = prowcolnum
     else
       prowcolnumlocal = .true.
     end if
     !
     ! -- Convert integers to characters and left-adjust
     write (cdigits, fmtndig) ndig
     cdigits = adjustl(cdigits)
     !
     ! -- Build format for printing to the list file in wrap format
     write (cvalues, fmtndig) nvalsp
     cvalues = adjustl(cvalues)
     write (cwidth, fmtndig) nwidp
     cwidth = adjustl(cwidth)
     if (prowcolnumlocal) then
       ufmt = '(1x,i3,1x,'
     else
       ufmt = '(5x,'
     end if
     !
     ufmt = trim(ufmt)//cvalues
     ufmt = trim(ufmt)//'(1x,f'
     ufmt = trim(ufmt)//cwidth
     ufmt = trim(ufmt)//'.'
     ufmt = trim(ufmt)//cdigits
     ufmt = trim(ufmt)//'):/(5x,'
     ufmt = trim(ufmt)//cvalues
     ufmt = trim(ufmt)//'(1x,f'
     ufmt = trim(ufmt)//cwidth
     ufmt = trim(ufmt)//'.'
     ufmt = trim(ufmt)//cdigits
     ufmt = trim(ufmt)//')))'
     outfmt = ufmt

Here is the caller graph for this function:

◆ buildfloatformat()

subroutine, public inputoutputmodule::buildfloatformat	(	integer(i4b), intent(in)	nvalsp,
		integer(i4b), intent(in)	nwidp,
		integer(i4b), intent(in)	ndig,
		character(len=*), intent(in)	editdesc,
		character(len=*), intent(inout)	outfmt,
		logical, intent(in), optional	prowcolnum
	)

Definition at line 1575 of file InputOutput.f90.

     implicit none
     ! -- dummy
     integer(I4B), intent(in) :: nvalsp, nwidp, ndig
     character(len=*), intent(in) :: editdesc
     character(len=*), intent(inout) :: outfmt
     logical, intent(in), optional :: prowcolnum ! default true
     ! -- local
     character(len=8) :: cvalues, cwidth, cdigits
     character(len=60) :: ufmt
     logical :: prowcolnumlocal
     ! -- formats
     character(len=*), parameter :: fmtndig = "(i8)"
     !
     if (present(prowcolnum)) then
       prowcolnumlocal = prowcolnum
     else
       prowcolnumlocal = .true.
     end if
     !
     ! -- Build the format
     write (cdigits, fmtndig) ndig
     cdigits = adjustl(cdigits)
     ! -- Convert integers to characters and left-adjust
     write (cwidth, fmtndig) nwidp
     cwidth = adjustl(cwidth)
     ! -- Build format for printing to the list file
     write (cvalues, fmtndig) (nvalsp - 1)
     cvalues = adjustl(cvalues)
     if (prowcolnumlocal) then
       ufmt = '(1x,i3,2x,1p,'//editdesc
     else
       ufmt = '(6x,1p,'//editdesc
     end if
     ufmt = trim(ufmt)//cwidth
     ufmt = trim(ufmt)//'.'
     ufmt = trim(ufmt)//cdigits
     if (nvalsp > 1) then
       ufmt = trim(ufmt)//','
       ufmt = trim(ufmt)//cvalues
       ufmt = trim(ufmt)//'(1x,'
       ufmt = trim(ufmt)//editdesc
       ufmt = trim(ufmt)//cwidth
       ufmt = trim(ufmt)//'.'
       ufmt = trim(ufmt)//cdigits
       ufmt = trim(ufmt)//')'
     end if
     !
     ufmt = trim(ufmt)//':/(5x,'
     write (cvalues, fmtndig) nvalsp
     cvalues = adjustl(cvalues)
     ufmt = trim(ufmt)//cvalues
     ufmt = trim(ufmt)//'(1x,'
     ufmt = trim(ufmt)//editdesc
     ufmt = trim(ufmt)//cwidth
     ufmt = trim(ufmt)//'.'
     ufmt = trim(ufmt)//cdigits
     ufmt = trim(ufmt)//')))'
     outfmt = ufmt

Here is the caller graph for this function:

◆ buildintformat()

subroutine, public inputoutputmodule::buildintformat	(	integer(i4b), intent(in)	nvalsp,
		integer(i4b), intent(in)	nwidp,
		character(len=*), intent(inout)	outfmt,
		logical, intent(in), optional	prowcolnum
	)

Definition at line 1638 of file InputOutput.f90.

     implicit none
     ! -- dummy
     integer(I4B), intent(in) :: nvalsp, nwidp
     character(len=*), intent(inout) :: outfmt
     logical, intent(in), optional :: prowcolnum ! default true
     ! -- local
     character(len=8) :: cvalues, cwidth
     character(len=60) :: ufmt
     logical :: prowcolnumlocal
     ! -- formats
     character(len=*), parameter :: fmtndig = "(i8)"
     !
     if (present(prowcolnum)) then
       prowcolnumlocal = prowcolnum
     else
       prowcolnumlocal = .true.
     end if
     !
     ! -- Build format for printing to the list file in wrap format
     write (cvalues, fmtndig) nvalsp
     cvalues = adjustl(cvalues)
     write (cwidth, fmtndig) nwidp
     cwidth = adjustl(cwidth)
     if (prowcolnumlocal) then
       ufmt = '(1x,i3,1x,'
     else
       ufmt = '(5x,'
     end if
     ufmt = trim(ufmt)//cvalues
     ufmt = trim(ufmt)//'(1x,i'
     ufmt = trim(ufmt)//cwidth
     ufmt = trim(ufmt)//'):/(5x,'
     ufmt = trim(ufmt)//cvalues
     ufmt = trim(ufmt)//'(1x,i'
     ufmt = trim(ufmt)//cwidth
     ufmt = trim(ufmt)//')))'
     outfmt = ufmt

Here is the caller graph for this function:

◆ extract_idnum_or_bndname()

subroutine, public inputoutputmodule::extract_idnum_or_bndname	(	character(len=*), intent(inout)	line,
		integer(i4b), intent(inout)	icol,
		integer(i4b), intent(inout)	istart,
		integer(i4b), intent(inout)	istop,
		integer(i4b), intent(out)	idnum,
		character(len=lenboundname), intent(out)	bndname
	)

If string can be interpreted as an integer(I4B), return integer in idnum argument. If token is not an integer(I4B), assume it is a boundary name, return NAMEDBOUNDFLAG in idnum, convert string to uppercase and return it in bndname.

Definition at line 1310 of file InputOutput.f90.

     implicit none
     ! -- dummy
     character(len=*), intent(inout) :: line
     integer(I4B), intent(inout) :: icol, istart, istop
     integer(I4B), intent(out) :: idnum
     character(len=LENBOUNDNAME), intent(out) :: bndname
     ! -- local
     integer(I4B) :: istat, ndum, ncode = 0
     real(DP) :: rdum
     !
     call urword(line, icol, istart, istop, ncode, ndum, rdum, 0, 0)
     read (line(istart:istop), *, iostat=istat) ndum
     if (istat == 0) then
       idnum = ndum
       bndname = ''
     else
       idnum = namedboundflag
       bndname = line(istart:istop)
       call upcase(bndname)
     end if

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freeunitnumber()

subroutine inputoutputmodule::freeunitnumber ( integer(i4b), intent(inout) iu )

Subroutine to assign a free unopened unit number to the iu dummy argument

Parameters

[in,out] iu next free file unit number

Definition at line 144 of file InputOutput.f90.

     ! -- modules
     implicit none
     ! -- dummy
     integer(I4B), intent(inout) :: iu !< next free file unit number
     ! -- local
     integer(I4B) :: i
     logical :: opened
     !
     do i = iunext, iulast
       inquire (unit=i, opened=opened)
       if (.not. opened) exit
     end do
     iu = i
     iunext = iu + 1

Here is the caller graph for this function:

◆ fseek_stream()

subroutine, public inputoutputmodule::fseek_stream	(	integer(i4b), intent(in)	iu,
		integer(i4b), intent(in)	offset,
		integer(i4b), intent(in)	whence,
		integer(i4b), intent(inout)	status
	)

Patterned after fseek, which is not supported as part of the fortran standard. For this subroutine to work the file must have been opened with access='stream' and action='readwrite'.

Definition at line 1712 of file InputOutput.f90.

     ! -- dummy
     integer(I4B), intent(in) :: iu
     integer(I4B), intent(in) :: offset
     integer(I4B), intent(in) :: whence
     integer(I4B), intent(inout) :: status
     ! -- local
     integer(I8B) :: ipos
     character(len=20) :: file_action
     !
     inquire (unit=iu, size=ipos)
     !
     select case (whence)
     case (0)
       !
       ! -- whence = 0, offset is relative to start of file
       ipos = 0 + offset
     case (1)
       !
       ! -- whence = 1, offset is relative to current pointer position
       inquire (unit=iu, pos=ipos)
       ipos = ipos + offset
     case (2)
       !
       ! -- whence = 2, offset is relative to end of file
       inquire (unit=iu, size=ipos)
       ipos = ipos + offset
     end select
     !
     ! -- position the file pointer to ipos using read or write depending
     !    on the file action, since write fails on read-only files and
     !    read fails on write-only files
     inquire (unit=iu, action=file_action)
     if (trim(file_action) == 'READ') then
       read (iu, pos=ipos, iostat=status)
     else
       write (iu, pos=ipos, iostat=status)
     end if
     inquire (unit=iu, pos=ipos)

Here is the caller graph for this function:

◆ get_line()

subroutine inputoutputmodule::get_line	(	integer(i4b), intent(in)	lun,
		character(len=:), intent(out), allocatable	line,
		integer(i4b), intent(out)	iostat
	)

private

Tack on a single space to the end so that routines like URWORD continue to function as before.

Definition at line 1856 of file InputOutput.f90.

     ! -- dummy
     integer(I4B), intent(in) :: lun
     character(len=:), intent(out), allocatable :: line
     integer(I4B), intent(out) :: iostat
     ! -- local
     integer(I4B), parameter :: buffer_len = maxcharlen
     character(len=buffer_len) :: buffer
     character(len=:), allocatable :: linetemp
     integer(I4B) :: size_read, linesize
     character(len=1), parameter :: cr = char(13)
     character(len=1), parameter :: lf = char(10)
     !
     ! -- initialize
     line = ''
     linetemp = ''
     !
     ! -- process
     do
       read (lun, '(A)', iostat=iostat, advance='no', size=size_read) buffer
       if (is_iostat_eor(iostat)) then
         linesize = len(line)
         deallocate (linetemp)
         allocate (character(len=linesize) :: linetemp)
         linetemp(:) = line(:)
         deallocate (line)
         allocate (character(len=linesize + size_read + 1) :: line)
         line(:) = linetemp(:)
         line(linesize + 1:) = buffer(:size_read)
         linesize = len(line)
         line(linesize:linesize) = ' '
         iostat = 0
         exit
       else if (iostat == 0) then
         linesize = len(line)
         deallocate (linetemp)
         allocate (character(len=linesize) :: linetemp)
         linetemp(:) = line(:)
         deallocate (line)
         allocate (character(len=linesize + size_read) :: line)
         line(:) = linetemp(:)
         line(linesize + 1:) = buffer(:size_read)
       else
         exit
       end if
     end do
     !
     ! -- look for undetected end-of-record with isolated CR or LF
     linesize = len(line)
     crlfcheck: do i = 1, linesize
       if (line(i:i) .eq. cr .or. line(i:i) .eq. lf) then
         if (line(i:i) .eq. cr) then
           write (errmsg, '(a)') &
             'get_line: Found an isolated Carriage Return.'
         end if
         if (line(i:i) .eq. lf) then
           write (errmsg, '(a)') &
             'get_line: Found an isolated Line Feed.'
         end if
         write (errmsg, '(a,1x,a,a)') trim(errmsg), &
           'Replace with Carriage Return and Line Feed to', &
           ' read as two separate lines.'
         write (errmsg, '(a,1x,5a)') trim(errmsg), &
           'Line: "', line(1:i - 1), '|', line(i + 1:linesize), '"'
         call store_error(errmsg, terminate=.false.)
         call store_error_unit(lun, terminate=.true.)
       end if
     end do crlfcheck

Here is the caller graph for this function:

◆ get_nwords()

integer(i4b) function, public inputoutputmodule::get_nwords ( character(len=*), intent(in) line )

Returns: number of words in a string

Definition at line 1680 of file InputOutput.f90.

     ! -- return
     integer(I4B) :: get_nwords !< number of words in a string
     ! -- dummy
     character(len=*), intent(in) :: line !< line
     ! -- local
     integer(I4B) :: linelen
     integer(I4B) :: lloc
     integer(I4B) :: istart
     integer(I4B) :: istop
     integer(I4B) :: idum
     real(DP) :: rdum
     !
     ! -- initialize variables
     get_nwords = 0
     linelen = len(line)
     !
     ! -- Count words in line and allocate words array
     lloc = 1
     do
       call urword(line, lloc, istart, istop, 0, idum, rdum, 0, 0)
       if (istart == linelen) exit
       get_nwords = get_nwords + 1
     end do

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getfilefrompath()

subroutine, public inputoutputmodule::getfilefrompath	(	character(len=*), intent(in)	pathname,
		character(len=*), intent(out)	filename
	)

Definition at line 1274 of file InputOutput.f90.

     implicit none
     ! -- dummy
     character(len=*), intent(in) :: pathname
     character(len=*), intent(out) :: filename
     ! -- local
     integer(I4B) :: i, istart, istop, lenpath
     character(len=1) :: fs = '/'
     character(len=1) :: bs = '\'
     !
     filename = ''
     lenpath = len_trim(pathname)
     istart = 1
     istop = lenpath
     loop: do i = lenpath, 1, -1
       if (pathname(i:i) == fs .or. pathname(i:i) == bs) then
         if (i == istop) then
           istop = istop - 1
         else
           istart = i + 1
           exit loop
         end if
       end if
     end do loop
     if (istop >= istart) then
       filename = pathname(istart:istop)
     end if

Here is the caller graph for this function:

◆ getunit()

integer(i4b) function, public inputoutputmodule::getunit

Function to get a free unit number that hasn't been used

Returns: free unit number

Definition at line 165 of file InputOutput.f90.

     ! -- modules
     implicit none
     ! -- return
     integer(I4B) :: getunit !< free unit number
     ! -- local
     integer(I4B) :: iunit
     !
     ! -- code
     call freeunitnumber(iunit)
     getunit = iunit

Here is the call graph for this function:

◆ lowcase()

subroutine, public inputoutputmodule::lowcase ( character(len=*) word )

Subroutine to convert a character string to lower case.

Definition at line 225 of file InputOutput.f90.

     implicit none
     ! -- dummy
     character(len=*) :: word
     ! -- local
     integer(I4B) :: idiff, k, l
     !
     ! -- Compute the difference between lowercase and uppercase.
     l = len(word)
     idiff = ichar('a') - ichar('A')
     !
     ! -- Loop through the string and convert any uppercase characters.
     do k = 1, l
       if (word(k:k) >= 'A' .and. word(k:k) <= 'Z') then
         word(k:k) = char(ichar(word(k:k)) + idiff)
       end if
     end do

Here is the caller graph for this function:

◆ openfile()

subroutine, public inputoutputmodule::openfile	(	integer(i4b), intent(inout)	iu,
		integer(i4b), intent(in)	iout,
		character(len=*), intent(in)	fname,
		character(len=*), intent(in)	ftype,
		character(len=*), intent(in), optional	fmtarg_opt,
		character(len=*), intent(in), optional	accarg_opt,
		character(len=*), intent(in), optional	filstat_opt,
		integer(i4b), intent(in), optional	mode_opt
	)

Subroutine to open a file using the specified arguments

Parameters

[in,out]	iu	unit number
[in]	iout	output unit number to write a message (iout=0 does not print)
[in]	fname	name of the file
[in]	ftype	file type (e.g. WEL)
[in]	fmtarg_opt	file format, default is 'formatted'
[in]	accarg_opt	file access, default is 'sequential'
[in]	filstat_opt	file status, default is 'old'. Use 'REPLACE' for output file.
[in]	mode_opt	simulation mode that is evaluated to determine if the file should be opened

Definition at line 28 of file InputOutput.f90.

     ! -- modules
     use openspecmodule, only: action
     implicit none
     ! -- dummy
     integer(I4B), intent(inout) :: iu !< unit number
     integer(I4B), intent(in) :: iout !< output unit number to write a message (iout=0 does not print)
     character(len=*), intent(in) :: fname !< name of the file
     character(len=*), intent(in) :: ftype !< file type (e.g. WEL)
     character(len=*), intent(in), optional :: fmtarg_opt !< file format, default is 'formatted'
     character(len=*), intent(in), optional :: accarg_opt !< file access, default is 'sequential'
     character(len=*), intent(in), optional :: filstat_opt !< file status, default is 'old'. Use 'REPLACE' for output file.
     integer(I4B), intent(in), optional :: mode_opt !< simulation mode that is evaluated to determine if the file should be opened
     ! -- local
     character(len=20) :: fmtarg
     character(len=20) :: accarg
     character(len=20) :: filstat
     character(len=20) :: filact
     integer(I4B) :: imode
     integer(I4B) :: iflen
     integer(I4B) :: ivar
     integer(I4B) :: iuop
     ! -- formats
     character(len=*), parameter :: fmtmsg = &
       "(1x,/1x,'OPENED ',a,/1x,'FILE TYPE:',a,'   UNIT ',I4,3x,'STATUS:',a,/ &
       & 1x,'FORMAT:',a,3x,'ACCESS:',a/1x,'ACTION:',a/)"
     character(len=*), parameter :: fmtmsg2 = &
                                    "(1x,/1x,'DID NOT OPEN ',a,/)"
     !
     ! -- Process mode_opt
     if (present(mode_opt)) then
       imode = mode_opt
     else
       imode = isim_mode
     end if
     !
     ! -- Evaluate if the file should be opened
     if (isim_mode < imode) then
       if (iout > 0) then
         write (iout, fmtmsg2) trim(fname)
       end if
     else
       !
       ! -- Default is to read an existing text file
       fmtarg = 'FORMATTED'
       accarg = 'SEQUENTIAL'
       filstat = 'OLD'
       !
       ! -- Override defaults
       if (present(fmtarg_opt)) then
         fmtarg = fmtarg_opt
         call upcase(fmtarg)
       end if
       if (present(accarg_opt)) then
         accarg = accarg_opt
         call upcase(accarg)
       end if
       if (present(filstat_opt)) then
         filstat = filstat_opt
         call upcase(filstat)
       end if
       if (filstat == 'OLD') then
         filact = action(1)
       else
         filact = action(2)
       end if
       !
       ! -- size of fname
       iflen = len_trim(fname)
       !
       ! -- Get a free unit number
       if (iu <= 0) then
         call freeunitnumber(iu)
       end if
       !
       ! -- Check if file is already open
       inquire (file=fname(1:iflen), number=iuop)
       open (unit=iu, file=fname(1:iflen), form=fmtarg, access=accarg, &
             status=filstat, action=filact, iostat=ivar)
       !
       ! -- Check for an error
       if (ivar /= 0) then
         write (errmsg, '(3a,1x,i0,a)') &
           'Could not open "', fname(1:iflen), '" on unit', iu, '.'
         if (iuop > 0) then
           write (errmsg, '(a,1x,a,1x,i0,a)') &
             trim(errmsg), 'File already open on unit', iuop, '.'
         end if
         write (errmsg, '(a,1x,a,1x,a,a)') &
           trim(errmsg), 'Specified file status', trim(filstat), '.'
         write (errmsg, '(a,1x,a,1x,a,a)') &
           trim(errmsg), 'Specified file format', trim(fmtarg), '.'
         write (errmsg, '(a,1x,a,1x,a,a)') &
           trim(errmsg), 'Specified file access', trim(accarg), '.'
         write (errmsg, '(a,1x,a,1x,a,a)') &
           trim(errmsg), 'Specified file action', trim(filact), '.'
         write (errmsg, '(a,1x,a,1x,i0,a)') &
           trim(errmsg), 'IOSTAT error number', ivar, '.'
         write (errmsg, '(a,1x,a)') &
           trim(errmsg), 'STOP EXECUTION in subroutine openfile().'
         call store_error(errmsg, terminate=.true.)
       end if
       !
       ! -- Write a message
       if (iout > 0) then
         write (iout, fmtmsg) fname(1:iflen), ftype, iu, filstat, fmtarg, &
           accarg, filact
       end if
     end if

Here is the call graph for this function:

◆ parseline()

subroutine, public inputoutputmodule::parseline	(	character(len=*), intent(in)	line,
		integer(i4b), intent(inout)	nwords,
		character(len=*), dimension(:), intent(inout), allocatable	words,
		integer(i4b), intent(in), optional	inunit,
		character(len=*), intent(in), optional	filename
	)

Blanks and commas are recognized as delimiters. Multiple blanks between words is OK, but multiple commas between words is treated as an error. Quotation marks are not recognized as delimiters.

Definition at line 1127 of file InputOutput.f90.

     ! -- modules
     use constantsmodule, only: linelength
     implicit none
     ! -- dummy
     character(len=*), intent(in) :: line
     integer(I4B), intent(inout) :: nwords
     character(len=*), allocatable, dimension(:), intent(inout) :: words
     integer(I4B), intent(in), optional :: inunit
     character(len=*), intent(in), optional :: filename
     ! -- local
     integer(I4B) :: i, idum, istart, istop, linelen, lloc
     real(DP) :: rdum
     !
     nwords = 0
     if (allocated(words)) then
       deallocate (words)
     end if
     linelen = len(line)
     !
     ! -- get the number of words in a line and allocate words array
     nwords = get_nwords(line)
     allocate (words(nwords))
     !
     ! -- Populate words array and return
     lloc = 1
     do i = 1, nwords
       call urword(line, lloc, istart, istop, 0, idum, rdum, 0, 0)
       words(i) = line(istart:istop)
     end do

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print_format()

subroutine, public inputoutputmodule::print_format	(	character(len=*), intent(in)	linein,
		character(len=*), intent(inout)	cdatafmp,
		character(len=*), intent(inout)	editdesc,
		integer(i4b), intent(inout)	nvaluesp,
		integer(i4b), intent(inout)	nwidthp,
		integer(i4b), intent(in)	inunit
	)

Define cdatafmp as a Fortran output format based on user input. Also define nvalues, nwidth, and editdesc.

Syntax for linein: COLUMNS nval WIDTH nwid [DIGITS ndig [options]]

Where: nval = Number of values per line. nwid = Number of character places to be used for each value. ndig = Number of digits to the right of the decimal point (required for real array). options are: editoption: One of [EXPONENTIAL, FIXED, GENERAL, SCIENTIFIC] A default value should be passed in for editdesc as G, I, E, F, or S. If I is passed in, then the fortran format will be for an integer variable.

Definition at line 1405 of file InputOutput.f90.

     ! -- dummy
     character(len=*), intent(in) :: linein
     character(len=*), intent(inout) :: cdatafmp
     character(len=*), intent(inout) :: editdesc
     integer(I4B), intent(inout) :: nvaluesp
     integer(I4B), intent(inout) :: nwidthp
     integer(I4B), intent(in) :: inunit
     ! -- local
     character(len=len(linein)) :: line
     character(len=20), dimension(:), allocatable :: words
     character(len=100) :: ermsg
     integer(I4B) :: ndigits = 0, nwords = 0
     integer(I4B) :: i, ierr
     logical :: isint
     !
     ! -- Parse line and initialize values
     line(:) = linein(:)
     call parseline(line, nwords, words, inunit)
     ierr = 0
     i = 0
     isint = .false.
     if (editdesc == 'I') isint = .true.
     !
     ! -- Check array name
     if (nwords < 1) then
       ermsg = 'Could not build PRINT_FORMAT from line'//trim(line)
       call store_error(trim(ermsg))
       ermsg = 'Syntax is: COLUMNS <columns> WIDTH <width> DIGITS &
               &<digits> <format>'
       call store_error(trim(ermsg))
       call store_error_unit(inunit)
     end if
     !
     ermsg = 'Error setting PRINT_FORMAT. Syntax is incorrect in line:'
     if (nwords >= 4) then
       if (.not. same_word(words(1), 'COLUMNS')) ierr = 1
       if (.not. same_word(words(3), 'WIDTH')) ierr = 1
       ! -- Read nvalues and nwidth
       if (ierr == 0) then
         read (words(2), *, iostat=ierr) nvaluesp
       end if
       if (ierr == 0) then
         read (words(4), *, iostat=ierr) nwidthp
       end if
     else
       ierr = 1
     end if
     if (ierr /= 0) then
       call store_error(ermsg)
       call store_error(line)
       ermsg = 'Syntax is: COLUMNS <columns> WIDTH <width> &
               &DIGITS <digits> <format>'
       call store_error(trim(ermsg))
       call store_error_unit(inunit)
     end if
     i = 4
     !
     if (.not. isint) then
       ! -- Check for DIGITS specification
       if (nwords >= 5) then
         if (.not. same_word(words(5), 'DIGITS')) ierr = 1
         ! -- Read ndigits
         read (words(6), *, iostat=ierr) ndigits
       else
         ierr = 1
       end if
       i = i + 2
     end if
     !
     ! -- Check for EXPONENTIAL | FIXED | GENERAL | SCIENTIFIC option.
     ! -- Check for LABEL, WRAP, and STRIP options.
     do
       i = i + 1
       if (i <= nwords) then
         call upcase(words(i))
         select case (words(i))
         case ('EXPONENTIAL')
           editdesc = 'E'
           if (isint) ierr = 1
         case ('FIXED')
           editdesc = 'F'
           if (isint) ierr = 1
         case ('GENERAL')
           editdesc = 'G'
           if (isint) ierr = 1
         case ('SCIENTIFIC')
           editdesc = 'S'
           if (isint) ierr = 1
         case default
           ermsg = 'Error in format specification. Unrecognized option: '//words(i)
           call store_error(ermsg)
           ermsg = 'Valid values are EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC.'
           call store_error(ermsg)
           call store_error_unit(inunit)
         end select
       else
         exit
       end if
     end do
     if (ierr /= 0) then
       call store_error(ermsg)
       call store_error(line)
       call store_error_unit(inunit)
     end if
     !
     ! -- Build the output format.
     select case (editdesc)
     case ('I')
       call buildintformat(nvaluesp, nwidthp, cdatafmp)
     case ('F')
       call buildfixedformat(nvaluesp, nwidthp, ndigits, cdatafmp)
     case ('E', 'G', 'S')
       call buildfloatformat(nvaluesp, nwidthp, ndigits, editdesc, cdatafmp)
     end select

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read_line()

character(len=:) function, allocatable, public inputoutputmodule::read_line	(	integer(i4b), intent(in)	iu,
		logical, intent(out)	eof
	)

The returned string can be stored in a deferred-length character variable, for example:

integer(I4B) :: iu character(len=:), allocatable :: my_string logical :: eof iu = 8 open(iu,file='my_file') my_string = read_line(iu, eof)

Definition at line 1215 of file InputOutput.f90.

     !
     implicit none
     ! -- dummy
     integer(I4B), intent(in) :: iu
     logical, intent(out) :: eof
     character(len=:), allocatable :: astring
     ! -- local
     integer(I4B) :: isize, istat
     character(len=256) :: buffer
     character(len=1000) :: ermsg, fname
     character(len=7) :: fmtd
     logical :: lop
     ! -- formats
     character(len=*), parameter :: fmterrmsg1 = &
       & "('Error in read_line: File ',i0,' is not open.')"
     character(len=*), parameter :: fmterrmsg2 = &
       & "('Error in read_line: Attempting to read text ' // &
       & 'from unformatted file: ""',a,'""')"
     character(len=*), parameter :: fmterrmsg3 = &
       & "('Error reading from file ""',a,'"" opened on unit ',i0, &
       & ' in read_line.')"
     !
     astring = ''
     eof = .false.
     do
       read (iu, '(a)', advance='NO', iostat=istat, size=isize, end=99) buffer
       if (istat > 0) then
         ! Determine error if possible, report it, and stop.
         if (iu <= 0) then
           ermsg = 'Programming error in call to read_line: '// &
                   'Attempt to read from unit number <= 0'
         else
           inquire (unit=iu, opened=lop, name=fname, formatted=fmtd)
           if (.not. lop) then
             write (ermsg, fmterrmsg1) iu
           elseif (fmtd == 'NO' .or. fmtd == 'UNKNOWN') then
             write (ermsg, fmterrmsg2) trim(fname)
           else
             write (ermsg, fmterrmsg3) trim(fname), iu
           end if
         end if
         call store_error(ermsg)
         call store_error_unit(iu)
       end if
       astring = astring//buffer(:isize)
       ! -- An end-of-record condition stops the loop.
       if (istat < 0) then
         return
       end if
     end do
     !
     return
 99  continue
     !
     ! An end-of-file condition returns an empty string.
     eof = .true.

Here is the call graph for this function:

◆ same_word()

logical function, public inputoutputmodule::same_word	(	character(len=*), intent(in)	word1,
		character(len=*), intent(in)	word2
	)

Definition at line 1071 of file InputOutput.f90.

     implicit none
     ! -- dummy
     character(len=*), intent(in) :: word1, word2
     ! -- local
     character(len=200) :: upword1, upword2
     !
     upword1 = word1
     call upcase(upword1)
     upword2 = word2
     call upcase(upword2)
     same_word = (upword1 == upword2)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ str_pad_left()

character(len=max(len_trim(str), width)) function, public inputoutputmodule::str_pad_left	(	character(len=*), intent(in)	str,
		integer, intent(in)	width
	)

Definition at line 1087 of file InputOutput.f90.

     ! -- local
     character(len=*), intent(in) :: str
     integer, intent(in) :: width
     ! -- Return
     character(len=max(len_trim(str), width)) :: res
     !
     res = str
     res = adjustr(res)

Here is the caller graph for this function:

◆ u9rdcom()

subroutine, public inputoutputmodule::u9rdcom	(	integer(i4b), intent(in)	iin,
		integer(i4b), intent(in)	iout,
		character(len=:), intent(inout), allocatable	line,
		integer(i4b), intent(out)	ierr
	)

Different from u8rdcom in that line is a deferred length character string, which allows any length lines to be read using the get_line subroutine.

Definition at line 1758 of file InputOutput.f90.

     ! -- module
     use, intrinsic :: iso_fortran_env, only: iostat_end
     implicit none
     ! -- dummy
     integer(I4B), intent(in) :: iin
     integer(I4B), intent(in) :: iout
     character(len=:), allocatable, intent(inout) :: line
     integer(I4B), intent(out) :: ierr
     ! -- local
     character(len=:), allocatable :: linetemp
     character(len=2), parameter :: comment = '//'
     character(len=1), parameter :: tab = char(9)
     logical :: iscomment
     integer(I4B) :: i, j, l, istart, lsize
     !
     !readerrmsg = ''
     line = comment
     pcomments: do
       call get_line(iin, line, ierr)
       if (ierr == iostat_end) then
         ! -- End of file reached. Return with ierr = IOSTAT_END
         !    and line as an empty string
         line = ' '
         exit pcomments
       elseif (ierr /= 0) then
         ! -- Other error...report it
         call unitinquire(iin)
         write (errmsg, *) 'u9rdcom: Could not read from unit: ', iin
         call store_error(errmsg, terminate=.true.)
       end if
       if (len_trim(line) < 1) then
         line = comment
         cycle
       end if
       !
       ! -- Ensure that any initial tab characters are treated as spaces
       cleartabs: do
         !
         ! -- adjustl manually to avoid stack overflow
         lsize = len(line)
         istart = 1
         allocate (character(len=lsize) :: linetemp)
         do j = 1, lsize
           if (line(j:j) /= ' ' .and. line(j:j) /= ',' .and. &
               line(j:j) /= char(9)) then
             istart = j
             exit
           end if
         end do
         linetemp(:) = ' '
         linetemp(:) = line(istart:)
         line(:) = linetemp(:)
         deallocate (linetemp)
         !
         ! -- check for comment
         iscomment = .false.
         select case (line(1:1))
         case ('#')
           iscomment = .true.
           exit cleartabs
         case ('!')
           iscomment = .true.
           exit cleartabs
         case (tab)
           line(1:1) = ' '
           cycle cleartabs
         case default
           if (line(1:2) == comment) iscomment = .true.
           if (len_trim(line) < 1) iscomment = .true.
           exit cleartabs
         end select
       end do cleartabs
       !
       if (.not. iscomment) then
         exit pcomments
       else
         if (iout > 0) then
           !find the last non-blank character.
           l = len(line)
           do i = l, 1, -1
             if (line(i:i) /= ' ') then
               exit
             end if
           end do
           ! -- print the line up to the last non-blank character.
           write (iout, '(1x,a)') line(1:i)
         end if
       end if
     end do pcomments

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ubdsv06()

subroutine, public inputoutputmodule::ubdsv06	(	integer(i4b), intent(in)	kstp,
		integer(i4b), intent(in)	kper,
		character(len=*), intent(in)	text,
		character(len=*), intent(in)	modelnam1,
		character(len=*), intent(in)	paknam1,
		character(len=*), intent(in)	modelnam2,
		character(len=*), intent(in)	paknam2,
		integer(i4b), intent(in)	ibdchn,
		integer(i4b), intent(in)	naux,
		character(len=16), dimension(:), intent(in)	auxtxt,
		integer(i4b), intent(in)	ncol,
		integer(i4b), intent(in)	nrow,
		integer(i4b), intent(in)	nlay,
		integer(i4b), intent(in)	nlist,
		integer(i4b), intent(in)	iout,
		real(dp), intent(in)	delt,
		real(dp), intent(in)	pertim,
		real(dp), intent(in)	totim
	)

Each item in the list is written by module ubdsvc

Definition at line 977 of file InputOutput.f90.

     implicit none
     ! -- dummy
     integer(I4B), intent(in) :: kstp
     integer(I4B), intent(in) :: kper
     character(len=*), intent(in) :: text
     character(len=*), intent(in) :: modelnam1
     character(len=*), intent(in) :: paknam1
     character(len=*), intent(in) :: modelnam2
     character(len=*), intent(in) :: paknam2
     integer(I4B), intent(in) :: naux
     character(len=16), dimension(:), intent(in) :: auxtxt
     integer(I4B), intent(in) :: ibdchn
     integer(I4B), intent(in) :: ncol
     integer(I4B), intent(in) :: nrow
     integer(I4B), intent(in) :: nlay
     integer(I4B), intent(in) :: nlist
     integer(I4B), intent(in) :: iout
     real(DP), intent(in) :: delt
     real(DP), intent(in) :: pertim
     real(DP), intent(in) :: totim
     ! -- local
     integer(I4B) :: n
     ! -- format
     character(len=*), parameter :: fmt = &
       & "(1X,'UBDSV06 SAVING ',A16,' IN MODEL ',A16,' PACKAGE ',A16,"// &
       & "'CONNECTED TO MODEL ',A16,' PACKAGE ',A16,"// &
       & "' ON UNIT',I7,' AT TIME STEP',I7,', STRESS PERIOD',I7)"
     !
     ! -- Write unformatted records identifying data.
     if (iout > 0) write (iout, fmt) text, modelnam1, paknam1, modelnam2, &
       paknam2, ibdchn, kstp, kper
     write (ibdchn) kstp, kper, text, ncol, nrow, -nlay
     write (ibdchn) 6, delt, pertim, totim
     write (ibdchn) modelnam1
     write (ibdchn) paknam1
     write (ibdchn) modelnam2
     write (ibdchn) paknam2
     write (ibdchn) naux + 1
     if (naux > 0) write (ibdchn) (auxtxt(n), n=1, naux)
     write (ibdchn) nlist

Here is the caller graph for this function:

◆ ubdsv1()

subroutine, public inputoutputmodule::ubdsv1	(	integer(i4b), intent(in)	kstp,
		integer(i4b), intent(in)	kper,
		character(len=*), intent(in)	text,
		integer(i4b), intent(in)	ibdchn,
		real(dp), dimension(:), intent(in)	buff,
		integer(i4b), intent(in)	ncol,
		integer(i4b), intent(in)	nrow,
		integer(i4b), intent(in)	nlay,
		integer(i4b), intent(in)	iout,
		real(dp), intent(in)	delt,
		real(dp), intent(in)	pertim,
		real(dp), intent(in)	totim
	)

Definition at line 941 of file InputOutput.f90.

     implicit none
     ! -- dummy
     integer(I4B), intent(in) :: kstp
     integer(I4B), intent(in) :: kper
     character(len=*), intent(in) :: text
     integer(I4B), intent(in) :: ibdchn
     real(DP), dimension(:), intent(in) :: buff
     integer(I4B), intent(in) :: ncol
     integer(I4B), intent(in) :: nrow
     integer(I4B), intent(in) :: nlay
     integer(I4B), intent(in) :: iout
     real(DP), intent(in) :: delt
     real(DP), intent(in) :: pertim
     real(DP), intent(in) :: totim
     ! -- format
     character(len=*), parameter :: fmt = &
       & "(1X,'UBDSV1 SAVING ',A16,' ON UNIT',I7,' AT TIME STEP',I7,"// &
       & "', STRESS PERIOD',I7)"
     !
     ! -- Write records
     if (iout > 0) write (iout, fmt) text, ibdchn, kstp, kper
     write (ibdchn) kstp, kper, text, ncol, nrow, -nlay
     write (ibdchn) 1, delt, pertim, totim
     write (ibdchn) buff
     !
     ! -- flush file
     flush (ibdchn)

Here is the caller graph for this function:

◆ ubdsv4()

subroutine, public inputoutputmodule::ubdsv4	(		kstp,
			kper,
		character(len=16)	text,
			naux,
		character(len=16), dimension(:)	auxtxt,
			ibdchn,
			ncol,
			nrow,
			nlay,
			nlist,
			iout,
		real(dp), intent(in)	delt,
		real(dp), intent(in)	pertim,
		real(dp), intent(in)	totim
	)

Each item in the list is written by module UBDSVB

Definition at line 622 of file InputOutput.f90.

     ! -- dummy
     character(len=16) :: text
     character(len=16), dimension(:) :: auxtxt
     real(DP), intent(in) :: delt, pertim, totim
     ! -- formats
     character(len=*), parameter :: fmt = &
       & "(1X,'UBDSV4 SAVING ',A16,' ON UNIT',I7,' AT TIME STEP',I7,"// &
       & "', STRESS PERIOD',I7)"
     !
     ! -- Write unformatted records identifying data
     if (iout > 0) write (iout, fmt) text, ibdchn, kstp, kper
     write (ibdchn) kstp, kper, text, ncol, nrow, -nlay
     write (ibdchn) 5, delt, pertim, totim
     write (ibdchn) naux + 1
     if (naux > 0) write (ibdchn) (auxtxt(n), n=1, naux)
     write (ibdchn) nlist

◆ ubdsvb()

subroutine, public inputoutputmodule::ubdsvb	(		ibdchn,
			icrl,
		real(dp)	q,
		real(dp), dimension(nvl)	val,
			nvl,
			naux,
			laux
	)

Definition at line 645 of file InputOutput.f90.

     ! -- dummy
     real(DP), dimension(nvl) :: val
     real(DP) :: q
     !
     ! -- Write cell number and flow rate
     IF (naux > 0) then
       n2 = laux + naux - 1
       write (ibdchn) icrl, q, (val(n), n=laux, n2)
     else
       write (ibdchn) icrl, q
     end if

◆ ubdsvc()

subroutine, public inputoutputmodule::ubdsvc	(	integer(i4b), intent(in)	ibdchn,
		integer(i4b), intent(in)	n,
		real(dp), intent(in)	q,
		integer(i4b), intent(in)	naux,
		real(dp), dimension(naux), intent(in)	aux
	)

From node (n) and to node (n2) are written to the file

Definition at line 1026 of file InputOutput.f90.

     implicit none
     ! -- dummy
     integer(I4B), intent(in) :: ibdchn
     integer(I4B), intent(in) :: n
     real(DP), intent(in) :: q
     integer(I4B), intent(in) :: naux
     real(DP), dimension(naux), intent(in) :: aux
     ! -- local
     integer(I4B) :: nn
     !
     ! -- Write record
     if (naux > 0) then
       write (ibdchn) n, q, (aux(nn), nn=1, naux)
     else
       write (ibdchn) n, q
     end if

◆ ubdsvd()

subroutine, public inputoutputmodule::ubdsvd	(	integer(i4b), intent(in)	ibdchn,
		integer(i4b), intent(in)	n,
		integer(i4b), intent(in)	n2,
		real(dp), intent(in)	q,
		integer(i4b), intent(in)	naux,
		real(dp), dimension(naux), intent(in)	aux
	)

From node (n) and to node (n2) are written to the file

Definition at line 1049 of file InputOutput.f90.

     implicit none
     ! -- dummy
     integer(I4B), intent(in) :: ibdchn
     integer(I4B), intent(in) :: n
     integer(I4B), intent(in) :: n2
     real(DP), intent(in) :: q
     integer(I4B), intent(in) :: naux
     real(DP), dimension(naux), intent(in) :: aux
     ! -- local
     integer(I4B) :: nn
     !
     ! -- Write record
     if (naux > 0) then
       write (ibdchn) n, n2, q, (aux(nn), nn=1, naux)
     else
       write (ibdchn) n, n2, q
     end if

Here is the caller graph for this function:

◆ ucolno()

subroutine, public inputoutputmodule::ucolno	(	nlbl1,
		nlbl2,
		nspace,
		ncpl,
		ndig,
		iout
	)

nlbl1 is the start column label (number) nlbl2 is the stop column label (number) nspace is number of blank spaces to leave at start of line ncpl is number of column numbers per line ndig is number of characters in each column field iout is output channel

Definition at line 668 of file InputOutput.f90.

     ! -- local
     character(len=1) :: DOT, SPACE, DG, BF
     dimension :: bf(1000), dg(10)
     ! -- constants
     data dg(1), dg(2), dg(3), dg(4), dg(5), dg(6), dg(7), dg(8), dg(9), dg(10)/ &
        & '0', '1', '2', '3', '4', '5', '6', '7', '8', '9'/
     data dot, space/'.', ' '/
     ! -- formats
     character(len=*), parameter :: fmtmsgout1 = "(1x)"
     character(len=*), parameter :: fmtmsgout2 = "(1x, 1000a1)"
     !
     ! -- Calculate # of columns to be printed (nlbl), width
     !    of a line (ntot), number of lines (nwrap).
     if (iout <= 0) return
     write (iout, fmtmsgout1)
     !
     nlbl = nlbl2 - nlbl1 + 1
     n = nlbl
     !
     if (nlbl < ncpl) n = ncpl
     ntot = nspace + n * ndig
     !
     if (ntot > 1000) go to 50
     nwrap = (nlbl - 1) / ncpl + 1
     j1 = nlbl1 - ncpl
     j2 = nlbl1 - 1
     !
     ! -- Build and print each line
     do n = 1, nwrap
       !
       ! -- Clear the buffer (BF)
       do i = 1, 1000
         bf(i) = space
       end do
       nbf = nspace
       !
       ! -- Determine first (j1) and last (j2) column # for this line.
       j1 = j1 + ncpl
       j2 = j2 + ncpl
       if (j2 > nlbl2) j2 = nlbl2
       !
       ! -- Load the column #'s into the buffer.
       do j = j1, j2
         nbf = nbf + ndig
         i2 = j / 10
         i1 = j - i2 * 10 + 1
         bf(nbf) = dg(i1)
         if (i2 == 0) go to 30
         i3 = i2 / 10
         i2 = i2 - i3 * 10 + 1
         bf(nbf - 1) = dg(i2)
         if (i3 == 0) go to 30
         i4 = i3 / 10
         i3 = i3 - i4 * 10 + 1
         bf(nbf - 2) = dg(i3)
         if (i4 == 0) go to 30
         if (i4 > 9) then
           ! -- If more than 4 digits, use "X" for 4th digit.
           bf(nbf - 3) = 'X'
         else
           bf(nbf - 3) = dg(i4 + 1)
         end if
 30    end do
       !
       ! -- Print the contents of the buffer (i.e. print the line).
       write (iout, fmtmsgout2) (bf(i), i=1, nbf)
       !
     end do
     !
     ! -- Print a line of dots (for aesthetic purposes only).
 50  ntot = ntot
     if (ntot > 1000) ntot = 1000
     write (iout, fmtmsgout2) (dot, i=1, ntot)

Here is the caller graph for this function:

◆ ulaprufw()

subroutine, public inputoutputmodule::ulaprufw	(	integer(i4b), intent(in)	ncol,
		integer(i4b), intent(in)	nrow,
		integer(i4b), intent(in)	kstp,
		integer(i4b), intent(in)	kper,
		integer(i4b), intent(in)	ilay,
		integer(i4b), intent(in)	iout,
		real(dp), dimension(ncol, nrow), intent(in)	buf,
		character(len=*), intent(in)	text,
		character(len=*), intent(in)	userfmt,
		integer(i4b), intent(in)	nvalues,
		integer(i4b), intent(in)	nwidth,
		character(len=1), intent(in)	editdesc
	)

Definition at line 1161 of file InputOutput.f90.

     implicit none
     ! -- dummy
     integer(I4B), intent(in) :: ncol, nrow, kstp, kper, ilay, iout
     real(DP), dimension(ncol, nrow), intent(in) :: buf
     character(len=*), intent(in) :: text
     character(len=*), intent(in) :: userfmt
     integer(I4B), intent(in) :: nvalues, nwidth
     character(len=1), intent(in) :: editdesc
     ! -- local
     integer(I4B) :: i, j, nspaces
     ! -- formats
     character(len=*), parameter :: fmtmsgout1 = &
       "('1',/2X,A,' IN LAYER ',I3,' AT END OF TIME STEP ',I3, &
 &        ' IN STRESS PERIOD ',I4/2X,75('-'))"
     character(len=*), parameter :: fmtmsgout2 = &
       "('1',/1X,A,' FOR CROSS SECTION AT END OF TIME STEP',I3, &
 &        ' IN STRESS PERIOD ',I4/1X,79('-'))"
     !
     if (iout <= 0) return
     ! -- Print a header depending on ILAY
     if (ilay > 0) then
       write (iout, fmtmsgout1) trim(text), ilay, kstp, kper
     else if (ilay < 0) then
       write (iout, fmtmsgout2) trim(text), kstp, kper
     end if
     !
     ! -- Print column numbers.
     nspaces = 0
     if (editdesc == 'F') nspaces = 3
     call ucolno(1, ncol, nspaces, nvalues, nwidth + 1, iout)
     !
     ! -- Loop through the rows, printing each one in its entirety.
     do i = 1, nrow
       write (iout, userfmt) i, (buf(j, i), j=1, ncol)
     end do
     !
     ! -- flush file
     flush (iout)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ulaprw()

subroutine, public inputoutputmodule::ulaprw	(	real(dp), dimension(ncol, nrow)	buf,
		character(len=16)	text,
			kstp,
			kper,
			ncol,
			nrow,
			ilay,
			iprn,
			iout
	)

Definition at line 746 of file InputOutput.f90.

     ! -- dummy
     character(len=16) :: text
     real(DP), dimension(ncol, nrow) :: buf
     ! -- formats
     character(len=*), parameter :: fmtmsgout1 = &
       & "('1', /2x, a, ' IN LAYER ',I3,' AT END OF TIME STEP ',I3, &
       & ' IN STRESS PERIOD ',I4/2x,75('-'))"
     character(len=*), parameter :: fmtmsgout2 = &
       & "('1',/1x,A,' FOR CROSS SECTION AT END OF TIME STEP',I3, &
       & ' IN STRESS PERIOD ',I4/1x,79('-'))"
     character(len=*), parameter :: fmtg10 = &
       & "(1X,I3,2X,1PG10.3,10(1X,G10.3):/(5X,11(1X,G10.3)))"
     character(len=*), parameter :: fmtg13 = &
       & "(1x,I3,2x,1PG13.6,8(1x,G13.6):/(5x,9(1x,G13.6)))"
     character(len=*), parameter :: fmtf7pt1 = &
       & "(1x,I3,1x,15(1x,F7.1):/(5x,15(1x,F7.1)))"
     character(len=*), parameter :: fmtf7pt2 = &
       & "(1x,I3,1x,15(1x,F7.2):/(5x,15(1x,F7.2)))"
     character(len=*), parameter :: fmtf7pt3 = &
       & "(1x,I3,1x,15(1x,F7.3):/(5x,15(1x,F7.3)))"
     character(len=*), parameter :: fmtf7pt4 = &
       & "(1x,I3,1x,15(1x,F7.4):/(5x,15(1x,F7.4)))"
     character(len=*), parameter :: fmtf5pt0 = &
       & "(1x,I3,1x,20(1x,F5.0):/(5x,20(1x,F5.0)))"
     character(len=*), parameter :: fmtf5pt1 = &
       & "(1x,I3,1x,20(1x,F5.1):/(5x,20(1x,F5.1)))"
     character(len=*), parameter :: fmtf5pt2 = &
       & "(1x,I3,1x,20(1x,F5.2):/(5x,20(1x,F5.2)))"
     character(len=*), parameter :: fmtf5pt3 = &
       & "(1x,I3,1x,20(1x,F5.3):/(5x,20(1x,F5.3)))"
     character(len=*), parameter :: fmtf5pt4 = &
       & "(1x,I3,1x,20(1x,F5.4):/(5x,20(1x,F5.4)))"
     character(len=*), parameter :: fmtg11 = &
       & "(1x,I3,2x,1PG11.4,9(1x,G11.4):/(5x,10(1x,G11.4)))"
     character(len=*), parameter :: fmtf6pt0 = &
       & "(1x,I3,1x,10(1x,F6.0):/(5X,10(1x,F6.0)))"
     character(len=*), parameter :: fmtf6pt1 = &
       & "(1x,I3,1x,10(1x,F6.1):/(5x,10(1x,F6.1)))"
     character(len=*), parameter :: fmtf6pt2 = &
       & "(1x,I3,1x,10(1x,F6.2):/(5x,10(1x,F6.2)))"
     character(len=*), parameter :: fmtf6pt3 = &
       & "(1x,I3,1x,10(1x,F6.3):/(5x,10(1x,F6.3)))"
     character(len=*), parameter :: fmtf6pt4 = &
       & "(1x,I3,1x,10(1x,F6.4):/(5x,10(1x,F6.4)))"
     character(len=*), parameter :: fmtf6pt5 = &
       & "(1x,I3,1x,10(1x,F6.5):/(5x,10(1x,F6.5)))"
     character(len=*), parameter :: fmtg12 = &
       & "(1x,I3,2x,1PG12.5,4(1x,G12.5):/(5x,5(1x,G12.5)))"
     character(len=*), parameter :: fmtg11pt4 = &
       & "(1x,I3,2x,1PG11.4,5(1x,G11.4):/(5x,6(1x,G11.4)))"
     character(len=*), parameter :: fmtg9pt2 = &
       & "(1x,I3,2x,1PG9.2,6(1x,G9.2):/(5x,7(1x,G9.2)))"
     !
     if (iout <= 0) return
     ! -- Print a header depending on ilay
     if (ilay > 0) then
       write (iout, fmtmsgout1) text, ilay, kstp, kper
     else if (ilay < 0) then
       write (iout, fmtmsgout2) text, kstp, kper
     end if
     !
     ! -- Make sure the format code (ip or iprn) is between 1 and 21
     ip = iprn
     if (ip < 1 .or. ip > 21) ip = 12
     !
     ! -- Call the utility module ucolno to print column numbers.
     if (ip == 1) call ucolno(1, ncol, 0, 11, 11, iout)
     if (ip == 2) call ucolno(1, ncol, 0, 9, 14, iout)
     if (ip >= 3 .and. ip <= 6) call ucolno(1, ncol, 3, 15, 8, iout)
     if (ip >= 7 .and. ip <= 11) call ucolno(1, ncol, 3, 20, 6, iout)
     if (ip == 12) call ucolno(1, ncol, 0, 10, 12, iout)
     if (ip >= 13 .and. ip <= 18) call ucolno(1, ncol, 3, 10, 7, iout)
     if (ip == 19) call ucolno(1, ncol, 0, 5, 13, iout)
     if (ip == 20) call ucolno(1, ncol, 0, 6, 12, iout)
     if (ip == 21) call ucolno(1, ncol, 0, 7, 10, iout)
     !
     ! -- Loop through the rows printing each one in its entirety.
     do i = 1, nrow
       select case (ip)
         !
       case (1)
         ! -- format 11G10.3
         write (iout, fmtg10) i, (buf(j, i), j=1, ncol)
         !
       case (2)
         ! -- format 9G13.6
         write (iout, fmtg13) i, (buf(j, i), j=1, ncol)
         !
       case (3)
         ! -- format 15F7.1
         write (iout, fmtf7pt1) i, (buf(j, i), j=1, ncol)
         !
       case (4)
         ! -- format 15F7.2
         write (iout, fmtf7pt2) i, (buf(j, i), j=1, ncol)
         !
       case (5)
         ! -- format 15F7.3
         write (iout, fmtf7pt3) i, (buf(j, i), j=1, ncol)
         !
       case (6)
         ! -- format 15F7.4
         write (iout, fmtf7pt4) i, (buf(j, i), j=1, ncol)
         !
       case (7)
         ! -- format 20F5.0
         write (iout, fmtf5pt0) i, (buf(j, i), j=1, ncol)
         !
       case (8)
         ! -- format 20F5.1
         write (iout, fmtf5pt1) i, (buf(j, i), j=1, ncol)
         !
       case (9)
         ! -- format 20F5.2
         write (iout, fmtf5pt2) i, (buf(j, i), j=1, ncol)
         !
       case (10)
         ! -- format 20F5.3
         write (iout, fmtf5pt3) i, (buf(j, i), j=1, ncol)
         !
       case (11)
         ! -- format 20F5.4
         write (iout, fmtf5pt4) i, (buf(j, i), j=1, ncol)
         !
       case (12)
         ! -- format 10G11.4
         write (iout, fmtg11) i, (buf(j, i), j=1, ncol)
         !
       case (13)
         ! -- format 10F6.0
         write (iout, fmtf6pt0) i, (buf(j, i), j=1, ncol)
         !
       case (14)
         ! -- format 10F6.1
         write (iout, fmtf6pt1) i, (buf(j, i), j=1, ncol)
         !
       case (15)
         ! -- format 10F6.2
         write (iout, fmtf6pt2) i, (buf(j, i), j=1, ncol)
         !
       case (16)
         ! -- format 10F6.3
         write (iout, fmtf6pt3) i, (buf(j, i), j=1, ncol)
         !
       case (17)
         ! -- format 10F6.4
         write (iout, fmtf6pt4) i, (buf(j, i), j=1, ncol)
         !
       case (18)
         ! -- format 10F6.5
         write (iout, fmtf6pt5) i, (buf(j, i), j=1, ncol)
         !
       case (19)
         ! -- format 5G12.5
         write (iout, fmtg12) i, (buf(j, i), j=1, ncol)
         !
       case (20)
         ! -- format 6G11.4
         write (iout, fmtg11pt4) i, (buf(j, i), j=1, ncol)
         !
       case (21)
         ! -- format 7G9.2
         write (iout, fmtg9pt2) i, (buf(j, i), j=1, ncol)
         !
       end select
     end do
     !
     ! -- Flush file
     flush (iout)

Here is the call graph for this function:

◆ ulasav()

subroutine, public inputoutputmodule::ulasav	(	real(dp), dimension(ncol, nrow)	buf,
		character(len=16)	text,
			kstp,
			kper,
		real(dp)	pertim,
		real(dp)	totim,
			ncol,
			nrow,
			ilay,
			ichn
	)

Definition at line 920 of file InputOutput.f90.

     ! -- dummy
     character(len=16) :: text
     real(DP), dimension(ncol, nrow) :: buf
     real(DP) :: pertim, totim
     !
     ! -- Write an unformatted record containing identifying information
     write (ichn) kstp, kper, pertim, totim, text, ncol, nrow, ilay
     !
     ! -- Write an unformatted record containing array values. The array is
     !    dimensioned (ncol,nrow)
     write (ichn) ((buf(ic, ir), ic=1, ncol), ir=1, nrow)
     !
     ! -- flush file
     flush (ichn)

Here is the caller graph for this function:

◆ ulstlb()

subroutine, public inputoutputmodule::ulstlb	(		iout,
		character(len=*)	label,
		character(len=16), dimension(ncaux)	caux,
			ncaux,
			naux
	)

Definition at line 584 of file InputOutput.f90.

     ! -- dummy
     character(len=*) :: label
     character(len=16) :: caux(ncaux)
     ! -- local
     character(len=400) buf
     ! -- constant
     character(len=1) DASH(400)
     data dash/400*'-'/
     ! -- formats
     character(len=*), parameter :: fmtmsgout1 = "(1x, a)"
     character(len=*), parameter :: fmtmsgout2 = "(1x, 400a)"
     !
     ! -- Construct the complete label in BUF.  Start with BUF=LABEL.
     buf = label
     !
     ! -- Add auxiliary data names if there are any.
     nbuf = len(label) + 9
     if (naux > 0) then
       do i = 1, naux
         n1 = nbuf + 1
         nbuf = nbuf + 16
         buf(n1:nbuf) = caux(i)
       end do
     end if
     !
     ! -- Write the label.
     write (iout, fmtmsgout1) buf(1:nbuf)
     !
     ! -- Add a line of dashes.
     write (iout, fmtmsgout2) (dash(j), j=1, nbuf)

Here is the caller graph for this function:

◆ unitinquire()

subroutine, public inputoutputmodule::unitinquire ( integer(i4b) iu )

Definition at line 1098 of file InputOutput.f90.

     ! -- dummy
     integer(I4B) :: iu
     ! -- local
     character(len=LINELENGTH) :: line
     character(len=100) :: fname, ac, act, fm, frm, seq, unf
     ! -- format
     character(len=*), parameter :: fmta = &
        &"('unit:',i4,'  name:',a,'  access:',a,'  action:',a)"
     character(len=*), parameter :: fmtb = &
        &"('    formatted:',a,'  sequential:',a,'  unformatted:',a,'  form:',a)"
     !
     ! -- set strings using inquire statement
     inquire (unit=iu, name=fname, access=ac, action=act, formatted=fm, &
              sequential=seq, unformatted=unf, form=frm)
     !
     ! -- write the results of the inquire statement
     write (line, fmta) iu, trim(fname), trim(ac), trim(act)
     call write_message(line)
     write (line, fmtb) trim(fm), trim(seq), trim(unf), trim(frm)
     call write_message(line)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ upcase()

subroutine, public inputoutputmodule::upcase ( character(len=*), intent(inout) word )

Subroutine to convert a character string to upper case.

Parameters

[in,out] word word to convert to upper case

Definition at line 201 of file InputOutput.f90.

     implicit none
     ! -- dummy
     character(len=*), intent(inout) :: word !< word to convert to upper case
     ! -- local
     integer(I4B) :: l
     integer(I4B) :: idiff
     integer(I4B) :: k
     !
     ! -- Compute the difference between lowercase and uppercase.
     l = len(word)
     idiff = ichar('a') - ichar('A')
     !
     ! -- Loop through the string and convert any lowercase characters.
     do k = 1, l
       IF (word(k:k) >= 'a' .and. word(k:k) <= 'z') &
         word(k:k) = char(ichar(word(k:k)) - idiff)
     end do

Here is the caller graph for this function:

◆ urdaux()

subroutine, public inputoutputmodule::urdaux	(	integer(i4b), intent(inout)	naux,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout,
		integer(i4b), intent(inout)	lloc,
		integer(i4b), intent(inout)	istart,
		integer(i4b), intent(inout)	istop,
		character(len=lenauxname), dimension(:), intent(inout), allocatable	auxname,
		character(len=*), intent(inout)	line,
		character(len=*), intent(in)	text
	)

Definition at line 1335 of file InputOutput.f90.

     ! -- modules
     use arrayhandlersmodule, only: expandarray
     use constantsmodule, only: lenauxname
     ! -- implicit
     implicit none
     ! -- dummy
     integer(I4B), intent(inout) :: naux
     integer(I4B), intent(in) :: inunit
     integer(I4B), intent(in) :: iout
     integer(I4B), intent(inout) :: lloc
     integer(I4B), intent(inout) :: istart
     integer(I4B), intent(inout) :: istop
     character(len=LENAUXNAME), allocatable, dimension(:), intent(inout) :: auxname
     character(len=*), intent(inout) :: line
     character(len=*), intent(in) :: text
     ! -- local
     integer(I4B) :: n, linelen
     integer(I4B) :: iauxlen
     real(DP) :: rval
     !
     linelen = len(line)
     if (naux > 0) then
       write (errmsg, '(a)') 'Auxiliary variables already specified. '// &
         & 'Auxiliary variables must be specified on one line in the '// &
         & 'options block.'
       call store_error(errmsg)
       call store_error_unit(inunit)
     end if
     auxloop: do
       call urword(line, lloc, istart, istop, 1, n, rval, iout, inunit)
       if (istart >= linelen) exit auxloop
       iauxlen = istop - istart + 1
       if (iauxlen > lenauxname) then
         write (errmsg, '(a, a, a, i0, a, i0, a)') &
           'Found auxiliary variable (', line(istart:istop), &
           ') with a name of size ', iauxlen, &
           '. Auxiliary variable names must be len than or equal&
           & to ', lenauxname, ' characters.'
         call store_error(errmsg)
         call store_error_unit(inunit)
       end if
       naux = naux + 1
       call expandarray(auxname)
       auxname(naux) = line(istart:istop)
       if (iout > 0) then
         write (iout, "(4X,'AUXILIARY ',a,' VARIABLE: ',A)") &
           trim(adjustl(text)), auxname(naux)
       end if
     end do auxloop

Here is the call graph for this function:

Here is the caller graph for this function:

◆ urword()

subroutine, public inputoutputmodule::urword	(	character(len=*)	line,
		integer(i4b), intent(inout)	icol,
		integer(i4b), intent(inout)	istart,
		integer(i4b), intent(inout)	istop,
		integer(i4b), intent(in)	ncode,
		integer(i4b), intent(inout)	n,
		real(dp), intent(inout)	r,
		integer(i4b), intent(in)	iout,
		integer(i4b), intent(in)	in
	)

Subroutine to extract a word from a line of text, and optionally convert the word to a number. The last character in the line is set to blank so that if any problems occur with finding a word, istart and istop will point to this blank character. Thus, a word will always be returned unless there is a numeric conversion error. Be sure that the last character in line is not an important character because it will always be set to blank.

A word starts with the first character that is not a space or comma, and ends when a subsequent character that is a space or comma. Note that these parsing rules do not treat two commas separated by one or more spaces as a null word.

For a word that begins with "'" or '"', the word starts with the character after the quote and ends with the character preceding a subsequent quote. Thus, a quoted word can include spaces and commas. The quoted word cannot contain a quote character of the same type within the word but can contain a different quote character. For example, "WORD'S" or 'WORD"S'.

Number conversion error is written to unit iout if iout is positive; error is written to default output if iout is 0; no error message is written if iout is negative.

Parameters

	line	line to parse
[in,out]	icol	current column in line
[in,out]	istart	starting character position of the word
[in,out]	istop	ending character position of the word
[in]	ncode	word conversion flag (1) upper case, (2) integer, (3) real number
[in,out]	n	integer data type
[in,out]	r	float data type
[in]	iout	output listing file unit
[in]	in	input file unit number

Definition at line 420 of file InputOutput.f90.

     ! -- dummy
     character(len=*) :: line !< line to parse
     integer(I4B), intent(inout) :: icol !< current column in line
     integer(I4B), intent(inout) :: istart !< starting character position of the word
     integer(I4B), intent(inout) :: istop !< ending character position of the word
     integer(I4B), intent(in) :: ncode !< word conversion flag (1) upper case, (2) integer, (3) real number
     integer(I4B), intent(inout) :: n !< integer data type
     real(DP), intent(inout) :: r !< float data type
     integer(I4B), intent(in) :: iout !< output listing file unit
     integer(I4B), intent(in) :: in !< input file unit number
     ! -- local
     character(len=20) string
     character(len=1) tab
     character(len=1) charend
     character(len=200) :: msg
     character(len=linelength) :: msg_line
     ! -- formats
     character(len=*), parameter :: fmtmsgout1 = &
       "(1X,'FILE UNIT ',I4,' : ERROR CONVERTING ""',A, &
       & '"" TO ',A,' IN LINE:')"
     character(len=*), parameter :: fmtmsgout2 = "(1x, &
       & 'KEYBOARD INPUT : ERROR CONVERTING ""',a,'"" TO ',a,' IN LINE:')"
     character(len=*), parameter :: fmtmsgout3 = "('File unit ', &
       & I0,': Error converting ""',a,'"" to ',A,' in following line:')"
     character(len=*), parameter :: fmtmsgout4 = &
       "('Keyboard input: Error converting ""',a, &
       & '"" to ',A,' in following line:')"
     !
     tab = char(9)
     !
     ! -- Set last char in LINE to blank and set ISTART and ISTOP to point
     !    to this blank as a default situation when no word is found.  If
     !    starting location in LINE is out of bounds, do not look for a word.
     linlen = len(line)
     line(linlen:linlen) = ' '
     istart = linlen
     istop = linlen
     linlen = linlen - 1
     if (icol < 1 .or. icol > linlen) go to 100
     !
     ! -- Find start of word, which is indicated by first character that
     !    is not a blank, a comma, or a tab.
     do i = icol, linlen
       if (line(i:i) /= ' ' .and. line(i:i) /= ',' .and. &
           line(i:i) /= tab) go to 20
     end do
     icol = linlen + 1
     go to 100
     !
     ! -- Found start of word.  Look for end.
     !    When word is quoted, only a quote can terminate it.
     !    search for a single (char(39)) or double (char(34)) quote
 20  if (line(i:i) == char(34) .or. line(i:i) == char(39)) then
       if (line(i:i) == char(34)) then
         charend = char(34)
       else
         charend = char(39)
       end if
       i = i + 1
       if (i <= linlen) then
         do j = i, linlen
           if (line(j:j) == charend) go to 40
         end do
       end if
       !
       ! -- When word is not quoted, space, comma, or tab will terminate.
     else
       do j = i, linlen
         if (line(j:j) == ' ' .or. line(j:j) == ',' .or. &
             line(j:j) == tab) go to 40
       end do
     end if
     !
     ! -- End of line without finding end of word; set end of word to
     !    end of line.
     j = linlen + 1
     !
     ! -- Found end of word; set J to point to last character in WORD and
     !    set ICOL to point to location for scanning for another word.
 40  icol = j + 1
     j = j - 1
     if (j < i) go to 100
     istart = i
     istop = j
     !
     ! -- Convert word to upper case and RETURN if NCODE is 1.
     if (ncode == 1) then
       idiff = ichar('a') - ichar('A')
       do k = istart, istop
         if (line(k:k) >= 'a' .and. line(k:k) <= 'z') &
           line(k:k) = char(ichar(line(k:k)) - idiff)
       end do
       return
     end if
     !
     ! -- Convert word to a number if requested.
 100 if (ncode == 2 .or. ncode == 3) then
       l = istop - istart + 1
       if (l < 1) go to 200
       if (istart > linlen) then
         ! support legacy urword behavior to return a zero value when
         ! no more data is on the line
         if (ncode == 2) n = 0
         if (ncode == 3) r = dzero
       else
         if (ncode == 2) read (line(istart:istop), *, err=200) n
         if (ncode == 3) read (line(istart:istop), *, err=200) r
       end if
     end if
     return
     !
     ! -- Number conversion error.
 200 if (ncode == 3) then
       string = 'a real number'
       l = 13
     else
       string = 'an integer'
       l = 10
     end if
     !
     ! -- If output unit is negative, set last character of string to 'E'.
     if (iout < 0) then
       n = 0
       r = 0.
       line(linlen + 1:linlen + 1) = 'E'
       return
       !
       ! -- If output unit is positive; write a message to output unit.
     else if (iout > 0) then
       if (in > 0) then
         write (msg_line, fmtmsgout1) in, line(istart:istop), string(1:l)
       else
         write (msg_line, fmtmsgout2) line(istart:istop), string(1:l)
       end if
       call write_message(msg_line, iunit=iout, skipbefore=1)
       call write_message(line, iunit=iout, fmt='(1x,a)')
       !
       ! -- If output unit is 0; write a message to default output.
     else
       if (in > 0) then
         write (msg_line, fmtmsgout1) in, line(istart:istop), string(1:l)
       else
         write (msg_line, fmtmsgout2) line(istart:istop), string(1:l)
       end if
       call write_message(msg_line, iunit=iout, skipbefore=1)
       call write_message(line, iunit=iout, fmt='(1x,a)')
     end if
     !
     ! -- STOP after storing error message.
     call lowcase(string)
     if (in > 0) then
       write (msg, fmtmsgout3) in, line(istart:istop), trim(string)
     else
       write (msg, fmtmsgout4) line(istart:istop), trim(string)
     end if
     !
     call store_error(msg)
     call store_error(trim(line))
     call store_error_unit(in)

Here is the call graph for this function:

◆ uwword()

subroutine, public inputoutputmodule::uwword	(	character(len=*), intent(inout)	line,
		integer(i4b), intent(inout)	icol,
		integer(i4b), intent(in)	ilen,
		integer(i4b), intent(in)	ncode,
		character(len=*), intent(in)	c,
		integer(i4b), intent(in)	n,
		real(dp), intent(in)	r,
		character(len=*), intent(in), optional	fmt,
		integer(i4b), intent(in), optional	alignment,
		character(len=*), intent(in), optional	sep
	)

Subroutine to create a formatted line with specified alignment and column separators. Like URWORD, UWWORD works with strings, integers, and floats. Can pass an optional format statement, alignment, and column separator.

Parameters

[in,out]	icol	column to write to line
[in]	ilen	current length of line
[in]	ncode	code for data type to write
[in]	c	character data type
[in]	n	integer data type
[in]	r	float data type
[in]	fmt	format statement
[in]	alignment	alignment specifier
[in]	sep	column separator

Definition at line 282 of file InputOutput.f90.

     implicit none
     ! -- dummy
     character(len=*), intent(inout) :: line !< line
     integer(I4B), intent(inout) :: icol !< column to write to line
     integer(I4B), intent(in) :: ilen !< current length of line
     integer(I4B), intent(in) :: ncode !< code for data type to write
     character(len=*), intent(in) :: c !< character data type
     integer(I4B), intent(in) :: n !< integer data type
     real(DP), intent(in) :: r !< float data type
     character(len=*), optional, intent(in) :: fmt !< format statement
     integer(I4B), optional, intent(in) :: alignment !< alignment specifier
     character(len=*), optional, intent(in) :: sep !< column separator
     ! -- local
     character(len=16) :: cfmt
     character(len=16) :: cffmt
     character(len=ILEN) :: cval
     integer(I4B) :: ialign
     integer(I4B) :: i
     integer(I4B) :: ispace
     integer(I4B) :: istop
     integer(I4B) :: ipad
     integer(I4B) :: ireal
     !
     ! -- initialize locals
     ipad = 0
     ireal = 0
     !
     ! -- process dummy variables
     if (present(fmt)) then
       cfmt = fmt
     else
       select case (ncode)
       case (tabstring, tabucstring)
         write (cfmt, '(a,I0,a)') '(a', ilen, ')'
       case (tabinteger)
         write (cfmt, '(a,I0,a)') '(I', ilen, ')'
       case (tabreal)
         ireal = 1
         i = ilen - 7
         write (cfmt, '(a,I0,a,I0,a)') '(1PG', ilen, '.', i, ')'
         if (r >= dzero) then
           ipad = 1
         end if
       end select
     end if
     write (cffmt, '(a,I0,a)') '(a', ilen, ')'
     !
     if (present(alignment)) then
       ialign = alignment
     else
       ialign = tabright
     end if
     !
     if (ncode == tabstring .or. ncode == tabucstring) then
       cval = c
       if (ncode == tabucstring) then
         call upcase(cval)
       end if
     else if (ncode == tabinteger) then
       write (cval, cfmt) n
     else if (ncode == tabreal) then
       write (cval, cfmt) r
     end if
     !
     ! -- Apply alignment to cval
     if (len_trim(adjustl(cval)) > ilen) then
       cval = adjustl(cval)
     else
       cval = trim(adjustl(cval))
     end if
     if (ialign == tabcenter) then
       i = len_trim(cval)
       ispace = (ilen - i) / 2
       if (ireal > 0) then
         if (ipad > 0) then
           cval = ' '//trim(adjustl(cval))
         else
           cval = trim(adjustl(cval))
         end if
       else
         cval = repeat(' ', ispace)//trim(cval)
       end if
     else if (ialign == tableft) then
       cval = trim(adjustl(cval))
       if (ipad > 0) then
         cval = ' '//trim(adjustl(cval))
       end if
     else
       cval = adjustr(cval)
     end if
     if (ncode == tabucstring) then
       call upcase(cval)
     end if
     !
     ! -- Increment istop to the end of the column
     istop = icol + ilen - 1
     !
     ! -- Write final string to line
     write (line(icol:istop), cffmt) cval
     !
     icol = istop + 1
     !
     if (present(sep)) then
       i = len(sep)
       istop = icol + i
       write (line(icol:istop), '(a)') sep
       icol = istop
     end if

Here is the call graph for this function:

Here is the caller graph for this function:

Functions/Subroutines

Function/Subroutine Documentation

◆ append_processor_id()

◆ assign_iounit()

◆ buildfixedformat()

◆ buildfloatformat()

◆ buildintformat()

◆ extract_idnum_or_bndname()

◆ freeunitnumber()

◆ fseek_stream()

◆ get_line()

◆ get_nwords()

◆ getfilefrompath()

◆ getunit()

◆ lowcase()

◆ openfile()

◆ parseline()

◆ print_format()

◆ read_line()

◆ same_word()

◆ str_pad_left()

◆ u9rdcom()

◆ ubdsv06()

◆ ubdsv1()

◆ ubdsv4()

◆ ubdsvb()

◆ ubdsvc()

◆ ubdsvd()

◆ ucolno()

◆ ulaprufw()

◆ ulaprw()

◆ ulasav()

◆ ulstlb()

◆ unitinquire()

◆ upcase()

◆ urdaux()

◆ urword()

◆ uwword()