Data Types
type	concentrationpointer

type	gwfvsctype

Functions/Subroutines
real(dp) function	calc_visc (ivisc, viscref, dviscdc, cviscref, conc, a2, a3, a4)
	Generic function to calculate changes in fluid viscosity using a linear formulation. More...

subroutine, public	vsc_cr (vscobj, name_model, inunit, iout)
	@ brief Create a new package object More...

subroutine	vsc_df (this, dis, vsc_input)
	@ brief Define viscosity package options and dimensions More...

subroutine	vsc_ar (this, ibound)
	@ brief Allocate and read method for viscosity package More...

subroutine	vsc_ar_bnd (this, packobj)
	Activate viscosity in advanced packages. More...

subroutine	set_npf_pointers (this)
	Set pointers to NPF variables. More...

subroutine	vsc_rp (this)
	@ brief Read new period data in viscosity package More...

subroutine	vsc_ad (this)
	@ brief Advance the viscosity package More...

subroutine	vsc_ad_bnd (this, packobj, hnew)
	Advance the boundary packages when viscosity is active. More...

subroutine	vsc_ad_standard_bnd (packobj, hnew, visc, viscref, locelev, locvisc, locconc, dviscdc, cviscref, ivisc, a2, a3, a4, ctemp)
	advance ghb while accounting for viscosity More...

subroutine	vsc_ad_sfr (packobj, visc, viscref, elev, locvisc, locconc, dviscdc, cviscref, ivisc, a2, a3, a4, ctemp)
	Update sfr-related viscosity ratios. More...

subroutine	vsc_ad_lak (packobj, visc, viscref, elev, locvisc, locconc, dviscdc, cviscref, ivisc, a2, a3, a4, ctemp)
	Update lak-related viscosity ratios. More...

subroutine	vsc_ad_maw (packobj, visc, viscref, elev, locvisc, locconc, dviscdc, cviscref, ivisc, a2, a3, a4, ctemp)
	Update maw-related viscosity ratios. More...

real(dp) function	update_bnd_cond (bndvisc, viscref, spcfdcond)
	Apply viscosity to the conductance term. More...

real(dp) function	calc_vsc_ratio (viscref, bndvisc)
	calculate and return the viscosity ratio More...

real(dp) function	calc_bnd_viscosity (n, locvisc, locconc, viscref, dviscdc, cviscref, ctemp, ivisc, a2, a3, a4, auxvar)
	@ brief Calculate the boundary viscosity More...

subroutine	get_visc_ratio (this, n, m, gwhdn, gwhdm, viscratio)
	Calculate the viscosity ratio. More...

subroutine	calc_q_visc (this, cellid, viscratio)
	Account for viscosity in the aquiferhorizontal flow barriers. More...

subroutine	update_k_with_vsc (this)
	Appled the viscosity ratio (mu_o/mu) to the hydraulic conductivity. More...

subroutine	vsc_set_changed_at (this, kper, kstp)
	Mark K changes as having occurred at (kper, kstp) More...

subroutine	vsc_ot_dv (this, idvfl)
	@ brief Output viscosity package dependent-variable terms. More...

subroutine	vsc_da (this)
	@ brief Deallocate viscosity package memory More...

subroutine	read_dimensions (this)
	@ brief Read dimensions More...

subroutine	read_packagedata (this)
	@ brief Read data for package More...

subroutine	set_packagedata (this, input_data)
	Sets package data instead of reading from file. More...

subroutine	vsc_calcvisc (this)
	Calculate fluid viscosity. More...

subroutine	allocate_scalars (this)
	@ brief Allocate scalars More...

subroutine	allocate_arrays (this, nodes)
	@ brief Allocate arrays More...

subroutine	read_options (this)
	@ brief Read Options block More...

subroutine	set_options (this, input_data)
	Sets options as opposed to reading them from a file. More...

subroutine	set_concentration_pointer (this, modelname, conc, icbund, istmpr)
	@ brief Set pointers to concentration(s) More...

Function/Subroutine Documentation

◆ allocate_arrays()

subroutine gwfvscmodule::allocate_arrays	(	class(gwfvsctype)	this,
		integer(i4b), intent(in)	nodes
	)

Allocate and initialize arrays for the VSC package.

Definition at line 1190 of file gwf-vsc.f90.

     ! -- 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

◆ allocate_scalars()

subroutine gwfvscmodule::allocate_scalars ( class(gwfvsctype) this )

private

Allocate and initialize scalars for the VSC package. The base model allocate scalars method is also called.

Definition at line 1150 of file gwf-vsc.f90.

     ! -- 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

◆ calc_bnd_viscosity()

real(dp) function gwfvscmodule::calc_bnd_viscosity	(	integer(i4b), intent(in)	n,
		integer(i4b), intent(in)	locvisc,
		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,
		integer(i4b), dimension(:), intent(in)	ivisc,
		real(dp), intent(in)	a2,
		real(dp), intent(in)	a3,
		real(dp), intent(in)	a4,
		real(dp), dimension(:, :), intent(in)	auxvar
	)

private

Return the viscosity of the boundary package using one of the options in the following order of priority:

Assign as aux variable in column with name 'VISCOSITY'
Calculate using viscosity equation and nviscspecies aux columns
If neither of those, then assign as viscref !!

Definition at line 730 of file gwf-vsc.f90.

     ! -- 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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calc_q_visc()

subroutine gwfvscmodule::calc_q_visc	(	class(gwfvsctype)	this,
		integer(i4b), intent(in)	cellid,
		real(dp), intent(inout)	viscratio
	)

Will return the viscosity associated with the upgradient node (cell) to the HFB package for adjusting the hydraulic characteristic (hydchr) of the barrier

Definition at line 801 of file gwf-vsc.f90.

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

Here is the call graph for this function:

◆ calc_visc()

real(dp) function gwfvscmodule::calc_visc	(	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,
		real(dp), intent(in)	a3,
		real(dp), intent(in)	a4
	)

private

Definition at line 97 of file gwf-vsc.f90.

     ! -- 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

Here is the caller graph for this function:

◆ calc_vsc_ratio()

real(dp) function gwfvscmodule::calc_vsc_ratio	(	real(dp), intent(in)	viscref,
		real(dp), intent(in)	bndvisc
	)

private

Definition at line 712 of file gwf-vsc.f90.

     ! -- dummy
     real(DP), intent(in) :: viscref
     real(DP), intent(in) :: bndvisc
     ! -- local
     real(DP) :: viscratio
     !
     viscratio = viscref / bndvisc

Here is the caller graph for this function:

◆ get_visc_ratio()

subroutine gwfvscmodule::get_visc_ratio	(	class(gwfvsctype)	this,
		integer(i4b), intent(in)	n,
		integer(i4b), intent(in)	m,
		real(dp), intent(in)	gwhdn,
		real(dp), intent(in)	gwhdm,
		real(dp), intent(inout)	viscratio
	)

private

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

Definition at line 775 of file gwf-vsc.f90.

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

◆ read_dimensions()

subroutine gwfvscmodule::read_dimensions ( class(gwfvsctype), intent(inout) this )

private

Read dimensions for the viscosity package

Definition at line 951 of file gwf-vsc.f90.

     ! -- modules
     ! -- dummy
     class(GwfVscType), intent(inout) :: this
     ! -- local
     character(len=LINELENGTH) :: errmsg, keyword
     integer(I4B) :: ierr
     logical :: isfound, endOfBlock
     !
     ! -- get dimensions block
     call this%parser%GetBlock('DIMENSIONS', isfound, ierr, &
                               supportopenclose=.true.)
     !
     ! -- parse dimensions block if detected
     if (isfound) then
       write (this%iout, '(/1x,a)') 'Processing VSC DIMENSIONS block'
       do
         call this%parser%GetNextLine(endofblock)
         if (endofblock) exit
         call this%parser%GetStringCaps(keyword)
         select case (keyword)
         case ('NVISCSPECIES')
           this%nviscspecies = this%parser%GetInteger()
           write (this%iout, '(4x,a,i0)') 'NVISCSPECIES = ', this%nviscspecies
         case default
           write (errmsg, '(a,a)') &
             'Unknown VSC dimension: ', trim(keyword)
           call store_error(errmsg)
           call this%parser%StoreErrorUnit()
         end select
       end do
       write (this%iout, '(1x,a)') 'End of VSC DIMENSIONS block'
     else
       call store_error('Required VSC DIMENSIONS block not found.')
       call this%parser%StoreErrorUnit()
     end if
     !
     ! -- check dimension
     if (this%nviscspecies < 1) then
       call store_error('NVISCSPECIES must be greater than zero.')
       call this%parser%StoreErrorUnit()
     end if

Here is the call graph for this function:

◆ read_options()

subroutine gwfvscmodule::read_options ( class(gwfvsctype) this )

private

Reads the options block inside the VSC package.

Definition at line 1229 of file gwf-vsc.f90.

     ! -- modules
     use openspecmodule, only: access, form
     use inputoutputmodule, only: urword, getunit, urdaux, openfile
     ! -- dummy
     class(GwfVscType) :: this
     ! -- local
     character(len=LINELENGTH) :: warnmsg, errmsg, keyword, keyword2
     character(len=MAXCHARLEN) :: fname
     integer(I4B) :: ierr
     logical :: isfound, endOfBlock
     ! -- formats
     character(len=*), parameter :: fmtfileout = &
       "(1x, 'VSC', 1x, a, 1x, 'Will be saved to file: ', &
       &a, /4x, 'opened on unit: ', I7)"
     character(len=*), parameter :: fmtlinear = &
       "(/,1x,'Viscosity will vary linearly with temperature &
       &change ')"
     character(len=*), parameter :: fmtnonlinear = &
       "(/,1x,'Viscosity will vary non-linearly with temperature &
       &change ')"
     !
     ! -- get options block
     call this%parser%GetBlock('OPTIONS', isfound, ierr, &
                               supportopenclose=.true., blockrequired=.false.)
     !
     ! -- parse options block if detected
     if (isfound) then
       write (this%iout, '(1x,a)') 'Processing VSC OPTIONS block'
       do
         call this%parser%GetNextLine(endofblock)
         if (endofblock) exit
         call this%parser%GetStringCaps(keyword)
         select case (keyword)
         case ('VISCREF')
           this%viscref = this%parser%GetDouble()
           write (this%iout, '(4x,a,1pg15.6)') &
             'Reference viscosity has been set to: ', &
             this%viscref
         case ('VISCOSITY')
           call this%parser%GetStringCaps(keyword)
           if (keyword == 'FILEOUT') then
             call this%parser%GetString(fname)
             this%ioutvisc = getunit()
             call openfile(this%ioutvisc, this%iout, fname, 'DATA(BINARY)', &
                           form, access, 'REPLACE')
             write (this%iout, fmtfileout) &
               'VISCOSITY', fname, this%ioutvisc
           else
             errmsg = 'Optional VISCOSITY keyword must be '// &
                      'followed by FILEOUT'
             call store_error(errmsg)
           end if
         case ('TEMPERATURE_SPECIES_NAME')
           call this%parser%GetStringCaps(this%name_temp_spec)
           write (this%iout, '(4x, a)') 'Temperature species name set to: '// &
             trim(this%name_temp_spec)
         case ('THERMAL_FORMULATION')
           call this%parser%GetStringCaps(keyword2)
           if (trim(adjustl(keyword2)) == 'LINEAR') this%thermivisc = 1
           if (trim(adjustl(keyword2)) == 'NONLINEAR') this%thermivisc = 2
           select case (this%thermivisc)
           case (1)
             write (this%iout, fmtlinear)
           case (2)
             write (this%iout, fmtnonlinear)
           end select
         case ('THERMAL_A2')
           this%a2 = this%parser%GetDouble()
           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
         case ('THERMAL_A3')
           this%a3 = this%parser%GetDouble()
           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
         case ('THERMAL_A4')
           this%a4 = this%parser%GetDouble()
           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
         case default
           write (errmsg, '(a,a)') 'Unknown VSC option: ', &
             trim(keyword)
           call store_error(errmsg)
           call this%parser%StoreErrorUnit()
         end select
       end do
       !
       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)
         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(errmsg)
         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
     end if
     !
     write (this%iout, '(/,1x,a)') 'end of VSC options block'

