packagebudgetmodule Module Reference

This module contains the PackageBudgetModule Module. More...

Data Types
type	packagebudgettype
	Derived type for storing flows. More...

Functions/Subroutines
subroutine	initialize (this, mempath)
	@ brief Initialize a PackageBudgetType object More...
subroutine	set_name (this, name, budtxt)
	@ brief Set names for this PackageBudgetType object More...
subroutine	set_auxname (this, naux, auxname)
	@ brief Set aux names for this PackageBudgetType object More...
subroutine	set_pointers (this, flowvarname, mem_path_target, input_mempath)
	@ brief Point members of this class to data stored in GWF packages More...
subroutine	copy_values (this, nbound, nodelist, flow, auxvar)
	@ brief Copy data read from a budget file into this object More...
real(dp) function	get_flow (this, i)
	@ brief Get flow rate for specified entry More...
subroutine	da (this)
	@ brief Deallocate More...

Detailed Description

The PackageBudgetType object defined here provides flows to the GWT model. The PackageBudgetType can be filled with flows from a budget object that was written from a previous GWF simulation, or its individual members can be pointed to flows that are being calculated by a GWF model that is running as part of this simulation.

Function/Subroutine Documentation

copy_values()

subroutine packagebudgetmodule::copy_values	(	class(packagebudgettype)	this,
		integer(i4b), intent(in)	nbound,
		integer(i4b), dimension(:), intent(in), contiguous	nodelist,
		real(dp), dimension(:), intent(in), contiguous	flow,
		real(dp), dimension(:, :), intent(in), contiguous	auxvar
	)

The routine is called when GWF flows are read from a budget file created from a previous GWF simulation. Arrays here must be dynamically resized because maxbound is not known unless the entire budget file was read first.

Parameters

	this	PackageBudgetType object
[in]	nbound	number of entries
[in]	nodelist	array of GWT node numbers
[in]	flow	array of flow rates
[in]	auxvar	array of auxiliary variables

Definition at line 158 of file PackageBudget.f90.

    class(PackageBudgetType) :: this !< PackageBudgetType object
    integer(I4B), intent(in) :: nbound !< number of entries
    integer(I4B), dimension(:), contiguous, intent(in) :: nodelist !< array of GWT node numbers
    real(DP), dimension(:), contiguous, intent(in) :: flow !< array of flow rates
    real(DP), dimension(:, :), contiguous, intent(in) :: auxvar !< array of auxiliary variables
    integer(I4B) :: i
    !
    ! -- Assign variables
    this%nbound = nbound
    !
    ! -- Lists are not large enough (maxbound is not known), so need to
    !    reallocate based on size in binary budget file.
    if (size(this%nodelist) < nbound) then
      call mem_reallocate(this%nodelist, nbound, 'NODELIST', this%memoryPath)
      call mem_reallocate(this%flow, nbound, 'FLOW', this%memoryPath)
      call mem_reallocate(this%auxvar, this%naux, nbound, 'AUXVAR', &
                          this%memoryPath)
    end if
    !
    ! -- Copy values into member variables
    do i = 1, nbound
      this%nodelist(i) = nodelist(i)
      this%flow(i) = flow(i)
      this%auxvar(:, i) = auxvar(:, i)
    end do

da()

subroutine packagebudgetmodule::da ( class(packagebudgettype)  this )

private

Free any memory associated with this object

Definition at line 204 of file PackageBudget.f90.

    class(PackageBudgetType) :: this
    call mem_deallocate(this%name, 'NAME', this%memoryPath)
    call mem_deallocate(this%budtxt, 'BUDTXT', this%memoryPath)
    call mem_deallocate(this%naux)
    call mem_deallocate(this%auxname, 'AUXNAME', this%memoryPath)
    call mem_deallocate(this%nbound)
    call mem_deallocate(this%nodelist, 'NODELIST', this%memoryPath)
    call mem_deallocate(this%flow, 'FLOW', this%memoryPath)
    call mem_deallocate(this%auxvar, 'AUXVAR', this%memoryPath)
    return

get_flow()

real(dp) function packagebudgetmodule::get_flow ( class(packagebudgettype)  this, integer(i4b), intent(in)  i  )

private

Return the flow rate for the specified entry

Parameters

	this	PackageBudgetType object
[in]	i	entry number

Definition at line 191 of file PackageBudget.f90.

    class(PackageBudgetType) :: this !< PackageBudgetType object
    integer(I4B), intent(in) :: i !< entry number
    real(DP) :: flow
    flow = this%flow(i)
    return

initialize()

subroutine packagebudgetmodule::initialize ( class(packagebudgettype)  this, character(len=*), intent(in)  mempath  )

private

Establish the memory path and allocate and initialize member variables.

Parameters

	this	PackageBudgetType object
