MODFLOW 6
version 6.6.0.dev0
USGS Modular Hydrologic Model
|
Data Types | |
type | gwelketype |
Functions/Subroutines | |
subroutine, public | lke_create (packobj, id, ibcnum, inunit, iout, namemodel, pakname, fmi, eqnsclfac, gwecommon, dvt, dvu, dvua) |
Create a new lke package. More... | |
subroutine | find_lke_package (this) |
Find corresponding lke package. More... | |
subroutine | lke_fc_expanded (this, rhs, ia, idxglo, matrix_sln) |
Add matrix terms related to LKE. More... | |
subroutine | lke_solve (this) |
Add terms specific to lakes to the explicit lake solve. More... | |
integer(i4b) function | lke_get_nbudterms (this) |
Function to return the number of budget terms just for this package. More... | |
subroutine | lke_setup_budobj (this, idx) |
Set up the budget object that stores all the lake flows. More... | |
subroutine | lke_fill_budobj (this, idx, x, flowja, ccratin, ccratout) |
Copy flow terms into thisbudobj. More... | |
subroutine | allocate_scalars (this) |
Allocate scalars specific to the lake energy transport (LKE) package. More... | |
subroutine | lke_allocate_arrays (this) |
Allocate arrays specific to the lake energy transport (LKE) package. More... | |
subroutine | lke_da (this) |
Deallocate memory. More... | |
subroutine | lke_rain_term (this, ientry, n1, n2, rrate, rhsval, hcofval) |
Rain term. More... | |
subroutine | lke_evap_term (this, ientry, n1, n2, rrate, rhsval, hcofval) |
Evaporative term. More... | |
subroutine | lke_roff_term (this, ientry, n1, n2, rrate, rhsval, hcofval) |
Runoff term. More... | |
subroutine | lke_iflw_term (this, ientry, n1, n2, rrate, rhsval, hcofval) |
Inflow Term. More... | |
subroutine | lke_wdrl_term (this, ientry, n1, n2, rrate, rhsval, hcofval) |
Specified withdrawal term. More... | |
subroutine | lke_outf_term (this, ientry, n1, n2, rrate, rhsval, hcofval) |
Outflow term. More... | |
subroutine | lke_df_obs (this) |
Defined observation types. More... | |
subroutine | lke_rp_obs (this, obsrv, found) |
Process package specific obs. More... | |
subroutine | lke_bd_obs (this, obstypeid, jj, v, found) |
Calculate observation value and pass it back to APT. More... | |
subroutine | lke_set_stressperiod (this, itemno, keyword, found) |
Sets the stress period attributes for keyword use. More... | |
Variables | |
character(len= *), parameter | ftype = 'LKE' |
character(len= *), parameter | flowtype = 'LAK' |
character(len=16) | text = ' LKE' |
subroutine gwelkemodule::allocate_scalars | ( | class(gwelketype) | this | ) |
Definition at line 707 of file gwe-lke.f90.
subroutine gwelkemodule::find_lke_package | ( | class(gwelketype) | this | ) |
subroutine gwelkemodule::lke_allocate_arrays | ( | class(gwelketype), intent(inout) | this | ) |
Definition at line 738 of file gwe-lke.f90.
subroutine gwelkemodule::lke_bd_obs | ( | class(gwelketype), 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 1063 of file gwe-lke.f90.
subroutine, public gwelkemodule::lke_create | ( | class(bndtype), pointer | packobj, |
integer(i4b), intent(in) | id, | ||
integer(i4b), intent(in) | ibcnum, | ||
integer(i4b), intent(in) | inunit, | ||
integer(i4b), intent(in) | iout, | ||
character(len=*), intent(in) | namemodel, | ||
character(len=*), intent(in) | pakname, | ||
type(tspfmitype), pointer | fmi, | ||
real(dp), intent(in), pointer | eqnsclfac, | ||
type(gweinputdatatype), intent(in), target | gwecommon, | ||
character(len=*), intent(in) | dvt, | ||
character(len=*), intent(in) | dvu, | ||
character(len=*), intent(in) | dvua | ||
) |
[in] | eqnsclfac | governing equation scale factor |
[in] | gwecommon | shared data container for use by multiple GWE packages |
[in] | dvt | For GWE, set to "TEMPERATURE" in TspAptType |
[in] | dvu | For GWE, set to "energy" in TspAptType |
[in] | dvua | For GWE, set to "E" in TspAptType |
Definition at line 101 of file gwe-lke.f90.
subroutine gwelkemodule::lke_da | ( | class(gwelketype) | this | ) |
Definition at line 767 of file gwe-lke.f90.
subroutine gwelkemodule::lke_df_obs | ( | class(gwelketype) | this | ) |
Store the observation type supported by the APT package and override BndTypebnd_df_obs
Definition at line 957 of file gwe-lke.f90.
subroutine gwelkemodule::lke_evap_term | ( | class(gwelketype) | 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 819 of file gwe-lke.f90.
subroutine gwelkemodule::lke_fc_expanded | ( | class(gwelketype) | this, |
real(dp), dimension(:), intent(inout) | rhs, | ||
integer(i4b), dimension(:), intent(in) | ia, | ||
integer(i4b), dimension(:), intent(in) | idxglo, | ||
class(matrixbasetype), pointer | matrix_sln | ||
) |
This will be called from TspAptTypeapt_fc_expanded() in order to add matrix terms specifically for LKE
Definition at line 285 of file gwe-lke.f90.
subroutine gwelkemodule::lke_fill_budobj | ( | class(gwelketype) | 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 598 of file gwe-lke.f90.
integer(i4b) function gwelkemodule::lke_get_nbudterms | ( | class(gwelketype) | this | ) |
This overrides a function in the parent class.
Definition at line 464 of file gwe-lke.f90.
subroutine gwelkemodule::lke_iflw_term | ( | class(gwelketype) | 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 | ||
) |
Accounts for energy flowing into a lake from a connected stream, for example.
Definition at line 873 of file gwe-lke.f90.
subroutine gwelkemodule::lke_outf_term | ( | class(gwelketype) | 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 | ||
) |
Accounts for the energy leaving a lake, for example, energy exiting a lake via a flow into a draining stream channel.
Definition at line 929 of file gwe-lke.f90.
subroutine gwelkemodule::lke_rain_term | ( | class(gwelketype) | 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 794 of file gwe-lke.f90.
subroutine gwelkemodule::lke_roff_term | ( | class(gwelketype) | 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 845 of file gwe-lke.f90.
subroutine gwelkemodule::lke_rp_obs | ( | class(gwelketype), 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 1033 of file gwe-lke.f90.
subroutine gwelkemodule::lke_set_stressperiod | ( | class(gwelketype), intent(inout) | this, |
integer(i4b), intent(in) | itemno, | ||
character(len=*), intent(in) | keyword, | ||
logical, intent(inout) | found | ||
) |
Definition at line 1106 of file gwe-lke.f90.
subroutine gwelkemodule::lke_setup_budobj | ( | class(gwelketype) | this, |
integer(i4b), intent(inout) | idx | ||
) |
Definition at line 484 of file gwe-lke.f90.
subroutine gwelkemodule::lke_solve | ( | class(gwelketype) | this | ) |
Definition at line 403 of file gwe-lke.f90.
subroutine gwelkemodule::lke_wdrl_term | ( | class(gwelketype) | 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 | ||
) |
Accounts for energy associated with a withdrawal of water from a lake or group of lakes.
Definition at line 901 of file gwe-lke.f90.
character(len=*), parameter gwelkemodule::flowtype = 'LAK' |
Definition at line 53 of file gwe-lke.f90.
character(len=*), parameter gwelkemodule::ftype = 'LKE' |
Definition at line 52 of file gwe-lke.f90.
character(len=16) gwelkemodule::text = ' LKE' |
Definition at line 54 of file gwe-lke.f90.