MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
Inheritance diagram for gwfstomodule::gwfstotype:
Inheritance graph
Collaboration diagram for gwfstomodule::gwfstotype:
Collaboration graph

Public Member Functions

procedure sto_ar (this, dis, ibound)
 Allocate and read method for package.
procedure sto_rp (this)
 Read and prepare method for package.
procedure sto_ad (this)
 Advance the package.
procedure sto_fc (this, kiter, hold, hnew, matrix_sln, idxglo, rhs)
 Fill A and right-hand side for the package.
procedure sto_fn (this, kiter, hold, hnew, matrix_sln, idxglo, rhs)
 Fill Newton-Raphson terms in A and right-hand side for the package.
procedure sto_cq (this, flowja, hnew, hold)
 Calculate flows for package.
procedure sto_bd (this, isuppress_output, model_budget)
 Model budget calculation for package.
procedure sto_save_model_flows (this, icbcfl, icbcun)
 Save model flows for package.
procedure sto_da (this)
 Deallocate package memory.
procedure allocate_scalars (this)
 Allocate scalars.
procedure add_sto_formulation (this, sto_form, form_id)
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 istor_coef => null()
 indicates if ss is the storage coefficient
integer(i4b), pointer iconf_ss => null()
 indicates if ss is 0 below the top of a layer
integer(i4b), pointer iorig_ss => null()
 indicates if the original storage specific storage formulation should be used
integer(i4b), pointer iss => null()
 steady state flag: 1 = steady, 0 = transient
integer(i4b), pointer iusesy => null()
 flag set if any cell is convertible (0, 1)
integer(i4b), dimension(:), pointer, contiguous iconvert => null()
 confined (0) or convertible (1)
real(dp), dimension(:), pointer, contiguous ss => null()
 specific storage or storage coefficient
real(dp), dimension(:), pointer, contiguous sy => null()
 specific yield
real(dp), dimension(:), pointer, contiguous strgss => null()
 vector of specific storage rates
real(dp), dimension(:), pointer, contiguous strgsy => null()
 vector of specific yield rates
integer(i4b), dimension(:), pointer, contiguous ibound => null()
 pointer to model ibound
real(dp), pointer satomega => null()
 newton-raphson saturation omega
integer(i4b), pointer integratechanges => null()
 indicates if mid-simulation ss and sy changes should be integrated via an additional matrix formulation term
integer(i4b), pointer intvs => null()
 TVS (time-varying storage) unit number (0 if unused).
type(tvstype), pointer tvs => null()
 TVS object.
integer(i4b), pointer iper => null()
 input context loaded period
character(len=:), pointer storage
 input context storage string
integer(i4b), dimension(:), pointer, contiguous iformulation => null()
 active formulation for the connection (size: n) with values 0 (= default) up to SIZE_STORAGE_FORM - 1
class(gwfstoformulationtype), pointer default_form => null()
 default storage formulation
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 package arrays.
procedure, private source_options (this)
 Source input options for package.
procedure, private source_data (this)
 Source input data for package.
procedure, private log_options (this, found)
 Log found options for package.
procedure, private save_old_ss_sy (this)
 Save old storage property values.
procedure, private fc_default_sto (this, n, matrix_sln, rhs, idxglo, hold, hnew)
 Default storage FC.
procedure, private fn_default_sto (this, n, matrix_sln, rhs, idxglo, hold, hnew)
procedure, private cq_default_sto (this, n, flowja, hnew, hold)
 Standard flow calculation for the storage.

Private Attributes

real(dp), dimension(:), pointer, private, contiguous oldss => null()
 previous time step specific storage
real(dp), dimension(:), pointer, private, contiguous oldsy => null()
 previous time step specific yield
type(gwfstoformcontainertype), dimension(max_ext_sto_forms), private sto_formulations
 alternative storage calculations by extension

Detailed Description

Definition at line 34 of file gwf-sto.f90.

Member Function/Subroutine Documentation

◆ add_sto_formulation()

procedure gwfstomodule::gwfstotype::add_sto_formulation ( class(gwfstotype), intent(inout) this,
class(gwfstoformulationtype), pointer sto_form,
integer(i4b) form_id )
Parameters
[in,out]thisthis NPF instance
sto_formthe alternative storage calculator
form_idthe id for the flow formulation

Definition at line 71 of file gwf-sto.f90.

◆ allocate_arrays()

procedure, private gwfstomodule::gwfstotype::allocate_arrays ( class(gwfstotype), target this,
integer(i4b), intent(in) nodes )
private

Allocate and initialize STO package arrays.

Parameters
thisGwfStoType object
[in]nodesactive model nodes

Definition at line 73 of file gwf-sto.f90.

◆ allocate_scalars() [1/2]

procedure gwfstomodule::gwfstotype::allocate_scalars ( class(gwfstotype) this)

Allocate and initialize scalars for the STO package. The base numerical package allocate scalars method is also called.

Parameters
thisGwfStoType object

Definition at line 70 of file gwf-sto.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.

◆ cq_default_sto()

procedure, private gwfstomodule::gwfstotype::cq_default_sto ( class(gwfstotype), intent(inout) this,
integer(i4b), intent(in) n,
real(dp), dimension(:), intent(inout) flowja,
real(dp), dimension(:), intent(in) hnew,
real(dp), dimension(:), intent(in) hold )
private

Definition at line 80 of file gwf-sto.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.

◆ fc_default_sto()

procedure, private gwfstomodule::gwfstotype::fc_default_sto ( class(gwfstotype) this,
integer(i4b), intent(in) n,
class(matrixbasetype), intent(inout), pointer matrix_sln,
real(dp), dimension(:), intent(inout) rhs,
integer(i4b), dimension(:), intent(in) idxglo,
real(dp), dimension(:), intent(in) hold,
real(dp), dimension(:), intent(in) hnew )
private
Parameters
thisGwfStoType object

Definition at line 78 of file gwf-sto.f90.

◆ fn_default_sto()

procedure, private gwfstomodule::gwfstotype::fn_default_sto ( class(gwfstotype), intent(inout) this,
integer(i4b), intent(in) n,
class(matrixbasetype), intent(inout), pointer matrix_sln,
real(dp), dimension(:), intent(inout) rhs,
integer(i4b), dimension(:), intent(in) idxglo,
real(dp), dimension(:), intent(in) hold,
real(dp), dimension(:), intent(in) hnew )
private

Definition at line 79 of file gwf-sto.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 gwfstomodule::gwfstotype::log_options ( class(gwfstotype) this,
type(gwfstoparamfoundtype), intent(in) found )
private

Log options block for STO package.

Parameters
thisGwfStoType object

Definition at line 76 of file gwf-sto.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.

◆ save_old_ss_sy()

procedure, private gwfstomodule::gwfstotype::save_old_ss_sy ( class(gwfstotype) this)
private

Save ss and sy values from the previous time step for use with storage integration when integratechanges is non-zero.

Parameters
thisGwfStoType object

Definition at line 77 of file gwf-sto.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 gwfstomodule::gwfstotype::source_data ( class(gwfstotype) this)
private

Source griddata block parameters for STO package.

Parameters
thisGwfStoType object

Definition at line 75 of file gwf-sto.f90.

◆ source_options()

procedure, private gwfstomodule::gwfstotype::source_options ( class(gwfstotype) this)
private

Source options block parameters for STO package.

Parameters
thisGwfStoType object

Definition at line 74 of file gwf-sto.f90.

◆ sto_ad()

procedure gwfstomodule::gwfstotype::sto_ad ( class(gwfstotype) this)

Advance data in the STO package.

Parameters
thisGwfStoType object

Definition at line 63 of file gwf-sto.f90.

◆ sto_ar()

procedure gwfstomodule::gwfstotype::sto_ar ( class(gwfstotype) this,
class(disbasetype), intent(in), pointer dis,
integer(i4b), dimension(:), pointer, contiguous ibound )

Method to allocate and read static data for the STO package.

Parameters
thisGwfStoType object
[in]dismodel discretization object
iboundmodel ibound array

Definition at line 61 of file gwf-sto.f90.

◆ sto_bd()

procedure gwfstomodule::gwfstotype::sto_bd ( class(gwfstotype) this,
integer(i4b), intent(in) isuppress_output,
type(budgettype), intent(inout) model_budget )

Budget calculation for the STO package components. Components include specific storage and specific yield storage.

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

Definition at line 67 of file gwf-sto.f90.

◆ sto_cq()

procedure gwfstomodule::gwfstotype::sto_cq ( class(gwfstotype) this,
real(dp), dimension(:), intent(inout), contiguous flowja,
real(dp), dimension(:), intent(in), contiguous hnew,
real(dp), dimension(:), intent(in), contiguous hold )

Flow calculation for the STO package components. Components include specific storage and specific yield storage.

Parameters
thisGwfStoType object
[in,out]flowjaconnection flows
[in]hnewcurrent head
[in]holdprevious head

Definition at line 66 of file gwf-sto.f90.

◆ sto_da()

procedure gwfstomodule::gwfstotype::sto_da ( class(gwfstotype) this)

Deallocate STO package scalars and arrays.

Parameters
thisGwfStoType object

Definition at line 69 of file gwf-sto.f90.

◆ sto_fc()

procedure gwfstomodule::gwfstotype::sto_fc ( class(gwfstotype) this,
integer(i4b), intent(in) kiter,
real(dp), dimension(:), intent(in) hold,
real(dp), dimension(:), intent(in) hnew,
class(matrixbasetype), pointer matrix_sln,
integer(i4b), dimension(:), intent(in) idxglo,
real(dp), dimension(:), intent(inout) rhs )

Fill the coefficient matrix and right-hand side with the STO package terms.

Parameters
thisGwfStoType object
[in]kiterouter iteration number
[in]holdprevious heads
[in]hnewcurrent heads
matrix_slnA matrix
[in]idxgloglobal index model to solution
[in,out]rhsright-hand side

Definition at line 64 of file gwf-sto.f90.

◆ sto_fn()

procedure gwfstomodule::gwfstotype::sto_fn ( class(gwfstotype) this,
integer(i4b), intent(in) kiter,
real(dp), dimension(:), intent(in) hold,
real(dp), dimension(:), intent(in) hnew,
class(matrixbasetype), pointer matrix_sln,
integer(i4b), dimension(:), intent(in) idxglo,
real(dp), dimension(:), intent(inout) rhs )

Fill the coefficient matrix and right-hand side with STO package with Newton-Raphson terms.

Parameters
thisGwfStoType object
[in]kiterouter iteration number
[in]holdprevious heads
[in]hnewcurrent heads
matrix_slnA matrix
[in]idxgloglobal index model to solution
[in,out]rhsright-hand side

Definition at line 65 of file gwf-sto.f90.

◆ sto_rp()

procedure gwfstomodule::gwfstotype::sto_rp ( class(gwfstotype) this)

Method to read and prepare stress period data for the STO package.

Parameters
thisGwfStoType object

Definition at line 62 of file gwf-sto.f90.

◆ sto_save_model_flows()

procedure gwfstomodule::gwfstotype::sto_save_model_flows ( class(gwfstotype) this,
integer(i4b), intent(in) icbcfl,
integer(i4b), intent(in) icbcun )

Save cell-by-cell budget terms for the STO package.

Parameters
thisGwfStoType object
[in]icbcflflag to output budget data
[in]icbcuncell-by-cell file unit number

Definition at line 68 of file gwf-sto.f90.

Member Data Documentation

◆ default_form

class(gwfstoformulationtype), pointer gwfstomodule::gwfstotype::default_form => null()

Definition at line 59 of file gwf-sto.f90.

◆ dis

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

Definition at line 50 of file NumericalPackage.f90.

◆ filtyp

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

Definition at line 33 of file NumericalPackage.f90.

◆ iasym

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

Definition at line 41 of file NumericalPackage.f90.

◆ ibound

integer(i4b), dimension(:), pointer, contiguous gwfstomodule::gwfstotype::ibound => null()

Definition at line 45 of file gwf-sto.f90.

◆ iconf_ss

integer(i4b), pointer gwfstomodule::gwfstotype::iconf_ss => null()

Definition at line 36 of file gwf-sto.f90.

◆ iconvert

integer(i4b), dimension(:), pointer, contiguous gwfstomodule::gwfstotype::iconvert => null()

Definition at line 40 of file gwf-sto.f90.

◆ id

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

Definition at line 37 of file NumericalPackage.f90.

◆ iformulation

integer(i4b), dimension(:), pointer, contiguous gwfstomodule::gwfstotype::iformulation => null()

Definition at line 55 of file gwf-sto.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.

◆ integratechanges

integer(i4b), pointer gwfstomodule::gwfstotype::integratechanges => null()

Definition at line 47 of file gwf-sto.f90.

◆ intvs

integer(i4b), pointer gwfstomodule::gwfstotype::intvs => null()

Definition at line 48 of file gwf-sto.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.

◆ iorig_ss

integer(i4b), pointer gwfstomodule::gwfstotype::iorig_ss => null()

Definition at line 37 of file gwf-sto.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.

◆ iper

integer(i4b), pointer gwfstomodule::gwfstotype::iper => null()

Definition at line 52 of file gwf-sto.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.

◆ iss

integer(i4b), pointer gwfstomodule::gwfstotype::iss => null()

Definition at line 38 of file gwf-sto.f90.

◆ istor_coef

integer(i4b), pointer gwfstomodule::gwfstotype::istor_coef => null()

Definition at line 35 of file gwf-sto.f90.

◆ iusesy

integer(i4b), pointer gwfstomodule::gwfstotype::iusesy => null()

Definition at line 39 of file gwf-sto.f90.

◆ lastonper

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

Definition at line 46 of file NumericalPackage.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.

◆ oldss

real(dp), dimension(:), pointer, private, contiguous gwfstomodule::gwfstotype::oldss => null()
private

Definition at line 50 of file gwf-sto.f90.

◆ oldsy

real(dp), dimension(:), pointer, private, contiguous gwfstomodule::gwfstotype::oldsy => null()
private

Definition at line 51 of file gwf-sto.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

◆ satomega

real(dp), pointer gwfstomodule::gwfstotype::satomega => null()

Definition at line 46 of file gwf-sto.f90.

◆ ss

real(dp), dimension(:), pointer, contiguous gwfstomodule::gwfstotype::ss => null()

Definition at line 41 of file gwf-sto.f90.

◆ sto_formulations

type(gwfstoformcontainertype), dimension(max_ext_sto_forms), private gwfstomodule::gwfstotype::sto_formulations
private

Definition at line 57 of file gwf-sto.f90.

57 type(GwfStoFormContainerType), dimension(MAX_EXT_STO_FORMS), private :: &
58 sto_formulations !< alternative storage calculations by extension

◆ storage

character(len=:), pointer gwfstomodule::gwfstotype::storage

Definition at line 53 of file gwf-sto.f90.

53 character(len=:), pointer :: storage !< input context storage string

◆ strgss

real(dp), dimension(:), pointer, contiguous gwfstomodule::gwfstotype::strgss => null()

Definition at line 43 of file gwf-sto.f90.

◆ strgsy

real(dp), dimension(:), pointer, contiguous gwfstomodule::gwfstotype::strgsy => null()

Definition at line 44 of file gwf-sto.f90.

◆ sy

real(dp), dimension(:), pointer, contiguous gwfstomodule::gwfstotype::sy => null()

Definition at line 42 of file gwf-sto.f90.

◆ tvs

type(tvstype), pointer gwfstomodule::gwfstotype::tvs => null()

Definition at line 49 of file gwf-sto.f90.


The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Model/GroundWaterFlow/gwf-sto.f90