fix(uzf): rename uzf package variables to avoid name clashes (MODFLOW…

…-USGS#1742)

* fix(uzf): rename uzf package variables to avoid name clashes

* 9 uzf variables had counterparts in uzf%uzfobj with the same memory path
* renamed the uzf package variables by adding _pvar to them
* close MODFLOW-USGS#1741

This does not fix underlying memory problems with UZF.  Instead it is a simple way to avoid multiple uzf variables with the same memory path.  A proper fix will require additional work as the variable contents in uzf and uzf%uzfobj are not the same.

* fprettifying

* clean up a few variables that can be replaced with dis%top, dis%bot, and dis%area

* gwet was named to gwet_pvar

* fprettify

src/Model/GroundWaterFlow/gwf-uzf.f90

@@ -61,15 +61,12 @@ module UzfModule
  !
  ! -- pointer to gwf variables
  integer(I4B), pointer :: gwfiss => null()
- real(DP), dimension(:), pointer, contiguous :: gwftop => null()
- real(DP), dimension(:), pointer, contiguous :: gwfbot => null()
- real(DP), dimension(:), pointer, contiguous :: gwfarea => null()
  real(DP), dimension(:), pointer, contiguous :: gwfhcond => null()
  !
  ! -- uzf data
- integer(I4B), pointer :: ntrail => null()
+ integer(I4B), pointer :: nwav_pvar => null()
+ integer(I4B), pointer :: ntrail_pvar => null()
  integer(I4B), pointer :: nsets => null()
- integer(I4B), pointer :: nwav => null()
  integer(I4B), pointer :: nodes => null()
  integer(I4B), pointer :: readflag => null()
  integer(I4B), pointer :: ietflag => null() !< et flag, 0 is off, 1 or 2 are different types
@@ -87,7 +84,7 @@ module UzfModule
  real(DP), dimension(:), pointer, contiguous :: rejinf0 => null()
  real(DP), dimension(:), pointer, contiguous :: rejinftomvr => null()
  real(DP), dimension(:), pointer, contiguous :: infiltration => null()
- real(DP), dimension(:), pointer, contiguous :: gwet => null()
+ real(DP), dimension(:), pointer, contiguous :: gwet_pvar => null()
  real(DP), dimension(:), pointer, contiguous :: uzet => null()
  real(DP), dimension(:), pointer, contiguous :: gwd => null()
  real(DP), dimension(:), pointer, contiguous :: gwd0 => null()
@@ -98,14 +95,17 @@ module UzfModule
  real(DP), dimension(:), pointer, contiguous :: wcnew => null() !< water content for this time step
  real(DP), dimension(:), pointer, contiguous :: wcold => null() !< water content for previous time step
  !
- ! -- timeseries aware variables
- real(DP), dimension(:), pointer, contiguous :: sinf => null()
- real(DP), dimension(:), pointer, contiguous :: pet => null()
+ ! -- timeseries aware package variables; these variables with
+ ! _pvar have uzfobj counterparts
+ real(DP), dimension(:), pointer, contiguous :: sinf_pvar => null()
+ real(DP), dimension(:), pointer, contiguous :: pet_pvar => null()
  real(DP), dimension(:), pointer, contiguous :: extdp => null()
- real(DP), dimension(:), pointer, contiguous :: extwc => null()
- real(DP), dimension(:), pointer, contiguous :: ha => null()
- real(DP), dimension(:), pointer, contiguous :: hroot => null()
- real(DP), dimension(:), pointer, contiguous :: rootact => null()
+ real(DP), dimension(:), pointer, contiguous :: extwc_pvar => null()
+ real(DP), dimension(:), pointer, contiguous :: ha_pvar => null()
+ real(DP), dimension(:), pointer, contiguous :: hroot_pvar => null()
+ real(DP), dimension(:), pointer, contiguous :: rootact_pvar => null()
+ !
+ ! -- aux variable
  real(DP), dimension(:, :), pointer, contiguous :: uauxvar => null()
  !
  ! -- convergence check
@@ -281,7 +281,7 @@ subroutine uzf_allocate_arrays(this)
  this%memoryPath)
  call mem_allocate(this%infiltration, this%nodes, 'INFILTRATION', &
  this%memoryPath)
- call mem_allocate(this%gwet, this%nodes, 'GWET', this%memoryPath)
+ call mem_allocate(this%gwet_pvar, this%nodes, 'GWET_PVAR', this%memoryPath)
  call mem_allocate(this%uzet, this%nodes, 'UZET', this%memoryPath)
  call mem_allocate(this%gwd, this%nodes, 'GWD', this%memoryPath)
  call mem_allocate(this%gwd0, this%nodes, 'GWD0', this%memoryPath)
@@ -296,13 +296,14 @@ subroutine uzf_allocate_arrays(this)
  call mem_allocate(this%ja, this%nodes, 'JA', this%memoryPath)
  !
  ! -- allocate timeseries aware variables
- call mem_allocate(this%sinf, this%nodes, 'SINF', this%memoryPath)
- call mem_allocate(this%pet, this%nodes, 'PET', this%memoryPath)
- call mem_allocate(this%extdp, this%nodes, 'EXDP', this%memoryPath)
- call mem_allocate(this%extwc, this%nodes, 'EXTWC', this%memoryPath)
- call mem_allocate(this%ha, this%nodes, 'HA', this%memoryPath)
- call mem_allocate(this%hroot, this%nodes, 'HROOT', this%memoryPath)
- call mem_allocate(this%rootact, this%nodes, 'ROOTACT', this%memoryPath)
+ call mem_allocate(this%sinf_pvar, this%nodes, 'SINF_PVAR', this%memoryPath)
+ call mem_allocate(this%pet_pvar, this%nodes, 'PET_PVAR', this%memoryPath)
+ call mem_allocate(this%extdp, this%nodes, 'EXDP_PVAR', this%memoryPath)
+ call mem_allocate(this%extwc_pvar, this%nodes, 'EXTWC_PVAR', this%memoryPath)
+ call mem_allocate(this%ha_pvar, this%nodes, 'HA_PVAR', this%memoryPath)
+ call mem_allocate(this%hroot_pvar, this%nodes, 'HROOT_PVAR', this%memoryPath)
+ call mem_allocate(this%rootact_pvar, this%nodes, 'ROOTACT_PVAR', &
+ this%memoryPath)
  call mem_allocate(this%uauxvar, this%naux, this%nodes, 'UAUXVAR', &
  this%memoryPath)
  !
@@ -312,7 +313,7 @@ subroutine uzf_allocate_arrays(this)
  this%rejinf(i) = DZERO
  this%rejinf0(i) = DZERO
  this%rejinftomvr(i) = DZERO
- this%gwet(i) = DZERO
+ this%gwet_pvar(i) = DZERO
  this%uzet(i) = DZERO
  this%gwd(i) = DZERO
  this%gwd0(i) = DZERO
@@ -324,13 +325,13 @@ subroutine uzf_allocate_arrays(this)
  ! -- integer variables
  this%ja(i) = 0
  ! -- timeseries aware variables
- this%sinf(i) = DZERO
- this%pet(i) = DZERO
+ this%sinf_pvar(i) = DZERO
+ this%pet_pvar(i) = DZERO
  this%extdp(i) = DZERO
- this%extwc(i) = DZERO
- this%ha(i) = DZERO
- this%hroot(i) = DZERO
- this%rootact(i) = DZERO
+ this%extwc_pvar(i) = DZERO
+ this%ha_pvar(i) = DZERO
+ this%hroot_pvar(i) = DZERO
+ this%rootact_pvar(i) = DZERO
  do j = 1, this%naux
  if (this%iauxmultcol > 0 .and. j == this%iauxmultcol) then
  this%uauxvar(j, i) = DONE
@@ -533,7 +534,7 @@ subroutine uzf_readdimensions(this)
  !
  ! -- initialize dimensions to -1
  this%nodes = -1
- this%ntrail = 0
+ this%ntrail_pvar = 0
  this%nsets = 0
  !
  ! -- get dimensions block
@@ -553,8 +554,8 @@ subroutine uzf_readdimensions(this)
  this%nodes = this%parser%GetInteger()
  write (this%iout, '(4x,a,i0)') 'NUZFCELLS = ', this%nodes
  case ('NTRAILWAVES')
- this%ntrail = this%parser%GetInteger()
- write (this%iout, '(4x,a,i0)') 'NTRAILWAVES = ', this%ntrail
+ this%ntrail_pvar = this%parser%GetInteger()
+ write (this%iout, '(4x,a,i0)') 'NTRAILWAVES = ', this%ntrail_pvar
  case ('NWAVESETS')
  this%nsets = this%parser%GetInteger()
  write (this%iout, '(4x,a,i0)') 'NTRAILSETS = ', this%nsets
