![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|
Derived type for storing flows. More...

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 | |
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.
| 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.
| 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 46 of file PackageBudget.f90.
| procedure packagebudgetmodule::packagebudgettype::da | ( | class(packagebudgettype) | this | ) |
Free any memory associated with this object
Definition at line 48 of file PackageBudget.f90.
| procedure packagebudgetmodule::packagebudgettype::get_flow | ( | class(packagebudgettype) | this, |
| integer(i4b), intent(in) | i ) |
Return the flow rate for the specified entry
| this | PackageBudgetType object | |
| [in] | i | entry number |
Definition at line 47 of file PackageBudget.f90.
| procedure packagebudgetmodule::packagebudgettype::initialize | ( | class(packagebudgettype) | this, |
| character(len=*), intent(in) | mempath ) |
Establish the memory path and allocate and initialize member variables.
| this | PackageBudgetType object | |
| [in] | mempath | memory path in memory manager |
Definition at line 42 of file PackageBudget.f90.
| 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
| this | PackageBudgetType object | |
| [in] | naux | number of auxiliary variables |
| [in] | auxname | array of names for auxiliary variables |
Definition at line 44 of file PackageBudget.f90.
| 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
| 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 43 of file PackageBudget.f90.
| 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.
| 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 45 of file PackageBudget.f90.
| character(len=lenauxname), dimension(:), pointer, contiguous packagebudgetmodule::packagebudgettype::auxname => null() |
Definition at line 32 of file PackageBudget.f90.
| real(dp), dimension(:, :), pointer, contiguous packagebudgetmodule::packagebudgettype::auxvar => null() |
Definition at line 38 of file PackageBudget.f90.
| character(len=lenpackagename), pointer packagebudgetmodule::packagebudgettype::budtxt => null() |
Definition at line 31 of file PackageBudget.f90.
| real(dp), dimension(:), pointer, contiguous packagebudgetmodule::packagebudgettype::flow => null() |
Definition at line 37 of file PackageBudget.f90.
| character(len=lenmempath) packagebudgetmodule::packagebudgettype::memorypath = '' |
Definition at line 29 of file PackageBudget.f90.
| character(len=lenpackagename), pointer packagebudgetmodule::packagebudgettype::name => null() |
Definition at line 30 of file PackageBudget.f90.
| integer(i4b), pointer packagebudgetmodule::packagebudgettype::naux => null() |
Definition at line 34 of file PackageBudget.f90.
| integer(i4b), pointer packagebudgetmodule::packagebudgettype::nbound => null() |
Definition at line 35 of file PackageBudget.f90.
| integer(i4b), dimension(:), pointer, contiguous packagebudgetmodule::packagebudgettype::nodelist => null() |
Definition at line 36 of file PackageBudget.f90.