MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
disconnexchangemodule::disconnexchangetype Type Referenceabstract

Exchange based on connection between discretizations of DisBaseType. The data specifies the connections, similar to the information stored in the connections object: DisBaseTypecon. More...

Inheritance diagram for disconnexchangemodule::disconnexchangetype:
Inheritance graph
Collaboration diagram for disconnexchangemodule::disconnexchangetype:
Collaboration graph

Public Member Functions

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

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

Detailed Description

Definition at line 23 of file DisConnExchange.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure disconnexchangemodule::disconnexchangetype::allocate_arrays ( class(disconnexchangetype) this)
Parameters
thisinstance of exchange object

Definition at line 62 of file DisConnExchange.f90.

◆ allocate_scalars()

procedure disconnexchangemodule::disconnexchangetype::allocate_scalars ( class(disconnexchangetype) this)
Parameters
thisinstance of exchange object

Definition at line 61 of file DisConnExchange.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 )
Parameters
thisinstance of exchange object
ndimmodel DIS dimension
[in]ioutthe output file unit

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

◆ disconnex_da()

procedure disconnexchangemodule::disconnexchangetype::disconnex_da ( class(disconnexchangetype) this)
Parameters
thisinstance of exchange object

Definition at line 63 of file DisConnExchange.f90.

◆ exg_ac()

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

Definition at line 20 of file NumericalExchange.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()

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

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

Definition at line 24 of file NumericalExchange.f90.

◆ exg_cq()

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/2]

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

Definition at line 29 of file BaseExchange.f90.

◆ exg_da() [2/2]

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

Definition at line 30 of file NumericalExchange.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()

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

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

Definition at line 28 of file BaseExchange.f90.

◆ exg_mc()

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/2]

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

Definition at line 27 of file BaseExchange.f90.

◆ exg_ot() [2/2]

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

Definition at line 29 of file NumericalExchange.f90.

◆ exg_rp()

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

Definition at line 25 of file BaseExchange.f90.

◆ get_iasym()

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

Definition at line 31 of file NumericalExchange.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 )
Parameters
thisinstance of exchange object
[in]ioutthe output file unit

Definition at line 70 of file DisConnExchange.f90.

◆ source_data()

procedure, pass(this) disconnexchangemodule::disconnexchangetype::source_data ( class(disconnexchangetype) this,
integer(i4b), intent(in) iout )
Parameters
thisinstance of exchange object
[in]ioutthe 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 )
Parameters
thisinstance of exchange object
[in]ioutfor logging

Definition at line 68 of file DisConnExchange.f90.

◆ source_options()

procedure, pass(this) disconnexchangemodule::disconnexchangetype::source_options ( class(disconnexchangetype) this,
integer(i4b), intent(in) iout )
Parameters
thisinstance of exchange object
[in]ioutfor logging

Definition at line 67 of file DisConnExchange.f90.

◆ use_interface_model()

procedure disconnexchangemodule::disconnexchangetype::use_interface_model ( class(disconnexchangetype) this)
Parameters
thisinstance of exchange object
Returns
flag whether interface model should be used for this exchange instead

Definition at line 64 of file DisConnExchange.f90.

Member Data Documentation

◆ auxname

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

Definition at line 44 of file DisConnExchange.f90.

◆ auxname_cst

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

Definition at line 46 of file DisConnExchange.f90.

◆ auxvar

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

Definition at line 48 of file DisConnExchange.f90.

◆ boundname

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

Definition at line 41 of file DisConnExchange.f90.

◆ cl1

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

Definition at line 37 of file DisConnExchange.f90.

◆ cl2

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

Definition at line 38 of file DisConnExchange.f90.

◆ dev_ifmod_on

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

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

Definition at line 24 of file DisConnExchange.f90.

◆ hwva

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

Definition at line 39 of file DisConnExchange.f90.

◆ ianglex

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

Definition at line 49 of file DisConnExchange.f90.

◆ icdist

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

Definition at line 50 of file DisConnExchange.f90.

◆ id

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

Definition at line 19 of file BaseExchange.f90.

19 integer(I4B) :: id

◆ ihc

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

Definition at line 36 of file DisConnExchange.f90.

◆ inamedbound

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

Definition at line 54 of file DisConnExchange.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()

Definition at line 53 of file DisConnExchange.f90.

◆ iprflow

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

Definition at line 52 of file DisConnExchange.f90.

◆ iprpak

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

Definition at line 51 of file DisConnExchange.f90.

◆ is_datacopy

logical(lgp) disconnexchangemodule::disconnexchangetype::is_datacopy

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

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

Definition at line 26 of file DisConnExchange.f90.

◆ model2

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

Definition at line 27 of file DisConnExchange.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()

Definition at line 40 of file DisConnExchange.f90.

◆ nexg

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

Definition at line 33 of file DisConnExchange.f90.

◆ nodem1

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

Definition at line 34 of file DisConnExchange.f90.

◆ nodem2

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

Definition at line 35 of file DisConnExchange.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()

Definition at line 28 of file DisConnExchange.f90.

◆ v_model2

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

Definition at line 29 of file DisConnExchange.f90.


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