Connects a GWE model to other GWE models in space. Derives from NumericalExchangeType so the solution can use it to fetch the coefficients for this connection. More...

Inheritance diagram for gwegweconnectionmodule::gwegweconnectiontype:

Collaboration diagram for gwegweconnectionmodule::gwegweconnectiontype:

Public Member Functions
procedure, pass(this)	gwegweconnection_ctor (this, model, gweex)
	Basic construction of the connection.
generic, public	construct (this, model, gweex)
	Basic construction of the connection.
procedure	exg_ar (this)
	allocate and read/set the connection's data structures
procedure	exg_df (this)
	define the GWE-GWE connection
procedure	exg_rp (this)
procedure	exg_ad (this)
	Advance this connection.
procedure	exg_cf (this, kiter)
procedure	exg_fc (this, kiter, matrix_sln, rhs_sln, inwtflag)
procedure	exg_da (this)
	Deallocate all resources.
procedure	exg_cq (this, icnvg, isuppress_output, isolnid)
procedure	exg_bd (this, icnvg, isuppress_output, isolnid)
procedure	exg_ot (this)
procedure	validateconnection (this)
	validate this connection prior to constructing
procedure, pass(this)	spatialconnection_ctor (this, model, exchange, name)
	Construct the spatial connection base.
generic	construct (this, model, exchange, name)
	Construct the spatial connection base.
procedure	exg_df (this)
	Define this connection, this is where the discretization (DISU) for the interface model is.
procedure	exg_df (this)
	Define the exchange.
procedure(exg_df), deferred	exg_df (this)
procedure	exg_ar (this)
	Allocate the connection,.
procedure	exg_ar (this)
	Allocate and read.
procedure(exg_ar), deferred	exg_ar (this)
procedure	exg_ac (this, sparse)
	Add connections, handled by the interface model, to the sparse matrix of the global system.
procedure	exg_ac (this, sparse)
	If an implicit exchange then add connections to sparse.
procedure	exg_mc (this, matrix_sln)
	Creates the mapping from the local system.
procedure	exg_mc (this, matrix_sln)
	Map the connections in the global matrix.
procedure	exg_cf (this, kiter)
	Calculate (or adjust) matrix coefficients, in this case those which are determined or affected.
procedure	exg_cf (this, kiter)
	Calculate conductance, and for explicit exchanges, set the conductance in the boundary package.
procedure	exg_fc (this, kiter, matrix_sln, rhs_sln, inwtflag)
	Formulate coefficients from interface model.
procedure	exg_fc (this, kiter, matrix_sln, rhs_sln, inwtflag)
	Fill the matrix.
procedure	exg_da (this)
	Deallocation.
procedure	exg_da (this)
	Deallocate memory.
procedure	exg_da (this)
	Deallocate memory.
procedure, pass(this)	spatialcon_df (this)
	Define this connection, this is where the discretization (DISU) for the interface model is.
procedure, pass(this)	spatialcon_ar (this)
	Allocate the connection,.
procedure, pass(this)	spatialcon_ac (this, sparse)
	Add connections, handled by the interface model, to the sparse matrix of the global system.
procedure, pass(this)	spatialcon_cf (this, kiter)
	Calculate (or adjust) matrix coefficients, in this case those which are determined or affected.
procedure, pass(this)	spatialcon_fc (this, kiter, matrix_sln, rhs_sln, inwtflag)
	Formulate coefficients from interface model.
procedure, pass(this)	spatialcon_da (this)
	Deallocation.
procedure, pass(this)	spatialcon_setmodelptrs (this)
	set model pointers to connection
procedure, pass(this)	spatialcon_connect (this)
	map interface model connections to our sparse matrix,
procedure, pass(this)	validateconnection (this)
	Validate this connection.
procedure, pass(this)	cfg_dv (this, var_name, subcomp_name, map_type, sync_stages, exg_var_name)
	Add a variable from the interface model to be synchronized at the configured stages by copying from the source memory in the models/exchanges that are part.
procedure, pass(this)	createmodelhalo (this)
	Find all models that might participate in this interface.
procedure	exg_cc (this, icnvg)
	Additional convergence check.
procedure	exg_cq (this, icnvg, isuppress_output, isolnid)
	Calculate flow.
procedure	exg_bd (this, icnvg, isuppress_output, isolnid)
	Exchange budget.
procedure	exg_ot (this)
	Output.
procedure	exg_ot (this)
	Run output routines.
procedure	get_iasym (this)
procedure	exg_rp (this)
	Read and prepare.
procedure	exg_dt (this)
	Calculate time step length.
procedure	exg_fp (this)
	Final processing.
procedure	exg_ad (this)
	Advance.
procedure	connects_model (this, model)
	Should return true when the exchange should be added to the solution where the model resides.

Public Attributes
class(gwemodeltype), pointer	gwemodel => null()
	the model for which this connection exists
class(gweexchangetype), pointer	gweexchange => null()
	the primary exchange, cast to GWE-GWE
class(gweinterfacemodeltype), pointer	gweinterfacemodel => null()
	the interface model
integer(i4b), pointer	iifaceadvscheme => null()
	the advection scheme at the interface: 0 = upstream, 1 = central, 2 = TVD
integer(i4b), pointer	iifacext3d => null()
	XT3D in the interface CND package: 0 = no, 1 = lhs, 2 = rhs.
integer(i4b), pointer	exgflowsign => null()
	indicates the flow direction of exgflowja
real(dp), dimension(:), pointer, contiguous	exgflowjagwe => null()
	gwe-flowja at the interface (this is a subset of the GWT interface model flowja's)
real(dp), dimension(:), pointer, contiguous	gwfflowja => null()
	gwfflowja for the interface model
real(dp), dimension(:), pointer, contiguous	gwfsat => null()
	gwfsat for the interface model
real(dp), dimension(:), pointer, contiguous	gwfhead => null()
	gwfhead for the interface model
real(dp), dimension(:, :), pointer, contiguous	gwfspdis => null()
	gwfspdis for the interface model
real(dp), dimension(:), pointer, contiguous	conc => null()
	pointer to concentration array
integer(i4b), dimension(:), pointer, contiguous	icbound => null()
	store pointer to gwe ibound array
integer(i4b)	iout = 0
	the list file for the interface model
class(numericalmodeltype), pointer	owner => null()
	the model whose connection this is
class(numericalmodeltype), pointer	interface_model => null()
	the interface model
integer(i4b), pointer	nr_connections => null()
	total nr. of connected cells (primary)
class(disconnexchangetype), pointer	prim_exchange => null()
	the exchange for which the interface model is created
logical(lgp)	owns_exchange
	there are two connections (in serial) for an exchange, one of them needs to manage/own the exchange (e.g. clean up)
type(stlvecint), pointer	halo_models
	models that are potentially in the halo of this interface
type(stlvecint), pointer	halo_exchanges
	exchanges that are potentially part of the halo of this interface (includes primary)
integer(i4b), pointer	int_stencil_depth => null()
	size of the computational stencil for the interior default = 1, xt3d = 2, ...
integer(i4b), pointer	exg_stencil_depth => null()
	size of the computational stencil at the interface default = 1, xt3d = 2, ...
integer(i4b), pointer	neq => null()
	nr. of equations in matrix system
class(sparsematrixtype), pointer	matrix => null()
	system matrix for the interface
real(dp), dimension(:), pointer, contiguous	rhs => null()
	rhs of interface system
real(dp), dimension(:), pointer, contiguous	x => null()
	dependent variable of interface system
integer(i4b), dimension(:), pointer, contiguous	active => null()
	cell status (c.f. ibound) of interface system
class(gridconnectiontype), pointer	ig_builder => null()
	facility to build the interface grid connection structure
integer(i4b), dimension(:), pointer	ipos_to_sln => null()
	mapping between position in the interface matrix and the solution matrix
type(listtype)	iface_dist_vars
	list with distributed variables for this interface
type(interfacemaptype), pointer	interface_map => null()
	a map of the interface into models and exchanges
character(len=7)	typename
	name of the type (e.g., 'GWF-GWF')
character(len=lenexchangename)	name
	the name of this exchange
character(len=lenmempath)	memorypath
	the location in the memory manager where the variables are stored
character(len=lenmempath)	input_mempath
integer(i4b)	id

Private Member Functions
procedure, private	allocate_scalars (this)
	Allocate scalar variables for this connection.
procedure, private	allocate_arrays (this)
	Allocate array variables for this connection.
procedure, private	cfg_dist_vars (this)
	Configure distributed variables for this interface model.
procedure, private	setgridextent (this)
	Set required extent of the interface grid from.
procedure, private	validategweexchange (this)
	Validate the exchange, intercepting those cases where two models have to be connected with an interface model, where the individual configurations don't allow this.
procedure, private	setflowtoexchange (this)
	Set the flows (flowja from interface model) to the.
procedure, pass(this), private	setupgridconnection (this)
	Creates the connection structure for the interface grid, starting from primary exchanges, then extending inward and outward, possibly across model boundaries.
procedure, pass(this), private	getnrofconnections (this)
	Returns total nr. of primary connections.
procedure, pass(this), private	allocatescalars (this)
	Allocation of scalars.
procedure, pass(this), private	allocatearrays (this)
	Allocation of arrays.
procedure, pass(this), private	createcoefficientmatrix (this, sparse)
	Create connection's matrix (ia,ja,amat) from sparse.
procedure, pass(this), private	maskownerconnections (this)
	Mask the owner's connections.
procedure, pass(this), private	addmodelneighbors (this, model_id, virtual_exchanges, depth, is_root, mask)
	Add neighbors and nbrs-of-nbrs to the model tree.

Detailed Description

Definition at line 30 of file GweGweConnection.f90.

Member Function/Subroutine Documentation

◆ addmodelneighbors()

procedure, pass(this), private spatialmodelconnectionmodule::spatialmodelconnectiontype::addmodelneighbors	(	class(spatialmodelconnectiontype)	this,
		integer(i4b)	model_id,
		type(listtype)	virtual_exchanges,
		integer(i4b), value	depth,
		logical(lgp)	is_root,
		integer(i4b), optional	mask )

privateinherited

Parameters

this	this connection
model_id	the model (id) to add neighbors for
virtual_exchanges	list with all virtual exchanges
depth	the maximal number of exchanges between
is_root	true when called for neighbor from primary exchange
mask	don't add this one as a neighbor

Definition at line 102 of file SpatialModelConnection.f90.

◆ allocate_arrays()

procedure, private gwegweconnectionmodule::gwegweconnectiontype::allocate_arrays ( class(gwegweconnectiontype) this )

private

Parameters

this	the connection

Definition at line 73 of file GweGweConnection.f90.

◆ allocate_scalars()

procedure, private gwegweconnectionmodule::gwegweconnectiontype::allocate_scalars ( class(gwegweconnectiontype) this )

private

Parameters

this	the connection

Definition at line 72 of file GweGweConnection.f90.

◆ allocatearrays()

procedure, pass(this), private spatialmodelconnectionmodule::spatialmodelconnectiontype::allocatearrays ( class(spatialmodelconnectiontype) this )

privateinherited

Parameters

this	this connection

Definition at line 99 of file SpatialModelConnection.f90.

◆ allocatescalars()

procedure, pass(this), private spatialmodelconnectionmodule::spatialmodelconnectiontype::allocatescalars ( class(spatialmodelconnectiontype) this )

privateinherited

Parameters

this	this connection

Definition at line 98 of file SpatialModelConnection.f90.

◆ cfg_dist_vars()

procedure, private gwegweconnectionmodule::gwegweconnectiontype::cfg_dist_vars ( class(gwegweconnectiontype) this )

private

Parameters

this	the connection

Definition at line 74 of file GweGweConnection.f90.

◆ cfg_dv()

procedure, pass(this) spatialmodelconnectionmodule::spatialmodelconnectiontype::cfg_dv	(	class(spatialmodelconnectiontype)	this,
		character(len=*)	var_name,
		character(len=*)	subcomp_name,
		integer(i4b)	map_type,
		integer(i4b), dimension(:)	sync_stages,
		character(len=*), optional	exg_var_name )

inherited

Parameters

this	this connection
var_name	name of variable, e.g. "K11"
subcomp_name	subcomponent, e.g. "NPF"
map_type	type of variable map
sync_stages	stages to sync
exg_var_name	needed for exchange variables, e.g. SIMVALS

Definition at line 92 of file SpatialModelConnection.f90.

◆ connects_model()

procedure baseexchangemodule::baseexchangetype::connects_model	(	class(baseexchangetype)	this,
		class(basemodeltype), intent(in), pointer	model )

inherited

Parameters

	this	the instance of the exchange
[in]	model	the model to which the exchange might hold a connection

Returns: true, when connected

Definition at line 31 of file BaseExchange.f90.

◆ construct() [1/2]

generic, public gwegweconnectionmodule::gwegweconnectiontype::construct	(	class(gwegweconnectiontype)	this,
		class(numericalmodeltype), pointer	model,
		class(disconnexchangetype), pointer	gweex )

Parameters

this	the connection
model	the model owning this connection, this must be a GweModelType
gweex	the GWE-GWE exchange the interface model is created for

Definition at line 55 of file GweGweConnection.f90.

Here is the call graph for this function:

◆ construct() [2/2]

generic spatialmodelconnectionmodule::spatialmodelconnectiontype::construct	(	class(spatialmodelconnectiontype)	this,
		class(numericalmodeltype), intent(in), pointer	model,
		class(disconnexchangetype), intent(in), pointer	exchange,
		character(len=*), intent(in)	name )

inherited

This constructor is typically called from a derived class.

Parameters

	this	the connection
[in]	model	the model that owns the connection
[in]	exchange	the primary exchange from which the connection is created
[in]	name	the connection name (for memory management mostly)

Definition at line 71 of file SpatialModelConnection.f90.

Here is the call graph for this function:

◆ createcoefficientmatrix()

procedure, pass(this), private spatialmodelconnectionmodule::spatialmodelconnectiontype::createcoefficientmatrix	(	class(spatialmodelconnectiontype)	this,
		type(sparsematrix), intent(inout)	sparse )

privateinherited

Parameters

	this	this connection
[in,out]	sparse	the sparse matrix with the cell connections

Definition at line 100 of file SpatialModelConnection.f90.

◆ createmodelhalo()

procedure, pass(this) spatialmodelconnectionmodule::spatialmodelconnectiontype::createmodelhalo ( class(spatialmodelconnectiontype) this )

inherited

Parameters

this	this connection

Definition at line 93 of file SpatialModelConnection.f90.

◆ exg_ac() [1/2]

procedure numericalexchangemodule::numericalexchangetype::exg_ac	(	class(numericalexchangetype)	this,
		type(sparsematrix), intent(inout)	sparse )

inherited

Definition at line 20 of file NumericalExchange.f90.

◆ exg_ac() [2/2]

procedure spatialmodelconnectionmodule::spatialmodelconnectiontype::exg_ac	(	class(spatialmodelconnectiontype)	this,
		type(sparsematrix), intent(inout)	sparse )

inherited

Parameters

	this	this connection
[in,out]	sparse	sparse matrix to store the connections

Definition at line 76 of file SpatialModelConnection.f90.

◆ exg_ad() [1/2]

procedure baseexchangemodule::baseexchangetype::exg_ad ( class(baseexchangetype) this )

inherited

Definition at line 30 of file BaseExchange.f90.

◆ exg_ad() [2/2]

procedure gwegweconnectionmodule::gwegweconnectiontype::exg_ad ( class(gwegweconnectiontype) this )

Parameters

this	this connection

Definition at line 60 of file GweGweConnection.f90.

◆ exg_ar() [1/4]

procedure(exg_ar), deferred baseexchangemodule::baseexchangetype::exg_ar ( class(baseexchangetype) this )

pure virtualinherited

Definition at line 24 of file BaseExchange.f90.

◆ exg_ar() [2/4]

procedure gwegweconnectionmodule::gwegweconnectiontype::exg_ar ( class(gwegweconnectiontype) this )

Parameters

this	the connection

Definition at line 57 of file GweGweConnection.f90.

◆ exg_ar() [3/4]

procedure numericalexchangemodule::numericalexchangetype::exg_ar ( class(numericalexchangetype) this )

inherited

Definition at line 22 of file NumericalExchange.f90.

◆ exg_ar() [4/4]

procedure spatialmodelconnectionmodule::spatialmodelconnectiontype::exg_ar ( class(spatialmodelconnectiontype) this )

inherited

Parameters

this	this connection

Definition at line 75 of file SpatialModelConnection.f90.

◆ exg_bd() [1/2]

procedure gwegweconnectionmodule::gwegweconnectiontype::exg_bd	(	class(gwegweconnectiontype)	this,
		integer(i4b), intent(inout)	icnvg,
		integer(i4b), intent(in)	isuppress_output,
		integer(i4b), intent(in)	isolnid )

Parameters

	this	the connection
[in,out]	icnvg	convergence flag
[in]	isuppress_output	suppress output when =1
[in]	isolnid	solution id

Definition at line 65 of file GweGweConnection.f90.

◆ exg_bd() [2/2]

procedure numericalexchangemodule::numericalexchangetype::exg_bd	(	class(numericalexchangetype)	this,
		integer(i4b), intent(inout)	icnvg,
		integer(i4b), intent(in)	isuppress_output,
		integer(i4b), intent(in)	isolnid )

inherited

Definition at line 28 of file NumericalExchange.f90.

◆ exg_cc()

procedure numericalexchangemodule::numericalexchangetype::exg_cc	(	class(numericalexchangetype)	this,
		integer(i4b), intent(inout)	icnvg )

inherited

Definition at line 26 of file NumericalExchange.f90.

◆ exg_cf() [1/3]

procedure gwegweconnectionmodule::gwegweconnectiontype::exg_cf	(	class(gwegweconnectiontype)	this,
		integer(i4b), intent(in)	kiter )

Parameters

	this	this connection
[in]	kiter	the iteration counter

Definition at line 61 of file GweGweConnection.f90.

◆ exg_cf() [2/3]

procedure numericalexchangemodule::numericalexchangetype::exg_cf	(	class(numericalexchangetype)	this,
		integer(i4b), intent(in)	kiter )

inherited

Definition at line 24 of file NumericalExchange.f90.

◆ exg_cf() [3/3]

procedure spatialmodelconnectionmodule::spatialmodelconnectiontype::exg_cf	(	class(spatialmodelconnectiontype)	this,
		integer(i4b), intent(in)	kiter )

inherited

Parameters

	this	this connection
[in]	kiter	the iteration counter

Definition at line 78 of file SpatialModelConnection.f90.

◆ exg_cq() [1/2]

procedure gwegweconnectionmodule::gwegweconnectiontype::exg_cq	(	class(gwegweconnectiontype)	this,
		integer(i4b), intent(inout)	icnvg,
		integer(i4b), intent(in)	isuppress_output,
		integer(i4b), intent(in)	isolnid )

Parameters

	this	the connection
[in,out]	icnvg	convergence flag
[in]	isuppress_output	suppress output when =1
[in]	isolnid	solution id

Definition at line 64 of file GweGweConnection.f90.

◆ exg_cq() [2/2]

procedure numericalexchangemodule::numericalexchangetype::exg_cq	(	class(numericalexchangetype)	this,
		integer(i4b), intent(inout)	icnvg,
		integer(i4b), intent(in)	isuppress_output,
		integer(i4b), intent(in)	isolnid )

inherited

Definition at line 27 of file NumericalExchange.f90.

◆ exg_da() [1/4]

procedure baseexchangemodule::baseexchangetype::exg_da ( class(baseexchangetype) this )

inherited

Definition at line 29 of file BaseExchange.f90.

◆ exg_da() [2/4]

procedure gwegweconnectionmodule::gwegweconnectiontype::exg_da ( class(gwegweconnectiontype) this )

Parameters

this	the connection

Definition at line 63 of file GweGweConnection.f90.

◆ exg_da() [3/4]

procedure numericalexchangemodule::numericalexchangetype::exg_da ( class(numericalexchangetype) this )

inherited

Definition at line 30 of file NumericalExchange.f90.

◆ exg_da() [4/4]

procedure spatialmodelconnectionmodule::spatialmodelconnectiontype::exg_da ( class(spatialmodelconnectiontype) this )

inherited

Parameters

this	this connection

Definition at line 80 of file SpatialModelConnection.f90.

◆ exg_df() [1/4]

procedure(exg_df), deferred baseexchangemodule::baseexchangetype::exg_df ( class(baseexchangetype) this )

pure virtualinherited

Definition at line 23 of file BaseExchange.f90.

◆ exg_df() [2/4]

procedure gwegweconnectionmodule::gwegweconnectiontype::exg_df ( class(gwegweconnectiontype) this )

Parameters

this	the connection

Definition at line 58 of file GweGweConnection.f90.

◆ exg_df() [3/4]

procedure numericalexchangemodule::numericalexchangetype::exg_df ( class(numericalexchangetype) this )

inherited

Definition at line 19 of file NumericalExchange.f90.

◆ exg_df() [4/4]

procedure spatialmodelconnectionmodule::spatialmodelconnectiontype::exg_df ( class(spatialmodelconnectiontype) this )

inherited

Parameters

this	this connection

Definition at line 74 of file SpatialModelConnection.f90.

◆ exg_dt()

procedure baseexchangemodule::baseexchangetype::exg_dt ( class(baseexchangetype) this )

inherited

Definition at line 26 of file BaseExchange.f90.

◆ exg_fc() [1/3]

procedure gwegweconnectionmodule::gwegweconnectiontype::exg_fc	(	class(gwegweconnectiontype)	this,
		integer(i4b), intent(in)	kiter,
		class(matrixbasetype), pointer	matrix_sln,
		real(dp), dimension(:), intent(inout)	rhs_sln,
		integer(i4b), intent(in), optional	inwtflag )

Parameters

	this	the connection
[in]	kiter	the iteration counter
	matrix_sln	the system matrix
[in,out]	rhs_sln	global right-hand-side
[in]	inwtflag	newton-raphson flag

Definition at line 62 of file GweGweConnection.f90.

◆ exg_fc() [2/3]

procedure numericalexchangemodule::numericalexchangetype::exg_fc	(	class(numericalexchangetype)	this,
		integer(i4b), intent(in)	kiter,
		class(matrixbasetype), pointer	matrix_sln,
		real(dp), dimension(:), intent(inout)	rhs_sln,
		integer(i4b), intent(in), optional	inwtflag )

inherited

Definition at line 25 of file NumericalExchange.f90.

◆ exg_fc() [3/3]

procedure spatialmodelconnectionmodule::spatialmodelconnectiontype::exg_fc	(	class(spatialmodelconnectiontype)	this,
		integer(i4b), intent(in)	kiter,
		class(matrixbasetype), pointer	matrix_sln,
		real(dp), dimension(:), intent(inout)	rhs_sln,
		integer(i4b), intent(in), optional	inwtflag )

inherited

Parameters

	this	this connection
[in]	kiter	the iteration counter
	matrix_sln	the system matrix
[in,out]	rhs_sln	global right-hand-side
[in]	inwtflag	newton-raphson flag

Definition at line 79 of file SpatialModelConnection.f90.

◆ exg_fp()

procedure baseexchangemodule::baseexchangetype::exg_fp ( class(baseexchangetype) this )

inherited

Definition at line 28 of file BaseExchange.f90.

◆ exg_mc() [1/2]

procedure numericalexchangemodule::numericalexchangetype::exg_mc	(	class(numericalexchangetype)	this,
		class(matrixbasetype), pointer	matrix_sln )

inherited

Definition at line 21 of file NumericalExchange.f90.

◆ exg_mc() [2/2]

procedure spatialmodelconnectionmodule::spatialmodelconnectiontype::exg_mc	(	class(spatialmodelconnectiontype)	this,
		class(matrixbasetype), pointer	matrix_sln )

inherited

Parameters

this	this connection
matrix_sln	global matrix

Definition at line 77 of file SpatialModelConnection.f90.

◆ exg_ot() [1/3]

procedure baseexchangemodule::baseexchangetype::exg_ot ( class(baseexchangetype) this )

inherited

Definition at line 27 of file BaseExchange.f90.

◆ exg_ot() [2/3]

procedure gwegweconnectionmodule::gwegweconnectiontype::exg_ot ( class(gwegweconnectiontype) this )

Parameters

this	the connection

Definition at line 66 of file GweGweConnection.f90.

◆ exg_ot() [3/3]

procedure numericalexchangemodule::numericalexchangetype::exg_ot ( class(numericalexchangetype) this )

inherited

Definition at line 29 of file NumericalExchange.f90.

◆ exg_rp() [1/2]

procedure baseexchangemodule::baseexchangetype::exg_rp ( class(baseexchangetype) this )

inherited

Definition at line 25 of file BaseExchange.f90.

◆ exg_rp() [2/2]

procedure gwegweconnectionmodule::gwegweconnectiontype::exg_rp ( class(gwegweconnectiontype) this )

Parameters

this	the connection

Definition at line 59 of file GweGweConnection.f90.

◆ get_iasym()

procedure numericalexchangemodule::numericalexchangetype::get_iasym ( class(numericalexchangetype) this )

inherited

Definition at line 31 of file NumericalExchange.f90.

◆ getnrofconnections()

procedure, pass(this), private spatialmodelconnectionmodule::spatialmodelconnectiontype::getnrofconnections ( class(spatialmodelconnectiontype) this )

privateinherited

Parameters

this	this connection

Definition at line 97 of file SpatialModelConnection.f90.

◆ gwegweconnection_ctor()

procedure, pass(this) gwegweconnectionmodule::gwegweconnectiontype::gwegweconnection_ctor	(	class(gwegweconnectiontype)	this,
		class(numericalmodeltype), pointer	model,
		class(disconnexchangetype), pointer	gweex )

Parameters

this	the connection
model	the model owning this connection, this must be a GweModelType
gweex	the GWE-GWE exchange the interface model is created for

Definition at line 54 of file GweGweConnection.f90.

◆ maskownerconnections()

procedure, pass(this), private spatialmodelconnectionmodule::spatialmodelconnectiontype::maskownerconnections ( class(spatialmodelconnectiontype) this )

privateinherited

Determine which connections are handled by the interface model (using the connections object in its discretization) and

Parameters

this	the connection

Definition at line 101 of file SpatialModelConnection.f90.

◆ setflowtoexchange()

procedure, private gwegweconnectionmodule::gwegweconnectiontype::setflowtoexchange ( class(gwegweconnectiontype) this )

private

Parameters

this	this connection

Definition at line 77 of file GweGweConnection.f90.

◆ setgridextent()

procedure, private gwegweconnectionmodule::gwegweconnectiontype::setgridextent ( class(gwegweconnectiontype) this )

private

Parameters

this	the connection

Definition at line 75 of file GweGweConnection.f90.

◆ setupgridconnection()

procedure, pass(this), private spatialmodelconnectionmodule::spatialmodelconnectiontype::setupgridconnection ( class(spatialmodelconnectiontype) this )

privateinherited

Parameters

this	this connection

Definition at line 96 of file SpatialModelConnection.f90.

◆ spatialcon_ac()

procedure, pass(this) spatialmodelconnectionmodule::spatialmodelconnectiontype::spatialcon_ac	(	class(spatialmodelconnectiontype)	this,
		type(sparsematrix), intent(inout)	sparse )

inherited

Parameters

	this	this connection
[in,out]	sparse	sparse matrix to store the connections

Definition at line 85 of file SpatialModelConnection.f90.

◆ spatialcon_ar()

procedure, pass(this) spatialmodelconnectionmodule::spatialmodelconnectiontype::spatialcon_ar ( class(spatialmodelconnectiontype) this )

inherited

Parameters

this	this connection

Definition at line 84 of file SpatialModelConnection.f90.

◆ spatialcon_cf()

procedure, pass(this) spatialmodelconnectionmodule::spatialmodelconnectiontype::spatialcon_cf	(	class(spatialmodelconnectiontype)	this,
		integer(i4b), intent(in)	kiter )

inherited

Parameters

	this	this connection
[in]	kiter	the iteration counter

Definition at line 86 of file SpatialModelConnection.f90.

◆ spatialcon_connect()

procedure, pass(this) spatialmodelconnectionmodule::spatialmodelconnectiontype::spatialcon_connect ( class(spatialmodelconnectiontype) this )

inherited

Parameters

this	this connection

Definition at line 90 of file SpatialModelConnection.f90.

◆ spatialcon_da()

procedure, pass(this) spatialmodelconnectionmodule::spatialmodelconnectiontype::spatialcon_da ( class(spatialmodelconnectiontype) this )

inherited

Parameters

this	this connection

Definition at line 88 of file SpatialModelConnection.f90.

◆ spatialcon_df()

procedure, pass(this) spatialmodelconnectionmodule::spatialmodelconnectiontype::spatialcon_df ( class(spatialmodelconnectiontype) this )

inherited

Parameters

this	this connection

Definition at line 83 of file SpatialModelConnection.f90.

◆ spatialcon_fc()

procedure, pass(this) spatialmodelconnectionmodule::spatialmodelconnectiontype::spatialcon_fc	(	class(spatialmodelconnectiontype)	this,
		integer(i4b), intent(in)	kiter,
		class(matrixbasetype), pointer	matrix_sln,
		real(dp), dimension(:), intent(inout)	rhs_sln,
		integer(i4b), intent(in), optional	inwtflag )

inherited

Parameters

	this	this connection
[in]	kiter	the iteration counter
	matrix_sln	the system matrix
[in,out]	rhs_sln	global right-hand-side
[in]	inwtflag	newton-raphson flag

Definition at line 87 of file SpatialModelConnection.f90.

◆ spatialcon_setmodelptrs()

procedure, pass(this) spatialmodelconnectionmodule::spatialmodelconnectiontype::spatialcon_setmodelptrs ( class(spatialmodelconnectiontype) this )

inherited

Parameters

this	this connection

Definition at line 89 of file SpatialModelConnection.f90.

◆ spatialconnection_ctor()

procedure, pass(this) spatialmodelconnectionmodule::spatialmodelconnectiontype::spatialconnection_ctor	(	class(spatialmodelconnectiontype)	this,
		class(numericalmodeltype), intent(in), pointer	model,
		class(disconnexchangetype), intent(in), pointer	exchange,
		character(len=*), intent(in)	name )

inherited

This constructor is typically called from a derived class.

Parameters

	this	the connection
[in]	model	the model that owns the connection
[in]	exchange	the primary exchange from which the connection is created
[in]	name	the connection name (for memory management mostly)

Definition at line 70 of file SpatialModelConnection.f90.

◆ validateconnection() [1/2]

procedure gwegweconnectionmodule::gwegweconnectiontype::validateconnection ( class(gwegweconnectiontype) this )

Parameters

this	this connection

Definition at line 69 of file GweGweConnection.f90.

◆ validateconnection() [2/2]

procedure, pass(this) spatialmodelconnectionmodule::spatialmodelconnectiontype::validateconnection ( class(spatialmodelconnectiontype) this )

inherited

Parameters

this	this connection

Definition at line 91 of file SpatialModelConnection.f90.

◆ validategweexchange()

procedure, private gwegweconnectionmodule::gwegweconnectiontype::validategweexchange ( class(gwegweconnectiontype) this )

private

Stops with error message on config mismatch

Parameters

this	this connection

Definition at line 76 of file GweGweConnection.f90.

Member Data Documentation

◆ active

integer(i4b), dimension(:), pointer, contiguous spatialmodelconnectionmodule::spatialmodelconnectiontype::active => null()

inherited

Definition at line 59 of file SpatialModelConnection.f90.

◆ conc

real(dp), dimension(:), pointer, contiguous gwegweconnectionmodule::gwegweconnectiontype::conc => null()

Definition at line 47 of file GweGweConnection.f90.

◆ exg_stencil_depth

integer(i4b), pointer spatialmodelconnectionmodule::spatialmodelconnectiontype::exg_stencil_depth => null()

inherited

Definition at line 51 of file SpatialModelConnection.f90.

◆ exgflowjagwe

real(dp), dimension(:), pointer, contiguous gwegweconnectionmodule::gwegweconnectiontype::exgflowjagwe => null()

Definition at line 39 of file GweGweConnection.f90.

◆ exgflowsign

integer(i4b), pointer gwegweconnectionmodule::gwegweconnectiontype::exgflowsign => null()

Definition at line 38 of file GweGweConnection.f90.

◆ gweexchange

class(gweexchangetype), pointer gwegweconnectionmodule::gwegweconnectiontype::gweexchange => null()

Definition at line 33 of file GweGweConnection.f90.

◆ gweinterfacemodel

class(gweinterfacemodeltype), pointer gwegweconnectionmodule::gwegweconnectiontype::gweinterfacemodel => null()

Definition at line 34 of file GweGweConnection.f90.

◆ gwemodel

class(gwemodeltype), pointer gwegweconnectionmodule::gwegweconnectiontype::gwemodel => null()

Definition at line 32 of file GweGweConnection.f90.

◆ gwfflowja

real(dp), dimension(:), pointer, contiguous gwegweconnectionmodule::gwegweconnectiontype::gwfflowja => null()

Definition at line 42 of file GweGweConnection.f90.

◆ gwfhead

real(dp), dimension(:), pointer, contiguous gwegweconnectionmodule::gwegweconnectiontype::gwfhead => null()

Definition at line 44 of file GweGweConnection.f90.

◆ gwfsat

real(dp), dimension(:), pointer, contiguous gwegweconnectionmodule::gwegweconnectiontype::gwfsat => null()

Definition at line 43 of file GweGweConnection.f90.

◆ gwfspdis

real(dp), dimension(:, :), pointer, contiguous gwegweconnectionmodule::gwegweconnectiontype::gwfspdis => null()

Definition at line 45 of file GweGweConnection.f90.

◆ halo_exchanges

type(stlvecint), pointer spatialmodelconnectionmodule::spatialmodelconnectiontype::halo_exchanges

inherited

Definition at line 48 of file SpatialModelConnection.f90.

48 type(STLVecInt), pointer :: halo_exchanges !< exchanges that are potentially part of the halo of this interface (includes primary)

◆ halo_models

type(stlvecint), pointer spatialmodelconnectionmodule::spatialmodelconnectiontype::halo_models

inherited

Definition at line 47 of file SpatialModelConnection.f90.

47 type(STLVecInt), pointer :: halo_models !< models that are potentially in the halo of this interface

◆ icbound

integer(i4b), dimension(:), pointer, contiguous gwegweconnectionmodule::gwegweconnectiontype::icbound => null()

Definition at line 48 of file GweGweConnection.f90.

◆ id

integer(i4b) baseexchangemodule::baseexchangetype::id

inherited

Definition at line 19 of file BaseExchange.f90.

19 integer(I4B) :: id

◆ iface_dist_vars

type(listtype) spatialmodelconnectionmodule::spatialmodelconnectiontype::iface_dist_vars

inherited

Definition at line 64 of file SpatialModelConnection.f90.

64 type(ListType) :: iface_dist_vars !< list with distributed variables for this interface

◆ ig_builder

class(gridconnectiontype), pointer spatialmodelconnectionmodule::spatialmodelconnectiontype::ig_builder => null()

inherited

Definition at line 62 of file SpatialModelConnection.f90.

◆ iifaceadvscheme

integer(i4b), pointer gwegweconnectionmodule::gwegweconnectiontype::iifaceadvscheme => null()

Definition at line 35 of file GweGweConnection.f90.

◆ iifacext3d

integer(i4b), pointer gwegweconnectionmodule::gwegweconnectiontype::iifacext3d => null()

Definition at line 37 of file GweGweConnection.f90.

◆ input_mempath

character(len=lenmempath) baseexchangemodule::baseexchangetype::input_mempath

inherited

Definition at line 18 of file BaseExchange.f90.

18 character(len=LENMEMPATH) :: input_mempath

◆ int_stencil_depth

integer(i4b), pointer spatialmodelconnectionmodule::spatialmodelconnectiontype::int_stencil_depth => null()

inherited

Definition at line 49 of file SpatialModelConnection.f90.

◆ interface_map

type(interfacemaptype), pointer spatialmodelconnectionmodule::spatialmodelconnectiontype::interface_map => null()

inherited

Definition at line 65 of file SpatialModelConnection.f90.

◆ interface_model

class(numericalmodeltype), pointer spatialmodelconnectionmodule::spatialmodelconnectiontype::interface_model => null()

inherited

Definition at line 41 of file SpatialModelConnection.f90.

◆ iout

integer(i4b) gwegweconnectionmodule::gwegweconnectiontype::iout = 0

Definition at line 50 of file GweGweConnection.f90.

◆ ipos_to_sln

integer(i4b), dimension(:), pointer spatialmodelconnectionmodule::spatialmodelconnectiontype::ipos_to_sln => null()

inherited

Definition at line 63 of file SpatialModelConnection.f90.

◆ matrix

class(sparsematrixtype), pointer spatialmodelconnectionmodule::spatialmodelconnectiontype::matrix => null()

inherited

Definition at line 56 of file SpatialModelConnection.f90.

◆ memorypath

character(len=lenmempath) baseexchangemodule::baseexchangetype::memorypath

inherited

Definition at line 17 of file BaseExchange.f90.

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

◆ name

character(len=lenexchangename) baseexchangemodule::baseexchangetype::name

inherited

Definition at line 16 of file BaseExchange.f90.

16 character(len=LENEXCHANGENAME) :: name !< the name of this exchange

◆ neq

integer(i4b), pointer spatialmodelconnectionmodule::spatialmodelconnectiontype::neq => null()

inherited

Definition at line 55 of file SpatialModelConnection.f90.

◆ nr_connections

integer(i4b), pointer spatialmodelconnectionmodule::spatialmodelconnectiontype::nr_connections => null()

inherited

Definition at line 42 of file SpatialModelConnection.f90.

◆ owner

class(numericalmodeltype), pointer spatialmodelconnectionmodule::spatialmodelconnectiontype::owner => null()

inherited

Definition at line 40 of file SpatialModelConnection.f90.

◆ owns_exchange

logical(lgp) spatialmodelconnectionmodule::spatialmodelconnectiontype::owns_exchange

inherited

Definition at line 45 of file SpatialModelConnection.f90.

45 logical(LGP) :: owns_exchange !< there are two connections (in serial) for an exchange,

◆ prim_exchange

class(disconnexchangetype), pointer spatialmodelconnectionmodule::spatialmodelconnectiontype::prim_exchange => null()

inherited

Definition at line 44 of file SpatialModelConnection.f90.

◆ rhs

real(dp), dimension(:), pointer, contiguous spatialmodelconnectionmodule::spatialmodelconnectiontype::rhs => null()

inherited

Definition at line 57 of file SpatialModelConnection.f90.

◆ typename

character(len=7) baseexchangemodule::baseexchangetype::typename

inherited

Definition at line 15 of file BaseExchange.f90.

15 character(len=7) :: typename !< name of the type (e.g., 'GWF-GWF')

◆ x

real(dp), dimension(:), pointer, contiguous spatialmodelconnectionmodule::spatialmodelconnectiontype::x => null()

inherited

Definition at line 58 of file SpatialModelConnection.f90.

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

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

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Member Function/Subroutine Documentation

◆ addmodelneighbors()

◆ allocate_arrays()

◆ allocate_scalars()

◆ allocatearrays()

◆ allocatescalars()

◆ cfg_dist_vars()

◆ cfg_dv()

◆ connects_model()

◆ construct() [1/2]

◆ construct() [2/2]

◆ createcoefficientmatrix()

◆ createmodelhalo()

◆ exg_ac() [1/2]

◆ exg_ac() [2/2]

◆ exg_ad() [1/2]

◆ exg_ad() [2/2]

◆ exg_ar() [1/4]

◆ exg_ar() [2/4]

◆ exg_ar() [3/4]

◆ exg_ar() [4/4]

◆ exg_bd() [1/2]

◆ exg_bd() [2/2]

◆ exg_cc()

◆ exg_cf() [1/3]

◆ exg_cf() [2/3]

◆ exg_cf() [3/3]

◆ exg_cq() [1/2]

◆ exg_cq() [2/2]

◆ exg_da() [1/4]

◆ exg_da() [2/4]

◆ exg_da() [3/4]

◆ exg_da() [4/4]

◆ exg_df() [1/4]

◆ exg_df() [2/4]

◆ exg_df() [3/4]

◆ exg_df() [4/4]

◆ exg_dt()

◆ exg_fc() [1/3]

◆ exg_fc() [2/3]

◆ exg_fc() [3/3]

◆ exg_fp()

◆ exg_mc() [1/2]

◆ exg_mc() [2/2]

◆ exg_ot() [1/3]

◆ exg_ot() [2/3]

◆ exg_ot() [3/3]

◆ exg_rp() [1/2]

◆ exg_rp() [2/2]

◆ get_iasym()

◆ getnrofconnections()

◆ gwegweconnection_ctor()

◆ maskownerconnections()

◆ setflowtoexchange()

◆ setgridextent()

◆ setupgridconnection()

◆ spatialcon_ac()

◆ spatialcon_ar()

◆ spatialcon_cf()

◆ spatialcon_connect()

◆ spatialcon_da()

◆ spatialcon_df()

◆ spatialcon_fc()

◆ spatialcon_setmodelptrs()

◆ spatialconnection_ctor()

◆ validateconnection() [1/2]

◆ validateconnection() [2/2]

◆ validategweexchange()

Member Data Documentation

◆ active

◆ conc

◆ exg_stencil_depth

◆ exgflowjagwe

◆ exgflowsign

◆ gweexchange

◆ gweinterfacemodel