![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|


Public Member Functions | |
| procedure | advance_bfr (this) |
| Advance the budget file reader. | |
| procedure | advance_hfr (this) |
| Advance the head file reader. | |
| procedure | allocate_arrays (this, nodes) |
| Allocate arrays. | |
| procedure | allocate_gwfpackages (this, ngwfterms) |
| Allocate budget packages. | |
| procedure | allocate_scalars (this) |
| Allocate scalars. | |
| procedure | deallocate_gwfpackages (this) |
| Deallocate memory in the gwfpackages array. | |
| procedure | finalize_bfr (this) |
| Finalize the budget file reader. | |
| procedure | finalize_hfr (this) |
| Finalize the head file reader. | |
| procedure | fmi_ar (this, ibound) |
| Allocate the package. | |
| procedure | fmi_da (this) |
| Deallocate variables. | |
| procedure | fmi_df (this, dis, idryinactive) |
| Define the flow model interface. | |
| procedure | get_package_index (this, name, idx) |
| Find the package index for the package with the given name. | |
| procedure | initialize_bfr (this) |
| Initialize the budget file reader. | |
| procedure | initialize_gwfterms_from_bfr (this) |
| Initialize gwf terms from budget file. | |
| procedure | initialize_gwfterms_from_gwfbndlist (this) |
| Initialize gwf terms from a GWF exchange. | |
| procedure | initialize_hfr (this) |
| Initialize the head file reader. | |
| procedure | source_options (this) |
| Source input options for package. | |
| procedure | source_packagedata (this) |
| Source input options for package. | |
| procedure | source_packagedata_other (this, flowtype, fname) |
| Source a packagedata entry with a model-specific flow type. | |
| procedure | read_grid (this) |
| Read/validate flow model grid. | |
| procedure | set_names (this, ibcnum, name_model, pakname, ftype, input_mempath) |
| Set package names. | |
| procedure | allocate_scalars (this) |
| Allocate package scalars. | |
| procedure | da (this) |
| Deallocate package scalars. | |
| procedure | read_check_ionper (this) |
| Check ionper. | |
| procedure | get_block_data (this, tags, lfound, varinames) |
| Read griddata block for a package. | |
Public Attributes | |
| character(len=lenpackagename) | text = '' |
| text string for package | |
| logical, pointer | flows_from_file => null() |
| if .false., then flows come from GWF through GWF-Model exg | |
| type(listtype), pointer | gwfbndlist => null() |
| list of gwf stress packages | |
| integer(i4b), pointer | iflowsupdated => null() |
| flows were updated for this time step | |
| integer(i4b), dimension(:), pointer, contiguous | ibound => null() |
| pointer to this model ibound | |
| real(dp), dimension(:), pointer, contiguous | gwfflowja => null() |
| pointer to the GWF flowja array | |
| real(dp), dimension(:, :), pointer, contiguous | gwfspdis => null() |
| pointer to npf specific discharge array | |
| real(dp), dimension(:), pointer, contiguous | gwfhead => null() |
| pointer to the GWF head array | |
| real(dp), dimension(:), pointer, contiguous | gwfsat => null() |
| pointer to the GWF saturation array | |
| integer(i4b), dimension(:), pointer, contiguous | ibdgwfsat0 => null() |
| mark cells with saturation = 0 to exclude from dispersion | |
| integer(i4b), pointer | idryinactive => null() |
| mark cells with an additional flag to exclude from deactivation (gwe will simulate conduction through dry cells) | |
| real(dp), dimension(:), pointer, contiguous | gwfstrgss => null() |
| pointer to flow model QSTOSS | |
| real(dp), dimension(:), pointer, contiguous | gwfstrgsy => null() |
| pointer to flow model QSTOSY | |
| integer(i4b), dimension(:), pointer, contiguous | gwfceltyp => null() |
| pointer to flow model NPF icelltype | |
| integer(i4b), pointer | igwfspdis => null() |
| indicates if gwfspdis is available | |
| integer(i4b), pointer | igwfstrgss => null() |
| indicates if gwfstrgss is available | |
| integer(i4b), pointer | igwfstrgsy => null() |
| indicates if gwfstrgsy is available | |
| integer(i4b), pointer | igwfceltyp => null() |
| indicates if gwfceltyp is available | |
| integer(i4b), pointer | iubud => null() |
| unit number GWF budget file | |
| integer(i4b), pointer | iuhds => null() |
| unit number GWF head file | |
| integer(i4b), pointer | iumvr => null() |
| unit number GWF mover budget file | |
| integer(i4b), pointer | iugrb => null() |
| unit number binary grid file | |
| integer(i4b), pointer | nflowpack => null() |
| number of GWF flow packages | |
| integer(i4b), dimension(:), pointer, contiguous | igwfmvrterm => null() |
| flag to indicate that gwf package is a mover term | |
| type(budgetfilereadertype) | bfr |
| budget file reader | |
| type(headfilereadertype) | hfr |
| head file reader | |
| type(gridfilereadertype) | gfr |
| grid file reader | |
| type(packagebudgettype), dimension(:), allocatable | gwfpackages |
| used to get flows between a package and gwf | |
| type(budgetobjecttype), pointer | mvrbudobj => null() |
| pointer to the mover budget object | |
| character(len=16), dimension(:), allocatable | flowpacknamearray |
| array of boundary package names (e.g. LAK-1, SFR-3, etc.) | |
| character(len=lenvarname) | depvartype = '' |
| character(len=lenmodelname) | name_model = '' |
| the name of the model that contains this package | |
| character(len=lenpackagename) | packname = '' |
| name of the package | |
| character(len=lenmempath) | memorypath = '' |
| the location in the memory manager where the variables are stored | |
| character(len=lenmempath) | memorypathmodel = '' |
| the location in the memory manager where the variables of the parent model are stored | |
| character(len=lenmempath) | input_mempath = '' |
| input context mempath | |
| character(len=linelength), pointer | input_fname => null() |
| input file name | |
| character(len=lenftype) | filtyp = '' |
| file type (CHD, DRN, RIV, etc.) | |
| character(len=lenftype), pointer | package_type => null() |
| package type (same as filtyp) stored in memory manager | |
| integer(i4b), pointer | id => null() |
| consecutive package number in model | |
| integer(i4b), pointer | inunit => null() |
| unit number for input file | |
| integer(i4b), pointer | iout => null() |
| unit number for writing package output | |
| integer(i4b), pointer | inewton => null() |
| newton flag | |
| integer(i4b), pointer | iasym => null() |
| package causes matrix asymmetry | |
| integer(i4b), pointer | iprpak => null() |
| integer flag to echo input | |
| integer(i4b), pointer | iprflow => null() |
| flag to print simulated flows | |
| integer(i4b), pointer | ipakcb => null() |
| output flows (-1, 0, 1) - save_flows | |
| integer(i4b), pointer | ionper => null() |
| stress period for next data | |
| integer(i4b), pointer | lastonper => null() |
| last value of ionper (for checking) | |
| type(blockparsertype) | parser |
| parser object for reading blocks of information | |
| class(disbasetype), pointer | dis => null() |
| model discretization object | |
Definition at line 23 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::advance_bfr | ( | class(flowmodelinterfacetype) | this | ) |
Advance the budget file reader by reading the next chunk of information for the current time step and stress period.
Definition at line 59 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::advance_hfr | ( | class(flowmodelinterfacetype) | this | ) |
Definition at line 60 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::allocate_arrays | ( | class(flowmodelinterfacetype) | this, |
| integer(i4b), intent(in) | nodes ) |
Definition at line 61 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::allocate_gwfpackages | ( | class(flowmodelinterfacetype) | this, |
| integer(i4b), intent(in) | ngwfterms ) |
gwfpackages is an array of PackageBudget objects. This routine allocates gwfpackages to the proper size and initializes some member variables.
Definition at line 62 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::allocate_scalars | ( | class(flowmodelinterfacetype) | this | ) |
Definition at line 63 of file FlowModelInterface.f90.
|
inherited |
Allocate and initialize base numerical package scalars.
| this | NumericalPackageType object |
Definition at line 54 of file NumericalPackage.f90.
|
inherited |
Deallocate and initialize base numerical package scalars.
| this | NumericalPackageType object |
Definition at line 55 of file NumericalPackage.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::deallocate_gwfpackages | ( | class(flowmodelinterfacetype) | this | ) |
Definition at line 64 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::finalize_bfr | ( | class(flowmodelinterfacetype) | this | ) |
Definition at line 65 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::finalize_hfr | ( | class(flowmodelinterfacetype) | this | ) |
Definition at line 66 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::fmi_ar | ( | class(flowmodelinterfacetype) | this, |
| integer(i4b), dimension(:), pointer, contiguous | ibound ) |
Definition at line 67 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::fmi_da | ( | class(flowmodelinterfacetype) | this | ) |
Definition at line 68 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::fmi_df | ( | class(flowmodelinterfacetype) | this, |
| class(disbasetype), intent(in), pointer | dis, | ||
| integer(i4b), intent(in) | idryinactive ) |
Definition at line 69 of file FlowModelInterface.f90.
|
inherited |
Generic method to read data in the GRIDDATA block for a package.
| this | NumericalPackageType object | |
| [in] | tags | vector with variable tags |
| [in,out] | lfound | boolean vector indicating of a variable tag was found |
| [in] | varinames | optional vector of variable names |
Definition at line 57 of file NumericalPackage.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::get_package_index | ( | class(flowmodelinterfacetype) | this, |
| character(len=*), intent(in) | name, | ||
| integer(i4b), intent(inout) | idx ) |
Definition at line 70 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::initialize_bfr | ( | class(flowmodelinterfacetype) | this | ) |
Definition at line 71 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::initialize_gwfterms_from_bfr | ( | class(flowmodelinterfacetype) | this | ) |
initialize terms and figure out how many different terms and packages are contained within the file
Definition at line 72 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::initialize_gwfterms_from_gwfbndlist | ( | class(flowmodelinterfacetype) | this | ) |
Definition at line 73 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::initialize_hfr | ( | class(flowmodelinterfacetype) | this | ) |
Definition at line 74 of file FlowModelInterface.f90.
|
inherited |
Generic method to read and check ionperiod, which is used to determine if new period data should be read from the input file. The check of ionperiod also makes sure periods are increasing in subsequent period data blocks.
| [in,out] | this | NumericalPackageType object |
Definition at line 56 of file NumericalPackage.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::read_grid | ( | class(flowmodelinterfacetype) | this | ) |
Definition at line 78 of file FlowModelInterface.f90.
|
inherited |
Method to assign the filtyp (ftype), the model name, and package name for a package. This method also creates the memoryPath and memoryPathModel that is used by the memory manager when variables are allocated.
| [in,out] | this | NumericalPackageType object |
| [in] | ibcnum | unique package number |
| [in] | name_model | name of the model |
| [in] | pakname | name of the package |
| [in] | ftype | package type |
Definition at line 53 of file NumericalPackage.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::source_options | ( | class(flowmodelinterfacetype) | this | ) |
Definition at line 75 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::source_packagedata | ( | class(flowmodelinterfacetype) | this | ) |
Definition at line 76 of file FlowModelInterface.f90.
| procedure flowmodelinterfacemodule::flowmodelinterfacetype::source_packagedata_other | ( | class(flowmodelinterfacetype) | this, |
| character(len=*), intent(in) | flowtype, | ||
| character(len=*), intent(in) | fname ) |
| [in] | flowtype | packagedata flow type |
| [in] | fname | packagedata file name |
Definition at line 77 of file FlowModelInterface.f90.
| type(budgetfilereadertype) flowmodelinterfacemodule::flowmodelinterfacetype::bfr |
Definition at line 49 of file FlowModelInterface.f90.
| character(len=lenvarname) flowmodelinterfacemodule::flowmodelinterfacetype::depvartype = '' |
Definition at line 55 of file FlowModelInterface.f90.
|
inherited |
Definition at line 50 of file NumericalPackage.f90.
|
inherited |
Definition at line 33 of file NumericalPackage.f90.
| character(len=16), dimension(:), allocatable flowmodelinterfacemodule::flowmodelinterfacetype::flowpacknamearray |
Definition at line 54 of file FlowModelInterface.f90.
| logical, pointer flowmodelinterfacemodule::flowmodelinterfacetype::flows_from_file => null() |
Definition at line 26 of file FlowModelInterface.f90.
| type(gridfilereadertype) flowmodelinterfacemodule::flowmodelinterfacetype::gfr |
Definition at line 51 of file FlowModelInterface.f90.
| type(listtype), pointer flowmodelinterfacemodule::flowmodelinterfacetype::gwfbndlist => null() |
Definition at line 27 of file FlowModelInterface.f90.
| integer(i4b), dimension(:), pointer, contiguous flowmodelinterfacemodule::flowmodelinterfacetype::gwfceltyp => null() |
Definition at line 38 of file FlowModelInterface.f90.
| real(dp), dimension(:), pointer, contiguous flowmodelinterfacemodule::flowmodelinterfacetype::gwfflowja => null() |
Definition at line 30 of file FlowModelInterface.f90.
| real(dp), dimension(:), pointer, contiguous flowmodelinterfacemodule::flowmodelinterfacetype::gwfhead => null() |
Definition at line 32 of file FlowModelInterface.f90.
| type(packagebudgettype), dimension(:), allocatable flowmodelinterfacemodule::flowmodelinterfacetype::gwfpackages |
Definition at line 52 of file FlowModelInterface.f90.
| real(dp), dimension(:), pointer, contiguous flowmodelinterfacemodule::flowmodelinterfacetype::gwfsat => null() |
Definition at line 33 of file FlowModelInterface.f90.
| real(dp), dimension(:, :), pointer, contiguous flowmodelinterfacemodule::flowmodelinterfacetype::gwfspdis => null() |
Definition at line 31 of file FlowModelInterface.f90.
| real(dp), dimension(:), pointer, contiguous flowmodelinterfacemodule::flowmodelinterfacetype::gwfstrgss => null() |
Definition at line 36 of file FlowModelInterface.f90.
| real(dp), dimension(:), pointer, contiguous flowmodelinterfacemodule::flowmodelinterfacetype::gwfstrgsy => null() |
Definition at line 37 of file FlowModelInterface.f90.
| type(headfilereadertype) flowmodelinterfacemodule::flowmodelinterfacetype::hfr |
Definition at line 50 of file FlowModelInterface.f90.
|
inherited |
Definition at line 41 of file NumericalPackage.f90.
| integer(i4b), dimension(:), pointer, contiguous flowmodelinterfacemodule::flowmodelinterfacetype::ibdgwfsat0 => null() |
Definition at line 34 of file FlowModelInterface.f90.
| integer(i4b), dimension(:), pointer, contiguous flowmodelinterfacemodule::flowmodelinterfacetype::ibound => null() |
Definition at line 29 of file FlowModelInterface.f90.
|
inherited |
Definition at line 37 of file NumericalPackage.f90.
| integer(i4b), pointer flowmodelinterfacemodule::flowmodelinterfacetype::idryinactive => null() |
Definition at line 35 of file FlowModelInterface.f90.
| integer(i4b), pointer flowmodelinterfacemodule::flowmodelinterfacetype::iflowsupdated => null() |
Definition at line 28 of file FlowModelInterface.f90.
| integer(i4b), pointer flowmodelinterfacemodule::flowmodelinterfacetype::igwfceltyp => null() |
Definition at line 42 of file FlowModelInterface.f90.
| integer(i4b), dimension(:), pointer, contiguous flowmodelinterfacemodule::flowmodelinterfacetype::igwfmvrterm => null() |
Definition at line 48 of file FlowModelInterface.f90.
| integer(i4b), pointer flowmodelinterfacemodule::flowmodelinterfacetype::igwfspdis => null() |
Definition at line 39 of file FlowModelInterface.f90.
| integer(i4b), pointer flowmodelinterfacemodule::flowmodelinterfacetype::igwfstrgss => null() |
Definition at line 40 of file FlowModelInterface.f90.
| integer(i4b), pointer flowmodelinterfacemodule::flowmodelinterfacetype::igwfstrgsy => null() |
Definition at line 41 of file FlowModelInterface.f90.
|
inherited |
Definition at line 40 of file NumericalPackage.f90.
|
inherited |
Definition at line 32 of file NumericalPackage.f90.
|
inherited |
Definition at line 31 of file NumericalPackage.f90.
|
inherited |
Definition at line 38 of file NumericalPackage.f90.
|
inherited |
Definition at line 45 of file NumericalPackage.f90.
|
inherited |
Definition at line 39 of file NumericalPackage.f90.
|
inherited |
Definition at line 44 of file NumericalPackage.f90.
|
inherited |
Definition at line 43 of file NumericalPackage.f90.
|
inherited |
Definition at line 42 of file NumericalPackage.f90.
| integer(i4b), pointer flowmodelinterfacemodule::flowmodelinterfacetype::iubud => null() |
Definition at line 43 of file FlowModelInterface.f90.
| integer(i4b), pointer flowmodelinterfacemodule::flowmodelinterfacetype::iugrb => null() |
Definition at line 46 of file FlowModelInterface.f90.
| integer(i4b), pointer flowmodelinterfacemodule::flowmodelinterfacetype::iuhds => null() |
Definition at line 44 of file FlowModelInterface.f90.
| integer(i4b), pointer flowmodelinterfacemodule::flowmodelinterfacetype::iumvr => null() |
Definition at line 45 of file FlowModelInterface.f90.
|
inherited |
Definition at line 46 of file NumericalPackage.f90.
|
inherited |
Definition at line 28 of file NumericalPackage.f90.
|
inherited |
Definition at line 29 of file NumericalPackage.f90.
| type(budgetobjecttype), pointer flowmodelinterfacemodule::flowmodelinterfacetype::mvrbudobj => null() |
Definition at line 53 of file FlowModelInterface.f90.
|
inherited |
Definition at line 26 of file NumericalPackage.f90.
| integer(i4b), pointer flowmodelinterfacemodule::flowmodelinterfacetype::nflowpack => null() |
Definition at line 47 of file FlowModelInterface.f90.
|
inherited |
Definition at line 34 of file NumericalPackage.f90.
|
inherited |
Definition at line 27 of file NumericalPackage.f90.
|
inherited |
Definition at line 49 of file NumericalPackage.f90.
| character(len=lenpackagename) flowmodelinterfacemodule::flowmodelinterfacetype::text = '' |
Definition at line 25 of file FlowModelInterface.f90.