gweeslmodule Module Reference

Data Types
type	gweesltype

Functions/Subroutines
subroutine, public	esl_create (packobj, id, ibcnum, inunit, iout, namemodel, pakname, gwecommon, input_mempath)
	Create an energy source loading package. More...
subroutine	esl_da (this)
	Deallocate memory. More...
subroutine	esl_allocate_scalars (this)
	Allocate scalars. More...
subroutine	esl_allocate_arrays (this, nodelist, auxvar)
	Allocate arrays. More...
subroutine	esl_ck (this)
	Check energy source loading boundary condition data. 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...
real(dp) function	esl_bound_value (this, col, row)
	@ brief Return a bound value More...
real(dp) function	ener_mult (this, row)
	Return a value that applies a multiplier. 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 244 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

ener_mult()

real(dp) function gweeslmodule::ener_mult	(	class(gweesltype), intent(inout)	this,
		integer(i4b), intent(in)	row
	)

Apply multiplier to specified energy load depending on user-selected option

Parameters

[in,out]

this

BndExtType object

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

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

esl_allocate_arrays()

subroutine gweeslmodule::esl_allocate_arrays	(	class(gweesltype)	this,
		integer(i4b), dimension(:), optional, pointer, contiguous	nodelist,
		real(dp), dimension(:, :), optional, pointer, contiguous	auxvar
	)

Parameters

nodelist	package nodelist
auxvar	package aux variable array

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

    use memorymanagermodule, only: mem_setptr, mem_checkin
    ! -- dummy
    class(GweEslType) :: this
    ! -- local
    integer(I4B), dimension(:), pointer, contiguous, optional :: nodelist !< package nodelist
    real(DP), dimension(:, :), pointer, contiguous, optional :: auxvar !< package aux variable array
 
    ! -- base class allocate arrays
    call this%BndExtType%allocate_arrays(nodelist, auxvar)
 
    ! -- set input context pointers
    call mem_setptr(this%senerrate, 'SENERRATE', this%input_mempath)
    !
    ! -- checkin input context pointers
    call mem_checkin(this%senerrate, 'SENERRATE', this%memoryPath, &
                     'SENERRATE', this%input_mempath)

esl_allocate_scalars()

subroutine gweeslmodule::esl_allocate_scalars

(

class(gweesltype)

this

)

Allocate scalars specific to this energy source loading package

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

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

esl_bound_value()

real(dp) function gweeslmodule::esl_bound_value ( class(gweesltype), 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 309 of file gwe-esl.f90.

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

esl_cf()

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

private

This subroutine:

• calculates hcof and rhs terms
• skip if no sources

Definition at line 179 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
      !
      ! -- set energy loading rate accounting for multiplier
      q = this%ener_mult(i)
      !
      this%rhs(i) = -q
    end do

esl_ck()

subroutine gweeslmodule::esl_ck

(

class(gweesltype), intent(inout)

this

)

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

    ! -- dummy
    class(GweEslType), intent(inout) :: this
    ! -- local
    integer(I4B) :: i
    integer(I4B) :: node
    ! -- formats
    character(len=*), parameter :: fmtenermulterr = &
      "('ESL BOUNDARY (',i0,') ESL MULTIPLIER (',g10.3,') IS &
      &LESS THAN ZERO THEREBY REVERSING THE ORIGINAL SIGN ON THE &
      &AMOUNT OF ENERGY ENTERING OR EXITING THE MODEL.')"
    !
    ! -- check stress period data
    do i = 1, this%nbound
      node = this%nodelist(i)
      !
      ! -- accumulate warnings
      if (this%iauxmultcol > 0) then
        if (this%auxvar(this%iauxmultcol, i) < dzero) then
          write (warnmsg, fmt=fmtenermulterr) &
            i, this%auxvar(this%iauxmultcol, i)
          call store_warning(warnmsg)
          write (this%iout, '(/1x,a)') 'WARNING: '//trim(warnmsg)
        end if
      end if
    end do

Here is the call graph for this function:

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,
		character(len=*), intent(in)	input_mempath
	)

This subroutine points bndobj to the newly created package

Parameters

[in]

gwecommon

shared data container for use by multiple GWE packages

Definition at line 48 of file gwe-esl.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
    type(GweInputDataType), intent(in), target :: gwecommon !< shared data container for use by multiple GWE packages
    character(len=*), intent(in) :: input_mempath
    ! -- 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, input_mempath)
    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

Here is the caller graph for this function:

esl_da()

subroutine gweeslmodule::esl_da

(

class(gweesltype)

this

)

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

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

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

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

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 274 of file gwe-esl.f90.

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

Variable Documentation

ftype

character(len=lenftype) gweeslmodule::ftype = 'ESL'

private

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

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

text

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

private

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

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