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


Public Member Functions | |
| procedure | vsc_df (this, dis, vsc_input) |
| Define viscosity package options and dimensions. | |
| procedure | vsc_ar (this, ibound) |
| Allocate and read method for viscosity package. | |
| procedure, public | vsc_ar_bnd (this, packobj) |
| Activate viscosity in advanced packages. | |
| procedure | vsc_rp (this) |
| Read new period data in viscosity package. | |
| procedure | vsc_ad (this) |
| Advance the viscosity package. | |
| procedure, public | vsc_ad_bnd (this, packobj, hnew) |
| Advance the boundary packages when viscosity is active. | |
| procedure | vsc_ot_dv (this, idvfl) |
| Output viscosity package dependent-variable terms. | |
| procedure | vsc_da (this) |
| Deallocate viscosity package memory. | |
| procedure | allocate_scalars (this) |
| Allocate scalars. | |
| procedure, public | update_k_with_vsc (this) |
| Appled the viscosity ratio (mu_o/mu) to the hydraulic conductivity. | |
| procedure, public | calc_q_visc (this, cellid, viscratio) |
| Account for viscosity in the aquifer hydraulic flow barriers. | |
| procedure, public | get_visc_ratio (this, n, m, gwhdn, gwhdm, viscratio) |
| Calculate the viscosity ratio. | |
| procedure | set_concentration_pointer (this, modelname, conc, icbund, istmpr) |
| Set pointers to concentration(s). | |
| procedure | set_names (this, ibcnum, name_model, pakname, ftype, input_mempath) |
| Set package names. | |
| procedure | allocate_scalars (this) |
| Allocate package scalars. | |
| 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 | |
| integer(i4b), pointer | thermivisc => null() |
| viscosity formulation flag (1:Linear, 2:Nonlinear) | |
| integer(i4b), pointer | idxtmpr => null() |
| if greater than 0 then an index for identifying whether the "species" array is temperature | |
| integer(i4b), pointer | ioutvisc => null() |
| unit number for saving viscosity | |
| integer(i4b), pointer | iconcset => null() |
| if 1 then conc points to a gwt (or gwe) modelx array | |
| integer(i4b), pointer | ireadelev => null() |
| if 1 then elev has been allocated and filled | |
| integer(i4b), dimension(:), pointer, contiguous | ivisc => null() |
| viscosity formulation flag for each species (1:Linear, 2:Nonlinear) | |
| real(dp), pointer | viscref => null() |
| reference fluid viscosity | |
| real(dp), dimension(:), pointer, contiguous | visc => null() |
| viscosity | |
| real(dp), dimension(:), pointer, contiguous | elev => null() |
| cell center elevation (optional; if not specified, then use (top+bot)/2) | |
| integer(i4b), dimension(:), pointer | ibound => null() |
| store pointer to ibound | |
| integer(i4b), pointer | nviscspecies => null() |
| number of concentration species used in viscosity equation | |
| real(dp), dimension(:), pointer, contiguous | dviscdc => null() |
| linear change in viscosity with change in concentration | |
| real(dp), dimension(:), pointer, contiguous | cviscref => null() |
| reference concentration used in viscosity equation | |
| real(dp), dimension(:), pointer, contiguous | ctemp => null() |
| temporary array of size (nviscspec) to pass to calc_visc_x | |
| character(len=lenmodelname), dimension(:), allocatable | cmodelname |
| names of gwt (or gwe) models used in viscosity equation | |
| character(len=lenauxname), dimension(:), allocatable | cauxspeciesname |
| names of aux columns used in viscosity equation | |
| character(len=lenauxname) | name_temp_spec = 'TEMPERATURE' |
| real(dp), pointer | a2 => null() |
| an empirical parameter specified by the user for calculating viscosity | |
| real(dp), pointer | a3 => null() |
| an empirical parameter specified by the user for calculating viscosity | |
| real(dp), pointer | a4 => null() |
| an empirical parameter specified by the user for calculating viscosity | |
| type(concentrationpointer), dimension(:), allocatable | modelconc |
| concentration (or temperature) pointer for each solute (or heat) transport model | |
| real(dp), dimension(:), pointer, contiguous | k11 => null() |
| NPF hydraulic conductivity; if anisotropic, then this is Kx prior to rotation. | |
| real(dp), dimension(:), pointer, contiguous | k22 => null() |
| NPF hydraulic conductivity; if specified then this is Ky prior to rotation. | |
| real(dp), dimension(:), pointer, contiguous | k33 => null() |
| NPF hydraulic conductivity; if specified then this is Kz prior to rotation. | |
| real(dp), dimension(:), pointer, contiguous | k11input => null() |
| NPF hydraulic conductivity before VSC adjustment, including TVK changes. | |
| real(dp), dimension(:), pointer, contiguous | k22input => null() |
| NPF hydraulic conductivity before VSC adjustment, including TVK changes. | |
| real(dp), dimension(:), pointer, contiguous | k33input => null() |
| NPF hydraulic conductivity before VSC adjustment, including TVK changes. | |
| integer(i4b), pointer | kchangeper => null() |
| integer(i4b), pointer | kchangestp => null() |
| integer(i4b), dimension(:), pointer, contiguous | nodekchange => null() |
| 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 | vsc_calcvisc (this) |
| Calculate fluid viscosity. | |
| procedure, private | allocate_arrays (this, nodes) |
| Allocate arrays. | |
| procedure, private | source_options (this) |
| Source VSC options. | |
| procedure, private | set_options (this, input_data) |
| Sets options as opposed to reading them from a file. | |
| procedure, private | log_options (this, found, viscosityfile) |
| log VSC options | |
| procedure, private | source_dimensions (this) |
| Source dimensions for package. | |
| procedure, private | source_packagedata (this) |
| source packagedata for package | |
| procedure, private | set_packagedata (this, input_data) |
| Sets package data instead of reading from file. | |
| procedure, private | set_npf_pointers (this) |
| Set pointers to NPF variables. | |
| procedure, private | vsc_set_changed_at (this, kper, kstp) |
| Mark K changes as having occurred at (kper, kstp). | |
Definition at line 31 of file gwf-vsc.f90.
|
private |
Allocate and initialize arrays for the VSC package.
Definition at line 80 of file gwf-vsc.f90.
| procedure gwfvscmodule::gwfvsctype::allocate_scalars | ( | class(gwfvsctype) | this | ) |
Allocate and initialize scalars for the VSC package. The base model allocate scalars method is also called.
Definition at line 79 of file gwf-vsc.f90.
|
inherited |
Allocate and initialize base numerical package scalars.
| this | NumericalPackageType object |
Definition at line 54 of file NumericalPackage.f90.
| procedure, public gwfvscmodule::gwfvsctype::calc_q_visc | ( | class(gwfvsctype) | this, |
| integer(i4b), intent(in) | cellid, | ||
| real(dp), intent(inout) | viscratio ) |
Will return the viscosity associated with the upgradient node (cell) to the HFB package for adjusting the hydraulic characteristic (hydchr) of the barrier
Definition at line 90 of file gwf-vsc.f90.
|
inherited |
Deallocate and initialize base numerical package scalars.
| this | NumericalPackageType object |
Definition at line 55 of file NumericalPackage.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 gwfvscmodule::gwfvsctype::get_visc_ratio | ( | class(gwfvsctype) | this, |
| integer(i4b), intent(in) | n, | ||
| integer(i4b), intent(in) | m, | ||
| real(dp), intent(in) | gwhdn, | ||
| real(dp), intent(in) | gwhdm, | ||
| real(dp), intent(inout) | viscratio ) |
Calculate the viscosity ratio applied to the hydraulic characteristic provided by the user. The viscosity ratio is applicable only when the hydraulic characteristic is specified as positive and will not be applied when the hydchr is negative
Definition at line 91 of file gwf-vsc.f90.
|
private |
Definition at line 83 of file gwf-vsc.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.
| procedure gwfvscmodule::gwfvsctype::set_concentration_pointer | ( | class(gwfvsctype) | this, |
| character(len=lenmodelname), intent(in) | modelname, | ||
| real(dp), dimension(:), pointer | conc, | ||
| integer(i4b), dimension(:), pointer | icbund, | ||
| integer(i4b), intent(in), optional | istmpr ) |
Pass in a gwt model name, concentration array, and ibound, and store a pointer to these in the VSC package so that viscosity can be calculated from them. This routine is called from the gwfgwt exchange in the exg_ar() method.
Definition at line 92 of file gwf-vsc.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.
|
private |
Set array and variable pointers from the NPF package for access by VSC.
Definition at line 87 of file gwf-vsc.f90.
|
private |
| [in] | input_data | the input data to be set |
Definition at line 82 of file gwf-vsc.f90.
|
private |
| this | this vscoancy pkg | |
| [in] | input_data | the input data to be set |
Definition at line 86 of file gwf-vsc.f90.
|
private |
Definition at line 84 of file gwf-vsc.f90.
|
private |
Definition at line 81 of file gwf-vsc.f90.
|
private |
Definition at line 85 of file gwf-vsc.f90.
| procedure, public gwfvscmodule::gwfvsctype::update_k_with_vsc | ( | class(gwfvsctype) | this | ) |
This routine called after updating the viscosity values using the latest concentration and/or temperature values. The ratio mu_o/mu, reference viscosity divided by the updated viscosity value, is multiplied by K for each cell.
Definition at line 88 of file gwf-vsc.f90.
| procedure gwfvscmodule::gwfvsctype::vsc_ad | ( | class(gwfvsctype) | this | ) |
Advance data in the VSC package. The method sets or advances time series, time array series, and observation data.
Definition at line 74 of file gwf-vsc.f90.
| procedure, public gwfvscmodule::gwfvsctype::vsc_ad_bnd | ( | class(gwfvsctype) | this, |
| class(bndtype), pointer | packobj, | ||
| real(dp), dimension(:), intent(in) | hnew ) |
Update the conductance values associate with inflow from a boundary when VSC package is active.
Definition at line 75 of file gwf-vsc.f90.
| procedure gwfvscmodule::gwfvsctype::vsc_ar | ( | class(gwfvsctype) | this, |
| integer(i4b), dimension(:), pointer | ibound ) |
Generic method to allocate and read static data for the viscosity package available within the GWF model type.
Definition at line 71 of file gwf-vsc.f90.
| procedure, public gwfvscmodule::gwfvsctype::vsc_ar_bnd | ( | class(gwfvsctype) | this, |
| class(bndtype), pointer | packobj ) |
Viscosity ar_bnd routine to activate viscosity in the advanced packages. This routine is called from gwf_ar() as it moves through each package
Definition at line 72 of file gwf-vsc.f90.
|
private |
Calculates fluid viscosity based on concentration or temperature
Definition at line 78 of file gwf-vsc.f90.
| procedure gwfvscmodule::gwfvsctype::vsc_da | ( | class(gwfvsctype) | this | ) |
Deallocate viscosity package scalars and arrays.
Definition at line 77 of file gwf-vsc.f90.
| procedure gwfvscmodule::gwfvsctype::vsc_df | ( | class(gwfvsctype) | this, |
| class(disbasetype), intent(in), pointer | dis, | ||
| type(gwfvscinputdatatype), intent(in), optional | vsc_input ) |
Define viscosity package options and dimensions
| this | this viscosity package | |
| [in] | dis | pointer to discretization |
| [in] | vsc_input | optional vsc input data, otherwise read from file |
Definition at line 70 of file gwf-vsc.f90.
| procedure gwfvscmodule::gwfvsctype::vsc_ot_dv | ( | class(gwfvsctype) | this, |
| integer(i4b), intent(in) | idvfl ) |
Save calculated viscosity array to binary file
Definition at line 76 of file gwf-vsc.f90.
| procedure gwfvscmodule::gwfvsctype::vsc_rp | ( | class(gwfvsctype) | this | ) |
Method to read and prepare period data for the VSC package.
Definition at line 73 of file gwf-vsc.f90.
|
private |
Procedure called by VSC code when K updated due to viscosity changes. K values changed at (kper, kstp).
Definition at line 89 of file gwf-vsc.f90.
| real(dp), pointer gwfvscmodule::gwfvsctype::a2 => null() |
Definition at line 52 of file gwf-vsc.f90.
| real(dp), pointer gwfvscmodule::gwfvsctype::a3 => null() |
Definition at line 53 of file gwf-vsc.f90.
| real(dp), pointer gwfvscmodule::gwfvsctype::a4 => null() |
Definition at line 54 of file gwf-vsc.f90.
| character(len=lenauxname), dimension(:), allocatable gwfvscmodule::gwfvsctype::cauxspeciesname |
Definition at line 48 of file gwf-vsc.f90.
| character(len=lenmodelname), dimension(:), allocatable gwfvscmodule::gwfvsctype::cmodelname |
Definition at line 47 of file gwf-vsc.f90.
| real(dp), dimension(:), pointer, contiguous gwfvscmodule::gwfvsctype::ctemp => null() |
Definition at line 46 of file gwf-vsc.f90.
| real(dp), dimension(:), pointer, contiguous gwfvscmodule::gwfvsctype::cviscref => null() |
Definition at line 45 of file gwf-vsc.f90.
|
inherited |
Definition at line 50 of file NumericalPackage.f90.
| real(dp), dimension(:), pointer, contiguous gwfvscmodule::gwfvsctype::dviscdc => null() |
Definition at line 44 of file gwf-vsc.f90.
| real(dp), dimension(:), pointer, contiguous gwfvscmodule::gwfvsctype::elev => null() |
Definition at line 40 of file gwf-vsc.f90.
|
inherited |
Definition at line 33 of file NumericalPackage.f90.
|
inherited |
Definition at line 41 of file NumericalPackage.f90.
| integer(i4b), dimension(:), pointer gwfvscmodule::gwfvsctype::ibound => null() |
Definition at line 41 of file gwf-vsc.f90.
| integer(i4b), pointer gwfvscmodule::gwfvsctype::iconcset => null() |
Definition at line 35 of file gwf-vsc.f90.
|
inherited |
Definition at line 37 of file NumericalPackage.f90.
| integer(i4b), pointer gwfvscmodule::gwfvsctype::idxtmpr => null() |
Definition at line 33 of file gwf-vsc.f90.
|
inherited |
Definition at line 40 of file NumericalPackage.f90.
|
inherited |
Definition at line 32 of file NumericalPackage.f90.
|
inherited |
Definition at line 31 of file NumericalPackage.f90.
|
inherited |
Definition at line 38 of file NumericalPackage.f90.
|
inherited |
Definition at line 45 of file NumericalPackage.f90.
|
inherited |
Definition at line 39 of file NumericalPackage.f90.
| integer(i4b), pointer gwfvscmodule::gwfvsctype::ioutvisc => null() |
Definition at line 34 of file gwf-vsc.f90.
|
inherited |
Definition at line 44 of file NumericalPackage.f90.
|
inherited |
Definition at line 43 of file NumericalPackage.f90.
|
inherited |
Definition at line 42 of file NumericalPackage.f90.
| integer(i4b), pointer gwfvscmodule::gwfvsctype::ireadelev => null() |
Definition at line 36 of file gwf-vsc.f90.
| integer(i4b), dimension(:), pointer, contiguous gwfvscmodule::gwfvsctype::ivisc => null() |
Definition at line 37 of file gwf-vsc.f90.
| real(dp), dimension(:), pointer, contiguous gwfvscmodule::gwfvsctype::k11 => null() |
Definition at line 58 of file gwf-vsc.f90.
| real(dp), dimension(:), pointer, contiguous gwfvscmodule::gwfvsctype::k11input => null() |
Definition at line 61 of file gwf-vsc.f90.
| real(dp), dimension(:), pointer, contiguous gwfvscmodule::gwfvsctype::k22 => null() |
Definition at line 59 of file gwf-vsc.f90.
| real(dp), dimension(:), pointer, contiguous gwfvscmodule::gwfvsctype::k22input => null() |
Definition at line 62 of file gwf-vsc.f90.
| real(dp), dimension(:), pointer, contiguous gwfvscmodule::gwfvsctype::k33 => null() |
Definition at line 60 of file gwf-vsc.f90.
| real(dp), dimension(:), pointer, contiguous gwfvscmodule::gwfvsctype::k33input => null() |
Definition at line 63 of file gwf-vsc.f90.
| integer(i4b), pointer gwfvscmodule::gwfvsctype::kchangeper => null() |
Definition at line 64 of file gwf-vsc.f90.
| integer(i4b), pointer gwfvscmodule::gwfvsctype::kchangestp => null() |
Definition at line 65 of file gwf-vsc.f90.
|
inherited |
Definition at line 46 of file NumericalPackage.f90.
|
inherited |
Definition at line 28 of file NumericalPackage.f90.
|
inherited |
Definition at line 29 of file NumericalPackage.f90.
| type(concentrationpointer), dimension(:), allocatable gwfvscmodule::gwfvsctype::modelconc |
Definition at line 56 of file gwf-vsc.f90.
|
inherited |
Definition at line 26 of file NumericalPackage.f90.
| character(len=lenauxname) gwfvscmodule::gwfvsctype::name_temp_spec = 'TEMPERATURE' |
Definition at line 49 of file gwf-vsc.f90.
| integer(i4b), dimension(:), pointer, contiguous gwfvscmodule::gwfvsctype::nodekchange => null() |
Definition at line 66 of file gwf-vsc.f90.
| integer(i4b), pointer gwfvscmodule::gwfvsctype::nviscspecies => null() |
Definition at line 43 of file gwf-vsc.f90.
|
inherited |
Definition at line 34 of file NumericalPackage.f90.
|
inherited |
Definition at line 27 of file NumericalPackage.f90.
|
inherited |
Definition at line 49 of file NumericalPackage.f90.
| integer(i4b), pointer gwfvscmodule::gwfvsctype::thermivisc => null() |
Definition at line 32 of file gwf-vsc.f90.
| real(dp), dimension(:), pointer, contiguous gwfvscmodule::gwfvsctype::visc => null() |
Definition at line 39 of file gwf-vsc.f90.
| real(dp), pointer gwfvscmodule::gwfvsctype::viscref => null() |
Definition at line 38 of file gwf-vsc.f90.