Data Types
type	gwtsfttype

Functions/Subroutines
subroutine, public	sft_create (packobj, id, ibcnum, inunit, iout, namemodel, pakname, fmi, eqnsclfac, dvt, dvu, dvua)
	Create a new sft package. More...

subroutine	find_sft_package (this)
	Find corresponding sft package. More...

subroutine	sft_fc_expanded (this, rhs, ia, idxglo, matrix_sln)
	Add matrix terms related to SFT. More...

subroutine	sft_solve (this)
	Add terms specific to sft to the explicit sft solve. More...

integer(i4b) function	sft_get_nbudterms (this)
	Function to return the number of budget terms just for this package. More...

subroutine	sft_setup_budobj (this, idx)
	Set up the budget object that stores all the sft flows. More...

subroutine	sft_fill_budobj (this, idx, x, flowja, ccratin, ccratout)
	Copy flow terms into thisbudobj. More...

subroutine	allocate_scalars (this)
	Allocate scalars specific to the streamflow energy transport (SFE) package. More...

subroutine	sft_allocate_arrays (this)
	Allocate arrays specific to the streamflow energy transport (SFE) package. More...

subroutine	sft_ad (this)
	Advance sft package routine. More...

subroutine	sft_da (this)
	Deallocate memory. More...

subroutine	sft_rain_term (this, ientry, n1, n2, rrate, rhsval, hcofval)
	Rain term. More...

subroutine	sft_evap_term (this, ientry, n1, n2, rrate, rhsval, hcofval)
	Evaporative term. More...

subroutine	sft_roff_term (this, ientry, n1, n2, rrate, rhsval, hcofval)
	Runoff term. More...

subroutine	sft_iflw_term (this, ientry, n1, n2, rrate, rhsval, hcofval)
	Inflow Term. More...

subroutine	sft_outf_term (this, ientry, n1, n2, rrate, rhsval, hcofval)
	Outflow term. More...

subroutine	sft_df_obs (this)
	Observations. More...

subroutine	sft_rp_obs (this, obsrv, found)
	Process package specific obs. More...

subroutine	sft_bd_obs (this, obstypeid, jj, v, found)
	Calculate observation value and pass it back to APT. More...

subroutine	sft_set_stressperiod (this, itemno, keyword, found)
	Sets the stress period attributes for keyword use. More...

subroutine	sft_get_volumes (this, icv, vnew, vold, delt)
	Return the sfr new volume and old volume. More...

Variables
character(len= *), parameter	ftype = 'SFT'

character(len= *), parameter	flowtype = 'SFR'

character(len=16)	text = ' SFT'

Function/Subroutine Documentation

◆ allocate_scalars()

subroutine gwtsftmodule::allocate_scalars ( class(gwtsfttype) this )

Definition at line 561 of file gwt-sft.f90.

     ! -- modules
     use memorymanagermodule, only: mem_allocate
     ! -- dummy
     class(GwtSftType) :: this
     ! -- local
     !
     ! -- allocate scalars in TspAptType
     call this%TspAptType%allocate_scalars()
     !
     ! -- Allocate
     call mem_allocate(this%idxbudrain, 'IDXBUDRAIN', this%memoryPath)
     call mem_allocate(this%idxbudevap, 'IDXBUDEVAP', this%memoryPath)
     call mem_allocate(this%idxbudroff, 'IDXBUDROFF', this%memoryPath)
     call mem_allocate(this%idxbudiflw, 'IDXBUDIFLW', this%memoryPath)
     call mem_allocate(this%idxbudoutf, 'IDXBUDOUTF', this%memoryPath)
     !
     ! -- Initialize
     this%idxbudrain = 0
     this%idxbudevap = 0
     this%idxbudroff = 0
     this%idxbudiflw = 0
     this%idxbudoutf = 0

◆ find_sft_package()

subroutine gwtsftmodule::find_sft_package ( class(gwtsfttype) this )

Definition at line 154 of file gwt-sft.f90.

     ! -- modules
     use memorymanagermodule, only: mem_allocate
     ! -- dummy
     class(GwtSftType) :: this
     ! -- local
     character(len=LINELENGTH) :: errmsg
     class(BndType), pointer :: packobj
     integer(I4B) :: ip, icount
     integer(I4B) :: nbudterm
     logical :: found
     !
     ! -- Initialize found to false, and error later if flow package cannot
     !    be found
     found = .false.
     !
     ! -- If user is specifying flows in a binary budget file, then set up
     !    the budget file reader, otherwise set a pointer to the flow package
     !    budobj
     if (this%fmi%flows_from_file) then
       call this%fmi%set_aptbudobj_pointer(this%flowpackagename, this%flowbudptr)
       if (associated(this%flowbudptr)) found = .true.
       !
     else
       if (associated(this%fmi%gwfbndlist)) then
         ! -- Look through gwfbndlist for a flow package with the same name as
         !    this transport package name
         do ip = 1, this%fmi%gwfbndlist%Count()
           packobj => getbndfromlist(this%fmi%gwfbndlist, ip)
           if (packobj%packName == this%flowpackagename) then
             found = .true.
             !
             ! -- store BndType pointer to packobj, and then
             !    use the select type to point to the budobj in flow package
             this%flowpackagebnd => packobj
             select type (packobj)
             type is (sfrtype)
               this%flowbudptr => packobj%budobj
             end select
           end if
           if (found) exit
         end do
       end if
     end if
     !
     ! -- error if flow package not found
     if (.not. found) then
       write (errmsg, '(a)') 'Could not find flow package with name '&
                             &//trim(adjustl(this%flowpackagename))//'.'
       call store_error(errmsg)
       call this%parser%StoreErrorUnit()
     end if
     !
     ! -- allocate space for idxbudssm, which indicates whether this is a
     !    special budget term or one that is a general source and sink
     nbudterm = this%flowbudptr%nbudterm
     call mem_allocate(this%idxbudssm, nbudterm, 'IDXBUDSSM', this%memoryPath)
     !
     ! -- Process budget terms and identify special budget terms
     write (this%iout, '(/, a, a)') &
       'PROCESSING '//ftype//' INFORMATION FOR ', this%packName
     write (this%iout, '(a)') '  IDENTIFYING FLOW TERMS IN '//flowtype//' PACKAGE'
     write (this%iout, '(a, i0)') &
       '  NUMBER OF '//flowtype//' = ', this%flowbudptr%ncv
     icount = 1
     do ip = 1, this%flowbudptr%nbudterm
       select case (trim(adjustl(this%flowbudptr%budterm(ip)%flowtype)))
       case ('FLOW-JA-FACE')
         this%idxbudfjf = ip
         this%idxbudssm(ip) = 0
       case ('GWF')
         this%idxbudgwf = ip
         this%idxbudssm(ip) = 0
       case ('STORAGE')
         this%idxbudsto = ip
         this%idxbudssm(ip) = 0
       case ('RAINFALL')
         this%idxbudrain = ip
         this%idxbudssm(ip) = 0
       case ('EVAPORATION')
         this%idxbudevap = ip
         this%idxbudssm(ip) = 0
       case ('RUNOFF')
         this%idxbudroff = ip
         this%idxbudssm(ip) = 0
       case ('EXT-INFLOW')
         this%idxbudiflw = ip
         this%idxbudssm(ip) = 0
       case ('EXT-OUTFLOW')
         this%idxbudoutf = ip
         this%idxbudssm(ip) = 0
       case ('TO-MVR')
         this%idxbudtmvr = ip
         this%idxbudssm(ip) = 0
       case ('FROM-MVR')
         this%idxbudfmvr = ip
         this%idxbudssm(ip) = 0
       case ('AUXILIARY')
         this%idxbudaux = ip
         this%idxbudssm(ip) = 0
       case default
         !
         ! -- set idxbudssm equal to a column index for where the concentrations
         !    are stored in the concbud(nbudssm, ncv) array
         this%idxbudssm(ip) = icount
         icount = icount + 1
       end select
       write (this%iout, '(a, i0, " = ", a,/, a, i0)') &
         '  TERM ', ip, trim(adjustl(this%flowbudptr%budterm(ip)%flowtype)), &
         '   MAX NO. OF ENTRIES = ', this%flowbudptr%budterm(ip)%maxlist
     end do
     write (this%iout, '(a, //)') 'DONE PROCESSING '//ftype//' INFORMATION'

Here is the call graph for this function:

◆ sft_ad()

subroutine gwtsftmodule::sft_ad ( class(gwtsfttype) this )

Definition at line 623 of file gwt-sft.f90.

     ! modules
     ! dummy
     class(GwtSftType) :: this
     ! local
     integer(I4B) :: n
  
     ! call base bnd_ad
     call this%TspAptType%bnd_ad()
  
     ! update vold
     do n = 1, this%ncv
       this%vold(n) = this%vnew(n)
     end do
  

◆ sft_allocate_arrays()

subroutine gwtsftmodule::sft_allocate_arrays ( class(gwtsfttype), intent(inout) this )

Definition at line 589 of file gwt-sft.f90.

     ! -- modules
     use memorymanagermodule, only: mem_allocate
     ! -- dummy
     class(GwtSftType), intent(inout) :: this
     ! -- local
     integer(I4B) :: n
     !
     ! -- time series
     call mem_allocate(this%concrain, this%ncv, 'CONCRAIN', this%memoryPath)
     call mem_allocate(this%concevap, this%ncv, 'CONCEVAP', this%memoryPath)
     call mem_allocate(this%concroff, this%ncv, 'CONCROFF', this%memoryPath)
     call mem_allocate(this%conciflw, this%ncv, 'CONCIFLW', this%memoryPath)
  
     call mem_allocate(this%vnew, this%ncv, 'VNEW', this%memoryPath)
     call mem_allocate(this%vold, this%ncv, 'VOLD', this%memoryPath)
  
     !
     ! -- call standard TspAptType allocate arrays
     call this%TspAptType%apt_allocate_arrays()
     !
     ! -- Initialize
     do n = 1, this%ncv
       this%concrain(n) = dzero
       this%concevap(n) = dzero
       this%concroff(n) = dzero
       this%conciflw(n) = dzero
       this%vnew(n) = dzero
       this%vold(n) = dzero
     end do

◆ sft_bd_obs()

subroutine gwtsftmodule::sft_bd_obs	(	class(gwtsfttype), intent(inout)	this,
		character(len=*), intent(in)	obstypeid,
		integer(i4b), intent(in)	jj,
		real(dp), intent(inout)	v,
		logical, intent(inout)	found
	)

Definition at line 915 of file gwt-sft.f90.

     ! -- dummy
     class(GwtSftType), intent(inout) :: this
     character(len=*), intent(in) :: obstypeid
     real(DP), intent(inout) :: v
     integer(I4B), intent(in) :: jj
     logical, intent(inout) :: found
     ! -- local
     integer(I4B) :: n1, n2
     !
     found = .true.
     select case (obstypeid)
     case ('RAINFALL')
       if (this%iboundpak(jj) /= 0) then
         call this%sft_rain_term(jj, n1, n2, v)
       end if
     case ('EVAPORATION')
       if (this%iboundpak(jj) /= 0) then
         call this%sft_evap_term(jj, n1, n2, v)
       end if
     case ('RUNOFF')
       if (this%iboundpak(jj) /= 0) then
         call this%sft_roff_term(jj, n1, n2, v)
       end if
     case ('EXT-INFLOW')
       if (this%iboundpak(jj) /= 0) then
         call this%sft_iflw_term(jj, n1, n2, v)
       end if
     case ('EXT-OUTFLOW')
       if (this%iboundpak(jj) /= 0) then
         call this%sft_outf_term(jj, n1, n2, v)
       end if
     case default
       found = .false.
     end select

◆ sft_create()

subroutine, public gwtsftmodule::sft_create	(	class(bndtype), pointer	packobj,
		integer(i4b), intent(in)	id,
		integer(i4b), intent(in)	ibcnum,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout,
		character(len=*), intent(in)	namemodel,
		character(len=*), intent(in)	pakname,
		type(tspfmitype), pointer	fmi,
		real(dp), intent(in), pointer	eqnsclfac,
		character(len=*), intent(in)	dvt,
		character(len=*), intent(in)	dvu,
		character(len=*), intent(in)	dvua
	)

Parameters

[in]	eqnsclfac	governing equation scale factor
[in]	dvt	For GWT, set to "CONCENTRATION" in TspAptType
[in]	dvu	For GWT, set to "mass" in TspAptType
[in]	dvua	For GWT, set to "M" in TspAptType

Definition at line 99 of file gwt-sft.f90.

     ! -- dummy
     class(BndType), pointer :: packobj
     integer(I4B), intent(in) :: id
     integer(I4B), intent(in) :: ibcnum
     integer(I4B), intent(in) :: inunit
     integer(I4B), intent(in) :: iout
     character(len=*), intent(in) :: namemodel
     character(len=*), intent(in) :: pakname
     type(TspFmiType), pointer :: fmi
     real(DP), intent(in), pointer :: eqnsclfac !< governing equation scale factor
     character(len=*), intent(in) :: dvt !< For GWT, set to "CONCENTRATION" in TspAptType
     character(len=*), intent(in) :: dvu !< For GWT, set to "mass" in TspAptType
     character(len=*), intent(in) :: dvua !< For GWT, set to "M" in TspAptType
     ! -- local
     type(GwtSftType), pointer :: sftobj
     !
     ! -- allocate the object and assign values to object variables
     allocate (sftobj)
     packobj => sftobj
     !
     ! -- create name and memory path
     call packobj%set_names(ibcnum, namemodel, pakname, ftype)
     packobj%text = text
     !
     ! -- allocate scalars
     call sftobj%allocate_scalars()
     !
     ! -- initialize package
     call packobj%pack_initialize()
     !
     packobj%inunit = inunit
     packobj%iout = iout
     packobj%id = id
     packobj%ibcnum = ibcnum
     packobj%ncolbnd = 1
     packobj%iscloc = 1
     !
     ! -- Store pointer to flow model interface.  When the GwfGwt exchange is
     !    created, it sets fmi%bndlist so that the GWT model has access to all
     !    the flow packages
     sftobj%fmi => fmi
     !
     ! -- Store pointer to governing equation scale factor
     sftobj%eqnsclfac => eqnsclfac
     !
     ! -- Set labels that will be used in generalized APT class
     sftobj%depvartype = dvt
     sftobj%depvarunit = dvu
     sftobj%depvarunitabbrev = dvua

Here is the caller graph for this function:

◆ sft_da()

subroutine gwtsftmodule::sft_da ( class(gwtsfttype) this )

Definition at line 642 of file gwt-sft.f90.

     ! -- modules
     use memorymanagermodule, only: mem_deallocate
     ! -- dummy
     class(GwtSftType) :: this
     ! -- local
     !
     ! -- deallocate scalars
     call mem_deallocate(this%idxbudrain)
     call mem_deallocate(this%idxbudevap)
     call mem_deallocate(this%idxbudroff)
     call mem_deallocate(this%idxbudiflw)
     call mem_deallocate(this%idxbudoutf)
     !
     ! -- deallocate time series
     call mem_deallocate(this%concrain)
     call mem_deallocate(this%concevap)
     call mem_deallocate(this%concroff)
     call mem_deallocate(this%conciflw)
  
     call mem_deallocate(this%vnew)
     call mem_deallocate(this%vold)
     !
     ! -- deallocate scalars in TspAptType
     call this%TspAptType%bnd_da()

◆ sft_df_obs()

subroutine gwtsftmodule::sft_df_obs ( class(gwtsfttype) this )

Store the observation type supported by the APT package and override BndTypebnd_df_obs

