gwtsrcmodule Module Reference

Data Types
type	gwtsrctype

Functions/Subroutines
subroutine, public	src_create (packobj, id, ibcnum, inunit, iout, namemodel, depvartype, pakname, input_mempath, fmi)
	Create a source loading package. More...
subroutine	src_options (this)
	Set additional options specific to the GwtSrcType. More...
subroutine	src_da (this)
	Deallocate memory. More...
subroutine	src_allocate_scalars (this)
	Allocate scalars. More...
subroutine	src_allocate_arrays (this, nodelist, auxvar)
	Allocate arrays. More...
subroutine	src_rp (this)
subroutine	set_nodesontop (this)
	Store nodelist in nodesontop. 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...
real(dp) function	src_bound_value (this, col, row)
	@ brief Return a bound value More...
real(dp) function	mass_mult (this, row)
	Return a value that applies a multiplier. 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 320 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

mass_mult()

real(dp) function gwtsrcmodule::mass_mult	(	class(gwtsrctype), intent(inout)	this,
		integer(i4b), intent(in)	row
	)

Apply multiplier to specified mass-source load depending on user-selected option

Parameters

[in,out]

this

BndExtType object

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

    ! -- modules
    use constantsmodule, only: dzero
    ! -- dummy variables
    class(GwtSrcType), intent(inout) :: this !< BndExtType object
    integer(I4B), intent(in) :: row
    ! -- result
    real(DP) :: ener
    !
    if (this%iauxmultcol > 0) then
      ener = this%smassrate(row) * this%auxvar(this%iauxmultcol, row)
    else
      ener = this%smassrate(row)
    end if

set_nodesontop()

subroutine gwtsrcmodule::set_nodesontop

(

class(gwtsrctype), intent(inout)

this

)

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

    implicit none
    ! -- dummy
    class(GwtSrcType), intent(inout) :: this
    ! -- local
    integer(I4B) :: n
    ! !
    ! ! -- allocate if necessary
    ! if (.not. associated(this%nodesontop)) then
    !   allocate (this%nodesontop(this%maxbound))
    ! end if
    !
    ! -- copy nodelist into nodesontop
    do n = 1, this%nbound
      this%nodesontop(n) = this%nodelist(n)
    end do

src_allocate_arrays()

subroutine gwtsrcmodule::src_allocate_arrays	(	class(gwtsrctype)	this,
		integer(i4b), dimension(:), optional, pointer, contiguous	nodelist,
		real(dp), dimension(:, :), optional, pointer, contiguous	auxvar
	)

Allocate scalars specific to this source loading package

Parameters

nodelist	package nodelist
auxvar	package aux variable array

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

    use memorymanagermodule, only: mem_allocate, mem_setptr, mem_checkin
    ! -- dummy
    class(GwtSrcType) :: this
    integer(I4B), dimension(:), pointer, contiguous, optional :: nodelist !< package nodelist
    real(DP), dimension(:, :), pointer, contiguous, optional :: auxvar !< package aux variable array
    ! local
    integer(I4B) :: n
    !
    ! -- base class allocate arrays
    call this%BndExtType%allocate_arrays(nodelist, auxvar)
    !
    ! -- allocate the object and assign values to object variables
    if (this%highest_sat) then
      call mem_allocate(this%nodesontop, this%maxbound, 'NODESONTOP', &
                        this%memoryPath)
    end if
 
    ! -- set input context pointers
    call mem_setptr(this%smassrate, 'SMASSRATE', this%input_mempath)
    !
    ! -- checkin input context pointers
    call mem_checkin(this%smassrate, 'SMASSRATE', this%memoryPath, &
                     'SMASSRATE', this%input_mempath)
    !
    ! -- Set values
    if (this%highest_sat) then
      do n = 1, this%maxbound
        this%nodesontop(n) = 0
      end do
    end if

src_allocate_scalars()

subroutine gwtsrcmodule::src_allocate_scalars

(

class(gwtsrctype)

this

)

Allocate scalars specific to this source loading package

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

    use memorymanagermodule, only: mem_allocate
    ! -- dummy
    class(GwtSrcType) :: this
    !
    ! -- base class allocate scalars
    call this%BndExtType%allocate_scalars()
    !
    ! -- allocate the object and assign values to object variables
    call mem_allocate(this%highest_sat, 'HIGHEST_SAT', this%memoryPath)
    !
    ! -- Set values
    this%highest_sat = .false.
 

src_bound_value()

real(dp) function gwtsrcmodule::src_bound_value ( class(gwtsrctype), intent(inout)  this, integer(i4b), intent(in)  col, integer(i4b), intent(in)  row  )

private

Return a bound value associated with an ncolbnd index and row.

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

    ! -- modules
    use constantsmodule, only: dzero
    ! -- dummy variables
    class(GwtSrcType), intent(inout) :: this
    integer(I4B), intent(in) :: col
    integer(I4B), intent(in) :: row
    ! -- result
    real(DP) :: bndval
    !
    select case (col)
    case (1)
      bndval = this%smassrate(row)
    case default
    end select

src_cf()

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

private

This subroutine:

• calculates hcof and rhs terms
• skip if no sources

Definition at line 241 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
      !
      ! -- Find the node number
      if (this%highest_sat) then
        node = this%nodesontop(i)
      else
        node = this%nodelist(i)
      end if
      !
      ! -- reset nodelist to highest active
      if (this%highest_sat) then
        if (this%fmi%gwfsat(node) == 0) &
          call this%dis%highest_saturated(node, this%fmi%gwfsat)
        this%nodelist(i) = node
      end if
 
      this%hcof(i) = dzero
      if (this%ibound(node) <= 0) then
        this%rhs(i) = dzero
        cycle
      end if
      !
      ! -- set energy loading rate accounting for multiplier
      q = this%mass_mult(i)
      !
      this%rhs(i) = -q
    end do

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=lenvarname), intent(in)	depvartype,
		character(len=*), intent(in)	pakname,
		character(len=*), intent(in)	input_mempath,
		type(tspfmitype), intent(in), target	fmi
	)

This subroutine points bndobj to the newly created package

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

    ! -- modules
    use bndmodule, only: bndtype
    ! -- 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
    character(len=*), intent(in) :: input_mempath
    type(TspFmiType), intent(in), target :: fmi
    ! -- 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, input_mempath)
    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
 
    srcobj%fmi => fmi
 

Here is the caller graph for this function:

src_da()

subroutine gwtsrcmodule::src_da

(

class(gwtsrctype)

this

)

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

    ! -- modules
    use memorymanagermodule, only: mem_deallocate
    ! -- dummy
    class(GwtSrcType) :: this
    !
    ! -- Deallocate parent package
    call this%BndExtType%bnd_da()
    !
    ! -- arrays
    call mem_deallocate(this%smassrate, 'SMASSRATE', this%memoryPath)
    if (this%highest_sat) then
      call mem_deallocate(this%nodesontop, "NODESONTOP", this%memoryPath)
    end if
    !
    ! -- scalars
    call mem_deallocate(this%highest_sat)

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 364 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

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 285 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

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 350 of file gwt-src.f90.

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

src_options()

subroutine gwtsrcmodule::src_options

(

class(gwtsrctype), intent(inout)

this

)

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

    ! -- modules
    use memorymanagerextmodule, only: mem_set_value
    use characterstringmodule, only: characterstringtype
    use gwtsrcinputmodule, only: gwtsrcparamfoundtype
    ! -- dummy
    class(GwtSrcType), intent(inout) :: this
    ! -- local
    type(GwtSrcParamFoundType) :: found
    !
    ! -- source base class options
    call this%BndExtType%source_options()
    !
    ! -- source options from input context
    call mem_set_value(this%highest_sat, 'HIGHEST_SAT', this%input_mempath, &
                       found%highest_sat)
 
    write (this%iout, '(/1x,a)') 'PROCESSING SRC OPTIONS'
    if (found%highest_sat) then
      write (this%iout, '(4x,a)') &
        'Mass source loading rate will be applied to the highest cell at or below &
        &the specified cellid with a non-zero saturation.'
    end if
    write (this%iout, '(1x,a)') 'END OF SRC OPTIONS'

src_rp()

subroutine gwtsrcmodule::src_rp

(

class(gwtsrctype), intent(inout)

this

)

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

    ! -- modules
    use tdismodule, only: kper
    ! -- dummy
    class(GwtSrcType), intent(inout) :: this
    if (this%iper /= kper) return
    call this%BndExtType%bnd_rp()
    if (this%highest_sat) call this%set_nodesontop()

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'