![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|
Energy Storage and Transfer (EST) Module. More...
Data Types | |
| type | gweesttype |
| Energy storage and transfer. More... | |
Enumerations | |
| enum | { decay_off = 0 , decay_zero_order = 2 , decay_water = 1 , decay_solid = 2 , decay_both = 3 } |
| Enumerator that defines the decay options. More... | |
Functions/Subroutines | |
| subroutine, public | est_cr (estobj, name_model, input_mempath, inunit, iout, fmi, eqnsclfac, gwecommon) |
| Create a new EST package object. | |
| subroutine | est_ar (this, dis, ibound) |
| Allocate and read method for package. | |
| subroutine | est_fc (this, nodes, cold, nja, matrix_sln, idxglo, cnew, rhs, kiter) |
| Fill coefficient method for package. | |
| subroutine | est_fc_sto (this, nodes, cold, nja, matrix_sln, idxglo, rhs) |
| Fill storage coefficient method for package. | |
| subroutine | est_fc_dcy_water (this, nodes, cold, cnew, nja, matrix_sln, idxglo, rhs, kiter) |
| Fill decay coefficient method for package. | |
| subroutine | est_fc_dcy_solid (this, nodes, cold, nja, matrix_sln, idxglo, rhs, cnew, kiter) |
| Fill solid decay coefficient method for package. | |
| subroutine | est_cq (this, nodes, cnew, cold, flowja) |
| Calculate flows for package. | |
| subroutine | est_cq_sto (this, nodes, cnew, cold, flowja) |
| Calculate storage terms for package. | |
| subroutine | est_cq_dcy (this, nodes, cnew, cold, flowja) |
| Calculate decay terms for aqueous phase. | |
| subroutine | est_cq_dcy_solid (this, nodes, cnew, cold, flowja) |
| Calculate decay terms for solid phase. | |
| subroutine | est_bd (this, isuppress_output, model_budget) |
| Calculate budget terms for package. | |
| subroutine | est_ot_flow (this, icbcfl, icbcun) |
| Output flow terms for package. | |
| subroutine | est_da (this) |
| Deallocate memory. | |
| subroutine | allocate_scalars (this) |
| Allocate scalar variables for package. | |
| subroutine | allocate_arrays (this, nodes) |
| Allocate arrays for package. | |
| subroutine | source_options (this) |
| Update simulation mempath options. | |
| subroutine | log_options (this, found) |
| Write user options to list file. | |
| subroutine | source_data (this) |
| Source EST griddata from input mempath. | |
Variables | |
| integer(i4b), parameter | nbditems = 3 |
| character(len=lenbudtxt), dimension(nbditems) | budtxt |
The GweEstModule contains the GweEstType, which is related to GwtEstModule; however, there are some important differences owing to the fact that a sorbed phase is not considered. Instead, a single temperature is simulated for each grid cell and is representative of both the aqueous and solid phases (i.e., instantaneous thermal equilibrium is assumed). Also, "thermal bleeding" is accommodated, where conductive processes can transport into, through, or out of dry cells that are part of the active domain.
| anonymous enum |
Definition at line 36 of file gwe-est.f90.
| subroutine gweestmodule::allocate_arrays | ( | class(gweesttype) | this, |
| integer(i4b), intent(in) | nodes ) |
Method to allocate arrays for the package.
| this | GweEstType object | |
| [in] | nodes | number of nodes |
Definition at line 679 of file gwe-est.f90.
| subroutine gweestmodule::allocate_scalars | ( | class(gweesttype) | this | ) |
Method to allocate scalar variables for the package.
| this | GweEstType object |
Definition at line 651 of file gwe-est.f90.
| subroutine gweestmodule::est_ar | ( | class(gweesttype), intent(inout) | this, |
| class(disbasetype), intent(in), pointer | dis, | ||
| integer(i4b), dimension(:), pointer, contiguous | ibound ) |
Method to allocate and read static data for the package.
| [in,out] | this | GweEstType object |
| [in] | dis | pointer to dis package |
| ibound | pointer to GWE ibound array |
Definition at line 136 of file gwe-est.f90.

| subroutine gweestmodule::est_bd | ( | class(gweesttype) | this, |
| integer(i4b), intent(in) | isuppress_output, | ||
| type(budgettype), intent(inout) | model_budget ) |
Method to calculate budget terms for the package.
| this | GweEstType object | |
| [in] | isuppress_output | flag to suppress output |
| [in,out] | model_budget | model budget object |
Definition at line 525 of file gwe-est.f90.

| subroutine gweestmodule::est_cq | ( | class(gweesttype) | this, |
| integer(i4b), intent(in) | nodes, | ||
| real(dp), dimension(nodes), intent(in) | cnew, | ||
| real(dp), dimension(nodes), intent(in) | cold, | ||
| real(dp), dimension(:), intent(inout), contiguous | flowja ) |
Method to calculate flows for the package.
| this | GweEstType object | |
| [in] | nodes | number of nodes |
| [in] | cnew | temperature at end of this time step |
| [in] | cold | temperature at end of last time step |
| [in,out] | flowja | flow between two connected control volumes |
Definition at line 347 of file gwe-est.f90.
| subroutine gweestmodule::est_cq_dcy | ( | class(gweesttype) | this, |
| integer(i4b), intent(in) | nodes, | ||
| real(dp), dimension(nodes), intent(in) | cnew, | ||
| real(dp), dimension(nodes), intent(in) | cold, | ||
| real(dp), dimension(:), intent(inout), contiguous | flowja ) |
Method to calculate decay terms for the aqueous phase.
| this | GweEstType object | |
| [in] | nodes | number of nodes |
| [in] | cnew | temperature at end of this time step |
| [in] | cold | temperature at end of last time step |
| [in,out] | flowja | flow between two connected control volumes |
Definition at line 426 of file gwe-est.f90.
| subroutine gweestmodule::est_cq_dcy_solid | ( | class(gweesttype) | this, |
| integer(i4b), intent(in) | nodes, | ||
| real(dp), dimension(nodes), intent(in) | cnew, | ||
| real(dp), dimension(nodes), intent(in) | cold, | ||
| real(dp), dimension(:), intent(inout), contiguous | flowja ) |
Method to calculate decay terms for the solid phase.
| this | GweEstType object | |
| [in] | nodes | number of nodes |
| [in] | cnew | temperature at end of this time step |
| [in] | cold | temperature at end of last time step |
| [in,out] | flowja | flow between two connected control volumes |
Definition at line 477 of file gwe-est.f90.
| subroutine gweestmodule::est_cq_sto | ( | class(gweesttype) | this, |
| integer(i4b), intent(in) | nodes, | ||
| real(dp), dimension(nodes), intent(in) | cnew, | ||
| real(dp), dimension(nodes), intent(in) | cold, | ||
| real(dp), dimension(:), intent(inout), contiguous | flowja ) |
Method to calculate storage terms for the package.
| this | GweEstType object | |
| [in] | nodes | number of nodes |
| [in] | cnew | temperature at end of this time step |
| [in] | cold | temperature at end of last time step |
| [in,out] | flowja | flow between two connected control volumes |
Definition at line 374 of file gwe-est.f90.
| subroutine, public gweestmodule::est_cr | ( | type(gweesttype), pointer | estobj, |
| character(len=*), intent(in) | name_model, | ||
| character(len=*), intent(in) | input_mempath, | ||
| integer(i4b), intent(in) | inunit, | ||
| integer(i4b), intent(in) | iout, | ||
| type(tspfmitype), intent(in), target | fmi, | ||
| real(dp), intent(in), pointer | eqnsclfac, | ||
| type(gweinputdatatype), intent(in), target | gwecommon ) |
Create a new EST package
| estobj | unallocated new est object to create | |
| [in] | name_model | name of the model |
| [in] | input_mempath | input mempath of package |
| [in] | inunit | unit number of WEL package input file |
| [in] | iout | unit number of model listing file |
| [in] | fmi | fmi package for this GWE model |
| [in] | eqnsclfac | governing equation scale factor |
| [in] | gwecommon | shared data container for use by multiple GWE packages |
Definition at line 103 of file gwe-est.f90.

| subroutine gweestmodule::est_da | ( | class(gweesttype) | this | ) |
Method to deallocate memory for the package.
| this | GweEstType object |
Definition at line 616 of file gwe-est.f90.
| subroutine gweestmodule::est_fc | ( | class(gweesttype) | this, |
| integer, intent(in) | nodes, | ||
| real(dp), dimension(nodes), intent(in) | cold, | ||
| integer(i4b), intent(in) | nja, | ||
| class(matrixbasetype), pointer | matrix_sln, | ||
| integer(i4b), dimension(nja), intent(in) | idxglo, | ||
| real(dp), dimension(nodes), intent(in) | cnew, | ||
| real(dp), dimension(nodes), intent(inout) | rhs, | ||
| integer(i4b), intent(in) | kiter ) |
Method to calculate and fill coefficients for the package.
| this | GweEstType object | |
| [in] | nodes | number of nodes |
| [in] | cold | temperature at end of last time step |
| [in] | nja | number of GWE connections |
| matrix_sln | solution matrix | |
| [in] | idxglo | mapping vector for model (local) to solution (global) |
| [in,out] | rhs | right-hand side vector for model |
| [in] | cnew | temperature at end of this time step |
| [in] | kiter | solution outer iteration number |
Definition at line 173 of file gwe-est.f90.
| subroutine gweestmodule::est_fc_dcy_solid | ( | class(gweesttype) | this, |
| integer, intent(in) | nodes, | ||
| real(dp), dimension(nodes), intent(in) | cold, | ||
| integer(i4b), intent(in) | nja, | ||
| class(matrixbasetype), pointer | matrix_sln, | ||
| integer(i4b), dimension(nja), intent(in) | idxglo, | ||
| real(dp), dimension(nodes), intent(inout) | rhs, | ||
| real(dp), dimension(nodes), intent(in) | cnew, | ||
| integer(i4b), intent(in) | kiter ) |
Method to calculate and fill energy decay coefficients for the solid phase.
| this | GwtMstType object | |
| [in] | nodes | number of nodes |
| [in] | cold | temperature at end of last time step |
| [in] | nja | number of GWE connections |
| matrix_sln | solution coefficient matrix | |
| [in] | idxglo | mapping vector for model (local) to solution (global) |
| [in,out] | rhs | right-hand side vector for model |
| [in] | cnew | temperature at end of this time step |
| [in] | kiter | solution outer iteration number |
Definition at line 298 of file gwe-est.f90.
| subroutine gweestmodule::est_fc_dcy_water | ( | class(gweesttype) | this, |
| integer, intent(in) | nodes, | ||
| real(dp), dimension(nodes), intent(in) | cold, | ||
| real(dp), dimension(nodes), intent(in) | cnew, | ||
| integer(i4b), intent(in) | nja, | ||
| class(matrixbasetype), pointer | matrix_sln, | ||
| integer(i4b), dimension(nja), intent(in) | idxglo, | ||
| real(dp), dimension(nodes), intent(inout) | rhs, | ||
| integer(i4b), intent(in) | kiter ) |
Method to calculate and fill decay coefficients for the package.
| this | GweEstType object | |
| [in] | nodes | number of nodes |
| [in] | cold | temperature at end of last time step |
| [in] | cnew | temperature at end of this time step |
| [in] | nja | number of GWE connections |
| matrix_sln | solution coefficient matrix | |
| [in] | idxglo | mapping vector for model (local) to solution (global) |
| [in,out] | rhs | right-hand side vector for model |
| [in] | kiter | solution outer iteration number |
Definition at line 250 of file gwe-est.f90.
| subroutine gweestmodule::est_fc_sto | ( | class(gweesttype) | this, |
| integer, intent(in) | nodes, | ||
| real(dp), dimension(nodes), intent(in) | cold, | ||
| integer(i4b), intent(in) | nja, | ||
| class(matrixbasetype), pointer | matrix_sln, | ||
| integer(i4b), dimension(nja), intent(in) | idxglo, | ||
| real(dp), dimension(nodes), intent(inout) | rhs ) |
Method to calculate and fill storage coefficients for the package.
| this | GweEstType object | |
| [in] | nodes | number of nodes |
| [in] | cold | temperature at end of last time step |
| [in] | nja | number of GWE connections |
| matrix_sln | solution coefficient matrix | |
| [in] | idxglo | mapping vector for model (local) to solution (global) |
| [in,out] | rhs | right-hand side vector for model |
Definition at line 202 of file gwe-est.f90.
| subroutine gweestmodule::est_ot_flow | ( | class(gweesttype) | this, |
| integer(i4b), intent(in) | icbcfl, | ||
| integer(i4b), intent(in) | icbcun ) |
Method to output terms for the package.
| this | GweEstType object | |
| [in] | icbcfl | flag and unit number for cell-by-cell output |
| [in] | icbcun | flag indication if cell-by-cell data should be saved |
Definition at line 563 of file gwe-est.f90.
| subroutine gweestmodule::log_options | ( | class(gweesttype) | this, |
| type(gweestparamfoundtype), intent(in) | found ) |
Definition at line 793 of file gwe-est.f90.
| subroutine gweestmodule::source_data | ( | class(gweesttype) | this | ) |
Definition at line 839 of file gwe-est.f90.

| subroutine gweestmodule::source_options | ( | class(gweesttype) | this | ) |
Definition at line 734 of file gwe-est.f90.

| character(len=lenbudtxt), dimension(nbditems) gweestmodule::budtxt |
Definition at line 31 of file gwe-est.f90.
| integer(i4b), parameter gweestmodule::nbditems = 3 |
Definition at line 30 of file gwe-est.f90.