MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
budgettermmodule::budgettermtype Type Reference
Collaboration diagram for budgettermmodule::budgettermtype:
Collaboration graph

Public Member Functions

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

Public Attributes

character(len=lenbudtxt) flowtype
character(len=lenbudtxt) text1id1
character(len=lenbudtxt) text2id1
character(len=lenbudtxt) text1id2
character(len=lenbudtxt) text2id2
character(len=lenbudtxt), dimension(:), pointer auxtxt => null()
integer(i4b) maxlist
integer(i4b) naux
integer(i4b) nlist
logical olconv1 = .false.
logical olconv2 = .false.
logical ordered_id1
integer(i4b), dimension(:), pointer id1 => null()
integer(i4b), dimension(:), pointer id2 => null()
real(dp), dimension(:), pointer flow => null()
real(dp), dimension(:, :), pointer auxvar => null()
integer(i4b) icounter

Detailed Description

Definition at line 16 of file BudgetTerm.f90.

Member Function/Subroutine Documentation

◆ accumulate_flow()

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

Definition at line 42 of file BudgetTerm.f90.

◆ allocate_arrays()

procedure budgettermmodule::budgettermtype::allocate_arrays ( class(budgettermtype) this)

Definition at line 39 of file BudgetTerm.f90.

◆ deallocate_arrays()

procedure budgettermmodule::budgettermtype::deallocate_arrays ( class(budgettermtype) this)

Definition at line 51 of file BudgetTerm.f90.

◆ fill_from_bfr()

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

Definition at line 50 of file BudgetTerm.f90.

◆ get_flow()

procedure budgettermmodule::budgettermtype::get_flow ( class(budgettermtype) this,
integer(i4b), intent(in) icount )

Definition at line 46 of file BudgetTerm.f90.

◆ get_flowtype()

procedure budgettermmodule::budgettermtype::get_flowtype ( class(budgettermtype) this)

Definition at line 45 of file BudgetTerm.f90.

◆ get_id1()

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

Definition at line 47 of file BudgetTerm.f90.

◆ get_id2()

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

Definition at line 48 of file BudgetTerm.f90.

◆ get_nlist()

procedure budgettermmodule::budgettermtype::get_nlist ( class(budgettermtype) this)

Definition at line 44 of file BudgetTerm.f90.

◆ initialize()

procedure budgettermmodule::budgettermtype::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 38 of file BudgetTerm.f90.

◆ read_flows()

procedure budgettermmodule::budgettermtype::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 49 of file BudgetTerm.f90.

◆ reset()

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

Definition at line 40 of file BudgetTerm.f90.

◆ save_flows()

procedure budgettermmodule::budgettermtype::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 43 of file BudgetTerm.f90.

◆ update_term()

procedure budgettermmodule::budgettermtype::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 41 of file BudgetTerm.f90.

Member Data Documentation

◆ auxtxt

character(len=lenbudtxt), dimension(:), pointer budgettermmodule::budgettermtype::auxtxt => null()

Definition at line 23 of file BudgetTerm.f90.

◆ auxvar

real(dp), dimension(:, :), pointer budgettermmodule::budgettermtype::auxvar => null()

Definition at line 33 of file BudgetTerm.f90.

◆ flow

real(dp), dimension(:), pointer budgettermmodule::budgettermtype::flow => null()

Definition at line 32 of file BudgetTerm.f90.

◆ flowtype

character(len=lenbudtxt) budgettermmodule::budgettermtype::flowtype

Definition at line 18 of file BudgetTerm.f90.

18 character(len=LENBUDTXT) :: flowtype ! type of flow (WEL, DRN, ...)

◆ icounter

integer(i4b) budgettermmodule::budgettermtype::icounter

Definition at line 34 of file BudgetTerm.f90.

34 integer(I4B) :: icounter ! counter variable

◆ id1

integer(i4b), dimension(:), pointer budgettermmodule::budgettermtype::id1 => null()

Definition at line 30 of file BudgetTerm.f90.

◆ id2

integer(i4b), dimension(:), pointer budgettermmodule::budgettermtype::id2 => null()

Definition at line 31 of file BudgetTerm.f90.

◆ maxlist

integer(i4b) budgettermmodule::budgettermtype::maxlist

Definition at line 24 of file BudgetTerm.f90.

24 integer(I4B) :: maxlist ! allocated size of arrays

◆ naux

integer(i4b) budgettermmodule::budgettermtype::naux

Definition at line 25 of file BudgetTerm.f90.

25 integer(I4B) :: naux ! number of auxiliary variables

◆ nlist

integer(i4b) budgettermmodule::budgettermtype::nlist

Definition at line 26 of file BudgetTerm.f90.

26 integer(I4B) :: nlist ! size of arrays for this period

◆ olconv1

logical budgettermmodule::budgettermtype::olconv1 = .false.

Definition at line 27 of file BudgetTerm.f90.

◆ olconv2

logical budgettermmodule::budgettermtype::olconv2 = .false.

Definition at line 28 of file BudgetTerm.f90.

◆ ordered_id1

logical budgettermmodule::budgettermtype::ordered_id1

Definition at line 29 of file BudgetTerm.f90.

29 logical :: ordered_id1 ! the id1 array is ordered sequentially

◆ text1id1

character(len=lenbudtxt) budgettermmodule::budgettermtype::text1id1

Definition at line 19 of file BudgetTerm.f90.

19 character(len=LENBUDTXT) :: text1id1 ! model

◆ text1id2

character(len=lenbudtxt) budgettermmodule::budgettermtype::text1id2

Definition at line 21 of file BudgetTerm.f90.

21 character(len=LENBUDTXT) :: text1id2 ! package/model

◆ text2id1

character(len=lenbudtxt) budgettermmodule::budgettermtype::text2id1

Definition at line 20 of file BudgetTerm.f90.

20 character(len=LENBUDTXT) :: text2id1 ! to model

◆ text2id2

character(len=lenbudtxt) budgettermmodule::budgettermtype::text2id2

Definition at line 22 of file BudgetTerm.f90.

22 character(len=LENBUDTXT) :: text2id2 ! to package/model

The documentation for this type was generated from the following file: