budgettermmodule Module Reference

Data Types
type	budgettermtype

Functions/Subroutines
subroutine	initialize (this, flowtype, text1id1, text2id1, text1id2, text2id2, maxlist, olconv1, olconv2, naux, auxtxt, ordered_id1)
	Initialize the budget term. More...
subroutine	allocate_arrays (this)
	Allocate budget term arrays. More...
subroutine	deallocate_arrays (this)
	Deallocate budget term arrays. More...
subroutine	reset (this, nlist)
	reset the budget term and counter so terms can be updated More...
subroutine	update_term (this, id1, id2, flow, auxvar)
	replace the terms in position thisicounter for id1, id2, flow, and aux More...
subroutine	accumulate_flow (this, ratin, ratout)
	Calculate ratin and ratout for all the flow terms. More...
subroutine	save_flows (this, dis, ibinun, kstp, kper, delt, pertim, totim, iout)
	Write flows to a binary file. More...
integer(i4b) function	get_nlist (this)
	Get the number of entries for the stress period. More...
character(len=lenbudtxt) function	get_flowtype (this)
	Get the flowtype for the budget term. More...
integer(i4b) function	get_id1 (this, icount)
	Get id1(icount) for the budget term. More...
integer(i4b) function	get_id2 (this, icount)
	Get id2(icount) for the budget term. More...
real(dp) function	get_flow (this, icount)
	Get flow(icount) for the budget term. More...
subroutine	read_flows (this, dis, ibinun, kstp, kper, delt, pertim, totim)
	Read flows from a binary file. More...
subroutine	fill_from_bfr (this, bfr, dis)
	Copy the flow from the binary file reader into this budterm. More...

Function/Subroutine Documentation

accumulate_flow()

subroutine budgettermmodule::accumulate_flow	(	class(budgettermtype)	this,
		real(dp), intent(inout)	ratin,
		real(dp), intent(inout)	ratout
	)

Definition at line 153 of file BudgetTerm.f90.

    ! -- dummy
    class(BudgetTermType) :: this
    real(DP), intent(inout) :: ratin
    real(DP), intent(inout) :: ratout
    ! -- local
    integer(I4B) :: i
    real(DP) :: q
    !
    ratin = dzero
    ratout = dzero
    do i = 1, this%nlist
      q = this%flow(i)
      if (q < dzero) then
        ratout = ratout - q
      else
        ratin = ratin + q
      end if
    end do
    !

allocate_arrays()

subroutine budgettermmodule::allocate_arrays

(

class(budgettermtype)

this

)

Definition at line 95 of file BudgetTerm.f90.

    ! -- dummy
    class(BudgetTermType) :: this
    !
    allocate (this%id1(this%maxlist))
    allocate (this%id2(this%maxlist))
    allocate (this%flow(this%maxlist))
    allocate (this%auxvar(this%naux, this%maxlist))
    allocate (this%auxtxt(this%naux))
    !

deallocate_arrays()

subroutine budgettermmodule::deallocate_arrays

(

class(budgettermtype)

this

)

Definition at line 109 of file BudgetTerm.f90.

    ! -- dummy
    class(BudgetTermType) :: this
    !
    deallocate (this%id1)
    deallocate (this%id2)
    deallocate (this%flow)
    deallocate (this%auxvar)
    deallocate (this%auxtxt)

fill_from_bfr()

subroutine budgettermmodule::fill_from_bfr	(	class(budgettermtype)	this,
		type(budgetfilereadertype)	bfr,
		class(disbasetype), intent(in)	dis
	)

