![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|


Public Member Functions | |
| procedure | set_pointers (this, neq, ibound, xnew, xold, flowja) |
| Set pointers to model arrays and variables so that a package has access to these items. | |
| procedure | bnd_ac (this, moffset, sparse) |
| Add package connection to matrix. | |
| procedure | bnd_mc (this, moffset, matrix_sln) |
| Advanced package transport map package connections to matrix. | |
| procedure | bnd_ar (this) |
| Advanced package transport allocate and read (ar) routine. | |
| procedure | bnd_rp (this) |
| Advanced package transport read and prepare (rp) routine. | |
| procedure | bnd_ad (this) |
| Advanced package transport routine. | |
| procedure, public | apt_ad_resync (this) |
| made public for sft/sfe | |
| procedure | bnd_reset (this) |
| Override bnd reset for custom mover logic. | |
| procedure | bnd_fc (this, rhs, ia, idxglo, matrix_sln) |
| procedure, public | apt_fc_expanded (this, rhs, ia, idxglo, matrix_sln) |
| Advanced package transport fill coefficient (fc) method. | |
| procedure, public | apt_ad_chk (this) |
| procedure | pak_fc_expanded (this, rhs, ia, idxglo, matrix_sln) |
| Advanced package transport fill coefficient (fc) method. | |
| procedure, public | apt_cfupdate (this) |
| Advanced package transport routine. | |
| procedure | apt_check_valid (this, itemno) |
| Advanced package transport routine. | |
| procedure | apt_setting_value (this, itemno, key) |
| Virtual hook: value for a package-specific PERIOD setting. Override in individual packages to supply the already-resolved value for a PERIOD field beyond STATUS, CONCENTRATION/TEMPERATURE, and AUXILIARY, so the shared apt_rp table echo can print it. | |
| procedure | apt_ad_ts (this) |
| Virtual hook: called every timestep, after the time series manager advances, before apt_ad_chk. No-op extension point for packages to override. | |
| procedure | apt_accumulate_ccterm (this, ilak, rrate, ccratin, ccratout) |
| Accumulate constant concentration (or temperature) terms for budget. | |
| procedure | bnd_cq (this, x, flowja, iadv) |
| Advanced package transport calculate flows (cq) routine. | |
| procedure | bnd_ot_package_flows (this, icbcfl, ibudfl) |
| Save advanced package flows routine. | |
| procedure | bnd_ot_dv (this, idvsave, idvprint) |
| procedure | bnd_ot_bdsummary (this, kstp, kper, iout, ibudfl) |
| Print advanced package transport dependent variables. | |
| procedure | bnd_da (this) |
| Deallocate memory. | |
| procedure | allocate_scalars (this) |
| Allocate scalars. | |
| procedure | apt_allocate_index_arrays (this) |
| Allocate index arrays. | |
| procedure | apt_allocate_arrays (this) |
| Allocate arrays. | |
| procedure | apt_checkin_deprecated_names (this) |
| Alias deprecated advanced transport variable names. | |
| procedure | find_apt_package (this) |
| Find corresponding advanced package transport package. | |
| procedure | apt_solve (this) |
| Add terms specific to advanced package transport to the explicit solve. | |
| procedure | pak_solve (this) |
| Add terms specific to advanced package transport features to the explicit solve routine. | |
| procedure | source_options (this) |
| Source OPTIONS block from the input context. | |
| procedure | source_dimensions (this) |
| Source DIMENSIONS from the flow package; allocate package arrays. | |
| procedure | apt_source_cvs (this) |
| Source PACKAGEDATA feature information from the input context. | |
| procedure | read_initial_attr (this) |
| Read the initial parameters for an advanced package. | |
| procedure | define_listlabel (this) |
| Define the list heading that is written to iout when PRINT_INPUT option is used. | |
| procedure | bnd_obs_supported (this) |
| Determine whether an obs type is supported. | |
| procedure | bnd_df_obs (this) |
| Define observation type. | |
| procedure | pak_df_obs (this) |
| Define apt observation type. | |
| procedure | pak_rp_obs (this, obsrv, found) |
| Process package specific obs. | |
| procedure | bnd_rp_obs (this) |
| Read and prepare apt-related observations. | |
| procedure | rp_obs_byfeature (this, obsrv) |
| Prepare observation. | |
| procedure | rp_obs_budterm (this, obsrv, budterm) |
| Prepare observation. | |
| procedure | rp_obs_flowjaface (this, obsrv, budterm) |
| Prepare observation. | |
| procedure | bnd_bd_obs (this) |
| Calculate observation values. | |
| procedure | pak_bd_obs (this, obstypeid, jj, v, found) |
| Check if observation exists in an advanced package. | |
| procedure | pak_get_nbudterms (this) |
| Function to return the number of budget terms just for this package. | |
| procedure | apt_setup_budobj (this) |
| Set up the budget object that stores advanced package flow terms. | |
| procedure | pak_setup_budobj (this, idx) |
| Set up a budget object that stores an advanced package flows. | |
| procedure | apt_fill_budobj (this, x, flowja) |
| Copy flow terms into thisbudobj. | |
| procedure | pak_fill_budobj (this, idx, x, flowja, ccratin, ccratout) |
| Copy flow terms into thisbudobj, must be overridden. | |
| procedure, public | apt_get_volumes (this, icv, vnew, vold, delt) |
| made public for sft/sfe | |
| procedure, public | apt_stor_term (this, ientry, n1, n2, rrate, rhsval, hcofval) |
| Account for mass or energy storage in advanced package features. | |
| procedure, public | apt_tmvr_term (this, ientry, n1, n2, rrate, rhsval, hcofval) |
| Account for mass or energy transferred to the MVR package. | |
| procedure, public | apt_fmvr_term (this, ientry, n1, n2, rrate, rhsval, hcofval) |
| made public for uze | |
| procedure, public | apt_fjf_term (this, ientry, n1, n2, rrate, rhsval, hcofval) |
| made public for uze | |
| procedure, public | get_mvr_depvar (this) |
| Advanced package transport utility function. | |
| 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 | |
| character(len=lenpackagename) | flowpackagename = '' |
| name of corresponding flow package | |
| character(len=8), dimension(:), pointer, contiguous | status => null() |
| active, inactive, constant | |
| character(len=lenauxname) | cauxfpconc = '' |
| name of aux column in flow package auxvar array for concentration (or temperature) | |
| integer(i4b), pointer | iauxfpconc => null() |
| column in flow package bound array to insert concs | |
| integer(i4b), pointer | imatrows => null() |
| if active, add new rows to matrix | |
| integer(i4b), pointer | iprconc => null() |
| print conc to listing file | |
| integer(i4b), pointer | iconcout => null() |
| unit number for conc output file | |
| integer(i4b), pointer | ibudgetout => null() |
| unit number for budget output file | |
| integer(i4b), pointer | ibudcsv => null() |
| unit number for csv budget output file | |
| integer(i4b), pointer | ncv => null() |
| number of control volumes | |
| integer(i4b), pointer | igwfaptpak => null() |
| package number of corresponding this package | |
| integer(i4b), pointer | idxprepak => null() |
| budget-object index that precedes package-specific budget objects | |
| integer(i4b), pointer | idxlastpak => null() |
| budget-object index of last package-specific budget object | |
| real(dp), dimension(:), pointer, contiguous | strt => null() |
| starting feature concentration (or temperature) | |
| integer(i4b), dimension(:), pointer, contiguous | idxlocnode => null() |
| map position in global rhs and x array of pack entry | |
| integer(i4b), dimension(:), pointer, contiguous | idxpakdiag => null() |
| map diag position of feature in global amat | |
| integer(i4b), dimension(:), pointer, contiguous | idxdglo => null() |
| map position in global array of package diagonal row entries | |
| integer(i4b), dimension(:), pointer, contiguous | idxoffdglo => null() |
| map position in global array of package off diagonal row entries | |
| integer(i4b), dimension(:), pointer, contiguous | idxsymdglo => null() |
| map position in global array of package diagonal entries to model rows | |
| integer(i4b), dimension(:), pointer, contiguous | idxsymoffdglo => null() |
| map position in global array of package off diagonal entries to model rows | |
| integer(i4b), dimension(:), pointer, contiguous | idxfjfdglo => null() |
| map diagonal feature to feature in global amat | |
| integer(i4b), dimension(:), pointer, contiguous | idxfjfoffdglo => null() |
| map off diagonal feature to feature in global amat | |
| integer(i4b), dimension(:), pointer, contiguous | iboundpak => null() |
| package ibound | |
| real(dp), dimension(:), pointer, contiguous | xnewpak => null() |
| feature concentration (or temperature) for current time step | |
| real(dp), dimension(:), pointer, contiguous | xoldpak => null() |
| feature concentration (or temperature) from previous time step | |
| real(dp), dimension(:), pointer, contiguous | dbuff => null() |
| temporary storage array | |
| character(len=lenboundname), dimension(:), pointer, contiguous | featname => null() |
| real(dp), dimension(:), pointer, contiguous | concfeat => null() |
| concentration (or temperature) of the feature | |
| type(tspfmitype), pointer | fmi => null() |
| pointer to fmi object | |
| real(dp), dimension(:), pointer, contiguous | qsto => null() |
| mass (or energy) flux due to storage change | |
| real(dp), dimension(:), pointer, contiguous | ccterm => null() |
| mass (or energy) flux required to maintain constant concentration (or temperature) | |
| integer(i4b), pointer | idxbudfjf => null() |
| index of flow ja face in flowbudptr | |
| integer(i4b), pointer | idxbudgwf => null() |
| index of gwf terms in flowbudptr | |
| integer(i4b), pointer | idxbudsto => null() |
| index of storage terms in flowbudptr | |
| integer(i4b), pointer | idxbudtmvr => null() |
| index of to mover terms in flowbudptr | |
| integer(i4b), pointer | idxbudfmvr => null() |
| index of from mover terms in flowbudptr | |
| integer(i4b), pointer | idxbudaux => null() |
| index of auxiliary terms in flowbudptr | |
| integer(i4b), dimension(:), pointer, contiguous | idxbudssm => null() |
| flag that flowbudptrbuditem is a general solute source/sink | |
| integer(i4b), pointer | nconcbudssm => null() |
| number of concbudssm terms (columns) | |
| real(dp), dimension(:, :), pointer, contiguous | concbudssm => null() |
| user specified concentrations (or temperatures) for flow terms | |
| real(dp), dimension(:), pointer, contiguous | qmfrommvr => null() |
| a mass or energy flow coming from the mover that needs to be added | |
| real(dp), pointer | eqnsclfac => null() |
| governing equation scale factor; =1. for solute; =rhow*cpw for energy | |
| character(len=lenvarname) | depvartype = '' |
| stores string identifying dependent variable type, depending on model type | |
| character(len=lenvarname) | depvarunit = '' |
| "mass" or "energy" | |
| character(len=lenvarname) | depvarunitabbrev = '' |
| "M" or "E" | |
| type(bndtype), pointer | flowpackagebnd => null() |
| type(budgetobjecttype), pointer | budobj => null() |
| apt solute budget object | |
| type(budgetobjecttype), pointer | flowbudptr => null() |
| GWF flow budget object. | |
| type(tabletype), pointer | dvtab => null() |
| 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 | apt_fc_nonexpanded (this, rhs, ia, idxglo, matrix_sln) |
| Advanced package transport fill coefficient (fc) method. | |
| procedure, private | apt_copy2flowp (this) |
| Copy concentrations (or temperatures) into flow package aux variable. | |
| procedure, private | apt_setup_tableobj (this) |
| Setup a table object an advanced package. | |
| procedure, private | pak_setup_outputtab (this) |
| Setup output table for package. | |
Definition at line 73 of file tsp-apt.f90.
|
inherited |
Allocate and initialize base boundary package arrays. This method only needs to be overridden if additional arrays are defined for a specific package.
| this | BndExtType object |
| nodelist | package nodelist |
| auxvar | package aux variable array |
Definition at line 54 of file BoundaryPackageExt.f90.
|
inherited |
Allocate and initialize base boundary package arrays. This method only needs to be overridden if additional arrays are defined for a specific package.
| this | BndType object |
| nodelist | package nodelist |
| auxvar | package aux variable array |
Definition at line 140 of file BoundaryPackage.f90.
|
inherited |
| this | BndExtType object |
Definition at line 55 of file BoundaryPackageExt.f90.
|
inherited |
Allocate and initialize base boundary package scalars. This method only needs to be overridden if additional scalars are defined for a specific package.
| this | BndExtType object |
Definition at line 53 of file BoundaryPackageExt.f90.
|
inherited |
Allocate and initialize base boundary package scalars. This method only needs to be overridden if additional scalars are defined for a specific package.
| this | BndType object |
Definition at line 139 of file BoundaryPackage.f90.
|
inherited |
Allocate and initialize base numerical package scalars.
| this | NumericalPackageType object |
Definition at line 54 of file NumericalPackage.f90.
| procedure tspaptmodule::tspapttype::allocate_scalars | ( | class(tspapttype) | this | ) |
Allocate scalar variables for an advanced package
Definition at line 158 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::apt_accumulate_ccterm | ( | class(tspapttype) | this, |
| integer(i4b), intent(in) | ilak, | ||
| real(dp), intent(in) | rrate, | ||
| real(dp), intent(inout) | ccratin, | ||
| real(dp), intent(inout) | ccratout ) |
Definition at line 152 of file tsp-apt.f90.
| procedure, public tspaptmodule::tspapttype::apt_ad_chk | ( | class(tspapttype), intent(inout) | this | ) |
Definition at line 145 of file tsp-apt.f90.
| procedure, public tspaptmodule::tspapttype::apt_ad_resync | ( | class(tspapttype) | this | ) |
Called directly by packages that override bnd_ad (e.g. SFT/SFE) so apt_ad_ts/apt_ad_chk still dispatch to their own overrides.
Definition at line 141 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::apt_ad_ts | ( | class(tspapttype), intent(inout) | this | ) |
Definition at line 151 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::apt_allocate_arrays | ( | class(tspapttype), intent(inout) | this | ) |
Allocate advanced package transport arrays
Definition at line 160 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::apt_allocate_index_arrays | ( | class(tspapttype), intent(inout) | this | ) |
Allocate arrays that map to locations in the numerical solution
Definition at line 159 of file tsp-apt.f90.
| procedure, public tspaptmodule::tspapttype::apt_cfupdate | ( | class(tspapttype) | this | ) |
Calculate advanced package transport hcof and rhs so transport budget is calculated.
Definition at line 148 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::apt_check_valid | ( | class(tspapttype), intent(inout) | this, |
| integer(i4b), intent(in) | itemno ) |
Determine if a valid feature number has been specified.
Definition at line 149 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::apt_checkin_deprecated_names | ( | class(tspapttype), intent(inout) | this | ) |
IDM integration moved the feature concentration (or temperature) and auxiliary arrays into the input context, renaming both. These aliases share memory with the relocated variables so that programs addressing them through the API by their old package-path names continue to resolve; each use is reported as deprecated. Each package overrides this routine to alias its own deprecated names and must call this base routine first; a package without an override only gets the names aliased here.
Definition at line 161 of file tsp-apt.f90.
|
private |
Definition at line 191 of file tsp-apt.f90.
| procedure, public tspaptmodule::tspapttype::apt_fc_expanded | ( | class(tspapttype) | this, |
| real(dp), dimension(:), intent(inout) | rhs, | ||
| integer(i4b), dimension(:), intent(in) | ia, | ||
| integer(i4b), dimension(:), intent(in) | idxglo, | ||
| class(matrixbasetype), pointer | matrix_sln ) |
Routine to formulate the expanded matrix case in which new rows are added to the system of equations for each advanced package transport feature
Definition at line 144 of file tsp-apt.f90.
|
private |
Routine to formulate the nonexpanded matrix case in which feature concentrations (or temperatures) are solved explicitly
Definition at line 147 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::apt_fill_budobj | ( | class(tspapttype) | this, |
| real(dp), dimension(:), intent(in) | x, | ||
| real(dp), dimension(:), intent(inout), contiguous | flowja ) |
Definition at line 184 of file tsp-apt.f90.
| procedure, public tspaptmodule::tspapttype::apt_fjf_term | ( | class(tspapttype) | this, |
| integer(i4b), intent(in) | ientry, | ||
| integer(i4b), intent(inout) | n1, | ||
| integer(i4b), intent(inout) | n2, | ||
| real(dp), intent(inout), optional | rrate, | ||
| real(dp), intent(inout), optional | rhsval, | ||
| real(dp), intent(inout), optional | hcofval ) |
Definition at line 190 of file tsp-apt.f90.
| procedure, public tspaptmodule::tspapttype::apt_fmvr_term | ( | class(tspapttype) | this, |
| integer(i4b), intent(in) | ientry, | ||
| integer(i4b), intent(inout) | n1, | ||
| integer(i4b), intent(inout) | n2, | ||
| real(dp), intent(inout), optional | rrate, | ||
| real(dp), intent(inout), optional | rhsval, | ||
| real(dp), intent(inout), optional | hcofval ) |
Definition at line 189 of file tsp-apt.f90.
| procedure, public tspaptmodule::tspapttype::apt_get_volumes | ( | class(tspapttype) | this, |
| integer(i4b), intent(in) | icv, | ||
| real(dp), intent(inout) | vnew, | ||
| real(dp), intent(inout) | vold, | ||
| real(dp), intent(in) | delt ) |
Definition at line 186 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::apt_setting_value | ( | class(tspapttype), intent(inout) | this, |
| integer(i4b), intent(in) | itemno, | ||
| character(len=*), intent(in) | key ) |
| [in] | itemno | feature number |
| [in] | key | SETTING dispatch key |
Definition at line 150 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::apt_setup_budobj | ( | class(tspapttype) | this | ) |
Definition at line 182 of file tsp-apt.f90.
|
private |
Set up the table object that is used to write the apt concentration (or temperature) data. The terms listed here must correspond in the apt_ot method.
Definition at line 192 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::apt_solve | ( | class(tspapttype) | this | ) |
Explicit solve for concentration (or temperature) in advaced package features, which is an alternative to the iterative implicit solve.
Definition at line 163 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::apt_source_cvs | ( | class(tspapttype), intent(inout) | this | ) |
Definition at line 167 of file tsp-apt.f90.
| procedure, public tspaptmodule::tspapttype::apt_stor_term | ( | class(tspapttype) | this, |
| integer(i4b), intent(in) | ientry, | ||
| integer(i4b), intent(inout) | n1, | ||
| integer(i4b), intent(inout) | n2, | ||
| real(dp), intent(inout), optional | rrate, | ||
| real(dp), intent(inout), optional | rhsval, | ||
| real(dp), intent(inout), optional | hcofval ) |
Definition at line 187 of file tsp-apt.f90.
| procedure, public tspaptmodule::tspapttype::apt_tmvr_term | ( | class(tspapttype) | this, |
| integer(i4b), intent(in) | ientry, | ||
| integer(i4b), intent(inout) | n1, | ||
| integer(i4b), intent(inout) | n2, | ||
| real(dp), intent(inout), optional | rrate, | ||
| real(dp), intent(inout), optional | rhsval, | ||
| real(dp), intent(inout), optional | hcofval ) |
Definition at line 188 of file tsp-apt.f90.
|
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.
| [in,out] | this | BndType object |
| [in] | moffset | solution matrix model offset |
| [in,out] | sparse | sparse object |
Definition at line 117 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_ac | ( | class(tspapttype), intent(inout) | this, |
| integer(i4b), intent(in) | moffset, | ||
| type(sparsematrix), intent(inout) | sparse ) |
Definition at line 136 of file tsp-apt.f90.
|
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)
| [in,out] | this | BndType object |
Definition at line 165 of file BoundaryPackage.f90.
|
inherited |
Does not call thisTsManagerad()/thisTasManagerad() – those managers are unused by this type (see bndext_df).
Definition at line 47 of file BoundaryPackageExt.f90.
|
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.
| this | BndType object |
Definition at line 121 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_ad | ( | class(tspapttype) | this | ) |
Add package connections to matrix
Definition at line 140 of file tsp-apt.f90.
|
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.
| [in,out] | this | BndType object |
Definition at line 119 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_ar | ( | class(tspapttype), intent(inout) | this | ) |
Definition at line 138 of file tsp-apt.f90.
|
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.
| this | BndType object | |
| [in,out] | model_budget | model budget object |
Definition at line 130 of file BoundaryPackage.f90.
|
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.
| this | BndType object |
Definition at line 156 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_bd_obs | ( | class(tspapttype) | this | ) |
Routine calculates observations common to SFT/LKT/MWT/UZT (or SFE/LKE/MWE/UZE) for as many TspAptType observations that are common among the advanced transport packages
Definition at line 179 of file tsp-apt.f90.
|
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.
| [in,out] | this | BndType object |
| [in] | innertot | total number of inner iterations |
| [in] | kiter | Picard iteration number |
| [in] | iend | flag indicating if this is the last Picard iteration |
| [in] | icnvgmod | flag inficating if the model has met specific convergence criteria |
| [in,out] | cpak | string for user node |
| [in,out] | ipak | location of the maximum dependent variable change |
| [in,out] | dpak | maximum dependent variable change |
Definition at line 128 of file BoundaryPackage.f90.
|
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.
| this | BndType object |
Definition at line 124 of file BoundaryPackage.f90.
|
inherited |
Check the boundary package period data. Base implementation that must be extended by each model boundary package.
| [in,out] | this | BndType object |
Definition at line 122 of file BoundaryPackage.f90.
|
inherited |
Calculate the flow between connected advanced package control volumes. Only advanced boundary packages need to override this method.
| [in,out] | this | BndType object |
| [in] | x | current dependent-variable value |
| [in,out] | flowja | flow between two connected control volumes |
| [in] | iadv | flag that indicates if this is an advance package |
Definition at line 129 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_cq | ( | class(tspapttype), intent(inout) | this, |
| real(dp), dimension(:), intent(in) | x, | ||
| real(dp), dimension(:), intent(inout), contiguous | flowja, | ||
| integer(i4b), intent(in), optional | iadv ) |
Calculate flows for the advanced package transport feature
Definition at line 153 of file tsp-apt.f90.
|
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.
| this | BndType object | |
| [in] | hnew | current dependent-variable value |
| [in,out] | flowja | flow between package and model |
| [in] | imover | flag indicating if the mover package is active |
Definition at line 146 of file BoundaryPackage.f90.
|
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.
| this | BndType object | |
| [in,out] | flowja | flow between package and model |
Definition at line 147 of file BoundaryPackage.f90.
|
inherited |
| this | BndExtType object |
Definition at line 52 of file BoundaryPackageExt.f90.
|
inherited |
Deallocate base boundary package scalars and arrays. This method only needs to be overridden if additional variables are defined for a specific package.
| this | BndType object |
Definition at line 137 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_da | ( | class(tspapttype) | this | ) |
Deallocate memory associated with this package
Definition at line 157 of file tsp-apt.f90.
|
inherited |
Define base boundary package options and dimensions for a model boundary package.
| [in,out] | this | BndExtType object |
| [in,out] | neq | number of equations |
| dis | discretization object |
Definition at line 46 of file BoundaryPackageExt.f90.
|
inherited |
Define base boundary package options and dimensions for a model boundary package.
| [in,out] | this | BndType object |
| [in,out] | neq | number of equations |
| dis | discretization object |
Definition at line 116 of file BoundaryPackage.f90.
|
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.
| this | BndType object |
Definition at line 155 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_df_obs | ( | class(tspapttype) | this | ) |
This routine:
Definition at line 172 of file tsp-apt.f90.
|
inherited |
| this | BndType object |
Definition at line 135 of file BoundaryPackage.f90.
|
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.
| this | BndType object | |
| [in,out] | rhs | right-hand side vector for model |
| [in] | ia | solution CRS row pointers |
| [in] | idxglo | mapping vector for model (local) to solution (global) |
| matrix_sln | solution coefficient matrix |
Definition at line 125 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_fc | ( | class(tspapttype) | this, |
| real(dp), dimension(:), intent(inout) | rhs, | ||
| integer(i4b), dimension(:), intent(in) | ia, | ||
| integer(i4b), dimension(:), intent(in) | idxglo, | ||
| class(matrixbasetype), pointer | matrix_sln ) |
Definition at line 143 of file tsp-apt.f90.
|
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.
| this | BndType object | |
| [in,out] | rhs | right-hand side vector for model |
| [in] | ia | solution CRS row pointers |
| [in] | idxglo | mapping vector for model (local) to solution (global) |
| matrix_sln | solution coefficient matrix |
Definition at line 126 of file BoundaryPackage.f90.
|
inherited |
| this | BndType object |
Definition at line 136 of file BoundaryPackage.f90.
|
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.
| [in,out] | this | BndType object |
| [in] | moffset | solution matrix model offset |
| matrix_sln | global system matrix |
Definition at line 118 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_mc | ( | class(tspapttype), intent(inout) | this, |
| integer(i4b), intent(in) | moffset, | ||
| class(matrixbasetype), pointer | matrix_sln ) |
Definition at line 137 of file tsp-apt.f90.
|
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.
| [in,out] | this | BndType object |
| [in] | neqpak | number of equations in the package |
| [in,out] | x | dependent variable |
| [in] | xtemp | previous dependent variable |
| [in,out] | dx | change in dependent variable |
| [in,out] | inewtonur | flag indicating if newton-raphson under-relaxation should be applied |
| [in,out] | dxmax | maximum change in the dependent variable |
| [in,out] | locmax | location of the maximum change in the dependent variable |
Definition at line 127 of file BoundaryPackage.f90.
|
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.
| this | BndType object |
Definition at line 154 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_obs_supported | ( | class(tspapttype) | this | ) |
This function:
Definition at line 171 of file tsp-apt.f90.
|
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.
| [in,out] | this | BndType object |
| [in,out] | option | option keyword string |
| [in,out] | found | boolean indicating if the option was found |
Definition at line 145 of file BoundaryPackage.f90.
|
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.
| this | BndType object | |
| [in] | kstp | time step number |
| [in] | kper | period number |
| [in] | iout | flag and unit number for the model listing file |
| [in] | ibudfl | flag indicating budget should be written |
Definition at line 134 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_ot_bdsummary | ( | class(tspapttype) | this, |
| integer(i4b), intent(in) | kstp, | ||
| integer(i4b), intent(in) | kper, | ||
| integer(i4b), intent(in) | iout, | ||
| integer(i4b), intent(in) | ibudfl ) |
| this | TspAptType object | |
| [in] | kstp | time step number |
| [in] | kper | period number |
| [in] | iout | flag and unit number for the model listing file |
| [in] | ibudfl | flag indicating budget should be written |
Definition at line 156 of file tsp-apt.f90.
|
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.
| this | BndType object | |
| [in] | idvsave | flag and unit number for dependent-variable output |
| [in] | idvprint | flag indicating if dependent-variable should be written to the model listing file |
Definition at line 133 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_ot_dv | ( | class(tspapttype) | this, |
| integer(i4b), intent(in) | idvsave, | ||
| integer(i4b), intent(in) | idvprint ) |
Definition at line 155 of file tsp-apt.f90.
|
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.
| this | BndType object | |
| [in] | icbcfl | flag for cell-by-cell output |
| [in] | ibudfl | flag indication if cell-by-cell data should be saved |
| [in] | icbcun | unit number for cell-by-cell output |
| [in] | imap | mapping vector that converts the 1 to nbound values to lake number, maw number, etc. |
Definition at line 131 of file BoundaryPackage.f90.
|
inherited |
Method to output simulated values for the boundary package. This method should not need to be overridden.
| this | BndType object |
Definition at line 157 of file BoundaryPackage.f90.
|
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.
| this | BndType object | |
| [in] | icbcfl | flag and unit number for cell-by-cell output |
| [in] | ibudfl | flag indication if cell-by-cell data should be saved |
Definition at line 132 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_ot_package_flows | ( | class(tspapttype) | this, |
| integer(i4b), intent(in) | icbcfl, | ||
| integer(i4b), intent(in) | ibudfl ) |
Definition at line 154 of file tsp-apt.f90.
|
inherited |
| this | BndType object |
Definition at line 123 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_reset | ( | class(tspapttype) | this | ) |
| this | GwtAptType object |
Definition at line 142 of file tsp-apt.f90.
|
inherited |
| [in,out] | this | BndExtType object |
Definition at line 48 of file BoundaryPackageExt.f90.
|
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.
| [in,out] | this | BndType object |
Definition at line 120 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_rp | ( | class(tspapttype), intent(inout) | this | ) |
This subroutine calls the attached packages' read and prepare routines.
Definition at line 139 of file tsp-apt.f90.
|
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.
|
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.
|
inherited |
Method to read and prepare observations for a boundary package This method should not need to be overridden for most boundary packages.
| [in,out] | this | BndType object |
Definition at line 158 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::bnd_rp_obs | ( | class(tspapttype), intent(inout) | this | ) |
Method to process specific observations for an apt package
Definition at line 175 of file tsp-apt.f90.
|
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.
|
inherited |
Return a bound value associated with an ncolbnd index and row. This function should be overridden in the derived package class.
| [in,out] | this | BndExtType object |
Definition at line 65 of file BoundaryPackageExt.f90.
|
inherited |
Convert period updated cellids to node numbers.
| this | BndExtType object |
Definition at line 59 of file BoundaryPackageExt.f90.
|
inherited |
| this | BndExtType object | |
| [in] | mshape | model shape |
| [in] | ndim | size of mshape |
Definition at line 63 of file BoundaryPackageExt.f90.
|
inherited |
boundnames_cst is an array of type(CharacterStringType), which can be stored in the MemoryManager.
| [in,out] | this | BndType object |
Definition at line 150 of file BoundaryPackage.f90.
|
inherited |
Deallocate and initialize base numerical package scalars.
| this | NumericalPackageType object |
Definition at line 55 of file NumericalPackage.f90.
|
inherited |
Equivalent to reading layer number array as CONSTANT 1
Definition at line 62 of file BoundaryPackageExt.f90.
|
inherited |
Method defined the list label for the boundary package. This method needs to be overridden by each boundary package.
| [in,out] | this | BndType object |
Definition at line 149 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::define_listlabel | ( | class(tspapttype), intent(inout) | this | ) |
Definition at line 169 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::find_apt_package | ( | class(tspapttype) | this | ) |
Definition at line 162 of file tsp-apt.f90.
|
inherited |
Generic method to read data in the GRIDDATA block for a package.
| this | NumericalPackageType object | |
| [in] | tags | vector with variable tags |
| [in,out] | lfound | boolean vector indicating of a variable tag was found |
| [in] | varinames | optional vector of variable names |
Definition at line 57 of file NumericalPackage.f90.
| procedure, public tspaptmodule::tspapttype::get_mvr_depvar | ( | class(tspapttype) | this | ) |
Set the concentration (or temperature) to be used by either MVT or MVE
Definition at line 193 of file tsp-apt.f90.
|
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.
| this | BndExtType object |
Definition at line 61 of file BoundaryPackageExt.f90.
|
inherited |
| [in,out] | this | BndExtType object |
Definition at line 57 of file BoundaryPackageExt.f90.
|
inherited |
Convert period user nodes to reduced nodes. Inactive cells are excluded by the input loader.
| this | BndExtType object |
Definition at line 60 of file BoundaryPackageExt.f90.
|
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.
| this | BndType object |
Definition at line 141 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::pak_bd_obs | ( | class(tspapttype), intent(inout) | this, |
| character(len=*), intent(in) | obstypeid, | ||
| integer(i4b), intent(in) | jj, | ||
| real(dp), intent(inout) | v, | ||
| logical, intent(inout) | found ) |
Definition at line 180 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::pak_df_obs | ( | class(tspapttype) | this | ) |
This routine:
Definition at line 173 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::pak_fc_expanded | ( | class(tspapttype) | this, |
| real(dp), dimension(:), intent(inout) | rhs, | ||
| integer(i4b), dimension(:), intent(in) | ia, | ||
| integer(i4b), dimension(:), intent(in) | idxglo, | ||
| class(matrixbasetype), pointer | matrix_sln ) |
Routine to allow a subclass advanced transport package to inject terms into the matrix assembly. This method must be overridden.
Definition at line 146 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::pak_fill_budobj | ( | class(tspapttype) | this, |
| integer(i4b), intent(inout) | idx, | ||
| real(dp), dimension(:), intent(in) | x, | ||
| real(dp), dimension(:), intent(inout), contiguous | flowja, | ||
| real(dp), intent(inout) | ccratin, | ||
| real(dp), intent(inout) | ccratout ) |
Definition at line 185 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::pak_get_nbudterms | ( | class(tspapttype) | this | ) |
This function must be overridden.
Definition at line 181 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::pak_rp_obs | ( | class(tspapttype), intent(inout) | this, |
| type(observetype), intent(inout) | obsrv, | ||
| logical, intent(inout) | found ) |
Method to process specific observations for this package.
| [in,out] | this | package class |
| [in,out] | obsrv | observation object |
| [in,out] | found | indicate whether observation was found |
Definition at line 174 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::pak_setup_budobj | ( | class(tspapttype) | this, |
| integer(i4b), intent(inout) | idx ) |
Individual packages set up their budget terms. Must be overridden.
Definition at line 183 of file tsp-apt.f90.
|
privateinherited |
Setup output table for a boundary package that is used to output package to model flow terms to the model listing file.
| [in,out] | this | BndType object |
Definition at line 151 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::pak_solve | ( | class(tspapttype) | this | ) |
This routine must be overridden by the specific apt package
Definition at line 164 of file tsp-apt.f90.
|
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.
| [in,out] | this | NumericalPackageType object |
Definition at line 56 of file NumericalPackage.f90.
|
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.
| [in,out] | this | BndType object |
Definition at line 143 of file BoundaryPackage.f90.
|
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.
| [in,out] | this | BndType object |
Definition at line 144 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::read_initial_attr | ( | class(tspapttype), intent(inout) | this | ) |
Definition at line 168 of file tsp-apt.f90.
|
inherited |
Read base options for boundary packages.
| [in,out] | this | BndType object |
Definition at line 142 of file BoundaryPackage.f90.
|
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.
| procedure tspaptmodule::tspapttype::rp_obs_budterm | ( | class(tspapttype), intent(inout) | this, |
| type(observetype), intent(inout) | obsrv, | ||
| type(budgettermtype), intent(in) | budterm ) |
Find the indices for this observation assuming they are first indexed by feature number and secondly by a connection number
| [in,out] | this | object |
| [in,out] | obsrv | observation |
| [in] | budterm | budget term |
Definition at line 177 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::rp_obs_byfeature | ( | class(tspapttype), intent(inout) | this, |
| type(observetype), intent(inout) | obsrv ) |
Find the indices for this observation assuming they are indexed by feature number
| [in,out] | this | object |
| [in,out] | obsrv | observation |
Definition at line 176 of file tsp-apt.f90.
| procedure tspaptmodule::tspapttype::rp_obs_flowjaface | ( | class(tspapttype), intent(inout) | this, |
| type(observetype), intent(inout) | obsrv, | ||
| type(budgettermtype), intent(in) | budterm ) |
Find the indices for this observation assuming they are first indexed by a feature number and secondly by a second feature number
| [in,out] | this | object |
| [in,out] | obsrv | observation |
| [in] | budterm | budget term |
Definition at line 178 of file tsp-apt.f90.
|
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.
| [in,out] | this | NumericalPackageType object |
| [in] | ibcnum | unique package number |
| [in] | name_model | name of the model |
| [in] | pakname | name of the package |
| [in] | ftype | package type |
Definition at line 53 of file NumericalPackage.f90.
|
inherited |
Set pointers to model variables so that a package has access to these variables. This base method should not need to be overridden.
| this | BndType object |
| neq | number of equations in the model |
| ibound | model idomain |
| xnew | current dependent variable |
| xold | previous dependent variable |
| flowja | connection flow terms |
Definition at line 148 of file BoundaryPackage.f90.
| procedure tspaptmodule::tspapttype::set_pointers | ( | class(tspapttype) | 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 ) |
Definition at line 135 of file tsp-apt.f90.
|
inherited |
| [in,out] | this | BndExtType object |
Definition at line 58 of file BoundaryPackageExt.f90.
| procedure tspaptmodule::tspapttype::source_dimensions | ( | class(tspapttype), intent(inout) | this | ) |
Definition at line 166 of file tsp-apt.f90.
|
inherited |
| [in,out] | this | BndExtType object |
Definition at line 56 of file BoundaryPackageExt.f90.
| procedure tspaptmodule::tspapttype::source_options | ( | class(tspapttype), intent(inout) | this | ) |
Definition at line 165 of file tsp-apt.f90.
|
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.
|
inherited |
Log period based input. This routine requires a package specific bound_value() routine to report accurate bound values.
| this | BndExtType object |
Definition at line 64 of file BoundaryPackageExt.f90.
|
inherited |
Definition at line 95 of file BoundaryPackage.f90.
|
inherited |
Definition at line 51 of file BoundaryPackage.f90.
|
inherited |
Definition at line 53 of file BoundaryPackage.f90.
|
inherited |
Definition at line 78 of file BoundaryPackage.f90.
|
inherited |
Definition at line 75 of file BoundaryPackage.f90.
|
inherited |
Definition at line 55 of file BoundaryPackage.f90.
|
inherited |
Definition at line 57 of file BoundaryPackage.f90.
| type(budgetobjecttype), pointer tspaptmodule::tspapttype::budobj => null() |
Definition at line 127 of file tsp-apt.f90.
| character(len=lenauxname) tspaptmodule::tspapttype::cauxfpconc = '' |
Definition at line 78 of file tsp-apt.f90.
| real(dp), dimension(:), pointer, contiguous tspaptmodule::tspapttype::ccterm => null() |
Definition at line 107 of file tsp-apt.f90.
|
inherited |
Definition at line 40 of file BoundaryPackageExt.f90.
| real(dp), dimension(:, :), pointer, contiguous tspaptmodule::tspapttype::concbudssm => null() |
Definition at line 116 of file tsp-apt.f90.
| real(dp), dimension(:), pointer, contiguous tspaptmodule::tspapttype::concfeat => null() |
Definition at line 104 of file tsp-apt.f90.
|
inherited |
Definition at line 88 of file BoundaryPackage.f90.
| real(dp), dimension(:), pointer, contiguous tspaptmodule::tspapttype::dbuff => null() |
Definition at line 101 of file tsp-apt.f90.
| character(len=lenvarname) tspaptmodule::tspapttype::depvartype = '' |
Definition at line 119 of file tsp-apt.f90.
| character(len=lenvarname) tspaptmodule::tspapttype::depvarunit = '' |
Definition at line 120 of file tsp-apt.f90.
| character(len=lenvarname) tspaptmodule::tspapttype::depvarunitabbrev = '' |
Definition at line 121 of file tsp-apt.f90.
|
inherited |
Definition at line 50 of file NumericalPackage.f90.
| type(tabletype), pointer tspaptmodule::tspapttype::dvtab => null() |
Definition at line 131 of file tsp-apt.f90.
| real(dp), pointer tspaptmodule::tspapttype::eqnsclfac => null() |
Definition at line 118 of file tsp-apt.f90.
|
inherited |
Definition at line 113 of file BoundaryPackage.f90.
| character(len=lenboundname), dimension(:), pointer, contiguous tspaptmodule::tspapttype::featname => null() |
Definition at line 102 of file tsp-apt.f90.
|
inherited |
Definition at line 44 of file BoundaryPackageExt.f90.
|
inherited |
Definition at line 33 of file NumericalPackage.f90.
| type(budgetobjecttype), pointer tspaptmodule::tspapttype::flowbudptr => null() |
Definition at line 128 of file tsp-apt.f90.
|
inherited |
Definition at line 106 of file BoundaryPackage.f90.
| type(bndtype), pointer tspaptmodule::tspapttype::flowpackagebnd => null() |
Definition at line 124 of file tsp-apt.f90.
| character(len=lenpackagename) tspaptmodule::tspapttype::flowpackagename = '' |
Definition at line 75 of file tsp-apt.f90.
| type(tspfmitype), pointer tspaptmodule::tspapttype::fmi => null() |
Definition at line 105 of file tsp-apt.f90.
|
inherited |
Definition at line 76 of file BoundaryPackage.f90.
|
inherited |
Definition at line 41 of file NumericalPackage.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::iauxfpconc => null() |
Definition at line 79 of file tsp-apt.f90.
|
inherited |
Definition at line 69 of file BoundaryPackage.f90.
|
inherited |
Definition at line 62 of file BoundaryPackage.f90.
|
inherited |
Definition at line 103 of file BoundaryPackage.f90.
| integer(i4b), dimension(:), pointer, contiguous tspaptmodule::tspapttype::iboundpak => null() |
Definition at line 98 of file tsp-apt.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::ibudcsv => null() |
Definition at line 84 of file tsp-apt.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::ibudgetout => null() |
Definition at line 83 of file tsp-apt.f90.
|
inherited |
Definition at line 107 of file BoundaryPackage.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::iconcout => null() |
Definition at line 82 of file tsp-apt.f90.
|
inherited |
Definition at line 108 of file BoundaryPackage.f90.
|
inherited |
Definition at line 37 of file NumericalPackage.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::idxbudaux => null() |
Definition at line 113 of file tsp-apt.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::idxbudfjf => null() |
Definition at line 108 of file tsp-apt.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::idxbudfmvr => null() |
Definition at line 112 of file tsp-apt.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::idxbudgwf => null() |
Definition at line 109 of file tsp-apt.f90.
| integer(i4b), dimension(:), pointer, contiguous tspaptmodule::tspapttype::idxbudssm => null() |
Definition at line 114 of file tsp-apt.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::idxbudsto => null() |
Definition at line 110 of file tsp-apt.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::idxbudtmvr => null() |
Definition at line 111 of file tsp-apt.f90.
| integer(i4b), dimension(:), pointer, contiguous tspaptmodule::tspapttype::idxdglo => null() |
Definition at line 92 of file tsp-apt.f90.
| integer(i4b), dimension(:), pointer, contiguous tspaptmodule::tspapttype::idxfjfdglo => null() |
Definition at line 96 of file tsp-apt.f90.
| integer(i4b), dimension(:), pointer, contiguous tspaptmodule::tspapttype::idxfjfoffdglo => null() |
Definition at line 97 of file tsp-apt.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::idxlastpak => null() |
Definition at line 88 of file tsp-apt.f90.
| integer(i4b), dimension(:), pointer, contiguous tspaptmodule::tspapttype::idxlocnode => null() |
Definition at line 90 of file tsp-apt.f90.
| integer(i4b), dimension(:), pointer, contiguous tspaptmodule::tspapttype::idxoffdglo => null() |
Definition at line 93 of file tsp-apt.f90.
| integer(i4b), dimension(:), pointer, contiguous tspaptmodule::tspapttype::idxpakdiag => null() |
Definition at line 91 of file tsp-apt.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::idxprepak => null() |
Definition at line 87 of file tsp-apt.f90.
| integer(i4b), dimension(:), pointer, contiguous tspaptmodule::tspapttype::idxsymdglo => null() |
Definition at line 94 of file tsp-apt.f90.
| integer(i4b), dimension(:), pointer, contiguous tspaptmodule::tspapttype::idxsymoffdglo => null() |
Definition at line 95 of file tsp-apt.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::igwfaptpak => null() |
Definition at line 86 of file tsp-apt.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::imatrows => null() |
Definition at line 80 of file tsp-apt.f90.
|
inherited |
Definition at line 83 of file BoundaryPackage.f90.
|
inherited |
Definition at line 68 of file BoundaryPackage.f90.
|
inherited |
Definition at line 94 of file BoundaryPackage.f90.
|
inherited |
Definition at line 40 of file NumericalPackage.f90.
|
inherited |
Definition at line 98 of file BoundaryPackage.f90.
|
inherited |
Definition at line 32 of file NumericalPackage.f90.
|
inherited |
Definition at line 31 of file NumericalPackage.f90.
|
inherited |
Definition at line 111 of file BoundaryPackage.f90.
|
inherited |
Definition at line 38 of file NumericalPackage.f90.
|
inherited |
Definition at line 71 of file BoundaryPackage.f90.
|
inherited |
Definition at line 45 of file NumericalPackage.f90.
|
inherited |
Definition at line 39 of file NumericalPackage.f90.
|
inherited |
Definition at line 44 of file NumericalPackage.f90.
|
inherited |
Definition at line 35 of file BoundaryPackageExt.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::iprconc => null() |
Definition at line 81 of file tsp-apt.f90.
|
inherited |
Definition at line 43 of file NumericalPackage.f90.
|
inherited |
Definition at line 42 of file NumericalPackage.f90.
|
inherited |
Definition at line 61 of file BoundaryPackage.f90.
|
inherited |
Definition at line 66 of file BoundaryPackage.f90.
|
inherited |
Definition at line 87 of file BoundaryPackage.f90.
|
inherited |
Definition at line 46 of file NumericalPackage.f90.
|
inherited |
Definition at line 49 of file BoundaryPackage.f90.
|
inherited |
Definition at line 63 of file BoundaryPackage.f90.
|
inherited |
Definition at line 28 of file NumericalPackage.f90.
|
inherited |
Definition at line 29 of file NumericalPackage.f90.
|
inherited |
Definition at line 26 of file NumericalPackage.f90.
|
inherited |
Definition at line 67 of file BoundaryPackage.f90.
|
inherited |
Definition at line 64 of file BoundaryPackage.f90.
|
inherited |
Definition at line 65 of file BoundaryPackage.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::nconcbudssm => null() |
Definition at line 115 of file tsp-apt.f90.
| integer(i4b), pointer tspaptmodule::tspapttype::ncv => null() |
Definition at line 85 of file tsp-apt.f90.
|
inherited |
Definition at line 102 of file BoundaryPackage.f90.
|
inherited |
Definition at line 73 of file BoundaryPackage.f90.
|
inherited |
Definition at line 41 of file BoundaryPackageExt.f90.
|
inherited |
Definition at line 74 of file BoundaryPackage.f90.
|
inherited |
Definition at line 70 of file BoundaryPackage.f90.
|
inherited |
Definition at line 99 of file BoundaryPackage.f90.
|
inherited |
Definition at line 112 of file BoundaryPackage.f90.
|
inherited |
Definition at line 34 of file NumericalPackage.f90.
|
inherited |
Definition at line 27 of file NumericalPackage.f90.
|
inherited |
Definition at line 84 of file BoundaryPackage.f90.
|
inherited |
Definition at line 49 of file NumericalPackage.f90.
|
inherited |
Definition at line 43 of file BoundaryPackageExt.f90.
| real(dp), dimension(:), pointer, contiguous tspaptmodule::tspapttype::qmfrommvr => null() |
Definition at line 117 of file tsp-apt.f90.
| real(dp), dimension(:), pointer, contiguous tspaptmodule::tspapttype::qsto => null() |
Definition at line 106 of file tsp-apt.f90.
|
inherited |
Definition at line 36 of file BoundaryPackageExt.f90.
|
inherited |
Definition at line 37 of file BoundaryPackageExt.f90.
|
inherited |
Definition at line 77 of file BoundaryPackage.f90.
|
inherited |
Definition at line 80 of file BoundaryPackage.f90.
|
inherited |
Definition at line 79 of file BoundaryPackage.f90.
| character(len=8), dimension(:), pointer, contiguous tspaptmodule::tspapttype::status => null() |
Definition at line 76 of file tsp-apt.f90.
| real(dp), dimension(:), pointer, contiguous tspaptmodule::tspapttype::strt => null() |
Definition at line 89 of file tsp-apt.f90.
|
inherited |
Definition at line 93 of file BoundaryPackage.f90.
|
inherited |
Definition at line 50 of file BoundaryPackage.f90.
|
inherited |
Definition at line 38 of file BoundaryPackageExt.f90.
|
inherited |
Definition at line 92 of file BoundaryPackage.f90.
|
inherited |
Definition at line 89 of file BoundaryPackage.f90.
|
inherited |
Definition at line 104 of file BoundaryPackage.f90.
| real(dp), dimension(:), pointer, contiguous tspaptmodule::tspapttype::xnewpak => null() |
Definition at line 99 of file tsp-apt.f90.
|
inherited |
Definition at line 105 of file BoundaryPackage.f90.
| real(dp), dimension(:), pointer, contiguous tspaptmodule::tspapttype::xoldpak => null() |
Definition at line 100 of file tsp-apt.f90.