MODFLOW 6  version 6.5.0.dev2
MODFLOW 6 Code Documentation
gwegweexchangemodule::gweexchangetype Type Reference

Derived type for GwtExchangeType. More...

Inheritance diagram for gwegweexchangemodule::gweexchangetype:
Inheritance graph
Collaboration diagram for gwegweexchangemodule::gweexchangetype:
Collaboration graph

Public Member Functions

procedure, public gwe_gwe_save_simvals
 

Private Member Functions

procedure exg_df => gwe_gwe_df
 
procedure exg_ar => gwe_gwe_ar
 
procedure exg_rp => gwe_gwe_rp
 
procedure exg_ad => gwe_gwe_ad
 
procedure exg_fc => gwe_gwe_fc
 
procedure exg_bd => gwe_gwe_bd
 
procedure exg_ot => gwe_gwe_ot
 
procedure exg_da => gwe_gwe_da
 
procedure exg_fp => gwe_gwe_fp
 
procedure connects_model => gwe_gwe_connects_model
 
procedure use_interface_model
 
procedure allocate_scalars
 
procedure allocate_arrays
 
procedure source_options
 
procedure read_mvt
 
procedure gwe_gwe_bdsav
 
procedure, private gwe_gwe_bdsav_model
 
procedure, private gwe_gwe_df_obs
 
procedure, private gwe_gwe_rp_obs
 
procedure, private validate_exchange
 
procedure disconnex_da
 
procedure, pass(this) source_dimensions
 
procedure, pass(this) source_data
 
procedure, pass(this) noder
 
procedure, pass(this) cellstr
 
procedure exg_ac
 
procedure exg_mc
 
procedure exg_cf
 
procedure exg_cc
 
procedure exg_cq
 
procedure get_iasym
 
procedure exg_calculate_delt
 

Private Attributes

character(len=lenmodelname) gwfmodelname1 = ''
 name of gwfmodel that corresponds to gwtmodel1 More...
 
character(len=lenmodelname) gwfmodelname2 = ''
 name of gwfmodel that corresponds to gwtmodel2 More...
 
real(dp), dimension(:), pointer, contiguous gwfsimvals => null()
 simulated gwf flow rate for each exchange More...
 
class(gwemodeltype), pointer gwemodel1 => null()
 pointer to GWT Model 1 More...
 
class(gwemodeltype), pointer gwemodel2 => null()
 pointer to GWT Model 2 More...
 
integer(i4b), pointer inewton => null()
 unneeded newton flag allows for mvt to be used here More...
 
integer(i4b), pointer iadvscheme
 the advection scheme at the interface: 0 = upstream, 1 = central, 2 = TVD More...
 
integer(i4b), pointer inmvt => null()
 unit number for mover transport (0 if off) More...
 
type(tspmvttype), pointer mvt => null()
 water mover object More...
 
integer(i4b), pointer inobs => null()
 unit number for GWT-GWT observations More...
 
type(obstype), pointer obs => null()
 observation object More...
 
real(dp), dimension(:), pointer, contiguous cond => null()
 conductance More...
 
real(dp), dimension(:), pointer, contiguous simvals => null()
 simulated flow rate for each exchange More...
 
type(tabletype), pointer outputtab1 => null()
 
type(tabletype), pointer outputtab2 => null()
 
character(len=linelength), pointer filename => null()
 name of the input file More...
 
class(numericalmodeltype), pointer model1 => null()
 model 1 More...
 
class(numericalmodeltype), pointer model2 => null()
 model 2 More...
 
class(virtualmodeltype), pointer v_model1 => null()
 virtual model 1 More...
 
class(virtualmodeltype), pointer v_model2 => null()
 virtual model 2 More...
 
logical(lgp) is_datacopy
 when true, this exchange is just a data copy on another process and not responsible for controlling movers, observations, ... More...
 
integer(i4b), pointer nexg => null()
 number of exchanges More...
 
integer(i4b), dimension(:), pointer, contiguous nodem1 => null()
 node numbers in model 1 More...
 
integer(i4b), dimension(:), pointer, contiguous nodem2 => null()
 node numbers in model 2 More...
 
integer(i4b), dimension(:), pointer, contiguous ihc => null()
 horizontal connection indicator array, size: nexg More...
 
real(dp), dimension(:), pointer, contiguous cl1 => null()
 connection length 1, size: nexg More...
 
real(dp), dimension(:), pointer, contiguous cl2 => null()
 connection length 2, size: nexg More...
 
real(dp), dimension(:), pointer, contiguous hwva => null()
 horizontal widths, vertical flow areas, size: nexg More...
 
integer(i4b), pointer naux => null()
 number of auxiliary variables More...
 
character(len=lenboundname), dimension(:), pointer, contiguous boundname => null()
 boundnames More...
 
character(len=lenauxname), dimension(:), pointer, contiguous auxname => null()
 vector of auxname More...
 
type(characterstringtype), dimension(:), pointer, contiguous auxname_cst => null()
 copy of vector auxname that can be stored in memory manager More...
 
real(dp), dimension(:, :), pointer, contiguous auxvar => null()
 array of auxiliary variable values More...
 
integer(i4b), pointer ianglex => null()
 flag indicating anglex was read, if read, ianglex is index in auxvar More...
 
integer(i4b), pointer icdist => null()
 flag indicating cdist was read, if read, icdist is index in auxvar More...
 
integer(i4b), pointer iprpak => null()
 print input flag More...
 
integer(i4b), pointer iprflow => null()
 print flag for cell by cell flows More...
 
integer(i4b), pointer ipakcb => null()
 save flag for cell by cell flows More...
 
integer(i4b), pointer inamedbound => null()
 flag to read boundnames More...
 
integer(i4b), pointer ixt3d => null()
 flag indicating if XT3D should be applied on the interface: 0 = off, 1 = lhs, 2 = rhs More...
 
logical(lgp), pointer dev_ifmod_on
 development option, forces interface model for this exchange More...
 
character(len=7) typename
 name of the type (e.g., 'GWF-GWF') More...
 
character(len=lenexchangename) name
 the name of this exchange More...
 
character(len=lenmempath) memorypath
 the location in the memory manager where the variables are stored More...
 
character(len=lenmempath) input_mempath
 
integer(i4b) id
 

Detailed Description

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

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

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure gwegweexchangemodule::gweexchangetype::allocate_arrays
private

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

◆ allocate_scalars()

procedure gwegweexchangemodule::gweexchangetype::allocate_scalars
private

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

◆ cellstr()

procedure, pass(this) disconnexchangemodule::disconnexchangetype::cellstr
privateinherited

Definition at line 71 of file DisConnExchange.f90.

◆ connects_model()

procedure gwegweexchangemodule::gweexchangetype::connects_model
private

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

◆ disconnex_da()

procedure disconnexchangemodule::disconnexchangetype::disconnex_da
privateinherited

Definition at line 63 of file DisConnExchange.f90.

◆ exg_ac()

procedure numericalexchangemodule::numericalexchangetype::exg_ac
privateinherited

Definition at line 22 of file NumericalExchange.f90.

◆ exg_ad()

procedure gwegweexchangemodule::gweexchangetype::exg_ad
private

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

◆ exg_ar()

procedure gwegweexchangemodule::gweexchangetype::exg_ar
private

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

◆ exg_bd()

procedure gwegweexchangemodule::gweexchangetype::exg_bd
private

Definition at line 86 of file exg-gwegwe.f90.

◆ exg_calculate_delt()

procedure baseexchangemodule::baseexchangetype::exg_calculate_delt
privateinherited

Definition at line 25 of file BaseExchange.f90.

◆ exg_cc()

procedure numericalexchangemodule::numericalexchangetype::exg_cc
privateinherited

