The GWF Interface Model is a utility to calculate the solution's exchange coefficients from the interface between a GWF model and its GWF neighbors. The interface model itself will not be part of the solution, it is not being solved. Patching (a part of the) discretizations of two GWF models in a general way, e.g. DIS+DIS with refinement, requires the resulting. More...

Inheritance diagram for gwfinterfacemodelmodule::gwfinterfacemodeltype:

Collaboration diagram for gwfinterfacemodelmodule::gwfinterfacemodeltype:

Public Member Functions
procedure, pass(this)	gwfifm_cr (this, name, iout, gridconn)
	set up the interface model, analogously to what
procedure	model_df (this)
	Define, mostly DISU and the NPF package.
procedure	model_ar (this)
	allocate and read the packages
procedure	model_da (this)
	Clean up.
procedure	model_df (this)
	Define packages of the model.
procedure	model_df (this)
procedure	model_df (this)
	Define the model.
procedure	model_ac (this, sparse)
	Add the internal connections of this model to the sparse matrix.
procedure	model_ac (this, sparse)
procedure	model_mc (this, matrix_sln)
	Map the positions of this models connections in the numerical solution coefficient matrix.
procedure	model_mc (this, matrix_sln)
procedure	model_ar (this)
	GroundWater Flow Model Allocate and Read.
procedure	model_ar (this)
procedure	model_ar (this)
	Allocate and read.
procedure	model_rp (this)
	GroundWater Flow Model Read and Prepare.
procedure	model_rp (this)
procedure	model_rp (this)
	Read and prepare.
procedure	model_ad (this)
	GroundWater Flow Model Time Step Advance.
procedure	model_ad (this)
procedure	model_cf (this, kiter)
	GroundWater Flow Model calculate coefficients.
procedure	model_cf (this, kiter)
procedure	model_fc (this, kiter, matrix_sln, inwtflag)
	GroundWater Flow Model fill coefficients.
procedure	model_fc (this, kiter, matrix_sln, inwtflag)
procedure	model_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak)
	GroundWater Flow Model Final Convergence Check for Boundary Packages.
procedure	model_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak)
procedure	model_ptcchk (this, iptc)
	check if pseudo-transient continuation factor should be used
procedure	model_ptcchk (this, iptc)
procedure	model_ptc (this, vec_residual, iptc, ptcf)
	calculate maximum pseudo-transient continuation factor
procedure	model_ptc (this, vec_residual, iptc, ptcf)
procedure	model_nur (this, neqmod, x, xtemp, dx, inewtonur, dxmax, locmax)
	under-relaxation
procedure	model_nur (this, neqmod, x, xtemp, dx, inewtonur, dxmax, locmax)
procedure	model_cq (this, icnvg, isuppress_output)
	Groundwater flow model calculate flow.
procedure	model_cq (this, icnvg, isuppress_output)
procedure	model_bd (this, icnvg, isuppress_output)
	GroundWater Flow Model Budget.
procedure	model_bd (this, icnvg, isuppress_output)
procedure	model_ot (this)
	GroundWater Flow Model Output.
procedure	model_ot (this)
procedure	model_ot (this)
	Output results.
procedure	model_dt (this)
	Submit boundary-package ATS time step requests.
procedure	model_dt (this)
	Calculate time step length.
procedure	model_fp (this)
procedure	model_fp (this)
procedure	model_fp (this)
	Final processing.
procedure	model_da (this)
	Deallocate.
procedure	model_da (this)
procedure	model_da (this)
	Deallocate.
procedure	model_bdentry (this, budterm, budtxt, rowlabel)
	GroundWater Flow Model Budget Entry.
procedure	model_bdentry (this, budterm, budtxt, rowlabel)
procedure	get_iasym (this)
	return 1 if any package causes the matrix to be asymmetric. Otherwise return 0.
procedure	get_iasym (this)
procedure	allocate_scalars (this, modelname)
	Allocate memory for non-allocatable members.
procedure	allocate_scalars (this, modelname)
procedure	allocate_scalars (this, modelname)
	Allocate scalar variables.
procedure	package_create (this, filtyp, ipakid, ipaknum, pakname, mempath, inunit, iout)
	Create boundary condition packages for this model.
procedure	ftype_check (this, indis)
	Check to make sure required input files have been specified.
procedure	gwf_ot_obs (this)
	GroundWater Flow Model output observations.
procedure	gwf_ot_flow (this, icbcfl, ibudfl, icbcun)
	Groundwater Flow Model output flows.
procedure	gwf_ot_dv (this, idvsave, idvprint, ipflag)
	Groundwater Flow Model output dependent variable.
procedure	gwf_ot_bdsummary (this, ibudfl, ipflag)
	Groundwater Flow Model output budget summary.
procedure	model_reset (this)
procedure	model_solve (this)
procedure	model_nr (this, kiter, matrix, inwtflag)
procedure	model_bdcalc (this, icnvg)
procedure	model_bdsave (this, icnvg)
procedure	allocate_arrays (this)
procedure	set_moffset (this, moffset)
procedure	set_idsoln (this, id)
procedure	set_xptr (this, xsln, sln_offset, varnametgt, mempathtgt)
procedure	set_rhsptr (this, rhssln, sln_offset, varnametgt, mempathtgt)
procedure	set_iboundptr (this, iboundsln, sln_offset, varnametgt, mempathtgt)
procedure	get_mrange (this, mstart, mend)
procedure	get_mcellid (this, node, mcellid)
procedure	get_mnodeu (this, node, nodeu)
procedure	get_idv_scale (this)
procedure	model_message (this, line, fmt)
	Write line to model iout.
procedure	create_lstfile (this, lst_fname, model_fname, defined, headertxt)

Public Attributes
class(gridconnectiontype), pointer	gridconnection => null()
	The grid connection class will provide the interface grid.
type(gwfictype), pointer	ic => null()
type(gwfnpftype), pointer	npf => null()
type(xt3dtype), pointer	xt3d => null()
type(gwfbuytype), pointer	buy => null()
type(gwfvsctype), pointer	vsc => null()
type(gwfstotype), pointer	sto => null()
type(gwfcsubtype), pointer	csub => null()
type(gwfoctype), pointer	oc => null()
type(ghostnodetype), pointer	gnc => null()
type(gwfhfbtype), pointer	hfb => null()
type(gwfmvrtype), pointer	mvr => null()
type(gwfobstype), pointer	obs => null()
type(budgettype), pointer	budget => null()
integer(i4b), pointer	inic => null()
integer(i4b), pointer	inoc => null()
integer(i4b), pointer	innpf => null()
integer(i4b), pointer	inbuy => null()
integer(i4b), pointer	invsc => null()
integer(i4b), pointer	insto => null()
integer(i4b), pointer	incsub => null()
integer(i4b), pointer	inmvr => null()
integer(i4b), pointer	inhfb => null()
integer(i4b), pointer	ingnc => null()
integer(i4b), pointer	inobs => null()
integer(i4b), pointer	iss => null()
integer(i4b), pointer	inewtonur => null()
integer(i4b), pointer	neq => null()
	number of equations
integer(i4b), pointer	moffset => null()
	offset of this model in the solution
integer(i4b), pointer	icnvg => null()
	convergence flag
integer(i4b), dimension(:), pointer, contiguous	ia => null()
	csr row pointer
integer(i4b), dimension(:), pointer, contiguous	ja => null()
	csr columns
real(dp), dimension(:), pointer, contiguous	x => null()
	dependent variable (head, conc, etc)
real(dp), dimension(:), pointer, contiguous	rhs => null()
	right-hand side vector
real(dp), dimension(:), pointer, contiguous	cond => null()
	conductance matrix
integer(i4b), dimension(:), pointer, contiguous	idxglo => null()
	pointer to position in solution matrix
real(dp), dimension(:), pointer, contiguous	xold => null()
	dependent variable for previous timestep
character(len=lenmempath)	memorypath
	the location in the memory manager where the variables are stored
character(len=lenmodelname), pointer	name => null()
	name of the model
character(len=linelength), pointer	filename => null()
	input file name
character(len=3), pointer	macronym => null()
	3 letter model acronym (GWF, GWT, ...)
integer(i4b), pointer	idsoln => null()
	id of the solution model is in
integer(i4b), pointer	id => null()
	model id
integer(i4b), pointer	iout => null()
	output unit number
integer(i4b), pointer	inewton => null()
	newton-raphson flag
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()
	save_flows flag
integer(i4b), pointer	nja => null()
	number of connections
integer(i4b), dimension(:), pointer, contiguous	ibound => null()
	ibound
real(dp), dimension(:), pointer, contiguous	flowja => null()
	intercell flows
type(listtype), pointer	bndlist => null()
	array of boundary packages
class(disbasetype), pointer	dis => null()
	discretization object

Private Member Functions
procedure, pass(this), private	setnpfoptions (this, npfoptions)
	Copy NPF options from the model owning the interface to the data structure.
procedure, pass(this), private	setbuydata (this, buydata)
	Sets the BUY input data from the models that make up this interface. We adopt everything from the owning model, but during validation it should be.
procedure, private	create_packages (this)
	Source package info and begin to process.
procedure, private	create_bndpkgs (this, bndpkgs, pkgtypes, pkgnames, mempaths, inunits)
	Source package info and begin to process.
procedure, private	log_namfile_options (this, found)
	Write model namfile options to list file.
procedure, private	steady_period_check (this)
	Check for steady state period.

Private Attributes
class(gwfmodeltype), pointer, private	owner => null()
	the real GWF model for which the exchange coefficients are calculated with this interface model

Detailed Description

Definition at line 27 of file GwfInterfaceModel.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure numericalmodelmodule::numericalmodeltype::allocate_arrays ( class(numericalmodeltype) this )

inherited

Definition at line 57 of file NumericalModel.f90.

◆ allocate_scalars() [1/3]

procedure basemodelmodule::basemodeltype::allocate_scalars	(	class(basemodeltype)	this,
		character(len=*), intent(in)	modelname )

inherited

Definition at line 41 of file BaseModel.f90.

◆ allocate_scalars() [2/3]

procedure gwfmodule::gwfmodeltype::allocate_scalars	(	class(gwfmodeltype)	this,
		character(len=*), intent(in)	modelname )

inherited

Definition at line 88 of file gwf.f90.

◆ allocate_scalars() [3/3]

procedure numericalmodelmodule::numericalmodeltype::allocate_scalars	(	class(numericalmodeltype)	this,
		character(len=*), intent(in)	modelname )

inherited

Definition at line 56 of file NumericalModel.f90.

◆ create_bndpkgs()

procedure, private gwfmodule::gwfmodeltype::create_bndpkgs	(	class(gwfmodeltype)	this,
		integer(i4b), dimension(:), intent(inout), allocatable	bndpkgs,
		type(characterstringtype), dimension(:), intent(inout), pointer, contiguous	pkgtypes,
		type(characterstringtype), dimension(:), intent(inout), pointer, contiguous	pkgnames,
		type(characterstringtype), dimension(:), intent(inout), pointer, contiguous	mempaths,
		integer(i4b), dimension(:), intent(inout), pointer, contiguous	inunits )

privateinherited

Definition at line 96 of file gwf.f90.

◆ create_lstfile()

procedure basemodelmodule::basemodeltype::create_lstfile	(	class(basemodeltype)	this,
		character(len=*), intent(inout)	lst_fname,
		character(len=*), intent(in)	model_fname,
		logical(lgp), intent(in)	defined,
		character(len=*), intent(in)	headertxt )

inherited

Definition at line 43 of file BaseModel.f90.

◆ create_packages()

procedure, private gwfmodule::gwfmodeltype::create_packages ( class(gwfmodeltype) this )

privateinherited

Definition at line 95 of file gwf.f90.

◆ ftype_check()

procedure gwfmodule::gwfmodeltype::ftype_check	(	class(gwfmodeltype)	this,
		integer(i4b), intent(in)	indis )

inherited

Definition at line 90 of file gwf.f90.

◆ get_iasym() [1/2]

procedure gwfmodule::gwfmodeltype::get_iasym ( class(gwfmodeltype) this )

inherited

Definition at line 86 of file gwf.f90.

◆ get_iasym() [2/2]

procedure numericalmodelmodule::numericalmodeltype::get_iasym ( class(numericalmodeltype) this )

inherited

Definition at line 66 of file NumericalModel.f90.

◆ get_idv_scale()

procedure numericalmodelmodule::numericalmodeltype::get_idv_scale ( class(numericalmodeltype) this )

inherited

Definition at line 67 of file NumericalModel.f90.

◆ get_mcellid()

procedure numericalmodelmodule::numericalmodeltype::get_mcellid	(	class(numericalmodeltype)	this,
		integer(i4b), intent(in)	node,
		character(len=*), intent(inout)	mcellid )

inherited

Definition at line 64 of file NumericalModel.f90.

◆ get_mnodeu()

procedure numericalmodelmodule::numericalmodeltype::get_mnodeu	(	class(numericalmodeltype)	this,
		integer(i4b), intent(in)	node,
		integer(i4b), intent(inout)	nodeu )

inherited

Definition at line 65 of file NumericalModel.f90.

◆ get_mrange()

procedure numericalmodelmodule::numericalmodeltype::get_mrange	(	class(numericalmodeltype)	this,
		integer(i4b), intent(inout)	mstart,
		integer(i4b), intent(inout)	mend )

inherited

Definition at line 63 of file NumericalModel.f90.

◆ gwf_ot_bdsummary()

procedure gwfmodule::gwfmodeltype::gwf_ot_bdsummary	(	class(gwfmodeltype)	this,
		integer(i4b), intent(in)	ibudfl,
		integer(i4b), intent(inout)	ipflag )

inherited

Definition at line 94 of file gwf.f90.

◆ gwf_ot_dv()

procedure gwfmodule::gwfmodeltype::gwf_ot_dv	(	class(gwfmodeltype)	this,
		integer(i4b), intent(in)	idvsave,
		integer(i4b), intent(in)	idvprint,
		integer(i4b), intent(inout)	ipflag )

inherited

Definition at line 93 of file gwf.f90.

◆ gwf_ot_flow()

procedure gwfmodule::gwfmodeltype::gwf_ot_flow	(	class(gwfmodeltype)	this,
		integer(i4b), intent(in)	icbcfl,
		integer(i4b), intent(in)	ibudfl,
		integer(i4b), intent(in)	icbcun )

inherited

Definition at line 92 of file gwf.f90.

◆ gwf_ot_obs()

procedure gwfmodule::gwfmodeltype::gwf_ot_obs ( class(gwfmodeltype) this )

inherited

Definition at line 91 of file gwf.f90.

◆ gwfifm_cr()

procedure, pass(this) gwfinterfacemodelmodule::gwfinterfacemodeltype::gwfifm_cr	(	class(gwfinterfacemodeltype)	this,
		character(len=*), intent(in)	name,
		integer(i4b), intent(in)	iout,
		class(gridconnectiontype), intent(in), pointer	gridconn )

Parameters

	this	the GWF interface model
[in]	name	the interface model's name
[in]	iout	the output unit
[in]	gridconn	the grid connection for creating a DISU

Definition at line 32 of file GwfInterfaceModel.f90.

◆ log_namfile_options()

procedure, private gwfmodule::gwfmodeltype::log_namfile_options	(	class(gwfmodeltype)	this,
		type(gwfnamparamfoundtype), intent(in)	found )

privateinherited

Definition at line 97 of file gwf.f90.

◆ model_ac() [1/2]

procedure gwfmodule::gwfmodeltype::model_ac	(	class(gwfmodeltype)	this,
		type(sparsematrix), intent(inout)	sparse )

inherited

Definition at line 68 of file gwf.f90.

◆ model_ac() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_ac	(	class(numericalmodeltype)	this,
		type(sparsematrix), intent(inout)	sparse )

inherited

Definition at line 36 of file NumericalModel.f90.

◆ model_ad() [1/2]

procedure gwfmodule::gwfmodeltype::model_ad ( class(gwfmodeltype) this )

inherited

(1) calls package advance subroutines

Definition at line 72 of file gwf.f90.

◆ model_ad() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_ad ( class(numericalmodeltype) this )

inherited

Definition at line 39 of file NumericalModel.f90.

◆ model_ar() [1/4]

procedure basemodelmodule::basemodeltype::model_ar ( class(basemodeltype) this )

inherited

Definition at line 35 of file BaseModel.f90.

◆ model_ar() [2/4]

procedure gwfinterfacemodelmodule::gwfinterfacemodeltype::model_ar ( class(gwfinterfacemodeltype) this )

Parameters

this	the GWF interface model

Definition at line 34 of file GwfInterfaceModel.f90.

◆ model_ar() [3/4]

procedure gwfmodule::gwfmodeltype::model_ar ( class(gwfmodeltype) this )

inherited

(1) allocates and reads packages part of this model, (2) allocates memory for arrays part of this model object

Definition at line 70 of file gwf.f90.

◆ model_ar() [4/4]

procedure numericalmodelmodule::numericalmodeltype::model_ar ( class(numericalmodeltype) this )

inherited

Definition at line 32 of file NumericalModel.f90.

◆ model_bd() [1/2]

procedure gwfmodule::gwfmodeltype::model_bd	(	class(gwfmodeltype)	this,
		integer(i4b), intent(in)	icnvg,
		integer(i4b), intent(in)	isuppress_output )

inherited

(1) Calculate stress package contributions to model budget

Definition at line 80 of file gwf.f90.

◆ model_bd() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_bd	(	class(numericalmodeltype)	this,
		integer(i4b), intent(in)	icnvg,
		integer(i4b), intent(in)	isuppress_output )

inherited

Definition at line 50 of file NumericalModel.f90.

◆ model_bdcalc()

procedure numericalmodelmodule::numericalmodeltype::model_bdcalc	(	class(numericalmodeltype)	this,
		integer(i4b), intent(in)	icnvg )

inherited

Definition at line 51 of file NumericalModel.f90.

◆ model_bdentry() [1/2]

procedure gwfmodule::gwfmodeltype::model_bdentry	(	class(gwfmodeltype)	this,
		real(dp), dimension(:, :), intent(in)	budterm,
		character(len=lenbudtxt), dimension(:), intent(in)	budtxt,
		character(len=*), intent(in)	rowlabel )

inherited

This subroutine adds a budget entry to the flow budget. It was added as a method for the gwf model object so that the exchange object could add its

Definition at line 85 of file gwf.f90.

◆ model_bdentry() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_bdentry	(	class(numericalmodeltype)	this,
		real(dp), dimension(:, :), intent(in)	budterm,
		character(len=lenbudtxt), dimension(:), intent(in)	budtxt,
		character(len=*), intent(in)	rowlabel )

inherited

Definition at line 54 of file NumericalModel.f90.

◆ model_bdsave()

procedure numericalmodelmodule::numericalmodeltype::model_bdsave	(	class(numericalmodeltype)	this,
		integer(i4b), intent(in)	icnvg )

inherited

Definition at line 52 of file NumericalModel.f90.

◆ model_cc() [1/2]

procedure gwfmodule::gwfmodeltype::model_cc	(	class(gwfmodeltype)	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

(1) calls package cc routines

Definition at line 75 of file gwf.f90.

◆ model_cc() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_cc	(	class(numericalmodeltype)	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

Definition at line 47 of file NumericalModel.f90.

◆ model_cf() [1/2]

procedure gwfmodule::gwfmodeltype::model_cf	(	class(gwfmodeltype)	this,
		integer(i4b), intent(in)	kiter )

inherited

Definition at line 73 of file gwf.f90.

◆ model_cf() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_cf	(	class(numericalmodeltype)	this,
		integer(i4b), intent(in)	kiter )

inherited

Definition at line 42 of file NumericalModel.f90.

◆ model_cq() [1/2]

procedure gwfmodule::gwfmodeltype::model_cq	(	class(gwfmodeltype)	this,
		integer(i4b), intent(in)	icnvg,
		integer(i4b), intent(in)	isuppress_output )

inherited

(1) Calculate intercell flows (flowja)

Definition at line 79 of file gwf.f90.

◆ model_cq() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_cq	(	class(numericalmodeltype)	this,
		integer(i4b), intent(in)	icnvg,
		integer(i4b), intent(in)	isuppress_output )

inherited

Definition at line 49 of file NumericalModel.f90.

◆ model_da() [1/4]

procedure basemodelmodule::basemodeltype::model_da ( class(basemodeltype) this )

inherited

Definition at line 40 of file BaseModel.f90.

◆ model_da() [2/4]

procedure gwfinterfacemodelmodule::gwfinterfacemodeltype::model_da ( class(gwfinterfacemodeltype) this )

Parameters

this	the GWF interface model

Definition at line 35 of file GwfInterfaceModel.f90.

◆ model_da() [3/4]

procedure gwfmodule::gwfmodeltype::model_da ( class(gwfmodeltype) this )

inherited

Definition at line 84 of file gwf.f90.

◆ model_da() [4/4]

procedure numericalmodelmodule::numericalmodeltype::model_da ( class(numericalmodeltype) this )

inherited

Definition at line 34 of file NumericalModel.f90.

◆ model_df() [1/4]

procedure basemodelmodule::basemodeltype::model_df ( class(basemodeltype) this )

inherited

Definition at line 34 of file BaseModel.f90.

◆ model_df() [2/4]

procedure gwfinterfacemodelmodule::gwfinterfacemodeltype::model_df ( class(gwfinterfacemodeltype) this )

Parameters

this	the GWF interface model

Definition at line 33 of file GwfInterfaceModel.f90.

◆ model_df() [3/4]

procedure gwfmodule::gwfmodeltype::model_df ( class(gwfmodeltype) this )

inherited

(1) call df routines for each package (2) set gwf variables and pointers

Definition at line 67 of file gwf.f90.

◆ model_df() [4/4]

procedure numericalmodelmodule::numericalmodeltype::model_df ( class(numericalmodeltype) this )

inherited

Definition at line 31 of file NumericalModel.f90.

◆ model_dt() [1/2]

procedure basemodelmodule::basemodeltype::model_dt ( class(basemodeltype) this )

inherited

Definition at line 37 of file BaseModel.f90.

◆ model_dt() [2/2]

procedure gwfmodule::gwfmodeltype::model_dt ( class(gwfmodeltype) this )

inherited

Definition at line 82 of file gwf.f90.

◆ model_fc() [1/2]

procedure gwfmodule::gwfmodeltype::model_fc	(	class(gwfmodeltype)	this,
		integer(i4b), intent(in)	kiter,
		class(matrixbasetype), pointer	matrix_sln,
		integer(i4b), intent(in)	inwtflag )

inherited

Definition at line 74 of file gwf.f90.

◆ model_fc() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_fc	(	class(numericalmodeltype)	this,
		integer(i4b), intent(in)	kiter,
		class(matrixbasetype), pointer	matrix_sln,
		integer(i4b), intent(in)	inwtflag )

inherited

Definition at line 43 of file NumericalModel.f90.

◆ model_fp() [1/3]

procedure basemodelmodule::basemodeltype::model_fp ( class(basemodeltype) this )

inherited

Definition at line 39 of file BaseModel.f90.

◆ model_fp() [2/3]

procedure gwfmodule::gwfmodeltype::model_fp ( class(gwfmodeltype) this )

inherited

Definition at line 83 of file gwf.f90.

◆ model_fp() [3/3]

procedure numericalmodelmodule::numericalmodeltype::model_fp ( class(numericalmodeltype) this )

inherited

Definition at line 33 of file NumericalModel.f90.

◆ model_mc() [1/2]

procedure gwfmodule::gwfmodeltype::model_mc	(	class(gwfmodeltype)	this,
		class(matrixbasetype), pointer	matrix_sln )

inherited

Definition at line 69 of file gwf.f90.

◆ model_mc() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_mc	(	class(numericalmodeltype)	this,
		class(matrixbasetype), pointer	matrix_sln )

inherited

Definition at line 37 of file NumericalModel.f90.

◆ model_message()

procedure basemodelmodule::basemodeltype::model_message	(	class(basemodeltype)	this,
		character(len=*), intent(in)	line,
		character(len=*), intent(in), optional	fmt )

inherited

Definition at line 42 of file BaseModel.f90.

◆ model_nr()

procedure numericalmodelmodule::numericalmodeltype::model_nr	(	class(numericalmodeltype)	this,
		integer(i4b), intent(in)	kiter,
		class(matrixbasetype), pointer	matrix,
		integer(i4b), intent(in)	inwtflag )

inherited

Definition at line 46 of file NumericalModel.f90.

◆ model_nur() [1/2]

procedure gwfmodule::gwfmodeltype::model_nur	(	class(gwfmodeltype)	this,
		integer(i4b), intent(in)	neqmod,
		real(dp), dimension(neqmod), intent(inout)	x,
		real(dp), dimension(neqmod), intent(in)	xtemp,
		real(dp), dimension(neqmod), intent(inout)	dx,
		integer(i4b), intent(inout)	inewtonur,
		real(dp), intent(inout)	dxmax,
		integer(i4b), intent(inout)	locmax )

inherited

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

Definition at line 78 of file gwf.f90.

◆ model_nur() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_nur	(	class(numericalmodeltype)	this,
		integer(i4b), intent(in)	neqmod,
		real(dp), dimension(neqmod), intent(inout)	x,
		real(dp), dimension(neqmod), intent(in)	xtemp,
		real(dp), dimension(neqmod), intent(inout)	dx,
		integer(i4b), intent(inout)	inewtonur,
		real(dp), intent(inout)	dxmax,
		integer(i4b), intent(inout)	locmax )

inherited

Definition at line 48 of file NumericalModel.f90.

◆ model_ot() [1/3]

procedure basemodelmodule::basemodeltype::model_ot ( class(basemodeltype) this )

inherited

Definition at line 38 of file BaseModel.f90.

◆ model_ot() [2/3]

procedure gwfmodule::gwfmodeltype::model_ot ( class(gwfmodeltype) this )

inherited

Definition at line 81 of file gwf.f90.

◆ model_ot() [3/3]

procedure numericalmodelmodule::numericalmodeltype::model_ot ( class(numericalmodeltype) this )

inherited

Definition at line 53 of file NumericalModel.f90.

◆ model_ptc() [1/2]

procedure gwfmodule::gwfmodeltype::model_ptc	(	class(gwfmodeltype)	this,
		class(vectorbasetype), pointer	vec_residual,
		integer(i4b), intent(inout)	iptc,
		real(dp), intent(inout)	ptcf )

inherited

(1) Calculate maximum pseudo-transient continuation factor for the current outer iteration

Definition at line 77 of file gwf.f90.

◆ model_ptc() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_ptc	(	class(numericalmodeltype)	this,
		class(vectorbasetype), pointer	vec_residual,
		integer(i4b), intent(inout)	iptc,
		real(dp), intent(inout)	ptcf )

inherited

Definition at line 45 of file NumericalModel.f90.

◆ model_ptcchk() [1/2]

procedure gwfmodule::gwfmodeltype::model_ptcchk	(	class(gwfmodeltype)	this,
		integer(i4b), intent(inout)	iptc )

inherited

(1) Check if pseudo-transient continuation factor should be used

Definition at line 76 of file gwf.f90.

◆ model_ptcchk() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_ptcchk	(	class(numericalmodeltype)	this,
		integer(i4b), intent(inout)	iptc )

inherited

Definition at line 44 of file NumericalModel.f90.

◆ model_reset()

procedure numericalmodelmodule::numericalmodeltype::model_reset ( class(numericalmodeltype) this )

inherited

Definition at line 40 of file NumericalModel.f90.

◆ model_rp() [1/3]

procedure basemodelmodule::basemodeltype::model_rp ( class(basemodeltype) this )

inherited

Definition at line 36 of file BaseModel.f90.

◆ model_rp() [2/3]

procedure gwfmodule::gwfmodeltype::model_rp ( class(gwfmodeltype) this )

inherited

(1) calls package read and prepare routines

Definition at line 71 of file gwf.f90.

◆ model_rp() [3/3]

procedure numericalmodelmodule::numericalmodeltype::model_rp ( class(numericalmodeltype) this )

inherited

Definition at line 38 of file NumericalModel.f90.

◆ model_solve()

procedure numericalmodelmodule::numericalmodeltype::model_solve ( class(numericalmodeltype) this )

inherited

Definition at line 41 of file NumericalModel.f90.

◆ package_create()

procedure gwfmodule::gwfmodeltype::package_create	(	class(gwfmodeltype)	this,
		character(len=*), intent(in)	filtyp,
		integer(i4b), intent(in)	ipakid,
		integer(i4b), intent(in)	ipaknum,
		character(len=*), intent(in)	pakname,
		character(len=*), intent(in)	mempath,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout )

inherited

(1) create new-style package (2) add a pointer to the package

Definition at line 89 of file gwf.f90.

◆ set_iboundptr()

procedure numericalmodelmodule::numericalmodeltype::set_iboundptr	(	class(numericalmodeltype)	this,
		integer(i4b), dimension(:), intent(in), pointer, contiguous	iboundsln,
		integer(i4b)	sln_offset,
		character(len=*), intent(in)	varnametgt,
		character(len=*), intent(in)	mempathtgt )

inherited

Definition at line 62 of file NumericalModel.f90.

◆ set_idsoln()

procedure numericalmodelmodule::numericalmodeltype::set_idsoln	(	class(numericalmodeltype)	this,
		integer(i4b), intent(in)	id )

inherited

Definition at line 59 of file NumericalModel.f90.

◆ set_moffset()

procedure numericalmodelmodule::numericalmodeltype::set_moffset	(	class(numericalmodeltype)	this,
		integer(i4b), intent(in)	moffset )

inherited

Definition at line 58 of file NumericalModel.f90.

◆ set_rhsptr()

procedure numericalmodelmodule::numericalmodeltype::set_rhsptr	(	class(numericalmodeltype)	this,
		real(dp), dimension(:), intent(in), pointer, contiguous	rhssln,
		integer(i4b)	sln_offset,
		character(len=*), intent(in)	varnametgt,
		character(len=*), intent(in)	mempathtgt )

inherited

Definition at line 61 of file NumericalModel.f90.

◆ set_xptr()

procedure numericalmodelmodule::numericalmodeltype::set_xptr	(	class(numericalmodeltype)	this,
		real(dp), dimension(:), intent(in), pointer, contiguous	xsln,
		integer(i4b)	sln_offset,
		character(len=*), intent(in)	varnametgt,
		character(len=*), intent(in)	mempathtgt )

inherited

Definition at line 60 of file NumericalModel.f90.

◆ setbuydata()

procedure, pass(this), private gwfinterfacemodelmodule::gwfinterfacemodeltype::setbuydata	(	class(gwfinterfacemodeltype)	this,
		type(gwfbuyinputdatatype)	buydata )

private

Parameters

this	the interface model
buydata	the data for the buoyancy package

Definition at line 39 of file GwfInterfaceModel.f90.

◆ setnpfoptions()

procedure, pass(this), private gwfinterfacemodelmodule::gwfinterfacemodeltype::setnpfoptions	(	class(gwfinterfacemodeltype)	this,
		type(gwfnpfoptionstype)	npfoptions )

private

Parameters

this	the GWF interface model
npfoptions	the options data to be filled

Definition at line 38 of file GwfInterfaceModel.f90.

◆ steady_period_check()

procedure, private gwfmodule::gwfmodeltype::steady_period_check ( class(gwfmodeltype) this )

privateinherited

Write warning message if steady state period and adaptive time stepping is active for the period

Definition at line 98 of file gwf.f90.

Member Data Documentation

◆ bndlist

type(listtype), pointer basemodelmodule::basemodeltype::bndlist => null()

inherited

Definition at line 31 of file BaseModel.f90.

◆ budget

type(budgettype), pointer gwfmodule::gwfmodeltype::budget => null()

inherited

Definition at line 50 of file gwf.f90.

◆ buy

type(gwfbuytype), pointer gwfmodule::gwfmodeltype::buy => null()

inherited

Definition at line 41 of file gwf.f90.

◆ cond

real(dp), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::cond => null()

inherited

Definition at line 25 of file NumericalModel.f90.

◆ csub

type(gwfcsubtype), pointer gwfmodule::gwfmodeltype::csub => null()

inherited

Definition at line 44 of file gwf.f90.

◆ dis

class(disbasetype), pointer basemodelmodule::basemodeltype::dis => null()

inherited

Definition at line 32 of file BaseModel.f90.

◆ filename

character(len=linelength), pointer basemodelmodule::basemodeltype::filename => null()

inherited

Definition at line 19 of file BaseModel.f90.

◆ flowja

real(dp), dimension(:), pointer, contiguous basemodelmodule::basemodeltype::flowja => null()

inherited

Definition at line 30 of file BaseModel.f90.

◆ gnc

type(ghostnodetype), pointer gwfmodule::gwfmodeltype::gnc => null()

inherited

Definition at line 46 of file gwf.f90.

◆ gridconnection

class(gridconnectiontype), pointer gwfinterfacemodelmodule::gwfinterfacemodeltype::gridconnection => null()

Definition at line 28 of file GwfInterfaceModel.f90.

◆ hfb

type(gwfhfbtype), pointer gwfmodule::gwfmodeltype::hfb => null()

inherited

Definition at line 47 of file gwf.f90.

◆ ia

integer(i4b), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::ia => null()

inherited

Definition at line 21 of file NumericalModel.f90.

◆ ibound

integer(i4b), dimension(:), pointer, contiguous basemodelmodule::basemodeltype::ibound => null()

inherited

Definition at line 29 of file BaseModel.f90.

◆ ic

type(gwfictype), pointer gwfmodule::gwfmodeltype::ic => null()

inherited

Definition at line 38 of file gwf.f90.

◆ icnvg

integer(i4b), pointer numericalmodelmodule::numericalmodeltype::icnvg => null()

inherited

Definition at line 20 of file NumericalModel.f90.

◆ id

integer(i4b), pointer basemodelmodule::basemodeltype::id => null()

inherited

Definition at line 22 of file BaseModel.f90.

◆ idsoln

integer(i4b), pointer basemodelmodule::basemodeltype::idsoln => null()

inherited

Definition at line 21 of file BaseModel.f90.

◆ idxglo

integer(i4b), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::idxglo => null()

inherited

Definition at line 26 of file NumericalModel.f90.

◆ inbuy

integer(i4b), pointer gwfmodule::gwfmodeltype::inbuy => null()

inherited

Definition at line 54 of file gwf.f90.

◆ incsub

integer(i4b), pointer gwfmodule::gwfmodeltype::incsub => null()

inherited

Definition at line 57 of file gwf.f90.

◆ inewton

integer(i4b), pointer basemodelmodule::basemodeltype::inewton => null()

inherited

Definition at line 24 of file BaseModel.f90.

◆ inewtonur

integer(i4b), pointer gwfmodule::gwfmodeltype::inewtonur => null()

inherited

Definition at line 63 of file gwf.f90.

◆ ingnc

integer(i4b), pointer gwfmodule::gwfmodeltype::ingnc => null()

inherited

Definition at line 60 of file gwf.f90.

◆ inhfb

integer(i4b), pointer gwfmodule::gwfmodeltype::inhfb => null()

inherited

Definition at line 59 of file gwf.f90.

◆ inic

integer(i4b), pointer gwfmodule::gwfmodeltype::inic => null()

inherited

Definition at line 51 of file gwf.f90.

◆ inmvr

integer(i4b), pointer gwfmodule::gwfmodeltype::inmvr => null()

inherited

Definition at line 58 of file gwf.f90.

◆ innpf

integer(i4b), pointer gwfmodule::gwfmodeltype::innpf => null()

inherited

Definition at line 53 of file gwf.f90.

◆ inobs

integer(i4b), pointer gwfmodule::gwfmodeltype::inobs => null()

inherited

Definition at line 61 of file gwf.f90.

◆ inoc

integer(i4b), pointer gwfmodule::gwfmodeltype::inoc => null()

inherited

Definition at line 52 of file gwf.f90.

◆ insto

integer(i4b), pointer gwfmodule::gwfmodeltype::insto => null()

inherited

Definition at line 56 of file gwf.f90.

◆ invsc

integer(i4b), pointer gwfmodule::gwfmodeltype::invsc => null()

inherited

Definition at line 55 of file gwf.f90.

◆ iout

integer(i4b), pointer basemodelmodule::basemodeltype::iout => null()

inherited

Definition at line 23 of file BaseModel.f90.

◆ ipakcb

integer(i4b), pointer basemodelmodule::basemodeltype::ipakcb => null()

inherited

Definition at line 27 of file BaseModel.f90.

◆ iprflow

integer(i4b), pointer basemodelmodule::basemodeltype::iprflow => null()

inherited

Definition at line 26 of file BaseModel.f90.

◆ iprpak

integer(i4b), pointer basemodelmodule::basemodeltype::iprpak => null()

inherited

Definition at line 25 of file BaseModel.f90.

◆ iss

integer(i4b), pointer gwfmodule::gwfmodeltype::iss => null()

inherited

Definition at line 62 of file gwf.f90.

◆ ja

integer(i4b), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::ja => null()

inherited

Definition at line 22 of file NumericalModel.f90.

◆ macronym

character(len=3), pointer basemodelmodule::basemodeltype::macronym => null()

inherited

Definition at line 20 of file BaseModel.f90.

◆ memorypath

character(len=lenmempath) basemodelmodule::basemodeltype::memorypath

inherited

Definition at line 17 of file BaseModel.f90.

17 character(len=LENMEMPATH) :: memoryPath !< the location in the memory manager where the variables are stored

◆ moffset

integer(i4b), pointer numericalmodelmodule::numericalmodeltype::moffset => null()

inherited

Definition at line 19 of file NumericalModel.f90.

◆ mvr

type(gwfmvrtype), pointer gwfmodule::gwfmodeltype::mvr => null()

inherited

Definition at line 48 of file gwf.f90.

◆ name

character(len=lenmodelname), pointer basemodelmodule::basemodeltype::name => null()

inherited

Definition at line 18 of file BaseModel.f90.

◆ neq

integer(i4b), pointer numericalmodelmodule::numericalmodeltype::neq => null()

inherited

Definition at line 18 of file NumericalModel.f90.

◆ nja

integer(i4b), pointer basemodelmodule::basemodeltype::nja => null()

inherited

Definition at line 28 of file BaseModel.f90.

◆ npf

type(gwfnpftype), pointer gwfmodule::gwfmodeltype::npf => null()

inherited

Definition at line 39 of file gwf.f90.

◆ obs

type(gwfobstype), pointer gwfmodule::gwfmodeltype::obs => null()

inherited

Definition at line 49 of file gwf.f90.

◆ oc

type(gwfoctype), pointer gwfmodule::gwfmodeltype::oc => null()

inherited

Definition at line 45 of file gwf.f90.

◆ owner

class(gwfmodeltype), pointer, private gwfinterfacemodelmodule::gwfinterfacemodeltype::owner => null()

private

Definition at line 29 of file GwfInterfaceModel.f90.

◆ rhs

real(dp), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::rhs => null()

inherited

Definition at line 24 of file NumericalModel.f90.

◆ sto

type(gwfstotype), pointer gwfmodule::gwfmodeltype::sto => null()

inherited

Definition at line 43 of file gwf.f90.

◆ vsc

type(gwfvsctype), pointer gwfmodule::gwfmodeltype::vsc => null()

inherited

Definition at line 42 of file gwf.f90.

◆ x

real(dp), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::x => null()

inherited

Definition at line 23 of file NumericalModel.f90.

◆ xold

real(dp), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::xold => null()

inherited

Definition at line 27 of file NumericalModel.f90.

◆ xt3d

type(xt3dtype), pointer gwfmodule::gwfmodeltype::xt3d => null()

inherited

Definition at line 40 of file gwf.f90.

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

/home/runner/work/modflow6/modflow6/src/Model/Connection/GwfInterfaceModel.f90

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ allocate_arrays()

◆ allocate_scalars() [1/3]

◆ allocate_scalars() [2/3]

◆ allocate_scalars() [3/3]

◆ create_bndpkgs()

◆ create_lstfile()

◆ create_packages()

◆ ftype_check()

◆ get_iasym() [1/2]

◆ get_iasym() [2/2]

◆ get_idv_scale()

◆ get_mcellid()

◆ get_mnodeu()

◆ get_mrange()

◆ gwf_ot_bdsummary()

◆ gwf_ot_dv()

◆ gwf_ot_flow()

◆ gwf_ot_obs()

◆ gwfifm_cr()

◆ log_namfile_options()

◆ model_ac() [1/2]

◆ model_ac() [2/2]

◆ model_ad() [1/2]

◆ model_ad() [2/2]

◆ model_ar() [1/4]

◆ model_ar() [2/4]

◆ model_ar() [3/4]

◆ model_ar() [4/4]

◆ model_bd() [1/2]

◆ model_bd() [2/2]

◆ model_bdcalc()

◆ model_bdentry() [1/2]

◆ model_bdentry() [2/2]

◆ model_bdsave()

◆ model_cc() [1/2]

◆ model_cc() [2/2]

◆ model_cf() [1/2]

◆ model_cf() [2/2]

◆ model_cq() [1/2]

◆ model_cq() [2/2]

◆ model_da() [1/4]

◆ model_da() [2/4]

◆ model_da() [3/4]

◆ model_da() [4/4]

◆ model_df() [1/4]

◆ model_df() [2/4]

◆ model_df() [3/4]

◆ model_df() [4/4]

◆ model_dt() [1/2]

◆ model_dt() [2/2]

◆ model_fc() [1/2]

◆ model_fc() [2/2]

◆ model_fp() [1/3]

◆ model_fp() [2/3]

◆ model_fp() [3/3]

◆ model_mc() [1/2]

◆ model_mc() [2/2]

◆ model_message()

◆ model_nr()

◆ model_nur() [1/2]

◆ model_nur() [2/2]

◆ model_ot() [1/3]

◆ model_ot() [2/3]

◆ model_ot() [3/3]

◆ model_ptc() [1/2]

◆ model_ptc() [2/2]

◆ model_ptcchk() [1/2]

◆ model_ptcchk() [2/2]

◆ model_reset()

◆ model_rp() [1/3]

◆ model_rp() [2/3]

◆ model_rp() [3/3]

◆ model_solve()

◆ package_create()