MODFLOW 6  version 6.7.0.dev0
USGS Modular Hydrologic Model
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
gwfstomodule::gwfstotype Type Reference
Inheritance diagram for gwfstomodule::gwfstotype:
Inheritance graph
Collaboration diagram for gwfstomodule::gwfstotype:
Collaboration graph

Public Member Functions

procedure sto_ar
 
procedure sto_rp
 
procedure sto_ad
 
procedure sto_fc
 
procedure sto_fn
 
procedure sto_cq
 
procedure sto_bd
 
procedure sto_save_model_flows
 
procedure sto_da
 
procedure allocate_scalars
 

Public Attributes

integer(i4b), pointer istor_coef => null()
 indicates if ss is the storage coefficient More...
 
integer(i4b), pointer iconf_ss => null()
 indicates if ss is 0 below the top of a layer More...
 
integer(i4b), pointer iorig_ss => null()
 indicates if the original storage specific storage formulation should be used More...
 
integer(i4b), pointer iss => null()
 steady state flag: 1 = steady, 0 = transient More...
 
integer(i4b), pointer iusesy => null()
 flag set if any cell is convertible (0, 1) More...
 
integer(i4b), dimension(:), pointer, contiguous iconvert => null()
 confined (0) or convertible (1) More...
 
real(dp), dimension(:), pointer, contiguous ss => null()
 specific storage or storage coefficient More...
 
real(dp), dimension(:), pointer, contiguous sy => null()
 specific yield More...
 
real(dp), dimension(:), pointer, contiguous strgss => null()
 vector of specific storage rates More...
 
real(dp), dimension(:), pointer, contiguous strgsy => null()
 vector of specific yield rates More...
 
integer(i4b), dimension(:), pointer, contiguous ibound => null()
 pointer to model ibound More...
 
real(dp), pointer satomega => null()
 newton-raphson saturation omega More...
 
integer(i4b), pointer integratechanges => null()
 indicates if mid-simulation ss and sy changes should be integrated via an additional matrix formulation term More...
 
integer(i4b), pointer intvs => null()
 TVS (time-varying storage) unit number (0 if unused) More...
 
type(tvstype), pointer tvs => null()
 TVS object. More...
 
integer(i4b), pointer iper => null()
 input context loaded period More...
 
character(len=:), pointer storage
 input context storage string More...
 

Private Member Functions

procedure, private allocate_arrays
 
procedure, private source_options
 
procedure, private source_data
 
procedure, private log_options
 
procedure, private save_old_ss_sy
 
procedure set_names
 
procedure da
 
procedure read_check_ionper
 
procedure get_block_data
 

Private Attributes

real(dp), dimension(:), pointer, private, contiguous oldss => null()
 previous time step specific storage More...
 
real(dp), dimension(:), pointer, private, contiguous oldsy => null()
 previous time step specific yield More...
 
character(len=lenmodelname) name_model = ''
 the name of the model that contains this package More...
 
character(len=lenpackagename) packname = ''
 name of the package More...
 
character(len=lenmempath) memorypath = ''
 the location in the memory manager where the variables are stored More...
 
character(len=lenmempath) memorypathmodel = ''
 the location in the memory manager where the variables of the parent model are stored More...
 
character(len=lenmempath) input_mempath = ''
 input context mempath More...
 
character(len=linelength), pointer input_fname => null()
 input file name More...
 
character(len=lenftype) filtyp = ''
 file type (CHD, DRN, RIV, etc.) More...
 
character(len=lenftype), pointer package_type => null()
 package type (same as filtyp) stored in memory manager More...
 
integer(i4b), pointer id => null()
 consecutive package number in model More...
 
integer(i4b), pointer inunit => null()
 unit number for input file More...
 
integer(i4b), pointer iout => null()
 unit number for writing package output More...
 
integer(i4b), pointer inewton => null()
 newton flag More...
 
integer(i4b), pointer iasym => null()
 package causes matrix asymmetry More...
 
integer(i4b), pointer iprpak => null()
 integer flag to echo input More...
 
integer(i4b), pointer iprflow => null()
 flag to print simulated flows More...
 
