Particle release point (PRP) package. More...

Inheritance diagram for prtprpmodule::prtprptype:

Collaboration diagram for prtprpmodule::prtprptype:

Public Member Functions
procedure, public	bnd_obs_supported => prp_obs_supported

procedure, public	bnd_df_obs => prp_df_obs

procedure, public	bnd_bd_obs

procedure, public	bnd_ot_obs

procedure, public	bnd_rp_obs

procedure, public	bnd_rp_ts

procedure, public	bnd_activate_viscosity

Private Member Functions
procedure	prp_allocate_arrays

procedure	prp_allocate_scalars

procedure	bnd_ar => prp_ar

procedure	bnd_ad => prp_ad

procedure	bnd_rp => prp_rp

procedure	bnd_cq_simrate => prp_cq_simrate

procedure	bnd_da => prp_da

procedure	define_listlabel

procedure	prp_set_pointers

procedure	bnd_options => prp_options

procedure	read_dimensions => prp_read_dimensions

procedure	prp_read_packagedata

procedure	prp_read_releasetimes

procedure	prp_load_releasetimefrequency

procedure	release

procedure	log_release

procedure	validate_release_point

procedure	initialize_particle

procedure	bnd_df

procedure	bnd_ac

procedure	bnd_mc

procedure	bnd_ck

procedure	bnd_reset

procedure	bnd_cf

procedure	bnd_fc

procedure	bnd_fn

procedure	bnd_nur

procedure	bnd_cc

procedure	bnd_cq

procedure	bnd_bd

procedure	bnd_ot_model_flows

procedure	bnd_ot_package_flows

procedure	bnd_ot_dv

procedure	bnd_ot_bdsummary

procedure	allocate_scalars

procedure	allocate_arrays

procedure	pack_initialize

procedure	read_options => bnd_read_options

procedure	read_initial_attr => bnd_read_initial_attr

procedure	bnd_cq_simtomvr

procedure	set_pointers

procedure	copy_boundname

procedure, private	pak_setup_outputtab

procedure, private	bnd_store_user_cond

procedure	set_names

procedure	da

procedure	read_check_ionper

procedure	get_block_data

Private Attributes
type(prtfmitype), pointer	fmi => null()
	flow model interface More...

type(particlestoretype), pointer	particles => null()
	particle store More...

type(trackcontroltype), pointer	trackctl => null()
	track control More...

type(releasescheduletype), pointer	schedule
	particle release schedule More...

integer(i4b), pointer	nreleasepoints => null()
	number of release points More...

integer(i4b), pointer	nreleasetimes => null()
	number of user-specified particle release times More...

integer(i4b), pointer	nparticles => null()
	number of particles released More...

integer(i4b), pointer	istopweaksink => null()
	weak sink option: 0 = no stop, 1 = stop More...

integer(i4b), pointer	istopzone => null()
	optional stop zone number: 0 = no stop zone More...

integer(i4b), pointer	idrape => null()
	drape option: 0 = do not drape, 1 = drape to topmost active cell More...

integer(i4b), pointer	idrymeth => null()
	dry tracking method: 0 = drop, 1 = stop, 2 = stay More...

integer(i4b), pointer	itrkout => null()
	binary track file More...

integer(i4b), pointer	itrkhdr => null()
	track header file More...

integer(i4b), pointer	itrkcsv => null()
	CSV track file. More...

integer(i4b), pointer	irlstls => null()
	release time file More...

integer(i4b), pointer	ilocalz => null()
	compute z coordinates local to the cell More...

integer(i4b), pointer	iextend => null()
	extend tracking beyond simulation's end More...

integer(i4b), pointer	ifrctrn => null()
	force ternary solution for quad grids More...

integer(i4b), pointer	iexmeth => null()
	method for iterative solution of particle exit location and time in generalized Pollock's method More...

real(dp), pointer	extol => null()
	tolerance for iterative solution of particle exit location and time in generalized Pollock's method More...

real(dp), pointer	rttol => null()
	tolerance for coincident particle release times More...

real(dp), pointer	rtfreq => null()
	frequency for regularly spaced release times More...

real(dp), pointer	offset => null()
	release time offset More...

real(dp), pointer	stoptime => null()
	stop time for all release points More...

real(dp), pointer	stoptraveltime => null()
	stop travel time for all points More...

integer(i4b), dimension(:), pointer, contiguous	rptnode => null()
	release point reduced nns More...

integer(i4b), dimension(:), pointer, contiguous	rptzone => null()
	release point zone numbers More...

real(dp), dimension(:), pointer, contiguous	rptx => null()
	release point x coordinates More...

real(dp), dimension(:), pointer, contiguous	rpty => null()
	release point y coordinates More...

real(dp), dimension(:), pointer, contiguous	rptz => null()
	release point z coordinates More...

real(dp), dimension(:), pointer, contiguous	rptm => null()
	total mass released from point More...

character(len=lenboundname), dimension(:), pointer, contiguous	rptname => null()
	release point names More...

character(len=lenlistlabel), pointer	listlabel => null()
	title of table written for RP More...

character(len=lenpackagename)	text = ''
	text string for package flow term More...

character(len=lenauxname), dimension(:), pointer, contiguous	auxname => null()
	vector of auxname More...

type(characterstringtype), dimension(:), pointer, contiguous	auxname_cst => null()
	copy of vector auxname that can be stored in memory manager More...

character(len=lenboundname), dimension(:), pointer, contiguous	boundname => null()
	vector of boundnames More...

type(characterstringtype), dimension(:), pointer, contiguous	boundname_cst => null()
	copy of vector boundname that can be stored in memory manager More...

integer(i4b), pointer	isadvpak => null()
	flag indicating package is advanced (1) or not (0) More...

integer(i4b), pointer	ibcnum => null()
	consecutive package number for this boundary condition More...

integer(i4b), pointer	maxbound => null()
	max number of boundaries More...

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

integer(i4b), pointer	ncolbnd => null()
	number of columns of the bound array More...

integer(i4b), pointer	iscloc => null()
	bound column to scale with SFAC More...

integer(i4b), pointer	naux => null()
	number of auxiliary variables More...

integer(i4b), pointer	inamedbound => null()
	flag to read boundnames More...

integer(i4b), pointer	iauxmultcol => null()
	column to use as multiplier for column iscloc More...

integer(i4b), pointer	npakeq => null()
	number of equations in this package (normally 0 unless package adds rows to matrix) More...

integer(i4b), pointer	ioffset => null()
	offset of this package in the model More...

integer(i4b), dimension(:), pointer, contiguous	nodelist => null()
	vector of reduced node numbers More...

integer(i4b), dimension(:), pointer, contiguous	noupdateauxvar => null()
	override auxvars from being updated More...

real(dp), dimension(:, :), pointer, contiguous	bound => null()
	array of package specific boundary numbers More...

real(dp), dimension(:), pointer, contiguous	hcof => null()
	diagonal contribution More...

real(dp), dimension(:), pointer, contiguous	rhs => null()
	right-hand side contribution More...

real(dp), dimension(:, :), pointer, contiguous	auxvar => null()
	auxiliary variable array More...

real(dp), dimension(:), pointer, contiguous	simvals => null()
	simulated values More...

real(dp), dimension(:), pointer, contiguous	simtomvr => null()
	simulated to mover values More...

integer(i4b), pointer	imover => null()
	flag indicating if the mover is active in the package More...

type(packagemovertype), pointer	pakmvrobj => null()
	mover object for package More...

integer(i4b), pointer	ivsc => null()
	flag indicating if viscosity is active in the model More...

real(dp), dimension(:), pointer, contiguous	condinput => null()
	stores user-specified conductance values More...

type(timeseriesmanagertype), pointer	tsmanager => null()
	time series manager More...

type(timearrayseriesmanagertype), pointer	tasmanager => null()
	time array series manager More...

integer(i4b)	indxconvertflux = 0
	indxconvertflux is column of bound to multiply by area to convert flux to rate More...

logical(lgp)	allowtimearrayseries = .false.

integer(i4b), pointer	inobspkg => null()
	unit number for obs package More...

type(obstype), pointer	obs => null()
	observation package More...

integer(i4b), pointer	neq
	number of equations for model More...

integer(i4b), dimension(:), pointer, contiguous	ibound => null()
	model ibound array More...

real(dp), dimension(:), pointer, contiguous	xnew => null()
	model dependent variable (head) for this time step More...

real(dp), dimension(:), pointer, contiguous	xold => null()
	model dependent variable for last time step More...

real(dp), dimension(:), pointer, contiguous	flowja => null()
	model intercell flows More...

integer(i4b), dimension(:), pointer, contiguous	icelltype => null()
	pointer to icelltype array in NPF More...

character(len=lenmempath)	ictmempath = ''
	memory path to the icelltype data (for GWF this is in NPF) More...

type(tabletype), pointer	inputtab => null()
	input table object More...

type(tabletype), pointer	outputtab => null()
	output table object for package flows writtent to the model listing file More...

type(tabletype), pointer	errortab => null()
	package error table 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 41 of file prt-prp.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure bndmodule::bndtype::allocate_arrays

privateinherited

Definition at line 138 of file BoundaryPackage.f90.

◆ allocate_scalars()

procedure bndmodule::bndtype::allocate_scalars

privateinherited

Definition at line 137 of file BoundaryPackage.f90.

◆ bnd_ac()

procedure bndmodule::bndtype::bnd_ac

privateinherited

Definition at line 117 of file BoundaryPackage.f90.

◆ bnd_activate_viscosity()

procedure, public bndmodule::bndtype::bnd_activate_viscosity

inherited

Definition at line 162 of file BoundaryPackage.f90.

◆ bnd_ad()

procedure prtprpmodule::prtprptype::bnd_ad

private

Definition at line 78 of file prt-prp.f90.

◆ bnd_ar()

procedure prtprpmodule::prtprptype::bnd_ar

private

Definition at line 77 of file prt-prp.f90.

◆ bnd_bd()

procedure bndmodule::bndtype::bnd_bd

privateinherited

Definition at line 130 of file BoundaryPackage.f90.

◆ bnd_bd_obs()

procedure, public bndmodule::bndtype::bnd_bd_obs

inherited

Definition at line 154 of file BoundaryPackage.f90.

◆ bnd_cc()

procedure bndmodule::bndtype::bnd_cc

privateinherited

Definition at line 128 of file BoundaryPackage.f90.

◆ bnd_cf()

procedure bndmodule::bndtype::bnd_cf

privateinherited

Definition at line 124 of file BoundaryPackage.f90.

◆ bnd_ck()

procedure bndmodule::bndtype::bnd_ck

privateinherited

Definition at line 122 of file BoundaryPackage.f90.

◆ bnd_cq()

procedure bndmodule::bndtype::bnd_cq

privateinherited

Definition at line 129 of file BoundaryPackage.f90.

◆ bnd_cq_simrate()

procedure prtprpmodule::prtprptype::bnd_cq_simrate

private

Definition at line 80 of file prt-prp.f90.

◆ bnd_cq_simtomvr()

procedure bndmodule::bndtype::bnd_cq_simtomvr

privateinherited

Definition at line 145 of file BoundaryPackage.f90.

◆ bnd_da()

procedure prtprpmodule::prtprptype::bnd_da

private

Definition at line 81 of file prt-prp.f90.

◆ bnd_df()

procedure bndmodule::bndtype::bnd_df

privateinherited

Definition at line 116 of file BoundaryPackage.f90.

◆ bnd_df_obs()

procedure, public prtprpmodule::prtprptype::bnd_df_obs

Definition at line 94 of file prt-prp.f90.

◆ bnd_fc()

procedure bndmodule::bndtype::bnd_fc

privateinherited

Definition at line 125 of file BoundaryPackage.f90.

◆ bnd_fn()

procedure bndmodule::bndtype::bnd_fn

privateinherited

Definition at line 126 of file BoundaryPackage.f90.

◆ bnd_mc()

procedure bndmodule::bndtype::bnd_mc

privateinherited

Definition at line 118 of file BoundaryPackage.f90.

◆ bnd_nur()

procedure bndmodule::bndtype::bnd_nur

privateinherited

Definition at line 127 of file BoundaryPackage.f90.

◆ bnd_obs_supported()

procedure, public prtprpmodule::prtprptype::bnd_obs_supported

Definition at line 93 of file prt-prp.f90.

◆ bnd_options()

procedure prtprpmodule::prtprptype::bnd_options

private

Definition at line 84 of file prt-prp.f90.

◆ bnd_ot_bdsummary()

procedure bndmodule::bndtype::bnd_ot_bdsummary

privateinherited

Definition at line 134 of file BoundaryPackage.f90.

◆ bnd_ot_dv()

procedure bndmodule::bndtype::bnd_ot_dv

privateinherited

Definition at line 133 of file BoundaryPackage.f90.

◆ bnd_ot_model_flows()

procedure bndmodule::bndtype::bnd_ot_model_flows

privateinherited

Definition at line 131 of file BoundaryPackage.f90.

◆ bnd_ot_obs()

procedure, public bndmodule::bndtype::bnd_ot_obs

inherited

Definition at line 155 of file BoundaryPackage.f90.

◆ bnd_ot_package_flows()

procedure bndmodule::bndtype::bnd_ot_package_flows

privateinherited

Definition at line 132 of file BoundaryPackage.f90.

◆ bnd_reset()

procedure bndmodule::bndtype::bnd_reset

privateinherited

Definition at line 123 of file BoundaryPackage.f90.

◆ bnd_rp()

procedure prtprpmodule::prtprptype::bnd_rp

private

Definition at line 79 of file prt-prp.f90.

◆ bnd_rp_obs()

procedure, public bndmodule::bndtype::bnd_rp_obs

inherited

Definition at line 156 of file BoundaryPackage.f90.

◆ bnd_rp_ts()

procedure, public bndmodule::bndtype::bnd_rp_ts

inherited

Definition at line 159 of file BoundaryPackage.f90.

◆ bnd_store_user_cond()

procedure, private bndmodule::bndtype::bnd_store_user_cond

privateinherited

Definition at line 165 of file BoundaryPackage.f90.

◆ copy_boundname()

procedure bndmodule::bndtype::copy_boundname

privateinherited

Definition at line 148 of file BoundaryPackage.f90.

◆ da()

procedure numericalpackagemodule::numericalpackagetype::da

privateinherited

Definition at line 55 of file NumericalPackage.f90.

◆ define_listlabel()

procedure prtprpmodule::prtprptype::define_listlabel

private

Definition at line 82 of file prt-prp.f90.

◆ get_block_data()

procedure numericalpackagemodule::numericalpackagetype::get_block_data

privateinherited

Definition at line 57 of file NumericalPackage.f90.

◆ initialize_particle()

procedure prtprpmodule::prtprptype::initialize_particle

private

Definition at line 92 of file prt-prp.f90.

◆ log_release()

procedure prtprpmodule::prtprptype::log_release

private

Definition at line 90 of file prt-prp.f90.

◆ pack_initialize()

procedure bndmodule::bndtype::pack_initialize

privateinherited

Definition at line 139 of file BoundaryPackage.f90.

◆ pak_setup_outputtab()

procedure, private bndmodule::bndtype::pak_setup_outputtab

privateinherited

Definition at line 149 of file BoundaryPackage.f90.

◆ prp_allocate_arrays()

procedure prtprpmodule::prtprptype::prp_allocate_arrays

private

Definition at line 75 of file prt-prp.f90.

◆ prp_allocate_scalars()

procedure prtprpmodule::prtprptype::prp_allocate_scalars

private

Definition at line 76 of file prt-prp.f90.

◆ prp_load_releasetimefrequency()

procedure prtprpmodule::prtprptype::prp_load_releasetimefrequency

private

Definition at line 88 of file prt-prp.f90.

◆ prp_read_packagedata()

procedure prtprpmodule::prtprptype::prp_read_packagedata

private

Definition at line 86 of file prt-prp.f90.

◆ prp_read_releasetimes()

procedure prtprpmodule::prtprptype::prp_read_releasetimes

private

Definition at line 87 of file prt-prp.f90.

◆ prp_set_pointers()

procedure prtprpmodule::prtprptype::prp_set_pointers

private

Definition at line 83 of file prt-prp.f90.

◆ read_check_ionper()

procedure numericalpackagemodule::numericalpackagetype::read_check_ionper

privateinherited

Definition at line 56 of file NumericalPackage.f90.

◆ read_dimensions()

procedure prtprpmodule::prtprptype::read_dimensions

private

Definition at line 85 of file prt-prp.f90.

◆ read_initial_attr()

procedure bndmodule::bndtype::read_initial_attr

privateinherited

Definition at line 142 of file BoundaryPackage.f90.

◆ read_options()

procedure bndmodule::bndtype::read_options

privateinherited

Definition at line 140 of file BoundaryPackage.f90.

◆ release()

procedure prtprpmodule::prtprptype::release

private

Definition at line 89 of file prt-prp.f90.

◆ set_names()

procedure numericalpackagemodule::numericalpackagetype::set_names

privateinherited

Definition at line 53 of file NumericalPackage.f90.

◆ set_pointers()

procedure bndmodule::bndtype::set_pointers

privateinherited

Definition at line 146 of file BoundaryPackage.f90.

◆ validate_release_point()

procedure prtprpmodule::prtprptype::validate_release_point

private

Definition at line 91 of file prt-prp.f90.

Member Data Documentation

◆ allowtimearrayseries

logical(lgp) bndmodule::bndtype::allowtimearrayseries = .false.

privateinherited

Definition at line 95 of file BoundaryPackage.f90.

95 logical(LGP) :: AllowTimeArraySeries = .false.

◆ auxname

character(len=lenauxname), dimension(:), pointer, contiguous bndmodule::bndtype::auxname => null()

privateinherited

Definition at line 52 of file BoundaryPackage.f90.

52 character(len=LENAUXNAME), dimension(:), pointer, &

53 contiguous :: auxname => null() !< vector of auxname

◆ auxname_cst

type(characterstringtype), dimension(:), pointer, contiguous bndmodule::bndtype::auxname_cst => null()

privateinherited

Definition at line 54 of file BoundaryPackage.f90.

54 type(CharacterStringType), dimension(:), pointer, &

55 contiguous :: auxname_cst => null() !< copy of vector auxname that can be stored in memory manager

◆ auxvar

real(dp), dimension(:, :), pointer, contiguous bndmodule::bndtype::auxvar => null()

privateinherited

Definition at line 79 of file BoundaryPackage.f90.

79 real(DP), dimension(:, :), pointer, contiguous :: auxvar => null() !< auxiliary variable array

◆ bound

real(dp), dimension(:, :), pointer, contiguous bndmodule::bndtype::bound => null()

privateinherited

Definition at line 76 of file BoundaryPackage.f90.

76 real(DP), dimension(:, :), pointer, contiguous :: bound => null() !< array of package specific boundary numbers

◆ boundname

character(len=lenboundname), dimension(:), pointer, contiguous bndmodule::bndtype::boundname => null()

privateinherited

Definition at line 56 of file BoundaryPackage.f90.

56 character(len=LENBOUNDNAME), dimension(:), pointer, &

57 contiguous :: boundname => null() !< vector of boundnames

◆ boundname_cst

type(characterstringtype), dimension(:), pointer, contiguous bndmodule::bndtype::boundname_cst => null()

privateinherited

Definition at line 58 of file BoundaryPackage.f90.

58 type(CharacterStringType), dimension(:), pointer, &

59 contiguous :: boundname_cst => null() !< copy of vector boundname that can be stored in memory manager

◆ condinput

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::condinput => null()

privateinherited

Definition at line 89 of file BoundaryPackage.f90.

89 real(DP), dimension(:), pointer, contiguous :: condinput => null() !< stores user-specified conductance values

◆ 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

◆ errortab

type(tabletype), pointer bndmodule::bndtype::errortab => null()

privateinherited

Definition at line 113 of file BoundaryPackage.f90.

113 type(TableType), pointer :: errortab => null() !< package error table

◆ extol

real(dp), pointer prtprpmodule::prtprptype::extol => null()

private

Definition at line 61 of file prt-prp.f90.

61 real(DP), pointer :: extol => null() !< tolerance for iterative solution of particle exit location and time in generalized Pollock's method

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

◆ flowja

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::flowja => null()

privateinherited

Definition at line 106 of file BoundaryPackage.f90.

106 real(DP), dimension(:), pointer, contiguous :: flowja => null() !< model intercell flows

◆ fmi

type(prtfmitype), pointer prtprpmodule::prtprptype::fmi => null()

private

Definition at line 42 of file prt-prp.f90.

42 type(PrtFmiType), pointer :: fmi => null() !< flow model interface

◆ hcof

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::hcof => null()

privateinherited

Definition at line 77 of file BoundaryPackage.f90.

77 real(DP), dimension(:), pointer, contiguous :: hcof => null() !< diagonal contribution

◆ 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

◆ iauxmultcol

integer(i4b), pointer bndmodule::bndtype::iauxmultcol => null()

privateinherited

Definition at line 70 of file BoundaryPackage.f90.

70 integer(I4B), pointer :: iauxmultcol => null() !< column to use as multiplier for column iscloc

◆ ibcnum

integer(i4b), pointer bndmodule::bndtype::ibcnum => null()

privateinherited

Definition at line 63 of file BoundaryPackage.f90.

63 integer(I4B), pointer :: ibcnum => null() !< consecutive package number for this boundary condition

◆ ibound

integer(i4b), dimension(:), pointer, contiguous bndmodule::bndtype::ibound => null()

privateinherited

Definition at line 103 of file BoundaryPackage.f90.

103 integer(I4B), dimension(:), pointer, contiguous :: ibound => null() !< model ibound array

◆ icelltype

integer(i4b), dimension(:), pointer, contiguous bndmodule::bndtype::icelltype => null()

privateinherited

Definition at line 107 of file BoundaryPackage.f90.

107 integer(I4B), dimension(:), pointer, contiguous :: icelltype => null() !< pointer to icelltype array in NPF

◆ ictmempath

character(len=lenmempath) bndmodule::bndtype::ictmempath = ''

privateinherited

Definition at line 108 of file BoundaryPackage.f90.

108 character(len=LENMEMPATH) :: ictMemPath = '' !< memory path to the icelltype data (for GWF this is in NPF)

◆ 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

◆ idrape

integer(i4b), pointer prtprpmodule::prtprptype::idrape => null()

private

Definition at line 51 of file prt-prp.f90.

51 integer(I4B), pointer :: idrape => null() !< drape option: 0 = do not drape, 1 = drape to topmost active cell

◆ idrymeth

integer(i4b), pointer prtprpmodule::prtprptype::idrymeth => null()

private

Definition at line 52 of file prt-prp.f90.

52 integer(I4B), pointer :: idrymeth => null() !< dry tracking method: 0 = drop, 1 = stop, 2 = stay

◆ iexmeth

integer(i4b), pointer prtprpmodule::prtprptype::iexmeth => null()

private

Definition at line 60 of file prt-prp.f90.

60 integer(I4B), pointer :: iexmeth => null() !< method for iterative solution of particle exit location and time in generalized Pollock's method

◆ iextend

integer(i4b), pointer prtprpmodule::prtprptype::iextend => null()

private

Definition at line 58 of file prt-prp.f90.

58 integer(I4B), pointer :: iextend => null() !< extend tracking beyond simulation's end

◆ ifrctrn

integer(i4b), pointer prtprpmodule::prtprptype::ifrctrn => null()

private

Definition at line 59 of file prt-prp.f90.

59 integer(I4B), pointer :: ifrctrn => null() !< force ternary solution for quad grids

◆ ilocalz

integer(i4b), pointer prtprpmodule::prtprptype::ilocalz => null()

private

Definition at line 57 of file prt-prp.f90.

57 integer(I4B), pointer :: ilocalz => null() !< compute z coordinates local to the cell

◆ imover

integer(i4b), pointer bndmodule::bndtype::imover => null()

privateinherited

Definition at line 84 of file BoundaryPackage.f90.

84 integer(I4B), pointer :: imover => null() !< flag indicating if the mover is active in the package

◆ inamedbound

integer(i4b), pointer bndmodule::bndtype::inamedbound => null()

privateinherited

Definition at line 69 of file BoundaryPackage.f90.

69 integer(I4B), pointer :: inamedbound => null() !< flag to read boundnames

◆ indxconvertflux

integer(i4b) bndmodule::bndtype::indxconvertflux = 0

privateinherited