@@ -580,7 +581,7 @@ subroutine uzf_readdimensions(this)
  call store_error(errmsg)
  end if
 
- if (this%ntrail <= 0) then
+ if (this%ntrail_pvar <= 0) then
  write (errmsg, '(a)') &
  'NTRAILWAVES was not specified or was specified incorrectly.'
  call store_error(errmsg)
@@ -598,7 +599,7 @@ subroutine uzf_readdimensions(this)
  end if
  !
  ! -- set the number of waves
- this%nwav = this%ntrail * this%nsets
+ this%nwav_pvar = this%ntrail_pvar * this%nsets
  !
  ! -- Call define_listlabel to construct the list label that is written
  ! when PRINT_INPUT option is used.
@@ -609,13 +610,8 @@ subroutine uzf_readdimensions(this)
  !
  ! -- initialize uzf group object
  allocate (this%uzfobj)
- call this%uzfobj%init(this%nodes, this%nwav, this%memoryPath)
- call this%uzfobjwork%init(1, this%nwav)
- !
- ! -- Set pointers to GWF model arrays
- call mem_setptr(this%gwftop, 'TOP', create_mem_path(this%name_model, 'DIS'))
- call mem_setptr(this%gwfbot, 'BOT', create_mem_path(this%name_model, 'DIS'))
- call mem_setptr(this%gwfarea, 'AREA', create_mem_path(this%name_model, 'DIS'))
+ call this%uzfobj%init(this%nodes, this%nwav_pvar, this%memoryPath)
+ call this%uzfobjwork%init(1, this%nwav_pvar)
  !
  !--Read uzf cell properties and set values
  call this%read_cell_properties()
@@ -795,15 +791,15 @@ subroutine uzf_rp(this)
  ! -- FINF
  call this%parser%GetStringCaps(text)
  jj = 1 ! For SINF
- bndElem => this%sinf(i)
+ bndElem => this%sinf_pvar(i)
  call read_value_or_time_series_adv(text, i, jj, bndElem, this%packName, &
  'BND', this%tsManager, this%iprpak, &
  'SINF')
  !
  ! -- PET
  call this%parser%GetStringCaps(text)
  jj = 1 ! For PET
- bndElem => this%pet(i)
+ bndElem => this%pet_pvar(i)
  call read_value_or_time_series_adv(text, i, jj, bndElem, this%packName, &
  'BND', this%tsManager, this%iprpak, &
  'PET')
@@ -819,31 +815,31 @@ subroutine uzf_rp(this)
  ! -- EXTWC
  call this%parser%GetStringCaps(text)
  jj = 1 ! For EXTWC
- bndElem => this%extwc(i)
+ bndElem => this%extwc_pvar(i)
  call read_value_or_time_series_adv(text, i, jj, bndElem, this%packName, &
  'BND', this%tsManager, this%iprpak, &
  'EXTWC')
  !
  ! -- HA
  call this%parser%GetStringCaps(text)
  jj = 1 ! For HA
- bndElem => this%ha(i)
+ bndElem => this%ha_pvar(i)
  call read_value_or_time_series_adv(text, i, jj, bndElem, this%packName, &
  'BND', this%tsManager, this%iprpak, &
  'HA')
  !
  ! -- HROOT
  call this%parser%GetStringCaps(text)
  jj = 1 ! For HROOT
- bndElem => this%hroot(i)
+ bndElem => this%hroot_pvar(i)
  call read_value_or_time_series_adv(text, i, jj, bndElem, this%packName, &
  'BND', this%tsManager, this%iprpak, &
  'HROOT')
  !
  ! -- ROOTACT
  call this%parser%GetStringCaps(text)
  jj = 1 ! For ROOTACT
- bndElem => this%rootact(i)
+ bndElem => this%rootact_pvar(i)
  call read_value_or_time_series_adv(text, i, jj, bndElem, this%packName, &
  'BND', this%tsManager, this%iprpak, &
  'ROOTACT')
@@ -871,15 +867,15 @@ subroutine uzf_rp(this)
  ! -- write data to the table
  call this%inputtab%add_term(i)
  call this%inputtab%add_term(cellid)
- call this%inputtab%add_term(this%sinf(i))
+ call this%inputtab%add_term(this%sinf_pvar(i))
  if (this%ietflag /= 0) then
- call this%inputtab%add_term(this%pet(i))
+ call this%inputtab%add_term(this%pet_pvar(i))
  call this%inputtab%add_term(this%extdp(i))
- call this%inputtab%add_term(this%extwc(i))
+ call this%inputtab%add_term(this%extwc_pvar(i))
  if (this%ietflag == 2) then
- call this%inputtab%add_term(this%ha(i))
- call this%inputtab%add_term(this%hroot(i))
- call this%inputtab%add_term(this%rootact(i))
+ call this%inputtab%add_term(this%ha_pvar(i))
+ call this%inputtab%add_term(this%hroot_pvar(i))
+ call this%inputtab%add_term(this%rootact_pvar(i))
  end if
  end if
  if (this%inamedbound == 1) then
@@ -991,22 +987,22 @@ subroutine uzf_ad(this)
  end if
  !
  ! -- FINF
- rval1 = this%sinf(i)
+ rval1 = this%sinf_pvar(i)
  call this%uzfobj%setdatafinf(i, rval1)
  !
  ! -- PET, EXTDP
- rval1 = this%pet(i)
+ rval1 = this%pet_pvar(i)
  rval2 = this%extdp(i)
  call this%uzfobj%setdataet(i, ivertflag, rval1, rval2)
  !
  ! -- ETWC
- rval1 = this%extwc(i)
+ rval1 = this%extwc_pvar(i)
  call this%uzfobj%setdataetwc(i, ivertflag, rval1)
  !
  ! -- HA, HROOT, ROOTACT
- rval1 = this%ha(i)
- rval2 = this%hroot(i)
- rval3 = this%rootact(i)
+ rval1 = this%ha_pvar(i)
+ rval2 = this%hroot_pvar(i)
+ rval3 = this%rootact_pvar(i)
  call this%uzfobj%setdataetha(i, ivertflag, rval1, rval2, rval3)
  end do
  !
@@ -1435,7 +1431,7 @@ subroutine uzf_cq(this, x, flowja, iadv)
  this%gwd(i) = q
  !
  ! -- calculate and store remaining budget terms
- this%gwet(i) = this%uzfobj%gwet(i)
+ this%gwet_pvar(i) = this%uzfobj%gwet(i)
  this%uzet(i) = this%uzfobj%etact(i) * this%uzfobj%uzfarea(i) / delt
  !
  ! -- End of UZF cell loop
@@ -1518,7 +1514,7 @@ subroutine uzf_bd(this, model_budget)
  !
  ! -- groundwater et (gwet array is positive, so switch ratin/ratout)
  if (this%igwetflag /= 0) then
- call rate_accumulator(-this%gwet, ratin, ratout)
+ call rate_accumulator(-this%gwet_pvar, ratin, ratout)
  call model_budget%addentry(ratin, ratout, delt, this%bdtxt(4), &
  isuppress_output, this%packName)
  end if
@@ -1593,7 +1589,7 @@ subroutine uzf_ot_model_flows(this, icbcfl, ibudfl, icbcun, imap)
  trim(this%packName)//') FLOW RATES'
  call save_print_model_flows(icbcfl, ibudfl, icbcun, this%iprflow, &
  this%outputtab, this%nbound, this%nodelist, &
- -this%gwet, this%ibound, title, &
+ -this%gwet_pvar, this%ibound, title, &
  this%bdtxt(itxt), this%ipakcb, this%dis, &
  this%naux, this%name_model, this%name_model, &
  this%name_model, this%packName, this%auxname, &
@@ -1968,7 +1964,7 @@ subroutine read_cell_properties(this)
  'must be greater than 0 (specified value is', surfdep, ').'
  call store_error(errmsg)
  end if
- if (surfdep >= this%GWFTOP(ic) - this%GWFBOT(ic)) then
+ if (surfdep >= this%dis%top(ic) - this%dis%bot(ic)) then
  write (errmsg, '(a,1x,i0,1x,a)') &
  'SURFDEP for uzf cell', i, &
  'cannot be greater than the cell thickness.'
@@ -2029,9 +2025,10 @@ subroutine read_cell_properties(this)
  ! -- set data if there are no data errors
  if (count_errors() == 0) then
  n = this%igwfnode(i)
- call this%uzfobj%setdata(i, this%gwfarea(n), this%gwftop(n), &
- this%gwfbot(n), surfdep, vks, thtr, thts, &
- thti, eps, this%ntrail, landflag, ivertcon)
+ call this%uzfobj%setdata(i, this%dis%area(n), this%dis%top(n), &
+ this%dis%bot(n), surfdep, vks, thtr, thts, &
+ thti, eps, this%ntrail_pvar, landflag, &
+ ivertcon)
  if (ivertcon > 0) then
  this%iuzf2uzf = 1
  end if
@@ -2388,7 +2385,7 @@ subroutine uzf_bd_obs(this)
  end if
  case ('UZF-GWET')
  if (this%igwetflag > 0) then
- v = this%gwet(n)
+ v = this%gwet_pvar(n)
  if (v > DZERO) then
  v = -v
  end if
@@ -2528,7 +2525,7 @@ subroutine uzf_rp_obs(this)
  !
  ! -- determine maximum cell depth
  ! -- This is presently complicated for landflag = 1 cells and surfdep
- ! greater than zero. In this case, celtop is gwftop - surfdep.
+ ! greater than zero. In this case, celtop is dis%top - surfdep.
  iuzid = obsrv%intPak1
  dmax = this%uzfobj%celtop(iuzid) - this%uzfobj%celbot(iuzid)
  ! -- check that obs depth is valid; call store_error if not
@@ -2641,11 +2638,11 @@ subroutine uzf_allocate_scalars(this)
  call mem_allocate(this%ibudgetout, 'IBUDGETOUT', this%memoryPath)
  call mem_allocate(this%ibudcsv, 'IBUDCSV', this%memoryPath)
  call mem_allocate(this%ipakcsv, 'IPAKCSV', this%memoryPath)
- call mem_allocate(this%ntrail, 'NTRAIL', this%memoryPath)
+ call mem_allocate(this%ntrail_pvar, 'NTRAIL', this%memoryPath)
  call mem_allocate(this%nsets, 'NSETS', this%memoryPath)
  call mem_allocate(this%nodes, 'NODES', this%memoryPath)
  call mem_allocate(this%istocb, 'ISTOCB', this%memoryPath)
- call mem_allocate(this%nwav, 'NWAV', this%memoryPath)
+ call mem_allocate(this%nwav_pvar, 'NWAV_PVAR', this%memoryPath)
  call mem_allocate(this%totfluxtot, 'TOTFLUXTOT', this%memoryPath)
  call mem_allocate(this%bditems, 'BDITEMS', this%memoryPath)
  call mem_allocate(this%nbdtxt, 'NBDTXT', this%memoryPath)
@@ -2725,11 +2722,11 @@ subroutine uzf_da(this)
  call mem_deallocate(this%ibudgetout)
  call mem_deallocate(this%ibudcsv)
  call mem_deallocate(this%ipakcsv)
- call mem_deallocate(this%ntrail)
+ call mem_deallocate(this%ntrail_pvar)
  call mem_deallocate(this%nsets)
  call mem_deallocate(this%nodes)
  call mem_deallocate(this%istocb)
- call mem_deallocate(this%nwav)
+ call mem_deallocate(this%nwav_pvar)
  call mem_deallocate(this%totfluxtot)
  call mem_deallocate(this%bditems)
  call mem_deallocate(this%nbdtxt)
@@ -2753,7 +2750,7 @@ subroutine uzf_da(this)
  call mem_deallocate(this%rejinf0)
  call mem_deallocate(this%rejinftomvr)
  call mem_deallocate(this%infiltration)
- call mem_deallocate(this%gwet)
+ call mem_deallocate(this%gwet_pvar)
  call mem_deallocate(this%uzet)
  call mem_deallocate(this%gwd)
  call mem_deallocate(this%gwd0)
@@ -2771,13 +2768,13 @@ subroutine uzf_da(this)
  call mem_deallocate(this%ja)
  !
  ! -- deallocate timeseries aware variables
- call mem_deallocate(this%sinf)
- call mem_deallocate(this%pet)
+ call mem_deallocate(this%sinf_pvar)
+ call mem_deallocate(this%pet_pvar)
  call mem_deallocate(this%extdp)
- call mem_deallocate(this%extwc)
- call mem_deallocate(this%ha)
- call mem_deallocate(this%hroot)
- call mem_deallocate(this%rootact)
+ call mem_deallocate(this%extwc_pvar)
+ call mem_deallocate(this%ha_pvar)
+ call mem_deallocate(this%hroot_pvar)
+ call mem_deallocate(this%rootact_pvar)
  call mem_deallocate(this%uauxvar)
  !
  ! -- Parent object