Derived type for GwfExchangeType. More...

Inheritance diagram for gwfgwfexchangemodule::gwfexchangetype:

Collaboration diagram for gwfgwfexchangemodule::gwfexchangetype:

Public Member Functions
procedure	exg_df (this)
	@ brief Define GWF GWF exchange
procedure	exg_ac (this, sparse)
	@ brief Add connections
procedure	exg_mc (this, matrix_sln)
	@ brief Map connections
procedure	exg_ar (this)
	@ brief Allocate and read
procedure	exg_rp (this)
	@ brief Read and prepare
procedure	exg_ad (this)
	@ brief Advance
procedure	exg_cf (this, kiter)
	@ brief Calculate coefficients
procedure	exg_fc (this, kiter, matrix_sln, rhs_sln, inwtflag)
	@ brief Fill coefficients
procedure	exg_fn (this, kiter, matrix_sln)
	@ brief Fill Newton
procedure	exg_cq (this, icnvg, isuppress_output, isolnid)
	@ brief Calculate flow
procedure	exg_bd (this, icnvg, isuppress_output, isolnid)
	@ brief Budget
procedure	exg_ot (this)
	@ brief Output
procedure	exg_da (this)
	@ brief Deallocate
procedure	exg_fp (this)
	@ brief Final processing
procedure	get_iasym (this)
	@ brief Set symmetric flag
procedure	connects_model (this, model)
	Return true when this exchange provides matrix coefficients for solving `model`.
procedure	use_interface_model (this)
	Should interface model be used for this exchange.
procedure	allocate_scalars (this)
	@ brief Allocate scalars
procedure	allocate_arrays (this)
	@ brief Allocate arrays
procedure	source_options (this, iout)
	@ brief Source options
procedure	read_gnc (this)
	@ brief Read ghost nodes
procedure	read_mvr (this, iout)
	@ brief Read mover
procedure	gwf_gwf_bdsav (this)
	@ brief Budget save
procedure, public	gwf_gwf_save_simvals (this)
	@ brief Save simulated flow observations
procedure, public	gwf_gwf_set_flow_to_npf (this)
	Set flow rates to the edges in the models.
procedure	gwf_gwf_add_to_flowja (this)
	Add exchange flow to each model flowja diagonal position so that residual is calculated correctly.
procedure	allocate_scalars (this)
	Allocate scalars and initialize to defaults.
procedure	allocate_arrays (this)
	Allocate array data, using the number of connected nodes `nexg`.
procedure	disconnex_da (this)
	Clean up all scalars and arrays.
procedure	use_interface_model (this)
	Should interface model be used to handle these exchanges, to be overridden for inheriting types.
procedure, pass(this)	source_options (this, iout)
	Source options from input context.
procedure, pass(this)	source_dimensions (this, iout)
	Source dimension from input context.
procedure, pass(this)	source_data (this, iout)
	Source exchange data from input context.
procedure, pass(this)	noder (this, model, cellid, iout)
	Returns reduced node number from user.
procedure, pass(this)	cellstr (this, ndim, cellid, iout)
procedure	exg_df (this)
	Define the exchange.
procedure(exg_df), deferred	exg_df (this)
procedure	exg_ac (this, sparse)
	If an implicit exchange then add connections to sparse.
procedure	exg_mc (this, matrix_sln)
	Map the connections in the global matrix.
procedure	exg_ar (this)
	Allocate and read.
procedure(exg_ar), deferred	exg_ar (this)
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)
	Fill the matrix.
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	exg_da (this)
	Deallocate memory.
procedure	exg_da (this)
	Deallocate memory.
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(gwfmodeltype), pointer	gwfmodel1 => null()
	pointer to GWF Model 1
class(gwfmodeltype), pointer	gwfmodel2 => null()
	pointer to GWF Model 2
integer(i4b), pointer	inewton => null()
	newton flag (1 newton is on)
integer(i4b), pointer	icellavg => null()
	cell averaging
integer(i4b), pointer	ivarcv => null()
	variable cv
integer(i4b), pointer	idewatcv => null()
	dewatered cv
integer(i4b), pointer	ingnc => null()
	unit number for gnc (0 if off)
type(ghostnodetype), pointer	gnc => null()
	gnc object
integer(i4b), pointer	inmvr => null()
	unit number for mover (0 if off)
class(gwfexgmovertype), pointer	mvr => null()
	water mover object
integer(i4b), pointer	inobs => null()
	unit number for GWF-GWF observations
type(obstype), pointer	obs => null()
	observation object
real(dp), dimension(:), pointer, contiguous	cond => null()
	conductance
real(dp), dimension(:), pointer, contiguous	condsat => null()
	saturated conductance
integer(i4b), dimension(:), pointer, contiguous	idxglo => null()
	mapping to global (solution) amat
integer(i4b), dimension(:), pointer, contiguous	idxsymglo => null()
	mapping to global (solution) symmetric amat
real(dp), pointer	satomega => null()
	saturation smoothing
real(dp), dimension(:), pointer, contiguous	simvals => null()
	simulated flow rate for each exchange
type(tabletype), pointer	outputtab1 => null()
type(tabletype), pointer	outputtab2 => null()
character(len=linelength), pointer	filename => null()
	name of the input file
class(numericalmodeltype), pointer	model1 => null()
	model 1
class(numericalmodeltype), pointer	model2 => null()
	model 2
class(virtualmodeltype), pointer	v_model1 => null()
	virtual model 1
class(virtualmodeltype), pointer	v_model2 => null()
	virtual model 2
logical(lgp)	is_datacopy
	when true, this exchange is just a data copy on another process and not responsible for controlling movers, observations, ...
integer(i4b), pointer	nexg => null()
	number of exchanges
integer(i4b), dimension(:), pointer, contiguous	nodem1 => null()
	node numbers in model 1
integer(i4b), dimension(:), pointer, contiguous	nodem2 => null()
	node numbers in model 2
integer(i4b), dimension(:), pointer, contiguous	ihc => null()
	horizontal connection indicator array, size: nexg
real(dp), dimension(:), pointer, contiguous	cl1 => null()
	connection length 1, size: nexg
real(dp), dimension(:), pointer, contiguous	cl2 => null()
	connection length 2, size: nexg
real(dp), dimension(:), pointer, contiguous	hwva => null()
	horizontal widths, vertical flow areas, size: nexg
integer(i4b), pointer	naux => null()
	number of auxiliary variables
character(len=lenboundname), dimension(:), pointer, contiguous	boundname => null()
	boundnames
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
real(dp), dimension(:, :), pointer, contiguous	auxvar => null()
	array of auxiliary variable values
integer(i4b), pointer	ianglex => null()
	flag indicating anglex was read, if read, ianglex is index in auxvar
integer(i4b), pointer	icdist => null()
	flag indicating cdist was read, if read, icdist is index in auxvar
integer(i4b), pointer	iprpak => null()
	print input flag
integer(i4b), pointer	iprflow => null()
	print flag for cell by cell flows
integer(i4b), pointer	ipakcb => null()
	save flag for cell by cell flows
integer(i4b), pointer	inamedbound => null()
	flag to read boundnames
integer(i4b), pointer	ixt3d => null()
	flag indicating if XT3D should be applied on the interface: 0 = off, 1 = lhs, 2 = rhs
logical(lgp), pointer	dev_ifmod_on
	development option, forces interface model for this exchange
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	calc_cond_sat (this)
procedure, private	condcalc (this)
	@ brief Calculate the conductance
procedure, private	rewet (this, kiter)
	@ brief Rewet
procedure, private	qcalc (this, iexg, n1, n2)
	@ brief Calculate flow
procedure, private	gwf_gwf_chd_bd (this)
	@ brief gwf-gwf-chd-bd
procedure, private	gwf_gwf_bdsav_model (this, model)
procedure, private	gwf_gwf_df_obs (this)
	@ brief Define observations
procedure, private	gwf_gwf_rp_obs (this)
	@ brief Read and prepare observations
procedure, private	gwf_gwf_calc_simvals (this)
	Calculate flow rates for the exchanges and store them in a member array.
procedure, private	validate_exchange (this)
	validate exchange data after reading

Detailed Description

This derived type contains information and methods for connecting two GWF models.

Definition at line 47 of file exg-gwfgwf.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays() [1/2]

procedure disconnexchangemodule::disconnexchangetype::allocate_arrays ( class(disconnexchangetype) this )

inherited

Parameters

this	instance of exchange object

Definition at line 62 of file DisConnExchange.f90.

◆ allocate_arrays() [2/2]

procedure gwfgwfexchangemodule::gwfexchangetype::allocate_arrays ( class(gwfexchangetype) this )

Allocate arrays

Parameters

this	GwfExchangeType

Definition at line 95 of file exg-gwfgwf.f90.

◆ allocate_scalars() [1/2]

procedure disconnexchangemodule::disconnexchangetype::allocate_scalars ( class(disconnexchangetype) this )

inherited

Parameters

this	instance of exchange object

Definition at line 61 of file DisConnExchange.f90.

◆ allocate_scalars() [2/2]

procedure gwfgwfexchangemodule::gwfexchangetype::allocate_scalars ( class(gwfexchangetype) this )

Allocate scalar variables

Parameters

this	GwfExchangeType

Definition at line 94 of file exg-gwfgwf.f90.

◆ calc_cond_sat()

procedure, private gwfgwfexchangemodule::gwfexchangetype::calc_cond_sat ( class(gwfexchangetype) this )

private

Parameters

this	GwfExchangeType

Definition at line 99 of file exg-gwfgwf.f90.

◆ cellstr()

procedure, pass(this) disconnexchangemodule::disconnexchangetype::cellstr	(	class(disconnexchangetype)	this,
		integer(i4b)	ndim,
		integer(i4b), dimension(:), intent(in)	cellid,
		integer(i4b), intent(in)	iout )

inherited

Parameters

	this	instance of exchange object
	ndim	model DIS dimension
[in]	iout	the output file unit

Definition at line 71 of file DisConnExchange.f90.

◆ condcalc()

procedure, private gwfgwfexchangemodule::gwfexchangetype::condcalc ( class(gwfexchangetype) this )

private

Calculate the conductance based on state

Parameters

this	GwfExchangeType

Definition at line 100 of file exg-gwfgwf.f90.

◆ connects_model() [1/2]

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.

◆ connects_model() [2/2]

procedure gwfgwfexchangemodule::gwfexchangetype::connects_model	(	class(gwfexchangetype)	this,
		class(basemodeltype), intent(in), pointer	model )

Parameters

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

Returns: true, when connected

Definition at line 92 of file exg-gwfgwf.f90.

◆ disconnex_da()

procedure disconnexchangemodule::disconnexchangetype::disconnex_da ( class(disconnexchangetype) this )

inherited

Parameters

this	instance of exchange object

Definition at line 63 of file DisConnExchange.f90.

◆ exg_ac() [1/2]

procedure gwfgwfexchangemodule::gwfexchangetype::exg_ac	(	class(gwfexchangetype)	this,
		type(sparsematrix), intent(inout)	sparse )

Override parent exg_ac so that gnc can add connections here.

Parameters

this	GwfExchangeType

Definition at line 78 of file exg-gwfgwf.f90.

◆ exg_ac() [2/2]

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

inherited

Definition at line 20 of file NumericalExchange.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 gwfgwfexchangemodule::gwfexchangetype::exg_ad ( class(gwfexchangetype) this )

Advance mover and obs

Parameters

this	GwfExchangeType

Definition at line 82 of file exg-gwfgwf.f90.

◆ exg_ar() [1/3]

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

pure virtualinherited

Definition at line 24 of file BaseExchange.f90.

◆ exg_ar() [2/3]

procedure gwfgwfexchangemodule::gwfexchangetype::exg_ar ( class(gwfexchangetype) this )

Allocated and read and calculate saturated conductance

Parameters

this	GwfExchangeType

Definition at line 80 of file exg-gwfgwf.f90.

◆ exg_ar() [3/3]

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

inherited

Definition at line 22 of file NumericalExchange.f90.

◆ exg_bd() [1/2]

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

Accumulate budget terms

Parameters

this	GwfExchangeType

Definition at line 87 of file exg-gwfgwf.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/2]

procedure gwfgwfexchangemodule::gwfexchangetype::exg_cf	(	class(gwfexchangetype)	this,
		integer(i4b), intent(in)	kiter )

Rewet as necessary

Parameters

this	GwfExchangeType

Definition at line 83 of file exg-gwfgwf.f90.

◆ exg_cf() [2/2]

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

inherited

Definition at line 24 of file NumericalExchange.f90.

◆ exg_cq() [1/2]

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

Calculate flow between two cells and store in simvals, also set information needed for specific discharge calculation

Parameters

this	GwfExchangeType

Definition at line 86 of file exg-gwfgwf.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/3]

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

inherited

Definition at line 29 of file BaseExchange.f90.

◆ exg_da() [2/3]

procedure gwfgwfexchangemodule::gwfexchangetype::exg_da ( class(gwfexchangetype) this )

Deallocate memory associated with this object

Parameters

this	GwfExchangeType

Definition at line 89 of file exg-gwfgwf.f90.

◆ exg_da() [3/3]

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

inherited

Definition at line 30 of file NumericalExchange.f90.

◆ exg_df() [1/3]

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

pure virtualinherited

Definition at line 23 of file BaseExchange.f90.

◆ exg_df() [2/3]

procedure gwfgwfexchangemodule::gwfexchangetype::exg_df ( class(gwfexchangetype) this )

Define GWF to GWF exchange object.

Parameters

this	GwfExchangeType

Definition at line 77 of file exg-gwfgwf.f90.

◆ exg_df() [3/3]

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

inherited

Definition at line 19 of file NumericalExchange.f90.

◆ exg_dt()

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

inherited

Definition at line 26 of file BaseExchange.f90.

◆ exg_fc() [1/2]

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

Calculate conductance and fill coefficient matrix

Parameters

this	GwfExchangeType

Definition at line 84 of file exg-gwfgwf.f90.

◆ exg_fc() [2/2]

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

procedure gwfgwfexchangemodule::gwfexchangetype::exg_fn	(	class(gwfexchangetype)	this,
		integer(i4b), intent(in)	kiter,
		class(matrixbasetype), pointer	matrix_sln )

Fill amatsln with Newton terms

Parameters

this	GwfExchangeType

Definition at line 85 of file exg-gwfgwf.f90.

◆ exg_fp() [1/2]

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

inherited

Definition at line 28 of file BaseExchange.f90.

◆ exg_fp() [2/2]

procedure gwfgwfexchangemodule::gwfexchangetype::exg_fp ( class(gwfexchangetype) this )

Conduct any final processing

Parameters

this	GwfExchangeType

Definition at line 90 of file exg-gwfgwf.f90.

◆ exg_mc() [1/2]

procedure gwfgwfexchangemodule::gwfexchangetype::exg_mc	(	class(gwfexchangetype)	this,
		class(matrixbasetype), pointer	matrix_sln )

Map the connections in the global matrix

Parameters

this	GwfExchangeType
matrix_sln	the system matrix

Definition at line 79 of file exg-gwfgwf.f90.

◆ exg_mc() [2/2]

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

inherited

Definition at line 21 of file NumericalExchange.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 gwfgwfexchangemodule::gwfexchangetype::exg_ot ( class(gwfexchangetype) this )

Write output

Parameters

this	GwfExchangeType

Definition at line 88 of file exg-gwfgwf.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 gwfgwfexchangemodule::gwfexchangetype::exg_rp ( class(gwfexchangetype) this )

Read new data for mover and obs

Parameters

this	GwfExchangeType

Definition at line 81 of file exg-gwfgwf.f90.

◆ get_iasym() [1/2]

procedure gwfgwfexchangemodule::gwfexchangetype::get_iasym ( class(gwfexchangetype) this )

Return flag indicating whether or not this exchange will cause the coefficient matrix to be asymmetric.

Parameters

this	GwfExchangeType

Definition at line 91 of file exg-gwfgwf.f90.

◆ get_iasym() [2/2]

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

inherited

Definition at line 31 of file NumericalExchange.f90.

◆ gwf_gwf_add_to_flowja()

procedure gwfgwfexchangemodule::gwfexchangetype::gwf_gwf_add_to_flowja ( class(gwfexchangetype) this )

Parameters

this	GwfExchangeType

Definition at line 112 of file exg-gwfgwf.f90.

◆ gwf_gwf_bdsav()

procedure gwfgwfexchangemodule::gwfexchangetype::gwf_gwf_bdsav ( class(gwfexchangetype) this )

Output individual flows to listing file and binary budget files

Parameters

this	GwfExchangeType

Definition at line 104 of file exg-gwfgwf.f90.

◆ gwf_gwf_bdsav_model()

procedure, private gwfgwfexchangemodule::gwfexchangetype::gwf_gwf_bdsav_model	(	class(gwfexchangetype)	this,
		class(gwfmodeltype), pointer	model )

private

Parameters

this	this exchange
model	the model to save budget for

Definition at line 105 of file exg-gwfgwf.f90.

◆ gwf_gwf_calc_simvals()

procedure, private gwfgwfexchangemodule::gwfexchangetype::gwf_gwf_calc_simvals ( class(gwfexchangetype) this )

private

Parameters

this	GwfExchangeType

Definition at line 109 of file exg-gwfgwf.f90.

◆ gwf_gwf_chd_bd()

procedure, private gwfgwfexchangemodule::gwfexchangetype::gwf_gwf_chd_bd ( class(gwfexchangetype) this )

private

Account for flow from an external model into a chd cell

Parameters

this	GwfExchangeType

Definition at line 103 of file exg-gwfgwf.f90.

◆ gwf_gwf_df_obs()

procedure, private gwfgwfexchangemodule::gwfexchangetype::gwf_gwf_df_obs ( class(gwfexchangetype) this )

private

Define the observations associated with this object

Parameters

this	GwfExchangeType

Definition at line 106 of file exg-gwfgwf.f90.

◆ gwf_gwf_rp_obs()

procedure, private gwfgwfexchangemodule::gwfexchangetype::gwf_gwf_rp_obs ( class(gwfexchangetype) this )

private

Handle observation exchanges exchange-boundary names.

Parameters

this	GwfExchangeType

Definition at line 107 of file exg-gwfgwf.f90.

◆ gwf_gwf_save_simvals()

procedure, public gwfgwfexchangemodule::gwfexchangetype::gwf_gwf_save_simvals ( class(gwfexchangetype), intent(inout) this )

Save the simulated flows for each exchange

Definition at line 108 of file exg-gwfgwf.f90.

◆ gwf_gwf_set_flow_to_npf()

procedure, public gwfgwfexchangemodule::gwfexchangetype::gwf_gwf_set_flow_to_npf ( class(gwfexchangetype) this )

Parameters

this	GwfExchangeType

Definition at line 110 of file exg-gwfgwf.f90.

◆ noder()

procedure, pass(this) disconnexchangemodule::disconnexchangetype::noder	(	class(disconnexchangetype)	this,
		class(numericalmodeltype), intent(in), pointer	model,
		integer(i4b), dimension(:), intent(in)	cellid,
		integer(i4b), intent(in)	iout )

inherited

Parameters

	this	instance of exchange object
[in]	iout	the output file unit

Definition at line 70 of file DisConnExchange.f90.

◆ qcalc()

procedure, private gwfgwfexchangemodule::gwfexchangetype::qcalc	(	class(gwfexchangetype)	this,
		integer(i4b), intent(in)	iexg,
		integer(i4b), intent(in)	n1,
		integer(i4b), intent(in)	n2 )

private

Calculate the flow for the specified exchange and node numbers

Parameters

this	GwfExchangeType

Definition at line 102 of file exg-gwfgwf.f90.

◆ read_gnc()

procedure gwfgwfexchangemodule::gwfexchangetype::read_gnc ( class(gwfexchangetype) this )

Read and process ghost nodes

Parameters

this	GwfExchangeType

Definition at line 97 of file exg-gwfgwf.f90.

◆ read_mvr()

procedure gwfgwfexchangemodule::gwfexchangetype::read_mvr	(	class(gwfexchangetype)	this,
		integer(i4b), intent(in)	iout )

Read and process movers

Parameters

this	GwfExchangeType

Definition at line 98 of file exg-gwfgwf.f90.

◆ rewet()

procedure, private gwfgwfexchangemodule::gwfexchangetype::rewet	(	class(gwfexchangetype)	this,
		integer(i4b), intent(in)	kiter )

private

Check if rewetting should propagate from one model to another

Parameters

this	GwfExchangeType

Definition at line 101 of file exg-gwfgwf.f90.

◆ source_data()

procedure, pass(this) disconnexchangemodule::disconnexchangetype::source_data	(	class(disconnexchangetype)	this,
		integer(i4b), intent(in)	iout )

inherited

Parameters

	this	instance of exchange object
[in]	iout	the output file unit

Definition at line 69 of file DisConnExchange.f90.

◆ source_dimensions()

procedure, pass(this) disconnexchangemodule::disconnexchangetype::source_dimensions	(	class(disconnexchangetype)	this,
		integer(i4b), intent(in)	iout )

inherited

Parameters

	this	instance of exchange object
[in]	iout	for logging

Definition at line 68 of file DisConnExchange.f90.

◆ source_options() [1/2]

procedure, pass(this) disconnexchangemodule::disconnexchangetype::source_options	(	class(disconnexchangetype)	this,
		integer(i4b), intent(in)	iout )

inherited

Parameters

	this	instance of exchange object
[in]	iout	for logging

Definition at line 67 of file DisConnExchange.f90.

◆ source_options() [2/2]

procedure gwfgwfexchangemodule::gwfexchangetype::source_options	(	class(gwfexchangetype)	this,
		integer(i4b), intent(in)	iout )

Source the options block

Parameters

this	GwfExchangeType

Definition at line 96 of file exg-gwfgwf.f90.

◆ use_interface_model() [1/2]

procedure disconnexchangemodule::disconnexchangetype::use_interface_model ( class(disconnexchangetype) this )

inherited

Parameters

this	instance of exchange object

Returns: flag whether interface model should be used for this exchange instead

Definition at line 64 of file DisConnExchange.f90.

◆ use_interface_model() [2/2]

procedure gwfgwfexchangemodule::gwfexchangetype::use_interface_model ( class(gwfexchangetype) this )

Parameters

this	GwfExchangeType

Returns: true when interface model should be used

Definition at line 93 of file exg-gwfgwf.f90.

◆ validate_exchange()

procedure, private gwfgwfexchangemodule::gwfexchangetype::validate_exchange ( class(gwfexchangetype) this )

private

Parameters

this	GwfExchangeType

Definition at line 111 of file exg-gwfgwf.f90.

Member Data Documentation

◆ auxname

character(len=lenauxname), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::auxname => null()

inherited

Definition at line 44 of file DisConnExchange.f90.

◆ auxname_cst

type(characterstringtype), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::auxname_cst => null()

inherited

Definition at line 46 of file DisConnExchange.f90.

◆ auxvar

real(dp), dimension(:, :), pointer, contiguous disconnexchangemodule::disconnexchangetype::auxvar => null()

inherited

Definition at line 48 of file DisConnExchange.f90.

◆ boundname

character(len=lenboundname), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::boundname => null()

inherited

Definition at line 41 of file DisConnExchange.f90.

◆ cl1

real(dp), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::cl1 => null()

inherited

Definition at line 37 of file DisConnExchange.f90.

◆ cl2

real(dp), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::cl2 => null()

inherited

Definition at line 38 of file DisConnExchange.f90.

◆ cond

real(dp), dimension(:), pointer, contiguous gwfgwfexchangemodule::gwfexchangetype::cond => null()

Definition at line 64 of file exg-gwfgwf.f90.

◆ condsat

real(dp), dimension(:), pointer, contiguous gwfgwfexchangemodule::gwfexchangetype::condsat => null()

Definition at line 65 of file exg-gwfgwf.f90.

◆ dev_ifmod_on

logical(lgp), pointer disconnexchangemodule::disconnexchangetype::dev_ifmod_on

inherited

Definition at line 57 of file DisConnExchange.f90.

57 logical(LGP), pointer :: dev_ifmod_on !< development option, forces interface model for this exchange

◆ filename

character(len=linelength), pointer disconnexchangemodule::disconnexchangetype::filename => null()

inherited

Definition at line 24 of file DisConnExchange.f90.

◆ gnc

type(ghostnodetype), pointer gwfgwfexchangemodule::gwfexchangetype::gnc => null()

Definition at line 57 of file exg-gwfgwf.f90.

◆ gwfmodel1

class(gwfmodeltype), pointer gwfgwfexchangemodule::gwfexchangetype::gwfmodel1 => null()

Definition at line 48 of file exg-gwfgwf.f90.

◆ gwfmodel2

class(gwfmodeltype), pointer gwfgwfexchangemodule::gwfexchangetype::gwfmodel2 => null()

Definition at line 49 of file exg-gwfgwf.f90.

◆ hwva

real(dp), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::hwva => null()

inherited

Definition at line 39 of file DisConnExchange.f90.

◆ ianglex

integer(i4b), pointer disconnexchangemodule::disconnexchangetype::ianglex => null()

inherited

Definition at line 49 of file DisConnExchange.f90.

◆ icdist

integer(i4b), pointer disconnexchangemodule::disconnexchangetype::icdist => null()

inherited

Definition at line 50 of file DisConnExchange.f90.

◆ icellavg

integer(i4b), pointer gwfgwfexchangemodule::gwfexchangetype::icellavg => null()

Definition at line 53 of file exg-gwfgwf.f90.

◆ id

integer(i4b) baseexchangemodule::baseexchangetype::id

inherited

Definition at line 19 of file BaseExchange.f90.

19 integer(I4B) :: id

◆ idewatcv

integer(i4b), pointer gwfgwfexchangemodule::gwfexchangetype::idewatcv => null()

Definition at line 55 of file exg-gwfgwf.f90.

◆ idxglo

integer(i4b), dimension(:), pointer, contiguous gwfgwfexchangemodule::gwfexchangetype::idxglo => null()

Definition at line 66 of file exg-gwfgwf.f90.

◆ idxsymglo

integer(i4b), dimension(:), pointer, contiguous gwfgwfexchangemodule::gwfexchangetype::idxsymglo => null()

Definition at line 67 of file exg-gwfgwf.f90.

◆ ihc

integer(i4b), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::ihc => null()

inherited

Definition at line 36 of file DisConnExchange.f90.

◆ inamedbound

integer(i4b), pointer disconnexchangemodule::disconnexchangetype::inamedbound => null()

inherited

Definition at line 54 of file DisConnExchange.f90.

◆ inewton

integer(i4b), pointer gwfgwfexchangemodule::gwfexchangetype::inewton => null()

Definition at line 52 of file exg-gwfgwf.f90.

◆ ingnc

integer(i4b), pointer gwfgwfexchangemodule::gwfexchangetype::ingnc => null()

Definition at line 56 of file exg-gwfgwf.f90.

◆ inmvr

integer(i4b), pointer gwfgwfexchangemodule::gwfexchangetype::inmvr => null()

Definition at line 58 of file exg-gwfgwf.f90.

◆ inobs

integer(i4b), pointer gwfgwfexchangemodule::gwfexchangetype::inobs => null()

Definition at line 60 of file exg-gwfgwf.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

◆ ipakcb

integer(i4b), pointer disconnexchangemodule::disconnexchangetype::ipakcb => null()

inherited

Definition at line 53 of file DisConnExchange.f90.

◆ iprflow

integer(i4b), pointer disconnexchangemodule::disconnexchangetype::iprflow => null()

inherited

Definition at line 52 of file DisConnExchange.f90.

◆ iprpak

integer(i4b), pointer disconnexchangemodule::disconnexchangetype::iprpak => null()

inherited

Definition at line 51 of file DisConnExchange.f90.

◆ is_datacopy

logical(lgp) disconnexchangemodule::disconnexchangetype::is_datacopy

inherited

Definition at line 30 of file DisConnExchange.f90.

30 logical(LGP) :: is_datacopy !< when true, this exchange is just a data copy on another process and

◆ ivarcv

integer(i4b), pointer gwfgwfexchangemodule::gwfexchangetype::ivarcv => null()

Definition at line 54 of file exg-gwfgwf.f90.

◆ ixt3d

integer(i4b), pointer disconnexchangemodule::disconnexchangetype::ixt3d => null()

inherited

Definition at line 56 of file DisConnExchange.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

◆ model1

class(numericalmodeltype), pointer disconnexchangemodule::disconnexchangetype::model1 => null()

inherited

Definition at line 26 of file DisConnExchange.f90.

◆ model2

class(numericalmodeltype), pointer disconnexchangemodule::disconnexchangetype::model2 => null()

inherited

Definition at line 27 of file DisConnExchange.f90.

◆ mvr

class(gwfexgmovertype), pointer gwfgwfexchangemodule::gwfexchangetype::mvr => null()

Definition at line 59 of file exg-gwfgwf.f90.

◆ 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

◆ naux

integer(i4b), pointer disconnexchangemodule::disconnexchangetype::naux => null()

inherited

Definition at line 40 of file DisConnExchange.f90.

◆ nexg

integer(i4b), pointer disconnexchangemodule::disconnexchangetype::nexg => null()

inherited

Definition at line 33 of file DisConnExchange.f90.

◆ nodem1

integer(i4b), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::nodem1 => null()

inherited

Definition at line 34 of file DisConnExchange.f90.

◆ nodem2

integer(i4b), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::nodem2 => null()

inherited

Definition at line 35 of file DisConnExchange.f90.

◆ obs

type(obstype), pointer gwfgwfexchangemodule::gwfexchangetype::obs => null()

Definition at line 61 of file exg-gwfgwf.f90.

◆ outputtab1

type(tabletype), pointer gwfgwfexchangemodule::gwfexchangetype::outputtab1 => null()

Definition at line 72 of file exg-gwfgwf.f90.

◆ outputtab2

type(tabletype), pointer gwfgwfexchangemodule::gwfexchangetype::outputtab2 => null()

Definition at line 73 of file exg-gwfgwf.f90.

◆ satomega

real(dp), pointer gwfgwfexchangemodule::gwfexchangetype::satomega => null()

Definition at line 68 of file exg-gwfgwf.f90.

◆ simvals

real(dp), dimension(:), pointer, contiguous gwfgwfexchangemodule::gwfexchangetype::simvals => null()

Definition at line 69 of file exg-gwfgwf.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')

◆ v_model1

class(virtualmodeltype), pointer disconnexchangemodule::disconnexchangetype::v_model1 => null()

inherited

Definition at line 28 of file DisConnExchange.f90.

◆ v_model2

class(virtualmodeltype), pointer disconnexchangemodule::disconnexchangetype::v_model2 => null()

inherited

Definition at line 29 of file DisConnExchange.f90.

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

/home/runner/work/modflow6/modflow6/src/Exchange/exg-gwfgwf.f90

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Member Function/Subroutine Documentation

◆ allocate_arrays() [1/2]

◆ allocate_arrays() [2/2]

◆ allocate_scalars() [1/2]

◆ allocate_scalars() [2/2]

◆ calc_cond_sat()

◆ cellstr()

◆ condcalc()

◆ connects_model() [1/2]

◆ connects_model() [2/2]

◆ disconnex_da()

◆ exg_ac() [1/2]

◆ exg_ac() [2/2]

◆ exg_ad() [1/2]

◆ exg_ad() [2/2]

◆ exg_ar() [1/3]

◆ exg_ar() [2/3]

◆ exg_ar() [3/3]

◆ exg_bd() [1/2]

◆ exg_bd() [2/2]

◆ exg_cc()

◆ exg_cf() [1/2]

◆ exg_cf() [2/2]

◆ exg_cq() [1/2]

◆ exg_cq() [2/2]

◆ exg_da() [1/3]

◆ exg_da() [2/3]

◆ exg_da() [3/3]

◆ exg_df() [1/3]

◆ exg_df() [2/3]

◆ exg_df() [3/3]

◆ exg_dt()

◆ exg_fc() [1/2]

◆ exg_fc() [2/2]

◆ exg_fn()

◆ exg_fp() [1/2]

◆ exg_fp() [2/2]

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

◆ get_iasym() [2/2]

◆ gwf_gwf_add_to_flowja()

◆ gwf_gwf_bdsav()

◆ gwf_gwf_bdsav_model()

◆ gwf_gwf_calc_simvals()

◆ gwf_gwf_chd_bd()

◆ gwf_gwf_df_obs()

◆ gwf_gwf_rp_obs()

◆ gwf_gwf_save_simvals()

◆ gwf_gwf_set_flow_to_npf()

◆ noder()

◆ qcalc()

◆ read_gnc()

◆ read_mvr()

◆ rewet()

◆ source_data()

◆ source_dimensions()

◆ source_options() [1/2]

◆ source_options() [2/2]

◆ use_interface_model() [1/2]

◆ use_interface_model() [2/2]

◆ validate_exchange()

Member Data Documentation

◆ auxname

◆ auxname_cst

◆ auxvar

◆ boundname

◆ cl1

◆ cl2

◆ cond

◆ condsat