apimodule Module Reference

This module contains the API package methods. More...

Data Types
type	apitype

Functions/Subroutines
subroutine, public	api_create (packobj, id, ibcnum, inunit, iout, namemodel, pakname, mempath)
	@ brief Create a new package object More...
subroutine	source_options (this)
	@ brief Source package options from input context More...
subroutine	source_dimensions (this)
	@ brief Source package dimensions from input context More...
subroutine	api_rp (this)
	@ brief Read and prepare stress period data for package More...
subroutine	api_fc (this, rhs, ia, idxglo, matrix_sln)
	@ brief Fill A and r for the package More...
logical function	api_obs_supported (this)
	Determine if observations are supported. More...
subroutine	api_df_obs (this)
	Define the observation types available in the package. More...

Variables
character(len=lenftype)	ftype = 'API'
character(len=lenpackagename)	text = ' API'

Detailed Description

This module contains the overridden methods from the base model package class for the API package. The API package is designed to be used with the shared object and have period data specified using the MODFLOW API. Several methods need to be overridden since no period data are specified in the API input file. Overridden methods include:

• bnd_rp no period data is specified
• bnd_fc BOUND array is not filled. hcof and rhs are specified dierctly

Function/Subroutine Documentation

api_create()

subroutine, public apimodule::api_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=*), intent(in)	mempath
	)

Create a new USR Package object

Parameters

	packobj	pointer to default package type
[in]	id	package id
[in]	ibcnum	boundary condition number
[in]	inunit	unit number of USR package input file
[in]	iout	unit number of model listing file
[in]	namemodel	model name
[in]	pakname	package name
[in]	mempath	input mempath

Definition at line 49 of file gwf-api.f90.

    ! -- dummy variables
    class(BndType), pointer :: packobj !< pointer to default package type
    integer(I4B), intent(in) :: id !< package id
    integer(I4B), intent(in) :: ibcnum !< boundary condition number
    integer(I4B), intent(in) :: inunit !< unit number of USR package input file
    integer(I4B), intent(in) :: iout !< unit number of model listing file
    character(len=*), intent(in) :: namemodel !< model name
    character(len=*), intent(in) :: pakname !< package name
    character(len=*), intent(in) :: mempath !< input mempath
    ! -- local variables
    type(ApiType), pointer :: apiobj
    !
    ! -- allocate the object and assign values to object variables
    allocate (apiobj)
    packobj => apiobj
    !
    ! -- create name and memory path
    call packobj%set_names(ibcnum, namemodel, pakname, ftype, mempath)
    packobj%text = text
    !
    ! -- allocate scalars
    call packobj%allocate_scalars()
    !
    ! -- initialize package
    call packobj%pack_initialize()
    !
    packobj%inunit = inunit
    packobj%iout = iout
    packobj%id = id
    packobj%ibcnum = ibcnum
    packobj%ncolbnd = 2
    packobj%iscloc = 2
    packobj%ictMemPath = create_mem_path(namemodel, 'NPF')

Here is the call graph for this function:

Here is the caller graph for this function:

api_df_obs()

subroutine apimodule::api_df_obs ( class(apitype)  this )

private

Method to define the observation types available in the USR package.

Definition at line 244 of file gwf-api.f90.

    ! -- dummy variables
    class(ApiType) :: this
    ! -- local variables
    integer(I4B) :: indx
    !
    ! -- initialize observations
    call this%obs%StoreObsType('api', .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:

api_fc()

subroutine apimodule::api_fc ( class(apitype)  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

Fill the coefficient matrix and right-hand side with the USR package terms.

Parameters

[in,out]	rhs	right-hand side vector
[in]	ia	pointer to the rows in A matrix
[in]	idxglo	position of entries in A matrix
	matrix_sln	A matrix for solution

Definition at line 189 of file gwf-api.f90.

    ! -- dummy variables
    class(ApiType) :: this
    real(DP), dimension(:), intent(inout) :: rhs !< right-hand side vector
    integer(I4B), dimension(:), intent(in) :: ia !< pointer to the rows in A matrix
    integer(I4B), dimension(:), intent(in) :: idxglo !< position of entries in A matrix
    class(MatrixBaseType), pointer :: matrix_sln !< A matrix for solution
    ! -- local variables
    integer(I4B) :: i
    integer(I4B) :: n
    integer(I4B) :: ipos
    real(DP) :: qusr
    !
    ! -- 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 this boundary is discharging,
      !    store available water (as positive value).
      qusr = this%rhs(i) - this%hcof(i) * this%xnew(n)
      if (this%imover == 1 .and. qusr > dzero) then
        call this%pakmvrobj%accumulate_qformvr(i, qusr)
      end if
    end do

api_obs_supported()

logical function apimodule::api_obs_supported ( class(apitype)  this )

private

Function to determine if observations are supported by the USR package. Observations are supported by the USR package.

Definition at line 231 of file gwf-api.f90.

    ! -- dummy variables
    class(ApiType) :: this
    !
    ! -- set variables
    api_obs_supported = .true.

api_rp()

subroutine apimodule::api_rp

(

class(apitype), intent(inout)

this

)

Method reads and prepares stress period data for the USR package. This method overrides the base read and prepare method and does not read any stress period data from the USR package input file.

Definition at line 178 of file gwf-api.f90.

    ! -- dummy variables
    class(ApiType), intent(inout) :: this

source_dimensions()

subroutine apimodule::source_dimensions

(

class(apitype), intent(inout)

this

)

Definition at line 142 of file gwf-api.f90.

    use simvariablesmodule, only: errmsg
    use simmodule, only: store_error, store_error_filename
    use memorymanagerextmodule, only: mem_set_value
    use gwfapiinputmodule, only: gwfapiparamfoundtype
    ! -- dummy variables
    class(ApiType), intent(inout) :: this
    ! -- local variables
    type(GwfApiParamFoundType) :: found
 
    ! update dimensions from input context
    call mem_set_value(this%maxbound, 'MAXBOUND', this%input_mempath, &
                       found%maxbound)
 
    ! log dimensions
    write (this%iout, '(/1x,a)') 'PROCESSING '//trim(adjustl(this%text))// &
      ' DIMENSIONS'
    write (this%iout, '(4x,a,i7)') 'MAXBOUND = ', this%maxbound
    write (this%iout, '(1x,a)') &
      'END OF '//trim(adjustl(this%text))//' DIMENSIONS'
 
    ! verify dimensions
    if (this%maxbound <= 0) then
      write (errmsg, '(a)') 'MAXBOUND must be an integer greater than zero.'
      call store_error(errmsg)
      call store_error_filename(this%input_fname)
    end if

Here is the call graph for this function:

source_options()

subroutine apimodule::source_options ( class(apitype), intent(inout)  this )

private

Definition at line 88 of file gwf-api.f90.

    use memorymanagerextmodule, only: mem_set_value
    use inputoutputmodule, only: getunit, openfile
    use sourcecommonmodule, only: filein_fname
    use gwfapiinputmodule, only: gwfapiparamfoundtype
    ! -- dummy variables
    class(ApiType), intent(inout) :: this
    type(GwfApiParamFoundType) :: found
    ! -- formats
    character(len=*), parameter :: fmtflow2 = &
      &"(4x, 'FLOWS WILL BE SAVED TO BUDGET FILE SPECIFIED IN OUTPUT CONTROL')"
 
    ! update default values from input context
    call mem_set_value(this%iprpak, 'IPRPAK', this%input_mempath, found%iprpak)
    call mem_set_value(this%iprflow, 'IPRFLOW', this%input_mempath, found%iprflow)
    call mem_set_value(this%ipakcb, 'IPAKCB', this%input_mempath, found%ipakcb)
    call mem_set_value(this%inamedbound, 'BOUNDNAMES', this%input_mempath, &
                       found%boundnames)
    call mem_set_value(this%imover, 'MOVER', this%input_mempath, found%mover)
 
    ! update internal state
    if (found%ipakcb) this%ipakcb = -1
 
    ! enforce 0 or 1 OBS6_FILENAME entries in option block
    if (filein_fname(this%obs%inputFilename, 'OBS6_FILENAME', &
                     this%input_mempath, this%input_fname)) then
      this%obs%active = .true.
      this%obs%inUnitObs = getunit()
      call openfile(this%obs%inUnitObs, this%iout, this%obs%inputFilename, 'OBS')
    end if
 
    ! log package options
    write (this%iout, '(/1x,a)') 'PROCESSING '//trim(adjustl(this%text)) &
      //' OPTIONS'
    if (found%iprpak) then
      write (this%iout, '(4x,a)') &
        'LISTS OF '//trim(adjustl(this%text))//' CELLS WILL BE PRINTED.'
    end if
    if (found%iprflow) then
      write (this%iout, '(4x,a)') trim(adjustl(this%text))// &
        ' FLOWS WILL BE PRINTED TO LISTING FILE.'
    end if
    if (found%ipakcb) write (this%iout, fmtflow2)
    if (found%boundnames) then
      write (this%iout, '(4x,a)') trim(adjustl(this%text))// &
        ' BOUNDARIES HAVE NAMES IN LAST COLUMN.'
    end if
    if (found%mover) write (this%iout, '(4x,A)') 'MOVER OPTION ENABLED'
    write (this%iout, '(1x,a)') &
      'END OF '//trim(adjustl(this%text))//' OPTIONS'

Here is the call graph for this function:

Variable Documentation

ftype

character(len=lenftype) apimodule::ftype = 'API'

private

Definition at line 28 of file gwf-api.f90.

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

text

character(len=lenpackagename) apimodule::text = ' API'

private

Definition at line 29 of file gwf-api.f90.

  character(len=LENPACKAGENAME) :: text = '             API'