Inheritance diagram for gwfmvrmodule::gwfmvrtype:

Collaboration diagram for gwfmvrmodule::gwfmvrtype:

Private Member Functions
procedure	mvr_init

procedure	mvr_ar

procedure	mvr_rp

procedure	mvr_ad

procedure	mvr_fc

procedure	mvr_cc

procedure	mvr_bd

procedure	mvr_bdsav

procedure	mvr_ot_saveflow

procedure	mvr_ot_printflow

procedure	mvr_ot_bdsummary

procedure	mvr_da

procedure	read_options

procedure	check_options

procedure	read_dimensions

procedure	read_packages

procedure	check_packages

procedure	assign_packagemovers

procedure	initialize_movers

procedure	fill_budobj

procedure	allocate_scalars

procedure	allocate_arrays

procedure, private	mvr_setup_budobj

procedure, private	mvr_setup_outputtab

procedure, private	mvr_print_outputtab

procedure, private	set_mapped_id

procedure	set_names

procedure	da

procedure	read_check_ionper

procedure	get_block_data

Private Attributes
logical(lgp), pointer	reset_mapped_id

integer(i4b), pointer	ibudgetout => null()
	binary budget output file More...

integer(i4b), pointer	ibudcsv => null()
	unit number for csv budget output file More...

integer(i4b), pointer	maxmvr => null()
	max number of movers to be specified More...

integer(i4b), pointer	maxpackages => null()
	max number of packages to be specified More...

integer(i4b), pointer	maxcomb => null()
	max number of combination of packages More...

integer(i4b), pointer	nmvr => null()
	number of movers for current stress period More...

integer(i4b), pointer	iexgmvr => null()
	indicate mover is for an exchange (not for a single model) More...

integer(i4b), pointer	imodelnames => null()
	indicate package input file has model names in it More...

integer(i4b), dimension(:), pointer, contiguous	ientries => null()
	number of entries for each combination More...

character(len=lenmempath), dimension(:), pointer, contiguous	pckmempaths
	memory paths of all packages used in this mover More...

character(len=lenpackagename), dimension(:), pointer, contiguous	paknames => null()
	array of package names More...

type(mvrtype), dimension(:), pointer, contiguous	mvr => null()
	array of movers More...

type(gwfmvrperioddatatype), pointer	gwfmvrperioddata => null()
	input data object More...

type(budgettype), pointer	budget => null()
	mover budget object (used to write table) More...

type(budgetobjecttype), pointer	budobj => null()
	new budget container (used to write binary file) More...

type(packagemovertype), dimension(:), pointer, contiguous	pakmovers => null()
	pointer to package mover objects More...

type(tabletype), pointer	outputtab => null()

logical(lgp)	suppress_fileout = .false.
	flag to disable output file (budget, budget csv) More...

character(len=lenmodelname)	name_model = ''
	the name of the model that contains this package More...

character(len=lenpackagename)	packname = ''
	name of the package More...

character(len=lenmempath)	memorypath = ''
	the location in the memory manager where the variables are stored More...

character(len=lenmempath)	memorypathmodel = ''
	the location in the memory manager where the variables of the parent model are stored More...

character(len=lenmempath)	input_mempath = ''
	input context mempath More...

character(len=linelength), pointer	input_fname => null()
	input file name More...

character(len=lenftype)	filtyp = ''
	file type (CHD, DRN, RIV, etc.) More...

character(len=lenftype), pointer	package_type => null()
	package type (same as filtyp) stored in memory manager More...

integer(i4b), pointer	id => null()
	consecutive package number in model More...

integer(i4b), pointer	inunit => null()
	unit number for input file More...

integer(i4b), pointer	iout => null()
	unit number for writing package output More...

integer(i4b), pointer	inewton => null()
	newton flag More...

integer(i4b), pointer	iasym => null()
	package causes matrix asymmetry More...

integer(i4b), pointer	iprpak => null()
	integer flag to echo input More...

integer(i4b), pointer	iprflow => null()
	flag to print simulated flows More...

integer(i4b), pointer	ipakcb => null()
	output flows (-1, 0, 1) - save_flows More...

integer(i4b), pointer	ionper => null()
	stress period for next data More...

integer(i4b), pointer	lastonper => null()
	last value of ionper (for checking) More...

type(blockparsertype)	parser
	parser object for reading blocks of information More...

class(disbasetype), pointer	dis => null()
	model discretization object More...

Detailed Description

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

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure gwfmvrmodule::gwfmvrtype::allocate_arrays

private

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

◆ allocate_scalars()

procedure gwfmvrmodule::gwfmvrtype::allocate_scalars

private

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

◆ assign_packagemovers()

procedure gwfmvrmodule::gwfmvrtype::assign_packagemovers

private

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

◆ check_options()

procedure gwfmvrmodule::gwfmvrtype::check_options

private

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

◆ check_packages()

procedure gwfmvrmodule::gwfmvrtype::check_packages

private

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

◆ da()

procedure numericalpackagemodule::numericalpackagetype::da

privateinherited

Definition at line 55 of file NumericalPackage.f90.

◆ fill_budobj()

procedure gwfmvrmodule::gwfmvrtype::fill_budobj

private

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

◆ get_block_data()

procedure numericalpackagemodule::numericalpackagetype::get_block_data

privateinherited

Definition at line 57 of file NumericalPackage.f90.

◆ initialize_movers()

procedure gwfmvrmodule::gwfmvrtype::initialize_movers

private

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

◆ mvr_ad()

procedure gwfmvrmodule::gwfmvrtype::mvr_ad

private

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

◆ mvr_ar()

procedure gwfmvrmodule::gwfmvrtype::mvr_ar

private

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

◆ mvr_bd()

procedure gwfmvrmodule::gwfmvrtype::mvr_bd

private

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

◆ mvr_bdsav()

procedure gwfmvrmodule::gwfmvrtype::mvr_bdsav

private

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

◆ mvr_cc()

procedure gwfmvrmodule::gwfmvrtype::mvr_cc

private

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

◆ mvr_da()

procedure gwfmvrmodule::gwfmvrtype::mvr_da

private

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

◆ mvr_fc()

procedure gwfmvrmodule::gwfmvrtype::mvr_fc

private

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

◆ mvr_init()

procedure gwfmvrmodule::gwfmvrtype::mvr_init

private

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

◆ mvr_ot_bdsummary()

procedure gwfmvrmodule::gwfmvrtype::mvr_ot_bdsummary

private

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

◆ mvr_ot_printflow()

procedure gwfmvrmodule::gwfmvrtype::mvr_ot_printflow

private

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

◆ mvr_ot_saveflow()

procedure gwfmvrmodule::gwfmvrtype::mvr_ot_saveflow

private

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

◆ mvr_print_outputtab()

procedure, private gwfmvrmodule::gwfmvrtype::mvr_print_outputtab

private

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

◆ mvr_rp()

procedure gwfmvrmodule::gwfmvrtype::mvr_rp

private

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

◆ mvr_setup_budobj()

procedure, private gwfmvrmodule::gwfmvrtype::mvr_setup_budobj

private

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

◆ mvr_setup_outputtab()

procedure, private gwfmvrmodule::gwfmvrtype::mvr_setup_outputtab

private

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

◆ read_check_ionper()

procedure numericalpackagemodule::numericalpackagetype::read_check_ionper

privateinherited

Definition at line 56 of file NumericalPackage.f90.

◆ read_dimensions()

procedure gwfmvrmodule::gwfmvrtype::read_dimensions

private

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

◆ read_options()

procedure gwfmvrmodule::gwfmvrtype::read_options

private

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

◆ read_packages()

procedure gwfmvrmodule::gwfmvrtype::read_packages

private

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

◆ set_mapped_id()

procedure, private gwfmvrmodule::gwfmvrtype::set_mapped_id

private

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

◆ set_names()

procedure numericalpackagemodule::numericalpackagetype::set_names

privateinherited

Definition at line 53 of file NumericalPackage.f90.

Member Data Documentation

◆ budget

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

private

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

142 type(BudgetType), pointer :: budget => null() !< mover budget object (used to write table)

◆ budobj

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

private

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

143 type(BudgetObjectType), pointer :: budobj => null() !< new budget container (used to write binary file)

◆ dis

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

privateinherited

Definition at line 50 of file NumericalPackage.f90.

50 class(DisBaseType), pointer :: dis => null() !< model discretization object

◆ filtyp

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

privateinherited

Definition at line 33 of file NumericalPackage.f90.

33 character(len=LENFTYPE) :: filtyp = '' !< file type (CHD, DRN, RIV, etc.)

◆ gwfmvrperioddata

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

private

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

141 type(GwfMvrPeriodDataType), pointer :: gwfmvrperioddata => null() !< input data object

◆ iasym

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

privateinherited

Definition at line 41 of file NumericalPackage.f90.

41 integer(I4B), pointer :: iasym => null() !< package causes matrix asymmetry

◆ ibudcsv

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

private

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

128 integer(I4B), pointer :: ibudcsv => null() !< unit number for csv budget output file

◆ ibudgetout

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

private

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

127 integer(I4B), pointer :: ibudgetout => null() !< binary budget output file

◆ id

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

privateinherited

Definition at line 37 of file NumericalPackage.f90.

37 integer(I4B), pointer :: id => null() !< consecutive package number in model

◆ ientries

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

private

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

135 integer(I4B), dimension(:), pointer, contiguous :: ientries => null() !< number of entries for each combination

◆ iexgmvr

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

private

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

133 integer(I4B), pointer :: iexgmvr => null() !< indicate mover is for an exchange (not for a single model)

◆ imodelnames

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

private

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

134 integer(I4B), pointer :: imodelnames => null() !< indicate package input file has model names in it

◆ inewton

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

privateinherited

Definition at line 40 of file NumericalPackage.f90.

40 integer(I4B), pointer :: inewton => null() !< newton flag

◆ input_fname

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

privateinherited

Definition at line 32 of file NumericalPackage.f90.

32 character(len=LINELENGTH), pointer :: input_fname => null() !< input file name

◆ input_mempath

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

privateinherited

Definition at line 31 of file NumericalPackage.f90.

31 character(len=LENMEMPATH) :: input_mempath = '' !< input context mempath

◆ inunit

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

privateinherited

Definition at line 38 of file NumericalPackage.f90.

38 integer(I4B), pointer :: inunit => null() !< unit number for input file

◆ ionper

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

privateinherited

Definition at line 45 of file NumericalPackage.f90.

45 integer(I4B), pointer :: ionper => null() !< stress period for next data

◆ iout

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

privateinherited

Definition at line 39 of file NumericalPackage.f90.

39 integer(I4B), pointer :: iout => null() !< unit number for writing package output

◆ ipakcb

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

privateinherited

Definition at line 44 of file NumericalPackage.f90.

44 integer(I4B), pointer :: ipakcb => null() !< output flows (-1, 0, 1) - save_flows

◆ iprflow

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

privateinherited

Definition at line 43 of file NumericalPackage.f90.

43 integer(I4B), pointer :: iprflow => null() !< flag to print simulated flows

◆ iprpak

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

privateinherited

Definition at line 42 of file NumericalPackage.f90.

42 integer(I4B), pointer :: iprpak => null() !< integer flag to echo input

◆ lastonper

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

privateinherited

Definition at line 46 of file NumericalPackage.f90.

46 integer(I4B), pointer :: lastonper => null() !< last value of ionper (for checking)

◆ maxcomb

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

private

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

131 integer(I4B), pointer :: maxcomb => null() !< max number of combination of packages

◆ maxmvr

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

private

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

129 integer(I4B), pointer :: maxmvr => null() !< max number of movers to be specified

◆ maxpackages

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

private

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

130 integer(I4B), pointer :: maxpackages => null() !< max number of packages to be specified

◆ memorypath

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

privateinherited

Definition at line 28 of file NumericalPackage.f90.

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

◆ memorypathmodel

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

privateinherited

Definition at line 29 of file NumericalPackage.f90.

29 character(len=LENMEMPATH) :: memoryPathModel = '' !< the location in the memory manager where the variables

◆ mvr

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

private

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

140 type(MvrType), dimension(:), pointer, contiguous :: mvr => null() !< array of movers

◆ name_model

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

privateinherited

Definition at line 26 of file NumericalPackage.f90.

26 character(len=LENMODELNAME) :: name_model = '' !< the name of the model that contains this package

◆ nmvr

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

private

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

132 integer(I4B), pointer :: nmvr => null() !< number of movers for current stress period

◆ outputtab

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

private

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

148 type(TableType), pointer :: outputtab => null()

◆ package_type

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

privateinherited

Definition at line 34 of file NumericalPackage.f90.

34 character(len=LENFTYPE), pointer :: package_type => null() !< package type (same as filtyp) stored in memory manager

◆ packname

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

privateinherited

Definition at line 27 of file NumericalPackage.f90.

27 character(len=LENPACKAGENAME) :: packName = '' !< name of the package

◆ pakmovers

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

private

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

144 type(PackageMoverType), &

145 dimension(:), pointer, contiguous :: pakmovers => null() !< pointer to package mover objects

◆ paknames

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

private

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

138 character(len=LENPACKAGENAME), &

139 dimension(:), pointer, contiguous :: paknames => null() !< array of package names

◆ parser

type(blockparsertype) numericalpackagemodule::numericalpackagetype::parser

privateinherited

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

private

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

private

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.

private

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

149 logical(LGP) :: suppress_fileout = .false. !< flag to disable output file (budget, budget csv)

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

/home/runner/work/modflow6/modflow6/src/Model/GroundWaterFlow/gwf-mvr.f90

Private Member Functions

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ allocate_arrays()

◆ allocate_scalars()

◆ assign_packagemovers()

◆ check_options()

◆ check_packages()

◆ da()

◆ fill_budobj()

◆ get_block_data()

◆ initialize_movers()

◆ mvr_ad()

◆ mvr_ar()

◆ mvr_bd()

◆ mvr_bdsav()

◆ mvr_cc()

◆ mvr_da()

◆ mvr_fc()

◆ mvr_init()

◆ mvr_ot_bdsummary()

◆ mvr_ot_printflow()

◆ mvr_ot_saveflow()

◆ mvr_print_outputtab()

◆ mvr_rp()

◆ mvr_setup_budobj()

◆ mvr_setup_outputtab()

◆ read_check_ionper()

◆ read_dimensions()

◆ read_options()

◆ read_packages()

◆ set_mapped_id()

◆ set_names()

Member Data Documentation

◆ budget

◆ budobj

◆ dis

◆ filtyp

◆ gwfmvrperioddata

◆ iasym

◆ ibudcsv

◆ ibudgetout

◆ id

◆ ientries

◆ iexgmvr

◆ imodelnames

◆ inewton

◆ input_fname

◆ input_mempath

◆ inunit

◆ ionper

◆ iout

◆ ipakcb

◆ iprflow

◆ iprpak

◆ lastonper

◆ maxcomb

◆ maxmvr

◆ maxpackages

◆ memorypath

◆ memorypathmodel

◆ mvr

◆ name_model

◆ nmvr

◆ outputtab

◆ package_type

◆ packname

◆ pakmovers

◆ paknames

◆ parser

◆ pckmempaths

◆ reset_mapped_id

◆ suppress_fileout