[in]	mempath	memory path in memory manager

Definition at line 59 of file PackageBudget.f90.

    class(PackageBudgetType) :: this !< PackageBudgetType object
    character(len=*), intent(in) :: mempath !< memory path in memory manager
    this%memoryPath = mempath
    !
    ! -- allocate member variables in memory manager
    call mem_allocate(this%name, lenpackagename, 'NAME', mempath)
    call mem_allocate(this%budtxt, lenpackagename, 'BUDTXT', mempath)
    call mem_allocate(this%naux, 'NAUX', mempath)
    call mem_allocate(this%auxname, lenauxname, 0, 'AUXNAME', this%memoryPath)
    call mem_allocate(this%nbound, 'NBOUND', mempath)
    call mem_allocate(this%nodelist, 0, 'NODELIST', mempath)
    call mem_allocate(this%flow, 0, 'FLOW', mempath)
    call mem_allocate(this%auxvar, 0, 0, 'AUXVAR', mempath)
    !
    ! -- initialize
    this%name = ''
    this%budtxt = ''
    this%naux = 0
    this%nbound = 0
    return

set_auxname()

subroutine packagebudgetmodule::set_auxname ( class(packagebudgettype)  this, integer(i4b), intent(in)  naux, character(len=lenauxname), dimension(:), intent(in), contiguous  auxname  )

private

Set the number of auxiliary variables and the names of the auxiliary variables

Parameters

	this	PackageBudgetType object
[in]	naux	number of auxiliary variables
[in]	auxname	array of names for auxiliary variables

Definition at line 102 of file PackageBudget.f90.

    class(PackageBudgetType) :: this !< PackageBudgetType object
    integer(I4B), intent(in) :: naux !< number of auxiliary variables
    character(len=LENAUXNAME), contiguous, &
      dimension(:), intent(in) :: auxname !< array of names for auxiliary variables
    this%naux = naux
    call mem_reallocate(this%auxname, lenauxname, naux, 'AUXNAME', &
                        this%memoryPath)
    this%auxname(:) = auxname(:)
    return

set_name()

subroutine packagebudgetmodule::set_name ( class(packagebudgettype)  this, character(len=lenpackagename)  name, character(len=lenpackagename)  budtxt  )

private

Set the name of the package and the name of the of budget text

Parameters

this	PackageBudgetType object
name	name of the package (WEL-1, DRN-4, etc.)
budtxt	name of budget term (CHD, RCH, EVT, DRN-TO-MVR, etc.)

Definition at line 87 of file PackageBudget.f90.

    class(PackageBudgetType) :: this !< PackageBudgetType object
    character(len=LENPACKAGENAME) :: name !< name of the package (WEL-1, DRN-4, etc.)
    character(len=LENPACKAGENAME) :: budtxt !< name of budget term (CHD, RCH, EVT, DRN-TO-MVR, etc.)
    this%name = name
    this%budtxt = budtxt
    return

set_pointers()

subroutine packagebudgetmodule::set_pointers ( class(packagebudgettype)  this, character(len=*), intent(in)  flowvarname, character(len=*), intent(in)  mem_path_target, character(len=*), intent(in)  input_mempath  )

private

The routine is called when a GWF model is being run concurrently with a GWT model. In this situation, the member variables NBOUND, NODELIST, FLOW, and AUXVAR are pointed into member variables of the individual GWF Package members stored in BndType.

Parameters

	this	PackageBudgetType object
[in]	flowvarname	name of variable storing flow (SIMVALS, SIMTOMVR)
[in]	mem_path_target	path where target variable is stored

Definition at line 122 of file PackageBudget.f90.

    use constantsmodule, only: lenvarname
    class(PackageBudgetType) :: this !< PackageBudgetType object
    character(len=*), intent(in) :: flowvarname !< name of variable storing flow (SIMVALS, SIMTOMVR)
    character(len=*), intent(in) :: mem_path_target !< path where target variable is stored
    character(len=*), intent(in) :: input_mempath
    character(len=LENVARNAME) :: auxvarname
    !
    ! -- set memory manager aux varname
    if (input_mempath /= '') then
      auxvarname = 'AUXVAR_IDM'
    else
      auxvarname = 'AUXVAR'
    end if
    !
    ! -- Reassign pointers to variables in the flow model
    call mem_reassignptr(this%nbound, 'NBOUND', this%memoryPath, &
                         'NBOUND', mem_path_target)
    call mem_reassignptr(this%nodelist, 'NODELIST', this%memoryPath, &
                         'NODELIST', mem_path_target)
    call mem_reassignptr(this%flow, 'FLOW', this%memoryPath, &
                         flowvarname, mem_path_target)
    call mem_reassignptr(this%auxvar, 'AUXVAR', this%memoryPath, &
                         auxvarname, mem_path_target)
    !
    return