Definition at line 364 of file BudgetTerm.f90.

    ! -- modules
    use budgetfilereadermodule, only: budgetfilereadertype
    ! -- dummy
    class(BudgetTermType) :: this
    type(BudgetFileReaderType) :: bfr
    class(DisBaseType), intent(in) :: dis
    ! -- local
    integer(I4B) :: i
    integer(I4B) :: n1
    integer(I4B) :: n2
    real(DP) :: q
    !
    this%flowtype = bfr%budtxt
    this%text1id1 = bfr%srcmodelname
    this%text2id1 = bfr%srcpackagename
    this%text1id2 = bfr%dstmodelname
    this%text2id2 = bfr%dstpackagename
    this%naux = bfr%naux
    !
    if (.not. associated(this%auxtxt)) then
      allocate (this%auxtxt(this%naux))
    else
      if (size(this%auxtxt) /= this%naux) then
        deallocate (this%auxtxt)
        allocate (this%auxtxt(this%naux))
      end if
    end if
    !
    if (this%naux > 0) this%auxtxt(:) = bfr%auxtxt(:)
    this%nlist = bfr%nlist
    if (.not. associated(this%id1)) then
      this%maxlist = this%nlist
      allocate (this%id1(this%maxlist))
      allocate (this%id2(this%maxlist))
      allocate (this%flow(this%maxlist))
      allocate (this%auxvar(this%naux, this%maxlist))
    else
      if (this%nlist > this%maxlist) then
        this%maxlist = this%nlist
        deallocate (this%id1)
        deallocate (this%id2)
        deallocate (this%flow)
        deallocate (this%auxvar)
        allocate (this%id1(this%maxlist))
        allocate (this%id2(this%maxlist))
        allocate (this%flow(this%maxlist))
        allocate (this%auxvar(this%naux, this%maxlist))
      end if
    end if
    !
    do i = 1, this%nlist
      n1 = bfr%nodesrc(i)
      n2 = bfr%nodedst(i)
      q = bfr%flow(i)
      this%auxvar(:, i) = bfr%auxvar(:, i)
      if (this%olconv1) n1 = dis%get_nodenumber(n1, 0)
      if (this%olconv2) n2 = dis%get_nodenumber(n2, 0)
      this%id1(i) = n1
      this%id2(i) = n2
      this%flow(i) = q
    end do
    !

get_flow()

real(dp) function budgettermmodule::get_flow	(	class(budgettermtype)	this,
		integer(i4b), intent(in)	icount
	)

Definition at line 279 of file BudgetTerm.f90.

    ! -- return
    real(DP) :: flow
    ! -- dummy
    class(BudgetTermType) :: this
    integer(I4B), intent(in) :: icount
    !
    flow = this%flow(icount)
    !

get_flowtype()

character(len=lenbudtxt) function budgettermmodule::get_flowtype

(

class(budgettermtype)

this

)

Definition at line 241 of file BudgetTerm.f90.

    ! -- dummy
    class(BudgetTermType) :: this
    ! -- return
    character(len=LENBUDTXT) :: flowtype
    !
    flowtype = this%flowtype
    !

get_id1()

integer(i4b) function budgettermmodule::get_id1	(	class(budgettermtype)	this,
		integer(i4b), intent(in)	icount
	)

Definition at line 253 of file BudgetTerm.f90.

    ! -- dummy
    class(BudgetTermType) :: this
    integer(I4B), intent(in) :: icount
    ! -- return
    integer(I4B) :: id1
    !
    id1 = this%id1(icount)
    !

get_id2()

integer(i4b) function budgettermmodule::get_id2	(	class(budgettermtype)	this,
		integer(i4b), intent(in)	icount
	)

Definition at line 266 of file BudgetTerm.f90.

    ! -- return
    integer(I4B) :: id2
    ! -- dummy
    class(BudgetTermType) :: this
    integer(I4B), intent(in) :: icount
    !
    id2 = this%id2(icount)
    !

get_nlist()

integer(i4b) function budgettermmodule::get_nlist

(

class(budgettermtype)

this

)

Definition at line 229 of file BudgetTerm.f90.

    ! -- dummy
    class(BudgetTermType) :: this
    ! -- return
    integer(I4B) :: nlist
    !
    nlist = this%nlist
    !

initialize()

subroutine budgettermmodule::initialize	(	class(budgettermtype)	this,
		character(len=lenbudtxt), intent(in)	flowtype,
		character(len=lenbudtxt), intent(in)	text1id1,
		character(len=lenbudtxt), intent(in)	text2id1,
		character(len=lenbudtxt), intent(in)	text1id2,
		character(len=lenbudtxt), intent(in)	text2id2,
		integer(i4b), intent(in)	maxlist,
		logical, intent(in)	olconv1,
		logical, intent(in)	olconv2,
		integer(i4b), intent(in)	naux,
		character(len=lenbudtxt), dimension(:), intent(in), optional	auxtxt,
		logical, intent(in), optional	ordered_id1
	)

