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


Public Member Functions | |
| procedure, public | tsp_cr (this, filename, id, modelname, macronym, indis) |
| Create a new generalized transport model object. | |
| procedure, public | tsp_df (this) |
| Generalized transport model define model. | |
| procedure, public | tsp_da (this) |
| Deallocate memory. | |
| procedure, public | tsp_ac (this, sparse) |
| Generalized transport model add connections. | |
| procedure, public | tsp_mc (this, matrix_sln) |
| Generalized transport model map coefficients. | |
| procedure, public | tsp_ar (this) |
| Generalized transport model allocate and read. | |
| procedure, public | tsp_rp (this) |
| Generalized transport model read and prepare. | |
| procedure, public | tsp_ad (this) |
| Generalized transport model time step advance. | |
| procedure, public | tsp_fc (this, kiter, matrix_sln, inwtflag) |
| Generalized transport model fill coefficients. | |
| procedure, public | tsp_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak) |
| Generalized transport model final convergence check. | |
| procedure, public | tsp_cq (this, icnvg, isuppress_output) |
| Generalized transport model calculate flows. | |
| procedure, public | tsp_bd (this, icnvg, isuppress_output) |
| Generalized transport model budget. | |
| procedure, public | model_ot (this) |
| Generalized transport model output routine. | |
| procedure, public | tsp_ot_flow (this, icbcfl, ibudfl, icbcun) |
| Generalized transport model output routine. | |
| procedure, public | tsp_ot_dv (this, idvsave, idvprint, ipflag) |
| Generalized transport model output routine. | |
| procedure, public | allocate_tsp_scalars (this, modelname) |
| Allocate scalar variables for transport model. | |
| procedure, public | set_tsp_labels (this, tsptype, depvartype, depvarunit, depvarunitabbrev) |
| Define the labels corresponding to the flavor of transport model. | |
| procedure, public | ftype_check (this, indis, inmst) |
| Generalized transport model routine. | |
| procedure, public | get_idv_scale (this) |
| return 1 if option to normalize the x and rhs has been specified. Otherwise return 0. | |
| procedure | model_df (this) |
| procedure | model_df (this) |
| Define the model. | |
| procedure | model_ar (this) |
| procedure | model_ar (this) |
| Allocate and read. | |
| procedure | model_fp (this) |
| procedure | model_fp (this) |
| Final processing. | |
| procedure | model_da (this) |
| procedure | model_da (this) |
| Deallocate. | |
| procedure | model_ac (this, sparse) |
| procedure | model_mc (this, matrix_sln) |
| procedure | model_rp (this) |
| procedure | model_rp (this) |
| Read and prepare. | |
| procedure | model_ad (this) |
| procedure | model_reset (this) |
| procedure | model_solve (this) |
| procedure | model_cf (this, kiter) |
| procedure | model_fc (this, kiter, matrix_sln, inwtflag) |
| procedure | model_ptcchk (this, iptc) |
| procedure | model_ptc (this, vec_residual, iptc, ptcf) |
| procedure | model_nr (this, kiter, matrix, inwtflag) |
| procedure | model_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak) |
| procedure | model_nur (this, neqmod, x, xtemp, dx, inewtonur, dxmax, locmax) |
| procedure | model_cq (this, icnvg, isuppress_output) |
| procedure | model_bd (this, icnvg, isuppress_output) |
| procedure | model_bdcalc (this, icnvg) |
| procedure | model_bdsave (this, icnvg) |
| procedure | model_ot (this) |
| procedure | model_ot (this) |
| Output results. | |
| procedure | model_bdentry (this, budterm, budtxt, rowlabel) |
| procedure | allocate_scalars (this, modelname) |
| procedure | allocate_scalars (this, modelname) |
| Allocate scalar variables. | |
| procedure | allocate_arrays (this) |
| procedure | set_moffset (this, moffset) |
| procedure | set_idsoln (this, id) |
| procedure | set_xptr (this, xsln, sln_offset, varnametgt, mempathtgt) |
| procedure | set_rhsptr (this, rhssln, sln_offset, varnametgt, mempathtgt) |
| procedure | set_iboundptr (this, iboundsln, sln_offset, varnametgt, mempathtgt) |
| procedure | get_mrange (this, mstart, mend) |
| procedure | get_mcellid (this, node, mcellid) |
| procedure | get_mnodeu (this, node, nodeu) |
| procedure | get_iasym (this) |
| procedure | get_idv_scale (this) |
| procedure | model_dt (this) |
| Calculate time step length. | |
| procedure | model_message (this, line, fmt) |
| Write line to model iout. | |
| procedure | create_lstfile (this, lst_fname, model_fname, defined, headertxt) |
Public Attributes | |
| type(tspadvtype), pointer | adv => null() |
| advection package | |
| type(tspfmitype), pointer | fmi => null() |
| flow model interface | |
| type(tspictype), pointer | ic => null() |
| initial conditions package | |
| type(tspmvttype), pointer | mvt => null() |
| mover transport package | |
| type(tspobstype), pointer | obs => null() |
| observation package | |
| type(tspoctype), pointer | oc => null() |
| output control package | |
| type(tspssmtype), pointer | ssm => null() |
| source sink mixing package | |
| type(budgettype), pointer | budget => null() |
| budget object | |
| integer(i4b), pointer | infmi => null() |
| integer(i4b), pointer | inadv => null() |
| unit number ADV | |
| integer(i4b), pointer | inic => null() |
| unit number IC | |
| integer(i4b), pointer | inmvt => null() |
| unit number MVT | |
| integer(i4b), pointer | inoc => null() |
| unit number OC | |
| integer(i4b), pointer | inobs => null() |
| unit number OBS | |
| integer(i4b), pointer | inssm => null() |
| unit number SSM | |
| real(dp), pointer | eqnsclfac => null() |
| constant factor by which all terms in the model's governing equation are scaled (divided) for formulation and solution | |
| character(len=lenvarname) | tsptype = '' |
| "solute" or "heat" | |
| character(len=lenvarname) | depvartype = '' |
| "concentration" or "temperature" | |
| character(len=lenvarname) | depvarunit = '' |
| "mass" or "energy" | |
| character(len=lenvarname) | depvarunitabbrev = '' |
| "M" or "E" | |
| integer(i4b), pointer | idv_scale => null() |
| integer(i4b), pointer | neq => null() |
| number of equations | |
| integer(i4b), pointer | moffset => null() |
| offset of this model in the solution | |
| integer(i4b), pointer | icnvg => null() |
| convergence flag | |
| integer(i4b), dimension(:), pointer, contiguous | ia => null() |
| csr row pointer | |
| integer(i4b), dimension(:), pointer, contiguous | ja => null() |
| csr columns | |
| real(dp), dimension(:), pointer, contiguous | x => null() |
| dependent variable (head, conc, etc) | |
| real(dp), dimension(:), pointer, contiguous | rhs => null() |
| right-hand side vector | |
| real(dp), dimension(:), pointer, contiguous | cond => null() |
| conductance matrix | |
| integer(i4b), dimension(:), pointer, contiguous | idxglo => null() |
| pointer to position in solution matrix | |
| real(dp), dimension(:), pointer, contiguous | xold => null() |
| dependent variable for previous timestep | |
| character(len=lenmempath) | memorypath |
| the location in the memory manager where the variables are stored | |
| character(len=lenmodelname), pointer | name => null() |
| name of the model | |
| character(len=linelength), pointer | filename => null() |
| input file name | |
| character(len=3), pointer | macronym => null() |
| 3 letter model acronym (GWF, GWT, ...) | |
| integer(i4b), pointer | idsoln => null() |
| id of the solution model is in | |
| integer(i4b), pointer | id => null() |
| model id | |
| integer(i4b), pointer | iout => null() |
| output unit number | |
| integer(i4b), pointer | inewton => null() |
| newton-raphson flag | |
| 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() |
| save_flows flag | |
| integer(i4b), pointer | nja => null() |
| number of connections | |
| integer(i4b), dimension(:), pointer, contiguous | ibound => null() |
| ibound | |
| real(dp), dimension(:), pointer, contiguous | flowja => null() |
| intercell flows | |
| type(listtype), pointer | bndlist => null() |
| array of boundary packages | |
| class(disbasetype), pointer | dis => null() |
| discretization object | |
Private Member Functions | |
| procedure, private | tsp_ot_obs (this) |
| Generalized transport model output routine. | |
| procedure, private | tsp_ot_flowja (this, nja, flowja, icbcfl, icbcun) |
| Generalized transport model output routine. | |
| procedure, private | tsp_ot_bdsummary (this, ibudfl, ipflag) |
| Generalized transport model output budget summary. | |
| procedure, private | create_tsp_packages (this, indis) |
| Source package info and begin to process. | |
| procedure, private | log_namfile_options (this, found) |
| Write model name file options to list file. | |
|
inherited |
Definition at line 57 of file NumericalModel.f90.
|
inherited |
Definition at line 41 of file BaseModel.f90.
|
inherited |
Definition at line 56 of file NumericalModel.f90.
| procedure, public transportmodelmodule::transportmodeltype::allocate_tsp_scalars | ( | class(transportmodeltype) | this, |
| character(len=*), intent(in) | modelname ) |
|
inherited |
Definition at line 43 of file BaseModel.f90.
|
private |
| procedure, public transportmodelmodule::transportmodeltype::ftype_check | ( | class(transportmodeltype) | this, |
| integer(i4b), intent(in) | indis, | ||
| integer(i4b), intent(in) | inmst ) |
|
inherited |
Definition at line 66 of file NumericalModel.f90.
|
inherited |
Definition at line 67 of file NumericalModel.f90.
| procedure, public transportmodelmodule::transportmodeltype::get_idv_scale | ( | class(transportmodeltype) | this | ) |
|
inherited |
Definition at line 64 of file NumericalModel.f90.
|
inherited |
Definition at line 65 of file NumericalModel.f90.
|
inherited |
Definition at line 63 of file NumericalModel.f90.
|
private |
|
inherited |
Definition at line 36 of file NumericalModel.f90.
|
inherited |
Definition at line 39 of file NumericalModel.f90.
|
inherited |
Definition at line 35 of file BaseModel.f90.
|
inherited |
Definition at line 32 of file NumericalModel.f90.
|
inherited |
Definition at line 50 of file NumericalModel.f90.
|
inherited |
Definition at line 51 of file NumericalModel.f90.
|
inherited |
Definition at line 54 of file NumericalModel.f90.
|
inherited |
Definition at line 52 of file NumericalModel.f90.
|
inherited |
Definition at line 47 of file NumericalModel.f90.
|
inherited |
Definition at line 42 of file NumericalModel.f90.
|
inherited |
Definition at line 49 of file NumericalModel.f90.
|
inherited |
Definition at line 40 of file BaseModel.f90.
|
inherited |
Definition at line 34 of file NumericalModel.f90.
|
inherited |
Definition at line 34 of file BaseModel.f90.
|
inherited |
Definition at line 31 of file NumericalModel.f90.
|
inherited |
Definition at line 37 of file BaseModel.f90.
|
inherited |
Definition at line 43 of file NumericalModel.f90.
|
inherited |
Definition at line 39 of file BaseModel.f90.
|
inherited |
Definition at line 33 of file NumericalModel.f90.
|
inherited |
Definition at line 37 of file NumericalModel.f90.
|
inherited |
Definition at line 42 of file BaseModel.f90.
|
inherited |
Definition at line 46 of file NumericalModel.f90.
|
inherited |
Definition at line 48 of file NumericalModel.f90.
|
inherited |
Definition at line 38 of file BaseModel.f90.
|
inherited |
Definition at line 53 of file NumericalModel.f90.
| procedure, public transportmodelmodule::transportmodeltype::model_ot | ( | class(transportmodeltype) | this | ) |
|
inherited |
Definition at line 45 of file NumericalModel.f90.
|
inherited |
Definition at line 44 of file NumericalModel.f90.
|
inherited |
Definition at line 40 of file NumericalModel.f90.
|
inherited |
Definition at line 36 of file BaseModel.f90.
|
inherited |
Definition at line 38 of file NumericalModel.f90.
|
inherited |
Definition at line 41 of file NumericalModel.f90.
|
inherited |
Definition at line 62 of file NumericalModel.f90.
|
inherited |
Definition at line 59 of file NumericalModel.f90.
|
inherited |
Definition at line 58 of file NumericalModel.f90.
|
inherited |
Definition at line 61 of file NumericalModel.f90.
| procedure, public transportmodelmodule::transportmodeltype::set_tsp_labels | ( | class(transportmodeltype) | this, |
| character(len=*), intent(in), pointer | tsptype, | ||
| character(len=*), intent(in) | depvartype, | ||
| character(len=*), intent(in) | depvarunit, | ||
| character(len=*), intent(in) | depvarunitabbrev ) |
Set variable names according to type of transport model
| [in] | tsptype | type of model, default is GWT (alternative is GWE) |
| [in] | depvartype | dependent variable type, default is "CONCENTRATION" |
| [in] | depvarunit | units of dependent variable for writing to list file |
| [in] | depvarunitabbrev | abbreviation of associated units |
|
inherited |
Definition at line 60 of file NumericalModel.f90.
| procedure, public transportmodelmodule::transportmodeltype::tsp_ac | ( | class(transportmodeltype) | this, |
| type(sparsematrix), intent(inout) | sparse ) |
| procedure, public transportmodelmodule::transportmodeltype::tsp_ad | ( | class(transportmodeltype) | this | ) |
| procedure, public transportmodelmodule::transportmodeltype::tsp_ar | ( | class(transportmodeltype) | this | ) |
| procedure, public transportmodelmodule::transportmodeltype::tsp_bd | ( | class(transportmodeltype) | this, |
| integer(i4b), intent(in) | icnvg, | ||
| integer(i4b), intent(in) | isuppress_output ) |
| procedure, public transportmodelmodule::transportmodeltype::tsp_cc | ( | class(transportmodeltype) | 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 ) |
| procedure, public transportmodelmodule::transportmodeltype::tsp_cq | ( | class(transportmodeltype) | this, |
| integer(i4b), intent(in) | icnvg, | ||
| integer(i4b), intent(in) | isuppress_output ) |
| procedure, public transportmodelmodule::transportmodeltype::tsp_cr | ( | class(transportmodeltype) | this, |
| character(len=*), intent(in) | filename, | ||
| integer(i4b), intent(in) | id, | ||
| character(len=*), intent(in) | modelname, | ||
| character(len=*), intent(in) | macronym, | ||
| integer(i4b), intent(inout) | indis ) |
| procedure, public transportmodelmodule::transportmodeltype::tsp_da | ( | class(transportmodeltype) | this | ) |
| procedure, public transportmodelmodule::transportmodeltype::tsp_df | ( | class(transportmodeltype) | this | ) |
| procedure, public transportmodelmodule::transportmodeltype::tsp_fc | ( | class(transportmodeltype) | this, |
| integer(i4b), intent(in) | kiter, | ||
| class(matrixbasetype), pointer | matrix_sln, | ||
| integer(i4b), intent(in) | inwtflag ) |
| procedure, public transportmodelmodule::transportmodeltype::tsp_mc | ( | class(transportmodeltype) | this, |
| class(matrixbasetype), pointer | matrix_sln ) |
|
private |
| procedure, public transportmodelmodule::transportmodeltype::tsp_ot_dv | ( | class(transportmodeltype) | this, |
| integer(i4b), intent(in) | idvsave, | ||
| integer(i4b), intent(in) | idvprint, | ||
| integer(i4b), intent(inout) | ipflag ) |
| procedure, public transportmodelmodule::transportmodeltype::tsp_ot_flow | ( | class(transportmodeltype) | this, |
| integer(i4b), intent(in) | icbcfl, | ||
| integer(i4b), intent(in) | ibudfl, | ||
| integer(i4b), intent(in) | icbcun ) |
|
private |
|
private |
| procedure, public transportmodelmodule::transportmodeltype::tsp_rp | ( | class(transportmodeltype) | this | ) |
| type(tspadvtype), pointer transportmodelmodule::transportmodeltype::adv => null() |
|
inherited |
Definition at line 31 of file BaseModel.f90.
| type(budgettype), pointer transportmodelmodule::transportmodeltype::budget => null() |
|
inherited |
Definition at line 25 of file NumericalModel.f90.
| character(len=lenvarname) transportmodelmodule::transportmodeltype::depvartype = '' |
| character(len=lenvarname) transportmodelmodule::transportmodeltype::depvarunit = '' |
| character(len=lenvarname) transportmodelmodule::transportmodeltype::depvarunitabbrev = '' |
|
inherited |
Definition at line 32 of file BaseModel.f90.
| real(dp), pointer transportmodelmodule::transportmodeltype::eqnsclfac => null() |
|
inherited |
Definition at line 19 of file BaseModel.f90.
|
inherited |
Definition at line 30 of file BaseModel.f90.
| type(tspfmitype), pointer transportmodelmodule::transportmodeltype::fmi => null() |
|
inherited |
Definition at line 21 of file NumericalModel.f90.
|
inherited |
Definition at line 29 of file BaseModel.f90.
| type(tspictype), pointer transportmodelmodule::transportmodeltype::ic => null() |
|
inherited |
Definition at line 20 of file NumericalModel.f90.
|
inherited |
Definition at line 22 of file BaseModel.f90.
|
inherited |
Definition at line 21 of file BaseModel.f90.
| integer(i4b), pointer transportmodelmodule::transportmodeltype::idv_scale => null() |
|
inherited |
Definition at line 26 of file NumericalModel.f90.
| integer(i4b), pointer transportmodelmodule::transportmodeltype::inadv => null() |
|
inherited |
Definition at line 24 of file BaseModel.f90.
| integer(i4b), pointer transportmodelmodule::transportmodeltype::infmi => null() |
| integer(i4b), pointer transportmodelmodule::transportmodeltype::inic => null() |
| integer(i4b), pointer transportmodelmodule::transportmodeltype::inmvt => null() |
| integer(i4b), pointer transportmodelmodule::transportmodeltype::inobs => null() |
| integer(i4b), pointer transportmodelmodule::transportmodeltype::inoc => null() |
| integer(i4b), pointer transportmodelmodule::transportmodeltype::inssm => null() |
|
inherited |
Definition at line 23 of file BaseModel.f90.
|
inherited |
Definition at line 27 of file BaseModel.f90.
|
inherited |
Definition at line 26 of file BaseModel.f90.
|
inherited |
Definition at line 25 of file BaseModel.f90.
|
inherited |
Definition at line 22 of file NumericalModel.f90.
|
inherited |
Definition at line 20 of file BaseModel.f90.
|
inherited |
Definition at line 17 of file BaseModel.f90.
|
inherited |
Definition at line 19 of file NumericalModel.f90.
| type(tspmvttype), pointer transportmodelmodule::transportmodeltype::mvt => null() |
|
inherited |
Definition at line 18 of file BaseModel.f90.
|
inherited |
Definition at line 18 of file NumericalModel.f90.
|
inherited |
Definition at line 28 of file BaseModel.f90.
| type(tspobstype), pointer transportmodelmodule::transportmodeltype::obs => null() |
| type(tspoctype), pointer transportmodelmodule::transportmodeltype::oc => null() |
|
inherited |
Definition at line 24 of file NumericalModel.f90.
| type(tspssmtype), pointer transportmodelmodule::transportmodeltype::ssm => null() |
| character(len=lenvarname) transportmodelmodule::transportmodeltype::tsptype = '' |
|
inherited |
Definition at line 23 of file NumericalModel.f90.
|
inherited |
Definition at line 27 of file NumericalModel.f90.