Here is the call graph for this function:

◆ read_packagedata()

subroutine gwfvscmodule::read_packagedata ( class(gwfvsctype) this )

private

Method to read data for the viscosity package.

Definition at line 999 of file gwf-vsc.f90.

     ! -- dummy
     class(GwfVscType) :: this
     ! -- local
     character(len=LINELENGTH) :: errmsg
     character(len=LINELENGTH) :: line
     integer(I4B) :: ierr
     integer(I4B) :: iviscspec
     logical :: isfound, endOfBlock
     logical :: blockrequired
     integer(I4B), dimension(:), allocatable :: itemp
     character(len=10) :: c10
     character(len=16) :: c16
     ! -- 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
     !
     ! -- get packagedata block
     blockrequired = .true.
     call this%parser%GetBlock('PACKAGEDATA', isfound, ierr, &
                               blockrequired=blockrequired, &
                               supportopenclose=.true.)
     !
     ! -- parse packagedata block
     if (isfound) then
       write (this%iout, '(1x,a)') 'Procesing VSC PACKAGEDATA block'
       do
         call this%parser%GetNextLine(endofblock)
         if (endofblock) exit
         iviscspec = this%parser%GetInteger()
         if (iviscspec < 1 .or. iviscspec > this%nviscspecies) then
           write (errmsg, fmterr) iviscspec
           call store_error(errmsg)
         end if
         if (itemp(iviscspec) /= 0) then
           write (errmsg, fmterr) iviscspec
           call store_error(errmsg)
         end if
         itemp(iviscspec) = 1
         !
         this%dviscdc(iviscspec) = this%parser%GetDouble()
         this%cviscref(iviscspec) = this%parser%GetDouble()
         call this%parser%GetStringCaps(this%cmodelname(iviscspec))
         call this%parser%GetStringCaps(this%cauxspeciesname(iviscspec))
         !
         if (this%cauxspeciesname(iviscspec) == 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
             if (this%thermivisc == 2) then
               this%ivisc(iviscspec) = 2
             end if
           end if
         end if
       end do
     else
       call store_error('Required VSC PACKAGEDATA block not found.')
       call this%parser%StoreErrorUnit()
     end if
     !
     ! -- Check for errors.
     if (count_errors() > 0) then
       call this%parser%StoreErrorUnit()
     end if
     !
     ! -- 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 iviscspec = 1, this%nviscspecies
       write (c10, '(i0)') iviscspec
       line = ' '//adjustr(c10)
  
       write (c16, '(g15.6)') this%dviscdc(iviscspec)
       line = trim(line)//' '//adjustr(c16)
       write (c16, '(g15.6)') this%cviscref(iviscspec)
       line = trim(line)//' '//adjustr(c16)
       write (c16, '(a)') this%cmodelname(iviscspec)
       line = trim(line)//' '//adjustr(c16)
       write (c16, '(a)') this%cauxspeciesname(iviscspec)
       line = trim(line)//' '//adjustr(c16)
       write (this%iout, '(a)') trim(line)
     end do
     !
     ! -- deallocate
     deallocate (itemp)
     !
     write (this%iout, '(/,1x,a)') 'End of VSC PACKAGEDATA block'

Here is the call graph for this function:

◆ set_concentration_pointer()

subroutine gwfvscmodule::set_concentration_pointer	(	class(gwfvsctype)	this,
		character(len=lenmodelname), intent(in)	modelname,
		real(dp), dimension(:), pointer	conc,
		integer(i4b), dimension(:), pointer	icbund,
		integer(i4b), intent(in), optional	istmpr
	)

private

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.

Definition at line 1387 of file gwf-vsc.f90.

     ! -- 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

◆ set_npf_pointers()

subroutine gwfvscmodule::set_npf_pointers ( class(gwfvsctype) this )

Set array and variable pointers from the NPF package for access by VSC.

Definition at line 300 of file gwf-vsc.f90.

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

Here is the call graph for this function:

◆ set_options()

subroutine gwfvscmodule::set_options	(	class(gwfvsctype)	this,
		type(gwfvscinputdatatype), intent(in)	input_data
	)

Parameters

[in] input_data the input data to be set

Definition at line 1372 of file gwf-vsc.f90.

     ! -- dummy
     class(GwfVscType) :: this
     type(GwfVscInputDataType), intent(in) :: input_data !< the input data to be set
     !
     this%viscref = input_data%viscref

◆ set_packagedata()

subroutine gwfvscmodule::set_packagedata	(	class(gwfvsctype)	this,
		type(gwfvscinputdatatype), intent(in)	input_data
	)

private

Parameters

	this	this vscoancy pkg
[in]	input_data	the input data to be set

Definition at line 1101 of file gwf-vsc.f90.

     ! -- 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

◆ update_bnd_cond()

real(dp) function gwfvscmodule::update_bnd_cond	(	real(dp), intent(in)	bndvisc,
		real(dp), intent(in)	viscref,
		real(dp), intent(in)	spcfdcond
	)

When the viscosity package is active apply the viscosity ratio to the active boundary package's conductance term.

Definition at line 695 of file gwf-vsc.f90.

     ! -- 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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update_k_with_vsc()

subroutine gwfvscmodule::update_k_with_vsc ( class(gwfvsctype) this )

private

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.

Definition at line 824 of file gwf-vsc.f90.

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

◆ vsc_ad()

subroutine gwfvscmodule::vsc_ad ( class(gwfvsctype) this )

Advance data in the VSC package. The method sets or advances time series, time array series, and observation data.

Definition at line 358 of file gwf-vsc.f90.

     ! -- dummy
     class(GwfVscType) :: this
     !
     ! -- update viscosity using the latest concentration/temperature
     call this%vsc_calcvisc()

◆ vsc_ad_bnd()

subroutine gwfvscmodule::vsc_ad_bnd	(	class(gwfvsctype)	this,
		class(bndtype), pointer	packobj,
		real(dp), dimension(:), intent(in)	hnew
	)

private

Update the conductance values associate with inflow from a boundary when VSC package is active.

Definition at line 371 of file gwf-vsc.f90.

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

Here is the call graph for this function:

◆ vsc_ad_lak()

subroutine gwfvscmodule::vsc_ad_lak	(	class(bndtype), pointer	packobj,
		real(dp), dimension(:), intent(in)	visc,
		real(dp), intent(in)	viscref,
		real(dp), dimension(:), intent(in)	elev,
		integer(i4b), intent(in)	locvisc,
		integer(i4b), dimension(:), intent(in)	locconc,
		real(dp), dimension(:), intent(in)	dviscdc,
		real(dp), dimension(:), intent(in)	cviscref,
		integer(i4b), dimension(:), intent(in)	ivisc,
		real(dp), intent(in)	a2,
		real(dp), intent(in)	a3,
		real(dp), intent(in)	a4,
		real(dp), dimension(:), intent(inout)	ctemp
	)

When the viscosity package is active, update the viscosity ratio that is applied to the lakebed conductance calculated in the LAK package

Definition at line 587 of file gwf-vsc.f90.

     ! -- 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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vsc_ad_maw()

subroutine gwfvscmodule::vsc_ad_maw	(	class(bndtype), pointer	packobj,
		real(dp), dimension(:), intent(in)	visc,
		real(dp), intent(in)	viscref,
		real(dp), dimension(:), intent(in)	elev,
		integer(i4b), intent(in)	locvisc,
		integer(i4b), dimension(:), intent(in)	locconc,
		real(dp), dimension(:), intent(in)	dviscdc,
		real(dp), dimension(:), intent(in)	cviscref,
		integer(i4b), dimension(:), intent(in)	ivisc,
		real(dp), intent(in)	a2,
		real(dp), intent(in)	a3,
		real(dp), intent(in)	a4,
		real(dp), dimension(:), intent(inout)	ctemp
	)

When the viscosity package is active, update the viscosity ratio that is applied to the conductance calculated in the MAW package

Definition at line 641 of file gwf-vsc.f90.

     ! -- 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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vsc_ad_sfr()

subroutine gwfvscmodule::vsc_ad_sfr	(	class(bndtype), pointer	packobj,
		real(dp), dimension(:), intent(in)	visc,
		real(dp), intent(in)	viscref,
		real(dp), dimension(:), intent(in)	elev,
		integer(i4b), intent(in)	locvisc,
		integer(i4b), dimension(:), intent(in)	locconc,
		real(dp), dimension(:), intent(in)	dviscdc,
		real(dp), dimension(:), intent(in)	cviscref,
		integer(i4b), dimension(:), intent(in)	ivisc,
		real(dp), intent(in)	a2,
		real(dp), intent(in)	a3,
		real(dp), intent(in)	a4,
		real(dp), dimension(:), intent(inout)	ctemp
	)

When the viscosity package is active, update the viscosity ratio that is applied to the hydraulic conductivity specified in the SFR package

Definition at line 533 of file gwf-vsc.f90.

     ! -- 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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vsc_ad_standard_bnd()

subroutine gwfvscmodule::vsc_ad_standard_bnd	(	class(bndtype), pointer	packobj,
		real(dp), dimension(:), intent(in)	hnew,
		real(dp), dimension(:), intent(in)	visc,
		real(dp), intent(in)	viscref,
		integer(i4b), intent(in)	locelev,
		integer(i4b), intent(in)	locvisc,
		integer(i4b), dimension(:), intent(in)	locconc,
		real(dp), dimension(:), intent(in)	dviscdc,
		real(dp), dimension(:), intent(in)	cviscref,
		integer(i4b), dimension(:), intent(in)	ivisc,
		real(dp), intent(in)	a2,
		real(dp), intent(in)	a3,
		real(dp), intent(in)	a4,
		real(dp), dimension(:), intent(inout)	ctemp
	)

When flow enters from ghb boundary type, take into account the effects of viscosity on the user-specified conductance terms

Definition at line 462 of file gwf-vsc.f90.

     ! -- 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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vsc_ar()

subroutine gwfvscmodule::vsc_ar	(	class(gwfvsctype)	this,
		integer(i4b), dimension(:), pointer	ibound
	)

private

Generic method to allocate and read static data for the viscosity package available within the GWF model type.

Definition at line 214 of file gwf-vsc.f90.

     ! -- 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()

◆ vsc_ar_bnd()

subroutine gwfvscmodule::vsc_ar_bnd	(	class(gwfvsctype)	this,
		class(bndtype), pointer	packobj
	)

private

Viscosity ar_bnd routine to activate viscosity in the advanced packages. This routine is called from gwf_ar() as it moves through each package

Definition at line 232 of file gwf-vsc.f90.

     ! -- 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

◆ vsc_calcvisc()

subroutine gwfvscmodule::vsc_calcvisc ( class(gwfvsctype) this )

private

Calculates fluid viscosity based on concentration or temperature

Definition at line 1121 of file gwf-vsc.f90.

     ! -- 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 = 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

Here is the call graph for this function:

◆ vsc_cr()

subroutine, public gwfvscmodule::vsc_cr	(	type(gwfvsctype), pointer	vscobj,
		character(len=*), intent(in)	name_model,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout
	)

Create a new VSC Package object.

Definition at line 139 of file gwf-vsc.f90.

     ! -- dummy
     type(GwfVscType), pointer :: vscobj
     character(len=*), intent(in) :: name_model
     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')
     !
     ! -- Allocate scalars
     call vscobj%allocate_scalars()
     !
     ! -- Set variables
     vscobj%inunit = inunit
     vscobj%iout = iout
     !
     ! -- Initialize block parser
     call vscobj%parser%Initialize(vscobj%inunit, vscobj%iout)

Here is the caller graph for this function:

◆ vsc_da()

subroutine gwfvscmodule::vsc_da ( class(gwfvsctype) this )

private

Deallocate viscosity package scalars and arrays.

Definition at line 904 of file gwf-vsc.f90.

     ! -- 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()

◆ vsc_df()

subroutine gwfvscmodule::vsc_df	(	class(gwfvsctype)	this,
		class(disbasetype), intent(in), pointer	dis,
		type(gwfvscinputdatatype), intent(in), optional	vsc_input
	)

private

Define viscosity package options and dimensions

Parameters

	this	this viscosity package
[in]	dis	pointer to discretization
[in]	vsc_input	optional vsc input data, otherwise read from file

Definition at line 167 of file gwf-vsc.f90.

     ! -- 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 unit ', i0, //)"
     !
     ! --print a message identifying the viscosity package
     write (this%iout, fmtvsc) this%inunit
     !
     ! -- store pointers to arguments that were passed in
     this%dis => dis
     !
     if (.not. present(vsc_input)) then
       !
       ! -- Read viscosity options
       call this%read_options()
       !
       ! -- Read viscosity dimensions
       call this%read_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%read_packagedata()
     else
       ! set from input data instead
       call this%set_packagedata(vsc_input)
     end if

◆ vsc_ot_dv()

subroutine gwfvscmodule::vsc_ot_dv	(	class(gwfvsctype)	this,
		integer(i4b), intent(in)	idvfl
	)

private

Save calculated viscosity array to binary file

Definition at line 865 of file gwf-vsc.f90.

     ! -- 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

◆ vsc_rp()

subroutine gwfvscmodule::vsc_rp ( class(gwfvsctype) this )

private

Method to read and prepare period data for the VSC package.

Definition at line 324 of file gwf-vsc.f90.

     ! -- modules
     use tdismodule, only: kstp, kper
     ! -- dummy
     class(GwfVscType) :: this
     ! -- local
     character(len=LINELENGTH) :: errmsg
     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 this%parser%StoreErrorUnit()
       end if
     end if

Here is the call graph for this function:

◆ vsc_set_changed_at()

subroutine gwfvscmodule::vsc_set_changed_at	(	class(gwfvsctype)	this,
		integer(i4b), intent(in)	kper,
		integer(i4b), intent(in)	kstp
	)

private

Procedure called by VSC code when K updated due to viscosity changes. K values changed at (kper, kstp).

Definition at line 851 of file gwf-vsc.f90.

     ! -- dummy variables
     class(GwfVscType) :: this
     integer(I4B), intent(in) :: kper
     integer(I4B), intent(in) :: kstp
     !
     this%kchangeper = kper
     this%kchangestp = kstp

Data Types

Functions/Subroutines

Function/Subroutine Documentation

◆ allocate_arrays()

◆ allocate_scalars()

◆ calc_bnd_viscosity()

◆ calc_q_visc()

◆ calc_visc()

◆ calc_vsc_ratio()

◆ get_visc_ratio()

◆ read_dimensions()

◆ read_options()

◆ read_packagedata()

◆ set_concentration_pointer()

◆ set_npf_pointers()

◆ set_options()

◆ set_packagedata()

◆ update_bnd_cond()

◆ update_k_with_vsc()

◆ vsc_ad()

◆ vsc_ad_bnd()

◆ vsc_ad_lak()

◆ vsc_ad_maw()

◆ vsc_ad_sfr()

◆ vsc_ad_standard_bnd()

◆ vsc_ar()

◆ vsc_ar_bnd()

◆ vsc_calcvisc()

◆ vsc_cr()

◆ vsc_da()

◆ vsc_df()

◆ vsc_ot_dv()

◆ vsc_rp()

◆ vsc_set_changed_at()