![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|
Exchange based on connection between discretizations of DisBaseType. The data specifies the connections, similar to the information stored in the connections object: DisBaseTypecon. More...


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 |
Definition at line 23 of file DisConnExchange.f90.
| procedure disconnexchangemodule::disconnexchangetype::allocate_arrays | ( | class(disconnexchangetype) | this | ) |
| this | instance of exchange object |
Definition at line 62 of file DisConnExchange.f90.
| procedure disconnexchangemodule::disconnexchangetype::allocate_scalars | ( | class(disconnexchangetype) | this | ) |
| this | instance of exchange object |
Definition at line 61 of file DisConnExchange.f90.
| procedure, pass(this) disconnexchangemodule::disconnexchangetype::cellstr | ( | class(disconnexchangetype) | this, |
| integer(i4b) | ndim, | ||
| integer(i4b), dimension(:), intent(in) | cellid, | ||
| integer(i4b), intent(in) | iout ) |
| this | instance of exchange object | |
| ndim | model DIS dimension | |
| [in] | iout | the output file unit |
Definition at line 71 of file DisConnExchange.f90.
|
inherited |
| this | the instance of the exchange | |
| [in] | model | the model to which the exchange might hold a connection |
Definition at line 31 of file BaseExchange.f90.
| procedure disconnexchangemodule::disconnexchangetype::disconnex_da | ( | class(disconnexchangetype) | this | ) |
| this | instance of exchange object |
Definition at line 63 of file DisConnExchange.f90.
|
inherited |
Definition at line 20 of file NumericalExchange.f90.
|
inherited |
Definition at line 30 of file BaseExchange.f90.
|
pure virtualinherited |
Definition at line 24 of file BaseExchange.f90.
|
inherited |
Definition at line 22 of file NumericalExchange.f90.
|
inherited |
Definition at line 28 of file NumericalExchange.f90.
|
inherited |
Definition at line 26 of file NumericalExchange.f90.
|
inherited |
Definition at line 24 of file NumericalExchange.f90.
|
inherited |
Definition at line 27 of file NumericalExchange.f90.
|
inherited |
Definition at line 29 of file BaseExchange.f90.
|
inherited |
Definition at line 30 of file NumericalExchange.f90.
|
pure virtualinherited |
Definition at line 23 of file BaseExchange.f90.
|
inherited |
Definition at line 19 of file NumericalExchange.f90.
|
inherited |
Definition at line 26 of file BaseExchange.f90.
|
inherited |
Definition at line 25 of file NumericalExchange.f90.
|
inherited |
Definition at line 28 of file BaseExchange.f90.
|
inherited |
Definition at line 21 of file NumericalExchange.f90.
|
inherited |
Definition at line 27 of file BaseExchange.f90.
|
inherited |
Definition at line 29 of file NumericalExchange.f90.
|
inherited |
Definition at line 25 of file BaseExchange.f90.
|
inherited |
Definition at line 31 of file NumericalExchange.f90.
| 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 ) |
| this | instance of exchange object | |
| [in] | iout | the output file unit |
Definition at line 70 of file DisConnExchange.f90.
| procedure, pass(this) disconnexchangemodule::disconnexchangetype::source_data | ( | class(disconnexchangetype) | this, |
| integer(i4b), intent(in) | iout ) |
| this | instance of exchange object | |
| [in] | iout | the output file unit |
Definition at line 69 of file DisConnExchange.f90.
| procedure, pass(this) disconnexchangemodule::disconnexchangetype::source_dimensions | ( | class(disconnexchangetype) | this, |
| integer(i4b), intent(in) | iout ) |
| this | instance of exchange object | |
| [in] | iout | for logging |
Definition at line 68 of file DisConnExchange.f90.
| procedure, pass(this) disconnexchangemodule::disconnexchangetype::source_options | ( | class(disconnexchangetype) | this, |
| integer(i4b), intent(in) | iout ) |
| this | instance of exchange object | |
| [in] | iout | for logging |
Definition at line 67 of file DisConnExchange.f90.
| procedure disconnexchangemodule::disconnexchangetype::use_interface_model | ( | class(disconnexchangetype) | this | ) |
| this | instance of exchange object |
Definition at line 64 of file DisConnExchange.f90.
| character(len=lenauxname), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::auxname => null() |
Definition at line 44 of file DisConnExchange.f90.
| type(characterstringtype), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::auxname_cst => null() |
Definition at line 46 of file DisConnExchange.f90.
| real(dp), dimension(:, :), pointer, contiguous disconnexchangemodule::disconnexchangetype::auxvar => null() |
Definition at line 48 of file DisConnExchange.f90.
| character(len=lenboundname), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::boundname => null() |
Definition at line 41 of file DisConnExchange.f90.
| real(dp), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::cl1 => null() |
Definition at line 37 of file DisConnExchange.f90.
| real(dp), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::cl2 => null() |
Definition at line 38 of file DisConnExchange.f90.
| logical(lgp), pointer disconnexchangemodule::disconnexchangetype::dev_ifmod_on |
Definition at line 57 of file DisConnExchange.f90.
| character(len=linelength), pointer disconnexchangemodule::disconnexchangetype::filename => null() |
Definition at line 24 of file DisConnExchange.f90.
| real(dp), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::hwva => null() |
Definition at line 39 of file DisConnExchange.f90.
| integer(i4b), pointer disconnexchangemodule::disconnexchangetype::ianglex => null() |
Definition at line 49 of file DisConnExchange.f90.
| integer(i4b), pointer disconnexchangemodule::disconnexchangetype::icdist => null() |
Definition at line 50 of file DisConnExchange.f90.
|
inherited |
Definition at line 19 of file BaseExchange.f90.
| integer(i4b), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::ihc => null() |
Definition at line 36 of file DisConnExchange.f90.
| integer(i4b), pointer disconnexchangemodule::disconnexchangetype::inamedbound => null() |
Definition at line 54 of file DisConnExchange.f90.
|
inherited |
Definition at line 18 of file BaseExchange.f90.
| integer(i4b), pointer disconnexchangemodule::disconnexchangetype::ipakcb => null() |
Definition at line 53 of file DisConnExchange.f90.
| integer(i4b), pointer disconnexchangemodule::disconnexchangetype::iprflow => null() |
Definition at line 52 of file DisConnExchange.f90.
| integer(i4b), pointer disconnexchangemodule::disconnexchangetype::iprpak => null() |
Definition at line 51 of file DisConnExchange.f90.
| logical(lgp) disconnexchangemodule::disconnexchangetype::is_datacopy |
Definition at line 30 of file DisConnExchange.f90.
| integer(i4b), pointer disconnexchangemodule::disconnexchangetype::ixt3d => null() |
Definition at line 56 of file DisConnExchange.f90.
|
inherited |
Definition at line 17 of file BaseExchange.f90.
| class(numericalmodeltype), pointer disconnexchangemodule::disconnexchangetype::model1 => null() |
Definition at line 26 of file DisConnExchange.f90.
| class(numericalmodeltype), pointer disconnexchangemodule::disconnexchangetype::model2 => null() |
Definition at line 27 of file DisConnExchange.f90.
|
inherited |
Definition at line 16 of file BaseExchange.f90.
| integer(i4b), pointer disconnexchangemodule::disconnexchangetype::naux => null() |
Definition at line 40 of file DisConnExchange.f90.
| integer(i4b), pointer disconnexchangemodule::disconnexchangetype::nexg => null() |
Definition at line 33 of file DisConnExchange.f90.
| integer(i4b), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::nodem1 => null() |
Definition at line 34 of file DisConnExchange.f90.
| integer(i4b), dimension(:), pointer, contiguous disconnexchangemodule::disconnexchangetype::nodem2 => null() |
Definition at line 35 of file DisConnExchange.f90.
|
inherited |
Definition at line 15 of file BaseExchange.f90.
| class(virtualmodeltype), pointer disconnexchangemodule::disconnexchangetype::v_model1 => null() |
Definition at line 28 of file DisConnExchange.f90.
| class(virtualmodeltype), pointer disconnexchangemodule::disconnexchangetype::v_model2 => null() |
Definition at line 29 of file DisConnExchange.f90.