This module contains the TspSpc Module. More...

Data Types
type	tspspctype
	Derived type for managing SPC input. More...

Functions/Subroutines
subroutine	initialize (this, dis, id, input_mempath, iout, name_model, packNameFlow, dvn, input_fname)
	Initialize the SPC type. More...

subroutine	allocate_scalars (this)
	Allocate package scalars. More...

subroutine	allocate_arrays (this)
	Allocate package arrays. More...

real(dp) function	get_value (this, ientry, nbound_flow)
	Get the data value from this package. More...

subroutine	apply_input_values (this)
	Apply current input mempath values to dblvec. More...

subroutine	spc_rp (this, nbound_flowpack, budtxt)
	Read and prepare stress period data. More...

subroutine	spc_ad (this, nbound_flowpack, budtxt)
	Advance. More...

subroutine	spc_da (this)
	Deallocate variables. More...

subroutine	check_flow_package (this, nbound_flowpack, budtxt)
	Check flow package consistency. More...

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

Detailed Description

This module contains the code for reading and storing a generic input file of source and sink concentrations or temperatures.

Function/Subroutine Documentation

◆ allocate_arrays()

subroutine tspspcmodule::allocate_arrays ( class(tspspctype) this )

Parameters

this	TspSpcType object

Definition at line 163 of file TspSpc.f90.

     ! -- modules
     use memorymanagermodule, only: mem_allocate
     ! -- dummy variables
     class(TspSpcType) :: this !< TspSpcType object
     ! -- local
     integer(I4B) :: i
     !
     call mem_allocate(this%dblvec, this%maxbound, 'DBLVEC', this%memoryPath)
     !
     do i = 1, this%maxbound
       this%dblvec(i) = dzero
     end do

◆ allocate_scalars()

subroutine tspspcmodule::allocate_scalars ( class(tspspctype) this )

private

Parameters

this	TspSpcType object

Definition at line 142 of file TspSpc.f90.

     ! -- modules
     use memorymanagermodule, only: mem_allocate
     ! -- dummy variables
     class(TspSpcType) :: this !< TspSpcType object
     !
     call mem_allocate(this%id, 'ID', this%memoryPath)
     call mem_allocate(this%iout, 'IOUT', this%memoryPath)
     call mem_allocate(this%maxbound, 'MAXBOUND', this%memoryPath)
     call mem_allocate(this%iprpak, 'IPRPAK', this%memoryPath)
     call mem_allocate(this%readasarrays, 'READASARRAYS', this%memoryPath)
     !
     this%id = 0
     this%iout = 0
     this%maxbound = 0
     this%iprpak = 0
     this%readasarrays = .false.

◆ apply_input_values()

subroutine tspspcmodule::apply_input_values ( class(tspspctype), intent(inout) this )

private

For list-based SPC, iterates BNDNO/value rows. For array-based SPCA, copies the depvarname array directly.

Parameters

[in,out] this TspSpcType object

Definition at line 220 of file TspSpc.f90.

     ! -- dummy
     class(TspSpcType), intent(inout) :: this !< TspSpcType object
     ! -- local
     integer(I4B), pointer :: nbound
     integer(I4B), dimension(:), pointer, contiguous :: bndno_arr
     real(DP), dimension(:), pointer, contiguous :: val_arr
     integer(I4B) :: n
     ! -- formats
     character(len=*), parameter :: fmthdr = &
       &"(1X,/1X,'INPUT VALUES FOR ',A,' PACKAGE (PACKAGE ',A,')')"
     character(len=*), parameter :: fmtdvhdr = &
       &"(5X,'NO.',5X,A)"
     character(len=*), parameter :: fmtdvval = &
       &"(5X,I6,2X,G12.5)"
     !
     if (this%readasarrays) then
       ! -- array mode: copy depvarname array into dblvec
       call mem_setptr(val_arr, trim(this%depvarname), this%input_mempath)
       do n = 1, this%maxbound
         this%dblvec(n) = val_arr(n)
       end do
       if (this%iprpak /= 0) then
         write (this%iout, fmthdr) trim(this%depvarname), &
           trim(this%packNameFlow)
         write (this%iout, fmtdvhdr) trim(this%depvarname)
         do n = 1, this%maxbound
           write (this%iout, fmtdvval) n, this%dblvec(n)
         end do
       end if
     else
       ! -- list mode: apply BNDNO-indexed values; DNODATA entries are skipped
       call mem_setptr(nbound, 'NBOUND', this%input_mempath)
       call mem_setptr(bndno_arr, 'BNDNO', this%input_mempath)
       call mem_setptr(val_arr, trim(this%depvarname), this%input_mempath)
       do n = 1, nbound
         if (val_arr(n) /= dnodata) then
           this%dblvec(bndno_arr(n)) = val_arr(n)
         end if
       end do
       if (this%iprpak /= 0) then
         write (this%iout, fmthdr) trim(this%depvarname), &
           trim(this%packNameFlow)
         write (this%iout, fmtdvhdr) trim(this%depvarname)
         do n = 1, this%maxbound
           write (this%iout, fmtdvval) n, this%dblvec(n)
         end do
       end if
     end if

◆ check_flow_package()

subroutine tspspcmodule::check_flow_package	(	class(tspspctype), intent(inout)	this,
		integer(i4b), intent(in)	nbound_flowpack,
		character(len=*), intent(in)	budtxt
	)

Check that MAXBOUND is not less than nbound_flowpack and that readasarrays is consistent with the flow package type.

Parameters

[in,out] this TspSpcType object

Definition at line 342 of file TspSpc.f90.

     ! -- dummy
     class(TspSpcType), intent(inout) :: this !< TspSpcType object
     integer(I4B), intent(in) :: nbound_flowpack
     character(len=*), intent(in) :: budtxt
     !
     ! -- Check and make sure MAXBOUND is not less than nbound_flowpack
     if (this%maxbound < nbound_flowpack) then
       write (errmsg, '(a,a,a,i0,a,i0,a)') &
         'The SPC Package corresponding to flow package ', &
         trim(this%packNameFlow), &
         ' has MAXBOUND set less than the number of boundaries &
         &active in this package.  Found MAXBOUND equal ', &
         this%maxbound, &
         ' and number of flow boundaries (NBOUND) equal ', &
         nbound_flowpack, &
         '. Increase MAXBOUND in the SPC input file for this package.'
       call store_error(errmsg)
       call store_error_filename(this%input_fname)
     end if
     !
     ! -- If budtxt is RCHA or EVTA, then readasarrays must be used, otherwise
     !    readasarrays cannot be used
     select case (trim(adjustl(budtxt)))
     case ('RCHA')
       if (.not. this%readasarrays) then
         write (errmsg, '(a,a,a)') &
           'Array-based recharge must be used with array-based stress package &
           &concentrations.  GWF Package ', trim(this%packNameFlow), ' is being &
           &used with list-based SPC6 input.  Use array-based SPC6 input instead.'
         call store_error(errmsg)
         call store_error_filename(this%input_fname)
       end if
     case ('EVTA')
       if (.not. this%readasarrays) then
         write (errmsg, '(a,a,a)') &
           'Array-based evapotranspiration must be used with array-based stress &
           &package concentrations.  GWF Package ', trim(this%packNameFlow), &
           &' is being used with list-based SPC6 input.  Use array-based SPC6 &
           &input instead.'
         call store_error(errmsg)
         call store_error_filename(this%input_fname)
       end if
     case default
       if (this%readasarrays) then
         write (errmsg, '(a,a,a)') &
           'List-based packages must be used with list-based stress &
           &package concentrations.  GWF Package ', trim(this%packNameFlow), &
           &' is being used with array-based SPC6 input.  Use list-based SPC6 &
           &input instead.'
         call store_error(errmsg)
         call store_error_filename(this%input_fname)
       end if
     end select

Here is the call graph for this function:

◆ get_value()

real(dp) function tspspcmodule::get_value	(	class(tspspctype)	this,
		integer(i4b), intent(in)	ientry,
		integer(i4b), intent(in)	nbound_flow
	)

Get the floating point value from the dblvec array.

Parameters

	this	TspSpcType object
[in]	ientry	index of the data to return
[in]	nbound_flow	size of bound list in flow package

Definition at line 183 of file TspSpc.f90.

     class(TspSpcType) :: this !< TspSpcType object
     integer(I4B), intent(in) :: ientry !< index of the data to return
     integer(I4B), intent(in) :: nbound_flow !< size of bound list in flow package
     real(DP) :: value
     integer(I4B) :: nu
     if (this%readasarrays) then
       ! -- Special handling for reduced grids and readasarrays.
       ! -- If flow and transport are in the same simulation, ientry is a user
       ! -- node number and corresponds to the correct position in dblvec.
       ! -- If flow and transport are not in the same simulation, ientry is a
       ! -- reduced node number, because the list of flows in the budget file
       ! -- does not include idomain < 1 entries. In that case, ientry must be
       ! -- converted to a user node number so that it corresponds to a user
       ! -- array, which includes idomain < 1 values.
       if (nbound_flow == this%maxbound) then
         ! -- flow and transport are in the same simulation or there
         ! -- are no idomain < 1 cells.
         value = this%dblvec(ientry)
       else
         ! -- flow and transport are in separate simulations; nbound_flow
         ! -- would equal ncpl if in the same simulation, but boundary cells
         ! -- with idomain < 1 are excluded from the binary budget file.
         nu = this%dis%get_nodeuser(ientry)
         value = this%dblvec(nu)
       end if
     else
       value = this%dblvec(ientry)
     end if

◆ initialize()

subroutine tspspcmodule::initialize	(	class(tspspctype)	this,
		class(disbasetype), intent(in), pointer	dis,
		integer(i4b), intent(in)	id,
		character(len=*), intent(in)	input_mempath,
		integer(i4b), intent(in)	iout,
		character(len=*), intent(in)	name_model,
		character(len=*), intent(in)	packNameFlow,
		character(len=*), intent(in)	dvn,
		character(len=*), intent(in)	input_fname
	)

private

Initialize the SPC object using input context data.

Parameters

	this	TspSpcType
[in]	dis	discretization package
[in]	id	id number for this spc package
[in]	input_mempath	input memory path
[in]	iout	unit number for output
[in]	name_model	model name
[in]	packnameflow	name of corresponding flow package
[in]	dvn	dependent variable name (CONCENTRATION or TEMPERATURE)
[in]	input_fname	SPC input file name

Definition at line 73 of file TspSpc.f90.

     ! -- dummy variables
     class(TspSpcType) :: this !< TspSpcType
     class(DisBaseType), pointer, intent(in) :: dis !< discretization package
     integer(I4B), intent(in) :: id !< id number for this spc package
     character(len=*), intent(in) :: input_mempath !< input memory path
     integer(I4B), intent(in) :: iout !< unit number for output
     character(len=*), intent(in) :: name_model !< model name
     character(len=*), intent(in) :: packNameFlow !< name of corresponding flow package
     character(len=*), intent(in) :: dvn !< dependent variable name (CONCENTRATION or TEMPERATURE)
     character(len=*), intent(in) :: input_fname !< SPC input file name
     ! -- local
     integer(I4B), pointer :: maxbound_ptr
     integer(I4B) :: isize
     logical(LGP) :: found_print_input
     !
     write (this%packName, '(a,i0)') 'SPC-', id
     !
     call this%allocate_scalars()
     !
     this%name_model = name_model
     this%memoryPath = create_mem_path(this%name_model, this%packName)
     this%input_mempath = input_mempath
     this%input_fname = input_fname
     this%id = id
     this%iout = iout
     this%packNameFlow = packnameflow
     this%depvarname = dvn
     this%dis => dis
     !
     ! -- READASARRAYS determine array or list based input
     call get_isize('READASARRAYS', input_mempath, isize)
     this%readasarrays = (isize > 0)
     !
     ! -- set maxbound
     if (this%readasarrays) then
       this%maxbound = dis%get_ncpl()
     else
       call mem_setptr(maxbound_ptr, 'MAXBOUND', input_mempath)
       this%maxbound = maxbound_ptr
     end if
     !
     call this%allocate_arrays()
     !
     ! -- read PRINT_INPUT flag from input context
     call mem_set_value(this%iprpak, 'PRINT_INPUT', this%input_mempath, &
                        found_print_input)
     if (found_print_input) then
       write (this%iout, '(4x,a)') 'TIME-VARYING INPUT WILL BE PRINTED.'
     end if
     !
     ! -- check for idm managed active timeseries
     call get_isize('TS6_FILENAME', input_mempath, isize)
     if (isize > 0) this%ts_active = .true.
     call get_isize('TAS6_FILENAME', input_mempath, isize)
     if (isize > 0) this%ts_active = .true.
     !
     write (this%iout, '(4x,a,a,a,a,a)') 'USING SPC INPUT FILE ', &
       trim(input_fname), ' TO SET ', trim(dvn), &
       'S FOR PACKAGE '//trim(packnameflow)
     !
     if (count_errors() > 0) then
       call store_error_filename(this%input_fname)
     end if

Here is the call graph for this function:

◆ spc_ad()

subroutine tspspcmodule::spc_ad	(	class(tspspctype), intent(inout)	this,
		integer(i4b), intent(in)	nbound_flowpack,
		character(len=*), intent(in)	budtxt
	)

private

Apply advanced input values at each time step.

Parameters

[in,out] this TspSpcType object

Definition at line 306 of file TspSpc.f90.

     ! -- dummy
     class(TspSpcType), intent(inout) :: this !< TspSpcType object
     integer(I4B), intent(in) :: nbound_flowpack
     character(len=*), intent(in) :: budtxt
     !
     ! -- no-op if timeseries inactive
     if (.not. this%ts_active) return
     !
     call this%apply_input_values()
     call this%check_flow_package(nbound_flowpack, budtxt)

◆ spc_da()

subroutine tspspcmodule::spc_da ( class(tspspctype) this )

private

Parameters

this	TspSpcType object

Definition at line 321 of file TspSpc.f90.

     ! -- modules
     use memorymanagermodule, only: mem_deallocate
     ! -- dummy variables
     class(TspSpcType) :: this !< TspSpcType object
     !
     nullify (this%dis)
     call mem_deallocate(this%dblvec)
     call mem_deallocate(this%id)
     call mem_deallocate(this%iout)
     call mem_deallocate(this%maxbound)
     call mem_deallocate(this%iprpak)
     call mem_deallocate(this%readasarrays)

◆ spc_rp()

subroutine tspspcmodule::spc_rp	(	class(tspspctype), intent(inout)	this,
		integer(i4b), intent(in)	nbound_flowpack,
		character(len=*), intent(in)	budtxt
	)

private

Copies input period data into dblvec when new data has been loaded for this stress period.

Parameters

[in,out] this TspSpcType object

Definition at line 277 of file TspSpc.f90.

     ! -- dummy
     class(TspSpcType), intent(inout) :: this !< TspSpcType object
     integer(I4B), intent(in) :: nbound_flowpack
     character(len=*), intent(in) :: budtxt
     ! -- local
     integer(I4B), pointer :: iper
     ! -- formats
     character(len=*), parameter :: fmtlsp = &
       &"(1X,/1X,'REUSING ',A,'S FROM LAST STRESS PERIOD')"
     !
     call mem_setptr(iper, 'IPER', this%input_mempath)
     if (iper /= kper) then
       write (this%iout, fmtlsp) trim(ftype)
       return
     end if
     !
     ! -- spc_ad applies each time step
     if (this%ts_active) return
     !
     call this%apply_input_values()
     call this%check_flow_package(nbound_flowpack, budtxt)

Variable Documentation

◆ ftype

character(len=lenftype) tspspcmodule::ftype = 'SPC'

private

Definition at line 26 of file TspSpc.f90.

26 character(len=LENFTYPE) :: ftype = 'SPC'

Data Types

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ allocate_arrays()

◆ allocate_scalars()

◆ apply_input_values()

◆ check_flow_package()

◆ get_value()

◆ initialize()

◆ spc_ad()

◆ spc_da()

◆ spc_rp()

Variable Documentation

◆ ftype