integer(i4b), pointer ipakcb => null()
 output flows (-1, 0, 1) - save_flows More...
 
integer(i4b), pointer ionper => null()
 stress period for next data More...
 
integer(i4b), pointer lastonper => null()
 last value of ionper (for checking) More...
 
type(blockparsertype) parser
 parser object for reading blocks of information More...
 
class(disbasetype), pointer dis => null()
 model discretization object More...
 

Detailed Description

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

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure, private gwfstomodule::gwfstotype::allocate_arrays
private

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

◆ allocate_scalars()

procedure gwfstomodule::gwfstotype::allocate_scalars

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

◆ da()

procedure numericalpackagemodule::numericalpackagetype::da
privateinherited

Definition at line 55 of file NumericalPackage.f90.

◆ get_block_data()

procedure numericalpackagemodule::numericalpackagetype::get_block_data
privateinherited

Definition at line 57 of file NumericalPackage.f90.

◆ log_options()

procedure, private gwfstomodule::gwfstotype::log_options
private

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

◆ read_check_ionper()

procedure numericalpackagemodule::numericalpackagetype::read_check_ionper
privateinherited

Definition at line 56 of file NumericalPackage.f90.

◆ save_old_ss_sy()

procedure, private gwfstomodule::gwfstotype::save_old_ss_sy
private

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

◆ set_names()

procedure numericalpackagemodule::numericalpackagetype::set_names
privateinherited

Definition at line 53 of file NumericalPackage.f90.

◆ source_data()

procedure, private gwfstomodule::gwfstotype::source_data
private

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

◆ source_options()

procedure, private gwfstomodule::gwfstotype::source_options
private

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

◆ sto_ad()

procedure gwfstomodule::gwfstotype::sto_ad

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

◆ sto_ar()

procedure gwfstomodule::gwfstotype::sto_ar

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

◆ sto_bd()

procedure gwfstomodule::gwfstotype::sto_bd

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

◆ sto_cq()

procedure gwfstomodule::gwfstotype::sto_cq

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

◆ sto_da()

procedure gwfstomodule::gwfstotype::sto_da

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

◆ sto_fc()

procedure gwfstomodule::gwfstotype::sto_fc

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

◆ sto_fn()

procedure gwfstomodule::gwfstotype::sto_fn

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

◆ sto_rp()

procedure gwfstomodule::gwfstotype::sto_rp

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

◆ sto_save_model_flows()

procedure gwfstomodule::gwfstotype::sto_save_model_flows

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

Member Data Documentation

◆ dis

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

Definition at line 50 of file NumericalPackage.f90.

50  class(DisBaseType), pointer :: dis => null() !< model discretization object

◆ filtyp

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

Definition at line 33 of file NumericalPackage.f90.

33  character(len=LENFTYPE) :: filtyp = '' !< file type (CHD, DRN, RIV, etc.)

◆ iasym

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

Definition at line 41 of file NumericalPackage.f90.

41  integer(I4B), pointer :: iasym => null() !< package causes matrix asymmetry

◆ ibound

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

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

42  integer(I4B), dimension(:), pointer, contiguous :: ibound => null() !< pointer to model ibound

◆ iconf_ss

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

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

33  integer(I4B), pointer :: iconf_ss => null() !< indicates if ss is 0 below the top of a layer

◆ iconvert

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

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

37  integer(I4B), dimension(:), pointer, contiguous :: iconvert => null() !< confined (0) or convertible (1)

◆ id

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

Definition at line 37 of file NumericalPackage.f90.

37  integer(I4B), pointer :: id => null() !< consecutive package number in model

◆ inewton

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

Definition at line 40 of file NumericalPackage.f90.

40  integer(I4B), pointer :: inewton => null() !< newton flag

◆ input_fname

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

Definition at line 32 of file NumericalPackage.f90.

32  character(len=LINELENGTH), pointer :: input_fname => null() !< input file name

◆ input_mempath

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

Definition at line 31 of file NumericalPackage.f90.

31  character(len=LENMEMPATH) :: input_mempath = '' !< input context mempath

