tvsmodule Module Reference

This module contains the time-varying storage package methods. More...

Data Types
type	tvstype

Functions/Subroutines
subroutine, public	tvs_cr (tvs, name_model, mempath, inunit, iout)
	Create a new TvsType object. More...
subroutine	tvs_ar_set_pointers (this)
	Announce package and set pointers to variables. More...
subroutine	tvs_source_package_options (this)
	Source TVS-specific options from the input memory path. More...
subroutine	tvs_apply_row_changes (this, nodeu, node)
	Apply this node's SS/SY input values to node. More...
subroutine	tvs_set_changed_at (this, kper, kstp)
	Mark property changes as having occurred at (kper, kstp) More...
subroutine	tvs_reset_change_flags (this)
	Clear all per-node change flags. More...
subroutine	tvs_validate_change (this, n, varName)
	Check that a given property value is valid. More...
subroutine	tvs_da (this)
	Deallocate package memory. More...

Detailed Description

This module contains the methods used to allow storage parameters in the STO package (specific storage and specific yield) to be varied throughout a simulation.

Function/Subroutine Documentation

tvs_apply_row_changes()

subroutine tvsmodule::tvs_apply_row_changes ( class(tvstype)  this, integer(i4b), intent(in)  nodeu, integer(i4b), intent(in)  node  )

private

Called for every tracked node; the DNODATA check on each field makes this a no-op except where a value is set. node may be invalid even when a field has a value at nodeu, so each field validates node itself before using it.

Definition at line 121 of file gwf-tvs.f90.

    ! -- dummy
    class(TvsType) :: this
    integer(I4B), intent(in) :: nodeu
    integer(I4B), intent(in) :: node
    ! -- local
    character(len=LINELENGTH) :: cellstr
    ! -- formats
    character(len=*), parameter :: fmtvalchg = &
      "(a, ' package: Setting ', a, ' value for cell ', a, ' at start of &
      &stress period ', i0, ' = ', g12.5)"
    !
    if (this%ss_src(nodeu) /= dnodata) then
      if (node < 1 .or. node > this%dis%nodes) then
        call this%dis%noder_to_string(node, cellstr)
        write (errmsg, '(a,2(1x,a))') &
          'CELLID', trim(cellstr), 'is not in the active model domain.'
        call store_error(errmsg)
      else
        this%ss(node) = this%ss_src(nodeu)
        call this%validate_change(node, 'SS')
        if (this%iprpak /= 0) then
          call this%dis%noder_to_string(node, cellstr)
          write (this%iout, fmtvalchg) &
            trim(adjustl(this%packName)), 'SS', trim(cellstr), kper, &
            this%ss(node)
        end if
      end if
    end if
    !
    if (this%sy_src(nodeu) /= dnodata) then
      if (node < 1 .or. node > this%dis%nodes) then
        call this%dis%noder_to_string(node, cellstr)
        write (errmsg, '(a,2(1x,a))') &
          'CELLID', trim(cellstr), 'is not in the active model domain.'
        call store_error(errmsg)
      else
        this%sy(node) = this%sy_src(nodeu)
        call this%validate_change(node, 'SY')
        if (this%iprpak /= 0) then
          call this%dis%noder_to_string(node, cellstr)
          write (this%iout, fmtvalchg) &
            trim(adjustl(this%packName)), 'SY', trim(cellstr), kper, &
            this%sy(node)
        end if
      end if
    end if

Here is the call graph for this function:

tvs_ar_set_pointers()

subroutine tvsmodule::tvs_ar_set_pointers ( class(tvstype)  this )

private

Announce package version, set array and variable pointers from the STO package for access by TVS, and enable storage change integration.

Definition at line 68 of file gwf-tvs.f90.

    ! -- dummy
    class(TvsType) :: this
    ! -- local
    character(len=LENMEMPATH) :: stoMemoryPath
    ! -- formats
    character(len=*), parameter :: fmttvs = &
      "(1x,/1x,'TVS -- TIME-VARYING S PACKAGE, VERSION 1, 08/18/2021', &
      &' INPUT READ FROM MEMPATH ', A, //)"
    !
    write (this%iout, fmttvs) this%input_mempath
    !
    stomemorypath = create_mem_path(this%name_model, 'STO')
    call mem_setptr(this%integratechanges, 'INTEGRATECHANGES', stomemorypath)
    call mem_setptr(this%iusesy, 'IUSESY', stomemorypath)
    call mem_setptr(this%ss, 'SS', stomemorypath)
    call mem_setptr(this%sy, 'SY', stomemorypath)
    !
    ! -- Instruct STO to integrate storage changes, since TVS is active
    this%integratechanges = 1
    !
    ! -- set input mempath pointers
    call mem_setptr(this%ss_src, 'SS', this%input_mempath)
    call mem_setptr(this%sy_src, 'SY', this%input_mempath)

Here is the call graph for this function:

tvs_cr()

