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


Public Member Functions | |
| procedure | model_df (this) |
| Define packages of the GWT model. | |
| procedure | model_ac (this, sparse) |
| Add the internal connections of this model to the sparse matrix. | |
| procedure | model_mc (this, matrix_sln) |
| Map the positions of the GWT model connections in the numerical solution coefficient matrix. | |
| procedure | model_ar (this) |
| GWT Model Allocate and Read. | |
| procedure | model_rp (this) |
| GWT Model Read and Prepare. | |
| procedure | model_dt (this) |
| GWT Model time step size. | |
| procedure | model_ad (this) |
| GWT Model Time Step Advance. | |
| procedure | model_cf (this, kiter) |
| GWT Model calculate coefficients. | |
| procedure | model_fc (this, kiter, matrix_sln, inwtflag) |
| GWT Model fill coefficients. | |
| procedure | model_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak) |
| GWT Model Final Convergence Check. | |
| procedure | model_cq (this, icnvg, isuppress_output) |
| GWT Model calculate flow. | |
| procedure | model_bd (this, icnvg, isuppress_output) |
| GWT Model Budget. | |
| procedure | tsp_ot_flow (this, icbcfl, ibudfl, icbcun) |
| GWT model output routine. | |
| procedure | tsp_ot_dv (this, idvsave, idvprint, ipflag) |
| GWT model dependent variable output. | |
| procedure | model_da (this) |
| Deallocate. | |
| procedure | model_bdentry (this, budterm, budtxt, rowlabel) |
| GroundWater Transport Model Budget Entry. | |
| procedure | allocate_scalars (this, modelname) |
| Allocate memory for non-allocatable members. | |
| procedure | get_iasym (this) |
| return 1 if any package causes the matrix to be asymmetric. Otherwise return 0. | |
| procedure | create_packages (this, indis) |
| Source package info and begin to process. | |
| 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 | model_ot (this) |
| procedure | model_ot (this) |
| Output results. | |
| 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 | get_idv_scale (this) |
| 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_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 | 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(gwtmsttype), pointer | mst => null() |
| type(gwtdsptype), pointer | dsp => null() |
| integer(i4b), pointer | inmst => null() |
| integer(i4b), pointer | indsp => null() |
| 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 | create_bndpkgs (this, bndpkgs, pkgtypes, pkgnames, mempaths, inunits) |
| Source package info and begin to process. | |
| procedure, private | package_create (this, filtyp, ipakid, ipaknum, pakname, mempath, inunit, iout) |
| Create boundary condition packages for this model. | |
| 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.
| procedure gwtmodule::gwtmodeltype::allocate_scalars | ( | class(gwtmodeltype) | this, |
| character(len=*), intent(in) | modelname ) |
|
inherited |
Definition at line 56 of file NumericalModel.f90.
|
inherited |
|
private |
|
inherited |
Definition at line 43 of file BaseModel.f90.
| procedure gwtmodule::gwtmodeltype::create_packages | ( | class(gwtmodeltype) | this, |
| integer(i4b), intent(in) | indis ) |
|
privateinherited |
|
inherited |
| procedure gwtmodule::gwtmodeltype::get_iasym | ( | class(gwtmodeltype) | this | ) |
|
inherited |
Definition at line 66 of file NumericalModel.f90.
|
inherited |
Definition at line 67 of file NumericalModel.f90.
|
inherited |
|
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.
|
privateinherited |
| procedure gwtmodule::gwtmodeltype::model_ac | ( | class(gwtmodeltype) | this, |
| type(sparsematrix), intent(inout) | sparse ) |
|
inherited |
Definition at line 36 of file NumericalModel.f90.
| procedure gwtmodule::gwtmodeltype::model_ad | ( | class(gwtmodeltype) | this | ) |
|
inherited |
Definition at line 39 of file NumericalModel.f90.
|
inherited |
Definition at line 35 of file BaseModel.f90.
| procedure gwtmodule::gwtmodeltype::model_ar | ( | class(gwtmodeltype) | this | ) |
|
inherited |
Definition at line 32 of file NumericalModel.f90.
| procedure gwtmodule::gwtmodeltype::model_bd | ( | class(gwtmodeltype) | this, |
| integer(i4b), intent(in) | icnvg, | ||
| integer(i4b), intent(in) | isuppress_output ) |
|
inherited |
Definition at line 50 of file NumericalModel.f90.
|
inherited |
Definition at line 51 of file NumericalModel.f90.
| procedure gwtmodule::gwtmodeltype::model_bdentry | ( | class(gwtmodeltype) | this, |
| real(dp), dimension(:, :), intent(in) | budterm, | ||
| character(len=lenbudtxt), dimension(:), intent(in) | budtxt, | ||
| character(len=*), intent(in) | rowlabel ) |
|
inherited |
Definition at line 54 of file NumericalModel.f90.
|
inherited |
Definition at line 52 of file NumericalModel.f90.
| procedure gwtmodule::gwtmodeltype::model_cc | ( | class(gwtmodeltype) | 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 ) |
If MVR/MVT is active, call the MVR convergence check subroutines to force at least 2 outer iterations. The other advanced transport packages are solved in the matrix equations directly which means the solver is completing the necessary checks thereby eliminating need to call package cc routines. That is, no need to loop over active packages and run: call packobjbnd_cc(iend, icnvg, hclose, rclose)
|
inherited |
Definition at line 47 of file NumericalModel.f90.
| procedure gwtmodule::gwtmodeltype::model_cf | ( | class(gwtmodeltype) | this, |
| integer(i4b), intent(in) | kiter ) |
|
inherited |
Definition at line 42 of file NumericalModel.f90.
| procedure gwtmodule::gwtmodeltype::model_cq | ( | class(gwtmodeltype) | this, |
| integer(i4b), intent(in) | icnvg, | ||
| integer(i4b), intent(in) | isuppress_output ) |
|
inherited |
Definition at line 49 of file NumericalModel.f90.
|
inherited |
Definition at line 40 of file BaseModel.f90.
| procedure gwtmodule::gwtmodeltype::model_da | ( | class(gwtmodeltype) | this | ) |
|
inherited |
Definition at line 34 of file NumericalModel.f90.
|
inherited |
Definition at line 34 of file BaseModel.f90.
| procedure gwtmodule::gwtmodeltype::model_df | ( | class(gwtmodeltype) | this | ) |
|
inherited |
Definition at line 31 of file NumericalModel.f90.
|
inherited |
Definition at line 37 of file BaseModel.f90.
| procedure gwtmodule::gwtmodeltype::model_dt | ( | class(gwtmodeltype) | this | ) |
| procedure gwtmodule::gwtmodeltype::model_fc | ( | class(gwtmodeltype) | this, |
| integer(i4b), intent(in) | kiter, | ||
| class(matrixbasetype), pointer | matrix_sln, | ||
| integer(i4b), intent(in) | inwtflag ) |
|
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.
| procedure gwtmodule::gwtmodeltype::model_mc | ( | class(gwtmodeltype) | this, |
| class(matrixbasetype), pointer | matrix_sln ) |
|
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.
|
inherited |
|
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.
| procedure gwtmodule::gwtmodeltype::model_rp | ( | class(gwtmodeltype) | this | ) |
|
inherited |
Definition at line 38 of file NumericalModel.f90.
|
inherited |
Definition at line 41 of file NumericalModel.f90.
|
private |
|
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.
|
inherited |
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.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
privateinherited |
| procedure gwtmodule::gwtmodeltype::tsp_ot_dv | ( | class(gwtmodeltype) | this, |
| integer(i4b), intent(in) | idvsave, | ||
| integer(i4b), intent(in) | idvprint, | ||
| integer(i4b), intent(inout) | ipflag ) |
|
inherited |
| procedure gwtmodule::gwtmodeltype::tsp_ot_flow | ( | class(gwtmodeltype) | this, |
| integer(i4b), intent(in) | icbcfl, | ||
| integer(i4b), intent(in) | ibudfl, | ||
| integer(i4b), intent(in) | icbcun ) |
|
inherited |
|
privateinherited |
|
privateinherited |
|
inherited |
|
inherited |
|
inherited |
Definition at line 31 of file BaseModel.f90.
|
inherited |
|
inherited |
Definition at line 25 of file NumericalModel.f90.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Definition at line 32 of file BaseModel.f90.
| type(gwtdsptype), pointer gwtmodule::gwtmodeltype::dsp => null() |
|
inherited |
|
inherited |
Definition at line 19 of file BaseModel.f90.
|
inherited |
Definition at line 30 of file BaseModel.f90.
|
inherited |
|
inherited |
Definition at line 21 of file NumericalModel.f90.
|
inherited |
Definition at line 29 of file BaseModel.f90.
|
inherited |
|
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.
|
inherited |
|
inherited |
Definition at line 26 of file NumericalModel.f90.
|
inherited |
| integer(i4b), pointer gwtmodule::gwtmodeltype::indsp => null() |
|
inherited |
Definition at line 24 of file BaseModel.f90.
|
inherited |
|
inherited |
| integer(i4b), pointer gwtmodule::gwtmodeltype::inmst => null() |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
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(gwtmsttype), pointer gwtmodule::gwtmodeltype::mst => null() |
|
inherited |
|
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.
|
inherited |
|
inherited |
|
inherited |
Definition at line 24 of file NumericalModel.f90.
|
inherited |
|
inherited |
|
inherited |
Definition at line 23 of file NumericalModel.f90.
|
inherited |
Definition at line 27 of file NumericalModel.f90.