![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|
Data Types | |
| type | gwfnpftype |
| type | defaultflowformulationtype |
| Default conductance flow formulation. More... | |
Functions/Subroutines | |
| subroutine, public | npf_cr (npfobj, name_model, input_mempath, inunit, iout) |
| Create a new NPF object. Pass a inunit value of 0 if npf data will initialized from memory. | |
| subroutine | npf_df (this, dis, xt3d, ingnc, invsc, npf_options) |
| Define the NPF package instance. | |
| subroutine | npf_ac (this, moffset, sparse) |
| Add connections for extended neighbors to the sparse matrix. | |
| subroutine | npf_mc (this, moffset, matrix_sln) |
| Map connections and construct iax, jax, and idxglox. | |
| subroutine | npf_ar (this, ic, vsc, ibound, hnew) |
| Allocate and read this NPF instance. | |
| subroutine | npf_rp (this) |
| Read and prepare method for package. | |
| subroutine | npf_ad (this, nodes, hold, hnew, irestore) |
| Advance. | |
| subroutine | npf_cf (this, kiter, nodes, hnew) |
| Calculate coefficients. | |
| subroutine | default_flow_cf (this, kiter) |
| Calculate coefficients for the default conductance formulation. | |
| subroutine | cf_default_flow (this, kiter, n) |
| Calculate coefficients using the. | |
| subroutine | npf_fc (this, kiter, matrix_sln, idxglo, rhs, hnew) |
| Formulate coefficients. | |
| subroutine | fc_default_flow (this, n, m, ipos, matrix_sln, rhs, idxglo, hnew) |
| Calculate and add coefficients using the. | |
| subroutine | default_flow_fc (this, kiter, matrix_sln, idxglo, rhs, hnew) |
| Fill coefficients for the default conductance formulation. | |
| subroutine | highest_cell_saturation (this, n, m, hn, hm, satn, satm) |
| Calculate dry cell saturation. | |
| subroutine | npf_fn (this, kiter, matrix_sln, idxglo, rhs, hnew) |
| Fill newton terms. | |
| subroutine | default_flow_fn (this, kiter, matrix_sln, idxglo, rhs, hnew) |
| Fill newton terms for the default conductance formulation. | |
| subroutine | fn_default_flow (this, n, m, ipos, matrix_sln, rhs, idxglo, hnew) |
| subroutine | npf_nur (this, neqmod, x, xtemp, dx, inewtonur, dxmax, locmax) |
| Under-relaxation. | |
| subroutine | npf_cq (this, hnew, flowja) |
| Calculate flowja. | |
| subroutine | default_flow_cq (this, hnew, flowja) |
| Calculate flows for the default conductance formulation. | |
| subroutine | cq_default_flow (this, n, m, ipos, flowja, hnew) |
| subroutine | sgwf_npf_thksat (this, n, hn, thksat) |
| Fractional cell saturation. | |
| subroutine | sgwf_npf_qcalc (this, n, m, hn, hm, icon, qnm) |
| Flow between two cells. | |
| subroutine | npf_save_model_flows (this, flowja, icbcfl, icbcun) |
| Record flowja and calculate specific discharge if requested. | |
| subroutine | npf_print_model_flows (this, ibudfl, flowja) |
| Print budget. | |
| subroutine | npf_da (this) |
| Deallocate variables. | |
| subroutine | allocate_scalars (this) |
| Allocate scalars. | |
| subroutine | store_original_k_arrays (this, ncells, njas) |
| Store backup copy of hydraulic conductivity when the VSC package is activate. | |
| subroutine | allocate_arrays (this, ncells, njas) |
| Allocate npf arrays. | |
| subroutine | log_options (this, found) |
| Log npf options sourced from the input mempath. | |
| subroutine | source_options (this) |
| Update simulation options from input mempath. | |
| subroutine | set_options (this, options) |
| Set options in the NPF object. | |
| subroutine | check_options (this) |
| Check for conflicting NPF options. | |
| subroutine | log_griddata (this, found) |
| Write dimensions to list file. | |
| subroutine | source_griddata (this) |
| Update simulation griddata from input mempath. | |
| subroutine | prepcheck (this) |
| Initialize and check NPF data. | |
| subroutine | preprocess_input (this) |
| preprocess the NPF input data | |
| subroutine | calc_condsat (this, node, upperonly) |
| Calculate CONDSAT array entries for the given node. | |
| real(dp) function | calc_initial_sat (this, n) |
| Calculate initial saturation for the given node. | |
| subroutine | sgwf_npf_wetdry (this, kiter, hnew) |
| Perform wetting and drying. | |
| subroutine | rewet_check (this, kiter, node, hm, ibdm, ihc, hnew, irewet) |
| Determine if a cell should rewet. | |
| subroutine | sgwf_npf_wdmsg (this, icode, ncnvrt, nodcnvrt, acnvrt, ihdcnv, kiter, n) |
| Print wet/dry message. | |
| real(dp) function | hy_eff (this, n, m, ihc, ipos, vg) |
| Calculate the effective hydraulic conductivity for the n-m connection. | |
| subroutine | calc_spdis (this, flowja) |
| Calculate the 3 components of specific discharge at the cell center. | |
| subroutine | sav_spdis (this, ibinun) |
| Save specific discharge in binary format to ibinun. | |
| subroutine | sav_sat (this, ibinun) |
| Save saturation in binary format to ibinun. | |
| subroutine | increase_edge_count (this, nedges) |
| Reserve space for nedges cells that have an edge on them. | |
| integer(i4b) function | calc_max_conns (this) |
| Calculate the maximum number of connections for any cell. | |
| subroutine | set_edge_properties (this, nodedge, ihcedge, q, area, nx, ny, distance) |
| Provide the npf package with edge properties. | |
| subroutine | prepare_edge_lookup (this) |
| real(dp) function | calcsatthickness (this, n, m, ihc) |
| Calculate saturated thickness between cell n and m. | |
| subroutine | add_flow_formulation (this, npf_form, form_id) |
|
private |
| [in,out] | this | this NPF instance |
| npf_form | the extended flow calculator | |
| form_id | the id for the flow formulation |
Definition at line 3134 of file gwf-npf.f90.
|
private |
Definition at line 1438 of file gwf-npf.f90.
|
private |
Allocate and initialize scalars for the VSC package. The base model allocate scalars method is also called.
Definition at line 1319 of file gwf-npf.f90.

|
private |
Calculate saturated conductances for all connections of the given node, or optionally for the upper portion of the matrix only.
Definition at line 2278 of file gwf-npf.f90.

|
private |
Calculate saturation as a fraction of thickness for the given node, used for saturated conductance calculations: full thickness by default (1.0) or saturation based on initial conditions if the THICKSTRT option is used.
Definition at line 2374 of file gwf-npf.f90.
|
private |
Definition at line 3008 of file gwf-npf.f90.
|
private |
Definition at line 2687 of file gwf-npf.f90.

|
private |
| this | this NPF instance |
| n | node n |
| m | node m |
| ihc | 1 = horizontal connection, 0 for vertical |
Definition at line 3109 of file gwf-npf.f90.
|
private |
Definition at line 541 of file gwf-npf.f90.
|
private |
Definition at line 1699 of file gwf-npf.f90.

|
private |
Definition at line 1016 of file gwf-npf.f90.
|
private |
Runs over all cells and computes the saturated fraction for convertible cells, skipping cells claimed by an exclusive formulation.
| [in,out] | this | default formulation |
| [in] | kiter | outer iteration number |
Definition at line 524 of file gwf-npf.f90.
|
private |
Runs over all connections and stores the standard NPF face flows, skipping faces claimed by an exclusive formulation.
| [in,out] | this | default formulation |
| [in,out] | hnew | new head values |
| [in,out] | flowja | flow between cells |
Definition at line 994 of file gwf-npf.f90.
|
private |
Runs over all connections and fills the standard NPF conductance terms, skipping faces claimed by an exclusive formulation.
| [in,out] | this | default formulation |
| [in] | kiter | outer iteration number |
| [in,out] | matrix_sln | system matrix |
| [in] | idxglo | local to global connection map |
| [in,out] | rhs | right-hand side vector |
| [in,out] | hnew | new head values |
Definition at line 684 of file gwf-npf.f90.
|
private |
Runs over all connections and fills the standard NPF newton terms, skipping faces claimed by an exclusive formulation.
| [in,out] | this | default formulation |
| [in] | kiter | outer iteration number |
| [in,out] | matrix_sln | system matrix |
| [in] | idxglo | local to global connection map |
| [in,out] | rhs | right-hand side vector |
| [in,out] | hnew | new head values |
Definition at line 783 of file gwf-npf.f90.
|
private |
| this | this instance | |
| n | node number n | |
| m | node number m | |
| ipos | connection number | |
| matrix_sln | system matrix | |
| [in,out] | rhs | rhs vector |
| [in] | idxglo | lookup table from local ipos to global system |
| [in,out] | hnew | new head values |
Definition at line 590 of file gwf-npf.f90.

|
private |
Definition at line 812 of file gwf-npf.f90.

|
private |
Calculate the saturation based on the maximum cell bottom for two connected cells
Definition at line 719 of file gwf-npf.f90.

|
private |
n is primary node node number m is connected node (not used if vg is provided) ihc is horizontal indicator (0 vertical, 1 horizontal, 2 vertically staggered) ipos_opt is position of connection in ja array vg is the global unit vector that expresses the direction from which to calculate an effective hydraulic conductivity.
Definition at line 2608 of file gwf-npf.f90.

|
private |
This must be called before the npfallocate_arrays routine, which is called from npfar.
Definition at line 2998 of file gwf-npf.f90.
|
private |
Definition at line 1770 of file gwf-npf.f90.
|
private |
Definition at line 1516 of file gwf-npf.f90.
|
private |
Definition at line 288 of file gwf-npf.f90.
|
private |
Sets hold (head old) to bot whenever a wettable cell is dry
Definition at line 431 of file gwf-npf.f90.
|
private |
Allocate remaining package arrays, preprocess the input data and call *_ar on xt3d, when active.
| this | instance of the NPF package | |
| [in] | ic | initial conditions |
| [in] | vsc | viscosity package |
| [in,out] | ibound | model ibound array |
| [in,out] | hnew | pointer to model head array |
Definition at line 316 of file gwf-npf.f90.

|
private |
Definition at line 495 of file gwf-npf.f90.
|
private |
Definition at line 965 of file gwf-npf.f90.
| subroutine, public gwfnpfmodule::npf_cr | ( | type(gwfnpftype), pointer | npfobj, |
| character(len=*), intent(in) | name_model, | ||
| character(len=*), intent(in) | input_mempath, | ||
| integer(i4b), intent(in) | inunit, | ||
| integer(i4b), intent(in) | iout ) |
Definition at line 188 of file gwf-npf.f90.

|
private |
Definition at line 1211 of file gwf-npf.f90.

|
private |
This is a hybrid routine: it either reads the options for this package from the input file, or the optional argument npf_options should be passed. A consistency check is performed, and finally xt3d_df is called, when enabled.
| this | instance of the NPF package | |
| [in,out] | dis | the pointer to the discretization |
| xt3d | the pointer to the XT3D 'package' | |
| [in] | ingnc | ghostnodes enabled? (>0 means yes) |
| [in] | invsc | viscosity enabled? (>0 means yes) |
| [in] | npf_options | the optional options, for when not constructing from file |
Definition at line 235 of file gwf-npf.f90.

|
private |
| this | this instance | |
| kiter | outer iteration number | |
| matrix_sln | the system to be formulated | |
| [in] | idxglo | lookup table from local to global connection number |
| [in,out] | rhs | the righthandside vector |
| [in,out] | hnew | the new head values |
Definition at line 562 of file gwf-npf.f90.
|
private |
Definition at line 748 of file gwf-npf.f90.
|
private |
Definition at line 302 of file gwf-npf.f90.
|
private |
Under-relaxation of Groundwater Flow Model Heads for current outer iteration using the cell bottoms at the bottom of the model
Definition at line 921 of file gwf-npf.f90.
|
private |
Definition at line 1172 of file gwf-npf.f90.
|
private |
Read and prepare NPF stress period data.
Definition at line 416 of file gwf-npf.f90.
|
private |
Definition at line 1135 of file gwf-npf.f90.
|
private |
Definition at line 3064 of file gwf-npf.f90.
|
private |
Definition at line 1915 of file gwf-npf.f90.

|
private |
This routine consists of the following steps:
| this | the instance of the NPF package |
Definition at line 2076 of file gwf-npf.f90.

|
private |
This method can be called from any external object that has a head that can be used to rewet the GWF cell node. The ihc value is used to determine if it is a vertical or horizontal connection, which can operate differently depending on user settings.
Definition at line 2495 of file gwf-npf.f90.
|
private |
Definition at line 2966 of file gwf-npf.f90.
|
private |
Definition at line 2938 of file gwf-npf.f90.
|
private |
Definition at line 3035 of file gwf-npf.f90.
|
private |
Definition at line 1681 of file gwf-npf.f90.
|
private |
Definition at line 1057 of file gwf-npf.f90.

|
private |
Definition at line 1034 of file gwf-npf.f90.

|
private |
Definition at line 2555 of file gwf-npf.f90.
|
private |
Definition at line 2389 of file gwf-npf.f90.

|
private |
Definition at line 1820 of file gwf-npf.f90.

|
private |
Definition at line 1590 of file gwf-npf.f90.

|
private |
The K arrays (K11, etc.) get multiplied by the viscosity ratio so that subsequent uses of K already take into account the effect of viscosity. Thus K before VSC adjustment, including TVK changes, is kept in k11input, for example. In a new stress period/time step, the values in k11input are multiplied by the viscosity ratio, not k11 since it contains viscosity-adjusted hydraulic conductivity values.
Definition at line 1418 of file gwf-npf.f90.