gwf-vsc.f90

Go to the documentation of this file.

! Viscosity Package for representing variable-viscosity groundwater flow
 
module gwfvscmodule
 
  use kindmodule, only: dp, i4b
  use simmodule, only: store_error, store_warning, count_errors, &
                       store_error_filename
  use simvariablesmodule, only: errmsg, warnmsg
  use memorymanagermodule, only: mem_allocate, mem_reallocate, &
                                 mem_deallocate, mem_setptr
  use memoryhelpermodule, only: create_mem_path
  use constantsmodule, only: dhalf, dzero, done, lenmodelname, lenauxname, &
                             dhnoflo, maxcharlen, linelength, lenmempath
  use tdismodule, only: kper, kstp
  use numericalpackagemodule, only: numericalpackagetype
  use basedismodule, only: disbasetype
  use gwfvscinputdatamodule, only: gwfvscinputdatatype
  use listsmodule, only: basemodellist
 
  implicit none
 
  private
  public :: gwfvsctype
  public :: vsc_cr
 
  type :: concentrationpointer
    real(dp), dimension(:), pointer :: conc => null() !< pointer to concentration array
    integer(I4B), dimension(:), pointer :: icbund => null() !< store pointer to gwt ibound array
  end type concentrationpointer
 
  type, extends(numericalpackagetype) :: gwfvsctype
    integer(I4B), pointer :: thermivisc => null() !< viscosity formulation flag (1:Linear, 2:Nonlinear)
    integer(I4B), pointer :: idxtmpr => null() !< if greater than 0 then an index for identifying whether the "species" array is temperature
    integer(I4B), pointer :: ioutvisc => null() !< unit number for saving viscosity
    integer(I4B), pointer :: iconcset => null() !< if 1 then conc points to a gwt (or gwe) model%x array
    integer(I4B), pointer :: ireadelev => null() !< if 1 then elev has been allocated and filled
    integer(I4B), dimension(:), pointer, contiguous :: ivisc => null() !< viscosity formulation flag for each species (1:Linear, 2:Nonlinear)
    real(dp), pointer :: viscref => null() !< reference fluid viscosity
    real(dp), dimension(:), pointer, contiguous :: visc => null() !< viscosity
    real(dp), dimension(:), pointer, contiguous :: elev => null() !< cell center elevation (optional; if not specified, then use (top+bot)/2)
    integer(I4B), dimension(:), pointer :: ibound => null() !< store pointer to ibound
 
    integer(I4B), pointer :: nviscspecies => null() !< number of concentration species used in viscosity equation
    real(dp), dimension(:), pointer, contiguous :: dviscdc => null() !< linear change in viscosity with change in concentration
    real(dp), dimension(:), pointer, contiguous :: cviscref => null() !< reference concentration used in viscosity equation
    real(dp), dimension(:), pointer, contiguous :: ctemp => null() !< temporary array of size (nviscspec) to pass to calc_visc_x
    character(len=LENMODELNAME), dimension(:), allocatable :: cmodelname !< names of gwt (or gwe) models used in viscosity equation
    character(len=LENAUXNAME), dimension(:), allocatable :: cauxspeciesname !< names of aux columns used in viscosity equation
    character(len=LENAUXNAME) :: name_temp_spec = 'TEMPERATURE'
    !
    ! -- Viscosity constants
    real(dp), pointer :: a2 => null() !< an empirical parameter specified by the user for calculating viscosity
    real(dp), pointer :: a3 => null() !< an empirical parameter specified by the user for calculating viscosity
    real(dp), pointer :: a4 => null() !< an empirical parameter specified by the user for calculating viscosity
 
    type(concentrationpointer), allocatable, dimension(:) :: modelconc !< concentration (or temperature) pointer for each solute (or heat) transport model
 
    real(dp), dimension(:), pointer, contiguous :: k11 => null() !< NPF hydraulic conductivity; if anisotropic, then this is Kx prior to rotation
    real(dp), dimension(:), pointer, contiguous :: k22 => null() !< NPF hydraulic conductivity; if specified then this is Ky prior to rotation
    real(dp), dimension(:), pointer, contiguous :: k33 => null() !< NPF hydraulic conductivity; if specified then this is Kz prior to rotation
    real(dp), dimension(:), pointer, contiguous :: k11input => null() !< NPF hydraulic conductivity as originally specified by the user
    real(dp), dimension(:), pointer, contiguous :: k22input => null() !< NPF hydraulic conductivity as originally specified by the user
    real(dp), dimension(:), pointer, contiguous :: k33input => null() !< NPF hydraulic conductivity as originally specified by the user
    integer(I4B), pointer :: kchangeper => null() ! last stress period in which any node K (or K22, or K33) values were changed (0 if unchanged from start of simulation)
    integer(I4B), pointer :: kchangestp => null() ! last time step in which any node K (or K22, or K33) values were changed (0 if unchanged from start of simulation)
    integer(I4B), dimension(:), pointer, contiguous :: nodekchange => null() ! grid array of flags indicating for each node whether its K (or K22, or K33) value changed (1) at (kchangeper, kchangestp) or not (0)
 
  contains
 
    procedure :: vsc_df
    procedure :: vsc_ar
    procedure, public :: vsc_ar_bnd
    procedure :: vsc_rp
    procedure :: vsc_ad
    procedure, public :: vsc_ad_bnd
    procedure :: vsc_ot_dv
    procedure :: vsc_da
    procedure, private :: vsc_calcvisc
    procedure :: allocate_scalars
    procedure, private :: allocate_arrays
    procedure, private :: source_options
    procedure, private :: set_options
    procedure, private :: log_options
    procedure, private :: source_dimensions
    procedure, private :: source_packagedata
    procedure, private :: set_packagedata
    procedure, private :: set_npf_pointers
    procedure, public :: update_k_with_vsc
    procedure, private :: vsc_set_changed_at
    procedure, public :: calc_q_visc
    procedure, public :: get_visc_ratio
    procedure :: set_concentration_pointer
  end type gwfvsctype
 
contains
 
  !> @brief Generic function to calculate changes in fluid viscosity using a
  !! linear formulation
  !<
  function calc_visc(ivisc, viscref, dviscdc, cviscref, conc, &
                     a2, a3, a4) result(visc)
    ! -- dummy
    integer(I4B), dimension(:), intent(in) :: ivisc
    real(dp), intent(in) :: viscref
    real(dp), dimension(:), intent(in) :: dviscdc
    real(dp), dimension(:), intent(in) :: cviscref
    real(dp), dimension(:), intent(in) :: conc
    real(dp), intent(in) :: a2, a3, a4
    ! -- return
    real(dp) :: visc
    ! -- local
    integer(I4B) :: nviscspec
    integer(I4B) :: i
    real(dp) :: mu_t
    real(dp) :: expon
    !
    nviscspec = size(dviscdc)
    visc = viscref
    !
    do i = 1, nviscspec
      if (ivisc(i) == 1) then
        visc = visc + dviscdc(i) * (conc(i) - cviscref(i))
      else
        expon = -1 * a3 * ((conc(i) - cviscref(i)) / &
                           ((conc(i) + a4) * (cviscref(i) + a4)))
        mu_t = viscref * a2**expon
        ! Order matters!! (This assumes we apply the temperature correction after
        ! accounting for solute concentrations)
        ! If a nonlinear correction is applied, then b/c it takes into account
        ! viscref, need to subtract it in this case
        ! At most, there will only ever be 1 nonlinear correction
        visc = (visc - viscref) + mu_t
      end if
      ! end if
    end do
  end function calc_visc
 
  !> @ brief Create a new package object
  !!
  !!  Create a new VSC Package object.
  !<
  subroutine vsc_cr(vscobj, name_model, input_mempath, inunit, iout)
    ! -- dummy
    type(gwfvsctype), pointer :: vscobj
    character(len=*), intent(in) :: name_model
    character(len=*), intent(in) :: input_mempath
    integer(I4B), intent(in) :: inunit
    integer(I4B), intent(in) :: iout
    !
    ! -- Create the object
    allocate (vscobj)
    !
    ! -- create name and memory path
    call vscobj%set_names(1, name_model, 'VSC', 'VSC', input_mempath)
    !
    ! -- Allocate scalars
    call vscobj%allocate_scalars()
    !
    ! -- Set variables
    vscobj%inunit = inunit
    vscobj%iout = iout
  end subroutine vsc_cr
 
  !> @ brief Define viscosity package options and dimensions
  !!
  !!  Define viscosity package options and dimensions
  !<
  subroutine vsc_df(this, dis, vsc_input)
    ! -- dummy
    class(gwfvsctype) :: this !< this viscosity package
    class(disbasetype), pointer, intent(in) :: dis !< pointer to discretization
    type(gwfvscinputdatatype), optional, intent(in) :: vsc_input !< optional vsc input data, otherwise read from file
    ! -- formats
    character(len=*), parameter :: fmtvsc = &
      "(1x,/1x,'VSC -- Viscosity Package, version 1, 11/15/2022', &
      &' input read from mempath: ', a, /)"
    !
    ! --print a message identifying the viscosity package
    write (this%iout, fmtvsc) this%input_mempath
    !
    ! -- store pointers to arguments that were passed in
    this%dis => dis
    !
    if (.not. present(vsc_input)) then
      !
      ! -- Read viscosity options
      call this%source_options()
      !
      ! -- Read viscosity dimensions
      call this%source_dimensions()
    else
      ! set from input data instead
      call this%set_options(vsc_input)
      this%nviscspecies = vsc_input%nviscspecies
    end if
    !
    ! -- Allocate arrays
    call this%allocate_arrays(dis%nodes)
    !
    if (.not. present(vsc_input)) then
      !
      ! -- Read viscosity packagedata
      call this%source_packagedata()
    else
      ! set from input data instead
      call this%set_packagedata(vsc_input)
    end if
  end subroutine vsc_df
 
  !> @ brief Allocate and read method for viscosity package
  !!
  !!  Generic method to allocate and read static data for the viscosity
  !!  package available within the GWF model type.
  !<
  subroutine vsc_ar(this, ibound)
    ! -- dummy
    class(gwfvsctype) :: this
    integer(I4B), dimension(:), pointer :: ibound
    !
    ! -- store pointers to arguments that were passed in
    this%ibound => ibound
    !
    ! -- Set pointers to npf variables
    call this%set_npf_pointers()
  end subroutine vsc_ar
 
  !> @brief Activate viscosity in advanced packages
  !!
  !! Viscosity ar_bnd routine to activate viscosity in the advanced
  !! packages.  This routine is called from gwf_ar() as it moves through each
  !! package
  !<
  subroutine vsc_ar_bnd(this, packobj)
    ! -- modules
    use bndmodule, only: bndtype
    use drnmodule, only: drntype
    use ghbmodule, only: ghbtype
    use rivmodule, only: rivtype
    use lakmodule, only: laktype
    use sfrmodule, only: sfrtype
    use mawmodule, only: mawtype
    ! -- dummy
    class(gwfvsctype) :: this
    class(bndtype), pointer :: packobj
    !
    ! -- Add density terms based on boundary package type
    select case (packobj%filtyp)
    case ('DRN')
      !
      ! -- activate viscosity for the drain package
      select type (packobj)
      type is (drntype)
        call packobj%bnd_activate_viscosity()
      end select
    case ('GHB')
      !
      ! -- activate viscosity for the drain package
      select type (packobj)
      type is (ghbtype)
        call packobj%bnd_activate_viscosity()
      end select
    case ('RIV')
      !
      ! -- activate viscosity for the drain package
      select type (packobj)
      type is (rivtype)
        call packobj%bnd_activate_viscosity()
      end select
    case ('LAK')
      !
      ! -- activate viscosity for lake package
      select type (packobj)
      type is (laktype)
        call packobj%lak_activate_viscosity()
      end select
    case ('SFR')
      !
      ! -- activate viscosity for sfr package
      select type (packobj)
      type is (sfrtype)
        call packobj%sfr_activate_viscosity()
      end select
    case ('MAW')
      !
      ! -- activate viscosity for maw package
      select type (packobj)
      type is (mawtype)
        call packobj%maw_activate_viscosity()
      end select
    case default
      !
      ! -- nothing
    end select
  end subroutine vsc_ar_bnd
 
  !> @brief Set pointers to NPF variables
  !!
  !! Set array and variable pointers from the NPF
  !! package for access by VSC.
  !<
  subroutine set_npf_pointers(this)
    ! -- dummy
    class(gwfvsctype) :: this
    ! -- local
    character(len=LENMEMPATH) :: npfMemoryPath
    !
    ! -- Set pointers to other package variables
    ! -- NPF
    npfmemorypath = create_mem_path(this%name_model, 'NPF')
    call mem_setptr(this%k11, 'K11', npfmemorypath)
    call mem_setptr(this%k22, 'K22', npfmemorypath)
    call mem_setptr(this%k33, 'K33', npfmemorypath)
    call mem_setptr(this%k11input, 'K11INPUT', npfmemorypath)
    call mem_setptr(this%k22input, 'K22INPUT', npfmemorypath)
    call mem_setptr(this%k33input, 'K33INPUT', npfmemorypath)
    call mem_setptr(this%kchangeper, 'KCHANGEPER', npfmemorypath)
    call mem_setptr(this%kchangestp, 'KCHANGESTP', npfmemorypath)
    call mem_setptr(this%nodekchange, 'NODEKCHANGE', npfmemorypath)
  end subroutine set_npf_pointers
 
  !> @ brief Read new period data in viscosity package
  !!
  !!  Method to read and prepare period data for the VSC package.
  !<
  subroutine vsc_rp(this)
    ! -- modules
    use tdismodule, only: kstp, kper
    ! -- dummy
    class(gwfvsctype) :: this
    ! -- local
    integer(I4B) :: i
    ! -- formats
    character(len=*), parameter :: fmtc = &
      "('Viscosity Package does not have a concentration set &
       &for species ',i0,'. One or more model names may be specified &
       &incorrectly in the PACKAGEDATA block or a GWF-GWT exchange may need &
       &to be activated.')"
    !
    ! -- Check to make sure all concentration pointers have been set
    if (kstp * kper == 1) then
      do i = 1, this%nviscspecies
        if (.not. associated(this%modelconc(i)%conc)) then
          write (errmsg, fmtc) i
          call store_error(errmsg)
        end if
      end do
      if (count_errors() > 0) then
        call store_error_filename(this%input_fname)
      end if
    end if
  end subroutine vsc_rp
 
  !> @ brief Advance the viscosity package
  !!
  !!  Advance data in the VSC package. The method sets or advances time series,
  !!  time array series, and observation data.
  !<
  subroutine vsc_ad(this)
    ! -- dummy
    class(gwfvsctype) :: this
    !
    ! -- update viscosity using the latest concentration/temperature
    call this%vsc_calcvisc()
  end subroutine vsc_ad
 
  !> @brief Advance the boundary packages when viscosity is active
  !!
  !! Update the conductance values associate with inflow from a boundary
  !! when VSC package is active.
  !<
  subroutine vsc_ad_bnd(this, packobj, hnew)
    ! -- modules
    use bndmodule, only: bndtype
    ! -- dummy
    class(gwfvsctype) :: this
    class(bndtype), pointer :: packobj
    real(DP), intent(in), dimension(:) :: hnew
    ! -- local
    integer(I4B) :: i, j
    integer(I4B) :: n, locvisc, locelev
    integer(I4B), dimension(:), allocatable :: locconc
    !
    ! -- initialize
    locvisc = 0
    locelev = 0
    allocate (locconc(this%nviscspecies))
    locconc(:) = 0
    !
    ! -- Add viscosity terms for conductance-dependent boundaries
    do n = 1, packobj%naux
      if (packobj%auxname(n) == 'VISCOSITY') then
        locvisc = n
      else if (packobj%auxname(n) == 'ELEVATION') then
        locelev = n
      end if
    end do
    !
    ! -- find aux columns for conc (or temp.) that affect viscosity
    do i = 1, this%nviscspecies
      locconc(i) = 0
      do j = 1, packobj%naux
        if (this%cauxspeciesname(i) == packobj%auxname(j)) then
          locconc(i) = j
          exit
        end if
      end do
      if (locconc(i) == 0) then
        ! -- one not found, so don't use and mark all as 0
        locconc(:) = 0
        exit
      end if
    end do
    !
    ! -- apply viscosity terms to inflow from boundary based on package type
    select case (packobj%filtyp)
    case ('GHB', 'DRN', 'RIV')
      !
      ! -- general head, drain, and river boundary
      call vsc_ad_standard_bnd(packobj, hnew, this%visc, this%viscref, &
                               locelev, locvisc, locconc, this%dviscdc, &
                               this%cviscref, this%ivisc, this%a2, this%a3, &
                               this%a4, this%ctemp)
    case ('LAK')
      !
      ! -- lake
      !  Update 'viscratios' internal to lak such that they are
      !  automatically applied in the LAK calc_cond() routine
      call vsc_ad_lak(packobj, this%visc, this%viscref, this%elev, locvisc, &
                      locconc, this%dviscdc, this%cviscref, this%ivisc, &
                      this%a2, this%a3, this%a4, this%ctemp)
    case ('SFR')
      !
      ! -- streamflow routing
      !  Update 'viscratios' internal to sfr such that they are
      !  automatically applied in the SFR calc_cond() routine
      call vsc_ad_sfr(packobj, this%visc, this%viscref, this%elev, locvisc, &
                      locconc, this%dviscdc, this%cviscref, this%ivisc, &
                      this%a2, this%a3, this%a4, this%ctemp)
    case ('MAW')
      !
      ! -- multi-aquifer well
      call vsc_ad_maw(packobj, this%visc, this%viscref, this%elev, locvisc, &
                      locconc, this%dviscdc, this%cviscref, this%ivisc, &
                      this%a2, this%a3, this%a4, this%ctemp)
    case ('UZF')
      !
      ! -- unsaturated-zone flow
    case default
      !
      ! -- nothing
    end select
    !
    ! -- deallocate
    deallocate (locconc)
  end subroutine vsc_ad_bnd
 
  !> @brief advance ghb while accounting for viscosity
  !!
  !! When flow enters from ghb boundary type, take into account the effects
  !! of viscosity on the user-specified conductance terms
  !<
  subroutine vsc_ad_standard_bnd(packobj, hnew, visc, viscref, locelev, &
                                 locvisc, locconc, dviscdc, cviscref, &
                                 ivisc, a2, a3, a4, ctemp)
    ! -- modules
    use bndmodule, only: bndtype
    use drnmodule, only: drntype
    use rivmodule, only: rivtype
    use ghbmodule, only: ghbtype
    class(bndtype), pointer :: packobj
    ! -- dummy
    real(DP), intent(in), dimension(:) :: hnew
    real(DP), intent(in), dimension(:) :: visc
    real(DP), intent(in) :: a2, a3, a4
    real(DP), intent(in) :: viscref
    integer(I4B), intent(in) :: locelev
    integer(I4B), intent(in) :: locvisc
    integer(I4B), dimension(:), intent(in) :: locconc
    integer(I4B), dimension(:), intent(in) :: ivisc
    real(DP), dimension(:), intent(in) :: dviscdc
    real(DP), dimension(:), intent(in) :: cviscref
    real(DP), dimension(:), intent(inout) :: ctemp
    ! -- local
    integer(I4B) :: n
    integer(I4B) :: node
    real(DP) :: viscbnd
    !
    ! -- Process density terms for each GHB
    do n = 1, packobj%nbound
      node = packobj%nodelist(n)
      !
      ! -- Check if boundary cell is active, cycle if not
      if (packobj%ibound(node) <= 0) cycle
      !
      ! -- calculate the viscosity associated with the boundary
      viscbnd = calc_bnd_viscosity(n, locvisc, locconc, viscref, dviscdc, &
                                   cviscref, ctemp, ivisc, a2, a3, a4, &
                                   packobj%auxvar)
      !
      ! -- update boundary conductance based on viscosity effects
      select case (packobj%filtyp)
      case ('DRN')
        select type (packobj)
        type is (drntype)
          packobj%cond(n) = update_bnd_cond(viscbnd, viscref, &
                                            packobj%condinput(n))
        end select
      case ('GHB')
        select type (packobj)
        type is (ghbtype)
          packobj%cond(n) = update_bnd_cond(viscbnd, viscref, &
                                            packobj%condinput(n))
        end select
      case ('RIV')
        select type (packobj)
        type is (rivtype)
          packobj%cond(n) = update_bnd_cond(viscbnd, viscref, &
                                            packobj%condinput(n))
        end select
      case default
        packobj%bound(2, n) = update_bnd_cond(viscbnd, viscref, &
                                              packobj%condinput(n))
      end select
      !
    end do
  end subroutine vsc_ad_standard_bnd
 
  !> @brief Update sfr-related viscosity ratios
  !!
  !! When the viscosity package is active, update the viscosity ratio that is
  !! applied to the hydraulic conductivity specified in the SFR package
  !<
  subroutine vsc_ad_sfr(packobj, visc, viscref, elev, locvisc, locconc, &
                        dviscdc, cviscref, ivisc, a2, a3, a4, ctemp)
    ! -- modules
    use bndmodule, only: bndtype
    use sfrmodule, only: sfrtype
    class(bndtype), pointer :: packobj
    ! -- dummy
    real(DP), intent(in) :: viscref
    real(DP), intent(in) :: a2, a3, a4
    integer(I4B), intent(in) :: locvisc
    integer(I4B), dimension(:), intent(in) :: locconc
    integer(I4B), dimension(:), intent(in) :: ivisc
    real(DP), dimension(:), intent(in) :: visc
    real(DP), dimension(:), intent(in) :: elev
    real(DP), dimension(:), intent(in) :: dviscdc
    real(DP), dimension(:), intent(in) :: cviscref
    real(DP), dimension(:), intent(inout) :: ctemp
    ! -- local
    integer(I4B) :: n
    integer(I4B) :: node
    real(DP) :: viscsfr
    !
    ! -- update viscosity ratios for updating hyd. cond (and conductance)
    select type (packobj)
    type is (sfrtype)
      do n = 1, packobj%nbound
        !
        ! -- get gwf node number
        node = packobj%nodelist(n)
        !
        ! -- Check if boundary cell is active, cycle if not
        if (packobj%ibound(node) <= 0) cycle
        !
        ! --
        !
        ! -- calculate the viscosity associated with the boundary
        viscsfr = calc_bnd_viscosity(n, locvisc, locconc, viscref, dviscdc, &
                                     cviscref, ctemp, ivisc, a2, a3, a4, &
                                     packobj%auxvar)
        !
        ! -- fill sfr relative viscosity into column 1 of viscratios
        packobj%viscratios(1, n) = calc_vsc_ratio(viscref, viscsfr)
        !
        ! -- fill gwf relative viscosity into column 2 of viscratios
        packobj%viscratios(2, n) = calc_vsc_ratio(viscref, visc(node))
      end do
    end select
  end subroutine vsc_ad_sfr
 
  !> @brief Update lak-related viscosity ratios
  !!
  !! When the viscosity package is active, update the viscosity ratio that is
  !! applied to the lakebed conductance calculated in the LAK package
  !<
  subroutine vsc_ad_lak(packobj, visc, viscref, elev, locvisc, locconc, &
                        dviscdc, cviscref, ivisc, a2, a3, a4, ctemp)
    ! -- modules
    use bndmodule, only: bndtype
    use lakmodule, only: laktype
    class(bndtype), pointer :: packobj
    ! -- dummy
    real(DP), intent(in) :: viscref
    real(DP), intent(in) :: a2, a3, a4
    integer(I4B), intent(in) :: locvisc
    integer(I4B), dimension(:), intent(in) :: locconc
    integer(I4B), dimension(:), intent(in) :: ivisc
    real(DP), dimension(:), intent(in) :: visc
    real(DP), dimension(:), intent(in) :: elev
    real(DP), dimension(:), intent(in) :: dviscdc
    real(DP), dimension(:), intent(in) :: cviscref
    real(DP), dimension(:), intent(inout) :: ctemp
    ! -- local
    integer(I4B) :: n
    integer(I4B) :: node
    real(DP) :: visclak
    !
    ! -- update viscosity ratios for updating hyd. cond (and conductance)
    select type (packobj)
    type is (laktype)
      do n = 1, packobj%nbound
        !
        ! -- get gwf node number
        node = packobj%nodelist(n)
        !
        ! -- Check if boundary cell is active, cycle if not
        if (packobj%ibound(node) <= 0) cycle
        !
        ! --
        !
        ! -- calculate the viscosity associated with the boundary
        visclak = calc_bnd_viscosity(n, locvisc, locconc, viscref, dviscdc, &
                                     cviscref, ctemp, ivisc, a2, a3, a4, &
                                     packobj%auxvar)
        !
        ! -- fill lak relative viscosity into column 1 of viscratios
        packobj%viscratios(1, n) = calc_vsc_ratio(viscref, visclak)
        !
        ! -- fill gwf relative viscosity into column 2 of viscratios
        packobj%viscratios(2, n) = calc_vsc_ratio(viscref, visc(node))
      end do
    end select
  end subroutine vsc_ad_lak
 
  !> @brief Update maw-related viscosity ratios
  !!
  !! When the viscosity package is active, update the viscosity ratio that is
  !! applied to the conductance calculated in the MAW package
  !<
  subroutine vsc_ad_maw(packobj, visc, viscref, elev, locvisc, locconc, &
                        dviscdc, cviscref, ivisc, a2, a3, a4, ctemp)
    ! -- modules
    use bndmodule, only: bndtype
    use mawmodule, only: mawtype
    class(bndtype), pointer :: packobj
    ! -- dummy
    real(DP), intent(in) :: viscref
    real(DP), intent(in) :: a2, a3, a4
    integer(I4B), intent(in) :: locvisc
    integer(I4B), dimension(:), intent(in) :: locconc
    integer(I4B), dimension(:), intent(in) :: ivisc
    real(DP), dimension(:), intent(in) :: visc
    real(DP), dimension(:), intent(in) :: elev
    real(DP), dimension(:), intent(in) :: dviscdc
    real(DP), dimension(:), intent(in) :: cviscref
    real(DP), dimension(:), intent(inout) :: ctemp
    ! -- local
    integer(I4B) :: n
    integer(I4B) :: node
    real(DP) :: viscmaw
    !
    ! -- update viscosity ratios for updating hyd. cond (and conductance)
    select type (packobj)
    type is (mawtype)
      do n = 1, packobj%nbound
        !
        ! -- get gwf node number
        node = packobj%nodelist(n)
        !
        ! -- Check if boundary cell is active, cycle if not
        if (packobj%ibound(node) <= 0) cycle
        !
        ! --
        !
        ! -- calculate the viscosity associated with the boundary
        viscmaw = calc_bnd_viscosity(n, locvisc, locconc, viscref, dviscdc, &
                                     cviscref, ctemp, ivisc, a2, a3, a4, &
                                     packobj%auxvar)
        !
        ! -- fill lak relative viscosity into column 1 of viscratios
        packobj%viscratios(1, n) = calc_vsc_ratio(viscref, viscmaw)
        !
        ! -- fill gwf relative viscosity into column 2 of viscratios
        packobj%viscratios(2, n) = calc_vsc_ratio(viscref, visc(node))
      end do
    end select
  end subroutine vsc_ad_maw
 
  !> @brief Apply viscosity to the conductance term
  !!
  !! When the viscosity package is active apply the viscosity ratio to the
  !! active boundary package's conductance term.
  !<
  function update_bnd_cond(bndvisc, viscref, spcfdcond) result(updatedcond)
    ! -- dummy
    real(dp), intent(in) :: viscref
    real(dp), intent(in) :: bndvisc
    real(dp), intent(in) :: spcfdcond
    ! -- local
    real(dp) :: vscratio
    real(dp) :: updatedcond
    !
    vscratio = calc_vsc_ratio(viscref, bndvisc)
    !
    ! -- calculate new conductance here
    updatedcond = vscratio * spcfdcond
  end function update_bnd_cond
 
  !> @brief calculate and return the viscosity ratio
  !<
  function calc_vsc_ratio(viscref, bndvisc) result(viscratio)
    ! -- dummy
    real(dp), intent(in) :: viscref
    real(dp), intent(in) :: bndvisc
    ! -- local
    real(dp) :: viscratio
    !
    viscratio = viscref / bndvisc
  end function calc_vsc_ratio
 
  !> @ brief Calculate the boundary viscosity
  !!
  !! Return the viscosity of the boundary package using one of
  !! the options in the following order of priority:
  !! 1. Assign as aux variable in column with name 'VISCOSITY'
  !! 2. Calculate using viscosity equation and nviscspecies aux columns
  !! 3. If neither of those, then assign as viscref  !!
  !<
  function calc_bnd_viscosity(n, locvisc, locconc, viscref, dviscdc, cviscref, &
                              ctemp, ivisc, a2, a3, a4, auxvar) result(viscbnd)
    ! -- modules
    ! -- dummy
    integer(I4B), intent(in) :: n
    integer(I4B), intent(in) :: locvisc
    real(dp), intent(in) :: a2, a3, a4
    integer(I4B), dimension(:), intent(in) :: ivisc
    integer(I4B), dimension(:), intent(in) :: locconc
    real(dp), intent(in) :: viscref
    real(dp), dimension(:), intent(in) :: dviscdc
    real(dp), dimension(:), intent(in) :: cviscref
    real(dp), dimension(:), intent(inout) :: ctemp
    real(dp), dimension(:, :), intent(in) :: auxvar
    ! -- Return
    real(dp) :: viscbnd
    ! -- local
    integer(I4B) :: i
    !
    ! -- assign boundary viscosity based on one of three options
    if (locvisc > 0) then
      ! -- assign viscosity to an aux column named 'VISCOSITY'
      viscbnd = auxvar(locvisc, n)
    else if (locconc(1) > 0) then
      ! -- calculate viscosity using one or more concentration auxcolumns
      do i = 1, size(locconc)
        ctemp(i) = dzero
        if (locconc(i) > 0) then
          ctemp(i) = auxvar(locconc(i), n)
        end if
      end do
      viscbnd = calc_visc(ivisc, viscref, dviscdc, cviscref, ctemp, a2, a3, a4)
    else
      ! -- neither of the above, so assign as viscref
      viscbnd = viscref
    end if
  end function calc_bnd_viscosity
 
  !> @brief Calculate the viscosity ratio
  !!
  !! Calculate the viscosity ratio applied to the hydraulic characteristic
  !! provided by the user.  The viscosity ratio is applicable only
  !! when the hydraulic characteristic is specified as positive and will not
  !! be applied when the hydchr is negative
  !<
  subroutine get_visc_ratio(this, n, m, gwhdn, gwhdm, viscratio)
    ! -- modules
    use constantsmodule, only: done
    ! -- dummy
    class(gwfvsctype) :: this
    integer(I4B), intent(in) :: n, m
    real(DP), intent(in) :: gwhdn, gwhdm
    real(DP), intent(inout) :: viscratio
    ! -- loca
    integer(I4B) :: cellid
    !
    viscratio = done
    if (gwhdm > gwhdn) then
      cellid = m
    else if (gwhdn >= gwhdm) then
      cellid = n
    end if
    call this%calc_q_visc(cellid, viscratio)
  end subroutine get_visc_ratio
 
  !> @brief Account for viscosity in the aquifer hydraulic flow barriers
  !!
  !! Will return the viscosity associated with the upgradient node (cell)
  !! to the HFB package for adjusting the hydraulic characteristic (hydchr)
  !! of the barrier
  !<
  subroutine calc_q_visc(this, cellid, viscratio)
    ! -- dummy variables
    class(gwfvsctype) :: this
    integer(I4B), intent(in) :: cellid
    ! -- Return
    real(DP), intent(inout) :: viscratio
    ! -- local
    real(DP) :: visc
    !
    ! -- Retrieve viscosity for the passed node number
    visc = this%visc(cellid)
    !
    ! -- Calculate the viscosity ratio for the
    viscratio = calc_vsc_ratio(this%viscref, visc)
  end subroutine calc_q_visc
 
  !> @brief Appled the viscosity ratio (mu_o/mu) to the hydraulic conductivity
  !!
  !! This routine called after updating the viscosity values using the latest
  !! concentration and/or temperature values.  The ratio mu_o/mu, reference
  !! viscosity divided by the updated viscosity value, is multiplied by K
  !! for each cell.
  !<
  subroutine update_k_with_vsc(this)
    ! -- dummy
    class(gwfvsctype) :: this
    ! -- local
    integer(I4B) :: n
    real(DP) :: viscratio
    !
    ! -- For viscosity-based K's, apply change of K to K11 by starting with
    !    user-specified K values and not the K's leftover from the last viscosity
    !    update.
    do n = 1, this%dis%nodes
      call this%calc_q_visc(n, viscratio)
      this%k11(n) = this%k11input(n) * viscratio
      this%k22(n) = this%k22input(n) * viscratio
      this%k33(n) = this%k33input(n) * viscratio
      this%nodekchange(n) = 1
    end do
    !
    ! -- Flag kchange
    call this%vsc_set_changed_at(kper, kstp)
  end subroutine update_k_with_vsc
 
  !> @brief Mark K changes as having occurred at (kper, kstp)
  !!
  !! Procedure called by VSC code when K updated due to viscosity changes.
  !! K values changed at (kper, kstp).
  !<
  subroutine vsc_set_changed_at(this, kper, kstp)
    ! -- dummy variables
    class(gwfvsctype) :: this
    integer(I4B), intent(in) :: kper
    integer(I4B), intent(in) :: kstp
    !
    this%kchangeper = kper
    this%kchangestp = kstp
  end subroutine vsc_set_changed_at
 
  !> @ brief Output viscosity package dependent-variable terms.
  !!
  !!  Save calculated viscosity array to binary file
  !<
  subroutine vsc_ot_dv(this, idvfl)
    ! -- dummy
    class(gwfvsctype) :: this
    integer(I4B), intent(in) :: idvfl
    ! -- local
    character(len=1) :: cdatafmp = ' ', editdesc = ' '
    integer(I4B) :: ibinun
    integer(I4B) :: iprint
    integer(I4B) :: nvaluesp
    integer(I4B) :: nwidthp
    real(DP) :: dinact
    !
    ! -- Set unit number for viscosity output
    if (this%ioutvisc /= 0) then
      ibinun = 1
    else
      ibinun = 0
    end if
    if (idvfl == 0) ibinun = 0
    !
    ! -- save viscosity array
    if (ibinun /= 0) then
      iprint = 0
      dinact = dhnoflo
      !
      ! -- write viscosity to binary file
      if (this%ioutvisc /= 0) then
        ibinun = this%ioutvisc
        call this%dis%record_array(this%visc, this%iout, iprint, ibinun, &
                                   '       VISCOSITY', cdatafmp, nvaluesp, &
                                   nwidthp, editdesc, dinact)
      end if
    end if
  end subroutine vsc_ot_dv
 
  !> @ brief Deallocate viscosity package memory
  !!
  !!  Deallocate viscosity package scalars and arrays.
  !<
  subroutine vsc_da(this)
    ! -- dummy
    class(gwfvsctype) :: this
    !
    ! -- Deallocate arrays if package was active
    if (this%inunit > 0) then
      call mem_deallocate(this%visc)
      call mem_deallocate(this%ivisc)
      call mem_deallocate(this%dviscdc)
      call mem_deallocate(this%cviscref)
      call mem_deallocate(this%ctemp)
      deallocate (this%cmodelname)
      deallocate (this%cauxspeciesname)
      deallocate (this%modelconc)
    end if
    !
    ! -- Scalars
    call mem_deallocate(this%thermivisc)
    call mem_deallocate(this%idxtmpr)
    call mem_deallocate(this%ioutvisc)
    call mem_deallocate(this%ireadelev)
    call mem_deallocate(this%iconcset)
    call mem_deallocate(this%viscref)
    call mem_deallocate(this%nviscspecies)
    call mem_deallocate(this%a2)
    call mem_deallocate(this%a3)
    call mem_deallocate(this%a4)
    !
    ! -- Nullify pointers to other package variables
    nullify (this%k11)
    nullify (this%k22)
    nullify (this%k33)
    nullify (this%k11input)
    nullify (this%k22input)
    nullify (this%k33input)
    nullify (this%kchangeper)
    nullify (this%kchangestp)
    nullify (this%nodekchange)
    !
    ! -- deallocate parent
    call this%NumericalPackageType%da()
  end subroutine vsc_da
 
  !> @ brief Source dimensions for package
  !<
  subroutine source_dimensions(this)
    ! -- modules
    use memorymanagerextmodule, only: mem_set_value
    use gwfvscinputmodule, only: gwfvscparamfoundtype
    ! -- dummy
    class(gwfvsctype), intent(inout) :: this
    ! -- local
    type(gwfvscparamfoundtype) :: found
 
    ! update defaults from input context
    call mem_set_value(this%nviscspecies, 'NVISCSPECIES', this%input_mempath, &
                       found%nviscspecies)
 
    ! log dimensions
    write (this%iout, '(/1x,a)') 'Processing VSC DIMENSIONS block'
    write (this%iout, '(4x,a,i0)') 'NVISCSPECIES = ', this%nviscspecies
    write (this%iout, '(1x,a)') 'End of VSC DIMENSIONS block'
 
    ! check dimension
    if (this%nviscspecies < 1) then
      call store_error('NVISCSPECIES must be greater than zero.')
      call store_error_filename(this%input_fname)
    end if
  end subroutine source_dimensions
 
  !> @ brief source packagedata for package
  !<
  subroutine source_packagedata(this)
    ! -- modules
    use memorymanagermodule, only: mem_setptr
    use memorymanagerextmodule, only: memorystore_release
    use characterstringmodule, only: characterstringtype
    ! -- dummy
    class(gwfvsctype), intent(inout) :: this
    integer(I4B), dimension(:), pointer, contiguous :: iviscspec
    type(characterstringtype), dimension(:), pointer, &
      contiguous :: modelnames, auxspeciesnames
    real(DP), dimension(:), pointer, contiguous :: dviscdc, cviscref
    integer(I4B), dimension(:), allocatable :: itemp
    character(len=LINELENGTH) :: modelname, auxspeciesname, line
    character(len=10) :: c10
    character(len=16) :: c16
    integer(I4B) :: n
    ! -- format
    character(len=*), parameter :: fmterr = &
      "('Invalid value for IRHOSPEC (',i0,') detected in VSC Package. &
      &IRHOSPEC must be > 0 and <= NVISCSPECIES, and duplicate values &
      &are not allowed.')"
 
    ! initialize
    allocate (itemp(this%nviscspecies))
    itemp(:) = 0
 
    ! set input context pointers
    call mem_setptr(iviscspec, 'IVISCSPEC', this%input_mempath)
    call mem_setptr(dviscdc, 'DVISCDC', this%input_mempath)
    call mem_setptr(cviscref, 'CVISCREF', this%input_mempath)
    call mem_setptr(modelnames, 'MODELNAME', this%input_mempath)
    call mem_setptr(auxspeciesnames, 'AUXSPECIESNAME', this%input_mempath)
 
    ! process package data
    do n = 1, size(iviscspec)
      modelname = modelnames(n)
      auxspeciesname = auxspeciesnames(n)
 
      if (iviscspec(n) < 1 .or. iviscspec(n) > this%nviscspecies) then
        write (errmsg, fmterr) iviscspec(n)
        call store_error(errmsg)
      end if
      if (itemp(iviscspec(n)) /= 0) then
        write (errmsg, fmterr) iviscspec(n)
        call store_error(errmsg)
      end if
      itemp(iviscspec(n)) = 1
      !
      this%dviscdc(iviscspec(n)) = dviscdc(n)
      this%cviscref(iviscspec(n)) = cviscref(n)
      this%cmodelname(iviscspec(n)) = trim(modelname)
      this%cauxspeciesname(iviscspec(n)) = trim(auxspeciesname)
      !
      if (auxspeciesname == this%name_temp_spec) then
        if (this%idxtmpr > 0) then
          write (errmsg, '(a)') 'More than one species in VSC input identified &
            &as '//trim(this%name_temp_spec)//'. Only one species may be &
            &designated to represent temperature.'
          call store_error(errmsg)
        else
          this%idxtmpr = iviscspec(n)
          if (this%thermivisc == 2) then
            this%ivisc(iviscspec(n)) = 2
          end if
        end if
      end if
    end do
 
    ! Check for errors.
    if (count_errors() > 0) then
      call store_error_filename(this%input_fname)
    end if
 
    ! log package data
    write (this%iout, '(/,1x,a)') 'Processing VSC PACKAGEDATA block'
 
    ! write packagedata information
    write (this%iout, '(1x,a)') 'Summary of species information in VSC Package'
    write (this%iout, '(1a11,5a17)') &
      'Species', 'DVISCDC', 'CVISCREF', 'Model', 'AUXSPECIESNAME'
    do n = 1, this%nviscspecies
      write (c10, '(i0)') n
      line = ' '//adjustr(c10)
 
      write (c16, '(g15.6)') this%dviscdc(n)
      line = trim(line)//' '//adjustr(c16)
      write (c16, '(g15.6)') this%cviscref(n)
      line = trim(line)//' '//adjustr(c16)
      write (c16, '(a)') this%cmodelname(n)
      line = trim(line)//' '//adjustr(c16)
      write (c16, '(a)') this%cauxspeciesname(n)
      line = trim(line)//' '//adjustr(c16)
      write (this%iout, '(a)') trim(line)
    end do
 
    write (this%iout, '(1x,a)') 'End of VSC PACKAGEDATA block'
 
    ! deallocate
    deallocate (itemp)
 
    call memorystore_release('IVISCSPEC', this%input_mempath)
    call memorystore_release('DVISCDC', this%input_mempath)
    call memorystore_release('CVISCREF', this%input_mempath)
    call memorystore_release('MODELNAME', this%input_mempath)
    call memorystore_release('AUXSPECIESNAME', this%input_mempath)
  end subroutine source_packagedata
 
  !> @brief Sets package data instead of reading from file
  !<
  subroutine set_packagedata(this, input_data)
    ! -- dummy
    class(gwfvsctype) :: this !< this vscoancy pkg
    type(gwfvscinputdatatype), intent(in) :: input_data !< the input data to be set
    ! -- local
    integer(I4B) :: ispec
    !
    do ispec = 1, this%nviscspecies
      this%dviscdc(ispec) = input_data%dviscdc(ispec)
      this%cviscref(ispec) = input_data%cviscref(ispec)
      this%cmodelname(ispec) = input_data%cmodelname(ispec)
      this%cauxspeciesname(ispec) = input_data%cauxspeciesname(ispec)
    end do
  end subroutine set_packagedata
 
  !> @brief Calculate fluid viscosity
  !!
  !! Calculates fluid viscosity based on concentration or
  !! temperature
  !<
  subroutine vsc_calcvisc(this)
    ! -- dummy
    class(gwfvsctype) :: this
    ! -- local
    integer(I4B) :: n
    integer(I4B) :: i
    !
    ! -- Calculate the viscosity using the specified concentration and/or
    !    temperature arrays
    do n = 1, this%dis%nodes
      do i = 1, this%nviscspecies
        if (this%modelconc(i)%icbund(n) == 0) then
          this%ctemp(i) = dzero
        else
          this%ctemp(i) = this%modelconc(i)%conc(n)
        end if
      end do
      !
      this%visc(n) = calc_visc(this%ivisc, this%viscref, this%dviscdc, &
                               this%cviscref, this%ctemp, this%a2, &
                               this%a3, this%a4)
    end do
  end subroutine vsc_calcvisc
 
  !> @ brief Allocate scalars
  !!
  !! Allocate and initialize scalars for the VSC package. The base model
  !! allocate scalars method is also called.
  !<
  subroutine allocate_scalars(this)
    ! -- modules
    use constantsmodule, only: dzero, dten, dep3
    ! -- dummy
    class(gwfvsctype) :: this
    !
    ! -- allocate scalars in NumericalPackageType
    call this%NumericalPackageType%allocate_scalars()
    !
    ! -- Allocate
    call mem_allocate(this%thermivisc, 'THERMIVISC', this%memoryPath)
    call mem_allocate(this%idxtmpr, 'IDXTMPR', this%memoryPath)
    call mem_allocate(this%ioutvisc, 'IOUTVISC', this%memoryPath)
    call mem_allocate(this%ireadelev, 'IREADELEV', this%memoryPath)
    call mem_allocate(this%iconcset, 'ICONCSET', this%memoryPath)
    call mem_allocate(this%viscref, 'VISCREF', this%memoryPath)
    call mem_allocate(this%a2, 'A2', this%memoryPath)
    call mem_allocate(this%a3, 'A3', this%memoryPath)
    call mem_allocate(this%a4, 'A4', this%memoryPath)
    !
    call mem_allocate(this%nviscspecies, 'NVISCSPECIES', this%memoryPath)
    !
    ! -- Initialize
    this%thermivisc = 0
    this%idxtmpr = 0
    this%ioutvisc = 0
    this%ireadelev = 0
    this%iconcset = 0
    this%viscref = dep3
    this%A2 = dten
    this%A3 = 248.37_dp
    this%A4 = 133.15_dp
    !
    this%nviscspecies = 0
  end subroutine allocate_scalars
 
  !> @ brief Allocate arrays
  !!
  !! Allocate and initialize arrays for the VSC package.
  !<
  subroutine allocate_arrays(this, nodes)
    ! -- dummy
    class(gwfvsctype) :: this
    integer(I4B), intent(in) :: nodes
    ! -- local
    integer(I4B) :: i
    !
    ! -- Allocate
    call mem_allocate(this%visc, nodes, 'VISC', this%memoryPath)
    call mem_allocate(this%ivisc, this%nviscspecies, 'IVISC', this%memoryPath)
    call mem_allocate(this%dviscdc, this%nviscspecies, 'DRHODC', &
                      this%memoryPath)
    call mem_allocate(this%cviscref, this%nviscspecies, 'CRHOREF', &
                      this%memoryPath)
    call mem_allocate(this%ctemp, this%nviscspecies, 'CTEMP', this%memoryPath)
    allocate (this%cmodelname(this%nviscspecies))
    allocate (this%cauxspeciesname(this%nviscspecies))
    allocate (this%modelconc(this%nviscspecies))
    !
    ! -- Initialize
    do i = 1, nodes
      this%visc(i) = this%viscref
    end do
    !
    ! -- Initialize nviscspecies arrays
    do i = 1, this%nviscspecies
      this%ivisc(i) = 1
      this%dviscdc(i) = dzero
      this%cviscref(i) = dzero
      this%ctemp(i) = dzero
      this%cmodelname(i) = ''
      this%cauxspeciesname(i) = ''
    end do
  end subroutine allocate_arrays
 
  !> @ brief Source VSC options
  !<
  subroutine source_options(this)
    ! -- modules
    use constantsmodule, only: lenvarname
    use memorymanagerextmodule, only: mem_set_value
    use openspecmodule, only: access, form
    use inputoutputmodule, only: getunit, openfile
    use gwfvscinputmodule, only: gwfvscparamfoundtype
    ! -- dummy
    class(gwfvsctype), intent(inout) :: this
    ! -- local
    character(len=LENVARNAME), dimension(2) :: thermal_form = &
      &[character(len=LENVARNAME) :: 'LINEAR', 'NONLINEAR']
    character(len=linelength) :: viscosityfile
    type(gwfvscparamfoundtype) :: found
 
    ! initialize variables
    viscosityfile = ''
 
    ! update defaults from input context
    call mem_set_value(this%viscref, 'VISCREF', this%input_mempath, &
                       found%viscref)
    call mem_set_value(viscosityfile, 'VISCOSITYFILE', this%input_mempath, &
                       found%viscosityfile)
    call mem_set_value(this%name_temp_spec, 'TEMP_SPECNAME', this%input_mempath, &
                       found%temp_specname)
    call mem_set_value(this%thermivisc, 'THERMAL_FORM', this%input_mempath, &
                       thermal_form, found%thermal_form)
    call mem_set_value(this%a2, 'THERMAL_A2', this%input_mempath, &
                       found%thermal_a2)
    call mem_set_value(this%a3, 'THERMAL_A3', this%input_mempath, &
                       found%thermal_a3)
    call mem_set_value(this%a4, 'THERMAL_A4', this%input_mempath, &
                       found%thermal_a4)
 
    ! fileout options
    if (found%viscosityfile) then
      this%ioutvisc = getunit()
      call openfile(this%ioutvisc, this%iout, viscosityfile, 'DATA(BINARY)', &
                    form, access, 'REPLACE')
    end if
 
    ! -- verify THERMAL_FORM input value is supported
    if (found%thermal_form) then
      if (this%thermivisc == 0) then
        call store_error('Unrecognized input value for THERMAL_FORM option.')
        call store_error_filename(this%input_fname)
      end if
    end if
 
    ! set warnings and errors
    if (this%thermivisc == 1) then
      if (this%a2 == 0.0) then
        write (errmsg, '(a)') 'LINEAR option selected for varying  &
          &viscosity with temperature, but A1, a surrogate for &
          &dVISC/dT, set equal to 0.0'
        call store_error(errmsg)
        call store_error_filename(this%input_fname)
      end if
    end if
    if (this%thermivisc > 1) then
      if (this%a2 == 0) then
        write (warnmsg, '(a)') 'NONLINEAR option selected for &
          &varying viscosity with temperature, but A2 set equal to &
          &zero which may lead to unintended values for viscosity'
        call store_warning(warnmsg)
      end if
      if (this%a3 == 0) then
        write (warnmsg, '(a)') 'NONLINEAR option selected for &
          &varying viscosity with temperature,, but A3 set equal to &
          &zero which may lead to unintended values for viscosity'
        call store_warning(warnmsg)
      end if
      if (this%a4 == 0) then
        write (warnmsg, '(a)') 'NONLINEAR option selected for &
          &varying viscosity with temperature, BUT A4 SET EQUAL TO &
          &zero which may lead to unintended values for viscosity'
        call store_warning(warnmsg)
      end if
    end if
 
    ! log options
    call this%log_options(found, viscosityfile)
  end subroutine source_options
 
  !> @ brief log VSC options
  !<
  subroutine log_options(this, found, viscosityfile)
    ! -- modules
    use gwfvscinputmodule, only: gwfvscparamfoundtype
    ! -- dummy variables
    class(gwfvsctype), intent(inout) :: this
    type(gwfvscparamfoundtype), intent(in) :: found
    character(len=*), intent(in) :: viscosityfile
    ! -- local variables
    ! -- formats
    character(len=*), parameter :: fmtfileout = &
      "(4x, 'VSC', 1x, a, 1x, 'Will be saved to file: ', &
      &a, ' opened on unit: ', I7)"
    character(len=*), parameter :: fmtlinear = &
      "(4x,'Viscosity will vary linearly with temperature &
      &change ')"
    character(len=*), parameter :: fmtnonlinear = &
      "(4x,'Viscosity will vary non-linearly with temperature &
      &change ')"
 
    write (this%iout, '(1x,a)') 'Processing VSC OPTIONS block'
 
    if (found%viscref) then
      write (this%iout, '(4x,a,1pg15.6)') &
        'Reference viscosity has been set to: ', this%viscref
    end if
    if (found%viscosityfile) then
      write (this%iout, fmtfileout) &
        'VISCOSITY', trim(viscosityfile), this%ioutvisc
    end if
    if (found%temp_specname) then
      write (this%iout, '(4x, a)') 'Temperature species name set to: '// &
        trim(this%name_temp_spec)
    end if
    if (found%thermal_form) then
      select case (this%thermivisc)
      case (1)
        write (this%iout, fmtlinear)
      case (2)
        write (this%iout, fmtnonlinear)
      end select
    end if
    if (found%thermal_a2) then
      if (this%thermivisc == 2) then
        write (this%iout, '(4x,a,1pg15.6)') &
          'A2 in nonlinear viscosity formulation has been set to: ', &
          this%a2
      else
        write (this%iout, '(4x,a,/,4x,a,/,4x,a)') 'THERMAL_A2 specified by user &
          &in VSC Package input file. LINEAR viscosity ', 'formulation also &
          &specified. THERMAL_A2 will not affect ', 'viscosity calculations.'
      end if
    end if
    if (found%thermal_a3) then
      if (this%thermivisc == 2) then
        write (this%iout, '(4x,a,1pg15.6)') &
          'A3 in nonlinear viscosity formulation has been set to: ', &
          this%a3
      else
        write (this%iout, '(4x,a,/,4x,a,/,4x,a)') 'THERMAL_A3 specified by user &
          &in VSC Package input file. LINEAR viscosity ', 'formulation also &
          &specified. THERMAL_A3 will not affect ', 'viscosity calculations.'
      end if
    end if
    if (found%thermal_a4) then
      if (this%thermivisc == 2) then
        write (this%iout, '(4x,a,1pg15.6)') &
          'A4 in nonlinear viscosity formulation has been set to: ', &
          this%a4
      else
        write (this%iout, '(4x,a,/,4x,a,/,4x,a)') 'THERMAL_A4 specified by user &
          &in VSC Package input file. LINEAR viscosity ', 'formulation also &
          &specified. THERMAL_A4 will not affect ', 'viscosity calculations.'
      end if
    end if
 
    write (this%iout, '(1x,a)') 'end of VSC options block'
  end subroutine log_options
 
  !> @brief Sets options as opposed to reading them from a file
  !<
  subroutine set_options(this, input_data)
    ! -- dummy
    class(gwfvsctype) :: this
    type(gwfvscinputdatatype), intent(in) :: input_data !< the input data to be set
    !
    this%viscref = input_data%viscref
  end subroutine set_options
 
  !> @ brief Set pointers to concentration(s)
  !!
  !! Pass in a gwt model name, concentration array, and ibound,
  !! and store a pointer to these in the VSC package so that
  !! viscosity can be calculated from them.  This routine is called
  !! from the gwfgwt exchange in the exg_ar() method.
  !<
  subroutine set_concentration_pointer(this, modelname, conc, icbund, istmpr)
    ! -- dummy
    class(gwfvsctype) :: this
    character(len=LENMODELNAME), intent(in) :: modelname
    real(DP), dimension(:), pointer :: conc
    integer(I4B), dimension(:), pointer :: icbund
    integer(I4B), optional, intent(in) :: istmpr
    ! -- local
    integer(I4B) :: i
    logical :: found
    !
    this%iconcset = 1
    found = .false.
    do i = 1, this%nviscspecies
      if (this%cmodelname(i) == modelname) then
        this%modelconc(i)%conc => conc
        this%modelconc(i)%icbund => icbund
        found = .true.
        exit
      end if
    end do
  end subroutine set_concentration_pointer
 
end module gwfvscmodule