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, inunit, iout)
	Create a new TvsType object. More...
subroutine	tvs_ar_set_pointers (this)
	Announce package and set pointers to variables. More...
logical function	tvs_read_option (this, keyword)
	Read a TVS-specific option from the OPTIONS block. More...
real(dp) function, pointer	tvs_get_pointer_to_value (this, n, varName)
	Get an array value pointer given a variable name and node index. 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_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 67 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 UNIT ', i0, //)"
    !
    ! -- Print a message identifying the TVS package
    write (this%iout, fmttvs) this%inunit
    !
    ! -- Set pointers to other package variables
    ! -- STO
    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
    !
    ! -- Return
    return

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,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout
	)

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

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

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

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 236 of file gwf-tvs.f90.

    ! -- dummy
    class(TvsType) :: this
    !
    ! -- Nullify pointers to other package variables
    nullify (this%integratechanges)
    nullify (this%iusesy)
    nullify (this%ss)
    nullify (this%sy)
    !
    ! -- Deallocate parent
    call tvbase_da(this)
    !
    ! -- Return
    return

Here is the call graph for this function:

tvs_get_pointer_to_value()

real(dp) function, pointer tvsmodule::tvs_get_pointer_to_value ( class(tvstype)  this, integer(i4b), intent(in)  n, character(len=*), intent(in)  varName  )

private

Return a pointer to the given node's value in the appropriate STO array based on the given variable name string.

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

    ! -- dummy
    class(TvsType) :: this
    integer(I4B), intent(in) :: n
    character(len=*), intent(in) :: varName
    ! -- return
    real(DP), pointer :: bndElem
    !
    select case (varname)
    case ('SS')
      bndelem => this%ss(n)
    case ('SY')
      bndelem => this%sy(n)
    case default
      bndelem => null()
    end select
    !
    ! -- Return
    return

tvs_read_option()

logical function tvsmodule::tvs_read_option ( class(tvstype)  this, character(len=*), intent(in)  keyword  )

private

Process a single TVS-specific option. Used when reading the OPTIONS block of the TVS package input file.

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

    ! -- dummy
    class(TvsType) :: this
    character(len=*), intent(in) :: keyword
    ! -- return
    logical :: success
    ! -- formats
    character(len=*), parameter :: fmtdsci = &
      "(4X, 'DISABLE_STORAGE_CHANGE_INTEGRATION OPTION:', /, 1X, &
      &'Storage derivative terms will not be added to STO matrix formulation')"
    !
    select case (keyword)
    case ('DISABLE_STORAGE_CHANGE_INTEGRATION')
      success = .true.
      this%integratechanges = 0
      write (this%iout, fmtdsci)
    case default
      success = .false.
    end select
    !
    ! -- Return
    return

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 174 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
    !
    ! -- Return
    return

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 155 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
    !
    ! -- Return
    return

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 191 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).')"
    !
    ! -- Check the changed value is ok and convert to storage capacity
    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
    !
    ! -- Return
    return

Here is the call graph for this function: