tvbasemodule Module Reference

This module contains common time-varying property functionality. More...

Data Types
type	tvbasetype
interface	ar_set_pointers
	Announce package and set pointers to variables. More...
interface	apply_row_changes
	Apply this node's current input value(s) to the model property array(s). More...
interface	set_changed_at
	Mark property changes as having occurred at (kper, kstp) More...
interface	reset_change_flags
	Clear all per-node change flags. More...
interface	validate_change
	Check that a given property value is valid. More...

Functions/Subroutines
subroutine	init (this, name_model, pakname, ftype, mempath, inunit, iout)
	Initialize the TvBaseType object. More...
subroutine	tvbase_allocate_scalars (this)
	Allocate scalar variables. More...
subroutine	tvbase_source_options (this)
	Source common options from the input memory path. More...
subroutine	tvbase_source_package_options (this)
	Source package-specific options from the input memory path. More...
subroutine	ar (this, dis)
	Allocate and read static data for the package. More...
subroutine	rp (this)
	Read and prepare stress period data for the package. More...
subroutine	ad (this)
	Apply advanced values at each time step. More...
subroutine	sync_node_changes (this)
	Sync every tracked node's current input value into the model property array(s) it belongs to (e.g. NPF's K11). More...
integer(i4b) function	cellid_to_nodeu (this, n)
	Return the unreduced node number for CELLID row n. More...
subroutine, public	tvbase_da (this)
	Deallocate package memory. More...

Detailed Description

This module contains methods implementing functionality common to both time-varying hydraulic conductivity (TVK) and time-varying storage (TVS) packages.

Function/Subroutine Documentation

ad()

subroutine tvbasemodule::ad ( class(tvbasetype)  this )

private

Definition at line 270 of file TvBase.f90.

    ! -- dummy
    class(TvBaseType) :: this
    !
    ! -- no-op when timeseries aren't active.
    if (.not. this%ts_active) return
    !
    call this%sync_node_changes()

ar()

subroutine tvbasemodule::ar ( class(tvbasetype)  this, class(disbasetype), intent(in), pointer  dis  )

private

Definition at line 212 of file TvBase.f90.

    ! -- dummy
    class(TvBaseType) :: this
    class(DisBaseType), pointer, intent(in) :: dis
    !
    this%dis => dis
    call this%ar_set_pointers()
    !
    call this%source_options()
    !
    ! -- set input mempath pointers
    call mem_setptr(this%cellid, 'CELLID', this%input_mempath)
    call this%tracked_nodeu%init()
    !
    if (count_errors() > 0) then
      call store_error_filename(this%input_fname)
    end if

Here is the call graph for this function:

cellid_to_nodeu()

integer(i4b) function tvbasemodule::cellid_to_nodeu ( class(tvbasetype)  this, integer(i4b), intent(in)  n  )

private

Parameters

[in]

n

row index in the period-data arrays

Definition at line 307 of file TvBase.f90.

    ! -- dummy
    class(TvBaseType) :: this
    integer(I4B), intent(in) :: n !< row index in the period-data arrays
    ! -- return
    integer(I4B) :: nodeu
    !
    if (this%dis%ndim == 1) then
      nodeu = this%cellid(1, n)
    elseif (this%dis%ndim == 2) then
      nodeu = get_node(this%cellid(1, n), 1, &
                       this%cellid(2, n), &
                       this%dis%mshape(1), 1, &
                       this%dis%mshape(2))
    else
      nodeu = get_node(this%cellid(1, n), &
                       this%cellid(2, n), &
                       this%cellid(3, n), &
                       this%dis%mshape(1), &
                       this%dis%mshape(2), &
                       this%dis%mshape(3))
    end if

Here is the call graph for this function:

init()

subroutine tvbasemodule::init	(	class(tvbasetype)	this,
		character(len=*), intent(in)	name_model,
		character(len=*), intent(in)	pakname,
		character(len=*), intent(in)	ftype,
		character(len=*), intent(in)	mempath,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout
	)

Allocate and initialize data members of the object.

Definition at line 136 of file TvBase.f90.

    ! -- dummy
    class(TvBaseType) :: this
    character(len=*), intent(in) :: name_model
    character(len=*), intent(in) :: pakname
    character(len=*), intent(in) :: ftype
    character(len=*), intent(in) :: mempath
    integer(I4B), intent(in) :: inunit
    integer(I4B), intent(in) :: iout
    !
    call this%set_names(1, name_model, pakname, ftype, mempath)
    call this%tvbase_allocate_scalars()
    this%inunit = inunit
    this%iout = iout

rp()

subroutine tvbasemodule::rp ( class(tvbasetype)  this )

private

Definition at line 233 of file TvBase.f90.

    ! -- dummy
    class(TvBaseType) :: this
    ! -- local variables
    integer(I4B), pointer :: iper, nbound
    integer(I4B) :: n, nodeu, nodeu_count
    !
    ! -- check last loaded input period
    call mem_setptr(iper, 'IPER', this%input_mempath)
    if (iper /= kper) return
    !
    ! -- record every node newly addressed by this period's own rows in
    ! -- tracked_nodeu, so sync_node_changes never has to scan the full
    ! -- node space to find which nodes have a live tracked value
    call mem_setptr(nbound, 'NBOUND', this%input_mempath)
    if (nbound > 0) then
      nodeu_count = product(this%dis%mshape)
      do n = 1, nbound
        nodeu = this%cellid_to_nodeu(n)
        if (nodeu < 1 .or. nodeu > nodeu_count) then
          write (errmsg, '(a,i0,a)') &
            'CELLID at PERIOD row ', n, ' is not in the active model domain.'
          call store_error(errmsg)
          cycle
        end if
        call this%tracked_nodeu%push_back_unique(nodeu)
      end do
    end if
    !
    ! -- When timeseries are active, ad applies values at every time step
    if (this%ts_active) return
    !
    call this%sync_node_changes()

Here is the call graph for this function:

sync_node_changes()

subroutine tvbasemodule::sync_node_changes ( class(tvbasetype)  this )

private

Definition at line 283 of file TvBase.f90.

    ! -- dummy
    class(TvBaseType) :: this
    ! -- local variables
    integer(I4B) :: i, nodeu, node
    !
    if (this%tracked_nodeu%size <= 0) return
    !
    call this%set_changed_at(kper, kstp)
    call this%reset_change_flags()
    !
    do i = 1, this%tracked_nodeu%size
      nodeu = this%tracked_nodeu%at(i)
      node = this%dis%get_nodenumber(nodeu, 1)
      call this%apply_row_changes(nodeu, node)
    end do
    !
    if (count_errors() > 0) then
      call store_error_filename(this%input_fname)
    end if

Here is the call graph for this function:

tvbase_allocate_scalars()

subroutine tvbasemodule::tvbase_allocate_scalars ( class(tvbasetype)  this )

private

Allocate scalar data members of the object.

Definition at line 156 of file TvBase.f90.

    ! -- dummy
    class(TvBaseType) :: this
    !
    ! -- Call standard NumericalPackageType allocate scalars
    call this%NumericalPackageType%allocate_scalars()

tvbase_da()

subroutine, public tvbasemodule::tvbase_da

(

class(tvbasetype)

this

)

Deallocate package scalars and arrays.

Definition at line 335 of file TvBase.f90.

    ! -- dummy
    class(TvBaseType) :: this
    !
    nullify (this%cellid)
    call this%tracked_nodeu%destroy()
    call this%NumericalPackageType%da()

Here is the caller graph for this function:

tvbase_source_options()

subroutine tvbasemodule::tvbase_source_options ( class(tvbasetype)  this )

private

Source common options and call derived package routine to source and log any package-specific options within the same block.

Definition at line 169 of file TvBase.f90.

    ! -- modules
    use memorymanagerextmodule, only: mem_set_value
    ! -- dummy
    class(TvBaseType) :: this
    ! -- locals
    integer(I4B) :: isize
    logical(LGP) :: found_print_input
    !
    write (this%iout, '(1x,a)') &
      'PROCESSING '//trim(adjustl(this%packName))//' OPTIONS'
    !
    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
    !
    call get_isize('TS6_FILENAME', this%input_mempath, isize)
    if (isize > 0) this%ts_active = .true.
    !
    ! -- source package-specific options
    call this%source_package_options()
    !
    write (this%iout, '(1x,a)') &
      'END OF '//trim(adjustl(this%packName))//' OPTIONS'

Here is the call graph for this function:

tvbase_source_package_options()

subroutine tvbasemodule::tvbase_source_package_options

(

class(tvbasetype)

this

)

Override in derived package to source and log package-specific options. Default implementation is a no-op.

Definition at line 203 of file TvBase.f90.

    ! -- dummy
    class(TvBaseType) :: this
    !
    ! -- no package-specific options in the base class