subroutine, public tvsmodule::tvs_cr	(	type(tvstype), intent(out), pointer	tvs,
		character(len=*), intent(in)	name_model,
		character(len=*), intent(in)	mempath,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout
	)

Create a new time-varying storage (TVS) object.

Definition at line 51 of file gwf-tvs.f90.

    ! -- dummy
    type(TvsType), pointer, intent(out) :: tvs
    character(len=*), intent(in) :: name_model
    character(len=*), intent(in) :: mempath
    integer(I4B), intent(in) :: inunit
    integer(I4B), intent(in) :: iout
    !
    allocate (tvs)
    call tvs%init(name_model, 'TVS', 'TVS', mempath, inunit, iout)

Here is the caller graph for this function:

tvs_da()

subroutine tvsmodule::tvs_da ( class(tvstype)  this )

private

Deallocate TVS package scalars and arrays.

Definition at line 246 of file gwf-tvs.f90.

    ! -- dummy
    class(TvsType) :: this
    !
    nullify (this%integratechanges)
    nullify (this%iusesy)
    nullify (this%ss)
    nullify (this%sy)
    nullify (this%ss_src)
    nullify (this%sy_src)
    call tvbase_da(this)

Here is the call graph for this function:

tvs_reset_change_flags()

subroutine tvsmodule::tvs_reset_change_flags ( class(tvstype)  this )

private

Deferred procedure implementation called by the TvBaseType code when a new time step commences, indicating that any previously set per-node property value change flags should be reset.

Definition at line 191 of file gwf-tvs.f90.

    ! -- dummy
    class(TvsType) :: this
    !
    ! -- No need to record TVS/STO changes, as no other packages cache
    ! -- Ss or Sy values

tvs_set_changed_at()

subroutine tvsmodule::tvs_set_changed_at ( class(tvstype)  this, integer(i4b), intent(in)  kper, integer(i4b), intent(in)  kstp  )

private

Deferred procedure implementation called by the TvBaseType code when a property value change occurs at (kper, kstp).

Definition at line 175 of file gwf-tvs.f90.

    ! -- dummy
    class(TvsType) :: this
    integer(I4B), intent(in) :: kper
    integer(I4B), intent(in) :: kstp
    !
    ! -- No need to record TVS/STO changes, as no other packages cache
    ! -- Ss or Sy values

tvs_source_package_options()

subroutine tvsmodule::tvs_source_package_options ( class(tvstype)  this )

private

Definition at line 96 of file gwf-tvs.f90.

    ! -- dummy
    class(TvsType) :: this
    ! -- locals
    integer(I4B) :: isize
    ! -- formats
    character(len=*), parameter :: fmtdsci = &
      "(4X, 'DISABLE_STORAGE_CHANGE_INTEGRATION OPTION:', /, 6X, &
      &'Storage derivative terms will not be added to STO matrix formulation')"
    !
    ! -- DISABLE_STORAGE_CHANGE_INTEGRATION is a keyword; check via get_isize
    call get_isize('DISABLE_SC_INT', this%input_mempath, isize)
    if (isize > 0) then
      this%integratechanges = 0
      write (this%iout, fmtdsci)
    end if

Here is the call graph for this function:

tvs_validate_change()

subroutine tvsmodule::tvs_validate_change ( class(tvstype)  this, integer(i4b), intent(in)  n, character(len=*), intent(in)  varName  )

private

Deferred procedure implementation called by the TvBaseType code after a property value change occurs. Check if the property value of the given variable at the given node is invalid, and log an error if so.

Definition at line 205 of file gwf-tvs.f90.

    ! -- dummy
    class(TvsType) :: this
    integer(I4B), intent(in) :: n
    character(len=*), intent(in) :: varName
    ! -- local
    character(len=LINELENGTH) :: cellstr
    ! -- formats
    character(len=*), parameter :: fmtserr = &
      "(1x, a, ' changed storage property ', a, ' is < 0 for cell ', a,' ', &
      &1pg15.6)"
    character(len=*), parameter :: fmtsyerr = &
      "(1x, a, ' cannot change ', a ,' for cell ', a, ' because SY is unused &
      &in this model (all ICONVERT flags are 0).')"
    !
    if (varname == 'SS') then
      if (this%ss(n) < dzero) then
        call this%dis%noder_to_string(n, cellstr)
        write (errmsg, fmtserr) trim(adjustl(this%packName)), 'SS', &
          trim(cellstr), this%ss(n)
        call store_error(errmsg)
      end if
    elseif (varname == 'SY') then
      if (this%iusesy /= 1) then
        call this%dis%noder_to_string(n, cellstr)
        write (errmsg, fmtsyerr) trim(adjustl(this%packName)), 'SY', &
          trim(cellstr)
        call store_error(errmsg)
      elseif (this%sy(n) < dzero) then
        call this%dis%noder_to_string(n, cellstr)
        write (errmsg, fmtserr) trim(adjustl(this%packName)), 'SY', &
          trim(cellstr), this%sy(n)
        call store_error(errmsg)
      end if
    end if

Here is the call graph for this function: