MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
packagebudgetmodule::packagebudgettype Type Reference

Derived type for storing flows. More...

Collaboration diagram for packagebudgetmodule::packagebudgettype:
Collaboration graph

Public Member Functions

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

Public Attributes

character(len=lenmempath) memorypath = ''
 the location in the memory manager where the variables are stored
character(len=lenpackagename), pointer name => null()
 name of the package
character(len=lenpackagename), pointer budtxt => null()
 type of flow (CHD, RCH, RCHA, ...)
character(len=lenauxname), dimension(:), pointer, contiguous auxname => null()
 vector of auxname
integer(i4b), pointer naux => null()
 number of auxiliary variables
integer(i4b), pointer nbound => null()
 number of boundaries for current stress period
integer(i4b), dimension(:), pointer, contiguous nodelist => null()
 vector of reduced node numbers
real(dp), dimension(:), pointer, contiguous flow => null()
 calculated flow
real(dp), dimension(:, :), pointer, contiguous auxvar => null()
 auxiliary variable array

Detailed Description

This derived type stores flows and provides them through the FMI package to other parts of GWT.

Definition at line 27 of file PackageBudget.f90.

Member Function/Subroutine Documentation

◆ copy_values()

procedure packagebudgetmodule::packagebudgettype::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
thisPackageBudgetType object
[in]nboundnumber of entries
[in]nodelistarray of GWT node numbers
[in]flowarray of flow rates
[in]auxvararray of auxiliary variables

Definition at line 46 of file PackageBudget.f90.

◆ da()

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

Free any memory associated with this object

Definition at line 48 of file PackageBudget.f90.

◆ get_flow()

procedure packagebudgetmodule::packagebudgettype::get_flow ( class(packagebudgettype) this,
integer(i4b), intent(in) i )

Return the flow rate for the specified entry

Parameters
thisPackageBudgetType object
[in]ientry number

Definition at line 47 of file PackageBudget.f90.

◆ initialize()

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

Establish the memory path and allocate and initialize member variables.

Parameters
thisPackageBudgetType object
[in]mempathmemory path in memory manager

Definition at line 42 of file PackageBudget.f90.

◆ set_auxname()

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

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

Parameters
thisPackageBudgetType object
[in]nauxnumber of auxiliary variables
[in]auxnamearray of names for auxiliary variables

Definition at line 44 of file PackageBudget.f90.

◆ set_name()

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

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

Parameters
thisPackageBudgetType object
namename of the package (WEL-1, DRN-4, etc.)
budtxtname of budget term (CHD, RCH, EVT, DRN-TO-MVR, etc.)

Definition at line 43 of file PackageBudget.f90.

◆ set_pointers()

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

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
thisPackageBudgetType object
[in]flowvarnamename of variable storing flow (SIMVALS, SIMTOMVR)
[in]mem_path_targetpath where target variable is stored

Definition at line 45 of file PackageBudget.f90.

Member Data Documentation

◆ auxname

character(len=lenauxname), dimension(:), pointer, contiguous packagebudgetmodule::packagebudgettype::auxname => null()

Definition at line 32 of file PackageBudget.f90.

◆ auxvar

real(dp), dimension(:, :), pointer, contiguous packagebudgetmodule::packagebudgettype::auxvar => null()

Definition at line 38 of file PackageBudget.f90.

◆ budtxt

character(len=lenpackagename), pointer packagebudgetmodule::packagebudgettype::budtxt => null()

Definition at line 31 of file PackageBudget.f90.

◆ flow

real(dp), dimension(:), pointer, contiguous packagebudgetmodule::packagebudgettype::flow => null()

Definition at line 37 of file PackageBudget.f90.

◆ memorypath

character(len=lenmempath) packagebudgetmodule::packagebudgettype::memorypath = ''

Definition at line 29 of file PackageBudget.f90.

◆ name

character(len=lenpackagename), pointer packagebudgetmodule::packagebudgettype::name => null()

Definition at line 30 of file PackageBudget.f90.

◆ naux

integer(i4b), pointer packagebudgetmodule::packagebudgettype::naux => null()

Definition at line 34 of file PackageBudget.f90.

◆ nbound

integer(i4b), pointer packagebudgetmodule::packagebudgettype::nbound => null()

Definition at line 35 of file PackageBudget.f90.

◆ nodelist

integer(i4b), dimension(:), pointer, contiguous packagebudgetmodule::packagebudgettype::nodelist => null()

Definition at line 36 of file PackageBudget.f90.


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