gwtsrcmodule Module Reference

Data Types
type	gwtsrctype

Functions/Subroutines
subroutine, public	src_create (packobj, id, ibcnum, inunit, iout, namemodel, pakname, depvartype)
	Create a source loading package. More...
subroutine	src_da (this)
	Deallocate memory. More...
subroutine	src_allocate_scalars (this)
	Allocate scalars. More...
subroutine	src_cf (this)
	Formulate the HCOF and RHS terms. More...
subroutine	src_fc (this, rhs, ia, idxglo, matrix_sln)
	Add matrix terms related to specified mass source loading. More...
subroutine	define_listlabel (this)
	Define list labels. More...
logical function	src_obs_supported (this)
	Support function for specified mass source loading observations. More...
subroutine	src_df_obs (this)
	Define observations. More...
subroutine	src_rp_ts (this)
	Procedure related to time series. More...

Variables
character(len=lenftype)	ftype = 'SRC'
character(len=16)	text = ' SRC'

Function/Subroutine Documentation

define_listlabel()

subroutine gwtsrcmodule::define_listlabel ( class(gwtsrctype), intent(inout)  this )

private

Define the list heading that is written to iout when PRINT_INPUT option is used.

Definition at line 198 of file gwt-src.f90.

    ! -- dummy
    class(GwtSrcType), intent(inout) :: this
    ! -- local
    !
    ! -- create the header list label
    this%listlabel = trim(this%filtyp)//' NO.'
    if (this%dis%ndim == 3) then
      write (this%listlabel, '(a, a7)') trim(this%listlabel), 'LAYER'
      write (this%listlabel, '(a, a7)') trim(this%listlabel), 'ROW'
      write (this%listlabel, '(a, a7)') trim(this%listlabel), 'COL'
    elseif (this%dis%ndim == 2) then
      write (this%listlabel, '(a, a7)') trim(this%listlabel), 'LAYER'
      write (this%listlabel, '(a, a7)') trim(this%listlabel), 'CELL2D'
    else
      write (this%listlabel, '(a, a7)') trim(this%listlabel), 'NODE'
    end if
    write (this%listlabel, '(a, a16)') trim(this%listlabel), 'STRESS RATE'
    if (this%inamedbound == 1) then
      write (this%listlabel, '(a, a16)') trim(this%listlabel), 'BOUNDARY NAME'
    end if
    !
    ! -- Return
    return

src_allocate_scalars()

subroutine gwtsrcmodule::src_allocate_scalars

(

class(gwtsrctype)

this

)

Allocate scalars specific to this source loading package

Definition at line 108 of file gwt-src.f90.

    use memorymanagermodule, only: mem_allocate
    ! -- dummy
    class(GwtSrcType) :: this
    !
    ! -- call standard BndType allocate scalars
    call this%BndType%allocate_scalars()
    !
    ! -- allocate the object and assign values to object variables
    !
    ! -- Set values
    !
    ! -- Return
    return

src_cf()

subroutine gwtsrcmodule::src_cf

(

class(gwtsrctype)

this

)

This subroutine:

• calculates hcof and rhs terms
• skip if no sources

Definition at line 130 of file gwt-src.f90.

    ! -- dummy
    class(GwtSrcType) :: this
    ! -- local
    integer(I4B) :: i, node
    real(DP) :: q
    !
    ! -- Return if no sources
    if (this%nbound == 0) return
    !
    ! -- Calculate hcof and rhs for each source entry
    do i = 1, this%nbound
      node = this%nodelist(i)
      this%hcof(i) = dzero
      if (this%ibound(node) <= 0) then
        this%rhs(i) = dzero
        cycle
      end if
      q = this%bound(1, i)
      this%rhs(i) = -q
    end do
    !
    ! -- Return
    return

src_create()

subroutine, public gwtsrcmodule::src_create	(	class(bndtype), pointer	packobj,
		integer(i4b), intent(in)	id,
		integer(i4b), intent(in)	ibcnum,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout,
		character(len=*), intent(in)	namemodel,
		character(len=*), intent(in)	pakname,
		character(len=lenvarname), intent(in)	depvartype
	)

This subroutine points bndobj to the newly created package

Definition at line 45 of file gwt-src.f90.

    ! -- dummy
    class(BndType), pointer :: packobj
    integer(I4B), intent(in) :: id
    integer(I4B), intent(in) :: ibcnum
    integer(I4B), intent(in) :: inunit
    integer(I4B), intent(in) :: iout
    character(len=*), intent(in) :: namemodel
    character(len=*), intent(in) :: pakname
    character(len=LENVARNAME), intent(in) :: depvartype
    ! -- local
    type(GwtSrcType), pointer :: srcobj
    !
    ! -- allocate the object and assign values to object variables
    allocate (srcobj)
    packobj => srcobj
    !
    ! -- create name and memory path
    call packobj%set_names(ibcnum, namemodel, pakname, ftype)
    packobj%text = text
    !
    ! -- allocate scalars
    call srcobj%allocate_scalars()
    !
    ! -- initialize package
    call packobj%pack_initialize()
 
    packobj%inunit = inunit
    packobj%iout = iout
    packobj%id = id
    packobj%ibcnum = ibcnum
    packobj%ncolbnd = 1
    packobj%iscloc = 1
    !
    ! -- Store the appropriate label based on the dependent variable
    srcobj%depvartype = depvartype
    !
    ! -- return
    return

Here is the caller graph for this function:

src_da()

subroutine gwtsrcmodule::src_da ( class(gwtsrctype)  this )

private

Definition at line 89 of file gwt-src.f90.

    ! -- modules
    use memorymanagermodule, only: mem_deallocate
    ! -- dummy
    class(GwtSrcType) :: this
    !
    ! -- Deallocate parent package
    call this%BndType%bnd_da()
    !
    ! -- scalars
    !
    ! -- Return
    return

src_df_obs()

subroutine gwtsrcmodule::src_df_obs ( class(gwtsrctype)  this )

private

This subroutine:

• stores observation types supported by SRC package.
• overrides BndTypebnd_df_obs

Definition at line 248 of file gwt-src.f90.

    implicit none
    ! -- dummy
    class(GwtSrcType) :: this
    ! -- local
    integer(I4B) :: indx
    !
    call this%obs%StoreObsType('src', .true., indx)
    this%obs%obsData(indx)%ProcessIdPtr => defaultobsidprocessor
    !
    ! -- Store obs type and assign procedure pointer
    !    for to-mvr observation type.
    call this%obs%StoreObsType('to-mvr', .true., indx)
    this%obs%obsData(indx)%ProcessIdPtr => defaultobsidprocessor
    !
    ! -- Return
    return

Here is the call graph for this function:

src_fc()

subroutine gwtsrcmodule::src_fc ( class(gwtsrctype)  this, real(dp), dimension(:), intent(inout)  rhs, integer(i4b), dimension(:), intent(in)  ia, integer(i4b), dimension(:), intent(in)  idxglo, class(matrixbasetype), pointer  matrix_sln  )

private

Copy rhs and hcof into solution rhs and amat

Definition at line 160 of file gwt-src.f90.

    ! -- dummy
    class(GwtSrcType) :: this
    real(DP), dimension(:), intent(inout) :: rhs
    integer(I4B), dimension(:), intent(in) :: ia
    integer(I4B), dimension(:), intent(in) :: idxglo
    class(MatrixBaseType), pointer :: matrix_sln
    ! -- local
    integer(I4B) :: i, n, ipos
    !
    ! -- pakmvrobj fc
    if (this%imover == 1) then
      call this%pakmvrobj%fc()
    end if
    !
    ! -- Copy package rhs and hcof into solution rhs and amat
    do i = 1, this%nbound
      n = this%nodelist(i)
      rhs(n) = rhs(n) + this%rhs(i)
      ipos = ia(n)
      call matrix_sln%add_value_pos(idxglo(ipos), this%hcof(i))
      !
      ! -- If mover is active and mass is being withdrawn,
      !    store available mass (as positive value).
      if (this%imover == 1 .and. this%rhs(i) > dzero) then
        call this%pakmvrobj%accumulate_qformvr(i, this%rhs(i))
      end if
    end do
    !
    ! -- Return
    return

src_obs_supported()

logical function gwtsrcmodule::src_obs_supported ( class(gwtsrctype)  this )

private

This function:

• returns true because SRC package supports observations.
• overrides BndTypebnd_obs_supported()

Definition at line 231 of file gwt-src.f90.

    implicit none
    ! -- dummy
    class(GwtSrcType) :: this
    !
    src_obs_supported = .true.
    !
    ! -- Return
    return

src_rp_ts()

subroutine gwtsrcmodule::src_rp_ts ( class(gwtsrctype), intent(inout)  this )

private

Assign tsLinkText appropriately for all time series in use by package. In the SRC package only the SMASSRATE variable can be controlled by time series.

Definition at line 273 of file gwt-src.f90.

    ! -- dummy
    class(GwtSrcType), intent(inout) :: this
    ! -- local
    integer(I4B) :: i, nlinks
    type(TimeSeriesLinkType), pointer :: tslink => null()
    !
    nlinks = this%TsManager%boundtslinks%Count()
    do i = 1, nlinks
      tslink => gettimeserieslinkfromlist(this%TsManager%boundtslinks, i)
      if (associated(tslink)) then
        if (tslink%JCol == 1) then
          tslink%Text = 'SMASSRATE'
        end if
      end if
    end do
    !
    ! -- Return
    return

Here is the call graph for this function:

Variable Documentation

ftype

character(len=lenftype) gwtsrcmodule::ftype = 'SRC'

private

Definition at line 17 of file gwt-src.f90.

  character(len=LENFTYPE) :: ftype = 'SRC'

text

character(len=16) gwtsrcmodule::text = ' SRC'

private

Definition at line 18 of file gwt-src.f90.

  character(len=16) :: text = '             SRC'