MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches

Energy storage and transfer. More...

Inheritance diagram for gweestmodule::gweesttype:
Inheritance graph
Collaboration diagram for gweestmodule::gweesttype:
Collaboration graph

Public Member Functions

procedure est_ar (this, dis, ibound)
 Allocate and read method for package.
procedure est_fc (this, nodes, cold, nja, matrix_sln, idxglo, cnew, rhs, kiter)
 Fill coefficient method for package.
procedure est_fc_sto (this, nodes, cold, nja, matrix_sln, idxglo, rhs)
 Fill storage coefficient method for package.
procedure est_fc_dcy_water (this, nodes, cold, cnew, nja, matrix_sln, idxglo, rhs, kiter)
 Fill decay coefficient method for package.
procedure est_fc_dcy_solid (this, nodes, cold, nja, matrix_sln, idxglo, rhs, cnew, kiter)
 Fill solid decay coefficient method for package.
procedure est_cq (this, nodes, cnew, cold, flowja)
 Calculate flows for package.
procedure est_cq_sto (this, nodes, cnew, cold, flowja)
 Calculate storage terms for package.
procedure est_cq_dcy (this, nodes, cnew, cold, flowja)
 Calculate decay terms for aqueous phase.
procedure est_cq_dcy_solid (this, nodes, cnew, cold, flowja)
 Calculate decay terms for solid phase.
procedure est_bd (this, isuppress_output, model_budget)
 Calculate budget terms for package.
procedure est_ot_flow (this, icbcfl, icbcun)
 Output flow terms for package.
procedure est_da (this)
 Deallocate memory.
procedure allocate_scalars (this)
 Allocate scalar variables for package.
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

real(dp), pointer cpw => null()
 heat capacity of water
real(dp), pointer rhow => null()
 density of water
real(dp), pointer latheatvap => null()
 latent heat of vaporization
real(dp), dimension(:), pointer, contiguous cps => null()
 heat capacity of solid
real(dp), dimension(:), pointer, contiguous rhos => null()
 density of solid
real(dp), dimension(:), pointer, contiguous porosity => null()
 porosity
real(dp), dimension(:), pointer, contiguous ratesto => null()
 rate of energy storage
integer(i4b), pointer idcy => null()
 order of decay rate (0:none, 1:first, 2:zero (aqueous and/or solid))
integer(i4b), pointer idcysrc => null()
 decay source (or sink) (1: aqueous only, 2: solid only, 3: both phases
real(dp), dimension(:), pointer, contiguous decay_water => null()
 first or zero order decay rate (aqueous)
real(dp), dimension(:), pointer, contiguous decay_solid => null()
 first or zero order decay rate (solid)
real(dp), dimension(:), pointer, contiguous ratedcyw => null()
 rate of decay in aqueous phase
real(dp), dimension(:), pointer, contiguous ratedcys => null()
 rate of decay in solid phase
real(dp), dimension(:), pointer, contiguous decaylastw => null()
 aqueous phase decay rate used for last iteration (needed for zero order decay)
real(dp), dimension(:), pointer, contiguous decaylasts => null()
 solid phase decay rate used for last iteration (needed for zero order decay)
integer(i4b), dimension(:), pointer, contiguous ibound => null()
 pointer to model ibound
type(tspfmitype), pointer fmi => null()
 pointer to fmi object
type(gweinputdatatype), pointer gwecommon => null()
 pointer to shared gwe data used by multiple packages but set in est
real(dp), pointer eqnsclfac => null()
 governing equation scale factor; =rhow*cpw for energy
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 allocate_arrays (this, nodes)
 Allocate arrays for package.
procedure, private source_options (this)
 Update simulation mempath options.
procedure, private source_data (this)
 Source EST griddata from input mempath.
procedure, private log_options (this, found)
 Write user options to list file.

Detailed Description

Data and methods for handling changes in temperature

Definition at line 48 of file gwe-est.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure, private gweestmodule::gweesttype::allocate_arrays ( class(gweesttype) this,
integer(i4b), intent(in) nodes )
private

Method to allocate arrays for the package.

Parameters
thisGweEstType object
[in]nodesnumber of nodes

Definition at line 90 of file gwe-est.f90.

◆ allocate_scalars() [1/2]

procedure gweestmodule::gweesttype::allocate_scalars ( class(gweesttype) this)

Method to allocate scalar variables for the package.

Parameters
thisGweEstType object

Definition at line 89 of file gwe-est.f90.

◆ allocate_scalars() [2/2]

procedure numericalpackagemodule::numericalpackagetype::allocate_scalars ( class(numericalpackagetype) this)
inherited

Allocate and initialize base numerical package scalars.

Parameters
thisNumericalPackageType object

Definition at line 54 of file NumericalPackage.f90.

◆ da()

procedure numericalpackagemodule::numericalpackagetype::da ( class(numericalpackagetype) this)
inherited

Deallocate and initialize base numerical package scalars.

Parameters
thisNumericalPackageType object

Definition at line 55 of file NumericalPackage.f90.

◆ est_ar()

procedure gweestmodule::gweesttype::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.

Parameters
[in,out]thisGweEstType object
[in]dispointer to dis package
iboundpointer to GWE ibound array

Definition at line 77 of file gwe-est.f90.

◆ est_bd()

procedure gweestmodule::gweesttype::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.

Parameters
thisGweEstType object
[in]isuppress_outputflag to suppress output
[in,out]model_budgetmodel budget object

Definition at line 86 of file gwe-est.f90.

◆ est_cq()

procedure gweestmodule::gweesttype::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.

Parameters
thisGweEstType object
[in]nodesnumber of nodes
[in]cnewtemperature at end of this time step
[in]coldtemperature at end of last time step
[in,out]flowjaflow between two connected control volumes

Definition at line 82 of file gwe-est.f90.

◆ est_cq_dcy()

procedure gweestmodule::gweesttype::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.

Parameters
thisGweEstType object
[in]nodesnumber of nodes
[in]cnewtemperature at end of this time step
[in]coldtemperature at end of last time step
[in,out]flowjaflow between two connected control volumes

Definition at line 84 of file gwe-est.f90.

◆ est_cq_dcy_solid()

procedure gweestmodule::gweesttype::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.

Parameters
thisGweEstType object
[in]nodesnumber of nodes
[in]cnewtemperature at end of this time step
[in]coldtemperature at end of last time step
[in,out]flowjaflow between two connected control volumes

Definition at line 85 of file gwe-est.f90.

◆ est_cq_sto()

procedure gweestmodule::gweesttype::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.

Parameters
thisGweEstType object
[in]nodesnumber of nodes
[in]cnewtemperature at end of this time step
[in]coldtemperature at end of last time step
[in,out]flowjaflow between two connected control volumes

Definition at line 83 of file gwe-est.f90.

◆ est_da()

procedure gweestmodule::gweesttype::est_da ( class(gweesttype) this)

Method to deallocate memory for the package.

Parameters
thisGweEstType object

Definition at line 88 of file gwe-est.f90.

◆ est_fc()

procedure gweestmodule::gweesttype::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.

Parameters
thisGweEstType object
[in]nodesnumber of nodes
[in]coldtemperature at end of last time step
[in]njanumber of GWE connections
matrix_slnsolution matrix
[in]idxglomapping vector for model (local) to solution (global)
[in,out]rhsright-hand side vector for model
[in]cnewtemperature at end of this time step
[in]kitersolution outer iteration number

Definition at line 78 of file gwe-est.f90.

◆ est_fc_dcy_solid()

procedure gweestmodule::gweesttype::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.

Parameters
thisGwtMstType object
[in]nodesnumber of nodes
[in]coldtemperature at end of last time step
[in]njanumber of GWE connections
matrix_slnsolution coefficient matrix
[in]idxglomapping vector for model (local) to solution (global)
[in,out]rhsright-hand side vector for model
[in]cnewtemperature at end of this time step
[in]kitersolution outer iteration number

Definition at line 81 of file gwe-est.f90.

◆ est_fc_dcy_water()

procedure gweestmodule::gweesttype::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.

Parameters
thisGweEstType object
[in]nodesnumber of nodes
[in]coldtemperature at end of last time step
[in]cnewtemperature at end of this time step
[in]njanumber of GWE connections
matrix_slnsolution coefficient matrix
[in]idxglomapping vector for model (local) to solution (global)
[in,out]rhsright-hand side vector for model
[in]kitersolution outer iteration number

Definition at line 80 of file gwe-est.f90.

◆ est_fc_sto()

procedure gweestmodule::gweesttype::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.

Parameters
thisGweEstType object
[in]nodesnumber of nodes
[in]coldtemperature at end of last time step
[in]njanumber of GWE connections
matrix_slnsolution coefficient matrix
[in]idxglomapping vector for model (local) to solution (global)
[in,out]rhsright-hand side vector for model

Definition at line 79 of file gwe-est.f90.

◆ est_ot_flow()

procedure gweestmodule::gweesttype::est_ot_flow ( class(gweesttype) this,
integer(i4b), intent(in) icbcfl,
integer(i4b), intent(in) icbcun )

Method to output terms for the package.

Parameters
thisGweEstType object
[in]icbcflflag and unit number for cell-by-cell output
[in]icbcunflag indication if cell-by-cell data should be saved

Definition at line 87 of file gwe-est.f90.

◆ get_block_data()

procedure numericalpackagemodule::numericalpackagetype::get_block_data ( class(numericalpackagetype) this,
character(len=24), dimension(:), intent(in) tags,
logical, dimension(:), intent(inout) lfound,
character(len=24), dimension(:), intent(in), optional varinames )
inherited

Generic method to read data in the GRIDDATA block for a package.

Parameters
thisNumericalPackageType object
[in]tagsvector with variable tags
[in,out]lfoundboolean vector indicating of a variable tag was found
[in]varinamesoptional vector of variable names

Definition at line 57 of file NumericalPackage.f90.

◆ log_options()

procedure, private gweestmodule::gweesttype::log_options ( class(gweesttype) this,
type(gweestparamfoundtype), intent(in) found )
private

Definition at line 93 of file gwe-est.f90.

◆ read_check_ionper()

procedure numericalpackagemodule::numericalpackagetype::read_check_ionper ( class(numericalpackagetype), intent(inout) this)
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.

Parameters
[in,out]thisNumericalPackageType object

Definition at line 56 of file NumericalPackage.f90.

◆ set_names()

procedure numericalpackagemodule::numericalpackagetype::set_names ( class(numericalpackagetype), intent(inout) this,
integer(i4b), intent(in) ibcnum,
character(len=*), intent(in) name_model,
character(len=*), intent(in) pakname,
character(len=*), intent(in) ftype,
character(len=*), intent(in), optional input_mempath )
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.

Parameters
[in,out]thisNumericalPackageType object
[in]ibcnumunique package number
[in]name_modelname of the model
[in]paknamename of the package
[in]ftypepackage type

Definition at line 53 of file NumericalPackage.f90.

◆ source_data()

procedure, private gweestmodule::gweesttype::source_data ( class(gweesttype) this)
private

Definition at line 92 of file gwe-est.f90.

◆ source_options()

procedure, private gweestmodule::gweesttype::source_options ( class(gweesttype) this)
private

Definition at line 91 of file gwe-est.f90.

Member Data Documentation

◆ cps

real(dp), dimension(:), pointer, contiguous gweestmodule::gweesttype::cps => null()

Definition at line 54 of file gwe-est.f90.

◆ cpw

real(dp), pointer gweestmodule::gweesttype::cpw => null()

Definition at line 51 of file gwe-est.f90.

◆ decay_solid

real(dp), dimension(:), pointer, contiguous gweestmodule::gweesttype::decay_solid => null()

Definition at line 63 of file gwe-est.f90.

◆ decay_water

real(dp), dimension(:), pointer, contiguous gweestmodule::gweesttype::decay_water => null()

Definition at line 62 of file gwe-est.f90.

◆ decaylasts

real(dp), dimension(:), pointer, contiguous gweestmodule::gweesttype::decaylasts => null()

Definition at line 67 of file gwe-est.f90.

◆ decaylastw

real(dp), dimension(:), pointer, contiguous gweestmodule::gweesttype::decaylastw => null()

Definition at line 66 of file gwe-est.f90.

◆ dis

class(disbasetype), pointer numericalpackagemodule::numericalpackagetype::dis => null()
inherited

Definition at line 50 of file NumericalPackage.f90.

◆ eqnsclfac

real(dp), pointer gweestmodule::gweesttype::eqnsclfac => null()

Definition at line 73 of file gwe-est.f90.

◆ filtyp

character(len=lenftype) numericalpackagemodule::numericalpackagetype::filtyp = ''
inherited

Definition at line 33 of file NumericalPackage.f90.

◆ fmi

type(tspfmitype), pointer gweestmodule::gweesttype::fmi => null()

Definition at line 71 of file gwe-est.f90.

◆ gwecommon

type(gweinputdatatype), pointer gweestmodule::gweesttype::gwecommon => null()

Definition at line 72 of file gwe-est.f90.

◆ iasym

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iasym => null()
inherited

Definition at line 41 of file NumericalPackage.f90.

◆ ibound

integer(i4b), dimension(:), pointer, contiguous gweestmodule::gweesttype::ibound => null()

Definition at line 70 of file gwe-est.f90.

◆ id

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::id => null()
inherited

Definition at line 37 of file NumericalPackage.f90.

◆ idcy

integer(i4b), pointer gweestmodule::gweesttype::idcy => null()

Definition at line 60 of file gwe-est.f90.

◆ idcysrc

integer(i4b), pointer gweestmodule::gweesttype::idcysrc => null()

Definition at line 61 of file gwe-est.f90.

◆ inewton

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::inewton => null()
inherited

Definition at line 40 of file NumericalPackage.f90.

◆ input_fname

character(len=linelength), pointer numericalpackagemodule::numericalpackagetype::input_fname => null()
inherited

Definition at line 32 of file NumericalPackage.f90.

◆ input_mempath

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::input_mempath = ''
inherited

Definition at line 31 of file NumericalPackage.f90.

◆ inunit

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::inunit => null()
inherited

Definition at line 38 of file NumericalPackage.f90.

◆ ionper

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::ionper => null()
inherited

Definition at line 45 of file NumericalPackage.f90.

◆ iout

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iout => null()
inherited

Definition at line 39 of file NumericalPackage.f90.

◆ ipakcb

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::ipakcb => null()
inherited

Definition at line 44 of file NumericalPackage.f90.

◆ iprflow

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iprflow => null()
inherited

Definition at line 43 of file NumericalPackage.f90.

◆ iprpak

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iprpak => null()
inherited

Definition at line 42 of file NumericalPackage.f90.

◆ lastonper

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::lastonper => null()
inherited

Definition at line 46 of file NumericalPackage.f90.

◆ latheatvap

real(dp), pointer gweestmodule::gweesttype::latheatvap => null()

Definition at line 53 of file gwe-est.f90.

◆ memorypath

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::memorypath = ''
inherited

Definition at line 28 of file NumericalPackage.f90.

◆ memorypathmodel

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::memorypathmodel = ''
inherited

Definition at line 29 of file NumericalPackage.f90.

◆ name_model

character(len=lenmodelname) numericalpackagemodule::numericalpackagetype::name_model = ''
inherited

Definition at line 26 of file NumericalPackage.f90.

◆ package_type

character(len=lenftype), pointer numericalpackagemodule::numericalpackagetype::package_type => null()
inherited

Definition at line 34 of file NumericalPackage.f90.

◆ packname

character(len=lenpackagename) numericalpackagemodule::numericalpackagetype::packname = ''
inherited

Definition at line 27 of file NumericalPackage.f90.

◆ parser

type(blockparsertype) numericalpackagemodule::numericalpackagetype::parser
inherited

Definition at line 49 of file NumericalPackage.f90.

49 type(BlockParserType) :: parser !< parser object for reading blocks of information

◆ porosity

real(dp), dimension(:), pointer, contiguous gweestmodule::gweesttype::porosity => null()

Definition at line 56 of file gwe-est.f90.

◆ ratedcys

real(dp), dimension(:), pointer, contiguous gweestmodule::gweesttype::ratedcys => null()

Definition at line 65 of file gwe-est.f90.

◆ ratedcyw

real(dp), dimension(:), pointer, contiguous gweestmodule::gweesttype::ratedcyw => null()

Definition at line 64 of file gwe-est.f90.

◆ ratesto

real(dp), dimension(:), pointer, contiguous gweestmodule::gweesttype::ratesto => null()

Definition at line 57 of file gwe-est.f90.

◆ rhos

real(dp), dimension(:), pointer, contiguous gweestmodule::gweesttype::rhos => null()

Definition at line 55 of file gwe-est.f90.

◆ rhow

real(dp), pointer gweestmodule::gweesttype::rhow => null()

Definition at line 52 of file gwe-est.f90.


The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Model/GroundWaterEnergy/gwe-est.f90