Definition at line 94 of file BoundaryPackage.f90.

94 integer(I4B) :: indxconvertflux = 0 !< indxconvertflux is column of bound to multiply by area to convert flux to rate

◆ 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

◆ inobspkg

integer(i4b), pointer bndmodule::bndtype::inobspkg => null()

privateinherited

Definition at line 98 of file BoundaryPackage.f90.

98 integer(I4B), pointer :: inobspkg => null() !< unit number for obs package

◆ 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

◆ inputtab

type(tabletype), pointer bndmodule::bndtype::inputtab => null()

privateinherited

Definition at line 111 of file BoundaryPackage.f90.

111 type(TableType), pointer :: inputtab => null() !< input table object

◆ 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

◆ ioffset

integer(i4b), pointer bndmodule::bndtype::ioffset => null()

privateinherited

Definition at line 72 of file BoundaryPackage.f90.

72 integer(I4B), pointer :: ioffset => null() !< offset of this package in the model

◆ 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

◆ irlstls

integer(i4b), pointer prtprpmodule::prtprptype::irlstls => null()

private

Definition at line 56 of file prt-prp.f90.

56 integer(I4B), pointer :: irlstls => null() !< release time file

◆ isadvpak

integer(i4b), pointer bndmodule::bndtype::isadvpak => null()

privateinherited

Definition at line 62 of file BoundaryPackage.f90.

62 integer(I4B), pointer :: isadvpak => null() !< flag indicating package is advanced (1) or not (0)

◆ iscloc

integer(i4b), pointer bndmodule::bndtype::iscloc => null()

privateinherited

Definition at line 67 of file BoundaryPackage.f90.

67 integer(I4B), pointer :: iscloc => null() !< bound column to scale with SFAC

◆ istopweaksink

integer(i4b), pointer prtprpmodule::prtprptype::istopweaksink => null()

private

Definition at line 49 of file prt-prp.f90.

49 integer(I4B), pointer :: istopweaksink => null() !< weak sink option: 0 = no stop, 1 = stop

◆ istopzone

integer(i4b), pointer prtprpmodule::prtprptype::istopzone => null()

private

Definition at line 50 of file prt-prp.f90.

50 integer(I4B), pointer :: istopzone => null() !< optional stop zone number: 0 = no stop zone

◆ itrkcsv

integer(i4b), pointer prtprpmodule::prtprptype::itrkcsv => null()

private

Definition at line 55 of file prt-prp.f90.

55 integer(I4B), pointer :: itrkcsv => null() !< CSV track file

◆ itrkhdr

integer(i4b), pointer prtprpmodule::prtprptype::itrkhdr => null()

private

Definition at line 54 of file prt-prp.f90.

54 integer(I4B), pointer :: itrkhdr => null() !< track header file

◆ itrkout

integer(i4b), pointer prtprpmodule::prtprptype::itrkout => null()

private

Definition at line 53 of file prt-prp.f90.

53 integer(I4B), pointer :: itrkout => null() !< binary track file

◆ ivsc

integer(i4b), pointer bndmodule::bndtype::ivsc => null()

privateinherited

Definition at line 88 of file BoundaryPackage.f90.

88 integer(I4B), pointer :: ivsc => null() !< flag indicating if viscosity is active in the model

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

◆ listlabel

character(len=lenlistlabel), pointer bndmodule::bndtype::listlabel => null()

privateinherited

Definition at line 50 of file BoundaryPackage.f90.

50 character(len=LENLISTLABEL), pointer :: listlabel => null() !< title of table written for RP

◆ maxbound

integer(i4b), pointer bndmodule::bndtype::maxbound => null()

privateinherited

Definition at line 64 of file BoundaryPackage.f90.

64 integer(I4B), pointer :: maxbound => null() !< max number of boundaries

◆ 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

◆ 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

◆ naux

integer(i4b), pointer bndmodule::bndtype::naux => null()

privateinherited

Definition at line 68 of file BoundaryPackage.f90.

68 integer(I4B), pointer :: naux => null() !< number of auxiliary variables

◆ nbound

integer(i4b), pointer bndmodule::bndtype::nbound => null()

privateinherited

Definition at line 65 of file BoundaryPackage.f90.

65 integer(I4B), pointer :: nbound => null() !< number of boundaries for current stress period

◆ ncolbnd

integer(i4b), pointer bndmodule::bndtype::ncolbnd => null()

privateinherited

Definition at line 66 of file BoundaryPackage.f90.

66 integer(I4B), pointer :: ncolbnd => null() !< number of columns of the bound array

◆ neq

integer(i4b), pointer bndmodule::bndtype::neq

privateinherited

Definition at line 102 of file BoundaryPackage.f90.

102 integer(I4B), pointer :: neq !< number of equations for model

◆ nodelist

integer(i4b), dimension(:), pointer, contiguous bndmodule::bndtype::nodelist => null()

privateinherited

Definition at line 74 of file BoundaryPackage.f90.

74 integer(I4B), dimension(:), pointer, contiguous :: nodelist => null() !< vector of reduced node numbers

◆ noupdateauxvar

integer(i4b), dimension(:), pointer, contiguous bndmodule::bndtype::noupdateauxvar => null()

privateinherited

Definition at line 75 of file BoundaryPackage.f90.

75 integer(I4B), dimension(:), pointer, contiguous :: noupdateauxvar => null() !< override auxvars from being updated

◆ npakeq

integer(i4b), pointer bndmodule::bndtype::npakeq => null()

privateinherited

Definition at line 71 of file BoundaryPackage.f90.

71 integer(I4B), pointer :: npakeq => null() !< number of equations in this package (normally 0 unless package adds rows to matrix)

◆ nparticles

integer(i4b), pointer prtprpmodule::prtprptype::nparticles => null()

private

Definition at line 48 of file prt-prp.f90.

48 integer(I4B), pointer :: nparticles => null() !< number of particles released

◆ nreleasepoints

integer(i4b), pointer prtprpmodule::prtprptype::nreleasepoints => null()

private

Definition at line 46 of file prt-prp.f90.

46 integer(I4B), pointer :: nreleasepoints => null() !< number of release points

◆ nreleasetimes

integer(i4b), pointer prtprpmodule::prtprptype::nreleasetimes => null()

private

Definition at line 47 of file prt-prp.f90.

47 integer(I4B), pointer :: nreleasetimes => null() !< number of user-specified particle release times

◆ obs

type(obstype), pointer bndmodule::bndtype::obs => null()

privateinherited

Definition at line 99 of file BoundaryPackage.f90.

99 type(ObsType), pointer :: obs => null() !< observation package

◆ offset

real(dp), pointer prtprpmodule::prtprptype::offset => null()

private

Definition at line 64 of file prt-prp.f90.

64 real(DP), pointer :: offset => null() !< release time offset

◆ outputtab

type(tabletype), pointer bndmodule::bndtype::outputtab => null()

privateinherited

Definition at line 112 of file BoundaryPackage.f90.

112 type(TableType), pointer :: outputtab => null() !< output table object for package flows writtent to the model listing file

◆ 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

◆ pakmvrobj

type(packagemovertype), pointer bndmodule::bndtype::pakmvrobj => null()

privateinherited

Definition at line 85 of file BoundaryPackage.f90.

85 type(PackageMoverType), pointer :: pakmvrobj => null() !< mover object for package

◆ 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

◆ particles

type(particlestoretype), pointer prtprpmodule::prtprptype::particles => null()

private

Definition at line 43 of file prt-prp.f90.

43 type(ParticleStoreType), pointer :: particles => null() !< particle store

◆ rhs

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::rhs => null()

privateinherited

Definition at line 78 of file BoundaryPackage.f90.

78 real(DP), dimension(:), pointer, contiguous :: rhs => null() !< right-hand side contribution

◆ rptm

real(dp), dimension(:), pointer, contiguous prtprpmodule::prtprptype::rptm => null()

private

Definition at line 72 of file prt-prp.f90.

72 real(DP), pointer, contiguous :: rptm(:) => null() !< total mass released from point

◆ rptname

character(len=lenboundname), dimension(:), pointer, contiguous prtprpmodule::prtprptype::rptname => null()

private

Definition at line 73 of file prt-prp.f90.

73 character(len=LENBOUNDNAME), pointer, contiguous :: rptname(:) => null() !< release point names

◆ rptnode

integer(i4b), dimension(:), pointer, contiguous prtprpmodule::prtprptype::rptnode => null()

private

Definition at line 67 of file prt-prp.f90.

67 integer(I4B), pointer, contiguous :: rptnode(:) => null() !< release point reduced nns

◆ rptx

real(dp), dimension(:), pointer, contiguous prtprpmodule::prtprptype::rptx => null()

private

Definition at line 69 of file prt-prp.f90.

69 real(DP), pointer, contiguous :: rptx(:) => null() !< release point x coordinates

◆ rpty

real(dp), dimension(:), pointer, contiguous prtprpmodule::prtprptype::rpty => null()

private

Definition at line 70 of file prt-prp.f90.

70 real(DP), pointer, contiguous :: rpty(:) => null() !< release point y coordinates

◆ rptz

real(dp), dimension(:), pointer, contiguous prtprpmodule::prtprptype::rptz => null()

private

Definition at line 71 of file prt-prp.f90.

71 real(DP), pointer, contiguous :: rptz(:) => null() !< release point z coordinates

◆ rptzone

integer(i4b), dimension(:), pointer, contiguous prtprpmodule::prtprptype::rptzone => null()

private

Definition at line 68 of file prt-prp.f90.

68 integer(I4B), pointer, contiguous :: rptzone(:) => null() !< release point zone numbers

◆ rtfreq

real(dp), pointer prtprpmodule::prtprptype::rtfreq => null()

private

Definition at line 63 of file prt-prp.f90.

63 real(DP), pointer :: rtfreq => null() !< frequency for regularly spaced release times

◆ rttol

real(dp), pointer prtprpmodule::prtprptype::rttol => null()

private

Definition at line 62 of file prt-prp.f90.

62 real(DP), pointer :: rttol => null() !< tolerance for coincident particle release times

◆ schedule

type(releasescheduletype), pointer prtprpmodule::prtprptype::schedule

private

Definition at line 45 of file prt-prp.f90.

45 type(ReleaseScheduleType), pointer :: schedule !< particle release schedule

◆ simtomvr

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::simtomvr => null()

privateinherited

Definition at line 81 of file BoundaryPackage.f90.

81 real(DP), dimension(:), pointer, contiguous :: simtomvr => null() !< simulated to mover values

◆ simvals

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::simvals => null()

privateinherited

Definition at line 80 of file BoundaryPackage.f90.

80 real(DP), dimension(:), pointer, contiguous :: simvals => null() !< simulated values

◆ stoptime

real(dp), pointer prtprpmodule::prtprptype::stoptime => null()

private

Definition at line 65 of file prt-prp.f90.

65 real(DP), pointer :: stoptime => null() !< stop time for all release points

◆ stoptraveltime

real(dp), pointer prtprpmodule::prtprptype::stoptraveltime => null()

private

Definition at line 66 of file prt-prp.f90.

66 real(DP), pointer :: stoptraveltime => null() !< stop travel time for all points

◆ tasmanager

type(timearrayseriesmanagertype), pointer bndmodule::bndtype::tasmanager => null()

privateinherited

Definition at line 93 of file BoundaryPackage.f90.

93 type(TimeArraySeriesManagerType), pointer :: TasManager => null() !< time array series manager

◆ text

character(len=lenpackagename) bndmodule::bndtype::text = ''

privateinherited

Definition at line 51 of file BoundaryPackage.f90.

51 character(len=LENPACKAGENAME) :: text = '' !< text string for package flow term

◆ trackctl

type(trackcontroltype), pointer prtprpmodule::prtprptype::trackctl => null()

private

Definition at line 44 of file prt-prp.f90.

44 type(TrackControlType), pointer :: trackctl => null() !< track control

◆ tsmanager

type(timeseriesmanagertype), pointer bndmodule::bndtype::tsmanager => null()

privateinherited

Definition at line 92 of file BoundaryPackage.f90.

92 type(TimeSeriesManagerType), pointer :: TsManager => null() !< time series manager

◆ xnew

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::xnew => null()

privateinherited

Definition at line 104 of file BoundaryPackage.f90.

104 real(DP), dimension(:), pointer, contiguous :: xnew => null() !< model dependent variable (head) for this time step

◆ xold

real(dp), dimension(:), pointer, contiguous bndmodule::bndtype::xold => null()

privateinherited

Definition at line 105 of file BoundaryPackage.f90.

105 real(DP), dimension(:), pointer, contiguous :: xold => null() !< model dependent variable for last time step

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

/home/runner/work/modflow6/modflow6/src/Model/ParticleTracking/prt-prp.f90

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ allocate_arrays()

◆ allocate_scalars()

◆ bnd_ac()

◆ bnd_activate_viscosity()

◆ bnd_ad()

◆ bnd_ar()

◆ bnd_bd()

◆ bnd_bd_obs()

◆ bnd_cc()

◆ bnd_cf()

◆ bnd_ck()

◆ bnd_cq()

◆ bnd_cq_simrate()

◆ bnd_cq_simtomvr()

◆ bnd_da()

◆ bnd_df()

◆ bnd_df_obs()

◆ bnd_fc()

◆ bnd_fn()

◆ bnd_mc()

◆ bnd_nur()

◆ bnd_obs_supported()

◆ bnd_options()

◆ bnd_ot_bdsummary()

◆ bnd_ot_dv()

◆ bnd_ot_model_flows()

◆ bnd_ot_obs()

◆ bnd_ot_package_flows()

◆ bnd_reset()

◆ bnd_rp()

◆ bnd_rp_obs()

◆ bnd_rp_ts()

◆ bnd_store_user_cond()

◆ copy_boundname()

◆ da()

◆ define_listlabel()

◆ get_block_data()

◆ initialize_particle()

◆ log_release()

◆ pack_initialize()

◆ pak_setup_outputtab()

◆ prp_allocate_arrays()

◆ prp_allocate_scalars()

◆ prp_load_releasetimefrequency()

◆ prp_read_packagedata()

◆ prp_read_releasetimes()

◆ prp_set_pointers()

◆ read_check_ionper()

◆ read_dimensions()

◆ read_initial_attr()

◆ read_options()

◆ release()

◆ set_names()

◆ set_pointers()

◆ validate_release_point()

Member Data Documentation

◆ allowtimearrayseries

◆ auxname

◆ auxname_cst

◆ auxvar

◆ bound

◆ boundname

◆ boundname_cst

◆ condinput

◆ dis

◆ errortab

◆ extol

◆ filtyp

◆ flowja

◆ fmi

◆ hcof

◆ iasym

◆ iauxmultcol

◆ ibcnum

◆ ibound