Definition at line 815 of file gwt-sft.f90.

     ! -- modules
     ! -- dummy
     class(GwtSftType) :: this
     ! -- local
     integer(I4B) :: indx
     !
     ! -- Store obs type and assign procedure pointer
     !    for concentration observation type.
     call this%obs%StoreObsType('concentration', .false., indx)
     this%obs%obsData(indx)%ProcessIdPtr => apt_process_obsid
     !
     ! -- Store obs type and assign procedure pointer
     !    for flow between reaches.
     call this%obs%StoreObsType('flow-ja-face', .true., indx)
     this%obs%obsData(indx)%ProcessIdPtr => apt_process_obsid12
     !
     ! -- Store obs type and assign procedure pointer
     !    for from-mvr observation type.
     call this%obs%StoreObsType('from-mvr', .true., indx)
     this%obs%obsData(indx)%ProcessIdPtr => apt_process_obsid
     !
     ! -- Store obs type and assign procedure pointer
     !    for to-mvr observation type.
     call this%obs%StoreObsType('to-mvr', .true., indx)
     this%obs%obsData(indx)%ProcessIdPtr => apt_process_obsid
     !
     ! -- Store obs type and assign procedure pointer
     !    for storage observation type.
     call this%obs%StoreObsType('storage', .true., indx)
     this%obs%obsData(indx)%ProcessIdPtr => apt_process_obsid
     !
     ! -- Store obs type and assign procedure pointer
     !    for constant observation type.
     call this%obs%StoreObsType('constant', .true., indx)
     this%obs%obsData(indx)%ProcessIdPtr => apt_process_obsid
     !
     ! -- Store obs type and assign procedure pointer
     !    for observation type: sft
     call this%obs%StoreObsType('sft', .true., indx)
     this%obs%obsData(indx)%ProcessIdPtr => apt_process_obsid
     !
     ! -- Store obs type and assign procedure pointer
     !    for rainfall observation type.
     call this%obs%StoreObsType('rainfall', .true., indx)
     this%obs%obsData(indx)%ProcessIdPtr => apt_process_obsid
     !
     ! -- Store obs type and assign procedure pointer
     !    for evaporation observation type.
     call this%obs%StoreObsType('evaporation', .true., indx)
     this%obs%obsData(indx)%ProcessIdPtr => apt_process_obsid
     !
     ! -- Store obs type and assign procedure pointer
     !    for runoff observation type.
     call this%obs%StoreObsType('runoff', .true., indx)
     this%obs%obsData(indx)%ProcessIdPtr => apt_process_obsid
     !
     ! -- Store obs type and assign procedure pointer
     !    for inflow observation type.
     call this%obs%StoreObsType('ext-inflow', .true., indx)
     this%obs%obsData(indx)%ProcessIdPtr => apt_process_obsid
     !
     ! -- Store obs type and assign procedure pointer
     !    for ext-outflow observation type.
     call this%obs%StoreObsType('ext-outflow', .true., indx)
     this%obs%obsData(indx)%ProcessIdPtr => apt_process_obsid

Here is the call graph for this function:

◆ sft_evap_term()

subroutine gwtsftmodule::sft_evap_term	(	class(gwtsfttype)	this,
		integer(i4b), intent(in)	ientry,
		integer(i4b), intent(inout)	n1,
		integer(i4b), intent(inout)	n2,
		real(dp), intent(inout), optional	rrate,
		real(dp), intent(inout), optional	rhsval,
		real(dp), intent(inout), optional	hcofval
	)

Definition at line 696 of file gwt-sft.f90.

     ! -- dummy
     class(GwtSftType) :: this
     integer(I4B), intent(in) :: ientry
     integer(I4B), intent(inout) :: n1
     integer(I4B), intent(inout) :: n2
     real(DP), intent(inout), optional :: rrate
     real(DP), intent(inout), optional :: rhsval
     real(DP), intent(inout), optional :: hcofval
     ! -- local
     real(DP) :: qbnd
     real(DP) :: ctmp
     real(DP) :: omega
     !
     n1 = this%flowbudptr%budterm(this%idxbudevap)%id1(ientry)
     n2 = this%flowbudptr%budterm(this%idxbudevap)%id2(ientry)
     ! -- note that qbnd is negative for evap
     qbnd = this%flowbudptr%budterm(this%idxbudevap)%flow(ientry)
     ctmp = this%concevap(n1)
     if (this%xnewpak(n1) < ctmp) then
       omega = done
     else
       omega = dzero
     end if
     if (present(rrate)) &
       rrate = omega * qbnd * this%xnewpak(n1) + &
               (done - omega) * qbnd * ctmp
     if (present(rhsval)) rhsval = -(done - omega) * qbnd * ctmp
     if (present(hcofval)) hcofval = omega * qbnd

◆ sft_fc_expanded()

subroutine gwtsftmodule::sft_fc_expanded	(	class(gwtsfttype)	this,
		real(dp), dimension(:), intent(inout)	rhs,
		integer(i4b), dimension(:), intent(in)	ia,
		integer(i4b), dimension(:), intent(in)	idxglo,
		class(matrixbasetype), pointer	matrix_sln
	)

This will be called from TspAptTypeapt_fc_expanded() in order to add matrix terms specifically for SFT

Definition at line 273 of file gwt-sft.f90.

     ! -- modules
     ! -- dummy
     class(GwtSftType) :: this
     real(DP), dimension(:), intent(inout) :: rhs
     integer(I4B), dimension(:), intent(in) :: ia
     integer(I4B), dimension(:), intent(in) :: idxglo
     class(MatrixBaseType), pointer :: matrix_sln
     ! -- local
     integer(I4B) :: j, n1, n2
     integer(I4B) :: iloc
     integer(I4B) :: iposd
     real(DP) :: rrate
     real(DP) :: rhsval
     real(DP) :: hcofval
     !
     ! -- add rainfall contribution
     if (this%idxbudrain /= 0) then
       do j = 1, this%flowbudptr%budterm(this%idxbudrain)%nlist
         call this%sft_rain_term(j, n1, n2, rrate, rhsval, hcofval)
         iloc = this%idxlocnode(n1)
         iposd = this%idxpakdiag(n1)
         call matrix_sln%add_value_pos(iposd, hcofval)
         rhs(iloc) = rhs(iloc) + rhsval
       end do
     end if
     !
     ! -- add evaporation contribution
     if (this%idxbudevap /= 0) then
       do j = 1, this%flowbudptr%budterm(this%idxbudevap)%nlist
         call this%sft_evap_term(j, n1, n2, rrate, rhsval, hcofval)
         iloc = this%idxlocnode(n1)
         iposd = this%idxpakdiag(n1)
         call matrix_sln%add_value_pos(iposd, hcofval)
         rhs(iloc) = rhs(iloc) + rhsval
       end do
     end if
     !
     ! -- add runoff contribution
     if (this%idxbudroff /= 0) then
       do j = 1, this%flowbudptr%budterm(this%idxbudroff)%nlist
         call this%sft_roff_term(j, n1, n2, rrate, rhsval, hcofval)
         iloc = this%idxlocnode(n1)
         iposd = this%idxpakdiag(n1)
         call matrix_sln%add_value_pos(iposd, hcofval)
         rhs(iloc) = rhs(iloc) + rhsval
       end do
     end if
     !
     ! -- add inflow contribution
     if (this%idxbudiflw /= 0) then
       do j = 1, this%flowbudptr%budterm(this%idxbudiflw)%nlist
         call this%sft_iflw_term(j, n1, n2, rrate, rhsval, hcofval)
         iloc = this%idxlocnode(n1)
         iposd = this%idxpakdiag(n1)
         call matrix_sln%add_value_pos(iposd, hcofval)
         rhs(iloc) = rhs(iloc) + rhsval
       end do
     end if
     !
     ! -- add outflow contribution
     if (this%idxbudoutf /= 0) then
       do j = 1, this%flowbudptr%budterm(this%idxbudoutf)%nlist
         call this%sft_outf_term(j, n1, n2, rrate, rhsval, hcofval)
         iloc = this%idxlocnode(n1)
         iposd = this%idxpakdiag(n1)
         call matrix_sln%add_value_pos(iposd, hcofval)
         rhs(iloc) = rhs(iloc) + rhsval
       end do
     end if

◆ sft_fill_budobj()

subroutine gwtsftmodule::sft_fill_budobj	(	class(gwtsfttype)	this,
		integer(i4b), intent(inout)	idx,
		real(dp), dimension(:), intent(in)	x,
		real(dp), dimension(:), intent(inout), contiguous	flowja,
		real(dp), intent(inout)	ccratin,
		real(dp), intent(inout)	ccratout
	)

Definition at line 492 of file gwt-sft.f90.

     ! -- modules
     ! -- dummy
     class(GwtSftType) :: this
     integer(I4B), intent(inout) :: idx
     real(DP), dimension(:), intent(in) :: x
     real(DP), dimension(:), contiguous, intent(inout) :: flowja
     real(DP), intent(inout) :: ccratin
     real(DP), intent(inout) :: ccratout
     ! -- local
     integer(I4B) :: j, n1, n2
     integer(I4B) :: nlist
     real(DP) :: q
     ! -- formats
     !
     ! -- RAIN
     idx = idx + 1
     nlist = this%flowbudptr%budterm(this%idxbudrain)%nlist
     call this%budobj%budterm(idx)%reset(nlist)
     do j = 1, nlist
       call this%sft_rain_term(j, n1, n2, q)
       call this%budobj%budterm(idx)%update_term(n1, n2, q)
       call this%apt_accumulate_ccterm(n1, q, ccratin, ccratout)
     end do
     !
     ! -- EVAPORATION
     idx = idx + 1
     nlist = this%flowbudptr%budterm(this%idxbudevap)%nlist
     call this%budobj%budterm(idx)%reset(nlist)
     do j = 1, nlist
       call this%sft_evap_term(j, n1, n2, q)
       call this%budobj%budterm(idx)%update_term(n1, n2, q)
       call this%apt_accumulate_ccterm(n1, q, ccratin, ccratout)
     end do
     !
     ! -- RUNOFF
     idx = idx + 1
     nlist = this%flowbudptr%budterm(this%idxbudroff)%nlist
     call this%budobj%budterm(idx)%reset(nlist)
     do j = 1, nlist
       call this%sft_roff_term(j, n1, n2, q)
       call this%budobj%budterm(idx)%update_term(n1, n2, q)
       call this%apt_accumulate_ccterm(n1, q, ccratin, ccratout)
     end do
     !
     ! -- EXT-INFLOW
     idx = idx + 1
     nlist = this%flowbudptr%budterm(this%idxbudiflw)%nlist
     call this%budobj%budterm(idx)%reset(nlist)
     do j = 1, nlist
       call this%sft_iflw_term(j, n1, n2, q)
       call this%budobj%budterm(idx)%update_term(n1, n2, q)
       call this%apt_accumulate_ccterm(n1, q, ccratin, ccratout)
     end do
     !
     ! -- EXT-OUTFLOW
     idx = idx + 1
     nlist = this%flowbudptr%budterm(this%idxbudoutf)%nlist
     call this%budobj%budterm(idx)%reset(nlist)
     do j = 1, nlist
       call this%sft_outf_term(j, n1, n2, q)
       call this%budobj%budterm(idx)%update_term(n1, n2, q)
       call this%apt_accumulate_ccterm(n1, q, ccratin, ccratout)
     end do

◆ sft_get_nbudterms()

integer(i4b) function gwtsftmodule::sft_get_nbudterms ( class(gwtsfttype) this )

This overrides a function in the parent class.

Definition at line 400 of file gwt-sft.f90.

     ! -- modules
     ! -- dummy
     class(GwtSftType) :: this
     ! -- return
     integer(I4B) :: nbudterms
     ! -- local
     !
     ! -- Number of budget terms is 5
     nbudterms = 5

◆ sft_get_volumes()

subroutine gwtsftmodule::sft_get_volumes	(	class(gwtsfttype)	this,
		integer(i4b), intent(in)	icv,
		real(dp), intent(inout)	vnew,
		real(dp), intent(inout)	vold,
		real(dp), intent(in)	delt
	)

Definition at line 1031 of file gwt-sft.f90.

     ! modules
     ! dummy
     class(GwtSftType) :: this
     integer(I4B), intent(in) :: icv
     real(DP), intent(inout) :: vnew, vold
     real(DP), intent(in) :: delt
     ! local
     real(DP) :: qss
     !
     ! -- get volumes
     vold = dzero
     vnew = vold
     if (this%idxbudsto /= 0) then
       qss = this%flowbudptr%budterm(this%idxbudsto)%flow(icv)
       vnew = this%flowbudptr%budterm(this%idxbudsto)%auxvar(1, icv)
       this%vnew(icv) = vnew
       if (qss /= dzero) then
         vold = vnew + qss * delt
       else
         if (vnew == dzero) then
           vold = dzero
         else
           vold = this%vold(icv)
         end if
       end if
     end if

◆ sft_iflw_term()

subroutine gwtsftmodule::sft_iflw_term	(	class(gwtsfttype)	this,
		integer(i4b), intent(in)	ientry,
		integer(i4b), intent(inout)	n1,
		integer(i4b), intent(inout)	n2,
		real(dp), intent(inout), optional	rrate,
		real(dp), intent(inout), optional	rhsval,
		real(dp), intent(inout), optional	hcofval
	)

Accounts for mass added via streamflow entering into a stream channel; for example, energy entering the model domain via a specified flow in a stream channel.

Definition at line 759 of file gwt-sft.f90.

     ! -- dummy
     class(GwtSftType) :: this
     integer(I4B), intent(in) :: ientry
     integer(I4B), intent(inout) :: n1
     integer(I4B), intent(inout) :: n2
     real(DP), intent(inout), optional :: rrate
     real(DP), intent(inout), optional :: rhsval
     real(DP), intent(inout), optional :: hcofval
     ! -- local
     real(DP) :: qbnd
     real(DP) :: ctmp
     !
     n1 = this%flowbudptr%budterm(this%idxbudiflw)%id1(ientry)
     n2 = this%flowbudptr%budterm(this%idxbudiflw)%id2(ientry)
     qbnd = this%flowbudptr%budterm(this%idxbudiflw)%flow(ientry)
     ctmp = this%conciflw(n1)
     if (present(rrate)) rrate = ctmp * qbnd
     if (present(rhsval)) rhsval = -rrate
     if (present(hcofval)) hcofval = dzero

◆ sft_outf_term()

subroutine gwtsftmodule::sft_outf_term	(	class(gwtsfttype)	this,
		integer(i4b), intent(in)	ientry,
		integer(i4b), intent(inout)	n1,
		integer(i4b), intent(inout)	n2,
		real(dp), intent(inout), optional	rrate,
		real(dp), intent(inout), optional	rhsval,
		real(dp), intent(inout), optional	hcofval
	)

Accounts for the mass leaving a stream channel; for example, mass exiting the model domain via a flow in a stream channel flowing out of the active domain.

Definition at line 787 of file gwt-sft.f90.

     ! -- dummy
     class(GwtSftType) :: this
     integer(I4B), intent(in) :: ientry
     integer(I4B), intent(inout) :: n1
     integer(I4B), intent(inout) :: n2
     real(DP), intent(inout), optional :: rrate
     real(DP), intent(inout), optional :: rhsval
     real(DP), intent(inout), optional :: hcofval
     ! -- local
     real(DP) :: qbnd
     real(DP) :: ctmp
     !
     n1 = this%flowbudptr%budterm(this%idxbudoutf)%id1(ientry)
     n2 = this%flowbudptr%budterm(this%idxbudoutf)%id2(ientry)
     qbnd = this%flowbudptr%budterm(this%idxbudoutf)%flow(ientry)
     ctmp = this%xnewpak(n1)
     if (present(rrate)) rrate = ctmp * qbnd
     if (present(rhsval)) rhsval = dzero
     if (present(hcofval)) hcofval = qbnd

◆ sft_rain_term()

subroutine gwtsftmodule::sft_rain_term	(	class(gwtsfttype)	this,
		integer(i4b), intent(in)	ientry,
		integer(i4b), intent(inout)	n1,
		integer(i4b), intent(inout)	n2,
		real(dp), intent(inout), optional	rrate,
		real(dp), intent(inout), optional	rhsval,
		real(dp), intent(inout), optional	hcofval
	)

Definition at line 671 of file gwt-sft.f90.

     ! -- dummy
     class(GwtSftType) :: this
     integer(I4B), intent(in) :: ientry
     integer(I4B), intent(inout) :: n1
     integer(I4B), intent(inout) :: n2
     real(DP), intent(inout), optional :: rrate
     real(DP), intent(inout), optional :: rhsval
     real(DP), intent(inout), optional :: hcofval
     ! -- local
     real(DP) :: qbnd
     real(DP) :: ctmp
     !
     n1 = this%flowbudptr%budterm(this%idxbudrain)%id1(ientry)
     n2 = this%flowbudptr%budterm(this%idxbudrain)%id2(ientry)
     qbnd = this%flowbudptr%budterm(this%idxbudrain)%flow(ientry)
     ctmp = this%concrain(n1)
     if (present(rrate)) rrate = ctmp * qbnd
     if (present(rhsval)) rhsval = -rrate
     if (present(hcofval)) hcofval = dzero

◆ sft_roff_term()

subroutine gwtsftmodule::sft_roff_term	(	class(gwtsfttype)	this,
		integer(i4b), intent(in)	ientry,
		integer(i4b), intent(inout)	n1,
		integer(i4b), intent(inout)	n2,
		real(dp), intent(inout), optional	rrate,
		real(dp), intent(inout), optional	rhsval,
		real(dp), intent(inout), optional	hcofval
	)

Definition at line 730 of file gwt-sft.f90.

     ! -- dummy
     class(GwtSftType) :: this
     integer(I4B), intent(in) :: ientry
     integer(I4B), intent(inout) :: n1
     integer(I4B), intent(inout) :: n2
     real(DP), intent(inout), optional :: rrate
     real(DP), intent(inout), optional :: rhsval
     real(DP), intent(inout), optional :: hcofval
     ! -- local
     real(DP) :: qbnd
     real(DP) :: ctmp
     !
     n1 = this%flowbudptr%budterm(this%idxbudroff)%id1(ientry)
     n2 = this%flowbudptr%budterm(this%idxbudroff)%id2(ientry)
     qbnd = this%flowbudptr%budterm(this%idxbudroff)%flow(ientry)
     ctmp = this%concroff(n1)
     if (present(rrate)) rrate = ctmp * qbnd
     if (present(rhsval)) rhsval = -rrate
     if (present(hcofval)) hcofval = dzero

◆ sft_rp_obs()

subroutine gwtsftmodule::sft_rp_obs	(	class(gwtsfttype), intent(inout)	this,
		type(observetype), intent(inout)	obsrv,
		logical, intent(inout)	found
	)

Method to process specific observations for this package.

Parameters

[in,out]	this	package class
[in,out]	obsrv	observation object
[in,out]	found	indicate whether observation was found

Definition at line 887 of file gwt-sft.f90.

     ! -- dummy
     class(GwtSftType), intent(inout) :: this !< package class
     type(ObserveType), intent(inout) :: obsrv !< observation object
     logical, intent(inout) :: found !< indicate whether observation was found
     ! -- local
     !
     found = .true.
     select case (obsrv%ObsTypeId)
     case ('RAINFALL')
       call this%rp_obs_byfeature(obsrv)
     case ('EVAPORATION')
       call this%rp_obs_byfeature(obsrv)
     case ('RUNOFF')
       call this%rp_obs_byfeature(obsrv)
     case ('EXT-INFLOW')
       call this%rp_obs_byfeature(obsrv)
     case ('EXT-OUTFLOW')
       call this%rp_obs_byfeature(obsrv)
     case ('TO-MVR')
       call this%rp_obs_byfeature(obsrv)
     case default
       found = .false.
     end select

◆ sft_set_stressperiod()

subroutine gwtsftmodule::sft_set_stressperiod	(	class(gwtsfttype), intent(inout)	this,
		integer(i4b), intent(in)	itemno,
		character(len=*), intent(in)	keyword,
		logical, intent(inout)	found
	)

Definition at line 954 of file gwt-sft.f90.

     use timeseriesmanagermodule, only: read_value_or_time_series_adv
     ! -- dummy
     class(GwtSftType), intent(inout) :: this
     integer(I4B), intent(in) :: itemno
     character(len=*), intent(in) :: keyword
     logical, intent(inout) :: found
     ! -- local
     character(len=LINELENGTH) :: text
     integer(I4B) :: ierr
     integer(I4B) :: jj
     real(DP), pointer :: bndElem => null()
     ! -- formats
     !
     ! RAINFALL <rainfall>
     ! EVAPORATION <evaporation>
     ! RUNOFF <runoff>
     ! INFLOW <inflow>
     ! WITHDRAWAL <withdrawal>
     !
     found = .true.
     select case (keyword)
     case ('RAINFALL')
       ierr = this%apt_check_valid(itemno)
       if (ierr /= 0) then
         goto 999
       end if
       call this%parser%GetString(text)
       jj = 1
       bndelem => this%concrain(itemno)
       call read_value_or_time_series_adv(text, itemno, jj, bndelem, &
                                          this%packName, 'BND', this%tsManager, &
                                          this%iprpak, 'RAINFALL')
     case ('EVAPORATION')
       ierr = this%apt_check_valid(itemno)
       if (ierr /= 0) then
         goto 999
       end if
       call this%parser%GetString(text)
       jj = 1
       bndelem => this%concevap(itemno)
       call read_value_or_time_series_adv(text, itemno, jj, bndelem, &
                                          this%packName, 'BND', this%tsManager, &
                                          this%iprpak, 'EVAPORATION')
     case ('RUNOFF')
       ierr = this%apt_check_valid(itemno)
       if (ierr /= 0) then
         goto 999
       end if
       call this%parser%GetString(text)
       jj = 1
       bndelem => this%concroff(itemno)
       call read_value_or_time_series_adv(text, itemno, jj, bndelem, &
                                          this%packName, 'BND', this%tsManager, &
                                          this%iprpak, 'RUNOFF')
     case ('INFLOW')
       ierr = this%apt_check_valid(itemno)
       if (ierr /= 0) then
         goto 999
       end if
       call this%parser%GetString(text)
       jj = 1
       bndelem => this%conciflw(itemno)
       call read_value_or_time_series_adv(text, itemno, jj, bndelem, &
                                          this%packName, 'BND', this%tsManager, &
                                          this%iprpak, 'INFLOW')
     case default
       !
       ! -- keyword not recognized so return to caller with found = .false.
       found = .false.
     end select
     !
 999 continue

Here is the call graph for this function:

◆ sft_setup_budobj()

subroutine gwtsftmodule::sft_setup_budobj	(	class(gwtsfttype)	this,
		integer(i4b), intent(inout)	idx
	)

