MODFLOW 6  version 6.5.0.dev2
MODFLOW 6 Code Documentation
budgettermmodule::budgettermtype Type Reference
Collaboration diagram for budgettermmodule::budgettermtype:
Collaboration graph

Public Member Functions

procedure initialize
 
procedure allocate_arrays
 
procedure reset
 
procedure update_term
 
procedure accumulate_flow
 
procedure save_flows
 
procedure get_nlist
 
procedure get_flowtype
 
procedure get_flow
 
procedure get_id1
 
procedure get_id2
 
procedure read_flows
 
procedure fill_from_bfr
 
procedure deallocate_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

Definition at line 42 of file BudgetTerm.f90.

◆ allocate_arrays()

procedure budgettermmodule::budgettermtype::allocate_arrays

Definition at line 39 of file BudgetTerm.f90.

◆ deallocate_arrays()

procedure budgettermmodule::budgettermtype::deallocate_arrays

Definition at line 51 of file BudgetTerm.f90.

◆ fill_from_bfr()

procedure budgettermmodule::budgettermtype::fill_from_bfr

Definition at line 50 of file BudgetTerm.f90.

◆ get_flow()

procedure budgettermmodule::budgettermtype::get_flow

Definition at line 46 of file BudgetTerm.f90.

◆ get_flowtype()

procedure budgettermmodule::budgettermtype::get_flowtype

Definition at line 45 of file BudgetTerm.f90.

◆ get_id1()

procedure budgettermmodule::budgettermtype::get_id1

Definition at line 47 of file BudgetTerm.f90.

◆ get_id2()

procedure budgettermmodule::budgettermtype::get_id2

Definition at line 48 of file BudgetTerm.f90.

◆ get_nlist()

procedure budgettermmodule::budgettermtype::get_nlist

Definition at line 44 of file BudgetTerm.f90.

◆ initialize()

procedure budgettermmodule::budgettermtype::initialize

Definition at line 38 of file BudgetTerm.f90.

◆ read_flows()

procedure budgettermmodule::budgettermtype::read_flows

Definition at line 49 of file BudgetTerm.f90.

◆ reset()

procedure budgettermmodule::budgettermtype::reset

Definition at line 40 of file BudgetTerm.f90.

◆ save_flows()

procedure budgettermmodule::budgettermtype::save_flows

Definition at line 43 of file BudgetTerm.f90.

◆ update_term()

procedure budgettermmodule::budgettermtype::update_term

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.

23  character(len=LENBUDTXT), dimension(:), pointer :: auxtxt => null() ! name of auxiliary variables

◆ auxvar

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

Definition at line 33 of file BudgetTerm.f90.

33  real(DP), dimension(:, :), pointer :: auxvar => null() ! auxiliary variables (naux, maxlist)

◆ flow

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

Definition at line 32 of file BudgetTerm.f90.

32  real(DP), dimension(:), pointer :: flow => null() ! point this to simvals or simtomvr (maxlist)

◆ 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.

30  integer(I4B), dimension(:), pointer :: id1 => null() ! first id (maxlist)

◆ id2

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

Definition at line 31 of file BudgetTerm.f90.

31  integer(I4B), dimension(:), pointer :: id2 => null() ! second id (maxlist)

◆ 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.

27  logical :: olconv1 = .false. ! convert id1 to user node upon output

◆ olconv2

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

Definition at line 28 of file BudgetTerm.f90.

28  logical :: olconv2 = .false. ! convert id2 to user node upon output

◆ 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: