lakmodule::laktype Type Reference

Inheritance diagram for lakmodule::laktype:

Collaboration diagram for lakmodule::laktype:

Public Member Functions
procedure	lak_allocate_scalars (this)
	Allocate scalar members.
procedure	lak_allocate_arrays (this)
	Allocate scalar members.
procedure	lak_checkin_deprecated_names (this)
	Alias deprecated LAK variable names to their current storage.
procedure	source_options (this)
	Source OPTIONS block from input context.
procedure	source_dimensions (this)
	Source DIMENSIONS block from input context and load static data.
procedure	read_initial_attr (this)
	Read the initial parameters for this package.
procedure	set_pointers (this, neq, ibound, xnew, xold, flowja)
	Set pointers to model arrays and variables so that a package has access to these things.
procedure	bnd_ar (this)
	Allocate and Read.
procedure	bnd_ac (this, moffset, sparse)
	Add the lake rows and columns to the sparse matrix.
procedure	bnd_mc (this, moffset, matrix_sln)
	Find the matrix position of each lake row and connection.
procedure	bnd_rp (this)
	Read and prepare (stress period data).
procedure	bnd_ad (this)
	Add package connection to matrix.
procedure	bnd_cf (this)
	Formulate the HCOF and RHS terms.
procedure	bnd_fc (this, rhs, ia, idxglo, matrix_sln)
	Copy rhs and hcof into solution rhs and amat.
procedure	bnd_fn (this, rhs, ia, idxglo, matrix_sln)
	Fill newton terms.
procedure	bnd_nur (this, neqpak, x, xtemp, dx, inewtonur, dxmax, locmax)
	Apply Newton under-relaxation to the lake stage.
procedure	bnd_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak)
	Final convergence check for package.
procedure	bnd_cq (this, x, flowja, iadv)
	Calculate flows.
procedure	bnd_ot_model_flows (this, icbcfl, ibudfl, icbcun, imap)
	Write flows to binary file and/or print flows to budget.
procedure	bnd_ot_package_flows (this, icbcfl, ibudfl)
	Output LAK package flow terms.
procedure	bnd_ot_dv (this, idvsave, idvprint)
	Save LAK-calculated values to binary file.
procedure	bnd_ot_bdsummary (this, kstp, kper, iout, ibudfl)
	Write LAK budget to listing file.
procedure	bnd_da (this)
	Deallocate objects.
procedure	define_listlabel (this)
	Define the list heading that is written to iout when PRINT_INPUT option is used.
procedure, public	bnd_obs_supported (this)
	Procedures related to observations (type-bound).
procedure, public	bnd_df_obs (this)
	Store observation type supported by LAK package. Overrides BndTypebnd_df_obs.
procedure, public	bnd_rp_obs (this)
	Process each observation.
procedure, public	bnd_bd_obs (this)
	Calculate observations this time step and call ObsTypeSaveOneSimval for each LakType observation.
procedure, public	lak_calculate_vol (this, ilak, stage, volume)
	Calculate the volume of a lake at a given stage.
procedure	lak_activate_density (this)
	Activate addition of density terms.
procedure	lak_activate_viscosity (this)
	Activate viscosity terms.
procedure	bnd_df (this, neq, dis)
	@ brief Define boundary package options and dimensions
procedure, public	bnd_df (this, neq, dis)
	@ brief Define boundary package options and dimensions
procedure	bnd_ad (this)
	Advance the package one time step.
procedure	bnd_ad (this)
	@ brief Advance the boundary package
procedure	bnd_rp (this)
procedure	bnd_rp (this)
	@ brief Allocate and read method for package
procedure	bnd_rp_log (this)
	Write the input list to the listing file if requested.
procedure, public	bnd_rp_log (this)
	Log period input for a boundary package.
procedure	validate_ifno (this, ifno_val, nfeatures, nboundchk, feature_label, blockname)
	@ brief Validate a list-input row's IFNO and update the per-feature coverage counter
procedure	report_ifno_coverage (this, nboundchk, nfeatures, feature_label, blockname, check_missing)
	@ brief Report missing or duplicate list-input rows for each feature
procedure	bnd_da (this)
	@ brief Deallocate package memory
procedure	bnd_da (this)
	@ brief Deallocate package memory
procedure	allocate_scalars (this)
	@ brief Allocate package scalars
procedure	allocate_scalars (this)
	@ brief Allocate package scalars
procedure	allocate_scalars (this)
	@ brief Allocate package scalars
procedure	allocate_arrays (this, nodelist, auxvar)
	@ brief Allocate package arrays
procedure	allocate_arrays (this, nodelist, auxvar)
	@ brief Allocate package arrays
procedure	allocate_featureauxvar (this)
	Point the per-feature auxiliary variable array at the input context's permanent, feature-indexed AUX array. For packages with PACKAGEDATA AUX variables only. A live alias, permuted from row order to IFNO order, skipping out-of-range IFNO.
procedure	source_options (this)
	@ brief Source package options from input context
procedure	log_options (this, found, sfacauxname)
	@ brief Log package options
procedure	source_dimensions (this)
	@ brief Source package dimensions from input context
procedure	cellid_to_nlist (this)
	@ brief Update package nodelist
procedure	nodeu_to_nlist (this)
	@ brief Update package nodelist
procedure	layarr_to_nlist (this)
	Update the nodelist based on layer number variable input.
procedure	default_nodelist (this)
	Assign default nodelist when READASARRAYS is specified.
procedure	check_cellid (this, ii, cellid, mshape, ndim)
	@ brief Check for valid cellid
procedure	write_lstfile (this)
	@ brief Log package stress period input
procedure	bound_value (this, col, row)
	@ brief Return a bound value
procedure	bnd_ac (this, moffset, sparse)
	@ brief Add boundary package connection to matrix
procedure	bnd_mc (this, moffset, matrix_sln)
	@ brief Map boundary package connection to matrix
procedure	bnd_ar (this)
	@ brief Allocate and read method for boundary package
procedure	bnd_ck (this)
	@ brief Check boundary package period data
procedure	bnd_reset (this)
	@ brief Reset bnd package before formulating
procedure	bnd_cf (this)
	@ brief Formulate the package hcof and rhs terms.
procedure	bnd_fc (this, rhs, ia, idxglo, matrix_sln)
	@ brief Copy hcof and rhs terms into solution.
procedure	bnd_fn (this, rhs, ia, idxglo, matrix_sln)
	@ brief Add Newton-Raphson terms for package into solution.
procedure	bnd_nur (this, neqpak, x, xtemp, dx, inewtonur, dxmax, locmax)
	@ brief Apply Newton-Raphson under-relaxation for package.
procedure	bnd_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak)
	@ brief Convergence check for package.
procedure	bnd_cq (this, x, flowja, iadv)
	@ brief Calculate advanced package flows.
procedure	bnd_bd (this, model_budget)
	@ brief Add package flows to model budget.
procedure	bnd_ot_model_flows (this, icbcfl, ibudfl, icbcun, imap)
	@ brief Output package flow terms.
procedure	bnd_ot_package_flows (this, icbcfl, ibudfl)
	@ brief Output advanced package flow terms.
procedure	bnd_ot_dv (this, idvsave, idvprint)
	@ brief Output advanced package dependent-variable terms.
procedure	bnd_ot_bdsummary (this, kstp, kper, iout, ibudfl)
	@ brief Output advanced package budget summary.
procedure	bnd_dt (this)
	Submit an ATS time step request (no-op by default).
procedure	bnd_fp (this)
	Final processing at end of simulation (no-op by default).
procedure	pack_initialize (this)
	@ brief Allocate and initialize select package members
procedure	read_options (this)
	@ brief Read additional options for package
procedure	read_dimensions (this)
	@ brief Read dimensions for package
procedure	read_initial_attr (this)
	@ brief Read initial parameters for package
procedure	bnd_options (this, option, found)
	@ brief Read additional options for package
procedure	bnd_cq_simrate (this, hnew, flowja, imover)
	@ brief Calculate simrate.
procedure	bnd_cq_simtomvr (this, flowja)
	@ brief Calculate flow to the mover.
procedure	set_pointers (this, neq, ibound, xnew, xold, flowja)
	@ brief Set pointers to model variables
procedure	define_listlabel (this)
	@ brief Define the list label for the package
procedure	copy_boundname (this)
	@ brief Copy boundnames into boundnames_cst
procedure, public	bnd_obs_supported (this)
	Determine if observations are supported.
procedure, public	bnd_df_obs (this)
	Define the observation types available in the package.
procedure, public	bnd_bd_obs (this)
	Save observations for the package.
procedure, public	bnd_ot_obs (this)
	Output observations for the package.
procedure, public	bnd_rp_obs (this)
	Read and prepare observations for a package.
procedure, public	bnd_rp_ts (this)
	Assign time series links for the package.
procedure, public	bnd_activate_viscosity (this)
	Activate viscosity terms.
procedure	set_names (this, ibcnum, name_model, pakname, ftype, input_mempath)
	@ brief Set package names
procedure	da (this)
	@ brief Deallocate package scalars
procedure	read_check_ionper (this)
	@ brief Check ionper
procedure	get_block_data (this, tags, lfound, varinames)
	@ brief Read griddata block for a package

Public Attributes
character(len=16), dimension(:), pointer, contiguous	clakbudget => NULL()
character(len=16), dimension(:), pointer, contiguous	cauxcbc => NULL()
integer(i4b), pointer	iprhed => null()
integer(i4b), pointer	istageout => null()
integer(i4b), pointer	ibudgetout => null()
integer(i4b), pointer	ibudcsv => null()
integer(i4b), pointer	ipakcsv => null()
character(len=:), allocatable	pakcsvfile
	requested PACKAGE_CONVERGENCE file, opened in lak_ar once the IMPLICIT option is known
integer(i4b), pointer	cbcauxitems => NULL()
integer(i4b), pointer	nlakes => NULL()
integer(i4b), pointer	noutlets => NULL()
integer(i4b), pointer	ntables => NULL()
real(dp), pointer	convlength => NULL()
real(dp), pointer	convtime => NULL()
real(dp), pointer	outdmax => NULL()
integer(i4b), pointer	igwhcopt => NULL()
integer(i4b), pointer	iconvchk => NULL()
integer(i4b), pointer	maxlakit => NULL()
	maximum number of iterations in LAK solve
real(dp), pointer	surfdep => NULL()
real(dp), pointer	dmaxchg => NULL()
real(dp), pointer	delh => NULL()
integer(i4b), pointer	check_attr => NULL()
integer(i4b), pointer	iimplicit => NULL()
	flag: solve lake stage in the gwf matrix
integer(i4b), pointer	iforceleg => NULL()
	flag (dev): force every active lake onto the legacy solver
integer(i4b), pointer	iforceleglak => NULL()
	lake (dev) forced onto the legacy solver, 0 if none
integer(i4b), pointer	bditems => NULL()
integer(i4b), dimension(:), pointer, contiguous	nlakeconn => null()
integer(i4b), dimension(:), pointer, contiguous	idxlakeconn => null()
integer(i4b), dimension(:), pointer, contiguous	ntabrow => null()
real(dp), dimension(:), pointer, contiguous	strt => null()
real(dp), dimension(:), pointer, contiguous	laketop => null()
real(dp), dimension(:), pointer, contiguous	lakebot => null()
real(dp), dimension(:), pointer, contiguous	sareamax => null()
character(len=lenboundname), dimension(:), pointer, contiguous	lakename => null()
character(len=8), dimension(:), pointer, contiguous	status => null()
real(dp), dimension(:), pointer, contiguous	avail => null()
real(dp), dimension(:), pointer, contiguous	lkgwsink => null()
real(dp), dimension(:), pointer, contiguous	stage => null()
real(dp), dimension(:), pointer, contiguous	rainfall => null()
real(dp), dimension(:), pointer, contiguous	evaporation => null()
real(dp), dimension(:), pointer, contiguous	runoff => null()
real(dp), dimension(:), pointer, contiguous	inflow => null()
real(dp), dimension(:), pointer, contiguous	withdrawal => null()
integer(i4b), dimension(:), pointer, contiguous	ialaktab => null()
real(dp), dimension(:), pointer, contiguous	tabstage => null()
real(dp), dimension(:), pointer, contiguous	tabvolume => null()
real(dp), dimension(:), pointer, contiguous	tabsarea => null()
real(dp), dimension(:), pointer, contiguous	tabwarea => null()
integer(i4b), dimension(:), pointer, contiguous	ncncvr => null()
integer(i4b), dimension(:), pointer, contiguous	ilegacy => null()
integer(i4b), dimension(:), pointer, contiguous	nstuck => null()
real(dp), dimension(:), pointer, contiguous	surfin => null()
real(dp), dimension(:), pointer, contiguous	surfout => null()
real(dp), dimension(:), pointer, contiguous	surfout1 => null()
real(dp), dimension(:), pointer, contiguous	precip => null()
real(dp), dimension(:), pointer, contiguous	precip1 => null()
real(dp), dimension(:), pointer, contiguous	evap => null()
real(dp), dimension(:), pointer, contiguous	evap1 => null()
real(dp), dimension(:), pointer, contiguous	evapo => null()
real(dp), dimension(:), pointer, contiguous	withr => null()
real(dp), dimension(:), pointer, contiguous	withr1 => null()
real(dp), dimension(:), pointer, contiguous	flwin => null()
real(dp), dimension(:), pointer, contiguous	flwiter => null()
real(dp), dimension(:), pointer, contiguous	flwiter1 => null()
real(dp), dimension(:), pointer, contiguous	seep => null()
real(dp), dimension(:), pointer, contiguous	seep1 => null()
real(dp), dimension(:), pointer, contiguous	seep0 => null()
real(dp), dimension(:), pointer, contiguous	stageiter => null()
real(dp), dimension(:), pointer, contiguous	chterm => null()
integer(i4b), dimension(:), pointer, contiguous	iseepc => null()
integer(i4b), dimension(:), pointer, contiguous	idhc => null()
real(dp), dimension(:), pointer, contiguous	en1 => null()
real(dp), dimension(:), pointer, contiguous	en2 => null()
real(dp), dimension(:), pointer, contiguous	r1 => null()
real(dp), dimension(:), pointer, contiguous	r2 => null()
real(dp), dimension(:), pointer, contiguous	dh0 => null()
real(dp), dimension(:), pointer, contiguous	s0 => null()
real(dp), dimension(:), pointer, contiguous	qgwf0 => null()
integer(i4b), dimension(:), pointer, contiguous	idxlocnode => null()
	local index of each lake row in x/rhs
integer(i4b), dimension(:), pointer, contiguous	idxdiag => null()
	position of lake-row diagonal (per lake)
integer(i4b), dimension(:), pointer, contiguous	idxoffdglo => null()
	position of lake-row -> gwf column (per connection)
integer(i4b), dimension(:), pointer, contiguous	idxsymdglo => null()
	position of gwf-row diagonal (per connection)
integer(i4b), dimension(:), pointer, contiguous	idxsymoffdglo => null()
	position of gwf-row -> lake column (per connection)
integer(i4b), dimension(:), pointer, contiguous	imap => null()
integer(i4b), dimension(:), pointer, contiguous	gwfconn => null()
integer(i4b), dimension(:), pointer, contiguous	nodesontop => null()
integer(i4b), dimension(:), pointer, contiguous	ictype => null()
real(dp), dimension(:), pointer, contiguous	bedleak => null()
real(dp), dimension(:), pointer, contiguous	belev => null()
real(dp), dimension(:), pointer, contiguous	telev => null()
real(dp), dimension(:), pointer, contiguous	connlength => null()
real(dp), dimension(:), pointer, contiguous	connwidth => null()
real(dp), dimension(:), pointer, contiguous	sarea => null()
real(dp), dimension(:), pointer, contiguous	warea => null()
real(dp), dimension(:), pointer, contiguous	satcond => null()
real(dp), dimension(:), pointer, contiguous	simcond => null()
real(dp), dimension(:), pointer, contiguous	simlakgw => null()
integer(i4b), dimension(:), pointer, contiguous	lakein => null()
integer(i4b), dimension(:), pointer, contiguous	lakeout => null()
integer(i4b), dimension(:), pointer, contiguous	iouttype => null()
real(dp), dimension(:), pointer, contiguous	outrate => null()
real(dp), dimension(:), pointer, contiguous	outinvert => null()
real(dp), dimension(:), pointer, contiguous	outwidth => null()
real(dp), dimension(:), pointer, contiguous	outrough => null()
real(dp), dimension(:), pointer, contiguous	outslope => null()
real(dp), dimension(:), pointer, contiguous	simoutrate => null()
logical(lgp), dimension(:), pointer, contiguous	outlet_invert_set => null()
logical(lgp), dimension(:), pointer, contiguous	outlet_width_set => null()
logical(lgp), dimension(:), pointer, contiguous	outlet_rough_set => null()
logical(lgp), dimension(:), pointer, contiguous	outlet_slope_set => null()
real(dp), dimension(:), pointer, contiguous	qauxcbc => null()
real(dp), dimension(:), pointer, contiguous	dbuff => null()
real(dp), dimension(:), pointer, contiguous	qleak => null()
real(dp), dimension(:), pointer, contiguous	holdconn => null()
real(dp), dimension(:), pointer, contiguous	qsto => null()
integer(i4b), pointer	gwfiss => NULL()
real(dp), dimension(:), pointer, contiguous	gwfk11 => NULL()
real(dp), dimension(:), pointer, contiguous	gwfk33 => NULL()
real(dp), dimension(:), pointer, contiguous	gwfsat => NULL()
integer(i4b), pointer	gwfik33 => NULL()
integer(i4b), dimension(:), pointer, contiguous	iboundpak => null()
real(dp), dimension(:), pointer, contiguous	xnewpak => null()
real(dp), dimension(:), pointer, contiguous	xoldpak => null()
type(budgetobjecttype), pointer	budobj => null()
type(lakinputtype)	input
type(tabletype), pointer	stagetab => null()
type(tabletype), pointer	pakcsvtab => null()
integer(i4b), pointer	idense
real(dp), dimension(:, :), pointer, contiguous	denseterms => null()
real(dp), dimension(:, :), pointer, contiguous	viscratios => null()
	viscosity ratios (1: lak vsc ratio; 2: gwf vsc ratio)
integer(i4b), pointer	iper
logical(lgp), pointer	readarraygrid
logical(lgp), pointer	readasarrays
logical(lgp), pointer	ts_active
	.true. if TS6 files are configured in OPTIONS
integer(i4b), dimension(:, :), pointer, contiguous	cellid => null()
	input user cellid list
integer(i4b), dimension(:), pointer, contiguous	nodeulist => null()
	input user nodelist
integer(i4b), dimension(:), pointer, contiguous	pkg_ifno => null()
	advanced feature index
real(dp), dimension(:, :), pointer, contiguous	featureauxvar => null()
	advanced per-feature AUX array
character(len=lenlistlabel), pointer	listlabel => null()
	title of table written for RP
character(len=lenpackagename)	text = ''
	text string for package flow term
character(len=lenauxname), dimension(:), pointer, contiguous	auxname => null()
	vector of auxname
type(characterstringtype), dimension(:), pointer, contiguous	auxname_cst => null()
	copy of vector auxname that can be stored in memory manager
character(len=lenboundname), dimension(:), pointer, contiguous	boundname => null()
	vector of boundnames
type(characterstringtype), dimension(:), pointer, contiguous	boundname_cst => null()
	copy of vector boundname that can be stored in memory manager
integer(i4b), pointer	isadvpak => null()
	flag indicating package is advanced (1) or not (0)
integer(i4b), pointer	ibcnum => null()
	consecutive package number for this boundary condition
integer(i4b), pointer	maxbound => null()
	max number of boundaries
integer(i4b), pointer	nbound => null()
	number of boundaries for current stress period
integer(i4b), pointer	ncolbnd => null()
	number of columns of the bound array
integer(i4b), pointer	iscloc => null()
	bound column to scale with SFAC
integer(i4b), pointer	naux => null()
	number of auxiliary variables
integer(i4b), pointer	inamedbound => null()
	flag to read boundnames
integer(i4b), pointer	iauxmultcol => null()
	column to use as multiplier for column iscloc
integer(i4b), pointer	npakeq => null()
	number of equations in this package (normally 0 unless package adds rows to matrix)
integer(i4b), pointer	ioffset => null()
	offset of this package in the model
integer(i4b), dimension(:), pointer, contiguous	nodelist => null()
	vector of reduced node numbers
integer(i4b), dimension(:), pointer, contiguous	noupdateauxvar => null()
	override auxvars from being updated
real(dp), dimension(:, :), pointer, contiguous	bound => null()
	array of package specific boundary numbers
real(dp), dimension(:), pointer, contiguous	hcof => null()
	diagonal contribution
real(dp), dimension(:), pointer, contiguous	rhs => null()
	right-hand side contribution
real(dp), dimension(:, :), pointer, contiguous	auxvar => null()
	auxiliary variable array
real(dp), dimension(:), pointer, contiguous	simvals => null()
	simulated values
real(dp), dimension(:), pointer, contiguous	simtomvr => null()
	simulated to mover values
integer(i4b), pointer	imover => null()
	flag indicating if the mover is active in the package
type(packagemovertype), pointer	pakmvrobj => null()
	mover object for package
integer(i4b), pointer	ivsc => null()
	flag indicating if viscosity is active in the model
real(dp), dimension(:), pointer, contiguous	condinput => null()
	stores user-specified conductance values
type(timeseriesmanagertype), pointer	tsmanager => null()
	time series manager
type(timearrayseriesmanagertype), pointer	tasmanager => null()
	time array series manager
integer(i4b)	indxconvertflux = 0
	indxconvertflux is column of bound to multiply by area to convert flux to rate
logical(lgp)	allowtimearrayseries = .false.
integer(i4b), pointer	inobspkg => null()
	unit number for obs package
type(obstype), pointer	obs => null()
	observation package
integer(i4b), pointer	neq
	number of equations for model
integer(i4b), dimension(:), pointer, contiguous	ibound => null()
	model ibound array
real(dp), dimension(:), pointer, contiguous	xnew => null()
	model dependent variable (head) for this time step
real(dp), dimension(:), pointer, contiguous	xold => null()
	model dependent variable for last time step
real(dp), dimension(:), pointer, contiguous	flowja => null()
	model intercell flows
integer(i4b), dimension(:), pointer, contiguous	icelltype => null()
	pointer to icelltype array in NPF
character(len=lenmempath)	ictmempath = ''
	memory path to the icelltype data (for GWF this is in NPF)
type(tabletype), pointer	inputtab => null()
	input table object
type(tabletype), pointer	outputtab => null()
	output table object for package flows writtent to the model listing file
type(tabletype), pointer	errortab => null()
	package error table
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	lak_set_legacy lak_set_legacy
procedure, private	lak_check_disconnected lak_check_disconnected
procedure, private	lak_source_packagedata (this)
	Source PACKAGEDATA block from input context.
procedure, private	lak_source_connectiondata (this)
	Source CONNECTIONDATA block from input context.
procedure, private	lak_source_outlets (this)
	Source OUTLETS block from input context.
procedure, private	lak_source_tables (this)
	Source TABLES block from input context.
procedure, private	lak_source_table (this, ilak, mempath, laketable)
	Source one lake's table from its LAKTAB6 subpackage.
procedure, private	lak_check_valid (this, itemno)
	Determine if a valid lake or outlet number has been specified.
procedure, private	lak_set_nonneg_value (this, n, itemno, setting, value_array, label)
	Apply a PERIOD lake setting and require its value be non-negative.
procedure, private	lak_set_attribute_error (this, ilak, keyword, msg)
	Issue a parameter error for lake ilak.
procedure, private	lak_bound_update (this)
	Store the lake head and connection conductance in the bound array.
procedure, private	lak_calculate_sarea (this, ilak, stage, sarea)
	Calculate the surface area of a lake at a given stage.
procedure, private	lak_calculate_warea (this, ilak, stage, warea, hin)
	Calculate the wetted area of a lake at a given stage.
procedure, private	lak_calculate_conn_warea (this, ilak, iconn, stage, head, wa)
	Calculate the wetted area of a lake connection at a given stage.
procedure, private	lak_calculate_conductance (this, ilak, stage, conductance)
	Calculate the total conductance for a lake at a provided stage.
procedure, private	lak_calculate_cond_head (this, iconn, stage, head, vv)
	Calculate the controlling lake stage or groundwater head used to calculate the conductance for a lake connection from a provided stage and groundwater head.
procedure, private	lak_calculate_conn_conductance (this, ilak, iconn, stage, head, cond)
	Calculate the conductance for a lake connection at a provided stage and groundwater head.
procedure, private	lak_calculate_exchange (this, ilak, stage, totflow)
	Calculate the total groundwater-lake flow at a provided stage.
procedure, private	lak_calculate_conn_exchange (this, ilak, iconn, stage, head, flow, gwfhcof, gwfrhs)
	Calculate the groundwater-lake flow at a provided stage and groundwater head.
procedure, private	lak_calculate_conn_exchange_deriv (this, ilak, iconn, stage, head, flow, dqds, dqdh)
	Lakebed seepage and its derivatives for a connection (IMPLICIT).
procedure, private	lak_estimate_conn_exchange (this, iflag, ilak, iconn, idry, stage, head, flow, source, gwfhcof, gwfrhs)
	Calculate the groundwater-lake flow at a provided stage and groundwater head.
procedure, private	lak_calculate_storagechange (this, ilak, stage, stage0, delt, dvr)
	Calculate the storage change in a lake based on provided stages and a passed delt.
procedure, private	lak_calculate_rainfall (this, ilak, stage, ra)
	Calculate the rainfall for a lake.
procedure, private	lak_calculate_runoff (this, ilak, ro)
	Calculate runoff to a lake.
procedure, private	lak_calculate_inflow (this, ilak, qin)
	Calculate specified inflow to a lake.
procedure, private	lak_calculate_external (this, ilak, ex)
	Calculate the external flow terms to a lake.
procedure, private	lak_calculate_withdrawal (this, ilak, avail, wr)
	Calculate the withdrawal from a lake subject to an available volume.
procedure, private	lak_calculate_evaporation (this, ilak, stage, avail, ev)
	Calculate the evaporation from a lake at a provided stage subject to an available volume.
procedure, private	lak_calculate_outlet_inflow (this, ilak, outinf)
	Calculate the outlet inflow to a lake.
procedure, private	lak_calculate_outlet_outflow (this, ilak, stage, avail, outoutf)
	Calculate the outlet outflow from a lake.
procedure, private	lak_get_internal_inlet (this, ilak, outinf)
	Get the outlet inflow to a lake from another lake.
procedure, private	lak_get_internal_outlet (this, ilak, outoutf)
	Get the outlet from a lake to another lake.
procedure, private	lak_get_external_outlet (this, ilak, outoutf)
	Get the outlet outflow from a lake to an external boundary.
procedure, private	lak_get_internal_mover (this, ilak, outoutf)
	Get the mover outflow from a lake to another lake.
procedure, private	lak_get_external_mover (this, ilak, outoutf)
	Get the mover outflow from a lake to an external boundary.
procedure, private	lak_get_outlet_tomover (this, ilak, outoutf)
	Get the outlet to mover from a lake.
procedure, private	lak_accumulate_chterm (this, ilak, rrate, chratin, chratout)
	Accumulate constant head terms for budget.
procedure, private	lak_vol2stage (this, ilak, vol, stage)
	Determine the stage from a provided volume.
procedure, private	lak_solve (this, update, only_legacy)
	Solve for lake stage.
procedure, private	lak_solve_single (this, n, iter, maxiter, ncnv, lupdate)
	Advance one lake stage by a single substitution iteration.
procedure, private	lak_estimate_seepage_single (this, n, ncnv)
	Estimate the lakebed seepage for a single lake.
procedure, private	lak_fc_implicit lak_fc_implicit
procedure, private	lak_budget_nogwf lak_budget_nogwf
procedure, private	lak_outlet_outflow_rate (this, ilak, stage, qout)
	Total uncapped outlet outflow rate from a lake at a provided stage.
procedure, private	lak_bisection (this, n, ibflg, hlak, temporary_stage, dh, residual)
	@ brief Lake package bisection method
procedure, private	lak_calculate_available (this, n, hlak, avail, ra, ro, qinf, ex, headp)
	Calculate the available volumetric rate for a lake given a passed stage.
procedure, private	lak_calculate_residual (this, n, hlak, resid, headp)
	Calculate the residual for a lake given a passed stage.
procedure, private	lak_linear_interpolation (this, n, x, y, z, v)
	Perform linear interpolation of two vectors.
procedure, private	lak_setup_budobj (this)
	Set up the budget object that stores all the lake flows.
procedure, private	lak_fill_budobj (this)
	Copy flow terms into thisbudobj.
procedure, private	laktables_to_vectors (this, laketables)
	Copy the laketables structure data into flattened vectors that are stored in the memory manager.
procedure, private	lak_setup_tableobj (this)
	Set up the table object that is used to write the lak stage data.
procedure, private	lak_calculate_density_exchange (this, iconn, stage, head, cond, botl, flow, gwfhcof, gwfrhs)
	Calculate the groundwater-lake density exchange terms.
procedure, private	pak_setup_outputtab (this)
	@ brief Setup output table for package
procedure, private	bnd_store_user_cond (this, nlist, rlist, condinput)
	@ brief Store user-specified conductances when vsc is active

Detailed Description

Definition at line 89 of file gwf-lak.f90.

Member Function/Subroutine Documentation

allocate_arrays() [1/2]

procedure bndextmodule::bndexttype::allocate_arrays ( class(bndexttype) this, integer(i4b), dimension(:), optional, pointer, contiguous nodelist, real(dp), dimension(:, :), optional, pointer, contiguous auxvar )

inherited

Allocate and initialize base boundary package arrays. This method only needs to be overridden if additional arrays are defined for a specific package.

Parameters

this	BndExtType object
nodelist	package nodelist
auxvar	package aux variable array

Definition at line 54 of file BoundaryPackageExt.f90.

allocate_arrays() [2/2]

procedure bndmodule::bndtype::allocate_arrays ( class(bndtype) this, integer(i4b), dimension(:), optional, pointer, contiguous nodelist, real(dp), dimension(:, :), optional, pointer, contiguous auxvar )

inherited

Allocate and initialize base boundary package arrays. This method only needs to be overridden if additional arrays are defined for a specific package.

Parameters

this	BndType object
nodelist	package nodelist
auxvar	package aux variable array

Definition at line 139 of file BoundaryPackage.f90.

allocate_featureauxvar()

procedure bndextmodule::bndexttype::allocate_featureauxvar ( class(bndexttype) this )

inherited

Parameters

this	BndExtType object

Definition at line 55 of file BoundaryPackageExt.f90.

allocate_scalars() [1/3]

procedure bndextmodule::bndexttype::allocate_scalars ( class(bndexttype) this )

inherited

Allocate and initialize base boundary package scalars. This method only needs to be overridden if additional scalars are defined for a specific package.

Parameters

this	BndExtType object

Definition at line 53 of file BoundaryPackageExt.f90.

allocate_scalars() [2/3]

procedure bndmodule::bndtype::allocate_scalars ( class(bndtype) this )

inherited

Allocate and initialize base boundary package scalars. This method only needs to be overridden if additional scalars are defined for a specific package.

Parameters

this	BndType object

Definition at line 138 of file BoundaryPackage.f90.

allocate_scalars() [3/3]

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

inherited

Allocate and initialize base numerical package scalars.

Parameters

this	NumericalPackageType object

Definition at line 54 of file NumericalPackage.f90.

bnd_ac() [1/2]

procedure bndmodule::bndtype::bnd_ac ( class(bndtype), intent(inout) this, integer(i4b), intent(in) moffset, type(sparsematrix), intent(inout) sparse )

inherited

Add boundary package connection to the matrix for packages that add connections to the coefficient matrix. An example would be the GWF model MAW package. Base implementation that must be extended.

Parameters

[in,out]	this	BndType object
[in]	moffset	solution matrix model offset
[in,out]	sparse	sparse object

Definition at line 116 of file BoundaryPackage.f90.

bnd_ac() [2/2]

procedure lakmodule::laktype::bnd_ac	(	class(laktype), intent(inout)	this,
		integer(i4b), intent(in)	moffset,
		type(sparsematrix), intent(inout)	sparse )

Implicit formulation only. Each lake adds one equation (row and column) to the groundwater flow matrix: a diagonal entry, plus a symmetric off-diagonal pair (lake-to-cell and cell-to-lake) for every lake-cell connection.

Definition at line 279 of file gwf-lak.f90.

bnd_activate_viscosity()

procedure, public bndmodule::bndtype::bnd_activate_viscosity ( class(bndtype), intent(inout) this )

inherited

Method to activate addition of viscosity terms when package type is DRN, GHB, or RIV (method not needed by other packages at this point)

Parameters

[in,out]

this

BndType object

Definition at line 164 of file BoundaryPackage.f90.

bnd_ad() [1/3]

procedure bndextmodule::bndexttype::bnd_ad ( class(bndexttype) this )

inherited

Does not call thisTsManagerad()/thisTasManagerad() – those managers are unused by this type (see bndext_df).

Definition at line 47 of file BoundaryPackageExt.f90.

bnd_ad() [2/3]

procedure bndmodule::bndtype::bnd_ad ( class(bndtype) this )

inherited

Advance data in the boundary package. The method sets advances time series, time array series, and observation data. A boundary package only needs to override this method if additional data needs to be advanced.

Parameters

this	BndType object

Definition at line 120 of file BoundaryPackage.f90.

bnd_ad() [3/3]

procedure lakmodule::laktype::bnd_ad

(

class(laktype)

this

)

Definition at line 282 of file gwf-lak.f90.

bnd_ar() [1/2]

procedure bndmodule::bndtype::bnd_ar ( class(bndtype), intent(inout) this )

inherited

Generic method to allocate and read static data for model boundary packages. A boundary package only needs to override this method if input data varies from the standard boundary package.

Parameters

[in,out]

this

BndType object

Definition at line 118 of file BoundaryPackage.f90.

bnd_ar() [2/2]

procedure lakmodule::laktype::bnd_ar

(

class(laktype), intent(inout)

this

)

Create new LAK package and point bndobj to the new package

Definition at line 278 of file gwf-lak.f90.

bnd_bd()

procedure bndmodule::bndtype::bnd_bd ( class(bndtype) this, type(budgettype), intent(inout) model_budget )

inherited

Add the flow between package and the model (ratin and ratout) to the model budget. This method only needs to be overridden if a different calculation needs to be made.

Parameters

	this	BndType object
[in,out]	model_budget	model budget object

Definition at line 129 of file BoundaryPackage.f90.

bnd_bd_obs() [1/2]

procedure, public bndmodule::bndtype::bnd_bd_obs ( class(bndtype) this )

inherited

Method to save simulated values for the boundary package. This method will need to be overridden for boundary packages with more observations than the calculate flow term (simvals) and to-mover.

Parameters

this	BndType object

Definition at line 155 of file BoundaryPackage.f90.

bnd_bd_obs() [2/2]

procedure, public lakmodule::laktype::bnd_bd_obs

(

class(laktype)

this

)

Definition at line 301 of file gwf-lak.f90.

bnd_cc() [1/2]

procedure bndmodule::bndtype::bnd_cc ( class(bndtype), intent(inout) this, integer(i4b), intent(in) innertot, integer(i4b), intent(in) kiter, integer(i4b), intent(in) iend, integer(i4b), intent(in) icnvgmod, character(len=lenpakloc), intent(inout) cpak, integer(i4b), intent(inout) ipak, real(dp), intent(inout) dpak )

inherited

Perform additional convergence checks on the flow between the package and the model it is attached to. This additional convergence check is applied to packages that solve their own continuity equation as part of the formulate step at the beginning of a Picard iteration. A boundary package only needs to override this method if a specific boundary package solves its own continuity equation. Example packages that implement this additional convergence check is the CSUB, SFR, LAK, and UZF packages.

Parameters

[in,out]	this	BndType object
[in]	innertot	total number of inner iterations
[in]	kiter	Picard iteration number
[in]	iend	flag indicating if this is the last Picard iteration
[in]	icnvgmod	flag inficating if the model has met specific convergence criteria
[in,out]	cpak	string for user node
[in,out]	ipak	location of the maximum dependent variable change
[in,out]	dpak	maximum dependent variable change

Definition at line 127 of file BoundaryPackage.f90.

bnd_cc() [2/2]

procedure lakmodule::laktype::bnd_cc	(	class(laktype), intent(inout)	this,
		integer(i4b), intent(in)	innertot,
		integer(i4b), intent(in)	kiter,
		integer(i4b), intent(in)	iend,
		integer(i4b), intent(in)	icnvgmod,
		character(len=lenpakloc), intent(inout)	cpak,
		integer(i4b), intent(inout)	ipak,
		real(dp), intent(inout)	dpak )

Definition at line 287 of file gwf-lak.f90.

bnd_cf() [1/2]

procedure bndmodule::bndtype::bnd_cf ( class(bndtype) this )

inherited

Formulate the hcof and rhs terms for the package that will be added to the coefficient matrix and right-hand side vector. Base implementation that must be extended by each model boundary package.

Parameters

this	BndType object

Definition at line 123 of file BoundaryPackage.f90.

bnd_cf() [2/2]

procedure lakmodule::laktype::bnd_cf

(

class(laktype)

this

)

Skip if no lakes, otherwise calculate hcof and rhs

Definition at line 283 of file gwf-lak.f90.

bnd_ck()

procedure bndmodule::bndtype::bnd_ck ( class(bndtype), intent(inout) this )

inherited

Check the boundary package period data. Base implementation that must be extended by each model boundary package.

Parameters

[in,out]

this

BndType object

Definition at line 121 of file BoundaryPackage.f90.

bnd_cq() [1/2]

procedure bndmodule::bndtype::bnd_cq ( class(bndtype), intent(inout) this, real(dp), dimension(:), intent(in) x, real(dp), dimension(:), intent(inout), contiguous flowja, integer(i4b), intent(in), optional iadv )

inherited

Calculate the flow between connected advanced package control volumes. Only advanced boundary packages need to override this method.

Parameters

[in,out]	this	BndType object
[in]	x	current dependent-variable value
[in,out]	flowja	flow between two connected control volumes
[in]	iadv	flag that indicates if this is an advance package

Definition at line 128 of file BoundaryPackage.f90.

bnd_cq() [2/2]

procedure lakmodule::laktype::bnd_cq	(	class(laktype), intent(inout)	this,
		real(dp), dimension(:), intent(in)	x,
		real(dp), dimension(:), intent(inout), contiguous	flowja,
		integer(i4b), intent(in), optional	iadv )

Definition at line 290 of file gwf-lak.f90.

bnd_cq_simrate()

procedure bndmodule::bndtype::bnd_cq_simrate ( class(bndtype) this, real(dp), dimension(:), intent(in) hnew, real(dp), dimension(:), intent(inout) flowja, integer(i4b), intent(in) imover )

inherited

Calculate the flow between package and the model (for example, GHB and groundwater cell) and store in the simvals variable. This method only needs to be overridden if a different calculation needs to be made.

Parameters

	this	BndType object
[in]	hnew	current dependent-variable value
[in,out]	flowja	flow between package and model
[in]	imover	flag indicating if the mover package is active

Definition at line 145 of file BoundaryPackage.f90.

bnd_cq_simtomvr()

procedure bndmodule::bndtype::bnd_cq_simtomvr ( class(bndtype) this, real(dp), dimension(:), intent(inout) flowja )

inherited

Calculate the flow between package and the model that is sent to the mover package and store in the simtomvr variable. This method only needs to be overridden if a different calculation needs to be made.

Parameters

	this	BndType object
[in,out]	flowja	flow between package and model

Definition at line 146 of file BoundaryPackage.f90.

bnd_da() [1/3]

procedure bndextmodule::bndexttype::bnd_da ( class(bndexttype) this )

inherited

Parameters

this	BndExtType object

Definition at line 52 of file BoundaryPackageExt.f90.

bnd_da() [2/3]

procedure bndmodule::bndtype::bnd_da ( class(bndtype) this )

inherited

Deallocate base boundary package scalars and arrays. This method only needs to be overridden if additional variables are defined for a specific package.

Parameters

this	BndType object

Definition at line 136 of file BoundaryPackage.f90.

bnd_da() [3/3]

procedure lakmodule::laktype::bnd_da

(

class(laktype)

this

)

Definition at line 295 of file gwf-lak.f90.

bnd_df() [1/2]

procedure bndextmodule::bndexttype::bnd_df ( class(bndexttype), intent(inout) this, integer(i4b), intent(inout) neq, class(disbasetype), pointer dis )

inherited

Define base boundary package options and dimensions for a model boundary package.

Parameters

[in,out]	this	BndExtType object
[in,out]	neq	number of equations
	dis	discretization object

Definition at line 46 of file BoundaryPackageExt.f90.

bnd_df() [2/2]

procedure, public bndmodule::bndtype::bnd_df ( class(bndtype), intent(inout) this, integer(i4b), intent(inout) neq, class(disbasetype), pointer dis )

inherited

Define base boundary package options and dimensions for a model boundary package.

Parameters

[in,out]	this	BndType object
[in,out]	neq	number of equations
	dis	discretization object

Definition at line 115 of file BoundaryPackage.f90.

bnd_df_obs() [1/2]

procedure, public bndmodule::bndtype::bnd_df_obs ( class(bndtype) this )

inherited

Method to define the observation types available in a boundary package. This method should be overridden if observations are supported in a boundary package.

Parameters

this	BndType object

Definition at line 154 of file BoundaryPackage.f90.

bnd_df_obs() [2/2]

procedure, public lakmodule::laktype::bnd_df_obs

(

class(laktype)

this

)

Definition at line 299 of file gwf-lak.f90.

bnd_dt()

procedure bndmodule::bndtype::bnd_dt ( class(bndtype) this )

inherited

Parameters

this	BndType object

Definition at line 134 of file BoundaryPackage.f90.

bnd_fc() [1/2]

procedure bndmodule::bndtype::bnd_fc ( class(bndtype) this, real(dp), dimension(:), intent(inout) rhs, integer(i4b), dimension(:), intent(in) ia, integer(i4b), dimension(:), intent(in) idxglo, class(matrixbasetype), pointer matrix_sln )

inherited

Add the hcof and rhs terms for the boundary package to the coefficient matrix and right-hand side vector. A boundary package only needs to override this method if it is different for a specific boundary package.

Parameters

	this	BndType object
[in,out]	rhs	right-hand side vector for model
[in]	ia	solution CRS row pointers
[in]	idxglo	mapping vector for model (local) to solution (global)
	matrix_sln	solution coefficient matrix

Definition at line 124 of file BoundaryPackage.f90.

bnd_fc() [2/2]

procedure lakmodule::laktype::bnd_fc	(	class(laktype)	this,
		real(dp), dimension(:), intent(inout)	rhs,
		integer(i4b), dimension(:), intent(in)	ia,
		integer(i4b), dimension(:), intent(in)	idxglo,
		class(matrixbasetype), pointer	matrix_sln )

Definition at line 284 of file gwf-lak.f90.

bnd_fn() [1/2]

procedure bndmodule::bndtype::bnd_fn ( class(bndtype) this, real(dp), dimension(:), intent(inout) rhs, integer(i4b), dimension(:), intent(in) ia, integer(i4b), dimension(:), intent(in) idxglo, class(matrixbasetype), pointer matrix_sln )

inherited

Calculate and add the Newton-Raphson terms for the boundary package to the coefficient matrix and right-hand side vector. A boundary package only needs to override this method if a specific boundary package needs to add Newton-Raphson terms.

Parameters

	this	BndType object
[in,out]	rhs	right-hand side vector for model
[in]	ia	solution CRS row pointers
[in]	idxglo	mapping vector for model (local) to solution (global)
	matrix_sln	solution coefficient matrix

Definition at line 125 of file BoundaryPackage.f90.

bnd_fn() [2/2]

procedure lakmodule::laktype::bnd_fn	(	class(laktype)	this,
		real(dp), dimension(:), intent(inout)	rhs,
		integer(i4b), dimension(:), intent(in)	ia,
		integer(i4b), dimension(:), intent(in)	idxglo,
		class(matrixbasetype), pointer	matrix_sln )

Definition at line 285 of file gwf-lak.f90.

bnd_fp()

procedure bndmodule::bndtype::bnd_fp ( class(bndtype) this )

inherited

Parameters

this	BndType object

Definition at line 135 of file BoundaryPackage.f90.

bnd_mc() [1/2]

procedure bndmodule::bndtype::bnd_mc ( class(bndtype), intent(inout) this, integer(i4b), intent(in) moffset, class(matrixbasetype), pointer matrix_sln )

inherited

Map boundary package connection to the matrix for packages that add connections to the coefficient matrix. An example would be the GWF model MAW package. Base implementation that must be extended.

Parameters

[in,out]	this	BndType object
[in]	moffset	solution matrix model offset
	matrix_sln	global system matrix

Definition at line 117 of file BoundaryPackage.f90.

bnd_mc() [2/2]

procedure lakmodule::laktype::bnd_mc	(	class(laktype), intent(inout)	this,
		integer(i4b), intent(in)	moffset,
		class(matrixbasetype), pointer	matrix_sln )

Implicit formulation only. Finds the position in the assembled matrix of each lake-row diagonal, lake-to-cell, cell diagonal, and cell-to-lake entry and stores them in the idx* arrays so they can be filled during assembly.

Definition at line 280 of file gwf-lak.f90.

bnd_nur() [1/2]

procedure bndmodule::bndtype::bnd_nur ( class(bndtype), intent(inout) this, integer(i4b), intent(in) neqpak, real(dp), dimension(neqpak), intent(inout) x, real(dp), dimension(neqpak), intent(in) xtemp, real(dp), dimension(neqpak), intent(inout) dx, integer(i4b), intent(inout) inewtonur, real(dp), intent(inout) dxmax, integer(i4b), intent(inout) locmax )

inherited

Apply Newton-Raphson under-relaxation for a boundary package. A boundary package only needs to override this method if a specific boundary package needs to apply Newton-Raphson under-relaxation. An example is the MAW package which adds rows to the system of equations and may need to have the dependent-variable constrained by the bottom of the model.

Parameters

[in,out]	this	BndType object
[in]	neqpak	number of equations in the package
[in,out]	x	dependent variable
[in]	xtemp	previous dependent variable
[in,out]	dx	change in dependent variable
[in,out]	inewtonur	flag indicating if newton-raphson under-relaxation should be applied
[in,out]	dxmax	maximum change in the dependent variable
[in,out]	locmax	location of the maximum change in the dependent variable

Definition at line 126 of file BoundaryPackage.f90.

bnd_nur() [2/2]

procedure lakmodule::laktype::bnd_nur	(	class(laktype), intent(inout)	this,
		integer(i4b), intent(in)	neqpak,
		real(dp), dimension(neqpak), intent(inout)	x,
		real(dp), dimension(neqpak), intent(in)	xtemp,
		real(dp), dimension(neqpak), intent(inout)	dx,
		integer(i4b), intent(inout)	inewtonur,
		real(dp), intent(inout)	dxmax,
		integer(i4b), intent(inout)	locmax )

Implicit formulation only. The model Newton under-relaxation step (gwf_nur) calls this routine with the lake-stage part of the solution. If an updated stage falls below the lake bottom, it is relaxed back toward the bottom (90 percent of the way) and its change is zeroed. Active only when the model uses NEWTON UNDER_RELAXATION.

Definition at line 286 of file gwf-lak.f90.

bnd_obs_supported() [1/2]

procedure, public bndmodule::bndtype::bnd_obs_supported ( class(bndtype) this )

inherited

Function to determine if observations are supported by the boundary package. By default, observations are not supported. This method should be overridden if observations are supported in a boundary package.

Returns

supported boolean indicating if observations are supported

boolean indicating if observations are supported

Parameters

this	BndType object

Definition at line 153 of file BoundaryPackage.f90.

bnd_obs_supported() [2/2]

procedure, public lakmodule::laktype::bnd_obs_supported

(

class(laktype)

this

)

Return true because LAK package supports observations. Overrides BndTypebnd_obs_supported()

Definition at line 298 of file gwf-lak.f90.

bnd_options()

procedure bndmodule::bndtype::bnd_options ( class(bndtype), intent(inout) this, character(len=*), intent(inout) option, logical(lgp), intent(inout) found )

inherited

Read additional options for a boundary package. This method should be overridden options in addition to the base options are implemented in a boundary package.

Parameters

[in,out]	this	BndType object
[in,out]	option	option keyword string
[in,out]	found	boolean indicating if the option was found

Definition at line 144 of file BoundaryPackage.f90.

bnd_ot_bdsummary() [1/2]

procedure bndmodule::bndtype::bnd_ot_bdsummary ( class(bndtype) this, integer(i4b), intent(in) kstp, integer(i4b), intent(in) kper, integer(i4b), intent(in) iout, integer(i4b), intent(in) ibudfl )

inherited

Output advanced boundary package budget summary. This method only needs to be overridden for advanced packages that save budget summaries to the model listing file.

Parameters

	this	BndType object
[in]	kstp	time step number
[in]	kper	period number
[in]	iout	flag and unit number for the model listing file
[in]	ibudfl	flag indicating budget should be written

Definition at line 133 of file BoundaryPackage.f90.

bnd_ot_bdsummary() [2/2]

procedure lakmodule::laktype::bnd_ot_bdsummary	(	class(laktype)	this,
		integer(i4b), intent(in)	kstp,
		integer(i4b), intent(in)	kper,
		integer(i4b), intent(in)	iout,
		integer(i4b), intent(in)	ibudfl )

Parameters

	this	LakType object
[in]	kstp	time step number
[in]	kper	period number
[in]	iout	flag and unit number for the model listing file
[in]	ibudfl	flag indicating budget should be written

Definition at line 294 of file gwf-lak.f90.

bnd_ot_dv() [1/2]

procedure bndmodule::bndtype::bnd_ot_dv ( class(bndtype) this, integer(i4b), intent(in) idvsave, integer(i4b), intent(in) idvprint )

inherited

Output advanced boundary package dependent-variable terms. This method only needs to be overridden for advanced packages that save dependent variable terms for each control volume.

Parameters

	this	BndType object
[in]	idvsave	flag and unit number for dependent-variable output
[in]	idvprint	flag indicating if dependent-variable should be written to the model listing file

Definition at line 132 of file BoundaryPackage.f90.

bnd_ot_dv() [2/2]

procedure lakmodule::laktype::bnd_ot_dv	(	class(laktype)	this,
		integer(i4b), intent(in)	idvsave,
		integer(i4b), intent(in)	idvprint )

Definition at line 293 of file gwf-lak.f90.

bnd_ot_model_flows() [1/2]

procedure bndmodule::bndtype::bnd_ot_model_flows ( class(bndtype) this, integer(i4b), intent(in) icbcfl, integer(i4b), intent(in) ibudfl, integer(i4b), intent(in) icbcun, integer(i4b), dimension(:), intent(in), optional imap )

inherited

Output flow terms between the boundary package and model to a binary file and/or print flows to the model listing file. This method should not need to be overridden.

Parameters

	this	BndType object
[in]	icbcfl	flag for cell-by-cell output
[in]	ibudfl	flag indication if cell-by-cell data should be saved
[in]	icbcun	unit number for cell-by-cell output
[in]	imap	mapping vector that converts the 1 to nbound values to lake number, maw number, etc.

Definition at line 130 of file BoundaryPackage.f90.

bnd_ot_model_flows() [2/2]

procedure lakmodule::laktype::bnd_ot_model_flows	(	class(laktype)	this,
		integer(i4b), intent(in)	icbcfl,
		integer(i4b), intent(in)	ibudfl,
		integer(i4b), intent(in)	icbcun,
		integer(i4b), dimension(:), intent(in), optional	imap )

Definition at line 291 of file gwf-lak.f90.

bnd_ot_obs()

procedure, public bndmodule::bndtype::bnd_ot_obs ( class(bndtype) this )

inherited

Method to output simulated values for the boundary package. This method should not need to be overridden.

Parameters

this	BndType object

Definition at line 156 of file BoundaryPackage.f90.

bnd_ot_package_flows() [1/2]

procedure bndmodule::bndtype::bnd_ot_package_flows ( class(bndtype) this, integer(i4b), intent(in) icbcfl, integer(i4b), intent(in) ibudfl )

inherited

Output advanced boundary package flow terms. This method only needs to be overridden for advanced packages that save flow terms than contribute to the continuity equation for each control volume.

Parameters

	this	BndType object
[in]	icbcfl	flag and unit number for cell-by-cell output
[in]	ibudfl	flag indication if cell-by-cell data should be saved

Definition at line 131 of file BoundaryPackage.f90.

bnd_ot_package_flows() [2/2]

procedure lakmodule::laktype::bnd_ot_package_flows	(	class(laktype)	this,
		integer(i4b), intent(in)	icbcfl,
		integer(i4b), intent(in)	ibudfl )

Definition at line 292 of file gwf-lak.f90.

bnd_reset()

procedure bndmodule::bndtype::bnd_reset ( class(bndtype) this )

inherited

Parameters

this	BndType object

Definition at line 122 of file BoundaryPackage.f90.

bnd_rp() [1/3]

procedure bndextmodule::bndexttype::bnd_rp ( class(bndexttype), intent(inout) this )

inherited

Parameters

[in,out]

this

BndExtType object

Definition at line 48 of file BoundaryPackageExt.f90.

bnd_rp() [2/3]

procedure bndmodule::bndtype::bnd_rp ( class(bndtype), intent(inout) this )

inherited

Generic method to read and prepare period data for model boundary packages. A boundary package only needs to override this method if period data varies from the standard boundary package.

Parameters

[in,out]

this

BndType object

Definition at line 119 of file BoundaryPackage.f90.

bnd_rp() [3/3]

procedure lakmodule::laktype::bnd_rp

(

class(laktype), intent(inout)

this

)

Definition at line 281 of file gwf-lak.f90.

bnd_rp_log() [1/2]

procedure bndextmodule::bndexttype::bnd_rp_log ( class(bndexttype), intent(inout) this )

inherited

Called from model control files after bnd_rp(), which ensures bound_value() dispatches to the correct derived type.

Definition at line 49 of file BoundaryPackageExt.f90.

bnd_rp_log() [2/2]

procedure, public bndmodule::bndtype::bnd_rp_log ( class(bndtype), intent(inout) this )

inherited

Write stress period input to the listing file if requested. This default implementation is a no-op; BndExtType overrides it.

Definition at line 158 of file BoundaryPackage.f90.

bnd_rp_obs() [1/2]

procedure, public bndmodule::bndtype::bnd_rp_obs ( class(bndtype), intent(inout) this )

inherited

Method to read and prepare observations for a boundary package This method should not need to be overridden for most boundary packages.

Parameters

[in,out]

this

BndType object

Definition at line 157 of file BoundaryPackage.f90.

bnd_rp_obs() [2/2]

procedure, public lakmodule::laktype::bnd_rp_obs

(

class(laktype), intent(inout)

this

)

Only done the first stress period since boundaries are fixed for the simulation

Definition at line 300 of file gwf-lak.f90.

bnd_rp_ts()

procedure, public bndmodule::bndtype::bnd_rp_ts ( class(bndtype), intent(inout) this )

inherited

Assign the time series links for the boundary package. This method will need to be overridden for boundary packages that support time series.

Definition at line 161 of file BoundaryPackage.f90.

bnd_store_user_cond()

procedure, private bndmodule::bndtype::bnd_store_user_cond ( class(bndtype), intent(inout) this, integer(i4b), intent(in) nlist, real(dp), dimension(:, :), intent(in), pointer, contiguous rlist, real(dp), dimension(:), intent(inout), pointer, contiguous condinput )

privateinherited

VSC will update boundary package conductance values. Because viscosity can change every stress period, but user-specified conductances may not, the base user-input should be stored in backup array so that viscosity-updated conductances may be recalculated every stress period/time step

Parameters

[in,out]

this

BndType object

Definition at line 167 of file BoundaryPackage.f90.

bound_value()

procedure bndextmodule::bndexttype::bound_value ( class(bndexttype), intent(inout) this, integer(i4b), intent(in) col, integer(i4b), intent(in) row )

inherited

Return a bound value associated with an ncolbnd index and row. This function should be overridden in the derived package class.

Parameters

[in,out]

this

BndExtType object

Definition at line 65 of file BoundaryPackageExt.f90.

cellid_to_nlist()

procedure bndextmodule::bndexttype::cellid_to_nlist ( class(bndexttype) this )

inherited

Convert period updated cellids to node numbers.

Parameters

this	BndExtType object

Definition at line 59 of file BoundaryPackageExt.f90.

check_cellid()

procedure bndextmodule::bndexttype::check_cellid ( class(bndexttype) this, integer(i4b), intent(in) ii, integer(i4b), dimension(:), intent(in) cellid, integer(i4b), dimension(:), intent(in) mshape, integer(i4b), intent(in) ndim )

inherited

Parameters

	this	BndExtType object
[in]	mshape	model shape
[in]	ndim	size of mshape

Definition at line 63 of file BoundaryPackageExt.f90.

copy_boundname()

procedure bndmodule::bndtype::copy_boundname ( class(bndtype), intent(inout) this )

inherited

boundnames_cst is an array of type(CharacterStringType), which can be stored in the MemoryManager.

Parameters

[in,out]

this

BndType object

Definition at line 149 of file BoundaryPackage.f90.

da()

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

inherited

Deallocate and initialize base numerical package scalars.

Parameters

this	NumericalPackageType object

Definition at line 55 of file NumericalPackage.f90.

default_nodelist()

procedure bndextmodule::bndexttype::default_nodelist ( class(bndexttype) this )

inherited

Equivalent to reading layer number array as CONSTANT 1

Definition at line 62 of file BoundaryPackageExt.f90.

define_listlabel() [1/2]

procedure bndmodule::bndtype::define_listlabel ( class(bndtype), intent(inout) this )

inherited

Method defined the list label for the boundary package. This method needs to be overridden by each boundary package.

Parameters

[in,out]

this

BndType object

Definition at line 148 of file BoundaryPackage.f90.

define_listlabel() [2/2]

procedure lakmodule::laktype::define_listlabel

(

class(laktype), intent(inout)

this

)

Definition at line 296 of file gwf-lak.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

	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.

lak_accumulate_chterm()

procedure, private lakmodule::laktype::lak_accumulate_chterm ( class(laktype) this, integer(i4b), intent(in) ilak, real(dp), intent(in) rrate, real(dp), intent(inout) chratin, real(dp), intent(inout) chratout )

private

Definition at line 338 of file gwf-lak.f90.

lak_activate_density()

procedure lakmodule::laktype::lak_activate_density

(

class(laktype), intent(inout)

this

)

Definition at line 356 of file gwf-lak.f90.

lak_activate_viscosity()

procedure lakmodule::laktype::lak_activate_viscosity

(

class(laktype), intent(inout)

this

)

Method to activate addition of viscosity terms for a LAK package reach.

Parameters

[in,out]

this

LakType object

Definition at line 359 of file gwf-lak.f90.

lak_allocate_arrays()

procedure lakmodule::laktype::lak_allocate_arrays

(

class(laktype), intent(inout)

this

)

Definition at line 272 of file gwf-lak.f90.

lak_allocate_scalars()

procedure lakmodule::laktype::lak_allocate_scalars

(

class(laktype), intent(inout)

this

)

Definition at line 271 of file gwf-lak.f90.

lak_bisection()

procedure, private lakmodule::laktype::lak_bisection ( class(laktype), intent(inout) this, integer(i4b), intent(in) n, integer(i4b), intent(inout) ibflg, real(dp), intent(in) hlak, real(dp), intent(inout) temporary_stage, real(dp), intent(inout) dh, real(dp), intent(inout) residual )

private

Use bisection method to find lake stage that reduces the residual

Parameters

[in]	n	lake number
[in,out]	ibflg	bisection flag
[in]	hlak	lake stage
[in,out]	temporary_stage	temporary lake stage
[in,out]	dh	lake stage change
[in,out]	residual	lake residual

Definition at line 346 of file gwf-lak.f90.

lak_bound_update()

procedure, private lakmodule::laktype::lak_bound_update ( class(laktype), intent(inout) this )

private

Definition at line 311 of file gwf-lak.f90.

lak_budget_nogwf()

procedure, private lakmodule::laktype::lak_budget_nogwf

private

Definition at line 344 of file gwf-lak.f90.

lak_calculate_available()

procedure, private lakmodule::laktype::lak_calculate_available ( class(laktype), intent(inout) this, integer(i4b), intent(in) n, real(dp), intent(in) hlak, real(dp), intent(inout) avail, real(dp), intent(inout) ra, real(dp), intent(inout) ro, real(dp), intent(inout) qinf, real(dp), intent(inout) ex, real(dp), intent(in), optional headp )

private

Definition at line 347 of file gwf-lak.f90.

lak_calculate_cond_head()

procedure, private lakmodule::laktype::lak_calculate_cond_head ( class(laktype), intent(inout) this, integer(i4b), intent(in) iconn, real(dp), intent(in) stage, real(dp), intent(in) head, real(dp), intent(inout) vv )

private

Definition at line 317 of file gwf-lak.f90.

lak_calculate_conductance()

procedure, private lakmodule::laktype::lak_calculate_conductance ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(in) stage, real(dp), intent(inout) conductance )

private

Definition at line 316 of file gwf-lak.f90.

lak_calculate_conn_conductance()

procedure, private lakmodule::laktype::lak_calculate_conn_conductance ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, integer(i4b), intent(in) iconn, real(dp), intent(in) stage, real(dp), intent(in) head, real(dp), intent(inout) cond )

private

Definition at line 318 of file gwf-lak.f90.

lak_calculate_conn_exchange()

procedure, private lakmodule::laktype::lak_calculate_conn_exchange ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, integer(i4b), intent(in) iconn, real(dp), intent(in) stage, real(dp), intent(in) head, real(dp), intent(inout) flow, real(dp), intent(inout), optional gwfhcof, real(dp), intent(inout), optional gwfrhs )

private

Definition at line 320 of file gwf-lak.f90.

lak_calculate_conn_exchange_deriv()

procedure, private lakmodule::laktype::lak_calculate_conn_exchange_deriv ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, integer(i4b), intent(in) iconn, real(dp), intent(in) stage, real(dp), intent(in) head, real(dp), intent(inout) flow, real(dp), intent(inout), optional dqds, real(dp), intent(inout), optional dqdh )

private

Returns the lakebed seepage for one connection, positive into the lake, and optionally its stage and head derivatives. The stage and the connected- cell head are each held at or above the lake bottom, the same wet/dry cutoff used by the default formulation, so the implicit seepage matches the default formulation exactly. lak_fc_implicit uses this to assemble the matrix and lak_cq uses it to report the budget, so the two are consistent.

Definition at line 321 of file gwf-lak.f90.

lak_calculate_conn_warea()

procedure, private lakmodule::laktype::lak_calculate_conn_warea ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, integer(i4b), intent(in) iconn, real(dp), intent(in) stage, real(dp), intent(in) head, real(dp), intent(inout) wa )

private

Definition at line 314 of file gwf-lak.f90.

lak_calculate_density_exchange()

procedure, private lakmodule::laktype::lak_calculate_density_exchange ( class(laktype), intent(inout) this, integer(i4b), intent(in) iconn, real(dp), intent(in) stage, real(dp), intent(in) head, real(dp), intent(in) cond, real(dp), intent(in) botl, real(dp), intent(inout) flow, real(dp), intent(inout) gwfhcof, real(dp), intent(inout) gwfrhs )

private

Arguments are as follows: iconn : lak-gwf connection number stage : lake stage head : gwf head cond : conductance botl : bottom elevation of this connection flow : calculated flow, updated here with density terms gwfhcof : gwf head coefficient, updated here with density terms gwfrhs : gwf right-hand-side value, updated here with density terms

Member variable used here denseterms : shape (3, MAXBOUND), filled by buoyancy package col 1 is relative density of lake (denselak / denseref) col 2 is relative density of gwf cell (densegwf / denseref) col 3 is elevation of gwf cell

Definition at line 357 of file gwf-lak.f90.

lak_calculate_evaporation()

procedure, private lakmodule::laktype::lak_calculate_evaporation ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(in) stage, real(dp), intent(inout) avail, real(dp), intent(inout) ev )

private

Definition at line 329 of file gwf-lak.f90.

lak_calculate_exchange()

procedure, private lakmodule::laktype::lak_calculate_exchange ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(in) stage, real(dp), intent(inout) totflow )

private

Definition at line 319 of file gwf-lak.f90.

lak_calculate_external()

procedure, private lakmodule::laktype::lak_calculate_external ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(inout) ex )

private

Definition at line 327 of file gwf-lak.f90.

lak_calculate_inflow()

procedure, private lakmodule::laktype::lak_calculate_inflow ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(inout) qin )

private

Definition at line 326 of file gwf-lak.f90.

lak_calculate_outlet_inflow()

procedure, private lakmodule::laktype::lak_calculate_outlet_inflow ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(inout) outinf )

private

Definition at line 330 of file gwf-lak.f90.

lak_calculate_outlet_outflow()

procedure, private lakmodule::laktype::lak_calculate_outlet_outflow ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(in) stage, real(dp), intent(inout) avail, real(dp), intent(inout) outoutf )

private

Definition at line 331 of file gwf-lak.f90.

lak_calculate_rainfall()

procedure, private lakmodule::laktype::lak_calculate_rainfall ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(in) stage, real(dp), intent(inout) ra )

private

Definition at line 324 of file gwf-lak.f90.

lak_calculate_residual()

procedure, private lakmodule::laktype::lak_calculate_residual ( class(laktype), intent(inout) this, integer(i4b), intent(in) n, real(dp), intent(in) hlak, real(dp), intent(inout) resid, real(dp), intent(in), optional headp )

private

Definition at line 348 of file gwf-lak.f90.

lak_calculate_runoff()

procedure, private lakmodule::laktype::lak_calculate_runoff ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(inout) ro )

private

Definition at line 325 of file gwf-lak.f90.

lak_calculate_sarea()

procedure, private lakmodule::laktype::lak_calculate_sarea ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(in) stage, real(dp), intent(inout) sarea )

private

Definition at line 312 of file gwf-lak.f90.

lak_calculate_storagechange()

procedure, private lakmodule::laktype::lak_calculate_storagechange ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(in) stage, real(dp), intent(in) stage0, real(dp), intent(in) delt, real(dp), intent(inout) dvr )

private

Definition at line 323 of file gwf-lak.f90.

lak_calculate_vol()

procedure, public lakmodule::laktype::lak_calculate_vol	(	class(laktype), intent(inout)	this,
		integer(i4b), intent(in)	ilak,
		real(dp), intent(in)	stage,
		real(dp), intent(inout)	volume )

Definition at line 315 of file gwf-lak.f90.

lak_calculate_warea()

procedure, private lakmodule::laktype::lak_calculate_warea ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(in) stage, real(dp), intent(inout) warea, real(dp), intent(inout), optional hin )

private

Definition at line 313 of file gwf-lak.f90.

lak_calculate_withdrawal()

procedure, private lakmodule::laktype::lak_calculate_withdrawal ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(inout) avail, real(dp), intent(inout) wr )

private

Definition at line 328 of file gwf-lak.f90.

lak_check_disconnected()

procedure, private lakmodule::laktype::lak_check_disconnected

private

Definition at line 289 of file gwf-lak.f90.

lak_check_valid()

procedure, private lakmodule::laktype::lak_check_valid ( class(laktype), intent(inout) this, integer(i4b), intent(in) itemno )

private

Definition at line 308 of file gwf-lak.f90.

lak_checkin_deprecated_names()

procedure lakmodule::laktype::lak_checkin_deprecated_names

(

class(laktype), intent(inout)

this

)

IDM integration (#3021) moved several lake and outlet variables into the input context, renaming some, and renamed the lake connection cell array. The legacy solver refactor (#2976) renamed the fallback variables. These aliases share memory with the current variables so that programs addressing them through the API by their old package-path names continue to resolve; each use is reported as deprecated. Outlet names are only aliased when outlets are present.

Definition at line 273 of file gwf-lak.f90.

lak_estimate_conn_exchange()

procedure, private lakmodule::laktype::lak_estimate_conn_exchange ( class(laktype), intent(inout) this, integer(i4b), intent(in) iflag, integer(i4b), intent(in) ilak, integer(i4b), intent(in) iconn, integer(i4b), intent(inout) idry, real(dp), intent(in) stage, real(dp), intent(in) head, real(dp), intent(inout) flow, real(dp), intent(inout) source, real(dp), intent(inout), optional gwfhcof, real(dp), intent(inout), optional gwfrhs )

private

Definition at line 322 of file gwf-lak.f90.

lak_estimate_seepage_single()

procedure, private lakmodule::laktype::lak_estimate_seepage_single ( class(laktype), intent(inout) this, integer(i4b), intent(in) n, integer(i4b), intent(in) ncnv )

private

Runs the two-pass connection-seepage estimate for lake n at its current stage and the perturbed stage, accumulating thisseep(n)/thisseep1(n) and, on the final pass when ncnv == 0, the gwf-cell hcof/rhs contributions. Lakes do not couple within this estimate (each connection touches only its own lake's flwiter), so evaluating both passes per lake is equivalent to the all-lakes-per-pass ordering in lak_solve. Extracted from lak_solve so the same estimate can drive the single-lake legacy solve for the IMPLICIT formulation.

Definition at line 342 of file gwf-lak.f90.

lak_fc_implicit()

procedure, private lakmodule::laktype::lak_fc_implicit

private

Definition at line 343 of file gwf-lak.f90.

lak_fill_budobj()

procedure, private lakmodule::laktype::lak_fill_budobj ( class(laktype) this )

private

Definition at line 351 of file gwf-lak.f90.

lak_get_external_mover()

procedure, private lakmodule::laktype::lak_get_external_mover ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(inout) outoutf )

private

Definition at line 336 of file gwf-lak.f90.

lak_get_external_outlet()

procedure, private lakmodule::laktype::lak_get_external_outlet ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(inout) outoutf )

private

Definition at line 334 of file gwf-lak.f90.

lak_get_internal_inlet()

procedure, private lakmodule::laktype::lak_get_internal_inlet ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(inout) outinf )

private

Definition at line 332 of file gwf-lak.f90.

lak_get_internal_mover()

procedure, private lakmodule::laktype::lak_get_internal_mover ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(inout) outoutf )

private

Definition at line 335 of file gwf-lak.f90.

lak_get_internal_outlet()

procedure, private lakmodule::laktype::lak_get_internal_outlet ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(inout) outoutf )

private

Definition at line 333 of file gwf-lak.f90.

lak_get_outlet_tomover()

procedure, private lakmodule::laktype::lak_get_outlet_tomover ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(inout) outoutf )

private

Definition at line 337 of file gwf-lak.f90.

lak_linear_interpolation()

procedure, private lakmodule::laktype::lak_linear_interpolation ( class(laktype), intent(inout) this, integer(i4b), intent(in) n, real(dp), dimension(n), intent(in) x, real(dp), dimension(n), intent(in) y, real(dp), intent(in) z, real(dp), intent(inout) v )

private

Function assumes x data is sorted in ascending order

Definition at line 349 of file gwf-lak.f90.

lak_outlet_outflow_rate()

procedure, private lakmodule::laktype::lak_outlet_outflow_rate ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(in) stage, real(dp), intent(inout) qout )

private

Side-effect-free companion to lak_calculate_outlet_outflow used by the implicit formulation: returns the summed (negative) rating-curve outflow for all outlets whose source is ilak, without applying the available-water cap or updating simoutrate. Used to linearize the outlet-outflow sink on the lake row in stage.

Definition at line 345 of file gwf-lak.f90.

lak_set_attribute_error()

procedure, private lakmodule::laktype::lak_set_attribute_error ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, character(len=*), intent(in) keyword, character(len=*), intent(in) msg )

private

Definition at line 310 of file gwf-lak.f90.

lak_set_legacy()

procedure, private lakmodule::laktype::lak_set_legacy

private

Definition at line 288 of file gwf-lak.f90.

lak_set_nonneg_value()

procedure, private lakmodule::laktype::lak_set_nonneg_value ( class(laktype), intent(inout) this, integer(i4b), intent(in) n, integer(i4b), intent(in) itemno, character(len=*), intent(in) setting, real(dp), dimension(:), intent(inout) value_array, character(len=*), intent(in) label )

private

Definition at line 309 of file gwf-lak.f90.

lak_setup_budobj()

procedure, private lakmodule::laktype::lak_setup_budobj ( class(laktype) this )

private

Definition at line 350 of file gwf-lak.f90.

lak_setup_tableobj()

procedure, private lakmodule::laktype::lak_setup_tableobj ( class(laktype) this )

private

The terms listed here must correspond in number and order to the ones written to the stage table in the lak_ot method

Definition at line 354 of file gwf-lak.f90.

lak_solve()

procedure, private lakmodule::laktype::lak_solve ( class(laktype), intent(inout) this, logical(lgp), intent(in), optional update, logical(lgp), intent(in), optional only_legacy )

private

Solve the lake stage by substitution. With only_legacy set, solve only the lakes flagged for the legacy solver (thisilegacy /= 0) and leave the remaining lakes – whose stage is solved in the global matrix by the IMPLICIT formulation – untouched. Without it (the default), every active lake is solved.

Definition at line 340 of file gwf-lak.f90.

lak_solve_single()

procedure, private lakmodule::laktype::lak_solve_single ( class(laktype), intent(inout) this, integer(i4b), intent(in) n, integer(i4b), intent(in) iter, integer(i4b), intent(in) maxiter, integer(i4b), intent(in) ncnv, logical(lgp), intent(in) lupdate )

private

Performs one Newton update (with a bisection backup) of lake n's stage in the default substitution solver, using the per-iteration seepage estimate (thisseep / thisseep1) already computed for the lake. Extracted from lak_solve so the same per-lake update can be reused to solve a single lake stage on its own – the per-lake legacy solve for the IMPLICIT formulation.

Definition at line 341 of file gwf-lak.f90.

lak_source_connectiondata()

procedure, private lakmodule::laktype::lak_source_connectiondata ( class(laktype), intent(inout) this )

private

Definition at line 304 of file gwf-lak.f90.

lak_source_outlets()

procedure, private lakmodule::laktype::lak_source_outlets ( class(laktype), intent(inout) this )

private

Definition at line 305 of file gwf-lak.f90.

lak_source_packagedata()

procedure, private lakmodule::laktype::lak_source_packagedata ( class(laktype), intent(inout) this )

private

Definition at line 303 of file gwf-lak.f90.

lak_source_table()

procedure, private lakmodule::laktype::lak_source_table ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, character(len=*), intent(in) mempath, type(laktabtype), intent(inout) laketable )

private

Definition at line 307 of file gwf-lak.f90.

lak_source_tables()

procedure, private lakmodule::laktype::lak_source_tables ( class(laktype), intent(inout) this )

private

Definition at line 306 of file gwf-lak.f90.

lak_vol2stage()

procedure, private lakmodule::laktype::lak_vol2stage ( class(laktype), intent(inout) this, integer(i4b), intent(in) ilak, real(dp), intent(in) vol, real(dp), intent(inout) stage )

private

Definition at line 339 of file gwf-lak.f90.

laktables_to_vectors()

procedure, private lakmodule::laktype::laktables_to_vectors ( class(laktype), intent(inout) this, type(laktabtype), dimension(:), intent(in), contiguous laketables )

private

Definition at line 352 of file gwf-lak.f90.

layarr_to_nlist()

procedure bndextmodule::bndexttype::layarr_to_nlist ( class(bndexttype) this )

inherited

This is a module scoped routine to check for I<filtyp> input. If array input was provided, INI<filtyp> and I<filtyp> will be allocated in the input context. If the read state variable INI<filtyp> is set to 1 during this period update, I<filtyp> input was read and is used here to update the nodelist.

Parameters

this	BndExtType object

Definition at line 61 of file BoundaryPackageExt.f90.

log_options()

procedure bndextmodule::bndexttype::log_options ( class(bndexttype), intent(inout) this, type(bndextfoundtype), intent(in) found, character(len=*), intent(in) sfacauxname )

inherited

Parameters

[in,out]

this

BndExtType object

Definition at line 57 of file BoundaryPackageExt.f90.

nodeu_to_nlist()

procedure bndextmodule::bndexttype::nodeu_to_nlist ( class(bndexttype) this )

inherited

Convert period user nodes to reduced nodes. Inactive cells are excluded by the input loader.

Parameters

this	BndExtType object

Definition at line 60 of file BoundaryPackageExt.f90.

pack_initialize()

procedure bndmodule::bndtype::pack_initialize ( class(bndtype) this )

inherited

Allocate and initialize select base boundary package members. This method needs to be overridden by a package if it is needed for a specific package.

Parameters

this	BndType object

Definition at line 140 of file BoundaryPackage.f90.

pak_setup_outputtab()

procedure, private bndmodule::bndtype::pak_setup_outputtab ( class(bndtype), intent(inout) this )

privateinherited

Setup output table for a boundary package that is used to output package to model flow terms to the model listing file.

Parameters

[in,out]

this

BndType object

Definition at line 150 of file BoundaryPackage.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]

this

NumericalPackageType object

Definition at line 56 of file NumericalPackage.f90.

read_dimensions()

procedure bndmodule::bndtype::read_dimensions ( class(bndtype), intent(inout) this )

inherited

Read base dimensions for boundary packages. This method should not need to be overridden unless more than MAXBOUND is specified in the DIMENSIONS block.

Parameters

[in,out]

this

BndType object

Definition at line 142 of file BoundaryPackage.f90.

read_initial_attr() [1/2]

procedure bndmodule::bndtype::read_initial_attr ( class(bndtype), intent(inout) this )

inherited

Read initial parameters for a boundary package. This method is not needed for most boundary packages. The SFR package is an example of a package that has overridden this method.

Parameters

[in,out]

this

BndType object

Definition at line 143 of file BoundaryPackage.f90.

read_initial_attr() [2/2]

procedure lakmodule::laktype::read_initial_attr

(

class(laktype), intent(inout)

this

)

Definition at line 276 of file gwf-lak.f90.

read_options()

procedure bndmodule::bndtype::read_options ( class(bndtype), intent(inout) this )

inherited

Read base options for boundary packages.

Parameters

[in,out]

this

BndType object

Definition at line 141 of file BoundaryPackage.f90.

report_ifno_coverage()

procedure bndextmodule::bndexttype::report_ifno_coverage ( class(bndexttype), intent(inout) this, integer(i4b), dimension(:), intent(in) nboundchk, integer(i4b), intent(in) nfeatures, character(len=*), intent(in) feature_label, character(len=*), intent(in) blockname, logical(lgp), intent(in), optional check_missing )

inherited

Set check_missing=.false. for an optional block where not every feature is expected to have a row (duplicates are still reported).

Definition at line 51 of file BoundaryPackageExt.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]	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.

set_pointers() [1/2]

procedure bndmodule::bndtype::set_pointers ( class(bndtype) this, integer(i4b), pointer neq, integer(i4b), dimension(:), pointer, contiguous ibound, real(dp), dimension(:), pointer, contiguous xnew, real(dp), dimension(:), pointer, contiguous xold, real(dp), dimension(:), pointer, contiguous flowja )

inherited

Set pointers to model variables so that a package has access to these variables. This base method should not need to be overridden.

Parameters

this	BndType object
neq	number of equations in the model
ibound	model idomain
xnew	current dependent variable
xold	previous dependent variable
flowja	connection flow terms

Definition at line 147 of file BoundaryPackage.f90.

set_pointers() [2/2]

procedure lakmodule::laktype::set_pointers	(	class(laktype)	this,
		integer(i4b), pointer	neq,
		integer(i4b), dimension(:), pointer, contiguous	ibound,
		real(dp), dimension(:), pointer, contiguous	xnew,
		real(dp), dimension(:), pointer, contiguous	xold,
		real(dp), dimension(:), pointer, contiguous	flowja )

Definition at line 277 of file gwf-lak.f90.

source_dimensions() [1/2]

procedure bndextmodule::bndexttype::source_dimensions ( class(bndexttype), intent(inout) this )

inherited

Parameters

[in,out]

this

BndExtType object

Definition at line 58 of file BoundaryPackageExt.f90.

source_dimensions() [2/2]

procedure lakmodule::laktype::source_dimensions

(

class(laktype), intent(inout)

this

)

Definition at line 275 of file gwf-lak.f90.

source_options() [1/2]

procedure bndextmodule::bndexttype::source_options ( class(bndexttype), intent(inout) this )

inherited

Parameters

[in,out]

this

BndExtType object

Definition at line 56 of file BoundaryPackageExt.f90.

source_options() [2/2]

procedure lakmodule::laktype::source_options

(

class(laktype), intent(inout)

this

)

Definition at line 274 of file gwf-lak.f90.

validate_ifno()

procedure bndextmodule::bndexttype::validate_ifno ( class(bndexttype), intent(inout) this, integer(i4b), intent(in) ifno_val, integer(i4b), intent(in) nfeatures, integer(i4b), dimension(:), intent(inout) nboundchk, character(len=*), intent(in) feature_label, character(len=*), intent(in) blockname )

inherited

Returns the validated feature index, or 0 if out of range (an error is logged; the caller should skip further processing for the row).

Definition at line 50 of file BoundaryPackageExt.f90.

write_lstfile()

procedure bndextmodule::bndexttype::write_lstfile ( class(bndexttype) this )

inherited

Log period based input. This routine requires a package specific bound_value() routine to report accurate bound values.

Parameters

this	BndExtType object

Definition at line 64 of file BoundaryPackageExt.f90.

Member Data Documentation

allowtimearrayseries

logical(lgp) bndmodule::bndtype::allowtimearrayseries = .false.

inherited

Definition at line 94 of file BoundaryPackage.f90.

auxname

character(len=lenauxname), dimension(:), pointer, contiguous bndmodule::bndtype::auxname => null()

inherited

Definition at line 51 of file BoundaryPackage.f90.

auxname_cst

type(characterstringtype), dimension(:), pointer, contiguous bndmodule::bndtype::auxname_cst => null()

inherited

Definition at line 53 of file BoundaryPackage.f90.

auxvar

real(dp), dimension(:, :), pointer, contiguous bndmodule::bndtype::auxvar => null()

inherited

Definition at line 78 of file BoundaryPackage.f90.

avail

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::avail => null()

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

bditems

integer(i4b), pointer lakmodule::laktype::bditems => NULL()

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

bedleak

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::bedleak => null()

Definition at line 199 of file gwf-lak.f90.

belev

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::belev => null()

Definition at line 200 of file gwf-lak.f90.

bound

real(dp), dimension(:, :), pointer, contiguous bndmodule::bndtype::bound => null()

inherited

Definition at line 75 of file BoundaryPackage.f90.

boundname

character(len=lenboundname), dimension(:), pointer, contiguous bndmodule::bndtype::boundname => null()

inherited

Definition at line 55 of file BoundaryPackage.f90.

boundname_cst

type(characterstringtype), dimension(:), pointer, contiguous bndmodule::bndtype::boundname_cst => null()

inherited

Definition at line 57 of file BoundaryPackage.f90.

budobj

type(budgetobjecttype), pointer lakmodule::laktype::budobj => null()

Definition at line 251 of file gwf-lak.f90.

cauxcbc

character(len=16), dimension(:), pointer, contiguous lakmodule::laktype::cauxcbc => NULL()

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

cbcauxitems

integer(i4b), pointer lakmodule::laktype::cbcauxitems => NULL()

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

cellid

integer(i4b), dimension(:, :), pointer, contiguous bndextmodule::bndexttype::cellid => null()

inherited

Definition at line 40 of file BoundaryPackageExt.f90.

check_attr

integer(i4b), pointer lakmodule::laktype::check_attr => NULL()

Definition at line 115 of file gwf-lak.f90.

chterm

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::chterm => null()

Definition at line 175 of file gwf-lak.f90.

clakbudget

character(len=16), dimension(:), pointer, contiguous lakmodule::laktype::clakbudget => NULL()

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

condinput

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::condinput => null()

inherited

Definition at line 88 of file BoundaryPackage.f90.

connlength

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::connlength => null()

Definition at line 202 of file gwf-lak.f90.

connwidth

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::connwidth => null()

Definition at line 203 of file gwf-lak.f90.

convlength

real(dp), pointer lakmodule::laktype::convlength => NULL()

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

convtime

real(dp), pointer lakmodule::laktype::convtime => NULL()

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

dbuff

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::dbuff => null()

Definition at line 230 of file gwf-lak.f90.

delh

real(dp), pointer lakmodule::laktype::delh => NULL()

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

denseterms

real(dp), dimension(:, :), pointer, contiguous lakmodule::laktype::denseterms => null()

Definition at line 262 of file gwf-lak.f90.

dh0

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::dh0 => null()

Definition at line 184 of file gwf-lak.f90.

dis

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

inherited

Definition at line 50 of file NumericalPackage.f90.

dmaxchg

real(dp), pointer lakmodule::laktype::dmaxchg => NULL()

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

en1

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::en1 => null()

Definition at line 180 of file gwf-lak.f90.

en2

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::en2 => null()

Definition at line 181 of file gwf-lak.f90.

errortab

type(tabletype), pointer bndmodule::bndtype::errortab => null()

inherited

Definition at line 112 of file BoundaryPackage.f90.

evap

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::evap => null()

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

evap1

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::evap1 => null()

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

evapo

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::evapo => null()

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

evaporation

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::evaporation => null()

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

featureauxvar

real(dp), dimension(:, :), pointer, contiguous bndextmodule::bndexttype::featureauxvar => null()

inherited

Definition at line 44 of file BoundaryPackageExt.f90.

filtyp

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

inherited

Definition at line 33 of file NumericalPackage.f90.

flowja

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::flowja => null()

inherited

Definition at line 105 of file BoundaryPackage.f90.

flwin

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::flwin => null()

Definition at line 168 of file gwf-lak.f90.

flwiter

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::flwiter => null()

Definition at line 169 of file gwf-lak.f90.

flwiter1

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::flwiter1 => null()

Definition at line 170 of file gwf-lak.f90.

gwfconn

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::gwfconn => null()

Definition at line 196 of file gwf-lak.f90.

gwfik33

integer(i4b), pointer lakmodule::laktype::gwfik33 => NULL()

Definition at line 243 of file gwf-lak.f90.

gwfiss

integer(i4b), pointer lakmodule::laktype::gwfiss => NULL()

Definition at line 239 of file gwf-lak.f90.

gwfk11

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::gwfk11 => NULL()

Definition at line 240 of file gwf-lak.f90.

gwfk33

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::gwfk33 => NULL()

Definition at line 241 of file gwf-lak.f90.

gwfsat

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::gwfsat => NULL()

Definition at line 242 of file gwf-lak.f90.

hcof

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::hcof => null()

inherited

Definition at line 76 of file BoundaryPackage.f90.

holdconn

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::holdconn => null()

Definition at line 235 of file gwf-lak.f90.

ialaktab

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::ialaktab => null()

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

iasym

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

inherited

Definition at line 41 of file NumericalPackage.f90.

iauxmultcol

integer(i4b), pointer bndmodule::bndtype::iauxmultcol => null()

inherited

Definition at line 69 of file BoundaryPackage.f90.

ibcnum

integer(i4b), pointer bndmodule::bndtype::ibcnum => null()

inherited

Definition at line 62 of file BoundaryPackage.f90.

ibound

integer(i4b), dimension(:), pointer, contiguous bndmodule::bndtype::ibound => null()

inherited

Definition at line 102 of file BoundaryPackage.f90.

iboundpak

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::iboundpak => null()

Definition at line 246 of file gwf-lak.f90.

ibudcsv

integer(i4b), pointer lakmodule::laktype::ibudcsv => null()

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

ibudgetout

integer(i4b), pointer lakmodule::laktype::ibudgetout => null()

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

icelltype

integer(i4b), dimension(:), pointer, contiguous bndmodule::bndtype::icelltype => null()

inherited

Definition at line 106 of file BoundaryPackage.f90.

iconvchk

integer(i4b), pointer lakmodule::laktype::iconvchk => NULL()

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

ictmempath

character(len=lenmempath) bndmodule::bndtype::ictmempath = ''

inherited

Definition at line 107 of file BoundaryPackage.f90.

ictype

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::ictype => null()

Definition at line 198 of file gwf-lak.f90.

id

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

inherited

Definition at line 37 of file NumericalPackage.f90.

idense

integer(i4b), pointer lakmodule::laktype::idense

Definition at line 261 of file gwf-lak.f90.

    integer(I4B), pointer :: idense

idhc

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::idhc => null()

Definition at line 179 of file gwf-lak.f90.

idxdiag

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::idxdiag => null()

Definition at line 189 of file gwf-lak.f90.

idxlakeconn

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::idxlakeconn => null()

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

idxlocnode

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::idxlocnode => null()

Definition at line 188 of file gwf-lak.f90.

idxoffdglo

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::idxoffdglo => null()

Definition at line 190 of file gwf-lak.f90.

idxsymdglo

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::idxsymdglo => null()

Definition at line 191 of file gwf-lak.f90.

idxsymoffdglo

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::idxsymoffdglo => null()

Definition at line 192 of file gwf-lak.f90.

iforceleg

integer(i4b), pointer lakmodule::laktype::iforceleg => NULL()

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

iforceleglak

integer(i4b), pointer lakmodule::laktype::iforceleglak => NULL()

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

igwhcopt

integer(i4b), pointer lakmodule::laktype::igwhcopt => NULL()

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

iimplicit

integer(i4b), pointer lakmodule::laktype::iimplicit => NULL()

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

ilegacy

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::ilegacy => null()

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

imap

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::imap => null()

Definition at line 195 of file gwf-lak.f90.

imover

