gweeslmodule Module Reference

Data Types
type	gweesltype

Functions/Subroutines
subroutine, public	esl_create (packobj, id, ibcnum, inunit, iout, namemodel, pakname, gwecommon)
	Create an energy source loading package. More...
subroutine	esl_da (this)
	Deallocate memory. More...
subroutine	esl_allocate_scalars (this)
	Allocate scalars. More...
subroutine	esl_cf (this)
	Formulate the HCOF and RHS terms. More...
subroutine	esl_fc (this, rhs, ia, idxglo, matrix_sln)
	Add matrix terms related to specified energy source loading. More...
subroutine	define_listlabel (this)
	Define list labels. More...
logical function	esl_obs_supported (this)
	Support function for specified energy source loading observations. More...
subroutine	esl_df_obs (this)
	Define observations. More...
subroutine	esl_rp_ts (this)
	Procedure related to time series. More...

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

Function/Subroutine Documentation

define_listlabel()

subroutine gweeslmodule::define_listlabel ( class(gweesltype), intent(inout)  this )

private

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

Definition at line 200 of file gwe-esl.f90.

    ! -- dummy
    class(GweEslType), intent(inout) :: this
    !
    ! -- 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

esl_allocate_scalars()

subroutine gweeslmodule::esl_allocate_scalars

(

class(gweesltype)

this

)

Allocate scalars specific to this energy source loading package

Definition at line 109 of file gwe-esl.f90.

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

esl_cf()

subroutine gweeslmodule::esl_cf

(

class(gweesltype)

this

)

This subroutine:

• calculates hcof and rhs terms
• skip if no sources

Definition at line 132 of file gwe-esl.f90.

    ! -- dummy
    class(GweEslType) :: 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

esl_create()

subroutine, public gweeslmodule::esl_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,
		type(gweinputdatatype), intent(in), target	gwecommon
	)

This subroutine points bndobj to the newly created package

Parameters

[in]

gwecommon

shared data container for use by multiple GWE packages

Definition at line 46 of file gwe-esl.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
    type(GweInputDataType), intent(in), target :: gwecommon !< shared data container for use by multiple GWE packages
    ! -- local
    type(GweEslType), pointer :: eslobj
    !
    ! -- Allocate the object and assign values to object variables
    allocate (eslobj)
    packobj => eslobj
    !
    ! -- Create name and memory path
    call packobj%set_names(ibcnum, namemodel, pakname, ftype)
    packobj%text = text
    !
    ! -- Allocate scalars
    call eslobj%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 pointer to shared data module for accessing cpw, rhow
    !    for the budget calculations, and for accessing the latent heat of
    !    vaporization for evaporative cooling.
    eslobj%gwecommon => gwecommon
    !
    ! -- Return
    return

Here is the caller graph for this function:

esl_da()

subroutine gweeslmodule::esl_da ( class(gweesltype)  this )

private

Definition at line 92 of file gwe-esl.f90.

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

esl_df_obs()

subroutine gweeslmodule::esl_df_obs ( class(gweesltype)  this )

private

This subroutine:

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

Definition at line 250 of file gwe-esl.f90.

    implicit none
    ! -- dummy
    class(GweEslType) :: this
    ! -- local
    integer(I4B) :: indx
    !
    call this%obs%StoreObsType('esl', .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:

esl_fc()

subroutine gweeslmodule::esl_fc ( class(gweesltype)  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 162 of file gwe-esl.f90.

    ! -- dummy
    class(GweEslType) :: 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

esl_obs_supported()

logical function gweeslmodule::esl_obs_supported ( class(gweesltype)  this )

private

This function:

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

Definition at line 233 of file gwe-esl.f90.

    implicit none
    ! -- dummy
    class(GweEslType) :: this
    !
    esl_obs_supported = .true.
    !
    ! -- Return
    return

esl_rp_ts()

subroutine gweeslmodule::esl_rp_ts ( class(gweesltype), intent(inout)  this )

private

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

Definition at line 275 of file gwe-esl.f90.

    ! -- dummy
    class(GweEslType), 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) gweeslmodule::ftype = 'ESL'

private

Definition at line 18 of file gwe-esl.f90.

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

text

character(len=16) gweeslmodule::text = ' ESL'

private

Definition at line 19 of file gwe-esl.f90.

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