Inheritance diagram for swfpcpmodule::swfpcptype:

Collaboration diagram for swfpcpmodule::swfpcptype:

Public Member Functions
procedure	pcp_allocate_scalars (this)
	Allocate scalar members.
procedure	allocate_arrays (this, nodelist, auxvar)
	Allocate package arrays.
procedure	source_options (this)
	Source options specific to PCPType.
procedure	source_dimensions (this)
	Source the dimensions for this package.
procedure	log_pcp_options (this, found_readasarrays)
	Log options specific to SwfPcpType.
procedure	read_initial_attr (this)
	Part of allocate and read.
procedure	bnd_rp (this)
	Read and Prepare.
procedure	bnd_ck (this)
	Ensure precipitation is positive.
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_da (this)
	Deallocate memory.
procedure	define_listlabel (this)
	Define the list heading that is written to iout when PRINT_INPUT option is used.
procedure	bound_value (this, col, row)
	Return requested boundary value.
procedure	default_nodelist (this)
	Assign default nodelist when READASARRAYS is specified.
procedure, public	bnd_obs_supported (this)
	Overrides BndTypebnd_obs_supported().
procedure, public	bnd_df_obs (this)
	Implements bnd_df_obs.
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
real(dp), dimension(:), pointer, contiguous	precipitation => null()
	boundary precipitation array
type(swfdfwtype), pointer	dfw
type(swfcxstype), pointer	cxs
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	reach_length_pointer (this)
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

Private Attributes
logical, pointer, private	read_as_arrays

Detailed Description

Definition at line 36 of file swf-pcp.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays() [1/3]

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/3]

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_arrays() [3/3]

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

Definition at line 47 of file swf-pcp.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()

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_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/2]

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/2]

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_ar()

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_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()

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_cc()

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_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 swfpcpmodule::swfpcptype::bnd_cf ( class(swfpcptype) this )

Skip if no precipitation. Otherwise, calculate hcof and rhs

Definition at line 54 of file swf-pcp.f90.

◆ bnd_ck() [1/2]

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_ck() [2/2]

procedure swfpcpmodule::swfpcptype::bnd_ck ( class(swfpcptype), intent(inout) this )

Definition at line 53 of file swf-pcp.f90.

◆ bnd_cq()

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_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 swfpcpmodule::swfpcptype::bnd_da ( class(swfpcptype) this )

Definition at line 56 of file swf-pcp.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 swfpcpmodule::swfpcptype::bnd_df_obs ( class(swfpcptype) this )

Store observation type supported by PCP package. Overrides BndTypebnd_df_obs

Definition at line 63 of file swf-pcp.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 swfpcpmodule::swfpcptype::bnd_fc	(	class(swfpcptype)	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 55 of file swf-pcp.f90.

◆ bnd_fn()

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_fp()

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

inherited

Parameters

this	BndType object

Definition at line 135 of file BoundaryPackage.f90.

◆ bnd_mc()

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_nur()

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_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 swfpcpmodule::swfpcptype::bnd_obs_supported ( class(swfpcptype) this )

Definition at line 62 of file swf-pcp.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()

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_dv()

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_model_flows()

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_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()

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_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 swfpcpmodule::swfpcptype::bnd_rp ( class(swfpcptype), intent(inout) this )

Read itmp and read new boundaries if itmp > 0

Definition at line 52 of file swf-pcp.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()

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_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() [1/2]

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.

◆ bound_value() [2/2]

procedure swfpcpmodule::swfpcptype::bound_value	(	class(swfpcptype), intent(inout)	this,
		integer(i4b), intent(in)	col,
		integer(i4b), intent(in)	row )

Definition at line 58 of file swf-pcp.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() [1/2]

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.

◆ default_nodelist() [2/2]

procedure swfpcpmodule::swfpcptype::default_nodelist ( class(swfpcptype) this )

Definition at line 59 of file swf-pcp.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 swfpcpmodule::swfpcptype::define_listlabel ( class(swfpcptype), intent(inout) this )

Definition at line 57 of file swf-pcp.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.

◆ 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.

◆ log_pcp_options()

procedure swfpcpmodule::swfpcptype::log_pcp_options	(	class(swfpcptype), intent(inout)	this,
		logical(lgp), intent(in)	found_readasarrays )

Definition at line 50 of file swf-pcp.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.

◆ pcp_allocate_scalars()

procedure swfpcpmodule::swfpcptype::pcp_allocate_scalars ( class(swfpcptype), intent(inout) this )

Definition at line 46 of file swf-pcp.f90.

◆ reach_length_pointer()

procedure, private swfpcpmodule::swfpcptype::reach_length_pointer ( class(swfpcptype) this )

private

Parameters

this	this instance

Definition at line 60 of file swf-pcp.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 swfpcpmodule::swfpcptype::read_initial_attr ( class(swfpcptype), intent(inout) this )

Definition at line 51 of file swf-pcp.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()

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.

◆ 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 swfpcpmodule::swfpcptype::source_dimensions ( class(swfpcptype), intent(inout) this )

Definition at line 49 of file swf-pcp.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 swfpcpmodule::swfpcptype::source_options ( class(swfpcptype), intent(inout) this )

Definition at line 48 of file swf-pcp.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.

◆ 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.

◆ cellid

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

inherited

Definition at line 40 of file BoundaryPackageExt.f90.

◆ condinput

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

inherited

Definition at line 88 of file BoundaryPackage.f90.

◆ cxs

type(swfcxstype), pointer swfpcpmodule::swfpcptype::cxs

Definition at line 42 of file swf-pcp.f90.

42 type(SwfCxsType), pointer :: cxs

◆ dfw

type(swfdfwtype), pointer swfpcpmodule::swfpcptype::dfw

Definition at line 41 of file swf-pcp.f90.

41 type(SwfDfwType), pointer :: dfw

◆ dis

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

inherited

Definition at line 50 of file NumericalPackage.f90.

◆ errortab

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

inherited

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

◆ hcof

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

inherited

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

◆ icelltype

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

inherited

Definition at line 106 of file BoundaryPackage.f90.

◆ ictmempath

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

inherited

Definition at line 107 of file BoundaryPackage.f90.

◆ id

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

inherited

Definition at line 37 of file NumericalPackage.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.

◆ inobspkg

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

inherited

Definition at line 97 of file BoundaryPackage.f90.

◆ input_fname

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

inherited

Definition at line 32 of file NumericalPackage.f90.

◆ input_mempath

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

inherited

Definition at line 31 of file NumericalPackage.f90.

◆ 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.

◆ ipakcb

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

inherited

Definition at line 44 of file NumericalPackage.f90.

◆ iper

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

inherited

Definition at line 35 of file BoundaryPackageExt.f90.

35 integer(I4B), pointer :: iper

◆ iprflow

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

inherited

Definition at line 43 of file NumericalPackage.f90.

◆ iprpak

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

inherited

Definition at line 42 of file NumericalPackage.f90.

◆ 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.

◆ ivsc

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

inherited

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

◆ maxbound

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

inherited

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

◆ 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.

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

◆ nodelist

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

inherited

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

◆ npakeq

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

inherited

Definition at line 70 of file BoundaryPackage.f90.

◆ obs

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

inherited

Definition at line 98 of file BoundaryPackage.f90.

◆ outputtab

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

inherited

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

◆ 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.

49 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.

◆ precipitation

real(dp), dimension(:), pointer, contiguous swfpcpmodule::swfpcptype::precipitation => null()

Definition at line 37 of file swf-pcp.f90.

◆ read_as_arrays

logical, pointer, private swfpcpmodule::swfpcptype::read_as_arrays

private

Definition at line 38 of file swf-pcp.f90.

38 logical, pointer, private :: read_as_arrays

◆ readarraygrid

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

inherited

Definition at line 36 of file BoundaryPackageExt.f90.

36 logical(LGP), pointer :: readarraygrid

◆ readasarrays

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

inherited

Definition at line 37 of file BoundaryPackageExt.f90.

37 logical(LGP), pointer :: readasarrays

◆ rhs

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

inherited

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

◆ tasmanager

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

inherited

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

38 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.

◆ xnew

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

inherited

Definition at line 103 of file BoundaryPackage.f90.

◆ xold

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

inherited

Definition at line 104 of file BoundaryPackage.f90.

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

/home/runner/work/modflow6/modflow6/src/Model/SurfaceWaterFlow/swf-pcp.f90

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ allocate_arrays() [1/3]

◆ allocate_arrays() [2/3]

◆ allocate_arrays() [3/3]

◆ allocate_featureauxvar()

◆ allocate_scalars() [1/3]

◆ allocate_scalars() [2/3]

◆ allocate_scalars() [3/3]

◆ bnd_ac()

◆ bnd_activate_viscosity()

◆ bnd_ad() [1/2]

◆ bnd_ad() [2/2]

◆ bnd_ar()

◆ bnd_bd()

◆ bnd_bd_obs()

◆ bnd_cc()

◆ bnd_cf() [1/2]

◆ bnd_cf() [2/2]

◆ bnd_ck() [1/2]

◆ bnd_ck() [2/2]

◆ bnd_cq()

◆ bnd_cq_simrate()

◆ bnd_cq_simtomvr()

◆ bnd_da() [1/3]

◆ bnd_da() [2/3]

◆ bnd_da() [3/3]

◆ bnd_df() [1/2]

◆ bnd_df() [2/2]

◆ bnd_df_obs() [1/2]

◆ bnd_df_obs() [2/2]

◆ bnd_dt()

◆ bnd_fc() [1/2]

◆ bnd_fc() [2/2]

◆ bnd_fn()

◆ bnd_fp()

◆ bnd_mc()

◆ bnd_nur()

◆ bnd_obs_supported() [1/2]

◆ bnd_obs_supported() [2/2]

◆ bnd_options()

◆ bnd_ot_bdsummary()

◆ bnd_ot_dv()

◆ bnd_ot_model_flows()

◆ bnd_ot_obs()

◆ bnd_ot_package_flows()

◆ bnd_reset()

◆ bnd_rp() [1/3]

◆ bnd_rp() [2/3]

◆ bnd_rp() [3/3]

◆ bnd_rp_log() [1/2]

◆ bnd_rp_log() [2/2]

◆ bnd_rp_obs()

◆ bnd_rp_ts()

◆ bnd_store_user_cond()

◆ bound_value() [1/2]

◆ bound_value() [2/2]

◆ cellid_to_nlist()

◆ check_cellid()

◆ copy_boundname()

◆ da()

◆ default_nodelist() [1/2]

◆ default_nodelist() [2/2]

◆ define_listlabel() [1/2]

◆ define_listlabel() [2/2]

◆ get_block_data()

◆ layarr_to_nlist()

◆ log_options()

◆ log_pcp_options()

◆ nodeu_to_nlist()

◆ pack_initialize()

◆ pak_setup_outputtab()

◆ pcp_allocate_scalars()

◆ reach_length_pointer()

◆ read_check_ionper()

◆ read_dimensions()