integer(i4b), pointer bndmodule::bndtype::imover => null()

inherited

Definition at line 83 of file BoundaryPackage.f90.

inamedbound

integer(i4b), pointer bndmodule::bndtype::inamedbound => null()

inherited

Definition at line 68 of file BoundaryPackage.f90.

indxconvertflux

integer(i4b) bndmodule::bndtype::indxconvertflux = 0

inherited

Definition at line 93 of file BoundaryPackage.f90.

inewton

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

inherited

Definition at line 40 of file NumericalPackage.f90.

inflow

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::inflow => null()

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

inobspkg

integer(i4b), pointer bndmodule::bndtype::inobspkg => null()

inherited

Definition at line 97 of file BoundaryPackage.f90.

input

type(lakinputtype) lakmodule::laktype::input

Definition at line 254 of file gwf-lak.f90.

    type(LakInputType) :: input

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.

inputtab

type(tabletype), pointer bndmodule::bndtype::inputtab => null()

inherited

Definition at line 110 of file BoundaryPackage.f90.

inunit

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

inherited

Definition at line 38 of file NumericalPackage.f90.

ioffset

integer(i4b), pointer bndmodule::bndtype::ioffset => null()

inherited

Definition at line 71 of file BoundaryPackage.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.

iouttype

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::iouttype => null()

Definition at line 213 of file gwf-lak.f90.

ipakcb

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

inherited

Definition at line 44 of file NumericalPackage.f90.

ipakcsv

integer(i4b), pointer lakmodule::laktype::ipakcsv => null()

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

iper

integer(i4b), pointer bndextmodule::bndexttype::iper

inherited

Definition at line 35 of file BoundaryPackageExt.f90.

    integer(I4B), pointer :: iper

iprflow

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

inherited

Definition at line 43 of file NumericalPackage.f90.

iprhed

integer(i4b), pointer lakmodule::laktype::iprhed => null()

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

iprpak

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

inherited

Definition at line 42 of file NumericalPackage.f90.

isadvpak

integer(i4b), pointer bndmodule::bndtype::isadvpak => null()

inherited

Definition at line 61 of file BoundaryPackage.f90.

iscloc

integer(i4b), pointer bndmodule::bndtype::iscloc => null()

inherited

Definition at line 66 of file BoundaryPackage.f90.

iseepc

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::iseepc => null()

Definition at line 178 of file gwf-lak.f90.

istageout

integer(i4b), pointer lakmodule::laktype::istageout => null()

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

ivsc

integer(i4b), pointer bndmodule::bndtype::ivsc => null()

inherited

Definition at line 87 of file BoundaryPackage.f90.

lakebot

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::lakebot => null()

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

lakein

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::lakein => null()

Definition at line 211 of file gwf-lak.f90.

lakename

character(len=lenboundname), dimension(:), pointer, contiguous lakmodule::laktype::lakename => null()

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

lakeout

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::lakeout => null()

Definition at line 212 of file gwf-lak.f90.

laketop

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::laketop => null()

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

lastonper

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

inherited

Definition at line 46 of file NumericalPackage.f90.

listlabel

character(len=lenlistlabel), pointer bndmodule::bndtype::listlabel => null()

inherited

Definition at line 49 of file BoundaryPackage.f90.

lkgwsink

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::lkgwsink => null()

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

maxbound

integer(i4b), pointer bndmodule::bndtype::maxbound => null()

inherited

Definition at line 63 of file BoundaryPackage.f90.

maxlakit

integer(i4b), pointer lakmodule::laktype::maxlakit => NULL()

Definition at line 111 of file gwf-lak.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.

naux

integer(i4b), pointer bndmodule::bndtype::naux => null()

inherited

Definition at line 67 of file BoundaryPackage.f90.

nbound

integer(i4b), pointer bndmodule::bndtype::nbound => null()

inherited

Definition at line 64 of file BoundaryPackage.f90.

ncncvr

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::ncncvr => null()

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

ncolbnd

integer(i4b), pointer bndmodule::bndtype::ncolbnd => null()

inherited

Definition at line 65 of file BoundaryPackage.f90.

neq

integer(i4b), pointer bndmodule::bndtype::neq

inherited

Definition at line 101 of file BoundaryPackage.f90.

    integer(I4B), pointer :: neq !< number of equations for model

nlakeconn

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::nlakeconn => null()

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

nlakes

integer(i4b), pointer lakmodule::laktype::nlakes => NULL()

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

nodelist

integer(i4b), dimension(:), pointer, contiguous bndmodule::bndtype::nodelist => null()

inherited

Definition at line 73 of file BoundaryPackage.f90.

nodesontop

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::nodesontop => null()

Definition at line 197 of file gwf-lak.f90.

nodeulist

integer(i4b), dimension(:), pointer, contiguous bndextmodule::bndexttype::nodeulist => null()

inherited

Definition at line 41 of file BoundaryPackageExt.f90.

noupdateauxvar

integer(i4b), dimension(:), pointer, contiguous bndmodule::bndtype::noupdateauxvar => null()

inherited

Definition at line 74 of file BoundaryPackage.f90.

noutlets

integer(i4b), pointer lakmodule::laktype::noutlets => NULL()

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

npakeq

integer(i4b), pointer bndmodule::bndtype::npakeq => null()

inherited

Definition at line 70 of file BoundaryPackage.f90.

nstuck

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::nstuck => null()

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

ntables

integer(i4b), pointer lakmodule::laktype::ntables => NULL()

Definition at line 105 of file gwf-lak.f90.

ntabrow

integer(i4b), dimension(:), pointer, contiguous lakmodule::laktype::ntabrow => null()

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

obs

type(obstype), pointer bndmodule::bndtype::obs => null()

inherited

Definition at line 98 of file BoundaryPackage.f90.

outdmax

real(dp), pointer lakmodule::laktype::outdmax => NULL()

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

outinvert

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::outinvert => null()

Definition at line 215 of file gwf-lak.f90.

outlet_invert_set

logical(lgp), dimension(:), pointer, contiguous lakmodule::laktype::outlet_invert_set => null()

Definition at line 223 of file gwf-lak.f90.

outlet_rough_set

logical(lgp), dimension(:), pointer, contiguous lakmodule::laktype::outlet_rough_set => null()

Definition at line 225 of file gwf-lak.f90.

outlet_slope_set

logical(lgp), dimension(:), pointer, contiguous lakmodule::laktype::outlet_slope_set => null()

Definition at line 226 of file gwf-lak.f90.

outlet_width_set

logical(lgp), dimension(:), pointer, contiguous lakmodule::laktype::outlet_width_set => null()

Definition at line 224 of file gwf-lak.f90.

outputtab

type(tabletype), pointer bndmodule::bndtype::outputtab => null()

inherited

Definition at line 111 of file BoundaryPackage.f90.

outrate

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::outrate => null()

Definition at line 214 of file gwf-lak.f90.

outrough

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::outrough => null()

Definition at line 217 of file gwf-lak.f90.

outslope

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::outslope => null()

Definition at line 218 of file gwf-lak.f90.

outwidth

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::outwidth => null()

Definition at line 216 of file gwf-lak.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.

pakcsvfile

character(len=:), allocatable lakmodule::laktype::pakcsvfile

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

    character(len=:), allocatable :: pakcsvfile !< requested PACKAGE_CONVERGENCE file, opened in lak_ar once the IMPLICIT option is known

pakcsvtab

type(tabletype), pointer lakmodule::laktype::pakcsvtab => null()

Definition at line 258 of file gwf-lak.f90.

pakmvrobj

type(packagemovertype), pointer bndmodule::bndtype::pakmvrobj => null()

inherited

Definition at line 84 of file BoundaryPackage.f90.

parser

type(blockparsertype) numericalpackagemodule::numericalpackagetype::parser

inherited

Definition at line 49 of file NumericalPackage.f90.

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

pkg_ifno

integer(i4b), dimension(:), pointer, contiguous bndextmodule::bndexttype::pkg_ifno => null()

inherited

Definition at line 43 of file BoundaryPackageExt.f90.

precip

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::precip => null()

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

precip1

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::precip1 => null()

Definition at line 162 of file gwf-lak.f90.

qauxcbc

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::qauxcbc => null()

Definition at line 229 of file gwf-lak.f90.

qgwf0

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::qgwf0 => null()

Definition at line 186 of file gwf-lak.f90.

qleak

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::qleak => null()

Definition at line 231 of file gwf-lak.f90.

qsto

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::qsto => null()

Definition at line 236 of file gwf-lak.f90.

r1

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::r1 => null()

Definition at line 182 of file gwf-lak.f90.

r2

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::r2 => null()

Definition at line 183 of file gwf-lak.f90.

rainfall

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::rainfall => null()

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

readarraygrid

logical(lgp), pointer bndextmodule::bndexttype::readarraygrid

inherited

Definition at line 36 of file BoundaryPackageExt.f90.

    logical(LGP), pointer :: readarraygrid

readasarrays

logical(lgp), pointer bndextmodule::bndexttype::readasarrays

inherited

Definition at line 37 of file BoundaryPackageExt.f90.

    logical(LGP), pointer :: readasarrays

rhs

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::rhs => null()

inherited

Definition at line 77 of file BoundaryPackage.f90.

runoff

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::runoff => null()

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

s0

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::s0 => null()

Definition at line 185 of file gwf-lak.f90.

sarea

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::sarea => null()

Definition at line 204 of file gwf-lak.f90.

sareamax

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::sareamax => null()

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

satcond

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::satcond => null()

Definition at line 206 of file gwf-lak.f90.

seep

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::seep => null()

Definition at line 171 of file gwf-lak.f90.

seep0

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::seep0 => null()

Definition at line 173 of file gwf-lak.f90.

seep1

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::seep1 => null()

Definition at line 172 of file gwf-lak.f90.

simcond

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::simcond => null()

Definition at line 207 of file gwf-lak.f90.

simlakgw

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::simlakgw => null()

Definition at line 208 of file gwf-lak.f90.

simoutrate

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::simoutrate => null()

Definition at line 219 of file gwf-lak.f90.

simtomvr

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::simtomvr => null()

inherited

Definition at line 80 of file BoundaryPackage.f90.

simvals

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::simvals => null()

inherited

Definition at line 79 of file BoundaryPackage.f90.

stage

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::stage => null()

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

stageiter

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::stageiter => null()

Definition at line 174 of file gwf-lak.f90.

stagetab

type(tabletype), pointer lakmodule::laktype::stagetab => null()

Definition at line 257 of file gwf-lak.f90.

status

character(len=8), dimension(:), pointer, contiguous lakmodule::laktype::status => null()

Definition at line 134 of file gwf-lak.f90.

strt

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::strt => null()

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

surfdep

real(dp), pointer lakmodule::laktype::surfdep => NULL()

Definition at line 112 of file gwf-lak.f90.

surfin

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::surfin => null()

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

surfout

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::surfout => null()

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

surfout1

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::surfout1 => null()

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

tabsarea

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::tabsarea => null()

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

tabstage

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::tabstage => null()

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

tabvolume

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::tabvolume => null()

Definition at line 147 of file gwf-lak.f90.

tabwarea

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::tabwarea => null()

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

tasmanager

type(timearrayseriesmanagertype), pointer bndmodule::bndtype::tasmanager => null()

inherited

Definition at line 92 of file BoundaryPackage.f90.

telev

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::telev => null()

Definition at line 201 of file gwf-lak.f90.

text

character(len=lenpackagename) bndmodule::bndtype::text = ''

inherited

Definition at line 50 of file BoundaryPackage.f90.

ts_active

logical(lgp), pointer bndextmodule::bndexttype::ts_active

inherited

Definition at line 38 of file BoundaryPackageExt.f90.

    logical(LGP), pointer :: ts_active !< .true. if TS6 files are configured in OPTIONS

tsmanager

type(timeseriesmanagertype), pointer bndmodule::bndtype::tsmanager => null()

inherited

Definition at line 91 of file BoundaryPackage.f90.

viscratios

real(dp), dimension(:, :), pointer, contiguous lakmodule::laktype::viscratios => null()

Definition at line 265 of file gwf-lak.f90.

warea

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::warea => null()

Definition at line 205 of file gwf-lak.f90.

withdrawal

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::withdrawal => null()

Definition at line 142 of file gwf-lak.f90.

withr

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::withr => null()

Definition at line 166 of file gwf-lak.f90.

withr1

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::withr1 => null()

Definition at line 167 of file gwf-lak.f90.

xnew

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::xnew => null()

inherited

Definition at line 103 of file BoundaryPackage.f90.

xnewpak

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::xnewpak => null()

Definition at line 247 of file gwf-lak.f90.

xold

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::xold => null()

inherited

Definition at line 104 of file BoundaryPackage.f90.

xoldpak

real(dp), dimension(:), pointer, contiguous lakmodule::laktype::xoldpak => null()

Definition at line 248 of file gwf-lak.f90.

---

The documentation for this type was generated from the following file:

• /home/runner/work/modflow6/modflow6/src/Model/GroundWaterFlow/gwf-lak.f90