◆ integratechanges

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

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

44  integer(I4B), pointer :: integratechanges => null() !< indicates if mid-simulation ss and sy changes should be integrated via an additional matrix formulation term

◆ intvs

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

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

45  integer(I4B), pointer :: intvs => null() !< TVS (time-varying storage) unit number (0 if unused)

◆ inunit

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

Definition at line 38 of file NumericalPackage.f90.

38  integer(I4B), pointer :: inunit => null() !< unit number for input file

◆ ionper

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

Definition at line 45 of file NumericalPackage.f90.

45  integer(I4B), pointer :: ionper => null() !< stress period for next data

◆ iorig_ss

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

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

34  integer(I4B), pointer :: iorig_ss => null() !< indicates if the original storage specific storage formulation should be used

◆ iout

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

Definition at line 39 of file NumericalPackage.f90.

39  integer(I4B), pointer :: iout => null() !< unit number for writing package output

◆ ipakcb

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

Definition at line 44 of file NumericalPackage.f90.

44  integer(I4B), pointer :: ipakcb => null() !< output flows (-1, 0, 1) - save_flows

◆ iper

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

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

49  integer(I4B), pointer :: iper => null() !< input context loaded period

◆ iprflow

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

Definition at line 43 of file NumericalPackage.f90.

43  integer(I4B), pointer :: iprflow => null() !< flag to print simulated flows

◆ iprpak

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

Definition at line 42 of file NumericalPackage.f90.

42  integer(I4B), pointer :: iprpak => null() !< integer flag to echo input

◆ iss

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

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

35  integer(I4B), pointer :: iss => null() !< steady state flag: 1 = steady, 0 = transient

◆ istor_coef

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

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

32  integer(I4B), pointer :: istor_coef => null() !< indicates if ss is the storage coefficient

◆ iusesy

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

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

36  integer(I4B), pointer :: iusesy => null() !< flag set if any cell is convertible (0, 1)

◆ lastonper

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

Definition at line 46 of file NumericalPackage.f90.

46  integer(I4B), pointer :: lastonper => null() !< last value of ionper (for checking)

◆ memorypath

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

Definition at line 28 of file NumericalPackage.f90.

28  character(len=LENMEMPATH) :: memoryPath = '' !< the location in the memory manager where the variables are stored

◆ memorypathmodel

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

Definition at line 29 of file NumericalPackage.f90.

29  character(len=LENMEMPATH) :: memoryPathModel = '' !< the location in the memory manager where the variables

◆ name_model

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

Definition at line 26 of file NumericalPackage.f90.

26  character(len=LENMODELNAME) :: name_model = '' !< the name of the model that contains this package

◆ oldss

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

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

47  real(DP), dimension(:), pointer, contiguous, private :: oldss => null() !< previous time step specific storage

◆ oldsy

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

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

48  real(DP), dimension(:), pointer, contiguous, private :: oldsy => null() !< previous time step specific yield

◆ package_type

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

Definition at line 34 of file NumericalPackage.f90.

34  character(len=LENFTYPE), pointer :: package_type => null() !< package type (same as filtyp) stored in memory manager

◆ packname

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

Definition at line 27 of file NumericalPackage.f90.

27  character(len=LENPACKAGENAME) :: packName = '' !< name of the package

◆ parser

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

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 43 of file gwf-sto.f90.

43  real(DP), pointer :: satomega => null() !< newton-raphson saturation omega

◆ ss

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

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

38  real(DP), dimension(:), pointer, contiguous :: ss => null() !< specific storage or storage coefficient

◆ storage

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

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

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

◆ strgss

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

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

40  real(DP), dimension(:), pointer, contiguous :: strgss => null() !< vector of specific storage rates

◆ strgsy

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

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

41  real(DP), dimension(:), pointer, contiguous :: strgsy => null() !< vector of specific yield rates

◆ sy

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

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

39  real(DP), dimension(:), pointer, contiguous :: sy => null() !< specific yield

◆ tvs

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

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

46  type(TvsType), pointer :: tvs => null() !< TVS object
The documentation for this type was generated from the following file: