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

Public Member Functions

procedure exg_df (this)
 Define the GwfGwt Exchange object.
procedure exg_ar (this)
 Allocate and read.
procedure exg_da (this)
 Deallocate memory.
procedure(exg_df), deferred exg_df (this)
procedure(exg_ar), deferred exg_ar (this)
procedure exg_rp (this)
 Read and prepare.
procedure exg_dt (this)
 Calculate time step length.
procedure exg_ot (this)
 Run output routines.
procedure exg_fp (this)
 Final processing.
procedure exg_da (this)
 Deallocate memory.
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

integer(i4b), pointer m1_idx => null()
 index into the list of base exchanges for model 1
integer(i4b), pointer m2_idx => null()
 index into the list of base exchanges for model 2
character(len=linelength) filename
 the input file for the GWF-GWT 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 set_model_pointers (this)
 Allocate and read.
procedure, private allocate_scalars (this)
 Allocate package scalars.
procedure, private gwfbnd2gwtfmi (this)
 Call routines in FMI that will set pointers to the necessary flow data.
procedure, private gwfconn2gwtconn (this, gwfmodel, gwtmodel)
 Link GWT connections to GWF connections or exchanges.
procedure, private link_connections (this, gwtconn, gwfconn)
 Links a GWT connection to its GWF counterpart.

Detailed Description

Definition at line 25 of file exg-gwfgwt.f90.

Member Function/Subroutine Documentation

◆ allocate_scalars()

procedure, private gwfgwtexchangemodule::gwfgwtexchangetype::allocate_scalars ( class(gwfgwtexchangetype) this)
private

Definition at line 37 of file exg-gwfgwt.f90.

◆ connects_model()

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.

◆ 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 gwfgwtexchangemodule::gwfgwtexchangetype::exg_ar ( class(gwfgwtexchangetype) this)

Definition at line 34 of file exg-gwfgwt.f90.

◆ exg_da() [1/2]

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

Definition at line 29 of file BaseExchange.f90.

◆ exg_da() [2/2]

procedure gwfgwtexchangemodule::gwfgwtexchangetype::exg_da ( class(gwfgwtexchangetype) this)

Definition at line 35 of file exg-gwfgwt.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 gwfgwtexchangemodule::gwfgwtexchangetype::exg_df ( class(gwfgwtexchangetype) this)

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

◆ exg_dt()

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

Definition at line 26 of file BaseExchange.f90.

◆ exg_fp()

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

Definition at line 28 of file BaseExchange.f90.

◆ exg_ot()

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

Definition at line 27 of file BaseExchange.f90.

◆ exg_rp()

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

Definition at line 25 of file BaseExchange.f90.

◆ gwfbnd2gwtfmi()

procedure, private gwfgwtexchangemodule::gwfgwtexchangetype::gwfbnd2gwtfmi ( class(gwfgwtexchangetype) this)
private

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

◆ gwfconn2gwtconn()

procedure, private gwfgwtexchangemodule::gwfgwtexchangetype::gwfconn2gwtconn ( class(gwfgwtexchangetype) this,
type(gwfmodeltype), pointer gwfmodel,
type(gwtmodeltype), pointer gwtmodel )
private
Parameters
thisthis exchange
gwfmodelthe flow model
gwtmodelthe transport model

Definition at line 39 of file exg-gwfgwt.f90.

◆ link_connections()

procedure, private gwfgwtexchangemodule::gwfgwtexchangetype::link_connections ( class(gwfgwtexchangetype) this,
class(gwtgwtconnectiontype), pointer gwtconn,
class(gwfgwfconnectiontype), pointer gwfconn )
private
Parameters
thisthis exchange
gwtconnGWT connection
gwfconnGWF connection

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

◆ set_model_pointers()

procedure, private gwfgwtexchangemodule::gwfgwtexchangetype::set_model_pointers ( class(gwfgwtexchangetype) this)
private

Definition at line 36 of file exg-gwfgwt.f90.

Member Data Documentation

◆ filename

character(len=linelength) gwfgwtexchangemodule::gwfgwtexchangetype::filename

Definition at line 29 of file exg-gwfgwt.f90.

29 character(len=LINELENGTH) :: filename !< the input file for the GWF-GWT exchange

◆ id

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

Definition at line 19 of file BaseExchange.f90.

19 integer(I4B) :: id

◆ input_mempath

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

Definition at line 18 of file BaseExchange.f90.

18 character(len=LENMEMPATH) :: input_mempath

◆ m1_idx

integer(i4b), pointer gwfgwtexchangemodule::gwfgwtexchangetype::m1_idx => null()

Definition at line 27 of file exg-gwfgwt.f90.

◆ m2_idx

integer(i4b), pointer gwfgwtexchangemodule::gwfgwtexchangetype::m2_idx => null()

Definition at line 28 of file exg-gwfgwt.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

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