MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
Inheritance diagram for gwfmvrmodule::gwfmvrtype:
Inheritance graph
Collaboration diagram for gwfmvrmodule::gwfmvrtype:
Collaboration graph

Public Member Functions

procedure mvr_init (this, name_parent, inunit, iout, dis, iexgmvr)
procedure mvr_ar (this)
 Allocate and read water mover information.
procedure mvr_rp (this)
 Read and Prepare.
procedure mvr_ad (this)
procedure mvr_fc (this)
 Calculate qfrommvr as a function of qtomvr.
procedure mvr_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak)
 Extra convergence check for mover.
procedure mvr_bd (this)
 Fill the mover budget object.
procedure mvr_bdsav (this, icbcfl, ibudfl, isuppress_output)
 Write mover terms.
procedure mvr_ot_saveflow (this, icbcfl, ibudfl)
 Write mover terms.
procedure mvr_ot_printflow (this, icbcfl, ibudfl)
 Print mover flow table.
procedure mvr_ot_bdsummary (this, ibudfl)
 Write mover budget to listing file.
procedure mvr_da (this)
 Deallocate.
procedure read_options (this)
 Read options specified in the input options block.
procedure check_options (this)
 Check MODELNAMES option set correctly.
procedure read_dimensions (this)
 Read the dimensions for this package.
procedure read_packages (this)
 Read the packages that will be managed by this mover.
procedure check_packages (this)
 Check to make sure packages have mover activated.
procedure assign_packagemovers (this)
 Assign pointer to each package's packagemover object.
procedure initialize_movers (this, nr_active_movers)
procedure fill_budobj (this)
 Fill budget object.
procedure allocate_scalars (this)
 Allocate package scalars.
procedure allocate_arrays (this)
 Allocate package arrays.
procedure set_names (this, ibcnum, name_model, pakname, ftype, input_mempath)
 Set package names.
procedure allocate_scalars (this)
 Allocate package scalars.
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

logical(lgp), pointer reset_mapped_id
integer(i4b), pointer ibudgetout => null()
 binary budget output file
integer(i4b), pointer ibudcsv => null()
 unit number for csv budget output file
integer(i4b), pointer maxmvr => null()
 max number of movers to be specified
integer(i4b), pointer maxpackages => null()
 max number of packages to be specified
integer(i4b), pointer maxcomb => null()
 max number of combination of packages
integer(i4b), pointer nmvr => null()
 number of movers for current stress period
integer(i4b), pointer iexgmvr => null()
 indicate mover is for an exchange (not for a single model)
integer(i4b), pointer imodelnames => null()
 indicate package input file has model names in it
integer(i4b), dimension(:), pointer, contiguous ientries => null()
 number of entries for each combination
character(len=lenmempath), dimension(:), pointer, contiguous pckmempaths
 memory paths of all packages used in this mover
character(len=lenpackagename), dimension(:), pointer, contiguous paknames => null()
 array of package names
type(mvrtype), dimension(:), pointer, contiguous mvr => null()
 array of movers
type(gwfmvrperioddatatype), pointer gwfmvrperioddata => null()
 input data object
type(budgettype), pointer budget => null()
 mover budget object (used to write table)
type(budgetobjecttype), pointer budobj => null()
 new budget container (used to write binary file)
type(packagemovertype), dimension(:), pointer, contiguous pakmovers => null()
 pointer to package mover objects
type(tabletype), pointer outputtab => null()
logical(lgp) suppress_fileout = .false.
 flag to disable output file (budget, budget csv)
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 mvr_setup_budobj (this)
 Set up the budget object that stores all the mvr flows.
procedure, private mvr_setup_outputtab (this)
 Set up output table.
procedure, private mvr_print_outputtab (this)
 Set up output table.
procedure, private set_mapped_id (this)
 Set mapped id.

Detailed Description

Definition at line 125 of file gwf-mvr.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure gwfmvrmodule::gwfmvrtype::allocate_arrays ( class(gwfmvrtype) this)

Definition at line 173 of file gwf-mvr.f90.

◆ allocate_scalars() [1/2]

procedure gwfmvrmodule::gwfmvrtype::allocate_scalars ( class(gwfmvrtype) this)

Definition at line 172 of file gwf-mvr.f90.

◆ allocate_scalars() [2/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.

◆ assign_packagemovers()

procedure gwfmvrmodule::gwfmvrtype::assign_packagemovers ( class(gwfmvrtype), intent(inout) this)

Definition at line 169 of file gwf-mvr.f90.

◆ check_options()

procedure gwfmvrmodule::gwfmvrtype::check_options ( class(gwfmvrtype) this)

Definition at line 165 of file gwf-mvr.f90.

◆ check_packages()

procedure gwfmvrmodule::gwfmvrtype::check_packages ( class(gwfmvrtype), intent(inout) this)

Definition at line 168 of file gwf-mvr.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.

◆ fill_budobj()

procedure gwfmvrmodule::gwfmvrtype::fill_budobj ( class(gwfmvrtype) this)

Definition at line 171 of file gwf-mvr.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.

◆ initialize_movers()

procedure gwfmvrmodule::gwfmvrtype::initialize_movers ( class(gwfmvrtype) this,
integer(i4b) nr_active_movers )

Definition at line 170 of file gwf-mvr.f90.

◆ mvr_ad()

procedure gwfmvrmodule::gwfmvrtype::mvr_ad ( class(gwfmvrtype) this)

Definition at line 155 of file gwf-mvr.f90.

◆ mvr_ar()

procedure gwfmvrmodule::gwfmvrtype::mvr_ar ( class(gwfmvrtype) this)

Definition at line 153 of file gwf-mvr.f90.

◆ mvr_bd()

procedure gwfmvrmodule::gwfmvrtype::mvr_bd ( class(gwfmvrtype) this)

Definition at line 158 of file gwf-mvr.f90.

◆ mvr_bdsav()

procedure gwfmvrmodule::gwfmvrtype::mvr_bdsav ( class(gwfmvrtype) this,
integer(i4b), intent(in) icbcfl,
integer(i4b), intent(in) ibudfl,
integer(i4b), intent(in) isuppress_output )

Definition at line 159 of file gwf-mvr.f90.

◆ mvr_cc()

procedure gwfmvrmodule::gwfmvrtype::mvr_cc ( class(gwfmvrtype) this,
integer(i4b), intent(in) innertot,
integer(i4b), intent(in) kiter,
integer(i4b), intent(in) iend,
integer(i4b), intent(in) icnvgmod,
character(len=lenpakloc), intent(inout) cpak,
integer(i4b), intent(inout) ipak,
real(dp), intent(inout) dpak )

Definition at line 157 of file gwf-mvr.f90.

◆ mvr_da()

procedure gwfmvrmodule::gwfmvrtype::mvr_da ( class(gwfmvrtype) this)

Definition at line 163 of file gwf-mvr.f90.

◆ mvr_fc()

procedure gwfmvrmodule::gwfmvrtype::mvr_fc ( class(gwfmvrtype) this)

Definition at line 156 of file gwf-mvr.f90.

◆ mvr_init()

procedure gwfmvrmodule::gwfmvrtype::mvr_init ( class(gwfmvrtype) this,
character(len=*), intent(in) name_parent,
integer(i4b), intent(in) inunit,
integer(i4b), intent(in) iout,
class(disbasetype), intent(in), pointer dis,
integer(i4b), optional iexgmvr )

Definition at line 152 of file gwf-mvr.f90.

◆ mvr_ot_bdsummary()

procedure gwfmvrmodule::gwfmvrtype::mvr_ot_bdsummary ( class(gwfmvrtype) this,
integer(i4b), intent(in) ibudfl )

Definition at line 162 of file gwf-mvr.f90.

◆ mvr_ot_printflow()

procedure gwfmvrmodule::gwfmvrtype::mvr_ot_printflow ( class(gwfmvrtype) this,
integer(i4b), intent(in) icbcfl,
integer(i4b), intent(in) ibudfl )

Definition at line 161 of file gwf-mvr.f90.

◆ mvr_ot_saveflow()

procedure gwfmvrmodule::gwfmvrtype::mvr_ot_saveflow ( class(gwfmvrtype) this,
integer(i4b), intent(in) icbcfl,
integer(i4b), intent(in) ibudfl )

Definition at line 160 of file gwf-mvr.f90.

◆ mvr_print_outputtab()

procedure, private gwfmvrmodule::gwfmvrtype::mvr_print_outputtab ( class(gwfmvrtype), intent(inout) this)
private

Definition at line 176 of file gwf-mvr.f90.

◆ mvr_rp()

procedure gwfmvrmodule::gwfmvrtype::mvr_rp ( class(gwfmvrtype), intent(inout) this)

Read itmp and read new boundaries if itmp > 0

Definition at line 154 of file gwf-mvr.f90.

◆ mvr_setup_budobj()

procedure, private gwfmvrmodule::gwfmvrtype::mvr_setup_budobj ( class(gwfmvrtype) this)
private

Definition at line 174 of file gwf-mvr.f90.

◆ mvr_setup_outputtab()

procedure, private gwfmvrmodule::gwfmvrtype::mvr_setup_outputtab ( class(gwfmvrtype), intent(inout) this)
private

Definition at line 175 of file gwf-mvr.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_dimensions()

procedure gwfmvrmodule::gwfmvrtype::read_dimensions ( class(gwfmvrtype), intent(inout) this)

Definition at line 166 of file gwf-mvr.f90.

◆ read_options()

procedure gwfmvrmodule::gwfmvrtype::read_options ( class(gwfmvrtype) this)

Definition at line 164 of file gwf-mvr.f90.

◆ read_packages()

procedure gwfmvrmodule::gwfmvrtype::read_packages ( class(gwfmvrtype), intent(inout) this)

Definition at line 167 of file gwf-mvr.f90.

◆ set_mapped_id()

procedure, private gwfmvrmodule::gwfmvrtype::set_mapped_id ( class(gwfmvrtype) this)
private

For the budget output, we don't write outlet number, instead we write the lake number. Normally the receiver number is the same as the feature number provided by the user. For moving water from a lake, the user specifies the outlet number, not the lake number, in the mover package. The iRchNrSrcMapped variable contains the lake number, not the outlet number, and is written to the budget files. For other packages, the iRchNrSrcMapped value is simply the well number, the stream reach, or the uzf cell number. This routine needs to be called each time a new set of movers is read. It can't be called from within mvr_rp because the iprmap isn't updated by lake until lak_rp, which is called after mvr_rp.

Definition at line 177 of file gwf-mvr.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.

Member Data Documentation

◆ budget

type(budgettype), pointer gwfmvrmodule::gwfmvrtype::budget => null()

Definition at line 142 of file gwf-mvr.f90.

◆ budobj

type(budgetobjecttype), pointer gwfmvrmodule::gwfmvrtype::budobj => null()

Definition at line 143 of file gwf-mvr.f90.

◆ dis

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

Definition at line 50 of file NumericalPackage.f90.

◆ filtyp

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

Definition at line 33 of file NumericalPackage.f90.

◆ gwfmvrperioddata

type(gwfmvrperioddatatype), pointer gwfmvrmodule::gwfmvrtype::gwfmvrperioddata => null()

Definition at line 141 of file gwf-mvr.f90.

◆ iasym

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

Definition at line 41 of file NumericalPackage.f90.

◆ ibudcsv

integer(i4b), pointer gwfmvrmodule::gwfmvrtype::ibudcsv => null()

Definition at line 128 of file gwf-mvr.f90.

◆ ibudgetout

integer(i4b), pointer gwfmvrmodule::gwfmvrtype::ibudgetout => null()

Definition at line 127 of file gwf-mvr.f90.

◆ id

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

Definition at line 37 of file NumericalPackage.f90.

◆ ientries

integer(i4b), dimension(:), pointer, contiguous gwfmvrmodule::gwfmvrtype::ientries => null()

Definition at line 135 of file gwf-mvr.f90.

◆ iexgmvr

integer(i4b), pointer gwfmvrmodule::gwfmvrtype::iexgmvr => null()

Definition at line 133 of file gwf-mvr.f90.

◆ imodelnames

integer(i4b), pointer gwfmvrmodule::gwfmvrtype::imodelnames => null()

Definition at line 134 of file gwf-mvr.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.

◆ maxcomb

integer(i4b), pointer gwfmvrmodule::gwfmvrtype::maxcomb => null()

Definition at line 131 of file gwf-mvr.f90.

◆ maxmvr

integer(i4b), pointer gwfmvrmodule::gwfmvrtype::maxmvr => null()

Definition at line 129 of file gwf-mvr.f90.

◆ maxpackages

integer(i4b), pointer gwfmvrmodule::gwfmvrtype::maxpackages => null()

Definition at line 130 of file gwf-mvr.f90.

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

◆ mvr

type(mvrtype), dimension(:), pointer, contiguous gwfmvrmodule::gwfmvrtype::mvr => null()

Definition at line 140 of file gwf-mvr.f90.

◆ name_model

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

Definition at line 26 of file NumericalPackage.f90.

◆ nmvr

integer(i4b), pointer gwfmvrmodule::gwfmvrtype::nmvr => null()

Definition at line 132 of file gwf-mvr.f90.

◆ outputtab

type(tabletype), pointer gwfmvrmodule::gwfmvrtype::outputtab => null()

Definition at line 148 of file gwf-mvr.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.

◆ pakmovers

type(packagemovertype), dimension(:), pointer, contiguous gwfmvrmodule::gwfmvrtype::pakmovers => null()

Definition at line 144 of file gwf-mvr.f90.

◆ paknames

character(len=lenpackagename), dimension(:), pointer, contiguous gwfmvrmodule::gwfmvrtype::paknames => null()

Definition at line 138 of file gwf-mvr.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

◆ pckmempaths

character(len=lenmempath), dimension(:), pointer, contiguous gwfmvrmodule::gwfmvrtype::pckmempaths

Definition at line 136 of file gwf-mvr.f90.

136 character(len=LENMEMPATH), &
137 dimension(:), pointer, contiguous :: pckMemPaths !< memory paths of all packages used in this mover

◆ reset_mapped_id

logical(lgp), pointer gwfmvrmodule::gwfmvrtype::reset_mapped_id

Definition at line 126 of file gwf-mvr.f90.

126 logical(LGP), pointer :: reset_mapped_id ! flag to indicate mapped ids must be reset; true when movers change

◆ suppress_fileout

logical(lgp) gwfmvrmodule::gwfmvrtype::suppress_fileout = .false.

Definition at line 149 of file gwf-mvr.f90.


The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Model/GroundWaterFlow/gwf-mvr.f90