tvkmodule Module Reference

This module contains time-varying conductivity package methods. More...

Data Types
type	tvktype

Functions/Subroutines
subroutine, public	tvk_cr (tvk, name_model, inunit, iout)
	Create a new TvkType object. More...
subroutine	tvk_ar_set_pointers (this)
	Announce package and set pointers to variables. More...
logical function	tvk_read_option (this, keyword)
	Read a TVK-specific option from the OPTIONS block. More...
real(dp) function, pointer	tvk_get_pointer_to_value (this, n, varName)
	Get an array value pointer given a variable name and node index. More...
subroutine	tvk_set_changed_at (this, kper, kstp)
	Mark property changes as having occurred at (kper, kstp) More...
subroutine	tvk_reset_change_flags (this)
	Clear all per-node change flags. More...
subroutine	tvk_validate_change (this, n, varName)
	Check that a given property value is valid. More...
subroutine	tvk_da (this)
	Deallocate package memory. More...

Detailed Description

This module contains the methods used to allow hydraulic conductivity parameters in the NPF package (K11, K22, K33) to be varied throughout a simulation.

Function/Subroutine Documentation

tvk_ar_set_pointers()

subroutine tvkmodule::tvk_ar_set_pointers ( class(tvktype)  this )

private

Announce package version and set array and variable pointers from the NPF package for access by TVK.

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

    ! -- dummy
    class(TvkType) :: this
    ! -- local
    character(len=LENMEMPATH) :: npfMemoryPath
    ! -- formats
    character(len=*), parameter :: fmttvk = &
      "(1x,/1x,'TVK -- TIME-VARYING K PACKAGE, VERSION 1, 08/18/2021', &
      &' INPUT READ FROM UNIT ', i0, //)"
    !
    ! -- Print a message identifying the TVK package
    write (this%iout, fmttvk) this%inunit
    !
    ! -- Set pointers to other package variables
    ! -- NPF
    npfmemorypath = create_mem_path(this%name_model, 'NPF')
    call mem_setptr(this%ik22overk, 'IK22OVERK', npfmemorypath)
    call mem_setptr(this%ik33overk, 'IK33OVERK', npfmemorypath)
    call mem_setptr(this%k11, 'K11', npfmemorypath)
    call mem_setptr(this%k22, 'K22', npfmemorypath)
    call mem_setptr(this%k33, 'K33', npfmemorypath)
    call mem_setptr(this%kchangeper, 'KCHANGEPER', npfmemorypath)
    call mem_setptr(this%kchangestp, 'KCHANGESTP', npfmemorypath)
    call mem_setptr(this%nodekchange, 'NODEKCHANGE', npfmemorypath)

Here is the call graph for this function:

tvk_cr()

subroutine, public tvkmodule::tvk_cr	(	type(tvktype), intent(out), pointer	tvk,
		character(len=*), intent(in)	name_model,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout
	)

Create a new time-varying conductivity (TvkType) object.

Definition at line 52 of file gwf-tvk.f90.

    ! -- dummy
    type(TvkType), pointer, intent(out) :: tvk
    character(len=*), intent(in) :: name_model
    integer(I4B), intent(in) :: inunit
    integer(I4B), intent(in) :: iout
    !
    allocate (tvk)
    call tvk%init(name_model, 'TVK', 'TVK', inunit, iout)

Here is the caller graph for this function:

tvk_da()

subroutine tvkmodule::tvk_da ( class(tvktype)  this )

private

Deallocate TVK package scalars and arrays.

Definition at line 225 of file gwf-tvk.f90.

    ! -- dummy
    class(TvkType) :: this
    !
    ! -- Nullify pointers to other package variables
    nullify (this%ik22overk)
    nullify (this%ik33overk)
    nullify (this%k11)
    nullify (this%k22)
    nullify (this%k33)
    nullify (this%kchangeper)
    nullify (this%kchangestp)
    nullify (this%nodekchange)
    !
    ! -- Deallocate parent
    call tvbase_da(this)

Here is the call graph for this function:

tvk_get_pointer_to_value()

real(dp) function, pointer tvkmodule::tvk_get_pointer_to_value ( class(tvktype)  this, integer(i4b), intent(in)  n, character(len=*), intent(in)  varName  )

private

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

Definition at line 115 of file gwf-tvk.f90.

    ! -- dummy
    class(TvkType) :: this
    integer(I4B), intent(in) :: n
    character(len=*), intent(in) :: varName
    ! -- return
    real(DP), pointer :: bndElem
    !
    select case (varname)
    case ('K')
      bndelem => this%k11(n)
    case ('K22')
      bndelem => this%k22(n)
    case ('K33')
      bndelem => this%k33(n)
    case default
      bndelem => null()
    end select

tvk_read_option()

logical function tvkmodule::tvk_read_option ( class(tvktype)  this, character(len=*), intent(in)  keyword  )

private

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

Definition at line 99 of file gwf-tvk.f90.

    ! -- dummy
    class(TvkType) :: this
    character(len=*), intent(in) :: keyword
    ! -- return
    logical :: success
    !
    ! -- There are no TVK-specific options, so just return false
    success = .false.

tvk_reset_change_flags()

subroutine tvkmodule::tvk_reset_change_flags ( class(tvktype)  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 156 of file gwf-tvk.f90.

    ! -- dummy variables
    class(TvkType) :: this
    ! -- local variables
    integer(I4B) :: i
    !
    ! -- Clear NPF's nodekchange array
    do i = 1, this%dis%nodes
      this%nodekchange(i) = 0
    end do

tvk_set_changed_at()

subroutine tvkmodule::tvk_set_changed_at ( class(tvktype)  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 140 of file gwf-tvk.f90.

    ! -- dummy
    class(TvkType) :: this
    integer(I4B), intent(in) :: kper
    integer(I4B), intent(in) :: kstp
    !
    this%kchangeper = kper
    this%kchangestp = kstp

tvk_validate_change()

subroutine tvkmodule::tvk_validate_change ( class(tvktype)  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. Update K22 and K33 values appropriately when specified as anisotropy.

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

    ! -- dummy
    class(TvkType) :: this
    integer(I4B), intent(in) :: n
    character(len=*), intent(in) :: varName
    ! -- local
    character(len=LINELENGTH) :: cellstr
    ! -- formats
    character(len=*), parameter :: fmtkerr = &
      "(1x, a, ' changed hydraulic property ', a, ' is <= 0 for cell ', a, &
      &' ', 1pg15.6)"
    !
    ! -- Mark the node as being changed this time step
    this%nodekchange(n) = 1
    !
    ! -- Check the changed value is ok
    if (varname == 'K') then
      if (this%k11(n) <= dzero) then
        call this%dis%noder_to_string(n, cellstr)
        write (errmsg, fmtkerr) &
          trim(adjustl(this%packName)), 'K', trim(cellstr), this%k11(n)
        call store_error(errmsg)
      end if
    elseif (varname == 'K22') then
      if (this%ik22overk == 1) then
        this%k22(n) = this%k22(n) * this%k11(n)
      end if
      if (this%k22(n) <= dzero) then
        call this%dis%noder_to_string(n, cellstr)
        write (errmsg, fmtkerr) &
          trim(adjustl(this%packName)), 'K22', trim(cellstr), this%k22(n)
        call store_error(errmsg)
      end if
    elseif (varname == 'K33') then
      if (this%ik33overk == 1) then
        this%k33(n) = this%k33(n) * this%k11(n)
      end if
      if (this%k33(n) <= dzero) then
        call this%dis%noder_to_string(n, cellstr)
        write (errmsg, fmtkerr) &
          trim(adjustl(this%packName)), 'K33', trim(cellstr), this%k33(n)
        call store_error(errmsg)
      end if
    end if

Here is the call graph for this function: