This module contains the TspSsm Module. More...

Data Types
type	tspssmtype
	Derived type for the SSM Package. More...

Functions/Subroutines
subroutine, public	ssm_cr (ssmobj, name_model, inunit, iout, fmi, eqnsclfac, depvartype)
	@ brief Create a new SSM package More...

subroutine	ssm_df (this)
	@ brief Define SSM Package More...

subroutine	ssm_ar (this, dis, ibound, cnew)
	@ brief Allocate and read SSM Package More...

subroutine	ssm_rp (this)
	@ brief Read and prepare this SSM Package More...

subroutine	ssm_ad (this)
	@ brief Advance the SSM Package More...

subroutine	ssm_term (this, ipackage, ientry, rrate, rhsval, hcofval, cssm, qssm)
	@ brief Calculate the SSM mass flow rate and hcof and rhs values More...

subroutine	get_ssm_conc (this, ipackage, ientry, nbound_flow, conc, lauxmixed)
	@ brief Provide bound concentration (or temperature) and mixed flag More...

subroutine	ssm_fc (this, matrix_sln, idxglo, rhs)
	@ brief Fill coefficients More...

subroutine	ssm_cq (this, flowja)
	@ brief Calculate flow More...

subroutine	ssm_bd (this, isuppress_output, model_budget)
	@ brief Calculate the global SSM budget terms More...

subroutine	ssm_ot_flow (this, icbcfl, ibudfl, icbcun)
	@ brief Output flows More...

subroutine	ssm_da (this)
	@ brief Deallocate More...

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

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

subroutine	read_options (this)
	@ brief Read package options More...

subroutine	read_data (this)
	@ brief Read package data More...

subroutine	read_sources_aux (this)
	@ brief Read SOURCES block More...

subroutine	read_sources_fileinput (this)
	@ brief Read FILEINPUT block More...

subroutine	set_iauxpak (this, ip, packname)
	@ brief Set iauxpak array value for package ip More...

subroutine	set_ssmivec (this, ip, packname)
	@ brief Set ssmivec array value for package ip More...

subroutine	pak_setup_outputtab (this)
	@ brief Setup the output table More...

Variables
character(len=lenftype)	ftype = 'SSM'

character(len=lenpackagename)	text = ' SOURCE-SINK MIX'

Detailed Description

This module contains the code for handling sources and sinks associated with groundwater flow model stress packages.

todo: need observations for SSM terms

Function/Subroutine Documentation

◆ allocate_arrays()

subroutine tspssmmodule::allocate_arrays ( class(tspssmtype) this )

Allocate array variables for this derived type

Parameters

this	TspSsmType object

Definition at line 712 of file tsp-ssm.f90.

     ! -- modules
     use memorymanagermodule, only: mem_allocate, mem_setptr
     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType object
     ! -- local
     integer(I4B) :: nflowpack
     integer(I4B) :: i
     !
     ! -- Allocate
     nflowpack = this%fmi%nflowpack
     call mem_allocate(this%iauxpak, nflowpack, 'IAUXPAK', this%memoryPath)
     call mem_allocate(this%isrctype, nflowpack, 'ISRCTYPE', this%memoryPath)
     !
     ! -- Initialize
     do i = 1, nflowpack
       this%iauxpak(i) = 0
       this%isrctype(i) = 0
     end do
     !
     ! -- Allocate the ssmivec array
     allocate (this%ssmivec(nflowpack))

◆ allocate_scalars()

subroutine tspssmmodule::allocate_scalars ( class(tspssmtype) this )

Allocate scalar variables for this derived type

Parameters

this	TspSsmType object

Definition at line 692 of file tsp-ssm.f90.

     ! -- modules
     use memorymanagermodule, only: mem_allocate, mem_setptr
     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType object
     !
     ! -- allocate scalars in NumericalPackageType
     call this%NumericalPackageType%allocate_scalars()
     !
     ! -- Allocate
     call mem_allocate(this%nbound, 'NBOUND', this%memoryPath)
     !
     ! -- Initialize
     this%nbound = 0

◆ get_ssm_conc()

subroutine tspssmmodule::get_ssm_conc	(	class(tspssmtype)	this,
		integer(i4b), intent(in)	ipackage,
		integer(i4b), intent(in)	ientry,
		integer(i4b), intent(in)	nbound_flow,
		real(dp), intent(out)	conc,
		logical(lgp), intent(out)	lauxmixed
	)

SSM concentrations and temperatures can be provided in auxiliary variables or through separate SPC files. If not provided, the default concentration (or temperature) is zero. This single routine provides the SSM bound concentration (or temperature) based on these different approaches. The mixed flag indicates whether or not the boundary as a mixed type.

Parameters

	this	TspSsmType
[in]	ipackage	package number
[in]	ientry	bound number
[in]	nbound_flow	size of flow package bound list
[out]	conc	user-specified concentration/temperature for this bound
[out]	lauxmixed	user-specified flag for marking this as a mixed boundary

Definition at line 356 of file tsp-ssm.f90.

     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType
     integer(I4B), intent(in) :: ipackage !< package number
     integer(I4B), intent(in) :: ientry !< bound number
     integer(I4B), intent(in) :: nbound_flow !< size of flow package bound list
     real(DP), intent(out) :: conc !< user-specified concentration/temperature for this bound
     logical(LGP), intent(out) :: lauxmixed !< user-specified flag for marking this as a mixed boundary
     ! -- local
     integer(I4B) :: isrctype
     integer(I4B) :: iauxpos
     !
     conc = dzero
     lauxmixed = .false.
     isrctype = this%isrctype(ipackage)
     !
     select case (isrctype)
     case (1, 2)
       iauxpos = this%iauxpak(ipackage)
       conc = this%fmi%gwfpackages(ipackage)%auxvar(iauxpos, ientry)
       if (isrctype == 2) lauxmixed = .true.
     case (3, 4)
       conc = this%ssmivec(ipackage)%get_value(ientry, nbound_flow)
       if (isrctype == 4) lauxmixed = .true.
     end select

◆ pak_setup_outputtab()

subroutine tspssmmodule::pak_setup_outputtab ( class(tspssmtype), intent(inout) this )

Setup the output table by creating the column headers.

Definition at line 1085 of file tsp-ssm.f90.

     ! -- dummy
     class(TspSsmType), intent(inout) :: this
     ! -- local
     character(len=LINELENGTH) :: title
     character(len=LINELENGTH) :: text
     integer(I4B) :: ntabcol
     !
     ! -- allocate and initialize the output table
     if (this%iprflow /= 0) then
       !
       ! -- dimension table
       ntabcol = 6
       !if (this%inamedbound > 0) then
       !  ntabcol = ntabcol + 1
       !end if
       !
       ! -- initialize the output table object
       title = 'SSM PACKAGE ('//trim(this%packName)// &
               ') FLOW RATES'
       call table_cr(this%outputtab, this%packName, title)
       call this%outputtab%table_df(1, ntabcol, this%iout, transient=.true.)
       text = 'NUMBER'
       call this%outputtab%initialize_column(text, 10, alignment=tabcenter)
       text = 'CELLID'
       call this%outputtab%initialize_column(text, 20, alignment=tableft)
       text = 'BOUND Q'
       call this%outputtab%initialize_column(text, 15, alignment=tabcenter)
       text = 'SSM CONC'
       call this%outputtab%initialize_column(text, 15, alignment=tabcenter)
       text = 'RATE'
       call this%outputtab%initialize_column(text, 15, alignment=tabcenter)
       text = 'PACKAGE NAME'
       call this%outputtab%initialize_column(text, 16, alignment=tabcenter)
       !if (this%inamedbound > 0) then
       !  text = 'NAME'
       !  call this%outputtab%initialize_column(text, 20, alignment=TABLEFT)
       !end if
     end if

Here is the call graph for this function:

◆ read_data()

subroutine tspssmmodule::read_data ( class(tspssmtype) this )

Read and set the SSM Package data

Parameters

this	TspSsmType object

Definition at line 787 of file tsp-ssm.f90.

     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType object
     !
     ! -- read and process required SOURCES block
     call this%read_sources_aux()
     !
     ! -- read and process optional FILEINPUT block
     call this%read_sources_fileinput()

◆ read_options()

subroutine tspssmmodule::read_options ( class(tspssmtype) this )

Read and set the SSM Package options

Parameters

this	TspSsmType object

Definition at line 740 of file tsp-ssm.f90.

     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType object
     ! -- local
     character(len=LINELENGTH) :: keyword
     integer(I4B) :: ierr
     logical :: isfound, endOfBlock
     ! -- formats
     character(len=*), parameter :: fmtiprflow = &
       "(4x,'SSM FLOW INFORMATION WILL BE PRINTED TO LISTING FILE &
       &WHENEVER ICBCFL IS NOT ZERO.')"
     character(len=*), parameter :: fmtisvflow = &
       "(4x,'CELL-BY-CELL FLOW INFORMATION WILL BE SAVED TO BINARY FILE &
       &WHENEVER ICBCFL IS NOT ZERO.')"
     !
     ! -- get options block
     call this%parser%GetBlock('OPTIONS', isfound, ierr, blockrequired=.false., &
                               supportopenclose=.true.)
     !
     ! -- parse options block if detected
     if (isfound) then
       write (this%iout, '(1x,a)') 'PROCESSING SSM OPTIONS'
       do
         call this%parser%GetNextLine(endofblock)
         if (endofblock) exit
         call this%parser%GetStringCaps(keyword)
         select case (keyword)
         case ('PRINT_FLOWS')
           this%iprflow = 1
           write (this%iout, fmtiprflow)
         case ('SAVE_FLOWS')
           this%ipakcb = -1
           write (this%iout, fmtisvflow)
         case default
           write (errmsg, '(a,a)') 'Unknown SSM option: ', trim(keyword)
           call store_error(errmsg)
           call this%parser%StoreErrorUnit()
         end select
       end do
       write (this%iout, '(1x,a)') 'END OF SSM OPTIONS'
     end if

Here is the call graph for this function:

◆ read_sources_aux()

subroutine tspssmmodule::read_sources_aux ( class(tspssmtype) this )

Read SOURCES block and look for auxiliary columns in corresponding flow data.

Parameters

this	TspSsmType object

Definition at line 803 of file tsp-ssm.f90.

     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType object
     ! -- local
     character(len=LINELENGTH) :: keyword
     character(len=20) :: srctype
     integer(I4B) :: ierr
     integer(I4B) :: ip
     integer(I4B) :: nflowpack
     integer(I4B) :: isrctype
     logical :: isfound, endOfBlock
     logical :: pakfound
     logical :: lauxmixed
     !
     ! -- initialize
     isfound = .false.
     lauxmixed = .false.
     nflowpack = this%fmi%nflowpack
     !
     ! -- get sources block
     call this%parser%GetBlock('SOURCES', isfound, ierr, &
                               supportopenclose=.true., &
                               blockrequired=.true.)
     if (isfound) then
       write (this%iout, '(1x,a)') 'PROCESSING SOURCES'
       do
         call this%parser%GetNextLine(endofblock)
         if (endofblock) exit
         !
         ! -- read package name and make sure it can be found
         call this%parser%GetStringCaps(keyword)
         pakfound = .false.
         do ip = 1, nflowpack
           if (trim(adjustl(this%fmi%gwfpackages(ip)%name)) == keyword) then
             pakfound = .true.
             exit
           end if
         end do
         if (.not. pakfound) then
           write (errmsg, '(a,a)') 'Flow package cannot be found: ', &
             trim(keyword)
           call store_error(errmsg)
           call this%parser%StoreErrorUnit()
         end if
         !
         ! -- Ensure package was not specified more than once in SOURCES block
         if (this%isrctype(ip) /= 0) then
           write (errmsg, '(a, a)') &
             'A package cannot be specified more than once in the SSM SOURCES &
             &block.  The following package was specified more than once: ', &
             trim(keyword)
           call store_error(errmsg)
           call this%parser%StoreErrorUnit()
         end if
         !
         ! -- read the source type
         call this%parser%GetStringCaps(srctype)
         select case (srctype)
         case ('AUX')
           write (this%iout, '(1x,a)') 'AUX SOURCE DETECTED.'
           isrctype = 1
         case ('AUXMIXED')
           write (this%iout, '(1x,a)') 'AUXMIXED SOURCE DETECTED.'
           lauxmixed = .true.
           isrctype = 2
         case default
           write (errmsg, '(a, a)') &
             'SRCTYPE must be AUX or AUXMIXED.  Found: ', trim(srctype)
           call store_error(errmsg)
           call this%parser%StoreErrorUnit()
         end select
         !
         ! -- Store the source type (1 or 2)
         this%isrctype(ip) = isrctype
         !
         ! -- Find and store the auxiliary column
         call this%set_iauxpak(ip, trim(keyword))
  
       end do
       write (this%iout, '(1x,a)') 'END PROCESSING SOURCES'
     else
       write (errmsg, '(a)') 'Required SOURCES block not found.'
       call store_error(errmsg)
       call this%parser%StoreErrorUnit()
     end if
     !
     ! -- terminate if errors
     if (count_errors() > 0) then
       call this%parser%StoreErrorUnit()
     end if

Here is the call graph for this function:

◆ read_sources_fileinput()

subroutine tspssmmodule::read_sources_fileinput ( class(tspssmtype) this )

Read optional FILEINPUT block and initialize an SPC input file reader for each entry.

Parameters

this	TspSsmType object

Definition at line 900 of file tsp-ssm.f90.

     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType object
     ! -- local
     character(len=LINELENGTH) :: keyword
     character(len=LINELENGTH) :: keyword2
     character(len=20) :: srctype
     integer(I4B) :: ierr
     integer(I4B) :: ip
     integer(I4B) :: nflowpack
     integer(I4B) :: isrctype
     logical :: isfound, endOfBlock
     logical :: pakfound
     logical :: lauxmixed
     !
     ! -- initialize
     isfound = .false.
     lauxmixed = .false.
     nflowpack = this%fmi%nflowpack
     !
     ! -- get sources_file block
     call this%parser%GetBlock('FILEINPUT', isfound, ierr, &
                               supportopenclose=.true., &
                               blockrequired=.false.)
     if (isfound) then
       write (this%iout, '(1x,a)') 'PROCESSING FILEINPUT'
       do
         call this%parser%GetNextLine(endofblock)
         if (endofblock) exit
         !
         ! -- read package name and make sure it can be found
         call this%parser%GetStringCaps(keyword)
         pakfound = .false.
         do ip = 1, nflowpack
           if (trim(adjustl(this%fmi%gwfpackages(ip)%name)) == keyword) then
             pakfound = .true.
             exit
           end if
         end do
         if (.not. pakfound) then
           write (errmsg, '(a,a)') 'Flow package cannot be found: ', &
             trim(keyword)
           call store_error(errmsg)
           call this%parser%StoreErrorUnit()
         end if
         !
         ! -- Ensure package was not specified more than once in SOURCES block
         if (this%isrctype(ip) /= 0) then
           write (errmsg, '(a, a)') &
             'A package cannot be specified more than once in the SSM SOURCES &
             &and SOURCES_FILES blocks.  The following package was specified &
             &more than once: ', &
             trim(keyword)
           call store_error(errmsg)
           call this%parser%StoreErrorUnit()
         end if
         !
         ! -- read the source type
         call this%parser%GetStringCaps(srctype)
         select case (srctype)
         case ('SPC6')
           write (this%iout, '(1x,a)') 'SPC6 SOURCE DETECTED.'
           isrctype = 3
           !
           ! verify filein is next
           call this%parser%GetStringCaps(keyword2)
           if (trim(adjustl(keyword2)) /= 'FILEIN') then
             errmsg = 'SPC6 keyword must be followed by "FILEIN" '// &
                      'then by filename and optionally by <MIXED>.'
             call store_error(errmsg)
             call this%parser%StoreErrorUnit()
           end if
           !
           ! -- Use set_ssmivec to read file name and set up
           !    ssmi file object
           call this%set_ssmivec(ip, trim(keyword))
           !
           ! -- check for optional MIXED keyword and set isrctype to 4 if found
           call this%parser%GetStringCaps(keyword2)
           if (trim(keyword2) == 'MIXED') then
             isrctype = 4
             write (this%iout, '(1x,a,a)') 'ASSIGNED MIXED SSM TYPE TO PACKAGE ', &
               trim(keyword)
           end if
         case default
           write (errmsg, '(a,a)') &
             'SRCTYPE must be SPC6.  Found: ', trim(srctype)
           call store_error(errmsg)
           call this%parser%StoreErrorUnit()
         end select
         !
         ! -- Store the source type (3 or 4)
         this%isrctype(ip) = isrctype
         !
       end do
       write (this%iout, '(1x,a)') 'END PROCESSING FILEINPUT'
     else
       write (this%iout, '(1x,a)') &
         'OPTIONAL FILEINPUT BLOCK NOT FOUND.  CONTINUING.'
     end if
     !
     ! -- terminate if errors
     if (count_errors() > 0) then
       call this%parser%StoreErrorUnit()
     end if

Here is the call graph for this function:

◆ set_iauxpak()

subroutine tspssmmodule::set_iauxpak	(	class(tspssmtype), intent(inout)	this,
		integer(i4b), intent(in)	ip,
		character(len=*), intent(in)	packname
	)

The next call to parser will return the auxiliary name for package ip in the SSM SOURCES block. The routine searches through the auxiliary names in package ip and sets iauxpak to the column number corresponding to the correct auxiliary column.

Parameters

[in,out]	this	TspSsmType
[in]	ip	package number
[in]	packname	name of package

Definition at line 1015 of file tsp-ssm.f90.

     ! -- dummy
     class(TspSsmType), intent(inout) :: this !< TspSsmType
     integer(I4B), intent(in) :: ip !< package number
     character(len=*), intent(in) :: packname !< name of package
     ! -- local
     character(len=LENAUXNAME) :: auxname
     logical :: auxfound
     integer(I4B) :: iaux
     !
     ! -- read name of auxiliary column
     call this%parser%GetStringCaps(auxname)
     auxfound = .false.
     do iaux = 1, this%fmi%gwfpackages(ip)%naux
       if (trim(this%fmi%gwfpackages(ip)%auxname(iaux)) == &
           trim(auxname)) then
         auxfound = .true.
         exit
       end if
     end do
     if (.not. auxfound) then
       write (errmsg, '(a, a)') &
         'Auxiliary name cannot be found: ', trim(auxname)
       call store_error(errmsg)
       call this%parser%StoreErrorUnit()
     end if
     !
     ! -- set iauxpak and write message
     this%iauxpak(ip) = iaux
     write (this%iout, '(4x, a, i0, a, a)') 'USING AUX COLUMN ', &
       iaux, ' IN PACKAGE ', trim(packname)

Here is the call graph for this function:

◆ set_ssmivec()

subroutine tspssmmodule::set_ssmivec	(	class(tspssmtype), intent(inout)	this,
		integer(i4b), intent(in)	ip,
		character(len=*), intent(in)	packname
	)

The next call to parser will return the input file name for package ip in the SSM SOURCES block. The routine then initializes the SPC input file.

Parameters

[in,out]	this	TspSsmType
[in]	ip	package number
[in]	packname	name of package

Definition at line 1054 of file tsp-ssm.f90.

     ! -- module
     use inputoutputmodule, only: openfile, getunit
     ! -- dummy
     class(TspSsmType), intent(inout) :: this !< TspSsmType
     integer(I4B), intent(in) :: ip !< package number
     character(len=*), intent(in) :: packname !< name of package
     ! -- local
     character(len=LINELENGTH) :: filename
     type(TspSpcType), pointer :: ssmiptr
     integer(I4B) :: inunit
     !
     ! -- read file name
     call this%parser%GetString(filename)
     inunit = getunit()
     call openfile(inunit, this%iout, filename, 'SPC', filstat_opt='OLD')
     !
     ! -- Create the SPC file object
     ssmiptr => this%ssmivec(ip)
     call ssmiptr%initialize(this%dis, ip, inunit, this%iout, this%name_model, &
                             trim(packname), this%depvartype)
     !
     write (this%iout, '(4x, a, a, a, a, a)') 'USING SPC INPUT FILE ', &
       trim(filename), ' TO SET ', trim(this%depvartype), &
       'S FOR PACKAGE ', trim(packname)

Here is the call graph for this function:

◆ ssm_ad()

subroutine tspssmmodule::ssm_ad ( class(tspssmtype) this )

This routine is called from gwt_ad(). It is called at the beginning of each time step. The total number of flow boundaries is counted and stored in thisnbound. Also, if any SPC input files are used to provide source and sink concentrations (or temperatures) and time series are referenced in those files, then ssm concenrations must be interpolated for the time step.

Parameters

this	TspSsmType object

Definition at line 214 of file tsp-ssm.f90.

     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType object
     ! -- local
     integer(I4B) :: ip
     type(TspSpcType), pointer :: ssmiptr
     integer(I4B) :: i
     integer(I4B) :: node
     !
     ! -- Calculate total number of existing flow boundaries. It is possible
     !    that a node may equal zero.  In this case, the bound should be
     !    skipped and not written to ssm output.
     this%nbound = 0
     do ip = 1, this%fmi%nflowpack
       if (this%fmi%iatp(ip) /= 0) cycle
       do i = 1, this%fmi%gwfpackages(ip)%nbound
         node = this%fmi%gwfpackages(ip)%nodelist(i)
         if (node > 0) then
           this%nbound = this%nbound + 1
         end if
       end do
     end do
     !
     ! -- Call the ad method on any ssm input files so that values for
     !    time-series are interpolated
     do ip = 1, this%fmi%nflowpack
       if (this%fmi%iatp(ip) /= 0) cycle
       if (this%isrctype(ip) == 3 .or. this%isrctype(ip) == 4) then
         ssmiptr => this%ssmivec(ip)
         call ssmiptr%spc_ad(this%fmi%gwfpackages(ip)%nbound, &
                             this%fmi%gwfpackages(ip)%budtxt)
       end if
     end do

◆ ssm_ar()

subroutine tspssmmodule::ssm_ar	(	class(tspssmtype)	this,
		class(disbasetype), intent(in), pointer	dis,
		integer(i4b), dimension(:), pointer, contiguous	ibound,
		real(dp), dimension(:), pointer, contiguous	cnew
	)

This routine is called from gwt_ar(). It allocates arrays, reads options and data, and sets up the output table.

Parameters

	this	TspSsmType object
[in]	dis	discretization package
	ibound	GWT model ibound
	cnew	GWT model dependent variable

Definition at line 134 of file tsp-ssm.f90.

     ! -- modules
     use memorymanagermodule, only: mem_setptr
     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType object
     class(DisBaseType), pointer, intent(in) :: dis !< discretization package
     integer(I4B), dimension(:), pointer, contiguous :: ibound !< GWT model ibound
     real(DP), dimension(:), pointer, contiguous :: cnew !< GWT model dependent variable
     ! -- formats
     character(len=*), parameter :: fmtssm = &
       "(1x,/1x,'SSM -- SOURCE-SINK MIXING PACKAGE, VERSION 1, 8/25/2017', &
       &' INPUT READ FROM UNIT ', i0, //)"
     !
     ! -- print a message identifying the storage package.
     write (this%iout, fmtssm) this%inunit
     !
     ! -- store pointers to arguments that were passed in
     this%dis => dis
     this%ibound => ibound
     this%cnew => cnew
     !
     ! -- Check to make sure that there are flow packages
     if (this%fmi%nflowpack == 0) then
       write (errmsg, '(a)') 'SSM package does not detect any boundary flows &
                             &that require SSM terms.  Activate GWF-GWT &
                             &exchange or activate FMI package and provide a &
                             &budget file that contains boundary flows.  If no &
                             &boundary flows are present in corresponding GWF &
                             &model then this SSM package should be removed.'
       call store_error(errmsg)
       call this%parser%StoreErrorUnit()
     end if
     !
     ! -- Allocate arrays
     call this%allocate_arrays()
     !
     ! -- Read ssm options
     call this%read_options()
     !
     ! -- read the data block
     call this%read_data()
     !
     ! -- setup the output table
     call this%pak_setup_outputtab()

Here is the call graph for this function:

◆ ssm_bd()

subroutine tspssmmodule::ssm_bd	(	class(tspssmtype)	this,
		integer(i4b), intent(in)	isuppress_output,
		type(budgettype), intent(inout)	model_budget
	)

Calculate the global SSM budget terms using separate in and out entries for each flow package.

Parameters

	this	TspSsmType object
[in]	isuppress_output	flag to suppress output
[in,out]	model_budget	budget object for the GWT model

Definition at line 466 of file tsp-ssm.f90.

     ! -- modules
     use tdismodule, only: delt
     use budgetmodule, only: budgettype
     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType object
     integer(I4B), intent(in) :: isuppress_output !< flag to suppress output
     type(BudgetType), intent(inout) :: model_budget !< budget object for the GWT model
     ! -- local
     character(len=LENBUDROWLABEL) :: rowlabel
     integer(I4B) :: ip
     integer(I4B) :: i
     integer(I4B) :: n
     real(DP) :: rate
     real(DP) :: rin
     real(DP) :: rout
     !
     ! -- do for each flow package, unless it is being handled by an advanced
     !    transport package
     do ip = 1, this%fmi%nflowpack
       !
       ! -- cycle if package is being managed as an advanced package
       if (this%fmi%iatp(ip) /= 0) cycle
       !
       ! -- Initialize the rate accumulators
       rin = dzero
       rout = dzero
       !
       ! -- do for each boundary
       do i = 1, this%fmi%gwfpackages(ip)%nbound
         n = this%fmi%gwfpackages(ip)%nodelist(i)
         if (n <= 0) cycle
         call this%ssm_term(ip, i, rrate=rate)
         if (rate < dzero) then
           rout = rout - rate
         else
           rin = rin + rate
         end if
         !
       end do
       !
       rowlabel = 'SSM_'//adjustl(trim(this%fmi%flowpacknamearray(ip)))
       call model_budget%addentry(rin, rout, delt, &
                                  this%fmi%gwfpackages(ip)%budtxt, &
                                  isuppress_output, rowlabel=rowlabel)
     end do

◆ ssm_cq()

subroutine tspssmmodule::ssm_cq	(	class(tspssmtype)	this,
		real(dp), dimension(:), intent(inout), contiguous	flowja
	)

Calculate the resulting mass flow between the boundary and the connected GWT/GWE model cell. Update the diagonal position of the flowja array so that it ultimately contains the solute balance residual.

Parameters

	this	TspSsmType object
[in,out]	flowja	flow across each face in the model grid

Definition at line 431 of file tsp-ssm.f90.

     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType object
     real(DP), dimension(:), contiguous, intent(inout) :: flowja !< flow across each face in the model grid
     ! -- local
     integer(I4B) :: ip
     integer(I4B) :: i
     integer(I4B) :: n
     integer(I4B) :: idiag
     real(DP) :: rate
     !
     ! -- do for each flow package
     do ip = 1, this%fmi%nflowpack
       !
       ! -- cycle if package is being managed as an advanced package
       if (this%fmi%iatp(ip) /= 0) cycle
       !
       ! -- do for each boundary
       do i = 1, this%fmi%gwfpackages(ip)%nbound
         n = this%fmi%gwfpackages(ip)%nodelist(i)
         if (n <= 0) cycle
         call this%ssm_term(ip, i, rrate=rate)
         idiag = this%dis%con%ia(n)
         flowja(idiag) = flowja(idiag) + rate
         !
       end do
       !
     end do

◆ ssm_cr()

subroutine, public tspssmmodule::ssm_cr	(	type(tspssmtype), pointer	ssmobj,
		character(len=*), intent(in)	name_model,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout,
		type(tspfmitype), intent(in), target	fmi,
		real(dp), intent(in), pointer	eqnsclfac,
		character(len=lenvarname), intent(in)	depvartype
	)

Create a new SSM package by defining names, allocating scalars and initializing the parser.

Parameters

	ssmobj	TspSsmType object
[in]	name_model	name of the model
[in]	inunit	fortran unit for input
[in]	iout	fortran unit for output
[in]	fmi	Transport FMI package
[in]	eqnsclfac	governing equation scale factor
[in]	depvartype	dependent variable type ('concentration' or 'temperature')

Definition at line 82 of file tsp-ssm.f90.

     ! -- dummy
     type(TspSsmType), pointer :: ssmobj !< TspSsmType object
     character(len=*), intent(in) :: name_model !< name of the model
     integer(I4B), intent(in) :: inunit !< fortran unit for input
     integer(I4B), intent(in) :: iout !< fortran unit for output
     type(TspFmiType), intent(in), target :: fmi !< Transport FMI package
     real(DP), intent(in), pointer :: eqnsclfac !< governing equation scale factor
     character(len=LENVARNAME), intent(in) :: depvartype !< dependent variable type ('concentration' or 'temperature')
     !
     ! -- Create the object
     allocate (ssmobj)
     !
     ! -- create name and memory path
     call ssmobj%set_names(1, name_model, 'SSM', 'SSM')
     !
     ! -- Allocate scalars
     call ssmobj%allocate_scalars()
     !
     ! -- Set variables
     ssmobj%inunit = inunit
     ssmobj%iout = iout
     ssmobj%fmi => fmi
     ssmobj%eqnsclfac => eqnsclfac
     !
     ! -- Initialize block parser
     call ssmobj%parser%Initialize(ssmobj%inunit, ssmobj%iout)
     !
     ! -- Store pointer to labels associated with the current model so that the
     !    package has access to the corresponding dependent variable type
     ssmobj%depvartype = depvartype

Here is the caller graph for this function:

◆ ssm_da()

subroutine tspssmmodule::ssm_da ( class(tspssmtype) this )

Deallocate the memory associated with this derived type

Parameters

this	TspSsmType object

Definition at line 646 of file tsp-ssm.f90.

     ! -- modules
     use memorymanagermodule, only: mem_deallocate
     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType object
     ! -- local
     integer(I4B) :: ip
     type(TspSpcType), pointer :: ssmiptr
     !
     ! -- Deallocate the ssmi objects if package was active
     if (this%inunit > 0) then
       do ip = 1, size(this%ssmivec)
         if (this%isrctype(ip) == 3 .or. this%isrctype(ip) == 4) then
           ssmiptr => this%ssmivec(ip)
           call ssmiptr%spc_da()
         end if
       end do
       deallocate (this%ssmivec)
     end if
     !
     ! -- Deallocate arrays if package was active
     if (this%inunit > 0) then
       call mem_deallocate(this%iauxpak)
       call mem_deallocate(this%isrctype)
       this%ibound => null()
       this%fmi => null()
     end if
     !
     ! -- output table object
     if (associated(this%outputtab)) then
       call this%outputtab%table_da()
       deallocate (this%outputtab)
       nullify (this%outputtab)
     end if
     !
     ! -- Scalars
     call mem_deallocate(this%nbound)
     !
     ! -- deallocate parent
     call this%NumericalPackageType%da()

◆ ssm_df()

subroutine tspssmmodule::ssm_df ( class(tspssmtype) this )

This routine is called from gwt_df(), but does not do anything because df is typically used to set up dimensions. For the ssm package, the total number of ssm entries is defined by the flow model.

Parameters

this	TspSsmType object

Definition at line 122 of file tsp-ssm.f90.

     ! -- modules
     use memorymanagermodule, only: mem_setptr
     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType object

◆ ssm_fc()

subroutine tspssmmodule::ssm_fc	(	class(tspssmtype)	this,
		class(matrixbasetype), pointer	matrix_sln,
		integer(i4b), dimension(:), intent(in)	idxglo,
		real(dp), dimension(:), intent(inout)	rhs
	)

This routine adds the effects of the SSM to the matrix equations by updating the a matrix and right-hand side vector.

Definition at line 389 of file tsp-ssm.f90.

     ! -- dummy
     class(TspSsmType) :: this
     class(MatrixBaseType), pointer :: matrix_sln
     integer(I4B), intent(in), dimension(:) :: idxglo
     real(DP), intent(inout), dimension(:) :: rhs
     ! -- local
     integer(I4B) :: ip
     integer(I4B) :: i
     integer(I4B) :: n
     integer(I4B) :: idiag
     integer(I4B) :: nflowpack
     integer(I4B) :: nbound
     real(DP) :: hcofval
     real(DP) :: rhsval
     !
     ! -- do for each flow package
     nflowpack = this%fmi%nflowpack
     do ip = 1, nflowpack
       if (this%fmi%iatp(ip) /= 0) cycle
       !
       ! -- do for each entry in package (ip)
       nbound = this%fmi%gwfpackages(ip)%nbound
       do i = 1, nbound
         n = this%fmi%gwfpackages(ip)%nodelist(i)
         if (n <= 0) cycle
         call this%ssm_term(ip, i, rhsval=rhsval, hcofval=hcofval)
         idiag = idxglo(this%dis%con%ia(n))
         call matrix_sln%add_value_pos(idiag, hcofval)
         rhs(n) = rhs(n) + rhsval
         !
       end do
       !
     end do

◆ ssm_ot_flow()

subroutine tspssmmodule::ssm_ot_flow	(	class(tspssmtype)	this,
		integer(i4b), intent(in)	icbcfl,
		integer(i4b), intent(in)	ibudfl,
		integer(i4b), intent(in)	icbcun
	)

Based on user-specified controls, print SSM mass flow rates to the GWT listing file and/or write the SSM mass flow rates to the GWT binary budget file.

Parameters

	this	TspSsmType object
[in]	icbcfl	flag for writing binary budget terms
[in]	ibudfl	flag for printing budget terms to list file
[in]	icbcun	fortran unit number for binary budget file

Definition at line 520 of file tsp-ssm.f90.

     ! -- modules
     use tdismodule, only: kstp, kper
     use constantsmodule, only: lenpackagename, lenboundname, lenauxname, dzero
     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType object
     integer(I4B), intent(in) :: icbcfl !< flag for writing binary budget terms
     integer(I4B), intent(in) :: ibudfl !< flag for printing budget terms to list file
     integer(I4B), intent(in) :: icbcun !< fortran unit number for binary budget file
     ! -- local
     character(len=LINELENGTH) :: title
     integer(I4B) :: node, nodeu
     character(len=20) :: nodestr
     integer(I4B) :: maxrows
     integer(I4B) :: ip
     integer(I4B) :: i, n2, ibinun
     real(DP) :: rrate
     real(DP) :: qssm
     real(DP) :: cssm
     integer(I4B) :: naux
     real(DP), dimension(0) :: auxrow
     character(len=LENAUXNAME), dimension(0) :: auxname
     ! -- for observations
     character(len=LENBOUNDNAME) :: bname
     ! -- formats
     character(len=*), parameter :: fmttkk = &
       &"(1X,/1X,A,'   PERIOD ',I0,'   STEP ',I0)"
     !
     ! -- initialize
     naux = 0
     maxrows = 0
     if (ibudfl /= 0 .and. this%iprflow /= 0) then
       call this%outputtab%set_kstpkper(kstp, kper)
       do ip = 1, this%fmi%nflowpack
         if (this%fmi%iatp(ip) /= 0) cycle
         !
         ! -- do for each boundary
         do i = 1, this%fmi%gwfpackages(ip)%nbound
           node = this%fmi%gwfpackages(ip)%nodelist(i)
           if (node > 0) then
             maxrows = maxrows + 1
           end if
         end do
       end do
       if (maxrows > 0) then
         call this%outputtab%set_maxbound(maxrows)
       end if
       title = 'SSM PACKAGE ('//trim(this%packName)// &
               ') FLOW RATES'
       call this%outputtab%set_title(title)
     end if
     !
     ! -- Set unit number for binary output
     if (this%ipakcb < 0) then
       ibinun = icbcun
     else if (this%ipakcb == 0) then
       ibinun = 0
     else
       ibinun = this%ipakcb
     end if
     if (icbcfl == 0) ibinun = 0
     !
     ! -- If cell-by-cell flows will be saved as a list, write header.
     if (ibinun /= 0) then
       call this%dis%record_srcdst_list_header(text, this%name_model, &
                                               this%name_model, this%name_model, &
                                               this%packName, naux, auxname, &
                                               ibinun, this%nbound, this%iout)
     end if
     !
     ! -- If no boundaries, skip flow calculations.
     if (this%nbound > 0) then
       !
       ! -- Loop through each boundary calculating flow.
       do ip = 1, this%fmi%nflowpack
         if (this%fmi%iatp(ip) /= 0) cycle
         !
         ! -- do for each boundary
         do i = 1, this%fmi%gwfpackages(ip)%nbound
           !
           ! -- Calculate rate for this entry
           node = this%fmi%gwfpackages(ip)%nodelist(i)
           if (node <= 0) cycle
           call this%ssm_term(ip, i, rrate=rrate, qssm=qssm, cssm=cssm)
           !
           ! -- Print the individual rates if the budget is being printed
           !    and PRINT_FLOWS was specified (this%iprflow<0)
           if (ibudfl /= 0) then
             if (this%iprflow /= 0) then
               !
               ! -- set nodestr and write outputtab table
               nodeu = this%dis%get_nodeuser(node)
               call this%dis%nodeu_to_string(nodeu, nodestr)
               bname = this%fmi%gwfpackages(ip)%name
               call this%outputtab%add_term(i)
               call this%outputtab%add_term(trim(adjustl(nodestr)))
               call this%outputtab%add_term(qssm)
               call this%outputtab%add_term(cssm)
               call this%outputtab%add_term(rrate)
               call this%outputtab%add_term(bname)
             end if
           end if
           !
           ! -- If saving cell-by-cell flows in list, write flow
           if (ibinun /= 0) then
             n2 = i
             call this%dis%record_mf6_list_entry(ibinun, node, n2, rrate, &
                                                 naux, auxrow, &
                                                 olconv2=.false.)
           end if
           !
         end do
         !
       end do
     end if
     if (ibudfl /= 0) then
       if (this%iprflow /= 0) then
         write (this%iout, '(1x)')
       end if
     end if

◆ ssm_rp()

subroutine tspssmmodule::ssm_rp ( class(tspssmtype) this )

This routine is called from gwt_rp(). It is called at the beginning of each stress period. If any SPC input files are used to provide source and sink concentrations (or temperatures), then period blocks for the current stress period are read.

Parameters

this	TspSsmType object

Definition at line 187 of file tsp-ssm.f90.

     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType object
     ! -- local
     integer(I4B) :: ip
     type(TspSpcType), pointer :: ssmiptr
     ! -- formats
     !
     ! -- Call the rp method on any ssm input files
     do ip = 1, this%fmi%nflowpack
       if (this%fmi%iatp(ip) /= 0) cycle
       if (this%isrctype(ip) == 3 .or. this%isrctype(ip) == 4) then
         ssmiptr => this%ssmivec(ip)
         call ssmiptr%spc_rp()
       end if
     end do

◆ ssm_term()

subroutine tspssmmodule::ssm_term	(	class(tspssmtype)	this,
		integer(i4b), intent(in)	ipackage,
		integer(i4b), intent(in)	ientry,
		real(dp), intent(out), optional	rrate,
		real(dp), intent(out), optional	rhsval,
		real(dp), intent(out), optional	hcofval,
		real(dp), intent(out), optional	cssm,
		real(dp), intent(out), optional	qssm
	)

This is the primary SSM routine that calculates the matrix coefficient and right-hand-side value for any package and package entry. It returns several different optional variables that are used throughout this package to update matrix terms, budget calculations, and output tables.

Parameters

	this	TspSsmType
[in]	ipackage	package number
[in]	ientry	bound number
[out]	rrate	calculated mass flow rate
[out]	rhsval	calculated rhs value
[out]	hcofval	calculated hcof value
[out]	cssm	calculated source concentration/temperature depending on flow direction
[out]	qssm	water flow rate into model cell from boundary package

Definition at line 256 of file tsp-ssm.f90.

     ! -- dummy
     class(TspSsmType) :: this !< TspSsmType
     integer(I4B), intent(in) :: ipackage !< package number
     integer(I4B), intent(in) :: ientry !< bound number
     real(DP), intent(out), optional :: rrate !< calculated mass flow rate
     real(DP), intent(out), optional :: rhsval !< calculated rhs value
     real(DP), intent(out), optional :: hcofval !< calculated hcof value
     real(DP), intent(out), optional :: cssm !< calculated source concentration/temperature depending on flow direction
     real(DP), intent(out), optional :: qssm !< water flow rate into model cell from boundary package
     ! -- local
     logical(LGP) :: lauxmixed
     integer(I4B) :: n
     integer(I4B) :: nbound_flow
     real(DP) :: qbnd
     real(DP) :: ctmp
     real(DP) :: omega
     real(DP) :: hcoftmp
     real(DP) :: rhstmp
     !
     ! -- retrieve node number, qbnd and iauxpos
     hcoftmp = dzero
     rhstmp = dzero
     ctmp = dzero
     qbnd = dzero
     nbound_flow = this%fmi%gwfpackages(ipackage)%nbound
     n = this%fmi%gwfpackages(ipackage)%nodelist(ientry)
     !
     ! -- If cell is active (ibound > 0) then calculate values
     if (this%ibound(n) > 0) then
       !
       ! -- retrieve qbnd and iauxpos
       qbnd = this%fmi%gwfpackages(ipackage)%get_flow(ientry)
       call this%get_ssm_conc(ipackage, ientry, nbound_flow, ctmp, lauxmixed)
       !
       ! -- assign values for hcoftmp, rhstmp, and ctmp for subsequent assignment
       !    of hcof, rhs, and rate
       if (.not. lauxmixed) then
         !
         ! -- If qbnd is positive, then concentration (or temperature) represents
         !    the inflow concentration (or temperature).  If qbnd is negative,
         !    then the outflow concentration (or temperature) is set equal to the
         !    simulated cell's concentration (or temperature).
         if (qbnd >= dzero) then
           omega = dzero ! rhs
         else
           ctmp = this%cnew(n)
           omega = done ! lhs
           if (ctmp < dzero) then
             omega = dzero ! concentration/temperature is negative, so set mass flux to zero
           end if
         end if
       else
         !
         ! -- lauxmixed value indicates that this is a mixed sink type where
         !    the concentration (or temperature) value represents the injected
         !    concentration (or temperature) if qbnd is positive. If qbnd is
         !    negative, then the withdrawn water is equal to the minimum of the
         !    aux concentration (or temperature) and the cell concentration
         !    (or temperature).
         if (qbnd >= dzero) then
           omega = dzero ! rhs (ctmp is aux value)
         else
           if (ctmp < this%cnew(n)) then
             omega = dzero ! rhs (ctmp is aux value)
           else
             omega = done ! lhs (ctmp is cell concentration)
             ctmp = this%cnew(n)
           end if
         end if
       end if
       !
       ! -- Add terms based on qbnd sign
       if (qbnd <= dzero) then
         hcoftmp = qbnd * omega * this%eqnsclfac
       else
         rhstmp = -qbnd * ctmp * (done - omega) * this%eqnsclfac
       end if
       !
       ! -- end of active ibound
     end if
     !
     ! -- set requested values
     if (present(hcofval)) hcofval = hcoftmp
     if (present(rhsval)) rhsval = rhstmp
     if (present(rrate)) rrate = hcoftmp * ctmp - rhstmp
     if (present(cssm)) cssm = ctmp
     if (present(qssm)) qssm = qbnd

Variable Documentation

◆ ftype

character(len=lenftype) tspssmmodule::ftype = 'SSM'

Definition at line 28 of file tsp-ssm.f90.

28 character(len=LENFTYPE) :: ftype = 'SSM'

◆ text

character(len=lenpackagename) tspssmmodule::text = ' SOURCE-SINK MIX'

Definition at line 29 of file tsp-ssm.f90.

29 character(len=LENPACKAGENAME) :: text = ' SOURCE-SINK MIX'

Data Types

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ allocate_arrays()

◆ allocate_scalars()

◆ get_ssm_conc()

◆ pak_setup_outputtab()

◆ read_data()

◆ read_options()

◆ read_sources_aux()

◆ read_sources_fileinput()

◆ set_iauxpak()

◆ set_ssmivec()

◆ ssm_ad()

◆ ssm_ar()

◆ ssm_bd()

◆ ssm_cq()

◆ ssm_cr()

◆ ssm_da()

◆ ssm_df()

◆ ssm_fc()

◆ ssm_ot_flow()

◆ ssm_rp()

◆ ssm_term()

Variable Documentation

◆ ftype

◆ text