MODFLOW 6
version 6.5.0.dev2
MODFLOW 6 Code Documentation
|
Data Types | |
type | gwtmodeltype |
Functions/Subroutines | |
subroutine, public | gwt_cr (filename, id, modelname) |
Create a new groundwater transport model object. More... | |
subroutine | gwt_df (this) |
Define packages of the GWT model. More... | |
subroutine | gwt_ac (this, sparse) |
Add the internal connections of this model to the sparse matrix. More... | |
subroutine | gwt_mc (this, matrix_sln) |
Map the positions of the GWT model connections in the numerical solution coefficient matrix. More... | |
subroutine | gwt_ar (this) |
GWT Model Allocate and Read. More... | |
subroutine | gwt_rp (this) |
GWT Model Read and Prepare. More... | |
subroutine | gwt_ad (this) |
GWT Model Time Step Advance. More... | |
subroutine | gwt_cf (this, kiter) |
GWT Model calculate coefficients. More... | |
subroutine | gwt_fc (this, kiter, matrix_sln, inwtflag) |
GWT Model fill coefficients. More... | |
subroutine | gwt_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak) |
GWT Model Final Convergence Check. More... | |
subroutine | gwt_cq (this, icnvg, isuppress_output) |
GWT Model calculate flow. More... | |
subroutine | gwt_bd (this, icnvg, isuppress_output) |
GWT Model Budget. More... | |
subroutine | gwt_ot (this) |
Print and/or save model output. More... | |
subroutine | gwt_da (this) |
Deallocate. More... | |
subroutine | gwt_bdentry (this, budterm, budtxt, rowlabel) |
GroundWater Transport Model Budget Entry. More... | |
integer(i4b) function | gwt_get_iasym (this) |
return 1 if any package causes the matrix to be asymmetric. Otherwise return 0. More... | |
subroutine | allocate_scalars (this, modelname) |
Allocate memory for non-allocatable members. More... | |
subroutine | package_create (this, filtyp, ipakid, ipaknum, pakname, mempath, inunit, iout) |
Create boundary condition packages for this model. More... | |
class(gwtmodeltype) function, pointer, public | castasgwtmodel (model) |
Cast to GwtModelType. More... | |
subroutine | create_bndpkgs (this, bndpkgs, pkgtypes, pkgnames, mempaths, inunits) |
Source package info and begin to process. More... | |
subroutine | create_gwt_packages (this, indis) |
Source package info and begin to process. More... | |
Variables | |
character(len=lenvarname), parameter | dvt = 'CONCENTRATION ' |
dependent variable type, varies based on model type More... | |
character(len=lenvarname), parameter | dvu = 'MASS ' |
dependent variable unit of measure, either "mass" or "energy" More... | |
character(len=lenvarname), parameter | dvua = 'M ' |
abbreviation of the dependent variable unit of measure, either "M" or "E" More... | |
integer(i4b), parameter, public | gwt_nbasepkg = 50 |
GWT base package array descriptors. More... | |
character(len=lenpackagetype), dimension(gwt_nbasepkg), public | gwt_basepkg |
integer(i4b), parameter, public | gwt_nmultipkg = 50 |
GWT multi package array descriptors. More... | |
character(len=lenpackagetype), dimension(gwt_nmultipkg), public | gwt_multipkg |
integer(i4b), parameter | niunit_gwt = GWT_NBASEPKG + GWT_NMULTIPKG |
|
private |
A subroutine for allocating the scalars specific to the GWT model type. Additional scalars used by the parent class are allocated by the parent class.
Definition at line 734 of file gwt.f90.
class(gwtmodeltype) function, pointer, public gwtmodule::castasgwtmodel | ( | class(*), pointer | model | ) |
|
private |
Definition at line 857 of file gwt.f90.
subroutine gwtmodule::create_gwt_packages | ( | class(gwtmodeltype) | this, |
integer(i4b), intent(in) | indis | ||
) |
Definition at line 914 of file gwt.f90.
subroutine gwtmodule::gwt_ac | ( | class(gwtmodeltype) | this, |
type(sparsematrix), intent(inout) | sparse | ||
) |
Definition at line 201 of file gwt.f90.
subroutine gwtmodule::gwt_ad | ( | class(gwtmodeltype) | this | ) |
Call the advance subroutines of the attached packages
Definition at line 344 of file gwt.f90.
|
private |
This subroutine:
Definition at line 259 of file gwt.f90.
subroutine gwtmodule::gwt_bd | ( | class(gwtmodeltype) | this, |
integer(i4b), intent(in) | icnvg, | ||
integer(i4b), intent(in) | isuppress_output | ||
) |
subroutine gwtmodule::gwt_bdentry | ( | class(gwtmodeltype) | this, |
real(dp), dimension(:, :), intent(in) | budterm, | ||
character(len=lenbudtxt), dimension(:), intent(in) | budtxt, | ||
character(len=*), intent(in) | rowlabel | ||
) |
This subroutine adds a budget entry to the flow budget. It was added as a method for the gwt model object so that the exchange object could add its contributions.
Definition at line 679 of file gwt.f90.
|
private |
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)
Definition at line 475 of file gwt.f90.
subroutine gwtmodule::gwt_cf | ( | class(gwtmodeltype) | this, |
integer(i4b), intent(in) | kiter | ||
) |
|
private |
subroutine, public gwtmodule::gwt_cr | ( | character(len=*), intent(in) | filename, |
integer(i4b), intent(in) | id, | ||
character(len=*), intent(in) | modelname | ||
) |
[in] | filename | input file |
[in] | id | consecutive model number listed in mfsim.nam |
[in] | modelname | name of the model |
Definition at line 97 of file gwt.f90.
|
private |
Deallocate memory at conclusion of model run
Definition at line 612 of file gwt.f90.
subroutine gwtmodule::gwt_df | ( | class(gwtmodeltype) | this | ) |
This subroutine defines a gwt model type. Steps include: (1) call df routines for each package (2) set variables and pointers
Definition at line 146 of file gwt.f90.
|
private |
integer(i4b) function gwtmodule::gwt_get_iasym | ( | class(gwtmodeltype) | this | ) |
subroutine gwtmodule::gwt_mc | ( | class(gwtmodeltype) | this, |
class(matrixbasetype), pointer | matrix_sln | ||
) |
subroutine gwtmodule::gwt_ot | ( | class(gwtmodeltype) | this | ) |
subroutine gwtmodule::gwt_rp | ( | class(gwtmodeltype) | this | ) |
Call the read and prepare routines of the attached packages
Definition at line 311 of file gwt.f90.
subroutine gwtmodule::package_create | ( | class(gwtmodeltype) | this, |
character(len=*), intent(in) | filtyp, | ||
integer(i4b), intent(in) | ipakid, | ||
integer(i4b), intent(in) | ipaknum, | ||
character(len=*), intent(in) | pakname, | ||
character(len=*), intent(in) | mempath, | ||
integer(i4b), intent(in) | inunit, | ||
integer(i4b), intent(in) | iout | ||
) |
Call the package create routines for packages activated by the user.
Definition at line 759 of file gwt.f90.
|
private |
|
private |
|
private |
character(len=lenpackagetype), dimension(gwt_nbasepkg), public gwtmodule::gwt_basepkg |
character(len=lenpackagetype), dimension(gwt_nmultipkg), public gwtmodule::gwt_multipkg |
integer(i4b), parameter, public gwtmodule::gwt_nbasepkg = 50 |
integer(i4b), parameter, public gwtmodule::gwt_nmultipkg = 50 |