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


Public Member Functions | |
| procedure | allocate_arrays (this, nodes) |
| Allocate arrays for FMI object. | |
| procedure | allocate_gwfpackages (this, ngwfterms) |
| Initialize an array for storing PackageBudget objects. | |
| procedure | allocate_scalars (this) |
| Allocate scalars. | |
| procedure | fmi_rp (this, inmvr) |
| Read and prepare. | |
| procedure | fmi_ad (this, cnew) |
| Advance routine for FMI object. | |
| procedure | fmi_fc (this, nodes, cold, nja, matrix_sln, idxglo, rhs) |
| Calculate coefficients and fill matrix and rhs terms associated with FMI object. | |
| procedure | fmi_cq (this, cnew, flowja) |
| Calculate flow correction. | |
| procedure | fmi_bd (this, isuppress_output, model_budget) |
| Calculate budget terms associated with FMI object. | |
| procedure | fmi_ot_flow (this, icbcfl, icbcun) |
| Save budget terms associated with FMI object. | |
| procedure | fmi_da (this) |
| Deallocate variables. | |
| procedure | gwfsatold (this, n, delt) |
| Calculate the previous saturation level. | |
| procedure | initialize_gwfterms_from_bfr (this) |
| Initialize the groundwater flow terms based on the budget file reader. | |
| procedure | initialize_gwfterms_from_gwfbndlist (this) |
| Initialize groundwater flow terms from the groundwater budget. | |
| procedure | source_options (this) |
| Source input options for package. | |
| procedure | set_aptbudobj_pointer (this, name, budobjptr) |
| Set the pointer to a budget object. | |
| procedure | source_packagedata_other (this, flowtype, fname) |
| Source a packagedata entry with a model-specific flow type. | |
| procedure | set_active_status (this, cnew) |
| Set gwt transport cell status. | |
| 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 | allocate_scalars (this) |
| Allocate package 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 | 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 | |
| integer(i4b), dimension(:), pointer, contiguous | iatp => null() |
| advanced transport package applied to gwfpackages | |
| integer(i4b), pointer | iflowerr => null() |
| add the flow error correction | |
| real(dp), dimension(:), pointer, contiguous | flowcorrect => null() |
| mass flow correction | |
| real(dp), pointer | eqnsclfac => null() |
| governing equation scale factor; =1. for solute; =rhow*cpw for energy | |
| type(dataadvancedpackagetype), dimension(:), pointer, contiguous | datp => null() |
| type(budobjptrarray), dimension(:), allocatable | aptbudobj |
| flow budget objects for the advanced packages | |
| 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 37 of file tsp-fmi.f90.
|
inherited |
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.
|
inherited |
Definition at line 60 of file FlowModelInterface.f90.
|
inherited |
Definition at line 61 of file FlowModelInterface.f90.
| procedure tspfmimodule::tspfmitype::allocate_arrays | ( | class(tspfmitype) | this, |
| integer(i4b), intent(in) | nodes ) |
Method to allocate arrays for the FMI package.
Definition at line 49 of file tsp-fmi.f90.
|
inherited |
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 tspfmimodule::tspfmitype::allocate_gwfpackages | ( | class(tspfmitype) | this, |
| integer(i4b), intent(in) | ngwfterms ) |
This routine allocates gwfpackages (an array of PackageBudget objects) to the proper size and initializes member variables.
Definition at line 50 of file tsp-fmi.f90.
|
inherited |
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.
| procedure tspfmimodule::tspfmitype::allocate_scalars | ( | class(tspfmitype) | this | ) |
Allocate scalar variables for an FMI object
Definition at line 51 of file tsp-fmi.f90.
|
inherited |
Deallocate and initialize base numerical package scalars.
| this | NumericalPackageType object |
Definition at line 55 of file NumericalPackage.f90.
|
inherited |
Definition at line 64 of file FlowModelInterface.f90.
|
inherited |
Definition at line 65 of file FlowModelInterface.f90.
|
inherited |
Definition at line 66 of file FlowModelInterface.f90.
| procedure tspfmimodule::tspfmitype::fmi_ad | ( | class(tspfmitype) | this, |
| real(dp), dimension(:), intent(inout) | cnew ) |
Definition at line 53 of file tsp-fmi.f90.
|
inherited |
Definition at line 67 of file FlowModelInterface.f90.
| procedure tspfmimodule::tspfmitype::fmi_bd | ( | class(tspfmitype) | this, |
| integer(i4b), intent(in) | isuppress_output, | ||
| type(budgettype), intent(inout) | model_budget ) |
Definition at line 56 of file tsp-fmi.f90.
| procedure tspfmimodule::tspfmitype::fmi_cq | ( | class(tspfmitype) | this, |
| real(dp), dimension(:), intent(in) | cnew, | ||
| real(dp), dimension(:), intent(inout), contiguous | flowja ) |
Where there is a flow imbalance for a given cell, a correction may be applied if selected
Definition at line 55 of file tsp-fmi.f90.
|
inherited |
Definition at line 68 of file FlowModelInterface.f90.
| procedure tspfmimodule::tspfmitype::fmi_da | ( | class(tspfmitype) | this | ) |
Deallocate memory associated with FMI object
Definition at line 58 of file tsp-fmi.f90.
|
inherited |
Definition at line 69 of file FlowModelInterface.f90.
| procedure tspfmimodule::tspfmitype::fmi_fc | ( | class(tspfmitype) | this, |
| integer, intent(in) | nodes, | ||
| real(dp), dimension(nodes), intent(in) | cold, | ||
| integer(i4b), intent(in) | nja, | ||
| class(matrixbasetype), pointer | matrix_sln, | ||
| integer(i4b), dimension(nja), intent(in) | idxglo, | ||
| real(dp), dimension(nodes), intent(inout) | rhs ) |
Definition at line 54 of file tsp-fmi.f90.
| procedure tspfmimodule::tspfmitype::fmi_ot_flow | ( | class(tspfmitype) | this, |
| integer(i4b), intent(in) | icbcfl, | ||
| integer(i4b), intent(in) | icbcun ) |
Definition at line 57 of file tsp-fmi.f90.
| procedure tspfmimodule::tspfmitype::fmi_rp | ( | class(tspfmitype) | this, |
| integer(i4b), intent(in) | inmvr ) |
Definition at line 52 of file tsp-fmi.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.
|
inherited |
Definition at line 70 of file FlowModelInterface.f90.
| procedure tspfmimodule::tspfmitype::gwfsatold | ( | class(tspfmitype) | this, |
| integer(i4b), intent(in) | n, | ||
| real(dp), intent(in) | delt ) |
Calculate the groundwater cell head saturation for the end of the last time step
Definition at line 59 of file tsp-fmi.f90.
|
inherited |
Definition at line 71 of file FlowModelInterface.f90.
|
inherited |
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 tspfmimodule::tspfmitype::initialize_gwfterms_from_bfr | ( | class(tspfmitype) | this | ) |
Initialize terms and figure out how many different terms and packages are contained within the file
Definition at line 60 of file tsp-fmi.f90.
|
inherited |
Definition at line 73 of file FlowModelInterface.f90.
| procedure tspfmimodule::tspfmitype::initialize_gwfterms_from_gwfbndlist | ( | class(tspfmitype) | this | ) |
Flows are coming from a gwf-gwt exchange object
Definition at line 61 of file tsp-fmi.f90.
|
inherited |
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.
|
inherited |
Definition at line 78 of file FlowModelInterface.f90.
| procedure tspfmimodule::tspfmitype::set_active_status | ( | class(tspfmitype) | this, |
| real(dp), dimension(:), intent(inout) | cnew ) |
Dry GWF cells are treated differently by GWT and GWE. Transport does not occur in deactivated GWF cells; however, GWE still simulates conduction through dry cells.
Definition at line 65 of file tsp-fmi.f90.
| procedure tspfmimodule::tspfmitype::set_aptbudobj_pointer | ( | class(tspfmitype) | this, |
| character(len=*), intent(in) | name, | ||
| type(budgetobjecttype), pointer | budobjptr ) |
An advanced transport can pass in a name and a pointer budget object, and this routine will look through the budget objects managed by FMI and point to the one with the same name, such as LAK-1, SFR-1, etc.
Definition at line 63 of file tsp-fmi.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.
|
inherited |
Definition at line 75 of file FlowModelInterface.f90.
| procedure tspfmimodule::tspfmitype::source_options | ( | class(tspfmitype) | this | ) |
Definition at line 62 of file tsp-fmi.f90.
|
inherited |
Definition at line 76 of file FlowModelInterface.f90.
|
inherited |
| [in] | flowtype | packagedata flow type |
| [in] | fname | packagedata file name |
Definition at line 77 of file FlowModelInterface.f90.
| procedure tspfmimodule::tspfmitype::source_packagedata_other | ( | class(tspfmitype) | this, |
| character(len=*), intent(in) | flowtype, | ||
| character(len=*), intent(in) | fname ) |
Any flow type not handled by the base FMI is taken to be the name of an advanced GWF package (e.g. LAK-1, SFR-1), and the file is read as that package's budget file.
| [in] | flowtype | advanced package name |
| [in] | fname | advanced package budget file |
Definition at line 64 of file tsp-fmi.f90.
| type(budobjptrarray), dimension(:), allocatable tspfmimodule::tspfmitype::aptbudobj |
Definition at line 45 of file tsp-fmi.f90.
|
inherited |
Definition at line 49 of file FlowModelInterface.f90.
| type(dataadvancedpackagetype), dimension(:), pointer, contiguous tspfmimodule::tspfmitype::datp => null() |
Definition at line 43 of file tsp-fmi.f90.
|
inherited |
Definition at line 55 of file FlowModelInterface.f90.
|
inherited |
Definition at line 50 of file NumericalPackage.f90.
| real(dp), pointer tspfmimodule::tspfmitype::eqnsclfac => null() |
Definition at line 42 of file tsp-fmi.f90.
|
inherited |
Definition at line 33 of file NumericalPackage.f90.
| real(dp), dimension(:), pointer, contiguous tspfmimodule::tspfmitype::flowcorrect => null() |
Definition at line 41 of file tsp-fmi.f90.
|
inherited |
Definition at line 54 of file FlowModelInterface.f90.
|
inherited |
Definition at line 26 of file FlowModelInterface.f90.
|
inherited |
Definition at line 51 of file FlowModelInterface.f90.
|
inherited |
Definition at line 27 of file FlowModelInterface.f90.
|
inherited |
Definition at line 38 of file FlowModelInterface.f90.
|
inherited |
Definition at line 30 of file FlowModelInterface.f90.
|
inherited |
Definition at line 32 of file FlowModelInterface.f90.
|
inherited |
Definition at line 52 of file FlowModelInterface.f90.
|
inherited |
Definition at line 33 of file FlowModelInterface.f90.
|
inherited |
Definition at line 31 of file FlowModelInterface.f90.
|
inherited |
Definition at line 36 of file FlowModelInterface.f90.
|
inherited |
Definition at line 37 of file FlowModelInterface.f90.
|
inherited |
Definition at line 50 of file FlowModelInterface.f90.
|
inherited |
Definition at line 41 of file NumericalPackage.f90.
| integer(i4b), dimension(:), pointer, contiguous tspfmimodule::tspfmitype::iatp => null() |
Definition at line 39 of file tsp-fmi.f90.
|
inherited |
Definition at line 34 of file FlowModelInterface.f90.
|
inherited |
Definition at line 29 of file FlowModelInterface.f90.
|
inherited |
Definition at line 37 of file NumericalPackage.f90.
|
inherited |
Definition at line 35 of file FlowModelInterface.f90.
| integer(i4b), pointer tspfmimodule::tspfmitype::iflowerr => null() |
Definition at line 40 of file tsp-fmi.f90.
|
inherited |
Definition at line 28 of file FlowModelInterface.f90.
|
inherited |
Definition at line 42 of file FlowModelInterface.f90.
|
inherited |
Definition at line 48 of file FlowModelInterface.f90.
|
inherited |
Definition at line 39 of file FlowModelInterface.f90.
|
inherited |
Definition at line 40 of file FlowModelInterface.f90.
|
inherited |
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.
|
inherited |
Definition at line 43 of file FlowModelInterface.f90.
|
inherited |
Definition at line 46 of file FlowModelInterface.f90.
|
inherited |
Definition at line 44 of file FlowModelInterface.f90.
|
inherited |
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.
|
inherited |
Definition at line 53 of file FlowModelInterface.f90.
|
inherited |
Definition at line 26 of file NumericalPackage.f90.
|
inherited |
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.
|
inherited |
Definition at line 25 of file FlowModelInterface.f90.