Definition at line 29 of file NumericalExchange.f90.

◆ exg_cf()

procedure numericalexchangemodule::numericalexchangetype::exg_cf
privateinherited

Definition at line 27 of file NumericalExchange.f90.

◆ exg_cq()

procedure numericalexchangemodule::numericalexchangetype::exg_cq
privateinherited

Definition at line 30 of file NumericalExchange.f90.

◆ exg_da()

procedure gwegweexchangemodule::gweexchangetype::exg_da
private

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

◆ exg_df()

procedure gwegweexchangemodule::gweexchangetype::exg_df
private

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

◆ exg_fc()

procedure gwegweexchangemodule::gweexchangetype::exg_fc
private

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

◆ exg_fp()

procedure gwegweexchangemodule::gweexchangetype::exg_fp
private

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

◆ exg_mc()

procedure numericalexchangemodule::numericalexchangetype::exg_mc
privateinherited

Definition at line 23 of file NumericalExchange.f90.

◆ exg_ot()

procedure gwegweexchangemodule::gweexchangetype::exg_ot
private

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

◆ exg_rp()

procedure gwegweexchangemodule::gweexchangetype::exg_rp
private

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

◆ get_iasym()

procedure numericalexchangemodule::numericalexchangetype::get_iasym
privateinherited

Definition at line 34 of file NumericalExchange.f90.

◆ gwe_gwe_bdsav()

procedure gwegweexchangemodule::gweexchangetype::gwe_gwe_bdsav
private

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

◆ gwe_gwe_bdsav_model()

procedure, private gwegweexchangemodule::gweexchangetype::gwe_gwe_bdsav_model
private

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

◆ gwe_gwe_df_obs()

procedure, private gwegweexchangemodule::gweexchangetype::gwe_gwe_df_obs
private

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

◆ gwe_gwe_rp_obs()

procedure, private gwegweexchangemodule::gweexchangetype::gwe_gwe_rp_obs
private

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

◆ gwe_gwe_save_simvals()

procedure, public gwegweexchangemodule::gweexchangetype::gwe_gwe_save_simvals

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

◆ noder()

procedure, pass(this) disconnexchangemodule::disconnexchangetype::noder
privateinherited

Definition at line 70 of file DisConnExchange.f90.

◆ read_mvt()

procedure gwegweexchangemodule::gweexchangetype::read_mvt
private

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

◆ source_data()

procedure, pass(this) disconnexchangemodule::disconnexchangetype::source_data
privateinherited

Definition at line 69 of file DisConnExchange.f90.

◆ source_dimensions()

procedure, pass(this) disconnexchangemodule::disconnexchangetype::source_dimensions
privateinherited

Definition at line 68 of file DisConnExchange.f90.

◆ source_options()

procedure gwegweexchangemodule::gweexchangetype::source_options
private

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

◆ use_interface_model()

procedure gwegweexchangemodule::gweexchangetype::use_interface_model
private

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

◆ validate_exchange()

procedure, private gwegweexchangemodule::gweexchangetype::validate_exchange
private

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

Member Data Documentation

◆ auxname

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

Definition at line 44 of file DisConnExchange.f90.

44  character(len=LENAUXNAME), dimension(:), &
45  pointer, contiguous :: auxname => null() !< vector of auxname

◆ auxname_cst

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

Definition at line 46 of file DisConnExchange.f90.

46  type(CharacterStringType), dimension(:), pointer, &
47  contiguous :: auxname_cst => null() !< copy of vector auxname that can be stored in memory manager

◆ auxvar

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

Definition at line 48 of file DisConnExchange.f90.

48  real(DP), dimension(:, :), pointer, contiguous :: auxvar => null() !< array of auxiliary variable values

◆ boundname

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

Definition at line 41 of file DisConnExchange.f90.

41  character(len=LENBOUNDNAME), dimension(:), &
42  pointer, contiguous :: boundname => null() !< boundnames

◆ cl1

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

Definition at line 37 of file DisConnExchange.f90.

37  real(DP), dimension(:), pointer, contiguous :: cl1 => null() !< connection length 1, size: nexg

◆ cl2

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

Definition at line 38 of file DisConnExchange.f90.

38  real(DP), dimension(:), pointer, contiguous :: cl2 => null() !< connection length 2, size: nexg

◆ cond

real(dp), dimension(:), pointer, contiguous gwegweexchangemodule::gweexchangetype::cond => null()
private

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

72  real(DP), dimension(:), pointer, contiguous :: cond => null() !< conductance

◆ dev_ifmod_on

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

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

Definition at line 24 of file DisConnExchange.f90.

24  character(len=LINELENGTH), pointer :: filename => null() !< name of the input file

◆ gwemodel1

class(gwemodeltype), pointer gwegweexchangemodule::gweexchangetype::gwemodel1 => null()
private

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

55  class(GweModelType), pointer :: gwemodel1 => null() !< pointer to GWT Model 1

◆ gwemodel2

class(gwemodeltype), pointer gwegweexchangemodule::gweexchangetype::gwemodel2 => null()
private

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

56  class(GweModelType), pointer :: gwemodel2 => null() !< pointer to GWT Model 2

◆ gwfmodelname1

character(len=lenmodelname) gwegweexchangemodule::gweexchangetype::gwfmodelname1 = ''
private

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

50  character(len=LENMODELNAME) :: gwfmodelname1 = '' !< name of gwfmodel that corresponds to gwtmodel1

◆ gwfmodelname2

character(len=lenmodelname) gwegweexchangemodule::gweexchangetype::gwfmodelname2 = ''
private

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

51  character(len=LENMODELNAME) :: gwfmodelname2 = '' !< name of gwfmodel that corresponds to gwtmodel2

◆ gwfsimvals

real(dp), dimension(:), pointer, contiguous gwegweexchangemodule::gweexchangetype::gwfsimvals => null()
private

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

52  real(DP), dimension(:), pointer, contiguous :: gwfsimvals => null() !< simulated gwf flow rate for each exchange

◆ hwva

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

Definition at line 39 of file DisConnExchange.f90.

39  real(DP), dimension(:), pointer, contiguous :: hwva => null() !< horizontal widths, vertical flow areas, size: nexg

◆ iadvscheme

integer(i4b), pointer gwegweexchangemodule::gweexchangetype::iadvscheme
private

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

60  integer(I4B), pointer :: iAdvScheme !< the advection scheme at the interface:

◆ ianglex

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

Definition at line 49 of file DisConnExchange.f90.

49  integer(I4B), pointer :: ianglex => null() !< flag indicating anglex was read, if read, ianglex is index in auxvar

◆ icdist

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

Definition at line 50 of file DisConnExchange.f90.

50  integer(I4B), pointer :: icdist => null() !< flag indicating cdist was read, if read, icdist is index in auxvar

◆ id

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

Definition at line 18 of file BaseExchange.f90.

18  integer(I4B) :: id

◆ ihc

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

Definition at line 36 of file DisConnExchange.f90.

36  integer(I4B), dimension(:), pointer, contiguous :: ihc => null() !< horizontal connection indicator array, size: nexg

◆ inamedbound

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

Definition at line 54 of file DisConnExchange.f90.

54  integer(I4B), pointer :: inamedbound => null() !< flag to read boundnames

◆ inewton

integer(i4b), pointer gwegweexchangemodule::gweexchangetype::inewton => null()
private

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

59  integer(I4B), pointer :: inewton => null() !< unneeded newton flag allows for mvt to be used here

◆ inmvt

integer(i4b), pointer gwegweexchangemodule::gweexchangetype::inmvt => null()
private

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

64  integer(I4B), pointer :: inmvt => null() !< unit number for mover transport (0 if off)

◆ inobs

integer(i4b), pointer gwegweexchangemodule::gweexchangetype::inobs => null()
private

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

68  integer(I4B), pointer :: inobs => null() !< unit number for GWT-GWT observations

◆ input_mempath

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

Definition at line 17 of file BaseExchange.f90.

17  character(len=LENMEMPATH) :: input_mempath

◆ ipakcb

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

Definition at line 53 of file DisConnExchange.f90.

53  integer(I4B), pointer :: ipakcb => null() !< save flag for cell by cell flows

◆ iprflow

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

Definition at line 52 of file DisConnExchange.f90.

52  integer(I4B), pointer :: iprflow => null() !< print flag for cell by cell flows

◆ iprpak

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

Definition at line 51 of file DisConnExchange.f90.

51  integer(I4B), pointer :: iprpak => null() !< print input flag

◆ is_datacopy

logical(lgp) disconnexchangemodule::disconnexchangetype::is_datacopy
privateinherited

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

◆ ixt3d

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

Definition at line 56 of file DisConnExchange.f90.

56  integer(I4B), pointer :: ixt3d => null() !< flag indicating if XT3D should be applied on the interface: 0 = off, 1 = lhs, 2 = rhs

◆ memorypath

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

Definition at line 16 of file BaseExchange.f90.

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

◆ model1

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

Definition at line 26 of file DisConnExchange.f90.

26  class(NumericalModelType), pointer :: model1 => null() !< model 1

◆ model2

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

Definition at line 27 of file DisConnExchange.f90.

27  class(NumericalModelType), pointer :: model2 => null() !< model 2

◆ mvt

type(tspmvttype), pointer gwegweexchangemodule::gweexchangetype::mvt => null()
private

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

65  type(TspMvtType), pointer :: mvt => null() !< water mover object

◆ name

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

Definition at line 15 of file BaseExchange.f90.

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

◆ naux

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

Definition at line 40 of file DisConnExchange.f90.

40  integer(I4B), pointer :: naux => null() !< number of auxiliary variables

◆ nexg

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

Definition at line 33 of file DisConnExchange.f90.

33  integer(I4B), pointer :: nexg => null() !< number of exchanges

◆ nodem1

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

Definition at line 34 of file DisConnExchange.f90.

34  integer(I4B), dimension(:), pointer, contiguous :: nodem1 => null() !< node numbers in model 1

◆ nodem2

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

Definition at line 35 of file DisConnExchange.f90.

35  integer(I4B), dimension(:), pointer, contiguous :: nodem2 => null() !< node numbers in model 2

◆ obs

type(obstype), pointer gwegweexchangemodule::gweexchangetype::obs => null()
private

Definition at line 69 of file exg-gwegwe.f90.

69  type(ObsType), pointer :: obs => null() !< observation object

◆ outputtab1

type(tabletype), pointer gwegweexchangemodule::gweexchangetype::outputtab1 => null()
private

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

76  type(TableType), pointer :: outputtab1 => null()

◆ outputtab2

type(tabletype), pointer gwegweexchangemodule::gweexchangetype::outputtab2 => null()
private

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

77  type(TableType), pointer :: outputtab2 => null()

◆ simvals

real(dp), dimension(:), pointer, contiguous gwegweexchangemodule::gweexchangetype::simvals => null()
private

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

73  real(DP), dimension(:), pointer, contiguous :: simvals => null() !< simulated flow rate for each exchange

◆ typename

character(len=7) numericalexchangemodule::numericalexchangetype::typename
privateinherited

Definition at line 17 of file NumericalExchange.f90.

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

◆ v_model1

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

Definition at line 28 of file DisConnExchange.f90.

28  class(VirtualModelType), pointer :: v_model1 => null() !< virtual model 1

◆ v_model2

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

Definition at line 29 of file DisConnExchange.f90.

29  class(VirtualModelType), pointer :: v_model2 => null() !< virtual model 2

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