MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
tspexchangemovermodule::tspexchangemovertype Type Reference
Inheritance diagram for tspexchangemovermodule::tspexchangemovertype:
Inheritance graph
Collaboration diagram for tspexchangemovermodule::tspexchangemovertype:
Collaboration graph

Public Member Functions

procedure mvt_rp (this)
 Read and prepare mover transport object.
procedure xmvt_cf (this, cnew1, cnew2)
procedure mvt_fc (this, cnew1, cnew2)
procedure mvt_da (this)
procedure mvt_init (this, name_model, inunit, iout, fmi1, eqnsclfac, depvartype, gwfmodelname1, gwfmodelname2, fmi2)
 Create a new mover transport object.
procedure mvt_df (this, dis)
 Define mover transport object.
procedure mvt_ar (this)
 Allocate and read mover-for-transport information.
procedure mvt_rp (this)
 Read and prepare mover transport object.
procedure mvt_fc (this, cnew1, cnew2)
 Calculate coefficients and fill amat and rhs.
procedure mvt_fill_mvrterm (this, cnew1, cnew2)
 Fill mvrterm with provider concentration and flow for each budget term.
procedure mvt_update_qmfrommvr (this)
 Assign mover transport mass into each receiver's qmfrommvr.
procedure mvt_cc (this, kiter, iend, icnvgmod, cpak, dpak)
 Extra convergence check for mover.
procedure mvt_bd (this)
 Write mover terms to listing file.
procedure mvt_ot_saveflow (this, icbcfl, ibudfl)
 Write mover budget terms.
procedure mvt_ot_printflow (this, icbcfl, ibudfl)
 Print mover flow table.
procedure mvt_ot_bdsummary (this, ibudfl)
 Write mover budget to listing file.
procedure mvt_da (this)
 Deallocate memory.
procedure allocate_scalars (this)
 Allocate scalar variables for package.
procedure allocate_scalars (this)
 Allocate package scalars.
procedure read_options (this)
 Read mover-for-transport options block.
procedure mvt_setup_budobj (this)
 Set up the budget object that stores all the mvr flows.
procedure mvt_fill_budobj (this)
 Copy mover-for-transport flow terms into thisbudobj.
procedure mvt_scan_mvrbudobj (this)
 Determine max number of packages in use.
procedure set_pointer_mvrbudobj (this, mvrbudobj)
 Set pointer to mvrbudobj.
procedure set_fmi (this, ibudterm, fmi, set_provider)
procedure set_names (this, ibcnum, name_model, pakname, ftype, input_mempath)
 Set package names.
procedure da (this)
 Deallocate package scalars.
procedure read_check_ionper (this)
 Check ionper.
procedure get_block_data (this, tags, lfound, varinames)
 Read griddata block for a package.

Public Attributes

class(virtualmodeltype), pointer model1 => null()
 virtual model 1
class(virtualmodeltype), pointer model2 => null()
 virtual model 2
integer(i4b), pointer maxmvt => null()
 size of quantity arrays
real(dp), dimension(:), pointer, contiguous quantity_m1 => null()
 concentration, temp, ...
real(dp), dimension(:), pointer, contiguous quantity_m2 => null()
 concentration, temp, ...
character(len=lenmodelname) gwfmodelname1 = ''
 name of model 1
character(len=lenmodelname) gwfmodelname2 = ''
 name of model 2 (set to modelname 1 for single model MVT)
integer(i4b), pointer maxpackages
 max number of packages
integer(i4b), pointer ibudgetout => null()
 unit number for budget output file
integer(i4b), pointer ibudcsv => null()
 unit number for csv budget output file
real(dp), pointer eqnsclfac => null()
 governing equation scale factor; =1. for solute; =rhow*cpw for energy
type(tspfmitype), pointer fmi1 => null()
 pointer to fmi object for model 1
type(tspfmitype), pointer fmi2 => null()
 pointer to fmi object for model 2 (set to fmi1 for single model)
type(budgettype), pointer budget => null()
 mover transport budget object (used to write balance table)
type(budgetobjecttype), pointer budobj => null()
 budget container (used to write binary file)
type(budgetobjecttype), pointer mvrbudobj => null()
 pointer to the water mover budget object
character(len=lenpackagename), dimension(:), pointer, contiguous paknames => null()
 array of package names
character(len=lenvarname) depvartype = ''
type(tabletype), pointer outputtab => null()
type(mvrtermtype), dimension(:), pointer, contiguous mvrterm => null()
 qty and flow per budget term
character(len=lenmodelname) name_model = ''
 the name of the model that contains this package
character(len=lenpackagename) packname = ''
 name of the package
character(len=lenmempath) memorypath = ''
 the location in the memory manager where the variables are stored
character(len=lenmempath) memorypathmodel = ''
 the location in the memory manager where the variables of the parent model are stored
character(len=lenmempath) input_mempath = ''
 input context mempath
character(len=linelength), pointer input_fname => null()
 input file name
character(len=lenftype) filtyp = ''
 file type (CHD, DRN, RIV, etc.)
character(len=lenftype), pointer package_type => null()
 package type (same as filtyp) stored in memory manager
integer(i4b), pointer id => null()
 consecutive package number in model
integer(i4b), pointer inunit => null()
 unit number for input file
integer(i4b), pointer iout => null()
 unit number for writing package output
integer(i4b), pointer inewton => null()
 newton flag
integer(i4b), pointer iasym => null()
 package causes matrix asymmetry
integer(i4b), pointer iprpak => null()
 integer flag to echo input
integer(i4b), pointer iprflow => null()
 flag to print simulated flows
integer(i4b), pointer ipakcb => null()
 output flows (-1, 0, 1) - save_flows
integer(i4b), pointer ionper => null()
 stress period for next data
integer(i4b), pointer lastonper => null()
 last value of ionper (for checking)
type(blockparsertype) parser
 parser object for reading blocks of information
class(disbasetype), pointer dis => null()
 model discretization object

Private Member Functions

procedure, private mvt_setup_outputtab (this)
 Set up the mover-for-transport output table.
procedure, private mvt_print_outputtab (this)
 Set up mover-for-transport output table.

Detailed Description

Definition at line 16 of file TspExchangeMover.f90.

Member Function/Subroutine Documentation

◆ allocate_scalars() [1/2]

procedure numericalpackagemodule::numericalpackagetype::allocate_scalars ( class(numericalpackagetype) this)
inherited

Allocate and initialize base numerical package scalars.

Parameters
thisNumericalPackageType object

Definition at line 54 of file NumericalPackage.f90.

◆ allocate_scalars() [2/2]

procedure tspmvtmodule::tspmvttype::allocate_scalars ( class(tspmvttype) this)
inherited

Method to allocate scalar variables for the MVT package.

Definition at line 70 of file tsp-mvt.f90.

◆ da()

procedure numericalpackagemodule::numericalpackagetype::da ( class(numericalpackagetype) this)
inherited

Deallocate and initialize base numerical package scalars.

Parameters
thisNumericalPackageType object

Definition at line 55 of file NumericalPackage.f90.

◆ get_block_data()

procedure numericalpackagemodule::numericalpackagetype::get_block_data ( class(numericalpackagetype) this,
character(len=24), dimension(:), intent(in) tags,
logical, dimension(:), intent(inout) lfound,
character(len=24), dimension(:), intent(in), optional varinames )
inherited

Generic method to read data in the GRIDDATA block for a package.

Parameters
thisNumericalPackageType object
[in]tagsvector with variable tags
[in,out]lfoundboolean vector indicating of a variable tag was found
[in]varinamesoptional vector of variable names

Definition at line 57 of file NumericalPackage.f90.

◆ mvt_ar()

procedure tspmvtmodule::tspmvttype::mvt_ar ( class(tspmvttype) this)
inherited

Definition at line 59 of file tsp-mvt.f90.

◆ mvt_bd()

procedure tspmvtmodule::tspmvttype::mvt_bd ( class(tspmvttype) this)
inherited

Definition at line 65 of file tsp-mvt.f90.

◆ mvt_cc()

procedure tspmvtmodule::tspmvttype::mvt_cc ( class(tspmvttype) this,
integer(i4b), intent(in) kiter,
integer(i4b), intent(in) iend,
integer(i4b), intent(in) icnvgmod,
character(len=lenpakloc), intent(inout) cpak,
real(dp), intent(inout) dpak )
inherited

Definition at line 64 of file tsp-mvt.f90.

◆ mvt_da() [1/2]

procedure tspexchangemovermodule::tspexchangemovertype::mvt_da ( class(tspexchangemovertype) this)

Definition at line 26 of file TspExchangeMover.f90.

◆ mvt_da() [2/2]

procedure tspmvtmodule::tspmvttype::mvt_da ( class(tspmvttype) this)
inherited

Method to deallocate memory for the package.

Definition at line 69 of file tsp-mvt.f90.

◆ mvt_df()

procedure tspmvtmodule::tspmvttype::mvt_df ( class(tspmvttype) this,
class(disbasetype), intent(in), pointer dis )
inherited

Definition at line 58 of file tsp-mvt.f90.

◆ mvt_fc() [1/2]

procedure tspexchangemovermodule::tspexchangemovertype::mvt_fc ( class(tspexchangemovertype) this,
real(dp), dimension(:), intent(in), target, contiguous cnew1,
real(dp), dimension(:), intent(in), target, contiguous cnew2 )

Definition at line 25 of file TspExchangeMover.f90.

◆ mvt_fc() [2/2]

procedure tspmvtmodule::tspmvttype::mvt_fc ( class(tspmvttype) this,
real(dp), dimension(:), intent(in), target, contiguous cnew1,
real(dp), dimension(:), intent(in), target, contiguous cnew2 )
inherited

The mvt package adds the mass flow rate to the provider qmfrommvr array. The advanced packages know enough to subtract any mass that is leaving, so the mvt just adds mass coming in from elsewhere. Because the movers change by stress period, their solute effects must be added to the right- hand side of the transport matrix equations.

Definition at line 61 of file tsp-mvt.f90.

◆ mvt_fill_budobj()

procedure tspmvtmodule::tspmvttype::mvt_fill_budobj ( class(tspmvttype) this)
inherited

Definition at line 73 of file tsp-mvt.f90.

◆ mvt_fill_mvrterm()

procedure tspmvtmodule::tspmvttype::mvt_fill_mvrterm ( class(tspmvttype) this,
real(dp), dimension(:), intent(in), target, contiguous cnew1,
real(dp), dimension(:), intent(in), target, contiguous cnew2 )
inherited

Definition at line 62 of file tsp-mvt.f90.

◆ mvt_init()

procedure tspmvtmodule::tspmvttype::mvt_init ( class(tspmvttype) this,
character(len=*), intent(in) name_model,
integer(i4b), intent(in) inunit,
integer(i4b), intent(in) iout,
type(tspfmitype), intent(in), pointer fmi1,
real(dp), intent(in), pointer eqnsclfac,
character(len=lenvarname), intent(in) depvartype,
character(len=*), intent(in), optional gwfmodelname1,
character(len=*), intent(in), optional gwfmodelname2,
type(tspfmitype), intent(in), optional, pointer fmi2 )
inherited
Parameters
[in]eqnsclfacgoverning equation scale factor
[in]depvartypedependent variable type ('concentration' or 'temperature')

Definition at line 57 of file tsp-mvt.f90.

◆ mvt_ot_bdsummary()

procedure tspmvtmodule::tspmvttype::mvt_ot_bdsummary ( class(tspmvttype) this,
integer(i4b), intent(in) ibudfl )
inherited

Definition at line 68 of file tsp-mvt.f90.

◆ mvt_ot_printflow()

procedure tspmvtmodule::tspmvttype::mvt_ot_printflow ( class(tspmvttype) this,
integer(i4b), intent(in) icbcfl,
integer(i4b), intent(in) ibudfl )
inherited

Definition at line 67 of file tsp-mvt.f90.

◆ mvt_ot_saveflow()

procedure tspmvtmodule::tspmvttype::mvt_ot_saveflow ( class(tspmvttype) this,
integer(i4b), intent(in) icbcfl,
integer(i4b), intent(in) ibudfl )
inherited

Definition at line 66 of file tsp-mvt.f90.

◆ mvt_print_outputtab()

procedure, private tspmvtmodule::tspmvttype::mvt_print_outputtab ( class(tspmvttype), intent(inout) this)
privateinherited

Definition at line 78 of file tsp-mvt.f90.

◆ mvt_rp() [1/2]

procedure tspexchangemovermodule::tspexchangemovertype::mvt_rp ( class(tspexchangemovertype) this)

Definition at line 23 of file TspExchangeMover.f90.

◆ mvt_rp() [2/2]

procedure tspmvtmodule::tspmvttype::mvt_rp ( class(tspmvttype) this)
inherited

Definition at line 60 of file tsp-mvt.f90.

◆ mvt_scan_mvrbudobj()

procedure tspmvtmodule::tspmvttype::mvt_scan_mvrbudobj ( class(tspmvttype) this)
inherited

Scan through the gwf water mover budget object and determine the maximum number of packages and unique package names

Definition at line 74 of file tsp-mvt.f90.

◆ mvt_setup_budobj()

procedure tspmvtmodule::tspmvttype::mvt_setup_budobj ( class(tspmvttype) this)
inherited

Definition at line 72 of file tsp-mvt.f90.

◆ mvt_setup_outputtab()

procedure, private tspmvtmodule::tspmvttype::mvt_setup_outputtab ( class(tspmvttype), intent(inout) this)
privateinherited

Definition at line 77 of file tsp-mvt.f90.

◆ mvt_update_qmfrommvr()

procedure tspmvtmodule::tspmvttype::mvt_update_qmfrommvr ( class(tspmvttype) this)
inherited

Definition at line 63 of file tsp-mvt.f90.

◆ read_check_ionper()

procedure numericalpackagemodule::numericalpackagetype::read_check_ionper ( class(numericalpackagetype), intent(inout) this)
inherited

Generic method to read and check ionperiod, which is used to determine if new period data should be read from the input file. The check of ionperiod also makes sure periods are increasing in subsequent period data blocks.

Parameters
[in,out]thisNumericalPackageType object

Definition at line 56 of file NumericalPackage.f90.

◆ read_options()

procedure tspmvtmodule::tspmvttype::read_options ( class(tspmvttype) this)
inherited

Definition at line 71 of file tsp-mvt.f90.

◆ set_fmi()

procedure tspmvtmodule::tspmvttype::set_fmi ( class(tspmvttype) this,
integer(i4b), intent(in) ibudterm,
type(tspfmitype), pointer fmi,
logical(lgp) set_provider )
inherited
Parameters
set_providerset provider fmi when true, receiver fmi otherwise

Definition at line 76 of file tsp-mvt.f90.

◆ set_names()

procedure numericalpackagemodule::numericalpackagetype::set_names ( class(numericalpackagetype), intent(inout) this,
integer(i4b), intent(in) ibcnum,
character(len=*), intent(in) name_model,
character(len=*), intent(in) pakname,
character(len=*), intent(in) ftype,
character(len=*), intent(in), optional input_mempath )
inherited

Method to assign the filtyp (ftype), the model name, and package name for a package. This method also creates the memoryPath and memoryPathModel that is used by the memory manager when variables are allocated.

Parameters
[in,out]thisNumericalPackageType object
[in]ibcnumunique package number
[in]name_modelname of the model
[in]paknamename of the package
[in]ftypepackage type

Definition at line 53 of file NumericalPackage.f90.

◆ set_pointer_mvrbudobj()

procedure tspmvtmodule::tspmvttype::set_pointer_mvrbudobj ( class(tspmvttype) this,
type(budgetobjecttype), intent(in), target mvrbudobj )
inherited

Store a pointer to mvrbudobj, which contains the simulated water mover flows from either a gwf model MVR package or from a gwf-gwf exchange MVR package.

Definition at line 75 of file tsp-mvt.f90.

◆ xmvt_cf()

procedure tspexchangemovermodule::tspexchangemovertype::xmvt_cf ( class(tspexchangemovertype) this,
real(dp), dimension(:), intent(in), target, contiguous cnew1,
real(dp), dimension(:), intent(in), target, contiguous cnew2 )

Definition at line 24 of file TspExchangeMover.f90.

Member Data Documentation

◆ budget

type(budgettype), pointer tspmvtmodule::tspmvttype::budget => null()
inherited

Definition at line 43 of file tsp-mvt.f90.

◆ budobj

type(budgetobjecttype), pointer tspmvtmodule::tspmvttype::budobj => null()
inherited

Definition at line 44 of file tsp-mvt.f90.

◆ depvartype

character(len=lenvarname) tspmvtmodule::tspmvttype::depvartype = ''
inherited

Definition at line 48 of file tsp-mvt.f90.

◆ dis

class(disbasetype), pointer numericalpackagemodule::numericalpackagetype::dis => null()
inherited

Definition at line 50 of file NumericalPackage.f90.

◆ eqnsclfac

real(dp), pointer tspmvtmodule::tspmvttype::eqnsclfac => null()
inherited

Definition at line 40 of file tsp-mvt.f90.

◆ filtyp

character(len=lenftype) numericalpackagemodule::numericalpackagetype::filtyp = ''
inherited

Definition at line 33 of file NumericalPackage.f90.

◆ fmi1

type(tspfmitype), pointer tspmvtmodule::tspmvttype::fmi1 => null()
inherited

Definition at line 41 of file tsp-mvt.f90.

◆ fmi2

type(tspfmitype), pointer tspmvtmodule::tspmvttype::fmi2 => null()
inherited

Definition at line 42 of file tsp-mvt.f90.

◆ gwfmodelname1

character(len=lenmodelname) tspmvtmodule::tspmvttype::gwfmodelname1 = ''
inherited

Definition at line 35 of file tsp-mvt.f90.

◆ gwfmodelname2

character(len=lenmodelname) tspmvtmodule::tspmvttype::gwfmodelname2 = ''
inherited

Definition at line 36 of file tsp-mvt.f90.

◆ iasym

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iasym => null()
inherited

Definition at line 41 of file NumericalPackage.f90.

◆ ibudcsv

integer(i4b), pointer tspmvtmodule::tspmvttype::ibudcsv => null()
inherited

Definition at line 39 of file tsp-mvt.f90.

◆ ibudgetout

integer(i4b), pointer tspmvtmodule::tspmvttype::ibudgetout => null()
inherited

Definition at line 38 of file tsp-mvt.f90.

◆ id

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::id => null()
inherited

Definition at line 37 of file NumericalPackage.f90.

◆ inewton

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::inewton => null()
inherited

Definition at line 40 of file NumericalPackage.f90.

◆ input_fname

character(len=linelength), pointer numericalpackagemodule::numericalpackagetype::input_fname => null()
inherited

Definition at line 32 of file NumericalPackage.f90.

◆ input_mempath

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::input_mempath = ''
inherited

Definition at line 31 of file NumericalPackage.f90.

◆ inunit

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::inunit => null()
inherited

Definition at line 38 of file NumericalPackage.f90.

◆ ionper

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::ionper => null()
inherited

Definition at line 45 of file NumericalPackage.f90.

◆ iout

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iout => null()
inherited

Definition at line 39 of file NumericalPackage.f90.

◆ ipakcb

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::ipakcb => null()
inherited

Definition at line 44 of file NumericalPackage.f90.

◆ iprflow

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iprflow => null()
inherited

Definition at line 43 of file NumericalPackage.f90.

◆ iprpak

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iprpak => null()
inherited

Definition at line 42 of file NumericalPackage.f90.

◆ lastonper

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::lastonper => null()
inherited

Definition at line 46 of file NumericalPackage.f90.

◆ maxmvt

integer(i4b), pointer tspexchangemovermodule::tspexchangemovertype::maxmvt => null()

Definition at line 19 of file TspExchangeMover.f90.

◆ maxpackages

integer(i4b), pointer tspmvtmodule::tspmvttype::maxpackages
inherited

Definition at line 37 of file tsp-mvt.f90.

37 integer(I4B), pointer :: maxpackages !< max number of packages

◆ memorypath

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::memorypath = ''
inherited

Definition at line 28 of file NumericalPackage.f90.

◆ memorypathmodel

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::memorypathmodel = ''
inherited

Definition at line 29 of file NumericalPackage.f90.

◆ model1

class(virtualmodeltype), pointer tspexchangemovermodule::tspexchangemovertype::model1 => null()

Definition at line 17 of file TspExchangeMover.f90.

◆ model2

class(virtualmodeltype), pointer tspexchangemovermodule::tspexchangemovertype::model2 => null()

Definition at line 18 of file TspExchangeMover.f90.

◆ mvrbudobj

type(budgetobjecttype), pointer tspmvtmodule::tspmvttype::mvrbudobj => null()
inherited

Definition at line 45 of file tsp-mvt.f90.

◆ mvrterm

type(mvrtermtype), dimension(:), pointer, contiguous tspmvtmodule::tspmvttype::mvrterm => null()
inherited

Definition at line 54 of file tsp-mvt.f90.

◆ name_model

character(len=lenmodelname) numericalpackagemodule::numericalpackagetype::name_model = ''
inherited

Definition at line 26 of file NumericalPackage.f90.

◆ outputtab

type(tabletype), pointer tspmvtmodule::tspmvttype::outputtab => null()
inherited

Definition at line 51 of file tsp-mvt.f90.

◆ package_type

character(len=lenftype), pointer numericalpackagemodule::numericalpackagetype::package_type => null()
inherited

Definition at line 34 of file NumericalPackage.f90.

◆ packname

character(len=lenpackagename) numericalpackagemodule::numericalpackagetype::packname = ''
inherited

Definition at line 27 of file NumericalPackage.f90.

◆ paknames

character(len=lenpackagename), dimension(:), pointer, contiguous tspmvtmodule::tspmvttype::paknames => null()
inherited

Definition at line 46 of file tsp-mvt.f90.

◆ parser

type(blockparsertype) numericalpackagemodule::numericalpackagetype::parser
inherited

Definition at line 49 of file NumericalPackage.f90.

49 type(BlockParserType) :: parser !< parser object for reading blocks of information

◆ quantity_m1

real(dp), dimension(:), pointer, contiguous tspexchangemovermodule::tspexchangemovertype::quantity_m1 => null()

Definition at line 20 of file TspExchangeMover.f90.

◆ quantity_m2

real(dp), dimension(:), pointer, contiguous tspexchangemovermodule::tspexchangemovertype::quantity_m2 => null()

Definition at line 21 of file TspExchangeMover.f90.


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