Definition at line 59 of file BudgetTerm.f90.

    ! -- dummy
    class(BudgetTermType) :: this
    character(len=LENBUDTXT), intent(in) :: flowtype
    character(len=LENBUDTXT), intent(in) :: text1id1
    character(len=LENBUDTXT), intent(in) :: text2id1
    character(len=LENBUDTXT), intent(in) :: text1id2
    character(len=LENBUDTXT), intent(in) :: text2id2
    integer(I4B), intent(in) :: maxlist
    logical, intent(in) :: olconv1
    logical, intent(in) :: olconv2
    integer(I4B), intent(in) :: naux
    character(len=LENBUDTXT), dimension(:), intent(in), optional :: auxtxt
    logical, intent(in), optional :: ordered_id1
    !
    this%flowtype = flowtype
    this%text1id1 = text1id1
    this%text2id1 = text2id1
    this%text1id2 = text1id2
    this%text2id2 = text2id2
    this%maxlist = maxlist
    this%olconv1 = olconv1
    this%olconv2 = olconv2
    this%naux = naux
    this%nlist = 0
    call this%allocate_arrays()
    if (present(auxtxt)) this%auxtxt(:) = auxtxt(1:naux)
    this%ordered_id1 = .true.
    if (present(ordered_id1)) this%ordered_id1 = ordered_id1
    !

read_flows()

subroutine budgettermmodule::read_flows	(	class(budgettermtype)	this,
		class(disbasetype), intent(in)	dis,
		integer(i4b), intent(in)	ibinun,
		integer(i4b), intent(inout)	kstp,
		integer(i4b), intent(inout)	kper,
		real(dp), intent(inout)	delt,
		real(dp), intent(inout)	pertim,
		real(dp), intent(inout)	totim
	)

Definition at line 292 of file BudgetTerm.f90.

    ! -- dummy
    class(BudgetTermType) :: this
    class(DisBaseType), intent(in) :: dis
    integer(I4B), intent(in) :: ibinun
    integer(I4B), intent(inout) :: kstp
    integer(I4B), intent(inout) :: kper
    real(DP), intent(inout) :: delt
    real(DP), intent(inout) :: pertim
    real(DP), intent(inout) :: totim
    ! -- local
    integer(I4B) :: idum1, idum2, imeth
    integer(I4B) :: i, j
    integer(I4B) :: n1
    integer(I4B) :: n2
    real(DP) :: q
    !
    read (ibinun) kstp, kper, this%flowtype, this%nlist, idum1, idum2
    read (ibinun) imeth, delt, pertim, totim
    read (ibinun) this%text1id1
    read (ibinun) this%text2id1
    read (ibinun) this%text1id2
    read (ibinun) this%text2id2
    read (ibinun) this%naux
    this%naux = this%naux - 1
    if (.not. associated(this%auxtxt)) then
      allocate (this%auxtxt(this%naux))
    else
      if (size(this%auxtxt) /= this%naux) then
        deallocate (this%auxtxt)
        allocate (this%auxtxt(this%naux))
      end if
    end if
    !
    if (this%naux > 0) read (ibinun) (this%auxtxt(j), j=1, this%naux)
    read (ibinun) this%nlist
    if (.not. associated(this%id1)) then
      this%maxlist = this%nlist
      allocate (this%id1(this%maxlist))
      allocate (this%id2(this%maxlist))
      allocate (this%flow(this%maxlist))
      allocate (this%auxvar(this%naux, this%maxlist))
    else
      if (this%nlist > this%maxlist) then
        this%maxlist = this%nlist
        deallocate (this%id1)
        deallocate (this%id2)
        deallocate (this%flow)
        deallocate (this%auxvar)
        allocate (this%id1(this%maxlist))
        allocate (this%id2(this%maxlist))
        allocate (this%flow(this%maxlist))
        allocate (this%auxvar(this%naux, this%maxlist))
      end if
    end if
    !
    do i = 1, this%nlist
      read (ibinun) n1
      read (ibinun) n2
      read (ibinun) q
      read (ibinun) (this%auxvar(j, i), j=1, this%naux)
      if (this%olconv1) n1 = dis%get_nodenumber(n1, 0)
      if (this%olconv2) n2 = dis%get_nodenumber(n2, 0)
      this%id1(i) = n1
      this%id2(i) = n2
      this%flow(i) = q
    end do
    !

reset()

subroutine budgettermmodule::reset	(	class(budgettermtype)	this,
		integer(i4b), intent(in)	nlist
	)

Definition at line 122 of file BudgetTerm.f90.

    ! -- dummy
    class(BudgetTermType) :: this
    integer(I4B), intent(in) :: nlist
    !
    this%nlist = nlist
    this%icounter = 1
    !

save_flows()

subroutine budgettermmodule::save_flows	(	class(budgettermtype)	this,
		class(disbasetype), intent(in)	dis,
		integer(i4b), intent(in)	ibinun,
		integer(i4b), intent(in)	kstp,
		integer(i4b), intent(in)	kper,
		real(dp), intent(in)	delt,
		real(dp), intent(in)	pertim,
		real(dp), intent(in)	totim,
		integer(i4b), intent(in)	iout
	)

Definition at line 177 of file BudgetTerm.f90.

    ! -- dummy
    class(BudgetTermType) :: this
    class(DisBaseType), intent(in) :: dis
    integer(I4B), intent(in) :: ibinun
    integer(I4B), intent(in) :: kstp
    integer(I4B), intent(in) :: kper
    real(DP), intent(in) :: delt
    real(DP), intent(in) :: pertim
    real(DP), intent(in) :: totim
    integer(I4B), intent(in) :: iout
    ! -- local
    integer(I4B) :: nlist
    integer(I4B) :: i
    integer(I4B) :: n1
    integer(I4B) :: n2
    real(DP) :: q
    !
    ! -- Count the size of the list and exclude ids less than or equal to zero
    nlist = 0
    do i = 1, this%nlist
      n1 = this%id1(i)
      n2 = this%id2(i)
      if (n1 <= 0 .or. n2 <= 0) cycle
      nlist = nlist + 1
    end do
    !
    ! -- Write the header
    call ubdsv06(kstp, kper, this%flowtype, &
                 this%text1id1, this%text2id1, &
                 this%text1id2, this%text2id2, &
                 ibinun, this%naux, this%auxtxt, &
                 nlist, 1, 1, nlist, &
                 iout, delt, pertim, totim)
    !
    ! -- Write each entry
    do i = 1, this%nlist
      q = this%flow(i)
      n1 = this%id1(i)
      n2 = this%id2(i)
      if (n1 <= 0 .or. n2 <= 0) cycle
      call dis%record_mf6_list_entry(ibinun, n1, n2, q, &
                                     this%naux, this%auxvar(:, i), &
                                     olconv=this%olconv1, &
                                     olconv2=this%olconv2)
    end do
    !

Here is the call graph for this function:

update_term()

subroutine budgettermmodule::update_term	(	class(budgettermtype)	this,
		integer(i4b), intent(in)	id1,
		integer(i4b), intent(in)	id2,
		real(dp), intent(in)	flow,
		real(dp), dimension(:), intent(in), optional	auxvar
	)

Definition at line 135 of file BudgetTerm.f90.

    ! -- dummy
    class(BudgetTermType) :: this
    integer(I4B), intent(in) :: id1
    integer(I4B), intent(in) :: id2
    real(DP), intent(in) :: flow
    real(DP), dimension(:), intent(in), optional :: auxvar
    !
    this%id1(this%icounter) = id1
    this%id2(this%icounter) = id2
    this%flow(this%icounter) = flow
    if (present(auxvar)) this%auxvar(:, this%icounter) = auxvar(1:this%naux)
    this%icounter = this%icounter + 1
    !