Definition at line 414 of file gwt-sft.f90.

     ! -- modules
     use constantsmodule, only: lenbudtxt
     ! -- dummy
     class(GwtSftType) :: this
     integer(I4B), intent(inout) :: idx
     ! -- local
     integer(I4B) :: maxlist, naux
     character(len=LENBUDTXT) :: text
     !
     ! --
     text = '        RAINFALL'
     idx = idx + 1
     maxlist = this%flowbudptr%budterm(this%idxbudrain)%maxlist
     naux = 0
     call this%budobj%budterm(idx)%initialize(text, &
                                              this%name_model, &
                                              this%packName, &
                                              this%name_model, &
                                              this%packName, &
                                              maxlist, .false., .false., &
                                              naux)
     !
     ! --
     text = '     EVAPORATION'
     idx = idx + 1
     maxlist = this%flowbudptr%budterm(this%idxbudevap)%maxlist
     naux = 0
     call this%budobj%budterm(idx)%initialize(text, &
                                              this%name_model, &
                                              this%packName, &
                                              this%name_model, &
                                              this%packName, &
                                              maxlist, .false., .false., &
                                              naux)
     !
     ! --
     text = '          RUNOFF'
     idx = idx + 1
     maxlist = this%flowbudptr%budterm(this%idxbudroff)%maxlist
     naux = 0
     call this%budobj%budterm(idx)%initialize(text, &
                                              this%name_model, &
                                              this%packName, &
                                              this%name_model, &
                                              this%packName, &
                                              maxlist, .false., .false., &
                                              naux)
     !
     ! --
     text = '      EXT-INFLOW'
     idx = idx + 1
     maxlist = this%flowbudptr%budterm(this%idxbudiflw)%maxlist
     naux = 0
     call this%budobj%budterm(idx)%initialize(text, &
                                              this%name_model, &
                                              this%packName, &
                                              this%name_model, &
                                              this%packName, &
                                              maxlist, .false., .false., &
                                              naux)
     !
     ! --
     text = '     EXT-OUTFLOW'
     idx = idx + 1
     maxlist = this%flowbudptr%budterm(this%idxbudoutf)%maxlist
     naux = 0
     call this%budobj%budterm(idx)%initialize(text, &
                                              this%name_model, &
                                              this%packName, &
                                              this%name_model, &
                                              this%packName, &
                                              maxlist, .false., .false., &
                                              naux)

◆ sft_solve()

subroutine gwtsftmodule::sft_solve ( class(gwtsfttype) this )

Definition at line 347 of file gwt-sft.f90.

     ! -- dummy
     class(GwtSftType) :: this
     ! -- local
     integer(I4B) :: j
     integer(I4B) :: n1, n2
     real(DP) :: rrate
     !
     ! -- add rainfall contribution
     if (this%idxbudrain /= 0) then
       do j = 1, this%flowbudptr%budterm(this%idxbudrain)%nlist
         call this%sft_rain_term(j, n1, n2, rrate)
         this%dbuff(n1) = this%dbuff(n1) + rrate
       end do
     end if
     !
     ! -- add evaporation contribution
     if (this%idxbudevap /= 0) then
       do j = 1, this%flowbudptr%budterm(this%idxbudevap)%nlist
         call this%sft_evap_term(j, n1, n2, rrate)
         this%dbuff(n1) = this%dbuff(n1) + rrate
       end do
     end if
     !
     ! -- add runoff contribution
     if (this%idxbudroff /= 0) then
       do j = 1, this%flowbudptr%budterm(this%idxbudroff)%nlist
         call this%sft_roff_term(j, n1, n2, rrate)
         this%dbuff(n1) = this%dbuff(n1) + rrate
       end do
     end if
     !
     ! -- add inflow contribution
     if (this%idxbudiflw /= 0) then
       do j = 1, this%flowbudptr%budterm(this%idxbudiflw)%nlist
         call this%sft_iflw_term(j, n1, n2, rrate)
         this%dbuff(n1) = this%dbuff(n1) + rrate
       end do
     end if
     !
     ! -- add outflow contribution
     if (this%idxbudoutf /= 0) then
       do j = 1, this%flowbudptr%budterm(this%idxbudoutf)%nlist
         call this%sft_outf_term(j, n1, n2, rrate)
         this%dbuff(n1) = this%dbuff(n1) + rrate
       end do
     end if

Variable Documentation

◆ flowtype

character(len=*), parameter gwtsftmodule::flowtype = 'SFR'

Definition at line 51 of file gwt-sft.f90.

51 character(len=*), parameter :: flowtype = 'SFR'

◆ ftype

character(len=*), parameter gwtsftmodule::ftype = 'SFT'

Definition at line 50 of file gwt-sft.f90.

50 character(len=*), parameter :: ftype = 'SFT'

◆ text

character(len=16) gwtsftmodule::text = ' SFT'

Definition at line 52 of file gwt-sft.f90.

52 character(len=16) :: text = ' SFT'

Data Types

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ allocate_scalars()

◆ find_sft_package()

◆ sft_ad()

◆ sft_allocate_arrays()

◆ sft_bd_obs()

◆ sft_create()

◆ sft_da()

◆ sft_df_obs()

◆ sft_evap_term()

◆ sft_fc_expanded()

◆ sft_fill_budobj()

◆ sft_get_nbudterms()

◆ sft_get_volumes()

◆ sft_iflw_term()

◆ sft_outf_term()

◆ sft_rain_term()

◆ sft_roff_term()

◆ sft_rp_obs()

◆ sft_set_stressperiod()

◆ sft_setup_budobj()

◆ sft_solve()

Variable Documentation

◆ flowtype

◆ ftype

◆ text