MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
Inheritance diagram for gwfnpfmodule::gwfnpftype:
Inheritance graph
Collaboration diagram for gwfnpfmodule::gwfnpftype:
Collaboration graph

Public Member Functions

procedure npf_df (this, dis, xt3d, ingnc, invsc, npf_options)
 Define the NPF package instance.
procedure npf_ac (this, moffset, sparse)
 Add connections for extended neighbors to the sparse matrix.
procedure npf_mc (this, moffset, matrix_sln)
 Map connections and construct iax, jax, and idxglox.
procedure npf_ar (this, ic, vsc, ibound, hnew)
 Allocate and read this NPF instance.
procedure npf_rp (this)
 Read and prepare method for package.
procedure npf_ad (this, nodes, hold, hnew, irestore)
 Advance.
procedure npf_cf (this, kiter, nodes, hnew)
 Calculate coefficients.
procedure npf_fc (this, kiter, matrix_sln, idxglo, rhs, hnew)
 Formulate coefficients.
procedure npf_fn (this, kiter, matrix_sln, idxglo, rhs, hnew)
 Fill newton terms.
procedure npf_cq (this, hnew, flowja)
 Calculate flowja.
procedure npf_save_model_flows (this, flowja, icbcfl, icbcun)
 Record flowja and calculate specific discharge if requested.
procedure npf_nur (this, neqmod, x, xtemp, dx, inewtonur, dxmax, locmax)
 Under-relaxation.
procedure npf_print_model_flows (this, ibudfl, flowja)
 Print budget.
procedure npf_da (this)
 Deallocate variables.
procedure allocate_scalars (this)
 Allocate scalars.
procedure rewet_check (this, kiter, node, hm, ibdm, ihc, hnew, irewet)
 Determine if a cell should rewet.
procedure hy_eff (this, n, m, ihc, ipos, vg)
 Calculate the effective hydraulic conductivity for the n-m connection.
procedure calc_spdis (this, flowja)
 Calculate the 3 components of specific discharge at the cell center.
procedure sav_spdis (this, ibinun)
 Save specific discharge in binary format to ibinun.
procedure sav_sat (this, ibinun)
 Save saturation in binary format to ibinun.
procedure increase_edge_count (this, nedges)
 Reserve space for nedges cells that have an edge on them.
procedure set_edge_properties (this, nodedge, ihcedge, q, area, nx, ny, distance)
 Provide the npf package with edge properties.
procedure calcsatthickness (this, n, m, ihc)
 Calculate saturated thickness between cell n and m.
procedure add_flow_formulation (this, npf_form, form_id)
procedure highest_cell_saturation (this, n, m, hn, hm, satn, satm)
 Calculate dry cell saturation.
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

type(gwfictype), pointer ic => null()
 initial conditions object
type(gwfvsctype), pointer vsc => null()
 viscosity object
type(xt3dtype), pointer xt3d => null()
 xt3d pointer
integer(i4b), pointer iname => null()
 length of variable names
character(len=24), dimension(:), pointer aname => null()
 variable names
integer(i4b), dimension(:), pointer, contiguous ibound => null()
 pointer to model ibound
real(dp), dimension(:), pointer, contiguous hnew => null()
 pointer to model xnew
integer(i4b), pointer ixt3d => null()
 xt3d flag (0 is off, 1 is lhs, 2 is rhs)
integer(i4b), pointer ixt3drhs => null()
 xt3d rhs flag, xt3d rhs is set active if 1
integer(i4b), pointer iperched => null()
 vertical flow corrections if 1
integer(i4b), pointer ivarcv => null()
 CV is function of water table.
integer(i4b), pointer idewatcv => null()
 CV may be a discontinuous function of water table.
integer(i4b), pointer ithickstrt => null()
 thickstrt option flag
integer(i4b), pointer ihighcellsat => null()
 highest_cell_saturation option flag
integer(i4b), pointer igwfnewtonur => null()
 newton head dampening using node bottom option flag
integer(i4b), pointer icalcspdis => null()
 Calculate specific discharge at cell centers.
integer(i4b), pointer isavspdis => null()
 Save specific discharge at cell centers.
integer(i4b), pointer isavsat => null()
 Save sat to budget file.
real(dp), pointer hnoflo => null()
 default is 1.e30
real(dp), pointer satomega => null()
 newton-raphson saturation omega
integer(i4b), pointer irewet => null()
 rewetting (0:off, 1:on)
integer(i4b), pointer iwetit => null()
 wetting interval (default is 1)
integer(i4b), pointer ihdwet => null()
 (0 or not 0)
integer(i4b), pointer icellavg => null()
 harmonic(0), logarithmic(1), or arithmetic thick-log K (2)
real(dp), pointer wetfct => null()
 wetting factor
real(dp), pointer hdry => null()
 default is -1.d30
integer(i4b), dimension(:), pointer, contiguous icelltype => null()
 confined (0) or convertible (1)
integer(i4b), dimension(:), pointer, contiguous ithickstartflag => null()
 array of flags for handling the thickstrt option
real(dp), dimension(:), pointer, contiguous k11 => null()
 hydraulic conductivity; if anisotropic, then this is Kx prior to rotation
real(dp), dimension(:), pointer, contiguous k22 => null()
 hydraulic conductivity; if specified then this is Ky prior to rotation
real(dp), dimension(:), pointer, contiguous k33 => null()
 hydraulic conductivity; if specified then this is Kz prior to rotation
real(dp), dimension(:), pointer, contiguous krel => null()
 relative permeability; unless UZR flow is active in a cell, this is 1
real(dp), dimension(:), pointer, contiguous k11input => null()
 hydraulic conductivity before VSC modification, including TVK changes
real(dp), dimension(:), pointer, contiguous k22input => null()
 hydraulic conductivity before VSC modification, including TVK changes
real(dp), dimension(:), pointer, contiguous k33input => null()
 hydraulic conductivity before VSC modification, including TVK changes
integer(i4b), pointer iavgkeff => null()
 effective conductivity averaging (0: harmonic, 1: arithmetic)
integer(i4b), pointer ik22 => null()
 flag that k22 is specified
integer(i4b), pointer ik33 => null()
 flag that k33 is specified
integer(i4b), pointer ik22overk => null()
 flag that k22 is specified as anisotropy ratio
integer(i4b), pointer ik33overk => null()
 flag that k33 is specified as anisotropy ratio
integer(i4b), pointer iangle1 => null()
 flag to indicate angle1 was read
integer(i4b), pointer iangle2 => null()
 flag to indicate angle2 was read
integer(i4b), pointer iangle3 => null()
 flag to indicate angle3 was read
real(dp), dimension(:), pointer, contiguous angle1 => null()
 k ellipse rotation in xy plane around z axis (yaw)
real(dp), dimension(:), pointer, contiguous angle2 => null()
 k ellipse rotation up from xy plane around y axis (pitch)
real(dp), dimension(:), pointer, contiguous angle3 => null()
 k tensor rotation around x axis (roll)
integer(i4b), pointer iwetdry => null()
 flag to indicate angle1 was read
real(dp), dimension(:), pointer, contiguous wetdry => null()
 wetdry array
real(dp), dimension(:), pointer, contiguous sat => null()
 saturation (0. to 1.) for each cell
real(dp), dimension(:), pointer, contiguous condsat => null()
 saturated conductance (symmetric array)
integer(i4b), dimension(:), pointer, contiguous ibotnode => null()
 bottom node used if igwfnewtonur /= 0
real(dp), dimension(:, :), pointer, contiguous spdis => null()
 specific discharge : qx, qy, qz (nodes, 3)
integer(i4b), pointer nedges => null()
 number of cell edges
integer(i4b), pointer lastedge => null()
 last edge number
integer(i4b), dimension(:), pointer, contiguous nodedge => null()
 array of node numbers that have edges
integer(i4b), dimension(:), pointer, contiguous ihcedge => null()
 edge type (horizontal or vertical)
real(dp), dimension(:, :), pointer, contiguous propsedge => null()
 edge properties (Q, area, nx, ny, distance)
integer(i4b), dimension(:), pointer, contiguous iedge_ptr => null()
 csr pointer into edge index array
integer(i4b), dimension(:), pointer, contiguous edge_idxs => null()
 sorted edge indexes for faster lookup
type(spdisworkarraytype), pointer spdis_wa => null()
 work arrays for spdis calculation
integer(i4b), pointer intvk => null()
 TVK (time-varying K) unit number (0 if unused).
integer(i4b), pointer invsc => null()
 VSC (viscosity) unit number (0 if unused); viscosity leads to time-varying K's.
type(tvktype), pointer tvk => null()
 TVK object.
integer(i4b), pointer kchangeper => null()
 last stress period in which any node K (or K22, or K33) values were changed (0 if unchanged from start of simulation)
integer(i4b), pointer kchangestp => null()
 last time step in which any node K (or K22, or K33) values were changed (0 if unchanged from start of simulation)
integer(i4b), dimension(:), pointer, contiguous nodekchange => null()
integer(i4b), dimension(:), pointer, contiguous iformulation => null()
 active formulation for the connection (size: nja)
class(gwfnpfformulationtype), pointer default_form => null()
 default conductance formulation
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

Private Member Functions

procedure, private thksat (this, n, hn, thksat)
 Fractional cell saturation.
procedure, private qcalc (this, n, m, hn, hm, icon, qnm)
 Flow between two cells.
procedure, private wd (this, kiter, hnew)
 Perform wetting and drying.
procedure, private wdmsg (this, icode, ncnvrt, nodcnvrt, acnvrt, ihdcnv, kiter, n)
 Print wet/dry message.
procedure, private store_original_k_arrays (this, ncells, njas)
 Store backup copy of hydraulic conductivity when the VSC package is activate.
procedure, private allocate_arrays (this, ncells, njas)
 Allocate npf arrays.
procedure, private source_options (this)
 Update simulation options from input mempath.
procedure, private source_griddata (this)
 Update simulation griddata from input mempath.
procedure, private log_options (this, found)
 Log npf options sourced from the input mempath.
procedure, private log_griddata (this, found)
 Write dimensions to list file.
procedure, private set_options (this, options)
 Set options in the NPF object.
procedure, private check_options (this)
 Check for conflicting NPF options.
procedure, private prepcheck (this)
 Initialize and check NPF data.
procedure, private preprocess_input (this)
 preprocess the NPF input data
procedure, private cf_default_flow (this, kiter, n)
 Calculate coefficients using the.
procedure, private fc_default_flow (this, n, m, ipos, matrix_sln, rhs, idxglo, hnew)
 Calculate and add coefficients using the.
procedure, private fn_default_flow (this, n, m, ipos, matrix_sln, rhs, idxglo, hnew)
procedure, private cq_default_flow (this, n, m, ipos, flowja, hnew)
procedure, private calc_condsat (this, node, upperonly)
 Calculate CONDSAT array entries for the given node.
procedure, private calc_initial_sat (this, n)
 Calculate initial saturation for the given node.
procedure, private calc_max_conns (this)
 Calculate the maximum number of connections for any cell.
procedure, private prepare_edge_lookup (this)

Private Attributes

type(gwfnpfformcontainertype), dimension(max_ext_flow_forms), private flow_formulations
 alternative flow calculations by extension

Detailed Description

Definition at line 39 of file gwf-npf.f90.

Member Function/Subroutine Documentation

◆ add_flow_formulation()

procedure gwfnpfmodule::gwfnpftype::add_flow_formulation ( class(gwfnpftype), intent(inout) this,
class(gwfnpfformulationtype), pointer npf_form,
integer(i4b) form_id )
Parameters
[in,out]thisthis NPF instance
npf_formthe extended flow calculator
form_idthe id for the flow formulation

Definition at line 141 of file gwf-npf.f90.

◆ allocate_arrays()

procedure, private gwfnpfmodule::gwfnpftype::allocate_arrays ( class(gwfnpftype), target this,
integer(i4b), intent(in) ncells,
integer(i4b), intent(in) njas )
private

Definition at line 148 of file gwf-npf.f90.

◆ allocate_scalars() [1/2]

procedure gwfnpfmodule::gwfnpftype::allocate_scalars ( class(gwfnpftype) this)

Allocate and initialize scalars for the VSC package. The base model allocate scalars method is also called.

Definition at line 132 of file gwf-npf.f90.

◆ allocate_scalars() [2/2]

procedure numericalpackagemodule::numericalpackagetype::allocate_scalars ( class(numericalpackagetype) this)
inherited

Allocate and initialize base numerical package scalars.

Parameters
thisNumericalPackageType object

Definition at line 54 of file NumericalPackage.f90.

◆ calc_condsat()

procedure, private gwfnpfmodule::gwfnpftype::calc_condsat ( class(gwfnpftype) this,
integer(i4b), intent(in) node,
logical, intent(in) upperonly )
private

Calculate saturated conductances for all connections of the given node, or optionally for the upper portion of the matrix only.

Definition at line 161 of file gwf-npf.f90.

◆ calc_initial_sat()

procedure, private gwfnpfmodule::gwfnpftype::calc_initial_sat ( class(gwfnpftype) this,
integer(i4b), intent(in) n )
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 162 of file gwf-npf.f90.

◆ calc_max_conns()

procedure, private gwfnpfmodule::gwfnpftype::calc_max_conns ( class(gwfnpftype) this)
private

Definition at line 163 of file gwf-npf.f90.

◆ calc_spdis()

procedure gwfnpfmodule::gwfnpftype::calc_spdis ( class(gwfnpftype) this,
real(dp), dimension(:), intent(in) flowja )

Definition at line 135 of file gwf-npf.f90.

◆ calcsatthickness()

procedure gwfnpfmodule::gwfnpftype::calcsatthickness ( class(gwfnpftype) this,
integer(i4b) n,
integer(i4b) m,
integer(i4b) ihc )
Parameters
thisthis NPF instance
nnode n
mnode m
ihc1 = horizontal connection, 0 for vertical
Returns
saturated thickness

Definition at line 140 of file gwf-npf.f90.

◆ cf_default_flow()

procedure, private gwfnpfmodule::gwfnpftype::cf_default_flow ( class(gwfnpftype) this,
integer(i4b) kiter,
integer(i4b) n )
private

Definition at line 157 of file gwf-npf.f90.

◆ check_options()

procedure, private gwfnpfmodule::gwfnpftype::check_options ( class(gwfnpftype) this)
private

Definition at line 154 of file gwf-npf.f90.

◆ cq_default_flow()

procedure, private gwfnpfmodule::gwfnpftype::cq_default_flow ( class(gwfnpftype) this,
integer(i4b), intent(in) n,
integer(i4b), intent(in) m,
integer(i4b), intent(in) ipos,
real(dp), dimension(:), intent(inout) flowja,
real(dp), dimension(:), intent(in) hnew )
private

Definition at line 160 of file gwf-npf.f90.

◆ da()

procedure numericalpackagemodule::numericalpackagetype::da ( class(numericalpackagetype) this)
inherited

Deallocate and initialize base numerical package scalars.

Parameters
thisNumericalPackageType object

Definition at line 55 of file NumericalPackage.f90.

◆ fc_default_flow()

procedure, private gwfnpfmodule::gwfnpftype::fc_default_flow ( class(gwfnpftype) this,
integer(i4b) n,
integer(i4b) m,
integer(i4b) ipos,
class(matrixbasetype), pointer matrix_sln,
real(dp), dimension(:), intent(inout) rhs,
integer(i4b), dimension(:), intent(in) idxglo,
real(dp), dimension(:), intent(inout) hnew )
private
Parameters
thisthis instance
nnode number n
mnode number m
iposconnection number
matrix_slnsystem matrix
[in,out]rhsrhs vector
[in]idxglolookup table from local ipos to global system
[in,out]hnewnew head values

Definition at line 158 of file gwf-npf.f90.

◆ fn_default_flow()

procedure, private gwfnpfmodule::gwfnpftype::fn_default_flow ( class(gwfnpftype) this,
integer(i4b) n,
integer(i4b) m,
integer(i4b) ipos,
class(matrixbasetype), pointer matrix_sln,
real(dp), dimension(:), intent(inout) rhs,
integer(i4b), dimension(:), intent(in) idxglo,
real(dp), dimension(:), intent(inout) hnew )
private

Definition at line 159 of file gwf-npf.f90.

◆ get_block_data()

procedure numericalpackagemodule::numericalpackagetype::get_block_data ( class(numericalpackagetype) this,
character(len=24), dimension(:), intent(in) tags,
logical, dimension(:), intent(inout) lfound,
character(len=24), dimension(:), intent(in), optional varinames )
inherited

Generic method to read data in the GRIDDATA block for a package.

Parameters
thisNumericalPackageType object
[in]tagsvector with variable tags
[in,out]lfoundboolean vector indicating of a variable tag was found
[in]varinamesoptional vector of variable names

Definition at line 57 of file NumericalPackage.f90.

◆ highest_cell_saturation()

procedure gwfnpfmodule::gwfnpftype::highest_cell_saturation ( class(gwfnpftype) this,
integer(i4b), intent(in) n,
integer(i4b), intent(in) m,
real(dp), intent(in) hn,
real(dp), intent(in) hm,
real(dp), intent(inout) satn,
real(dp), intent(inout) satm )

Calculate the saturation based on the maximum cell bottom for two connected cells

Definition at line 165 of file gwf-npf.f90.

◆ hy_eff()

procedure gwfnpfmodule::gwfnpftype::hy_eff ( class(gwfnpftype) this,
integer(i4b), intent(in) n,
integer(i4b), intent(in) m,
integer(i4b), intent(in) ihc,
integer(i4b), intent(in), optional ipos,
real(dp), dimension(3), intent(in), optional vg )

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 134 of file gwf-npf.f90.

◆ increase_edge_count()

procedure gwfnpfmodule::gwfnpftype::increase_edge_count ( class(gwfnpftype) this,
integer(i4b), intent(in) nedges )

This must be called before the npfallocate_arrays routine, which is called from npfar.

Definition at line 138 of file gwf-npf.f90.

◆ log_griddata()

procedure, private gwfnpfmodule::gwfnpftype::log_griddata ( class(gwfnpftype) this,
type(gwfnpfparamfoundtype), intent(in) found )
private

Definition at line 152 of file gwf-npf.f90.

◆ log_options()

procedure, private gwfnpfmodule::gwfnpftype::log_options ( class(gwfnpftype) this,
type(gwfnpfparamfoundtype), intent(in) found )
private

Definition at line 151 of file gwf-npf.f90.

◆ npf_ac()

procedure gwfnpfmodule::gwfnpftype::npf_ac ( class(gwfnpftype) this,
integer(i4b), intent(in) moffset,
type(sparsematrix), intent(inout) sparse )

Definition at line 119 of file gwf-npf.f90.

◆ npf_ad()

procedure gwfnpfmodule::gwfnpftype::npf_ad ( class(gwfnpftype) this,
integer(i4b), intent(in) nodes,
real(dp), dimension(nodes), intent(inout) hold,
real(dp), dimension(nodes), intent(inout) hnew,
integer(i4b), intent(in) irestore )

Sets hold (head old) to bot whenever a wettable cell is dry

Definition at line 123 of file gwf-npf.f90.

◆ npf_ar()

procedure gwfnpfmodule::gwfnpftype::npf_ar ( class(gwfnpftype) this,
type(gwfictype), intent(in), pointer ic,
type(gwfvsctype), intent(in), pointer vsc,
integer(i4b), dimension(:), intent(inout), pointer, contiguous ibound,
real(dp), dimension(:), intent(inout), pointer, contiguous hnew )

Allocate remaining package arrays, preprocess the input data and call *_ar on xt3d, when active.

Parameters
thisinstance of the NPF package
[in]icinitial conditions
[in]vscviscosity package
[in,out]iboundmodel ibound array
[in,out]hnewpointer to model head array

Definition at line 121 of file gwf-npf.f90.

◆ npf_cf()

procedure gwfnpfmodule::gwfnpftype::npf_cf ( class(gwfnpftype) this,
integer(i4b) kiter,
integer(i4b), intent(in) nodes,
real(dp), dimension(nodes), intent(inout) hnew )

Definition at line 124 of file gwf-npf.f90.

◆ npf_cq()

procedure gwfnpfmodule::gwfnpftype::npf_cq ( class(gwfnpftype) this,
real(dp), dimension(:), intent(inout) hnew,
real(dp), dimension(:), intent(inout) flowja )

Definition at line 127 of file gwf-npf.f90.

◆ npf_da()

procedure gwfnpfmodule::gwfnpftype::npf_da ( class(gwfnpftype) this)

Definition at line 131 of file gwf-npf.f90.

◆ npf_df()

procedure gwfnpfmodule::gwfnpftype::npf_df ( class(gwfnpftype) this,
class(disbasetype), intent(inout), pointer dis,
type(xt3dtype), pointer xt3d,
integer(i4b), intent(in) ingnc,
integer(i4b), intent(in) invsc,
type(gwfnpfoptionstype), intent(in), optional npf_options )

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.

Parameters
thisinstance of the NPF package
[in,out]disthe pointer to the discretization
xt3dthe pointer to the XT3D 'package'
[in]ingncghostnodes enabled? (>0 means yes)
[in]invscviscosity enabled? (>0 means yes)
[in]npf_optionsthe optional options, for when not constructing from file

Definition at line 118 of file gwf-npf.f90.

◆ npf_fc()

procedure gwfnpfmodule::gwfnpftype::npf_fc ( class(gwfnpftype) this,
integer(i4b) kiter,
class(matrixbasetype), pointer matrix_sln,
integer(i4b), dimension(:), intent(in) idxglo,
real(dp), dimension(:), intent(inout) rhs,
real(dp), dimension(:), intent(inout) hnew )
Parameters
thisthis instance
kiterouter iteration number
matrix_slnthe system to be formulated
[in]idxglolookup table from local to global connection number
[in,out]rhsthe righthandside vector
[in,out]hnewthe new head values

Definition at line 125 of file gwf-npf.f90.

◆ npf_fn()

procedure gwfnpfmodule::gwfnpftype::npf_fn ( class(gwfnpftype) this,
integer(i4b) kiter,
class(matrixbasetype), pointer matrix_sln,
integer(i4b), dimension(:), intent(in) idxglo,
real(dp), dimension(:), intent(inout) rhs,
real(dp), dimension(:), intent(inout) hnew )

Definition at line 126 of file gwf-npf.f90.

◆ npf_mc()

procedure gwfnpfmodule::gwfnpftype::npf_mc ( class(gwfnpftype) this,
integer(i4b), intent(in) moffset,
class(matrixbasetype), pointer matrix_sln )

Definition at line 120 of file gwf-npf.f90.

◆ npf_nur()

procedure gwfnpfmodule::gwfnpftype::npf_nur ( class(gwfnpftype) this,
integer(i4b), intent(in) neqmod,
real(dp), dimension(neqmod), intent(inout) x,
real(dp), dimension(neqmod), intent(in) xtemp,
real(dp), dimension(neqmod), intent(inout) dx,
integer(i4b), intent(inout) inewtonur,
real(dp), intent(inout) dxmax,
integer(i4b), intent(inout) locmax )

Under-relaxation of Groundwater Flow Model Heads for current outer iteration using the cell bottoms at the bottom of the model

Definition at line 129 of file gwf-npf.f90.

◆ npf_print_model_flows()

procedure gwfnpfmodule::gwfnpftype::npf_print_model_flows ( class(gwfnpftype) this,
integer(i4b), intent(in) ibudfl,
real(dp), dimension(:), intent(inout) flowja )

Definition at line 130 of file gwf-npf.f90.

◆ npf_rp()

procedure gwfnpfmodule::gwfnpftype::npf_rp ( class(gwfnpftype) this)

Read and prepare NPF stress period data.

Definition at line 122 of file gwf-npf.f90.

◆ npf_save_model_flows()

procedure gwfnpfmodule::gwfnpftype::npf_save_model_flows ( class(gwfnpftype) this,
real(dp), dimension(:), intent(in) flowja,
integer(i4b), intent(in) icbcfl,
integer(i4b), intent(in) icbcun )

Definition at line 128 of file gwf-npf.f90.

◆ prepare_edge_lookup()

procedure, private gwfnpfmodule::gwfnpftype::prepare_edge_lookup ( class(gwfnpftype) this)
private

Definition at line 164 of file gwf-npf.f90.

◆ prepcheck()

procedure, private gwfnpfmodule::gwfnpftype::prepcheck ( class(gwfnpftype) this)
private

Definition at line 155 of file gwf-npf.f90.

◆ preprocess_input()

procedure, private gwfnpfmodule::gwfnpftype::preprocess_input ( class(gwfnpftype) this)
private

This routine consists of the following steps:

  1. convert cells to noflow when all transmissive parameters equal zero
  2. perform initial wetting and drying
  3. initialize cell saturation
  4. calculate saturated conductance (when not xt3d)
  5. If NEWTON under-relaxation, determine lower most node
    Parameters
    thisthe instance of the NPF package

Definition at line 156 of file gwf-npf.f90.

◆ qcalc()

procedure, private gwfnpfmodule::gwfnpftype::qcalc ( class(gwfnpftype) this,
integer(i4b), intent(in) n,
integer(i4b), intent(in) m,
real(dp), intent(in) hn,
real(dp), intent(in) hm,
integer(i4b), intent(in) icon,
real(dp), intent(inout) qnm )
private

Definition at line 144 of file gwf-npf.f90.

◆ read_check_ionper()

procedure numericalpackagemodule::numericalpackagetype::read_check_ionper ( class(numericalpackagetype), intent(inout) this)
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.

Parameters
[in,out]thisNumericalPackageType object

Definition at line 56 of file NumericalPackage.f90.

◆ rewet_check()

procedure gwfnpfmodule::gwfnpftype::rewet_check ( class(gwfnpftype) this,
integer(i4b), intent(in) kiter,
integer(i4b), intent(in) node,
real(dp), intent(in) hm,
integer(i4b), intent(in) ibdm,
integer(i4b), intent(in) ihc,
real(dp), dimension(:), intent(inout) hnew,
integer(i4b), intent(out) irewet )

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 133 of file gwf-npf.f90.

◆ sav_sat()

procedure gwfnpfmodule::gwfnpftype::sav_sat ( class(gwfnpftype) this,
integer(i4b), intent(in) ibinun )

Definition at line 137 of file gwf-npf.f90.

◆ sav_spdis()

procedure gwfnpfmodule::gwfnpftype::sav_spdis ( class(gwfnpftype) this,
integer(i4b), intent(in) ibinun )

Definition at line 136 of file gwf-npf.f90.

◆ set_edge_properties()

procedure gwfnpfmodule::gwfnpftype::set_edge_properties ( class(gwfnpftype) this,
integer(i4b), intent(in) nodedge,
integer(i4b), intent(in) ihcedge,
real(dp), intent(in) q,
real(dp), intent(in) area,
real(dp), intent(in) nx,
real(dp), intent(in) ny,
real(dp), intent(in) distance )

Definition at line 139 of file gwf-npf.f90.

◆ set_names()

procedure numericalpackagemodule::numericalpackagetype::set_names ( class(numericalpackagetype), intent(inout) this,
integer(i4b), intent(in) ibcnum,
character(len=*), intent(in) name_model,
character(len=*), intent(in) pakname,
character(len=*), intent(in) ftype,
character(len=*), intent(in), optional input_mempath )
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.

Parameters
[in,out]thisNumericalPackageType object
[in]ibcnumunique package number
[in]name_modelname of the model
[in]paknamename of the package
[in]ftypepackage type

Definition at line 53 of file NumericalPackage.f90.

◆ set_options()

procedure, private gwfnpfmodule::gwfnpftype::set_options ( class(gwfnpftype) this,
type(gwfnpfoptionstype), intent(in) options )
private

Definition at line 153 of file gwf-npf.f90.

◆ source_griddata()

procedure, private gwfnpfmodule::gwfnpftype::source_griddata ( class(gwfnpftype) this)
private

Definition at line 150 of file gwf-npf.f90.

◆ source_options()

procedure, private gwfnpfmodule::gwfnpftype::source_options ( class(gwfnpftype) this)
private

Definition at line 149 of file gwf-npf.f90.

◆ store_original_k_arrays()

procedure, private gwfnpfmodule::gwfnpftype::store_original_k_arrays ( class(gwfnpftype) this,
integer(i4b), intent(in) ncells,
integer(i4b), intent(in) njas )
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 147 of file gwf-npf.f90.

◆ thksat()

procedure, private gwfnpfmodule::gwfnpftype::thksat ( class(gwfnpftype) this,
integer(i4b), intent(in) n,
real(dp), intent(in) hn,
real(dp), intent(inout) thksat )
private

Definition at line 143 of file gwf-npf.f90.

◆ wd()

procedure, private gwfnpfmodule::gwfnpftype::wd ( class(gwfnpftype) this,
integer(i4b), intent(in) kiter,
real(dp), dimension(:), intent(inout) hnew )
private

Definition at line 145 of file gwf-npf.f90.

◆ wdmsg()

procedure, private gwfnpfmodule::gwfnpftype::wdmsg ( class(gwfnpftype) this,
integer(i4b), intent(in) icode,
integer(i4b), intent(inout) ncnvrt,
character(len=30), dimension(5), intent(inout) nodcnvrt,
character(len=3), dimension(5), intent(inout) acnvrt,
integer(i4b), intent(inout) ihdcnv,
integer(i4b), intent(in) kiter,
integer(i4b), intent(in) n )
private

Definition at line 146 of file gwf-npf.f90.

Member Data Documentation

◆ aname

character(len=24), dimension(:), pointer gwfnpfmodule::gwfnpftype::aname => null()

Definition at line 45 of file gwf-npf.f90.

◆ angle1

real(dp), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::angle1 => null()

Definition at line 86 of file gwf-npf.f90.

◆ angle2

real(dp), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::angle2 => null()

Definition at line 87 of file gwf-npf.f90.

◆ angle3

real(dp), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::angle3 => null()

Definition at line 88 of file gwf-npf.f90.

◆ condsat

real(dp), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::condsat => null()

Definition at line 93 of file gwf-npf.f90.

◆ default_form

class(gwfnpfformulationtype), pointer gwfnpfmodule::gwfnpftype::default_form => null()

Definition at line 116 of file gwf-npf.f90.

◆ dis

class(disbasetype), pointer numericalpackagemodule::numericalpackagetype::dis => null()
inherited

Definition at line 50 of file NumericalPackage.f90.

◆ edge_idxs

integer(i4b), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::edge_idxs => null()

Definition at line 103 of file gwf-npf.f90.

◆ filtyp

character(len=lenftype) numericalpackagemodule::numericalpackagetype::filtyp = ''
inherited

Definition at line 33 of file NumericalPackage.f90.

◆ flow_formulations

type(gwfnpfformcontainertype), dimension(max_ext_flow_forms), private gwfnpfmodule::gwfnpftype::flow_formulations
private

Definition at line 114 of file gwf-npf.f90.

114 type(GwfNpfFormContainerType), dimension(MAX_EXT_FLOW_FORMS), private :: &
115 flow_formulations !< alternative flow calculations by extension

◆ hdry

real(dp), pointer gwfnpfmodule::gwfnpftype::hdry => null()

Definition at line 66 of file gwf-npf.f90.

◆ hnew

real(dp), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::hnew => null()

Definition at line 47 of file gwf-npf.f90.

◆ hnoflo

real(dp), pointer gwfnpfmodule::gwfnpftype::hnoflo => null()

Definition at line 59 of file gwf-npf.f90.

◆ iangle1

integer(i4b), pointer gwfnpfmodule::gwfnpftype::iangle1 => null()

Definition at line 83 of file gwf-npf.f90.

◆ iangle2

integer(i4b), pointer gwfnpfmodule::gwfnpftype::iangle2 => null()

