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)
	@ brief Create a new package object More...
subroutine	api_options (this, option, found)
	@ brief Read additional options for package 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
	)

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

Definition at line 48 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
    ! -- 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)
    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')
    !
    ! -- return
    return

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 195 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
    !
    ! -- return
    return

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 134 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
    !
    ! -- return
    return

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 179 of file gwf-api.f90.

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

api_options()

subroutine apimodule::api_options ( class(apitype), intent(inout)  this, character(len=*), intent(inout)  option, logical, intent(inout)  found  )

private

Read additional options for USR package.

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

    ! -- dummy variables
    class(ApiType), intent(inout) :: this
    character(len=*), intent(inout) :: option
    logical, intent(inout) :: found
    !
    ! -- process package options
    select case (option)
    case ('MOVER')
      this%imover = 1
      write (this%iout, '(4x,A)') 'MOVER OPTION ENABLED'
      found = .true.
    case default
      !
      ! -- No options found
      found = .false.
    end select
    !
    ! -- return
    return

api_rp()

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

private

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 120 of file gwf-api.f90.

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

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'