flopy.mf6.modflow.mfgwfcsub module

class ModflowGwfcsub(model, loading_package=False, boundnames=None, print_input=None, save_flows=None, gammaw=9806.65, beta=4.6512e-10, head_based=None, initial_preconsolidation_head=None, ndelaycells=None, compression_indices=None, update_material_properties=None, cell_fraction=None, specified_initial_interbed_state=None, specified_initial_preconsolidation_stress=None, specified_initial_delay_head=None, effective_stress_lag=None, strainib_filerecord=None, straincg_filerecord=None, compaction_filerecord=None, compaction_elastic_filerecord=None, compaction_inelastic_filerecord=None, compaction_interbed_filerecord=None, compaction_coarse_filerecord=None, zdisplacement_filerecord=None, package_convergence_filerecord=None, timeseries=None, observations=None, ninterbeds=None, maxsig0=None, cg_ske_cr=1e-05, cg_theta=0.2, sgm=None, sgs=None, packagedata=None, stress_period_data=None, filename=None, pname=None, **kwargs)[source]

Bases: MFPackage

ModflowGwfcsub defines a CSUB package.

Parameters:

  • boundnames (keyword) – keyword to indicate that boundary names may be provided with the list of csub cells.

  • print_input (keyword) – keyword to indicate that the list of csub information will be written to the listing file immediately after it is read.

  • save_flows (keyword) – keyword to indicate that cell-by-cell flow terms will be written to the file specified with ‘budget save file’ in output control.

  • gammaw (double precision) – unit weight of water. for freshwater, gammaw is 9806.65 newtons/cubic meters or 62.48 lb/cubic foot in si and english units, respectively. by default, gammaw is 9806.65 newtons/cubic meters.

  • beta (double precision) – compressibility of water. typical values of beta are 4.6512e-10 1/pa or 2.2270e-8 lb/square foot in si and english units, respectively. by default, beta is 4.6512e-10 1/pa.

  • head_based (keyword) – keyword to indicate the head-based formulation will be used to simulate coarse- grained aquifer materials and no-delay and delay interbeds. specifying head_based also specifies the initial_preconsolidation_head option.

  • initial_preconsolidation_head (keyword) – keyword to indicate that preconsolidation heads will be specified for no-delay and delay interbeds in the packagedata block. if the specified_initial_interbed_state option is specified in the options block, user-specified preconsolidation heads in the packagedata block are absolute values. otherwise, user-specified preconsolidation heads in the packagedata block are relative to steady-state or initial heads.

  • ndelaycells (integer) – number of nodes used to discretize delay interbeds. if not specified, then a default value of 19 is assigned.

  • compression_indices (keyword) – keyword to indicate that the recompression (cr) and compression (cc) indices are specified instead of the elastic specific storage (sse) and inelastic specific storage (ssv) coefficients. if not specified, then elastic specific storage (sse) and inelastic specific storage (ssv) coefficients must be specified.

  • update_material_properties (keyword) – keyword to indicate that the thickness and void ratio of coarse-grained and interbed sediments (delay and no-delay) will vary during the simulation. if not specified, the thickness and void ratio of coarse-grained and interbed sediments will not vary during the simulation.

  • cell_fraction (keyword) – keyword to indicate that the thickness of interbeds will be specified in terms of the fraction of cell thickness. if not specified, interbed thicknness must be specified.

  • specified_initial_interbed_state (keyword) – keyword to indicate that absolute preconsolidation stresses (heads) and delay bed heads will be specified for interbeds defined in the packagedata block. the specified_initial_interbed_state option is equivalent to specifying the specified_initial_preconsolitation_stress and specified_initial_delay_head. if specified_initial_interbed_state is not specified then preconsolidation stress (head) and delay bed head values specified in the packagedata block are relative to simulated values of the first stress period if steady-state or initial stresses and gwf heads if the first stress period is transient.

  • specified_initial_preconsolidation_stress (keyword) – keyword to indicate that absolute preconsolidation stresses (heads) will be specified for interbeds defined in the packagedata block. if specified_initial_preconsolitation_stress and specified_initial_interbed_state are not specified then preconsolidation stress (head) values specified in the packagedata block are relative to simulated values if the first stress period is steady-state or initial stresses (heads) if the first stress period is transient.

  • specified_initial_delay_head (keyword) – keyword to indicate that absolute initial delay bed head will be specified for interbeds defined in the packagedata block. if specified_initial_delay_head and specified_initial_interbed_state are not specified then delay bed head values specified in the packagedata block are relative to simulated values if the first stress period is steady-state or initial gwf heads if the first stress period is transient.

  • effective_stress_lag (keyword) – keyword to indicate the effective stress from the previous time step will be used to calculate specific storage values. this option can 1) help with convergence in models with thin cells and water table elevations close to land surface; 2) is identical to the approach used in the subwt package for modflow-2005; and 3) is only used if the effective-stress formulation is being used. by default, current effective stress values are used to calculate specific storage values.

  • strainib_filerecord ((interbedstrain_filename)) –

    • interbedstrain_filenamestring

      name of the comma-separated-values output file to write final interbed strain information.

  • straincg_filerecord ((coarsestrain_filename)) –

    • coarsestrain_filenamestring

      name of the comma-separated-values output file to write final coarse-grained material strain information.

  • compaction_filerecord ((compaction_filename)) –

    • compaction_filenamestring

      name of the binary output file to write compaction information.

  • compaction_elastic_filerecord ((elastic_compaction_filename)) –

    • elastic_compaction_filenamestring

      name of the binary output file to write elastic interbed compaction information.

  • compaction_inelastic_filerecord ((inelastic_compaction_filename)) –

    • inelastic_compaction_filenamestring

      name of the binary output file to write inelastic interbed compaction information.

  • compaction_interbed_filerecord ((interbed_compaction_filename)) –

    • interbed_compaction_filenamestring

      name of the binary output file to write interbed compaction information.

  • compaction_coarse_filerecord ((coarse_compaction_filename)) –

    • coarse_compaction_filenamestring

      name of the binary output file to write elastic coarse-grained material compaction information.

  • zdisplacement_filerecord ((zdisplacement_filename)) –

    • zdisplacement_filenamestring

      name of the binary output file to write z-displacement information.

  • package_convergence_filerecord ((package_convergence_filename)) –

    • package_convergence_filenamestring

      name of the comma spaced values output file to write package convergence information.

  • timeseries (record ts6 filein ts6_filename) – Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information.

  • observations (record obs6 filein obs6_filename) – Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information.

  • ninterbeds (integer) – is the number of csub interbed systems. more than 1 csub interbed systems can be assigned to a gwf cell; however, only 1 gwf cell can be assigned to a single csub interbed system.

  • maxsig0 (integer) – is the maximum number of cells that can have a specified stress offset. more than 1 stress offset can be assigned to a gwf cell. by default, maxsig0 is 0.

  • cg_ske_cr ([double precision]) – is the initial elastic coarse-grained material specific storage or recompression index. the recompression index is specified if compression_indices is specified in the options block. specified or calculated elastic coarse-grained material specific storage values are not adjusted from initial values if head_based is specified in the options block.

  • cg_theta ([double precision]) – is the initial porosity of coarse-grained materials.

  • sgm ([double precision]) – is the specific gravity of moist or unsaturated sediments. if not specified, then a default value of 1.7 is assigned.

  • sgs ([double precision]) – is the specific gravity of saturated sediments. if not specified, then a default value of 2.0 is assigned.

  • packagedata ([list]) –

  • stress_period_data ([list]) –

cg_ske_cr = <flopy.mf6.data.mfdatautil.ArrayTemplateGenerator object>
cg_theta = <flopy.mf6.data.mfdatautil.ArrayTemplateGenerator object>
compaction_coarse_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
compaction_elastic_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
compaction_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
compaction_inelastic_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
compaction_interbed_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
dfn = [['header'], ['block options', 'name boundnames', 'type keyword', 'shape', 'reader urword', 'optional true'], ['block options', 'name print_input', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name save_flows', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name gammaw', 'type double precision', 'reader urword', 'optional true', 'default 9806.65'], ['block options', 'name beta', 'type double precision', 'reader urword', 'optional true', 'default 4.6512e-10'], ['block options', 'name head_based', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name initial_preconsolidation_head', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name ndelaycells', 'type integer', 'reader urword', 'optional true'], ['block options', 'name compression_indices', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name update_material_properties', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name cell_fraction', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name specified_initial_interbed_state', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name specified_initial_preconsolidation_stress', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name specified_initial_delay_head', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name effective_stress_lag', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name strainib_filerecord', 'type record strain_csv_interbed fileout interbedstrain_filename', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name strain_csv_interbed', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name fileout', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name interbedstrain_filename', 'type string', 'shape', 'in_record true', 'reader urword', 'tagged false', 'optional false'], ['block options', 'name straincg_filerecord', 'type record strain_csv_coarse fileout coarsestrain_filename', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name strain_csv_coarse', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name coarsestrain_filename', 'type string', 'shape', 'in_record true', 'reader urword', 'tagged false', 'optional false'], ['block options', 'name compaction_filerecord', 'type record compaction fileout compaction_filename', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name compaction', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name compaction_filename', 'type string', 'shape', 'in_record true', 'reader urword', 'tagged false', 'optional false'], ['block options', 'name compaction_elastic_filerecord', 'type record compaction_elastic fileout elastic_compaction_filename', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name compaction_elastic', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name elastic_compaction_filename', 'type string', 'shape', 'in_record true', 'reader urword', 'tagged false', 'optional false'], ['block options', 'name compaction_inelastic_filerecord', 'type record compaction_inelastic fileout inelastic_compaction_filename', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name compaction_inelastic', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name inelastic_compaction_filename', 'type string', 'shape', 'in_record true', 'reader urword', 'tagged false', 'optional false'], ['block options', 'name compaction_interbed_filerecord', 'type record compaction_interbed fileout interbed_compaction_filename', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name compaction_interbed', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name interbed_compaction_filename', 'type string', 'shape', 'in_record true', 'reader urword', 'tagged false', 'optional false'], ['block options', 'name compaction_coarse_filerecord', 'type record compaction_coarse fileout coarse_compaction_filename', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name compaction_coarse', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name coarse_compaction_filename', 'type string', 'shape', 'in_record true', 'reader urword', 'tagged false', 'optional false'], ['block options', 'name zdisplacement_filerecord', 'type record zdisplacement fileout zdisplacement_filename', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name zdisplacement', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name zdisplacement_filename', 'type string', 'shape', 'in_record true', 'reader urword', 'tagged false', 'optional false'], ['block options', 'name package_convergence_filerecord', 'type record package_convergence fileout package_convergence_filename', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name package_convergence', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name package_convergence_filename', 'type string', 'shape', 'in_record true', 'reader urword', 'tagged false', 'optional false'], ['block options', 'name ts_filerecord', 'type record ts6 filein ts6_filename', 'shape', 'reader urword', 'tagged true', 'optional true', 'construct_package ts', 'construct_data timeseries', 'parameter_name timeseries'], ['block options', 'name ts6', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name filein', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name ts6_filename', 'type string', 'in_record true', 'reader urword', 'optional false', 'tagged false'], ['block options', 'name obs_filerecord', 'type record obs6 filein obs6_filename', 'shape', 'reader urword', 'tagged true', 'optional true', 'construct_package obs', 'construct_data observations', 'parameter_name continuous'], ['block options', 'name obs6', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name obs6_filename', 'type string', 'in_record true', 'tagged false', 'reader urword', 'optional false'], ['block dimensions', 'name ninterbeds', 'type integer', 'reader urword', 'optional false'], ['block dimensions', 'name maxsig0', 'type integer', 'reader urword', 'optional true'], ['block griddata', 'name cg_ske_cr', 'type double precision', 'shape (nodes)', 'valid', 'reader readarray', 'default 1e-5'], ['block griddata', 'name cg_theta', 'type double precision', 'shape (nodes)', 'valid', 'reader readarray', 'default 0.2'], ['block griddata', 'name sgm', 'type double precision', 'shape (nodes)', 'valid', 'reader readarray', 'optional true'], ['block griddata', 'name sgs', 'type double precision', 'shape (nodes)', 'valid', 'reader readarray', 'optional true'], ['block packagedata', 'name packagedata', 'type recarray icsubno cellid cdelay pcs0 thick_frac rnb ssv_cc sse_cr theta kv h0 boundname', 'shape (ninterbeds)', 'reader urword'], ['block packagedata', 'name icsubno', 'type integer', 'shape', 'tagged false', 'in_record true', 'reader urword', 'numeric_index true'], ['block packagedata', 'name cellid', 'type integer', 'shape (ncelldim)', 'tagged false', 'in_record true', 'reader urword'], ['block packagedata', 'name cdelay', 'type string', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block packagedata', 'name pcs0', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block packagedata', 'name thick_frac', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block packagedata', 'name rnb', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block packagedata', 'name ssv_cc', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block packagedata', 'name sse_cr', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block packagedata', 'name theta', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword', 'default 0.2'], ['block packagedata', 'name kv', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block packagedata', 'name h0', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block packagedata', 'name boundname', 'type string', 'shape', 'tagged false', 'in_record true', 'reader urword', 'optional true'], ['block period', 'name iper', 'type integer', 'block_variable True', 'in_record true', 'tagged false', 'shape', 'valid', 'reader urword', 'optional false'], ['block period', 'name stress_period_data', 'type recarray cellid sig0', 'shape (maxsig0)', 'reader urword'], ['block period', 'name cellid', 'type integer', 'shape (ncelldim)', 'tagged false', 'in_record true', 'reader urword'], ['block period', 'name sig0', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword', 'time_series true']]
dfn_file_name = 'gwf-csub.dfn'
obs_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
package_abbr = 'gwfcsub'
package_convergence_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
packagedata = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
sgm = <flopy.mf6.data.mfdatautil.ArrayTemplateGenerator object>
sgs = <flopy.mf6.data.mfdatautil.ArrayTemplateGenerator object>
straincg_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
strainib_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
stress_period_data = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
ts_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
zdisplacement_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>