MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
swfgwfexchangemodule::swfgwfexchangetype Type Referenceabstract
Inheritance diagram for swfgwfexchangemodule::swfgwfexchangetype:
Inheritance graph
Collaboration diagram for swfgwfexchangemodule::swfgwfexchangetype:
Collaboration graph

Public Member Functions

procedure exg_ac (this, sparse)
 Add connections.
procedure exg_mc (this, matrix_sln)
 Map connections.
procedure exg_fc (this, kiter, matrix_sln, rhs_sln, inwtflag)
 Fill coefficients.
procedure exg_cq (this, icnvg, isuppress_output, isolnid)
 Calculate flow.
procedure exg_bd (this, icnvg, isuppress_output, isolnid)
 Budget.
procedure exg_ot (this)
 Output.
procedure exg_da (this)
 Deallocate.
procedure initialize (this, filename, name, swf_ftype, id, m1_id, m2_id, input_mempath)
 Initialize SWF GWF exchange.
procedure allocate_scalars (this)
 Allocate scalars.
procedure allocate_arrays (this)
 Allocate array data, using the number of connected nodes nexg.
procedure swf_gwf_calc_simvals (this)
 Calculate flow rates for the exchanges and store them in a member array.
procedure swf_gwf_save_simvals (this)
 Save simulated flow observations.
procedure qcalc (this, iexg, hswf, hgwf)
 Calculate flow.
procedure get_cond (this, iexg, hswf, hgwf)
 Calculate conductance.
procedure get_wetted_perimeter (this, nodeswf, depth)
 Get wetted perimeter for swf channel model.
procedure swf_gwf_add_to_flowja (this)
 Add exchange flow to each model flowja diagonal position so that residual is calculated correctly.
procedure swf_gwf_bdsav (this)
 Budget save.
procedure connects_model (this, model)
 Should return true when the exchange should be added to the solution where the model resides.
procedure, pass(this) noder (this, model, cellid, iout)
procedure, pass(this) cellstr (this, model, 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(numericalmodeltype), pointer model1 => null()
 model 1
class(numericalmodeltype), pointer model2 => null()
 model 2
class(swfmodeltype), pointer swfmodel => null()
 pointer to SWF Model
class(gwfmodeltype), pointer gwfmodel => null()
 pointer to GWF Model
character(len=lenftype), pointer swf_ftype => null()
 type of swf model (CHF or OLF)
character(len=linelength), pointer filename => null()
 name of the input file
integer(i4b), pointer ipr_input => null()
 flag to print input
integer(i4b), pointer ipr_flow => null()
 print flag for cell by cell flows
integer(i4b), pointer ifixedcond => null()
 conductance is fixed as product of bedleak and cfact
integer(i4b), pointer nexg => null()
 number of exchanges
integer(i4b), dimension(:), pointer, contiguous nodeswf => null()
 node numbers in swf model
integer(i4b), dimension(:), pointer, contiguous nodegwf => null()
 node numbers in gwf model
real(dp), dimension(:), pointer, contiguous bedleak => null()
 bed leakance, size: nexg
real(dp), dimension(:), pointer, contiguous cfact => null()
 factor used in conductance calculation, size: nexg
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), dimension(:), pointer, contiguous simvals => null()
 simulated flow rate for each exchange
integer(i4b), pointer inobs => null()
 unit number for GWF-GWF observations
type(obstype), pointer obs => null()
 observation object
type(tabletype), pointer outputtab1 => null()
type(tabletype), pointer outputtab2 => null()
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 swf_gwf_chd_bd (this)
 swf-gwf-chd-bd

Detailed Description

Definition at line 33 of file exg-swfgwf.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure swfgwfexchangemodule::swfgwfexchangetype::allocate_arrays ( class(swfgwfexchangetype) this)
Parameters
thisinstance of exchange object

Definition at line 75 of file exg-swfgwf.f90.

◆ allocate_scalars()

procedure swfgwfexchangemodule::swfgwfexchangetype::allocate_scalars ( class(swfgwfexchangetype) this)

Allocate scalar variables

Parameters
thisSwfGwfExchangeType

Definition at line 74 of file exg-swfgwf.f90.

◆ cellstr()

procedure, pass(this) swfgwfexchangemodule::swfgwfexchangetype::cellstr ( class(swfgwfexchangetype) this,
class(numericalmodeltype), intent(in), pointer model,
integer(i4b), dimension(:), intent(in) cellid,
integer(i4b), intent(in) iout )
Parameters
thisinstance of exchange object
[in]ioutthe output file unit

Definition at line 88 of file exg-swfgwf.f90.

◆ connects_model() [1/2]

procedure baseexchangemodule::baseexchangetype::connects_model ( class(baseexchangetype) this,
class(basemodeltype), intent(in), pointer model )
inherited
Parameters
thisthe instance of the exchange
[in]modelthe 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 swfgwfexchangemodule::swfgwfexchangetype::connects_model ( class(swfgwfexchangetype) this,
class(basemodeltype), intent(in), pointer model )
Parameters
thisthe instance of the exchange
[in]modelthe model to which the exchange might hold a connection
Returns
true, when connected

Definition at line 85 of file exg-swfgwf.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 swfgwfexchangemodule::swfgwfexchangetype::exg_ac ( class(swfgwfexchangetype) this,
type(sparsematrix), intent(inout) sparse )

Override parent exg_ac so that gnc can add connections here.

Parameters
thisSwfGwfExchangeType

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

◆ exg_ad()

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

Definition at line 30 of file BaseExchange.f90.

◆ exg_ar() [1/2]

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

Definition at line 24 of file BaseExchange.f90.

◆ exg_ar() [2/2]

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

Definition at line 22 of file NumericalExchange.f90.

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

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

Accumulate budget terms

Parameters
thisSwfGwfExchangeType

Definition at line 70 of file exg-swfgwf.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()

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

procedure swfgwfexchangemodule::swfgwfexchangetype::exg_cq ( class(swfgwfexchangetype) 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
thisSwfGwfExchangeType

Definition at line 69 of file exg-swfgwf.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 numericalexchangemodule::numericalexchangetype::exg_da ( class(numericalexchangetype) this)
inherited

Definition at line 30 of file NumericalExchange.f90.

◆ exg_da() [3/3]

procedure swfgwfexchangemodule::swfgwfexchangetype::exg_da ( class(swfgwfexchangetype) this)

Deallocate memory associated with this object

Parameters
thisSwfGwfExchangeType

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

◆ exg_df() [1/2]

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

Definition at line 23 of file BaseExchange.f90.

◆ exg_df() [2/2]

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

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

Fill conductance into coefficient matrix. For now assume all connections are vertical and no newton correction is needed.

Parameters
thisSwfGwfExchangeType

Definition at line 68 of file exg-swfgwf.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 swfgwfexchangemodule::swfgwfexchangetype::exg_mc ( class(swfgwfexchangetype) this,
class(matrixbasetype), pointer matrix_sln )

Map the connections in the global matrix

Parameters
thisSwfGwfExchangeType
matrix_slnthe system matrix

Definition at line 67 of file exg-swfgwf.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 numericalexchangemodule::numericalexchangetype::exg_ot ( class(numericalexchangetype) this)
inherited

Definition at line 29 of file NumericalExchange.f90.

◆ exg_ot() [3/3]

procedure swfgwfexchangemodule::swfgwfexchangetype::exg_ot ( class(swfgwfexchangetype) this)

Write output

Parameters
thisSwfGwfExchangeType

Definition at line 71 of file exg-swfgwf.f90.

◆ exg_rp()

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

Definition at line 25 of file BaseExchange.f90.

◆ get_cond()

procedure swfgwfexchangemodule::swfgwfexchangetype::get_cond ( class(swfgwfexchangetype) this,
integer(i4b), intent(in) iexg,
real(dp), intent(in) hswf,
real(dp), intent(in) hgwf )

Calculate the conductance between the surface water cell and the underlying groundwater cell.

Parameters
thisSwfGwfExchangeType
[in]iexgexchange number
[in]hswfsurface water model head
[in]hgwfgroundwater model head

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

◆ get_iasym()

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

Definition at line 31 of file NumericalExchange.f90.

◆ get_wetted_perimeter()

procedure swfgwfexchangemodule::swfgwfexchangetype::get_wetted_perimeter ( class(swfgwfexchangetype) this,
integer(i4b), intent(in) nodeswf,
real(dp), intent(in) depth )
Parameters
thisSwfGwfExchangeType
[in]nodeswfnode number for surface water model cell
[in]depthwater depth in surface water model cell

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

◆ initialize()

procedure swfgwfexchangemodule::swfgwfexchangetype::initialize ( class(swfgwfexchangetype) this,
character(len=*), intent(in) filename,
character(len=*) name,
character(len=*) swf_ftype,
integer(i4b), intent(in) id,
integer(i4b), intent(in) m1_id,
integer(i4b), intent(in) m2_id,
character(len=*), intent(in) input_mempath )
Parameters
thisSwfGwfExchangeType
[in]filenamefilename for reading
nameexchange name
swf_ftypetype of swf model, CHF or OLF
[in]idid for the exchange
[in]m1_idid for model 1
[in]m2_idid for model 2

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

◆ noder()

procedure, pass(this) swfgwfexchangemodule::swfgwfexchangetype::noder ( class(swfgwfexchangetype) this,
class(numericalmodeltype), intent(in), pointer model,
integer(i4b), dimension(:), intent(in) cellid,
integer(i4b), intent(in) iout )
Parameters
thisinstance of exchange object
[in]ioutthe output file unit

Definition at line 87 of file exg-swfgwf.f90.

◆ qcalc()

procedure swfgwfexchangemodule::swfgwfexchangetype::qcalc ( class(swfgwfexchangetype) this,
integer(i4b), intent(in) iexg,
real(dp), intent(in) hswf,
real(dp), intent(in) hgwf )

Calculate the flow for the specified exchange and node numbers. Flow is positive into the surface water model

Parameters
thisSwfGwfExchangeType

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

◆ swf_gwf_add_to_flowja()

procedure swfgwfexchangemodule::swfgwfexchangetype::swf_gwf_add_to_flowja ( class(swfgwfexchangetype) this)
Parameters
thisSwfGwfExchangeType

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

◆ swf_gwf_bdsav()

procedure swfgwfexchangemodule::swfgwfexchangetype::swf_gwf_bdsav ( class(swfgwfexchangetype) this)

Output individual flows to listing file and binary budget files

Parameters
thisSwfGwfExchangeType

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

◆ swf_gwf_calc_simvals()

procedure swfgwfexchangemodule::swfgwfexchangetype::swf_gwf_calc_simvals ( class(swfgwfexchangetype) this)
Parameters
thisSwfGwfExchangeType

Definition at line 76 of file exg-swfgwf.f90.

◆ swf_gwf_chd_bd()

procedure, private swfgwfexchangemodule::swfgwfexchangetype::swf_gwf_chd_bd ( class(swfgwfexchangetype) this)
private

Account for flow from an external model into a chd cell

Parameters
thisGwfExchangeType

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

◆ swf_gwf_save_simvals()

procedure swfgwfexchangemodule::swfgwfexchangetype::swf_gwf_save_simvals ( class(swfgwfexchangetype), intent(inout) this)

Save the simulated flows for each exchange

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

Member Data Documentation

◆ bedleak

real(dp), dimension(:), pointer, contiguous swfgwfexchangemodule::swfgwfexchangetype::bedleak => null()

Definition at line 50 of file exg-swfgwf.f90.

◆ cfact

real(dp), dimension(:), pointer, contiguous swfgwfexchangemodule::swfgwfexchangetype::cfact => null()

Definition at line 51 of file exg-swfgwf.f90.

◆ filename

character(len=linelength), pointer swfgwfexchangemodule::swfgwfexchangetype::filename => null()

Definition at line 41 of file exg-swfgwf.f90.

◆ gwfmodel

class(gwfmodeltype), pointer swfgwfexchangemodule::swfgwfexchangetype::gwfmodel => null()

Definition at line 38 of file exg-swfgwf.f90.

◆ id

integer(i4b) baseexchangemodule::baseexchangetype::id
inherited

Definition at line 19 of file BaseExchange.f90.

19 integer(I4B) :: id

◆ idxglo

integer(i4b), dimension(:), pointer, contiguous swfgwfexchangemodule::swfgwfexchangetype::idxglo => null()

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

◆ idxsymglo

integer(i4b), dimension(:), pointer, contiguous swfgwfexchangemodule::swfgwfexchangetype::idxsymglo => null()

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

◆ ifixedcond

integer(i4b), pointer swfgwfexchangemodule::swfgwfexchangetype::ifixedcond => null()

Definition at line 45 of file exg-swfgwf.f90.

◆ inobs

integer(i4b), pointer swfgwfexchangemodule::swfgwfexchangetype::inobs => null()

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

◆ ipr_flow

integer(i4b), pointer swfgwfexchangemodule::swfgwfexchangetype::ipr_flow => null()

Definition at line 43 of file exg-swfgwf.f90.

◆ ipr_input

integer(i4b), pointer swfgwfexchangemodule::swfgwfexchangetype::ipr_input => null()

Definition at line 42 of file exg-swfgwf.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 swfgwfexchangemodule::swfgwfexchangetype::model1 => null()

Definition at line 35 of file exg-swfgwf.f90.

◆ model2

class(numericalmodeltype), pointer swfgwfexchangemodule::swfgwfexchangetype::model2 => null()

Definition at line 36 of file exg-swfgwf.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

◆ nexg

integer(i4b), pointer swfgwfexchangemodule::swfgwfexchangetype::nexg => null()

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

◆ nodegwf

integer(i4b), dimension(:), pointer, contiguous swfgwfexchangemodule::swfgwfexchangetype::nodegwf => null()

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

◆ nodeswf

integer(i4b), dimension(:), pointer, contiguous swfgwfexchangemodule::swfgwfexchangetype::nodeswf => null()

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

◆ obs

type(obstype), pointer swfgwfexchangemodule::swfgwfexchangetype::obs => null()

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

◆ outputtab1

type(tabletype), pointer swfgwfexchangemodule::swfgwfexchangetype::outputtab1 => null()

Definition at line 60 of file exg-swfgwf.f90.

◆ outputtab2

type(tabletype), pointer swfgwfexchangemodule::swfgwfexchangetype::outputtab2 => null()

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

◆ simvals

real(dp), dimension(:), pointer, contiguous swfgwfexchangemodule::swfgwfexchangetype::simvals => null()

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

◆ swf_ftype

character(len=lenftype), pointer swfgwfexchangemodule::swfgwfexchangetype::swf_ftype => null()

Definition at line 40 of file exg-swfgwf.f90.

◆ swfmodel

class(swfmodeltype), pointer swfgwfexchangemodule::swfgwfexchangetype::swfmodel => null()

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

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