Definition at line 84 of file gwf-npf.f90.

◆ iangle3

integer(i4b), pointer gwfnpfmodule::gwfnpftype::iangle3 => null()

Definition at line 85 of file gwf-npf.f90.

◆ iasym

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iasym => null()
inherited

Definition at line 41 of file NumericalPackage.f90.

◆ iavgkeff

integer(i4b), pointer gwfnpfmodule::gwfnpftype::iavgkeff => null()

Definition at line 78 of file gwf-npf.f90.

◆ ibotnode

integer(i4b), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::ibotnode => null()

Definition at line 94 of file gwf-npf.f90.

◆ ibound

integer(i4b), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::ibound => null()

Definition at line 46 of file gwf-npf.f90.

◆ ic

type(gwfictype), pointer gwfnpfmodule::gwfnpftype::ic => null()

Definition at line 41 of file gwf-npf.f90.

◆ icalcspdis

integer(i4b), pointer gwfnpfmodule::gwfnpftype::icalcspdis => null()

Definition at line 56 of file gwf-npf.f90.

◆ icellavg

integer(i4b), pointer gwfnpfmodule::gwfnpftype::icellavg => null()

Definition at line 64 of file gwf-npf.f90.

◆ icelltype

integer(i4b), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::icelltype => null()

Definition at line 67 of file gwf-npf.f90.

◆ id

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::id => null()
inherited

Definition at line 37 of file NumericalPackage.f90.

◆ idewatcv

integer(i4b), pointer gwfnpfmodule::gwfnpftype::idewatcv => null()

Definition at line 52 of file gwf-npf.f90.

◆ iedge_ptr

integer(i4b), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::iedge_ptr => null()

Definition at line 102 of file gwf-npf.f90.

◆ iformulation

integer(i4b), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::iformulation => null()

Definition at line 113 of file gwf-npf.f90.

◆ igwfnewtonur

integer(i4b), pointer gwfnpfmodule::gwfnpftype::igwfnewtonur => null()

Definition at line 55 of file gwf-npf.f90.

◆ ihcedge

integer(i4b), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::ihcedge => null()

Definition at line 100 of file gwf-npf.f90.

◆ ihdwet

integer(i4b), pointer gwfnpfmodule::gwfnpftype::ihdwet => null()

Definition at line 63 of file gwf-npf.f90.

◆ ihighcellsat

integer(i4b), pointer gwfnpfmodule::gwfnpftype::ihighcellsat => null()

Definition at line 54 of file gwf-npf.f90.

◆ ik22

integer(i4b), pointer gwfnpfmodule::gwfnpftype::ik22 => null()

Definition at line 79 of file gwf-npf.f90.

◆ ik22overk

integer(i4b), pointer gwfnpfmodule::gwfnpftype::ik22overk => null()

Definition at line 81 of file gwf-npf.f90.

◆ ik33

integer(i4b), pointer gwfnpfmodule::gwfnpftype::ik33 => null()

Definition at line 80 of file gwf-npf.f90.

◆ ik33overk

integer(i4b), pointer gwfnpfmodule::gwfnpftype::ik33overk => null()

Definition at line 82 of file gwf-npf.f90.

◆ iname

integer(i4b), pointer gwfnpfmodule::gwfnpftype::iname => null()

Definition at line 44 of file gwf-npf.f90.

◆ inewton

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::inewton => null()
inherited

Definition at line 40 of file NumericalPackage.f90.

◆ input_fname

character(len=linelength), pointer numericalpackagemodule::numericalpackagetype::input_fname => null()
inherited

Definition at line 32 of file NumericalPackage.f90.

◆ input_mempath

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::input_mempath = ''
inherited

Definition at line 31 of file NumericalPackage.f90.

◆ intvk

integer(i4b), pointer gwfnpfmodule::gwfnpftype::intvk => null()

Definition at line 106 of file gwf-npf.f90.

◆ inunit

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::inunit => null()
inherited

Definition at line 38 of file NumericalPackage.f90.

◆ invsc

integer(i4b), pointer gwfnpfmodule::gwfnpftype::invsc => null()

Definition at line 107 of file gwf-npf.f90.

◆ ionper

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::ionper => null()
inherited

Definition at line 45 of file NumericalPackage.f90.

◆ iout

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iout => null()
inherited

Definition at line 39 of file NumericalPackage.f90.

◆ ipakcb

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::ipakcb => null()
inherited

Definition at line 44 of file NumericalPackage.f90.

◆ iperched

integer(i4b), pointer gwfnpfmodule::gwfnpftype::iperched => null()

Definition at line 50 of file gwf-npf.f90.

◆ iprflow

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iprflow => null()
inherited

Definition at line 43 of file NumericalPackage.f90.

◆ iprpak

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iprpak => null()
inherited

Definition at line 42 of file NumericalPackage.f90.

◆ irewet

integer(i4b), pointer gwfnpfmodule::gwfnpftype::irewet => null()

Definition at line 61 of file gwf-npf.f90.

◆ isavsat

integer(i4b), pointer gwfnpfmodule::gwfnpftype::isavsat => null()

Definition at line 58 of file gwf-npf.f90.

◆ isavspdis

integer(i4b), pointer gwfnpfmodule::gwfnpftype::isavspdis => null()

Definition at line 57 of file gwf-npf.f90.

◆ ithickstartflag

integer(i4b), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::ithickstartflag => null()

Definition at line 68 of file gwf-npf.f90.

◆ ithickstrt

integer(i4b), pointer gwfnpfmodule::gwfnpftype::ithickstrt => null()

Definition at line 53 of file gwf-npf.f90.

◆ ivarcv

integer(i4b), pointer gwfnpfmodule::gwfnpftype::ivarcv => null()

Definition at line 51 of file gwf-npf.f90.

◆ iwetdry

integer(i4b), pointer gwfnpfmodule::gwfnpftype::iwetdry => null()

Definition at line 90 of file gwf-npf.f90.

◆ iwetit

integer(i4b), pointer gwfnpfmodule::gwfnpftype::iwetit => null()

Definition at line 62 of file gwf-npf.f90.

◆ ixt3d

integer(i4b), pointer gwfnpfmodule::gwfnpftype::ixt3d => null()

Definition at line 48 of file gwf-npf.f90.

◆ ixt3drhs

integer(i4b), pointer gwfnpfmodule::gwfnpftype::ixt3drhs => null()

Definition at line 49 of file gwf-npf.f90.

◆ k11

real(dp), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::k11 => null()

Definition at line 71 of file gwf-npf.f90.

◆ k11input

real(dp), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::k11input => null()

Definition at line 75 of file gwf-npf.f90.

◆ k22

real(dp), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::k22 => null()

Definition at line 72 of file gwf-npf.f90.

◆ k22input

real(dp), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::k22input => null()

Definition at line 76 of file gwf-npf.f90.

◆ k33

real(dp), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::k33 => null()

Definition at line 73 of file gwf-npf.f90.

◆ k33input

real(dp), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::k33input => null()

Definition at line 77 of file gwf-npf.f90.

◆ kchangeper

integer(i4b), pointer gwfnpfmodule::gwfnpftype::kchangeper => null()

Definition at line 109 of file gwf-npf.f90.

◆ kchangestp

integer(i4b), pointer gwfnpfmodule::gwfnpftype::kchangestp => null()

Definition at line 110 of file gwf-npf.f90.

◆ krel

real(dp), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::krel => null()

Definition at line 74 of file gwf-npf.f90.

◆ lastedge

integer(i4b), pointer gwfnpfmodule::gwfnpftype::lastedge => null()

Definition at line 98 of file gwf-npf.f90.

◆ lastonper

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::lastonper => null()
inherited

Definition at line 46 of file NumericalPackage.f90.

◆ memorypath

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::memorypath = ''
inherited

Definition at line 28 of file NumericalPackage.f90.

◆ memorypathmodel

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::memorypathmodel = ''
inherited

Definition at line 29 of file NumericalPackage.f90.

◆ name_model

character(len=lenmodelname) numericalpackagemodule::numericalpackagetype::name_model = ''
inherited

Definition at line 26 of file NumericalPackage.f90.

◆ nedges

integer(i4b), pointer gwfnpfmodule::gwfnpftype::nedges => null()

Definition at line 97 of file gwf-npf.f90.

◆ nodedge

integer(i4b), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::nodedge => null()

Definition at line 99 of file gwf-npf.f90.

◆ nodekchange

integer(i4b), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::nodekchange => null()

Definition at line 111 of file gwf-npf.f90.

◆ package_type

character(len=lenftype), pointer numericalpackagemodule::numericalpackagetype::package_type => null()
inherited

Definition at line 34 of file NumericalPackage.f90.

◆ packname

character(len=lenpackagename) numericalpackagemodule::numericalpackagetype::packname = ''
inherited

Definition at line 27 of file NumericalPackage.f90.

◆ parser

type(blockparsertype) numericalpackagemodule::numericalpackagetype::parser
inherited

Definition at line 49 of file NumericalPackage.f90.

49 type(BlockParserType) :: parser !< parser object for reading blocks of information

◆ propsedge

real(dp), dimension(:, :), pointer, contiguous gwfnpfmodule::gwfnpftype::propsedge => null()

Definition at line 101 of file gwf-npf.f90.

◆ sat

real(dp), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::sat => null()

Definition at line 92 of file gwf-npf.f90.

◆ satomega

real(dp), pointer gwfnpfmodule::gwfnpftype::satomega => null()

Definition at line 60 of file gwf-npf.f90.

◆ spdis

real(dp), dimension(:, :), pointer, contiguous gwfnpfmodule::gwfnpftype::spdis => null()

Definition at line 96 of file gwf-npf.f90.

◆ spdis_wa

type(spdisworkarraytype), pointer gwfnpfmodule::gwfnpftype::spdis_wa => null()

Definition at line 104 of file gwf-npf.f90.

◆ tvk

type(tvktype), pointer gwfnpfmodule::gwfnpftype::tvk => null()

Definition at line 108 of file gwf-npf.f90.

◆ vsc

type(gwfvsctype), pointer gwfnpfmodule::gwfnpftype::vsc => null()

Definition at line 42 of file gwf-npf.f90.

◆ wetdry

real(dp), dimension(:), pointer, contiguous gwfnpfmodule::gwfnpftype::wetdry => null()

Definition at line 91 of file gwf-npf.f90.

◆ wetfct

real(dp), pointer gwfnpfmodule::gwfnpftype::wetfct => null()

Definition at line 65 of file gwf-npf.f90.

◆ xt3d

type(xt3dtype), pointer gwfnpfmodule::gwfnpftype::xt3d => null()

Definition at line 43 of file gwf-npf.f90.


The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Model/GroundWaterFlow/gwf-npf.f90