MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches

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

Inheritance diagram for prtprpmodule::prtprptype:
Inheritance graph
Collaboration diagram for prtprpmodule::prtprptype:
Collaboration graph

Public Member Functions

procedure prp_allocate_arrays (this, nodelist, auxvar)
 Allocate arrays.
procedure prp_allocate_scalars (this)
 Allocate scalars.
procedure bnd_ar (this)
 Allocate and read period data.
procedure bnd_ad (this)
 Advance a time step and release particles if scheduled.
procedure bnd_rp (this)
 Read and prepare period data for particle input.
procedure bnd_cq_simrate (this, hnew, flowja, imover)
 Calculate flow between package and model.
procedure bnd_da (this)
 Deallocate memory.
procedure prp_commit (this)
 Commit staged particle state to the "final" store.
procedure define_listlabel (this)
procedure prp_set_pointers (this, ibound, izone)
 Set pointers to model variables.
procedure source_options (this)
 Set options specific to PrtPrpType.
procedure source_dimensions (this)
 Set dimensions specific to PrtPrpType.
procedure prp_log_options (this, found, trackfile, trackcsvfile)
 Log options specific to PrtPrpType.
procedure prp_packagedata (this)
 Load package data (release points).
procedure prp_releasetimes (this)
 Load explicitly specified release times.
procedure prp_load_releasetimefrequency (this)
 Load regularly spaced release times if configured.
procedure prp_load_default_release (this)
 Release once at t=0 if the input configures no releases.
procedure prp_check_releases (this)
 Warn if the input configures releases but none will happen.
procedure release (this, ip, trelease)
 Release a particle at the specified time.
procedure log_release (this)
 Log the release scheduled for this time step.
procedure validate_release_point (this, ic, x, y, z)
 Verify that the release point is in the cell.
procedure initialize_particle (this, particle, ip, trelease)
procedure, public bnd_obs_supported (this)
 Indicates whether observations are supported.
procedure, public bnd_df_obs (this)
 Store supported observations.
procedure bnd_df (this, neq, dis)
 Define boundary package options and dimensions.
procedure, public bnd_df (this, neq, dis)
 Define boundary package options and dimensions.
procedure bnd_ad (this)
 Advance the package one time step.
procedure bnd_ad (this)
 Advance the boundary package.
procedure bnd_rp (this)
procedure bnd_rp (this)
 Allocate and read method for package.
procedure bnd_rp_log (this)
 Write the input list to the listing file if requested.
procedure, public bnd_rp_log (this)
 Log period input for a boundary package.
procedure validate_ifno (this, ifno_val, nfeatures, nboundchk, feature_label, blockname)
 Validate a list-input row's IFNO and update the per-feature coverage counter.
procedure report_ifno_coverage (this, nboundchk, nfeatures, feature_label, blockname, check_missing)
 Report missing or duplicate list-input rows for each feature.
procedure bnd_da (this)
 Deallocate package memory.
procedure bnd_da (this)
 Deallocate package memory.
procedure allocate_scalars (this)
 Allocate package scalars.
procedure allocate_scalars (this)
 Allocate package scalars.
procedure allocate_scalars (this)
 Allocate package scalars.
procedure allocate_arrays (this, nodelist, auxvar)
 Allocate package arrays.
procedure allocate_arrays (this, nodelist, auxvar)
 Allocate package arrays.
procedure allocate_featureauxvar (this)
 Point the per-feature auxiliary variable array at the input context's permanent, feature-indexed AUX array. For packages with PACKAGEDATA AUX variables only. A live alias, permuted from row order to IFNO order, skipping out-of-range IFNO.
procedure source_options (this)
 Source package options from input context.
procedure log_options (this, found, sfacauxname)
 Log package options.
procedure source_dimensions (this)
 Source package dimensions from input context.
procedure cellid_to_nlist (this)
 Update package nodelist.
procedure nodeu_to_nlist (this)
 Update package nodelist.
procedure layarr_to_nlist (this)
 Update the nodelist based on layer number variable input.
procedure default_nodelist (this)
 Assign default nodelist when READASARRAYS is specified.
procedure check_cellid (this, ii, cellid, mshape, ndim)
 Check for valid cellid.
procedure write_lstfile (this)
 Log package stress period input.
procedure bound_value (this, col, row)
 Return a bound value.
procedure bnd_ac (this, moffset, sparse)
 Add boundary package connection to matrix.
procedure bnd_mc (this, moffset, matrix_sln)
 Map boundary package connection to matrix.
procedure bnd_ar (this)
 Allocate and read method for boundary package.
procedure bnd_ck (this)
 Check boundary package period data.
procedure bnd_reset (this)
 Reset bnd package before formulating.
procedure bnd_cf (this)
 Formulate the package hcof and rhs terms.
procedure bnd_fc (this, rhs, ia, idxglo, matrix_sln)
 Copy hcof and rhs terms into solution.
procedure bnd_fn (this, rhs, ia, idxglo, matrix_sln)
 Add Newton-Raphson terms for package into solution.
procedure bnd_nur (this, neqpak, x, xtemp, dx, inewtonur, dxmax, locmax)
 Apply Newton-Raphson under-relaxation for package.
procedure bnd_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak)
 Convergence check for package.
procedure bnd_cq (this, x, flowja, iadv)
 Calculate advanced package flows.
procedure bnd_bd (this, model_budget)
 Add package flows to model budget.
procedure bnd_ot_model_flows (this, icbcfl, ibudfl, icbcun, imap)
 Output package flow terms.
procedure bnd_ot_package_flows (this, icbcfl, ibudfl)
 Output advanced package flow terms.
procedure bnd_ot_dv (this, idvsave, idvprint)
 Output advanced package dependent-variable terms.
procedure bnd_ot_bdsummary (this, kstp, kper, iout, ibudfl)
 Output advanced package budget summary.
procedure bnd_dt (this)
 Submit an ATS time step request (no-op by default).
procedure bnd_fp (this)
 Final processing at end of simulation (no-op by default).
procedure pack_initialize (this)
 Allocate and initialize select package members.
procedure read_options (this)
 Read additional options for package.
procedure read_dimensions (this)
 Read dimensions for package.
procedure read_initial_attr (this)
 Read initial parameters for package.
procedure bnd_options (this, option, found)
 Read additional options for package.
procedure bnd_cq_simrate (this, hnew, flowja, imover)
 Calculate simrate.
procedure bnd_cq_simtomvr (this, flowja)
 Calculate flow to the mover.
procedure set_pointers (this, neq, ibound, xnew, xold, flowja)
 Set pointers to model variables.
procedure define_listlabel (this)
 Define the list label for the package.
procedure copy_boundname (this)
 Copy boundnames into boundnames_cst.
procedure, public bnd_obs_supported (this)
 Determine if observations are supported.
procedure, public bnd_df_obs (this)
 Define the observation types available in the package.
procedure, public bnd_bd_obs (this)
 Save observations for the package.
procedure, public bnd_ot_obs (this)
 Output observations for the package.
procedure, public bnd_rp_obs (this)
 Read and prepare observations for a package.
procedure, public bnd_rp_ts (this)
 Assign time series links for the package.
procedure, public bnd_activate_viscosity (this)
 Activate viscosity terms.
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

logical(lgp), pointer extend => null()
 extend tracking beyond simulation's end
logical(lgp), pointer frctrn => null()
 force ternary solution for quad grids
logical(lgp), pointer drape => null()
 whether to drape particle to topmost active cell
logical(lgp), pointer localz => null()
 compute z coordinates local to the release cell
integer(i4b), pointer istopweaksink => null()
 weak sink option: 0 = no stop, 1 = stop
integer(i4b), pointer istopzone => null()
 optional stop zone number: 0 = no stop zone
integer(i4b), pointer idrymeth => null()
 dry tracking method: 0 = drop, 1 = stop, 2 = stay
integer(i4b), pointer itrkout => null()
 binary track file
integer(i4b), pointer itrkhdr => null()
 track header file
integer(i4b), pointer itrkcsv => null()
 CSV track file.
integer(i4b), pointer irlstls => null()
 release time file
integer(i4b), pointer iexmeth => null()
 method for iterative solution of particle exit location and time in generalized Pollock's method
integer(i4b), pointer ichkmeth => null()
 method for checking particle release coordinates are in the specified cells, 0 = none, 1 = eager
integer(i4b), pointer icycwin => null()
 cycle detection window size
real(dp), pointer extol => null()
 tolerance for iterative solution of particle exit location and time in generalized Pollock's method
real(dp), pointer rttol => null()
 tolerance for coincident particle release times
real(dp), pointer rtfreq => null()
 frequency for regularly spaced release times
real(dp), pointer offset => null()
 release time offset
real(dp), pointer stoptime => null()
 stop time for all release points
real(dp), pointer stoptraveltime => null()
 stop travel time for all points
type(prtfmitype), pointer fmi => null()
 flow model interface
type(particlestoretype), pointer particles => null()
 committed particle state (end of last successful time step)
type(particlestoretype), pointer particles_staging => null()
 staging particle state for the current solve attempt
type(particlereleasescheduletype), pointer schedule => null()
 particle release schedule
integer(i4b), pointer nreleasepoints => null()
 number of release points
integer(i4b), pointer nreleasetimes => null()
 number of user-specified particle release times
integer(i4b), pointer nparticles => null()
 number of particles released
integer(i4b), dimension(:), pointer, contiguous rptnode => null()
 release point reduced nns
integer(i4b), dimension(:), pointer, contiguous rptzone => null()
 release point zone numbers
real(dp), dimension(:), pointer, contiguous rptx => null()
 release point x coordinates
real(dp), dimension(:), pointer, contiguous rpty => null()
 release point y coordinates
real(dp), dimension(:), pointer, contiguous rptz => null()
 release point z coordinates
real(dp), dimension(:), pointer, contiguous rptm => null()
 total mass released from point
character(len=lenboundname), dimension(:), pointer, contiguous rptname => null()
 release point names
character(len=linelength), dimension(:), allocatable period_block_lines
 last period block configuration for fill-forward
integer(i4b) applied_kper
 period for which configuration was last applied
integer(i4b), pointer iper
logical(lgp), pointer readarraygrid
logical(lgp), pointer readasarrays
logical(lgp), pointer ts_active
 .true. if TS6 files are configured in OPTIONS
integer(i4b), dimension(:, :), pointer, contiguous cellid => null()
 input user cellid list
integer(i4b), dimension(:), pointer, contiguous nodeulist => null()
 input user nodelist
integer(i4b), dimension(:), pointer, contiguous pkg_ifno => null()
 advanced feature index
real(dp), dimension(:, :), pointer, contiguous featureauxvar => null()
 advanced per-feature AUX array
character(len=lenlistlabel), pointer listlabel => null()
 title of table written for RP
character(len=lenpackagename) text = ''
 text string for package flow term
character(len=lenauxname), dimension(:), pointer, contiguous auxname => null()
 vector of auxname
type(characterstringtype), dimension(:), pointer, contiguous auxname_cst => null()
 copy of vector auxname that can be stored in memory manager
character(len=lenboundname), dimension(:), pointer, contiguous boundname => null()
 vector of boundnames
type(characterstringtype), dimension(:), pointer, contiguous boundname_cst => null()
 copy of vector boundname that can be stored in memory manager
integer(i4b), pointer isadvpak => null()
 flag indicating package is advanced (1) or not (0)
integer(i4b), pointer ibcnum => null()
 consecutive package number for this boundary condition
integer(i4b), pointer maxbound => null()
 max number of boundaries
integer(i4b), pointer nbound => null()
 number of boundaries for current stress period
integer(i4b), pointer ncolbnd => null()
 number of columns of the bound array
integer(i4b), pointer iscloc => null()
 bound column to scale with SFAC
integer(i4b), pointer naux => null()
 number of auxiliary variables
integer(i4b), pointer inamedbound => null()
 flag to read boundnames
integer(i4b), pointer iauxmultcol => null()
 column to use as multiplier for column iscloc
integer(i4b), pointer npakeq => null()
 number of equations in this package (normally 0 unless package adds rows to matrix)
integer(i4b), pointer ioffset => null()
 offset of this package in the model
integer(i4b), dimension(:), pointer, contiguous nodelist => null()
 vector of reduced node numbers
integer(i4b), dimension(:), pointer, contiguous noupdateauxvar => null()
 override auxvars from being updated
real(dp), dimension(:, :), pointer, contiguous bound => null()
 array of package specific boundary numbers
real(dp), dimension(:), pointer, contiguous hcof => null()
 diagonal contribution
real(dp), dimension(:), pointer, contiguous rhs => null()
 right-hand side contribution
real(dp), dimension(:, :), pointer, contiguous auxvar => null()
 auxiliary variable array
real(dp), dimension(:), pointer, contiguous simvals => null()
 simulated values
real(dp), dimension(:), pointer, contiguous simtomvr => null()
 simulated to mover values
integer(i4b), pointer imover => null()
 flag indicating if the mover is active in the package
type(packagemovertype), pointer pakmvrobj => null()
 mover object for package
integer(i4b), pointer ivsc => null()
 flag indicating if viscosity is active in the model
real(dp), dimension(:), pointer, contiguous condinput => null()
 stores user-specified conductance values
real(dp), dimension(:), allocatable viscratio
 viscosity ratio applied to each boundary conductance
type(timeseriesmanagertype), pointer tsmanager => null()
 time series manager
type(timearrayseriesmanagertype), pointer tasmanager => null()
 time array series manager
integer(i4b) indxconvertflux = 0
 indxconvertflux is column of bound to multiply by area to convert flux to rate
logical(lgp) allowtimearrayseries = .false.
integer(i4b), pointer inobspkg => null()
 unit number for obs package
type(obstype), pointer obs => null()
 observation package
integer(i4b), pointer neq
 number of equations for model
integer(i4b), dimension(:), pointer, contiguous ibound => null()
 model ibound array
real(dp), dimension(:), pointer, contiguous xnew => null()
 model dependent variable (head) for this time step
real(dp), dimension(:), pointer, contiguous xold => null()
 model dependent variable for last time step
real(dp), dimension(:), pointer, contiguous flowja => null()
 model intercell flows
integer(i4b), dimension(:), pointer, contiguous icelltype => null()
 pointer to icelltype array in NPF
character(len=lenmempath) ictmempath = ''
 memory path to the icelltype data (for GWF this is in NPF)
type(tabletype), pointer inputtab => null()
 input table object
type(tabletype), pointer outputtab => null()
 output table object for package flows writtent to the model listing file
type(tabletype), pointer errortab => null()
 package error table
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 pak_setup_outputtab (this)
 Setup output table for package.

Detailed Description

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

Member Function/Subroutine Documentation

◆ allocate_arrays() [1/2]

procedure bndextmodule::bndexttype::allocate_arrays ( class(bndexttype) this,
integer(i4b), dimension(:), optional, pointer, contiguous nodelist,
real(dp), dimension(:, :), optional, pointer, contiguous auxvar )
inherited

Allocate and initialize base boundary package arrays. This method only needs to be overridden if additional arrays are defined for a specific package.

Parameters
thisBndExtType object
nodelistpackage nodelist
auxvarpackage aux variable array

Definition at line 54 of file BoundaryPackageExt.f90.

◆ allocate_arrays() [2/2]

procedure bndmodule::bndtype::allocate_arrays ( class(bndtype) this,
integer(i4b), dimension(:), optional, pointer, contiguous nodelist,
real(dp), dimension(:, :), optional, pointer, contiguous auxvar )
inherited

Allocate and initialize base boundary package arrays. This method only needs to be overridden if additional arrays are defined for a specific package.

Parameters
thisBndType object
nodelistpackage nodelist
auxvarpackage aux variable array

Definition at line 140 of file BoundaryPackage.f90.

◆ allocate_featureauxvar()

procedure bndextmodule::bndexttype::allocate_featureauxvar ( class(bndexttype) this)
inherited
Parameters
thisBndExtType object

Definition at line 55 of file BoundaryPackageExt.f90.

◆ allocate_scalars() [1/3]

procedure bndextmodule::bndexttype::allocate_scalars ( class(bndexttype) this)
inherited

Allocate and initialize base boundary package scalars. This method only needs to be overridden if additional scalars are defined for a specific package.

Parameters
thisBndExtType object

Definition at line 53 of file BoundaryPackageExt.f90.

◆ allocate_scalars() [2/3]

procedure bndmodule::bndtype::allocate_scalars ( class(bndtype) this)
inherited

Allocate and initialize base boundary package scalars. This method only needs to be overridden if additional scalars are defined for a specific package.

Parameters
thisBndType object

Definition at line 139 of file BoundaryPackage.f90.

◆ allocate_scalars() [3/3]

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.

◆ bnd_ac()

procedure bndmodule::bndtype::bnd_ac ( class(bndtype), intent(inout) this,
integer(i4b), intent(in) moffset,
type(sparsematrix), intent(inout) sparse )
inherited

Add boundary package connection to the matrix for packages that add connections to the coefficient matrix. An example would be the GWF model MAW package. Base implementation that must be extended.

Parameters
[in,out]thisBndType object
[in]moffsetsolution matrix model offset
[in,out]sparsesparse object

Definition at line 117 of file BoundaryPackage.f90.

◆ bnd_activate_viscosity()

procedure, public bndmodule::bndtype::bnd_activate_viscosity ( class(bndtype), intent(inout) this)
inherited

Method to activate addition of viscosity terms when package type is DRN, GHB, or RIV (method not needed by other packages at this point)

Parameters
[in,out]thisBndType object

Definition at line 165 of file BoundaryPackage.f90.

◆ bnd_ad() [1/3]

procedure bndextmodule::bndexttype::bnd_ad ( class(bndexttype) this)
inherited

Does not call thisTsManagerad()/thisTasManagerad() – those managers are unused by this type (see bndext_df).

Definition at line 47 of file BoundaryPackageExt.f90.

◆ bnd_ad() [2/3]

procedure bndmodule::bndtype::bnd_ad ( class(bndtype) this)
inherited

Advance data in the boundary package. The method sets advances time series, time array series, and observation data. A boundary package only needs to override this method if additional data needs to be advanced.

Parameters
thisBndType object

Definition at line 121 of file BoundaryPackage.f90.

◆ bnd_ad() [3/3]

procedure prtprpmodule::prtprptype::bnd_ad ( class(prtprptype) this)

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

◆ bnd_ar() [1/2]

procedure bndmodule::bndtype::bnd_ar ( class(bndtype), intent(inout) this)
inherited

Generic method to allocate and read static data for model boundary packages. A boundary package only needs to override this method if input data varies from the standard boundary package.

Parameters
[in,out]thisBndType object

Definition at line 119 of file BoundaryPackage.f90.

◆ bnd_ar() [2/2]

procedure prtprpmodule::prtprptype::bnd_ar ( class(prtprptype), intent(inout) this)

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

◆ bnd_bd()

procedure bndmodule::bndtype::bnd_bd ( class(bndtype) this,
type(budgettype), intent(inout) model_budget )
inherited

Add the flow between package and the model (ratin and ratout) to the model budget. This method only needs to be overridden if a different calculation needs to be made.

Parameters
thisBndType object
[in,out]model_budgetmodel budget object

Definition at line 130 of file BoundaryPackage.f90.

◆ bnd_bd_obs()

procedure, public bndmodule::bndtype::bnd_bd_obs ( class(bndtype) this)
inherited

Method to save simulated values for the boundary package. This method will need to be overridden for boundary packages with more observations than the calculate flow term (simvals) and to-mover.

Parameters
thisBndType object

Definition at line 156 of file BoundaryPackage.f90.

◆ bnd_cc()

procedure bndmodule::bndtype::bnd_cc ( class(bndtype), intent(inout) 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 )
inherited

Perform additional convergence checks on the flow between the package and the model it is attached to. This additional convergence check is applied to packages that solve their own continuity equation as part of the formulate step at the beginning of a Picard iteration. A boundary package only needs to override this method if a specific boundary package solves its own continuity equation. Example packages that implement this additional convergence check is the CSUB, SFR, LAK, and UZF packages.

Parameters
[in,out]thisBndType object
[in]innertottotal number of inner iterations
[in]kiterPicard iteration number
[in]iendflag indicating if this is the last Picard iteration
[in]icnvgmodflag inficating if the model has met specific convergence criteria
[in,out]cpakstring for user node
[in,out]ipaklocation of the maximum dependent variable change
[in,out]dpakmaximum dependent variable change

Definition at line 128 of file BoundaryPackage.f90.

◆ bnd_cf()

procedure bndmodule::bndtype::bnd_cf ( class(bndtype) this)
inherited

Formulate the hcof and rhs terms for the package that will be added to the coefficient matrix and right-hand side vector. Base implementation that must be extended by each model boundary package.

Parameters
thisBndType object

Definition at line 124 of file BoundaryPackage.f90.

◆ bnd_ck()

procedure bndmodule::bndtype::bnd_ck ( class(bndtype), intent(inout) this)
inherited

Check the boundary package period data. Base implementation that must be extended by each model boundary package.

Parameters
[in,out]thisBndType object

Definition at line 122 of file BoundaryPackage.f90.

◆ bnd_cq()

procedure bndmodule::bndtype::bnd_cq ( class(bndtype), intent(inout) this,
real(dp), dimension(:), intent(in) x,
real(dp), dimension(:), intent(inout), contiguous flowja,
integer(i4b), intent(in), optional iadv )
inherited

Calculate the flow between connected advanced package control volumes. Only advanced boundary packages need to override this method.

Parameters
[in,out]thisBndType object
[in]xcurrent dependent-variable value
[in,out]flowjaflow between two connected control volumes
[in]iadvflag that indicates if this is an advance package

Definition at line 129 of file BoundaryPackage.f90.

◆ bnd_cq_simrate() [1/2]

procedure bndmodule::bndtype::bnd_cq_simrate ( class(bndtype) this,
real(dp), dimension(:), intent(in) hnew,
real(dp), dimension(:), intent(inout) flowja,
integer(i4b), intent(in) imover )
inherited

Calculate the flow between package and the model (for example, GHB and groundwater cell) and store in the simvals variable. This method only needs to be overridden if a different calculation needs to be made.

Parameters
thisBndType object
[in]hnewcurrent dependent-variable value
[in,out]flowjaflow between package and model
[in]imoverflag indicating if the mover package is active

Definition at line 146 of file BoundaryPackage.f90.

◆ bnd_cq_simrate() [2/2]

procedure prtprpmodule::prtprptype::bnd_cq_simrate ( class(prtprptype) this,
real(dp), dimension(:), intent(in) hnew,
real(dp), dimension(:), intent(inout) flowja,
integer(i4b), intent(in) imover )
Parameters
[in,out]flowjaflow between package and model
[in]imoverflag indicating if the mover package is active

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

◆ bnd_cq_simtomvr()

procedure bndmodule::bndtype::bnd_cq_simtomvr ( class(bndtype) this,
real(dp), dimension(:), intent(inout) flowja )
inherited

Calculate the flow between package and the model that is sent to the mover package and store in the simtomvr variable. This method only needs to be overridden if a different calculation needs to be made.

Parameters
thisBndType object
[in,out]flowjaflow between package and model

Definition at line 147 of file BoundaryPackage.f90.

◆ bnd_da() [1/3]

procedure bndextmodule::bndexttype::bnd_da ( class(bndexttype) this)
inherited
Parameters
thisBndExtType object

Definition at line 52 of file BoundaryPackageExt.f90.

◆ bnd_da() [2/3]

procedure bndmodule::bndtype::bnd_da ( class(bndtype) this)
inherited

Deallocate base boundary package scalars and arrays. This method only needs to be overridden if additional variables are defined for a specific package.

Parameters
thisBndType object

Definition at line 137 of file BoundaryPackage.f90.

◆ bnd_da() [3/3]

procedure prtprpmodule::prtprptype::bnd_da ( class(prtprptype) this)

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

◆ bnd_df() [1/2]

procedure bndextmodule::bndexttype::bnd_df ( class(bndexttype), intent(inout) this,
integer(i4b), intent(inout) neq,
class(disbasetype), pointer dis )
inherited

Define base boundary package options and dimensions for a model boundary package.

Parameters
[in,out]thisBndExtType object
[in,out]neqnumber of equations
disdiscretization object

Definition at line 46 of file BoundaryPackageExt.f90.

◆ bnd_df() [2/2]

procedure, public bndmodule::bndtype::bnd_df ( class(bndtype), intent(inout) this,
integer(i4b), intent(inout) neq,
class(disbasetype), pointer dis )
inherited

Define base boundary package options and dimensions for a model boundary package.

Parameters
[in,out]thisBndType object
[in,out]neqnumber of equations
disdiscretization object

Definition at line 116 of file BoundaryPackage.f90.

◆ bnd_df_obs() [1/2]

procedure, public bndmodule::bndtype::bnd_df_obs ( class(bndtype) this)
inherited

Method to define the observation types available in a boundary package. This method should be overridden if observations are supported in a boundary package.

Parameters
thisBndType object

Definition at line 155 of file BoundaryPackage.f90.

◆ bnd_df_obs() [2/2]

procedure, public prtprpmodule::prtprptype::bnd_df_obs ( class(prtprptype) this)

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

◆ bnd_dt()

procedure bndmodule::bndtype::bnd_dt ( class(bndtype) this)
inherited
Parameters
thisBndType object

Definition at line 135 of file BoundaryPackage.f90.

◆ bnd_fc()

procedure bndmodule::bndtype::bnd_fc ( class(bndtype) this,
real(dp), dimension(:), intent(inout) rhs,
integer(i4b), dimension(:), intent(in) ia,
integer(i4b), dimension(:), intent(in) idxglo,
class(matrixbasetype), pointer matrix_sln )
inherited

Add the hcof and rhs terms for the boundary package to the coefficient matrix and right-hand side vector. A boundary package only needs to override this method if it is different for a specific boundary package.

Parameters
thisBndType object
[in,out]rhsright-hand side vector for model
[in]iasolution CRS row pointers
[in]idxglomapping vector for model (local) to solution (global)
matrix_slnsolution coefficient matrix

Definition at line 125 of file BoundaryPackage.f90.

◆ bnd_fn()

procedure bndmodule::bndtype::bnd_fn ( class(bndtype) this,
real(dp), dimension(:), intent(inout) rhs,
integer(i4b), dimension(:), intent(in) ia,
integer(i4b), dimension(:), intent(in) idxglo,
class(matrixbasetype), pointer matrix_sln )
inherited

Calculate and add the Newton-Raphson terms for the boundary package to the coefficient matrix and right-hand side vector. A boundary package only needs to override this method if a specific boundary package needs to add Newton-Raphson terms.

Parameters
thisBndType object
[in,out]rhsright-hand side vector for model
[in]iasolution CRS row pointers
[in]idxglomapping vector for model (local) to solution (global)
matrix_slnsolution coefficient matrix

Definition at line 126 of file BoundaryPackage.f90.

◆ bnd_fp()

procedure bndmodule::bndtype::bnd_fp ( class(bndtype) this)
inherited
Parameters
thisBndType object

Definition at line 136 of file BoundaryPackage.f90.

◆ bnd_mc()

procedure bndmodule::bndtype::bnd_mc ( class(bndtype), intent(inout) this,
integer(i4b), intent(in) moffset,
class(matrixbasetype), pointer matrix_sln )
inherited

Map boundary package connection to the matrix for packages that add connections to the coefficient matrix. An example would be the GWF model MAW package. Base implementation that must be extended.

Parameters
[in,out]thisBndType object
[in]moffsetsolution matrix model offset
matrix_slnglobal system matrix

Definition at line 118 of file BoundaryPackage.f90.

◆ bnd_nur()

procedure bndmodule::bndtype::bnd_nur ( class(bndtype), intent(inout) this,
integer(i4b), intent(in) neqpak,
real(dp), dimension(neqpak), intent(inout) x,
real(dp), dimension(neqpak), intent(in) xtemp,
real(dp), dimension(neqpak), intent(inout) dx,
integer(i4b), intent(inout) inewtonur,
real(dp), intent(inout) dxmax,
integer(i4b), intent(inout) locmax )
inherited

Apply Newton-Raphson under-relaxation for a boundary package. A boundary package only needs to override this method if a specific boundary package needs to apply Newton-Raphson under-relaxation. An example is the MAW package which adds rows to the system of equations and may need to have the dependent-variable constrained by the bottom of the model.

Parameters
[in,out]thisBndType object
[in]neqpaknumber of equations in the package
[in,out]xdependent variable
[in]xtempprevious dependent variable
[in,out]dxchange in dependent variable
[in,out]inewtonurflag indicating if newton-raphson under-relaxation should be applied
[in,out]dxmaxmaximum change in the dependent variable
[in,out]locmaxlocation of the maximum change in the dependent variable

Definition at line 127 of file BoundaryPackage.f90.

◆ bnd_obs_supported() [1/2]

procedure, public bndmodule::bndtype::bnd_obs_supported ( class(bndtype) this)
inherited

Function to determine if observations are supported by the boundary package. By default, observations are not supported. This method should be overridden if observations are supported in a boundary package.

Returns
supported boolean indicating if observations are supported
boolean indicating if observations are supported
Parameters
thisBndType object

Definition at line 154 of file BoundaryPackage.f90.

◆ bnd_obs_supported() [2/2]

procedure, public prtprpmodule::prtprptype::bnd_obs_supported ( class(prtprptype) this)

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

◆ bnd_options()

procedure bndmodule::bndtype::bnd_options ( class(bndtype), intent(inout) this,
character(len=*), intent(inout) option,
logical(lgp), intent(inout) found )
inherited

Read additional options for a boundary package. This method should be overridden options in addition to the base options are implemented in a boundary package.

Parameters
[in,out]thisBndType object
[in,out]optionoption keyword string
[in,out]foundboolean indicating if the option was found

Definition at line 145 of file BoundaryPackage.f90.

◆ bnd_ot_bdsummary()

procedure bndmodule::bndtype::bnd_ot_bdsummary ( class(bndtype) this,
integer(i4b), intent(in) kstp,
integer(i4b), intent(in) kper,
integer(i4b), intent(in) iout,
integer(i4b), intent(in) ibudfl )
inherited

Output advanced boundary package budget summary. This method only needs to be overridden for advanced packages that save budget summaries to the model listing file.

Parameters
thisBndType object
[in]kstptime step number
[in]kperperiod number
[in]ioutflag and unit number for the model listing file
[in]ibudflflag indicating budget should be written

Definition at line 134 of file BoundaryPackage.f90.

◆ bnd_ot_dv()

procedure bndmodule::bndtype::bnd_ot_dv ( class(bndtype) this,
integer(i4b), intent(in) idvsave,
integer(i4b), intent(in) idvprint )
inherited

Output advanced boundary package dependent-variable terms. This method only needs to be overridden for advanced packages that save dependent variable terms for each control volume.

Parameters
thisBndType object
[in]idvsaveflag and unit number for dependent-variable output
[in]idvprintflag indicating if dependent-variable should be written to the model listing file

Definition at line 133 of file BoundaryPackage.f90.

◆ bnd_ot_model_flows()

procedure bndmodule::bndtype::bnd_ot_model_flows ( class(bndtype) this,
integer(i4b), intent(in) icbcfl,
integer(i4b), intent(in) ibudfl,
integer(i4b), intent(in) icbcun,
integer(i4b), dimension(:), intent(in), optional imap )
inherited

Output flow terms between the boundary package and model to a binary file and/or print flows to the model listing file. This method should not need to be overridden.

Parameters
thisBndType object
[in]icbcflflag for cell-by-cell output
[in]ibudflflag indication if cell-by-cell data should be saved
[in]icbcununit number for cell-by-cell output
[in]imapmapping vector that converts the 1 to nbound values to lake number, maw number, etc.

Definition at line 131 of file BoundaryPackage.f90.

◆ bnd_ot_obs()

procedure, public bndmodule::bndtype::bnd_ot_obs ( class(bndtype) this)
inherited

Method to output simulated values for the boundary package. This method should not need to be overridden.

Parameters
thisBndType object

Definition at line 157 of file BoundaryPackage.f90.

◆ bnd_ot_package_flows()

procedure bndmodule::bndtype::bnd_ot_package_flows ( class(bndtype) this,
integer(i4b), intent(in) icbcfl,
integer(i4b), intent(in) ibudfl )
inherited

Output advanced boundary package flow terms. This method only needs to be overridden for advanced packages that save flow terms than contribute to the continuity equation for each control volume.

Parameters
thisBndType object
[in]icbcflflag and unit number for cell-by-cell output
[in]ibudflflag indication if cell-by-cell data should be saved

Definition at line 132 of file BoundaryPackage.f90.

◆ bnd_reset()

procedure bndmodule::bndtype::bnd_reset ( class(bndtype) this)
inherited
Parameters
thisBndType object

Definition at line 123 of file BoundaryPackage.f90.

◆ bnd_rp() [1/3]

procedure bndextmodule::bndexttype::bnd_rp ( class(bndexttype), intent(inout) this)
inherited
Parameters
[in,out]thisBndExtType object

Definition at line 48 of file BoundaryPackageExt.f90.

◆ bnd_rp() [2/3]

procedure bndmodule::bndtype::bnd_rp ( class(bndtype), intent(inout) this)
inherited

Generic method to read and prepare period data for model boundary packages. A boundary package only needs to override this method if period data varies from the standard boundary package.

Parameters
[in,out]thisBndType object

Definition at line 120 of file BoundaryPackage.f90.

◆ bnd_rp() [3/3]

procedure prtprpmodule::prtprptype::bnd_rp ( class(prtprptype), intent(inout) this)

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

◆ bnd_rp_log() [1/2]

procedure bndextmodule::bndexttype::bnd_rp_log ( class(bndexttype), intent(inout) this)
inherited

Called from model control files after bnd_rp(), which ensures bound_value() dispatches to the correct derived type.

Definition at line 49 of file BoundaryPackageExt.f90.

◆ bnd_rp_log() [2/2]

procedure, public bndmodule::bndtype::bnd_rp_log ( class(bndtype), intent(inout) this)
inherited

Write stress period input to the listing file if requested. This default implementation is a no-op; BndExtType overrides it.

Definition at line 159 of file BoundaryPackage.f90.

◆ bnd_rp_obs()

procedure, public bndmodule::bndtype::bnd_rp_obs ( class(bndtype), intent(inout) this)
inherited

Method to read and prepare observations for a boundary package This method should not need to be overridden for most boundary packages.

Parameters
[in,out]thisBndType object

Definition at line 158 of file BoundaryPackage.f90.

◆ bnd_rp_ts()

procedure, public bndmodule::bndtype::bnd_rp_ts ( class(bndtype), intent(inout) this)
inherited

Assign the time series links for the boundary package. This method will need to be overridden for boundary packages that support time series.

Definition at line 162 of file BoundaryPackage.f90.

◆ bound_value()

procedure bndextmodule::bndexttype::bound_value ( class(bndexttype), intent(inout) this,
integer(i4b), intent(in) col,
integer(i4b), intent(in) row )
inherited

Return a bound value associated with an ncolbnd index and row. This function should be overridden in the derived package class.

Parameters
[in,out]thisBndExtType object

Definition at line 65 of file BoundaryPackageExt.f90.

◆ cellid_to_nlist()

procedure bndextmodule::bndexttype::cellid_to_nlist ( class(bndexttype) this)
inherited

Convert period updated cellids to node numbers.

Parameters
thisBndExtType object

Definition at line 59 of file BoundaryPackageExt.f90.

◆ check_cellid()

procedure bndextmodule::bndexttype::check_cellid ( class(bndexttype) this,
integer(i4b), intent(in) ii,
integer(i4b), dimension(:), intent(in) cellid,
integer(i4b), dimension(:), intent(in) mshape,
integer(i4b), intent(in) ndim )
inherited
Parameters
thisBndExtType object
[in]mshapemodel shape
[in]ndimsize of mshape

Definition at line 63 of file BoundaryPackageExt.f90.

◆ copy_boundname()

procedure bndmodule::bndtype::copy_boundname ( class(bndtype), intent(inout) this)
inherited

boundnames_cst is an array of type(CharacterStringType), which can be stored in the MemoryManager.

Parameters
[in,out]thisBndType object

Definition at line 150 of file BoundaryPackage.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.

◆ default_nodelist()

procedure bndextmodule::bndexttype::default_nodelist ( class(bndexttype) this)
inherited

Equivalent to reading layer number array as CONSTANT 1

Definition at line 62 of file BoundaryPackageExt.f90.

◆ define_listlabel() [1/2]

procedure bndmodule::bndtype::define_listlabel ( class(bndtype), intent(inout) this)
inherited

Method defined the list label for the boundary package. This method needs to be overridden by each boundary package.

Parameters
[in,out]thisBndType object

Definition at line 149 of file BoundaryPackage.f90.

◆ define_listlabel() [2/2]

procedure prtprpmodule::prtprptype::define_listlabel ( class(prtprptype), intent(inout) this)

Definition at line 87 of file prt-prp.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_particle()

procedure prtprpmodule::prtprptype::initialize_particle ( class(prtprptype), intent(inout) this,
type(particletype), intent(inout), pointer particle,
integer(i4b), intent(in) ip,
real(dp), intent(in) trelease )
Parameters
[in,out]thisthis instance
[in,out]particlethe particle
[in]ipparticle index
[in]treleaserelease time

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

◆ layarr_to_nlist()

procedure bndextmodule::bndexttype::layarr_to_nlist ( class(bndexttype) this)
inherited

This is a module scoped routine to check for I<filtyp> input. If array input was provided, INI<filtyp> and I<filtyp> will be allocated in the input context. If the read state variable INI<filtyp> shows values were given in this period block, I<filtyp> input was read and is used here to update the nodelist.

Parameters
thisBndExtType object

Definition at line 61 of file BoundaryPackageExt.f90.

◆ log_options()

procedure bndextmodule::bndexttype::log_options ( class(bndexttype), intent(inout) this,
type(bndextfoundtype), intent(in) found,
character(len=*), intent(in) sfacauxname )
inherited
Parameters
[in,out]thisBndExtType object

Definition at line 57 of file BoundaryPackageExt.f90.

◆ log_release()

procedure prtprpmodule::prtprptype::log_release ( class(prtprptype), intent(inout) this)
Parameters
[in,out]thisprp

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

◆ nodeu_to_nlist()

procedure bndextmodule::bndexttype::nodeu_to_nlist ( class(bndexttype) this)
inherited

Convert period user nodes to reduced nodes. Inactive cells are excluded by the input loader.

Parameters
thisBndExtType object

Definition at line 60 of file BoundaryPackageExt.f90.

◆ pack_initialize()

procedure bndmodule::bndtype::pack_initialize ( class(bndtype) this)
inherited

Allocate and initialize select base boundary package members. This method needs to be overridden by a package if it is needed for a specific package.

Parameters
thisBndType object

Definition at line 141 of file BoundaryPackage.f90.

◆ pak_setup_outputtab()

procedure, private bndmodule::bndtype::pak_setup_outputtab ( class(bndtype), intent(inout) this)
privateinherited

Setup output table for a boundary package that is used to output package to model flow terms to the model listing file.

Parameters
[in,out]thisBndType object

Definition at line 151 of file BoundaryPackage.f90.

◆ prp_allocate_arrays()

procedure prtprpmodule::prtprptype::prp_allocate_arrays ( class(prtprptype) this,
integer(i4b), dimension(:), optional, pointer, contiguous nodelist,
real(dp), dimension(:, :), optional, pointer, contiguous auxvar )

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

◆ prp_allocate_scalars()

procedure prtprpmodule::prtprptype::prp_allocate_scalars ( class(prtprptype) this)

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

◆ prp_check_releases()

procedure prtprpmodule::prtprptype::prp_check_releases ( class(prtprptype), intent(inout) this)

Call after release times, the release time frequency and the default are loaded. Then an empty time selection means no time-based releases, and IONPER still holds the first period block's number, or nper + 1 if there is no block to load.

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

◆ prp_commit()

procedure prtprpmodule::prtprptype::prp_commit ( class(prtprptype) this)

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

◆ prp_load_default_release()

procedure prtprpmodule::prtprptype::prp_load_default_release ( class(prtprptype), intent(inout) this)

The default depends on the input only: no explicit release times, no release time frequency, and no period blocks. It doesn't depend on the schedule, which only holds the times that will be used, so explicit times that are all dropped don't trigger the default.

The exchange PRP doesn't get this default, on purpose: it carries particles between models and never calls prp_dimensions.

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

◆ prp_load_releasetimefrequency()

procedure prtprpmodule::prtprptype::prp_load_releasetimefrequency ( class(prtprptype), intent(inout) this)

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

◆ prp_log_options()

procedure prtprpmodule::prtprptype::prp_log_options ( class(prtprptype), intent(inout) this,
type(prtprpparamfoundtype), intent(in) found,
character(len=*), intent(in) trackfile,
character(len=*), intent(in) trackcsvfile )

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

◆ prp_packagedata()

procedure prtprpmodule::prtprptype::prp_packagedata ( class(prtprptype), intent(inout) this)

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

◆ prp_releasetimes()

procedure prtprpmodule::prtprptype::prp_releasetimes ( class(prtprptype), intent(inout) this)

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

◆ prp_set_pointers()

procedure prtprpmodule::prtprptype::prp_set_pointers ( class(prtprptype) this,
integer(i4b), dimension(:), pointer, contiguous ibound,
integer(i4b), dimension(:), pointer, contiguous izone )

Definition at line 88 of file prt-prp.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 bndmodule::bndtype::read_dimensions ( class(bndtype), intent(inout) this)
inherited

Read base dimensions for boundary packages. This method should not need to be overridden unless more than MAXBOUND is specified in the DIMENSIONS block.

Parameters
[in,out]thisBndType object

Definition at line 143 of file BoundaryPackage.f90.

◆ read_initial_attr()

procedure bndmodule::bndtype::read_initial_attr ( class(bndtype), intent(inout) this)
inherited

Read initial parameters for a boundary package. This method is not needed for most boundary packages. The SFR package is an example of a package that has overridden this method.

Parameters
[in,out]thisBndType object

Definition at line 144 of file BoundaryPackage.f90.

◆ read_options()

procedure bndmodule::bndtype::read_options ( class(bndtype), intent(inout) this)
inherited

Read base options for boundary packages.

Parameters
[in,out]thisBndType object

Definition at line 142 of file BoundaryPackage.f90.

◆ release()

procedure prtprpmodule::prtprptype::release ( class(prtprptype), intent(inout) this,
integer(i4b), intent(in) ip,
real(dp), intent(in) trelease )

Releasing a particle entails validating the particle's coordinates and settings, transforming its coordinates if needed, initializing the particle's initial tracking time to the given release time, storing the particle in the particle store (from which the PRT model will later retrieve it, apply the tracking method, and check it in again), and accumulating the particle's mass (the total mass released from each release point is calculated for budget reporting).

Parameters
[in,out]thisthis instance
[in]ipparticle index
[in]treleaserelease time

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

◆ report_ifno_coverage()

procedure bndextmodule::bndexttype::report_ifno_coverage ( class(bndexttype), intent(inout) this,
integer(i4b), dimension(:), intent(in) nboundchk,
integer(i4b), intent(in) nfeatures,
character(len=*), intent(in) feature_label,
character(len=*), intent(in) blockname,
logical(lgp), intent(in), optional check_missing )
inherited

Set check_missing=.false. for an optional block where not every feature is expected to have a row (duplicates are still reported).

Definition at line 51 of file BoundaryPackageExt.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_pointers()

procedure bndmodule::bndtype::set_pointers ( class(bndtype) this,
integer(i4b), pointer neq,
integer(i4b), dimension(:), pointer, contiguous ibound,
real(dp), dimension(:), pointer, contiguous xnew,
real(dp), dimension(:), pointer, contiguous xold,
real(dp), dimension(:), pointer, contiguous flowja )
inherited

Set pointers to model variables so that a package has access to these variables. This base method should not need to be overridden.

Parameters
thisBndType object
neqnumber of equations in the model
iboundmodel idomain
xnewcurrent dependent variable
xoldprevious dependent variable
flowjaconnection flow terms

Definition at line 148 of file BoundaryPackage.f90.

◆ source_dimensions() [1/2]

procedure bndextmodule::bndexttype::source_dimensions ( class(bndexttype), intent(inout) this)
inherited
Parameters
[in,out]thisBndExtType object

Definition at line 58 of file BoundaryPackageExt.f90.

◆ source_dimensions() [2/2]

procedure prtprpmodule::prtprptype::source_dimensions ( class(prtprptype), intent(inout) this)

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

◆ source_options() [1/2]

procedure bndextmodule::bndexttype::source_options ( class(bndexttype), intent(inout) this)
inherited
Parameters
[in,out]thisBndExtType object

Definition at line 56 of file BoundaryPackageExt.f90.

◆ source_options() [2/2]

procedure prtprpmodule::prtprptype::source_options ( class(prtprptype), intent(inout) this)

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

◆ validate_ifno()

procedure bndextmodule::bndexttype::validate_ifno ( class(bndexttype), intent(inout) this,
integer(i4b), intent(in) ifno_val,
integer(i4b), intent(in) nfeatures,
integer(i4b), dimension(:), intent(inout) nboundchk,
character(len=*), intent(in) feature_label,
character(len=*), intent(in) blockname )
inherited

Returns the validated feature index, or 0 if out of range (an error is logged; the caller should skip further processing for the row).

Definition at line 50 of file BoundaryPackageExt.f90.

◆ validate_release_point()

procedure prtprpmodule::prtprptype::validate_release_point ( class(prtprptype), intent(inout) this,
integer(i4b), intent(in) ic,
real(dp), intent(in) x,
real(dp), intent(in) y,
real(dp), intent(in) z )

Terminate with an error if the release point lies outside the given cell, or if the point is above or below the grid top or bottom, respectively.

Parameters
[in,out]thisthis instance
[in]iccell index
[in]zrelease point

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

◆ write_lstfile()

procedure bndextmodule::bndexttype::write_lstfile ( class(bndexttype) this)
inherited

Log period based input. This routine requires a package specific bound_value() routine to report accurate bound values.

Parameters
thisBndExtType object

Definition at line 64 of file BoundaryPackageExt.f90.

Member Data Documentation

◆ allowtimearrayseries

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

Definition at line 95 of file BoundaryPackage.f90.

◆ applied_kper

integer(i4b) prtprpmodule::prtprptype::applied_kper

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

77 integer(I4B) :: applied_kper !< period for which configuration was last applied

◆ auxname

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

Definition at line 51 of file BoundaryPackage.f90.

◆ auxname_cst

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

Definition at line 53 of file BoundaryPackage.f90.

◆ auxvar

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

Definition at line 78 of file BoundaryPackage.f90.

◆ bound

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

Definition at line 75 of file BoundaryPackage.f90.

◆ boundname

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

Definition at line 55 of file BoundaryPackage.f90.

◆ boundname_cst

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

Definition at line 57 of file BoundaryPackage.f90.

◆ cellid

integer(i4b), dimension(:, :), pointer, contiguous bndextmodule::bndexttype::cellid => null()
inherited

Definition at line 40 of file BoundaryPackageExt.f90.

◆ condinput

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

Definition at line 88 of file BoundaryPackage.f90.

◆ dis

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

Definition at line 50 of file NumericalPackage.f90.

◆ drape

logical(lgp), pointer prtprpmodule::prtprptype::drape => null()

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

◆ errortab

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

Definition at line 113 of file BoundaryPackage.f90.

◆ extend

logical(lgp), pointer prtprpmodule::prtprptype::extend => null()

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

◆ extol

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

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

◆ featureauxvar

real(dp), dimension(:, :), pointer, contiguous bndextmodule::bndexttype::featureauxvar => null()
inherited

Definition at line 44 of file BoundaryPackageExt.f90.

◆ filtyp

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

Definition at line 33 of file NumericalPackage.f90.

◆ flowja

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

Definition at line 106 of file BoundaryPackage.f90.

◆ fmi

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

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

◆ frctrn

logical(lgp), pointer prtprpmodule::prtprptype::frctrn => null()

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

◆ hcof

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

Definition at line 76 of file BoundaryPackage.f90.

◆ iasym

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

Definition at line 41 of file NumericalPackage.f90.

◆ iauxmultcol

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

Definition at line 69 of file BoundaryPackage.f90.

◆ ibcnum

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

Definition at line 62 of file BoundaryPackage.f90.

◆ ibound

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

Definition at line 103 of file BoundaryPackage.f90.

◆ icelltype

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

Definition at line 107 of file BoundaryPackage.f90.

◆ ichkmeth

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

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

◆ ictmempath

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

Definition at line 108 of file BoundaryPackage.f90.

◆ icycwin

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

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

◆ id

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

Definition at line 37 of file NumericalPackage.f90.

◆ idrymeth

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

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

◆ iexmeth

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

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

◆ imover

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

Definition at line 83 of file BoundaryPackage.f90.

◆ inamedbound

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

Definition at line 68 of file BoundaryPackage.f90.

◆ indxconvertflux

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

Definition at line 94 of file BoundaryPackage.f90.

◆ inewton

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

Definition at line 40 of file NumericalPackage.f90.

◆ inobspkg

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

Definition at line 98 of file BoundaryPackage.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.

◆ inputtab

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

Definition at line 111 of file BoundaryPackage.f90.

◆ inunit

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

Definition at line 38 of file NumericalPackage.f90.

◆ ioffset

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

Definition at line 71 of file BoundaryPackage.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.

◆ iper

integer(i4b), pointer bndextmodule::bndexttype::iper
inherited

Definition at line 35 of file BoundaryPackageExt.f90.

35 integer(I4B), pointer :: iper

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

◆ irlstls

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

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

◆ isadvpak

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

Definition at line 61 of file BoundaryPackage.f90.

◆ iscloc

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

Definition at line 66 of file BoundaryPackage.f90.

◆ istopweaksink

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

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

◆ istopzone

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

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

◆ itrkcsv

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

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

◆ itrkhdr

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

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

◆ itrkout

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

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

◆ ivsc

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

Definition at line 87 of file BoundaryPackage.f90.

◆ lastonper

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

Definition at line 46 of file NumericalPackage.f90.

◆ listlabel

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

Definition at line 49 of file BoundaryPackage.f90.

◆ localz

logical(lgp), pointer prtprpmodule::prtprptype::localz => null()

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

◆ maxbound

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

Definition at line 63 of file BoundaryPackage.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.

◆ name_model

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

Definition at line 26 of file NumericalPackage.f90.

◆ naux

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

Definition at line 67 of file BoundaryPackage.f90.

◆ nbound

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

Definition at line 64 of file BoundaryPackage.f90.

◆ ncolbnd

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

Definition at line 65 of file BoundaryPackage.f90.

◆ neq

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

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()
inherited

Definition at line 73 of file BoundaryPackage.f90.

◆ nodeulist

integer(i4b), dimension(:), pointer, contiguous bndextmodule::bndexttype::nodeulist => null()
inherited

Definition at line 41 of file BoundaryPackageExt.f90.

◆ noupdateauxvar

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

Definition at line 74 of file BoundaryPackage.f90.

◆ npakeq

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

Definition at line 70 of file BoundaryPackage.f90.

◆ nparticles

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

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

◆ nreleasepoints

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

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

◆ nreleasetimes

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

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

◆ obs

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

Definition at line 99 of file BoundaryPackage.f90.

◆ offset

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

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

◆ outputtab

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

Definition at line 112 of file BoundaryPackage.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.

◆ pakmvrobj

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

Definition at line 84 of file BoundaryPackage.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

◆ particles

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

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

◆ particles_staging

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

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

◆ period_block_lines

character(len=linelength), dimension(:), allocatable prtprpmodule::prtprptype::period_block_lines

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

76 character(len=LINELENGTH), allocatable :: period_block_lines(:) !< last period block configuration for fill-forward

◆ pkg_ifno

integer(i4b), dimension(:), pointer, contiguous bndextmodule::bndexttype::pkg_ifno => null()
inherited

Definition at line 43 of file BoundaryPackageExt.f90.

◆ readarraygrid

logical(lgp), pointer bndextmodule::bndexttype::readarraygrid
inherited

Definition at line 36 of file BoundaryPackageExt.f90.

36 logical(LGP), pointer :: readarraygrid

◆ readasarrays

logical(lgp), pointer bndextmodule::bndexttype::readasarrays
inherited

Definition at line 37 of file BoundaryPackageExt.f90.

37 logical(LGP), pointer :: readasarrays

◆ rhs

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

Definition at line 77 of file BoundaryPackage.f90.

◆ rptm

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

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

◆ rptname

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

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

◆ rptnode

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

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

◆ rptx

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

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

◆ rpty

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

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

◆ rptz

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

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

◆ rptzone

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

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

◆ rtfreq

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

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

◆ rttol

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

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

◆ schedule

type(particlereleasescheduletype), pointer prtprpmodule::prtprptype::schedule => null()

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

◆ simtomvr

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

Definition at line 80 of file BoundaryPackage.f90.

◆ simvals

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

Definition at line 79 of file BoundaryPackage.f90.

◆ stoptime

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

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

◆ stoptraveltime

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

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

◆ tasmanager

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

Definition at line 93 of file BoundaryPackage.f90.

◆ text

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

Definition at line 50 of file BoundaryPackage.f90.

◆ ts_active

logical(lgp), pointer bndextmodule::bndexttype::ts_active
inherited

Definition at line 38 of file BoundaryPackageExt.f90.

38 logical(LGP), pointer :: ts_active !< .true. if TS6 files are configured in OPTIONS

◆ tsmanager

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

Definition at line 92 of file BoundaryPackage.f90.

◆ viscratio

real(dp), dimension(:), allocatable bndmodule::bndtype::viscratio
inherited

Definition at line 89 of file BoundaryPackage.f90.

89 real(DP), dimension(:), allocatable :: viscratio !< viscosity ratio applied to each boundary conductance

◆ xnew

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

Definition at line 104 of file BoundaryPackage.f90.

◆ xold

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

Definition at line 105 of file BoundaryPackage.f90.


The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Model/ParticleTracking/prt-prp.f90