From 5c79c3e6f4195b146dbf61997d9d4b62644e7052 Mon Sep 17 00:00:00 2001 From: wpbonelli Date: Thu, 5 Nov 2026 10:07:10 -0800 Subject: [PATCH 1/8] Simplify the converter (squashed from typed-loader-parked) One schema-driven model of an MF6 block in both directions: stored DFNs and spec helpers, the rewritten loader (_Load), one egress path (_Unstructure), header kinds, and STO's period value as a word per period. Rebased onto develop be07090a, with develop's changes ported into the rewritten paths: binary list input, array reading (#513), external list writing (ListIO), binding rows (read_row/write_row), text tokens (#534). The typed loader and its grammar work are dropped here, back to develop's; they're on typed-loader-parked, to go on a branch stacked on this one. _Load keeps its ComponentLoad base for that. Co-Authored-By: Claude Opus 5.5 --- docs/dev/converter-simplification-plan.md | 270 +++ docs/dev/load-benchmarks.md | 11 +- docs/dev/loader-comparison.md | 158 ++ docs/examples/circle.ipynb | 2 +- docs/examples/circle.py | 2 +- docs/examples/twri.ipynb | 2 +- docs/examples/twri.py | 2 +- docs/migrating.md | 4 +- flopy4/mf6/__init__.py | 2 +- flopy4/mf6/_sync.py | 31 +- flopy4/mf6/chf/cdb.py | 6 +- flopy4/mf6/chf/chd.py | 6 +- flopy4/mf6/chf/evp.py | 6 +- flopy4/mf6/chf/flw.py | 6 +- flopy4/mf6/chf/oc.py | 6 +- flopy4/mf6/chf/pcp.py | 6 +- flopy4/mf6/chf/sto.py | 21 +- flopy4/mf6/chf/zdg.py | 6 +- flopy4/mf6/component.py | 5 +- flopy4/mf6/converter/egress/unstructure.py | 548 +++--- flopy4/mf6/converter/ingress/structure.py | 1581 ++++++++--------- flopy4/mf6/dfns/chf-cdb.toml | 289 +++ flopy4/mf6/dfns/chf-chd.toml | 295 +++ flopy4/mf6/dfns/chf-cxs.toml | 107 ++ flopy4/mf6/dfns/chf-dfw.toml | 159 ++ flopy4/mf6/dfns/chf-disv1d.toml | 258 +++ flopy4/mf6/dfns/chf-evp.toml | 295 +++ flopy4/mf6/dfns/chf-flw.toml | 308 ++++ flopy4/mf6/dfns/chf-ic.toml | 39 + flopy4/mf6/dfns/chf-nam.toml | 167 ++ flopy4/mf6/dfns/chf-oc.toml | 223 +++ flopy4/mf6/dfns/chf-pcp.toml | 295 +++ flopy4/mf6/dfns/chf-sto.toml | 53 + flopy4/mf6/dfns/chf-zdg.toml | 324 ++++ flopy4/mf6/dfns/exg-chfgwf.toml | 147 ++ flopy4/mf6/dfns/exg-gwegwe.toml | 317 ++++ flopy4/mf6/dfns/exg-gwfgwe.toml | 6 + flopy4/mf6/dfns/exg-gwfgwf.toml | 341 ++++ flopy4/mf6/dfns/exg-gwfgwt.toml | 6 + flopy4/mf6/dfns/exg-gwfprt.toml | 6 + flopy4/mf6/dfns/exg-gwtgwt.toml | 317 ++++ flopy4/mf6/dfns/exg-olfgwf.toml | 147 ++ flopy4/mf6/dfns/gwe-adv.toml | 22 + flopy4/mf6/dfns/gwe-cnd.toml | 189 ++ flopy4/mf6/dfns/gwe-ctp.toml | 300 ++++ flopy4/mf6/dfns/gwe-dis.toml | 302 ++++ flopy4/mf6/dfns/gwe-disu.toml | 366 ++++ flopy4/mf6/dfns/gwe-disv.toml | 326 ++++ flopy4/mf6/dfns/gwe-esl.toml | 308 ++++ flopy4/mf6/dfns/gwe-est.toml | 174 ++ flopy4/mf6/dfns/gwe-fmi.toml | 44 + flopy4/mf6/dfns/gwe-ic.toml | 51 + flopy4/mf6/dfns/gwe-lke.toml | 638 +++++++ flopy4/mf6/dfns/gwe-mve.toml | 82 + flopy4/mf6/dfns/gwe-mwe.toml | 541 ++++++ flopy4/mf6/dfns/gwe-nam.toml | 222 +++ flopy4/mf6/dfns/gwe-oc.toml | 212 +++ flopy4/mf6/dfns/gwe-sfe.toml | 659 +++++++ flopy4/mf6/dfns/gwe-ssm.toml | 102 ++ flopy4/mf6/dfns/gwe-uze.toml | 551 ++++++ flopy4/mf6/dfns/gwf-api.toml | 108 ++ flopy4/mf6/dfns/gwf-buy.toml | 106 ++ flopy4/mf6/dfns/gwf-chd.toml | 307 ++++ flopy4/mf6/dfns/gwf-chdg.toml | 299 ++++ flopy4/mf6/dfns/gwf-csub.toml | 939 ++++++++++ flopy4/mf6/dfns/gwf-dis.toml | 302 ++++ flopy4/mf6/dfns/gwf-disu.toml | 368 ++++ flopy4/mf6/dfns/gwf-disv.toml | 326 ++++ flopy4/mf6/dfns/gwf-drn.toml | 342 ++++ flopy4/mf6/dfns/gwf-drng.toml | 339 ++++ flopy4/mf6/dfns/gwf-evt.toml | 371 ++++ flopy4/mf6/dfns/gwf-evta.toml | 336 ++++ flopy4/mf6/dfns/gwf-ghb.toml | 324 ++++ flopy4/mf6/dfns/gwf-ghbg.toml | 321 ++++ flopy4/mf6/dfns/gwf-gnc.toml | 98 + flopy4/mf6/dfns/gwf-hfb.toml | 63 + flopy4/mf6/dfns/gwf-ic.toml | 51 + flopy4/mf6/dfns/gwf-lak.toml | 1214 +++++++++++++ flopy4/mf6/dfns/gwf-maw.toml | 832 +++++++++ flopy4/mf6/dfns/gwf-mvr.toml | 209 +++ flopy4/mf6/dfns/gwf-nam.toml | 232 +++ flopy4/mf6/dfns/gwf-npf.toml | 473 +++++ flopy4/mf6/dfns/gwf-oc.toml | 207 +++ flopy4/mf6/dfns/gwf-rch.toml | 301 ++++ flopy4/mf6/dfns/gwf-rcha.toml | 314 ++++ flopy4/mf6/dfns/gwf-riv.toml | 331 ++++ flopy4/mf6/dfns/gwf-rivg.toml | 333 ++++ flopy4/mf6/dfns/gwf-sfr.toml | 1070 +++++++++++ flopy4/mf6/dfns/gwf-sto.toml | 188 ++ flopy4/mf6/dfns/gwf-uzf.toml | 611 +++++++ flopy4/mf6/dfns/gwf-vsc.toml | 130 ++ flopy4/mf6/dfns/gwf-wel.toml | 382 ++++ flopy4/mf6/dfns/gwf-welg.toml | 363 ++++ flopy4/mf6/dfns/gwt-adv.toml | 23 + flopy4/mf6/dfns/gwt-api.toml | 108 ++ flopy4/mf6/dfns/gwt-cnc.toml | 300 ++++ flopy4/mf6/dfns/gwt-dis.toml | 302 ++++ flopy4/mf6/dfns/gwt-disu.toml | 368 ++++ flopy4/mf6/dfns/gwt-disv.toml | 326 ++++ flopy4/mf6/dfns/gwt-dsp.toml | 168 ++ flopy4/mf6/dfns/gwt-fmi.toml | 44 + flopy4/mf6/dfns/gwt-ic.toml | 51 + flopy4/mf6/dfns/gwt-ist.toml | 366 ++++ flopy4/mf6/dfns/gwt-lkt.toml | 609 +++++++ flopy4/mf6/dfns/gwt-mst.toml | 210 +++ flopy4/mf6/dfns/gwt-mvt.toml | 82 + flopy4/mf6/dfns/gwt-mwt.toml | 504 ++++++ flopy4/mf6/dfns/gwt-nam.toml | 222 +++ flopy4/mf6/dfns/gwt-oc.toml | 212 +++ flopy4/mf6/dfns/gwt-sft.toml | 609 +++++++ flopy4/mf6/dfns/gwt-src.toml | 319 ++++ flopy4/mf6/dfns/gwt-ssm.toml | 102 ++ flopy4/mf6/dfns/gwt-uzt.toml | 533 ++++++ flopy4/mf6/dfns/olf-cdb.toml | 288 +++ flopy4/mf6/dfns/olf-chd.toml | 295 +++ flopy4/mf6/dfns/olf-dfw.toml | 159 ++ flopy4/mf6/dfns/olf-dis2d.toml | 217 +++ flopy4/mf6/dfns/olf-disv1d.toml | 277 +++ flopy4/mf6/dfns/olf-disv2d.toml | 243 +++ flopy4/mf6/dfns/olf-evp.toml | 295 +++ flopy4/mf6/dfns/olf-flw.toml | 308 ++++ flopy4/mf6/dfns/olf-ic.toml | 39 + flopy4/mf6/dfns/olf-nam.toml | 167 ++ flopy4/mf6/dfns/olf-oc.toml | 223 +++ flopy4/mf6/dfns/olf-pcp.toml | 295 +++ flopy4/mf6/dfns/olf-sto.toml | 53 + flopy4/mf6/dfns/olf-zdg.toml | 324 ++++ flopy4/mf6/dfns/prt-dis.toml | 297 ++++ flopy4/mf6/dfns/prt-disv.toml | 323 ++++ flopy4/mf6/dfns/prt-fmi.toml | 33 + flopy4/mf6/dfns/prt-mip.toml | 78 + flopy4/mf6/dfns/prt-nam.toml | 87 + flopy4/mf6/dfns/prt-oc.toml | 318 ++++ flopy4/mf6/dfns/prt-prp.toml | 525 ++++++ flopy4/mf6/dfns/sim-nam.toml | 200 +++ flopy4/mf6/dfns/sim-tdis.toml | 85 + flopy4/mf6/dfns/sln-ems.toml | 18 + flopy4/mf6/dfns/sln-ims.toml | 422 +++++ flopy4/mf6/dfns/utl-ats.toml | 69 + flopy4/mf6/dfns/utl-hpc.toml | 43 + flopy4/mf6/dfns/utl-laktab.toml | 68 + flopy4/mf6/dfns/utl-ncf.toml | 132 ++ flopy4/mf6/dfns/utl-obs.toml | 91 + flopy4/mf6/dfns/utl-sfrtab.toml | 62 + flopy4/mf6/dfns/utl-spc.toml | 99 ++ flopy4/mf6/dfns/utl-spca.toml | 76 + flopy4/mf6/dfns/utl-tas.toml | 79 + flopy4/mf6/dfns/utl-ts.toml | 119 ++ flopy4/mf6/dfns/utl-tvk.toml | 79 + flopy4/mf6/dfns/utl-tvs.toml | 84 + flopy4/mf6/external.py | 69 +- flopy4/mf6/gwe/ctp.py | 6 +- flopy4/mf6/gwe/esl.py | 6 +- flopy4/mf6/gwe/lke.py | 17 +- flopy4/mf6/gwe/mwe.py | 17 +- flopy4/mf6/gwe/oc.py | 6 +- flopy4/mf6/gwe/sfe.py | 17 +- flopy4/mf6/gwe/uze.py | 17 +- flopy4/mf6/gwf/chd.py | 6 +- flopy4/mf6/gwf/chdg.py | 6 +- flopy4/mf6/gwf/csub.py | 17 +- flopy4/mf6/gwf/drn.py | 6 +- flopy4/mf6/gwf/drng.py | 6 +- flopy4/mf6/gwf/evt.py | 6 +- flopy4/mf6/gwf/evta.py | 6 +- flopy4/mf6/gwf/ghb.py | 6 +- flopy4/mf6/gwf/ghbg.py | 6 +- flopy4/mf6/gwf/hfb.py | 6 +- flopy4/mf6/gwf/lak.py | 5 + flopy4/mf6/gwf/maw.py | 5 + flopy4/mf6/gwf/mvr.py | 6 +- flopy4/mf6/gwf/oc.py | 6 +- flopy4/mf6/gwf/rch.py | 6 +- flopy4/mf6/gwf/rcha.py | 6 +- flopy4/mf6/gwf/riv.py | 6 +- flopy4/mf6/gwf/rivg.py | 6 +- flopy4/mf6/gwf/sfr.py | 5 + flopy4/mf6/gwf/sto.py | 21 +- flopy4/mf6/gwf/uzf.py | 17 +- flopy4/mf6/gwf/wel.py | 6 +- flopy4/mf6/gwf/welg.py | 6 +- flopy4/mf6/gwt/cnc.py | 6 +- flopy4/mf6/gwt/lkt.py | 17 +- flopy4/mf6/gwt/mwt.py | 17 +- flopy4/mf6/gwt/oc.py | 6 +- flopy4/mf6/gwt/sft.py | 17 +- flopy4/mf6/gwt/src.py | 6 +- flopy4/mf6/gwt/uzt.py | 17 +- flopy4/mf6/legacy.py | 8 +- flopy4/mf6/olf/cdb.py | 6 +- flopy4/mf6/olf/chd.py | 6 +- flopy4/mf6/olf/evp.py | 6 +- flopy4/mf6/olf/flw.py | 6 +- flopy4/mf6/olf/oc.py | 6 +- flopy4/mf6/olf/pcp.py | 6 +- flopy4/mf6/olf/sto.py | 21 +- flopy4/mf6/olf/zdg.py | 6 +- flopy4/mf6/prt/oc.py | 6 +- flopy4/mf6/prt/prp.py | 6 +- flopy4/mf6/simulation.py | 6 +- flopy4/mf6/spec.py | 312 +++- flopy4/mf6/utils/codegen/filters.py | 14 + flopy4/mf6/utils/codegen/make.py | 100 +- .../utils/codegen/templates/package.py.jinja | 8 + flopy4/mf6/utl/obs.py | 6 +- flopy4/mf6/utl/spc.py | 6 +- flopy4/mf6/utl/spca.py | 6 +- flopy4/mf6/utl/tas.py | 6 +- flopy4/mf6/utl/tvk.py | 6 +- flopy4/mf6/utl/tvs.py | 6 +- flopy4/mf6/write_context.py | 16 +- pyproject.toml | 1 + ...ip[mf6testtest001a_Tharmonic_extlist].json | 2 +- ...undtrip[mf6testtest001b_Tlogarithmic].json | 2 +- ...st_roundtrip[mf6testtest001c_Tamtlmk].json | 2 +- ...st_roundtrip[mf6testtest001d_Tnewton].json | 2 +- ...trip[mf6testtest001e_Tnewton_2models].json | 2 +- ...roundtrip[mf6testtest001e_UZF_3layTS].json | 6 +- ...t_roundtrip[mf6testtest001e_UZF_3lay].json | 6 +- ...est_roundtrip[mf6testtest001e_UZF_TS].json | 6 +- ...roundtrip[mf6testtest001e_UZF_spring].json | 6 +- ...roundtrip[mf6testtest001e_noUZF_3lay].json | 6 +- ...undtrip[mf6testtest001f_hfb-xt3d-nwt].json | 2 +- ...t_roundtrip[mf6testtest001f_hfb-xt3d].json | 2 +- .../test_roundtrip[mf6testtest001f_hfb].json | 2 +- .../test_roundtrip[mf6testtest001g_MVR].json | 2 +- ...ndtrip[mf6testtest001g_MVR_transient].json | 2 +- .../test_roundtrip[mf6testtest003_gwfs].json | 2 +- ...t_roundtrip[mf6testtest003_gwfs_disv].json | 2 +- ...ndtrip[mf6testtest003_gwfs_disv_xt3d].json | 2 +- ...st_roundtrip[mf6testtest003_gwfs_obs].json | 2 +- ...oundtrip[mf6testtest003_gwfs_reduced].json | 2 +- ...est_roundtrip[mf6testtest003_gwfs_tr].json | 6 +- .../test_roundtrip[mf6testtest004_bcfss].json | 2 +- .../test_roundtrip[mf6testtest004_lpfss].json | 2 +- ..._roundtrip[mf6testtest004_lpfss_disv].json | 2 +- ...st_roundtrip[mf6testtest004_lpfss_nr].json | 2 +- ...roundtrip[mf6testtest005_advgw_tidal].json | 8 +- ...roundtrip[mf6testtest006_2models_gnc].json | 2 +- ...dtrip[mf6testtest006_2models_mvr_dev].json | 2 +- ...ndtrip[mf6testtest006_2models_unconf].json | 2 +- ...rip[mf6testtest006_2models_unconf_nr].json | 2 +- ...mf6testtest006_2models_unconf_nr_gnc].json | 2 +- ...[mf6testtest006_2models_unconf_tr_nr].json | 2 +- .../test_roundtrip[mf6testtest006_gwf3].json | 2 +- ...t_roundtrip[mf6testtest006_gwf3_disv].json | 2 +- ...undtrip[mf6testtest006_gwf3_disv_ext].json | 2 +- ...ndtrip[mf6testtest006_gwf3_disv_hani].json | 2 +- ...sttest006_gwf3_disv_trimesh2-3D_xt3d].json | 2 +- ...ip[mf6testtest006_gwf3_disv_trimesh2].json | 2 +- ...6testtest006_gwf3_disv_trimesh2_xt3d].json | 2 +- ...rip[mf6testtest006_gwf3_disv_trimesh].json | 2 +- ...f6testtest006_gwf3_disv_trimesh_xt3d].json | 2 +- ...ndtrip[mf6testtest006_gwf3_disv_xt3d].json | 2 +- ...st_roundtrip[mf6testtest006_gwf3_gnc].json | 2 +- ...rip[mf6testtest006_gwf3_gnc_nr_mfusg].json | 2 +- ...undtrip[mf6testtest006_gwf3_nr_mfusg].json | 2 +- ...est_roundtrip[mf6testtest006_gwf3_tr].json | 2 +- ..._roundtrip[mf6testtest006_gwf3_tr_nr].json | 2 +- ...roundtrip[mf6testtest006_gwf3_unconf].json | 2 +- ...[mf6testtest006a_gwf3_disv_thickstrt].json | 2 +- .../test_roundtrip[mf6testtest007_75x75].json | 8 +- ...ndtrip[mf6testtest007_75x75_confined].json | 8 +- ...t_roundtrip[mf6testtest009_3lay-disu].json | 2 +- ...t_roundtrip[mf6testtest011_mflgr_ex3].json | 2 +- ...undtrip[mf6testtest011_mflgr_ex3_sfr].json | 2 +- ..._roundtrip[mf6testtest012_WaterTable].json | 2 +- ...test_roundtrip[mf6testtest013_Zaidel].json | 2 +- ...t_roundtrip[mf6testtest014_NWTP3High].json | 2 +- ...dtrip[mf6testtest014_NWTP3High_mfusg].json | 2 +- ...st_roundtrip[mf6testtest014_NWTP3Low].json | 2 +- ...oundtrip[mf6testtest014_NWTP3Low_MAW].json | 2 +- ...dtrip[mf6testtest014_NWTP3Low_MD_dev].json | 2 +- ...trip[mf6testtest014_NWTP3Low_RCM_dev].json | 2 +- ...oundtrip[mf6testtest014_NWTP3Low_dev].json | 2 +- ...[mf6testtest015_KeatingLike-xt3d-rhs].json | 2 +- ...trip[mf6testtest015_KeatingLike-xt3d].json | 2 +- ...roundtrip[mf6testtest015_KeatingLike].json | 2 +- ...trip[mf6testtest015_KeatingLike_disu].json | 2 +- ...f6testtest015_KeatingLike_disu_mfusg].json | 2 +- ...est_roundtrip[mf6testtest016_Keating].json | 2 +- ...roundtrip[mf6testtest016_Keating_dev].json | 2 +- ...trip[mf6testtest016_Keating_disu_250].json | 2 +- ...mf6testtest016_Keating_disu_250_xt3d].json | 2 +- ...ip[mf6testtest016_Keating_disu_mfusg].json | 2 +- ...est_roundtrip[mf6testtest017_Crinkle].json | 6 +- ...oundtrip[mf6testtest019_VilhelmsenGC].json | 2 +- ...oundtrip[mf6testtest019_VilhelmsenGF].json | 2 +- ...undtrip[mf6testtest019_VilhelmsenLGR].json | 2 +- ...trip[mf6testtest019_VilhelmsenLGR_nr].json | 2 +- .../test_roundtrip[mf6testtest020_NT_EI].json | 2 +- ...esttest020_NevilleTonkinTransientTS2].json | 2 +- ...testtest020_NevilleTonkinTransientTS].json | 2 +- ...f6testtest020_NevilleTonkinTransient].json | 2 +- ...test020_NevilleTonkinTransient_aniso].json | 2 +- ...0_NevilleTonkinTransient_constantMAW].json | 2 +- ...st020_NevilleTonkinTransient_cumcond].json | 2 +- ...0_NevilleTonkinTransient_cumcond_dev].json | 2 +- ...020_NevilleTonkinTransient_thickstrt].json | 2 +- ...roundtrip[mf6testtest020_mawconfined].json | 2 +- ...mf6testtest020_mawconfined_openclose].json | 2 +- .../test_roundtrip[mf6testtest021_twri].json | 2 +- ...roundtrip[mf6testtest023_FlowingWell].json | 2 +- ...test_roundtrip[mf6testtest024_Reilly].json | 2 +- ..._roundtrip[mf6testtest024_Reilly_ext].json | 2 +- ..._roundtrip[mf6testtest025_ConstantCV].json | 2 +- ...ip[mf6testtest025_ConstantCV_perched].json | 2 +- ..._roundtrip[mf6testtest025_VariableCV].json | 2 +- ...[mf6testtest025_Vertically_Staggered].json | 2 +- ...undtrip[mf6testtest026_WellReduction].json | 2 +- ...ndtrip[mf6testtest027_TimeseriesTest].json | 6 +- ...f6testtest027_TimeseriesTest_idomain].json | 6 +- .../test_roundtrip[mf6testtest028_sfr].json | 2 +- ...est_roundtrip[mf6testtest028_sfr_mvr].json | 2 +- ...rip[mf6testtest028_sfr_mvr_openclose].json | 2 +- ...t_roundtrip[mf6testtest028_sfr_rewet].json | 2 +- ...dtrip[mf6testtest028_sfr_rewet_drain].json | 2 +- ...oundtrip[mf6testtest028_sfr_rewet_nr].json | 2 +- ...trip[mf6testtest028_sfr_rewet_simple].json | 2 +- ..._roundtrip[mf6testtest028_sfr_simple].json | 2 +- ...dtrip[mf6testtest029_lgr_parentchild].json | 2 +- ...undtrip[mf6testtest029_lgrsfr_parent].json | 2 +- ...ip[mf6testtest029_lgrsfr_parent_hole].json | 2 +- ...ip[mf6testtest029_lgrsfr_parentchild].json | 2 +- ...st_roundtrip[mf6testtest030_hani_col].json | 2 +- ...undtrip[mf6testtest030_hani_col_disu].json | 2 +- ...st_roundtrip[mf6testtest030_hani_row].json | 2 +- ...undtrip[mf6testtest030_hani_row_disu].json | 2 +- ...t_roundtrip[mf6testtest030_hani_xt3d].json | 2 +- ...ndtrip[mf6testtest030_hani_xt3d_disu].json | 2 +- .../test_roundtrip[mf6testtest032_sfr].json | 2 +- ...est_roundtrip[mf6testtest033_wtdecay].json | 2 +- .../test_roundtrip[mf6testtest034_nwtp2].json | 4 +- ...st_roundtrip[mf6testtest034_nwtp2_1d].json | 4 +- .../test_roundtrip[mf6testtest035_fhb].json | 2 +- ...est_roundtrip[mf6testtest036_twrihfb].json | 2 +- ...oundtrip[mf6testtest036_twrihfb_5lay].json | 2 +- ...roundtrip[mf6testtest036_twrihfb_lpf].json | 2 +- ..._roundtrip[mf6testtest036_twrihfb_nr].json | 2 +- ...rip[mf6testtest036_twrihfb_openclose].json | 2 +- .../test_roundtrip[mf6testtest037_mfcp3].json | 8 +- ...est_roundtrip[mf6testtest038_idomain].json | 2 +- ..._roundtrip[mf6testtest041_flowdivert].json | 2 +- ...trip[mf6testtest041_flowdivert_mfusg].json | 2 +- ...undtrip[mf6testtest041_flowdivert_nr].json | 2 +- ...ip[mf6testtest041_flowdivert_nwt_dev].json | 2 +- ...t_roundtrip[mf6testtest042_lake0_dev].json | 2 +- ...dtrip[mf6testtest042_lake0_embeddedh].json | 2 +- ...[mf6testtest042_lake0_embeddedh_conf].json | 2 +- ...esttest042_lake0_embeddedh_openclose].json | 2 +- ...dtrip[mf6testtest042_lake0_embeddedv].json | 2 +- ...[mf6testtest042_lake0_embeddedv_conf].json | 2 +- ...p[mf6testtest042_lake0_embeddedv_dev].json | 2 +- ...roundtrip[mf6testtest043_drylake_dev].json | 2 +- ...dtrip[mf6testtest044_lakebotfill_dev].json | 2 +- ...est_roundtrip[mf6testtest045_lake1ss].json | 2 +- ...f6testtest045_lake1ss_1layer_alt_dev].json | 2 +- ...ip[mf6testtest045_lake1ss_1layer_dev].json | 2 +- ...test045_lake1ss_1layer_thickstrt_dev].json | 2 +- ...roundtrip[mf6testtest045_lake1ss_dev].json | 2 +- ...trip[mf6testtest045_lake1ss_none_dev].json | 2 +- ...rip[mf6testtest045_lake1ss_table_dev].json | 2 +- ...roundtrip[mf6testtest045_lake1tr_dev].json | 2 +- ..._roundtrip[mf6testtest045_lake1tr_nr].json | 2 +- ...roundtrip[mf6testtest045_lake2tr_dev].json | 2 +- ...ndtrip[mf6testtest045_lake2tr_il_dev].json | 2 +- ..._roundtrip[mf6testtest045_lake2tr_nr].json | 2 +- ...rip[mf6testtest045_lake2tr_xsfra_dev].json | 2 +- ...rip[mf6testtest045_lake2tr_xsfrb_dev].json | 2 +- ...rip[mf6testtest045_lake2tr_xsfrc_dev].json | 2 +- ...rip[mf6testtest045_lake2tr_xsfrd_dev].json | 2 +- ...rip[mf6testtest045_lake2tr_xsfre_dev].json | 2 +- ...est_roundtrip[mf6testtest045_lake4ss].json | 2 +- ...ndtrip[mf6testtest045_lake4ss_cl_dev].json | 2 +- ...roundtrip[mf6testtest045_lake4ss_dev].json | 2 +- ...ndtrip[mf6testtest045_lake4ss_il_dev].json | 2 +- ...ndtrip[mf6testtest045_lake4ss_nr_dev].json | 2 +- ...p[mf6testtest045_lake4ss_nr_embedded].json | 2 +- ...roundtrip[mf6testtest046_periodic_bc].json | 2 +- ...mf6testtest046_periodic_bc_openclose].json | 2 +- ..._roundtrip[mf6testtest048_lgr3d_conf].json | 2 +- ...undtrip[mf6testtest048_lgr3d_unconfB].json | 2 +- ...undtrip[mf6testtest048_lgr3d_unconfC].json | 2 +- ...undtrip[mf6testtest048_lgr3d_unconfD].json | 2 +- ...oundtrip[mf6testtest048_lgr3d_unconf].json | 2 +- ...roundtrip[mf6testtest049_gwfexgrewet].json | 2 +- ...undtrip[mf6testtest050_circle_island].json | 2 +- ...est_roundtrip[mf6testtest051_uzfp2TS].json | 6 +- .../test_roundtrip[mf6testtest051_uzfp2].json | 6 +- ...t_roundtrip[mf6testtest051_uzfp2_mvr].json | 6 +- ...roundtrip[mf6testtest051_uzfp2_nouzf].json | 6 +- ...dtrip[mf6testtest051_uzfp2_openclose].json | 6 +- ...mf6testtest051_uzfp3_aeET_lakmvr_dev].json | 6 +- ...ttest051_uzfp3_lakmvr_2uzfmodels_dev].json | 6 +- ...trip[mf6testtest051_uzfp3_lakmvr_dev].json | 6 +- ...f6testtest051_uzfp3_lakmvr_nouzf_dev].json | 6 +- ...p[mf6testtest051_uzfp3_lakmvr_v2_dev].json | 6 +- ...ip[mf6testtest051_uzfp3_wellakmvr_v2].json | 6 +- ...st_roundtrip[mf6testtest052_uzf_3col].json | 2 +- .../test_roundtrip[mf6testtest053_npf-a].json | 2 +- ...roundtrip[mf6testtest053_npf-a_mfusg].json | 2 +- .../test_roundtrip[mf6testtest053_npf-b].json | 2 +- ...roundtrip[mf6testtest053_npf-b_mfusg].json | 2 +- ...oundtrip[mf6testtest054_xt3d_whirlsA].json | 2 +- ...oundtrip[mf6testtest054_xt3d_whirlsB].json | 2 +- ...oundtrip[mf6testtest054_xt3d_whirlsC].json | 2 +- ...p[mf6testtest055_xt3d_lvda-doc-test1].json | 2 +- ...testtest056_mt3dms_usgs_gwtex_IR_dev].json | 2 +- ...mf6testtest056_mt3dms_usgs_gwtex_dev].json | 2 +- ...oundtrip[mf6testtest057_transientchd].json | 2 +- ...undtrip[mf6testtest059_mvlake_lak_ss].json | 2 +- ..._roundtrip[mf6testtest061_csub_holly].json | 2 +- ..._roundtrip[mf6testtest061_csub_jacob].json | 4 +- .../test_roundtrip[mf6testtest100_ss_ic].json | 2 +- .../test_roundtrip[mf6testtest101_fhb].json | 2 +- ...est_roundtrip[mf6testtest102_wel_mvr].json | 2 +- ...est_roundtrip[mf6testtest103_drn_mvr].json | 2 +- ...est_roundtrip[mf6testtest104_riv_mvr].json | 2 +- ...est_roundtrip[mf6testtest105_ghb_mvr].json | 2 +- ...st_roundtrip[mf6testtest106_tsnodata].json | 6 +- ...rip[mf6testtest106_tsnodataalt_model].json | 6 +- ...rip[mf6testtest205_gwtbuy-henrytidal].json | 2 +- test/mf6/test_mf6_codec.py | 69 +- test/mf6/test_mf6_codegen.py | 15 +- test/mf6/test_mf6_component.py | 2 +- test/mf6/test_mf6_dfn.py | 161 ++ test/mf6/test_mf6_external_arrays.py | 78 + test/mf6/test_mf6_integration.py | 4 +- test/mf6/test_mf6_io_roundtrip.py | 56 +- test/mf6/test_mf6_legacy.py | 12 +- test/mf6/test_mf6_sync.py | 61 +- 431 files changed, 36372 insertions(+), 1700 deletions(-) create mode 100644 docs/dev/converter-simplification-plan.md create mode 100644 docs/dev/loader-comparison.md create mode 100644 flopy4/mf6/dfns/chf-cdb.toml create mode 100644 flopy4/mf6/dfns/chf-chd.toml create mode 100644 flopy4/mf6/dfns/chf-cxs.toml create mode 100644 flopy4/mf6/dfns/chf-dfw.toml create mode 100644 flopy4/mf6/dfns/chf-disv1d.toml create mode 100644 flopy4/mf6/dfns/chf-evp.toml create mode 100644 flopy4/mf6/dfns/chf-flw.toml create mode 100644 flopy4/mf6/dfns/chf-ic.toml create mode 100644 flopy4/mf6/dfns/chf-nam.toml create mode 100644 flopy4/mf6/dfns/chf-oc.toml create mode 100644 flopy4/mf6/dfns/chf-pcp.toml create mode 100644 flopy4/mf6/dfns/chf-sto.toml create mode 100644 flopy4/mf6/dfns/chf-zdg.toml create mode 100644 flopy4/mf6/dfns/exg-chfgwf.toml create mode 100644 flopy4/mf6/dfns/exg-gwegwe.toml create mode 100644 flopy4/mf6/dfns/exg-gwfgwe.toml create mode 100644 flopy4/mf6/dfns/exg-gwfgwf.toml create mode 100644 flopy4/mf6/dfns/exg-gwfgwt.toml create mode 100644 flopy4/mf6/dfns/exg-gwfprt.toml create mode 100644 flopy4/mf6/dfns/exg-gwtgwt.toml create mode 100644 flopy4/mf6/dfns/exg-olfgwf.toml create mode 100644 flopy4/mf6/dfns/gwe-adv.toml create mode 100644 flopy4/mf6/dfns/gwe-cnd.toml create mode 100644 flopy4/mf6/dfns/gwe-ctp.toml create mode 100644 flopy4/mf6/dfns/gwe-dis.toml create mode 100644 flopy4/mf6/dfns/gwe-disu.toml create mode 100644 flopy4/mf6/dfns/gwe-disv.toml create mode 100644 flopy4/mf6/dfns/gwe-esl.toml create mode 100644 flopy4/mf6/dfns/gwe-est.toml create mode 100644 flopy4/mf6/dfns/gwe-fmi.toml create mode 100644 flopy4/mf6/dfns/gwe-ic.toml create mode 100644 flopy4/mf6/dfns/gwe-lke.toml create mode 100644 flopy4/mf6/dfns/gwe-mve.toml create mode 100644 flopy4/mf6/dfns/gwe-mwe.toml create mode 100644 flopy4/mf6/dfns/gwe-nam.toml create mode 100644 flopy4/mf6/dfns/gwe-oc.toml create mode 100644 flopy4/mf6/dfns/gwe-sfe.toml create mode 100644 flopy4/mf6/dfns/gwe-ssm.toml create mode 100644 flopy4/mf6/dfns/gwe-uze.toml create mode 100644 flopy4/mf6/dfns/gwf-api.toml create mode 100644 flopy4/mf6/dfns/gwf-buy.toml create mode 100644 flopy4/mf6/dfns/gwf-chd.toml create mode 100644 flopy4/mf6/dfns/gwf-chdg.toml create mode 100644 flopy4/mf6/dfns/gwf-csub.toml create mode 100644 flopy4/mf6/dfns/gwf-dis.toml create mode 100644 flopy4/mf6/dfns/gwf-disu.toml create mode 100644 flopy4/mf6/dfns/gwf-disv.toml create mode 100644 flopy4/mf6/dfns/gwf-drn.toml create mode 100644 flopy4/mf6/dfns/gwf-drng.toml create mode 100644 flopy4/mf6/dfns/gwf-evt.toml create mode 100644 flopy4/mf6/dfns/gwf-evta.toml create mode 100644 flopy4/mf6/dfns/gwf-ghb.toml create mode 100644 flopy4/mf6/dfns/gwf-ghbg.toml create mode 100644 flopy4/mf6/dfns/gwf-gnc.toml create mode 100644 flopy4/mf6/dfns/gwf-hfb.toml create mode 100644 flopy4/mf6/dfns/gwf-ic.toml create mode 100644 flopy4/mf6/dfns/gwf-lak.toml create mode 100644 flopy4/mf6/dfns/gwf-maw.toml create mode 100644 flopy4/mf6/dfns/gwf-mvr.toml create mode 100644 flopy4/mf6/dfns/gwf-nam.toml create mode 100644 flopy4/mf6/dfns/gwf-npf.toml create mode 100644 flopy4/mf6/dfns/gwf-oc.toml create mode 100644 flopy4/mf6/dfns/gwf-rch.toml create mode 100644 flopy4/mf6/dfns/gwf-rcha.toml create mode 100644 flopy4/mf6/dfns/gwf-riv.toml create mode 100644 flopy4/mf6/dfns/gwf-rivg.toml create mode 100644 flopy4/mf6/dfns/gwf-sfr.toml create mode 100644 flopy4/mf6/dfns/gwf-sto.toml create mode 100644 flopy4/mf6/dfns/gwf-uzf.toml create mode 100644 flopy4/mf6/dfns/gwf-vsc.toml create mode 100644 flopy4/mf6/dfns/gwf-wel.toml create mode 100644 flopy4/mf6/dfns/gwf-welg.toml create mode 100644 flopy4/mf6/dfns/gwt-adv.toml create mode 100644 flopy4/mf6/dfns/gwt-api.toml create mode 100644 flopy4/mf6/dfns/gwt-cnc.toml create mode 100644 flopy4/mf6/dfns/gwt-dis.toml create mode 100644 flopy4/mf6/dfns/gwt-disu.toml create mode 100644 flopy4/mf6/dfns/gwt-disv.toml create mode 100644 flopy4/mf6/dfns/gwt-dsp.toml create mode 100644 flopy4/mf6/dfns/gwt-fmi.toml create mode 100644 flopy4/mf6/dfns/gwt-ic.toml create mode 100644 flopy4/mf6/dfns/gwt-ist.toml create mode 100644 flopy4/mf6/dfns/gwt-lkt.toml create mode 100644 flopy4/mf6/dfns/gwt-mst.toml create mode 100644 flopy4/mf6/dfns/gwt-mvt.toml create mode 100644 flopy4/mf6/dfns/gwt-mwt.toml create mode 100644 flopy4/mf6/dfns/gwt-nam.toml create mode 100644 flopy4/mf6/dfns/gwt-oc.toml create mode 100644 flopy4/mf6/dfns/gwt-sft.toml create mode 100644 flopy4/mf6/dfns/gwt-src.toml create mode 100644 flopy4/mf6/dfns/gwt-ssm.toml create mode 100644 flopy4/mf6/dfns/gwt-uzt.toml create mode 100644 flopy4/mf6/dfns/olf-cdb.toml create mode 100644 flopy4/mf6/dfns/olf-chd.toml create mode 100644 flopy4/mf6/dfns/olf-dfw.toml create mode 100644 flopy4/mf6/dfns/olf-dis2d.toml create mode 100644 flopy4/mf6/dfns/olf-disv1d.toml create mode 100644 flopy4/mf6/dfns/olf-disv2d.toml create mode 100644 flopy4/mf6/dfns/olf-evp.toml create mode 100644 flopy4/mf6/dfns/olf-flw.toml create mode 100644 flopy4/mf6/dfns/olf-ic.toml create mode 100644 flopy4/mf6/dfns/olf-nam.toml create mode 100644 flopy4/mf6/dfns/olf-oc.toml create mode 100644 flopy4/mf6/dfns/olf-pcp.toml create mode 100644 flopy4/mf6/dfns/olf-sto.toml create mode 100644 flopy4/mf6/dfns/olf-zdg.toml create mode 100644 flopy4/mf6/dfns/prt-dis.toml create mode 100644 flopy4/mf6/dfns/prt-disv.toml create mode 100644 flopy4/mf6/dfns/prt-fmi.toml create mode 100644 flopy4/mf6/dfns/prt-mip.toml create mode 100644 flopy4/mf6/dfns/prt-nam.toml create mode 100644 flopy4/mf6/dfns/prt-oc.toml create mode 100644 flopy4/mf6/dfns/prt-prp.toml create mode 100644 flopy4/mf6/dfns/sim-nam.toml create mode 100644 flopy4/mf6/dfns/sim-tdis.toml create mode 100644 flopy4/mf6/dfns/sln-ems.toml create mode 100644 flopy4/mf6/dfns/sln-ims.toml create mode 100644 flopy4/mf6/dfns/utl-ats.toml create mode 100644 flopy4/mf6/dfns/utl-hpc.toml create mode 100644 flopy4/mf6/dfns/utl-laktab.toml create mode 100644 flopy4/mf6/dfns/utl-ncf.toml create mode 100644 flopy4/mf6/dfns/utl-obs.toml create mode 100644 flopy4/mf6/dfns/utl-sfrtab.toml create mode 100644 flopy4/mf6/dfns/utl-spc.toml create mode 100644 flopy4/mf6/dfns/utl-spca.toml create mode 100644 flopy4/mf6/dfns/utl-tas.toml create mode 100644 flopy4/mf6/dfns/utl-ts.toml create mode 100644 flopy4/mf6/dfns/utl-tvk.toml create mode 100644 flopy4/mf6/dfns/utl-tvs.toml create mode 100644 test/mf6/test_mf6_dfn.py diff --git a/docs/dev/converter-simplification-plan.md b/docs/dev/converter-simplification-plan.md new file mode 100644 index 000000000..a45605e70 --- /dev/null +++ b/docs/dev/converter-simplification-plan.md @@ -0,0 +1,270 @@ +# Converter simplification plan (structure / unstructure) + +Status: **done**, apart from D5 and D6 (skipped for now) and the +follow-ups under "Later". Written 2026-09-22 against `fe5423c` and revised +2026-10-19/20 after rebasing onto `develop` (`916c2f8b`). From 2026-10-20 +the plan was two loaders built side by side, then compared. Trimmed +2026-10-22 to the results; the full plan, with each phase as planned, is +in this file's git history (before this trim, `65af7491`). Rebased +2026-10-23 onto `develop` at `d14e5fb2` (#503, flopy3's period-data +keywords), with devtools at `07d1273a`. Squashed and rebased 2026-11-05 +onto `develop` at `be07090a` (#539), which also took the typed loader off +this branch: see "The typed loader" below. The commit hashes here are on +`typed-loader-parked` (`f46cfeca`), the pre-squash history. + +The work is a refactor on the current attrs object model, independent of +the `pydantic-plan` migration. The round-trip suite +(`test/mf6/test_mf6_io_roundtrip.py`), the load snapshots and the +written-file snapshots are the safety net. The one API change is STO's +period value (decision 1). + +## Goal + +Replace the multi-pass, exception-driven ingress (`structure.py`) and the +type-sniffing egress (`unstructure.py`) with one schema-driven model of an +MF6 block, used the same way in both directions. + +Before, on `develop` @ `916c2f8b`: +- **Ingress** ran seven passes. Each classified fields from their Python + annotations, guessed a list's taggedness from its block's size, and + grouped repeating blocks its own way. There were three array readers, + and six copies of the kwarg-name rule that disagreed. +- **Egress** dispatched on runtime value types through about a dozen + `isinstance` branches. It hardcoded `maxbound` and `solutiongroup 1`, + and had separate paths for packages and other components. + +## Where it ended up + +- **One loader here** (`converter/ingress/structure.py`, `_Load`): the + basic grammar's token rows, with block structure from the DFNs stored + with the classes. + - **Base class** (`ComponentLoad`): assembling a repeating block's values + by header, fill-forward and clearing, list rows into `Item`s, child + bindings, and the instance's `WriteContext`. It has one subclass on + this branch, and stays split for the typed loader's. +- **One egress path** (`egress/unstructure.py`, `_Unstructure`), the + inverse of `_Load`. It walks the DFN's blocks in order and writes each + field by its DFN type. +- **Stored DFNs.** Sync writes the DFNs it generated the classes from to + `flopy4/mf6/dfns`, as TOML. `spec.dfn(cls)` loads one when first asked + for; `spec.block_keys(cls, block)` gives a block's row keys, dynamic + keys and untagged field. `spec.attr_names(cls)`, from codegen, maps + each DFN field to its class attribute. +- **What the classes carry**, written by codegen: `dfn_name`; `headers`, + each repeating block's `Header(kind, index)` (D7); and each field's + `block`, `fill_forward` and type metadata. + +## Phases + +Each kept the round-trip suite and the load and written-file snapshots +green when it landed. + +### Shared + +- **S1. Name mapping** (`971db3f6`). Codegen records the attribute it + names for each DFN field (`make.attr_names`), so there's one naming + rule. The loader switch from this commit left with the typed loader. +- **S2. Egress mirror** (`0995bc85`). One path for every component. + - `maxbound` is read from the class's property, and the `solutiongroup + 1` hack is gone: a field holding one value is the first occurrence's. + - The rows naming children come from `bindings`, the inverse of + `_resolve_bindings`. + - Written files changed only in field order, now the DFN's: `MXITER` + before the solution rows, and EVT's `MAXBOUND` before `NSEG`. + +### Track A: the basic loader + +- **A1. Stored DFNs** (`ac0e06ee`, lazy loading `58fd00e0`). Sync stores + the DFNs again (`_store_dfns`, dropped in #455). `spec.dfn`, + `block_keys` and `following_tags` wrap the devtools helpers in one + place. + - A first attempt emitted a `BlockSpec` per class and was dropped: it + restated the DFN in a vocabulary of its own. +- **A2. Value parsers** (`aa840941`). `_read_array` reads every grid + array (griddata, G/A period, TAS time), its length from the field's DFN + shape. `_tagged_value` and `parse_list` serve every block. + - `FACTOR` is applied on load and not kept (`write-options-plan.md`, in + the archive). +- **A3. Ingress loop** (`ed1185e2`). `structure_component` reads the + DFN's blocks in order, options and dimensions first. + - `_occurrences` groups blocks by name and header. + - A row goes to the field of its own block whose key it begins with; + the rest go to the untagged field, or to `_resolve_bindings`. + - Passes 1–4, the block-size inference and `repeating_array_key_type` + are gone. + +### The typed loader (not on this branch) + +Phases B (typed load, B1-B4) and C (comparing the loaders) were built here +and moved off in the 2026-11-05 rebase. They're on `typed-loader-parked`, +to be rebuilt on a `typed-loader` branch stacked on this one, with the +develop changes this rebase ported into `_Load` ported there too. That +branch doesn't exist yet. `typed.lark`, the generated grammars, `loads_typed` +and `_check_typed_grammar` here are `develop`'s, unchanged. C's results, +from before the rebase, are in +[`loader-comparison.md`](loader-comparison.md). + +### D: cleanups from the post-C audit + +The audit (2026-10-21, at `0fb2ef70`) counted +405 code lines on the +branch. The basic loader and egress were about +30 together; the typed +loader about +360. + +- **D1. One child-binding predicate** (`f68645ef`): `spec.binding_fields`, + used in all five places that had their own. +- **D2. One header parse** (`835f7d4c`). +- **D3. `_resolve_bindings` rewritten** (`7aa6139c`). `_binding_target` + makes one ftype comparison over each field's classes, and one context + is carried through a block, gaining dims as providers load. +- **D4. `_Load.body` untangled** (`b3cbd503`). `_groups` puts each row + with the records after it, so the loop is a plain `for`. OC's `HEAD` + direction check moved to `field_of`, for file records only (``XT3D + [RHS]`` has an optional second keyword). +- **D5. Value kind from the DFN on ingress.** *Skipped for now.* While + both loaders stay, none of the annotation helpers (`item_list_type`, + `block_list_type`, `_per_header`, ...) could go: the typed loader, the + shared code and egress use them. So this would only add a second + dispatch. Revisit with deleting a loader. +- **D6. Two sources of truth at runtime** (the classes and the stored + DFNs, joined by `attr_names`). *Skipped for now,* with D5. Storing the + names at sync time stays in "Later". +- **D7. Header kinds from the generated classes** (`bf264dda`, + `00051dee`). + - Codegen writes `headers: ClassVar[dict[str, Header]]` from the DFN's + `block.header`: + - the 59 period blocks: `Header("integer", index=True)`; + - Simulation's solution groups: `Header("integer")`; + - TAS: `Header("double")`; + - OBS: `Header("record")`. + - `index` is the DFN's: devtools marks IPER `index = true` (dd9bd848). + - `_header`, egress's `occurrences` and `annotate_arrays` + read `headers`, so no code names the `period` or `time` block. + +## Representation decisions + +1. **STO period: done** (`d3e9feb4`). devtools now names the merged + field `stress_period_data`. + - Codegen emits it as one word per period: + `stress_period_data: Optional[dict[int, Literal["steady-state", + "transient"]]]`, filled forward. + - `string(valid=...)` keeps a value as the DFN spells it, whatever its + case. + - Egress writes it uppercase, as keywords are. + - `stress_period_data={0: [("STEADY-STATE",)]}` is now + `stress_period_data={0: "steady-state"}`. + - flopy3's `steady_state=` / `transient=` (#503) convert to this form + (`flopy4.mf6.legacy.sto_period_data`). +2. **`stress_period_data` naming: done upstream.** devtools #399 names + every fill-forward period list `stress_period_data` in the DFNs, as + codegen already named the attribute, so the generated classes didn't + change. What's left in codegen isn't about the DFN's name: the list is + the private `_stress_period_data`, aliased `stress_period_data`, for + `Package`'s DataFrame setter. flopy3's old names (`perioddata`, ...) + are #503's `_LEGACY_PERIOD_KWARGS`. + +G/A period arrays are sparse per-period dicts on `develop` +(`flopy4.mf6.period_arrays`), the same `{header: value}` shape as every +repeating block. + +## The block model + +These are the rules both directions follow, and the schema facts they +rest on. They were re-scanned 2026-10-19 over the modflow6 DFNs at +`2.0.0.dev3`: 368 blocks. + +> A block is an ordered set of fields. A body row whose first token is a +> tagged field's key belongs to that field. Every other row belongs to the +> block's untagged field, and there is at most one of those, last. + +- **Where a tagged key comes from:** + - the field's name; + - a record's or file record's keyword (`ts6`, `obs6`, `gwfhead`); + - a tagged list's item keyword (OC's `SAVE` / `PRINT`); + - a dynamic key, from the values of the field its `fk` names (G/A + `aux`, keyed by `auxiliary` names). +- **Where untagged fields occur:** 124 blocks have one and 244 none. + Simulation's `solutiongroup` is the only block where it isn't alone + (tagged `mxiter`, then the list). +- **Repetition within a block:** a field occurs once, or is a `List`, + tagged or untagged. +- **Repetition of a block:** a block with a header repeats. Its value is + `{header: body}`, the header read by its kind in the class's `headers`. + `fill_forward` is about meaning, not parsing: an absent period keeps + the previous one's values. + +| block | fill_forward | fields | components | +|---|---|---|---| +| period | yes | one untagged list | list-based stress packages | +| period | yes | tagged list | OC (`output`) | +| period | yes | tagged arrays + tagged `aux` list | G/A packages, `utl-spca` | +| period | yes | one untagged string | `*-sto` | +| time | no | one untagged array | `utl-tas` | +| solutiongroup | no | tagged integer + untagged list | `sim-nam` | +| continuous | no | one untagged list, record header | `utl-obs` | + +## Benchmarks + +- **Baseline:** recorded in [discussion + #55](https://github.com/modflowpy/pyphoenix-project/discussions/55#discussioncomment-18978194), + with the harness in `benchmarks/`. +- **Rerun after S2** (2026-10-21, against the merge base `c5c606eb`, basic + loader): + - load and write: no regression beyond noise; + - peak memory: within ±5% everywhere; + - cold start: the first load took 0.26 s against 0.21 s. That's the + stored DFNs the model needs plus building codegen's spec for + `attr_names` (see "Later"). +- **Phase C:** the typed loader's numbers are in `loader-comparison.md`. + +## devtools follow-ups + +- **Extend `Block._check_field_order` to untagged fields of any type** + (at most one per block, and last), so the converter can rely on it. +- **Make `_leading_tags` / `_is_dynamic_key` public** (a `Field.tags` + property, say). flopy4 wraps them in `spec.py` until then. + +## Later + +Each is its own change. + +- **Deleting a loader**, if decided (see `loader-comparison.md`). Deleting the basic loader + takes the stored DFNs with it, once egress reads the classes' fields. + The size at stake: + - typed: ~360 code lines, ~1,300 with grammar generation and templates, + plus 6,581 lines of generated grammars; + - basic: ~450 code lines. +- **Attribute names at sync time.** `spec.attr_names` builds codegen's + spec of each class on its first load, most of the cold-start gap + above. Sync could store the names, as it stores the DFNs. +- **An auxiliary variable named like a field:** the typed grammar parses + an aux named RECHARGE as the field. No corpus file does it. +- **A TAS time's array isn't recorded in `ArrayIO`** by either loader, so + its read options aren't kept on write. +- **`test060_gms_ets`** loads under neither loader. +- **Load errors don't name the file.** The typed loader's give a line and + column; the basic loader's give neither. +- **The basic loader is lenient where MF6 isn't.** A missing `END` reads + the next `BEGIN` as an unknown option, and a wrong-typed computed field + (`MAXBOUND two`) is ignored. +- **The typed loader's memory:** 1.8× basic's peak on + `test016_Keating_dev` and 1.7× on `test045_lake4ss_dev`. Worth looking + into before deleting the basic loader. +- **The writer's `field_type`** (`simplification-survey.md` #5): egress + knows each field's DFN type, so could pass it along. + +Out of scope: the index-domain / time-dimension sentinel discussion. + +## History + +The first draft's Phase 0 survey (load → write → reload over 239 corpus +models) found ten pre-existing issues. All were fixed on `develop` before +the refactor: +- ISO datetimes, float precision, model subdirectories, trailing tokens + and a single-name `AUXILIARY`; +- aux-named G/A period arrays (devtools #371); +- a repeated `TS6` (devtools #368); +- TAS-sourced period arrays (#413); +- ungenerated packages; +- quoted strings (#462). + +The Phase 0 harness is `test/mf6/test_mf6_io_roundtrip.py`. diff --git a/docs/dev/load-benchmarks.md b/docs/dev/load-benchmarks.md index f01b04314..7b18867b7 100644 --- a/docs/dev/load-benchmarks.md +++ b/docs/dev/load-benchmarks.md @@ -22,12 +22,14 @@ manifest. | level | flopy3 | flopy4 basic | flopy4 typed | suite | |---|---|---|---|---| -| full simulation load | `MFSimulation.load` | `Simulation.load` | **not possible yet** | `test_load.py` | +| full simulation load | `MFSimulation.load` | `Simulation.load` | `Simulation.load(..., loader="typed")` | `test_load.py` | | parse stage (parse + transform) | n/a | yes | yes | `test_parse.py` | -Typed parser output isn't wired into `structure.py`, so there's no full typed -load to time. The typed loader appears here at the parse stage only. It gets a -column in the first row once it's wired in. +When this baseline was taken, typed parser output wasn't wired into +`structure.py`, so the typed loader appeared at the parse stage only. It +now loads every component (`--loader typed`), and the load benchmarks run +it as `flopy4-typed`; the two loaders are compared in +[`loader-comparison.md`](loader-comparison.md). There are two benchmark modules, both opt-in pytest-benchmark modules under `benchmarks/` (`pixi run -e dev bench` runs both): @@ -327,7 +329,6 @@ directly. ## Not measured yet -- **A full typed load**, which doesn't exist yet (see above). - **The 74 excluded models.** flopy4 skips DISU, TS/OBS and other child files. Once it loads them, those models can join the corpus, but that changes the pinned set, so it needs a fresh baseline. diff --git a/docs/dev/loader-comparison.md b/docs/dev/loader-comparison.md new file mode 100644 index 000000000..6605b2eef --- /dev/null +++ b/docs/dev/loader-comparison.md @@ -0,0 +1,158 @@ +# flopy4's two loaders, compared + +Phase C of the [converter simplification plan](converter-simplification-plan.md): +the basic loader (Track A: one generic grammar, block structure read from +the stored DFNs at runtime) against the typed loader (Track B: a grammar +generated per component, values read by the classes' fields alone). Both +stay, with `loader="basic" | "typed"` (the tests' `--loader`) choosing +between them; deleting one is a separate decision. + +Measured 2026-10-21 at `721503fe`, on an Apple M2 Max (macOS, CPython +3.11.16), standard benchmark tier (9 models, 15.1 MB of input). + +## Summary + +| | basic | typed | +|---|---|---| +| correctness (round-trip suite, load snapshots) | passes | passes but `test1001_Peterson`, a basic-loader bug | +| load + materialize, all models | 0.254 s | 0.318 s (1.25×) | +| peak memory, load | — | 0.97–1.81× basic's; most models within 3%, two 1.7–1.8× | +| cold start, first load | 0.265 s | 0.32–0.33 s with the grammar cache warm, 0.62 s without | +| malformed files | lenient: loads most, warning or silently | strict: a missing `END` or wrong value type raises, with line and column | +| code only it needs | ~450 lines (~570 with the DFN accessor egress shares), plus 129 stored DFNs (1.4 MB) | ~1,300 lines with the grammar templates, plus 129 generated grammars (6,581 lines) | + +**Recommendation:** keep basic as the default and typed as the opt-in. +The basic loader is faster, smaller and lighter on memory; the typed +loader's advantages are stricter errors and no DFN at runtime, and the +first can be had in the basic loader for less (see "Errors"). Before +deciding to delete either, look into the typed loader's memory on +`test016_Keating_dev` and `test045_lake4ss_dev`, which wasn't investigated +here, and fix the error-reporting gaps both share. + +## Correctness + +Both pass the round-trip suite (load → write → load over the corpus) and +produce the same load snapshots, but one: under `--loader typed`, 257 of +258 load snapshots pass. `test1001_Peterson` differs in IMS's +`rclose_option`, a string written `50000.000`: the typed loader keeps the +word, the basic loader reads it as the number `50000.0`. The basic +loader's is the bug (its parse reads numbers before the converter knows +the field), and the snapshot pins it. `test060_gms_ets` loads under +neither. Rerun at `721503fe`: + + pixi run -e dev pytest test/mf6/test_mf6_io_roundtrip.py \ + test/mf6/test_mf6_load_all_models.py --loader typed + +## Load time and memory + +`pixi run -e dev bench -k load` and `pixi run -e dev bench-memory -k +test_load`, which now run `flopy4-typed` beside `flopy3` and `flopy4` +(`benchmarks/_ops.py`, `LOADS`); `benchmarks/report.py` has a "Loaders, +basic vs. typed" section. Times are the minimum of 3 rounds; memory is +peak heap (memray). Ratios are typed / basic. + +| benchmark | basic | typed | × | +|---|---:|---:|---:| +| load, all models | 0.205 s | 0.273 s | 1.33 | +| load + materialize, all models | 0.254 s | 0.318 s | 1.25 | + +| model | input MB | load+mat basic | typed | × | load memory, MiB | × | +|---|---:|---:|---:|---:|---:|---:| +| test001a_Tharmonic | 0.003 | 0.00309 | 0.00433 | 1.40 | 0.167 / 0.162 | 0.97 | +| test001a_Tharmonic_extlist | 0.003 | 0.00328 | 0.00464 | 1.42 | 0.077 / 0.096 | 1.26 | +| test028_sfr | 0.021 | 0.00994 | 0.0122 | 1.23 | 0.269 / 0.277 | 1.03 | +| test045_lake4ss_dev | 0.299 | 0.0100 | 0.0149 | 1.48 | 0.500 / 0.841 | 1.68 | +| test050_circle_island | 0.551 | 0.0584 | 0.0769 | 1.32 | 4.33 / 4.24 | 0.98 | +| test120_mv_dis-lgr | 0.735 | 0.0162 | 0.0243 | 1.50 | 1.17 / 1.43 | 1.22 | +| test033_wtdecay | 1.18 | 0.0121 | 0.0154 | 1.27 | 3.59 / 3.61 | 1.01 | +| test016_Keating_dev | 1.47 | 0.0265 | 0.0450 | 1.70 | 2.85 / 5.15 | 1.81 | +| test019_VilhelmsenGF | 10.8 | 0.110 | 0.117 | 1.06 | 36.2 / 36.3 | 1.00 | + +The typed loader is slower on every model, by 6% (the largest, where +reading array values dominates and both share the code) to 70%. Peak +memory is about the same where arrays dominate, and up to 1.8× where +they don't. Against flopy3, flopy4 stays ahead with either loader: typed +load + materialize is 3.3× faster over the tier (basic, 4.2×). + +## Cold start + +A fresh interpreter importing flopy4, then loading and materializing +`test050_circle_island` (`benchmarks/_worker.py cold`), three alternating +runs each. The import is the same for both (~0.8 s); the first load: + +| | first load | +|---|---:| +| basic | 0.265–0.268 s | +| typed, grammar cache warm (the usual case) | 0.321–0.332 s | +| typed, no cache (`FLOPY4_CACHE_DIR=`) | 0.617–0.635 s | + +The basic loader's first load includes loading the 10 DFNs this +simulation needs and building codegen's spec of each class for +`attr_names`; the typed loader's, reading (or building) a parser per +component. With no cache, the typed loader builds each grammar, which +happens once per machine and lark/Python version. In the benchmark run's +`test_cold_start` (wall time, five rounds), flopy3 took 1.04 s, flopy4 +1.16 s basic and 1.24 s typed. + +## Errors + +Seven malformed copies of `test001a_Tharmonic`, one fault each, loaded +with both loaders: + +| fault | basic | typed | +|---|---|---| +| missing `END OPTIONS` (CHD) | loads; warns "no field takes OPTIONS entry BEGIN" | `UnexpectedToken` at the `MAXBOUND` line, line and column, the tokens expected | +| misspelled keyword (`PRINT_FLOWZ`) | loads; warns "no field takes OPTIONS entry PRINT_FLOWZ" | the same | +| wrong value type (`MAXBOUND two`) | loads silently | `UnexpectedToken` at `two`, line and column, expecting an integer | +| short list row (CHD, no head) | `ValueError: StressPeriodData: can't read a row from [1, 1, 10]` | the same | +| bad OPEN/CLOSE path (NPF `K`) | `FileNotFoundError` naming the path | the same | +| short array (IC `STRT`, 9 values for 10 cells) | loads silently | the same | +| unknown block (`DIMENSIONZ`) | loads; warns "ignoring unknown block" | the same | + +- The typed loader catches two faults the basic one doesn't, and says + where. The basic loader's missing `END` happens to load the right + values here; MF6 would stop. +- Neither loader's errors name the file. The typed loader's give a line + and column in a file the message doesn't name; the basic loader's give + neither. +- Both accept a short array. A `LAYERED` field with fewer values than a + layer has is filled by repeating them (`np.resize`, there to repeat a + record across layers when there are fewer records than layers); a + non-layered one keeps its 9 values for the 10 cells. +- The basic loader ignores a `MAXBOUND` it can't read because MAXBOUND is + computed; a wrong-typed value in a field it keeps would fail where the + converter casts it. + +The script that made these isn't checked in; each fault is a one-line +edit of the file named. The follow-ups are in the plan's "Later". + +## Code size + +Code lines (no blanks, comments or docstrings), from parse to component +kwargs. `structure.py`'s functions are split by what the typed loader +imports from it, directly or through what it calls. + +| | lines | +|---|---:| +| **basic only** | | +| `basic.lark` | 40 | +| basic transformer | 67 | +| `structure.py`: `_Load`, the array and row readers, block grouping | ~340 | +| DFN accessor in `spec.py` (also egress's; see below) | ~120 | +| stored DFNs, `flopy4/mf6/dfns` | 129 files, 1.4 MB | +| **typed only** | | +| `typed.lark` | 144 | +| grammar generation (`grammar/__init__.py`, `filters.py`, `names.py`, `dfn2lark.py`) | 260 | +| grammar templates (Jinja) | 335 | +| typed transformer | 298 | +| `ingress/typed.py` | 276 | +| generated grammars | 129 files, 6,581 lines (536 KB) | +| **shared** | | +| `structure.py`: `ComponentLoad`, bindings, array files, children | ~410 | +| `transformer/rows.py` | 97 | +| `parser.py` (both parsers, the typed parsers' disk cache) | 108 | + +Egress (S2) reads block structure through the DFN accessor too, so the +stored DFNs and the accessor stay while either egress or the basic +loader needs them. Deleting the basic loader would mean egress reading +the classes' fields instead (plan, Phase C). diff --git a/docs/examples/circle.ipynb b/docs/examples/circle.ipynb index 08dd77247..e6eaa808f 100644 --- a/docs/examples/circle.ipynb +++ b/docs/examples/circle.ipynb @@ -581,7 +581,7 @@ "sto = flopy4.mf6.gwf.Sto(\n", " ss=1.0e-5,\n", " sy=0.15,\n", - " stress_period_data={0: [(\"STEADY-STATE\",)]},\n", + " stress_period_data={0: \"steady-state\"},\n", " iconvert=0,\n", " dims=dims,\n", ")" diff --git a/docs/examples/circle.py b/docs/examples/circle.py index 824b887a6..ca0c06e1f 100644 --- a/docs/examples/circle.py +++ b/docs/examples/circle.py @@ -172,7 +172,7 @@ def plot_head_ugrid(head, cbc, workspace): sto = flopy4.mf6.gwf.Sto( ss=1.0e-5, sy=0.15, - stress_period_data={0: [("STEADY-STATE",)]}, + stress_period_data={0: "steady-state"}, iconvert=0, dims=dims, ) diff --git a/docs/examples/twri.ipynb b/docs/examples/twri.ipynb index 3f3f3ad40..514c7ef47 100644 --- a/docs/examples/twri.ipynb +++ b/docs/examples/twri.ipynb @@ -366,7 +366,7 @@ " storagecoefficient=False,\n", " ss=1.0e-5,\n", " sy=0.15,\n", - " stress_period_data={0: [(\"STEADY-STATE\",)]},\n", + " stress_period_data={0: \"steady-state\"},\n", " iconvert=0,\n", " dims=dims,\n", ")" diff --git a/docs/examples/twri.py b/docs/examples/twri.py index 7ac3295cf..57d99cc5b 100644 --- a/docs/examples/twri.py +++ b/docs/examples/twri.py @@ -129,7 +129,7 @@ def plot_head(head, workspace): storagecoefficient=False, ss=1.0e-5, sy=0.15, - stress_period_data={0: [("STEADY-STATE",)]}, + stress_period_data={0: "steady-state"}, iconvert=0, dims=dims, ) diff --git a/docs/migrating.md b/docs/migrating.md index 2c033b22a..f297d256f 100644 --- a/docs/migrating.md +++ b/docs/migrating.md @@ -31,14 +31,14 @@ you need to make anyway: flopy4's class names (`Sto`, not `flopy.mf6.ModflowGwfsto`), and its constructors taking the parent as a keyword (`parent=gwf`), not by position. -STO takes one entry per period, `STEADY-STATE` or `TRANSIENT`: +STO takes one word per period, `steady-state` or `transient`: ```python # flopy3 sto = flopy.mf6.ModflowGwfsto(gwf, steady_state={0: True}, transient={1: True}) # flopy4 -sto = Sto(parent=gwf, stress_period_data={0: [("STEADY-STATE",)], 1: [("TRANSIENT",)]}) +sto = Sto(parent=gwf, stress_period_data={0: "steady-state", 1: "transient"}) ``` OC takes each period's saves and prints in one list, each starting with diff --git a/flopy4/mf6/__init__.py b/flopy4/mf6/__init__.py index e713a8cfd..ca12a7b35 100644 --- a/flopy4/mf6/__init__.py +++ b/flopy4/mf6/__init__.py @@ -176,7 +176,7 @@ def _write_mf6(component: Component, context=None, **kwargs) -> None: # settle the arrays' and lists' files before opening (and emptying) # the component's, which a strict write may refuse - data = annotate_arrays(unstructure(component), ctx) + data = annotate_arrays(unstructure(component), type(component), ctx) where = (component.root, component.filename, component._name_or_class()) data = write_external_arrays(data, *where, ctx) data = write_external_lists(data, *where, ctx) diff --git a/flopy4/mf6/_sync.py b/flopy4/mf6/_sync.py index 082969b22..ab239a96b 100644 --- a/flopy4/mf6/_sync.py +++ b/flopy4/mf6/_sync.py @@ -22,7 +22,7 @@ _DFN_SCHEMA_VERSION = "2.0.0.dev3" _DEFAULT_REPO = "MODFLOW-ORG/modflow6" _CONTRACT = "_contract.py" -# Where syncs before the typed reader stopped needing DFNs stored them. +# The DFNs the classes were generated from, as TOML, for the converter. _DFNS = "dfns" # The typed reader's grammars, one per component, all generated. _GRAMMARS = "codec/reader/grammar/generated" @@ -285,6 +285,24 @@ def _check_writable(path: Path) -> None: ) +def _store_dfns(dfn_dir: Path, dest: Path) -> set[str]: + """Write the DFNs in ``dfn_dir`` to ``dest`` as TOML at the schema + version the classes are generated against: migrated from legacy + ``.dfn`` files, or copied if they're TOML already. Returns their + names.""" + dest.mkdir(parents=True) + if any(dfn_dir.glob("*.dfn")): + with warnings.catch_warnings(): + warnings.filterwarnings("ignore", message=".*modflow_devtools.dfns.*experimental.*") + from modflow_devtools.dfns.migrate import migrate + + migrate(dfn_dir, dest, _DFN_SCHEMA_VERSION, fmt="toml") + else: + for f in sorted(dfn_dir.glob("*.toml")): + shutil.copy2(f, dest / f.name) + return {f.name for f in dest.iterdir() if f.is_file()} + + def _make_grammars(dfns: dict, stage: Path) -> set[str]: """Generate the typed reader's grammar for every component into ``stage``, checking each one builds. Returns their paths, relative to @@ -454,7 +472,7 @@ def sync( """Regenerate the ``flopy4.mf6`` classes for an MF6 version. Fetches or reads the DFNs, regenerates the component classes and the - typed reader's grammars, and records the MF6 version in + typed reader's grammars, stores the DFNs as TOML, and records the MF6 version in ``_contract.py``. Generated modules and grammars the DFNs don't cover are removed. Nothing changes unless every generated module imports and every grammar builds. Warns of handwritten methods that read fields the @@ -533,6 +551,7 @@ def sync( raise SyncError(f"No .dfn or .toml files in {path}") registry = LocalDfnRegistry(path=path) source = str(path) + dfn_dir = path version = mf6_version or _local_mf6_version(path) commit = _local_commit(path) else: @@ -560,6 +579,7 @@ def sync( # pinned semver tag (first char is a digit). is_branch = not version[0].isdigit() _populate_remote_cache(registry, release_id, force=force or is_branch) + dfn_dir = registry.cache_path commit = _remote_commit(release_id) if version == "unknown": @@ -605,6 +625,7 @@ def sync( ) inits = make_package_inits(specs, outdir, stage=stage, verbose=verbose) generated = {p.relative_to(outdir).as_posix() for p in [s.outpath for s in specs] + inits} + dfn_files = {f"{_DFNS}/{f}" for f in _store_dfns(dfn_dir, stage / _DFNS)} old_dfn_files = ( {f"{_DFNS}/{f.name}" for f in (outdir / _DFNS).iterdir() if f.is_file()} if (outdir / _DFNS).is_dir() @@ -639,11 +660,9 @@ def sync( _swap( stage, outdir, - replace=[*sorted(generated), *sorted(grammars), _CONTRACT], - remove=sorted(removed | old_dfn_files | (old_grammars - grammars)), + replace=[*sorted(generated), *sorted(dfn_files), *sorted(grammars), _CONTRACT], + remove=sorted(removed | (old_dfn_files - dfn_files) | (old_grammars - grammars)), ) - if (outdir / _DFNS).is_dir() and not any((outdir / _DFNS).iterdir()): - (outdir / _DFNS).rmdir() finally: shutil.rmtree(stage, ignore_errors=True) diff --git a/flopy4/mf6/chf/cdb.py b/flopy4/mf6/chf/cdb.py index caa6e92d6..4deff5900 100644 --- a/flopy4/mf6/chf/cdb.py +++ b/flopy4/mf6/chf/cdb.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, integer, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, integer, keyword, list_, string from flopy4.mf6.utl.obs import Obs @@ -19,6 +19,10 @@ class Cdb(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "cdb": (("cellid",), ("string",)), "to-mvr": (("cellid",), ("string",)), diff --git a/flopy4/mf6/chf/chd.py b/flopy4/mf6/chf/chd.py index 1dc2ae8ce..7d767bbe9 100644 --- a/flopy4/mf6/chf/chd.py +++ b/flopy4/mf6/chf/chd.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Chd(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "chd": (("cellid",), ("string",)), } diff --git a/flopy4/mf6/chf/evp.py b/flopy4/mf6/chf/evp.py index 93e58831c..d818836f6 100644 --- a/flopy4/mf6/chf/evp.py +++ b/flopy4/mf6/chf/evp.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Evp(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "evp": (("cellid",), ("string",)), } diff --git a/flopy4/mf6/chf/flw.py b/flopy4/mf6/chf/flw.py index 886bab8b3..068f30653 100644 --- a/flopy4/mf6/chf/flw.py +++ b/flopy4/mf6/chf/flw.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Flw(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "flw": (("cellid",), ("string",)), "to-mvr": (("cellid",), ("string",)), diff --git a/flopy4/mf6/chf/oc.py b/flopy4/mf6/chf/oc.py index 59b23ad49..e03e88a99 100644 --- a/flopy4/mf6/chf/oc.py +++ b/flopy4/mf6/chf/oc.py @@ -8,7 +8,7 @@ from flopy4.mf6.legacy import Legacy, oc_period_data from flopy4.mf6.package import Package from flopy4.mf6.record import Record -from flopy4.mf6.spec import array, file, integer, list_, record, string, union +from flopy4.mf6.spec import Header, array, file, integer, list_, record, string, union @attrs.define(kw_only=True, slots=False) @@ -16,6 +16,10 @@ class Oc(Package): dfn_name: ClassVar[str] = "chf-oc" ftype: ClassVar[str] = "OC6" + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + legacy_kwargs: ClassVar[dict[str, Legacy]] = { "saverecord": Legacy("stress_period_data", oc_period_data), "printrecord": Legacy("stress_period_data", oc_period_data), diff --git a/flopy4/mf6/chf/pcp.py b/flopy4/mf6/chf/pcp.py index ed1cbbc97..4af44aba8 100644 --- a/flopy4/mf6/chf/pcp.py +++ b/flopy4/mf6/chf/pcp.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Pcp(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "pcp": (("cellid",), ("string",)), } diff --git a/flopy4/mf6/chf/sto.py b/flopy4/mf6/chf/sto.py index f51036a96..5329e0620 100644 --- a/flopy4/mf6/chf/sto.py +++ b/flopy4/mf6/chf/sto.py @@ -1,12 +1,11 @@ # autogenerated file, do not modify -from typing import ClassVar, Optional +from typing import ClassVar, Literal, Optional import attrs -from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy, sto_period_data from flopy4.mf6.package import Package -from flopy4.mf6.spec import keyword, list_, string +from flopy4.mf6.spec import Header, keyword, string @attrs.define(kw_only=True, slots=False) @@ -14,15 +13,15 @@ class Sto(Package): dfn_name: ClassVar[str] = "chf-sto" ftype: ClassVar[str] = "STO6" + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + legacy_kwargs: ClassVar[dict[str, Legacy]] = { "steady_state": Legacy("stress_period_data", sto_period_data), "transient": Legacy("stress_period_data", sto_period_data), } - @attrs.define - class StressPeriodData(Item): - stress_period_data: str = string() - save_flows: bool = keyword( default=False, block="options", @@ -35,13 +34,9 @@ class StressPeriodData(Item): optional=True, longname="export array variables to layered ascii files.", ) - _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( - alias="stress_period_data", + stress_period_data: Optional[dict[int, Literal["steady-state", "transient"]]] = string( default=None, - repr=False, block="period", fill_forward=True, + valid=("steady-state", "transient"), ) - - -StoStressPeriodData = Sto.StressPeriodData diff --git a/flopy4/mf6/chf/zdg.py b/flopy4/mf6/chf/zdg.py index 66d59fc9f..aa814a3fb 100644 --- a/flopy4/mf6/chf/zdg.py +++ b/flopy4/mf6/chf/zdg.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, integer, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, integer, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Zdg(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "to-mvr": (("cellid",), ("string",)), "zdg": (("cellid",), ("string",)), diff --git a/flopy4/mf6/component.py b/flopy4/mf6/component.py index b87a01524..dbf0a7cf4 100644 --- a/flopy4/mf6/component.py +++ b/flopy4/mf6/component.py @@ -13,7 +13,7 @@ from flopy4.mf6.constants import MF6 from flopy4.mf6.external import in_write_session, write_session from flopy4.mf6.legacy import Legacy, LegacyKwargs -from flopy4.mf6.spec import fields_dict +from flopy4.mf6.spec import Header, fields_dict from flopy4.mf6.write_context import WriteContext from flopy4.spec import is_reference, reference_names, referenced, resolve, retarget from flopy4.uio import IO, Loader, Writer @@ -254,6 +254,9 @@ class Component(DimensionResolverMixin, ABC, MutableMapping, metaclass=LegacyKwa """The token naming the component's file type in name files (e.g. 'GWF6', 'CHD6', 'GWF6-GWT6'), from its DFN. Array-based variants share their base's ('Chdg' is 'CHD6'). Empty for the simulation.""" + headers: ClassVar[dict[str, Header]] = {} + """The header of each of the component's repeating blocks, by block + name, set by codegen from the DFN (see `Header`).""" _load = IO(Loader) # type: ignore _write = IO(Writer) # type: ignore diff --git a/flopy4/mf6/converter/egress/unstructure.py b/flopy4/mf6/converter/egress/unstructure.py index b0e519bab..663f8ec54 100644 --- a/flopy4/mf6/converter/egress/unstructure.py +++ b/flopy4/mf6/converter/egress/unstructure.py @@ -1,6 +1,5 @@ -from collections.abc import Iterable, Mapping -from datetime import datetime -from functools import cache, partial +from collections.abc import Mapping +from functools import cached_property, partial from pathlib import Path from typing import Any @@ -10,25 +9,19 @@ from modflow_devtools.dfns import dim_value from flopy4._imports import isinstance_of -from flopy4.attrs_xarray import child_field_candidates from flopy4.mf6._types import TimeArraySeriesRef from flopy4.mf6.block import block_list_type from flopy4.mf6.component import Component, WorkspaceComponent from flopy4.mf6.constants import FILL_DNODATA from flopy4.mf6.converter.binding import write_row +from flopy4.mf6.converter.ingress.structure import _init_key, _per_header from flopy4.mf6.dims_provider_methods import DimsProviderMethods -from flopy4.mf6.item import ( - Item, - conditional_fields, - dim_lookup, - item_list_type, - sized_by, -) +from flopy4.mf6.item import Item, conditional_fields, dim_lookup, item_list_type, sized_by from flopy4.mf6.item_table import ItemTable, Rows from flopy4.mf6.package import Package from flopy4.mf6.period_arrays import is_cleared, is_grid_package from flopy4.mf6.record import Record, record_type -from flopy4.mf6.spec import FileDirection, block_sort_key, blocks_dict, to_field_type +from flopy4.mf6.spec import FileDirection, attr_names, binding_fields, block_keys, dfn from flopy4.mf6.write_context import WriteContext from flopy4.spec import is_array @@ -54,51 +47,6 @@ def _child_path(child: Component) -> Path: return Path(path.name) if path.is_absolute() else path -def _put_child_file_records(block: dict, field: attrs.Attribute, value: Any) -> None: - """File records naming children: NCF6 FILEIN .""" - children = value if isinstance(value, list) else [value] - rows = [_path_to_tuple(field, _child_path(c)) for c in children if c is not None] - if rows and isinstance(value, list): - block[field.name] = rows - elif rows: - block[rows[0][0].lower()] = rows[0] - - -def _make_binding_blocks(value: Component) -> dict[str, dict[str, list[tuple[str, ...]]]]: - if not isinstance(value, WorkspaceComponent): - return {} - - blocks = {} # type: ignore - - for f in attrs.fields(type(value)): # type: ignore[arg-type] - # a child() field; a record option is a field like any other - if not f.metadata.get("child") or child_field_candidates(f) is None: - continue - child_name = f.name - if (child := getattr(value, child_name, None)) is None: - continue - block_name = f.metadata.get("block") - if block_name is None: - continue - if block_name not in blocks: - blocks[block_name] = {} - if f.metadata.get("_keyword"): - _put_child_file_records(blocks[block_name], f, child) - continue - columns = f.metadata["row"] - match child: - case Component(): - blocks[block_name][child_name] = [write_row(child, columns)] - case Iterable(): - rows = [write_row(c, columns) for c in child if c is not None] - if rows: - blocks[block_name][child_name] = rows - case _: - raise ValueError(f"Unexpected child type: {type(child)}") - - return blocks - - def _grid_dims(value: Package) -> tuple[int, tuple[int, ...]]: """(nlay, layer shape) of the package's grid: a layer is (nrow, ncol) on a structured grid, else (ncpl,). Empty if the grid isn't known. A grid @@ -246,198 +194,24 @@ def _normalize_kper(kper: Any) -> int | None: return None -def _unstructure_package(value: Package) -> dict[str, Any]: - """Unstructure a package into a dict.""" - cls = type(value) - blocks: dict[str, dict[str, Any]] = {} - write_if_empty_set: set[str] = set() - spd_period: dict[int, Rows] = {} - readarray_period: dict[int, dict[str, Any]] = {} - # per period, the (non-aux) array fields given, and those all DNODATA - stress_period: dict[int, set[str]] = {} - nodata_period: dict[int, set[str]] = {} - # resolved once, if an array's written - grid_dims = cache(lambda: _grid_dims(value)) - ncelldim = _ncelldim(value) - grid = is_grid_package(cls) - fill_forward_block: str | None = None - - for f in attrs.fields(cls): # type: ignore[arg-type] - meta = f.metadata - block_name = meta.get("block") - if not block_name: - continue - - if meta.get("write_if_empty"): - write_if_empty_set.add(block_name) - blocks.setdefault(block_name, {}) - - attr_name = f.alias if (f.alias and f.name.startswith("_")) else f.name - field_value = getattr(value, attr_name, None) - if field_value is None: - continue - - dfn_type = to_field_type(f.type) - - # fill-forward block - if meta.get("fill_forward"): - fill_forward_block = block_name - # dynamically named arrays (RCHA's aux): {kper: {name: array}}, each - # written under its name - if meta.get("fk"): - for kper, arrays in field_value.items(): - for name, arr in arrays.items(): - readarray_period.setdefault(kper, {})[name] = _period_dataarray( - name, arr, meta, *grid_dims() - ) - continue - # arrays: {kper: array} - if item_list_type(f.type) is None: - for kper, arr in field_value.items(): - # a cleared grid period's array is None, filled below - readarray_period.setdefault(kper, {})[f.name] = ( - None if arr is None else _period_dataarray(f.name, arr, meta, *grid_dims()) - ) - if grid and is_cleared(arr): - nodata_period.setdefault(kper, set()).add(f.name) - stress_period.setdefault(kper, set()).add(f.name) - continue - # list: dict[int, list[Item]] - if not isinstance(field_value, dict): - continue - list_kwargs = _list_kwargs(value, attr_name, f) - for kper, row_list in field_value.items(): - kper_int = _normalize_kper(kper) - if kper_int is None: - continue - rows = spd_period.setdefault(kper_int, Rows(ncelldim, **list_kwargs)) - if isinstance(row_list, (list, ItemTable)): - rows.append(row_list) - continue - - # blocks repeating under a record header (OBS's CONTINUOUS), one per - # header: list[Block] - if (block_cls := block_list_type(f.type)) is not None: - _, list_name, _ = block_cls.parts() - for block in field_value: - key = " ".join([block_name, *map(str, block.header_tokens())]) - blocks[key] = {list_name: _rows(getattr(block, list_name), ncelldim)} - continue - - if isinstance(field_value, dict): - # arrays keyed by time (a TAS's), a layer each - array_key = f.name if meta.get("tagged") else "" - for tval, arr in field_value.items(): - arr = arr if hasattr(arr, "shape") or isinstance(arr, str) else np.asarray(arr) - blocks[f"{block_name} {tval}"] = {array_key: _grid_shaped(arr, meta, *grid_dims())} - continue - - # non-fill-forward block - if block_name not in blocks: - blocks[block_name] = {} - - if dfn_type == "keyword": - if field_value: - blocks[block_name][f.name] = field_value - - elif isinstance(field_value, list) and field_value and isinstance(field_value[0], Path): - # A list of file records (DFN tagged list): one line each. - blocks[block_name][f.name] = [_path_to_tuple(f, v) for v in field_value] - - elif meta.get("direction") and isinstance(field_value, Path): - t = _path_to_tuple(f, field_value) - blocks[block_name][t[0].lower()] = t - - elif meta.get("child") and meta.get("_keyword"): - _put_child_file_records(blocks[block_name], f, field_value) - - elif ( - isinstance(field_value, (list, ItemTable)) - and field_value - and isinstance(field_value[0], Item) - ): - blocks[block_name][f.name] = _rows( - field_value, ncelldim, **_list_kwargs(value, attr_name, f) - ) - - elif isinstance(field_value, list) and field_value and isinstance(field_value[0], tuple): - blocks[block_name][f.name] = field_value - - elif is_array(f) and meta.get("shape") and not isinstance(field_value, bool): - # a grid array; an inline one has no shape (AUXILIARY's names) - if meta.get("index"): - field_value = _to_file_index(field_value) - # a grid package's arrays are shaped like its grid; others' (NPF's - # K) stay as given, non-layered, which MF6 reads in one go - dims = grid_dims() if isinstance(value, DimsProviderMethods) else (1, ()) - blocks[block_name][f.name] = _mark_netcdf(_grid_shaped(field_value, meta, *dims), meta) - - elif isinstance(field_value, np.ndarray) and field_value.dtype.kind == "U": - # An inline string array (AUXILIARY's names): one line. - if field_value.size: - blocks[block_name][f.name] = (f.name.upper(), *map(str, field_value)) - - elif isinstance(field_value, Record): - blocks[block_name][f.name] = field_value.to_tokens() - - elif (rec := record_type(f.type)) is not None: - raise _not_a_record(value, f.name, rec, field_value) - - elif dfn_type in ("integer", "double", "double precision"): - blocks[block_name][f.name] = field_value - - elif dfn_type == "string" and field_value: - blocks[block_name][f.name] = field_value - - # `maxbound` is a computed property on some classes, not a real field - if isinstance(getattr(cls, "maxbound", None), property): - maxbound = value.maxbound # type: ignore[attr-defined] - if maxbound: - blocks.setdefault("dimensions", {})["maxbound"] = maxbound - - # sort filled blocks by label - if fill_forward_block is not None: - for kper in sorted(spd_period.keys()): - key = f"{fill_forward_block} {kper + 1}" - blocks[key] = {fill_forward_block: spd_period[kper]} - - # One block per period any array is given in. A grid package's - # period whose stress arrays are all DNODATA clears every boundary: - # an empty block. - for kper in sorted(readarray_period.keys()): - key = f"{fill_forward_block} {kper + 1}" - if grid and stress_period.get(kper) and nodata_period.get(kper) == stress_period[kper]: - blocks[key] = {} - write_if_empty_set.add(key) - else: - arrays = readarray_period[kper] - like = next(a for a in arrays.values() if a is not None) - blocks[key] = { - n: xr.full_like(like, FILL_DNODATA, dtype=np.float64) if a is None else a - for n, a in arrays.items() - } - - return { - name: block - for name, block in sorted(blocks.items(), key=block_sort_key) - if block or name in write_if_empty_set - } - - -def annotate_arrays(data: dict[str, Any], context: WriteContext) -> dict[str, Any]: +def annotate_arrays( + data: dict[str, Any], cls: type[Component], context: WriteContext +) -> dict[str, Any]: """Copy each array's settings from `context.arrays` (see `ArrayKey`) onto the DataArray `data` holds for it, as attrs the writer reads: `iprn`, and `layer_iprn` for layers of a layered array whose IPRN differs from the whole array's; `path`, `format`, `hash` and `layered`, and `layer_path`, `layer_format` and `layer_hash` for layers given their - own (see `write_external_arrays` and `array_how`). A period block's - arrays are keyed by period.""" + own (see `write_external_arrays` and `array_how`). A block whose + header is an index (a period's IPER, see `cls.headers`) has its + arrays keyed by it, 0-based.""" if not context.arrays: return data out: dict[str, Any] = {} for block_name, block in data.items(): name, _, header = block_name.partition(" ") - kper = int(header) - 1 if name == "period" and header.isdigit() else None + kind = cls.headers.get(name) + kper = int(header) - 1 if kind is not None and kind.index and header.isdigit() else None if not isinstance(block, dict): out[block_name] = block continue @@ -481,74 +255,236 @@ def _not_a_record(component: Component, name: str, rec: type[Record], value: Any def unstructure_component(value: Component) -> dict[str, Any]: - # TODO unify _unstructure_package/_unstructure_component into one path - if isinstance(value, Package): - return _unstructure_package(value) - return _unstructure_component(value) - - -def _unstructure_component(value: Component) -> dict[str, Any]: - """Unstructure an internal-node component (Gwf, Simulation, etc.) with - attrs-typed child fields, including its child binding blocks.""" - blockspec = blocks_dict(type(value)) - blocks: dict[str, dict[str, Any]] = {} - fields_by_name = {f.name: f for f in attrs.fields(type(value))} # type: ignore[arg-type] - - # create child component binding blocks - blocks.update(_make_binding_blocks(value)) - - for block_name, block in blockspec.items(): - if block_name not in blocks: - blocks[block_name] = {} - - for field_name in block.keys(): - # Skip child components already processed as bindings - field = fields_by_name.get(field_name) - if ( - isinstance(value, WorkspaceComponent) - and field is not None - and field.metadata.get("child") - and child_field_candidates(field) is not None - and field.metadata.get("block") == block_name + """A component as the writer takes it, ``{block: {field: value}}`` + (see `_Unstructure`).""" + return _Unstructure(value).blocks() + + +class _Unstructure: + """One component's blocks for the writer, the inverse of the loader's + `_Load`: its DFN's blocks, in order, each field keyed by its DFN name + and taken from the class's attribute holding it (see `attr_names`), or + from a property computing it (a list package's MAXBOUND). A repeating + block is written once per header (see `occurrences`), and the rows + naming children (a model's packages, the simulation's models and + solutions) are made from them (see `bindings`). A block with nothing + to write is left out, unless codegen marked it `write_if_empty` or + it's a name file's.""" + + def __init__(self, value: Component) -> None: + self.value = value + self.cls = type(value) + self._fields = attrs.fields_dict(self.cls) # type: ignore[arg-type] + self._names = attr_names(self.cls) + self.grid = is_grid_package(self.cls) + # blocks whose rows name children + self.binding_blocks = binding_fields(self.cls) + + @cached_property + def ncelldim(self) -> int | None: + return _ncelldim(self.value) if isinstance(self.value, Package) else None + + @cached_property + def grid_dims(self) -> tuple[int, tuple[int, ...]]: + return _grid_dims(self.value) # type: ignore[arg-type] + + def blocks(self) -> dict[str, dict[str, Any]]: + out: dict[str, dict[str, Any]] = {} + keep: set[str] = set() + for name, block in (dfn(self.cls).blocks or {}).items(): + if isinstance(self.value, WorkspaceComponent) or any( + f.metadata.get("write_if_empty") + for f in self._fields.values() + if f.metadata.get("block") == name ): - continue + keep.add(name) + if block.header is None: + out[name] = self.body(name, block) + else: + for header, (body, empty) in self.occurrences(name, block).items(): + out[f"{name} {header}"] = body + if empty: + keep.add(f"{name} {header}") + return {name: body for name, body in out.items() if body or name in keep} + + def attribute(self, block: str, f: Any) -> "attrs.Attribute | None": + """The class's field holding the DFN field `f` of `block`, if any.""" + return self._fields.get(self._names.get((block, f.name), "")) + + def get(self, block: str, f: Any) -> "tuple[attrs.Attribute | None, Any]": + """The DFN field `f`'s attribute and value: a private field's by + its alias (``stress_period_data``), a computed one's (a list + package's MAXBOUND) by its property, with no attribute.""" + if (a := self.attribute(block, f)) is not None: + return a, getattr(self.value, _init_key(a), None) + if isinstance(getattr(self.cls, f.name, None), property): + # a MAXBOUND of 0 (no rows) isn't written + return None, getattr(self.value, f.name) or None + return None, None + + def body(self, name: str, block: Any) -> dict[str, Any]: + """A block that doesn't repeat, by DFN field.""" + values = {f.name: self.value_of(name, f) for f in block.fields.values()} + return {k: v for k, v in values.items() if v is not None} + + def value_of(self, name: str, f: Any) -> Any: + """The DFN field `f` of the block `name` as the writer takes it, + or None to leave it out: a binding block's untagged field is its + rows naming children.""" + if name in self.binding_blocks and f is block_keys(self.cls, name).untagged: + return self.bindings(name) + a, value = self.get(name, f) + return None if value is None else self.field(f, a, value) + + def field(self, f: Any, a: "attrs.Attribute | None", value: Any) -> Any: + """The DFN field `f`'s value as the writer takes it, by the type + of the attribute `a` holding it (or of `f`, for a computed one), or + None to leave it out.""" + meta = a.metadata if a is not None else {} + if meta.get("child"): + # a child's file record: OBS6 FILEIN + assert a is not None + if isinstance(value, list): + return [_path_to_tuple(a, _child_path(c)) for c in value if c is not None] or None + return _path_to_tuple(a, _child_path(value)) + match meta.get("type", f.type): + case "keyword": + return value or None + case "integer" | "double": + return value + case "string": + return value or None + case "file" if isinstance(value, list): + # a DFN tagged list of file records: one line each + assert a is not None + return [_path_to_tuple(a, v) for v in value] or None + case "file": + assert a is not None + return _path_to_tuple(a, value) + case "record": + if not isinstance(value, Record): + rec = record_type(a.type) if a is not None else None + raise _not_a_record(self.value, a.name if a else f.name, rec or Record, value) + return value.to_tokens() + case "array" if meta.get("shape"): + # a grid array; a grid package's are shaped like its grid, + # others' (NPF's K) stay as given, non-layered, which MF6 + # reads in one go + if meta.get("index"): + value = _to_file_index(value) + dims = self.grid_dims if isinstance(self.value, DimsProviderMethods) else (1, ()) + return _mark_netcdf(_grid_shaped(value, meta, *dims), meta) + case "array": + # inline (AUXILIARY's names): one line + return (f.name.upper(), *map(str, value)) if len(value) else None + case "list" if not value: + return None + case "list" if isinstance(value[0], tuple): + return value + case "list": + assert a is not None + return _rows(value, self.ncelldim, **self.list_kwargs(a)) + return None - raw_value = getattr(value, field_name, None) - if raw_value is None: + def bindings(self, name: str) -> list[tuple[str, ...]] | None: + """The rows naming the children of the block `name` (``GWF6 + ``), in field order: the inverse of + `_resolve_bindings`.""" + rows = [] + for f, *_ in self.binding_blocks.get(name, ()): + child = getattr(self.value, f.name, None) + children = child if isinstance(child, list) else [child] + rows += [write_row(c, f.metadata["row"]) for c in children if c is not None] + return rows or None + + def list_kwargs(self, a: attrs.Attribute) -> dict[str, Any]: + """A list field's `Rows` arguments, for writing it to a file.""" + return _list_kwargs(self.value, _init_key(a), a) # type: ignore[arg-type] + + def occurrences(self, name: str, block: Any) -> dict[str, tuple[dict[str, Any], bool]]: + """A repeating block's occurrences by header as written (a period's + 1-based number), each its fields and whether it's written even if + empty (a grid package's period clearing every boundary). A field + holding one value, not one per header (the simulation's MXITER), + is the first occurrence's (``SOLUTIONGROUP 1``). A period's + cleared grid array (None) is written as DNODATA.""" + header = self.cls.headers[name] + numbered = header.kind != "record" + found: dict[Any, dict[str, Any]] = {} + # per period, the (non-aux) arrays given, and those all DNODATA + given: dict[Any, set[str]] = {} + cleared: dict[Any, set[str]] = {} + for f in block.fields.values(): + a, value = self.get(name, f) + if a is None or not _per_header(a): + if (value := self.value_of(name, f)) is not None: + found.setdefault(1, {})[f.name] = value continue - # a private field's file name is its alias (Gwf's _list: LIST), a - # renamed keyword's is its name without the underscore (continue_) - key = field.alias if field is not None and field_name.startswith("_") else field_name - key = key.removesuffix("_") - if isinstance(raw_value, Record): - blocks[block_name][key] = raw_value.to_tokens() + if value is None: + continue + meta = a.metadata + if (blocks := block_list_type(a.type)) is not None: + # OBS's CONTINUOUS FILEOUT : list[Block] + _, list_name, _ = blocks.parts() + for b in value: + header_tokens = " ".join(map(str, b.header_tokens())) + found.setdefault(header_tokens, {})[f.name] = _rows( + getattr(b, list_name), self.ncelldim + ) + elif meta.get("fk"): + # dynamically named arrays (RCHA's aux): {kper: {name: array}}, + # each written under its name + for kper, arrays in value.items(): + for aux, arr in arrays.items(): + found.setdefault(kper, {})[aux] = _period_dataarray( + aux, arr, meta, *self.grid_dims + ) + elif is_array(a) and meta.get("fill_forward"): + for kper, arr in value.items(): + found.setdefault(kper, {})[f.name] = ( + None + if arr is None + else _period_dataarray(f.name, arr, meta, *self.grid_dims) + ) + if self.grid and is_cleared(arr): + cleared.setdefault(kper, set()).add(f.name) + given.setdefault(kper, set()).add(f.name) + elif is_array(a): + # TAS times: {time: array}, a layer each + key = f.name if f.tagged else "" + for time, arr in value.items(): + arr = arr if hasattr(arr, "shape") or isinstance(arr, str) else np.asarray(arr) + found.setdefault(time, {})[key] = _grid_shaped(arr, meta, *self.grid_dims) + elif meta.get("type") == "string": + # a word per period (STO's steady-state or transient), untagged, + # written uppercase as keywords are + for kper, word in value.items(): + found.setdefault(kper, {})[""] = word.upper() + else: + # a list per period: {kper: list[Item]} + list_kwargs = self.list_kwargs(a) + for kper, row_list in value.items(): + if (kper := _normalize_kper(kper)) is None: + continue + rows = found.setdefault(kper, {}).setdefault( + f.name, Rows(self.ncelldim, **list_kwargs) + ) + if isinstance(row_list, (list, ItemTable)): + rows.append(row_list) + + out: dict[str, tuple[dict[str, Any], bool]] = {} + for h in sorted(found) if numbered else found: + body = found[h] + label = h + 1 if header.index else h + if self.grid and given.get(h) and cleared.get(h) == given[h]: + # every stress array DNODATA clears every boundary: an empty block + out[str(label)] = ({}, True) continue - if field is not None and (rec := record_type(field.type)) is not None: - raise _not_a_record(value, field_name, rec, raw_value) - - # Dispatch on field value type - match field_value := raw_value: - case None: - continue - case bool(): - if field_value: - blocks[block_name][key] = field_value - case Path(): - assert field is not None # field_name comes from blocks_dict(type(value)) - t = _path_to_tuple(field, field_value) - blocks[block_name][t[0]] = t - case datetime(): - blocks[block_name][key] = field_value.isoformat() - case _: - blocks[block_name][key] = field_value - - blocks = dict(sorted(blocks.items(), key=block_sort_key)) - - # total temporary hack! manually set solutiongroup 1. - # TODO still need to support multiple.. - if "solutiongroup" in blocks: - sg = blocks["solutiongroup"] - blocks["solutiongroup 1"] = sg - del blocks["solutiongroup"] - - return {name: block for name, block in blocks.items()} + if any(v is None for v in body.values()): + like = next(v for v in body.values() if v is not None) + body = { + k: xr.full_like(like, FILL_DNODATA, dtype=np.float64) if v is None else v + for k, v in body.items() + } + out[str(label)] = (body, False) + return out diff --git a/flopy4/mf6/converter/ingress/structure.py b/flopy4/mf6/converter/ingress/structure.py index d16183a07..c4daf2003 100644 --- a/flopy4/mf6/converter/ingress/structure.py +++ b/flopy4/mf6/converter/ingress/structure.py @@ -1,6 +1,5 @@ import warnings from abc import ABC -from collections import Counter from collections.abc import Callable, Mapping from pathlib import Path from typing import Any, cast, get_args, get_origin @@ -20,7 +19,7 @@ parts, without_comments, ) -from flopy4.mf6.component import Component, get_ftype +from flopy4.mf6.component import Component, get_ftypes from flopy4.mf6.converter.binding import read_row from flopy4.mf6.external import read_array_file, read_binary_list_file, read_list_file from flopy4.mf6.item import ( @@ -40,7 +39,15 @@ from flopy4.mf6.package import Package from flopy4.mf6.period_arrays import is_grid_package from flopy4.mf6.record import Record -from flopy4.mf6.spec import repeating_array_key_type, to_field_type +from flopy4.mf6.spec import ( + BlockKeys, + attr_names, + binding_fields, + block_keys, + dfn, + following_tags, + to_field_type, +) from flopy4.mf6.write_context import ArrayIO, ListIO, WriteContext, array_hash, list_hash from flopy4.spec import is_array, referenced from flopy4.utils import fortran_float, from_text, unwrap_optional @@ -59,6 +66,33 @@ def _inner_class_type(field_type) -> type[Record] | None: return None +def _tagged_value(f: Any, row: list) -> Any: + """The value of the tagged field `f` from its row, which begins with + its key: a record's, from all its tokens; a keyword's, True; an + inline array's (AUXILIARY's names), the rest of the row; a scalar's, + the token after the key. MF6 ignores anything after what the field + takes (often an inline comment, or a second value like IMS's + `UNDER_RELAXATION NONE DBD`).""" + # A Record-typed field must go through from_tokens(), even when the + # matched token is the field's own name rather than the record's + # trigger keyword. + if (inner_cls := _inner_class_type(f.type)) is not None: + return inner_cls.from_tokens(row) + t = unwrap_optional(f.type) + if t is bool: + return True + if get_origin(t) in (list, np.ndarray, npt.NDArray): + # even with one element; numpy >= 2.5's NDArray[X] has origin + # NDArray, not ndarray + args = get_args(t) + elem = args[-1] if get_origin(t) is not list else (args[0] if args else Any) + if get_origin(elem) is np.dtype: + elem = get_args(elem)[0] if get_args(elem) else Any + elem = {np.int64: int, np.float64: float, np.str_: str}.get(elem, elem) + return [from_text(v, elem) for v in row[1:]] + return from_text(row[1], t) + + def _parse_rows( rows: list, item_cls: "type[Item] | tuple[type[Item], ...]", @@ -119,7 +153,6 @@ def _read_open_close_values(vrow: list, context: LoadContext, dtype, length: int if not tokens: raise ValueError("OPEN/CLOSE control record missing a filename") path = context.resolve(_strip_quotes(tokens[0])) - binary = any(t.upper() in ("BINARY", "(BINARY)") for t in tokens[1:]) return read_array_file(path, dtype, length, binary=binary) @@ -222,6 +255,34 @@ def _leading_word(part) -> str: return str(part[0]).upper() +def _is_record(part) -> bool: + """Whether the part continues an array's name row: a control record, + or its values (a row of numbers).""" + if isinstance(part, NumberRows): + return True + return _leading_word(part) in _CONTROL_KINDS or bool(_numeric_prefix(part[:1])) + + +def _groups(parts: list) -> list[list]: + """A block's parts (see `parts`), each row with the records after it + (see `_is_record`): an array's name row with its control records and + values. Records before any row are a group of their own.""" + groups: list[list] = [] + for part in parts: + if not part: + continue + if groups and _is_record(part): + groups[-1].append(part) + else: + groups.append([part]) + return groups + + +def _rows_of(parts: list) -> list: + """Parts as rows, a `NumberRows`' each.""" + return [row for part in parts for row in (part if isinstance(part, NumberRows) else [part])] + + def _numeric_prefix(row: list) -> list: """Tokens from the start of `row` up to (not including) the first non-numeric one. Real INTERNAL/bare-data-row array data is purely @@ -243,25 +304,24 @@ def _numeric_prefix(row: list) -> list: return out -def _apply_factor(values: np.ndarray, vrow: list) -> np.ndarray: - """Scale `values` by the INTERNAL/OPEN-CLOSE control record's - ``FACTOR `` option, if `vrow` has one. MF6 reads an integer - array's FACTOR as an integer, so it's truncated to one here too.""" +def _factor(vrow: list, dtype) -> "int | float | None": + """The INTERNAL/OPEN-CLOSE control record's ``FACTOR `` option, if + `vrow` has one. MF6 reads an integer array's FACTOR as an integer, so + it's truncated to one here too.""" tokens = [str(t) for t in vrow[1:]] for j, tok in enumerate(tokens): if tok.upper() == "FACTOR" and j + 1 < len(tokens): factor = fortran_float(tokens[j + 1]) - if values.dtype == np.int64: - return values * int(factor) - return values * factor - return values + return int(factor) if dtype == np.int64 else factor + return None def _control_io(vrow: list, values: np.ndarray) -> ArrayIO: """How a control record wrote its array, to write it back the same way: its kind, as an `ArrayFormat`, and ``IPRN ``; an OPEN/CLOSE record's file, as written (relative to the simulation directory), and - the hash of the `values` read from it.""" + the hash of the `values` read from it, scaled by its FACTOR. The + FACTOR itself isn't kept: see `ArrayIO`.""" kind = _leading_word(vrow) if kind == "CONSTANT": return ArrayIO(format="constant") @@ -311,49 +371,52 @@ def _record_array_io( def _read_control_record( rows: list, i: int, context: LoadContext, dtype, length: int, name: str = "" -) -> "tuple[np.ndarray, int]": +) -> "tuple[np.ndarray, ArrayIO, int]": """Read one CONSTANT/INTERNAL/OPEN-CLOSE array control record starting - at ``rows[i]`` (a block's `parts`), shared by array blocks (`_parse_array_block`) and - READARRAY period (`_parse_readarray_period_block`) array ingress. - - Always returns a full ``length``-element ``ndarray`` (CONSTANT - broadcasts here rather than leaving that to the caller) plus the next - row index to resume from. INTERNAL's (and a bare, keyword-less data - row's) values commonly wrap across multiple physical lines for a large - array -- each is one row here -- so both keep consuming rows until - ``length`` values are collected, rather than assuming exactly one row. + at ``rows[i]`` (a block's `parts`), for `_read_array`. + + Returns a full ``length``-element ``ndarray`` (CONSTANT broadcasts + here rather than leaving that to the caller), scaled by its FACTOR; + how the record wrote it (see `_control_io`); and the next row index to + resume from. INTERNAL's (and a bare, keyword-less data row's) values + commonly wrap across multiple physical lines for a large array -- each + is one row here -- so both keep consuming rows until ``length`` values + are collected, rather than assuming exactly one row. Too few raises; ``name`` prefixes errors. """ vrow = rows[i] kind = _leading_word(vrow) if kind == "CONSTANT": v = from_text(vrow[1], int if dtype == np.int64 else float) - return np.full(length, v, dtype=dtype), i + 1 + return np.full(length, v, dtype=dtype), ArrayIO(format="constant"), i + 1 + factor = _factor(vrow, dtype) if kind == "OPEN/CLOSE": # read only the values the array needs; a file may hold more - return _apply_factor(_read_open_close_values(vrow, context, dtype, length), vrow), i + 1 - j = i + 1 if kind == "INTERNAL" else i - chunks: list[np.ndarray] = [] - count = 0 - while count < length and j < len(rows): - part = rows[j] - if isinstance(part, NumberRows): - text = without_comments(part.raw_text) - elif prefix := _numeric_prefix(part): - text = " ".join(map(str, prefix)) - else: - break - chunk = array_values(text, dtype, source=name) - chunks.append(chunk) - count += len(chunk) - j += 1 - if count < length: - source = f"{name}: " if name else "" - raise ValueError(f"{source}expected {length} values, got {count}") - array = np.concatenate(chunks)[:length] if chunks else np.array([], dtype=dtype) - if kind == "INTERNAL": - array = _apply_factor(array, vrow) - return array, j + array = _read_open_close_values(vrow, context, dtype, length) + j = i + 1 + else: + j = i + 1 if kind == "INTERNAL" else i + chunks: list[np.ndarray] = [] + count = 0 + while count < length and j < len(rows): + part = rows[j] + if isinstance(part, NumberRows): + text = without_comments(part.raw_text) + elif prefix := _numeric_prefix(part): + text = " ".join(map(str, prefix)) + else: + break + chunk = array_values(text, dtype, source=name) + chunks.append(chunk) + count += len(chunk) + j += 1 + if count < length: + source = f"{name}: " if name else "" + raise ValueError(f"{source}expected {length} values, got {count}") + array = np.concatenate(chunks)[:length] if chunks else np.array([], dtype=dtype) + if factor is not None: + array = array * factor + return array, _control_io(vrow, array), j def _from_file_index(value: np.ndarray) -> np.ndarray: @@ -362,111 +425,96 @@ def _from_file_index(value: np.ndarray) -> np.ndarray: return np.abs(value) - 1 -def _griddata_flat_length(f, dims: dict, default: int) -> int: - """Target length for a non-layered griddata field's flat array -- - e.g. DIS's `delr`/`delc` are `(ncol,)`/`(nrow,)`, not `(nodes,)`. Falls - back to `default` (the grid's total node count) when the field's - declared shape dimension isn't resolvable from `dims`. - """ - shape_meta = f.metadata.get("shape") - if shape_meta: - dim_name = shape_meta[-1] if isinstance(shape_meta, (tuple, list)) else shape_meta - if dim_name in dims: - return dims[dim_name] - return default +@attrs.frozen +class _Grid: + """The grid sizes an array's shape resolves against: the dims, with + ``nodes`` and ``ncpl`` filled in from each other and ``nlay``.""" + + dims: dict + nlay: int + ncpl: int + + @classmethod + def of(cls, dims: Mapping[str, int]) -> "_Grid | None": + """The grid of `dims`, or None if they give no cells.""" + nlay = dims.get("nlay", 1) + # a component with cells but no layers of its own has only ncpl (NCF) + nodes = dims.get("nodes") or nlay * dims.get("ncpl", 0) + if not nodes: + return None + ncpl = nodes // nlay if nlay else nodes + return cls({"nodes": nodes, "ncpl": ncpl, **dims}, nlay or 1, ncpl) + + def size(self, f: Any) -> int: + """How many values the array field `f` holds: its DFN shape (one + dimension, e.g. DIS's `delr` is ``(ncol,)``, `botm` ``(nodes,)``) + resolved against the dims, else every node. An unknown field's + array is a layer's (a G/A package's).""" + if f is None: + return self.ncpl + shape = f.metadata.get("shape") or () + name = shape[-1] if isinstance(shape, (tuple, list)) and shape else shape + return self.dims.get(name) or self.dims["nodes"] -def _parse_array_block( +def _read_array( rows: list, - fields_by_name: dict, - dims: dict, + i: int, + f: Any, + grid: _Grid, context: LoadContext, - arrays: "dict | None" = None, -) -> dict: - """Parse an array block's (GRIDDATA, DISU's CONNECTIONDATA) token rows - into {field_name: np.ndarray}. - - Token rows alternate: [field_name, ?LAYERED] then one control record - per layer (LAYERED) or a single one otherwise -- CONSTANT/INTERNAL/ - OPEN-CLOSE, per `_read_control_record`. How each array was written - goes in `arrays`, per `_record_array_io`. - """ - result: dict = {} - nlay = dims.get("nlay", 1) - # a component with cells but no layers of its own has only ncpl (NCF) - nodes = dims.get("nodes") or nlay * dims.get("ncpl", 0) - if not nodes: - return result - ncpl = nodes // nlay if nlay else nodes - - rows = parts(rows) - i = 0 - while i < len(rows): - row = rows[i] - if not _leading_word(row): - i += 1 - continue - key = str(row[0]).lower() - f = fields_by_name.get(key) - if f is None: - i += 1 - continue - - dtype = np.int64 if to_field_type(f.type) == "integer" else np.float64 - layered = any(str(t).upper() == "LAYERED" for t in row[1:]) - i += 1 - - if layered: - # Read as many per-layer control records as are actually there, - # rather than assuming exactly `nlay` -- some real-world files - # (mf5to15-converted ones observed so far) tag a field LAYERED - # with fewer rows than nlay (e.g. a single-row TOP); trusting - # nlay blindly would consume the next field's name row as if - # it were layer data. Stops at the first row that isn't a - # recognized control record -- i.e. the next field's row. - # - # Per-record length is min(ncpl, target): correct for a truly - # per-layer field (botm/idomain, shape=(nodes,), target > ncpl) - # *and* for a field tagged LAYERED despite not truly being one - # (delr/delc/top, shape=(ncol,)/(nrow,)/(ncpl,), target <= - # ncpl) -- using ncpl unconditionally there would read far more - # values than the field's one real record has, consuming - # however many subsequent lines (including the next field's - # own name row) it takes to reach ncpl values. - target = _griddata_flat_length(f, dims, nodes) - record_len = min(ncpl, target) if target else ncpl - layers = [] - layer_ios = [] - while i < len(rows): - vrow = rows[i] - if _leading_word(vrow) not in _CONTROL_KINDS: - break - value, j = _read_control_record(rows, i, context, dtype, record_len, f.name) - layer_ios.append(_control_io(vrow, value)) - layers.append(value) - i = j - _record_array_io(arrays, (f.name,), layer_ios, layered=True) - if layers: - # A single-record LAYERED field (see above) is really a - # plain target-shaped array duplicated across nlay -- - # broadcast to it rather than leaving it short - # (concatenating fewer than nlay records would). - stacked = np.concatenate(layers).astype(dtype) - if stacked.size < target and stacked.size and target % stacked.size == 0: - stacked = np.tile(stacked, target // stacked.size) - result[f.name] = stacked - else: - if i >= len(rows): - break - length = _griddata_flat_length(f, dims, nodes) - value, j = _read_control_record(rows, i, context, dtype, length, f.name) - _record_array_io(arrays, (f.name,), [_control_io(rows[i], value)]) - i = j - result[f.name] = value - if f.metadata.get("index") and f.name in result: - result[f.name] = _from_file_index(result[f.name]) - - return result + layered: bool, + name: str = "", +) -> "tuple[np.ndarray | None, list[ArrayIO], int]": + """Read the array field `f`'s control record(s) from ``rows[i]`` (a + block's `parts`) on: one, or with `layered` (its name row said + LAYERED), one per layer. Returns the array, flat and as long as the + field's shape says (see `_Grid.size`), or None if there's no record; + how each record wrote it; and the next row index. `f` is None for an + unknown field, whose records are read only to skip them. `name` + prefixes errors.""" + dtype = np.int64 if f is not None and to_field_type(f.type) == "integer" else np.float64 + size = grid.size(f) + ios: list[ArrayIO] = [] + if layered: + # Read as many per-layer control records as are actually there, + # rather than assuming exactly `nlay` -- some real-world files + # (mf5to15-converted ones observed so far) tag a field LAYERED + # with fewer rows than nlay (e.g. a single-row TOP); trusting + # nlay blindly would consume the next field's name row as if + # it were layer data. Stops at the first row that isn't a + # recognized control record -- i.e. the next field's row. + # + # A record is a layer's (ncpl values), or the whole field's if + # it's smaller (delr/delc/top tagged LAYERED despite not truly + # being layered): reading ncpl there would consume however many + # subsequent lines (including the next field's own name row) it + # takes to reach ncpl values. + record = min(grid.ncpl, size) + layers = [] + while i < len(rows) and _leading_word(rows[i]) in _CONTROL_KINDS: + value, io, i = _read_control_record(rows, i, context, dtype, record, name) + layers.append(value) + ios.append(io) + if not layers: + return None, ios, i + # fewer records than layers repeat, to fill the field + values = np.concatenate(layers).astype(dtype) + if values.size and values.size < size and size % values.size == 0: + values = np.tile(values, size // values.size) + else: + if i >= len(rows): + return None, ios, i + values, io, i = _read_control_record(rows, i, context, dtype, size, name) + ios.append(io) + if f is not None and f.metadata.get("index"): + values = _from_file_index(values) + return values, ios, i + + +def _is_layered(row: list) -> bool: + """Whether an array's name row says LAYERED.""" + return any(str(t).upper() == "LAYERED" for t in row[1:]) def _self_dims_from_kwargs(kwargs: dict) -> dict: @@ -491,113 +539,6 @@ def _names(value: Any) -> list[str]: return [] if value is None else [str(v) for v in np.atleast_1d(value)] -def _parse_readarray_period_block( - rows: list, - ra_fields: dict, - dims: dict, - context: LoadContext, - arrays: "dict | None" = None, -) -> "dict[str, np.ndarray | TimeArraySeriesRef]": - """Arrays by the (lowercase) name they're written under: a field's - name, or an auxiliary variable's, for its named array (see Pass 3b). A - time-array series reference gives the series' name. How each array was - written goes in `arrays` by that name, per `_record_array_io`.""" - nlay = dims.get("nlay", 1) - nodes = dims.get("nodes", 1) - ncpl = nodes // nlay if nlay > 1 else nodes - - result: dict[str, np.ndarray | TimeArraySeriesRef] = {} - rows = parts(rows) - i = 0 - while i < len(rows): - row = rows[i] - if not _leading_word(row): - i += 1 - continue - key = str(row[0]).lower() - f = ra_fields.get(key) - i += 1 - - # A field can come from a time-array series, by name -- - # "RECHARGE TIMEARRAYSERIES " -- instead of a control record on - # the next row. Keep the name (see flopy4.mf6.period_arrays). - tokens = [str(t) for t in row[1:]] - tas = next( - (j for j, t in enumerate(tokens) if t.upper() in ("TIMEARRAYSERIES", "TAS6")), None - ) - if tas is not None: - if f is not None and f.metadata.get("time_series") and tas + 1 < len(tokens): - result[key] = TimeArraySeriesRef(tokens[tas + 1]) - continue - - if f is None: - # Unrecognized field name -- e.g. a per-period AUXILIARY-named - # array (RCHA/EVTA-style: `AUXILIARY ` in OPTIONS lets - # `` appear as its own array field in the period block, - # keyed dynamically, so it's not one of `ra_fields`'s declared - # class fields). Still consume its control-record data so it - # doesn't get mistaken for the *next* real field's row; just - # don't store it (not resolved to a real array yet either). - is_layered_unknown = any(str(t).upper() == "LAYERED" for t in row[1:]) - if is_layered_unknown: - while i < len(rows): - vrow = rows[i] - if _leading_word(vrow) not in _CONTROL_KINDS: - break - _, i = _read_control_record(rows, i, context, np.float64, ncpl, key) - elif i < len(rows): - _, i = _read_control_record(rows, i, context, np.float64, ncpl, key) - continue - - is_int = to_field_type(f.type) == "integer" - # an array is layered only when given with LAYERED (the dfn's - # `layered` flag just allows it); otherwise it covers the field's - # whole shape, all nodes for a grid package - is_layered = any(str(t).upper() == "LAYERED" for t in row[1:]) - per_node = (f.metadata.get("shape") or ("",))[-1] == "nodes" - dtype = np.int64 if is_int else np.float64 - - if is_layered: - layers = [] - layer_ios = [] - while i < len(rows): - vrow = rows[i] - if _leading_word(vrow) not in _CONTROL_KINDS: - break - value, j = _read_control_record(rows, i, context, dtype, ncpl, key) - layer_ios.append(_control_io(vrow, value)) - layers.append(value) - i = j - _record_array_io(arrays, (key,), layer_ios, layered=True) - if layers: - if len(layers) < nlay: - layers = (layers * nlay)[:nlay] - result[key] = np.stack(layers) # (nlay, ncpl) - else: - if i >= len(rows): - break - if _leading_word(rows[i]) == "CONSTANT": - # one value for the period, kept as a 0-d array, as a - # scalar given at construction is (period_arrays._as_array) - v = from_text(rows[i][1], int if dtype == np.int64 else float) - value = np.asarray(v, dtype=dtype) - _record_array_io(arrays, (key,), [_control_io(rows[i], value)]) - i += 1 - result[key] = value - else: - size = nlay * ncpl if per_node else ncpl - value, j = _read_control_record(rows, i, context, dtype, size, key) - _record_array_io(arrays, (key,), [_control_io(rows[i], value)]) - i = j - result[key] = ( - np.asarray(value).reshape(nlay, ncpl) if per_node and nlay > 1 else value - ) - if f.metadata.get("index") and isinstance(arr := result.get(key), np.ndarray): - result[key] = np.asarray(_from_file_index(arr)) - - return result - - def _disambiguate_ga_variant(candidates: "list[type[Component]]", path: Path) -> "type[Component]": """ Pick between a base package class and its G/A-variant sibling @@ -625,157 +566,87 @@ def _disambiguate_ga_variant(candidates: "list[type[Component]]", path: Path) -> return candidates[0] -def _resolve_bindings(cls: type, raw_lower: dict, context: LoadContext) -> dict[str, Any]: - """Resolve packages/models/exchanges/solutiongroup-style binding rows - into loaded child component instances, keyed by field name -- merged - into `structure_component`'s kwargs so children are attached the same - way manual construction already attaches them (`Gwf(dis=Dis(...))`). - - Child-Component fields are found via `child_field_candidates()` - (mirroring `unstructure.py`'s `_make_binding_blocks`, the egress side of - this same job), grouped by block name since several fields can share one - block (every `Gwf` package field shares `"packages"`). Within a block, - `DimensionProvider` targets (`dis`/`disv`/`disu`) are resolved first so - their dims can be threaded into the context of that block's other - children -- `dimensions.py`'s object-graph walk only helps once a child - is already attached, not while its siblings are still loading. A row's - columns are read as its field's ``row`` says (see `converter.binding`). - Its references (an exchange's models) resolve among the models loaded - so far, from the models block, which comes first (field order), and go - in the child's context as well. - """ - from flopy4.attrs_xarray import child_field_candidates - from flopy4.mf6.model import Model - - # Model scope to prefer when resolving this class's own binding rows' - # ftype tokens via get_ftype() below -- e.g. structuring a Gwf's - # "packages" block should resolve "DIS6" to gwf's own Dis, not gwt's/ - # gwe's/prt's. - # A Model class's __module__ is "flopy4.mf6." (defined directly - # in that subpackage's __init__.py), not "...." like its - # child packages, so this can't reuse component.py's _model_prefix -- - # a Model's own class name *is* its model prefix by convention. - model_prefix = cls.__name__.lower() if issubclass(cls, Model) else None - - fields_by_block: dict[str, list] = {} - # Blocks with other fields too. In the rest, every row names a child (a - # model's packages, the simulation's models), and a row no field takes, - # as for a package flopy4 has no class for yet, warns. - mixed: set[str] = set() - for f in attrs.fields(cls): # type: ignore[arg-type] - spec = child_field_candidates(f) if f.metadata.get("child") else None - if spec is None or f.metadata.get("_keyword"): - if (block := f.metadata.get("block")) is not None: - mixed.add(block) - if spec is None: - continue - block_name = f.metadata.get("block") - if block_name is None or f.metadata.get("_keyword"): - continue # file records' children load with their records - kind, candidates = spec - columns = f.metadata["row"] - fields_by_block.setdefault(block_name, []).append((f.name, kind, candidates, columns)) +def _binding_classes(accepted: tuple[type, ...]) -> "list[type[Component]]": + """The classes a child field takes, as concrete ones: an abstract + one (the simulation's `Model`, `Exchange`, `Solution`) as each + component class deriving from it.""" + out: "list[type[Component]]" = [] + for c in accepted: + if ABC in c.__bases__: + out += [k for k in dict.fromkeys(get_ftypes().values()) if issubclass(k, c)] + else: + out.append(cast("type[Component]", c)) + return out - if not fields_by_block: - return {} +def _binding_target(row: list, field_specs: list, context: LoadContext) -> tuple | None: + """The child field a row names (``CHD6 ``) and the class + to load it as, by the row's ftype, read as the field's ``row`` says, + or None if no field takes it. A G/A pair (`Chd`/`Chdg`) shares one + ftype, so is told apart by the file's options (see + `_disambiguate_ga_variant`).""" + matches = [] + for f, kind, accepted in field_specs: + token = str(row[f.metadata["row"].index("ftype")]).lower() + matches += [(f, kind, c) for c in _binding_classes(accepted) if c.ftype.lower() == token] + if len(matches) > 1: + fname = str(row[matches[0][0].metadata["row"].index("filename")]) + target = _disambiguate_ga_variant([c for *_, c in matches], context.resolve(fname)) + return next(m for m in matches if m[2] is target) + return matches[0] if matches else None + + +def _resolve_bindings(cls: type, rows_by_block: dict, context: LoadContext) -> dict[str, Any]: + """The children the rows of `cls`'s blocks name (a model's packages, + the simulation's models, exchanges and solutions), loaded, by field: + the kwargs construction attaches them by (`Gwf(dis=Dis(...))`). + Egress's `_Unstructure.bindings` is the inverse. + + A block's dims providers (`dis`/`disv`/`disu`) load first, so the + rest load with their dims; the object-graph walk in `dimensions.py` + only finds them once the children are attached. A row's columns are + read as its field's ``row`` says (see `converter.binding`). Its + references (an exchange's models) resolve among the models loaded so + far, from the models block, which comes first (field order), and go + in the child's context as well.""" kwargs: dict[str, Any] = {} - for block_name, field_specs in fields_by_block.items(): - # Some binding blocks are numbered (e.g. "SOLUTIONGROUP 1", like - # "PERIOD 1" elsewhere) -- gather every raw block whose name matches - # or starts with "{block_name} ". - raw_names = [ - raw_name - for raw_name in raw_lower - if raw_name == block_name or raw_name.startswith(f"{block_name} ") - ] - # several solution groups, each with its own MXITER, would be - # merged into one, which MF6 runs differently - if block_name == "solutiongroup" and len(raw_names) > 1: - groups = ", ".join(n.upper() for n in raw_names) - raise ValueError( - f"{cls.__name__}: more than one solution group ({groups}); only one is supported" - ) - rows = [row for raw_name in raw_names for row in raw_lower[raw_name]] - if not rows: - continue - - # Resolve each row's target class + owning field up front, so rows - # can be reordered (dims providers first) without re-parsing. - resolved = [] - for row in rows: + for block_name, field_specs in binding_fields(cls).items(): + targets = [] + for row in rows_by_block.get(block_name) or []: if not row: continue - for child_name, kind, accepted, columns in field_specs: - token = str(row[columns.index("ftype")]).lower() - # Concrete candidates first: compare each accepted class's - # own ftype directly to the row's token. G/A-variant pairs - # (Chd/Chdg, Rch/Rcha, ...) share one namefile ftype (real - # MF6 has no separate 'CHDG6' case, only 'CHD6' -- see - # Component.ftype), so more than one concrete - # candidate can match; disambiguate from the file content. - concrete = [c for c in accepted if ABC not in c.__bases__] - matches = [c for c in concrete if c.ftype.lower() == token] - if len(matches) > 1: - fname = str(row[columns.index("filename")]) - target_cls = _disambiguate_ga_variant(matches, context.resolve(fname)) - elif matches: - target_cls = matches[0] - else: - # Fall back to the ftype registry for abstract-typed - # fields (Model/Exchange/Solution), where the - # field's declared type can't be compared to a token - # directly. - resolved_cls = get_ftype(token, prefix=model_prefix) - if resolved_cls is None or not any( - issubclass(resolved_cls, t) for t in accepted - ): - continue - target_cls = resolved_cls - - resolved.append((row, target_cls, child_name, kind, columns)) - break - else: - if block_name in mixed: - continue + if (target := _binding_target(row, field_specs, context)) is None: + # a package flopy4 has no class for yet, say warnings.warn( f"{cls.__name__}: no field takes {block_name} entry " f"{str(row[0]).upper()} ({row[1] if len(row) > 1 else ''}), skipped", UserWarning, stacklevel=2, ) + continue + targets.append((row, *target)) + targets.sort(key=lambda t: not issubclass(t[3], DimensionProvider)) - resolved.sort(key=lambda r: 0 if issubclass(r[1], DimensionProvider) else 1) - - dims: dict = {} - collectors: dict[str, Any] = {} - for row, target_cls, child_name, kind, columns in resolved: - values = read_row(row, columns, target_cls, kwargs.get("models", [])) + child_context = attrs.evolve(context, dims={}, parent=None) + for row, f, kind, target_cls in targets: + values = read_row(row, f.metadata["row"], target_cls, kwargs.get("models", [])) fname = str(values.pop("filename")) name = values.pop("name", None) values.pop("ftype") # the rest are references, set like a built child's - referenced_models = [v for value in values.values() for v in referenced(value)] - child_context = attrs.evolve( - context, - dims=dims, - parent=None, - models=tuple(referenced_models) or None, - ) - child = target_cls.load(context.resolve(fname), name=name, context=child_context) + refs = [v for value in values.values() for v in referenced(value)] + load_context = attrs.evolve(child_context, models=tuple(refs) or None) + child = target_cls.load(context.resolve(fname), name=name, context=load_context) child.filename = Path(fname) for attr, value in values.items(): setattr(child, attr, value) if isinstance(child, DimensionProvider): - dims = {**dims, **child.get_dims()} - - if kind == "only": - collectors[child_name] = child - elif kind == "list": - collectors.setdefault(child_name, []).append(child) - - kwargs.update(collectors) - + dims = {**child_context.dims, **child.get_dims()} + child_context = attrs.evolve(child_context, dims=dims) + if kind == "list": + kwargs.setdefault(f.name, []).append(child) + else: + kwargs[f.name] = child return kwargs @@ -827,20 +698,454 @@ def _load_file_child(field: Any, path: Path, context: LoadContext) -> Any: return child -def _group_repeating_rows( - raw_lower: dict, prefixes: "set[str]", cast -) -> "dict[str, dict[Any, list]]": - grouped: dict[str, dict[Any, list]] = {} - for block_name, rows in raw_lower.items(): - names = block_name.split() - if len(names) < 2 or names[0] not in prefixes: - continue - try: - header = cast(names[1]) - except ValueError: +def _init_key(f: attrs.Attribute) -> str: + """The `__init__` argument setting the field `f`: its alias (a private + field's name without the underscore, as ``stress_period_data``), else + its name.""" + return f.alias or f.name + + +def _is_grid_array(f: Any) -> bool: + """Whether `f` holds a numeric array read with control records + (griddata, a G/A period's, a TAS time's), not inline (AUXILIARY's).""" + return is_array(f) and to_field_type(f.type) in ("integer", "double") + + +def _per_header(f: attrs.Attribute) -> bool: + """Whether the field `f`, of a repeating block, holds a value per + header (a period's, a time's, an OBS output file's), not one.""" + return get_origin(unwrap_optional(f.type)) is dict or block_list_type(f.type) is not None + + +def _header(cls: "type[Component]", block: str, words: list[str]) -> Any: + """A repeating block's header, from the words after its name, by its + kind in ``cls.headers``, as both loaders key its occurrences: an index + (a period's IPER) 0-based, another integer (SOLUTIONGROUP's) or a + double (a TAS time) as a number, a record (OBS's ``FILEOUT ``) + as its words, case kept. Raises ValueError if there are none, or a + number's doesn't parse.""" + if not words: + raise ValueError(f"no {block} header") + header = cls.headers[block] + if header.kind == "integer": + n = int(words[0]) + return n - 1 if header.index else n + if header.kind == "double": + return fortran_float(words[0]) + return tuple(words) + + +def _occurrences(raw: dict, cls: type) -> dict[str, dict[Any, list]]: + """The file's blocks by DFN block name, each as ``{None: rows}``, or for + a repeating block ``{header: rows}`` (see `_header`) in file order. MF6 + ignores a block it doesn't read (an old IMS file's XMD), so one that + isn't in the DFN warns and is skipped; so, silently, is a repeating + one whose header doesn't parse.""" + blocks = dfn(cls).blocks or {} + found: dict[str, dict[Any, list]] = {} + for raw_name, rows in raw.items(): + name, *tokens = raw_name.lower().split() + if (block := blocks.get(name)) is None: + if rows: + warnings.warn(f"{cls.__name__}: ignoring unknown block {raw_name.upper()}") continue - grouped.setdefault(names[0], {})[header] = rows - return grouped + header = None + if block.header is not None: + try: + header = _header(cls, name, raw_name.split()[1:]) + except ValueError: + continue + found.setdefault(name, {})[header] = rows + return found + + +def _period_array( + value: np.ndarray, ios: "list[ArrayIO]", f: Any, grid: _Grid, layered: bool +) -> np.ndarray: + """A G/A period's array as the field holds it (see + flopy4.mf6.period_arrays): a LAYERED one by layer, a CONSTANT one as + its value (0-d, as a scalar given at construction is), a nodes-shaped + one by layer, else flat.""" + if layered: + layers = value.reshape(-1, grid.ncpl) # (nlay, ncpl) + # fewer records than layers repeat + return layers if len(layers) >= grid.nlay else np.resize(layers, (grid.nlay, grid.ncpl)) + if ios[0].format == "constant": + return np.asarray(value[0]) + if (f.metadata.get("shape") or ("",))[-1] == "nodes" and grid.nlay > 1: + return value.reshape(grid.nlay, grid.ncpl) + return value + + +class ComponentLoad: + """What any loader's read of one component's file builds: its + `__init__` arguments, so far; how the file wrote each array; and the + rows naming children, for `_resolve_bindings`. Its fields are read a + block at a time in file-schema order, options and dimensions first, so + a block can read by those before it (the auxiliary names, the sizes + and switches of a list's columns, a dims provider's own dims).""" + + def __init__(self, cls: type, context: LoadContext) -> None: + self.cls = cls + self.context = context + self.kwargs: dict[str, Any] = {} + # how the file wrote each array, by `ArrayKey`, and list, by + # `ListKey`, for the instance's write_context + self.array_ios: dict = {} + self.list_ios: dict = {} + self.bindings: dict[str, list] = {} + self._children: dict[Path, Any] = {} + self._union_arm = _union_arm(context.parent) + self._union_forms = _union_forms(context.parent) + # the child fields named by each block's rows + self.binding_blocks = binding_fields(cls) + + @property + def dims(self) -> dict: + """The grid's dims: the context's, or for a dims provider, which + has none yet, its own (see `_self_dims_from_kwargs`).""" + return dict(self.context.dims) or _self_dims_from_kwargs(self.kwargs) + + def finish(self, name: str | None = None) -> Any: + """The component, from the arguments read, with its children + loaded from the rows naming them and its arrays written back the + way the file wrote them.""" + kwargs = self.kwargs + if self.context.workspace and self.bindings: + kwargs.update(_resolve_bindings(self.cls, self.bindings, self.context)) + if name is not None: + kwargs["name"] = name + if self.array_ios or self.list_ios: + kwargs["write_context"] = WriteContext(arrays=self.array_ios, lists=self.list_ios) + return self.cls(**kwargs) + + def read_blocks( + self, + name: str, + fields: list, + found: dict[Any, Any], + *, + numbered: bool, + fill_forward: bool, + ) -> None: + """Read the occurrences of the block `name`, ``{header: contents}`` + (``{None: contents}`` for a block that doesn't repeat), into the + arguments: its `fields`' values, or a repeating block's by header, + in order if `numbered`. An empty occurrence of a `fill_forward` + block (a period) clears its lists and, for a grid package, its + arrays. `body` reads each occurrence's contents.""" + if None in found: + for f, value in self.body(name, found[None], None).items(): + self.kwargs[_init_key(f)] = value + return + if len(found) > 1 and not any(_per_header(f) for f in fields): + # several solution groups, each with its own MXITER, would be + # merged into one, which MF6 runs differently + names = ", ".join(f"{name.upper()} {h}" for h in found) + raise ValueError( + f"{self.cls.__name__}: more than one {name} block ({names}); only one is supported" + ) + values: dict[attrs.Attribute, dict] = {} + for header in sorted(found) if numbered else found: + if contents := found[header]: + body = self.body(name, contents, header) + elif fill_forward: + body = self.cleared(fields) + else: + body = {} + for f, value in body.items(): + values.setdefault(f, {})[header] = value + for f in fields: + if (blocks := block_list_type(f.type)) is not None: + header_cls, list_name, _ = blocks.parts() + self.kwargs[_init_key(f)] = [ + blocks( + **{ + blocks._header: header_cls.from_tokens(list(header)), + list_name: values.get(f, {}).get(header) or [], + } + ) + for header in found + ] + elif f in values: + by_header = values[f] + self.kwargs[_init_key(f)] = ( + by_header if _per_header(f) else next(iter(by_header.values())) + ) + + def body(self, name: str, contents: Any, header: Any) -> dict: + """The values of one occurrence of the block `name`, by field.""" + raise NotImplementedError + + def cleared(self, fields: list) -> dict: + """An empty period's values: no rows for each list, and for a grid + package, no array.""" + lists: dict[Any, Any] = {f: [] for f in fields if item_list_type(f.type) is not None} + if not is_grid_package(self.cls): + return lists + return lists | {f: None for f in fields if _is_grid_array(f) and not f.metadata.get("fk")} + + def layout(self, item_cls: Any) -> tuple[dict[str, int], frozenset[str]]: + """The sizes (aux by auxiliary, GNC's alphasj by numalphaj) and + switches (boundnames) of a list's columns, as read so far.""" + sizes = {} + for shape in sized_by(item_cls): + n = dim_value(shape, lookup=lambda name: dim_lookup(self.kwargs, name)) + if n is not None: + sizes[shape] = n + enabled = frozenset(o for o in conditional_fields(item_cls).values() if self.kwargs.get(o)) + return sizes, enabled + + def parse_list(self, rows: list, item_cls: Any, words: tuple[str, ...] = ()) -> Any: + """A list field's value from its rows, laid out as `layout` says.""" + sizes, enabled = self.layout(item_cls) + return _parse_rows( + rows, + item_cls, + sizes=sizes, + enabled=enabled, + # the grid's dims give the cellids' width (see LoadContext.ncelldim) + context=attrs.evolve(self.context, dims=self.dims), + union_arm=self._union_arm, + union_forms=self._union_forms, + load_child=self.load_child, + words=words, + ) + + def load_child(self, f: Any, token: str) -> Any: + """A row's child column (LAK's TAB6 file), loaded from its file, + once per file (SFR's periods may name one table again).""" + path = Path(_strip_quotes(token)) + if path not in self._children: + context = attrs.evolve(self.context, dims=self.dims, parent=self.cls) + self._children[path] = _load_file_child(f, path, context) + return self._children[path] + + +class _Load(ComponentLoad): + """The basic loader's read of one component's file, a block at a time + in DFN order (see `ComponentLoad`).""" + + def __init__(self, cls: type, context: LoadContext) -> None: + super().__init__(cls, context) + self._fields = attrs.fields_dict(cls) + self._names = attr_names(cls) + + def attribute(self, block: str, f: Any) -> "attrs.Attribute | None": + """The class's field holding the DFN field `f` of `block`, if it + has one: not a computed one (a list package's MAXBOUND) or one + codegen leaves out.""" + a = self._fields.get(self._names.get((block, f.name), "")) + return a if a is not None and a.init is not False else None + + def value_at(self, path: str) -> Any: + """The value read so far for the DFN field at `path` (``block.field``).""" + block, name = path.split(".", 1) + a = self._fields.get(self._names.get((block, name), "")) + return None if a is None else self.kwargs.get(_init_key(a)) + + def read(self, name: str, block: Any, found: dict[Any, list]) -> None: + """Read the occurrences of the DFN block `block` into the + arguments (see `ComponentLoad.read_blocks`).""" + fields = [a for f in block.fields.values() if (a := self.attribute(name, f)) is not None] + header = block.header + self.read_blocks( + name, + fields, + found, + numbered=header is not None and header.field.type in ("integer", "double"), + fill_forward=header is not None and bool(header.fill_forward), + ) + + def body(self, name: str, rows: list, header: Any) -> dict: + """The values of one occurrence of the block `name`, by field. A + row whose first word is a tagged field's key is that field's; the + rest are the block's untagged field's, or name children (see + `_resolve_bindings`). An array's name row comes with its control + records (see `_groups`). A tagged list collects its rows. An + unknown word warns, and its records are skipped.""" + keys = block_keys(self.cls, name) + binds = name in self.binding_blocks + untagged = self.attribute(name, keys.untagged) if keys.untagged else None + if not keys.tagged and not keys.dynamic and not binds: + value = None if untagged is None else self.untagged(untagged, rows, header) + return {} if value is None else {untagged: value} + written = rows + rows = _resolve_open_close_rows(rows, self.context) + if not keys.tagged and not keys.dynamic: + self.bindings.setdefault(name, []).extend(rows) + return {} + + values: dict[attrs.Attribute, Any] = {} + lists: dict[attrs.Attribute, list] = {} + rest: list = [] + for head, *records in _groups(parts(rows)): + if (found := self.field_of(keys, head)) is None: + if binds or keys.untagged is not None: + rest += _rows_of([head, *records]) + elif not _is_record(head): + self.unknown(name, head) + continue + f, aux_name = found + if (a := self.attribute(name, f)) is None: + self.unknown(name, head) + elif _is_grid_array(a): + self.array(a, aux_name, [head, *records], header, values) + elif item_list_type(a.type) is not None: + lists.setdefault(a, []).append(head) + elif a.metadata.get("_keyword"): + self.file(a, head, values) + else: + values[a] = _tagged_value(a, head) + for a, list_rows in lists.items(): + item_cls = item_list_type(a.type) + value = self.parse_list(list_rows, item_cls, item_list_words(a.type)) + if value is not None: + values[a] = value + self.record_list_io(a, written, value, item_cls, header) + if binds: + self.bindings.setdefault(name, []).extend(rest) + elif untagged is not None and rest: + if (value := self.untagged(untagged, rest, header)) is not None: + values[untagged] = value + return values + + def field_of(self, keys: BlockKeys, row: Any) -> "tuple[Any, str | None] | None": + """The DFN field whose row `row` is, by its first word, with the + name a dynamic key gives (an auxiliary variable's); None for a row + of numbers, or a word no field's. A dynamic key wins: an auxiliary + name that matches a field's (Q) is the aux array, as in MF6. Where + a word begins several fields' rows (OC's HEAD), the next one tells + them apart; a file record's row has its direction, so OC's ``HEAD + PRINT_FORMAT`` isn't a ``HEAD FILEOUT `` record.""" + word = _leading_word(row).lower() + if not word: + return None + for path, f in keys.dynamic.items(): + for n in _names(self.value_at(path)): + if n.lower() == word: + return f, n + following = str(row[1]).lower() if len(row) > 1 else "" + candidates = keys.tagged.get(word, ()) + if len(candidates) > 1: + candidates = tuple(f for f in candidates if following in following_tags(f)) or tuple( + f for f in candidates if not following_tags(f) + ) + if not candidates: + return None + if following_tags(candidates[0]) in (["filein"], ["fileout"]) and following not in ( + "filein", + "fileout", + ): + return None + return candidates[0], None + + def unknown(self, name: str, row: list) -> None: + """Warn of a row no field of the block `name` takes. MF6 rejects a + keyword it doesn't know, so this is likely one flopy4 doesn't + support yet. A computed one (a list package's MAXBOUND) is + derived, not read.""" + key = str(row[0]) + if not isinstance(getattr(self.cls, key.lower(), None), property): + warnings.warn( + f"{self.cls.__name__}: no field takes {name.upper()} entry {key.upper()}, skipped", + UserWarning, + stacklevel=4, + ) + + def array(self, f: Any, aux_name: "str | None", rows: list, header: Any, values: dict) -> None: + """Read the grid array `f`, from its name row and control records + (`rows`), into `values`, and how the file wrote it, by `ArrayKey`, + into `array_ios`; an auxiliary variable's (`aux_name`) into `f`'s + value by that name. A field can come from a time-array series, by + name -- ``RECHARGE TIMEARRAYSERIES `` -- instead of a control + record; its value keeps the name (see flopy4.mf6.period_arrays).""" + row = rows[0] + if (grid := _Grid.of(self.dims)) is None: + return + tokens = [str(t) for t in row[1:]] + tas = next( + (j for j, t in enumerate(tokens) if t.upper() in ("TIMEARRAYSERIES", "TAS6")), None + ) + value: Any + if tas is not None: + if not f.metadata.get("time_series") or tas + 1 >= len(tokens): + return + value = TimeArraySeriesRef(tokens[tas + 1]) + else: + # An array is layered only when given with LAYERED (the dfn's + # `layered` flag just allows it); otherwise it covers the + # field's whole shape, all nodes for a grid package. + layered = _is_layered(row) + value, ios, _ = _read_array(rows, 1, f, grid, self.context, layered, aux_name or f.name) + if aux_name is None: + key = (f.name,) if header is None else (f.name, header) + _record_array_io(self.array_ios, key, ios, layered=layered) + if value is None: + return + if header is not None: + value = _period_array(value, ios, f, grid, layered) + if aux_name is None: + values[f] = value + else: + values.setdefault(f, {})[aux_name] = value + + def file(self, f: Any, row: list, values: dict) -> None: + """A file record's value (``KEYWORD [FILEIN|FILEOUT] ``) into + `values`: its path, or the child loaded from it. A list of them (a + DFN tagged list of file records) gets one element per row.""" + has_direction = len(row) > 1 and str(row[1]).upper() in ("FILEIN", "FILEOUT") + tokens = row[2:] if has_direction else row[1:] + if not tokens: + return + path = Path(_strip_quotes(str(tokens[0]))) + value = ( + _load_file_child(f, path, attrs.evolve(self.context, parent=self.cls)) + if f.metadata.get("child") + else path + ) + if get_origin(unwrap_optional(f.type)) is list: + values.setdefault(f, []).append(value) + else: + values[f] = value + + def from_files(self, rows: list, item_cls: Any) -> list: + """A list's rows: its block's, or those of the file (see + `_resolve_open_close_rows`) that its only row names.""" + sizes, enabled = self.layout(item_cls) + context = attrs.evolve(self.context, dims=self.dims) + return _resolve_open_close_rows(rows, context, item_cls, sizes, enabled) + + def untagged_list(self, f: Any, rows: list, item_cls: Any, header: Any) -> Any: + """An untagged list's value (see `record_list_io`).""" + value = self.parse_list(self.from_files(rows, item_cls), item_cls, item_list_words(f.type)) + self.record_list_io(f, rows, value, item_cls, header) + return value + + def record_list_io(self, f: Any, rows: list, value: Any, item_cls: Any, header: Any) -> None: + """Record how the block (its `rows`, as written) wrote the list + `f`, if to a file, in `list_ios` by `ListKey`.""" + context = attrs.evolve(self.context, dims=self.dims) + if (io := _list_io(rows, value, item_cls, context)) is not None: + key = _list_key(f) + self.list_ios[key if header is None else (key, header)] = io + + def untagged(self, f: Any, rows: list, header: Any = None) -> Any: + """The value of a block's untagged field from its rows: a list's + elements (an OBS output file's, for a list of blocks), a TAS + time's array, a control record with no name row, or a word (STO's + steady-state or transient), its first row's first, as MF6 reads it.""" + if (item_cls := item_list_type(f.type)) is not None: + return self.untagged_list(f, rows, item_cls, header) + if (blocks := block_list_type(f.type)) is not None: + item_cls = blocks.parts()[2] + return self.parse_list(self.from_files(rows, item_cls), item_cls) + if _is_grid_array(f) and (grid := _Grid.of(self.dims)) is not None: + value, _, _ = _read_array(parts(rows), 0, f, grid, self.context, False, f.name) + return value + if f.metadata.get("type") == "string" and rows and rows[0]: + return str(rows[0][0]) + return None def structure_component( @@ -852,13 +1157,19 @@ def structure_component( ) -> Any: """Reconstruct a component instance from a raw parsed MF6 input dict. + The file's blocks are read in the order of ``cls``'s DFN, whose + options and dimensions blocks come first (see `_Load`). Each row goes + to the field of its block whose key it begins with, else to the + block's untagged field; a repeating block's values are kept by header + (see `_occurrences`). The rows naming children are resolved last (see + `_resolve_bindings`). + Parameters ---------- raw : dict Output of ``loads()`` — {BLOCK_NAME_UPPER: list_of_token_rows}. cls : type - The component class to instantiate. Fields are read via their - ``block`` metadata (see ``flopy4.mf6.spec``). + The component class to instantiate. context : LoadContext, optional Where the file sits in the simulation: the workspace relative paths resolve against, the grid dims (e.g. {"nlay": 3, "nodes": @@ -879,467 +1190,11 @@ def structure_component( ------- Component instance. """ - context = context or LoadContext() - dims = dict(context.dims) - raw_lower = {k.lower(): v for k, v in raw.items()} - binding_kwargs = _resolve_bindings(cls, raw_lower, context) if context.workspace else {} - - # Only DFN-block-derived fields -- excludes identity/bookkeeping - # attributes (Component.name, filename, ...) with no `block` metadata, - # so a block keyword can't shadow them (e.g. utl-tas's "NAME ..." row - # is for time_series_name, not Package.name). - all_fields = { - f.name: f for f in attrs.fields(cls) if f.init is not False and "block" in f.metadata - } - alias_map: dict[str, str] = {} # alias → name - for f in attrs.fields(cls): - if f.alias and f.alias != f.name: - alias_map[f.alias] = f.name - - # Block-level file records ("TS6 FILEIN ") are keyed by their - # trigger keyword, the path field's _keyword metadata (see spec.file), - # not by the field's py name (ts_file). - file_fields: dict[str, Any] = { - f.metadata["_keyword"]: f for f in all_fields.values() if f.metadata.get("_keyword") - } - - # Index Optional[InnerClass] fields by the inner class's _keyword (lowercase). - # Covers options-block compound records like Npf.Cvoptions, Ims.Rclose, etc. - inner_class_fields: dict[str, tuple] = {} - for f in attrs.fields(cls): - if f.init is False: - continue - inner_cls = _inner_class_type(f.type) - if inner_cls is None: - continue - if kw := vars(inner_cls).get("_keyword", ""): - for k in (kw, *vars(inner_cls).get("_aliases", ())): - inner_class_fields[k.lower()] = (f, inner_cls) - - # Identify Item-list fields (packagedata, connectiondata, partitions …) -- - # the field's own type annotation (Optional[list[ItemClass]] or - # Optional[dict[int, list[ItemClass]]]) is the schema. One alone in its - # block takes all the block's rows; one sharing its block with other - # fields (a DFN tagged list) takes the rows starting with its elements' - # keyword(s). - block_item_fields: dict[str, tuple] = {} # block_name → (field, item_cls) - keyword_item_fields: dict[str, tuple] = {} # keyword → (field, item_cls) - period_field = None # field for the period Item-list - period_item_cls: "type[Item] | tuple[type[Item], ...] | None" = None - - # Fill-forward repeating blocks (period), per the fields' own - # fill_forward metadata (from the DFN's BlockHeader.fill_forward). - fill_forward_blocks = { - f.metadata["block"] for f in attrs.fields(cls) if f.metadata.get("fill_forward") - } - block_sizes = Counter(f.metadata["block"] for f in all_fields.values()) - - for f in attrs.fields(cls): - block = f.metadata.get("block", "") - item_cls = item_list_type(f.type) - if item_cls is None: - continue - if f.metadata.get("fill_forward"): - period_field = f - period_item_cls = item_cls - elif block_sizes[block] == 1: - block_item_fields[block] = (f, item_cls) - else: - for elem_cls in item_cls if isinstance(item_cls, tuple) else (item_cls,): - keyword_item_fields[elem_cls.keyword().lower()] = (f, elem_cls) - - # Array fields whose own block repeats per header value -- e.g. - # utl-tas's tas_array, dict[float, ndarray]. Detected structurally from - # the field's own annotation (Optional[dict[K, ArrayLike]]), the same - # way block_item_fields above is detected via item_list_type -- not via - # a metadata flag. Mirrors egress/unstructure.py's write path. - repeating_array_fields = { - f.name: f - for f in attrs.fields(cls) - if repeating_array_key_type(f.type) is not None - and not f.metadata.get("fill_forward") - and f.init is not False - and not f.metadata.get("fk") - } - repeating_array_block_prefixes = {f.metadata["block"] for f in repeating_array_fields.values()} - - # Blocks of plain numeric arrays, read by Pass 4: GRIDDATA, and DISU's - # CONNECTIONDATA. - array_fields: dict[str, dict[str, Any]] = {} - for f in all_fields.values(): - if ( - is_array(f) - and not f.metadata.get("fill_forward") - and f.name not in repeating_array_fields - and item_list_type(f.type) is None - and to_field_type(f.type) in ("integer", "double") - ): - array_fields.setdefault(f.metadata["block"], {})[f.name] = f - - # Blocks repeating under a record header (OBS's CONTINUOUS), by block. - header_block_fields = { - f.metadata["block"]: (f, b) for f in attrs.fields(cls) if (b := block_list_type(f.type)) - } - - # ── Pass 1: scalar blocks (options, dimensions, etc.) ──────────────────── - known_blocks = {f.metadata.get("block") for f in attrs.fields(cls)} - # Blocks naming children (a model's packages, the simulation's - # solutions), whose rows _resolve_bindings takes, and warns for. - binding_blocks = { - f.metadata.get("block") - for f in attrs.fields(cls) - if f.metadata.get("child") and not f.metadata.get("_keyword") - } - if isinstance(getattr(cls, "maxbound", None), property): - known_blocks.add("dimensions") # computed maxbound, see unstructure.py - kwargs: dict[str, Any] = {} - # how the file wrote each array, by `ArrayKey`, and list, by `ListKey`, - # for the instance's write_context - array_ios: dict = {} - list_ios: dict = {} - for block_name, rows in raw_lower.items(): - if not rows: - continue - if block_name.split()[0] not in known_blocks: - # MF6 ignores blocks it doesn't read (an old IMS file's XMD) - warnings.warn(f"{cls.__name__}: ignoring unknown block {block_name.upper()}") - continue - if ( - block_name in block_item_fields - or block_name.split()[0] in fill_forward_blocks - or block_name in array_fields - or block_name.split()[0] in repeating_array_block_prefixes - or block_name.split()[0] in header_block_fields - ): - continue - rows = _resolve_open_close_rows(rows, context) - for row in rows: - if not row: - continue - key = str(row[0]).lower() - has_direction = len(row) > 1 and str(row[1]).upper() in ("FILEIN", "FILEOUT") - # A file record has its direction token, so OC's "HEAD - # PRINT_FORMAT ..." isn't the "HEAD FILEOUT " record. - if (ff := file_fields.get(key)) is not None and ( - has_direction or not ff.metadata.get("direction") - ): - # KEYWORD FILEIN|FILEOUT : the path follows the - # keyword and the direction token. - tokens = row[2:] if has_direction else row[1:] - if tokens: - path = Path(_strip_quotes(str(tokens[0]))) - init_key = ff.alias or ff.name - if ff.metadata.get("child"): - child = _load_file_child(ff, path, attrs.evolve(context, parent=cls)) - if get_origin(unwrap_optional(ff.type)) is list: - kwargs.setdefault(init_key, []).append(child) - else: - kwargs[init_key] = child - continue - # A list[Path] field (a DFN tagged list of file - # records) gets one element per row. - if get_origin(unwrap_optional(ff.type)) is list: - kwargs.setdefault(init_key, []).append(path) - else: - kwargs[init_key] = path - continue - if (kf := keyword_item_fields.get(key)) is not None: - # One element of an Item list sharing its block with other - # fields (a DFN tagged list), by its leading keyword. - f, item_cls = kf - kwargs.setdefault(f.alias or f.name, []).append(item_cls.from_tokens(row)) - continue - # A record's keyword wins over a field's name: utl-ts's SFAC is - # sfacrecord_single's keyword, and the SFACS record's field name. - if key in inner_class_fields: - cand_f, inner_cls = inner_class_fields[key] - cand_init = cand_f.alias if cand_f.alias else cand_f.name - kwargs[cand_init] = inner_cls.from_tokens(row) - continue - # keywords are renamed with a trailing underscore (CONTINUE: continue_) - f = ( - all_fields.get(key) - or all_fields.get(alias_map.get(key, "")) - or all_fields.get(f"{key}_") - ) - if f is None: - # MF6 rejects a keyword it doesn't know, so this is likely - # one flopy4 doesn't support yet, or a developmode one the - # classes were synced without. A computed one (a list - # package's MAXBOUND) is derived, not read. - if block_name.split()[0] not in binding_blocks and not isinstance( - getattr(cls, key, None), property - ): - warnings.warn( - f"{cls.__name__}: no field takes {block_name.upper()} entry " - f"{str(row[0]).upper()}, skipped", - UserWarning, - stacklevel=2, - ) - continue - init_key = f.alias if f.alias else f.name - # A Record-typed field must go through from_tokens(), even when - # the matched token is the field's own name rather than the - # record's trigger keyword. - inner_cls = _inner_class_type(f.type) - if inner_cls is not None: - kwargs[init_key] = inner_cls.from_tokens(row) - continue - # Take what the field's type needs from the row; MF6 ignores - # anything after it (often an inline comment, or a second value - # like IMS's `UNDER_RELAXATION NONE DBD`). - t = unwrap_optional(f.type) - if t is bool: - kwargs[init_key] = True - elif get_origin(t) in (list, np.ndarray, npt.NDArray): - # inline arrays (AUXILIARY's names), even with one element; numpy - # >= 2.5's NDArray[X] has origin NDArray, not ndarray - args = get_args(t) - elem = args[-1] if get_origin(t) is not list else (args[0] if args else Any) - if get_origin(elem) is np.dtype: - elem = get_args(elem)[0] if get_args(elem) else Any - elem = {np.int64: int, np.float64: float, np.str_: str}.get(elem, elem) - kwargs[init_key] = [from_text(v, elem) for v in row[1:]] - else: - kwargs[init_key] = from_text(row[1], t) - - item_types = [ic for _, ic in block_item_fields.values()] - if period_item_cls is not None: - item_types.append(period_item_cls) - # Sizes of the package fields and dimensions sizing item columns - # (aux by auxiliary, GNC's alphasj by numalphaj). - sizes = {} - for ic in item_types: - for shape in sized_by(ic): - if (n := dim_value(shape, lookup=lambda name: dim_lookup(kwargs, name))) is not None: - sizes[shape] = n - enabled = frozenset( - o for ic in item_types for o in conditional_fields(ic).values() if kwargs.get(o) - ) - - # The grid's dims give the cellids' width (see LoadContext.ncelldim). - # Same "self dims, since a DimensionProvider has none threaded to it - # yet" fallback as Pass 4's griddata parsing. - effective_dims = dims or _self_dims_from_kwargs(kwargs) - rows_context = attrs.evolve(context, dims=effective_dims) - union_arm = _union_arm(context.parent) - union_forms = _union_forms(context.parent) - - loaded_children: dict[Path, Any] = {} - - def load_child(f: Any, token: str) -> Any: - """A row's child column (LAK's TAB6 file), loaded from its file, - once per file (SFR's periods may name one table again).""" - path = Path(_strip_quotes(token)) - if path not in loaded_children: - context = attrs.evolve(rows_context, parent=cls) - loaded_children[path] = _load_file_child(f, path, context) - return loaded_children[path] - - # ── Pass 2: block Item-list fields (packagedata, partitions …) ────────── - for block_name, (f, item_cls) in block_item_fields.items(): - block_rows = raw_lower.get(block_name, []) - if not block_rows: - continue - rows = _resolve_open_close_rows(block_rows, context, item_cls, sizes, enabled) - row_list = _parse_rows( - rows, - item_cls, - sizes=sizes, - enabled=enabled, - context=rows_context, - union_arm=union_arm, - union_forms=union_forms, - load_child=load_child, - words=item_list_words(f.type), - ) - if row_list is not None: - init_key = f.alias if (f.alias and not f.alias.startswith("_")) else f.name - kwargs[init_key] = row_list - if (list_io := _list_io(block_rows, row_list, item_cls, rows_context)) is not None: - list_ios[_list_key(f)] = list_io - - # ── Pass 2b: blocks repeating under a record header ────────────────────── - # Read from `raw`, not `raw_lower`: the header keeps its case (a file name). - for block_name, (f, block_cls) in header_block_fields.items(): - header_cls, list_name, item_cls = block_cls.parts() - blocks = [] - for raw_name, rows in raw.items(): - prefix, *header = raw_name.split() - if prefix.lower() != block_name or not header: - continue - rows = _resolve_open_close_rows(rows, context, item_cls, sizes, enabled) - items = _parse_rows( - rows, - item_cls, - sizes=sizes, - enabled=enabled, - context=rows_context, - union_arm=union_arm, - union_forms=union_forms, - ) - blocks.append( - block_cls( - **{block_cls._header: header_cls.from_tokens(header), list_name: items or []} - ) - ) - if blocks: - kwargs[f.alias or f.name] = blocks - - # ── Pass 3: period blocks ──────────────────────────────────────────────── - # At most one fill-forward block per component (enforced by codegen). - kper_rows: dict[int, list] = {} - if fill_forward_blocks: - (fill_forward_block,) = fill_forward_blocks - kper_rows = _group_repeating_rows(raw_lower, fill_forward_blocks, lambda s: int(s) - 1).get( - fill_forward_block, {} - ) - - if kper_rows: - if period_field is not None: - assert period_item_cls is not None # set together with period_field above - spd: dict[int, list | ItemTable] = {} - for kper, block_rows in sorted(kper_rows.items()): - if not block_rows: - # an empty period block turns off every boundary - spd[kper] = [] - continue - rows = _resolve_open_close_rows( - block_rows, context, period_item_cls, sizes, enabled - ) - row_list = _parse_rows( - rows, - period_item_cls, - sizes=sizes, - enabled=enabled, - context=rows_context, - union_arm=union_arm, - union_forms=union_forms, - load_child=load_child, - words=item_list_words(period_field.type), - ) - if row_list is not None: - spd[kper] = row_list - list_io = _list_io(block_rows, row_list, period_item_cls, rows_context) - if list_io is not None: - list_ios[(_list_key(period_field), kper)] = list_io - if spd: - # Use the alias (stress_period_data) as the init kwarg - init_key = period_field.alias if period_field.alias else period_field.name - kwargs[init_key] = spd - - else: - # ── Pass 3b: READARRAY period fields (G/A variants) ───────────── - # Packages like Rcha/Chdg store full-grid arrays per stress period. - # Each field is fill_forward and a dict[int, Int|FloatArrayLike] - # keyed by period -- not an Item-list (else period_field would be - # set above). - ra_fields = { - f.name: f - for f in attrs.fields(cls) - if f.metadata.get("fill_forward") - and f.name not in repeating_array_fields - and to_field_type(f.type) in ("integer", "double") - and f.init is not False - and not f.metadata.get("fk") - } - # Dynamically named arrays (RCHA's aux), one per name in the field the fk - # points at: written under the name, not the field's. - named: dict[str, tuple[Any, str]] = { - str(n).lower(): (f, str(n)) - for f in attrs.fields(cls) - if f.metadata.get("fill_forward") and (fk := f.metadata.get("fk")) - for n in _names(kwargs.get(fk.rsplit(".", 1)[-1])) - } - if ra_fields and dims: - grid = is_grid_package(cls) - - # Each field holds the periods the file gives (see - # flopy4.mf6.period_arrays). An empty grid period block - # clears every boundary: its stress arrays are None. - periods: dict[str, dict[int, np.ndarray | TimeArraySeriesRef | None]] = {} - named_periods: dict[str, dict[int, dict[str, np.ndarray | TimeArraySeriesRef]]] = {} - # An auxiliary name that matches a field's (Q) is the aux - # array, as in MF6. - lookup = ra_fields | {k: f for k, (f, _) in named.items()} - for kper, rows in sorted(kper_rows.items()): - if not rows: - if grid: - for fname in ra_fields: - periods.setdefault(fname, {})[kper] = None - continue - period_ios: dict = {} - parsed = _parse_readarray_period_block(rows, lookup, dims, context, period_ios) - for k, io in period_ios.items(): - name_, *layer = (k,) if isinstance(k, str) else k - if name_ not in named: - array_ios[(name_, kper, *layer)] = io - for key, arr in parsed.items(): - if key in named: - f, aux_name = named[key] - named_periods.setdefault(f.name, {}).setdefault(kper, {})[aux_name] = ( - arr - ) - else: - periods.setdefault(key, {})[kper] = arr - kwargs.update(periods) - kwargs.update(named_periods) - - # ── Pass 3c: array fields whose own block repeats (utl-tas.tas_array is - # the only current DFN example) ────────────────────────────────────────── - # No `layered` form (single flat control record, always) -- confirmed - # every current field of this shape is only ever consumed by - # single-layer array packages (their own array fields are likewise - # ncpl-shaped, no layered form), so the flat length is ncpl, not the - # full-grid nodes count. Same derivation as Pass 3b's READARRAY period - # fields. Row grouping (by "{block} {header}" prefix, cast header value) - # is the same mechanic Pass 3 uses for "period" -- see - # _group_repeating_rows -- just with a no-offset header cast to the - # field's own dict key type instead of period's int/-1 one. - if repeating_array_fields: - effective_dims = dims or _self_dims_from_kwargs(kwargs) - nodes = effective_dims.get("nodes", 0) - if nodes: - nlay = effective_dims.get("nlay", 1) - ncpl = nodes // nlay if nlay > 1 else nodes - for fname, f in repeating_array_fields.items(): - block = f.metadata["block"] - key_type = repeating_array_key_type(f.type) - series_rows = _group_repeating_rows(raw_lower, {block}, key_type).get(block) - if not series_rows: - continue - dtype = np.int64 if to_field_type(f.type) == "integer" else np.float64 - length = _griddata_flat_length(f, effective_dims, ncpl) - series: dict[Any, np.ndarray] = {} - for header, rows in sorted(series_rows.items()): - if not rows: - continue - value, _ = _read_control_record(parts(rows), 0, context, dtype, length, fname) - series[header] = value - if series: - init_key = f.alias if f.alias else fname - kwargs[init_key] = series - - # ── Pass 4: array blocks (griddata, connectiondata) ────────────────────── - # A DimensionProvider (Dis/Disv/Disu) has no external `dims` the first - # time it's loaded -- it *is* the dims source. Its own array blocks still - # need shapes, derived from the DIMENSIONS block Pass 1 already parsed - # into kwargs above. A no-op ({}) for any other class, which just falls - # through to the `dims` param threaded from an already-loaded sibling. - effective_dims = dims or _self_dims_from_kwargs(kwargs) - if effective_dims: - for block_name, block_fields in array_fields.items(): - if rows := raw_lower.get(block_name): - kwargs.update( - _parse_array_block(rows, block_fields, effective_dims, context, array_ios) - ) - - kwargs.update(binding_kwargs) - if name is not None: - kwargs["name"] = name - if array_ios or list_ios: - # write the arrays and lists back the way the file wrote them - kwargs["write_context"] = WriteContext(arrays=array_ios, lists=list_ios) + load = _Load(cls, context) + found = _occurrences(raw, cls) + for block_name, block in (dfn(cls).blocks or {}).items(): + if block_name in found: + load.read(block_name, block, found[block_name]) - return cls(**kwargs) + return load.finish(name) diff --git a/flopy4/mf6/dfns/chf-cdb.toml b/flopy4/mf6/dfns/chf-cdb.toml new file mode 100644 index 000000000..5c58fef0a --- /dev/null +++ b/flopy4/mf6/dfns/chf-cdb.toml @@ -0,0 +1,289 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "chf-cdb" +parent = "chf-nam" +ftype = "CDB6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of critical depth boundary cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of critical depth boundary information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of critical depth boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save flows to budget file" +description = "keyword to indicate that critical depth boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CDB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CDB package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of critical depth boundaries" +description = "integer value specifying the maximum number of critical depth boundary cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.idcxs] +type = "integer" +longname = "cross section identifier" +description = "is the identifier for the cross section specified in the CXS Package. A value of zero indicates the zero-depth-gradient calculation will use parameters for a hydraulically wide channel." +tagged = false +index = true +fk = "chf-cxs.packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.fields.width] +type = "double" +longname = "width of the zero-depth gradient boundary" +description = "is the channel width of the zero-depth gradient boundary. If a cross section is associated with this boundary, the width will be scaled by the cross section information. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "zero-depth-gradient boundary name" +description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: idcxs, 1: width." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "CDB" +output = true +obs_type = "CDB" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "CDB-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.cdb] +type = "union" + +[observations.cdb.arms.cellid] +type = "cellid" +tagged = false + +[observations.cdb.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/chf-chd.toml b/flopy4/mf6/dfns/chf-chd.toml new file mode 100644 index 000000000..2ae47358f --- /dev/null +++ b/flopy4/mf6/dfns/chf-chd.toml @@ -0,0 +1,295 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "chf-chd" +parent = "chf-nam" +ftype = "CHD6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of CHD head value." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of constant-head cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of constant-head information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print CHD flows to listing file" +description = "keyword to indicate that the list of constant-head flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save CHD flows to budget file" +description = "keyword to indicate that constant-head flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of constant heads" +description = "integer value specifying the maximum number of constant-head cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.head] +type = "double" +longname = "head value assigned to constant head" +description = "is the head at the boundary. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "constant head boundary name" +description = "name of the constant head boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: head." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "CHD" +output = true +obs_type = "CHD" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.chd] +type = "union" + +[observations.chd.arms.cellid] +type = "cellid" +tagged = false + +[observations.chd.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/chf-cxs.toml b/flopy4/mf6/dfns/chf-cxs.toml new file mode 100644 index 000000000..fe60b1049 --- /dev/null +++ b/flopy4/mf6/dfns/chf-cxs.toml @@ -0,0 +1,107 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "chf-cxs" +parent = "chf-nam" +ftype = "CXS6" + +[dims.nsections] +value = "nsections" + +[dims.npoints] +value = "npoints" + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of stream reach information will be written to the listing file immediately after it is read." +optional = true + +[blocks.dimensions.fields.nsections] +type = "integer" +longname = "number of reaches" +description = "integer value specifying the number of cross sections that will be defined. There must be NSECTIONS entries in the PACKAGEDATA block." + +[blocks.dimensions.fields.npoints] +type = "integer" +longname = "total number of points defined for all reaches" +description = "integer value specifying the total number of cross-section points defined for all reaches. There must be NPOINTS entries in the CROSSSECTIONDATA block." + +[blocks.packagedata.fields.packagedata] +type = "list" +shape = [ + "nsections", +] + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.ifno] +type = "integer" +longname = "cross section number for this entry" +description = "integer value that defines the feature (cross section) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NSECTIONS. Information must be specified for every section or the program will terminate with an error. The program will also terminate with an error if information for a section is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.nxspoints] +type = "integer" +longname = "number of points used to define cross section" +description = "integer value that defines the number of points used to define the define the shape of a section. NXSPOINTS must be greater than 1 or the program will terminate with an error. NXSPOINTS defines the number of points that must be entered for the reach in the CROSSSECTIONDATA block. The sum of NXSPOINTS for all sections must equal the NPOINTS dimension." +tagged = false + +[blocks.crosssectiondata.fields.crosssectiondata] +type = "list" +shape = [ + "npoints", +] + +[blocks.crosssectiondata.fields.crosssectiondata.item] +name = "crosssectiondata" +type = "record" + +[blocks.crosssectiondata.fields.crosssectiondata.item.fields.ifno] +type = "integer" +longname = "cross section number for this entry" +description = "integer value that defines the feature (cross section) number associated with the specified CROSSSECTIONDATA data on the line. IFNO must be greater than zero and less than or equal to NSECTIONS. IFNO must be the same for consecutive entries corresponding to the same cross section, and there must be NXSPOINTS consecutive entries, as specified in PACKAGEDATA, for each cross section." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.crosssectiondata.fields.crosssectiondata.item.fields.xfraction] +type = "double" +longname = "fractional width" +description = "real value that defines the station (x) data for the cross-section as a fraction of the width (WIDTH) of the reach. XFRACTION must be greater than or equal to zero but can be greater than one. XFRACTION values can be used to decrease or increase the width of a reach from the specified reach width (WIDTH)." +tagged = false + +[blocks.crosssectiondata.fields.crosssectiondata.item.fields.height] +type = "double" +longname = "depth" +description = "real value that is the height relative to the top of the lowest elevation of the streambed (ELEVATION) and corresponding to the station data on the same line. HEIGHT must be greater than or equal to zero and at least one cross-section height must be equal to zero." +tagged = false + +[blocks.crosssectiondata.fields.crosssectiondata.item.fields.manfraction] +type = "double" +longname = "Manning's roughness coefficient" +description = "real value that defines the Manning's roughness coefficient data for the cross-section as a fraction of the Manning's roughness coefficient for the reach (MANNINGSN) and corresponding to the station data on the same line. MANFRACTION must be greater than zero. MANFRACTION is applied from the XFRACTION value on the same line to the XFRACTION value on the next line." +tagged = false + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.ifno_pkgdata] +set_in = "ar" +source = "ifno" +type = "integer" + +[memory.nsections] +set_in = "ar" +source = "nsections" +type = "integer" + +[memory.npoints] +set_in = "ar" +source = "npoints" +type = "integer" diff --git a/flopy4/mf6/dfns/chf-dfw.toml b/flopy4/mf6/dfns/chf-dfw.toml new file mode 100644 index 000000000..c61ba9ee5 --- /dev/null +++ b/flopy4/mf6/dfns/chf-dfw.toml @@ -0,0 +1,159 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "chf-dfw" +parent = "chf-nam" +ftype = "DFW6" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.central_in_space] +type = "keyword" +longname = "use central in space weighting" +description = "keyword to indicate conductance should be calculated using central-in-space weighting instead of the default upstream weighting approach. This option should be used with caution as it does not work well unless all of the stream reaches are saturated. With this option, there is no way for water to flow into a dry reach from connected reaches." +optional = true + +[blocks.options.fields.length_conversion] +type = "double" +longname = "length conversion factor" +description = "real value that is used to convert user-specified Manning's roughness coefficients from meters to model length units. LENGTH_CONVERSION should be set to 3.28081, 1.0, and 100.0 when using length units (LENGTH_UNITS) of feet, meters, or centimeters in the simulation, respectively. LENGTH_CONVERSION does not need to be specified if LENGTH_UNITS are meters." +optional = true + +[blocks.options.fields.time_conversion] +type = "double" +longname = "time conversion factor" +description = "real value that is used to convert user-specified Manning's roughness coefficients from seconds to model time units. TIME_CONVERSION should be set to 1.0, 60.0, 3,600.0, 86,400.0, and 31,557,600.0 when using time units (TIME_UNITS) of seconds, minutes, hours, days, or years in the simulation, respectively. TIME_CONVERSION does not need to be specified if TIME_UNITS are seconds." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "keyword to save DFW flows" +description = "keyword to indicate that budget flow terms will be written to the file specified with 'BUDGET SAVE FILE' in Output Control." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "keyword to print DFW flows to listing file" +description = "keyword to indicate that calculated flows between cells will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period. This option can produce extremely large list files because all cell-by-cell flows are printed. It should only be used with the DFW Package for models that have a small number of cells." +optional = true + +[blocks.options.fields.save_velocity] +type = "keyword" +longname = "keyword to save velocity" +description = "keyword to indicate that x, y, and z components of velocity will be calculated at cell centers and written to the budget file, which is specified with 'BUDGET SAVE FILE' in Output Control. If this option is activated, then additional information may be required in the discretization packages and the GWF Exchange package (if GWF models are coupled). Specifically, ANGLDEGX must be specified in the CONNECTIONDATA block of the DISU Package; ANGLDEGX must also be specified for the GWF Exchange as an auxiliary variable." +optional = true + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.dev_swr_conductance] +type = "keyword" +longname = "use SWR conductance formulation" +description = "use the conductance formulation in the Surface Water Routing (SWR) Process for MODFLOW-2005." +optional = true +developmode = true + +[blocks.griddata.fields.manningsn] +type = "array" +longname = "mannings roughness coefficient" +description = "mannings roughness coefficient" +optional = true +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.idcxs] +type = "array" +longname = "cross section number" +description = "integer value indication the cross section identifier in the Cross Section Package that applies to the reach. If not provided then reach will be treated as hydraulically wide." +optional = true +dtype = "integer" +index = true +fk = "chf-cxs.packagedata.ifno" +shape = [ + "nodes", +] + +[memory.icentral] +set_in = "ar" +source = "central_in_space" +type = "integer" + +[memory.lengthconv] +set_in = "ar" +source = "length_conversion" +type = "double" + +[memory.timeconv] +set_in = "ar" +source = "time_conversion" +type = "double" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.isavvelocity] +set_in = "ar" +source = "save_velocity" +type = "integer" + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.iswrcond] +set_in = "ar" +source = "dev_swr_conductance" +type = "integer" + +[memory.manningsn] +type = "array" +set_in = "ar" +source = "manningsn" +dtype = "double" +shape = [ + "nodes", +] + +[memory.idcxs] +type = "array" +set_in = "ar" +source = "idcxs" +dtype = "integer" +shape = [ + "nodes", +] + +[observations.ext-outflow] +type = "integer" +tagged = false +index = true diff --git a/flopy4/mf6/dfns/chf-disv1d.toml b/flopy4/mf6/dfns/chf-disv1d.toml new file mode 100644 index 000000000..c9bdb068a --- /dev/null +++ b/flopy4/mf6/dfns/chf-disv1d.toml @@ -0,0 +1,258 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "chf-disv1d" +parent = "chf-nam" +ftype = "DISV1D6" + +[dims.nodes] +value = "nodes" +scope = "model" + +[dims.nvert] +value = "nvert" +scope = "model" + +[dims.ncelldim] +value = "1" +scope = "model" + +[runtime_dims.nodes] +set_in = "ar" + +[runtime_dims.nodesuser] +set_in = "ar" + +[blocks.options.fields.length_units] +type = "string" +longname = "model length units" +description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." +optional = true + +[blocks.options.fields.nogrb] +type = "keyword" +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." +optional = true + +[blocks.options.fields.grb_filerecord] +type = "record" +optional = true + +[blocks.options.fields.grb_filerecord.fields.grb6] +type = "keyword" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" + +[blocks.options.fields.xorigin] +type = "double" +longname = "x-position origin of the model grid coordinate system" +description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.yorigin] +type = "double" +longname = "y-position origin of the model grid coordinate system" +description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.angrot] +type = "double" +longname = "rotation angle" +description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.crs] +type = "string" +longname = "CRS user input string" +description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true +case_sensitive = true + +[blocks.dimensions.fields.nodes] +type = "integer" +longname = "number of linear features" +description = "is the number of linear cells." + +[blocks.dimensions.fields.nvert] +type = "integer" +longname = "number of vertices" +description = "is the total number of (x, y, z) vertex pairs used to characterize the model grid." +optional = true + +[blocks.griddata.fields.width] +type = "array" +longname = "width" +description = "real value that defines the width for each one-dimensional cell. WIDTH must be greater than zero. If the Cross Section (CXS) Package is used, then the WIDTH value will be multiplied by the specified cross section x-fraction values." +optional = true +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.bottom] +type = "array" +longname = "bottom elevation for the one-dimensional cell" +description = "bottom elevation for the one-dimensional cell." +optional = true +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.idomain] +type = "array" +longname = "idomain existence array" +description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation." +optional = true +dtype = "integer" +shape = [ + "nodes", +] + +[blocks.vertices.fields.vertices] +type = "list" +longname = "vertices data" +shape = [ + "nvert", +] + +[blocks.vertices.fields.vertices.item] +name = "vertices" +type = "record" + +[blocks.vertices.fields.vertices.item.fields.iv] +type = "integer" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +tagged = false +index = true +pk = true + +[blocks.vertices.fields.vertices.item.fields.xv] +type = "double" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." +tagged = false + +[blocks.vertices.fields.vertices.item.fields.yv] +type = "double" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." +tagged = false + +[blocks.cell1d.fields.cell1d] +type = "list" +longname = "cell1d data" +shape = [ + "nodes", +] + +[blocks.cell1d.fields.cell1d.item] +name = "cell1d" +type = "record" + +[blocks.cell1d.fields.cell1d.item.fields.icell1d] +type = "integer" +longname = "cell1d number" +description = "is the cell1d number. Records in the cell1d block must be listed in consecutive order from the first to the last." +tagged = false +index = true +pk = true + +[blocks.cell1d.fields.cell1d.item.fields.fdc] +type = "double" +longname = "fractional distance to the cell center" +description = "is the fractional distance to the cell center. FDC is relative to the first vertex in the ICVERT array. In most cases FDC should be 0.5, which would place the center of the line segment that defines the cell. If the value of FDC is 1, the cell center would located at the last vertex. FDC values of 0 and 1 can be used to place the node at either end of the cell which can be useful for cells with boundary conditions." +tagged = false + +[blocks.cell1d.fields.cell1d.item.fields.ncvert] +type = "integer" +longname = "number of cell vertices" +description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." +tagged = false + +[blocks.cell1d.fields.cell1d.item.fields.icvert] +type = "array" +longname = "number of cell vertices" +description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC." +tagged = false +dtype = "integer" +index = true +shape = [ + "ncvert", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.nodes] +set_in = "ar" +source = "nodes" +type = "integer" + +[memory.nvert] +set_in = "ar" +source = "nvert" +type = "integer" + +[memory.width] +type = "array" +set_in = "ar" +source = "width" +dtype = "double" +shape = [ + "nodes", +] + +[memory.bottom] +type = "array" +set_in = "ar" +source = "bottom" +dtype = "double" +shape = [ + "nodes", +] + +[memory.idomain] +type = "array" +set_in = "ar" +source = "idomain" +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodeuser] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodereduced] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." +dtype = "integer" +shape = [ + "nodesuser", +] diff --git a/flopy4/mf6/dfns/chf-evp.toml b/flopy4/mf6/dfns/chf-evp.toml new file mode 100644 index 000000000..419888bdd --- /dev/null +++ b/flopy4/mf6/dfns/chf-evp.toml @@ -0,0 +1,295 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "chf-evp" +parent = "chf-nam" +ftype = "EVP6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of evaporation." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of evaporation cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of evaporation information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print evaporation rates to listing file" +description = "keyword to indicate that the list of evaporation flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save evaporation to budget file" +description = "keyword to indicate that evaporation flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the EVP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVP package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of evaporation cells" +description = "integer value specifying the maximum number of evaporation cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.evaporation] +type = "double" +longname = "evaporation rate" +description = "is the evaporation flux rate ($LT^{-1}$). This rate is multiplied inside the program by the water surface area of the cell to calculate the volumetric evaporation rate. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "evaporation name" +description = "name of the evaporation cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: evaporation." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "EVP" +output = true +obs_type = "EVP" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.evp] +type = "union" + +[observations.evp.arms.cellid] +type = "cellid" +tagged = false + +[observations.evp.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/chf-flw.toml b/flopy4/mf6/dfns/chf-flw.toml new file mode 100644 index 000000000..b3f31ef96 --- /dev/null +++ b/flopy4/mf6/dfns/chf-flw.toml @@ -0,0 +1,308 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "chf-flw" +parent = "chf-nam" +ftype = "FLW6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of flow rate." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of inflow cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of inflow information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of inflow flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save well flows to budget file" +description = "keyword to indicate that inflow flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the FLW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the FLW package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of inflow" +description = "integer value specifying the maximum number of inflow cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.q] +type = "double" +longname = "well rate" +description = "is the volumetric inflow rate. A positive value indicates inflow to the stream. Negative values are not allows. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "inflow name" +description = "name of the inflow cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: q." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "FLW" +output = true +obs_type = "FLW" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "FLW-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.flw] +type = "union" + +[observations.flw.arms.cellid] +type = "cellid" +tagged = false + +[observations.flw.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/chf-ic.toml b/flopy4/mf6/dfns/chf-ic.toml new file mode 100644 index 000000000..d650d0381 --- /dev/null +++ b/flopy4/mf6/dfns/chf-ic.toml @@ -0,0 +1,39 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "chf-ic" +parent = "chf-nam" +ftype = "IC6" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.griddata.fields.strt] +type = "array" +longname = "starting concentration" +description = "is the initial (starting) stage---that is, stage at the beginning of the CHF Model simulation. STRT must be specified for all CHF Model simulations. One value is read for every model reach." +default = 0.0 +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.strt] +type = "array" +set_in = "ar" +source = "strt" +dtype = "double" +shape = [ + "nodes", +] diff --git a/flopy4/mf6/dfns/chf-nam.toml b/flopy4/mf6/dfns/chf-nam.toml new file mode 100644 index 000000000..5ec3fc03d --- /dev/null +++ b/flopy4/mf6/dfns/chf-nam.toml @@ -0,0 +1,167 @@ +type = "model" +schema_version = "2.0.0.dev3" +name = "chf-nam" +parent = "sim-nam" +ftype = "CHF6" +dependent_variable = "stage" + +[runtime_dims.nja] +set_in = "ar" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.list] +type = "string" +longname = "name of listing file" +description = "is name of the listing file to create for this CHF model. If not specified, then the name of the list file will be the basename of the CHF model name file and the '.lst' extension. For example, if the CHF name file is called 'my.model.nam' then the list file will be called 'my.model.lst'." +optional = true +case_sensitive = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save flows for all packages to budget file" +description = "keyword to indicate that all model package flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.newtonoptions] +type = "record" +longname = "newton keyword and options" +description = "none" +optional = true + +[blocks.options.fields.newtonoptions.fields.newton] +type = "keyword" +longname = "keyword to activate Newton-Raphson formulation" +description = "keyword that activates the Newton-Raphson formulation for surface water flow between connected reaches and stress packages that support calculation of Newton-Raphson terms." + +[blocks.options.fields.newtonoptions.fields.under_relaxation] +type = "keyword" +longname = "keyword to activate Newton-Raphson UNDER_RELAXATION option" +description = "keyword that indicates whether the surface water stage in a reach will be under-relaxed when water levels fall below the bottom of the model below any given cell. By default, Newton-Raphson UNDER_RELAXATION is not applied." +optional = true + +[blocks.packages.fields.packages] +type = "list" +longname = "package list" + +[blocks.packages.fields.packages.item] +name = "packages" +type = "record" + +[blocks.packages.fields.packages.item.fields.ftype] +type = "string" +longname = "package type" +description = "is the file type, which must be one of the following character values shown in table~ref{table:ftype-chf}. Ftype may be entered in any combination of uppercase and lowercase." +tagged = false + +[blocks.packages.fields.packages.item.fields.fname] +type = "file" +longname = "file name" +description = "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run." +tagged = false +direction = "in" +mode_keyword = false +component = "package" +component_ftype = "ftype" + +[blocks.packages.fields.packages.item.fields.pname] +type = "string" +longname = "user name for package" +description = "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single CHF Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters." +optional = true +tagged = false +pk = true + +[memory.x] +type = "array" +set_in = "ca" +description = "Stage for each model cell. Checked in from the solution-level dependent-variable vector (or directly allocated when the DFW package is absent). Initialized by the IC package during AR; updated by the nonlinear solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." +obs_type = "STAGE" +dtype = "double" +shape = [ + "nodes", +] + +[memory.xold] +type = "array" +readonly = true +set_in = "ad" +description = "Dependent variable from the end of the previous time step. Copied from X at advance (AD); used to restore X if the adaptive time stepping scheme retries a failed time step." +dtype = "double" +shape = [ + "nodes", +] + +[memory.flowja] +type = "array" +readonly = true +set_in = "cq" +description = "Intercell flows in compressed sparse row (CSR) order, calculated after solution convergence. Diagonal entries hold the flow residual." +budget = "FLOW-JA-FACE" +dtype = "double" +shape = [ + "nja", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution for this model, sliced from the solution-level RHS vector. Rebuilt each solver iteration." +dtype = "double" +shape = [ + "nodes", +] + +[memory.ibound] +type = "array" +set_in = "ar" +description = "Cell activity flag: positive values indicate active cells, zero indicates inactive (no-flow) cells. Set during model initialisation; may change when Newton-Raphson wet-dry logic activates or deactivates cells." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.neq] +readonly = true +set_in = "ar" +description = "Number of equations (unknowns) for this model. Equal to the number of active cells (NODES) for standard models." +type = "integer" + +[memory.idxglo] +type = "array" +readonly = true +set_in = "mc" +description = "Maps each local CSR position to the corresponding row/column index in the global solution matrix. Populated during matrix connectivity (MC) and constant thereafter." +dtype = "integer" +shape = [ + "nja", +] + +[observations.stage] +type = "cellid" +tagged = false + +[observations.flow-ja-face] +type = "record" + +[observations.flow-ja-face.fields.cellid] +type = "cellid" +tagged = false + +[observations.flow-ja-face.fields.cellid2] +type = "cellid" +tagged = false diff --git a/flopy4/mf6/dfns/chf-oc.toml b/flopy4/mf6/dfns/chf-oc.toml new file mode 100644 index 000000000..c943f9d4d --- /dev/null +++ b/flopy4/mf6/dfns/chf-oc.toml @@ -0,0 +1,223 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "chf-oc" +parent = "chf-nam" +ftype = "OC6" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information. Data are written to this file only for time steps in which SAVE BUDGET is specified in a PERIOD block. If SAVE BUDGET is specified in a PERIOD block and this file is not specified, MODFLOW 6 will terminate with an error." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. If specified, a budget summary record will be written to this file for every time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.qoutflow_filerecord] +type = "record" +optional = true + +[blocks.options.fields.qoutflow_filerecord.fields.qoutflow] +type = "keyword" +longname = "qoutflow keyword" +description = "keyword to specify that record corresponds to qoutflow." + +[blocks.options.fields.qoutflow_filerecord.fields.qoutflowfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write conc information." +tagged = false +direction = "out" + +[blocks.options.fields.stage_filerecord] +type = "record" +optional = true + +[blocks.options.fields.stage_filerecord.fields.stage] +type = "keyword" +longname = "stage keyword" +description = "keyword to specify that record corresponds to stage." + +[blocks.options.fields.stage_filerecord.fields.stagefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write stage information." +tagged = false +direction = "out" + +[blocks.options.fields.qoutflowprintrecord] +type = "record" +optional = true + +[blocks.options.fields.qoutflowprintrecord.fields.qoutflow] +type = "keyword" +longname = "qoutflow keyword" +description = "keyword to specify that record corresponds to qoutflow." + +[blocks.options.fields.qoutflowprintrecord.fields.print_format] +type = "keyword" +longname = "keyword to indicate that a print format follows" +description = "keyword to specify format for printing to the listing file." + +[blocks.options.fields.qoutflowprintrecord.fields.formatrecord] +type = "record" + +[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.columns] +type = "integer" +longname = "number of columns" +description = "number of columns for writing data." +optional = true + +[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.width] +type = "integer" +longname = "width for each number" +description = "width for writing each number." +optional = true + +[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.digits] +type = "integer" +longname = "number of digits" +description = "number of digits to use for writing a number." +optional = true + +[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.format] +type = "string" +longname = "write format" +description = "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC." +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" +optional = true + +[blocks.period.fields.stress_period_data.item] +name = "output_record" +type = "union" + +[blocks.period.fields.stress_period_data.item.arms.saverecord] +type = "record" +optional = true + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.save] +type = "keyword" +longname = "keyword to save" +description = "keyword to indicate that information will be saved this stress period." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.rtype] +type = "string" +longname = "record type" +description = "type of information to save or print. Can be BUDGET." +tagged = false +valid = [ + "STAGE", + "BUDGET", +] + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting] +type = "union" +description = "specifies the steps for which the data will be saved." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.all] +type = "keyword" +description = "keyword to indicate save for all time steps in period." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.first] +type = "keyword" +description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.last] +type = "keyword" +description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.frequency] +type = "integer" +description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.steps] +type = "array" +description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." +dtype = "integer" +shape = [ + "<=nstp", +] + +[blocks.period.fields.stress_period_data.item.arms.printrecord] +type = "record" +optional = true + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.print] +type = "keyword" +longname = "keyword to save" +description = "keyword to indicate that information will be printed this stress period." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.rtype] +type = "string" +longname = "record type" +description = "type of information to save or print. Can be BUDGET." +tagged = false +valid = [ + "STAGE", + "BUDGET", +] + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting] +type = "union" +description = "specifies the steps for which the data will be saved." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.all] +type = "keyword" +description = "keyword to indicate save for all time steps in period." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.first] +type = "keyword" +description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.last] +type = "keyword" +description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.frequency] +type = "integer" +description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.steps] +type = "array" +description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." +dtype = "integer" +shape = [ + "<=nstp", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true diff --git a/flopy4/mf6/dfns/chf-pcp.toml b/flopy4/mf6/dfns/chf-pcp.toml new file mode 100644 index 000000000..280b4b418 --- /dev/null +++ b/flopy4/mf6/dfns/chf-pcp.toml @@ -0,0 +1,295 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "chf-pcp" +parent = "chf-nam" +ftype = "PCP6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of precipitation." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of precipitation cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of precipitation information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print precipitation rates to listing file" +description = "keyword to indicate that the list of precipitation flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save precipitation to budget file" +description = "keyword to indicate that precipitation flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the PCP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the PCP package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of precipitation cells" +description = "integer value specifying the maximum number of precipitation cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.precipitation] +type = "double" +longname = "precipitation rate" +description = "is the precipitation flux rate ($LT^{-1}$). This rate is multiplied inside the program by the surface area of the cell to calculate the volumetric precipitation rate. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "precipitation name" +description = "name of the precipitation cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: precipitation." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "PCP" +output = true +obs_type = "PCP" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.pcp] +type = "union" + +[observations.pcp.arms.cellid] +type = "cellid" +tagged = false + +[observations.pcp.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/chf-sto.toml b/flopy4/mf6/dfns/chf-sto.toml new file mode 100644 index 000000000..4cf4b2172 --- /dev/null +++ b/flopy4/mf6/dfns/chf-sto.toml @@ -0,0 +1,53 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "chf-sto" +parent = "chf-nam" +ftype = "STO6" + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "keyword to save NPF flows" +description = "keyword to indicate that cell-by-cell flow terms will be written to the file specified with 'BUDGET SAVE FILE' in Output Control." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input grid arrays, which already support the layered keyword, should be written to layered ascii output files." +optional = true + +[blocks.period.fields.stress_period_data] +type = "string" +longname = "storage state" +description = "keyword to indicate that stress period IPER is steady-state. Steady-state conditions will apply until the TRANSIENT keyword is specified in a subsequent BEGIN PERIOD block." +optional = true +tagged = false +valid = [ + "steady-state", + "transient", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.steady_state] +set_in = "rp" +type = "logical" diff --git a/flopy4/mf6/dfns/chf-zdg.toml b/flopy4/mf6/dfns/chf-zdg.toml new file mode 100644 index 000000000..54bb7d1ed --- /dev/null +++ b/flopy4/mf6/dfns/chf-zdg.toml @@ -0,0 +1,324 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "chf-zdg" +parent = "chf-nam" +ftype = "ZDG6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of zero-depth-gradient boundary cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of zero-depth-gradient boundary information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of zero-depth-gradient boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save flows to budget file" +description = "keyword to indicate that zero-depth-gradient boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the ZDG package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ZDG package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of zero-depth-gradient boundaries" +description = "integer value specifying the maximum number of zero-depth-gradient boundary cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.idcxs] +type = "integer" +longname = "cross section identifier" +description = "is the identifier for the cross section specified in the CXS Package. A value of zero indicates the zero-depth-gradient calculation will use parameters for a hydraulically wide channel." +tagged = false +index = true +fk = "chf-cxs.packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.fields.width] +type = "double" +longname = "width of the zero-depth gradient boundary" +description = "is the channel width of the zero-depth gradient boundary. If a cross section is associated with this boundary, the width will be scaled by the cross section information. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.slope] +type = "double" +longname = "channel slope" +description = "is the channel slope used to calculate flow to the zero-depth-gradient boundary. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.rough] +type = "double" +longname = "channel roughness" +description = "is the Manning channel roughness value used to calculate flow to the zero-depth-gradient boundary. If a cross section is associated with this boundary, the roughness value will be multiplied by the roughness fraction for each part of the cross section. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "zero-depth-gradient boundary name" +description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: idcxs, 1: width, 2: slope, 3: rough." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "ZDG" +output = true +obs_type = "ZDG" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "ZDG-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.zdg] +type = "union" + +[observations.zdg.arms.cellid] +type = "cellid" +tagged = false + +[observations.zdg.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/exg-chfgwf.toml b/flopy4/mf6/dfns/exg-chfgwf.toml new file mode 100644 index 000000000..de1fa8925 --- /dev/null +++ b/flopy4/mf6/dfns/exg-chfgwf.toml @@ -0,0 +1,147 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "exg-chfgwf" +parent = "sim-nam" +ftype = "CHF6-GWF6" +multi = true +subtype = "exchange" + +[dims.nexg] +value = "nexg" + +[blocks.options.fields.print_input] +type = "keyword" +longname = "keyword to print input to list file" +description = "keyword to indicate that the list of exchange entries will be echoed to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "keyword to print chfgwf flows to list file" +description = "keyword to indicate that the list of exchange flow rates will be printed to the listing file for every stress period in which 'SAVE BUDGET' is specified in Output Control." +optional = true + +[blocks.options.fields.fixed_conductance] +type = "keyword" +longname = "keyword to indicate conductance is fixed" +description = "keyword to indicate that the product of the bedleak and cfact input variables in the exchangedata block represents conductance. This conductance is fixed and does not change as a function of head in the surface water and groundwater models." +optional = true + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the SWF-GWF package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.nexg] +type = "integer" +longname = "number of exchanges" +description = "keyword and integer value specifying the number of SWF-GWF exchanges." + +[blocks.exchangedata.fields.exchangedata] +type = "list" +longname = "exchange data" +shape = [ + "nexg", +] + +[blocks.exchangedata.fields.exchangedata.item] +name = "exchangedata" +type = "record" + +[blocks.exchangedata.fields.exchangedata.item.fields.cellidm1] +type = "cellid" +longname = "cellid of cell in surface water model" +description = "is the cellid of the cell in model 1, which must be the surface water model. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell." +tagged = false +model = "1" + +[blocks.exchangedata.fields.exchangedata.item.fields.cellidm2] +type = "cellid" +longname = "cellid of cell in groundwater model" +description = "is the cellid of the cell in model 2, which must be the groundwater model. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell." +tagged = false +model = "2" + +[blocks.exchangedata.fields.exchangedata.item.fields.bedleak] +type = "double" +longname = "bed leakance" +description = "is the leakance between the surface water and groundwater. bedleak has dimensions of 1/T and is equal to the hydraulic conductivity of the bed sediments divided by the thickness of the bed sediments." +tagged = false + +[blocks.exchangedata.fields.exchangedata.item.fields.cfact] +type = "double" +longname = "factor used for conductance calculation" +description = "is the factor used for the conductance calculation. The definition for this parameter depends the type of surface water model and whether or not the fixed_conductance option is specified. If the fixed_conductance option is specified, then the hydraulic conductance is calculated as the product of bedleak and cfact. In this case, the conductance is fixed and does not change as a function of the calculated surface water and groundwater head. If the fixed_conductance option is not specified, then the definition of cfact depends on whether the surface water model represents one-dimensional channel flow or two-dimensional overland flow. If the surface water model represents one-dimensional channel flow, then cfact is the length of the channel cell in the groundwater model cell. If the surface water model represents two-dimensional overland flow, then cfact is the intersection area of the overland flow cell and the underlying groundwater model cell." +tagged = false + +[memory.ipr_input] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.ipr_flow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ifixedcond] +set_in = "ar" +source = "fixed_conductance" +type = "integer" + +[memory.nexg] +set_in = "ar" +source = "nexg" +type = "integer" + +[memory.nodem1] +type = "array" +set_in = "ar" +source = "cellidm1" +description = "Reduced node number in the surface water model for each exchange, derived from CELLIDM1. Registered as NODEM1 in memory though the Fortran field is named NODESWF." +dtype = "integer" +shape = [ + "nexg", +] + +[memory.nodem2] +type = "array" +set_in = "ar" +source = "cellidm2" +description = "Reduced node number in the GWF model for each exchange, derived from CELLIDM2. Registered as NODEM2 in memory though the Fortran field is named NODEGWF." +dtype = "integer" +shape = [ + "nexg", +] + +[memory.bedleak] +type = "array" +set_in = "ar" +source = "bedleak" +description = "Bed leakance for each exchange." +dtype = "double" +shape = [ + "nexg", +] + +[memory.cfact] +type = "array" +set_in = "ar" +source = "cfact" +description = "Factor used in the conductance calculation for each exchange." +dtype = "double" +shape = [ + "nexg", +] diff --git a/flopy4/mf6/dfns/exg-gwegwe.toml b/flopy4/mf6/dfns/exg-gwegwe.toml new file mode 100644 index 000000000..f91cdd8cb --- /dev/null +++ b/flopy4/mf6/dfns/exg-gwegwe.toml @@ -0,0 +1,317 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "exg-gwegwe" +parent = "sim-nam" +ftype = "GWE6-GWE6" +multi = true +subtype = "exchange" + +[dims.nexg] +value = "nexg" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[blocks.options.fields.gwfmodelname1] +type = "string" +longname = "keyword to specify name of first corresponding GWF Model" +description = "keyword to specify name of first corresponding GWF Model. In the simulation name file, the GWE6-GWE6 entry contains names for GWE Models (exgmnamea and exgmnameb). The GWE Model with the name exgmnamea must correspond to the GWF Model with the name gwfmodelname1." + +[blocks.options.fields.gwfmodelname2] +type = "string" +longname = "keyword to specify name of second corresponding GWF Model" +description = "keyword to specify name of second corresponding GWF Model. In the simulation name file, the GWE6-GWE6 entry contains names for GWE Models (exgmnamea and exgmnameb). The GWE Model with the name exgmnameb must correspond to the GWF Model with the name gwfmodelname2." + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "an array of auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided. Most auxiliary variables will not be used by the GWE-GWE Exchange, but they will be available for use by other parts of the program. If an auxiliary variable with the name 'ANGLDEGX' is found, then this information will be used as the angle (provided in degrees) between the connection face normal and the x axis, where a value of zero indicates that a normal vector points directly along the positive x axis. The connection face normal is a normal vector on the cell face shared between the cell in model 1 and the cell in model 2 pointing away from the model 1 cell. Additional information on 'ANGLDEGX' is provided in the description of the DISU Package. If an auxiliary variable with the name 'CDIST' is found, then this information will be used as the straight-line connection distance, including the vertical component, between the two cell centers. Both ANGLDEGX and CDIST are required if specific discharge is calculated for either of the groundwater models." +optional = true +dtype = "string" + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of GWE Exchange cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "keyword to print input to list file" +description = "keyword to indicate that the list of exchange entries will be echoed to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "keyword to print gwfgwf flows to list file" +description = "keyword to indicate that the list of exchange flow rates will be printed to the listing file for every stress period in which 'SAVE BUDGET' is specified in Output Control." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "keyword to save GWFGWF flows" +description = "keyword to indicate that cell-by-cell flow terms will be written to the budget file for each model provided that the Output Control for the models are set up with the 'BUDGET SAVE FILE' option." +optional = true + +[blocks.options.fields.adv_scheme] +type = "string" +longname = "advective scheme" +description = "scheme used to solve the advection term. Can be upstream, central, or TVD. If not specified, upstream weighting is the default weighting scheme." +optional = true +valid = [ + "upstream", + "central", + "tvd", +] + +[blocks.options.fields.cnd_xt3d_off] +type = "keyword" +longname = "deactivate xt3d" +description = "deactivate the xt3d method for the dispersive flux and use the faster and less accurate approximation for this exchange." +optional = true + +[blocks.options.fields.cnd_xt3d_rhs] +type = "keyword" +longname = "xt3d on right-hand side" +description = "add xt3d dispersion terms to right-hand side, when possible, for this exchange." +optional = true + +[blocks.options.fields.mve_filerecord] +type = "record" +optional = true + +[blocks.options.fields.mve_filerecord.fields.mve6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an energy transport mover file." + +[blocks.options.fields.mve_filerecord.fields.mve6_filename] +type = "file" +longname = "mve6 input filename" +description = "is the file name of the transport mover input file to apply to this exchange. Information for the transport mover are provided in the file provided with these keywords." +tagged = false +direction = "in" +component = "gwe-mve" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwe-obstypetable} lists observation type(s) supported by the GWE-GWE Exchange Package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.dev_interfacemodel_on] +type = "keyword" +longname = "activate interface model on exchange" +description = "activates the interface model mechanism for calculating the coefficients at (and possibly near) the exchange. This keyword should only be used for development purposes." +optional = true +developmode = true + +[blocks.dimensions.fields.nexg] +type = "integer" +longname = "number of exchanges" +description = "keyword and integer value specifying the number of GWE-GWE exchanges." + +[blocks.exchangedata.fields.exchangedata] +type = "list" +longname = "exchange data" +shape = [ + "nexg", +] + +[blocks.exchangedata.fields.exchangedata.item] +name = "exchangedata" +type = "record" + +[blocks.exchangedata.fields.exchangedata.item.fields.cellidm1] +type = "cellid" +longname = "cellid of first cell" +description = "is the cellid of the cell in model 1 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell." +tagged = false +model = "1" + +[blocks.exchangedata.fields.exchangedata.item.fields.cellidm2] +type = "cellid" +longname = "cellid of second cell" +description = "is the cellid of the cell in model 2 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell." +tagged = false +model = "2" + +[blocks.exchangedata.fields.exchangedata.item.fields.ihc] +type = "integer" +longname = "integer flag for connection type" +description = "is an integer flag indicating the direction between node n and all of its m connections. If IHC = 0 then the connection is vertical. If IHC = 1 then the connection is horizontal. If IHC = 2 then the connection is horizontal for a vertically staggered grid." +tagged = false + +[blocks.exchangedata.fields.exchangedata.item.fields.cl1] +type = "double" +longname = "connection distance" +description = "is the distance between the center of cell 1 and the its shared face with cell 2." +tagged = false + +[blocks.exchangedata.fields.exchangedata.item.fields.cl2] +type = "double" +longname = "connection distance" +description = "is the distance between the center of cell 2 and the its shared face with cell 1." +tagged = false + +[blocks.exchangedata.fields.exchangedata.item.fields.hwva] +type = "double" +longname = "horizontal cell width or area for vertical flow" +description = "is the horizontal width of the flow connection between cell 1 and cell 2 if IHC $>$ 0, or it is the area perpendicular to flow of the vertical connection between cell 1 and cell 2 if IHC = 0." +tagged = false + +[blocks.exchangedata.fields.exchangedata.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each GWEGWE Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block." +optional = true +tagged = false +dtype = "double" +shape = [ + "auxiliary", +] + +[blocks.exchangedata.fields.exchangedata.item.fields.boundname] +type = "string" +longname = "exchange boundname" +description = "name of the GWE Exchange cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.dev_ifmod_on] +set_in = "ar" +source = "dev_interfacemodel_on" +type = "logical" + +[memory.auxvar] +type = "array" +set_in = "ar" +source = "aux" +description = "Auxiliary variable values for each exchange." +dtype = "double" +shape = [ + "naux", + "nexg", +] + +[memory.nexg] +set_in = "ar" +source = "nexg" +type = "integer" + +[memory.nodem1] +type = "array" +set_in = "ar" +source = "cellidm1" +description = "Reduced node number in model 1 for each exchange, derived from CELLIDM1." +dtype = "integer" +shape = [ + "nexg", +] + +[memory.nodem2] +type = "array" +set_in = "ar" +source = "cellidm2" +description = "Reduced node number in model 2 for each exchange, derived from CELLIDM2." +dtype = "integer" +shape = [ + "nexg", +] + +[memory.ihc] +type = "array" +set_in = "ar" +source = "ihc" +description = "Connection type flag for each exchange: 0 vertical, 1 horizontal, 2 horizontal for a vertically staggered grid." +dtype = "integer" +shape = [ + "nexg", +] + +[memory.cl1] +type = "array" +set_in = "ar" +source = "cl1" +description = "Distance between the center of the model 1 cell and its shared face." +dtype = "double" +shape = [ + "nexg", +] + +[memory.cl2] +type = "array" +set_in = "ar" +source = "cl2" +description = "Distance between the center of the model 2 cell and its shared face." +dtype = "double" +shape = [ + "nexg", +] + +[memory.hwva] +type = "array" +set_in = "ar" +source = "hwva" +description = "Horizontal width of the connection if IHC > 0, or the area perpendicular to flow of the vertical connection if IHC = 0." +dtype = "double" +shape = [ + "nexg", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.flow-ja-face] +type = "union" + +[observations.flow-ja-face.arms.iexg] +type = "integer" +tagged = false +index = true + +[observations.flow-ja-face.arms.boundname] +type = "string" +tagged = false diff --git a/flopy4/mf6/dfns/exg-gwfgwe.toml b/flopy4/mf6/dfns/exg-gwfgwe.toml new file mode 100644 index 000000000..937210bdf --- /dev/null +++ b/flopy4/mf6/dfns/exg-gwfgwe.toml @@ -0,0 +1,6 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "exg-gwfgwe" +parent = "sim-nam" +ftype = "GWF6-GWE6" +subtype = "exchange" diff --git a/flopy4/mf6/dfns/exg-gwfgwf.toml b/flopy4/mf6/dfns/exg-gwfgwf.toml new file mode 100644 index 000000000..545ada77b --- /dev/null +++ b/flopy4/mf6/dfns/exg-gwfgwf.toml @@ -0,0 +1,341 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "exg-gwfgwf" +parent = "sim-nam" +ftype = "GWF6-GWF6" +multi = true +subtype = "exchange" + +[dims.nexg] +value = "nexg" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "an array of auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided. Most auxiliary variables will not be used by the GWF-GWF Exchange, but they will be available for use by other parts of the program. If an auxiliary variable with the name 'ANGLDEGX' is found, then this information will be used as the angle (provided in degrees) between the connection face normal and the x axis, where a value of zero indicates that a normal vector points directly along the positive x axis. The connection face normal is a normal vector on the cell face shared between the cell in model 1 and the cell in model 2 pointing away from the model 1 cell. Additional information on 'ANGLDEGX' and when it is required is provided in the description of the DISU Package. If an auxiliary variable with the name 'CDIST' is found, then this information will be used in the calculation of specific discharge within model cells connected by the exchange. For a horizontal connection, CDIST should be specified as the horizontal distance between the cell centers, and should not include the vertical component. For vertical connections, CDIST should be specified as the difference in elevation between the two cell centers. Both ANGLDEGX and CDIST are required if specific discharge is calculated for either of the groundwater models." +optional = true +dtype = "string" + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of GWF Exchange cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "keyword to print input to list file" +description = "keyword to indicate that the list of exchange entries will be echoed to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "keyword to print gwfgwf flows to list file" +description = "keyword to indicate that the list of exchange flow rates will be printed to the listing file for every stress period in which 'SAVE BUDGET' is specified in Output Control." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "keyword to save GWFGWF flows" +description = "keyword to indicate that cell-by-cell flow terms will be written to the budget file for each model provided that the Output Control for the models are set up with the 'BUDGET SAVE FILE' option." +optional = true + +[blocks.options.fields.cell_averaging] +type = "string" +longname = "conductance weighting option" +description = "is a keyword and text keyword to indicate the method that will be used for calculating the conductance for horizontal cell connections. The text value for CELL_AVERAGING can be 'HARMONIC', 'LOGARITHMIC', or 'AMT-LMK', which means 'arithmetic-mean thickness and logarithmic-mean hydraulic conductivity'. If the user does not specify a value for CELL_AVERAGING, then the harmonic-mean method will be used." +optional = true +valid = [ + "harmonic", + "logarithmic", + "amt-lmk", +] + +[blocks.options.fields.cvoptions] +type = "record" +longname = "vertical conductance options" +description = "none" +optional = true + +[blocks.options.fields.cvoptions.fields.variablecv] +type = "keyword" +longname = "keyword to activate VARIABLECV option" +description = "keyword to indicate that the vertical conductance will be calculated using the saturated thickness and properties of the overlying cell and the thickness and properties of the underlying cell. If the DEWATERED keyword is also specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top. If these keywords are not specified, then the default condition is to calculate the vertical conductance at the start of the simulation using the initial head and the cell properties. The vertical conductance remains constant for the entire simulation." + +[blocks.options.fields.cvoptions.fields.dewatered] +type = "keyword" +longname = "keyword to activate DEWATERED option" +description = "If the DEWATERED keyword is specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top." +optional = true + +[blocks.options.fields.newton] +type = "keyword" +longname = "keyword to activate Newton-Raphson" +description = "keyword that activates the Newton-Raphson formulation for groundwater flow between connected, convertible groundwater cells. Cells will not dry when this option is used." +optional = true + +[blocks.options.fields.xt3d] +type = "keyword" +longname = "keyword to activate XT3D" +description = "keyword that activates the XT3D formulation between the cells connected with this GWF-GWF Exchange." +optional = true + +[blocks.options.fields.gnc_filerecord] +type = "record" +optional = true + +[blocks.options.fields.gnc_filerecord.fields.gnc6] +type = "keyword" +longname = "gnc6 keyword" +description = "keyword to specify that record corresponds to a ghost-node correction file." + +[blocks.options.fields.gnc_filerecord.fields.gnc6_filename] +type = "file" +longname = "gnc6 input filename" +description = "is the file name for ghost node correction input file. Information for the ghost nodes are provided in the file provided with these keywords. The format for specifying the ghost nodes is the same as described for the GNC Package of the GWF Model. This includes specifying OPTIONS, DIMENSIONS, and GNCDATA blocks. The order of the ghost nodes must follow the same order as the order of the cells in the EXCHANGEDATA block. For the GNCDATA, noden and all of the nodej values are assumed to be located in model 1, and nodem is assumed to be in model 2." +tagged = false +direction = "in" +component = "gwf-gnc" + +[blocks.options.fields.mvr_filerecord] +type = "record" +optional = true + +[blocks.options.fields.mvr_filerecord.fields.mvr6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to a mover file." + +[blocks.options.fields.mvr_filerecord.fields.mvr6_filename] +type = "file" +longname = "mvr6 input filename" +description = "is the file name of the water mover input file to apply to this exchange. Information for the water mover are provided in the file provided with these keywords. The format for specifying the water mover information is the same as described for the Water Mover (MVR) Package of the GWF Model, with two exceptions. First, in the PACKAGES block, the model name must be included as a separate string before each package. Second, the appropriate model name must be included before package name 1 and package name 2 in the BEGIN PERIOD block. This allows providers and receivers to be located in both models listed as part of this exchange." +tagged = false +direction = "in" +component = "gwf-mvr" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the GWF-GWF package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.dev_interfacemodel_on] +type = "keyword" +longname = "activate interface model on exchange" +description = "activates the interface model mechanism for calculating the coefficients at (and possibly near) the exchange. This keyword should only be used for development purposes." +optional = true +developmode = true + +[blocks.dimensions.fields.nexg] +type = "integer" +longname = "number of exchanges" +description = "keyword and integer value specifying the number of GWF-GWF exchanges." + +[blocks.exchangedata.fields.exchangedata] +type = "list" +longname = "exchange data" +shape = [ + "nexg", +] + +[blocks.exchangedata.fields.exchangedata.item] +name = "exchangedata" +type = "record" + +[blocks.exchangedata.fields.exchangedata.item.fields.cellidm1] +type = "cellid" +longname = "cellid of first cell" +description = "is the cellid of the cell in model 1 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell." +tagged = false +model = "1" + +[blocks.exchangedata.fields.exchangedata.item.fields.cellidm2] +type = "cellid" +longname = "cellid of second cell" +description = "is the cellid of the cell in model 2 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell." +tagged = false +model = "2" + +[blocks.exchangedata.fields.exchangedata.item.fields.ihc] +type = "integer" +longname = "integer flag for connection type" +description = "is an integer flag indicating the direction between node n and all of its m connections. If IHC = 0 then the connection is vertical. If IHC = 1 then the connection is horizontal. If IHC = 2 then the connection is horizontal for a vertically staggered grid." +tagged = false + +[blocks.exchangedata.fields.exchangedata.item.fields.cl1] +type = "double" +longname = "connection distance" +description = "is the distance between the center of cell 1 and the its shared face with cell 2." +tagged = false + +[blocks.exchangedata.fields.exchangedata.item.fields.cl2] +type = "double" +longname = "connection distance" +description = "is the distance between the center of cell 2 and the its shared face with cell 1." +tagged = false + +[blocks.exchangedata.fields.exchangedata.item.fields.hwva] +type = "double" +longname = "horizontal cell width or area for vertical flow" +description = "is the horizontal width of the flow connection between cell 1 and cell 2 if IHC $>$ 0, or it is the area perpendicular to flow of the vertical connection between cell 1 and cell 2 if IHC = 0." +tagged = false + +[blocks.exchangedata.fields.exchangedata.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each GWFGWF Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block." +optional = true +tagged = false +dtype = "double" +shape = [ + "auxiliary", +] + +[blocks.exchangedata.fields.exchangedata.item.fields.boundname] +type = "string" +longname = "exchange boundname" +description = "name of the GWF Exchange cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.dev_ifmod_on] +set_in = "ar" +source = "dev_interfacemodel_on" +type = "logical" + +[memory.auxvar] +type = "array" +set_in = "ar" +source = "aux" +description = "Auxiliary variable values for each exchange." +dtype = "double" +shape = [ + "naux", + "nexg", +] + +[memory.nexg] +set_in = "ar" +source = "nexg" +type = "integer" + +[memory.nodem1] +type = "array" +set_in = "ar" +source = "cellidm1" +description = "Reduced node number in model 1 for each exchange, derived from CELLIDM1." +dtype = "integer" +shape = [ + "nexg", +] + +[memory.nodem2] +type = "array" +set_in = "ar" +source = "cellidm2" +description = "Reduced node number in model 2 for each exchange, derived from CELLIDM2." +dtype = "integer" +shape = [ + "nexg", +] + +[memory.ihc] +type = "array" +set_in = "ar" +source = "ihc" +description = "Connection type flag for each exchange: 0 vertical, 1 horizontal, 2 horizontal for a vertically staggered grid." +dtype = "integer" +shape = [ + "nexg", +] + +[memory.cl1] +type = "array" +set_in = "ar" +source = "cl1" +description = "Distance between the center of the model 1 cell and its shared face." +dtype = "double" +shape = [ + "nexg", +] + +[memory.cl2] +type = "array" +set_in = "ar" +source = "cl2" +description = "Distance between the center of the model 2 cell and its shared face." +dtype = "double" +shape = [ + "nexg", +] + +[memory.hwva] +type = "array" +set_in = "ar" +source = "hwva" +description = "Horizontal width of the connection if IHC > 0, or the area perpendicular to flow of the vertical connection if IHC = 0." +dtype = "double" +shape = [ + "nexg", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.flow-ja-face] +type = "union" + +[observations.flow-ja-face.arms.iexg] +type = "integer" +tagged = false +index = true + +[observations.flow-ja-face.arms.boundname] +type = "string" +tagged = false diff --git a/flopy4/mf6/dfns/exg-gwfgwt.toml b/flopy4/mf6/dfns/exg-gwfgwt.toml new file mode 100644 index 000000000..7edb54fa7 --- /dev/null +++ b/flopy4/mf6/dfns/exg-gwfgwt.toml @@ -0,0 +1,6 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "exg-gwfgwt" +parent = "sim-nam" +ftype = "GWF6-GWT6" +subtype = "exchange" diff --git a/flopy4/mf6/dfns/exg-gwfprt.toml b/flopy4/mf6/dfns/exg-gwfprt.toml new file mode 100644 index 000000000..021485823 --- /dev/null +++ b/flopy4/mf6/dfns/exg-gwfprt.toml @@ -0,0 +1,6 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "exg-gwfprt" +parent = "sim-nam" +ftype = "GWF6-PRT6" +subtype = "exchange" diff --git a/flopy4/mf6/dfns/exg-gwtgwt.toml b/flopy4/mf6/dfns/exg-gwtgwt.toml new file mode 100644 index 000000000..c2031defe --- /dev/null +++ b/flopy4/mf6/dfns/exg-gwtgwt.toml @@ -0,0 +1,317 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "exg-gwtgwt" +parent = "sim-nam" +ftype = "GWT6-GWT6" +multi = true +subtype = "exchange" + +[dims.nexg] +value = "nexg" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[blocks.options.fields.gwfmodelname1] +type = "string" +longname = "keyword to specify name of first corresponding GWF Model" +description = "keyword to specify name of first corresponding GWF Model. In the simulation name file, the GWT6-GWT6 entry contains names for GWT Models (exgmnamea and exgmnameb). The GWT Model with the name exgmnamea must correspond to the GWF Model with the name gwfmodelname1." + +[blocks.options.fields.gwfmodelname2] +type = "string" +longname = "keyword to specify name of second corresponding GWF Model" +description = "keyword to specify name of second corresponding GWF Model. In the simulation name file, the GWT6-GWT6 entry contains names for GWT Models (exgmnamea and exgmnameb). The GWT Model with the name exgmnameb must correspond to the GWF Model with the name gwfmodelname2." + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "an array of auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided. Most auxiliary variables will not be used by the GWT-GWT Exchange, but they will be available for use by other parts of the program. If an auxiliary variable with the name 'ANGLDEGX' is found, then this information will be used as the angle (provided in degrees) between the connection face normal and the x axis, where a value of zero indicates that a normal vector points directly along the positive x axis. The connection face normal is a normal vector on the cell face shared between the cell in model 1 and the cell in model 2 pointing away from the model 1 cell. Additional information on 'ANGLDEGX' is provided in the description of the DISU Package. ANGLDEGX must be specified if dispersion is simulated in the connected GWT models." +optional = true +dtype = "string" + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of GWT Exchange cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "keyword to print input to list file" +description = "keyword to indicate that the list of exchange entries will be echoed to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "keyword to print gwfgwf flows to list file" +description = "keyword to indicate that the list of exchange flow rates will be printed to the listing file for every stress period in which 'SAVE BUDGET' is specified in Output Control." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "keyword to save GWFGWF flows" +description = "keyword to indicate that cell-by-cell flow terms will be written to the budget file for each model provided that the Output Control for the models are set up with the 'BUDGET SAVE FILE' option." +optional = true + +[blocks.options.fields.adv_scheme] +type = "string" +longname = "advective scheme" +description = "scheme used to solve the advection term. Can be upstream, central, or TVD. If not specified, upstream weighting is the default weighting scheme." +optional = true +valid = [ + "upstream", + "central", + "tvd", +] + +[blocks.options.fields.dsp_xt3d_off] +type = "keyword" +longname = "deactivate xt3d" +description = "deactivate the xt3d method for the dispersive flux and use the faster and less accurate approximation for this exchange." +optional = true + +[blocks.options.fields.dsp_xt3d_rhs] +type = "keyword" +longname = "xt3d on right-hand side" +description = "add xt3d dispersion terms to right-hand side, when possible, for this exchange." +optional = true + +[blocks.options.fields.mvt_filerecord] +type = "record" +optional = true + +[blocks.options.fields.mvt_filerecord.fields.mvt6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to a transport mover file." + +[blocks.options.fields.mvt_filerecord.fields.mvt6_filename] +type = "file" +longname = "mvt6 input filename" +description = "is the file name of the transport mover input file to apply to this exchange. Information for the transport mover are provided in the file provided with these keywords." +tagged = false +direction = "in" +component = "gwt-mvt" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwt-obstypetable} lists observation type(s) supported by the GWT-GWT package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.dev_interfacemodel_on] +type = "keyword" +longname = "activate interface model on exchange" +description = "activates the interface model mechanism for calculating the coefficients at (and possibly near) the exchange. This keyword should only be used for development purposes." +optional = true +developmode = true + +[blocks.dimensions.fields.nexg] +type = "integer" +longname = "number of exchanges" +description = "keyword and integer value specifying the number of GWT-GWT exchanges." + +[blocks.exchangedata.fields.exchangedata] +type = "list" +longname = "exchange data" +shape = [ + "nexg", +] + +[blocks.exchangedata.fields.exchangedata.item] +name = "exchangedata" +type = "record" + +[blocks.exchangedata.fields.exchangedata.item.fields.cellidm1] +type = "cellid" +longname = "cellid of first cell" +description = "is the cellid of the cell in model 1 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell." +tagged = false +model = "1" + +[blocks.exchangedata.fields.exchangedata.item.fields.cellidm2] +type = "cellid" +longname = "cellid of second cell" +description = "is the cellid of the cell in model 2 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell." +tagged = false +model = "2" + +[blocks.exchangedata.fields.exchangedata.item.fields.ihc] +type = "integer" +longname = "integer flag for connection type" +description = "is an integer flag indicating the direction between node n and all of its m connections. If IHC = 0 then the connection is vertical. If IHC = 1 then the connection is horizontal. If IHC = 2 then the connection is horizontal for a vertically staggered grid." +tagged = false + +[blocks.exchangedata.fields.exchangedata.item.fields.cl1] +type = "double" +longname = "connection distance" +description = "is the distance between the center of cell 1 and the its shared face with cell 2." +tagged = false + +[blocks.exchangedata.fields.exchangedata.item.fields.cl2] +type = "double" +longname = "connection distance" +description = "is the distance between the center of cell 2 and the its shared face with cell 1." +tagged = false + +[blocks.exchangedata.fields.exchangedata.item.fields.hwva] +type = "double" +longname = "horizontal cell width or area for vertical flow" +description = "is the horizontal width of the flow connection between cell 1 and cell 2 if IHC $>$ 0, or it is the area perpendicular to flow of the vertical connection between cell 1 and cell 2 if IHC = 0." +tagged = false + +[blocks.exchangedata.fields.exchangedata.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each GWTGWT Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block." +optional = true +tagged = false +dtype = "double" +shape = [ + "auxiliary", +] + +[blocks.exchangedata.fields.exchangedata.item.fields.boundname] +type = "string" +longname = "exchange boundname" +description = "name of the GWT Exchange cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.dev_ifmod_on] +set_in = "ar" +source = "dev_interfacemodel_on" +type = "logical" + +[memory.auxvar] +type = "array" +set_in = "ar" +source = "aux" +description = "Auxiliary variable values for each exchange." +dtype = "double" +shape = [ + "naux", + "nexg", +] + +[memory.nexg] +set_in = "ar" +source = "nexg" +type = "integer" + +[memory.nodem1] +type = "array" +set_in = "ar" +source = "cellidm1" +description = "Reduced node number in model 1 for each exchange, derived from CELLIDM1." +dtype = "integer" +shape = [ + "nexg", +] + +[memory.nodem2] +type = "array" +set_in = "ar" +source = "cellidm2" +description = "Reduced node number in model 2 for each exchange, derived from CELLIDM2." +dtype = "integer" +shape = [ + "nexg", +] + +[memory.ihc] +type = "array" +set_in = "ar" +source = "ihc" +description = "Connection type flag for each exchange: 0 vertical, 1 horizontal, 2 horizontal for a vertically staggered grid." +dtype = "integer" +shape = [ + "nexg", +] + +[memory.cl1] +type = "array" +set_in = "ar" +source = "cl1" +description = "Distance between the center of the model 1 cell and its shared face." +dtype = "double" +shape = [ + "nexg", +] + +[memory.cl2] +type = "array" +set_in = "ar" +source = "cl2" +description = "Distance between the center of the model 2 cell and its shared face." +dtype = "double" +shape = [ + "nexg", +] + +[memory.hwva] +type = "array" +set_in = "ar" +source = "hwva" +description = "Horizontal width of the connection if IHC > 0, or the area perpendicular to flow of the vertical connection if IHC = 0." +dtype = "double" +shape = [ + "nexg", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.flow-ja-face] +type = "union" + +[observations.flow-ja-face.arms.iexg] +type = "integer" +tagged = false +index = true + +[observations.flow-ja-face.arms.boundname] +type = "string" +tagged = false diff --git a/flopy4/mf6/dfns/exg-olfgwf.toml b/flopy4/mf6/dfns/exg-olfgwf.toml new file mode 100644 index 000000000..c07fa5620 --- /dev/null +++ b/flopy4/mf6/dfns/exg-olfgwf.toml @@ -0,0 +1,147 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "exg-olfgwf" +parent = "sim-nam" +ftype = "OLF6-GWF6" +multi = true +subtype = "exchange" + +[dims.nexg] +value = "nexg" + +[blocks.options.fields.print_input] +type = "keyword" +longname = "keyword to print input to list file" +description = "keyword to indicate that the list of exchange entries will be echoed to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "keyword to print olfgwf flows to list file" +description = "keyword to indicate that the list of exchange flow rates will be printed to the listing file for every stress period in which 'SAVE BUDGET' is specified in Output Control." +optional = true + +[blocks.options.fields.fixed_conductance] +type = "keyword" +longname = "keyword to indicate conductance is fixed" +description = "keyword to indicate that the product of the bedleak and cfact input variables in the exchangedata block represents conductance. This conductance is fixed and does not change as a function of head in the surface water and groundwater models." +optional = true + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the SWF-GWF package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.nexg] +type = "integer" +longname = "number of exchanges" +description = "keyword and integer value specifying the number of SWF-GWF exchanges." + +[blocks.exchangedata.fields.exchangedata] +type = "list" +longname = "exchange data" +shape = [ + "nexg", +] + +[blocks.exchangedata.fields.exchangedata.item] +name = "exchangedata" +type = "record" + +[blocks.exchangedata.fields.exchangedata.item.fields.cellidm1] +type = "cellid" +longname = "cellid of cell in surface water model" +description = "is the cellid of the cell in model 1, which must be the surface water model. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell." +tagged = false +model = "1" + +[blocks.exchangedata.fields.exchangedata.item.fields.cellidm2] +type = "cellid" +longname = "cellid of cell in groundwater model" +description = "is the cellid of the cell in model 2, which must be the groundwater model. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell." +tagged = false +model = "2" + +[blocks.exchangedata.fields.exchangedata.item.fields.bedleak] +type = "double" +longname = "bed leakance" +description = "is the leakance between the surface water and groundwater. bedleak has dimensions of 1/T and is equal to the hydraulic conductivity of the bed sediments divided by the thickness of the bed sediments." +tagged = false + +[blocks.exchangedata.fields.exchangedata.item.fields.cfact] +type = "double" +longname = "factor used for conductance calculation" +description = "is the factor used for the conductance calculation. The definition for this parameter depends the type of surface water model and whether or not the fixed_conductance option is specified. If the fixed_conductance option is specified, then the hydraulic conductance is calculated as the product of bedleak and cfact. In this case, the conductance is fixed and does not change as a function of the calculated surface water and groundwater head. If the fixed_conductance option is not specified, then the definition of cfact depends on whether the surface water model represents one-dimensional channel flow or two-dimensional overland flow. If the surface water model represents one-dimensional channel flow, then cfact is the length of the channel cell in the groundwater model cell. If the surface water model represents two-dimensional overland flow, then cfact is the intersection area of the overland flow cell and the underlying groundwater model cell." +tagged = false + +[memory.ipr_input] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.ipr_flow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ifixedcond] +set_in = "ar" +source = "fixed_conductance" +type = "integer" + +[memory.nexg] +set_in = "ar" +source = "nexg" +type = "integer" + +[memory.nodem1] +type = "array" +set_in = "ar" +source = "cellidm1" +description = "Reduced node number in the surface water model for each exchange, derived from CELLIDM1. Registered as NODEM1 in memory though the Fortran field is named NODESWF." +dtype = "integer" +shape = [ + "nexg", +] + +[memory.nodem2] +type = "array" +set_in = "ar" +source = "cellidm2" +description = "Reduced node number in the GWF model for each exchange, derived from CELLIDM2. Registered as NODEM2 in memory though the Fortran field is named NODEGWF." +dtype = "integer" +shape = [ + "nexg", +] + +[memory.bedleak] +type = "array" +set_in = "ar" +source = "bedleak" +description = "Bed leakance for each exchange." +dtype = "double" +shape = [ + "nexg", +] + +[memory.cfact] +type = "array" +set_in = "ar" +source = "cfact" +description = "Factor used in the conductance calculation for each exchange." +dtype = "double" +shape = [ + "nexg", +] diff --git a/flopy4/mf6/dfns/gwe-adv.toml b/flopy4/mf6/dfns/gwe-adv.toml new file mode 100644 index 000000000..5bafab449 --- /dev/null +++ b/flopy4/mf6/dfns/gwe-adv.toml @@ -0,0 +1,22 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-adv" +parent = "gwe-nam" +ftype = "ADV6" + +[blocks.options.fields.scheme] +type = "string" +longname = "advective scheme" +description = "scheme used to solve the advection term. Can be upstream, central, TVD, or UTVD. If not specified, upstream weighting is the default weighting scheme." +optional = true +valid = [ + "central", + "upstream", + "tvd", +] + +[blocks.options.fields.ats_percel] +type = "double" +longname = "fractional cell distance used for time step calculation" +description = "fractional cell distance submitted by the ADV Package to the adaptive time stepping (ATS) package. If ATS_PERCEL is specified and the ATS Package is active, a time step calculation will be made for each cell based on flow through the cell and cell properties. The largest time step will be calculated such that the advective fractional cell distance (ATS_PERCEL) is not exceeded for any active cell in the grid. This time-step constraint will be submitted to the ATS Package, perhaps with constraints submitted by other packages, in the calculation of the time step. ATS_PERCEL must be greater than zero. If a value of zero is specified for ATS_PERCEL the program will automatically reset it to an internal no data value to indicate that time steps should not be subject to this constraint." +optional = true diff --git a/flopy4/mf6/dfns/gwe-cnd.toml b/flopy4/mf6/dfns/gwe-cnd.toml new file mode 100644 index 000000000..2d02f2af3 --- /dev/null +++ b/flopy4/mf6/dfns/gwe-cnd.toml @@ -0,0 +1,189 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-cnd" +parent = "gwe-nam" +ftype = "CND6" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.xt3d_off] +type = "keyword" +longname = "deactivate xt3d" +description = "deactivate the xt3d method and use the faster and less accurate approximation. This option may provide a fast and accurate solution under some circumstances, such as when flow aligns with the model grid, there is no mechanical dispersion, or when the longitudinal and transverse dispersivities are equal. This option may also be used to assess the computational demand of the XT3D approach by noting the run time differences with and without this option on." +optional = true + +[blocks.options.fields.xt3d_rhs] +type = "keyword" +longname = "xt3d on right-hand side" +description = "add xt3d terms to right-hand side, when possible. This option uses less memory, but may require more iterations." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.griddata.fields.alh] +type = "array" +longname = "longitudinal dispersivity in horizontal direction" +description = "longitudinal dispersivity in horizontal direction. If flow is strictly horizontal, then this is the longitudinal dispersivity that will be used. If flow is not strictly horizontal or strictly vertical, then the longitudinal dispersivity is a function of both ALH and ALV. If mechanical dispersion is represented (by specifying any dispersivity values) then this array is required." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.alv] +type = "array" +longname = "longitudinal dispersivity in vertical direction" +description = "longitudinal dispersivity in vertical direction. If flow is strictly vertical, then this is the longitudinal dispsersivity value that will be used. If flow is not strictly horizontal or strictly vertical, then the longitudinal dispersivity is a function of both ALH and ALV. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ALH." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.ath1] +type = "array" +longname = "transverse dispersivity in horizontal direction" +description = "transverse dispersivity in horizontal direction. This is the transverse dispersivity value for the second ellipsoid axis. If flow is strictly horizontal and directed in the x direction (along a row for a regular grid), then this value controls spreading in the y direction. If mechanical dispersion is represented (by specifying any dispersivity values) then this array is required." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.ath2] +type = "array" +longname = "transverse dispersivity in horizontal direction" +description = "transverse dispersivity in horizontal direction. This is the transverse dispersivity value for the third ellipsoid axis. If flow is strictly horizontal and directed in the x direction (along a row for a regular grid), then this value controls spreading in the z direction. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ATH1." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.atv] +type = "array" +longname = "transverse dispersivity when flow is in vertical direction" +description = "transverse dispersivity when flow is in vertical direction. If flow is strictly vertical and directed in the z direction, then this value controls spreading in the x and y directions. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ATH2." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.ktw] +type = "array" +longname = "thermal conductivity of the simulated fluid" +description = "thermal conductivity of the simulated fluid. Note that the CND Package does not account for the tortuosity of the flow paths when solving for the conductive spread of heat. If tortuosity plays an important role in the thermal conductivity calculation, its effect should be reflected in the value specified for KTW." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.kts] +type = "array" +longname = "thermal conductivity of the aquifer material" +description = "thermal conductivity of the solid aquifer material" +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.alh] +type = "array" +set_in = "ar" +source = "alh" +dtype = "double" +shape = [ + "nodes", +] + +[memory.alv] +type = "array" +set_in = "ar" +source = "alv" +dtype = "double" +shape = [ + "nodes", +] + +[memory.ath1] +type = "array" +set_in = "ar" +source = "ath1" +dtype = "double" +shape = [ + "nodes", +] + +[memory.ath2] +type = "array" +set_in = "ar" +source = "ath2" +dtype = "double" +shape = [ + "nodes", +] + +[memory.atv] +type = "array" +set_in = "ar" +source = "atv" +dtype = "double" +shape = [ + "nodes", +] + +[memory.ktw] +type = "array" +set_in = "ar" +source = "ktw" +dtype = "double" +shape = [ + "nodes", +] + +[memory.kts] +type = "array" +set_in = "ar" +source = "kts" +dtype = "double" +shape = [ + "nodes", +] diff --git a/flopy4/mf6/dfns/gwe-ctp.toml b/flopy4/mf6/dfns/gwe-ctp.toml new file mode 100644 index 000000000..579f434ee --- /dev/null +++ b/flopy4/mf6/dfns/gwe-ctp.toml @@ -0,0 +1,300 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-ctp" +parent = "gwe-nam" +ftype = "CTP6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of temperature value." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of constant temperature cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of constant temperature information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of constant temperature flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save constant temperature flows to budget file" +description = "keyword to indicate that constant temperature flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "time series keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CTP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CTP package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of constant temperatures" +description = "integer value specifying the maximum number of constant temperature cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.temp] +type = "double" +longname = "constant temperature value" +description = "is the constant temperature value. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each constant temperature. The values of auxiliary variables must be present for each constant temperature. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "constant temperature name" +description = "name of the constant temperature cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.tspvar] +set_in = "ad" +source = "temp" +type = "double" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: temp." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "CTP" +output = true +obs_type = "CTP" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.ctp] +type = "union" + +[observations.ctp.arms.cellid] +type = "cellid" +tagged = false + +[observations.ctp.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwe-dis.toml b/flopy4/mf6/dfns/gwe-dis.toml new file mode 100644 index 000000000..712251fc2 --- /dev/null +++ b/flopy4/mf6/dfns/gwe-dis.toml @@ -0,0 +1,302 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-dis" +parent = "gwe-nam" +ftype = "DIS6" + +[dims.nlay] +value = "nlay" +scope = "model" + +[dims.nrow] +value = "nrow" +scope = "model" + +[dims.ncol] +value = "ncol" +scope = "model" + +[dims.ncpl] +value = "nrow * ncol" +scope = "model" + +[dims.nodes] +value = "nlay * nrow * ncol" +scope = "model" + +[dims.ncelldim] +value = "3" +scope = "model" + +[runtime_dims.nodes] +set_in = "ar" + +[runtime_dims.nodesuser] +set_in = "ar" + +[blocks.options.fields.length_units] +type = "string" +longname = "model length units" +description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." +optional = true + +[blocks.options.fields.nogrb] +type = "keyword" +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." +optional = true + +[blocks.options.fields.grb_filerecord] +type = "record" +optional = true + +[blocks.options.fields.grb_filerecord.fields.grb6] +type = "keyword" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" + +[blocks.options.fields.xorigin] +type = "double" +longname = "x-position of the model grid origin" +description = "x-position of the lower-left corner of the model grid. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.yorigin] +type = "double" +longname = "y-position of the model grid origin" +description = "y-position of the lower-left corner of the model grid. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.angrot] +type = "double" +longname = "rotation angle" +description = "counter-clockwise rotation angle (in degrees) of the lower-left corner of the model grid. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.options.fields.crs] +type = "string" +longname = "CRS user input string" +description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true +case_sensitive = true + +[blocks.options.fields.ncf_filerecord] +type = "record" +optional = true + +[blocks.options.fields.ncf_filerecord.fields.ncf6] +type = "keyword" +longname = "ncf keyword" +description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" +component = "utl-ncf" + +[blocks.dimensions.fields.nlay] +type = "integer" +longname = "number of layers" +description = "is the number of layers in the model grid." +default = 1 + +[blocks.dimensions.fields.nrow] +type = "integer" +longname = "number of rows" +description = "is the number of rows in the model grid." +default = 2 + +[blocks.dimensions.fields.ncol] +type = "integer" +longname = "number of columns" +description = "is the number of columns in the model grid." +default = 2 + +[blocks.griddata.fields.delr] +type = "array" +longname = "spacing along a row" +description = "is the column spacing in the row direction." +default = 1.0 +netcdf = true +dtype = "double" +shape = [ + "ncol", +] + +[blocks.griddata.fields.delc] +type = "array" +longname = "spacing along a column" +description = "is the row spacing in the column direction." +default = 1.0 +netcdf = true +dtype = "double" +shape = [ + "nrow", +] + +[blocks.griddata.fields.top] +type = "array" +longname = "cell top elevation" +description = "is the top elevation for each cell in the top model layer." +default = 1.0 +netcdf = true +dtype = "double" +shape = [ + "ncol", + "nrow", +] + +[blocks.griddata.fields.botm] +type = "array" +longname = "cell bottom elevation" +description = "is the bottom elevation for each cell." +default = 0.0 +netcdf = true +dtype = "double" +layered = true +shape = [ + "ncol", + "nrow", + "nlay", +] + +[blocks.griddata.fields.idomain] +type = "array" +longname = "idomain existence array" +description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." +optional = true +netcdf = true +dtype = "integer" +layered = true +shape = [ + "ncol", + "nrow", + "nlay", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.nlay] +set_in = "ar" +source = "nlay" +type = "integer" + +[memory.nrow] +set_in = "ar" +source = "nrow" +type = "integer" + +[memory.ncol] +set_in = "ar" +source = "ncol" +type = "integer" + +[memory.delr] +type = "array" +set_in = "ar" +source = "delr" +dtype = "double" +shape = [ + "ncol", +] + +[memory.delc] +type = "array" +set_in = "ar" +source = "delc" +dtype = "double" +shape = [ + "nrow", +] + +[memory.top] +type = "array" +set_in = "ar" +source = "top" +dtype = "double" +shape = [ + "ncol", + "nrow", +] + +[memory.botm] +type = "array" +set_in = "ar" +source = "botm" +dtype = "double" +shape = [ + "ncol", + "nrow", + "nlay", +] + +[memory.idomain] +type = "array" +set_in = "ar" +source = "idomain" +dtype = "integer" +shape = [ + "ncol", + "nrow", + "nlay", +] + +[memory.area] +type = "array" +readonly = true +set_in = "ar" +description = "Horizontal cell area, computed from grid geometry." +dtype = "double" +shape = [ + "ncpl", +] + +[memory.nodeuser] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodereduced] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." +dtype = "integer" +shape = [ + "nodesuser", +] diff --git a/flopy4/mf6/dfns/gwe-disu.toml b/flopy4/mf6/dfns/gwe-disu.toml new file mode 100644 index 000000000..af1f8fdc2 --- /dev/null +++ b/flopy4/mf6/dfns/gwe-disu.toml @@ -0,0 +1,366 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-disu" +parent = "gwe-nam" +ftype = "DISU6" + +[dims.nodes] +value = "nodes" +scope = "model" + +[dims.nja] +value = "nja" +scope = "model" + +[dims.nvert] +value = "nvert" +scope = "model" + +[dims.ncelldim] +value = "1" +scope = "model" + +[dims.njas] +value = "(nja - nodes) / 2" + +[runtime_dims.nodes] +set_in = "ar" + +[runtime_dims.nodesuser] +set_in = "ar" + +[blocks.options.fields.length_units] +type = "string" +longname = "model length units" +description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." +optional = true + +[blocks.options.fields.nogrb] +type = "keyword" +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." +optional = true + +[blocks.options.fields.grb_filerecord] +type = "record" +optional = true + +[blocks.options.fields.grb_filerecord.fields.grb6] +type = "keyword" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" + +[blocks.options.fields.xorigin] +type = "double" +longname = "x-position origin of the model grid coordinate system" +description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.yorigin] +type = "double" +longname = "y-position origin of the model grid coordinate system" +description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.angrot] +type = "double" +longname = "rotation angle" +description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.vertical_offset_tolerance] +type = "double" +longname = "vertical length dimension for top and bottom checking" +description = "checks are performed to ensure that the top of a cell is not higher than the bottom of an overlying cell. This option can be used to specify the tolerance that is used for checking. If top of a cell is above the bottom of an overlying cell by a value less than this tolerance, then the program will not terminate with an error. The default value is zero. This option should generally not be used." +optional = true +default = 0.0 + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.crs] +type = "string" +longname = "CRS user input string" +description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true +case_sensitive = true + +[blocks.dimensions.fields.nodes] +type = "integer" +longname = "number of layers" +description = "is the number of cells in the model grid." + +[blocks.dimensions.fields.nja] +type = "integer" +longname = "number of columns" +description = "is the sum of the number of connections and NODES. When calculating the total number of connections, the connection between cell n and cell m is considered to be different from the connection between cell m and cell n. Thus, NJA is equal to the total number of connections, including n to m and m to n, and the total number of cells." + +[blocks.dimensions.fields.nvert] +type = "integer" +longname = "number of vertices" +description = "is the total number of (x, y) vertex pairs used to define the plan-view shape of each cell in the model grid. If NVERT is not specified or is specified as zero, then the VERTICES and CELL2D blocks below are not read. NVERT and the accompanying VERTICES and CELL2D blocks should be specified for most simulations. If the XT3D or SAVE_SPECIFIC_DISCHARGE options are specified in the NPF Package, then this information is required." +optional = true + +[blocks.griddata.fields.top] +type = "array" +longname = "cell top elevation" +description = "is the top elevation for each cell in the model grid." +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.bot] +type = "array" +longname = "cell bottom elevation" +description = "is the bottom elevation for each cell." +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.area] +type = "array" +longname = "cell surface area" +description = "is the cell surface area (in plan view)." +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.idomain] +type = "array" +longname = "idomain existence array" +description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1 or greater, the cell exists in the simulation. IDOMAIN values of -1 cannot be specified for the DISU Package." +optional = true +dtype = "integer" +shape = [ + "nodes", +] + +[blocks.connectiondata.fields.iac] +type = "array" +longname = "number of cell connections" +description = "is the number of connections (plus 1) for each cell. The sum of all the entries in IAC must be equal to NJA." +dtype = "integer" +shape = [ + "nodes", +] + +[blocks.connectiondata.fields.ja] +type = "array" +longname = "grid connectivity" +description = "is a list of cell number (n) followed by its connecting cell numbers (m) for each of the m cells connected to cell n. The number of values to provide for cell n is IAC(n). This list is sequentially provided for the first to the last cell. The first value in the list must be cell n itself, and the remaining cells must be listed in an increasing order (sorted from lowest number to highest). Note that the cell and its connections are only supplied for the GWE cells and their connections to the other GWE cells. Also note that the JA list input may be divided such that every node and its connectivity list can be on a separate line for ease in readability of the file. To further ease readability of the file, the node number of the cell whose connectivity is subsequently listed, may be expressed as a negative number, the sign of which is subsequently converted to positive by the code." +dtype = "integer" +index = true +shape = [ + "nja", +] + +[blocks.connectiondata.fields.ihc] +type = "array" +longname = "connection type" +description = "is an index array indicating the direction between node n and all of its m connections. If IHC = 0 then cell n and cell m are connected in the vertical direction. Cell n overlies cell m if the cell number for n is less than m; cell m overlies cell n if the cell number for m is less than n. If IHC = 1 then cell n and cell m are connected in the horizontal direction. If IHC = 2 then cell n and cell m are connected in the horizontal direction, and the connection is vertically staggered. A vertically staggered connection is one in which a cell is horizontally connected to more than one cell in a horizontal connection." +dtype = "integer" +shape = [ + "nja", +] + +[blocks.connectiondata.fields.cl12] +type = "array" +longname = "connection lengths" +description = "is the array containing connection lengths between the center of cell n and the shared face with each adjacent m cell." +dtype = "double" +shape = [ + "nja", +] + +[blocks.connectiondata.fields.hwva] +type = "array" +longname = "connection lengths" +description = "is a symmetric array of size NJA. For horizontal connections, entries in HWVA are the horizontal width perpendicular to flow. For vertical connections, entries in HWVA are the vertical area for flow. Thus, values in the HWVA array contain dimensions of both length and area. Entries in the HWVA array have a one-to-one correspondence with the connections specified in the JA array. Likewise, there is a one-to-one correspondence between entries in the HWVA array and entries in the IHC array, which specifies the connection type (horizontal or vertical). Entries in the HWVA array must be symmetric; the program will terminate with an error if the value for HWVA for an n to m connection does not equal the value for HWVA for the corresponding n to m connection." +dtype = "double" +shape = [ + "nja", +] + +[blocks.connectiondata.fields.angldegx] +type = "array" +longname = "angle of face normal to connection" +description = "is the angle (in degrees) between the horizontal x-axis and the outward normal to the face between a cell and its connecting cells. The angle varies between zero and 360.0 degrees, where zero degrees points in the positive x-axis direction, and 90 degrees points in the positive y-axis direction. ANGLDEGX is only needed if horizontal anisotropy is specified in the NPF Package, if the XT3D option is used in the NPF Package, or if the SAVE_SPECIFIC_DISCHARGE option is specified in the NPF Package. ANGLDEGX does not need to be specified if these conditions are not met. ANGLDEGX is of size NJA; values specified for vertical connections and for the diagonal position are not used. Note that ANGLDEGX is read in degrees, which is different from MODFLOW-USG, which reads a similar variable (ANGLEX) in radians." +optional = true +dtype = "double" +shape = [ + "nja", +] + +[blocks.vertices.fields.vertices] +type = "list" +longname = "vertices data" +shape = [ + "nvert", +] + +[blocks.vertices.fields.vertices.item] +name = "vertices" +type = "record" + +[blocks.vertices.fields.vertices.item.fields.iv] +type = "integer" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +tagged = false +index = true +pk = true + +[blocks.vertices.fields.vertices.item.fields.xv] +type = "double" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." +tagged = false + +[blocks.vertices.fields.vertices.item.fields.yv] +type = "double" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." +tagged = false + +[blocks.cell2d.fields.cell2d] +type = "list" +longname = "cell2d data" +shape = [ + "nodes", +] + +[blocks.cell2d.fields.cell2d.item] +name = "cell2d" +type = "record" + +[blocks.cell2d.fields.cell2d.item.fields.icell2d] +type = "integer" +longname = "cell2d number" +description = "is the cell2d number. Records in the CELL2D block must be listed in consecutive order from 1 to NODES." +tagged = false +index = true +pk = true + +[blocks.cell2d.fields.cell2d.item.fields.xc] +type = "double" +longname = "x-coordinate for cell center" +description = "is the x-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.yc] +type = "double" +longname = "y-coordinate for cell center" +description = "is the y-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.ncvert] +type = "integer" +longname = "number of cell vertices" +description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.icvert] +type = "array" +longname = "array of vertex numbers" +description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order." +tagged = false +dtype = "integer" +index = true +shape = [ + "ncvert", +] + +[memory.voffsettol] +set_in = "ar" +source = "vertical_offset_tolerance" +type = "double" + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.nodes] +set_in = "ar" +source = "nodes" +type = "integer" + +[memory.nja] +set_in = "ar" +source = "nja" +type = "integer" + +[memory.nvert] +set_in = "ar" +source = "nvert" +type = "integer" + +[memory.top] +type = "array" +set_in = "ar" +source = "top" +dtype = "double" +shape = [ + "nodes", +] + +[memory.bot] +type = "array" +set_in = "ar" +source = "bot" +dtype = "double" +shape = [ + "nodes", +] + +[memory.area] +type = "array" +readonly = true +set_in = "ar" +description = "Horizontal cell area, computed from grid geometry." +dtype = "double" +shape = [ + "nodesuser", +] + +[memory.idomain] +type = "array" +set_in = "ar" +source = "idomain" +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodeuser] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodereduced] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." +dtype = "integer" +shape = [ + "nodesuser", +] diff --git a/flopy4/mf6/dfns/gwe-disv.toml b/flopy4/mf6/dfns/gwe-disv.toml new file mode 100644 index 000000000..f60b9a4f5 --- /dev/null +++ b/flopy4/mf6/dfns/gwe-disv.toml @@ -0,0 +1,326 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-disv" +parent = "gwe-nam" +ftype = "DISV6" + +[dims.nlay] +value = "nlay" +scope = "model" + +[dims.ncpl] +value = "ncpl" +scope = "model" + +[dims.nvert] +value = "nvert" +scope = "model" + +[dims.nodes] +value = "nlay * ncpl" +scope = "model" + +[dims.ncelldim] +value = "2" +scope = "model" + +[runtime_dims.nodes] +set_in = "ar" + +[runtime_dims.nodesuser] +set_in = "ar" + +[blocks.options.fields.length_units] +type = "string" +longname = "model length units" +description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." +optional = true + +[blocks.options.fields.nogrb] +type = "keyword" +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." +optional = true + +[blocks.options.fields.grb_filerecord] +type = "record" +optional = true + +[blocks.options.fields.grb_filerecord.fields.grb6] +type = "keyword" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" + +[blocks.options.fields.xorigin] +type = "double" +longname = "x-position origin of the model grid coordinate system" +description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.yorigin] +type = "double" +longname = "y-position origin of the model grid coordinate system" +description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.angrot] +type = "double" +longname = "rotation angle" +description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.options.fields.crs] +type = "string" +longname = "CRS user input string" +description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true +case_sensitive = true + +[blocks.options.fields.ncf_filerecord] +type = "record" +optional = true + +[blocks.options.fields.ncf_filerecord.fields.ncf6] +type = "keyword" +longname = "ncf keyword" +description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" +component = "utl-ncf" + +[blocks.dimensions.fields.nlay] +type = "integer" +longname = "number of layers" +description = "is the number of layers in the model grid." + +[blocks.dimensions.fields.ncpl] +type = "integer" +longname = "number of cells per layer" +description = "is the number of cells per layer. This is a constant value for the grid and it applies to all layers." + +[blocks.dimensions.fields.nvert] +type = "integer" +longname = "number of vertices" +description = "is the total number of (x, y) vertex pairs used to characterize the horizontal configuration of the model grid." + +[blocks.griddata.fields.top] +type = "array" +longname = "model top elevation" +description = "is the top elevation for each cell in the top model layer." +netcdf = true +dtype = "double" +shape = [ + "ncpl", +] + +[blocks.griddata.fields.botm] +type = "array" +longname = "model bottom elevation" +description = "is the bottom elevation for each cell." +netcdf = true +dtype = "double" +layered = true +shape = [ + "ncpl", + "nlay", +] + +[blocks.griddata.fields.idomain] +type = "array" +longname = "idomain existence array" +description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." +optional = true +netcdf = true +dtype = "integer" +layered = true +shape = [ + "ncpl", + "nlay", +] + +[blocks.vertices.fields.vertices] +type = "list" +longname = "vertices data" +shape = [ + "nvert", +] + +[blocks.vertices.fields.vertices.item] +name = "vertices" +type = "record" + +[blocks.vertices.fields.vertices.item.fields.iv] +type = "integer" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +tagged = false +index = true +pk = true + +[blocks.vertices.fields.vertices.item.fields.xv] +type = "double" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." +tagged = false + +[blocks.vertices.fields.vertices.item.fields.yv] +type = "double" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." +tagged = false + +[blocks.cell2d.fields.cell2d] +type = "list" +longname = "cell2d data" +shape = [ + "ncpl", +] + +[blocks.cell2d.fields.cell2d.item] +name = "cell2d" +type = "record" + +[blocks.cell2d.fields.cell2d.item.fields.icell2d] +type = "integer" +longname = "cell2d number" +description = "is the CELL2D number. Records in the CELL2D block must be listed in consecutive order from the first to the last." +tagged = false +index = true +pk = true + +[blocks.cell2d.fields.cell2d.item.fields.xc] +type = "double" +longname = "x-coordinate for cell center" +description = "is the x-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.yc] +type = "double" +longname = "y-coordinate for cell center" +description = "is the y-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.ncvert] +type = "integer" +longname = "number of cell vertices" +description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.icvert] +type = "array" +longname = "array of vertex numbers" +description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false +dtype = "integer" +index = true +shape = [ + "ncvert", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.nlay] +set_in = "ar" +source = "nlay" +type = "integer" + +[memory.ncpl] +set_in = "ar" +source = "ncpl" +type = "integer" + +[memory.nvert] +set_in = "ar" +source = "nvert" +type = "integer" + +[memory.top] +type = "array" +set_in = "ar" +source = "top" +dtype = "double" +shape = [ + "ncpl", +] + +[memory.botm] +type = "array" +set_in = "ar" +source = "botm" +dtype = "double" +shape = [ + "ncpl", + "nlay", +] + +[memory.idomain] +type = "array" +set_in = "ar" +source = "idomain" +dtype = "integer" +shape = [ + "ncpl", + "nlay", +] + +[memory.area] +type = "array" +readonly = true +set_in = "ar" +description = "Horizontal cell area, computed from grid geometry." +dtype = "double" +shape = [ + "ncpl", +] + +[memory.nodeuser] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodereduced] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." +dtype = "integer" +shape = [ + "nodesuser", +] diff --git a/flopy4/mf6/dfns/gwe-esl.toml b/flopy4/mf6/dfns/gwe-esl.toml new file mode 100644 index 000000000..be0af9284 --- /dev/null +++ b/flopy4/mf6/dfns/gwe-esl.toml @@ -0,0 +1,308 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-esl" +parent = "gwe-nam" +ftype = "ESL6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of energy loading rate." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of energy source loading cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of energy source loading information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of energy source loading flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save ESL flows to budget file" +description = "keyword to indicate that energy source loading flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the ESL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ESL package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of sources" +description = "integer value specifying the maximum number of source cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.senerrate] +type = "double" +longname = "energy source loading rate" +description = "is the energy source loading rate. A positive value indicates addition of energy and a negative value indicates removal of energy. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each energy source. The values of auxiliary variables must be present for each energy source. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "energy source loading name" +description = "name of the energy source cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: senerrate." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "ESL" +output = true +obs_type = "ESL" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "ESL-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.esl] +type = "union" + +[observations.esl.arms.cellid] +type = "cellid" +tagged = false + +[observations.esl.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwe-est.toml b/flopy4/mf6/dfns/gwe-est.toml new file mode 100644 index 000000000..1233e13c8 --- /dev/null +++ b/flopy4/mf6/dfns/gwe-est.toml @@ -0,0 +1,174 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-est" +parent = "gwe-nam" +ftype = "EST6" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save calculated flows to budget file" +description = "keyword to indicate that EST flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.zero_order_decay_water] +type = "keyword" +longname = "activate zero-order decay in aqueous phase" +description = "is a text keyword to indicate that zero-order decay will occur in the aqueous phase. That is, decay occurs in the water and is a rate per volume of water only, not per volume of aquifer (i.e., grid cell). Use of this keyword requires that DECAY_WATER is specified in the GRIDDATA block." +optional = true + +[blocks.options.fields.zero_order_decay_solid] +type = "keyword" +longname = "activate zero-order decay in solid phase" +description = "is a text keyword to indicate that zero-order decay will occur in the solid phase. That is, decay occurs in the solid and is a rate per mass (not volume) of solid only. Use of this keyword requires that DECAY_SOLID is specified in the GRIDDATA block." +optional = true + +[blocks.options.fields.density_water] +type = "double" +longname = "density of water" +description = "density of water used by calculations related to heat storage and conduction. This value is set to 1,000 kg/m3 if no overriding value is specified. A user-specified value should be provided for models that use units other than kilograms and meters or if it is necessary to use a value other than the default." +optional = true +default = 1000.0 + +[blocks.options.fields.heat_capacity_water] +type = "double" +longname = "heat capacity of water" +description = "heat capacity of water used by calculations related to heat storage and conduction. This value is set to 4,184 J/kg/C if no overriding value is specified. A user-specified value should be provided for models that use units other than kilograms, joules, and degrees Celsius or it is necessary to use a value other than the default." +optional = true +default = 4184.0 + +[blocks.options.fields.latent_heat_vaporization] +type = "double" +longname = "latent heat of vaporization" +description = "latent heat of vaporization is the amount of energy that is required to convert a given quantity of liquid into a gas and is associated with evaporative cooling. While the EST package does not simulate evaporation, multiple other packages in a GWE simulation may. To avoid having to specify the latent heat of vaporization in multiple packages, it is specified in a single location and accessed wherever it is needed. For example, evaporation may occur from the surface of streams or lakes and the energy consumed by the change in phase would be needed in both the SFE and LKE packages. This value is set to 2,453,500 J/kg if no overriding value is specified. A user-specified value should be provided for models that use units other than joules and kilograms or if it is necessary to use a value other than the default." +optional = true +default = 2453500.0 + +[blocks.griddata.fields.porosity] +type = "array" +longname = "porosity" +description = "is the mobile domain porosity, defined as the mobile domain pore volume per mobile domain volume. The GWE model does not support the concept of an immobile domain in the context of heat transport." +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.decay_water] +type = "array" +longname = "aqueous phase decay rate coefficient" +description = "is the rate coefficient for zero-order decay for the aqueous phase of the mobile domain. A negative value indicates heat (energy) production. The dimensions of zero-order decay in the aqueous phase are energy per length cubed (volume of water) per time. Zero-order decay in the aqueous phase will have no effect on simulation results unless ZERO_ORDER_DECAY_WATER is specified in the options block." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.decay_solid] +type = "array" +longname = "solid phase decay rate coefficient" +description = "is the rate coefficient for zero-order decay for the solid phase. A negative value indicates heat (energy) production. The dimensions of zero-order decay in the solid phase are energy per mass of solid per time. Zero-order decay in the solid phase will have no effect on simulation results unless ZERO_ORDER_DECAY_SOLID is specified in the options block." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.heat_capacity_solid] +type = "array" +longname = "heat capacity of the aquifer material" +description = "is the mass-based heat capacity of dry solids (aquifer material). For example, units of J/kg/C may be used (or equivalent)." +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.density_solid] +type = "array" +longname = "density of aquifer material" +description = "is a user-specified value of the density of aquifer material not considering the voids. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kilograms per cubic meter." +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[memory.ord0_decay_water] +set_in = "ar" +source = "zero_order_decay_water" +type = "logical" + +[memory.ord0_decay_solid] +set_in = "ar" +source = "zero_order_decay_solid" +type = "logical" + +[memory.rhow] +set_in = "ar" +source = "density_water" +type = "double" + +[memory.cpw] +set_in = "ar" +source = "heat_capacity_water" +type = "double" + +[memory.latheatvap] +set_in = "ar" +source = "latent_heat_vaporization" +type = "double" + +[memory.cps] +type = "array" +set_in = "ar" +source = "heat_capacity_solid" +dtype = "double" +shape = [ + "nodes", +] + +[memory.rhos] +type = "array" +set_in = "ar" +source = "density_solid" +dtype = "double" +shape = [ + "nodes", +] + +[memory.porosity] +type = "array" +set_in = "ar" +source = "porosity" +dtype = "double" +shape = [ + "nodes", +] + +[memory.decay_water] +type = "array" +set_in = "ar" +source = "decay_water" +dtype = "double" +shape = [ + "nodes", +] + +[memory.decay_solid] +type = "array" +set_in = "ar" +source = "decay_solid" +dtype = "double" +shape = [ + "nodes", +] diff --git a/flopy4/mf6/dfns/gwe-fmi.toml b/flopy4/mf6/dfns/gwe-fmi.toml new file mode 100644 index 000000000..e3023eaa0 --- /dev/null +++ b/flopy4/mf6/dfns/gwe-fmi.toml @@ -0,0 +1,44 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-fmi" +parent = "gwe-nam" +ftype = "FMI6" + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save calculated flow imbalance correction to budget file" +description = "keyword to indicate that FMI flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.flow_imbalance_correction] +type = "keyword" +longname = "correct for flow imbalance" +description = "correct for an imbalance in flows by assuming that any residual flow error comes in or leaves at the temperature of the cell. When this option is activated, the GWE Model budget written to the listing file will contain two additional entries: FLOW-ERROR and FLOW-CORRECTION. These two entries will be equal but opposite in sign. The FLOW-CORRECTION term is a mass flow that is added to offset the error caused by an imprecise flow balance. If these terms are not relatively small, the flow model should be rerun with stricter convergence tolerances." +optional = true + +[blocks.packagedata.fields.packagedata] +type = "list" +longname = "flowtype list" +optional = true + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.flowtype] +type = "string" +longname = "flow type" +description = "is the word GWFBUDGET, GWFHEAD, GWFGRID, GWFMOVER or the name of an advanced GWF stress package from a previous model run. If GWFBUDGET is specified, then the corresponding file must be a budget file. If GWFHEAD is specified, the file must be a head file. If GWFGRID is specified, the file must be a binary grid file. If GWFMOVER is specified, the file must be a mover file. If an advanced GWF stress package name appears then the corresponding file must be the budget file saved by a LAK, SFR, MAW or UZF Package." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.fname] +type = "file" +longname = "file name" +description = "is the name of the file containing flows. The path to the file should be included if the file is not located in the folder where the program was run." +tagged = false +direction = "in" + +[memory.imbalancecorrect] +set_in = "ar" +source = "flow_imbalance_correction" +type = "logical" diff --git a/flopy4/mf6/dfns/gwe-ic.toml b/flopy4/mf6/dfns/gwe-ic.toml new file mode 100644 index 000000000..3a6380c51 --- /dev/null +++ b/flopy4/mf6/dfns/gwe-ic.toml @@ -0,0 +1,51 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-ic" +parent = "gwe-nam" +ftype = "IC6" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.griddata.fields.strt] +type = "array" +longname = "starting temperature" +description = "is the initial (starting) temperature---that is, the temperature at the beginning of the GWE Model simulation. STRT must be specified for all GWE Model simulations. One value is read for every model cell." +default = 0.0 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.strt] +type = "array" +set_in = "ar" +source = "strt" +dtype = "double" +shape = [ + "nodes", +] diff --git a/flopy4/mf6/dfns/gwe-lke.toml b/flopy4/mf6/dfns/gwe-lke.toml new file mode 100644 index 000000000..1ffcb06dd --- /dev/null +++ b/flopy4/mf6/dfns/gwe-lke.toml @@ -0,0 +1,638 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-lke" +parent = "gwe-nam" +ftype = "LKE6" +multi = true +subtype = "advanced" + +[dims.auxiliary] +value = "len(auxiliary)" + +[runtime_dims.ncv] +set_in = "ar" + +[blocks.options.fields.flow_package_name] +type = "string" +longname = "keyword to specify name of corresponding flow package" +description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWE name file)." +optional = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.flow_package_auxiliary_name] +type = "string" +longname = "keyword to specify name of temperature auxiliary variable in flow package" +description = "keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated temperatures from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of lake cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of lake information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_temperature] +type = "keyword" +longname = "print calculated temperatures to listing file" +description = "keyword to indicate that the list of lake {#2} will be printed to the listing file for every stress period in which 'TEMPERATURE PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of lake flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save lake flows to budget file" +description = "keyword to indicate that lake flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.temperature_filerecord] +type = "record" +optional = true + +[blocks.options.fields.temperature_filerecord.fields.temperature] +type = "keyword" +longname = "stage keyword" +description = "keyword to specify that record corresponds to temperature." + +[blocks.options.fields.temperature_filerecord.fields.tempfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write temperature information." +tagged = false +direction = "out" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the LKE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LKE package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.dev_nonexpanding_matrix] +type = "keyword" +longname = "do not add rows to the solution matrix" +description = "keyword that solves the feature temperature with a general mixing equation and adds the result to the right-hand side of the GWE equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." +optional = true +developmode = true + +[blocks.packagedata.fields.packagedata] +type = "list" + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.lakeno] +type = "integer" +longname = "lake number for this entry" +description = "integer value that defines the lake number associated with the specified PACKAGEDATA data on the line. LAKENO must be greater than zero and less than or equal to NLAKES. Lake information must be specified for every lake or the program will terminate with an error. The program will also terminate with an error if information for a lake is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.strt] +type = "double" +longname = "starting lake temperature" +description = "real value that defines the starting temperature for the lake." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.ktf] +type = "double" +longname = "boundary thermal conductivity" +description = "is the thermal conductivity of the material between the aquifer cell and the lake. The thickness of the material is defined by the variable RBTHCND." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.rbthcnd] +type = "double" +longname = "streambed thickness" +description = "real value that defines the thickness of the lakebed material through which conduction occurs. Must be greater than 0." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.packagedata.fields.packagedata.item.fields.boundname] +type = "string" +longname = "lake name" +description = "name of the lake cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "lakeperioddata" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.lakeno] +type = "integer" +longname = "lake number for this entry" +description = "integer value that defines the lake number associated with the specified PERIOD data on the line. LAKENO must be greater than zero and less than or equal to NLAKES." +tagged = false +index = true +fk = "packagedata.lakeno" + +[blocks.period.fields.stress_period_data.item.fields.laksetting] +type = "union" +description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the LAKSETTING string include: STATUS, TEMPERATURE, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the temperature associated with the corresponding flow terms. Temperatures cannot be specified for all flow terms. For example, the Lake Package supports a 'WITHDRAWAL' flow term. If this withdrawal term is active, then water will be withdrawn from the lake at the calculated temperature of the lake." + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.status] +type = "string" +longname = "lake temperature status" +description = "keyword option to define lake status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the lake. If a lake is inactive, then there will be no energy fluxes into or out of the lake and the inactive value will be written for the lake temperature. If a lake is constant, then the temperature for the lake will be fixed at the user specified value." + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.temperature] +type = "double" +longname = "lake temperature" +description = "real or character value that defines the temperature for the lake. The specified TEMPERATURE is only applied if the lake is a constant temperature lake. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.rainfall] +type = "double" +longname = "rainfall temperature" +description = "real or character value that defines the rainfall temperature for the lake. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.evaporation] +type = "double" +longname = "evaporation temperature" +description = "use of the EVAPORATION keyword is allowed in the LKE package; however, the specified value is not currently used in LKE calculations. Instead, the latent heat of evaporation is multiplied by the simulated evaporation rate for determining the thermal energy lost from a stream reach." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.runoff] +type = "double" +longname = "runoff temperature" +description = "real or character value that defines the temperature of runoff for the lake. Users are free to use whatever temperature scale they want, which might include negative temperatures. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.ext-inflow] +type = "double" +longname = "ext-inflow temperature" +description = "real or character value that defines the temperature of external inflow for the lake. Users are free to use whatever temperature scale they want, which might include negative temperatures. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord.fields.auxiliary] +type = "keyword" +description = "keyword for specifying auxiliary variable." + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord.fields.auxname] +type = "string" +description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord.fields.auxval] +type = "double" +longname = "auxiliary variable value" +description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.flow_pkg_name] +set_in = "ar" +source = "flow_package_name" +type = "string" + +[memory.fp_aux_name] +set_in = "ar" +source = "flow_package_auxiliary_name" +type = "string" + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprconc] +set_in = "ar" +source = "print_temperature" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.dev_nonexpanding] +set_in = "ar" +source = "dev_nonexpanding_matrix" +type = "logical" + +[memory.packagedata_ifno] +set_in = "ar" +source = "lakeno" +type = "integer" + +[memory.ifno] +set_in = "rp" +source = "lakeno" +type = "integer" + +[memory.period_auxiliary] +set_in = "rp" +source = "auxiliary" +type = "logical" + +[memory.ncv] +readonly = true +set_in = "ar" +description = "Number of control volumes. Assigned from the linked flow package during AR." +type = "integer" + +[memory.strt] +type = "array" +set_in = "ar" +source = "strt" +description = "Starting temperature for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xnewpak] +type = "array" +set_in = "ca" +description = "Current temperature for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xoldpak] +type = "array" +readonly = true +set_in = "ad" +description = "Temperature from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." +dtype = "double" +shape = [ + "ncv", +] + +[memory.ibound] +type = "array" +set_in = "ar" +description = "Boundary activity flag for each control volume." +dtype = "integer" +shape = [ + "ncv", +] + +[memory.concfeat] +type = "array" +readonly = true +set_in = "cq" +description = "Computed temperature for each feature. Set from XNEWPAK after solver convergence." +dtype = "double" +shape = [ + "ncv", +] + +[memory.qsto] +type = "array" +readonly = true +set_in = "cq" +description = "Storage temperature flow contribution for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.temprain] +type = "array" +set_in = "rp" +description = "Rainfall temperature for each lake." +dtype = "double" +shape = [ + "ncv", +] + +[memory.tempevap] +type = "array" +set_in = "rp" +description = "Evaporation temperature for each lake." +dtype = "double" +shape = [ + "ncv", +] + +[memory.temproff] +type = "array" +set_in = "rp" +description = "Runoff temperature for each lake." +dtype = "double" +shape = [ + "ncv", +] + +[memory.tempiflw] +type = "array" +set_in = "rp" +description = "External inflow temperature for each lake." +dtype = "double" +shape = [ + "ncv", +] + +[memory.ktf] +type = "array" +set_in = "ar" +source = "ktf" +description = "Thermal conductivity of the lakebed (E/T/L/Deg)." +dtype = "double" +shape = [ + "ncv", +] + +[memory.rfeatthk] +type = "array" +set_in = "ar" +source = "rbthcnd" +description = "Thickness of the lakebed conduction layer (L)." +dtype = "double" +shape = [ + "ncv", +] + +[observations.temperature] +type = "union" + +[observations.temperature.arms.lakeno] +type = "integer" +tagged = false +index = true +fk = "packagedata.lakeno" + +[observations.temperature.arms.boundname] +type = "string" +tagged = false + +[observations.storage] +type = "union" + +[observations.storage.arms.lakeno] +type = "integer" +tagged = false +index = true +fk = "packagedata.lakeno" + +[observations.storage.arms.boundname] +type = "string" +tagged = false + +[observations.constant] +type = "union" + +[observations.constant.arms.lakeno] +type = "integer" +tagged = false +index = true +fk = "packagedata.lakeno" + +[observations.constant.arms.boundname] +type = "string" +tagged = false + +[observations.from-mvr] +type = "union" + +[observations.from-mvr.arms.lakeno] +type = "integer" +tagged = false +index = true +fk = "packagedata.lakeno" + +[observations.from-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.lke] +type = "union" + +[observations.lke.arms.lakeno] +type = "integer" +tagged = false +index = true +fk = "packagedata.lakeno" + +[observations.lke.arms.boundname] +type = "string" +tagged = false + +[observations.rainfall] +type = "union" + +[observations.rainfall.arms.lakeno] +type = "integer" +tagged = false +index = true +fk = "packagedata.lakeno" + +[observations.rainfall.arms.boundname] +type = "string" +tagged = false + +[observations.evaporation] +type = "union" + +[observations.evaporation.arms.lakeno] +type = "integer" +tagged = false +index = true +fk = "packagedata.lakeno" + +[observations.evaporation.arms.boundname] +type = "string" +tagged = false + +[observations.runoff] +type = "union" + +[observations.runoff.arms.lakeno] +type = "integer" +tagged = false +index = true +fk = "packagedata.lakeno" + +[observations.runoff.arms.boundname] +type = "string" +tagged = false + +[observations.ext-inflow] +type = "union" + +[observations.ext-inflow.arms.lakeno] +type = "integer" +tagged = false +index = true +fk = "packagedata.lakeno" + +[observations.ext-inflow.arms.boundname] +type = "string" +tagged = false + +[observations.withdrawal] +type = "union" + +[observations.withdrawal.arms.lakeno] +type = "integer" +tagged = false +index = true +fk = "packagedata.lakeno" + +[observations.withdrawal.arms.boundname] +type = "string" +tagged = false + +[observations.ext-outflow] +type = "union" + +[observations.ext-outflow.arms.lakeno] +type = "integer" +tagged = false +index = true +fk = "packagedata.lakeno" + +[observations.ext-outflow.arms.boundname] +type = "string" +tagged = false + +[observations.flow-ja-face] +type = "union" + +[observations.flow-ja-face.arms.lakeno_lakeno2] +type = "record" + +[observations.flow-ja-face.arms.lakeno_lakeno2.fields.lakeno] +type = "integer" +tagged = false +index = true +fk = "packagedata.lakeno" + +[observations.flow-ja-face.arms.lakeno_lakeno2.fields.lakeno2] +type = "integer" +tagged = false +index = true +fk = "packagedata.lakeno" + +[observations.flow-ja-face.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.outletno] +type = "integer" +tagged = false +index = true + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false diff --git a/flopy4/mf6/dfns/gwe-mve.toml b/flopy4/mf6/dfns/gwe-mve.toml new file mode 100644 index 000000000..5a62335c8 --- /dev/null +++ b/flopy4/mf6/dfns/gwe-mve.toml @@ -0,0 +1,82 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-mve" +ftype = "MVE6" +parent = [ + "exg-gwegwe", + "gwe-nam", +] + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of mover information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of lake flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save MVE flows to budget file" +description = "keyword to indicate that lake flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[memory.iprpak] +set_in = "ar" +source = "print_input" +description = "Flag controlling whether mover input is echoed to the listing file." +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +description = "Flag controlling whether mover flow rates are printed to the listing file." +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether mover flows are written to the budget file." +type = "integer" + +[memory.maxpackages] +readonly = true +set_in = "ar" +description = "Number of packages participating in the mover. Computed from the packages that supply or receive moved water." +type = "integer" diff --git a/flopy4/mf6/dfns/gwe-mwe.toml b/flopy4/mf6/dfns/gwe-mwe.toml new file mode 100644 index 000000000..d21d2c8b1 --- /dev/null +++ b/flopy4/mf6/dfns/gwe-mwe.toml @@ -0,0 +1,541 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-mwe" +parent = "gwe-nam" +ftype = "MWE6" +multi = true +subtype = "advanced" + +[dims.auxiliary] +value = "len(auxiliary)" + +[runtime_dims.ncv] +set_in = "ar" + +[blocks.options.fields.flow_package_name] +type = "string" +longname = "keyword to specify name of corresponding flow package" +description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWE name file)." +optional = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.flow_package_auxiliary_name] +type = "string" +longname = "keyword to specify name of temperature auxiliary variable in flow package" +description = "keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated temperatures from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of well cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of well information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_temperature] +type = "keyword" +longname = "print calculated temperatures to listing file" +description = "keyword to indicate that the list of well {#2} will be printed to the listing file for every stress period in which 'TEMPERATURE PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of well flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save well flows to budget file" +description = "keyword to indicate that well flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.temperature_filerecord] +type = "record" +optional = true + +[blocks.options.fields.temperature_filerecord.fields.temperature] +type = "keyword" +longname = "stage keyword" +description = "keyword to specify that record corresponds to temperature." + +[blocks.options.fields.temperature_filerecord.fields.tempfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write temperature information." +tagged = false +direction = "out" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the MWE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MWE package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.dev_nonexpanding_matrix] +type = "keyword" +longname = "do not add rows to the solution matrix" +description = "keyword that solves the feature temperature with a general mixing equation and adds the result to the right-hand side of the GWE equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." +optional = true +developmode = true + +[blocks.packagedata.fields.packagedata] +type = "list" + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.mawno] +type = "integer" +longname = "well number for this entry" +description = "integer value that defines the well number associated with the specified PACKAGEDATA data on the line. MAWNO must be greater than zero and less than or equal to NMAWWELLS. Well information must be specified for every well or the program will terminate with an error. The program will also terminate with an error if information for a well is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.strt] +type = "double" +longname = "starting well temperature" +description = "real value that defines the starting temperature for the well." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.ktf] +type = "double" +longname = "thermal conductivity of the feature" +description = "is the thermal conductivity of the material between the aquifer cell and the feature. The thickness of the material is defined by the variable FTHK." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.fthk] +type = "double" +longname = "thickness of the well feature" +description = "real value that defines the thickness of the material through which conduction occurs. Must be greater than 0." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.packagedata.fields.packagedata.item.fields.boundname] +type = "string" +longname = "well name" +description = "name of the well cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "mweperioddata" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.mawno] +type = "integer" +longname = "well number for this entry" +description = "integer value that defines the well number associated with the specified PERIOD data on the line. MAWNO must be greater than zero and less than or equal to NMAWWELLS." +tagged = false +index = true +fk = "packagedata.mawno" + +[blocks.period.fields.stress_period_data.item.fields.mwesetting] +type = "union" +description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the MWESETTING string include: STATUS, TEMPERATURE, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the temperature of associated with the corresponding flow terms. Temperatures cannot be specified for all flow terms. For example, the Multi-Aquifer Well Package supports a 'WITHDRAWAL' flow term. If this withdrawal term is active, then water will be withdrawn from the well at the calculated temperature of the well." + +[blocks.period.fields.stress_period_data.item.fields.mwesetting.arms.status] +type = "string" +longname = "well temperature status" +description = "keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the well. If a well is inactive, then there will be no solute mass fluxes into or out of the well and the inactive value will be written for the well temperature. If a well is constant, then the temperature for the well will be fixed at the user specified value." + +[blocks.period.fields.stress_period_data.item.fields.mwesetting.arms.temperature] +type = "double" +longname = "well temperature" +description = "real or character value that defines the temperature for the well. The specified TEMPERATURE is only applied if the well is a constant temperature well. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.mwesetting.arms.rate] +type = "double" +longname = "well injection temperature" +description = "real or character value that defines the injection temperature $(e.g.,:^{circ}C:or:^{circ}F)$ for the well. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.mwesetting.arms.auxiliaryrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.mwesetting.arms.auxiliaryrecord.fields.auxiliary] +type = "keyword" +description = "keyword for specifying auxiliary variable." + +[blocks.period.fields.stress_period_data.item.fields.mwesetting.arms.auxiliaryrecord.fields.auxname] +type = "string" +description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.mwesetting.arms.auxiliaryrecord.fields.auxval] +type = "double" +longname = "auxiliary variable value" +description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.flow_pkg_name] +set_in = "ar" +source = "flow_package_name" +type = "string" + +[memory.fp_aux_name] +set_in = "ar" +source = "flow_package_auxiliary_name" +type = "string" + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprconc] +set_in = "ar" +source = "print_temperature" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.dev_nonexpanding] +set_in = "ar" +source = "dev_nonexpanding_matrix" +type = "logical" + +[memory.packagedata_ifno] +set_in = "ar" +source = "mawno" +type = "integer" + +[memory.ifno] +set_in = "rp" +source = "mawno" +type = "integer" + +[memory.period_auxiliary] +set_in = "rp" +source = "auxiliary" +type = "logical" + +[memory.ncv] +readonly = true +set_in = "ar" +description = "Number of control volumes. Assigned from the linked flow package during AR." +type = "integer" + +[memory.strt] +type = "array" +set_in = "ar" +source = "strt" +description = "Starting temperature for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xnewpak] +type = "array" +set_in = "ca" +description = "Current temperature for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xoldpak] +type = "array" +readonly = true +set_in = "ad" +description = "Temperature from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." +dtype = "double" +shape = [ + "ncv", +] + +[memory.ibound] +type = "array" +set_in = "ar" +description = "Boundary activity flag for each control volume." +dtype = "integer" +shape = [ + "ncv", +] + +[memory.concfeat] +type = "array" +readonly = true +set_in = "cq" +description = "Computed temperature for each feature. Set from XNEWPAK after solver convergence." +dtype = "double" +shape = [ + "ncv", +] + +[memory.qsto] +type = "array" +readonly = true +set_in = "cq" +description = "Storage temperature flow contribution for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.temprate] +type = "array" +set_in = "rp" +description = "Pumping-rate temperature for each multi-aquifer well." +dtype = "double" +shape = [ + "ncv", +] + +[memory.ktf] +type = "array" +set_in = "ar" +source = "ktf" +description = "Thermal conductivity of the well casing (E/T/L/Deg)." +dtype = "double" +shape = [ + "ncv", +] + +[memory.rfeatthk] +type = "array" +set_in = "ar" +source = "fthk" +description = "Thickness of the well casing conduction layer (L)." +dtype = "double" +shape = [ + "ncv", +] + +[observations.temperature] +type = "union" + +[observations.temperature.arms.mawno] +type = "integer" +tagged = false +index = true +fk = "packagedata.mawno" + +[observations.temperature.arms.boundname] +type = "string" +tagged = false + +[observations.storage] +type = "union" + +[observations.storage.arms.mawno] +type = "integer" +tagged = false +index = true +fk = "packagedata.mawno" + +[observations.storage.arms.boundname] +type = "string" +tagged = false + +[observations.constant] +type = "union" + +[observations.constant.arms.mawno] +type = "integer" +tagged = false +index = true +fk = "packagedata.mawno" + +[observations.constant.arms.boundname] +type = "string" +tagged = false + +[observations.from-mvr] +type = "union" + +[observations.from-mvr.arms.mawno] +type = "integer" +tagged = false +index = true +fk = "packagedata.mawno" + +[observations.from-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.rate] +type = "union" + +[observations.rate.arms.mawno] +type = "integer" +tagged = false +index = true +fk = "packagedata.mawno" + +[observations.rate.arms.boundname] +type = "string" +tagged = false + +[observations.fw-rate] +type = "union" + +[observations.fw-rate.arms.mawno] +type = "integer" +tagged = false +index = true +fk = "packagedata.mawno" + +[observations.fw-rate.arms.boundname] +type = "string" +tagged = false + +[observations.rate-to-mvr] +type = "union" + +[observations.rate-to-mvr.arms.mawno] +type = "integer" +tagged = false +index = true +fk = "packagedata.mawno" + +[observations.rate-to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.fw-rate-to-mvr] +type = "union" + +[observations.fw-rate-to-mvr.arms.mawno] +type = "integer" +tagged = false +index = true +fk = "packagedata.mawno" + +[observations.fw-rate-to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.mwe] +type = "union" + +[observations.mwe.arms.mawno_iconn] +type = "record" + +[observations.mwe.arms.mawno_iconn.fields.mawno] +type = "integer" +tagged = false +index = true +fk = "packagedata.mawno" + +[observations.mwe.arms.mawno_iconn.fields.iconn] +type = "integer" +tagged = false +index = true + +[observations.mwe.arms.boundname] +type = "string" +tagged = false diff --git a/flopy4/mf6/dfns/gwe-nam.toml b/flopy4/mf6/dfns/gwe-nam.toml new file mode 100644 index 000000000..eb7701352 --- /dev/null +++ b/flopy4/mf6/dfns/gwe-nam.toml @@ -0,0 +1,222 @@ +type = "model" +schema_version = "2.0.0.dev3" +name = "gwe-nam" +parent = "sim-nam" +ftype = "GWE6" +dependent_variable = "temperature" + +[runtime_dims.nja] +set_in = "ar" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.list] +type = "string" +longname = "name of listing file" +description = "is name of the listing file to create for this GWE model. If not specified, then the name of the list file will be the basename of the GWE model name file and the '.lst' extension. For example, if the GWE name file is called 'my.model.nam' then the list file will be called 'my.model.lst'." +optional = true +case_sensitive = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save flows for all packages to budget file" +description = "keyword to indicate that all model package flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.dependent_variable_scaling] +type = "keyword" +longname = "flag to scale X and RHS" +description = "flag to scale X and RHS to avoid very large positive or negative dependent variable values" +optional = true + +[blocks.options.fields.nc_mesh2d_filerecord] +type = "record" +description = "NetCDF layered mesh fileout record." +optional = true + +[blocks.options.fields.nc_mesh2d_filerecord.fields.netcdf_mesh2d] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to a layered mesh NetCDF file." + +[blocks.options.fields.nc_mesh2d_filerecord.fields.ncmesh2dfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF ugrid layered mesh output file." +tagged = false +direction = "out" + +[blocks.options.fields.nc_structured_filerecord] +type = "record" +description = "NetCDF structured fileout record." +optional = true + +[blocks.options.fields.nc_structured_filerecord.fields.netcdf_structured] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to a structured NetCDF file." + +[blocks.options.fields.nc_structured_filerecord.fields.ncstructfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF structured output file." +tagged = false +direction = "out" + +[blocks.options.fields.nc_filerecord] +type = "record" +description = "NetCDF filerecord" +optional = true + +[blocks.options.fields.nc_filerecord.fields.netcdf] +type = "keyword" +longname = "netcdf keyword" +description = "keyword to specify that record corresponds to a NetCDF input file." + +[blocks.options.fields.nc_filerecord.fields.netcdf_filename] +type = "file" +longname = "netcdf input filename" +description = "defines a NetCDF input file." +tagged = false +direction = "in" + +[blocks.packages.fields.packages] +type = "list" +longname = "package list" + +[blocks.packages.fields.packages.item] +name = "packages" +type = "record" + +[blocks.packages.fields.packages.item.fields.ftype] +type = "string" +longname = "package type" +description = "is the file type, which must be one of the following character values shown in table~ref{table:ftype-gwe}. Ftype may be entered in any combination of uppercase and lowercase." +tagged = false + +[blocks.packages.fields.packages.item.fields.fname] +type = "file" +longname = "file name" +description = "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run." +tagged = false +direction = "in" +mode_keyword = false +component = "package" +component_ftype = "ftype" + +[blocks.packages.fields.packages.item.fields.pname] +type = "string" +longname = "user name for package" +description = "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single GWE Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters." +optional = true +tagged = false +pk = true + +[memory.idv_scale] +set_in = "ar" +source = "dependent_variable_scaling" +type = "integer" + +[memory.netcdf_struct] +set_in = "ar" +source = "netcdf_structured" +type = "logical" + +[memory.netcdf_fname] +set_in = "ar" +source = "netcdf_filename" +type = "string" + +[memory.x] +type = "array" +set_in = "ca" +description = "Temperature for each model cell. Checked in from the solution-level dependent-variable vector. Initialized by the IC package during AR; updated by the nonlinear solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." +obs_type = "TEMPERATURE" +dtype = "double" +shape = [ + "nodes", +] + +[memory.xold] +type = "array" +readonly = true +set_in = "ad" +description = "Dependent variable from the end of the previous time step. Copied from X at advance (AD); used to restore X if the adaptive time stepping scheme retries a failed time step." +dtype = "double" +shape = [ + "nodes", +] + +[memory.flowja] +type = "array" +readonly = true +set_in = "cq" +description = "Intercell flows in compressed sparse row (CSR) order, calculated after solution convergence. Diagonal entries hold the flow residual." +budget = "FLOW-JA-FACE" +dtype = "double" +shape = [ + "nja", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution for this model, sliced from the solution-level RHS vector. Rebuilt each solver iteration." +dtype = "double" +shape = [ + "nodes", +] + +[memory.ibound] +type = "array" +set_in = "ar" +description = "Cell activity flag: positive values indicate active cells, zero indicates inactive (no-flow) cells. Set during model initialisation; may change when Newton-Raphson wet-dry logic activates or deactivates cells." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.neq] +readonly = true +set_in = "ar" +description = "Number of equations (unknowns) for this model. Equal to the number of active cells (NODES) for standard models." +type = "integer" + +[memory.idxglo] +type = "array" +readonly = true +set_in = "mc" +description = "Maps each local CSR position to the corresponding row/column index in the global solution matrix. Populated during matrix connectivity (MC) and constant thereafter." +dtype = "integer" +shape = [ + "nja", +] + +[observations.temperature] +type = "cellid" +tagged = false + +[observations.flow-ja-face] +type = "record" + +[observations.flow-ja-face.fields.cellid] +type = "cellid" +tagged = false + +[observations.flow-ja-face.fields.cellid2] +type = "cellid" +tagged = false diff --git a/flopy4/mf6/dfns/gwe-oc.toml b/flopy4/mf6/dfns/gwe-oc.toml new file mode 100644 index 000000000..9922249bd --- /dev/null +++ b/flopy4/mf6/dfns/gwe-oc.toml @@ -0,0 +1,212 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-oc" +parent = "gwe-nam" +ftype = "OC6" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information. Data are written to this file only for time steps in which SAVE BUDGET is specified in a PERIOD block. If SAVE BUDGET is specified in a PERIOD block and this file is not specified, MODFLOW 6 will terminate with an error." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. If specified, a budget summary record will be written to this file for every time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.temperature_filerecord] +type = "record" +optional = true + +[blocks.options.fields.temperature_filerecord.fields.temperature] +type = "keyword" +longname = "temperature keyword" +description = "keyword to specify that record corresponds to temperature." + +[blocks.options.fields.temperature_filerecord.fields.temperaturefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write temperature information." +tagged = false +direction = "out" + +[blocks.options.fields.temperatureprintrecord] +type = "record" +optional = true + +[blocks.options.fields.temperatureprintrecord.fields.temperature] +type = "keyword" +longname = "temperature keyword" +description = "keyword to specify that record corresponds to temperature." + +[blocks.options.fields.temperatureprintrecord.fields.print_format] +type = "keyword" +longname = "keyword to indicate that a print format follows" +description = "keyword to specify format for printing to the listing file." + +[blocks.options.fields.temperatureprintrecord.fields.formatrecord] +type = "record" + +[blocks.options.fields.temperatureprintrecord.fields.formatrecord.fields.columns] +type = "integer" +longname = "number of columns" +description = "number of columns for writing data." +optional = true + +[blocks.options.fields.temperatureprintrecord.fields.formatrecord.fields.width] +type = "integer" +longname = "width for each number" +description = "width for writing each number." +optional = true + +[blocks.options.fields.temperatureprintrecord.fields.formatrecord.fields.digits] +type = "integer" +longname = "number of digits" +description = "number of digits to use for writing a number." +optional = true + +[blocks.options.fields.temperatureprintrecord.fields.formatrecord.fields.format] +type = "string" +longname = "write format" +description = "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC." +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" +optional = true + +[blocks.period.fields.stress_period_data.item] +name = "output_record" +type = "union" + +[blocks.period.fields.stress_period_data.item.arms.saverecord] +type = "record" +optional = true + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.save] +type = "keyword" +longname = "keyword to save" +description = "keyword to indicate that information will be saved this stress period." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.rtype] +type = "string" +longname = "record type" +description = "type of information to save or print. Can be BUDGET or TEMPERATURE." +tagged = false +valid = [ + "TEMPERATURE", + "BUDGET", +] + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting] +type = "union" +description = "specifies the steps for which the data will be saved." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.all] +type = "keyword" +description = "keyword to indicate save for all time steps in period." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.first] +type = "keyword" +description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.last] +type = "keyword" +description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.frequency] +type = "integer" +description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.steps] +type = "array" +description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." +dtype = "integer" +shape = [ + "<=nstp", +] + +[blocks.period.fields.stress_period_data.item.arms.printrecord] +type = "record" +optional = true + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.print] +type = "keyword" +longname = "keyword to save" +description = "keyword to indicate that information will be printed this stress period." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.rtype] +type = "string" +longname = "record type" +description = "type of information to save or print. Can be BUDGET or TEMPERATURE." +tagged = false +valid = [ + "TEMPERATURE", + "BUDGET", +] + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting] +type = "union" +description = "specifies the steps for which the data will be saved." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.all] +type = "keyword" +description = "keyword to indicate save for all time steps in period." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.first] +type = "keyword" +description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.last] +type = "keyword" +description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.frequency] +type = "integer" +description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.steps] +type = "array" +description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." +dtype = "integer" +shape = [ + "<=nstp", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.tempfile] +set_in = "ar" +source = "temperaturefile" +type = "string" diff --git a/flopy4/mf6/dfns/gwe-sfe.toml b/flopy4/mf6/dfns/gwe-sfe.toml new file mode 100644 index 000000000..e27839add --- /dev/null +++ b/flopy4/mf6/dfns/gwe-sfe.toml @@ -0,0 +1,659 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-sfe" +parent = "gwe-nam" +ftype = "SFE6" +multi = true +subtype = "advanced" + +[dims.auxiliary] +value = "len(auxiliary)" + +[runtime_dims.ncv] +set_in = "ar" + +[blocks.options.fields.flow_package_name] +type = "string" +longname = "keyword to specify name of corresponding flow package" +description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWE name file)." +optional = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.flow_package_auxiliary_name] +type = "string" +longname = "keyword to specify name of temperature auxiliary variable in flow package" +description = "keyword to specify the name of an auxiliary variable provided in the corresponding flow package (i.e., FLOW_PACKAGE_NAME). If specified, then the simulated temperatures from this advanced energy transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced energy transport package are read from a file, then this option will have no effect." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of reach cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of reach information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_temperature] +type = "keyword" +longname = "print calculated temperature to listing file" +description = "keyword to indicate that the list of reach {#2} will be printed to the listing file for every stress period in which 'TEMPERATURE PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of reach flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save reach flows to budget file" +description = "keyword to indicate that reach flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.temperature_filerecord] +type = "record" +optional = true + +[blocks.options.fields.temperature_filerecord.fields.temperature] +type = "keyword" +longname = "temperature keyword" +description = "keyword to specify that record corresponds to temperature." + +[blocks.options.fields.temperature_filerecord.fields.tempfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write temperature information." +tagged = false +direction = "out" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the SFE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFE package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.dev_nonexpanding_matrix] +type = "keyword" +longname = "do not add rows to the solution matrix" +description = "keyword that solves the feature temperature with a general mixing equation and adds the result to the right-hand side of the GWE equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." +optional = true +developmode = true + +[blocks.packagedata.fields.packagedata] +type = "list" + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.rno] +type = "integer" +longname = "reach number for this entry" +description = "integer value that defines the reach number associated with the specified PACKAGEDATA data on the line. RNO must be greater than zero and less than or equal to NREACHES. Reach information must be specified for every reach or the program will terminate with an error. The program will also terminate with an error if information for a reach is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.strt] +type = "double" +longname = "starting reach temperature" +description = "real value that defines the starting temperature for the reach." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.ktf] +type = "double" +longname = "boundary thermal conductivity" +description = "is the thermal conductivity of the material between the aquifer cell and the stream reach. The thickness of the material is defined by the variable RBTHCND." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.rbthcnd] +type = "double" +longname = "streambed thickness" +description = "real value that defines the thickness of the streambed material through which conduction occurs. Must be greater than 0." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each reach. The values of auxiliary variables must be present for each reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.packagedata.fields.packagedata.item.fields.boundname] +type = "string" +longname = "well name" +description = "name of the reach cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "reachperioddata" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.rno] +type = "integer" +longname = "reach number for this entry" +description = "integer value that defines the reach number associated with the specified PERIOD data on the line. RNO must be greater than zero and less than or equal to NREACHES." +tagged = false +index = true +fk = "packagedata.rno" + +[blocks.period.fields.stress_period_data.item.fields.reachsetting] +type = "union" +description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the REACHSETTING string include: STATUS, TEMPERATURE, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the temperature of associated with the corresponding flow terms. Temperatures cannot be specified for all flow terms. For example, the Streamflow Package supports a 'DIVERSION' flow term. Diversion water will be routed using the calculated temperature of the reach." + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.status] +type = "string" +longname = "reach temperature status" +description = "keyword option to define reach status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the reach. If a reach is inactive, then there will be no energy fluxes into or out of the reach and the inactive value will be written for the reach temperature. If a reach is constant, then the temperature for the reach will be fixed at the user specified value." + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.temperature] +type = "double" +longname = "reach temperature" +description = "real or character value that defines the temperature for the reach. The specified TEMPERATURE is only applied if the reach is a constant temperature reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.rainfall] +type = "double" +longname = "rainfall temperature" +description = "real or character value that defines the rainfall temperature $(e.g.,:^{circ}C:or:^{circ}F)$ for the reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.evaporation] +type = "double" +longname = "evaporation temperature" +description = "use of the EVAPORATION keyword is allowed in the SFE package; however, the specified value is not currently used in SFE calculations. Instead, the latent heat of evaporation is multiplied by the simulated evaporation rate for determining the thermal energy lost from a stream reach." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.runoff] +type = "double" +longname = "runoff temperature" +description = "real or character value that defines the temperature of runoff $(e.g.,:^{circ}C:or:^{circ}F)$ for the reach. Users are free to use whatever temperature scale they want, which might include negative temperatures. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.inflow] +type = "double" +longname = "inflow temperature" +description = "real or character value that defines the temperature of inflow $(e.g.,:^{circ}C:or:^{circ}F)$ for the reach. Users are free to use whatever temperature scale they want, which might include negative temperatures. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord.fields.auxiliary] +type = "keyword" +description = "keyword for specifying auxiliary variable." + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord.fields.auxname] +type = "string" +description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord.fields.auxval] +type = "double" +longname = "auxiliary variable value" +description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.flow_pkg_name] +set_in = "ar" +source = "flow_package_name" +type = "string" + +[memory.fp_aux_name] +set_in = "ar" +source = "flow_package_auxiliary_name" +type = "string" + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprconc] +set_in = "ar" +source = "print_temperature" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.dev_nonexpanding] +set_in = "ar" +source = "dev_nonexpanding_matrix" +type = "logical" + +[memory.packagedata_ifno] +set_in = "ar" +source = "rno" +type = "integer" + +[memory.ifno] +set_in = "rp" +source = "rno" +type = "integer" + +[memory.period_auxiliary] +set_in = "rp" +source = "auxiliary" +type = "logical" + +[memory.ncv] +readonly = true +set_in = "ar" +description = "Number of control volumes. Assigned from the linked flow package during AR." +type = "integer" + +[memory.strt] +type = "array" +set_in = "ar" +source = "strt" +description = "Starting temperature for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xnewpak] +type = "array" +set_in = "ca" +description = "Current temperature for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xoldpak] +type = "array" +readonly = true +set_in = "ad" +description = "Temperature from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." +dtype = "double" +shape = [ + "ncv", +] + +[memory.ibound] +type = "array" +set_in = "ar" +description = "Boundary activity flag for each control volume." +dtype = "integer" +shape = [ + "ncv", +] + +[memory.concfeat] +type = "array" +readonly = true +set_in = "cq" +description = "Computed temperature for each feature. Set from XNEWPAK after solver convergence." +dtype = "double" +shape = [ + "ncv", +] + +[memory.qsto] +type = "array" +readonly = true +set_in = "cq" +description = "Storage temperature flow contribution for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.temprain] +type = "array" +set_in = "rp" +description = "Rainfall temperature for each reach." +dtype = "double" +shape = [ + "ncv", +] + +[memory.tempevap] +type = "array" +set_in = "rp" +description = "Evaporation temperature for each reach." +dtype = "double" +shape = [ + "ncv", +] + +[memory.temproff] +type = "array" +set_in = "rp" +description = "Runoff temperature for each reach." +dtype = "double" +shape = [ + "ncv", +] + +[memory.tempiflw] +type = "array" +set_in = "rp" +description = "Inflow temperature for each reach." +dtype = "double" +shape = [ + "ncv", +] + +[memory.vnew] +type = "array" +readonly = true +set_in = "cq" +description = "Reach water volume at the end of the current time step." +dtype = "double" +shape = [ + "ncv", +] + +[memory.vold] +type = "array" +readonly = true +set_in = "ad" +description = "Reach water volume at the start of the current time step." +dtype = "double" +shape = [ + "ncv", +] + +[memory.ktf] +type = "array" +set_in = "ar" +source = "ktf" +description = "Thermal conductivity of the streambed (E/T/L/Deg)." +dtype = "double" +shape = [ + "ncv", +] + +[memory.rfeatthk] +type = "array" +set_in = "ar" +source = "rbthcnd" +description = "Thickness of the streambed conduction layer (L)." +dtype = "double" +shape = [ + "ncv", +] + +[observations.temperature] +type = "union" + +[observations.temperature.arms.rno] +type = "integer" +tagged = false +index = true +fk = "packagedata.rno" + +[observations.temperature.arms.boundname] +type = "string" +tagged = false + +[observations.storage] +type = "union" + +[observations.storage.arms.rno] +type = "integer" +tagged = false +index = true +fk = "packagedata.rno" + +[observations.storage.arms.boundname] +type = "string" +tagged = false + +[observations.constant] +type = "union" + +[observations.constant.arms.rno] +type = "integer" +tagged = false +index = true +fk = "packagedata.rno" + +[observations.constant.arms.boundname] +type = "string" +tagged = false + +[observations.from-mvr] +type = "union" + +[observations.from-mvr.arms.rno] +type = "integer" +tagged = false +index = true +fk = "packagedata.rno" + +[observations.from-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.sfe] +type = "union" + +[observations.sfe.arms.rno] +type = "integer" +tagged = false +index = true +fk = "packagedata.rno" + +[observations.sfe.arms.boundname] +type = "string" +tagged = false + +[observations.strmbd-cond] +type = "union" + +[observations.strmbd-cond.arms.rno] +type = "integer" +tagged = false +index = true +fk = "packagedata.rno" + +[observations.strmbd-cond.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.rno] +type = "integer" +tagged = false +index = true +fk = "packagedata.rno" + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.rainfall] +type = "union" + +[observations.rainfall.arms.rno] +type = "integer" +tagged = false +index = true +fk = "packagedata.rno" + +[observations.rainfall.arms.boundname] +type = "string" +tagged = false + +[observations.evaporation] +type = "union" + +[observations.evaporation.arms.rno] +type = "integer" +tagged = false +index = true +fk = "packagedata.rno" + +[observations.evaporation.arms.boundname] +type = "string" +tagged = false + +[observations.runoff] +type = "union" + +[observations.runoff.arms.rno] +type = "integer" +tagged = false +index = true +fk = "packagedata.rno" + +[observations.runoff.arms.boundname] +type = "string" +tagged = false + +[observations.ext-inflow] +type = "union" + +[observations.ext-inflow.arms.rno] +type = "integer" +tagged = false +index = true +fk = "packagedata.rno" + +[observations.ext-inflow.arms.boundname] +type = "string" +tagged = false + +[observations.ext-outflow] +type = "union" + +[observations.ext-outflow.arms.rno] +type = "integer" +tagged = false +index = true +fk = "packagedata.rno" + +[observations.ext-outflow.arms.boundname] +type = "string" +tagged = false + +[observations.flow-ja-face] +type = "union" + +[observations.flow-ja-face.arms.rno_rno2] +type = "record" + +[observations.flow-ja-face.arms.rno_rno2.fields.rno] +type = "integer" +tagged = false +index = true +fk = "packagedata.rno" + +[observations.flow-ja-face.arms.rno_rno2.fields.rno2] +type = "integer" +tagged = false +index = true +fk = "packagedata.rno" + +[observations.flow-ja-face.arms.boundname] +type = "string" +tagged = false diff --git a/flopy4/mf6/dfns/gwe-ssm.toml b/flopy4/mf6/dfns/gwe-ssm.toml new file mode 100644 index 000000000..f64d01177 --- /dev/null +++ b/flopy4/mf6/dfns/gwe-ssm.toml @@ -0,0 +1,102 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-ssm" +parent = "gwe-nam" +ftype = "SSM6" + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of SSM flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save calculated flows to budget file" +description = "keyword to indicate that SSM flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.sources] +write_if_empty = true + +[blocks.sources.fields.sources] +type = "list" +longname = "package list" + +[blocks.sources.fields.sources.item] +name = "sources" +type = "record" + +[blocks.sources.fields.sources.item.fields.pname] +type = "string" +longname = "package name" +description = "name of the flow package for which an auxiliary variable contains a source temperature. If this flow package is represented using an advanced transport package (SFE, LKE, MWE, or UZE), then the advanced transport package will override SSM terms specified here." +tagged = false +pk = true + +[blocks.sources.fields.sources.item.fields.pname.fk] +path = "gwf-nam.packages.pname" +rule = "flow_model" + +[blocks.sources.fields.sources.item.fields.srctype] +type = "string" +longname = "source type" +description = "keyword indicating how temperature will be assigned for sources and sinks. Keyword must be specified as either AUX or AUXMIXED. For both options the user must provide an auxiliary variable in the corresponding flow package. The auxiliary variable must have the same name as the AUXNAME value that follows. If the AUX keyword is specified, then the auxiliary variable specified by the user will be assigned as the temperature value for groundwater sources (flows with a positive sign). For negative flow rates (sinks), groundwater will be withdrawn from the cell at the simulated temperature of the cell. The AUXMIXED option provides an alternative method for how to determine the temperature of sinks. If the cell temperature is larger than the user-specified auxiliary temperature, then the temperature of groundwater withdrawn from the cell will be assigned as the user-specified temperature. Alternatively, if the user-specified auxiliary temperature is larger than the cell temperature, then groundwater will be withdrawn at the cell temperature. Thus, the AUXMIXED option is designed to work with the Evapotranspiration (EVT) and Recharge (RCH) Packages where water may be withdrawn at a temperature that is less than the cell temperature." +tagged = false + +[blocks.sources.fields.sources.item.fields.auxname] +type = "string" +longname = "auxiliary variable name" +description = "name of the auxiliary variable in the package PNAME. This auxiliary variable must exist and be specified by the user in that package. The values in this auxiliary variable will be used to set the temperature associated with the flows for that boundary package." +tagged = false + +[blocks.fileinput.fields.fileinput] +type = "list" +optional = true + +[blocks.fileinput.fields.fileinput.item] +name = "fileinput" +type = "record" + +[blocks.fileinput.fields.fileinput.item.fields.pname] +type = "string" +longname = "package name" +description = "name of the flow package for which an SPC6 input file contains a source temperature. If this flow package is represented using an advanced transport package (SFE, LKE, MWE, or UZE), then the advanced transport package will override SSM terms specified here." +tagged = false +pk = true + +[blocks.fileinput.fields.fileinput.item.fields.pname.fk] +path = "gwf-nam.packages.pname" +rule = "flow_model" + +[blocks.fileinput.fields.fileinput.item.fields.spc6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a source sink mixing input file." + +[blocks.fileinput.fields.fileinput.item.fields.spc6_filename] +type = "file" +longname = "spc file name" +description = "character string that defines the path and filename for the file containing source and sink input data for the flow package. The SPC6_FILENAME file is a flexible input file that allows temperatures to be specified by stress period and with time series. Instructions for creating the SPC6_FILENAME input file are provided in the next section on file input for boundary temperatures." +tagged = false +direction = "in" +component = [ + "utl-spc", + "utl-spca", +] + +[blocks.fileinput.fields.fileinput.item.fields.mixed] +type = "keyword" +longname = "mixed keyword" +description = "keyword to specify that these stress package boundaries will have the mixed condition. The MIXED condition is described in the SOURCES block for AUXMIXED. The MIXED condition allows for water to be withdrawn at a temperature that is less than the cell temperature. It is intended primarily for representing evapotranspiration." +optional = true + +[memory.pname_sources] +source = "pname" +type = "string" + +[keys] +source = [ + "sources.pname", + "fileinput.pname", +] diff --git a/flopy4/mf6/dfns/gwe-uze.toml b/flopy4/mf6/dfns/gwe-uze.toml new file mode 100644 index 000000000..fc5da30fe --- /dev/null +++ b/flopy4/mf6/dfns/gwe-uze.toml @@ -0,0 +1,551 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwe-uze" +parent = "gwe-nam" +ftype = "UZE6" +multi = true +subtype = "advanced" + +[dims.auxiliary] +value = "len(auxiliary)" + +[runtime_dims.ncv] +set_in = "ar" + +[blocks.options.fields.flow_package_name] +type = "string" +longname = "keyword to specify name of corresponding flow package" +description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWE name file)." +optional = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.flow_package_auxiliary_name] +type = "string" +longname = "keyword to specify name of concentration auxiliary variable in flow package" +description = "keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated temperatures from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of unsaturated zone flow cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of unsaturated zone flow information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_temperature] +type = "keyword" +longname = "print calculated temperatures to listing file" +description = "keyword to indicate that the list of UZF cell {#2} will be printed to the listing file for every stress period in which 'TEMPERATURE PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of unsaturated zone flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save UZE cell flows to budget file" +description = "keyword to indicate that unsaturated zone flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.temperature_filerecord] +type = "record" +optional = true + +[blocks.options.fields.temperature_filerecord.fields.temperature] +type = "keyword" +longname = "stage keyword" +description = "keyword to specify that record corresponds to temperature." + +[blocks.options.fields.temperature_filerecord.fields.tempfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write temperature information." +tagged = false +direction = "out" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the UZE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZE package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.dev_nonexpanding_matrix] +type = "keyword" +longname = "do not add rows to the solution matrix" +description = "keyword that solves the feature temperature with a general mixing equation and adds the result to the right-hand side of the GWE equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." +optional = true +developmode = true + +[blocks.packagedata.fields.packagedata] +type = "list" + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.uzfno] +type = "integer" +longname = "UZF cell number for this entry" +description = "integer value that defines the UZF cell number associated with the specified PACKAGEDATA data on the line. UZFNO must be greater than zero and less than or equal to NUZFCELLS. Unsaturated zone flow information must be specified for every UZF cell or the program will terminate with an error. The program also will terminate with an error if information for a UZF cell is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.strt] +type = "double" +longname = "starting UZF cell temperature" +description = "real value that defines the starting temperature for the unsaturated zone flow cell." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each unsaturated zone flow. The values of auxiliary variables must be present for each unsaturated zone flow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.packagedata.fields.packagedata.item.fields.boundname] +type = "string" +longname = "UZF cell name" +description = "name of the unsaturated zone flow cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "uzeperioddata" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.uzfno] +type = "integer" +longname = "unsaturated zone flow cell number for this entry" +description = "integer value that defines the UZF cell number associated with the specified PERIOD data on the line. UZFNO must be greater than zero and less than or equal to NUZFCELLS." +tagged = false +index = true +fk = "packagedata.uzfno" + +[blocks.period.fields.stress_period_data.item.fields.uzesetting] +type = "union" +description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the UZESETTING string include: STATUS, TEMPERATURE, INFILTRATION, UZET, and AUXILIARY. These settings are used to assign the temperature associated with the corresponding flow terms. Temperatures cannot be specified for all flow terms." + +[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.status] +type = "string" +longname = "unsaturated zone flow cell temperature status" +description = "keyword option to define UZF cell status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the UZF cell. If a UZF cell is inactive, then there will be no energy fluxes into or out of the UZF cell and the inactive value will be written for the UZF cell temperature. If a UZF cell is constant, then the temperature for the UZF cell will be fixed at the user specified value." + +[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.temperature] +type = "double" +longname = "unsaturated zone flow cell temperature" +description = "real or character value that defines the temperature for the unsaturated zone flow cell. The specified TEMPERATURE is only applied if the unsaturated zone flow cell is a constant temperature cell. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.infiltration] +type = "double" +longname = "infiltration temperature" +description = "real or character value that defines the temperature of the infiltration $(e.g.,:^{circ}C:or:^{circ}F)$ for the UZF cell. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.uzet] +type = "double" +longname = "unsaturated zone et temperature" +description = "real or character value that states what fraction of the simulated unsaturated zone evapotranspiration is associated with evaporation. The evaporative losses from the unsaturated zone moisture content will have an evaporative cooling effect on the GWE cell from which the evaporation originated. If this value is larger than 1, then it will be reset to 1. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.auxiliaryrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.auxiliaryrecord.fields.auxiliary] +type = "keyword" +description = "keyword for specifying auxiliary variable." + +[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.auxiliaryrecord.fields.auxname] +type = "string" +description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.auxiliaryrecord.fields.auxval] +type = "double" +longname = "auxiliary variable value" +description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.flow_pkg_name] +set_in = "ar" +source = "flow_package_name" +type = "string" + +[memory.fp_aux_name] +set_in = "ar" +source = "flow_package_auxiliary_name" +type = "string" + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprconc] +set_in = "ar" +source = "print_temperature" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.dev_nonexpanding] +set_in = "ar" +source = "dev_nonexpanding_matrix" +type = "logical" + +[memory.packagedata_ifno] +set_in = "ar" +source = "uzfno" +type = "integer" + +[memory.ifno] +set_in = "rp" +source = "uzfno" +type = "integer" + +[memory.period_auxiliary] +set_in = "rp" +source = "auxiliary" +type = "logical" + +[memory.ncv] +readonly = true +set_in = "ar" +description = "Number of control volumes. Assigned from the linked flow package during AR." +type = "integer" + +[memory.strt] +type = "array" +set_in = "ar" +source = "strt" +description = "Starting temperature for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xnewpak] +type = "array" +set_in = "ca" +description = "Current temperature for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xoldpak] +type = "array" +readonly = true +set_in = "ad" +description = "Temperature from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." +dtype = "double" +shape = [ + "ncv", +] + +[memory.ibound] +type = "array" +set_in = "ar" +description = "Boundary activity flag for each control volume." +dtype = "integer" +shape = [ + "ncv", +] + +[memory.concfeat] +type = "array" +readonly = true +set_in = "cq" +description = "Computed temperature for each feature. Set from XNEWPAK after solver convergence." +dtype = "double" +shape = [ + "ncv", +] + +[memory.qsto] +type = "array" +readonly = true +set_in = "cq" +description = "Storage temperature flow contribution for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.tempinfl] +type = "array" +set_in = "rp" +description = "Infiltration temperature for each UZF cell." +dtype = "double" +shape = [ + "ncv", +] + +[memory.tempuzet] +type = "array" +set_in = "rp" +description = "ET temperature for each UZF cell." +dtype = "double" +shape = [ + "ncv", +] + +[observations.temperature] +type = "union" + +[observations.temperature.arms.uzfno] +type = "integer" +tagged = false +index = true +fk = "packagedata.uzfno" + +[observations.temperature.arms.boundname] +type = "string" +tagged = false + +[observations.storage] +type = "union" + +[observations.storage.arms.uzfno] +type = "integer" +tagged = false +index = true +fk = "packagedata.uzfno" + +[observations.storage.arms.boundname] +type = "string" +tagged = false + +[observations.constant] +type = "union" + +[observations.constant.arms.uzfno] +type = "integer" +tagged = false +index = true +fk = "packagedata.uzfno" + +[observations.constant.arms.boundname] +type = "string" +tagged = false + +[observations.from-mvr] +type = "union" + +[observations.from-mvr.arms.uzfno] +type = "integer" +tagged = false +index = true +fk = "packagedata.uzfno" + +[observations.from-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.uze] +type = "union" + +[observations.uze.arms.uzfno] +type = "integer" +tagged = false +index = true +fk = "packagedata.uzfno" + +[observations.uze.arms.boundname] +type = "string" +tagged = false + +[observations.thermal-equil] +type = "union" + +[observations.thermal-equil.arms.uzfno] +type = "integer" +tagged = false +index = true +fk = "packagedata.uzfno" + +[observations.thermal-equil.arms.boundname] +type = "string" +tagged = false + +[observations.infiltration] +type = "union" + +[observations.infiltration.arms.uzfno] +type = "integer" +tagged = false +index = true +fk = "packagedata.uzfno" + +[observations.infiltration.arms.boundname] +type = "string" +tagged = false + +[observations.rej-inf] +type = "union" + +[observations.rej-inf.arms.uzfno] +type = "integer" +tagged = false +index = true +fk = "packagedata.uzfno" + +[observations.rej-inf.arms.boundname] +type = "string" +tagged = false + +[observations.uzet] +type = "union" + +[observations.uzet.arms.uzfno] +type = "integer" +tagged = false +index = true +fk = "packagedata.uzfno" + +[observations.uzet.arms.boundname] +type = "string" +tagged = false + +[observations.rej-inf-to-mvr] +type = "union" + +[observations.rej-inf-to-mvr.arms.uzfno] +type = "integer" +tagged = false +index = true +fk = "packagedata.uzfno" + +[observations.rej-inf-to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.flow-ja-face] +type = "union" + +[observations.flow-ja-face.arms.uzfno_uzfno2] +type = "record" + +[observations.flow-ja-face.arms.uzfno_uzfno2.fields.uzfno] +type = "integer" +tagged = false +index = true +fk = "packagedata.uzfno" + +[observations.flow-ja-face.arms.uzfno_uzfno2.fields.uzfno2] +type = "integer" +tagged = false +index = true +fk = "packagedata.uzfno" + +[observations.flow-ja-face.arms.boundname] +type = "string" +tagged = false diff --git a/flopy4/mf6/dfns/gwf-api.toml b/flopy4/mf6/dfns/gwf-api.toml new file mode 100644 index 000000000..00193f128 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-api.toml @@ -0,0 +1,108 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-api" +parent = "gwf-nam" +ftype = "API6" +multi = true + +[dims.maxbound] +value = "maxbound" + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of api boundary cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of api boundary information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of api boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save api flows to budget file" +description = "keyword to indicate that api boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the api boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the api boundary package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.mover] +type = "keyword" +description = "keyword to indicate that this instance of the api boundary Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." +optional = true + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of user-defined api boundaries" +description = "integer value specifying the maximum number of api boundary cells that will be specified for use during any stress period." + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.maxbound] +set_in = "ar" +source = "maxbound" +type = "integer" + +[observations.api] +type = "union" + +[observations.api.arms.cellid] +type = "cellid" +tagged = false + +[observations.api.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" + +[keys.mover_provider] +path = "<=maxbound" +when = "mover" diff --git a/flopy4/mf6/dfns/gwf-buy.toml b/flopy4/mf6/dfns/gwf-buy.toml new file mode 100644 index 000000000..339ead8df --- /dev/null +++ b/flopy4/mf6/dfns/gwf-buy.toml @@ -0,0 +1,106 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-buy" +parent = "gwf-nam" +ftype = "BUY6" + +[dims.nrhospecies] +value = "nrhospecies" + +[blocks.options.fields.hhformulation_rhs] +type = "keyword" +longname = "hh formulation on right-hand side" +description = "use the variable-density hydraulic head formulation and add off-diagonal terms to the right-hand. This option will prevent the BUY Package from adding asymmetric terms to the flow matrix." +optional = true + +[blocks.options.fields.denseref] +type = "double" +longname = "reference density" +description = "fluid reference density used in the equation of state. This value is set to 1000. if not specified as an option." +optional = true +default = 1000.0 + +[blocks.options.fields.density_filerecord] +type = "record" +optional = true + +[blocks.options.fields.density_filerecord.fields.density] +type = "keyword" +longname = "density keyword" +description = "keyword to specify that record corresponds to density." + +[blocks.options.fields.density_filerecord.fields.densityfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write density information. The density file has the same format as the head file. Density values will be written to the density file whenever heads are written to the binary head file. The settings for controlling head output are contained in the Output Control option." +tagged = false +direction = "out" + +[blocks.options.fields.dev_efh_formulation] +type = "keyword" +longname = "use equivalent freshwater head formulation" +description = "use the variable-density equivalent freshwater head formulation instead of the hydraulic head head formulation. This dev option has only been implemented for confined aquifer conditions and should generally not be used." +optional = true +developmode = true + +[blocks.dimensions.fields.nrhospecies] +type = "integer" +longname = "number of species used in density equation of state" +description = "number of species used in density equation of state. This value must be one or greater if the BUY package is activated." + +[blocks.packagedata.fields.packagedata] +type = "list" +shape = [ + "nrhospecies", +] + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.irhospec] +type = "integer" +longname = "species number for this entry" +description = "integer value that defines the species number associated with the specified PACKAGEDATA data on the line. IRHOSPECIES must be greater than zero and less than or equal to NRHOSPECIES. Information must be specified for each of the NRHOSPECIES species or the program will terminate with an error. The program will also terminate with an error if information for a species is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.drhodc] +type = "double" +longname = "slope of the density-concentration line" +description = "real value that defines the slope of the density-concentration line for this species used in the density equation of state." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.crhoref] +type = "double" +longname = "reference concentration value" +description = "real value that defines the reference concentration value used for this species in the density equation of state." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.modelname] +type = "string" +longname = "modelname" +description = "name of a GWT or GWE model used to simulate a species that will be used in the density equation of state. This name will have no effect if the simulation does not include a GWT or GWE model that corresponds to this GWF model." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.auxspeciesname] +type = "string" +longname = "auxspeciesname" +description = "name of an auxiliary variable in a GWF stress package that will be used for this species to calculate a density value. If a density value is needed by the Buoyancy Package then it will use the concentration values in this AUXSPECIESNAME column in the density equation of state. For advanced stress packages (LAK, SFR, MAW, and UZF) that have an associated advanced transport package (LKT, SFT, MWT, and UZT), the FLOW_PACKAGE_AUXILIARY_NAME option in the advanced transport package can be used to transfer simulated concentrations into the flow package auxiliary variable. In this manner, the Buoyancy Package can calculate density values for lakes, streams, multi-aquifer wells, and unsaturated zone flow cells using simulated concentrations." +tagged = false + +[memory.hhform_rhs] +set_in = "ar" +source = "hhformulation_rhs" +type = "logical" + +[memory.dev_efh_form] +set_in = "ar" +source = "dev_efh_formulation" +type = "logical" + +[memory.nrhospecies] +set_in = "ar" +source = "nrhospecies" +type = "integer" diff --git a/flopy4/mf6/dfns/gwf-chd.toml b/flopy4/mf6/dfns/gwf-chd.toml new file mode 100644 index 000000000..4a3946e0d --- /dev/null +++ b/flopy4/mf6/dfns/gwf-chd.toml @@ -0,0 +1,307 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-chd" +parent = "gwf-nam" +ftype = "CHD6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of CHD head value." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of constant-head cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of constant-head information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print CHD flows to listing file" +description = "keyword to indicate that the list of constant-head flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save CHD flows to budget file" +description = "keyword to indicate that constant-head flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.dev_no_newton] +type = "keyword" +longname = "turn off Newton for unconfined cells" +description = "turn off Newton for unconfined cells" +optional = true +developmode = true + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of constant heads" +description = "integer value specifying the maximum number of constant-head cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.head] +type = "double" +longname = "head value assigned to constant head" +description = "is the head at the boundary. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "constant head boundary name" +description = "name of the constant head boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.inewton] +set_in = "ar" +source = "dev_no_newton" +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: head." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "CHD" +output = true +obs_type = "CHD" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.chd] +type = "union" + +[observations.chd.arms.cellid] +type = "cellid" +tagged = false + +[observations.chd.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwf-chdg.toml b/flopy4/mf6/dfns/gwf-chdg.toml new file mode 100644 index 000000000..d60f35490 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-chdg.toml @@ -0,0 +1,299 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-chdg" +parent = "gwf-nam" +ftype = "CHD6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.readarraygrid] +type = "keyword" +longname = "use array-based grid input" +description = "indicates that array-based grid input will be used for the constant head package. This keyword must be specified to use array-based grid input. When READARRAYGRID is specified, values must be provided for every cell within a model grid, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results. No data cells should contain the value DNODATA (3.0E+30)." +default = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of CHD head value." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of constant-head information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print CHD flows to listing file" +description = "keyword to indicate that the list of constant-head flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save CHD flows to budget file" +description = "keyword to indicate that constant-head flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.options.fields.dev_no_newton] +type = "keyword" +longname = "turn off Newton for unconfined cells" +description = "turn off Newton for unconfined cells" +optional = true +developmode = true + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of constant head cells in any stress period" +description = "integer value specifying the maximum number of constant-head cells that will be specified for use during any stress period." +optional = true + +[blocks.period.fields.head] +type = "array" +longname = "head value assigned to constant head" +description = "is the head at the boundary." +default = 3e+30 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.period.fields.aux] +type = "list" +longname = "constant head auxiliary variable iaux" +description = "is an array of values for auxiliary variable aux(iaux), where iaux is a value from 1 to naux, and aux(iaux) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then it will retain its value from the most recently specified period block. If an auxiliary variable array has never been specified, its value is zero. If the value specified here for the auxiliary variable is the same as auxmultname, then the head array will be multiplied by this array." +optional = true +shape = [ + "<=auxiliary", +] + +[blocks.period.fields.aux.item] +name = "aux" +type = "record" + +[blocks.period.fields.aux.item.fields.auxname] +type = "string" +longname = "auxiliary variable name" +description = "name of the auxiliary variable the following array sets; must be one of the auxiliary variables." +tagged = false +fk = "options.auxiliary" +dynamic = true + +[blocks.period.fields.aux.item.fields.aux] +type = "array" +longname = "constant head auxiliary variable iaux" +netcdf = true +tagged = false +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.inewton] +set_in = "ar" +source = "dev_no_newton" +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "CHD" +output = true +obs_type = "CHD" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.chd] +type = "union" + +[observations.chd.arms.cellid] +type = "cellid" +tagged = false + +[observations.chd.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwf-csub.toml b/flopy4/mf6/dfns/gwf-csub.toml new file mode 100644 index 000000000..77cb5c3ea --- /dev/null +++ b/flopy4/mf6/dfns/gwf-csub.toml @@ -0,0 +1,939 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-csub" +parent = "gwf-nam" +ftype = "CSUB6" + +[dims.ninterbeds] +value = "ninterbeds" + +[dims.maxsig0] +value = "maxsig0" + +[runtime_dims.ncelldim] +set_in = "ar" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of CSUB cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of CSUB information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "keyword to save CSUB flows" +description = "keyword to indicate that cell-by-cell flow terms will be written to the file specified with 'BUDGET SAVE FILE' in Output Control." +optional = true + +[blocks.options.fields.gammaw] +type = "double" +longname = "unit weight of water" +description = "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." +optional = true +default = 9806.65 + +[blocks.options.fields.beta] +type = "double" +longname = "compressibility of water" +description = "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." +optional = true +default = 4.6512e-10 + +[blocks.options.fields.elastic_inelastic_smoothing] +type = "keyword" +longname = "elastic to inelastic smoothing" +description = "keyword to activate smoothing of the delay interbed skeletal specific storage as the effective stress exceeds the preconsolidation stress. When active, the skeletal specific storage is smoothly transitioned from the elastic value to the inelastic value over a small window (0.001 of the preconsolidation stress) instead of switching discontinuously at the preconsolidation stress. Activating this option can improve convergence of models with delay interbeds. By default, the elastic to inelastic transition is discontinuous." +optional = true + +[blocks.options.fields.strict_effective_stress] +type = "keyword" +longname = "terminate on negative effective stress" +description = "keyword to terminate the simulation when the calculated effective stress is small or negative, instead of regularizing it. By default the effective stress used to calculate the skeletal specific storage is not allowed to fall below a small fraction (0.001) of the geostatic stress, which keeps the specific storage bounded and allows the simulation to continue; a warning reports the number of time steps in which a negative effective stress was regularized. Negative effective stress typically occurs in uppermost cells where simulated water levels rise above land surface. This keyword is deprecated and will be removed in a future release." +optional = true +deprecated = "6.8.0" + +[blocks.options.fields.head_based] +type = "keyword" +longname = "keyword to indicate the head-based formulation will be used" +description = "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." +optional = true + +[blocks.options.fields.initial_preconsolidation_head] +type = "keyword" +longname = "keyword to indicate that preconsolidation heads will be specified" +description = "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." +optional = true + +[blocks.options.fields.ndelaycells] +type = "integer" +longname = "number of interbed cell nodes" +description = "number of nodes used to discretize delay interbeds. If not specified, then a default value of 19 is assigned." +optional = true + +[blocks.options.fields.compression_indices] +type = "keyword" +longname = "keyword to indicate CR and CC are read instead of SSE and SSV" +description = "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." +optional = true + +[blocks.options.fields.update_material_properties] +type = "keyword" +longname = "keyword to indicate material properties can change during the simulations" +description = "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." +optional = true + +[blocks.options.fields.cell_fraction] +type = "keyword" +longname = "keyword to indicate cell fraction interbed thickness" +description = "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." +optional = true + +[blocks.options.fields.specified_initial_interbed_state] +type = "keyword" +longname = "keyword to indicate that absolute initial states will be specified" +description = "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." +optional = true + +[blocks.options.fields.specified_initial_preconsolidation_stress] +type = "keyword" +longname = "keyword to indicate that absolute initial preconsolidation stresses (head) will be specified" +description = "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." +optional = true + +[blocks.options.fields.specified_initial_delay_head] +type = "keyword" +longname = "keyword to indicate that absolute initial delay bed heads will be specified" +description = "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." +optional = true + +[blocks.options.fields.effective_stress_lag] +type = "keyword" +longname = "keyword to indicate that specific storage will be calculate using the effective stress from the previous time step" +description = "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." +optional = true + +[blocks.options.fields.strainib_filerecord] +type = "record" +optional = true + +[blocks.options.fields.strainib_filerecord.fields.strain_csv_interbed] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify the record that corresponds to final interbed strain output." + +[blocks.options.fields.strainib_filerecord.fields.interbedstrain_filename] +type = "file" +longname = "file keyword" +description = "name of the comma-separated-values output file to write final interbed strain information." +tagged = false +direction = "out" + +[blocks.options.fields.straincg_filerecord] +type = "record" +optional = true + +[blocks.options.fields.straincg_filerecord.fields.strain_csv_coarse] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify the record that corresponds to final coarse-grained material strain output." + +[blocks.options.fields.straincg_filerecord.fields.coarsestrain_filename] +type = "file" +longname = "file keyword" +description = "name of the comma-separated-values output file to write final coarse-grained material strain information." +tagged = false +direction = "out" + +[blocks.options.fields.compaction_filerecord] +type = "record" +optional = true + +[blocks.options.fields.compaction_filerecord.fields.compaction] +type = "keyword" +longname = "compaction keyword" +description = "keyword to specify that record corresponds to the compaction." + +[blocks.options.fields.compaction_filerecord.fields.compaction_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write compaction information." +tagged = false +direction = "out" + +[blocks.options.fields.compaction_elastic_filerecord] +type = "record" +optional = true + +[blocks.options.fields.compaction_elastic_filerecord.fields.compaction_elastic] +type = "keyword" +longname = "elastic interbed compaction keyword" +description = "keyword to specify that record corresponds to the elastic interbed compaction binary file." + +[blocks.options.fields.compaction_elastic_filerecord.fields.elastic_compaction_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write elastic interbed compaction information." +tagged = false +direction = "out" + +[blocks.options.fields.compaction_inelastic_filerecord] +type = "record" +optional = true + +[blocks.options.fields.compaction_inelastic_filerecord.fields.compaction_inelastic] +type = "keyword" +longname = "inelastic interbed compaction keyword" +description = "keyword to specify that record corresponds to the inelastic interbed compaction binary file." + +[blocks.options.fields.compaction_inelastic_filerecord.fields.inelastic_compaction_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write inelastic interbed compaction information." +tagged = false +direction = "out" + +[blocks.options.fields.compaction_interbed_filerecord] +type = "record" +optional = true + +[blocks.options.fields.compaction_interbed_filerecord.fields.compaction_interbed] +type = "keyword" +longname = "interbed compaction keyword" +description = "keyword to specify that record corresponds to the interbed compaction binary file." + +[blocks.options.fields.compaction_interbed_filerecord.fields.interbed_compaction_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write interbed compaction information." +tagged = false +direction = "out" + +[blocks.options.fields.compaction_coarse_filerecord] +type = "record" +optional = true + +[blocks.options.fields.compaction_coarse_filerecord.fields.compaction_coarse] +type = "keyword" +longname = "coarse compaction keyword" +description = "keyword to specify that record corresponds to the elastic coarse-grained material compaction binary file." + +[blocks.options.fields.compaction_coarse_filerecord.fields.coarse_compaction_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write elastic coarse-grained material compaction information." +tagged = false +direction = "out" + +[blocks.options.fields.zdisplacement_filerecord] +type = "record" +optional = true + +[blocks.options.fields.zdisplacement_filerecord.fields.zdisplacement] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the z-displacement binary file." + +[blocks.options.fields.zdisplacement_filerecord.fields.zdisplacement_filename] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write z-displacement information." +tagged = false +direction = "out" + +[blocks.options.fields.package_convergence_filerecord] +type = "record" +optional = true + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence] +type = "keyword" +longname = "package_convergence keyword" +description = "keyword to specify that record corresponds to the package convergence comma spaced values file. Package convergence data is for delay interbeds. A warning message will be issued if package convergence data is requested but delay interbeds are not included in the package." + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] +type = "file" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." +tagged = false +direction = "out" + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CSUB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CSUB package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.ninterbeds] +type = "integer" +longname = "number of CSUB interbed systems" +description = "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." + +[blocks.dimensions.fields.maxsig0] +type = "integer" +longname = "maximum number of stress offset cells" +description = "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." +optional = true + +[blocks.griddata.fields.cg_ske_cr] +type = "array" +longname = "elastic coarse specific storage" +description = "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." +default = 1e-05 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.cg_theta] +type = "array" +longname = "initial coarse-grained material porosity" +description = "is the initial porosity of coarse-grained materials." +default = 0.2 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.sgm] +type = "array" +longname = "specific gravity of moist sediments" +description = "is the specific gravity of moist or unsaturated sediments. If not specified, then a default value of 1.7 is assigned." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.sgs] +type = "array" +longname = "specific gravity of saturated sediments" +description = "is the specific gravity of saturated sediments. If not specified, then a default value of 2.0 is assigned." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.packagedata.fields.packagedata] +type = "list" +optional = true +shape = [ + "ninterbeds", +] + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.icsubno] +type = "integer" +longname = "CSUB id number for this entry" +description = "integer value that defines the CSUB interbed number associated with the specified PACKAGEDATA data on the line. CSUBNO must be greater than zero and less than or equal to NINTERBEDS. CSUB information must be specified for every CSUB cell or the program will terminate with an error. The program will also terminate with an error if information for a CSUB interbed number is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.cdelay] +type = "string" +longname = "delay type" +description = "character string that defines the subsidence delay type for the interbed. Possible subsidence package CDELAY strings include: NODELAY--character keyword to indicate that delay will not be simulated in the interbed. DELAY--character keyword to indicate that delay will be simulated in the interbed." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.pcs0] +type = "double" +longname = "initial stress" +description = "is the initial offset from the calculated initial effective stress or initial preconsolidation stress in the interbed, in units of height of a column of water. PCS0 is the initial preconsolidation stress if SPECIFIED_INITIAL_INTERBED_STATE or SPECIFIED_INITIAL_PRECONSOLIDATION_STRESS are specified in the OPTIONS block. If HEAD_BASED is specified in the OPTIONS block, PCS0 is the initial offset from the calculated initial head or initial preconsolidation head in the CSUB interbed and the initial preconsolidation stress is calculated from the calculated initial effective stress or calculated initial geostatic stress, respectively. When PCS0 is a relative offset, the sign depends on the formulation. For the default effective-stress formulation, specify a positive PCS0 for an overconsolidated interbed since the preconsolidation stress is greater than the initial effective stress. If HEAD_BASED is specified, specify a negative PCS0 for an overconsolidated interbed since the preconsolidation head is less than the initial head. A PCS0 of zero is normally consolidated in both formulations." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.thick_frac] +type = "double" +longname = "interbed thickness or cell fraction" +description = "is the interbed thickness or cell fraction of the interbed. Interbed thickness is specified as a fraction of the cell thickness if CELL_FRACTION is specified in the OPTIONS block." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.rnb] +type = "double" +longname = "delay interbed material factor" +description = "is the interbed material factor equivalent number of interbeds in the interbed system represented by the interbed. RNB must be greater than or equal to 1 if CDELAY is DELAY. Otherwise, RNB can be any value." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.ssv_cc] +type = "double" +longname = "initial interbed inelastic specific storage" +description = "is the initial inelastic specific storage or compression index of the interbed. The compression index is specified if COMPRESSION_INDICES is specified in the OPTIONS block. Specified or calculated interbed inelastic specific storage values are not adjusted from initial values if HEAD_BASED is specified in the OPTIONS block." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.sse_cr] +type = "double" +longname = "initial interbed elastic specific storage" +description = "is the initial elastic coarse-grained material specific storage or recompression index of the interbed. The recompression index is specified if COMPRESSION_INDICES is specified in the OPTIONS block. Specified or calculated interbed elastic specific storage values are not adjusted from initial values if HEAD_BASED is specified in the OPTIONS block." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.theta] +type = "double" +longname = "initial interbed porosity" +description = "is the initial porosity of the interbed." +default = 0.2 +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.kv] +type = "double" +longname = "delay interbed vertical hydraulic conductivity" +description = "is the vertical hydraulic conductivity of the delay interbed. KV must be greater than 0 if CDELAY is DELAY. Otherwise, KV can be any value." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.h0] +type = "double" +longname = "initial delay interbed head" +description = "is the initial offset from the head in cell cellid or the initial head in the delay interbed. H0 is the initial head in the delay bed if SPECIFIED_INITIAL_INTERBED_STATE or SPECIFIED_INITIAL_DELAY_HEAD are specified in the OPTIONS block. H0 can be any value if CDELAY is NODELAY." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.boundname] +type = "string" +longname = "interbed name" +description = "name of the CSUB cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxsig0", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.sig0] +type = "double" +longname = "geostatic stress offset" +description = "is the stress offset for the cell. SIG0 is added to the calculated geostatic stress for the cell. SIG0 is specified only if MAXSIG0 is specified to be greater than 0 in the DIMENSIONS block. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.ei_smoothing] +set_in = "ar" +source = "elastic_inelastic_smoothing" +type = "logical" + +[memory.strict_stress] +set_in = "ar" +source = "strict_effective_stress" +type = "logical" + +[memory.precon_head] +set_in = "ar" +source = "initial_preconsolidation_head" +type = "logical" + +[memory.icompress] +set_in = "ar" +source = "compression_indices" +type = "logical" + +[memory.matprop] +set_in = "ar" +source = "update_material_properties" +type = "logical" + +[memory.interbed_state] +set_in = "ar" +source = "specified_initial_interbed_state" +type = "integer" + +[memory.precon_stress] +set_in = "ar" +source = "specified_initial_preconsolidation_stress" +type = "logical" + +[memory.delay_head] +set_in = "ar" +source = "specified_initial_delay_head" +type = "logical" + +[memory.stress_lag] +set_in = "ar" +source = "effective_stress_lag" +type = "logical" + +[memory.csvinterbed] +set_in = "ar" +source = "strain_csv_interbed" +type = "logical" + +[memory.interbedstrainfn] +set_in = "ar" +source = "interbedstrain_filename" +type = "string" + +[memory.csvcoarse] +set_in = "ar" +source = "strain_csv_coarse" +type = "logical" + +[memory.coarsestrainfn] +set_in = "ar" +source = "coarsestrain_filename" +type = "string" + +[memory.cmpfn] +set_in = "ar" +source = "compaction_filename" +type = "string" + +[memory.cmpelastic] +set_in = "ar" +source = "compaction_elastic" +type = "logical" + +[memory.elasticcmpfn] +set_in = "ar" +source = "elastic_compaction_filename" +type = "string" + +[memory.cmpinelastic] +set_in = "ar" +source = "compaction_inelastic" +type = "logical" + +[memory.inelasticcmpfn] +set_in = "ar" +source = "inelastic_compaction_filename" +type = "string" + +[memory.cmpinterbed] +set_in = "ar" +source = "compaction_interbed" +type = "logical" + +[memory.interbedcmpfn] +set_in = "ar" +source = "interbed_compaction_filename" +type = "string" + +[memory.cmpcoarse] +set_in = "ar" +source = "compaction_coarse" +type = "logical" + +[memory.cmpcoarsefn] +set_in = "ar" +source = "coarse_compaction_filename" +type = "string" + +[memory.zdispfn] +set_in = "ar" +source = "zdisplacement_filename" +type = "string" + +[memory.pkgconverge] +set_in = "ar" +source = "package_convergence" +type = "logical" + +[memory.pkgconvergefn] +set_in = "ar" +source = "package_convergence_filename" +type = "string" + +[memory.maxbound] +set_in = "ar" +source = "maxsig0" +type = "integer" + +[memory.cellid_pkgdata] +type = "array" +set_in = "ar" +source = "cellid" +dtype = "integer" +shape = [ + "ncelldim", +] + +[memory.ninterbeds] +set_in = "ar" +source = "ninterbeds" +type = "integer" + +[memory.cg_ske_cr] +type = "array" +set_in = "ar" +source = "cg_ske_cr" +dtype = "double" +shape = [ + "nodes", +] + +[memory.cg_theta] +type = "array" +set_in = "ar" +source = "cg_theta" +dtype = "double" +shape = [ + "nodes", +] + +[memory.sgm] +type = "array" +set_in = "ar" +source = "sgm" +dtype = "double" +shape = [ + "nodes", +] + +[memory.sgs] +type = "array" +set_in = "ar" +source = "sgs" +dtype = "double" +shape = [ + "nodes", +] + +[observations.csub] +type = "union" + +[observations.csub.arms.icsubno] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.csub.arms.boundname] +type = "string" +tagged = false + +[observations.inelastic-csub] +type = "union" + +[observations.inelastic-csub.arms.icsubno] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.inelastic-csub.arms.boundname] +type = "string" +tagged = false + +[observations.elastic-csub] +type = "union" + +[observations.elastic-csub.arms.icsubno] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.elastic-csub.arms.boundname] +type = "string" +tagged = false + +[observations.delay-flowtop] +type = "union" + +[observations.delay-flowtop.arms.icsubno] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.delay-flowtop.arms.boundname] +type = "string" +tagged = false + +[observations.delay-flowbot] +type = "union" + +[observations.delay-flowbot.arms.icsubno] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.delay-flowbot.arms.boundname] +type = "string" +tagged = false + +[observations.sk] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.ske] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.theta] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.thickness] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.interbed-compaction] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.interbed-compaction-pct] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.inelastic-compaction] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.elastic-compaction] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.delay-head] +type = "record" + +[observations.delay-head.fields.icsubno] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.delay-head.fields.idcellno] +type = "integer" +tagged = false +index = true + +[observations.delay-gstress] +type = "record" + +[observations.delay-gstress.fields.icsubno] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.delay-gstress.fields.idcellno] +type = "integer" +tagged = false +index = true + +[observations.delay-estress] +type = "record" + +[observations.delay-estress.fields.icsubno] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.delay-estress.fields.idcellno] +type = "integer" +tagged = false +index = true + +[observations.delay-preconstress] +type = "record" + +[observations.delay-preconstress.fields.icsubno] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.delay-preconstress.fields.idcellno] +type = "integer" +tagged = false +index = true + +[observations.delay-compaction] +type = "record" + +[observations.delay-compaction.fields.icsubno] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.delay-compaction.fields.idcellno] +type = "integer" +tagged = false +index = true + +[observations.delay-thickness] +type = "record" + +[observations.delay-thickness.fields.icsubno] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.delay-thickness.fields.idcellno] +type = "integer" +tagged = false +index = true + +[observations.delay-theta] +type = "record" + +[observations.delay-theta.fields.icsubno] +type = "integer" +tagged = false +index = true +fk = "packagedata.icsubno" + +[observations.delay-theta.fields.idcellno] +type = "integer" +tagged = false +index = true + +[observations.coarse-csub] +type = "cellid" +tagged = false + +[observations.csub-cell] +type = "cellid" +tagged = false + +[observations.wcomp-csub-cell] +type = "cellid" +tagged = false + +[observations.sk-cell] +type = "cellid" +tagged = false + +[observations.ske-cell] +type = "cellid" +tagged = false + +[observations.estress-cell] +type = "cellid" +tagged = false + +[observations.gstress-cell] +type = "cellid" +tagged = false + +[observations.preconstress-cell] +type = "cellid" +tagged = false + +[observations.coarse-compaction] +type = "cellid" +tagged = false + +[observations.compaction-cell] +type = "cellid" +tagged = false + +[observations.inelastic-compaction-cell] +type = "cellid" +tagged = false + +[observations.elastic-compaction-cell] +type = "cellid" +tagged = false + +[observations.coarse-thickness] +type = "cellid" +tagged = false + +[observations.thickness-cell] +type = "cellid" +tagged = false + +[observations.coarse-theta] +type = "cellid" +tagged = false + +[observations.theta-cell] +type = "cellid" +tagged = false diff --git a/flopy4/mf6/dfns/gwf-dis.toml b/flopy4/mf6/dfns/gwf-dis.toml new file mode 100644 index 000000000..37b32d1d8 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-dis.toml @@ -0,0 +1,302 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-dis" +parent = "gwf-nam" +ftype = "DIS6" + +[dims.nlay] +value = "nlay" +scope = "model" + +[dims.nrow] +value = "nrow" +scope = "model" + +[dims.ncol] +value = "ncol" +scope = "model" + +[dims.ncpl] +value = "nrow * ncol" +scope = "model" + +[dims.nodes] +value = "nlay * nrow * ncol" +scope = "model" + +[dims.ncelldim] +value = "3" +scope = "model" + +[runtime_dims.nodes] +set_in = "ar" + +[runtime_dims.nodesuser] +set_in = "ar" + +[blocks.options.fields.length_units] +type = "string" +longname = "model length units" +description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." +optional = true + +[blocks.options.fields.nogrb] +type = "keyword" +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." +optional = true + +[blocks.options.fields.grb_filerecord] +type = "record" +optional = true + +[blocks.options.fields.grb_filerecord.fields.grb6] +type = "keyword" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" + +[blocks.options.fields.xorigin] +type = "double" +longname = "x-position of the model grid origin" +description = "x-position of the lower-left corner of the model grid. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.yorigin] +type = "double" +longname = "y-position of the model grid origin" +description = "y-position of the lower-left corner of the model grid. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.angrot] +type = "double" +longname = "rotation angle" +description = "counter-clockwise rotation angle (in degrees) of the lower-left corner of the model grid. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.options.fields.crs] +type = "string" +longname = "CRS user input string" +description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true +case_sensitive = true + +[blocks.options.fields.ncf_filerecord] +type = "record" +optional = true + +[blocks.options.fields.ncf_filerecord.fields.ncf6] +type = "keyword" +longname = "ncf keyword" +description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" +component = "utl-ncf" + +[blocks.dimensions.fields.nlay] +type = "integer" +longname = "number of layers" +description = "is the number of layers in the model grid." +default = 1 + +[blocks.dimensions.fields.nrow] +type = "integer" +longname = "number of rows" +description = "is the number of rows in the model grid." +default = 2 + +[blocks.dimensions.fields.ncol] +type = "integer" +longname = "number of columns" +description = "is the number of columns in the model grid." +default = 2 + +[blocks.griddata.fields.delr] +type = "array" +longname = "spacing along a row" +description = "is the column spacing in the row direction." +default = 1.0 +netcdf = true +dtype = "double" +shape = [ + "ncol", +] + +[blocks.griddata.fields.delc] +type = "array" +longname = "spacing along a column" +description = "is the row spacing in the column direction." +default = 1.0 +netcdf = true +dtype = "double" +shape = [ + "nrow", +] + +[blocks.griddata.fields.top] +type = "array" +longname = "cell top elevation" +description = "is the top elevation for each cell in the top model layer." +default = 1.0 +netcdf = true +dtype = "double" +shape = [ + "ncol", + "nrow", +] + +[blocks.griddata.fields.botm] +type = "array" +longname = "cell bottom elevation" +description = "is the bottom elevation for each cell." +default = 0.0 +netcdf = true +dtype = "double" +layered = true +shape = [ + "ncol", + "nrow", + "nlay", +] + +[blocks.griddata.fields.idomain] +type = "array" +longname = "idomain existence array" +description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1 or greater, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." +optional = true +netcdf = true +dtype = "integer" +layered = true +shape = [ + "ncol", + "nrow", + "nlay", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.nlay] +set_in = "ar" +source = "nlay" +type = "integer" + +[memory.nrow] +set_in = "ar" +source = "nrow" +type = "integer" + +[memory.ncol] +set_in = "ar" +source = "ncol" +type = "integer" + +[memory.delr] +type = "array" +set_in = "ar" +source = "delr" +dtype = "double" +shape = [ + "ncol", +] + +[memory.delc] +type = "array" +set_in = "ar" +source = "delc" +dtype = "double" +shape = [ + "nrow", +] + +[memory.top] +type = "array" +set_in = "ar" +source = "top" +dtype = "double" +shape = [ + "ncol", + "nrow", +] + +[memory.botm] +type = "array" +set_in = "ar" +source = "botm" +dtype = "double" +shape = [ + "ncol", + "nrow", + "nlay", +] + +[memory.idomain] +type = "array" +set_in = "ar" +source = "idomain" +dtype = "integer" +shape = [ + "ncol", + "nrow", + "nlay", +] + +[memory.area] +type = "array" +readonly = true +set_in = "ar" +description = "Horizontal cell area, computed from grid geometry." +dtype = "double" +shape = [ + "ncpl", +] + +[memory.nodeuser] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodereduced] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." +dtype = "integer" +shape = [ + "nodesuser", +] diff --git a/flopy4/mf6/dfns/gwf-disu.toml b/flopy4/mf6/dfns/gwf-disu.toml new file mode 100644 index 000000000..ffec76ee2 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-disu.toml @@ -0,0 +1,368 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-disu" +parent = "gwf-nam" +ftype = "DISU6" + +[dims.nodes] +value = "nodes" +scope = "model" + +[dims.nja] +value = "nja" +scope = "model" + +[dims.nvert] +value = "nvert" +scope = "model" + +[dims.ncelldim] +value = "1" +scope = "model" + +[dims.njas] +value = "(nja - nodes) / 2" + +[runtime_dims.nodes] +set_in = "ar" + +[runtime_dims.nodesuser] +set_in = "ar" + +[blocks.options.fields.length_units] +type = "string" +longname = "model length units" +description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." +optional = true + +[blocks.options.fields.nogrb] +type = "keyword" +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." +optional = true + +[blocks.options.fields.grb_filerecord] +type = "record" +optional = true + +[blocks.options.fields.grb_filerecord.fields.grb6] +type = "keyword" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" + +[blocks.options.fields.xorigin] +type = "double" +longname = "x-position origin of the model grid coordinate system" +description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.yorigin] +type = "double" +longname = "y-position origin of the model grid coordinate system" +description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.angrot] +type = "double" +longname = "rotation angle" +description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.vertical_offset_tolerance] +type = "double" +longname = "vertical length dimension for top and bottom checking" +description = "checks are performed to ensure that the top of a cell is not higher than the bottom of an overlying cell. This option can be used to specify the tolerance that is used for checking. If top of a cell is above the bottom of an overlying cell by a value less than this tolerance, then the program will not terminate with an error. The default value is zero. This option should generally not be used." +optional = true +default = 0.0 + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.crs] +type = "string" +longname = "CRS user input string" +description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true +case_sensitive = true + +[blocks.dimensions.fields.nodes] +type = "integer" +longname = "number of layers" +description = "is the number of cells in the model grid." + +[blocks.dimensions.fields.nja] +type = "integer" +longname = "number of columns" +description = "is the sum of the number of connections and NODES. When calculating the total number of connections, the connection between cell n and cell m is considered to be different from the connection between cell m and cell n. Thus, NJA is equal to the total number of connections, including n to m and m to n, and the total number of cells." + +[blocks.dimensions.fields.nvert] +type = "integer" +longname = "number of vertices" +description = "is the total number of (x, y) vertex pairs used to define the plan-view shape of each cell in the model grid. If NVERT is not specified or is specified as zero, then the VERTICES and CELL2D blocks below are not read. NVERT and the accompanying VERTICES and CELL2D blocks should be specified for most simulations. If the XT3D or SAVE_SPECIFIC_DISCHARGE options are specified in the NPF Package, then this information is required." +optional = true + +[blocks.griddata.fields.top] +type = "array" +longname = "cell top elevation" +description = "is the top elevation for each cell in the model grid." +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.bot] +type = "array" +longname = "cell bottom elevation" +description = "is the bottom elevation for each cell." +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.area] +type = "array" +longname = "cell surface area" +description = "is the cell surface area (in plan view)." +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.idomain] +type = "array" +longname = "idomain existence array" +description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1 or greater, the cell exists in the simulation. IDOMAIN values of -1 cannot be specified for the DISU Package." +optional = true +dtype = "integer" +shape = [ + "nodes", +] + +[blocks.connectiondata.fields.iac] +type = "array" +longname = "number of cell connections" +description = "is the number of connections (plus 1) for each cell. The sum of all the entries in IAC must be equal to NJA." +dtype = "integer" +shape = [ + "nodes", +] + +[blocks.connectiondata.fields.ja] +type = "array" +longname = "grid connectivity" +description = "is a list of cell number (n) followed by its connecting cell numbers (m) for each of the m cells connected to cell n. The number of values to provide for cell n is IAC(n). This list is sequentially provided for the first to the last cell. The first value in the list must be cell n itself, and the remaining cells must be listed in an increasing order (sorted from lowest number to highest). Note that the cell and its connections are only supplied for the GWF cells and their connections to the other GWF cells. Also note that the JA list input may be divided such that every node and its connectivity list can be on a separate line for ease in readability of the file. To further ease readability of the file, the node number of the cell whose connectivity is subsequently listed, may be expressed as a negative number, the sign of which is subsequently converted to positive by the code." +dtype = "integer" +index = true +shape = [ + "nja", +] + +[blocks.connectiondata.fields.ihc] +type = "array" +longname = "connection type" +description = "is an index array indicating the direction between node n and all of its m connections. If IHC = 0 then cell n and cell m are connected in the vertical direction. Cell n overlies cell m if the cell number for n is less than m; cell m overlies cell n if the cell number for m is less than n. If IHC = 1 then cell n and cell m are connected in the horizontal direction. If IHC = 2 then cell n and cell m are connected in the horizontal direction, and the connection is vertically staggered. A vertically staggered connection is one in which a cell is horizontally connected to more than one cell in a horizontal connection." +dtype = "integer" +shape = [ + "nja", +] + +[blocks.connectiondata.fields.cl12] +type = "array" +longname = "connection lengths" +description = "is the array containing connection lengths between the center of cell n and the shared face with each adjacent m cell." +dtype = "double" +shape = [ + "nja", +] + +[blocks.connectiondata.fields.hwva] +type = "array" +longname = "connection lengths" +description = "is a symmetric array of size NJA. For horizontal connections, entries in HWVA are the horizontal width perpendicular to flow. For vertical connections, entries in HWVA are the vertical area for flow. Thus, values in the HWVA array contain dimensions of both length and area. Entries in the HWVA array have a one-to-one correspondence with the connections specified in the JA array. Likewise, there is a one-to-one correspondence between entries in the HWVA array and entries in the IHC array, which specifies the connection type (horizontal or vertical). Entries in the HWVA array must be symmetric; the program will terminate with an error if the value for HWVA for an n to m connection does not equal the value for HWVA for the corresponding n to m connection." +dtype = "double" +shape = [ + "nja", +] + +[blocks.connectiondata.fields.angldegx] +type = "array" +longname = "angle of face normal to connection" +description = "is the angle (in degrees) between the horizontal x-axis and the outward normal to the face between a cell and its connecting cells. The angle varies between zero and 360.0 degrees, where zero degrees points in the positive x-axis direction, and 90 degrees points in the positive y-axis direction. ANGLDEGX is only needed if horizontal anisotropy is specified in the NPF Package, if the XT3D option is used in the NPF Package, or if the SAVE_SPECIFIC_DISCHARGE option is specified in the NPF Package. ANGLDEGX does not need to be specified otherwise. ANGLDEGX is of size NJA; values specified for vertical connections and for the diagonal position are not used. Note that ANGLDEGX is read in degrees, which is different from MODFLOW-USG, which reads a similar variable (ANGLEX) in radians. Only the value specified for the connection from the lower to the higher cell number is used, but the values for both directions of every horizontal connection between active cells are checked. Because ANGLDEGX is the outward normal of the shared face, the value for the connection from cell n to cell m must differ by 180 degrees (within 0.01 degrees) from the value for the connection from cell m to cell n. If VERTICES and CELL2D are specified, ANGLDEGX must be expressed in the same coordinate system as the vertex coordinates; the centers of two connected cells must lie on opposite sides of their shared face, so ANGLDEGX must be within 90 degrees of the direction from the cell center to the center of the connected cell, and, for cells that share exactly two vertices, ANGLDEGX must agree within 1 degree with the outward normal of the face computed from those vertices. A warning is issued for each of these three conditions that is not met, and the simulation terminates with an error if any of them is not met and the NPF Package requires ANGLDEGX to be specified (XT3D, K22, or SAVE_SPECIFIC_DISCHARGE). A warning is also issued if ANGLDEGX deviates by more than 45 degrees from the direction between the centers of the connected cells; this is not an error, but such connections depart from the assumptions of the control-volume finite-difference method and may warrant a closer look at the grid." +optional = true +dtype = "double" +shape = [ + "nja", +] + +[blocks.vertices.fields.vertices] +type = "list" +longname = "vertices data" +optional = true +shape = [ + "nvert", +] + +[blocks.vertices.fields.vertices.item] +name = "vertices" +type = "record" + +[blocks.vertices.fields.vertices.item.fields.iv] +type = "integer" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +tagged = false +index = true +pk = true + +[blocks.vertices.fields.vertices.item.fields.xv] +type = "double" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." +tagged = false + +[blocks.vertices.fields.vertices.item.fields.yv] +type = "double" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." +tagged = false + +[blocks.cell2d.fields.cell2d] +type = "list" +longname = "cell2d data" +optional = true +shape = [ + "nodes", +] + +[blocks.cell2d.fields.cell2d.item] +name = "cell2d" +type = "record" + +[blocks.cell2d.fields.cell2d.item.fields.icell2d] +type = "integer" +longname = "cell2d number" +description = "is the cell2d number. Records in the CELL2D block must be listed in consecutive order from 1 to NODES." +tagged = false +index = true +pk = true + +[blocks.cell2d.fields.cell2d.item.fields.xc] +type = "double" +longname = "x-coordinate for cell center" +description = "is the x-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.yc] +type = "double" +longname = "y-coordinate for cell center" +description = "is the y-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.ncvert] +type = "integer" +longname = "number of cell vertices" +description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.icvert] +type = "array" +longname = "array of vertex numbers" +description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order." +tagged = false +dtype = "integer" +index = true +shape = [ + "ncvert", +] + +[memory.voffsettol] +set_in = "ar" +source = "vertical_offset_tolerance" +type = "double" + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.nodes] +set_in = "ar" +source = "nodes" +type = "integer" + +[memory.nja] +set_in = "ar" +source = "nja" +type = "integer" + +[memory.nvert] +set_in = "ar" +source = "nvert" +type = "integer" + +[memory.top] +type = "array" +set_in = "ar" +source = "top" +dtype = "double" +shape = [ + "nodes", +] + +[memory.bot] +type = "array" +set_in = "ar" +source = "bot" +dtype = "double" +shape = [ + "nodes", +] + +[memory.area] +type = "array" +readonly = true +set_in = "ar" +description = "Horizontal cell area, computed from grid geometry." +dtype = "double" +shape = [ + "nodesuser", +] + +[memory.idomain] +type = "array" +set_in = "ar" +source = "idomain" +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodeuser] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodereduced] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." +dtype = "integer" +shape = [ + "nodesuser", +] diff --git a/flopy4/mf6/dfns/gwf-disv.toml b/flopy4/mf6/dfns/gwf-disv.toml new file mode 100644 index 000000000..83a4512b2 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-disv.toml @@ -0,0 +1,326 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-disv" +parent = "gwf-nam" +ftype = "DISV6" + +[dims.nlay] +value = "nlay" +scope = "model" + +[dims.ncpl] +value = "ncpl" +scope = "model" + +[dims.nvert] +value = "nvert" +scope = "model" + +[dims.nodes] +value = "nlay * ncpl" +scope = "model" + +[dims.ncelldim] +value = "2" +scope = "model" + +[runtime_dims.nodes] +set_in = "ar" + +[runtime_dims.nodesuser] +set_in = "ar" + +[blocks.options.fields.length_units] +type = "string" +longname = "model length units" +description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." +optional = true + +[blocks.options.fields.nogrb] +type = "keyword" +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." +optional = true + +[blocks.options.fields.grb_filerecord] +type = "record" +optional = true + +[blocks.options.fields.grb_filerecord.fields.grb6] +type = "keyword" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" + +[blocks.options.fields.xorigin] +type = "double" +longname = "x-position origin of the model grid coordinate system" +description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.yorigin] +type = "double" +longname = "y-position origin of the model grid coordinate system" +description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.angrot] +type = "double" +longname = "rotation angle" +description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.options.fields.crs] +type = "string" +longname = "CRS user input string" +description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true +case_sensitive = true + +[blocks.options.fields.ncf_filerecord] +type = "record" +optional = true + +[blocks.options.fields.ncf_filerecord.fields.ncf6] +type = "keyword" +longname = "ncf keyword" +description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" +component = "utl-ncf" + +[blocks.dimensions.fields.nlay] +type = "integer" +longname = "number of layers" +description = "is the number of layers in the model grid." + +[blocks.dimensions.fields.ncpl] +type = "integer" +longname = "number of cells per layer" +description = "is the number of cells per layer. This is a constant value for the grid and it applies to all layers." + +[blocks.dimensions.fields.nvert] +type = "integer" +longname = "number of vertices" +description = "is the total number of (x, y) vertex pairs used to characterize the horizontal configuration of the model grid." + +[blocks.griddata.fields.top] +type = "array" +longname = "model top elevation" +description = "is the top elevation for each cell in the top model layer." +netcdf = true +dtype = "double" +shape = [ + "ncpl", +] + +[blocks.griddata.fields.botm] +type = "array" +longname = "model bottom elevation" +description = "is the bottom elevation for each cell." +netcdf = true +dtype = "double" +layered = true +shape = [ + "ncpl", + "nlay", +] + +[blocks.griddata.fields.idomain] +type = "array" +longname = "idomain existence array" +description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1 or greater, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." +optional = true +netcdf = true +dtype = "integer" +layered = true +shape = [ + "ncpl", + "nlay", +] + +[blocks.vertices.fields.vertices] +type = "list" +longname = "vertices data" +shape = [ + "nvert", +] + +[blocks.vertices.fields.vertices.item] +name = "vertices" +type = "record" + +[blocks.vertices.fields.vertices.item.fields.iv] +type = "integer" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +tagged = false +index = true +pk = true + +[blocks.vertices.fields.vertices.item.fields.xv] +type = "double" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." +tagged = false + +[blocks.vertices.fields.vertices.item.fields.yv] +type = "double" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." +tagged = false + +[blocks.cell2d.fields.cell2d] +type = "list" +longname = "cell2d data" +shape = [ + "ncpl", +] + +[blocks.cell2d.fields.cell2d.item] +name = "cell2d" +type = "record" + +[blocks.cell2d.fields.cell2d.item.fields.icell2d] +type = "integer" +longname = "cell2d number" +description = "is the CELL2D number. Records in the CELL2D block must be listed in consecutive order from the first to the last." +tagged = false +index = true +pk = true + +[blocks.cell2d.fields.cell2d.item.fields.xc] +type = "double" +longname = "x-coordinate for cell center" +description = "is the x-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.yc] +type = "double" +longname = "y-coordinate for cell center" +description = "is the y-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.ncvert] +type = "integer" +longname = "number of cell vertices" +description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.icvert] +type = "array" +longname = "array of vertex numbers" +description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false +dtype = "integer" +index = true +shape = [ + "ncvert", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.nlay] +set_in = "ar" +source = "nlay" +type = "integer" + +[memory.ncpl] +set_in = "ar" +source = "ncpl" +type = "integer" + +[memory.nvert] +set_in = "ar" +source = "nvert" +type = "integer" + +[memory.top] +type = "array" +set_in = "ar" +source = "top" +dtype = "double" +shape = [ + "ncpl", +] + +[memory.botm] +type = "array" +set_in = "ar" +source = "botm" +dtype = "double" +shape = [ + "ncpl", + "nlay", +] + +[memory.idomain] +type = "array" +set_in = "ar" +source = "idomain" +dtype = "integer" +shape = [ + "ncpl", + "nlay", +] + +[memory.area] +type = "array" +readonly = true +set_in = "ar" +description = "Horizontal cell area, computed from grid geometry." +dtype = "double" +shape = [ + "ncpl", +] + +[memory.nodeuser] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodereduced] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." +dtype = "integer" +shape = [ + "nodesuser", +] diff --git a/flopy4/mf6/dfns/gwf-drn.toml b/flopy4/mf6/dfns/gwf-drn.toml new file mode 100644 index 000000000..0d859612b --- /dev/null +++ b/flopy4/mf6/dfns/gwf-drn.toml @@ -0,0 +1,342 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-drn" +parent = "gwf-nam" +ftype = "DRN6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of drain conductance." +optional = true + +[blocks.options.fields.auxdepthname] +type = "string" +longname = "name of auxiliary variable for drainage depth" +description = "name of a variable listed in AUXILIARY that defines the depth at which drainage discharge will be scaled. If a positive value is specified for the AUXDEPTHNAME AUXILIARY variable, then ELEV is the elevation at which the drain starts to discharge and ELEV + DDRN (assuming DDRN is the AUXDEPTHNAME variable) is the elevation when the drain conductance (COND) scaling factor is 1. If a negative drainage depth value is specified for DDRN, then ELEV + DDRN is the elevation at which the drain starts to discharge and ELEV is the elevation when the conductance (COND) scaling factor is 1. A linear- or cubic-scaling is used to scale the drain conductance (COND) when the Standard or Newton-Raphson Formulation is used, respectively. This discharge scaling option is described in more detail in Chapter 3 of the Supplemental Technical Information." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of drain cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of drain information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of drain flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save DRN flows to budget file" +description = "keyword to indicate that drain flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the DRN package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DRN package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.mover] +type = "keyword" +description = "keyword to indicate that this instance of the Drain Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." +optional = true + +[blocks.options.fields.dev_cubic_scaling] +type = "keyword" +longname = "cubic-scaling" +description = "cubic-scaling is used to scale the drain conductance" +optional = true +developmode = true + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of drains" +description = "integer value specifying the maximum number of drains cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.elev] +type = "double" +longname = "drain elevation" +description = "is the elevation of the drain. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.cond] +type = "double" +longname = "drain conductance" +description = "is the hydraulic conductance of the interface between the aquifer and the drain. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each drain. The values of auxiliary variables must be present for each drain. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "drain name" +description = "name of the drain cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.icubicsfac] +set_in = "ar" +source = "dev_cubic_scaling" +type = "logical" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: elev, 1: cond." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "DRN" +output = true +obs_type = "DRN" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "DRN-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.drn] +type = "union" + +[observations.drn.arms.cellid] +type = "cellid" +tagged = false + +[observations.drn.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" + +[keys.mover_provider] +path = "<=maxbound" +when = "mover" diff --git a/flopy4/mf6/dfns/gwf-drng.toml b/flopy4/mf6/dfns/gwf-drng.toml new file mode 100644 index 000000000..ab47f46ef --- /dev/null +++ b/flopy4/mf6/dfns/gwf-drng.toml @@ -0,0 +1,339 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-drng" +parent = "gwf-nam" +ftype = "DRN6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.readarraygrid] +type = "keyword" +longname = "use array-based grid input" +description = "indicates that array-based grid input will be used for the drain package. This keyword must be specified to use array-based grid input. When READARRAYGRID is specified, values must be provided for every cell within a model grid, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results. No data cells should contain the value DNODATA (3.0E+30)." +default = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of drain conductance." +optional = true + +[blocks.options.fields.auxdepthname] +type = "string" +longname = "name of auxiliary variable for drainage depth" +description = "name of a variable listed in AUXILIARY that defines the depth at which drainage discharge will be scaled. If a positive value is specified for the AUXDEPTHNAME AUXILIARY variable, then ELEV is the elevation at which the drain starts to discharge and ELEV + DDRN (assuming DDRN is the AUXDEPTHNAME variable) is the elevation when the drain conductance (COND) scaling factor is 1. If a negative drainage depth value is specified for DDRN, then ELEV + DDRN is the elevation at which the drain starts to discharge and ELEV is the elevation when the conductance (COND) scaling factor is 1. A linear- or cubic-scaling is used to scale the drain conductance (COND) when the Standard or Newton-Raphson Formulation is used, respectively. This discharge scaling option is described in more detail in Chapter 3 of the Supplemental Technical Information." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of drain information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of drain flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save DRNG flows to budget file" +description = "keyword to indicate that drain flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the DRN package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DRN package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.mover] +type = "keyword" +description = "keyword to indicate that this instance of the Drain Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.options.fields.dev_cubic_scaling] +type = "keyword" +longname = "cubic-scaling" +description = "cubic-scaling is used to scale the drain conductance" +optional = true +developmode = true + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of drain cells in any stress period" +description = "integer value specifying the maximum number of drains cells that will be specified for use during any stress period." +optional = true + +[blocks.period.fields.elev] +type = "array" +longname = "drain elevation" +description = "is the elevation of the drain." +default = 3e+30 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.period.fields.cond] +type = "array" +longname = "drain conductance" +description = "is the hydraulic conductance of the interface between the aquifer and the drain." +default = 3e+30 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.period.fields.aux] +type = "list" +longname = "drain auxiliary variable iaux" +description = "is an array of values for auxiliary variable aux(iaux), where iaux is a value from 1 to naux, and aux(iaux) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then it will retain its value from the most recently specified period block. If an auxiliary variable array has never been specified, its value is zero. If the value specified here for the auxiliary variable is the same as auxmultname, then the conductance array will be multiplied by this array." +optional = true +shape = [ + "<=auxiliary", +] + +[blocks.period.fields.aux.item] +name = "aux" +type = "record" + +[blocks.period.fields.aux.item.fields.auxname] +type = "string" +longname = "auxiliary variable name" +description = "name of the auxiliary variable the following array sets; must be one of the auxiliary variables." +tagged = false +fk = "options.auxiliary" +dynamic = true + +[blocks.period.fields.aux.item.fields.aux] +type = "array" +longname = "drain auxiliary variable iaux" +netcdf = true +tagged = false +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.icubicsfac] +set_in = "ar" +source = "dev_cubic_scaling" +type = "logical" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "DRN" +output = true +obs_type = "DRN" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "DRN-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.drn] +type = "union" + +[observations.drn.arms.cellid] +type = "cellid" +tagged = false + +[observations.drn.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" + +[keys.mover_provider] +path = "<=maxbound" +when = "mover" diff --git a/flopy4/mf6/dfns/gwf-evt.toml b/flopy4/mf6/dfns/gwf-evt.toml new file mode 100644 index 000000000..15fe6201b --- /dev/null +++ b/flopy4/mf6/dfns/gwf-evt.toml @@ -0,0 +1,371 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-evt" +parent = "gwf-nam" +ftype = "EVT6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.nseg] +value = "nseg" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.fixed_cell] +type = "keyword" +longname = "if cell is dry do not apply evapotranspiration to underlying cell" +description = "indicates that evapotranspiration will not be reassigned to a cell underlying the cell specified in the list if the specified cell is inactive." +optional = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of evapotranspiration rate." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of evapotranspiration cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of evapotranspiration information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print evapotranspiration rates to listing file" +description = "keyword to indicate that the list of evapotranspiration flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save evapotranspiration rates to budget file" +description = "keyword to indicate that evapotranspiration flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the EVT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVT package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.surf_rate_specified] +type = "keyword" +longname = "specify proportion of evapotranspiration rate at ET surface" +description = "indicates that the proportion of the evapotranspiration rate at the ET surface will be specified as PETM0 in list input." +optional = true + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of evapotranspiration cells" +description = "integer value specifying the maximum number of evapotranspiration cells that will be specified for use during any stress period." + +[blocks.dimensions.fields.nseg] +type = "integer" +longname = "number of ET segments" +description = "number of ET segments. Default is one. When NSEG is greater than 1, the PXDP and PETM arrays must be of size NSEG - 1 and be listed in order from the uppermost segment down. Values for PXDP must be listed first followed by the values for PETM. PXDP defines the extinction-depth proportion at the bottom of a segment. PETM defines the proportion of the maximum ET flux rate at the bottom of a segment." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.surface] +type = "double" +longname = "ET surface" +description = "is the elevation of the ET surface ($L$). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.rate] +type = "double" +longname = "maximum ET rate" +description = "is the maximum ET flux rate ($LT^{-1}$). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.depth] +type = "double" +longname = "ET extinction depth" +description = "is the ET extinction depth ($L$). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.pxdp] +type = "array" +longname = "proportion of ET extinction depth" +description = "is the proportion of the ET extinction depth at the bottom of a segment (dimensionless). pxdp is an array of size (nseg - 1). Values in pxdp must be greater than 0.0 and less than 1.0. pxdp values for a cell must increase monotonically. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "nseg-1", +] + +[blocks.period.fields.stress_period_data.item.fields.petm] +type = "array" +longname = "proportion of maximum ET rate" +description = "is the proportion of the maximum ET flux rate at the bottom of a segment (dimensionless). petm is an array of size (nseg - 1). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "nseg-1", +] + +[blocks.period.fields.stress_period_data.item.fields.petm0] +type = "double" +longname = "proportion of maximum ET rate at ET surface" +description = "is the proportion of the maximum ET flux rate that will apply when head is at or above the ET surface (dimensionless). PETM0 is read only when the SURF_RATE_SPECIFIED option is used. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +when = "surf_rate_specified" +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each evapotranspiration. The values of auxiliary variables must be present for each evapotranspiration. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "evapotranspiration name" +description = "name of the evapotranspiration cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.surfratespec] +set_in = "ar" +source = "surf_rate_specified" +type = "logical" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nseg] +set_in = "ar" +source = "nseg" +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: surface, 1: rate, 2: depth, 3: petm0." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "EVT" +output = true +obs_type = "EVT" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.evt] +type = "union" + +[observations.evt.arms.cellid] +type = "cellid" +tagged = false + +[observations.evt.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwf-evta.toml b/flopy4/mf6/dfns/gwf-evta.toml new file mode 100644 index 000000000..104f706b4 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-evta.toml @@ -0,0 +1,336 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-evta" +parent = "gwf-nam" +ftype = "EVT6" +multi = true +subtype = "stress" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.readasarrays] +type = "keyword" +longname = "use array-based input" +description = "indicates that array-based input will be used for the Evapotranspiration Package. This keyword must be specified to use array-based input. When READASARRAYS is specified, values must be provided for every cell within a model layer, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results." +default = true + +[blocks.options.fields.fixed_cell] +type = "keyword" +longname = "if cell is dry do not apply evapotranspiration to underlying cell" +description = "indicates that evapotranspiration will not be reassigned to a cell underlying the cell specified in the list if the specified cell is inactive." +optional = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of evapotranspiration rate." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of evapotranspiration information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print evapotranspiration rates to listing file" +description = "keyword to indicate that the list of evapotranspiration flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save EVTA flows to budget file" +description = "keyword to indicate that evapotranspiration flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.tas_filerecord] +type = "list" +optional = true + +[blocks.options.fields.tas_filerecord.item] +name = "tas_filerecord" +type = "record" + +[blocks.options.fields.tas_filerecord.item.fields.tas6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-array-series file." + +[blocks.options.fields.tas_filerecord.item.fields.tas6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the Time-Variable Input section for instructions on using the time-array series capability." +tagged = false +direction = "in" +component = "utl-tas" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the EVT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVT package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.period.fields.ievt] +type = "array" +longname = "layer number for evapotranspiration" +description = "IEVT is the layer number that defines the layer in each vertical column where evapotranspiration is applied. If IEVT is omitted, evapotranspiration by default is applied to cells in layer 1. If IEVT is specified, it must be specified as the first variable in the PERIOD block or MODFLOW will terminate with an error." +optional = true +netcdf = true +dtype = "integer" +index = true +shape = [ + "ncpl", +] + +[blocks.period.fields.surface] +type = "array" +longname = "evapotranspiration surface" +description = "is the elevation of the ET surface ($L$)." +default = 0.0 +netcdf = true +dtype = "double" +shape = [ + "ncpl", +] + +[blocks.period.fields.rate] +type = "array" +longname = "evapotranspiration rate" +description = "is the maximum ET flux rate ($LT^{-1}$)." +default = 0.001 +netcdf = true +dtype = "double" +time_series = true +shape = [ + "ncpl", +] + +[blocks.period.fields.depth] +type = "array" +longname = "extinction depth" +description = "is the ET extinction depth ($L$)." +default = 1.0 +netcdf = true +dtype = "double" +shape = [ + "ncpl", +] + +[blocks.period.fields.aux] +type = "list" +longname = "evapotranspiration auxiliary variable iaux" +description = "is an array of values for auxiliary variable AUX(IAUX), where iaux is a value from 1 to NAUX, and AUX(IAUX) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then it will retain its value from the most recently specified period block. If an auxiliary variable array has never been specified, its value is zero. If the value specified here for the auxiliary variable is the same as auxmultname, then the evapotranspiration rate will be multiplied by this array." +optional = true +shape = [ + "<=auxiliary", +] + +[blocks.period.fields.aux.item] +name = "aux" +type = "record" + +[blocks.period.fields.aux.item.fields.auxname] +type = "string" +longname = "auxiliary variable name" +description = "name of the auxiliary variable the following array sets; must be one of the auxiliary variables." +tagged = false +fk = "options.auxiliary" +dynamic = true + +[blocks.period.fields.aux.item.fields.aux] +type = "array" +longname = "evapotranspiration auxiliary variable iaux" +netcdf = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "ncpl", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "EVTA" +output = true +obs_type = "EVT" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.evt] +type = "union" + +[observations.evt.arms.cellid] +type = "cellid" +tagged = false + +[observations.evt.arms.boundname] +type = "string" +tagged = false diff --git a/flopy4/mf6/dfns/gwf-ghb.toml b/flopy4/mf6/dfns/gwf-ghb.toml new file mode 100644 index 000000000..d4caff02d --- /dev/null +++ b/flopy4/mf6/dfns/gwf-ghb.toml @@ -0,0 +1,324 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-ghb" +parent = "gwf-nam" +ftype = "GHB6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of general-head boundary conductance." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of general-head boundary cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of general-head boundary information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of general-head boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save GHB flows to budget file" +description = "keyword to indicate that general-head boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the GHB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the GHB package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.mover] +type = "keyword" +description = "keyword to indicate that this instance of the General-Head Boundary Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." +optional = true + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of general-head boundaries" +description = "integer value specifying the maximum number of general-head boundary cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.bhead] +type = "double" +longname = "boundary head" +description = "is the boundary head. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.cond] +type = "double" +longname = "boundary conductance" +description = "is the hydraulic conductance of the interface between the aquifer cell and the boundary. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each general-head boundary. The values of auxiliary variables must be present for each general-head boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "general-head boundary name" +description = "name of the general-head boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: bhead, 1: cond." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "GHB" +output = true +obs_type = "GHB" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "GHB-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.ghb] +type = "union" + +[observations.ghb.arms.cellid] +type = "cellid" +tagged = false + +[observations.ghb.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" + +[keys.mover_provider] +path = "<=maxbound" +when = "mover" diff --git a/flopy4/mf6/dfns/gwf-ghbg.toml b/flopy4/mf6/dfns/gwf-ghbg.toml new file mode 100644 index 000000000..a8e3ab7e3 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-ghbg.toml @@ -0,0 +1,321 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-ghbg" +parent = "gwf-nam" +ftype = "GHB6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.readarraygrid] +type = "keyword" +longname = "use array-based grid input" +description = "indicates that array-based grid input will be used for the general-head boundary package. This keyword must be specified to use array-based grid input. When READARRAYGRID is specified, values must be provided for every cell within a model grid, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results. No data cells should contain the value DNODATA (3.0E+30)." +default = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of general-head boundary conductance." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of general-head boundary information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of general-head boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save GHBG flows to budget file" +description = "keyword to indicate that general-head boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the GHB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the GHB package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.mover] +type = "keyword" +description = "keyword to indicate that this instance of the General-Head Boundary Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of general-head boundaries in any stress period" +description = "integer value specifying the maximum number of general-head boundary cells that will be specified for use during any stress period." +optional = true + +[blocks.period.fields.bhead] +type = "array" +longname = "boundary head" +description = "is the boundary head." +default = 3e+30 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.period.fields.cond] +type = "array" +longname = "boundary conductance" +description = "is the hydraulic conductance of the interface between the aquifer cell and the boundary." +default = 3e+30 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.period.fields.aux] +type = "list" +longname = "general-head boundary auxiliary variable iaux" +description = "is an array of values for auxiliary variable aux(iaux), where iaux is a value from 1 to naux, and aux(iaux) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then it will retain its value from the most recently specified period block. If an auxiliary variable array has never been specified, its value is zero. If the value specified here for the auxiliary variable is the same as auxmultname, then the conductance array will be multiplied by this array." +optional = true +shape = [ + "<=auxiliary", +] + +[blocks.period.fields.aux.item] +name = "aux" +type = "record" + +[blocks.period.fields.aux.item.fields.auxname] +type = "string" +longname = "auxiliary variable name" +description = "name of the auxiliary variable the following array sets; must be one of the auxiliary variables." +tagged = false +fk = "options.auxiliary" +dynamic = true + +[blocks.period.fields.aux.item.fields.aux] +type = "array" +longname = "general-head boundary auxiliary variable iaux" +netcdf = true +tagged = false +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "GHB" +output = true +obs_type = "GHB" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "GHB-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.ghb] +type = "union" + +[observations.ghb.arms.cellid] +type = "cellid" +tagged = false + +[observations.ghb.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" + +[keys.mover_provider] +path = "<=maxbound" +when = "mover" diff --git a/flopy4/mf6/dfns/gwf-gnc.toml b/flopy4/mf6/dfns/gwf-gnc.toml new file mode 100644 index 000000000..09c720844 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-gnc.toml @@ -0,0 +1,98 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-gnc" +ftype = "GNC6" +parent = [ + "exg-gwfgwf", + "gwf-nam", +] + +[dims.numgnc] +value = "numgnc" + +[dims.numalphaj] +value = "numalphaj" + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of GNC information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print simulated flows to listing file" +description = "keyword to indicate that the list of GNC flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.explicit] +type = "keyword" +longname = "use explicit GNC formulation" +description = "keyword to indicate that the ghost node correction is applied in an explicit manner on the right-hand side of the matrix. The explicit approach will likely require additional outer iterations. If the keyword is not specified, then the correction will be applied in an implicit manner on the left-hand side. The implicit approach will likely converge better, but may require additional memory. If the EXPLICIT keyword is not specified, then the BICGSTAB linear acceleration option should be specified within the LINEAR block of the Sparse Matrix Solver." +optional = true + +[blocks.dimensions.fields.numgnc] +type = "integer" +longname = "number of ghost node corrections" +description = "is the number of GNC entries." + +[blocks.dimensions.fields.numalphaj] +type = "integer" +longname = "number of contributing factors" +description = "is the number of contributing factors." + +[blocks.gncdata.fields.gncdata] +type = "list" +shape = [ + "numgnc", +] + +[blocks.gncdata.fields.gncdata.item] +name = "gncdata" +type = "record" + +[blocks.gncdata.fields.gncdata.item.fields.cellidn] +type = "cellid" +longname = "GNC cellid n" +description = "is the cellid of the cell, $n$, in which the ghost node is located. For a structured grid that uses the DIS input file, CELLIDN is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDN is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDN is the node number for the cell." +tagged = false +model = "1" + +[blocks.gncdata.fields.gncdata.item.fields.cellidm] +type = "cellid" +longname = "GNC cellid n" +description = "is the cellid of the connecting cell, $m$, to which flow occurs from the ghost node. For a structured grid that uses the DIS input file, CELLIDM is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM is the node number for the cell." +tagged = false +model = "2" + +[blocks.gncdata.fields.gncdata.item.fields.cellidsj] +type = "array" +longname = "GNC contributing cells" +description = "is the array of CELLIDS for the contributing j cells, which contribute to the interpolated head value at the ghost node. This item contains one CELLID for each of the contributing cells of the ghost node. Note that if the number of actual contributing cells needed by the user is less than NUMALPHAJ for any ghost node, then a dummy CELLID of zero(s) should be inserted with an associated contributing factor of zero. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLID is the layer number and cell2d number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLID is the node number for the cell." +tagged = false +dtype = "cellid" +model = "1" +allow_zero = true +shape = [ + "numalphaj", +] + +[blocks.gncdata.fields.gncdata.item.fields.alphasj] +type = "array" +longname = "GNC contributing factors" +description = "is the contributing factors for each contributing node in CELLIDSJ. Note that if the number of actual contributing cells is less than NUMALPHAJ for any ghost node, then dummy CELLIDS should be inserted with an associated contributing factor of zero. The sum of ALPHASJ should be less than one. This is because one minus the sum of ALPHASJ is equal to the alpha term (alpha n in equation 4-61 of the GWF Model report) that is multiplied by the head in cell n." +tagged = false +dtype = "double" +shape = [ + "numalphaj", +] + +[memory.numgnc] +set_in = "ar" +source = "numgnc" +type = "integer" + +[memory.numalphaj] +set_in = "ar" +source = "numalphaj" +type = "integer" diff --git a/flopy4/mf6/dfns/gwf-hfb.toml b/flopy4/mf6/dfns/gwf-hfb.toml new file mode 100644 index 000000000..fb30dc4f8 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-hfb.toml @@ -0,0 +1,63 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-hfb" +parent = "gwf-nam" +ftype = "HFB6" + +[dims.maxhfb] +value = "maxhfb" + +[blocks.options.fields.print_input] +type = "keyword" +longname = "model print input to listing file" +description = "keyword to indicate that the list of hydraulic flow barriers will be written to the listing file immediately after it is read." +optional = true + +[blocks.dimensions.fields.maxhfb] +type = "integer" +longname = "maximum number of barriers" +description = "integer value specifying the maximum number of hydraulic flow barriers that will be entered in this input file. The value of MAXHFB is used to allocate memory for the hydraulic flow barriers." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxhfb", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid1] +type = "cellid" +longname = "first cell adjacent to barrier" +description = "identifier for the first cell. For a structured grid that uses the DIS input file, CELLID1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLID1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLID1 is the node number for the cell. The barrier is located between cells designated as CELLID1 and CELLID2. The program will terminate with an error if CELLID1 and CELLID2 are not horizontally or vertically adjacent." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.cellid2] +type = "cellid" +longname = "second cell adjacent to barrier" +description = "identifier for the second cell. See CELLID1 for description of how to specify." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.hydchr] +type = "double" +longname = "barrier hydraulic characteristic" +description = "is the hydraulic characteristic of the hydraulic-flow barrier. The hydraulic characteristic is the barrier hydraulic conductivity divided by the width of the hydraulic-flow barrier. If the hydraulic characteristic is negative, then the absolute value of HYDCHR acts as a multiplier to the conductance between the two model cells specified as containing the barrier. For example, if the value for HYDCHR was specified as -1.5, the conductance calculated for the two cells would be multiplied by 1.5." +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.maxbound] +set_in = "ar" +source = "maxhfb" +type = "integer" diff --git a/flopy4/mf6/dfns/gwf-ic.toml b/flopy4/mf6/dfns/gwf-ic.toml new file mode 100644 index 000000000..4884980b4 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-ic.toml @@ -0,0 +1,51 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-ic" +parent = "gwf-nam" +ftype = "IC6" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.griddata.fields.strt] +type = "array" +longname = "starting head" +description = "is the initial (starting) head---that is, head at the beginning of the GWF Model simulation. STRT must be specified for all simulations, including steady-state simulations. One value is read for every model cell. For simulations in which the first stress period is steady state, the values used for STRT generally do not affect the simulation (exceptions may occur if cells go dry and (or) rewet). The execution time, however, will be less if STRT includes hydraulic heads that are close to the steady-state solution. A head value lower than the cell bottom can be provided if a cell should start as dry." +default = 1.0 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.strt] +type = "array" +set_in = "ar" +source = "strt" +dtype = "double" +shape = [ + "nodes", +] diff --git a/flopy4/mf6/dfns/gwf-lak.toml b/flopy4/mf6/dfns/gwf-lak.toml new file mode 100644 index 000000000..494d02de5 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-lak.toml @@ -0,0 +1,1214 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-lak" +parent = "gwf-nam" +ftype = "LAK6" +multi = true +subtype = "advanced" + +[dims.nlakes] +value = "nlakes" + +[dims.noutlets] +value = "noutlets" + +[dims.ntables] +value = "ntables" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.nlakeconn] +value = "sum(packagedata.nlakeconn)" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of lake cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of lake information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_stage] +type = "keyword" +longname = "print calculated stages to listing file" +description = "keyword to indicate that the list of lake {#2} will be printed to the listing file for every stress period in which 'HEAD PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of lake flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save lake flows to budget file" +description = "keyword to indicate that lake flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.stage_filerecord] +type = "record" +optional = true + +[blocks.options.fields.stage_filerecord.fields.stage] +type = "keyword" +longname = "stage keyword" +description = "keyword to specify that record corresponds to stage." + +[blocks.options.fields.stage_filerecord.fields.stagefile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write stage information." +tagged = false +direction = "out" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.package_convergence_filerecord] +type = "record" +optional = true + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence] +type = "keyword" +longname = "package_convergence keyword" +description = "keyword to specify that record corresponds to the package convergence comma spaced values file. A warning message will be issued if package convergence data is requested but the IMPLICIT option is specified. In that case the lake stage is included in the Iterative Model Solution (IMS) convergence check and the package convergence file is not written." + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] +type = "file" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." +tagged = false +direction = "out" + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the LAK package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LAK package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.mover] +type = "keyword" +description = "keyword to indicate that this instance of the LAK Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." +optional = true + +[blocks.options.fields.dev_force_legacy] +type = "keyword" +longname = "force the legacy solution for every lake" +description = "keyword that solves every active lake with the default (legacy) substitution solver under the implicit formulation, instead of only those lakes that are too poorly conditioned to solve as a matrix unknown. Cannot be specified with DEV_FORCE_LEGACY_LAKE. This development option exists to test that path and is not supported." +optional = true +developmode = true + +[blocks.options.fields.dev_force_legacy_lake] +type = "integer" +longname = "force the legacy solution for one lake" +description = "integer lake number that is solved with the default (legacy) substitution solver under the implicit formulation, while the other lakes are solved as matrix unknowns. Cannot be specified with DEV_FORCE_LEGACY. This development option exists to test that path and is not supported." +optional = true +developmode = true + +[blocks.options.fields.dev_groundwater_head_conductance] +type = "keyword" +longname = "use the groundwater head to calculate horizontal conductance" +description = "keyword that calculates the conductance for horizontal connections using the groundwater head instead of the lake stage. This development option is not supported." +optional = true +developmode = true + +[blocks.options.fields.dev_maximum_outlet_depth] +type = "double" +longname = "maximum outlet depth" +description = "real number value that defines the maximum depth used to calculate outlet flow. This development option is not supported." +optional = true +developmode = true + +[blocks.options.fields.surfdep] +type = "double" +longname = "surface depression depth" +description = "real value that defines the surface depression depth for VERTICAL lake-GWF connections. If specified, SURFDEP must be greater than or equal to zero. If SURFDEP is not specified, a default value of zero is used for all vertical lake-GWF connections." +optional = true + +[blocks.options.fields.implicit] +type = "keyword" +longname = "solve lake stage in the groundwater flow matrix" +description = "keyword that activates the implicit formulation. With this option each lake stage is solved as an additional unknown in the groundwater flow matrix, instead of by the default substitution-iteration solver. The implicit formulation typically converges in far fewer outer iterations for steady-state and strongly coupled lakes and can solve problems for which the default formulation fails to converge. Converged results are equivalent to the default formulation. The implicit formulation makes the coefficient matrix asymmetric and therefore requires the BICGSTAB linear acceleration in the Iterative Model Solution (IMS). Each lake must have at least one groundwater connection when the IMPLICIT option is active because the implicit formulation solves the lake stage through its lakebed seepage; the program will terminate with an error if a lake with no groundwater connections is specified with the IMPLICIT option. The implicit formulation does not yet include the density terms of the Buoyancy (BUY) Package, and the program will terminate with an error if the IMPLICIT option is specified and the BUY Package is active. If a lake stage becomes too poorly conditioned to solve as a matrix unknown, which can happen for a weakly connected or disconnected lake, that lake is solved automatically by the default substitution solver instead, so the implicit formulation remains as robust as the default formulation. The Newton formulation is recommended for lakes that may become perched (disconnected from the aquifer), because results obtained with the standard rewetting (REWET) capability can otherwise differ between the two approaches." +optional = true + +[blocks.options.fields.maximum_iterations] +type = "integer" +longname = "LAK Newton-Raphson iterations" +description = "integer value that defines the maximum number of Newton-Raphson iterations allowed for a lake. By default, MAXIMUM_ITERATIONS is equal to 100. MAXIMUM_ITERATIONS would only need to be increased from the default value if one or more lakes in a simulation has a large water budget error. This option applies only to the default substitution-iteration solver; when the IMPLICIT option is active the lake stage is solved within the groundwater flow matrix and its convergence is controlled by the Iterative Model Solution (IMS) settings instead." +optional = true + +[blocks.options.fields.maximum_stage_change] +type = "double" +longname = "stage closure tolerance" +description = "real value that defines the lake stage closure tolerance. By default, MAXIMUM_STAGE_CHANGE is equal to $1 times 10^{-5}$. The MAXIMUM_STAGE_CHANGE would only need to be increased or decreased from the default value if the water budget error for one or more lakes is too small or too large, respectively. This option applies only to the default substitution-iteration solver; when the IMPLICIT option is active the lake stage is solved within the groundwater flow matrix and its convergence is controlled by the Iterative Model Solution (IMS) settings instead." +optional = true + +[blocks.options.fields.time_conversion] +type = "double" +longname = "time conversion factor" +description = "real value that is used to convert user-specified Manning's roughness coefficients or gravitational acceleration used to calculate outlet flows from seconds to model time units. TIME_CONVERSION should be set to 1.0, 60.0, 3,600.0, 86,400.0, and 31,557,600.0 when using time units (TIME_UNITS) of seconds, minutes, hours, days, or years in the simulation, respectively. TIME_CONVERSION does not need to be specified if no lake outlets are specified or TIME_UNITS are seconds." +optional = true + +[blocks.options.fields.length_conversion] +type = "double" +longname = "length conversion factor" +description = "real value that is used to convert outlet user-specified Manning's roughness coefficients or gravitational acceleration used to calculate outlet flows from meters to model length units. LENGTH_CONVERSION should be set to 3.28081, 1.0, and 100.0 when using length units (LENGTH_UNITS) of feet, meters, or centimeters in the simulation, respectively. LENGTH_CONVERSION does not need to be specified if no lake outlets are specified or LENGTH_UNITS are meters." +optional = true + +[blocks.options.fields.dev_no_final_check] +type = "keyword" +longname = "disable final convergence check for lake stages" +description = "flag disabling the final convergence check of the change in lake stages. By default this check is enabled." +optional = true +developmode = true + +[blocks.dimensions.fields.nlakes] +type = "integer" +longname = "number of lakes" +description = "value specifying the number of lakes that will be simulated for all stress periods." + +[blocks.dimensions.fields.noutlets] +type = "integer" +longname = "number of outlets" +description = "value specifying the number of outlets that will be simulated for all stress periods. If NOUTLETS is not specified, a default value of zero is used." + +[blocks.dimensions.fields.ntables] +type = "integer" +longname = "number of tables" +description = "value specifying the number of lakes tables that will be used to define the lake stage, volume relation, and surface area. If NTABLES is not specified, a default value of zero is used." + +[blocks.packagedata.fields.packagedata] +type = "list" +shape = [ + "nlakes", +] + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.ifno] +type = "integer" +longname = "lake number for this entry" +description = "integer value that defines the feature (lake) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NLAKES. Lake information must be specified for every lake or the program will terminate with an error. The program will also terminate with an error if information for a lake is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.strt] +type = "double" +longname = "starting lake stage" +description = "real value that defines the starting stage for the lake." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.nlakeconn] +type = "integer" +longname = "number of lake connections" +description = "integer value that defines the number of GWF cells connected to this (IFNO) lake. There can only be one vertical lake connection to each GWF cell. NLAKECONN must be greater than zero." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.packagedata.fields.packagedata.item.fields.boundname] +type = "string" +longname = "well name" +description = "name of the lake cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.connectiondata.fields.connectiondata] +type = "list" +shape = [ + "nlakeconn", +] + +[blocks.connectiondata.fields.connectiondata.item] +name = "connectiondata" +type = "record" + +[blocks.connectiondata.fields.connectiondata.item.fields.ifno] +type = "integer" +longname = "lake number for this entry" +description = "integer value that defines the feature (lake) number associated with the specified CONNECTIONDATA data on the line. IFNO must be greater than zero and less than or equal to NLAKES. Lake connection information must be specified for every lake connection to the GWF model (NLAKECONN) or the program will terminate with an error. The program will also terminate with an error if connection information for a lake connection to the GWF model is specified more than once." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.connectiondata.fields.connectiondata.item.fields.iconn] +type = "integer" +longname = "connection number for this entry" +description = "integer value that defines the GWF connection number for this lake connection entry. ICONN must be greater than zero and less than or equal to NLAKECONN for lake IFNO." +tagged = false +index = true + +[blocks.connectiondata.fields.connectiondata.item.fields.iconn.pk] +scope = "ifno" + +[blocks.connectiondata.fields.connectiondata.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.connectiondata.fields.connectiondata.item.fields.claktype] +type = "string" +longname = "lake connection type" +description = "character string that defines the lake-GWF connection type for the lake connection. Possible lake-GWF connection type strings include: VERTICAL--character keyword to indicate the lake-GWF connection is vertical and connection conductance calculations use the hydraulic conductivity corresponding to the $K_{33}$ tensor component defined for CELLID in the NPF package. HORIZONTAL--character keyword to indicate the lake-GWF connection is horizontal and connection conductance calculations use the hydraulic conductivity corresponding to the $K_{11}$ tensor component defined for CELLID in the NPF package. EMBEDDEDH--character keyword to indicate the lake-GWF connection is embedded in a single cell and connection conductance calculations use the hydraulic conductivity corresponding to the $K_{11}$ tensor component defined for CELLID in the NPF package. EMBEDDEDV--character keyword to indicate the lake-GWF connection is embedded in a single cell and connection conductance calculations use the hydraulic conductivity corresponding to the $K_{33}$ tensor component defined for CELLID in the NPF package. Embedded lakes can only be connected to a single cell (NLAKECONN = 1) and there must be a lake table associated with each embedded lake." +tagged = false + +[blocks.connectiondata.fields.connectiondata.item.fields.bedleak] +type = "union" +longname = "bed leakance" +description = "real value or character string that defines the bed leakance for the lake-GWF connection. BEDLEAK must be greater than or equal to zero, equal to the DNODATA value (3.0E+30), or specified to be NONE. If DNODATA or NONE is specified for BEDLEAK, the lake-GWF connection conductance is solely a function of aquifer properties in the connected GWF cell and lakebed sediments are assumed to be absent. Warning messages will be issued if NONE is specified. Eventually the ability to specify NONE will be deprecated and cause MODFLOW 6 to terminate with an error." + +[blocks.connectiondata.fields.connectiondata.item.fields.bedleak.arms.none] +type = "keyword" + +[blocks.connectiondata.fields.connectiondata.item.fields.bedleak.arms.value] +type = "double" +tagged = false + +[blocks.connectiondata.fields.connectiondata.item.fields.belev] +type = "double" +longname = "bottom elevation" +description = "real value that defines the bottom elevation for a HORIZONTAL lake-GWF connection. Any value can be specified if CLAKTYPE is VERTICAL, EMBEDDEDH, or EMBEDDEDV. If CLAKTYPE is HORIZONTAL and BELEV is not equal to TELEV, BELEV must be greater than or equal to the bottom of the GWF cell CELLID. If BELEV is equal to TELEV, BELEV is reset to the bottom of the GWF cell CELLID." +tagged = false + +[blocks.connectiondata.fields.connectiondata.item.fields.telev] +type = "double" +longname = "top elevation" +description = "real value that defines the top elevation for a HORIZONTAL lake-GWF connection. Any value can be specified if CLAKTYPE is VERTICAL, EMBEDDEDH, or EMBEDDEDV. If CLAKTYPE is HORIZONTAL and TELEV is not equal to BELEV, TELEV must be less than or equal to the top of the GWF cell CELLID. If TELEV is equal to BELEV, TELEV is reset to the top of the GWF cell CELLID." +tagged = false + +[blocks.connectiondata.fields.connectiondata.item.fields.connlen] +type = "double" +longname = "connection length" +description = "real value that defines the distance between the connected GWF CELLID node and the lake for a HORIZONTAL, EMBEDDEDH, or EMBEDDEDV lake-GWF connection. CONLENN must be greater than zero for a HORIZONTAL, EMBEDDEDH, or EMBEDDEDV lake-GWF connection. Any value can be specified if CLAKTYPE is VERTICAL." +tagged = false + +[blocks.connectiondata.fields.connectiondata.item.fields.connwidth] +type = "double" +longname = "connection width" +description = "real value that defines the connection face width for a HORIZONTAL lake-GWF connection. CONNWIDTH must be greater than zero for a HORIZONTAL lake-GWF connection. Any value can be specified if CLAKTYPE is VERTICAL, EMBEDDEDH, or EMBEDDEDV." +tagged = false + +[blocks.tables.fields.tables] +type = "list" +optional = true +shape = [ + "ntables", +] + +[blocks.tables.fields.tables.item] +name = "tables" +type = "record" + +[blocks.tables.fields.tables.item.fields.ifno] +type = "integer" +longname = "lake number for this entry" +description = "integer value that defines the feature (lake) number associated with the specified TABLES data on the line. IFNO must be greater than zero and less than or equal to NLAKES. The program will terminate with an error if table information for a lake is specified more than once or the number of specified tables is less than NTABLES." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.tables.fields.tables.item.fields.tab6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a table file." + +[blocks.tables.fields.tables.item.fields.tab6_filename] +type = "file" +longname = "table file name" +description = "character string that defines the path and filename for the file containing lake table data for the lake connection. The TAB6_FILENAME file includes the number of entries in the file and the relation between stage, volume, and surface area for each entry in the file. Lake table files for EMBEDDEDH and EMBEDDEDV lake-GWF connections also include lake-GWF exchange area data for each entry in the file. Instructions for creating the TAB6_FILENAME input file are provided in Lake Table Input File section." +tagged = false +direction = "in" +component = "utl-laktab" + +[blocks.outlets.fields.outlets] +type = "list" +optional = true +shape = [ + "noutlets", +] + +[blocks.outlets.fields.outlets.item] +name = "outlets" +type = "record" + +[blocks.outlets.fields.outlets.item.fields.outletno] +type = "integer" +longname = "outlet number for this entry" +description = "integer value that defines the outlet number associated with the specified OUTLETS data on the line. OUTLETNO must be greater than zero and less than or equal to NOUTLETS. Outlet information must be specified for every outlet or the program will terminate with an error. The program will also terminate with an error if information for a outlet is specified more than once." +tagged = false +index = true +pk = true + +[blocks.outlets.fields.outlets.item.fields.lakein] +type = "integer" +longname = "lake number for upstream lake" +description = "integer value that defines the lake number that outlet is connected to. LAKEIN must be greater than zero and less than or equal to NLAKES." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.outlets.fields.outlets.item.fields.lakeout] +type = "integer" +longname = "lake number for downstream lake" +description = "integer value that defines the lake number that outlet discharge from lake outlet OUTLETNO is routed to. LAKEOUT must be greater than or equal to zero and less than or equal to NLAKES. If LAKEOUT is zero, outlet discharge from lake outlet OUTLETNO is discharged to an external boundary." +tagged = false +index = true +fk = "packagedata.ifno" +allow_zero = true + +[blocks.outlets.fields.outlets.item.fields.couttype] +type = "string" +longname = "outlet type" +description = "character string that defines the outlet type for the outlet OUTLETNO. Possible COUTTYPE strings include: SPECIFIED--character keyword to indicate the outlet is defined as a specified flow. MANNING--character keyword to indicate the outlet is defined using Manning's equation. WEIR--character keyword to indicate the outlet is defined using a sharp weir equation." +tagged = false + +[blocks.outlets.fields.outlets.item.fields.invert] +type = "double" +longname = "invert elevation" +description = "real value that defines the invert elevation for the lake outlet. Any value can be specified if COUTTYPE is SPECIFIED. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.outlets.fields.outlets.item.fields.width] +type = "double" +longname = "outlet width" +description = "real value that defines the width of the lake outlet. Any value can be specified if COUTTYPE is SPECIFIED. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.outlets.fields.outlets.item.fields.rough] +type = "double" +longname = "roughness coefficient" +description = "real value that defines the roughness coefficient for the lake outlet. Any value can be specified if COUTTYPE is not MANNING. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.outlets.fields.outlets.item.fields.slope] +type = "double" +longname = "bed slope" +description = "real value that defines the bed slope for the lake outlet. Any value can be specified if COUTTYPE is not MANNING. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "laksetting" +type = "union" +description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the LAKSETTING string include both keywords for lake settings and keywords for outlet settings. Keywords for lake settings include: STATUS, STAGE, RAINFALL, EVAPORATION, RUNOFF, INFLOW, WITHDRAWAL, and AUXILIARY. Keywords for outlet settings include RATE, INVERT, WIDTH, SLOPE, and ROUGH." + +[blocks.period.fields.stress_period_data.item.arms.status] +type = "record" + +[blocks.period.fields.stress_period_data.item.arms.status.fields.lakeno] +type = "integer" +longname = "lake or outlet number for this entry" +description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.arms.status.fields.status] +type = "string" +longname = "lake status" +description = "keyword option to define lake status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE." + +[blocks.period.fields.stress_period_data.item.arms.stage] +type = "record" + +[blocks.period.fields.stress_period_data.item.arms.stage.fields.lakeno] +type = "integer" +longname = "lake or outlet number for this entry" +description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.arms.stage.fields.stage] +type = "double" +longname = "lake stage" +description = "real or character value that defines the stage for the lake. The specified STAGE is only applied if the lake is a constant stage lake. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.arms.rainfall] +type = "record" + +[blocks.period.fields.stress_period_data.item.arms.rainfall.fields.lakeno] +type = "integer" +longname = "lake or outlet number for this entry" +description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.arms.rainfall.fields.rainfall] +type = "double" +longname = "rainfall rate" +description = "real or character value that defines the rainfall rate $(LT^{-1})$ for the lake. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.arms.evaporation] +type = "record" + +[blocks.period.fields.stress_period_data.item.arms.evaporation.fields.lakeno] +type = "integer" +longname = "lake or outlet number for this entry" +description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.arms.evaporation.fields.evaporation] +type = "double" +longname = "evaporation rate" +description = "real or character value that defines the maximum evaporation rate $(LT^{-1})$ for the lake. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.arms.runoff] +type = "record" + +[blocks.period.fields.stress_period_data.item.arms.runoff.fields.lakeno] +type = "integer" +longname = "lake or outlet number for this entry" +description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.arms.runoff.fields.runoff] +type = "double" +longname = "runoff rate" +description = "real or character value that defines the runoff rate $(L^3 T^{-1})$ for the lake. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.arms.inflow] +type = "record" + +[blocks.period.fields.stress_period_data.item.arms.inflow.fields.lakeno] +type = "integer" +longname = "lake or outlet number for this entry" +description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.arms.inflow.fields.inflow] +type = "double" +longname = "inflow rate" +description = "real or character value that defines the volumetric inflow rate $(L^3 T^{-1})$ for the lake. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, inflow rates are zero for each lake." +time_series = true + +[blocks.period.fields.stress_period_data.item.arms.withdrawal] +type = "record" + +[blocks.period.fields.stress_period_data.item.arms.withdrawal.fields.lakeno] +type = "integer" +longname = "lake or outlet number for this entry" +description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.arms.withdrawal.fields.withdrawal] +type = "double" +longname = "maximum withdrawal rate" +description = "real or character value that defines the maximum withdrawal rate $(L^3 T^{-1})$ for the lake. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.arms.rate] +type = "record" + +[blocks.period.fields.stress_period_data.item.arms.rate.fields.outletno] +type = "integer" +longname = "lake or outlet number for this entry" +description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." +tagged = false +index = true +fk = "outlets.outletno" + +[blocks.period.fields.stress_period_data.item.arms.rate.fields.rate] +type = "double" +longname = "extraction rate" +description = "real or character value that defines the extraction rate for the lake outflow. A positive value indicates inflow and a negative value indicates outflow from the lake. RATE only applies to outlets associated with active lakes (STATUS is ACTIVE). A specified RATE is only applied if COUTTYPE for the OUTLETNO is SPECIFIED. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, the RATE for each SPECIFIED lake outlet is zero." +time_series = true + +[blocks.period.fields.stress_period_data.item.arms.invert] +type = "record" + +[blocks.period.fields.stress_period_data.item.arms.invert.fields.outletno] +type = "integer" +longname = "lake or outlet number for this entry" +description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." +tagged = false +index = true +fk = "outlets.outletno" + +[blocks.period.fields.stress_period_data.item.arms.invert.fields.invert] +type = "double" +longname = "invert elevation" +description = "real or character value that defines the invert elevation for the lake outlet. A specified INVERT value is only used for active lakes if COUTTYPE for lake outlet OUTLETNO is not SPECIFIED. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.arms.width] +type = "record" + +[blocks.period.fields.stress_period_data.item.arms.width.fields.outletno] +type = "integer" +longname = "lake or outlet number for this entry" +description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." +tagged = false +index = true +fk = "outlets.outletno" + +[blocks.period.fields.stress_period_data.item.arms.width.fields.width] +type = "double" +longname = "outlet width" +description = "real or character value that defines the width of the lake outlet. A specified WIDTH value is only used for active lakes if COUTTYPE for lake outlet OUTLETNO is not SPECIFIED. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.arms.slope] +type = "record" + +[blocks.period.fields.stress_period_data.item.arms.slope.fields.outletno] +type = "integer" +longname = "lake or outlet number for this entry" +description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." +tagged = false +index = true +fk = "outlets.outletno" + +[blocks.period.fields.stress_period_data.item.arms.slope.fields.slope] +type = "double" +longname = "bed slope" +description = "real or character value that defines the bed slope for the lake outlet. A specified SLOPE value is only used for active lakes if COUTTYPE for lake outlet OUTLETNO is MANNING. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.arms.rough] +type = "record" + +[blocks.period.fields.stress_period_data.item.arms.rough.fields.outletno] +type = "integer" +longname = "lake or outlet number for this entry" +description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." +tagged = false +index = true +fk = "outlets.outletno" + +[blocks.period.fields.stress_period_data.item.arms.rough.fields.rough] +type = "double" +longname = "roughness coefficient" +description = "real value that defines the roughness coefficient for the lake outlet. Any value can be specified if COUTTYPE is not MANNING. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.arms.auxiliaryrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.arms.auxiliaryrecord.fields.lakeno] +type = "integer" +longname = "lake or outlet number for this entry" +description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.arms.auxiliaryrecord.fields.auxiliary] +type = "keyword" +description = "keyword for specifying auxiliary variable." + +[blocks.period.fields.stress_period_data.item.arms.auxiliaryrecord.fields.auxname] +type = "string" +description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." +tagged = false + +[blocks.period.fields.stress_period_data.item.arms.auxiliaryrecord.fields.auxval] +type = "double" +longname = "auxiliary variable value" +description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.options_stage] +set_in = "ar" +source = "stage" +type = "logical" + +[memory.pkgconv] +set_in = "ar" +source = "package_convergence" +type = "logical" + +[memory.pkgconvfname] +set_in = "ar" +source = "package_convergence_filename" +type = "string" + +[memory.options_filein] +set_in = "ar" +type = "logical" + +[memory.iforceleg] +set_in = "ar" +source = "dev_force_legacy" +type = "integer" + +[memory.iforceleglak] +set_in = "ar" +source = "dev_force_legacy_lake" +type = "integer" + +[memory.igwhcopt] +set_in = "ar" +source = "dev_groundwater_head_conductance" +type = "integer" + +[memory.outdmax] +set_in = "ar" +source = "dev_maximum_outlet_depth" +type = "double" + +[memory.surfdep] +set_in = "ar" +source = "surfdep" +type = "double" + +[memory.iimplicit] +set_in = "ar" +source = "implicit" +type = "integer" + +[memory.maxlakit] +set_in = "ar" +source = "maximum_iterations" +type = "integer" + +[memory.dmaxchg] +set_in = "ar" +source = "maximum_stage_change" +type = "double" + +[memory.convtime] +set_in = "ar" +source = "time_conversion" +type = "double" + +[memory.convlength] +set_in = "ar" +source = "length_conversion" +type = "double" + +[memory.iconvchk] +set_in = "ar" +source = "dev_no_final_check" +type = "integer" + +[memory.packagedata_ifno] +set_in = "ar" +source = "ifno" +type = "integer" + +[memory.conndata_ifno] +source = "ifno" +type = "integer" + +[memory.tables_ifno] +source = "ifno" +type = "integer" + +[memory.tables_filein] +type = "logical" + +[memory.laktab6_filename] +source = "tab6_filename" +type = "string" + +[memory.outlets_outletno] +source = "outletno" +type = "integer" + +[memory.outlets_invert] +source = "invert" +type = "double" + +[memory.outlets_width] +source = "width" +type = "double" + +[memory.outlets_rough] +source = "rough" +type = "double" + +[memory.outlets_slope] +source = "slope" +type = "double" + +[memory.ifno] +set_in = "rp" +type = "integer" + +[memory.period_auxiliary] +set_in = "rp" +source = "auxiliary" +type = "logical" + +[memory.nlakes] +set_in = "ar" +source = "nlakes" +type = "integer" + +[memory.noutlets] +set_in = "ar" +source = "noutlets" +type = "integer" + +[memory.ntables] +set_in = "ar" +source = "ntables" +type = "integer" + +[observations.stage] +type = "union" + +[observations.stage.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.stage.arms.boundname] +type = "string" +tagged = false + +[observations.ext-inflow] +type = "union" + +[observations.ext-inflow.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.ext-inflow.arms.boundname] +type = "string" +tagged = false + +[observations.outlet-inflow] +type = "union" + +[observations.outlet-inflow.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.outlet-inflow.arms.boundname] +type = "string" +tagged = false + +[observations.inflow] +type = "union" + +[observations.inflow.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.inflow.arms.boundname] +type = "string" +tagged = false + +[observations.from-mvr] +type = "union" + +[observations.from-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.from-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.rainfall] +type = "union" + +[observations.rainfall.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.rainfall.arms.boundname] +type = "string" +tagged = false + +[observations.runoff] +type = "union" + +[observations.runoff.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.runoff.arms.boundname] +type = "string" +tagged = false + +[observations.withdrawal] +type = "union" + +[observations.withdrawal.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.withdrawal.arms.boundname] +type = "string" +tagged = false + +[observations.evaporation] +type = "union" + +[observations.evaporation.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.evaporation.arms.boundname] +type = "string" +tagged = false + +[observations.storage] +type = "union" + +[observations.storage.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.storage.arms.boundname] +type = "string" +tagged = false + +[observations.constant] +type = "union" + +[observations.constant.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.constant.arms.boundname] +type = "string" +tagged = false + +[observations.volume] +type = "union" + +[observations.volume.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.volume.arms.boundname] +type = "string" +tagged = false + +[observations.surface-area] +type = "union" + +[observations.surface-area.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.surface-area.arms.boundname] +type = "string" +tagged = false + +[observations.lak] +type = "union" + +[observations.lak.arms.ifno_iconn] +type = "record" + +[observations.lak.arms.ifno_iconn.fields.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.lak.arms.ifno_iconn.fields.iconn] +type = "integer" +tagged = false +index = true + +[observations.lak.arms.ifno_iconn.fields.iconn.fk] +path = "connectiondata.iconn" +scope = "ifno" + +[observations.lak.arms.ifno_boundname] +type = "record" + +[observations.lak.arms.ifno_boundname.fields.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.lak.arms.ifno_boundname.fields.boundname] +type = "string" +tagged = false + +[observations.lak.arms.boundname] +type = "string" +tagged = false + +[observations.wetted-area] +type = "union" + +[observations.wetted-area.arms.ifno_iconn] +type = "record" + +[observations.wetted-area.arms.ifno_iconn.fields.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.wetted-area.arms.ifno_iconn.fields.iconn] +type = "integer" +tagged = false +index = true + +[observations.wetted-area.arms.ifno_iconn.fields.iconn.fk] +path = "connectiondata.iconn" +scope = "ifno" + +[observations.wetted-area.arms.ifno_boundname] +type = "record" + +[observations.wetted-area.arms.ifno_boundname.fields.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.wetted-area.arms.ifno_boundname.fields.boundname] +type = "string" +tagged = false + +[observations.wetted-area.arms.boundname] +type = "string" +tagged = false + +[observations.conductance] +type = "union" + +[observations.conductance.arms.ifno_iconn] +type = "record" + +[observations.conductance.arms.ifno_iconn.fields.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.conductance.arms.ifno_iconn.fields.iconn] +type = "integer" +tagged = false +index = true + +[observations.conductance.arms.ifno_iconn.fields.iconn.fk] +path = "connectiondata.iconn" +scope = "ifno" + +[observations.conductance.arms.ifno_boundname] +type = "record" + +[observations.conductance.arms.ifno_boundname.fields.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.conductance.arms.ifno_boundname.fields.boundname] +type = "string" +tagged = false + +[observations.conductance.arms.boundname] +type = "string" +tagged = false + +[observations.ext-outflow] +type = "union" + +[observations.ext-outflow.arms.outletno] +type = "integer" +tagged = false +index = true +fk = "outlets.outletno" + +[observations.ext-outflow.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.outletno] +type = "integer" +tagged = false +index = true +fk = "outlets.outletno" + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.outlet] +type = "union" + +[observations.outlet.arms.outletno] +type = "integer" +tagged = false +index = true +fk = "outlets.outletno" + +[observations.outlet.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=nlakeconn" + +[keys.mover_provider] +path = "outlets.outletno" +when = "mover" + +[keys.mover_receiver] +path = "packagedata.ifno" +when = "mover" diff --git a/flopy4/mf6/dfns/gwf-maw.toml b/flopy4/mf6/dfns/gwf-maw.toml new file mode 100644 index 000000000..c4ac850de --- /dev/null +++ b/flopy4/mf6/dfns/gwf-maw.toml @@ -0,0 +1,832 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-maw" +parent = "gwf-nam" +ftype = "MAW6" +multi = true +subtype = "advanced" + +[dims.nmawwells] +value = "nmawwells" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.ngwfnodes] +value = "sum(packagedata.ngwfnodes)" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of multi-aquifer well cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of multi-aquifer well information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_head] +type = "keyword" +longname = "print calculated heads to listing file" +description = "keyword to indicate that the list of multi-aquifer well {#2} will be printed to the listing file for every stress period in which 'HEAD PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of multi-aquifer well flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save well flows to budget file" +description = "keyword to indicate that multi-aquifer well flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.head_filerecord] +type = "record" +optional = true + +[blocks.options.fields.head_filerecord.fields.head] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to head." + +[blocks.options.fields.head_filerecord.fields.headfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write head information." +tagged = false +direction = "out" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.no_well_storage] +type = "keyword" +longname = "deactivate well storage" +description = "keyword that deactivates inclusion of well storage contributions to the multi-aquifer well package continuity equation." +optional = true + +[blocks.options.fields.flow_correction] +type = "keyword" +longname = "activate flow correction" +description = "keyword that activates flow corrections in cases where the head in a multi-aquifer well is below the bottom of the screen for a connection or the head in a convertible cell connected to a multi-aquifer well is below the cell bottom. When flow corrections are activated, unit head gradients are used to calculate the flow between a multi-aquifer well and a connected GWF cell. By default, flow corrections are not made." +optional = true + +[blocks.options.fields.non_vertical_wells] +type = "keyword" +longname = "activate non-vertical well connections" +description = "keyword that activates support for non-vertical (slanted) multi-aquifer well connections. When this option is specified, an ANGLEDATA block can be used to assign a tilt angle (deviation from vertical) to individual multi-aquifer well connections. The saturated conductance for a connection listed in the ANGLEDATA block is scaled by the in-cell screen length, which is calculated from the screen top, screen bottom, and tilt angle (or specified directly), instead of the vertical screen thickness. By default, all multi-aquifer well connections are assumed to be vertical. The tilt angle and connection length scale the conductance for a single connection only and do not route flow through intervening cells; a well that passes through more than one cell (a slanted well or a horizontal lateral) must have a separate connection to each cell that it penetrates. For a connection that uses the SPECIFIED conductance equation, the saturated conductance is used unchanged (the length correction is not applied because the conductance is provided by the user), but the screen top and bottom are honored so that the connection saturation is calculated over the correct interval rather than over the full cell." +optional = true + +[blocks.options.fields.flowing_wells] +type = "keyword" +longname = "activate flowing wells" +description = "keyword that activates the flowing wells option for the multi-aquifer well package." +optional = true + +[blocks.options.fields.shutdown_theta] +type = "double" +longname = "shutdown theta" +description = "value that defines the weight applied to discharge rate for wells that limit the water level in a discharging well (defined using the HEAD_LIMIT keyword in the stress period data). SHUTDOWN_THETA is used to control discharge rate oscillations when the flow rate from the aquifer is less than the specified flow rate from the aquifer to the well. Values range between 0.0 and 1.0, and larger values increase the weight (decrease under-relaxation) applied to the well discharge rate. The HEAD_LIMIT option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the HEAD_LIMIT option is recommended. By default, SHUTDOWN_THETA is 0.7." +optional = true + +[blocks.options.fields.shutdown_kappa] +type = "double" +longname = "shutdown kappa" +description = "value that defines the weight applied to discharge rate for wells that limit the water level in a discharging well (defined using the HEAD_LIMIT keyword in the stress period data). SHUTDOWN_KAPPA is used to control discharge rate oscillations when the flow rate from the aquifer is less than the specified flow rate from the aquifer to the well. Values range between 0.0 and 1.0, and larger values increase the weight applied to the well discharge rate. The HEAD_LIMIT option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the HEAD_LIMIT option is recommended. By default, SHUTDOWN_KAPPA is 0.0001." +optional = true + +[blocks.options.fields.mfrcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.mfrcsv_filerecord.fields.maw_flow_reduce_csv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the output option in which a new record is written for each multi-aquifer well and for each time step in which the user-requested extraction or injection rate is reduced by the program." + +[blocks.options.fields.mfrcsv_filerecord.fields.mfrcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write information about multi-aquifer well extraction or injection rates that have been reduced by the program. Entries are only written if the extraction or injection rates are reduced." +tagged = false +direction = "out" + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the MAW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MAW package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.mover] +type = "keyword" +description = "keyword to indicate that this instance of the MAW Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." +optional = true + +[blocks.options.fields.dev_peaceman_effective_radius] +type = "keyword" +longname = "use the Peaceman effective radius" +description = "keyword that calculates the effective radius for structured grids using the approach of Peaceman (1983) instead of the default approach. This development option is not supported." +optional = true +developmode = true + +[blocks.dimensions.fields.nmawwells] +type = "integer" +longname = "number of MAW wells" +description = "integer value specifying the number of multi-aquifer wells that will be simulated for all stress periods." + +[blocks.packagedata.fields.packagedata] +type = "list" +shape = [ + "nmawwells", +] + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.ifno] +type = "integer" +longname = "well number for this entry" +description = "integer value that defines the feature (well) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. Multi-aquifer well information must be specified for every multi-aquifer well or the program will terminate with an error. The program will also terminate with an error if information for a multi-aquifer well is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.radius] +type = "double" +longname = "well radius" +description = "radius for the multi-aquifer well. The program will terminate with an error if the radius is less than or equal to zero." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.bottom] +type = "double" +longname = "well bottom" +description = "bottom elevation of the multi-aquifer well. If CONDEQN is SPECIFIED, THIEM, SKIN, or CUMULATIVE, BOTTOM is set to the cell bottom in the lowermost GWF cell connection in cases where the specified well bottom is above the bottom of this GWF cell. If CONDEQN is MEAN, BOTTOM is set to the lowermost GWF cell connection screen bottom in cases where the specified well bottom is above this value. The bottom elevation defines the lowest well head that will be simulated when the NEWTON UNDER_RELAXATION option is specified in the GWF model name file. The bottom elevation is also used to calculate volumetric storage in the well." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.strt] +type = "double" +longname = "starting head" +description = "starting head for the multi-aquifer well. The program will terminate with an error if the starting head is less than the specified well bottom." +tagged = false +time_series = true + +[blocks.packagedata.fields.packagedata.item.fields.condeqn] +type = "string" +longname = "conductance equation" +description = "character string that defines the conductance equation that is used to calculate the saturated conductance for the multi-aquifer well. Possible multi-aquifer well CONDEQN strings include: SPECIFIED--character keyword to indicate the multi-aquifer well saturated conductance will be specified. THIEM--character keyword to indicate the multi-aquifer well saturated conductance will be calculated using the Thiem equation, which considers the cell top and bottom, aquifer hydraulic conductivity, and effective cell and well radius. SKIN--character keyword to indicate that the multi-aquifer well saturated conductance will be calculated using the cell top and bottom, aquifer and screen hydraulic conductivity, and well and skin radius. CUMULATIVE--character keyword to indicate that the multi-aquifer well saturated conductance will be calculated using a combination of the Thiem and SKIN equations. MEAN--character keyword to indicate the multi-aquifer well saturated conductance will be calculated using the aquifer and screen top and bottom, aquifer and screen hydraulic conductivity, and well and skin radius. The CUMULATIVE conductance equation is identical to the SKIN LOSSTYPE in the Multi-Node Well (MNW2) package for MODFLOW-2005. The program will terminate with an error condition if CONDEQN is SKIN or CUMULATIVE and the calculated saturated conductance is less than zero; if an error condition occurs, it is suggested that the THIEM or MEAN conductance equations be used for these multi-aquifer wells." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.ngwfnodes] +type = "integer" +longname = "number of connected GWF cells" +description = "integer value that defines the number of GWF nodes connected to this (IFNO) multi-aquifer well. NGWFNODES must be greater than zero." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each multi-aquifer well. The values of auxiliary variables must be present for each multi-aquifer well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.packagedata.fields.packagedata.item.fields.boundname] +type = "string" +longname = "well name" +description = "name of the multi-aquifer well cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.connectiondata.fields.connectiondata] +type = "list" +shape = [ + "ngwfnodes", +] + +[blocks.connectiondata.fields.connectiondata.item] +name = "connectiondata" +type = "record" + +[blocks.connectiondata.fields.connectiondata.item.fields.ifno] +type = "integer" +longname = "well number for this entry" +description = "integer value that defines the feature (well) number associated with the specified CONNECTIONDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. Multi-aquifer well connection information must be specified for every multi-aquifer well connection to the GWF model (NGWFNODES) or the program will terminate with an error. The program will also terminate with an error if connection information for a multi-aquifer well connection to the GWF model is specified more than once." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.connectiondata.fields.connectiondata.item.fields.icon] +type = "integer" +longname = "connection number" +description = "integer value that defines the GWF connection number for this multi-aquifer well connection entry. ICONN must be greater than zero and less than or equal to NGWFNODES for multi-aquifer well IFNO." +tagged = false +index = true + +[blocks.connectiondata.fields.connectiondata.item.fields.icon.pk] +scope = "ifno" + +[blocks.connectiondata.fields.connectiondata.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. One or more screened intervals can be connected to the same CELLID if CONDEQN for a well is MEAN. The program will terminate with an error if MAW wells using SPECIFIED, THIEM, SKIN, or CUMULATIVE conductance equations have more than one connection to the same CELLID." +tagged = false + +[blocks.connectiondata.fields.connectiondata.item.fields.scrn_top] +type = "double" +longname = "screen top" +description = "value that defines the top elevation of the screen for the multi-aquifer well connection. If CONDEQN is SPECIFIED, THIEM, SKIN, or CUMULATIVE, SCRN_TOP can be any value and is set to the top of the cell. If CONDEQN is MEAN, SCRN_TOP is set to the multi-aquifer well connection cell top if the specified value is greater than the cell top. The program will terminate with an error if the screen top is less than the screen bottom." +tagged = false + +[blocks.connectiondata.fields.connectiondata.item.fields.scrn_bot] +type = "double" +longname = "screen bottom" +description = "value that defines the bottom elevation of the screen for the multi-aquifer well connection. If CONDEQN is SPECIFIED, THIEM, SKIN, or CUMULATIVE, SCRN_BOT can be any value and is set to the bottom of the cell. If CONDEQN is MEAN, SCRN_BOT is set to the multi-aquifer well connection cell bottom if the specified value is less than the cell bottom. The program will terminate with an error if the screen bottom is greater than the screen top." +tagged = false + +[blocks.connectiondata.fields.connectiondata.item.fields.hk_skin] +type = "double" +longname = "skin data" +description = "value that defines the skin (filter pack) hydraulic conductivity (if CONDEQN for the multi-aquifer well is SKIN, CUMULATIVE, or MEAN) or conductance (if CONDEQN for the multi-aquifer well is SPECIFIED) for each GWF node connected to the multi-aquifer well (NGWFNODES). If CONDEQN is SPECIFIED, HK_SKIN must be greater than or equal to zero. HK_SKIN can be any value if CONDEQN is THIEM. Otherwise, HK_SKIN must be greater than zero. If CONDEQN is SKIN, the contrast between the cell transmissivity (the product of geometric mean horizontal hydraulic conductivity and the cell thickness) and the well transmissivity (the product of HK_SKIN and the screen thicknesses) must be greater than one in node CELLID or the program will terminate with an error condition; if an error condition occurs, it is suggested that the HK_SKIN be reduced to a value less than K11 and K22 in node CELLID or the THIEM or MEAN conductance equations be used for these multi-aquifer wells." +tagged = false + +[blocks.connectiondata.fields.connectiondata.item.fields.radius_skin] +type = "double" +longname = "skin radius" +description = "real value that defines the skin radius (filter pack radius) for the multi-aquifer well. RADIUS_SKIN can be any value if CONDEQN is SPECIFIED or THIEM. If CONDEQN is SKIN, CUMULATIVE, or MEAN, the program will terminate with an error if RADIUS_SKIN is less than or equal to the RADIUS for the multi-aquifer well." +tagged = false + +[blocks.angledata.fields.angledata] +type = "list" +optional = true + +[blocks.angledata.fields.angledata.item] +name = "angledata" +type = "record" + +[blocks.angledata.fields.angledata.item.fields.ifno] +type = "integer" +longname = "well number for this entry" +description = "integer value that defines the feature (well) number associated with the specified ANGLEDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. This block can only be specified if the NON_VERTICAL_WELLS option is specified in the OPTIONS block. Multi-aquifer well connections that are not listed in the ANGLEDATA block are assumed to be vertical. The program will terminate with an error if connection information for a multi-aquifer well connection is specified more than once." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.angledata.fields.angledata.item.fields.icon] +type = "integer" +longname = "connection number" +description = "integer value that defines the GWF connection number for this multi-aquifer well connection entry. ICON must be greater than zero and less than or equal to NGWFNODES for multi-aquifer well IFNO." +tagged = false +index = true + +[blocks.angledata.fields.angledata.item.fields.icon.pk] +scope = "ifno" + +[blocks.angledata.fields.angledata.item.fields.icon.fk] +path = "connectiondata.icon" +scope = "ifno" + +[blocks.angledata.fields.angledata.item.fields.angle] +type = "double" +longname = "tilt angle from vertical" +description = "value that defines the tilt angle of the multi-aquifer well connection, in degrees measured as a deviation from vertical. ANGLE must be greater than or equal to 0.0 (a vertical connection) and less than or equal to 90.0 (a horizontal connection) degrees. The in-cell screen length used to calculate the saturated conductance is computed from the screen top, screen bottom, well radius, and ANGLE, unless CONN_LENGTH is specified. The horizontal distance spanned by a connection grows rapidly as ANGLE approaches 90.0 degrees, and a warning is issued if it is greater than the maximum horizontal extent of the connected cell. A connection that is intended to pass through more than one cell should be specified as a separate connection to each cell that it passes through. If a connection passes through more than one cell unintentionally, ANGLE or CONN_LENGTH should be reduced." +tagged = false + +[blocks.angledata.fields.angledata.item.fields.conn_length] +type = "double" +longname = "in-cell screen length" +description = "optional value that defines the length of the multi-aquifer well screen within the connected GWF cell. If CONN_LENGTH is specified (and greater than zero), it is used directly as the in-cell screen length; otherwise, the in-cell screen length is calculated from the screen top, screen bottom, well radius, and ANGLE. CONN_LENGTH must be specified for horizontal connections (ANGLE equal to 90.0 degrees) because the in-cell screen length cannot be derived from the screen elevations for a horizontal connection. A warning is issued if the horizontal distance spanned by the connection is greater than the maximum horizontal extent of the connected cell. The MEAN conductance equation is recommended for horizontal connections. For a horizontal connection using the MEAN conductance equation, SCRN_TOP and SCRN_BOT do not affect the magnitude of the saturated conductance but do determine the elevation range over which the connection saturates and dewaters; SCRN_TOP and SCRN_BOT should be set to the top and bottom of the horizontal borehole so that the vertical screen extent (SCRN_TOP $-$ SCRN_BOT) equals the well diameter (2 times RADIUS). The program snaps SCRN_TOP to SCRN_BOT plus the well diameter when the specified extent is essentially equal to the well diameter, and otherwise issues a warning." +optional = true +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "perioddata" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.ifno] +type = "integer" +longname = "well number for this entry" +description = "integer value that defines the well number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.fields.mawsetting] +type = "union" +description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the MAWSETTING string include: STATUS, CONNECTION_STATUS, BOTTOM, FLOWING_WELL, RATE, WELL_HEAD, HEAD_LIMIT, SHUT_OFF, RATE_SCALING, and AUXILIARY." + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.status] +type = "string" +longname = "well status" +description = "keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE." + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.connection_statusrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.connection_statusrecord.fields.connection_status] +type = "keyword" +longname = "connection status keyword" +description = "keyword to indicate that the status of an individual multi-aquifer well connection is being changed. If CONNECTION_STATUS is specified, both ICON and CONNSTATUS must be specified." + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.connection_statusrecord.fields.icon] +type = "integer" +longname = "connection number" +description = "integer value that defines the connection number of multi-aquifer well IFNO for which CONNSTATUS is being specified. ICON must be greater than zero and less than or equal to NGWFNODES for multi-aquifer well IFNO." +tagged = false +index = true + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.connection_statusrecord.fields.connstatus] +type = "string" +longname = "connection status" +description = "keyword option to define the status of an individual multi-aquifer well connection. CONNSTATUS can be ACTIVE or INACTIVE. By default, every multi-aquifer well connection is ACTIVE. An INACTIVE connection does not exchange water with the connected GWF cell and is reported in the multi-aquifer well budget file with a flow rate of zero. MAW and CONDUCTANCE observations of an INACTIVE connection are reported as DNODATA (3.0E+30), as they are for an INACTIVE well. A connection that is not simulated, because it or its multi-aquifer well is INACTIVE, has no wetted area, so an associated MWE Package does not conduct heat through it. A connection is simulated only if both the multi-aquifer well and the connection are active, so setting the well STATUS to INACTIVE suspends all of its connections without changing their individual settings; the previously specified connection settings are used again when the well is made ACTIVE or CONSTANT. At least one connection of a multi-aquifer well must be ACTIVE; to deactivate every connection of a well, set the well STATUS to INACTIVE. CONNECTION_STATUS does not change the volume of water stored in the multi-aquifer well; use BOTTOM to change the elevation at which the well is empty when the lower part of a well is filled." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.bottom] +type = "double" +longname = "well bottom" +description = "real value that defines the bottom elevation of the multi-aquifer well. BOTTOM can be used to raise the bottom of a well that has been filled or plugged, so that the well stops yielding water at the elevation of the fill instead of at its original bottom. BOTTOM does not change the amount of water released from or taken into multi-aquifer well storage for a given change in head, which is determined by the well radius; it changes the elevation at which the multi-aquifer well is empty. The volume of water displaced by the material used to fill the well is not included in the multi-aquifer well budget. BOTTOM must be less than or equal to the simulated head in the well and must be less than or equal to the screen bottom of every active connection for the multi-aquifer well." + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.flowing_wellrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.flowing_wellrecord.fields.flowing_well] +type = "keyword" +longname = "well is a flowing well" +description = "keyword to indicate the well is a flowing well. The FLOWING_WELL option can be used to simulate flowing wells when the simulated well head exceeds the specified drainage elevation." + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.flowing_wellrecord.fields.fwelev] +type = "double" +longname = "flowing well elevation" +description = "elevation used to determine whether or not the well is flowing." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.flowing_wellrecord.fields.fwcond] +type = "double" +longname = "well flowing well conductance" +description = "conductance used to calculate the discharge of a free flowing well. Flow occurs when the head in the well is above the well top elevation (FWELEV)." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.flowing_wellrecord.fields.fwrlen] +type = "double" +longname = "flowing well reduction length" +description = "length used to reduce the conductance of the flowing well. When the head in the well drops below the well top plus the reduction length, then the conductance is reduced. This reduction length can be used to improve the stability of simulations with flowing wells so that there is not an abrupt change in flowing well rates." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.rate] +type = "double" +longname = "well pumping rate" +description = "is the volumetric pumping rate for the multi-aquifer well. A positive value indicates recharge and a negative value indicates discharge (pumping). RATE only applies to active (STATUS is ACTIVE) multi-aquifer wells. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, the RATE for each multi-aquifer well is zero." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.well_head] +type = "double" +longname = "well head" +description = "is the head in the multi-aquifer well. WELL_HEAD is only applied to constant head (STATUS is CONSTANT) and inactive (STATUS is INACTIVE) multi-aquifer wells. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. The program will terminate with an error if WELL_HEAD is less than the bottom of the well." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.head_limitrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.head_limitrecord.fields.head_limit] +type = "keyword" + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.head_limitrecord.fields.head_limit_value] +type = "union" +longname = "head limit" +description = "is the limiting water level (head) in the well, which is the minimum of the well RATE or the well inflow rate from the aquifer. HEAD_LIMIT can be applied to extraction wells (RATE $<$ 0) or injection wells (RATE $>$ 0). HEAD_LIMIT can be deactivated by specifying the text string `OFF'. The HEAD_LIMIT option is based on the HEAD_LIMIT functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The HEAD_LIMIT option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the HEAD_LIMIT option is recommended. By default, HEAD_LIMIT is `OFF'." + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.head_limitrecord.fields.head_limit_value.arms.off] +type = "keyword" + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.head_limitrecord.fields.head_limit_value.arms.value] +type = "double" +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.shutoffrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.shutoffrecord.fields.shut_off] +type = "keyword" +longname = "shut off well" +description = "keyword for activating well shut off capability. Subsequent values define the minimum and maximum pumping rate that a well must exceed to shutoff or reactivate a well, respectively, during a stress period. SHUT_OFF is only applied to injection wells (RATE$<0$) and if HEAD_LIMIT is specified (not set to `OFF'). If HEAD_LIMIT is specified, SHUT_OFF can be deactivated by specifying a minimum value equal to zero. The SHUT_OFF option is based on the SHUT_OFF functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The SHUT_OFF option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the SHUT_OFF option is recommended. By default, SHUT_OFF is not used." + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.shutoffrecord.fields.minrate] +type = "double" +longname = "minimum shutoff rate" +description = "is the minimum rate that a well must exceed to shutoff a well during a stress period. The well will shut down during a time step if the flow rate to the well from the aquifer is less than MINRATE. If a well is shut down during a time step, reactivation of the well cannot occur until the next time step to reduce oscillations. MINRATE must be less than maxrate." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.shutoffrecord.fields.maxrate] +type = "double" +longname = "maximum shutoff rate" +description = "is the maximum rate that a well must exceed to reactivate a well during a stress period. The well will reactivate during a timestep if the well was shutdown during the previous time step and the flow rate to the well from the aquifer exceeds maxrate. Reactivation of the well cannot occur until the next time step if a well is shutdown to reduce oscillations. maxrate must be greater than MINRATE." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.rate_scalingrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.rate_scalingrecord.fields.rate_scaling] +type = "keyword" +longname = "rate scaling" +description = "activate rate scaling. If RATE_SCALING is specified, both PUMP_ELEVATION and SCALING_LENGTH must be specified. RATE_SCALING cannot be used with HEAD_LIMIT. RATE_SCALING can be used for extraction or injection wells. For extraction wells, the extraction rate will start to decrease once the head in the well lowers to a level equal to the pump elevation plus the scaling length. If the head in the well drops below the pump elevation, then the extraction rate is calculated to be zero. For an injection well, the injection rate will begin to decrease once the head in the well rises above the specified pump elevation. If the head in the well rises above the pump elevation plus the scaling length, then the injection rate will be set to zero." + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.rate_scalingrecord.fields.pump_elevation] +type = "double" +longname = "pump elevation" +description = "is the elevation of the multi-aquifer well pump (PUMP_ELEVATION). PUMP_ELEVATION should not be less than the bottom elevation (BOTTOM) of the multi-aquifer well." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.rate_scalingrecord.fields.scaling_length] +type = "double" +description = "height above the pump elevation (SCALING_LENGTH). If the simulated well head is below this elevation (pump elevation plus the scaling length), then the pumping rate is reduced." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.auxiliaryrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.auxiliaryrecord.fields.auxiliary] +type = "keyword" +description = "keyword for specifying auxiliary variable." + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.auxiliaryrecord.fields.auxname] +type = "string" +description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.auxiliaryrecord.fields.auxval] +type = "double" +longname = "auxiliary variable value" +description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.inonvert] +set_in = "ar" +source = "non_vertical_wells" +type = "integer" + +[memory.maw_flw_red_csv] +set_in = "ar" +source = "maw_flow_reduce_csv" +type = "logical" + +[memory.ieffradopt] +set_in = "ar" +source = "dev_peaceman_effective_radius" +type = "integer" + +[memory.maxbound] +set_in = "ar" +source = "nmawwells" +type = "integer" + +[memory.packagedata_ifno] +set_in = "ar" +source = "ifno" +type = "integer" + +[memory.conndata_ifno] +source = "ifno" +type = "integer" + +[memory.angledata_ifno] +source = "ifno" +type = "integer" + +[memory.angledata_icon] +source = "icon" +type = "integer" + +[memory.connlen] +source = "conn_length" +type = "double" + +[memory.conn_status] +set_in = "rp" +source = "connection_status" +type = "logical" + +[memory.period_icon] +set_in = "rp" +source = "icon" +type = "integer" + +[memory.period_bottom] +set_in = "rp" +source = "bottom" +type = "double" + +[memory.period_auxiliary] +set_in = "rp" +source = "auxiliary" +type = "logical" + +[observations.head] +type = "union" + +[observations.head.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.head.arms.boundname] +type = "string" +tagged = false + +[observations.from-mvr] +type = "union" + +[observations.from-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.from-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.rate] +type = "union" + +[observations.rate.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.rate.arms.boundname] +type = "string" +tagged = false + +[observations.rate-to-mvr] +type = "union" + +[observations.rate-to-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.rate-to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.fw-rate] +type = "union" + +[observations.fw-rate.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.fw-rate.arms.boundname] +type = "string" +tagged = false + +[observations.fw-to-mvr] +type = "union" + +[observations.fw-to-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.fw-to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.storage] +type = "union" + +[observations.storage.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.storage.arms.boundname] +type = "string" +tagged = false + +[observations.constant] +type = "union" + +[observations.constant.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.constant.arms.boundname] +type = "string" +tagged = false + +[observations.fw-conductance] +type = "union" + +[observations.fw-conductance.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.fw-conductance.arms.boundname] +type = "string" +tagged = false + +[observations.maw] +type = "union" + +[observations.maw.arms.ifno_icon] +type = "record" + +[observations.maw.arms.ifno_icon.fields.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.maw.arms.ifno_icon.fields.icon] +type = "integer" +tagged = false +index = true + +[observations.maw.arms.ifno_icon.fields.icon.fk] +path = "connectiondata.icon" +scope = "ifno" + +[observations.maw.arms.ifno_boundname] +type = "record" + +[observations.maw.arms.ifno_boundname.fields.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.maw.arms.ifno_boundname.fields.boundname] +type = "string" +tagged = false + +[observations.maw.arms.boundname] +type = "string" +tagged = false + +[observations.conductance] +type = "union" + +[observations.conductance.arms.ifno_icon] +type = "record" + +[observations.conductance.arms.ifno_icon.fields.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.conductance.arms.ifno_icon.fields.icon] +type = "integer" +tagged = false +index = true + +[observations.conductance.arms.ifno_icon.fields.icon.fk] +path = "connectiondata.icon" +scope = "ifno" + +[observations.conductance.arms.ifno_boundname] +type = "record" + +[observations.conductance.arms.ifno_boundname.fields.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.conductance.arms.ifno_boundname.fields.boundname] +type = "string" +tagged = false + +[observations.conductance.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=ngwfnodes" + +[keys.mover_provider] +path = "packagedata.ifno" +when = "mover" + +[keys.mover_receiver] +path = "packagedata.ifno" +when = "mover" diff --git a/flopy4/mf6/dfns/gwf-mvr.toml b/flopy4/mf6/dfns/gwf-mvr.toml new file mode 100644 index 000000000..332bf9f68 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-mvr.toml @@ -0,0 +1,209 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-mvr" +ftype = "MVR6" +parent = [ + "exg-gwfgwf", + "gwf-nam", +] + +[dims.maxmvr] +value = "maxmvr" + +[dims.maxpackages] +value = "maxpackages" + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of MVR information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of MVR flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.modelnames] +type = "keyword" +longname = "precede all package names with model names" +description = "keyword to indicate that all package names will be preceded by the model name for the package. Model names are required when the Mover Package is used with a GWF-GWF Exchange. The MODELNAME keyword should not be used for a Mover Package that is for a single GWF Model." +optional = true + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[blocks.dimensions.fields.maxmvr] +type = "integer" +longname = "maximum number of movers" +description = "integer value specifying the maximum number of water mover entries that will specified for any stress period." + +[blocks.dimensions.fields.maxpackages] +type = "integer" +longname = "number of packages to be used with the mover" +description = "integer value specifying the number of unique packages that are included in this water mover input file." + +[blocks.packages.fields.packages] +type = "list" +shape = [ + "maxpackages", +] + +[blocks.packages.fields.packages.item] +name = "packages" +type = "record" + +[blocks.packages.fields.packages.item.fields.mname] +type = "string" +description = "name of model containing the package. Model names are assigned by the user in the simulation name file." +when = "modelnames" +tagged = false + +[blocks.packages.fields.packages.item.fields.mname.fk] +path = "sim-nam.models.mname" +rule = "exchange_models" + +[blocks.packages.fields.packages.item.fields.pname] +type = "string" +description = "is the name of a package that may be included in a subsequent stress period block. The package name is assigned in the name file for the GWF Model. Package names are optionally provided in the name file. If they are not provided by the user, then packages are assigned a default value, which is the package acronym followed by a hyphen and the package number. For example, the first Drain Package is named DRN-1. The second Drain Package is named DRN-2, and so forth." +tagged = false + +[blocks.packages.fields.packages.item.fields.pname.pk] +scope = "mname" + +[blocks.packages.fields.packages.item.fields.pname.fk] +path = "gwf-nam.packages.pname" +scope = "mname" +rule = "mover_enabled" + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "perioddata" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.mname1] +type = "string" +description = "name of model containing the package, PNAME1." +when = "modelnames" +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.mname1.fk] +path = "sim-nam.models.mname" +rule = "exchange_models" + +[blocks.period.fields.stress_period_data.item.fields.pname1] +type = "string" +longname = "provider package name" +description = "is the package name for the provider. The package PNAME1 must be designated to provide water through the MVR Package by specifying the keyword 'MOVER' in its OPTIONS block." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.pname1.fk] +path = "packages.pname" +scope = "mname1" + +[blocks.period.fields.stress_period_data.item.fields.id1] +type = "integer" +longname = "provider reach" +description = "is the identifier for the provider. For the standard boundary packages, the provider identifier is the number of the boundary as it is listed in the package input file. (Note that the order of these boundaries may change by stress period, which must be accounted for in the Mover Package.) So the first well has an identifier of one. The second is two, and so forth. For the advanced packages, the identifier is the reach number (SFR Package), well number (MAW Package), or UZF cell number. For the Lake Package, ID1 is the lake outlet number. Thus, outflows from a single lake can be routed to different streams, for example." +tagged = false +index = true + +[blocks.period.fields.stress_period_data.item.fields.id1.fk] +scope = "pname1" +key = "mover_provider" + +[blocks.period.fields.stress_period_data.item.fields.mname2] +type = "string" +description = "name of model containing the package, PNAME2." +when = "modelnames" +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.mname2.fk] +path = "sim-nam.models.mname" +rule = "exchange_models" + +[blocks.period.fields.stress_period_data.item.fields.pname2] +type = "string" +longname = "receiver package name" +description = "is the package name for the receiver. The package PNAME2 must be designated to receive water from the MVR Package by specifying the keyword 'MOVER' in its OPTIONS block." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.pname2.fk] +path = "packages.pname" +scope = "mname2" + +[blocks.period.fields.stress_period_data.item.fields.id2] +type = "integer" +longname = "receiver reach" +description = "is the identifier for the receiver. The receiver identifier is the reach number (SFR Package), Lake number (LAK Package), well number (MAW Package), or UZF cell number." +tagged = false +index = true + +[blocks.period.fields.stress_period_data.item.fields.id2.fk] +scope = "pname2" +key = "mover_receiver" + +[blocks.period.fields.stress_period_data.item.fields.mvrtype] +type = "string" +longname = "mover type" +description = "is the character string signifying the method for determining how much water will be moved. Supported values are 'FACTOR' 'EXCESS' 'THRESHOLD' and 'UPTO'. These four options determine how the receiver flow rate, $Q_R$, is calculated. These options mirror the options defined for the cprior variable in the SFR package, with the term 'FACTOR' being functionally equivalent to the 'FRACTION' option for cprior." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.value] +type = "double" +longname = "mover value" +description = "is the value to be used in the equation for calculating the amount of water to move. For the 'FACTOR' option, VALUE is the $alpha$ factor. For the remaining options, VALUE is the specified flow rate, $Q_S$." +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.maxmvr] +set_in = "ar" +source = "maxmvr" +type = "integer" + +[memory.maxpackages] +set_in = "ar" +source = "maxpackages" +type = "integer" diff --git a/flopy4/mf6/dfns/gwf-nam.toml b/flopy4/mf6/dfns/gwf-nam.toml new file mode 100644 index 000000000..29b626004 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-nam.toml @@ -0,0 +1,232 @@ +type = "model" +schema_version = "2.0.0.dev3" +name = "gwf-nam" +parent = "sim-nam" +ftype = "GWF6" +dependent_variable = "head" + +[runtime_dims.nja] +set_in = "ar" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.list] +type = "string" +longname = "name of listing file" +description = "is name of the listing file to create for this GWF model. If not specified, then the name of the list file will be the basename of the GWF model name file and the '.lst' extension. For example, if the GWF name file is called 'my.model.nam' then the list file will be called 'my.model.lst'." +optional = true +case_sensitive = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save flows for all packages to budget file" +description = "keyword to indicate that all model package flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.newtonoptions] +type = "record" +longname = "newton keyword and options" +description = "none" +optional = true + +[blocks.options.fields.newtonoptions.fields.newton] +type = "keyword" +longname = "keyword to activate Newton-Raphson formulation" +description = "keyword that activates the Newton-Raphson formulation for groundwater flow between connected, convertible groundwater cells and stress packages that support calculation of Newton-Raphson terms for groundwater exchanges. Cells will not dry when this option is used. By default, the Newton-Raphson formulation is not applied." + +[blocks.options.fields.newtonoptions.fields.under_relaxation] +type = "keyword" +longname = "keyword to activate Newton-Raphson UNDER_RELAXATION option" +description = "keyword that indicates whether the groundwater head in a cell will be under-relaxed when water levels fall below the bottom of the model below any given cell. By default, Newton-Raphson UNDER_RELAXATION is not applied." +optional = true + +[blocks.options.fields.nc_mesh2d_filerecord] +type = "record" +description = "NetCDF layered mesh fileout record." +optional = true + +[blocks.options.fields.nc_mesh2d_filerecord.fields.netcdf_mesh2d] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to a layered mesh NetCDF file." + +[blocks.options.fields.nc_mesh2d_filerecord.fields.ncmesh2dfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF ugrid layered mesh output file." +tagged = false +direction = "out" + +[blocks.options.fields.nc_structured_filerecord] +type = "record" +description = "NetCDF structured fileout record." +optional = true + +[blocks.options.fields.nc_structured_filerecord.fields.netcdf_structured] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to a structured NetCDF file." + +[blocks.options.fields.nc_structured_filerecord.fields.ncstructfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF structured output file." +tagged = false +direction = "out" + +[blocks.options.fields.nc_filerecord] +type = "record" +description = "NetCDF filerecord" +optional = true + +[blocks.options.fields.nc_filerecord.fields.netcdf] +type = "keyword" +longname = "netcdf keyword" +description = "keyword to specify that record corresponds to a NetCDF input file." + +[blocks.options.fields.nc_filerecord.fields.netcdf_filename] +type = "file" +longname = "netcdf input filename" +description = "defines a NetCDF input file." +tagged = false +direction = "in" + +[blocks.packages.fields.packages] +type = "list" +longname = "package list" + +[blocks.packages.fields.packages.item] +name = "packages" +type = "record" + +[blocks.packages.fields.packages.item.fields.ftype] +type = "string" +longname = "package type" +description = "is the file type, which must be one of the following character values shown in table~ref{table:ftype-gwf}. Ftype may be entered in any combination of uppercase and lowercase." +tagged = false + +[blocks.packages.fields.packages.item.fields.fname] +type = "file" +longname = "file name" +description = "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run." +tagged = false +direction = "in" +mode_keyword = false +component = "package" +component_ftype = "ftype" + +[blocks.packages.fields.packages.item.fields.pname] +type = "string" +longname = "user name for package" +description = "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single GWF Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters." +optional = true +tagged = false +pk = true + +[memory.netcdf_struct] +set_in = "ar" +source = "netcdf_structured" +type = "logical" + +[memory.netcdf_fname] +set_in = "ar" +source = "netcdf_filename" +type = "string" + +[memory.x] +type = "array" +set_in = "ca" +description = "Hydraulic head for each model cell. Checked in from the solution-level dependent-variable vector. Initialized by the IC package during AR; updated by the nonlinear solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." +obs_type = "HEAD" +dtype = "double" +shape = [ + "nodes", +] + +[memory.xold] +type = "array" +readonly = true +set_in = "ad" +description = "Dependent variable from the end of the previous time step. Copied from X at advance (AD); used to restore X if the adaptive time stepping scheme retries a failed time step." +dtype = "double" +shape = [ + "nodes", +] + +[memory.flowja] +type = "array" +readonly = true +set_in = "cq" +description = "Intercell flows in compressed sparse row (CSR) order, calculated after solution convergence. Diagonal entries hold the flow residual." +budget = "FLOW-JA-FACE" +dtype = "double" +shape = [ + "nja", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution for this model, sliced from the solution-level RHS vector. Rebuilt each solver iteration." +dtype = "double" +shape = [ + "nodes", +] + +[memory.ibound] +type = "array" +set_in = "ar" +description = "Cell activity flag: positive values indicate active cells, zero indicates inactive (no-flow) cells. Set during model initialisation; may change when Newton-Raphson wet-dry logic activates or deactivates cells." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.neq] +readonly = true +set_in = "ar" +description = "Number of equations (unknowns) for this model. Equal to the number of active cells (NODES) for standard models." +type = "integer" + +[memory.idxglo] +type = "array" +readonly = true +set_in = "mc" +description = "Maps each local CSR position to the corresponding row/column index in the global solution matrix. Populated during matrix connectivity (MC) and constant thereafter." +dtype = "integer" +shape = [ + "nja", +] + +[observations.head] +type = "cellid" +tagged = false + +[observations.drawdown] +type = "cellid" +tagged = false + +[observations.flow-ja-face] +type = "record" + +[observations.flow-ja-face.fields.cellid] +type = "cellid" +tagged = false + +[observations.flow-ja-face.fields.cellid2] +type = "cellid" +tagged = false diff --git a/flopy4/mf6/dfns/gwf-npf.toml b/flopy4/mf6/dfns/gwf-npf.toml new file mode 100644 index 000000000..75f79fb39 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-npf.toml @@ -0,0 +1,473 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-npf" +parent = "gwf-nam" +ftype = "NPF6" + +[runtime_dims.njas] +set_in = "ar" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "keyword to save NPF flows" +description = "keyword to indicate that budget flow terms will be written to the file specified with 'BUDGET SAVE FILE' in Output Control." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "keyword to print NPF flows to listing file" +description = "keyword to indicate that calculated flows between cells will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period. This option can produce extremely large list files because all cell-by-cell flows are printed. It should only be used with the NPF Package for models that have a small number of cells." +optional = true + +[blocks.options.fields.alternative_cell_averaging] +type = "string" +longname = "conductance weighting option" +description = "is a text keyword to indicate that an alternative method will be used for calculating the conductance for horizontal cell connections. The text value for ALTERNATIVE_CELL_AVERAGING can be 'LOGARITHMIC', 'AMT-LMK', or 'AMT-HMK'. 'AMT-LMK' signifies that the conductance will be calculated using arithmetic-mean thickness and logarithmic-mean hydraulic conductivity. 'AMT-HMK' signifies that the conductance will be calculated using arithmetic-mean thickness and harmonic-mean hydraulic conductivity. If the user does not specify a value for ALTERNATIVE_CELL_AVERAGING, then the harmonic-mean method will be used. This option cannot be used if the XT3D option is invoked. The AMT-HMK ALTERNATIVE_CELL_AVERAGING option, in combination with the DRY_CELL_SATURATION option, can be used to calculate the same horizontal conductance as MODFLOW-USG when upstream weighting is used (LAYCON=4)." +optional = true +valid = [ + "logarithmic", + "amt-lmk", + "amt-hmk", +] + +[blocks.options.fields.thickstrt] +type = "keyword" +longname = "keyword to activate THICKSTRT option" +description = "indicates that cells having a negative ICELLTYPE are confined, and their cell thickness for conductance calculations will be computed as STRT-BOT rather than TOP-BOT. This option should be used with caution as it only affects conductance calculations in the NPF Package." +optional = true + +[blocks.options.fields.cvoptions] +type = "record" +longname = "vertical conductance options" +description = "none" +optional = true + +[blocks.options.fields.cvoptions.fields.variablecv] +type = "keyword" +longname = "keyword to activate VARIABLECV option" +description = "keyword to indicate that the vertical conductance will be calculated using the saturated thickness and properties of the overlying cell and the thickness and properties of the underlying cell. If the DEWATERED keyword is also specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top. If these keywords are not specified, then the default condition is to calculate the vertical conductance at the start of the simulation using the initial head and the cell properties. The vertical conductance remains constant for the entire simulation." + +[blocks.options.fields.cvoptions.fields.dewatered] +type = "keyword" +longname = "keyword to activate DEWATERED option" +description = "If the DEWATERED keyword is specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top." +optional = true + +[blocks.options.fields.perched] +type = "keyword" +longname = "keyword to activate PERCHED option" +description = "keyword to indicate that when a cell is overlying a dewatered convertible cell, the head difference used in Darcy's Law is equal to the head in the overlying cell minus the bottom elevation of the overlying cell. If not specified, then the default is to use the head difference between the two cells." +optional = true + +[blocks.options.fields.rewet_record] +type = "record" +optional = true + +[blocks.options.fields.rewet_record.fields.rewet] +type = "keyword" +longname = "keyword to activate rewetting" +description = "activates model rewetting. Rewetting is off by default." + +[blocks.options.fields.rewet_record.fields.wetfct] +type = "double" +longname = "wetting factor to use for rewetting" +description = "is a keyword and factor that is included in the calculation of the head that is initially established at a cell when that cell is converted from dry to wet." + +[blocks.options.fields.rewet_record.fields.iwetit] +type = "integer" +longname = "interval to use for rewetting" +description = "is a keyword and iteration interval for attempting to wet cells. Wetting is attempted every IWETIT iteration. This applies to outer iterations and not inner iterations. If IWETIT is specified as zero or less, then the value is changed to 1." + +[blocks.options.fields.rewet_record.fields.ihdwet] +type = "integer" +longname = "flag to determine wetting equation" +description = "is a keyword and integer flag that determines which equation is used to define the initial head at cells that become wet. If IHDWET is 0, h = BOT + WETFCT (hm - BOT). If IHDWET is not 0, h = BOT + WETFCT (THRESH)." + +[blocks.options.fields.xt3doptions] +type = "record" +longname = "keyword to activate XT3D" +description = "none" +optional = true + +[blocks.options.fields.xt3doptions.fields.xt3d] +type = "keyword" +longname = "keyword to activate XT3D" +description = "keyword indicating that the XT3D formulation will be used. If the RHS keyword is also included, then the XT3D additional terms will be added to the right-hand side. If the RHS keyword is excluded, then the XT3D terms will be put into the coefficient matrix. Use of XT3D will substantially increase the computational effort, but will result in improved accuracy for anisotropic conductivity fields and for unstructured grids in which the CVFD requirement is violated. XT3D requires additional information about the shapes of grid cells. If XT3D is active and the DISU Package is used, then the user will need to provide in the DISU Package the angldegx array in the CONNECTIONDATA block and the VERTICES and CELL2D blocks." + +[blocks.options.fields.xt3doptions.fields.rhs] +type = "keyword" +longname = "keyword to XT3D on right hand side" +description = "If the RHS keyword is also included, then the XT3D additional terms will be added to the right-hand side. If the RHS keyword is excluded, then the XT3D terms will be put into the coefficient matrix." +optional = true + +[blocks.options.fields.highest_cell_saturation] +type = "keyword" +longname = "keyword to activate HIGHEST_CELL_SATURATION option" +description = "keyword indicating that the maximum cell bottom will be used to calculate the saturation used to calculate the horizontal conductance between cells. This option is intended to prevent flow from leaving a dry cell and is based on~cite{painter2008robust}. This option is only applied when the Newton-Raphson formulation is used, A warning will be issued if this option is specified and the Newton-Raphson formulation is not specified in the GWF name file. This option, in combination with the AMT-HMK ALTERNATIVE_CELL_AVERAGING option, can be used to calculate the same horizontal conductance as MODFLOW-USG when upstream weighting is used (LAYCON=4)." +optional = true + +[blocks.options.fields.save_specific_discharge] +type = "keyword" +longname = "keyword to save specific discharge" +description = "keyword to indicate that x, y, and z components of specific discharge will be calculated at cell centers and written to the budget file, which is specified with 'BUDGET SAVE FILE' in Output Control. If this option is activated, then additional information may be required in the discretization packages and the GWF Exchange package (if GWF models are coupled). Specifically, ANGLDEGX must be specified in the CONNECTIONDATA block of the DISU Package; ANGLDEGX must also be specified for the GWF Exchange as an auxiliary variable." +optional = true + +[blocks.options.fields.save_saturation] +type = "keyword" +longname = "keyword to save saturation" +description = "keyword to indicate that cell saturation will be written to the budget file, which is specified with 'BUDGET SAVE FILE' in Output Control. Saturation will be saved to the budget file as an auxiliary variable saved with the DATA-SAT text label. Saturation is a cell variable that ranges from zero to one and can be used by post processing programs to determine how much of a cell volume is saturated. If ICELLTYPE is 0, then saturation is always one." +optional = true + +[blocks.options.fields.k22overk] +type = "keyword" +longname = "keyword to indicate that specified K22 is a ratio" +description = "keyword to indicate that specified K22 is a ratio of K22 divided by K. If this option is specified, then the K22 array entered in the NPF Package will be multiplied by K after being read." +optional = true + +[blocks.options.fields.k33overk] +type = "keyword" +longname = "keyword to indicate that specified K33 is a ratio" +description = "keyword to indicate that specified K33 is a ratio of K33 divided by K. If this option is specified, then the K33 array entered in the NPF Package will be multiplied by K after being read." +optional = true + +[blocks.options.fields.tvk_filerecord] +type = "record" +optional = true + +[blocks.options.fields.tvk_filerecord.fields.tvk6] +type = "keyword" +longname = "tvk keyword" +description = "keyword to specify that record corresponds to a time-varying hydraulic conductivity (TVK) file. The behavior of TVK and a description of the input file is provided separately." + +[blocks.options.fields.tvk_filerecord.fields.tvk6_filename] +type = "file" +longname = "file name of TVK information" +description = "defines a time-varying hydraulic conductivity (TVK) input file. Records in the TVK file can be used to change hydraulic conductivity properties at specified times or stress periods." +tagged = false +direction = "in" +component = "utl-tvk" + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.options.fields.dev_no_newton] +type = "keyword" +longname = "turn off Newton for unconfined cells" +description = "turn off Newton for unconfined cells" +optional = true +developmode = true + +[blocks.options.fields.dev_omega] +type = "double" +longname = "set saturation omega value" +description = "set saturation omega value" +optional = true +developmode = true + +[blocks.griddata.fields.icelltype] +type = "array" +longname = "confined or convertible indicator" +description = "flag for each cell that specifies how saturated thickness is treated. 0 means saturated thickness is held constant; $>$0 means saturated thickness varies with computed head when head is below the cell top; $<$0 means saturated thickness varies with computed head unless the THICKSTRT option is in effect. When THICKSTRT is in effect, a negative value for ICELLTYPE indicates that the saturated thickness value used in conductance calculations in the NPF Package will be computed as STRT-BOT and held constant. If the THICKSTRT option is not in effect, then negative values provided by the user for ICELLTYPE are automatically reassigned by the program to a value of one." +optional = true +default = 0 +netcdf = true +dtype = "integer" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.k] +type = "array" +longname = "hydraulic conductivity (L/T)" +description = "is the hydraulic conductivity. For the common case in which the user would like to specify the horizontal hydraulic conductivity and the vertical hydraulic conductivity, then K should be assigned as the horizontal hydraulic conductivity, K33 should be assigned as the vertical hydraulic conductivity, and K22 and the three rotation angles should not be specified. When more sophisticated anisotropy is required, then K corresponds to the K11 hydraulic conductivity axis. All included cells (IDOMAIN $>$ 0) must have a K value greater than zero." +optional = true +default = 1.0 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.k22] +type = "array" +longname = "hydraulic conductivity of second ellipsoid axis" +description = "is the hydraulic conductivity of the second ellipsoid axis (or the ratio of K22/K if the K22OVERK option is specified); for an unrotated case this is the hydraulic conductivity in the y direction. If K22 is not included in the GRIDDATA block, then K22 is set equal to K. For a regular MODFLOW grid (DIS Package is used) in which no rotation angles are specified, K22 is the hydraulic conductivity along columns in the y direction. For an unstructured DISU grid, the user must assign principal x and y axes and provide the angle for each cell face relative to the assigned x direction. All included cells (IDOMAIN $>$ 0) must have a K22 value greater than zero." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.k33] +type = "array" +longname = "hydraulic conductivity of third ellipsoid axis (L/T)" +description = "is the hydraulic conductivity of the third ellipsoid axis (or the ratio of K33/K if the K33OVERK option is specified); for an unrotated case, this is the vertical hydraulic conductivity. When anisotropy is applied, K33 corresponds to the K33 tensor component. All included cells (IDOMAIN $>$ 0) must have a K33 value greater than zero." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.angle1] +type = "array" +longname = "first anisotropy rotation angle (degrees)" +description = "is a rotation angle of the hydraulic conductivity tensor in degrees. The angle represents the first of three sequential rotations of the hydraulic conductivity ellipsoid. With the K11, K22, and K33 axes of the ellipsoid initially aligned with the x, y, and z coordinate axes, respectively, ANGLE1 rotates the ellipsoid about its K33 axis (within the x - y plane). A positive value represents counter-clockwise rotation when viewed from any point on the positive K33 axis, looking toward the center of the ellipsoid. A value of zero indicates that the K11 axis lies within the x - z plane. If ANGLE1 is not specified, default values of zero are assigned to ANGLE1, ANGLE2, and ANGLE3, in which case the K11, K22, and K33 axes are aligned with the x, y, and z axes, respectively." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.angle2] +type = "array" +longname = "second anisotropy rotation angle (degrees)" +description = "is a rotation angle of the hydraulic conductivity tensor in degrees. The angle represents the second of three sequential rotations of the hydraulic conductivity ellipsoid. Following the rotation by ANGLE1 described above, ANGLE2 rotates the ellipsoid about its K22 axis (out of the x - y plane). An array can be specified for ANGLE2 only if ANGLE1 is also specified. A positive value of ANGLE2 represents clockwise rotation when viewed from any point on the positive K22 axis, looking toward the center of the ellipsoid. A value of zero indicates that the K11 axis lies within the x - y plane. If ANGLE2 is not specified, default values of zero are assigned to ANGLE2 and ANGLE3; connections that are not user-designated as vertical are assumed to be strictly horizontal (that is, to have no z component to their orientation); and connection lengths are based on horizontal distances." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.angle3] +type = "array" +longname = "third anisotropy rotation angle (degrees)" +description = "is a rotation angle of the hydraulic conductivity tensor in degrees. The angle represents the third of three sequential rotations of the hydraulic conductivity ellipsoid. Following the rotations by ANGLE1 and ANGLE2 described above, ANGLE3 rotates the ellipsoid about its K11 axis. An array can be specified for ANGLE3 only if ANGLE1 and ANGLE2 are also specified. An array must be specified for ANGLE3 if ANGLE2 is specified. A positive value of ANGLE3 represents clockwise rotation when viewed from any point on the positive K11 axis, looking toward the center of the ellipsoid. A value of zero indicates that the K22 axis lies within the x - y plane." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.wetdry] +type = "array" +longname = "wetdry threshold and factor" +description = "is a combination of the wetting threshold and a flag to indicate which neighboring cells can cause a cell to become wet. If WETDRY $<$ 0, only a cell below a dry cell can cause the cell to become wet. If WETDRY $>$ 0, the cell below a dry cell and horizontally adjacent cells can cause a cell to become wet. If WETDRY is 0, the cell cannot be wetted. The absolute value of WETDRY is the wetting threshold. When the sum of BOT and the absolute value of WETDRY at a dry cell is equaled or exceeded by the head at an adjacent cell, the cell is wetted. WETDRY must be specified if 'REWET' is specified in the OPTIONS block. If 'REWET' is not specified in the options block, then WETDRY can be entered, and memory will be allocated for it, even though it is not used." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.cellavg] +set_in = "ar" +source = "alternative_cell_averaging" +type = "string" + +[memory.ithickstrt] +set_in = "ar" +source = "thickstrt" +type = "integer" + +[memory.ivarcv] +set_in = "ar" +source = "variablecv" +type = "integer" + +[memory.idewatcv] +set_in = "ar" +source = "dewatered" +type = "integer" + +[memory.iperched] +set_in = "ar" +source = "perched" +type = "integer" + +[memory.irewet] +set_in = "ar" +source = "rewet" +type = "integer" + +[memory.ixt3d] +set_in = "ar" +source = "xt3d" +type = "integer" + +[memory.ixt3drhs] +set_in = "ar" +source = "rhs" +type = "integer" + +[memory.ihighcellsat] +set_in = "ar" +source = "highest_cell_saturation" +type = "integer" + +[memory.isavspdis] +set_in = "ar" +source = "save_specific_discharge" +type = "integer" + +[memory.isavsat] +set_in = "ar" +source = "save_saturation" +type = "integer" + +[memory.ik22overk] +set_in = "ar" +source = "k22overk" +type = "integer" + +[memory.ik33overk] +set_in = "ar" +source = "k33overk" +type = "integer" + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.inewton] +set_in = "ar" +source = "dev_no_newton" +type = "integer" + +[memory.satomega] +set_in = "ar" +source = "dev_omega" +type = "double" + +[memory.icelltype] +type = "array" +set_in = "ar" +source = "icelltype" +dtype = "integer" +shape = [ + "nodes", +] + +[memory.k22] +type = "array" +set_in = "ar" +source = "k22" +dtype = "double" +shape = [ + "nodes", +] + +[memory.k33] +type = "array" +set_in = "ar" +source = "k33" +dtype = "double" +shape = [ + "nodes", +] + +[memory.angle1] +type = "array" +set_in = "ar" +source = "angle1" +dtype = "double" +shape = [ + "nodes", +] + +[memory.angle2] +type = "array" +set_in = "ar" +source = "angle2" +dtype = "double" +shape = [ + "nodes", +] + +[memory.angle3] +type = "array" +set_in = "ar" +source = "angle3" +dtype = "double" +shape = [ + "nodes", +] + +[memory.wetdry] +type = "array" +set_in = "ar" +source = "wetdry" +dtype = "double" +shape = [ + "nodes", +] + +[memory.k11] +type = "array" +source = "k" +description = "Hydraulic conductivity along the major (K11) axis. Loaded from the K griddata field. Used directly when XT3D is active; otherwise feeds into CONDSAT. Recomputed each time step when TVK is active." +dtype = "double" +set_in = [ + "ar", + "ad", +] +shape = [ + "nodes", +] + +[memory.condsat] +type = "array" +description = "Saturated intercell conductance. Computed once during AR from hydraulic conductivity and cell geometry. Recomputed each time step when TVK or VSC is active. Inoperative under XT3D." +dtype = "double" +set_in = [ + "ar", + "ad", +] +source = [ + "k11", + "k22", + "k33", +] +shape = [ + "njas", +] + +[memory.sat] +type = "array" +readonly = true +set_in = "fc" +description = "Cell saturation (0-1). Recomputed each solver iteration." +dtype = "double" +shape = [ + "nodes", +] diff --git a/flopy4/mf6/dfns/gwf-oc.toml b/flopy4/mf6/dfns/gwf-oc.toml new file mode 100644 index 000000000..bfe8fbc4e --- /dev/null +++ b/flopy4/mf6/dfns/gwf-oc.toml @@ -0,0 +1,207 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-oc" +parent = "gwf-nam" +ftype = "OC6" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information. Data are written to this file only for time steps in which SAVE BUDGET is specified in a PERIOD block. If SAVE BUDGET is specified in a PERIOD block and this file is not specified, MODFLOW 6 will terminate with an error." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. If specified, a budget summary record will be written to this file for every time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.head_filerecord] +type = "record" +optional = true + +[blocks.options.fields.head_filerecord.fields.head] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to head." + +[blocks.options.fields.head_filerecord.fields.headfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write head information." +tagged = false +direction = "out" + +[blocks.options.fields.headprintrecord] +type = "record" +optional = true + +[blocks.options.fields.headprintrecord.fields.head] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to head." + +[blocks.options.fields.headprintrecord.fields.print_format] +type = "keyword" +longname = "keyword to indicate that a print format follows" +description = "keyword to specify format for printing to the listing file." + +[blocks.options.fields.headprintrecord.fields.formatrecord] +type = "record" + +[blocks.options.fields.headprintrecord.fields.formatrecord.fields.columns] +type = "integer" +longname = "number of columns" +description = "number of columns for writing data." +optional = true + +[blocks.options.fields.headprintrecord.fields.formatrecord.fields.width] +type = "integer" +longname = "width for each number" +description = "width for writing each number." +optional = true + +[blocks.options.fields.headprintrecord.fields.formatrecord.fields.digits] +type = "integer" +longname = "number of digits" +description = "number of digits to use for writing a number." +optional = true + +[blocks.options.fields.headprintrecord.fields.formatrecord.fields.format] +type = "string" +longname = "write format" +description = "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC." +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" +optional = true + +[blocks.period.fields.stress_period_data.item] +name = "output_record" +type = "union" + +[blocks.period.fields.stress_period_data.item.arms.saverecord] +type = "record" +optional = true + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.save] +type = "keyword" +longname = "keyword to save" +description = "keyword to indicate that information will be saved this stress period." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.rtype] +type = "string" +longname = "record type" +description = "type of information to save or print. Can be BUDGET or HEAD." +tagged = false +valid = [ + "HEAD", + "BUDGET", +] + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting] +type = "union" +description = "specifies the steps for which the data will be saved." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.all] +type = "keyword" +description = "keyword to indicate save for all time steps in period." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.first] +type = "keyword" +description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.last] +type = "keyword" +description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.frequency] +type = "integer" +description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.steps] +type = "array" +description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." +dtype = "integer" +shape = [ + "<=nstp", +] + +[blocks.period.fields.stress_period_data.item.arms.printrecord] +type = "record" +optional = true + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.print] +type = "keyword" +longname = "keyword to save" +description = "keyword to indicate that information will be printed this stress period." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.rtype] +type = "string" +longname = "record type" +description = "type of information to save or print. Can be BUDGET or HEAD." +tagged = false +valid = [ + "HEAD", + "BUDGET", +] + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting] +type = "union" +description = "specifies the steps for which the data will be saved." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.all] +type = "keyword" +description = "keyword to indicate save for all time steps in period." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.first] +type = "keyword" +description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.last] +type = "keyword" +description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.frequency] +type = "integer" +description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.steps] +type = "array" +description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." +dtype = "integer" +shape = [ + "<=nstp", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true diff --git a/flopy4/mf6/dfns/gwf-rch.toml b/flopy4/mf6/dfns/gwf-rch.toml new file mode 100644 index 000000000..9883ec054 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-rch.toml @@ -0,0 +1,301 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-rch" +parent = "gwf-nam" +ftype = "RCH6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.fixed_cell] +type = "keyword" +longname = "if cell is dry do not apply recharge to underlying cell" +description = "indicates that recharge will not be reassigned to a cell underlying the cell specified in the list if the specified cell is inactive." +optional = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of recharge." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of recharge cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of recharge information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print recharge rates to listing file" +description = "keyword to indicate that the list of recharge flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save recharge to budget file" +description = "keyword to indicate that recharge flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the RCH package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RCH package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of recharge cells" +description = "integer value specifying the maximum number of recharge cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.recharge] +type = "double" +longname = "recharge rate" +description = "is the recharge flux rate ($LT^{-1}$). This rate is multiplied inside the program by the surface area of the cell to calculate the volumetric recharge rate. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each recharge. The values of auxiliary variables must be present for each recharge. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "recharge name" +description = "name of the recharge cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: recharge." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "RCH" +output = true +obs_type = "RCH" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.rch] +type = "union" + +[observations.rch.arms.cellid] +type = "cellid" +tagged = false + +[observations.rch.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwf-rcha.toml b/flopy4/mf6/dfns/gwf-rcha.toml new file mode 100644 index 000000000..83fe4d7a1 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-rcha.toml @@ -0,0 +1,314 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-rcha" +parent = "gwf-nam" +ftype = "RCH6" +multi = true +subtype = "stress" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.readasarrays] +type = "keyword" +longname = "use array-based input" +description = "indicates that array-based input will be used for the Recharge Package. This keyword must be specified to use array-based input. When READASARRAYS is specified, values must be provided for every cell within a model layer, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results." +default = true + +[blocks.options.fields.fixed_cell] +type = "keyword" +longname = "if cell is dry do not apply recharge to underlying cell" +description = "indicates that recharge will not be reassigned to a cell underlying the cell specified in the list if the specified cell is inactive." +optional = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of recharge." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of recharge information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print recharge rates to listing file" +description = "keyword to indicate that the list of recharge flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save RCHA flows to budget file" +description = "keyword to indicate that recharge flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.tas_filerecord] +type = "list" +optional = true + +[blocks.options.fields.tas_filerecord.item] +name = "tas_filerecord" +type = "record" + +[blocks.options.fields.tas_filerecord.item.fields.tas6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-array-series file." + +[blocks.options.fields.tas_filerecord.item.fields.tas6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-array series capability." +tagged = false +direction = "in" +component = "utl-tas" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the RCH package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RCH package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.period.fields.irch] +type = "array" +longname = "layer number for recharge" +description = "IRCH is the layer number that defines the layer in each vertical column where recharge is applied. If IRCH is omitted, recharge by default is applied to cells in layer 1. IRCH can only be used if READASARRAYS is specified in the OPTIONS block. If IRCH is specified, it must be specified as the first variable in the PERIOD block or MODFLOW will terminate with an error." +optional = true +netcdf = true +dtype = "integer" +index = true +shape = [ + "ncpl", +] + +[blocks.period.fields.recharge] +type = "array" +longname = "recharge rate" +description = "is the recharge flux rate ($LT^{-1}$). This rate is multiplied inside the program by the surface area of the cell to calculate the volumetric recharge rate. The recharge array may be defined by a time-array series (see the 'Using Time-Array Series in a Package' section)." +default = 0.001 +netcdf = true +dtype = "double" +time_series = true +shape = [ + "ncpl", +] + +[blocks.period.fields.aux] +type = "list" +longname = "recharge auxiliary variable iaux" +description = "is an array of values for auxiliary variable aux(iaux), where iaux is a value from 1 to naux, and aux(iaux) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then it will retain its value from the most recently specified period block. If an auxiliary variable array has never been specified, its value is zero. If the value specified here for the auxiliary variable is the same as auxmultname, then the recharge array will be multiplied by this array." +optional = true +shape = [ + "<=auxiliary", +] + +[blocks.period.fields.aux.item] +name = "aux" +type = "record" + +[blocks.period.fields.aux.item.fields.auxname] +type = "string" +longname = "auxiliary variable name" +description = "name of the auxiliary variable the following array sets; must be one of the auxiliary variables." +tagged = false +fk = "options.auxiliary" +dynamic = true + +[blocks.period.fields.aux.item.fields.aux] +type = "array" +longname = "recharge auxiliary variable iaux" +netcdf = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "ncpl", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "RCHA" +output = true +obs_type = "RCH" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.rch] +type = "union" + +[observations.rch.arms.cellid] +type = "cellid" +tagged = false + +[observations.rch.arms.boundname] +type = "string" +tagged = false diff --git a/flopy4/mf6/dfns/gwf-riv.toml b/flopy4/mf6/dfns/gwf-riv.toml new file mode 100644 index 000000000..02fd98a9f --- /dev/null +++ b/flopy4/mf6/dfns/gwf-riv.toml @@ -0,0 +1,331 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-riv" +parent = "gwf-nam" +ftype = "RIV6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of riverbed conductance." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of river cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of river information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of river flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save RIV flows to budget file" +description = "keyword to indicate that river flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the RIV package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RIV package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.mover] +type = "keyword" +description = "keyword to indicate that this instance of the River Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." +optional = true + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of rivers" +description = "integer value specifying the maximum number of rivers cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.stage] +type = "double" +longname = "river stage" +description = "is the head in the river. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.cond] +type = "double" +longname = "river conductance" +description = "is the riverbed hydraulic conductance. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.rbot] +type = "double" +longname = "river bottom elevation" +description = "is the elevation of the bottom of the riverbed. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each river. The values of auxiliary variables must be present for each river. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "river name" +description = "name of the river cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: stage, 1: cond, 2: rbot." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "RIV" +output = true +obs_type = "RIV" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "RIV-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.riv] +type = "union" + +[observations.riv.arms.cellid] +type = "cellid" +tagged = false + +[observations.riv.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" + +[keys.mover_provider] +path = "<=maxbound" +when = "mover" diff --git a/flopy4/mf6/dfns/gwf-rivg.toml b/flopy4/mf6/dfns/gwf-rivg.toml new file mode 100644 index 000000000..bb3945dcd --- /dev/null +++ b/flopy4/mf6/dfns/gwf-rivg.toml @@ -0,0 +1,333 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-rivg" +parent = "gwf-nam" +ftype = "RIV6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.readarraygrid] +type = "keyword" +longname = "use array-based grid input" +description = "indicates that array-based grid input will be used for the river package. This keyword must be specified to use array-based grid input. When READARRAYGRID is specified, values must be provided for every cell within a model grid, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results. No data cells should contain the value DNODATA (3.0E+30)." +default = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of riverbed conductance." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of river information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of river flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save RIV flows to budget file" +description = "keyword to indicate that river flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the RIV package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RIV package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.mover] +type = "keyword" +description = "keyword to indicate that this instance of the River Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of river cells in any stress period" +description = "integer value specifying the maximum number of rivers cells that will be specified for use during any stress period." +optional = true + +[blocks.period.fields.stage] +type = "array" +longname = "river stage" +description = "is the head in the river." +default = 3e+30 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.period.fields.cond] +type = "array" +longname = "river conductance" +description = "is the riverbed hydraulic conductance." +default = 3e+30 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.period.fields.rbot] +type = "array" +longname = "river bottom elevation" +description = "is the elevation of the bottom of the riverbed." +default = 3e+30 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.period.fields.aux] +type = "list" +longname = "river auxiliary variable iaux" +description = "is an array of values for auxiliary variable aux(iaux), where iaux is a value from 1 to naux, and aux(iaux) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then it will retain its value from the most recently specified period block. If an auxiliary variable array has never been specified, its value is zero. If the value specified here for the auxiliary variable is the same as auxmultname, then the conductance array will be multiplied by this array." +optional = true +shape = [ + "<=auxiliary", +] + +[blocks.period.fields.aux.item] +name = "aux" +type = "record" + +[blocks.period.fields.aux.item.fields.auxname] +type = "string" +longname = "auxiliary variable name" +description = "name of the auxiliary variable the following array sets; must be one of the auxiliary variables." +tagged = false +fk = "options.auxiliary" +dynamic = true + +[blocks.period.fields.aux.item.fields.aux] +type = "array" +longname = "river auxiliary variable iaux" +netcdf = true +tagged = false +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "RIV" +output = true +obs_type = "RIV" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "RIV-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.riv] +type = "union" + +[observations.riv.arms.cellid] +type = "cellid" +tagged = false + +[observations.riv.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" + +[keys.mover_provider] +path = "<=maxbound" +when = "mover" diff --git a/flopy4/mf6/dfns/gwf-sfr.toml b/flopy4/mf6/dfns/gwf-sfr.toml new file mode 100644 index 000000000..009fea4c9 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-sfr.toml @@ -0,0 +1,1070 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-sfr" +parent = "gwf-nam" +ftype = "SFR6" +multi = true +subtype = "advanced" + +[dims.nreaches] +value = "nreaches" + +[dims.auxiliary] +value = "len(auxiliary)" + +[runtime_dims.maxbound] +set_in = "ar" + +[blocks.options.fields.storage] +type = "keyword" +longname = "activate reach storage" +description = "keyword that activates storage contributions to the stream-flow routing package continuity equation." +optional = true + +[blocks.options.fields.ats_courant] +type = "double" +longname = "target Courant number for adaptive time stepping" +description = "real number value that defines the target Courant number submitted by the SFR Package to the adaptive time stepping (ATS) package. If ATS_COURANT is specified and the ATS Package is active, the SFR Package will compute the time step that achieves the target Courant number for the most constraining reach (the reach with the highest wave celerity-to-length ratio) and submit that time step to the ATS Package. The STORAGE option must be active when ATS_COURANT is specified. ATS_COURANT must be greater than zero. A recommended baseline value is 1.0, which targets unit Courant number; values between 0.5 and 2.0 are generally acceptable for kinematic wave routing." +optional = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of stream reach cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of stream reach information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_stage] +type = "keyword" +longname = "print calculated stages to listing file" +description = "keyword to indicate that the list of stream reach {#2} will be printed to the listing file for every stress period in which 'HEAD PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of stream reach flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save stream reach flows to budget file" +description = "keyword to indicate that stream reach flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.stage_filerecord] +type = "record" +optional = true + +[blocks.options.fields.stage_filerecord.fields.stage] +type = "keyword" +longname = "stage keyword" +description = "keyword to specify that record corresponds to stage." + +[blocks.options.fields.stage_filerecord.fields.stagefile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write stage information." +tagged = false +direction = "out" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.package_convergence_filerecord] +type = "record" +optional = true + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence] +type = "keyword" +longname = "package_convergence keyword" +description = "keyword to specify that record corresponds to the package convergence comma spaced values file." + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] +type = "file" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." +tagged = false +direction = "out" + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the SFR package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFR package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.mover] +type = "keyword" +description = "keyword to indicate that this instance of the SFR Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." +optional = true + +[blocks.options.fields.maximum_picard_iterations] +type = "integer" +longname = "SFR picard iterations" +description = "integer value that defines the maximum number of Streamflow Routing picard iterations allowed when solving for reach stages and flows as part of the GWF formulate step. Picard iterations are used to minimize differences in SFR package results between subsequent GWF picard (non-linear) iterations as a result of non-optimal reach numbering. If reaches are numbered in order, from upstream to downstream, MAXIMUM_PICARD_ITERATIONS can be set to 1 to reduce model run time. By default, MAXIMUM_PICARD_ITERATIONS is equal to 100." +optional = true + +[blocks.options.fields.maximum_iterations] +type = "integer" +longname = "SFR Newton-Raphson iterations" +description = "integer value that defines the maximum number of Streamflow Routing Newton-Raphson iterations allowed for a reach. By default, MAXIMUM_ITERATIONS is equal to 100. MAXIMUM_ITERATIONS would only need to be increased from the default value if one or more reach in a simulation has a large water budget error." +optional = true + +[blocks.options.fields.maximum_depth_change] +type = "double" +longname = "depth closure tolerance" +description = "real value that defines the depth closure tolerance. By default, MAXIMUM_DEPTH_CHANGE is equal to $1 times 10^{-5}$. The MAXIMUM_STAGE_CHANGE would only need to be increased or decreased from the default value if the water budget error for one or more reach is too small or too large, respectively." +optional = true + +[blocks.options.fields.unit_conversion] +type = "double" +longname = "conversion factor" +description = "real value that is used to convert user-specified Manning's roughness coefficients from seconds per meters$^{1/3}$ to model length and time units. A constant of 1.486 is used for flow units of cubic feet per second, and a constant of 1.0 is used for units of cubic meters per second. The constant must be multiplied by 86,400 when using time units of days in the simulation." +optional = true +deprecated = "6.4.2" + +[blocks.options.fields.length_conversion] +type = "double" +longname = "length conversion factor" +description = "real value that is used to convert user-specified Manning's roughness coefficients from meters to model length units. LENGTH_CONVERSION should be set to 3.28081, 1.0, and 100.0 when using length units (LENGTH_UNITS) of feet, meters, or centimeters in the simulation, respectively. LENGTH_CONVERSION does not need to be specified if LENGTH_UNITS are meters." +optional = true + +[blocks.options.fields.time_conversion] +type = "double" +longname = "time conversion factor" +description = "real value that is used to convert user-specified Manning's roughness coefficients from seconds to model time units. TIME_CONVERSION should be set to 1.0, 60.0, 3,600.0, 86,400.0, and 31,557,600.0 when using time units (TIME_UNITS) of seconds, minutes, hours, days, or years in the simulation, respectively. TIME_CONVERSION does not need to be specified if TIME_UNITS are seconds." +optional = true + +[blocks.options.fields.dev_storage_weight] +type = "double" +longname = "reach storage time weighting" +description = "real number value that defines the time weighting factor used to calculate the change in channel storage. DEV_STORAGE_WEIGHT must have a value between 0.5 and 1. The default DEV_STORAGE_WEIGHT value is 1, which is fully implicit and is recommended for all practical applications." +optional = true +developmode = true + +[blocks.options.fields.dev_no_check] +type = "keyword" +longname = "do not check reach geometry and parameters" +description = "keyword that deactivates the checks of reach geometry relative to the model grid and of reach parameters for reasonable values. This development option is not supported." +optional = true +developmode = true + +[blocks.options.fields.dev_no_final_check] +type = "keyword" +longname = "do not perform final convergence check" +description = "keyword that deactivates the final convergence check of the change in stream flow routing stages and flows. This development option is not supported." +optional = true +developmode = true + +[blocks.dimensions.fields.nreaches] +type = "integer" +longname = "maximum number reaches" +description = "integer value specifying the number of stream reaches. There must be NREACHES entries in the PACKAGEDATA block." + +[blocks.packagedata.fields.packagedata] +type = "list" +shape = [ + "nreaches", +] + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.ifno] +type = "integer" +longname = "reach number for this entry" +description = "integer value that defines the feature (reach) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NREACHES. Reach information must be specified for every reach or the program will terminate with an error. The program will also terminate with an error if information for a reach is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. For reaches that are not connected to an underlying GWF cell, a zero should be specified for each grid dimension. For example, for a DIS grid a CELLID of 0 0 0 should be specified. Reach-aquifer flow is not calculated for unconnected reaches. The keyword NONE can be still be specified to identify unconnected reaches for backward compatibility with previous versions of MODFLOW 6 but eventually NONE will be deprecated and will cause MODFLOW 6 to terminate with an error." +tagged = false +allow_zero = true + +[blocks.packagedata.fields.packagedata.item.fields.rlen] +type = "double" +longname = "reach length" +description = "real value that defines the reach length. RLEN must be greater than zero." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.rwid] +type = "double" +longname = "reach width" +description = "real value that defines the reach width. RWID must be greater than zero." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.rgrd] +type = "double" +longname = "stream gradient" +description = "real value that defines the stream gradient (slope) across the reach. RGRD must be greater than zero." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.rtp] +type = "double" +longname = "reach streambed top elevation" +description = "real value that defines the top elevation of the streambed of a reach." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.rbth] +type = "double" +longname = "streambed thickness" +description = "real value that defines the thickness of the reach streambed. RBTH can be any value if the reach is not connected to an underlying GWF cell. Otherwise, RBTH must be greater than zero." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.rhk] +type = "double" +longname = "reach bed hydraulic conductivity" +description = "real or character value that defines the hydraulic conductivity of the reach streambed. RHK can be any positive value if the reach is not connected to an underlying GWF cell. Otherwise, RHK must be greater than zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.packagedata.fields.packagedata.item.fields.man] +type = "double" +longname = "Manning's roughness coefficient" +description = "real or character value that defines the Manning's roughness coefficient for the reach. MAN must be greater than zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.packagedata.fields.packagedata.item.fields.ncon] +type = "integer" +longname = "number of connected reaches" +description = "integer value that defines the number of reaches connected to the reach. If a value of zero is specified for NCON an entry for IFNO is still required in the subsequent CONNECTIONDATA block." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.ustrf] +type = "double" +longname = "fraction of upstream flow" +description = "real value that defines the fraction of upstream flow from each upstream reach that is applied as upstream inflow to the reach. The sum of all USTRF values for all reaches connected to the same upstream reach must be equal to one and USTRF must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.packagedata.fields.packagedata.item.fields.ndv] +type = "integer" +longname = "number of downstream reaches" +description = "integer value that defines the number of downstream diversions for the reach." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each stream reach. The values of auxiliary variables must be present for each stream reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.packagedata.fields.packagedata.item.fields.boundname] +type = "string" +longname = "well name" +description = "name of the stream reach cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.crosssections.fields.crosssections] +type = "list" +optional = true + +[blocks.crosssections.fields.crosssections.item] +name = "crosssections" +type = "record" + +[blocks.crosssections.fields.crosssections.item.fields.ifno] +type = "integer" +longname = "reach number for this entry" +description = "integer value that defines the feature (reach) number associated with the specified cross-section table file on the line. IFNO must be greater than zero and less than or equal to NREACHES. The program will also terminate with an error if table information for a reach is specified more than once." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.crosssections.fields.crosssections.item.fields.tab6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a cross-section table file." + +[blocks.crosssections.fields.crosssections.item.fields.tab6_filename] +type = "file" +longname = "table file name" +description = "character string that defines the path and filename for the file containing cross-section table data for the reach. The TAB6_FILENAME file includes the number of entries in the file and the station elevation data in terms of the fractional width and the reach depth. Instructions for creating the TAB6_FILENAME input file are provided in SFR Reach Cross-Section Table Input File section." +tagged = false +direction = "in" +component = "utl-sfrtab" + +[blocks.connectiondata.fields.connectiondata] +type = "list" +shape = [ + "nreaches", +] + +[blocks.connectiondata.fields.connectiondata.item] +name = "connectiondata" +type = "record" + +[blocks.connectiondata.fields.connectiondata.item.fields.ifno] +type = "integer" +longname = "reach number for this entry" +description = "integer value that defines the feature (reach) number associated with the specified CONNECTIONDATA data on the line. IFNO must be greater than zero and less than or equal to NREACHES. Reach connection information must be specified for every reach or the program will terminate with an error. The program will also terminate with an error if connection information for a reach is specified more than once." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.connectiondata.fields.connectiondata.item.fields.ic] +type = "array" +longname = "connected reach numbers" +description = "integer value that defines the reach number of the reach connected to the current reach and whether it is connected to the upstream or downstream end of the reach. Negative IC numbers indicate connected reaches are connected to the downstream end of the current reach. Positive IC numbers indicate connected reaches are connected to the upstream end of the current reach. The absolute value of IC must be greater than zero and less than or equal to NREACHES. IC should not be specified when NCON is zero but must be specified otherwise." +optional = true +tagged = false +dtype = "integer" +index = "signed" +fk = "packagedata.ifno" +shape = [ + "packagedata.ncon(ifno)", +] + +[blocks.diversions.fields.diversions] +type = "list" +optional = true + +[blocks.diversions.fields.diversions.item] +name = "diversions" +type = "record" + +[blocks.diversions.fields.diversions.item.fields.ifno] +type = "integer" +longname = "reach number for this entry" +description = "integer value that defines the feature (reach) number associated with the specified DIVERSIONS data on the line. IFNO must be greater than zero and less than or equal to NREACHES. Reach diversion information must be specified for every reach with a NDV value greater than 0 or the program will terminate with an error. The program will also terminate with an error if diversion information for a given reach diversion is specified more than once." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.diversions.fields.diversions.item.fields.idv] +type = "integer" +longname = "downstream diversion number" +description = "integer value that defines the downstream diversion number for the diversion for reach IFNO. IDV must be greater than zero and less than or equal to NDV for reach IFNO." +tagged = false +index = true + +[blocks.diversions.fields.diversions.item.fields.idv.pk] +scope = "ifno" + +[blocks.diversions.fields.diversions.item.fields.iconr] +type = "integer" +longname = "downstream reach number for diversion" +description = "integer value that defines the downstream reach that will receive the diverted water. IDV must be greater than zero and less than or equal to NREACHES. Furthermore, reach ICONR must be a downstream connection for reach IFNO." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.diversions.fields.diversions.item.fields.cprior] +type = "string" +longname = "iprior code" +description = "character string value that defines the the prioritization system for the diversion, such as when insufficient water is available to meet all diversion stipulations, and is used in conjunction with the value of FLOW value specified in the STRESS_PERIOD_DATA section. Available diversion options include: (1) CPRIOR = `FRACTION', then the amount of the diversion is computed as a fraction of the streamflow leaving reach IFNO ($Q_{DS}$); in this case, 0.0 $le$ DIVFLOW $le$ 1.0. (2) CPRIOR = `EXCESS', a diversion is made only if $Q_{DS}$ for reach IFNO exceeds the value of DIVFLOW. If this occurs, then the quantity of water diverted is the excess flow ($Q_{DS} -$ DIVFLOW) and $Q_{DS}$ from reach IFNO is set equal to DIVFLOW. This represents a flood-control type of diversion, as described by Danskin and Hanson (2002). (3) CPRIOR = `THRESHOLD', then if $Q_{DS}$ in reach IFNO is less than the specified diversion flow DIVFLOW, no water is diverted from reach IFNO. If $Q_{DS}$ in reach IFNO is greater than or equal to DIVFLOW, DIVFLOW is diverted and $Q_{DS}$ is set to the remainder ($Q_{DS} -$ DIVFLOW)). This approach assumes that once flow in the stream is sufficiently low, diversions from the stream cease, and is the `priority' algorithm that originally was programmed into the STR1 Package (Prudic, 1989). (4) CPRIOR = `UPTO' -- if $Q_{DS}$ in reach IFNO is greater than or equal to the specified diversion flow DIVFLOW, $Q_{DS}$ is reduced by DIVFLOW. If $Q_{DS}$ in reach IFNO is less than DIVFLOW, DIVFLOW is set to $Q_{DS}$ and there will be no flow available for reaches connected to downstream end of reach IFNO." +tagged = false + +[blocks.initialstages.fields.initialstages] +type = "list" +optional = true +shape = [ + "nreaches", +] + +[blocks.initialstages.fields.initialstages.item] +name = "initialstages" +type = "record" + +[blocks.initialstages.fields.initialstages.item.fields.ifno] +type = "integer" +longname = "reach number for this entry" +description = "integer value that defines the feature (reach) number associated with the specified initial stage. Initial stage data must be specified for every reach or the program will terminate with an error. The program will also terminate with a error if IFNO is less than one or greater than NREACHES." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.initialstages.fields.initialstages.item.fields.initialstage] +type = "double" +longname = "initial reach stage" +description = "real value that defines the initial stage for the reach. The program will terminate with an error if INITIALSTAGE is less than the RTP value for reach IFNO defined in the PACKAGEDATA block. INITIALSTAGE data are used only if STORAGE is specified in the Options block and the first stress period is transient or for reaches defined to use the SIMPLE STATUS in the Period block." +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "perioddata" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.ifno] +type = "integer" +longname = "reach number for this entry" +description = "integer value that defines the feature (reach) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NREACHES." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting] +type = "union" +description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the SFRSETTING string include: STATUS, BEDK, MANNING, STAGE, INFLOW, RAINFALL, EVAPORATION, RUNOFF, DIVERSION, UPSTREAM_FRACTION, and AUXILIARY." + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.status] +type = "string" +longname = "reach status" +description = "keyword option to define stream reach status. STATUS can be ACTIVE, INACTIVE, or SIMPLE. The SIMPLE STATUS option simulates streamflow using a user-specified stage for a reach or a stage set to the top of the reach (depth = 0). In cases where the simulated leakage calculated using the specified stage exceeds the sum of inflows to the reach, the stage is set to the top of the reach and leakage is set equal to the sum of inflows. Upstream fractions should be changed using the UPSTREAM_FRACTION SFRSETTING if the status for one or more reaches is changed to ACTIVE or INACTIVE. For example, if one of two downstream connections for a reach is inactivated, the upstream fraction for the active and inactive downstream reach should be changed to 1.0 and 0.0, respectively, to ensure that the active reach receives all of the downstream outflow from the upstream reach. By default, STATUS is ACTIVE." + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.bedk] +type = "double" +longname = "reach bed hydraulic conductivity" +description = "real or character value that defines the hydraulic conductivity of the reach streambed. BEDK can be any positive value if the reach is not connected to an underlying GWF cell. Otherwise, BEDK must be greater than zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.manning] +type = "double" +longname = "reach Manning's roughness coefficient" +description = "real or character value that defines the Manning's roughness coefficient for the reach. MANNING must be greater than zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.stage] +type = "double" +longname = "reach stage" +description = "real or character value that defines the stage for the reach. The specified STAGE is only applied if the reach uses the simple routing option. If STAGE is not specified for reaches that use the simple routing option, the specified stage is set to the top of the reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.inflow] +type = "double" +longname = "inflow rate" +description = "real or character value that defines the volumetric inflow rate for the streamflow routing reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, inflow rates are zero for each reach." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.rainfall] +type = "double" +longname = "rainfall rate" +description = "real or character value that defines the volumetric rate per unit area of water added by precipitation directly on the streamflow routing reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, rainfall rates are zero for each reach." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.evaporation] +type = "double" +longname = "evaporation rate" +description = "real or character value that defines the volumetric rate per unit area of water subtracted by evaporation from the streamflow routing reach. A positive evaporation rate should be provided. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. If the volumetric evaporation rate for a reach exceeds the sources of water to the reach (upstream and specified inflows, rainfall, and runoff but excluding groundwater leakage into the reach) the volumetric evaporation rate is limited to the sources of water to the reach. By default, evaporation rates are zero for each reach." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.runoff] +type = "double" +longname = "runoff rate" +description = "real or character value that defines the volumetric rate of diffuse overland runoff that enters the streamflow routing reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. If the volumetric runoff rate for a reach is negative and exceeds inflows to the reach (upstream and specified inflows, and rainfall but excluding groundwater leakage into the reach) the volumetric runoff rate is limited to inflows to the reach and the volumetric evaporation rate for the reach is set to zero. By default, runoff rates are zero for each reach." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.diversionrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.diversionrecord.fields.diversion] +type = "keyword" +longname = "diversion keyword" +description = "keyword to indicate diversion record." + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.diversionrecord.fields.idv] +type = "integer" +longname = "diversion number" +description = "an integer value specifying which diversion of reach IFNO that DIVFLOW is being specified for. Must be less or equal to ndv for the current reach (IFNO)." +tagged = false +index = true + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.diversionrecord.fields.idv.fk] +path = "diversions.idv" +scope = "ifno" + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.diversionrecord.fields.divflow] +type = "double" +longname = "volumetric diversion flow rate" +description = "real or character value that defines the volumetric diversion (DIVFLOW) rate for the streamflow routing reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.upstream_fraction] +type = "double" +longname = "fraction of upstream flow" +description = "real value that defines the fraction of upstream flow (USTRF) from each upstream reach that is applied as upstream inflow to the reach. The sum of all USTRF values for all reaches connected to the same upstream reach must be equal to one." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.cross_sectionrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.cross_sectionrecord.fields.cross_section] +type = "keyword" +longname = "cross_section keyword" +description = "keyword to specify that record corresponds to a reach cross-section." + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.cross_sectionrecord.fields.tab6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a cross-section table file." + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.cross_sectionrecord.fields.tab6_filename] +type = "file" +longname = "table file name" +description = "character string that defines the path and filename for the file containing cross-section table data for the reach. The TAB6_FILENAME file includes the number of entries in the file and the station elevation data in terms of the fractional width and the reach depth. Instructions for creating the TAB6_FILENAME input file are provided in SFR Reach Cross-Section Table Input File section." +tagged = false +direction = "in" +component = "utl-sfrtab" + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.auxiliaryrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.auxiliaryrecord.fields.auxiliary] +type = "keyword" +description = "keyword for specifying auxiliary variable." + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.auxiliaryrecord.fields.auxname] +type = "string" +description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.auxiliaryrecord.fields.auxval] +type = "double" +longname = "auxiliary variable value" +description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.options_stage] +set_in = "ar" +source = "stage" +type = "logical" + +[memory.pkgconv] +set_in = "ar" +source = "package_convergence" +type = "logical" + +[memory.pkgconvfname] +set_in = "ar" +source = "package_convergence_filename" +type = "string" + +[memory.options_filein] +set_in = "ar" +type = "logical" + +[memory.maxsfrpicard] +set_in = "ar" +source = "maximum_picard_iterations" +type = "integer" + +[memory.maxsfrit] +set_in = "ar" +source = "maximum_iterations" +type = "integer" + +[memory.dmaxchg] +set_in = "ar" +source = "maximum_depth_change" +type = "double" + +[memory.lengthconv] +set_in = "ar" +source = "length_conversion" +type = "double" + +[memory.storage_weight] +set_in = "ar" +source = "dev_storage_weight" +type = "double" + +[memory.icheck] +set_in = "ar" +source = "dev_no_check" +type = "integer" + +[memory.iconvchk] +set_in = "ar" +source = "dev_no_final_check" +type = "integer" + +[memory.maxbound] +set_in = "ar" +source = "nreaches" +type = "integer" + +[memory.packagedata_ifno] +set_in = "ar" +source = "ifno" +type = "integer" + +[memory.crosssect_ifno] +source = "ifno" +type = "integer" + +[memory.xs_tab6] +source = "tab6" +type = "logical" + +[memory.xs_filein] +type = "logical" + +[memory.sfrtab6_filename] +source = "tab6_filename" +type = "string" + +[memory.conndata_ifno] +source = "ifno" +type = "integer" + +[memory.diversions_ifno] +source = "ifno" +type = "integer" + +[memory.diversions_idv] +source = "idv" +type = "integer" + +[memory.initstage_ifno] +source = "ifno" +type = "integer" + +[memory.upstream_frac] +set_in = "ad" +source = "upstream_fraction" +type = "double" + +[memory.period_auxiliary] +set_in = "rp" +source = "auxiliary" +type = "logical" + +[memory.length] +type = "array" +set_in = "ar" +source = "rlen" +description = "Reach length (L)." +dtype = "double" +shape = [ + "maxbound", +] + +[memory.width] +type = "array" +set_in = "ar" +source = "rwid" +description = "Reach width (L)." +dtype = "double" +shape = [ + "maxbound", +] + +[memory.slope] +type = "array" +set_in = "ar" +source = "rgrd" +description = "Reach gradient (dimensionless)." +dtype = "double" +shape = [ + "maxbound", +] + +[memory.strtop] +type = "array" +set_in = "ar" +source = "rtp" +description = "Top elevation of the reach streambed (L)." +dtype = "double" +shape = [ + "maxbound", +] + +[memory.bthick] +type = "array" +set_in = "ar" +source = "rbth" +description = "Thickness of the reach streambed (L)." +dtype = "double" +shape = [ + "maxbound", +] + +[memory.hk] +type = "array" +set_in = "ar" +source = "rhk" +description = "Hydraulic conductivity of the reach streambed (L/T)." +dtype = "double" +shape = [ + "maxbound", +] + +[memory.rough] +type = "array" +set_in = "ar" +source = "man" +description = "Manning's roughness coefficient." +dtype = "double" +shape = [ + "maxbound", +] + +[memory.nconnreach] +type = "array" +readonly = true +set_in = "ar" +source = "ncon" +description = "Number of connections for each reach." +dtype = "integer" +shape = [ + "maxbound", +] + +[memory.ustrf] +type = "array" +set_in = "ar" +source = "ustrf" +description = "Upstream fraction of flow for each reach." +dtype = "double" +shape = [ + "maxbound", +] + +[memory.ndiv] +type = "array" +readonly = true +set_in = "ar" +source = "ndv" +description = "Number of diversions for each reach." +dtype = "integer" +shape = [ + "maxbound", +] + +[observations.stage] +type = "union" + +[observations.stage.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.stage.arms.boundname] +type = "string" +tagged = false + +[observations.ext-inflow] +type = "union" + +[observations.ext-inflow.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.ext-inflow.arms.boundname] +type = "string" +tagged = false + +[observations.inflow] +type = "union" + +[observations.inflow.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.inflow.arms.boundname] +type = "string" +tagged = false + +[observations.from-mvr] +type = "union" + +[observations.from-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.from-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.rainfall] +type = "union" + +[observations.rainfall.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.rainfall.arms.boundname] +type = "string" +tagged = false + +[observations.runoff] +type = "union" + +[observations.runoff.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.runoff.arms.boundname] +type = "string" +tagged = false + +[observations.sfr] +type = "union" + +[observations.sfr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.sfr.arms.boundname] +type = "string" +tagged = false + +[observations.evaporation] +type = "union" + +[observations.evaporation.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.evaporation.arms.boundname] +type = "string" +tagged = false + +[observations.outflow] +type = "union" + +[observations.outflow.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.outflow.arms.boundname] +type = "string" +tagged = false + +[observations.ext-outflow] +type = "union" + +[observations.ext-outflow.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.ext-outflow.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.upstream-flow] +type = "union" + +[observations.upstream-flow.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.upstream-flow.arms.boundname] +type = "string" +tagged = false + +[observations.downstream-flow] +type = "union" + +[observations.downstream-flow.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.downstream-flow.arms.boundname] +type = "string" +tagged = false + +[observations.depth] +type = "union" + +[observations.depth.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.depth.arms.boundname] +type = "string" +tagged = false + +[observations.wet-perimeter] +type = "union" + +[observations.wet-perimeter.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.wet-perimeter.arms.boundname] +type = "string" +tagged = false + +[observations.wet-area] +type = "union" + +[observations.wet-area.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.wet-area.arms.boundname] +type = "string" +tagged = false + +[observations.wet-width] +type = "union" + +[observations.wet-width.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.wet-width.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "packagedata.ifno" + +[keys.mover_provider] +path = "packagedata.ifno" +when = "mover" + +[keys.mover_receiver] +path = "packagedata.ifno" +when = "mover" diff --git a/flopy4/mf6/dfns/gwf-sto.toml b/flopy4/mf6/dfns/gwf-sto.toml new file mode 100644 index 000000000..082068f33 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-sto.toml @@ -0,0 +1,188 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-sto" +parent = "gwf-nam" +ftype = "STO6" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "keyword to save NPF flows" +description = "keyword to indicate that cell-by-cell flow terms will be written to the file specified with 'BUDGET SAVE FILE' in Output Control." +optional = true + +[blocks.options.fields.storagecoefficient] +type = "keyword" +longname = "keyword to indicate SS is read as storage coefficient" +description = "keyword to indicate that the SS array is read as storage coefficient rather than specific storage." +optional = true + +[blocks.options.fields.ss_confined_only] +type = "keyword" +longname = "keyword to indicate specific storage only applied under confined conditions" +description = "keyword to indicate that compressible storage is only calculated for a convertible cell (ICONVERT>0) when the cell is under confined conditions (head greater than or equal to the top of the cell). This option has no effect on cells that are marked as being always confined (ICONVERT=0). This option is identical to the approach used to calculate storage changes under confined conditions in MODFLOW-2005." +optional = true + +[blocks.options.fields.tvs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.tvs_filerecord.fields.tvs6] +type = "keyword" +longname = "tvs keyword" +description = "keyword to specify that record corresponds to a time-varying storage (TVS) file. The behavior of TVS and a description of the input file is provided separately." + +[blocks.options.fields.tvs_filerecord.fields.tvs6_filename] +type = "file" +longname = "file name of TVS information" +description = "defines a time-varying storage (TVS) input file. Records in the TVS file can be used to change specific storage and specific yield properties at specified times or stress periods." +tagged = false +direction = "in" +component = "utl-tvs" + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input grid arrays, which already support the layered keyword, should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.options.fields.dev_original_specific_storage] +type = "keyword" +longname = "development option for original specific storage" +description = "flag indicating the original storage specific storage formulation should be used" +optional = true +developmode = true + +[blocks.options.fields.dev_oldstorageformulation] +type = "keyword" +longname = "development option flag for old storage formulation" +description = "development option flag for old storage formulation" +optional = true +developmode = true + +[blocks.griddata.fields.iconvert] +type = "array" +longname = "convertible indicator" +description = "is a flag for each cell that specifies whether or not a cell is convertible for the storage calculation. 0 indicates confined storage is used. $>$0 indicates confined storage is used when head is above cell top and a mixed formulation of unconfined and confined storage is used when head is below cell top." +default = 0 +netcdf = true +dtype = "integer" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.ss] +type = "array" +longname = "specific storage" +description = "is specific storage (or the storage coefficient if STORAGECOEFFICIENT is specified as an option). Specific storage values must be greater than or equal to 0. If the CSUB Package is included in the GWF model, specific storage must be zero for every cell." +default = 1e-05 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.sy] +type = "array" +longname = "specific yield" +description = "is specific yield. Specific yield values must be greater than or equal to 0. Specific yield does not have to be specified if there are no convertible cells (ICONVERT=0 in every cell)." +default = 0.15 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.period.fields.stress_period_data] +type = "string" +longname = "storage state" +description = "keyword to indicate that stress period IPER is steady-state. Steady-state conditions will apply until the TRANSIENT keyword is specified in a subsequent BEGIN PERIOD block. If the CSUB Package is included in the GWF model, only the first and last stress period can be steady-state." +optional = true +tagged = false +valid = [ + "steady-state", + "transient", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.istor_coef] +set_in = "ar" +source = "storagecoefficient" +type = "integer" + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.iorig_ss] +set_in = "ar" +source = "dev_original_specific_storage" +type = "integer" + +[memory.iconf_ss] +set_in = "ar" +source = "dev_oldstorageformulation" +type = "integer" + +[memory.steady_state] +set_in = "rp" +type = "logical" + +[memory.iconvert] +type = "array" +set_in = "ar" +source = "iconvert" +dtype = "integer" +shape = [ + "nodes", +] + +[memory.ss] +type = "array" +set_in = "ar" +source = "ss" +dtype = "double" +shape = [ + "nodes", +] + +[memory.sy] +type = "array" +set_in = "ar" +source = "sy" +dtype = "double" +shape = [ + "nodes", +] diff --git a/flopy4/mf6/dfns/gwf-uzf.toml b/flopy4/mf6/dfns/gwf-uzf.toml new file mode 100644 index 000000000..188829d48 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-uzf.toml @@ -0,0 +1,611 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-uzf" +parent = "gwf-nam" +ftype = "UZF6" +multi = true +subtype = "advanced" + +[dims.nuzfcells] +value = "nuzfcells" + +[dims.ntrailwaves] +value = "ntrailwaves" + +[dims.nwavesets] +value = "nwavesets" + +[dims.auxiliary] +value = "len(auxiliary)" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of GWF cell area used by UZF cell." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of UZF cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of UZF information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of UZF flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save well flows to budget file" +description = "keyword to indicate that UZF flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.wc_filerecord] +type = "record" +optional = true + +[blocks.options.fields.wc_filerecord.fields.water_content] +type = "keyword" +longname = "water_content keyword" +description = "keyword to specify that record corresponds to unsaturated zone water contents." + +[blocks.options.fields.wc_filerecord.fields.wcfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write water content information." +tagged = false +direction = "out" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.package_convergence_filerecord] +type = "record" +optional = true + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence] +type = "keyword" +longname = "package_convergence keyword" +description = "keyword to specify that record corresponds to the package convergence comma spaced values file." + +[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] +type = "file" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." +tagged = false +direction = "out" + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the UZF package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZF package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.mover] +type = "keyword" +description = "keyword to indicate that this instance of the UZF Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." +optional = true + +[blocks.options.fields.dev_no_final_check] +type = "keyword" +longname = "do not check final convergence" +description = "keyword that deactivates the final convergence check of the change in UZF recharge. This development option is not supported." +optional = true +developmode = true + +[blocks.options.fields.simulate_et] +type = "keyword" +description = "keyword specifying that ET in the unsaturated (UZF) and saturated zones (GWF) will be simulated. ET can be simulated in the UZF cell and not the GWF cell by omitting keywords LINEAR_GWET and SQUARE_GWET." +optional = true + +[blocks.options.fields.linear_gwet] +type = "keyword" +longname = "use linear evapotranspiration" +description = "keyword specifying that groundwater ET will be simulated using the original ET formulation of MODFLOW-2005." +optional = true + +[blocks.options.fields.square_gwet] +type = "keyword" +longname = "use square evapotranspiration" +description = "keyword specifying that groundwater ET will be simulated by assuming a constant ET rate for groundwater levels between land surface (TOP) and land surface minus the ET extinction depth (TOP-EXTDP). Groundwater ET is smoothly reduced from the PET rate to zero over a nominal interval at TOP-EXTDP." +optional = true + +[blocks.options.fields.simulate_gwseep] +type = "keyword" +longname = "activate seepage" +description = "keyword specifying that groundwater discharge (GWSEEP) to land surface will be simulated. Groundwater discharge is nonzero when groundwater head is greater than land surface. This option is no longer recommended; a better approach is to use the Drain Package with discharge scaling as a way to handle seepage to land surface. The Drain Package with discharge scaling is described in Chapter 3 of the Supplemental Technical Information." +optional = true +deprecated = "6.5.0" + +[blocks.options.fields.unsat_etwc] +type = "keyword" +longname = "use PET for theta greater than extwc" +description = "keyword specifying that ET in the unsaturated zone will be simulated as a function of the specified PET rate while the water content (THETA) is greater than the ET extinction water content (EXTWC)." +optional = true + +[blocks.options.fields.unsat_etae] +type = "keyword" +longname = "use root potential" +description = "keyword specifying that ET in the unsaturated zone will be simulated using a capillary pressure based formulation. Capillary pressure is calculated using the Brooks-Corey retention function." +optional = true + +[blocks.dimensions.fields.nuzfcells] +type = "integer" +longname = "number of UZF cells" +description = "is the number of UZF cells. More than one UZF cell can be assigned to a GWF cell; however, only one GWF cell can be assigned to a single UZF cell. If more than one UZF cell is assigned to a GWF cell, then an auxiliary variable should be used to reduce the surface area of the UZF cell with the AUXMULTNAME option." + +[blocks.dimensions.fields.ntrailwaves] +type = "integer" +longname = "number of trailing waves" +description = "is the number of trailing waves. A recommended value of 7 can be used for NTRAILWAVES. This value can be increased to lower mass balance error in the unsaturated zone." +default = 7 + +[blocks.dimensions.fields.nwavesets] +type = "integer" +longname = "number of wave sets" +description = "is the number of wave sets. A recommended value of 40 can be used for NWAVESETS. This value can be increased if more waves are required to resolve variations in water content within the unsaturated zone." +default = 40 + +[blocks.packagedata.fields.packagedata] +type = "list" +shape = [ + "nuzfcells", +] + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.ifno] +type = "integer" +longname = "uzf id number for this entry" +description = "integer value that defines the feature (UZF object) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NUZFCELLS. UZF information must be specified for every UZF cell or the program will terminate with an error. The program will also terminate with an error if information for a UZF cell is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.landflag] +type = "integer" +longname = "land flag" +description = "integer value set to one for land surface cells indicating that boundary conditions can be applied and data can be specified in the PERIOD block. A value of 0 specifies a non-land surface cell." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.ivertcon] +type = "integer" +longname = "vertical connection flag" +description = "integer value set to specify underlying UZF cell that receives water flowing to bottom of cell. If unsaturated zone flow reaches the water table before the cell bottom, then water is added to the GWF cell instead of flowing to the underlying UZF cell. A value of 0 indicates the UZF cell is not connected to an underlying UZF cell." +tagged = false +index = true +fk = "packagedata.ifno" +allow_zero = true + +[blocks.packagedata.fields.packagedata.item.fields.surfdep] +type = "double" +longname = "surface depression depth" +description = "is the surface depression depth of the UZF cell." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.vks] +type = "double" +longname = "vertical saturated hydraulic conductivity" +description = "is the saturated vertical hydraulic conductivity of the UZF cell. This value is used with the Brooks-Corey function and the simulated water content to calculate the partially saturated hydraulic conductivity." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.thtr] +type = "double" +longname = "residual water content" +description = "is the residual (irreducible) water content of the UZF cell. This residual water is not available to plants and will not drain into underlying aquifer cells." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.thts] +type = "double" +longname = "saturated water content" +description = "is the saturated water content of the UZF cell. The values for saturated and residual water content should be set in a manner that is consistent with the specific yield value specified in the Storage Package. The saturated water content must be greater than the residual content." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.thti] +type = "double" +longname = "initial water content" +description = "is the initial water content of the UZF cell. The value must be greater than or equal to the residual water content and less than or equal to the saturated water content." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.eps] +type = "double" +longname = "Brooks-Corey exponent" +description = "is the exponent used in the Brooks-Corey function. The Brooks-Corey function is used by UZF to calculated hydraulic conductivity under partially saturated conditions as a function of water content and the user-specified saturated hydraulic conductivity." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.boundname] +type = "string" +longname = "well name" +description = "name of the UZF cell cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "perioddata" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.ifno] +type = "integer" +longname = "UZF id number" +description = "integer value that defines the feature (UZF object) number associated with the specified PERIOD data on the line." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.fields.finf] +type = "double" +longname = "infiltration rate" +description = "real or character value that defines the applied infiltration rate of the UZF cell ($LT^{-1}$). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.pet] +type = "double" +longname = "potential ET rate" +description = "real or character value that defines the potential evapotranspiration rate of the UZF cell and specified GWF cell. Evapotranspiration is first removed from the unsaturated zone and any remaining potential evapotranspiration is applied to the saturated zone. If IVERTCON is greater than zero then residual potential evapotranspiration not satisfied in the UZF cell is applied to the underlying UZF and GWF cells. PET is always specified, but is only used if SIMULATE_ET is specified in the OPTIONS block. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.extdp] +type = "double" +longname = "extinction depth" +description = "real or character value that defines the evapotranspiration extinction depth of the UZF cell. If IVERTCON is greater than zero and EXTDP extends below the GWF cell bottom then remaining potential evapotranspiration is applied to the underlying UZF and GWF cells. EXTDP is always specified, but is only used if SIMULATE_ET is specified in the OPTIONS block. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.extwc] +type = "double" +longname = "extinction water content" +description = "real or character value that defines the evapotranspiration extinction water content of the UZF cell. EXTWC is always specified, but is only used if SIMULATE_ET and UNSAT_ETWC are specified in the OPTIONS block. The evapotranspiration rate from the unsaturated zone will be set to zero when the calculated water content is at or less than this value. The value for EXTWC cannot be less than the residual water content, and if it is specified as being less than the residual water content it is set to the residual water content. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.ha] +type = "double" +longname = "air entry potential" +description = "real or character value that defines the air entry potential (head) of the UZF cell. HA is always specified, but is only used if SIMULATE_ET and UNSAT_ETAE are specified in the OPTIONS block. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.hroot] +type = "double" +longname = "root potential" +description = "real or character value that defines the root potential (head) of the UZF cell. HROOT is always specified, but is only used if SIMULATE_ET and UNSAT_ETAE are specified in the OPTIONS block. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.rootact] +type = "double" +longname = "root activity function" +description = "real or character value that defines the root activity function of the UZF cell. ROOTACT is the length of roots in a given volume of soil divided by that volume. Values range from 0 to about 3 $cm^{-2}$, depending on the plant community and its stage of development. ROOTACT is always specified, but is only used if SIMULATE_ET and UNSAT_ETAE are specified in the OPTIONS block. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each UZF. The values of auxiliary variables must be present for each UZF. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.pkgconv] +set_in = "ar" +source = "package_convergence" +type = "logical" + +[memory.pkgconvfname] +set_in = "ar" +source = "package_convergence_filename" +type = "string" + +[memory.iconvchk] +set_in = "ar" +source = "dev_no_final_check" +type = "integer" + +[memory.maxbound] +set_in = "ar" +source = "nuzfcells" +type = "integer" + +[memory.packagedata_ifno] +set_in = "ar" +source = "ifno" +type = "integer" + +[memory.ntrailwaves] +set_in = "ar" +source = "ntrailwaves" +type = "integer" + +[memory.nwavesets] +set_in = "ar" +source = "nwavesets" +type = "integer" + +[observations.uzf-gwrch] +type = "union" + +[observations.uzf-gwrch.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.uzf-gwrch.arms.boundname] +type = "string" +tagged = false + +[observations.uzf-gwd] +type = "union" + +[observations.uzf-gwd.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.uzf-gwd.arms.boundname] +type = "string" +tagged = false + +[observations.uzf-gwd-to-mvr] +type = "union" + +[observations.uzf-gwd-to-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.uzf-gwd-to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.uzf-gwet] +type = "union" + +[observations.uzf-gwet.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.uzf-gwet.arms.boundname] +type = "string" +tagged = false + +[observations.infiltration] +type = "union" + +[observations.infiltration.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.infiltration.arms.boundname] +type = "string" +tagged = false + +[observations.from-mvr] +type = "union" + +[observations.from-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.from-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.rej-inf] +type = "union" + +[observations.rej-inf.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.rej-inf.arms.boundname] +type = "string" +tagged = false + +[observations.rej-inf-to-mvr] +type = "union" + +[observations.rej-inf-to-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.rej-inf-to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.uzet] +type = "union" + +[observations.uzet.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.uzet.arms.boundname] +type = "string" +tagged = false + +[observations.storage] +type = "union" + +[observations.storage.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.storage.arms.boundname] +type = "string" +tagged = false + +[observations.net-infiltration] +type = "union" + +[observations.net-infiltration.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.net-infiltration.arms.boundname] +type = "string" +tagged = false + +[observations.water-content] +type = "record" + +[observations.water-content.fields.ifno] +type = "union" + +[observations.water-content.fields.ifno.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.water-content.fields.ifno.arms.boundname] +type = "string" +tagged = false + +[observations.water-content.fields.depth] +type = "double" +tagged = false + +[keys] +bound = "packagedata.ifno" + +[keys.mover_provider] +path = "packagedata.ifno" +when = "mover" + +[keys.mover_receiver] +path = "packagedata.ifno" +when = "mover" diff --git a/flopy4/mf6/dfns/gwf-vsc.toml b/flopy4/mf6/dfns/gwf-vsc.toml new file mode 100644 index 000000000..79d9d07a2 --- /dev/null +++ b/flopy4/mf6/dfns/gwf-vsc.toml @@ -0,0 +1,130 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-vsc" +parent = "gwf-nam" +ftype = "VSC6" + +[dims.nviscspecies] +value = "nviscspecies" + +[blocks.options.fields.viscref] +type = "double" +longname = "reference viscosity" +description = "fluid reference viscosity used in the equation of state. This value is set to 1.0 if not specified as an option." +optional = true +default = 1.0 + +[blocks.options.fields.temperature_species_name] +type = "string" +longname = "auxspeciesname that corresponds to temperature" +description = "string used to identify the auxspeciesname in PACKAGEDATA that corresponds to the temperature species. There can be only one occurrence of this temperature species name in the PACKAGEDATA block or the program will terminate with an error. This value has no effect if viscosity does not depend on temperature." +optional = true + +[blocks.options.fields.thermal_formulation] +type = "string" +longname = "keyword to specify viscosity formulation for the temperature species" +description = "may be used for specifying which viscosity formulation to use for the temperature species. Can be either LINEAR or NONLINEAR. The LINEAR viscosity formulation is the default." +optional = true +valid = [ + "linear", + "nonlinear", +] + +[blocks.options.fields.thermal_a2] +type = "double" +longname = "coefficient used in nonlinear viscosity function" +description = "is an empirical parameter specified by the user for calculating viscosity using a nonlinear formulation. If A2 is not specified, a default value of 10.0 is assigned (Voss, 1984)." +optional = true +default = 10.0 + +[blocks.options.fields.thermal_a3] +type = "double" +longname = "coefficient used in nonlinear viscosity function" +description = "is an empirical parameter specified by the user for calculating viscosity using a nonlinear formulation. If A3 is not specified, a default value of 248.37 is assigned (Voss, 1984)." +optional = true +default = 248.37 + +[blocks.options.fields.thermal_a4] +type = "double" +longname = "coefficient used in nonlinear viscosity function" +description = "is an empirical parameter specified by the user for calculating viscosity using a nonlinear formulation. If A4 is not specified, a default value of 133.15 is assigned (Voss, 1984)." +optional = true +default = 133.15 + +[blocks.options.fields.viscosity_filerecord] +type = "record" +optional = true + +[blocks.options.fields.viscosity_filerecord.fields.viscosity] +type = "keyword" +longname = "viscosity keyword" +description = "keyword to specify that record corresponds to viscosity." + +[blocks.options.fields.viscosity_filerecord.fields.viscosityfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write viscosity information. The viscosity file has the same format as the head file. Viscosity values will be written to the viscosity file whenever heads are written to the binary head file. The settings for controlling head output are contained in the Output Control option." +tagged = false +direction = "out" + +[blocks.dimensions.fields.nviscspecies] +type = "integer" +longname = "number of species used in viscosity equation of state" +description = "number of species used in the viscosity equation of state. If either concentrations or temperature (or both) are used to update viscosity then nviscspecies needs to be at least one." + +[blocks.packagedata.fields.packagedata] +type = "list" +shape = [ + "nviscspecies", +] + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.iviscspec] +type = "integer" +longname = "species number for this entry" +description = "integer value that defines the species number associated with the specified PACKAGEDATA data entered on each line. IVISCSPECIES must be greater than zero and less than or equal to NVISCSPECIES. Information must be specified for each of the NVISCSPECIES species or the program will terminate with an error. The program will also terminate with an error if information for a species is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.dviscdc] +type = "double" +longname = "slope of the line that defines the linear relationship between viscosity and temperature or between viscosity and concentration, depending on the type of species entered on each line." +description = "real value that defines the slope of the line defining the linear relationship between viscosity and temperature or between viscosity and concentration, depending on the type of species entered on each line. If the value of AUXSPECIESNAME entered on a line corresponds to TEMPERATURE_SPECIES_NAME (in the OPTIONS block), this value will be used when VISCOSITY_FUNC is equal to LINEAR (the default) in the OPTIONS block. When VISCOSITY_FUNC is set to NONLINEAR, a value for DVISCDC must be specified though it is not used." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.cviscref] +type = "double" +longname = "reference temperature value or reference concentration value" +description = "real value that defines the reference temperature or reference concentration value used for this species in the viscosity equation of state. If AUXSPECIESNAME entered on a line corresponds to TEMPERATURE_SPECIES_NAME (in the OPTIONS block), then CVISCREF refers to a reference temperature, otherwise it refers to a reference concentration." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.modelname] +type = "string" +longname = "modelname" +description = "name of a GWT or GWE model used to simulate a species that will be used in the viscosity equation of state. This name will have no effect if the simulation does not include a GWT or GWE model that corresponds to this GWF model." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.auxspeciesname] +type = "string" +longname = "auxspeciesname" +description = "name of an auxiliary variable in a GWF stress package that will be used for this species to calculate the viscosity values. If a viscosity value is needed by the Viscosity Package then it will use the temperature or concentration values associated with this AUXSPECIESNAME in the viscosity equation of state. For advanced stress packages (LAK, SFR, MAW, and UZF) that have an associated advanced transport package (LKT, SFT, MWT, and UZT), the FLOW_PACKAGE_AUXILIARY_NAME option in the advanced transport package can be used to transfer simulated temperature or concentration(s) into the flow package auxiliary variable. In this manner, the Viscosity Package can calculate viscosity values for lakes, streams, multi-aquifer wells, and unsaturated zone flow cells using simulated concentrations." +tagged = false + +[memory.temp_specname] +set_in = "ar" +source = "temperature_species_name" +type = "string" + +[memory.thermal_form] +set_in = "ar" +source = "thermal_formulation" +type = "string" + +[memory.nviscspecies] +set_in = "ar" +source = "nviscspecies" +type = "integer" diff --git a/flopy4/mf6/dfns/gwf-wel.toml b/flopy4/mf6/dfns/gwf-wel.toml new file mode 100644 index 000000000..cdc0bfc8c --- /dev/null +++ b/flopy4/mf6/dfns/gwf-wel.toml @@ -0,0 +1,382 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-wel" +parent = "gwf-nam" +ftype = "WEL6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of well flow rate." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of well cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of well information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of well flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save well flows to budget file" +description = "keyword to indicate that well flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.auto_flow_reduce] +type = "double" +longname = "cell fractional thickness for reduced pumping" +description = "keyword and real value that defines the fraction of the cell thickness used as an interval for smoothly adjusting negative pumping rates to 0 in cells with head values less than or equal to the bottom of the cell. Negative pumping rates are adjusted to 0 or a smaller negative value when the head in the cell is equal to or less than the calculated interval above the cell bottom. AUTO_FLOW_REDUCE is set to 0.1 if the specified value is less than or equal to zero. AUTO_FLOW_REDUCE is set to 1.0 if the specified value is greater than 1.0 and the FLOW_REDUCTION_LENGTH option is not specified (that is, the value is interpreted as a fraction of the cell thickness). By default, negative pumping rates are not reduced during a simulation. This AUTO_FLOW_REDUCE option only applies to wells in model cells that are marked as 'convertible' (ICELLTYPE /= 0) in the Node Property Flow (NPF) input file. Reduction in flow will not occur for wells in cells marked as confined (ICELLTYPE = 0)." +optional = true + +[blocks.options.fields.afrcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.afrcsv_filerecord.fields.auto_flow_reduce_csv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program." + +[blocks.options.fields.afrcsv_filerecord.fields.afrcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write information about well extraction rates that have been reduced by the program. Entries are only written if the extraction rates are reduced." +tagged = false +direction = "out" + +[blocks.options.fields.flow_reduction_length] +type = "keyword" +longname = "flow reduction length keyword" +description = "keyword that indicates the AUTO_FLOW_REDUCE value is a length instead of a fraction of the cell thickness. A warning will be issued if the FLOW_REDUCTION_LENGTH option is specified but the AUTO_FLOW_REDUCE option is not specified in the options block. The program will terminate with an error if the FLOW_REDUCTION_LENGTH option is specified and the AUTO_FLOW_REDUCE value specified in the options block is less than or equal to zero." +optional = true + +[blocks.options.fields.auto_flow_reduce_auxname] +type = "string" +longname = "name of auxiliary variable for the per-well AUTO\\_FLOW\\_REDUCE value" +description = "name of a variable listed in AUXILIARY that defines the per-well AUTO_FLOW_REDUCE value used to compute the flow reduction threshold for each well. The auxiliary variable is interpreted the same way as the global AUTO_FLOW_REDUCE value: as a length above the cell bottom when FLOW_REDUCTION_LENGTH is specified, or otherwise as a fraction of the cell thickness. When specified, the per-well auxiliary value overrides the global AUTO_FLOW_REDUCE value for that well. A warning will be issued if AUTO_FLOW_REDUCE_AUXNAME is specified but AUTO_FLOW_REDUCE is not specified in the OPTIONS block. A warning will be issued if AUTO_FLOW_REDUCE_AUXNAME is specified but FLOW_REDUCTION_LENGTH is not specified in the OPTIONS block. The program will terminate with an error if AUTO_FLOW_REDUCE_AUXNAME is specified but no AUXILIARY variables are specified, or if the named AUXILIARY variable cannot be found. The per-well value must be greater than zero and less than or equal to 1 when FLOW_REDUCTION_LENGTH is not specified, or greater than zero and less than or equal to the cell thickness when FLOW_REDUCTION_LENGTH is specified; the program will terminate with an error if a value is outside the valid range." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the WEL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the WEL package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.mover] +type = "keyword" +description = "keyword to indicate that this instance of the Well Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." +optional = true + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of wells" +description = "integer value specifying the maximum number of wells cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.q] +type = "double" +longname = "well rate" +description = "is the volumetric well rate. A positive value indicates recharge (injection) and a negative value indicates discharge (extraction). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "well name" +description = "name of the well cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.flowred] +set_in = "ar" +source = "auto_flow_reduce" +type = "double" + +[memory.afrcsv] +set_in = "ar" +source = "auto_flow_reduce_csv" +type = "logical" + +[memory.iflowredlen] +set_in = "ar" +source = "flow_reduction_length" +type = "integer" + +[memory.afrauxname] +set_in = "ar" +source = "auto_flow_reduce_auxname" +type = "string" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: q." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "WEL" +output = true +obs_type = "WEL" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "WEL-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.wel] +type = "union" + +[observations.wel.arms.cellid] +type = "cellid" +tagged = false + +[observations.wel.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.wel-reduction] +type = "union" + +[observations.wel-reduction.arms.cellid] +type = "cellid" +tagged = false + +[observations.wel-reduction.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" + +[keys.mover_provider] +path = "<=maxbound" +when = "mover" diff --git a/flopy4/mf6/dfns/gwf-welg.toml b/flopy4/mf6/dfns/gwf-welg.toml new file mode 100644 index 000000000..d1d78818b --- /dev/null +++ b/flopy4/mf6/dfns/gwf-welg.toml @@ -0,0 +1,363 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwf-welg" +parent = "gwf-nam" +ftype = "WEL6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.readarraygrid] +type = "keyword" +longname = "use array-based grid input" +description = "indicates that array-based grid input will be used for the well boundary package. This keyword must be specified to use array-based grid input. When READARRAYGRID is specified, values must be provided for every cell within a model grid, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results. No data cells should contain the value DNODATA (3.0E+30)." +default = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of well flow rate." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of well information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of well flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save well flows to budget file" +description = "keyword to indicate that well flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.auto_flow_reduce] +type = "double" +longname = "cell fractional thickness for reduced pumping" +description = "keyword and real value that defines the fraction of the cell thickness used as an interval for smoothly adjusting negative pumping rates to 0 in cells with head values less than or equal to the bottom of the cell. Negative pumping rates are adjusted to 0 or a smaller negative value when the head in the cell is equal to or less than the calculated interval above the cell bottom. AUTO_FLOW_REDUCE is set to 0.1 if the specified value is less than or equal to zero. By default, negative pumping rates are not reduced during a simulation. This AUTO_FLOW_REDUCE option only applies to wells in model cells that are marked as 'convertible' (ICELLTYPE /= 0) in the Node Property Flow (NPF) input file. Reduction in flow will not occur for wells in cells marked as confined (ICELLTYPE = 0)." +optional = true + +[blocks.options.fields.afrcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.afrcsv_filerecord.fields.auto_flow_reduce_csv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program." + +[blocks.options.fields.afrcsv_filerecord.fields.afrcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write information about well extraction rates that have been reduced by the program. Entries are only written if the extraction rates are reduced." +tagged = false +direction = "out" + +[blocks.options.fields.flow_reduction_length] +type = "keyword" +longname = "flow reduction length keyword" +description = "keyword that indicates the AUTO_FLOW_REDUCE value is a length instead of a fraction of the cell thickness. A warning will be issued if the FLOW_REDUCTION_LENGTH option is specified but the AUTO_FLOW_REDUCE option is not specified in the options block. The program will terminate with an error if the FLOW_REDUCTION_LENGTH option is specified and the AUTO_FLOW_REDUCE value specified in the options block is less than or equal to zero." +optional = true + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the WEL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the WEL package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.mover] +type = "keyword" +description = "keyword to indicate that this instance of the Well Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of wells in any stress period" +description = "integer value specifying the maximum number of wells cells that will be specified for use during any stress period." +optional = true + +[blocks.period.fields.q] +type = "array" +longname = "well rate" +description = "is the volumetric well rate. A positive value indicates recharge (injection) and a negative value indicates discharge (extraction)." +default = 3e+30 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.period.fields.aux] +type = "list" +longname = "well auxiliary variable iaux" +description = "is an array of values for auxiliary variable aux(iaux), where iaux is a value from 1 to naux, and aux(iaux) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then it will retain its value from the most recently specified period block. If an auxiliary variable array has never been specified, its value is zero. If the value specified here for the auxiliary variable is the same as auxmultname, then the well rate array will be multiplied by this array." +optional = true +shape = [ + "<=auxiliary", +] + +[blocks.period.fields.aux.item] +name = "aux" +type = "record" + +[blocks.period.fields.aux.item.fields.auxname] +type = "string" +longname = "auxiliary variable name" +description = "name of the auxiliary variable the following array sets; must be one of the auxiliary variables." +tagged = false +fk = "options.auxiliary" +dynamic = true + +[blocks.period.fields.aux.item.fields.aux] +type = "array" +longname = "well auxiliary variable iaux" +netcdf = true +tagged = false +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.flowred] +set_in = "ar" +source = "auto_flow_reduce" +type = "double" + +[memory.afrcsv] +set_in = "ar" +source = "auto_flow_reduce_csv" +type = "logical" + +[memory.iflowredlen] +set_in = "ar" +source = "flow_reduction_length" +type = "integer" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "WEL" +output = true +obs_type = "WEL" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "WEL-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.wel] +type = "union" + +[observations.wel.arms.cellid] +type = "cellid" +tagged = false + +[observations.wel.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.wel-reduction] +type = "union" + +[observations.wel-reduction.arms.cellid] +type = "cellid" +tagged = false + +[observations.wel-reduction.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" + +[keys.mover_provider] +path = "<=maxbound" +when = "mover" diff --git a/flopy4/mf6/dfns/gwt-adv.toml b/flopy4/mf6/dfns/gwt-adv.toml new file mode 100644 index 000000000..9b87594d2 --- /dev/null +++ b/flopy4/mf6/dfns/gwt-adv.toml @@ -0,0 +1,23 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-adv" +parent = "gwt-nam" +ftype = "ADV6" + +[blocks.options.fields.scheme] +type = "string" +longname = "advective scheme" +description = "scheme used to solve the advection term. Can be upstream, central, TVD or UTVD. If not specified, upstream weighting is the default weighting scheme." +optional = true +valid = [ + "central", + "upstream", + "tvd", + "utvd", +] + +[blocks.options.fields.ats_percel] +type = "double" +longname = "fractional cell distance used for time step calculation" +description = "fractional cell distance submitted by the ADV Package to the adaptive time stepping (ATS) package. If ATS_PERCEL is specified and the ATS Package is active, a time step calculation will be made for each cell based on flow through the cell and cell properties. The largest time step will be calculated such that the advective fractional cell distance (ATS_PERCEL) is not exceeded for any active cell in the grid. This time-step constraint will be submitted to the ATS Package, perhaps with constraints submitted by other packages, in the calculation of the time step. ATS_PERCEL must be greater than zero. If a value of zero is specified for ATS_PERCEL the program will automatically reset it to an internal no data value to indicate that time steps should not be subject to this constraint." +optional = true diff --git a/flopy4/mf6/dfns/gwt-api.toml b/flopy4/mf6/dfns/gwt-api.toml new file mode 100644 index 000000000..1f0bd4098 --- /dev/null +++ b/flopy4/mf6/dfns/gwt-api.toml @@ -0,0 +1,108 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-api" +parent = "gwt-nam" +ftype = "API6" +multi = true + +[dims.maxbound] +value = "maxbound" + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of api boundary cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of api boundary information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of api boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save api flows to budget file" +description = "keyword to indicate that api boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the api boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the api boundary package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.mover] +type = "keyword" +description = "keyword to indicate that this instance of the api boundary Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." +optional = true + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of user-defined api boundaries" +description = "integer value specifying the maximum number of api boundary cells that will be specified for use during any stress period." + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.maxbound] +set_in = "ar" +source = "maxbound" +type = "integer" + +[observations.api] +type = "union" + +[observations.api.arms.cellid] +type = "cellid" +tagged = false + +[observations.api.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" + +[keys.mover_provider] +path = "<=maxbound" +when = "mover" diff --git a/flopy4/mf6/dfns/gwt-cnc.toml b/flopy4/mf6/dfns/gwt-cnc.toml new file mode 100644 index 000000000..3db73f3e5 --- /dev/null +++ b/flopy4/mf6/dfns/gwt-cnc.toml @@ -0,0 +1,300 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-cnc" +parent = "gwt-nam" +ftype = "CNC6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of concentration value." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of constant concentration cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of constant concentration information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of constant concentration flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save constant concentration flows to budget file" +description = "keyword to indicate that constant concentration flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "time series keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CNC package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CNC package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of constant concentrations" +description = "integer value specifying the maximum number of constant concentrations cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.conc] +type = "double" +longname = "constant concentration value" +description = "is the constant concentration value. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each constant concentration. The values of auxiliary variables must be present for each constant concentration. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "constant concentration name" +description = "name of the constant concentration cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.tspvar] +set_in = "ad" +source = "conc" +type = "double" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: conc." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "CNC" +output = true +obs_type = "CNC" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.cnc] +type = "union" + +[observations.cnc.arms.cellid] +type = "cellid" +tagged = false + +[observations.cnc.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwt-dis.toml b/flopy4/mf6/dfns/gwt-dis.toml new file mode 100644 index 000000000..86c0a7688 --- /dev/null +++ b/flopy4/mf6/dfns/gwt-dis.toml @@ -0,0 +1,302 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-dis" +parent = "gwt-nam" +ftype = "DIS6" + +[dims.nlay] +value = "nlay" +scope = "model" + +[dims.nrow] +value = "nrow" +scope = "model" + +[dims.ncol] +value = "ncol" +scope = "model" + +[dims.ncpl] +value = "nrow * ncol" +scope = "model" + +[dims.nodes] +value = "nlay * nrow * ncol" +scope = "model" + +[dims.ncelldim] +value = "3" +scope = "model" + +[runtime_dims.nodes] +set_in = "ar" + +[runtime_dims.nodesuser] +set_in = "ar" + +[blocks.options.fields.length_units] +type = "string" +longname = "model length units" +description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." +optional = true + +[blocks.options.fields.nogrb] +type = "keyword" +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." +optional = true + +[blocks.options.fields.grb_filerecord] +type = "record" +optional = true + +[blocks.options.fields.grb_filerecord.fields.grb6] +type = "keyword" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" + +[blocks.options.fields.xorigin] +type = "double" +longname = "x-position of the model grid origin" +description = "x-position of the lower-left corner of the model grid. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.yorigin] +type = "double" +longname = "y-position of the model grid origin" +description = "y-position of the lower-left corner of the model grid. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.angrot] +type = "double" +longname = "rotation angle" +description = "counter-clockwise rotation angle (in degrees) of the lower-left corner of the model grid. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.options.fields.crs] +type = "string" +longname = "CRS user input string" +description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true +case_sensitive = true + +[blocks.options.fields.ncf_filerecord] +type = "record" +optional = true + +[blocks.options.fields.ncf_filerecord.fields.ncf6] +type = "keyword" +longname = "ncf keyword" +description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" +component = "utl-ncf" + +[blocks.dimensions.fields.nlay] +type = "integer" +longname = "number of layers" +description = "is the number of layers in the model grid." +default = 1 + +[blocks.dimensions.fields.nrow] +type = "integer" +longname = "number of rows" +description = "is the number of rows in the model grid." +default = 2 + +[blocks.dimensions.fields.ncol] +type = "integer" +longname = "number of columns" +description = "is the number of columns in the model grid." +default = 2 + +[blocks.griddata.fields.delr] +type = "array" +longname = "spacing along a row" +description = "is the column spacing in the row direction." +default = 1.0 +netcdf = true +dtype = "double" +shape = [ + "ncol", +] + +[blocks.griddata.fields.delc] +type = "array" +longname = "spacing along a column" +description = "is the row spacing in the column direction." +default = 1.0 +netcdf = true +dtype = "double" +shape = [ + "nrow", +] + +[blocks.griddata.fields.top] +type = "array" +longname = "cell top elevation" +description = "is the top elevation for each cell in the top model layer." +default = 1.0 +netcdf = true +dtype = "double" +shape = [ + "ncol", + "nrow", +] + +[blocks.griddata.fields.botm] +type = "array" +longname = "cell bottom elevation" +description = "is the bottom elevation for each cell." +default = 0.0 +netcdf = true +dtype = "double" +layered = true +shape = [ + "ncol", + "nrow", + "nlay", +] + +[blocks.griddata.fields.idomain] +type = "array" +longname = "idomain existence array" +description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." +optional = true +netcdf = true +dtype = "integer" +layered = true +shape = [ + "ncol", + "nrow", + "nlay", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.nlay] +set_in = "ar" +source = "nlay" +type = "integer" + +[memory.nrow] +set_in = "ar" +source = "nrow" +type = "integer" + +[memory.ncol] +set_in = "ar" +source = "ncol" +type = "integer" + +[memory.delr] +type = "array" +set_in = "ar" +source = "delr" +dtype = "double" +shape = [ + "ncol", +] + +[memory.delc] +type = "array" +set_in = "ar" +source = "delc" +dtype = "double" +shape = [ + "nrow", +] + +[memory.top] +type = "array" +set_in = "ar" +source = "top" +dtype = "double" +shape = [ + "ncol", + "nrow", +] + +[memory.botm] +type = "array" +set_in = "ar" +source = "botm" +dtype = "double" +shape = [ + "ncol", + "nrow", + "nlay", +] + +[memory.idomain] +type = "array" +set_in = "ar" +source = "idomain" +dtype = "integer" +shape = [ + "ncol", + "nrow", + "nlay", +] + +[memory.area] +type = "array" +readonly = true +set_in = "ar" +description = "Horizontal cell area, computed from grid geometry." +dtype = "double" +shape = [ + "ncpl", +] + +[memory.nodeuser] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodereduced] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." +dtype = "integer" +shape = [ + "nodesuser", +] diff --git a/flopy4/mf6/dfns/gwt-disu.toml b/flopy4/mf6/dfns/gwt-disu.toml new file mode 100644 index 000000000..aac2670e6 --- /dev/null +++ b/flopy4/mf6/dfns/gwt-disu.toml @@ -0,0 +1,368 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-disu" +parent = "gwt-nam" +ftype = "DISU6" + +[dims.nodes] +value = "nodes" +scope = "model" + +[dims.nja] +value = "nja" +scope = "model" + +[dims.nvert] +value = "nvert" +scope = "model" + +[dims.ncelldim] +value = "1" +scope = "model" + +[dims.njas] +value = "(nja - nodes) / 2" + +[runtime_dims.nodes] +set_in = "ar" + +[runtime_dims.nodesuser] +set_in = "ar" + +[blocks.options.fields.length_units] +type = "string" +longname = "model length units" +description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." +optional = true + +[blocks.options.fields.nogrb] +type = "keyword" +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." +optional = true + +[blocks.options.fields.grb_filerecord] +type = "record" +optional = true + +[blocks.options.fields.grb_filerecord.fields.grb6] +type = "keyword" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" + +[blocks.options.fields.xorigin] +type = "double" +longname = "x-position origin of the model grid coordinate system" +description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.yorigin] +type = "double" +longname = "y-position origin of the model grid coordinate system" +description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.angrot] +type = "double" +longname = "rotation angle" +description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.vertical_offset_tolerance] +type = "double" +longname = "vertical length dimension for top and bottom checking" +description = "checks are performed to ensure that the top of a cell is not higher than the bottom of an overlying cell. This option can be used to specify the tolerance that is used for checking. If top of a cell is above the bottom of an overlying cell by a value less than this tolerance, then the program will not terminate with an error. The default value is zero. This option should generally not be used." +optional = true +default = 0.0 + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.crs] +type = "string" +longname = "CRS user input string" +description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true +case_sensitive = true + +[blocks.dimensions.fields.nodes] +type = "integer" +longname = "number of layers" +description = "is the number of cells in the model grid." + +[blocks.dimensions.fields.nja] +type = "integer" +longname = "number of columns" +description = "is the sum of the number of connections and NODES. When calculating the total number of connections, the connection between cell n and cell m is considered to be different from the connection between cell m and cell n. Thus, NJA is equal to the total number of connections, including n to m and m to n, and the total number of cells." + +[blocks.dimensions.fields.nvert] +type = "integer" +longname = "number of vertices" +description = "is the total number of (x, y) vertex pairs used to define the plan-view shape of each cell in the model grid. If NVERT is not specified or is specified as zero, then the VERTICES and CELL2D blocks below are not read. NVERT and the accompanying VERTICES and CELL2D blocks should be specified for most simulations. If the XT3D or SAVE_SPECIFIC_DISCHARGE options are specified in the NPF Package, then this information is required." +optional = true + +[blocks.griddata.fields.top] +type = "array" +longname = "cell top elevation" +description = "is the top elevation for each cell in the model grid." +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.bot] +type = "array" +longname = "cell bottom elevation" +description = "is the bottom elevation for each cell." +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.area] +type = "array" +longname = "cell surface area" +description = "is the cell surface area (in plan view)." +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.idomain] +type = "array" +longname = "idomain existence array" +description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1 or greater, the cell exists in the simulation. IDOMAIN values of -1 cannot be specified for the DISU Package." +optional = true +dtype = "integer" +shape = [ + "nodes", +] + +[blocks.connectiondata.fields.iac] +type = "array" +longname = "number of cell connections" +description = "is the number of connections (plus 1) for each cell. The sum of all the entries in IAC must be equal to NJA." +dtype = "integer" +shape = [ + "nodes", +] + +[blocks.connectiondata.fields.ja] +type = "array" +longname = "grid connectivity" +description = "is a list of cell number (n) followed by its connecting cell numbers (m) for each of the m cells connected to cell n. The number of values to provide for cell n is IAC(n). This list is sequentially provided for the first to the last cell. The first value in the list must be cell n itself, and the remaining cells must be listed in an increasing order (sorted from lowest number to highest). Note that the cell and its connections are only supplied for the GWT cells and their connections to the other GWT cells. Also note that the JA list input may be divided such that every node and its connectivity list can be on a separate line for ease in readability of the file. To further ease readability of the file, the node number of the cell whose connectivity is subsequently listed, may be expressed as a negative number, the sign of which is subsequently converted to positive by the code." +dtype = "integer" +index = true +shape = [ + "nja", +] + +[blocks.connectiondata.fields.ihc] +type = "array" +longname = "connection type" +description = "is an index array indicating the direction between node n and all of its m connections. If IHC = 0 then cell n and cell m are connected in the vertical direction. Cell n overlies cell m if the cell number for n is less than m; cell m overlies cell n if the cell number for m is less than n. If IHC = 1 then cell n and cell m are connected in the horizontal direction. If IHC = 2 then cell n and cell m are connected in the horizontal direction, and the connection is vertically staggered. A vertically staggered connection is one in which a cell is horizontally connected to more than one cell in a horizontal connection." +dtype = "integer" +shape = [ + "nja", +] + +[blocks.connectiondata.fields.cl12] +type = "array" +longname = "connection lengths" +description = "is the array containing connection lengths between the center of cell n and the shared face with each adjacent m cell." +dtype = "double" +shape = [ + "nja", +] + +[blocks.connectiondata.fields.hwva] +type = "array" +longname = "connection lengths" +description = "is a symmetric array of size NJA. For horizontal connections, entries in HWVA are the horizontal width perpendicular to flow. For vertical connections, entries in HWVA are the vertical area for flow. Thus, values in the HWVA array contain dimensions of both length and area. Entries in the HWVA array have a one-to-one correspondence with the connections specified in the JA array. Likewise, there is a one-to-one correspondence between entries in the HWVA array and entries in the IHC array, which specifies the connection type (horizontal or vertical). Entries in the HWVA array must be symmetric; the program will terminate with an error if the value for HWVA for an n to m connection does not equal the value for HWVA for the corresponding n to m connection." +dtype = "double" +shape = [ + "nja", +] + +[blocks.connectiondata.fields.angldegx] +type = "array" +longname = "angle of face normal to connection" +description = "is the angle (in degrees) between the horizontal x-axis and the outward normal to the face between a cell and its connecting cells. The angle varies between zero and 360.0 degrees, where zero degrees points in the positive x-axis direction, and 90 degrees points in the positive y-axis direction. ANGLDEGX is only needed if horizontal anisotropy is specified in the NPF Package, if the XT3D option is used in the NPF Package, or if the SAVE_SPECIFIC_DISCHARGE option is specified in the NPF Package. ANGLDEGX does not need to be specified if these conditions are not met. ANGLDEGX is of size NJA; values specified for vertical connections and for the diagonal position are not used. Note that ANGLDEGX is read in degrees, which is different from MODFLOW-USG, which reads a similar variable (ANGLEX) in radians." +optional = true +dtype = "double" +shape = [ + "nja", +] + +[blocks.vertices.fields.vertices] +type = "list" +longname = "vertices data" +optional = true +shape = [ + "nvert", +] + +[blocks.vertices.fields.vertices.item] +name = "vertices" +type = "record" + +[blocks.vertices.fields.vertices.item.fields.iv] +type = "integer" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +tagged = false +index = true +pk = true + +[blocks.vertices.fields.vertices.item.fields.xv] +type = "double" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." +tagged = false + +[blocks.vertices.fields.vertices.item.fields.yv] +type = "double" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." +tagged = false + +[blocks.cell2d.fields.cell2d] +type = "list" +longname = "cell2d data" +optional = true +shape = [ + "nodes", +] + +[blocks.cell2d.fields.cell2d.item] +name = "cell2d" +type = "record" + +[blocks.cell2d.fields.cell2d.item.fields.icell2d] +type = "integer" +longname = "cell2d number" +description = "is the cell2d number. Records in the CELL2D block must be listed in consecutive order from 1 to NODES." +tagged = false +index = true +pk = true + +[blocks.cell2d.fields.cell2d.item.fields.xc] +type = "double" +longname = "x-coordinate for cell center" +description = "is the x-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.yc] +type = "double" +longname = "y-coordinate for cell center" +description = "is the y-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.ncvert] +type = "integer" +longname = "number of cell vertices" +description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.icvert] +type = "array" +longname = "array of vertex numbers" +description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order." +tagged = false +dtype = "integer" +index = true +shape = [ + "ncvert", +] + +[memory.voffsettol] +set_in = "ar" +source = "vertical_offset_tolerance" +type = "double" + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.nodes] +set_in = "ar" +source = "nodes" +type = "integer" + +[memory.nja] +set_in = "ar" +source = "nja" +type = "integer" + +[memory.nvert] +set_in = "ar" +source = "nvert" +type = "integer" + +[memory.top] +type = "array" +set_in = "ar" +source = "top" +dtype = "double" +shape = [ + "nodes", +] + +[memory.bot] +type = "array" +set_in = "ar" +source = "bot" +dtype = "double" +shape = [ + "nodes", +] + +[memory.area] +type = "array" +readonly = true +set_in = "ar" +description = "Horizontal cell area, computed from grid geometry." +dtype = "double" +shape = [ + "nodesuser", +] + +[memory.idomain] +type = "array" +set_in = "ar" +source = "idomain" +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodeuser] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodereduced] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." +dtype = "integer" +shape = [ + "nodesuser", +] diff --git a/flopy4/mf6/dfns/gwt-disv.toml b/flopy4/mf6/dfns/gwt-disv.toml new file mode 100644 index 000000000..adc75c519 --- /dev/null +++ b/flopy4/mf6/dfns/gwt-disv.toml @@ -0,0 +1,326 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-disv" +parent = "gwt-nam" +ftype = "DISV6" + +[dims.nlay] +value = "nlay" +scope = "model" + +[dims.ncpl] +value = "ncpl" +scope = "model" + +[dims.nvert] +value = "nvert" +scope = "model" + +[dims.nodes] +value = "nlay * ncpl" +scope = "model" + +[dims.ncelldim] +value = "2" +scope = "model" + +[runtime_dims.nodes] +set_in = "ar" + +[runtime_dims.nodesuser] +set_in = "ar" + +[blocks.options.fields.length_units] +type = "string" +longname = "model length units" +description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." +optional = true + +[blocks.options.fields.nogrb] +type = "keyword" +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." +optional = true + +[blocks.options.fields.grb_filerecord] +type = "record" +optional = true + +[blocks.options.fields.grb_filerecord.fields.grb6] +type = "keyword" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" + +[blocks.options.fields.xorigin] +type = "double" +longname = "x-position origin of the model grid coordinate system" +description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.yorigin] +type = "double" +longname = "y-position origin of the model grid coordinate system" +description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.angrot] +type = "double" +longname = "rotation angle" +description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.options.fields.crs] +type = "string" +longname = "CRS user input string" +description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true +case_sensitive = true + +[blocks.options.fields.ncf_filerecord] +type = "record" +optional = true + +[blocks.options.fields.ncf_filerecord.fields.ncf6] +type = "keyword" +longname = "ncf keyword" +description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" +component = "utl-ncf" + +[blocks.dimensions.fields.nlay] +type = "integer" +longname = "number of layers" +description = "is the number of layers in the model grid." + +[blocks.dimensions.fields.ncpl] +type = "integer" +longname = "number of cells per layer" +description = "is the number of cells per layer. This is a constant value for the grid and it applies to all layers." + +[blocks.dimensions.fields.nvert] +type = "integer" +longname = "number of vertices" +description = "is the total number of (x, y) vertex pairs used to characterize the horizontal configuration of the model grid." + +[blocks.griddata.fields.top] +type = "array" +longname = "model top elevation" +description = "is the top elevation for each cell in the top model layer." +netcdf = true +dtype = "double" +shape = [ + "ncpl", +] + +[blocks.griddata.fields.botm] +type = "array" +longname = "model bottom elevation" +description = "is the bottom elevation for each cell." +netcdf = true +dtype = "double" +layered = true +shape = [ + "ncpl", + "nlay", +] + +[blocks.griddata.fields.idomain] +type = "array" +longname = "idomain existence array" +description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." +optional = true +netcdf = true +dtype = "integer" +layered = true +shape = [ + "ncpl", + "nlay", +] + +[blocks.vertices.fields.vertices] +type = "list" +longname = "vertices data" +shape = [ + "nvert", +] + +[blocks.vertices.fields.vertices.item] +name = "vertices" +type = "record" + +[blocks.vertices.fields.vertices.item.fields.iv] +type = "integer" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +tagged = false +index = true +pk = true + +[blocks.vertices.fields.vertices.item.fields.xv] +type = "double" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." +tagged = false + +[blocks.vertices.fields.vertices.item.fields.yv] +type = "double" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." +tagged = false + +[blocks.cell2d.fields.cell2d] +type = "list" +longname = "cell2d data" +shape = [ + "ncpl", +] + +[blocks.cell2d.fields.cell2d.item] +name = "cell2d" +type = "record" + +[blocks.cell2d.fields.cell2d.item.fields.icell2d] +type = "integer" +longname = "cell2d number" +description = "is the CELL2D number. Records in the CELL2D block must be listed in consecutive order from the first to the last." +tagged = false +index = true +pk = true + +[blocks.cell2d.fields.cell2d.item.fields.xc] +type = "double" +longname = "x-coordinate for cell center" +description = "is the x-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.yc] +type = "double" +longname = "y-coordinate for cell center" +description = "is the y-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.ncvert] +type = "integer" +longname = "number of cell vertices" +description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.icvert] +type = "array" +longname = "array of vertex numbers" +description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false +dtype = "integer" +index = true +shape = [ + "ncvert", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.nlay] +set_in = "ar" +source = "nlay" +type = "integer" + +[memory.ncpl] +set_in = "ar" +source = "ncpl" +type = "integer" + +[memory.nvert] +set_in = "ar" +source = "nvert" +type = "integer" + +[memory.top] +type = "array" +set_in = "ar" +source = "top" +dtype = "double" +shape = [ + "ncpl", +] + +[memory.botm] +type = "array" +set_in = "ar" +source = "botm" +dtype = "double" +shape = [ + "ncpl", + "nlay", +] + +[memory.idomain] +type = "array" +set_in = "ar" +source = "idomain" +dtype = "integer" +shape = [ + "ncpl", + "nlay", +] + +[memory.area] +type = "array" +readonly = true +set_in = "ar" +description = "Horizontal cell area, computed from grid geometry." +dtype = "double" +shape = [ + "ncpl", +] + +[memory.nodeuser] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodereduced] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." +dtype = "integer" +shape = [ + "nodesuser", +] diff --git a/flopy4/mf6/dfns/gwt-dsp.toml b/flopy4/mf6/dfns/gwt-dsp.toml new file mode 100644 index 000000000..a0d840b0b --- /dev/null +++ b/flopy4/mf6/dfns/gwt-dsp.toml @@ -0,0 +1,168 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-dsp" +parent = "gwt-nam" +ftype = "DSP6" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.xt3d_off] +type = "keyword" +longname = "deactivate xt3d" +description = "deactivate the xt3d method and use the faster and less accurate approximation. This option may provide a fast and accurate solution under some circumstances, such as when flow aligns with the model grid, there is no mechanical dispersion, or when the longitudinal and transverse dispersivities are equal. This option may also be used to assess the computational demand of the XT3D approach by noting the run time differences with and without this option on." +optional = true + +[blocks.options.fields.xt3d_rhs] +type = "keyword" +longname = "xt3d on right-hand side" +description = "add xt3d terms to right-hand side, when possible. This option uses less memory, but may require more iterations." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.griddata.fields.diffc] +type = "array" +longname = "effective molecular diffusion coefficient" +description = "effective molecular diffusion coefficient." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.alh] +type = "array" +longname = "longitudinal dispersivity in horizontal direction" +description = "longitudinal dispersivity in horizontal direction. If flow is strictly horizontal, then this is the longitudinal dispersivity that will be used. If flow is not strictly horizontal or strictly vertical, then the longitudinal dispersivity is a function of both ALH and ALV. If mechanical dispersion is represented (by specifying any dispersivity values) then this array is required." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.alv] +type = "array" +longname = "longitudinal dispersivity in vertical direction" +description = "longitudinal dispersivity in vertical direction. If flow is strictly vertical, then this is the longitudinal dispsersivity value that will be used. If flow is not strictly horizontal or strictly vertical, then the longitudinal dispersivity is a function of both ALH and ALV. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ALH." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.ath1] +type = "array" +longname = "transverse dispersivity in horizontal direction" +description = "transverse dispersivity in horizontal direction. This is the transverse dispersivity value for the second ellipsoid axis. If flow is strictly horizontal and directed in the x direction (along a row for a regular grid), then this value controls spreading in the y direction. If mechanical dispersion is represented (by specifying any dispersivity values) then this array is required." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.ath2] +type = "array" +longname = "transverse dispersivity in horizontal direction" +description = "transverse dispersivity in horizontal direction. This is the transverse dispersivity value for the third ellipsoid axis. If flow is strictly horizontal and directed in the x direction (along a row for a regular grid), then this value controls spreading in the z direction. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ATH1." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.atv] +type = "array" +longname = "transverse dispersivity when flow is in vertical direction" +description = "transverse dispersivity when flow is in vertical direction. If flow is strictly vertical and directed in the z direction, then this value controls spreading in the x and y directions. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ATH2." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.diffc] +type = "array" +set_in = "ar" +source = "diffc" +dtype = "double" +shape = [ + "nodes", +] + +[memory.alh] +type = "array" +set_in = "ar" +source = "alh" +dtype = "double" +shape = [ + "nodes", +] + +[memory.alv] +type = "array" +set_in = "ar" +source = "alv" +dtype = "double" +shape = [ + "nodes", +] + +[memory.ath1] +type = "array" +set_in = "ar" +source = "ath1" +dtype = "double" +shape = [ + "nodes", +] + +[memory.ath2] +type = "array" +set_in = "ar" +source = "ath2" +dtype = "double" +shape = [ + "nodes", +] + +[memory.atv] +type = "array" +set_in = "ar" +source = "atv" +dtype = "double" +shape = [ + "nodes", +] diff --git a/flopy4/mf6/dfns/gwt-fmi.toml b/flopy4/mf6/dfns/gwt-fmi.toml new file mode 100644 index 000000000..58c774aad --- /dev/null +++ b/flopy4/mf6/dfns/gwt-fmi.toml @@ -0,0 +1,44 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-fmi" +parent = "gwt-nam" +ftype = "FMI6" + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save calculated flow imbalance correction to budget file" +description = "keyword to indicate that FMI flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.flow_imbalance_correction] +type = "keyword" +longname = "correct for flow imbalance" +description = "correct for an imbalance in flows by assuming that any residual flow error comes in or leaves at the concentration of the cell. When this option is activated, the GWT Model budget written to the listing file will contain two additional entries: FLOW-ERROR and FLOW-CORRECTION. These two entries will be equal but opposite in sign. The FLOW-CORRECTION term is a mass flow that is added to offset the error caused by an imprecise flow balance. If these terms are not relatively small, the flow model should be rerun with stricter convergence tolerances." +optional = true + +[blocks.packagedata.fields.packagedata] +type = "list" +longname = "flowtype list" +optional = true + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.flowtype] +type = "string" +longname = "flow type" +description = "is the word GWFBUDGET, GWFHEAD, GWFGRID, GWFMOVER or the name of an advanced GWF stress package. If GWFBUDGET is specified, then the corresponding file must be a budget file. If GWFHEAD is specified, the file must be a head file. If GWFGRID is specified, the file must be a binary grid file. If an advanced GWF stress package name appears then the corresponding file must be the budget file saved by a LAK, SFR, MAW or UZF Package." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.fname] +type = "file" +longname = "file name" +description = "is the name of the file containing flows. The path to the file should be included if the file is not located in the folder where the program was run." +tagged = false +direction = "in" + +[memory.imbalancecorrect] +set_in = "ar" +source = "flow_imbalance_correction" +type = "logical" diff --git a/flopy4/mf6/dfns/gwt-ic.toml b/flopy4/mf6/dfns/gwt-ic.toml new file mode 100644 index 000000000..576050a91 --- /dev/null +++ b/flopy4/mf6/dfns/gwt-ic.toml @@ -0,0 +1,51 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-ic" +parent = "gwt-nam" +ftype = "IC6" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.griddata.fields.strt] +type = "array" +longname = "starting concentration" +description = "is the initial (starting) concentration---that is, concentration at the beginning of the GWT Model simulation. STRT must be specified for all GWT Model simulations. One value is read for every model cell." +default = 0.0 +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.strt] +type = "array" +set_in = "ar" +source = "strt" +dtype = "double" +shape = [ + "nodes", +] diff --git a/flopy4/mf6/dfns/gwt-ist.toml b/flopy4/mf6/dfns/gwt-ist.toml new file mode 100644 index 000000000..1ff5c9436 --- /dev/null +++ b/flopy4/mf6/dfns/gwt-ist.toml @@ -0,0 +1,366 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-ist" +parent = "gwt-nam" +ftype = "IST6" +multi = true + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save calculated flows to budget file" +description = "keyword to indicate that IST flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.sorption] +type = "string" +longname = "activate sorption" +description = "is a text keyword to indicate that sorption will be activated. Valid sorption options include LINEAR, FREUNDLICH, and LANGMUIR. Use of this keyword requires that BULK_DENSITY and DISTCOEF are specified in the GRIDDATA block. If sorption is specified as FREUNDLICH or LANGMUIR then SP2 is also required in the GRIDDATA block. The sorption option must be consistent with the sorption option specified in the MST Package or the program will terminate with an error." +optional = true +valid = [ + "linear", + "freundlich", + "langmuir", +] + +[blocks.options.fields.first_order_decay] +type = "keyword" +longname = "activate first-order decay" +description = "is a text keyword to indicate that first-order decay will occur. Use of this keyword requires that DECAY and DECAY_SORBED (if sorption is active) are specified in the GRIDDATA block." +optional = true + +[blocks.options.fields.zero_order_decay] +type = "keyword" +longname = "activate zero-order decay" +description = "is a text keyword to indicate that zero-order decay will occur. Use of this keyword requires that DECAY and DECAY_SORBED (if sorption is active) are specified in the GRIDDATA block." +optional = true + +[blocks.options.fields.cim_filerecord] +type = "record" +optional = true + +[blocks.options.fields.cim_filerecord.fields.cim] +type = "keyword" +longname = "cim keyword" +description = "keyword to specify that record corresponds to immobile concentration." + +[blocks.options.fields.cim_filerecord.fields.cimfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write immobile concentrations. This file is a binary file that has the same format and structure as a binary head and concentration file. The value for the text variable written to the file is CIM. Immobile domain concentrations will be written to this file at the same interval as mobile domain concentrations are saved, as specified in the GWT Model Output Control file." +tagged = false +direction = "out" + +[blocks.options.fields.cimprintrecord] +type = "record" +optional = true + +[blocks.options.fields.cimprintrecord.fields.cim] +type = "keyword" +longname = "cim keyword" +description = "keyword to specify that record corresponds to immobile concentration." + +[blocks.options.fields.cimprintrecord.fields.print_format] +type = "keyword" +longname = "keyword to indicate that a print format follows" +description = "keyword to specify format for printing to the listing file." + +[blocks.options.fields.cimprintrecord.fields.formatrecord] +type = "record" + +[blocks.options.fields.cimprintrecord.fields.formatrecord.fields.columns] +type = "integer" +longname = "number of columns" +description = "number of columns for writing data." +optional = true + +[blocks.options.fields.cimprintrecord.fields.formatrecord.fields.width] +type = "integer" +longname = "width for each number" +description = "width for writing each number." +optional = true + +[blocks.options.fields.cimprintrecord.fields.formatrecord.fields.digits] +type = "integer" +longname = "number of digits" +description = "number of digits to use for writing a number." +optional = true + +[blocks.options.fields.cimprintrecord.fields.formatrecord.fields.format] +type = "string" +longname = "write format" +description = "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC." +tagged = false + +[blocks.options.fields.sorbate_filerecord] +type = "record" +optional = true + +[blocks.options.fields.sorbate_filerecord.fields.sorbate] +type = "keyword" +longname = "sorbate keyword" +description = "keyword to specify that record corresponds to immobile sorbate concentration." + +[blocks.options.fields.sorbate_filerecord.fields.sorbatefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write immobile sorbate concentration information. Immobile sorbate concentrations will be written whenever aqueous immobile concentrations are saved, as determined by settings in the Output Control option." +tagged = false +direction = "out" + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.griddata.fields.porosity] +type = "array" +longname = "porosity of the immobile domain" +description = "porosity of the immobile domain specified as the immobile domain pore volume per immobile domain volume." +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.volfrac] +type = "array" +longname = "volume fraction of this immobile domain" +description = "fraction of the cell volume that consists of this immobile domain. The sum of all immobile domain volume fractions must be less than one." +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.zetaim] +type = "array" +longname = "mass transfer rate coefficient between the mobile and immobile domains" +description = "mass transfer rate coefficient between the mobile and immobile domains, in dimensions of per time." +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.cim] +type = "array" +longname = "initial concentration of the immobile domain" +description = "initial concentration of the immobile domain in mass per length cubed. If CIM is not specified, then it is assumed to be zero." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.decay] +type = "array" +longname = "first rate coefficient" +description = "is the rate coefficient for first or zero-order decay for the aqueous phase of the immobile domain. A negative value indicates solute production. The dimensions of decay for first-order decay is one over time. The dimensions of decay for zero-order decay is mass per length cubed per time. Decay will have no effect on simulation results unless either first- or zero-order decay is specified in the options block." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.decay_sorbed] +type = "array" +longname = "second rate coefficient" +description = "is the rate coefficient for first or zero-order decay for the sorbed phase of the immobile domain. A negative value indicates solute production. The dimensions of decay_sorbed for first-order decay is one over time. The dimensions of decay_sorbed for zero-order decay is mass of solute per mass of aquifer per time. If decay_sorbed is not specified and both decay and sorption are active, then the program will terminate with an error. decay_sorbed will have no effect on simulation results unless the SORPTION keyword and either first- or zero-order decay are specified in the options block." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.bulk_density] +type = "array" +longname = "bulk density" +description = "is the bulk density of this immobile domain in mass per length cubed. Bulk density is defined as the immobile domain solid mass per volume of the immobile domain. bulk_density is not required unless the SORPTION keyword is specified in the options block. If the SORPTION keyword is not specified in the options block, bulk_density will have no effect on simulation results." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.distcoef] +type = "array" +longname = "distribution coefficient" +description = "is the distribution coefficient for the equilibrium-controlled linear sorption isotherm in dimensions of length cubed per mass. distcoef is not required unless the SORPTION keyword is specified in the options block. If the SORPTION keyword is not specified in the options block, distcoef will have no effect on simulation results." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.sp2] +type = "array" +longname = "second sorption parameter" +description = "is the exponent for the Freundlich isotherm and the sorption capacity for the Langmuir isotherm. sp2 is not required unless the SORPTION keyword is specified in the options block and sorption is specified as FREUNDLICH or LANGMUIR. If the SORPTION keyword is not specified in the options block, or if sorption is specified as LINEAR, sp2 will have no effect on simulation results." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[memory.order1_decay] +set_in = "ar" +source = "first_order_decay" +type = "logical" + +[memory.order0_decay] +set_in = "ar" +source = "zero_order_decay" +type = "logical" + +[memory.cimopt] +set_in = "ar" +source = "cim" +type = "logical" + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.porosity] +type = "array" +set_in = "ar" +source = "porosity" +dtype = "double" +shape = [ + "nodes", +] + +[memory.volfrac] +type = "array" +set_in = "ar" +source = "volfrac" +dtype = "double" +shape = [ + "nodes", +] + +[memory.zetaim] +type = "array" +set_in = "ar" +source = "zetaim" +dtype = "double" +shape = [ + "nodes", +] + +[memory.cim] +type = "array" +set_in = "ar" +source = "cim" +dtype = "double" +shape = [ + "nodes", +] + +[memory.decay] +type = "array" +set_in = "ar" +source = "decay" +dtype = "double" +shape = [ + "nodes", +] + +[memory.decay_sorbed] +type = "array" +set_in = "ar" +source = "decay_sorbed" +dtype = "double" +shape = [ + "nodes", +] + +[memory.bulk_density] +type = "array" +set_in = "ar" +source = "bulk_density" +dtype = "double" +shape = [ + "nodes", +] + +[memory.distcoef] +type = "array" +set_in = "ar" +source = "distcoef" +dtype = "double" +shape = [ + "nodes", +] + +[memory.sp2] +type = "array" +set_in = "ar" +source = "sp2" +dtype = "double" +shape = [ + "nodes", +] diff --git a/flopy4/mf6/dfns/gwt-lkt.toml b/flopy4/mf6/dfns/gwt-lkt.toml new file mode 100644 index 000000000..bc1e35930 --- /dev/null +++ b/flopy4/mf6/dfns/gwt-lkt.toml @@ -0,0 +1,609 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-lkt" +parent = "gwt-nam" +ftype = "LKT6" +multi = true +subtype = "advanced" + +[dims.auxiliary] +value = "len(auxiliary)" + +[runtime_dims.ncv] +set_in = "ar" + +[blocks.options.fields.flow_package_name] +type = "string" +longname = "keyword to specify name of corresponding flow package" +description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWT name file)." +optional = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.flow_package_auxiliary_name] +type = "string" +longname = "keyword to specify name of concentration auxiliary variable in flow package" +description = "keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated concentrations from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of lake cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of lake information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_concentration] +type = "keyword" +longname = "print calculated stages to listing file" +description = "keyword to indicate that the list of lake {#2} will be printed to the listing file for every stress period in which 'CONCENTRATION PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of lake flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save lake flows to budget file" +description = "keyword to indicate that lake flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.concentration_filerecord] +type = "record" +optional = true + +[blocks.options.fields.concentration_filerecord.fields.concentration] +type = "keyword" +longname = "stage keyword" +description = "keyword to specify that record corresponds to concentration." + +[blocks.options.fields.concentration_filerecord.fields.concfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write concentration information." +tagged = false +direction = "out" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the LKT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LKT package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.dev_nonexpanding_matrix] +type = "keyword" +longname = "do not add rows to the solution matrix" +description = "keyword that solves the feature concentration with a general mixing equation and adds the result to the right-hand side of the GWT equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." +optional = true +developmode = true + +[blocks.packagedata.fields.packagedata] +type = "list" + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.ifno] +type = "integer" +longname = "lake number for this entry" +description = "integer value that defines the feature (lake) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NLAKES. Lake information must be specified for every lake or the program will terminate with an error. The program will also terminate with an error if information for a lake is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.strt] +type = "double" +longname = "starting lake concentration" +description = "real value that defines the starting concentration for the lake." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.packagedata.fields.packagedata.item.fields.boundname] +type = "string" +longname = "lake name" +description = "name of the lake cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "lakeperioddata" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.ifno] +type = "integer" +longname = "lake number for this entry" +description = "integer value that defines the feature (lake) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NLAKES." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.fields.laksetting] +type = "union" +description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the LAKSETTING string include: STATUS, CONCENTRATION, RAINFALL, EVAPORATION, RUNOFF, EXT-INFLOW, and AUXILIARY. These settings are used to assign the concentration of associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms. For example, the Lake Package supports a 'WITHDRAWAL' flow term. If this withdrawal term is active, then water will be withdrawn from the lake at the calculated concentration of the lake." + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.status] +type = "string" +longname = "lake concentration status" +description = "keyword option to define lake status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that concentration will be calculated for the lake. If a lake is inactive, then there will be no solute mass fluxes into or out of the lake and the inactive value will be written for the lake concentration. If a lake is constant, then the concentration for the lake will be fixed at the user specified value." + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.concentration] +type = "double" +longname = "lake concentration" +description = "real or character value that defines the concentration for the lake. The specified CONCENTRATION is only applied if the lake is a constant concentration lake. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.rainfall] +type = "double" +longname = "rainfall concentration" +description = "real or character value that defines the rainfall solute concentration $(ML^{-3})$ for the lake. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.evaporation] +type = "double" +longname = "evaporation concentration" +description = "real or character value that defines the concentration of evaporated water $(ML^{-3})$ for the lake. If this concentration value is larger than the simulated concentration in the lake, then the evaporated water will be removed at the same concentration as the lake. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.runoff] +type = "double" +longname = "runoff concentration" +description = "real or character value that defines the concentration of runoff $(ML^{-3})$ for the lake. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.ext-inflow] +type = "double" +longname = "ext-inflow concentration" +description = "real or character value that defines the concentration of external inflow $(ML^{-3})$ for the lake. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord.fields.auxiliary] +type = "keyword" +description = "keyword for specifying auxiliary variable." + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord.fields.auxname] +type = "string" +description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord.fields.auxval] +type = "double" +longname = "auxiliary variable value" +description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.flow_pkg_name] +set_in = "ar" +source = "flow_package_name" +type = "string" + +[memory.fp_aux_name] +set_in = "ar" +source = "flow_package_auxiliary_name" +type = "string" + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprconc] +set_in = "ar" +source = "print_concentration" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.dev_nonexpanding] +set_in = "ar" +source = "dev_nonexpanding_matrix" +type = "logical" + +[memory.packagedata_ifno] +set_in = "ar" +source = "ifno" +type = "integer" + +[memory.period_auxiliary] +set_in = "rp" +source = "auxiliary" +type = "logical" + +[memory.ncv] +readonly = true +set_in = "ar" +description = "Number of control volumes. Assigned from the linked flow package during AR." +type = "integer" + +[memory.strt] +type = "array" +set_in = "ar" +source = "strt" +description = "Starting concentration for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xnewpak] +type = "array" +set_in = "ca" +description = "Current concentration for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xoldpak] +type = "array" +readonly = true +set_in = "ad" +description = "Concentration from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." +dtype = "double" +shape = [ + "ncv", +] + +[memory.ibound] +type = "array" +set_in = "ar" +description = "Boundary activity flag for each control volume." +dtype = "integer" +shape = [ + "ncv", +] + +[memory.concfeat] +type = "array" +readonly = true +set_in = "cq" +description = "Computed concentration for each feature. Set from XNEWPAK after solver convergence." +dtype = "double" +shape = [ + "ncv", +] + +[memory.qsto] +type = "array" +readonly = true +set_in = "cq" +description = "Storage concentration flow contribution for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.concrain] +type = "array" +set_in = "rp" +description = "Rainfall concentration for each lake." +dtype = "double" +shape = [ + "ncv", +] + +[memory.concevap] +type = "array" +set_in = "rp" +description = "Evaporation concentration for each lake." +dtype = "double" +shape = [ + "ncv", +] + +[memory.concroff] +type = "array" +set_in = "rp" +description = "Runoff concentration for each lake." +dtype = "double" +shape = [ + "ncv", +] + +[memory.conciflw] +type = "array" +set_in = "rp" +description = "External inflow concentration for each lake." +dtype = "double" +shape = [ + "ncv", +] + +[observations.concentration] +type = "union" + +[observations.concentration.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.concentration.arms.boundname] +type = "string" +tagged = false + +[observations.storage] +type = "union" + +[observations.storage.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.storage.arms.boundname] +type = "string" +tagged = false + +[observations.constant] +type = "union" + +[observations.constant.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.constant.arms.boundname] +type = "string" +tagged = false + +[observations.from-mvr] +type = "union" + +[observations.from-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.from-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.rainfall] +type = "union" + +[observations.rainfall.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.rainfall.arms.boundname] +type = "string" +tagged = false + +[observations.evaporation] +type = "union" + +[observations.evaporation.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.evaporation.arms.boundname] +type = "string" +tagged = false + +[observations.runoff] +type = "union" + +[observations.runoff.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.runoff.arms.boundname] +type = "string" +tagged = false + +[observations.ext-inflow] +type = "union" + +[observations.ext-inflow.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.ext-inflow.arms.boundname] +type = "string" +tagged = false + +[observations.withdrawal] +type = "union" + +[observations.withdrawal.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.withdrawal.arms.boundname] +type = "string" +tagged = false + +[observations.ext-outflow] +type = "union" + +[observations.ext-outflow.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.ext-outflow.arms.boundname] +type = "string" +tagged = false + +[observations.flow-ja-face] +type = "union" + +[observations.flow-ja-face.arms.ifno_ifno2] +type = "record" + +[observations.flow-ja-face.arms.ifno_ifno2.fields.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.flow-ja-face.arms.ifno_ifno2.fields.ifno2] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.flow-ja-face.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.outletno] +type = "integer" +tagged = false +index = true + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.lkt] +type = "union" + +[observations.lkt.arms.ifno_iconn] +type = "record" + +[observations.lkt.arms.ifno_iconn.fields.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.lkt.arms.ifno_iconn.fields.iconn] +type = "integer" +tagged = false +index = true + +[observations.lkt.arms.boundname] +type = "string" +tagged = false diff --git a/flopy4/mf6/dfns/gwt-mst.toml b/flopy4/mf6/dfns/gwt-mst.toml new file mode 100644 index 000000000..24be6f582 --- /dev/null +++ b/flopy4/mf6/dfns/gwt-mst.toml @@ -0,0 +1,210 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-mst" +parent = "gwt-nam" +ftype = "MST6" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save calculated flows to budget file" +description = "keyword to indicate that MST flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.first_order_decay] +type = "keyword" +longname = "activate first-order decay" +description = "is a text keyword to indicate that first-order decay will occur. Use of this keyword requires that DECAY and DECAY_SORBED (if sorption is active) are specified in the GRIDDATA block." +optional = true + +[blocks.options.fields.zero_order_decay] +type = "keyword" +longname = "activate zero-order decay" +description = "is a text keyword to indicate that zero-order decay will occur. Use of this keyword requires that DECAY and DECAY_SORBED (if sorption is active) are specified in the GRIDDATA block." +optional = true + +[blocks.options.fields.sorption] +type = "string" +longname = "activate sorption" +description = "is a text keyword to indicate that sorption will be activated. Valid sorption options include LINEAR, FREUNDLICH, and LANGMUIR. Use of this keyword requires that BULK_DENSITY and DISTCOEF are specified in the GRIDDATA block. If sorption is specified as FREUNDLICH or LANGMUIR then SP2 is also required in the GRIDDATA block." +optional = true +valid = [ + "linear", + "freundlich", + "langmuir", +] + +[blocks.options.fields.sorbate_filerecord] +type = "record" +optional = true + +[blocks.options.fields.sorbate_filerecord.fields.sorbate] +type = "keyword" +longname = "sorbate keyword" +description = "keyword to specify that record corresponds to sorbate concentration." + +[blocks.options.fields.sorbate_filerecord.fields.sorbatefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write sorbate concentration information. Sorbate concentrations will be written whenever aqueous concentrations are saved, as determined by settings in the Output Control option." +tagged = false +direction = "out" + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.griddata.fields.porosity] +type = "array" +longname = "porosity" +description = "is the mobile domain porosity, defined as the mobile domain pore volume per mobile domain volume. Additional information on porosity within the context of mobile and immobile domain transport simulations is included in the MODFLOW 6 Supplemental Technical Information document." +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.decay] +type = "array" +longname = "aqueous phase decay rate coefficient" +description = "is the rate coefficient for first or zero-order decay for the aqueous phase of the mobile domain. A negative value indicates solute production. The dimensions of decay for first-order decay is one over time. The dimensions of decay for zero-order decay is mass per length cubed per time. decay will have no effect on simulation results unless either first- or zero-order decay is specified in the options block." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.decay_sorbed] +type = "array" +longname = "sorbed phase decay rate coefficient" +description = "is the rate coefficient for first or zero-order decay for the sorbed phase of the mobile domain. A negative value indicates solute production. The dimensions of decay_sorbed for first-order decay is one over time. The dimensions of decay_sorbed for zero-order decay is mass of solute per mass of aquifer per time. If decay_sorbed is not specified and both decay and sorption are active, then the program will terminate with an error. decay_sorbed will have no effect on simulation results unless the SORPTION keyword and either first- or zero-order decay are specified in the options block." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.bulk_density] +type = "array" +longname = "bulk density" +description = "is the bulk density of the aquifer in mass per length cubed. bulk_density is not required unless the SORPTION keyword is specified. Bulk density is defined as the mobile domain solid mass per mobile domain volume. Additional information on bulk density is included in the MODFLOW 6 Supplemental Technical Information document." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.distcoef] +type = "array" +longname = "distribution coefficient" +description = "is the distribution coefficient for the equilibrium-controlled linear sorption isotherm in dimensions of length cubed per mass. If the Freunchlich isotherm is specified, then discoef is the Freundlich constant. If the Langmuir isotherm is specified, then distcoef is the Langmuir constant. distcoef is not required unless the SORPTION keyword is specified." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.sp2] +type = "array" +longname = "second sorption parameter" +description = "is the exponent for the Freundlich isotherm and the sorption capacity for the Langmuir isotherm. sp2 is not required unless the SORPTION keyword is specified in the options block. If the SORPTION keyword is not specified in the options block, sp2 will have no effect on simulation results." +optional = true +netcdf = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[memory.order1_decay] +set_in = "ar" +source = "first_order_decay" +type = "logical" + +[memory.order0_decay] +set_in = "ar" +source = "zero_order_decay" +type = "logical" + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.porosity] +type = "array" +set_in = "ar" +source = "porosity" +dtype = "double" +shape = [ + "nodes", +] + +[memory.decay] +type = "array" +set_in = "ar" +source = "decay" +dtype = "double" +shape = [ + "nodes", +] + +[memory.decay_sorbed] +type = "array" +set_in = "ar" +source = "decay_sorbed" +dtype = "double" +shape = [ + "nodes", +] + +[memory.bulk_density] +type = "array" +set_in = "ar" +source = "bulk_density" +dtype = "double" +shape = [ + "nodes", +] + +[memory.distcoef] +type = "array" +set_in = "ar" +source = "distcoef" +dtype = "double" +shape = [ + "nodes", +] + +[memory.sp2] +type = "array" +set_in = "ar" +source = "sp2" +dtype = "double" +shape = [ + "nodes", +] diff --git a/flopy4/mf6/dfns/gwt-mvt.toml b/flopy4/mf6/dfns/gwt-mvt.toml new file mode 100644 index 000000000..b9e8f55dd --- /dev/null +++ b/flopy4/mf6/dfns/gwt-mvt.toml @@ -0,0 +1,82 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-mvt" +ftype = "MVT6" +parent = [ + "exg-gwtgwt", + "gwt-nam", +] + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of mover information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of lake flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save MVT flows to budget file" +description = "keyword to indicate that lake flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[memory.iprpak] +set_in = "ar" +source = "print_input" +description = "Flag controlling whether mover input is echoed to the listing file." +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +description = "Flag controlling whether mover flow rates are printed to the listing file." +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether mover flows are written to the budget file." +type = "integer" + +[memory.maxpackages] +readonly = true +set_in = "ar" +description = "Number of packages participating in the mover. Computed from the packages that supply or receive moved water." +type = "integer" diff --git a/flopy4/mf6/dfns/gwt-mwt.toml b/flopy4/mf6/dfns/gwt-mwt.toml new file mode 100644 index 000000000..6c50abb84 --- /dev/null +++ b/flopy4/mf6/dfns/gwt-mwt.toml @@ -0,0 +1,504 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-mwt" +parent = "gwt-nam" +ftype = "MWT6" +multi = true +subtype = "advanced" + +[dims.auxiliary] +value = "len(auxiliary)" + +[runtime_dims.ncv] +set_in = "ar" + +[blocks.options.fields.flow_package_name] +type = "string" +longname = "keyword to specify name of corresponding flow package" +description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWT name file)." +optional = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.flow_package_auxiliary_name] +type = "string" +longname = "keyword to specify name of concentration auxiliary variable in flow package" +description = "keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated concentrations from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of well cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of well information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_concentration] +type = "keyword" +longname = "print calculated concentrations to listing file" +description = "keyword to indicate that the list of well {#2} will be printed to the listing file for every stress period in which 'CONCENTRATION PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of well flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save well flows to budget file" +description = "keyword to indicate that well flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.concentration_filerecord] +type = "record" +optional = true + +[blocks.options.fields.concentration_filerecord.fields.concentration] +type = "keyword" +longname = "stage keyword" +description = "keyword to specify that record corresponds to concentration." + +[blocks.options.fields.concentration_filerecord.fields.concfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write concentration information." +tagged = false +direction = "out" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the MWT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MWT package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.dev_nonexpanding_matrix] +type = "keyword" +longname = "do not add rows to the solution matrix" +description = "keyword that solves the feature concentration with a general mixing equation and adds the result to the right-hand side of the GWT equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." +optional = true +developmode = true + +[blocks.packagedata.fields.packagedata] +type = "list" + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.ifno] +type = "integer" +longname = "well number for this entry" +description = "integer value that defines the feature (well) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. Well information must be specified for every well or the program will terminate with an error. The program will also terminate with an error if information for a well is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.strt] +type = "double" +longname = "starting well concentration" +description = "real value that defines the starting concentration for the well." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.packagedata.fields.packagedata.item.fields.boundname] +type = "string" +longname = "well name" +description = "name of the well cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "mwtperioddata" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.ifno] +type = "integer" +longname = "well number for this entry" +description = "integer value that defines the feature (well) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.fields.mwtsetting] +type = "union" +description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the MWTSETTING string include: STATUS, CONCENTRATION, RATE, and AUXILIARY. These settings are used to assign the concentration associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms. For example, the Multi-Aquifer Well Package supports a 'WITHDRAWAL' flow term. If this withdrawal term is active, then water will be withdrawn from the well at the calculated concentration of the well." + +[blocks.period.fields.stress_period_data.item.fields.mwtsetting.arms.status] +type = "string" +longname = "well concentration status" +description = "keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that concentration will be calculated for the well. If a well is inactive, then there will be no solute mass fluxes into or out of the well and the inactive value will be written for the well concentration. If a well is constant, then the concentration for the well will be fixed at the user specified value." + +[blocks.period.fields.stress_period_data.item.fields.mwtsetting.arms.concentration] +type = "double" +longname = "well concentration" +description = "real or character value that defines the concentration for the well. The specified CONCENTRATION is only applied if the well is a constant concentration well. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.mwtsetting.arms.rate] +type = "double" +longname = "well injection concentration" +description = "real or character value that defines the injection solute concentration $(ML^{-3})$ for the well. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.mwtsetting.arms.auxiliaryrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.mwtsetting.arms.auxiliaryrecord.fields.auxiliary] +type = "keyword" +description = "keyword for specifying auxiliary variable." + +[blocks.period.fields.stress_period_data.item.fields.mwtsetting.arms.auxiliaryrecord.fields.auxname] +type = "string" +description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.mwtsetting.arms.auxiliaryrecord.fields.auxval] +type = "double" +longname = "auxiliary variable value" +description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.flow_pkg_name] +set_in = "ar" +source = "flow_package_name" +type = "string" + +[memory.fp_aux_name] +set_in = "ar" +source = "flow_package_auxiliary_name" +type = "string" + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprconc] +set_in = "ar" +source = "print_concentration" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.dev_nonexpanding] +set_in = "ar" +source = "dev_nonexpanding_matrix" +type = "logical" + +[memory.packagedata_ifno] +set_in = "ar" +source = "ifno" +type = "integer" + +[memory.period_auxiliary] +set_in = "rp" +source = "auxiliary" +type = "logical" + +[memory.ncv] +readonly = true +set_in = "ar" +description = "Number of control volumes. Assigned from the linked flow package during AR." +type = "integer" + +[memory.strt] +type = "array" +set_in = "ar" +source = "strt" +description = "Starting concentration for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xnewpak] +type = "array" +set_in = "ca" +description = "Current concentration for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xoldpak] +type = "array" +readonly = true +set_in = "ad" +description = "Concentration from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." +dtype = "double" +shape = [ + "ncv", +] + +[memory.ibound] +type = "array" +set_in = "ar" +description = "Boundary activity flag for each control volume." +dtype = "integer" +shape = [ + "ncv", +] + +[memory.concfeat] +type = "array" +readonly = true +set_in = "cq" +description = "Computed concentration for each feature. Set from XNEWPAK after solver convergence." +dtype = "double" +shape = [ + "ncv", +] + +[memory.qsto] +type = "array" +readonly = true +set_in = "cq" +description = "Storage concentration flow contribution for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.concrate] +type = "array" +set_in = "rp" +description = "Pumping-rate concentration for each multi-aquifer well." +dtype = "double" +shape = [ + "ncv", +] + +[observations.concentration] +type = "union" + +[observations.concentration.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.concentration.arms.boundname] +type = "string" +tagged = false + +[observations.storage] +type = "union" + +[observations.storage.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.storage.arms.boundname] +type = "string" +tagged = false + +[observations.constant] +type = "union" + +[observations.constant.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.constant.arms.boundname] +type = "string" +tagged = false + +[observations.from-mvr] +type = "union" + +[observations.from-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.from-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.rate] +type = "union" + +[observations.rate.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.rate.arms.boundname] +type = "string" +tagged = false + +[observations.fw-rate] +type = "union" + +[observations.fw-rate.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.fw-rate.arms.boundname] +type = "string" +tagged = false + +[observations.rate-to-mvr] +type = "union" + +[observations.rate-to-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.rate-to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.fw-rate-to-mvr] +type = "union" + +[observations.fw-rate-to-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.fw-rate-to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.mwt] +type = "union" + +[observations.mwt.arms.ifno_iconn] +type = "record" + +[observations.mwt.arms.ifno_iconn.fields.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.mwt.arms.ifno_iconn.fields.iconn] +type = "integer" +tagged = false +index = true + +[observations.mwt.arms.boundname] +type = "string" +tagged = false diff --git a/flopy4/mf6/dfns/gwt-nam.toml b/flopy4/mf6/dfns/gwt-nam.toml new file mode 100644 index 000000000..82ea36b17 --- /dev/null +++ b/flopy4/mf6/dfns/gwt-nam.toml @@ -0,0 +1,222 @@ +type = "model" +schema_version = "2.0.0.dev3" +name = "gwt-nam" +parent = "sim-nam" +ftype = "GWT6" +dependent_variable = "concentration" + +[runtime_dims.nja] +set_in = "ar" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.list] +type = "string" +longname = "name of listing file" +description = "is name of the listing file to create for this GWT model. If not specified, then the name of the list file will be the basename of the GWT model name file and the '.lst' extension. For example, if the GWT name file is called 'my.model.nam' then the list file will be called 'my.model.lst'." +optional = true +case_sensitive = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save flows for all packages to budget file" +description = "keyword to indicate that all model package flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.dependent_variable_scaling] +type = "keyword" +longname = "flag to scale X and RHS" +description = "flag to scale X and RHS to avoid very large positive or negative dependent variable values" +optional = true + +[blocks.options.fields.nc_mesh2d_filerecord] +type = "record" +description = "NetCDF layered mesh fileout record." +optional = true + +[blocks.options.fields.nc_mesh2d_filerecord.fields.netcdf_mesh2d] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to a layered mesh NetCDF file." + +[blocks.options.fields.nc_mesh2d_filerecord.fields.ncmesh2dfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF ugrid layered mesh output file." +tagged = false +direction = "out" + +[blocks.options.fields.nc_structured_filerecord] +type = "record" +description = "NetCDF structured fileout record." +optional = true + +[blocks.options.fields.nc_structured_filerecord.fields.netcdf_structured] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to a structured NetCDF file." + +[blocks.options.fields.nc_structured_filerecord.fields.ncstructfile] +type = "file" +longname = "file keyword" +description = "name of the NetCDF structured output file." +tagged = false +direction = "out" + +[blocks.options.fields.nc_filerecord] +type = "record" +description = "NetCDF filerecord" +optional = true + +[blocks.options.fields.nc_filerecord.fields.netcdf] +type = "keyword" +longname = "netcdf keyword" +description = "keyword to specify that record corresponds to a NetCDF input file." + +[blocks.options.fields.nc_filerecord.fields.netcdf_filename] +type = "file" +longname = "netcdf input filename" +description = "defines a NetCDF input file." +tagged = false +direction = "in" + +[blocks.packages.fields.packages] +type = "list" +longname = "package list" + +[blocks.packages.fields.packages.item] +name = "packages" +type = "record" + +[blocks.packages.fields.packages.item.fields.ftype] +type = "string" +longname = "package type" +description = "is the file type, which must be one of the following character values shown in table~ref{table:ftype-gwt}. Ftype may be entered in any combination of uppercase and lowercase." +tagged = false + +[blocks.packages.fields.packages.item.fields.fname] +type = "file" +longname = "file name" +description = "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run." +tagged = false +direction = "in" +mode_keyword = false +component = "package" +component_ftype = "ftype" + +[blocks.packages.fields.packages.item.fields.pname] +type = "string" +longname = "user name for package" +description = "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single GWT Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters." +optional = true +tagged = false +pk = true + +[memory.idv_scale] +set_in = "ar" +source = "dependent_variable_scaling" +type = "integer" + +[memory.netcdf_struct] +set_in = "ar" +source = "netcdf_structured" +type = "logical" + +[memory.netcdf_fname] +set_in = "ar" +source = "netcdf_filename" +type = "string" + +[memory.x] +type = "array" +set_in = "ca" +description = "Solute concentration for each model cell. Checked in from the solution-level dependent-variable vector. Initialized by the IC package during AR; updated by the nonlinear solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." +obs_type = "CONCENTRATION" +dtype = "double" +shape = [ + "nodes", +] + +[memory.xold] +type = "array" +readonly = true +set_in = "ad" +description = "Dependent variable from the end of the previous time step. Copied from X at advance (AD); used to restore X if the adaptive time stepping scheme retries a failed time step." +dtype = "double" +shape = [ + "nodes", +] + +[memory.flowja] +type = "array" +readonly = true +set_in = "cq" +description = "Intercell flows in compressed sparse row (CSR) order, calculated after solution convergence. Diagonal entries hold the flow residual." +budget = "FLOW-JA-FACE" +dtype = "double" +shape = [ + "nja", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution for this model, sliced from the solution-level RHS vector. Rebuilt each solver iteration." +dtype = "double" +shape = [ + "nodes", +] + +[memory.ibound] +type = "array" +set_in = "ar" +description = "Cell activity flag: positive values indicate active cells, zero indicates inactive (no-flow) cells. Set during model initialisation; may change when Newton-Raphson wet-dry logic activates or deactivates cells." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.neq] +readonly = true +set_in = "ar" +description = "Number of equations (unknowns) for this model. Equal to the number of active cells (NODES) for standard models." +type = "integer" + +[memory.idxglo] +type = "array" +readonly = true +set_in = "mc" +description = "Maps each local CSR position to the corresponding row/column index in the global solution matrix. Populated during matrix connectivity (MC) and constant thereafter." +dtype = "integer" +shape = [ + "nja", +] + +[observations.concentration] +type = "cellid" +tagged = false + +[observations.flow-ja-face] +type = "record" + +[observations.flow-ja-face.fields.cellid] +type = "cellid" +tagged = false + +[observations.flow-ja-face.fields.cellid2] +type = "cellid" +tagged = false diff --git a/flopy4/mf6/dfns/gwt-oc.toml b/flopy4/mf6/dfns/gwt-oc.toml new file mode 100644 index 000000000..9f3c046fa --- /dev/null +++ b/flopy4/mf6/dfns/gwt-oc.toml @@ -0,0 +1,212 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-oc" +parent = "gwt-nam" +ftype = "OC6" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information. Data are written to this file only for time steps in which SAVE BUDGET is specified in a PERIOD block. If SAVE BUDGET is specified in a PERIOD block and this file is not specified, MODFLOW 6 will terminate with an error." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. If specified, a budget summary record will be written to this file for every time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.concentration_filerecord] +type = "record" +optional = true + +[blocks.options.fields.concentration_filerecord.fields.concentration] +type = "keyword" +longname = "concentration keyword" +description = "keyword to specify that record corresponds to concentration." + +[blocks.options.fields.concentration_filerecord.fields.concentrationfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write conc information." +tagged = false +direction = "out" + +[blocks.options.fields.concentrationprintrecord] +type = "record" +optional = true + +[blocks.options.fields.concentrationprintrecord.fields.concentration] +type = "keyword" +longname = "concentration keyword" +description = "keyword to specify that record corresponds to concentration." + +[blocks.options.fields.concentrationprintrecord.fields.print_format] +type = "keyword" +longname = "keyword to indicate that a print format follows" +description = "keyword to specify format for printing to the listing file." + +[blocks.options.fields.concentrationprintrecord.fields.formatrecord] +type = "record" + +[blocks.options.fields.concentrationprintrecord.fields.formatrecord.fields.columns] +type = "integer" +longname = "number of columns" +description = "number of columns for writing data." +optional = true + +[blocks.options.fields.concentrationprintrecord.fields.formatrecord.fields.width] +type = "integer" +longname = "width for each number" +description = "width for writing each number." +optional = true + +[blocks.options.fields.concentrationprintrecord.fields.formatrecord.fields.digits] +type = "integer" +longname = "number of digits" +description = "number of digits to use for writing a number." +optional = true + +[blocks.options.fields.concentrationprintrecord.fields.formatrecord.fields.format] +type = "string" +longname = "write format" +description = "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC." +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" +optional = true + +[blocks.period.fields.stress_period_data.item] +name = "output_record" +type = "union" + +[blocks.period.fields.stress_period_data.item.arms.saverecord] +type = "record" +optional = true + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.save] +type = "keyword" +longname = "keyword to save" +description = "keyword to indicate that information will be saved this stress period." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.rtype] +type = "string" +longname = "record type" +description = "type of information to save or print. Can be BUDGET or CONCENTRATION." +tagged = false +valid = [ + "CONCENTRATION", + "BUDGET", +] + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting] +type = "union" +description = "specifies the steps for which the data will be saved." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.all] +type = "keyword" +description = "keyword to indicate save for all time steps in period." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.first] +type = "keyword" +description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.last] +type = "keyword" +description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.frequency] +type = "integer" +description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.steps] +type = "array" +description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." +dtype = "integer" +shape = [ + "<=nstp", +] + +[blocks.period.fields.stress_period_data.item.arms.printrecord] +type = "record" +optional = true + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.print] +type = "keyword" +longname = "keyword to save" +description = "keyword to indicate that information will be printed this stress period." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.rtype] +type = "string" +longname = "record type" +description = "type of information to save or print. Can be BUDGET or CONCENTRATION." +tagged = false +valid = [ + "CONCENTRATION", + "BUDGET", +] + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting] +type = "union" +description = "specifies the steps for which the data will be saved." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.all] +type = "keyword" +description = "keyword to indicate save for all time steps in period." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.first] +type = "keyword" +description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.last] +type = "keyword" +description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.frequency] +type = "integer" +description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.steps] +type = "array" +description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." +dtype = "integer" +shape = [ + "<=nstp", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.concfile] +set_in = "ar" +source = "concentrationfile" +type = "string" diff --git a/flopy4/mf6/dfns/gwt-sft.toml b/flopy4/mf6/dfns/gwt-sft.toml new file mode 100644 index 000000000..22337f858 --- /dev/null +++ b/flopy4/mf6/dfns/gwt-sft.toml @@ -0,0 +1,609 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-sft" +parent = "gwt-nam" +ftype = "SFT6" +multi = true +subtype = "advanced" + +[dims.auxiliary] +value = "len(auxiliary)" + +[runtime_dims.ncv] +set_in = "ar" + +[blocks.options.fields.flow_package_name] +type = "string" +longname = "keyword to specify name of corresponding flow package" +description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWT name file)." +optional = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.flow_package_auxiliary_name] +type = "string" +longname = "keyword to specify name of concentration auxiliary variable in flow package" +description = "keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated concentrations from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of reach cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of reach information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_concentration] +type = "keyword" +longname = "print calculated concentrations to listing file" +description = "keyword to indicate that the list of reach {#2} will be printed to the listing file for every stress period in which 'CONCENTRATION PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of reach flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save reach flows to budget file" +description = "keyword to indicate that reach flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.concentration_filerecord] +type = "record" +optional = true + +[blocks.options.fields.concentration_filerecord.fields.concentration] +type = "keyword" +longname = "concentration keyword" +description = "keyword to specify that record corresponds to concentration." + +[blocks.options.fields.concentration_filerecord.fields.concfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write concentration information." +tagged = false +direction = "out" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the SFT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFT package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.dev_nonexpanding_matrix] +type = "keyword" +longname = "do not add rows to the solution matrix" +description = "keyword that solves the feature concentration with a general mixing equation and adds the result to the right-hand side of the GWT equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." +optional = true +developmode = true + +[blocks.packagedata.fields.packagedata] +type = "list" + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.ifno] +type = "integer" +longname = "reach number for this entry" +description = "integer value that defines the feature (reach) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NREACHES. Reach information must be specified for every reach or the program will terminate with an error. The program will also terminate with an error if information for a reach is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.strt] +type = "double" +longname = "starting reach concentration" +description = "real value that defines the starting concentration for the reach." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each reach. The values of auxiliary variables must be present for each reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.packagedata.fields.packagedata.item.fields.boundname] +type = "string" +longname = "well name" +description = "name of the reach cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "reachperioddata" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.ifno] +type = "integer" +longname = "reach number for this entry" +description = "integer value that defines the feature (reach) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NREACHES." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.fields.reachsetting] +type = "union" +description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the REACHSETTING string include: STATUS, CONCENTRATION, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the concentration of associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms. For example, the Streamflow Package supports a 'DIVERSION' flow term. Diversion water will be routed using the calculated concentration of the reach." + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.status] +type = "string" +longname = "reach concentration status" +description = "keyword option to define reach status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that concentration will be calculated for the reach. If a reach is inactive, then there will be no solute mass fluxes into or out of the reach and the inactive value will be written for the reach concentration. If a reach is constant, then the concentration for the reach will be fixed at the user specified value." + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.concentration] +type = "double" +longname = "reach concentration" +description = "real or character value that defines the concentration for the reach. The specified CONCENTRATION is only applied if the reach is a constant concentration reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.rainfall] +type = "double" +longname = "rainfall concentration" +description = "real or character value that defines the rainfall solute concentration $(ML^{-3})$ for the reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.evaporation] +type = "double" +longname = "evaporation concentration" +description = "real or character value that defines the concentration of evaporated water $(ML^{-3})$ for the reach. If this concentration value is larger than the simulated concentration in the reach, then the evaporated water will be removed at the same concentration as the reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.runoff] +type = "double" +longname = "runoff concentration" +description = "real or character value that defines the concentration of runoff $(ML^{-3})$ for the reach. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.inflow] +type = "double" +longname = "inflow concentration" +description = "real or character value that defines the concentration of inflow $(ML^{-3})$ for the reach. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord.fields.auxiliary] +type = "keyword" +description = "keyword for specifying auxiliary variable." + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord.fields.auxname] +type = "string" +description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord.fields.auxval] +type = "double" +longname = "auxiliary variable value" +description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.flow_pkg_name] +set_in = "ar" +source = "flow_package_name" +type = "string" + +[memory.fp_aux_name] +set_in = "ar" +source = "flow_package_auxiliary_name" +type = "string" + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprconc] +set_in = "ar" +source = "print_concentration" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.dev_nonexpanding] +set_in = "ar" +source = "dev_nonexpanding_matrix" +type = "logical" + +[memory.packagedata_ifno] +set_in = "ar" +source = "ifno" +type = "integer" + +[memory.period_auxiliary] +set_in = "rp" +source = "auxiliary" +type = "logical" + +[memory.ncv] +readonly = true +set_in = "ar" +description = "Number of control volumes. Assigned from the linked flow package during AR." +type = "integer" + +[memory.strt] +type = "array" +set_in = "ar" +source = "strt" +description = "Starting concentration for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xnewpak] +type = "array" +set_in = "ca" +description = "Current concentration for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xoldpak] +type = "array" +readonly = true +set_in = "ad" +description = "Concentration from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." +dtype = "double" +shape = [ + "ncv", +] + +[memory.ibound] +type = "array" +set_in = "ar" +description = "Boundary activity flag for each control volume." +dtype = "integer" +shape = [ + "ncv", +] + +[memory.concfeat] +type = "array" +readonly = true +set_in = "cq" +description = "Computed concentration for each feature. Set from XNEWPAK after solver convergence." +dtype = "double" +shape = [ + "ncv", +] + +[memory.qsto] +type = "array" +readonly = true +set_in = "cq" +description = "Storage concentration flow contribution for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.concrain] +type = "array" +set_in = "rp" +description = "Rainfall concentration for each reach." +dtype = "double" +shape = [ + "ncv", +] + +[memory.concevap] +type = "array" +set_in = "rp" +description = "Evaporation concentration for each reach." +dtype = "double" +shape = [ + "ncv", +] + +[memory.concroff] +type = "array" +set_in = "rp" +description = "Runoff concentration for each reach." +dtype = "double" +shape = [ + "ncv", +] + +[memory.conciflw] +type = "array" +set_in = "rp" +description = "Inflow concentration for each reach." +dtype = "double" +shape = [ + "ncv", +] + +[memory.vnew] +type = "array" +readonly = true +set_in = "cq" +description = "Reach water volume at the end of the current time step." +dtype = "double" +shape = [ + "ncv", +] + +[memory.vold] +type = "array" +readonly = true +set_in = "ad" +description = "Reach water volume at the start of the current time step." +dtype = "double" +shape = [ + "ncv", +] + +[observations.concentration] +type = "union" + +[observations.concentration.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.concentration.arms.boundname] +type = "string" +tagged = false + +[observations.storage] +type = "union" + +[observations.storage.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.storage.arms.boundname] +type = "string" +tagged = false + +[observations.constant] +type = "union" + +[observations.constant.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.constant.arms.boundname] +type = "string" +tagged = false + +[observations.from-mvr] +type = "union" + +[observations.from-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.from-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.sft] +type = "union" + +[observations.sft.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.sft.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.rainfall] +type = "union" + +[observations.rainfall.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.rainfall.arms.boundname] +type = "string" +tagged = false + +[observations.evaporation] +type = "union" + +[observations.evaporation.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.evaporation.arms.boundname] +type = "string" +tagged = false + +[observations.runoff] +type = "union" + +[observations.runoff.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.runoff.arms.boundname] +type = "string" +tagged = false + +[observations.ext-inflow] +type = "union" + +[observations.ext-inflow.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.ext-inflow.arms.boundname] +type = "string" +tagged = false + +[observations.ext-outflow] +type = "union" + +[observations.ext-outflow.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.ext-outflow.arms.boundname] +type = "string" +tagged = false + +[observations.flow-ja-face] +type = "union" + +[observations.flow-ja-face.arms.ifno_ifno2] +type = "record" + +[observations.flow-ja-face.arms.ifno_ifno2.fields.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.flow-ja-face.arms.ifno_ifno2.fields.ifno2] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.flow-ja-face.arms.boundname] +type = "string" +tagged = false diff --git a/flopy4/mf6/dfns/gwt-src.toml b/flopy4/mf6/dfns/gwt-src.toml new file mode 100644 index 000000000..566246ff1 --- /dev/null +++ b/flopy4/mf6/dfns/gwt-src.toml @@ -0,0 +1,319 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-src" +parent = "gwt-nam" +ftype = "SRC6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of mass loading rate." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of mass source cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of mass source information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of mass source flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save SRC flows to budget file" +description = "keyword to indicate that mass source flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the SRC package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SRC package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.highest_saturated] +type = "keyword" +longname = "apply source to highest saturated cell" +description = "Apply mass source loading rate to specified CELLID or highest underlying cell with a cell saturation greater than zero. The highest_saturated option has an additional complication for certain types of grids specified using the DISU Package. When the DISU Package is used, a cell may have more than one cell underlying it. If the overlying cell were to become inactive, there is no straightforward method for determining how to apportion the mass source loading rate to the underlying cells. In this case, the approach described by cite{modflowusg} is used. The mass source loading rate is assigned to the first active cell encountered (determined by searching through the underlying cell numbers from the lowest number to the highest number). In this manner, the total mass source loading rate is conserved; however, the spatial distribution of the applied mass source loading rate may not be maintained as layers become dry or wet during a simulation." +optional = true + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of sources" +description = "integer value specifying the maximum number of sources cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.smassrate] +type = "double" +longname = "mass source loading rate" +description = "is the mass source loading rate. A positive value indicates addition of solute mass and a negative value indicates removal of solute mass. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each mass source. The values of auxiliary variables must be present for each mass source. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "source name" +description = "name of the mass source cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.highest_sat] +set_in = "ar" +source = "highest_saturated" +type = "logical" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: smassrate." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "SRC" +output = true +obs_type = "SRC" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "SRC-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.src] +type = "union" + +[observations.src.arms.cellid] +type = "cellid" +tagged = false + +[observations.src.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwt-ssm.toml b/flopy4/mf6/dfns/gwt-ssm.toml new file mode 100644 index 000000000..4ceb2d618 --- /dev/null +++ b/flopy4/mf6/dfns/gwt-ssm.toml @@ -0,0 +1,102 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-ssm" +parent = "gwt-nam" +ftype = "SSM6" + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of SSM flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save calculated flows to budget file" +description = "keyword to indicate that SSM flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.sources] +write_if_empty = true + +[blocks.sources.fields.sources] +type = "list" +longname = "package list" + +[blocks.sources.fields.sources.item] +name = "sources" +type = "record" + +[blocks.sources.fields.sources.item.fields.pname] +type = "string" +longname = "package name" +description = "name of the flow package for which an auxiliary variable contains a source concentration. If this flow package is represented using an advanced transport package (SFT, LKT, MWT, or UZT), then the advanced transport package will override SSM terms specified here." +tagged = false +pk = true + +[blocks.sources.fields.sources.item.fields.pname.fk] +path = "gwf-nam.packages.pname" +rule = "flow_model" + +[blocks.sources.fields.sources.item.fields.srctype] +type = "string" +longname = "source type" +description = "keyword indicating how concentration will be assigned for sources and sinks. Keyword must be specified as either AUX or AUXMIXED. For both options the user must provide an auxiliary variable in the corresponding flow package. The auxiliary variable must have the same name as the AUXNAME value that follows. If the AUX keyword is specified, then the auxiliary variable specified by the user will be assigned as the concentration value for groundwater sources (flows with a positive sign). For negative flow rates (sinks), groundwater will be withdrawn from the cell at the simulated concentration of the cell. The AUXMIXED option provides an alternative method for how to determine the concentration of sinks. If the cell concentration is larger than the user-specified auxiliary concentration, then the concentration of groundwater withdrawn from the cell will be assigned as the user-specified concentration. Alternatively, if the user-specified auxiliary concentration is larger than the cell concentration, then groundwater will be withdrawn at the cell concentration. Thus, the AUXMIXED option is designed to work with the Evapotranspiration (EVT) and Recharge (RCH) Packages where water may be withdrawn at a concentration that is less than the cell concentration." +tagged = false + +[blocks.sources.fields.sources.item.fields.auxname] +type = "string" +longname = "auxiliary variable name" +description = "name of the auxiliary variable in the package PNAME. This auxiliary variable must exist and be specified by the user in that package. The values in this auxiliary variable will be used to set the concentration associated with the flows for that boundary package." +tagged = false + +[blocks.fileinput.fields.fileinput] +type = "list" +optional = true + +[blocks.fileinput.fields.fileinput.item] +name = "fileinput" +type = "record" + +[blocks.fileinput.fields.fileinput.item.fields.pname] +type = "string" +longname = "package name" +description = "name of the flow package for which an SPC6 input file contains a source concentration. If this flow package is represented using an advanced transport package (SFT, LKT, MWT, or UZT), then the advanced transport package will override SSM terms specified here." +tagged = false +pk = true + +[blocks.fileinput.fields.fileinput.item.fields.pname.fk] +path = "gwf-nam.packages.pname" +rule = "flow_model" + +[blocks.fileinput.fields.fileinput.item.fields.spc6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a source sink mixing input file." + +[blocks.fileinput.fields.fileinput.item.fields.spc6_filename] +type = "file" +longname = "spc file name" +description = "character string that defines the path and filename for the file containing source and sink input data for the flow package. The SPC6_FILENAME file is a flexible input file that allows concentrations to be specified by stress period and with time series. Instructions for creating the SPC6_FILENAME input file are provided in the next section on file input for boundary concentrations." +tagged = false +direction = "in" +component = [ + "utl-spc", + "utl-spca", +] + +[blocks.fileinput.fields.fileinput.item.fields.mixed] +type = "keyword" +longname = "mixed keyword" +description = "keyword to specify that these stress package boundaries will have the mixed condition. The MIXED condition is described in the SOURCES block for AUXMIXED. The MIXED condition allows for water to be withdrawn at a concentration that is less than the cell concentration. It is intended primarily for representing evapotranspiration." +optional = true + +[memory.pname_sources] +source = "pname" +type = "string" + +[keys] +source = [ + "sources.pname", + "fileinput.pname", +] diff --git a/flopy4/mf6/dfns/gwt-uzt.toml b/flopy4/mf6/dfns/gwt-uzt.toml new file mode 100644 index 000000000..3c262e01e --- /dev/null +++ b/flopy4/mf6/dfns/gwt-uzt.toml @@ -0,0 +1,533 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "gwt-uzt" +parent = "gwt-nam" +ftype = "UZT6" +multi = true +subtype = "advanced" + +[dims.auxiliary] +value = "len(auxiliary)" + +[runtime_dims.ncv] +set_in = "ar" + +[blocks.options.fields.flow_package_name] +type = "string" +longname = "keyword to specify name of corresponding flow package" +description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWT name file)." +optional = true + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.flow_package_auxiliary_name] +type = "string" +longname = "keyword to specify name of concentration auxiliary variable in flow package" +description = "keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated concentrations from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of unsaturated zone flow cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of unsaturated zone flow information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_concentration] +type = "keyword" +longname = "print calculated concentrations to listing file" +description = "keyword to indicate that the list of UZF cell {#2} will be printed to the listing file for every stress period in which 'CONCENTRATION PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of unsaturated zone flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save UZT cell flows to budget file" +description = "keyword to indicate that unsaturated zone flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.concentration_filerecord] +type = "record" +optional = true + +[blocks.options.fields.concentration_filerecord.fields.concentration] +type = "keyword" +longname = "stage keyword" +description = "keyword to specify that record corresponds to concentration." + +[blocks.options.fields.concentration_filerecord.fields.concfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write concentration information." +tagged = false +direction = "out" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write budget information." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the UZT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZT package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.dev_nonexpanding_matrix] +type = "keyword" +longname = "do not add rows to the solution matrix" +description = "keyword that solves the feature concentration with a general mixing equation and adds the result to the right-hand side of the GWT equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." +optional = true +developmode = true + +[blocks.packagedata.fields.packagedata] +type = "list" + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.ifno] +type = "integer" +longname = "UZF cell number for this entry" +description = "integer value that defines the feature (UZF object) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NUZFCELLS. Unsaturated zone flow information must be specified for every UZF cell or the program will terminate with an error. The program will also terminate with an error if information for a UZF cell is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.strt] +type = "double" +longname = "starting UZF cell concentration" +description = "real value that defines the starting concentration for the unsaturated zone flow cell." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each unsaturated zone flow. The values of auxiliary variables must be present for each unsaturated zone flow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.packagedata.fields.packagedata.item.fields.boundname] +type = "string" +longname = "UZF cell name" +description = "name of the unsaturated zone flow cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "uztperioddata" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.ifno] +type = "integer" +longname = "unsaturated zone flow cell number for this entry" +description = "integer value that defines the feature (UZF object) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NUZFCELLS." +tagged = false +index = true +fk = "packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.fields.uztsetting] +type = "union" +description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the UZTSETTING string include: STATUS, CONCENTRATION, INFILTRATION, UZET, and AUXILIARY. These settings are used to assign the concentration of associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms." + +[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.status] +type = "string" +longname = "unsaturated zone flow cell concentration status" +description = "keyword option to define UZF cell status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that concentration will be calculated for the UZF cell. If a UZF cell is inactive, then there will be no solute mass fluxes into or out of the UZF cell and the inactive value will be written for the UZF cell concentration. If a UZF cell is constant, then the concentration for the UZF cell will be fixed at the user specified value." + +[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.concentration] +type = "double" +longname = "unsaturated zone flow cell concentration" +description = "real or character value that defines the concentration for the unsaturated zone flow cell. The specified CONCENTRATION is only applied if the unsaturated zone flow cell is a constant concentration cell. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.infiltration] +type = "double" +longname = "infiltration concentration" +description = "real or character value that defines the infiltration solute concentration $(ML^{-3})$ for the UZF cell. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.uzet] +type = "double" +longname = "unsaturated zone et concentration" +description = "real or character value that defines the concentration of unsaturated zone evapotranspiration water $(ML^{-3})$ for the UZF cell. If this concentration value is larger than the simulated concentration in the UZF cell, then the unsaturated zone ET water will be removed at the same concentration as the UZF cell. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.auxiliaryrecord] +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.auxiliaryrecord.fields.auxiliary] +type = "keyword" +description = "keyword for specifying auxiliary variable." + +[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.auxiliaryrecord.fields.auxname] +type = "string" +description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.auxiliaryrecord.fields.auxval] +type = "double" +longname = "auxiliary variable value" +description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.flow_pkg_name] +set_in = "ar" +source = "flow_package_name" +type = "string" + +[memory.fp_aux_name] +set_in = "ar" +source = "flow_package_auxiliary_name" +type = "string" + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprconc] +set_in = "ar" +source = "print_concentration" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.dev_nonexpanding] +set_in = "ar" +source = "dev_nonexpanding_matrix" +type = "logical" + +[memory.packagedata_ifno] +set_in = "ar" +source = "ifno" +type = "integer" + +[memory.period_auxiliary] +set_in = "rp" +source = "auxiliary" +type = "logical" + +[memory.ncv] +readonly = true +set_in = "ar" +description = "Number of control volumes. Assigned from the linked flow package during AR." +type = "integer" + +[memory.strt] +type = "array" +set_in = "ar" +source = "strt" +description = "Starting concentration for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xnewpak] +type = "array" +set_in = "ca" +description = "Current concentration for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." +dtype = "double" +shape = [ + "ncv", +] + +[memory.xoldpak] +type = "array" +readonly = true +set_in = "ad" +description = "Concentration from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." +dtype = "double" +shape = [ + "ncv", +] + +[memory.ibound] +type = "array" +set_in = "ar" +description = "Boundary activity flag for each control volume." +dtype = "integer" +shape = [ + "ncv", +] + +[memory.concfeat] +type = "array" +readonly = true +set_in = "cq" +description = "Computed concentration for each feature. Set from XNEWPAK after solver convergence." +dtype = "double" +shape = [ + "ncv", +] + +[memory.qsto] +type = "array" +readonly = true +set_in = "cq" +description = "Storage concentration flow contribution for each control volume." +dtype = "double" +shape = [ + "ncv", +] + +[memory.concinfl] +type = "array" +set_in = "rp" +description = "Infiltration concentration for each UZF cell." +dtype = "double" +shape = [ + "ncv", +] + +[memory.concuzet] +type = "array" +set_in = "rp" +description = "ET concentration for each UZF cell." +dtype = "double" +shape = [ + "ncv", +] + +[observations.concentration] +type = "union" + +[observations.concentration.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.concentration.arms.boundname] +type = "string" +tagged = false + +[observations.storage] +type = "union" + +[observations.storage.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.storage.arms.boundname] +type = "string" +tagged = false + +[observations.constant] +type = "union" + +[observations.constant.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.constant.arms.boundname] +type = "string" +tagged = false + +[observations.from-mvr] +type = "union" + +[observations.from-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.from-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.uzt] +type = "union" + +[observations.uzt.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.uzt.arms.boundname] +type = "string" +tagged = false + +[observations.infiltration] +type = "union" + +[observations.infiltration.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.infiltration.arms.boundname] +type = "string" +tagged = false + +[observations.rej-inf] +type = "union" + +[observations.rej-inf.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.rej-inf.arms.boundname] +type = "string" +tagged = false + +[observations.uzet] +type = "union" + +[observations.uzet.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.uzet.arms.boundname] +type = "string" +tagged = false + +[observations.rej-inf-to-mvr] +type = "union" + +[observations.rej-inf-to-mvr.arms.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.rej-inf-to-mvr.arms.boundname] +type = "string" +tagged = false + +[observations.flow-ja-face] +type = "union" + +[observations.flow-ja-face.arms.ifno_ifno2] +type = "record" + +[observations.flow-ja-face.arms.ifno_ifno2.fields.ifno] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.flow-ja-face.arms.ifno_ifno2.fields.ifno2] +type = "integer" +tagged = false +index = true +fk = "packagedata.ifno" + +[observations.flow-ja-face.arms.boundname] +type = "string" +tagged = false diff --git a/flopy4/mf6/dfns/olf-cdb.toml b/flopy4/mf6/dfns/olf-cdb.toml new file mode 100644 index 000000000..07de862e2 --- /dev/null +++ b/flopy4/mf6/dfns/olf-cdb.toml @@ -0,0 +1,288 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "olf-cdb" +parent = "olf-nam" +ftype = "CDB6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of critical depth boundary cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of critical depth boundary information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of critical depth boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save flows to budget file" +description = "keyword to indicate that critical depth boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CDB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CDB package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of critical depth boundaries" +description = "integer value specifying the maximum number of critical depth boundary cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.idcxs] +type = "integer" +longname = "cross section identifier" +description = "is the identifier for the cross section specified in the CXS Package. A value of zero indicates the zero-depth-gradient calculation will use parameters for a hydraulically wide channel." +tagged = false +index = true + +[blocks.period.fields.stress_period_data.item.fields.width] +type = "double" +longname = "width of the zero-depth gradient boundary" +description = "is the channel width of the zero-depth gradient boundary. If a cross section is associated with this boundary, the width will be scaled by the cross section information. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "zero-depth-gradient boundary name" +description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: idcxs, 1: width." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "CDB" +output = true +obs_type = "CDB" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "CDB-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.cdb] +type = "union" + +[observations.cdb.arms.cellid] +type = "cellid" +tagged = false + +[observations.cdb.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/olf-chd.toml b/flopy4/mf6/dfns/olf-chd.toml new file mode 100644 index 000000000..0f453b42d --- /dev/null +++ b/flopy4/mf6/dfns/olf-chd.toml @@ -0,0 +1,295 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "olf-chd" +parent = "olf-nam" +ftype = "CHD6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of CHD head value." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of constant-head cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of constant-head information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print CHD flows to listing file" +description = "keyword to indicate that the list of constant-head flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save CHD flows to budget file" +description = "keyword to indicate that constant-head flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of constant heads" +description = "integer value specifying the maximum number of constant-head cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.head] +type = "double" +longname = "head value assigned to constant head" +description = "is the head at the boundary. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "constant head boundary name" +description = "name of the constant head boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: head." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "CHD" +output = true +obs_type = "CHD" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.chd] +type = "union" + +[observations.chd.arms.cellid] +type = "cellid" +tagged = false + +[observations.chd.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/olf-dfw.toml b/flopy4/mf6/dfns/olf-dfw.toml new file mode 100644 index 000000000..fe71fd5fb --- /dev/null +++ b/flopy4/mf6/dfns/olf-dfw.toml @@ -0,0 +1,159 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "olf-dfw" +parent = "olf-nam" +ftype = "DFW6" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.central_in_space] +type = "keyword" +longname = "use central in space weighting" +description = "keyword to indicate conductance should be calculated using central-in-space weighting instead of the default upstream weighting approach. This option should be used with caution as it does not work well unless all of the stream reaches are saturated. With this option, there is no way for water to flow into a dry reach from connected reaches." +optional = true + +[blocks.options.fields.length_conversion] +type = "double" +longname = "length conversion factor" +description = "real value that is used to convert user-specified Manning's roughness coefficients from meters to model length units. LENGTH_CONVERSION should be set to 3.28081, 1.0, and 100.0 when using length units (LENGTH_UNITS) of feet, meters, or centimeters in the simulation, respectively. LENGTH_CONVERSION does not need to be specified if LENGTH_UNITS are meters." +optional = true + +[blocks.options.fields.time_conversion] +type = "double" +longname = "time conversion factor" +description = "real value that is used to convert user-specified Manning's roughness coefficients from seconds to model time units. TIME_CONVERSION should be set to 1.0, 60.0, 3,600.0, 86,400.0, and 31,557,600.0 when using time units (TIME_UNITS) of seconds, minutes, hours, days, or years in the simulation, respectively. TIME_CONVERSION does not need to be specified if TIME_UNITS are seconds." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "keyword to save DFW flows" +description = "keyword to indicate that budget flow terms will be written to the file specified with 'BUDGET SAVE FILE' in Output Control." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "keyword to print DFW flows to listing file" +description = "keyword to indicate that calculated flows between cells will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period. This option can produce extremely large list files because all cell-by-cell flows are printed. It should only be used with the DFW Package for models that have a small number of cells." +optional = true + +[blocks.options.fields.save_velocity] +type = "keyword" +longname = "keyword to save velocity" +description = "keyword to indicate that x, y, and z components of velocity will be calculated at cell centers and written to the budget file, which is specified with 'BUDGET SAVE FILE' in Output Control. If this option is activated, then additional information may be required in the discretization packages and the GWF Exchange package (if GWF models are coupled). Specifically, ANGLDEGX must be specified in the CONNECTIONDATA block of the DISU Package; ANGLDEGX must also be specified for the GWF Exchange as an auxiliary variable." +optional = true + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.dev_swr_conductance] +type = "keyword" +longname = "use SWR conductance formulation" +description = "use the conductance formulation in the Surface Water Routing (SWR) Process for MODFLOW-2005." +optional = true +developmode = true + +[blocks.griddata.fields.manningsn] +type = "array" +longname = "mannings roughness coefficient" +description = "mannings roughness coefficient" +optional = true +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.idcxs] +type = "array" +longname = "cross section number" +description = "integer value indication the cross section identifier in the Cross Section Package that applies to the reach. If not provided then reach will be treated as hydraulically wide." +optional = true +dtype = "integer" +index = true +fk = "chf-cxs.packagedata.ifno" +shape = [ + "nodes", +] + +[memory.icentral] +set_in = "ar" +source = "central_in_space" +type = "integer" + +[memory.lengthconv] +set_in = "ar" +source = "length_conversion" +type = "double" + +[memory.timeconv] +set_in = "ar" +source = "time_conversion" +type = "double" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.isavvelocity] +set_in = "ar" +source = "save_velocity" +type = "integer" + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.iswrcond] +set_in = "ar" +source = "dev_swr_conductance" +type = "integer" + +[memory.manningsn] +type = "array" +set_in = "ar" +source = "manningsn" +dtype = "double" +shape = [ + "nodes", +] + +[memory.idcxs] +type = "array" +set_in = "ar" +source = "idcxs" +dtype = "integer" +shape = [ + "nodes", +] + +[observations.ext-outflow] +type = "integer" +tagged = false +index = true diff --git a/flopy4/mf6/dfns/olf-dis2d.toml b/flopy4/mf6/dfns/olf-dis2d.toml new file mode 100644 index 000000000..7477d9de2 --- /dev/null +++ b/flopy4/mf6/dfns/olf-dis2d.toml @@ -0,0 +1,217 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "olf-dis2d" +parent = "olf-nam" +ftype = "DIS2D6" + +[dims.nrow] +value = "nrow" +scope = "model" + +[dims.ncol] +value = "ncol" +scope = "model" + +[dims.ncpl] +value = "nrow * ncol" +scope = "model" + +[dims.nodes] +value = "nrow * ncol" +scope = "model" + +[dims.ncelldim] +value = "2" +scope = "model" + +[runtime_dims.nodes] +set_in = "ar" + +[runtime_dims.nodesuser] +set_in = "ar" + +[blocks.options.fields.length_units] +type = "string" +longname = "model length units" +description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." +optional = true + +[blocks.options.fields.nogrb] +type = "keyword" +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." +optional = true + +[blocks.options.fields.grb_filerecord] +type = "record" +optional = true + +[blocks.options.fields.grb_filerecord.fields.grb6] +type = "keyword" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" + +[blocks.options.fields.xorigin] +type = "double" +longname = "x-position of the model grid origin" +description = "x-position of the lower-left corner of the model grid. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.yorigin] +type = "double" +longname = "y-position of the model grid origin" +description = "y-position of the lower-left corner of the model grid. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.angrot] +type = "double" +longname = "rotation angle" +description = "counter-clockwise rotation angle (in degrees) of the lower-left corner of the model grid. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.crs] +type = "string" +longname = "CRS user input string" +description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true +case_sensitive = true + +[blocks.dimensions.fields.nrow] +type = "integer" +longname = "number of rows" +description = "is the number of rows in the model grid." +default = 2 + +[blocks.dimensions.fields.ncol] +type = "integer" +longname = "number of columns" +description = "is the number of columns in the model grid." +default = 2 + +[blocks.griddata.fields.delr] +type = "array" +longname = "spacing along a row" +description = "is the column spacing in the row direction." +default = 1.0 +dtype = "double" +shape = [ + "ncol", +] + +[blocks.griddata.fields.delc] +type = "array" +longname = "spacing along a column" +description = "is the row spacing in the column direction." +default = 1.0 +dtype = "double" +shape = [ + "nrow", +] + +[blocks.griddata.fields.bottom] +type = "array" +longname = "cell bottom elevation" +description = "is the bottom elevation for each cell." +default = 0.0 +dtype = "double" +shape = [ + "ncol", + "nrow", +] + +[blocks.griddata.fields.idomain] +type = "array" +longname = "idomain existence array" +description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." +optional = true +dtype = "integer" +shape = [ + "ncol", + "nrow", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.nrow] +set_in = "ar" +source = "nrow" +type = "integer" + +[memory.ncol] +set_in = "ar" +source = "ncol" +type = "integer" + +[memory.delr] +type = "array" +set_in = "ar" +source = "delr" +dtype = "double" +shape = [ + "ncol", +] + +[memory.delc] +type = "array" +set_in = "ar" +source = "delc" +dtype = "double" +shape = [ + "nrow", +] + +[memory.bottom] +type = "array" +set_in = "ar" +source = "bottom" +dtype = "double" +shape = [ + "ncol", + "nrow", +] + +[memory.idomain] +type = "array" +set_in = "ar" +source = "idomain" +dtype = "integer" +shape = [ + "ncol", + "nrow", +] + +[memory.nodeuser] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodereduced] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." +dtype = "integer" +shape = [ + "nodesuser", +] diff --git a/flopy4/mf6/dfns/olf-disv1d.toml b/flopy4/mf6/dfns/olf-disv1d.toml new file mode 100644 index 000000000..6f0c20549 --- /dev/null +++ b/flopy4/mf6/dfns/olf-disv1d.toml @@ -0,0 +1,277 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "olf-disv1d" +parent = "olf-nam" +ftype = "DISV1D6" + +[dims.nodes] +value = "nodes" +scope = "model" + +[dims.nvert] +value = "nvert" +scope = "model" + +[dims.ncelldim] +value = "1" +scope = "model" + +[runtime_dims.nodes] +set_in = "ar" + +[runtime_dims.nodesuser] +set_in = "ar" + +[blocks.options.fields.length_units] +type = "string" +longname = "model length units" +description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." +optional = true + +[blocks.options.fields.nogrb] +type = "keyword" +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." +optional = true + +[blocks.options.fields.grb_filerecord] +type = "record" +optional = true + +[blocks.options.fields.grb_filerecord.fields.grb6] +type = "keyword" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" + +[blocks.options.fields.xorigin] +type = "double" +longname = "x-position origin of the model grid coordinate system" +description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.yorigin] +type = "double" +longname = "y-position origin of the model grid coordinate system" +description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.angrot] +type = "double" +longname = "rotation angle" +description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.crs] +type = "string" +longname = "CRS user input string" +description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true +case_sensitive = true + +[blocks.dimensions.fields.nodes] +type = "integer" +longname = "number of linear features" +description = "is the number of linear cells." + +[blocks.dimensions.fields.nvert] +type = "integer" +longname = "number of vertices" +description = "is the total number of (x, y, z) vertex pairs used to characterize the model grid." +optional = true + +[blocks.griddata.fields.length] +type = "array" +longname = "length" +description = "length for each one-dimensional cell" +optional = true +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.width] +type = "array" +longname = "width" +description = "real value that defines the width for each one-dimensional cell. WIDTH must be greater than zero. If the Cross Section (CXS) Package is used, then the WIDTH value will be multiplied by the specified cross section x-fraction values." +optional = true +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.bottom] +type = "array" +longname = "bottom elevation for the one-dimensional cell" +description = "bottom elevation for the one-dimensional cell." +optional = true +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.idomain] +type = "array" +longname = "idomain existence array" +description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation." +optional = true +dtype = "integer" +shape = [ + "nodes", +] + +[blocks.vertices.fields.vertices] +type = "list" +longname = "vertices data" +shape = [ + "nvert", +] + +[blocks.vertices.fields.vertices.item] +name = "vertices" +type = "record" + +[blocks.vertices.fields.vertices.item.fields.iv] +type = "integer" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +tagged = false +index = true +pk = true + +[blocks.vertices.fields.vertices.item.fields.xv] +type = "double" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." +tagged = false + +[blocks.vertices.fields.vertices.item.fields.yv] +type = "double" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." +tagged = false + +[blocks.cell2d.fields.cell2d] +type = "list" +longname = "cell2d data" +shape = [ + "nodes", +] + +[blocks.cell2d.fields.cell2d.item] +name = "cell2d" +type = "record" + +[blocks.cell2d.fields.cell2d.item.fields.icell2d] +type = "integer" +longname = "cell2d number" +description = "is the cell2d number. Records in the cell2d block must be listed in consecutive order from the first to the last." +tagged = false +index = true +pk = true + +[blocks.cell2d.fields.cell2d.item.fields.fdc] +type = "double" +longname = "fractional distance to the cell center" +description = "is the fractional distance to the cell center. FDC is relative to the first vertex in the ICVERT array. In most cases FDC should be 0.5, which would place the center of the line segment that defines the cell. If the value of FDC is 1, the cell center would located at the last vertex. FDC values of 0 and 1 can be used to place the node at either end of the cell which can be useful for cells with boundary conditions." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.ncvert] +type = "integer" +longname = "number of cell vertices" +description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.icvert] +type = "array" +longname = "number of cell vertices" +description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC." +tagged = false +dtype = "integer" +index = true +shape = [ + "ncvert", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.nodes] +set_in = "ar" +source = "nodes" +type = "integer" + +[memory.nvert] +set_in = "ar" +source = "nvert" +type = "integer" + +[memory.length] +type = "array" +set_in = "ar" +source = "length" +dtype = "double" +shape = [ + "nodes", +] + +[memory.width] +type = "array" +set_in = "ar" +source = "width" +dtype = "double" +shape = [ + "nodes", +] + +[memory.bottom] +type = "array" +set_in = "ar" +source = "bottom" +dtype = "double" +shape = [ + "nodes", +] + +[memory.idomain] +type = "array" +set_in = "ar" +source = "idomain" +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodeuser] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodereduced] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." +dtype = "integer" +shape = [ + "nodesuser", +] diff --git a/flopy4/mf6/dfns/olf-disv2d.toml b/flopy4/mf6/dfns/olf-disv2d.toml new file mode 100644 index 000000000..396bbd0c8 --- /dev/null +++ b/flopy4/mf6/dfns/olf-disv2d.toml @@ -0,0 +1,243 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "olf-disv2d" +parent = "olf-nam" +ftype = "DISV2D6" + +[dims.nodes] +value = "nodes" +scope = "model" + +[dims.nvert] +value = "nvert" +scope = "model" + +[dims.ncelldim] +value = "1" +scope = "model" + +[runtime_dims.nodes] +set_in = "ar" + +[runtime_dims.nodesuser] +set_in = "ar" + +[blocks.options.fields.length_units] +type = "string" +longname = "model length units" +description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." +optional = true + +[blocks.options.fields.nogrb] +type = "keyword" +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." +optional = true + +[blocks.options.fields.grb_filerecord] +type = "record" +optional = true + +[blocks.options.fields.grb_filerecord.fields.grb6] +type = "keyword" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" + +[blocks.options.fields.xorigin] +type = "double" +longname = "x-position of the model grid origin" +description = "x-position of the lower-left corner of the model grid. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.yorigin] +type = "double" +longname = "y-position of the model grid origin" +description = "y-position of the lower-left corner of the model grid. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.angrot] +type = "double" +longname = "rotation angle" +description = "counter-clockwise rotation angle (in degrees) of the lower-left corner of the model grid. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.crs] +type = "string" +longname = "CRS user input string" +description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true +case_sensitive = true + +[blocks.dimensions.fields.nodes] +type = "integer" +longname = "number of cells per layer" +description = "is the number of cells per layer. This is a constant value for the grid and it applies to all layers." + +[blocks.dimensions.fields.nvert] +type = "integer" +longname = "number of vertices" +description = "is the total number of (x, y) vertex pairs used to characterize the horizontal configuration of the model grid." + +[blocks.griddata.fields.bottom] +type = "array" +longname = "model bottom elevation" +description = "is the bottom elevation for each cell." +dtype = "double" +shape = [ + "nodes", +] + +[blocks.griddata.fields.idomain] +type = "array" +longname = "idomain existence array" +description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1 or greater, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." +optional = true +dtype = "integer" +shape = [ + "nodes", +] + +[blocks.vertices.fields.vertices] +type = "list" +longname = "vertices data" +shape = [ + "nvert", +] + +[blocks.vertices.fields.vertices.item] +name = "vertices" +type = "record" + +[blocks.vertices.fields.vertices.item.fields.iv] +type = "integer" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +tagged = false +index = true +pk = true + +[blocks.vertices.fields.vertices.item.fields.xv] +type = "double" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." +tagged = false + +[blocks.vertices.fields.vertices.item.fields.yv] +type = "double" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." +tagged = false + +[blocks.cell2d.fields.cell2d] +type = "list" +longname = "cell2d data" +shape = [ + "nodes", +] + +[blocks.cell2d.fields.cell2d.item] +name = "cell2d" +type = "record" + +[blocks.cell2d.fields.cell2d.item.fields.icell2d] +type = "integer" +longname = "cell2d number" +description = "is the CELL2D number. Records in the CELL2D block must be listed in consecutive order from the first to the last." +tagged = false +index = true +pk = true + +[blocks.cell2d.fields.cell2d.item.fields.xc] +type = "double" +longname = "x-coordinate for cell center" +description = "is the x-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.yc] +type = "double" +longname = "y-coordinate for cell center" +description = "is the y-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.ncvert] +type = "integer" +longname = "number of cell vertices" +description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.icvert] +type = "array" +longname = "array of vertex numbers" +description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false +dtype = "integer" +index = true +shape = [ + "ncvert", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.nodes] +set_in = "ar" +source = "nodes" +type = "integer" + +[memory.nvert] +set_in = "ar" +source = "nvert" +type = "integer" + +[memory.bottom] +type = "array" +set_in = "ar" +source = "bottom" +dtype = "double" +shape = [ + "nodes", +] + +[memory.idomain] +type = "array" +set_in = "ar" +source = "idomain" +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodeuser] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodereduced] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." +dtype = "integer" +shape = [ + "nodesuser", +] diff --git a/flopy4/mf6/dfns/olf-evp.toml b/flopy4/mf6/dfns/olf-evp.toml new file mode 100644 index 000000000..c58e1bb49 --- /dev/null +++ b/flopy4/mf6/dfns/olf-evp.toml @@ -0,0 +1,295 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "olf-evp" +parent = "olf-nam" +ftype = "EVP6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of evaporation." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of evaporation cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of evaporation information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print evaporation rates to listing file" +description = "keyword to indicate that the list of evaporation flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save evaporation to budget file" +description = "keyword to indicate that evaporation flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the EVP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVP package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of evaporation cells" +description = "integer value specifying the maximum number of evaporation cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.evaporation] +type = "double" +longname = "evaporation rate" +description = "is the evaporation flux rate ($LT^{-1}$). This rate is multiplied inside the program by the water surface area of the cell to calculate the volumetric evaporation rate. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "evaporation name" +description = "name of the evaporation cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: evaporation." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "EVP" +output = true +obs_type = "EVP" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.evp] +type = "union" + +[observations.evp.arms.cellid] +type = "cellid" +tagged = false + +[observations.evp.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/olf-flw.toml b/flopy4/mf6/dfns/olf-flw.toml new file mode 100644 index 000000000..14e2edd7b --- /dev/null +++ b/flopy4/mf6/dfns/olf-flw.toml @@ -0,0 +1,308 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "olf-flw" +parent = "olf-nam" +ftype = "FLW6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of flow rate." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of inflow cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of inflow information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of inflow flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save well flows to budget file" +description = "keyword to indicate that inflow flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the FLW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the FLW package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of inflow" +description = "integer value specifying the maximum number of inflow cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.q] +type = "double" +longname = "flow rate" +description = "is the volumetric inflow rate. A positive value indicates inflow to the stream. Negative values are not allowed. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "inflow name" +description = "name of the inflow cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: q." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "FLW" +output = true +obs_type = "FLW" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "FLW-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.flw] +type = "union" + +[observations.flw.arms.cellid] +type = "cellid" +tagged = false + +[observations.flw.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/olf-ic.toml b/flopy4/mf6/dfns/olf-ic.toml new file mode 100644 index 000000000..a80042d0a --- /dev/null +++ b/flopy4/mf6/dfns/olf-ic.toml @@ -0,0 +1,39 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "olf-ic" +parent = "olf-nam" +ftype = "IC6" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.griddata.fields.strt] +type = "array" +longname = "starting concentration" +description = "is the initial (starting) stage---that is, stage at the beginning of the OLF Model simulation. STRT must be specified for all OLF Model simulations. One value is read for every model reach." +default = 0.0 +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.strt] +type = "array" +set_in = "ar" +source = "strt" +dtype = "double" +shape = [ + "nodes", +] diff --git a/flopy4/mf6/dfns/olf-nam.toml b/flopy4/mf6/dfns/olf-nam.toml new file mode 100644 index 000000000..81aa4240e --- /dev/null +++ b/flopy4/mf6/dfns/olf-nam.toml @@ -0,0 +1,167 @@ +type = "model" +schema_version = "2.0.0.dev3" +name = "olf-nam" +parent = "sim-nam" +ftype = "OLF6" +dependent_variable = "stage" + +[runtime_dims.nja] +set_in = "ar" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.list] +type = "string" +longname = "name of listing file" +description = "is name of the listing file to create for this OLF model. If not specified, then the name of the list file will be the basename of the OLF model name file and the '.lst' extension. For example, if the OLF name file is called 'my.model.nam' then the list file will be called 'my.model.lst'." +optional = true +case_sensitive = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save flows for all packages to budget file" +description = "keyword to indicate that all model package flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.newtonoptions] +type = "record" +longname = "newton keyword and options" +description = "none" +optional = true + +[blocks.options.fields.newtonoptions.fields.newton] +type = "keyword" +longname = "keyword to activate Newton-Raphson formulation" +description = "keyword that activates the Newton-Raphson formulation for surface water flow between connected reaches and stress packages that support calculation of Newton-Raphson terms." + +[blocks.options.fields.newtonoptions.fields.under_relaxation] +type = "keyword" +longname = "keyword to activate Newton-Raphson UNDER_RELAXATION option" +description = "keyword that indicates whether the surface water stage in a reach will be under-relaxed when water levels fall below the bottom of the model below any given cell. By default, Newton-Raphson UNDER_RELAXATION is not applied." +optional = true + +[blocks.packages.fields.packages] +type = "list" +longname = "package list" + +[blocks.packages.fields.packages.item] +name = "packages" +type = "record" + +[blocks.packages.fields.packages.item.fields.ftype] +type = "string" +longname = "package type" +description = "is the file type, which must be one of the following character values shown in table~ref{table:ftype-olf}. Ftype may be entered in any combination of uppercase and lowercase." +tagged = false + +[blocks.packages.fields.packages.item.fields.fname] +type = "file" +longname = "file name" +description = "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run." +tagged = false +direction = "in" +mode_keyword = false +component = "package" +component_ftype = "ftype" + +[blocks.packages.fields.packages.item.fields.pname] +type = "string" +longname = "user name for package" +description = "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single OLF Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters." +optional = true +tagged = false +pk = true + +[memory.x] +type = "array" +set_in = "ca" +description = "Stage for each model cell. Checked in from the solution-level dependent-variable vector (or directly allocated when the DFW package is absent). Initialized by the IC package during AR; updated by the nonlinear solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." +obs_type = "STAGE" +dtype = "double" +shape = [ + "nodes", +] + +[memory.xold] +type = "array" +readonly = true +set_in = "ad" +description = "Dependent variable from the end of the previous time step. Copied from X at advance (AD); used to restore X if the adaptive time stepping scheme retries a failed time step." +dtype = "double" +shape = [ + "nodes", +] + +[memory.flowja] +type = "array" +readonly = true +set_in = "cq" +description = "Intercell flows in compressed sparse row (CSR) order, calculated after solution convergence. Diagonal entries hold the flow residual." +budget = "FLOW-JA-FACE" +dtype = "double" +shape = [ + "nja", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution for this model, sliced from the solution-level RHS vector. Rebuilt each solver iteration." +dtype = "double" +shape = [ + "nodes", +] + +[memory.ibound] +type = "array" +set_in = "ar" +description = "Cell activity flag: positive values indicate active cells, zero indicates inactive (no-flow) cells. Set during model initialisation; may change when Newton-Raphson wet-dry logic activates or deactivates cells." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.neq] +readonly = true +set_in = "ar" +description = "Number of equations (unknowns) for this model. Equal to the number of active cells (NODES) for standard models." +type = "integer" + +[memory.idxglo] +type = "array" +readonly = true +set_in = "mc" +description = "Maps each local CSR position to the corresponding row/column index in the global solution matrix. Populated during matrix connectivity (MC) and constant thereafter." +dtype = "integer" +shape = [ + "nja", +] + +[observations.stage] +type = "cellid" +tagged = false + +[observations.flow-ja-face] +type = "record" + +[observations.flow-ja-face.fields.cellid] +type = "cellid" +tagged = false + +[observations.flow-ja-face.fields.cellid2] +type = "cellid" +tagged = false diff --git a/flopy4/mf6/dfns/olf-oc.toml b/flopy4/mf6/dfns/olf-oc.toml new file mode 100644 index 000000000..003fcb72f --- /dev/null +++ b/flopy4/mf6/dfns/olf-oc.toml @@ -0,0 +1,223 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "olf-oc" +parent = "olf-nam" +ftype = "OC6" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information. Data are written to this file only for time steps in which SAVE BUDGET is specified in a PERIOD block. If SAVE BUDGET is specified in a PERIOD block and this file is not specified, MODFLOW 6 will terminate with an error." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. If specified, a budget summary record will be written to this file for every time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.qoutflow_filerecord] +type = "record" +optional = true + +[blocks.options.fields.qoutflow_filerecord.fields.qoutflow] +type = "keyword" +longname = "qoutflow keyword" +description = "keyword to specify that record corresponds to qoutflow." + +[blocks.options.fields.qoutflow_filerecord.fields.qoutflowfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write conc information." +tagged = false +direction = "out" + +[blocks.options.fields.stage_filerecord] +type = "record" +optional = true + +[blocks.options.fields.stage_filerecord.fields.stage] +type = "keyword" +longname = "stage keyword" +description = "keyword to specify that record corresponds to stage." + +[blocks.options.fields.stage_filerecord.fields.stagefile] +type = "file" +longname = "file keyword" +description = "name of the output file to write stage information." +tagged = false +direction = "out" + +[blocks.options.fields.qoutflowprintrecord] +type = "record" +optional = true + +[blocks.options.fields.qoutflowprintrecord.fields.qoutflow] +type = "keyword" +longname = "qoutflow keyword" +description = "keyword to specify that record corresponds to qoutflow." + +[blocks.options.fields.qoutflowprintrecord.fields.print_format] +type = "keyword" +longname = "keyword to indicate that a print format follows" +description = "keyword to specify format for printing to the listing file." + +[blocks.options.fields.qoutflowprintrecord.fields.formatrecord] +type = "record" + +[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.columns] +type = "integer" +longname = "number of columns" +description = "number of columns for writing data." +optional = true + +[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.width] +type = "integer" +longname = "width for each number" +description = "width for writing each number." +optional = true + +[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.digits] +type = "integer" +longname = "number of digits" +description = "number of digits to use for writing a number." +optional = true + +[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.format] +type = "string" +longname = "write format" +description = "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC." +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" +optional = true + +[blocks.period.fields.stress_period_data.item] +name = "output_record" +type = "union" + +[blocks.period.fields.stress_period_data.item.arms.saverecord] +type = "record" +optional = true + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.save] +type = "keyword" +longname = "keyword to save" +description = "keyword to indicate that information will be saved this stress period." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.rtype] +type = "string" +longname = "record type" +description = "type of information to save or print. Can be BUDGET." +tagged = false +valid = [ + "STAGE", + "BUDGET", +] + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting] +type = "union" +description = "specifies the steps for which the data will be saved." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.all] +type = "keyword" +description = "keyword to indicate save for all time steps in period." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.first] +type = "keyword" +description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.last] +type = "keyword" +description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.frequency] +type = "integer" +description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.steps] +type = "array" +description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." +dtype = "integer" +shape = [ + "<=nstp", +] + +[blocks.period.fields.stress_period_data.item.arms.printrecord] +type = "record" +optional = true + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.print] +type = "keyword" +longname = "keyword to save" +description = "keyword to indicate that information will be printed this stress period." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.rtype] +type = "string" +longname = "record type" +description = "type of information to save or print. Can be BUDGET." +tagged = false +valid = [ + "STAGE", + "BUDGET", +] + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting] +type = "union" +description = "specifies the steps for which the data will be saved." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.all] +type = "keyword" +description = "keyword to indicate save for all time steps in period." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.first] +type = "keyword" +description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.last] +type = "keyword" +description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.frequency] +type = "integer" +description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.steps] +type = "array" +description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." +dtype = "integer" +shape = [ + "<=nstp", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true diff --git a/flopy4/mf6/dfns/olf-pcp.toml b/flopy4/mf6/dfns/olf-pcp.toml new file mode 100644 index 000000000..8c3231e36 --- /dev/null +++ b/flopy4/mf6/dfns/olf-pcp.toml @@ -0,0 +1,295 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "olf-pcp" +parent = "olf-nam" +ftype = "PCP6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.auxmultname] +type = "string" +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of precipitation." +optional = true + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of precipitation cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of precipitation information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print precipitation rates to listing file" +description = "keyword to indicate that the list of precipitation flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save precipitation to budget file" +description = "keyword to indicate that precipitation flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the PCP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the PCP package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of precipitation cells" +description = "integer value specifying the maximum number of precipitation cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.precipitation] +type = "double" +longname = "precipitation rate" +description = "is the precipitation flux rate ($LT^{-1}$). This rate is multiplied inside the program by the surface area of the cell to calculate the volumetric precipitation rate. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "precipitation name" +description = "name of the precipitation cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: precipitation." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "PCP" +output = true +obs_type = "PCP" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.pcp] +type = "union" + +[observations.pcp.arms.cellid] +type = "cellid" +tagged = false + +[observations.pcp.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/olf-sto.toml b/flopy4/mf6/dfns/olf-sto.toml new file mode 100644 index 000000000..e5a70c960 --- /dev/null +++ b/flopy4/mf6/dfns/olf-sto.toml @@ -0,0 +1,53 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "olf-sto" +parent = "olf-nam" +ftype = "STO6" + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "keyword to save NPF flows" +description = "keyword to indicate that cell-by-cell flow terms will be written to the file specified with 'BUDGET SAVE FILE' in Output Control." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input grid arrays, which already support the layered keyword, should be written to layered ascii output files." +optional = true + +[blocks.period.fields.stress_period_data] +type = "string" +longname = "storage state" +description = "keyword to indicate that stress period IPER is steady-state. Steady-state conditions will apply until the TRANSIENT keyword is specified in a subsequent BEGIN PERIOD block." +optional = true +tagged = false +valid = [ + "steady-state", + "transient", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +type = "integer" + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.steady_state] +set_in = "rp" +type = "logical" diff --git a/flopy4/mf6/dfns/olf-zdg.toml b/flopy4/mf6/dfns/olf-zdg.toml new file mode 100644 index 000000000..5a2dbf252 --- /dev/null +++ b/flopy4/mf6/dfns/olf-zdg.toml @@ -0,0 +1,324 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "olf-zdg" +parent = "olf-nam" +ftype = "ZDG6" +multi = true +subtype = "stress" + +[dims.maxbound] +value = "maxbound" + +[dims.auxiliary] +value = "len(auxiliary)" + +[dims.naux] +value = "len(auxiliary)" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.auxiliary] +type = "array" +longname = "keyword to specify aux variables" +description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." +optional = true +dtype = "string" + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of zero-depth-gradient boundary cells." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of zero-depth-gradient boundary information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of zero-depth-gradient boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save flows to budget file" +description = "keyword to indicate that zero-depth-gradient boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.options.fields.obs_filerecord] +type = "record" +optional = true + +[blocks.options.fields.obs_filerecord.fields.obs6] +type = "keyword" +longname = "obs keyword" +description = "keyword to specify that record corresponds to an observations file." + +[blocks.options.fields.obs_filerecord.fields.obs6_filename] +type = "file" +longname = "obs6 input filename" +description = "name of input file to define observations for the ZDG package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ZDG package." +tagged = false +direction = "in" +component = "utl-obs" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of zero-depth-gradient boundaries" +description = "integer value specifying the maximum number of zero-depth-gradient boundary cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "stress_period_data" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.idcxs] +type = "integer" +longname = "cross section identifier" +description = "is the identifier for the cross section specified in the CXS Package. A value of zero indicates the zero-depth-gradient calculation will use parameters for a hydraulically wide channel." +tagged = false +index = true +fk = "chf-cxs.packagedata.ifno" + +[blocks.period.fields.stress_period_data.item.fields.width] +type = "double" +longname = "width of the zero-depth gradient boundary" +description = "is the channel width of the zero-depth gradient boundary. If a cross section is associated with this boundary, the width will be scaled by the cross section information. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.slope] +type = "double" +longname = "channel slope" +description = "is the channel slope used to calculate flow to the zero-depth-gradient boundary. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.rough] +type = "double" +longname = "channel roughness" +description = "is the Manning channel roughness value used to calculate flow to the zero-depth-gradient boundary. If a cross section is associated with this boundary, the roughness value will be multiplied by the roughness fraction for each part of the cross section. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +tagged = false +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.aux] +type = "array" +longname = "auxiliary variables" +description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +optional = true +tagged = false +dtype = "double" +time_series = true +shape = [ + "auxiliary", +] + +[blocks.period.fields.stress_period_data.item.fields.boundname] +type = "string" +longname = "zero-depth-gradient boundary name" +description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iprflow] +set_in = "ar" +source = "print_flows" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +source = "save_flows" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.auxvar] +type = "array" +source = "aux" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period. Columns (0-indexed): 0: idcxs, 1: width, 2: slope, 3: rough." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "ZDG" +output = true +obs_type = "ZDG" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "ZDG-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[observations.zdg] +type = "union" + +[observations.zdg.arms.cellid] +type = "cellid" +tagged = false + +[observations.zdg.arms.boundname] +type = "string" +tagged = false + +[observations.to-mvr] +type = "union" + +[observations.to-mvr.arms.cellid] +type = "cellid" +tagged = false + +[observations.to-mvr.arms.boundname] +type = "string" +tagged = false + +[keys] +bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/prt-dis.toml b/flopy4/mf6/dfns/prt-dis.toml new file mode 100644 index 000000000..a7f6b58ca --- /dev/null +++ b/flopy4/mf6/dfns/prt-dis.toml @@ -0,0 +1,297 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "prt-dis" +parent = "prt-nam" +ftype = "DIS6" + +[dims.nlay] +value = "nlay" +scope = "model" + +[dims.nrow] +value = "nrow" +scope = "model" + +[dims.ncol] +value = "ncol" +scope = "model" + +[dims.ncpl] +value = "nrow * ncol" +scope = "model" + +[dims.nodes] +value = "nlay * nrow * ncol" +scope = "model" + +[dims.ncelldim] +value = "3" +scope = "model" + +[runtime_dims.nodes] +set_in = "ar" + +[runtime_dims.nodesuser] +set_in = "ar" + +[blocks.options.fields.length_units] +type = "string" +longname = "model length units" +description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." +optional = true + +[blocks.options.fields.nogrb] +type = "keyword" +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." +optional = true + +[blocks.options.fields.grb_filerecord] +type = "record" +optional = true + +[blocks.options.fields.grb_filerecord.fields.grb6] +type = "keyword" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." +tagged = false +direction = "out" + +[blocks.options.fields.xorigin] +type = "double" +longname = "x-position of the model grid origin" +description = "x-position of the lower-left corner of the model grid. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.yorigin] +type = "double" +longname = "y-position of the model grid origin" +description = "y-position of the lower-left corner of the model grid. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.angrot] +type = "double" +longname = "rotation angle" +description = "counter-clockwise rotation angle (in degrees) of the lower-left corner of the model grid. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.options.fields.crs] +type = "string" +longname = "CRS user input string" +description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true +case_sensitive = true + +[blocks.options.fields.ncf_filerecord] +type = "record" +optional = true + +[blocks.options.fields.ncf_filerecord.fields.ncf6] +type = "keyword" +longname = "ncf keyword" +description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" +component = "utl-ncf" + +[blocks.dimensions.fields.nlay] +type = "integer" +longname = "number of layers" +description = "is the number of layers in the model grid." +default = 1 + +[blocks.dimensions.fields.nrow] +type = "integer" +longname = "number of rows" +description = "is the number of rows in the model grid." +default = 2 + +[blocks.dimensions.fields.ncol] +type = "integer" +longname = "number of columns" +description = "is the number of columns in the model grid." +default = 2 + +[blocks.griddata.fields.delr] +type = "array" +longname = "spacing along a row" +description = "is the column spacing in the row direction." +default = 1.0 +dtype = "double" +shape = [ + "ncol", +] + +[blocks.griddata.fields.delc] +type = "array" +longname = "spacing along a column" +description = "is the row spacing in the column direction." +default = 1.0 +dtype = "double" +shape = [ + "nrow", +] + +[blocks.griddata.fields.top] +type = "array" +longname = "cell top elevation" +description = "is the top elevation for each cell in the top model layer." +default = 1.0 +dtype = "double" +shape = [ + "ncol", + "nrow", +] + +[blocks.griddata.fields.botm] +type = "array" +longname = "cell bottom elevation" +description = "is the bottom elevation for each cell." +default = 0.0 +dtype = "double" +layered = true +shape = [ + "ncol", + "nrow", + "nlay", +] + +[blocks.griddata.fields.idomain] +type = "array" +longname = "idomain existence array" +description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." +optional = true +dtype = "integer" +layered = true +shape = [ + "ncol", + "nrow", + "nlay", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.nlay] +set_in = "ar" +source = "nlay" +type = "integer" + +[memory.nrow] +set_in = "ar" +source = "nrow" +type = "integer" + +[memory.ncol] +set_in = "ar" +source = "ncol" +type = "integer" + +[memory.delr] +type = "array" +set_in = "ar" +source = "delr" +dtype = "double" +shape = [ + "ncol", +] + +[memory.delc] +type = "array" +set_in = "ar" +source = "delc" +dtype = "double" +shape = [ + "nrow", +] + +[memory.top] +type = "array" +set_in = "ar" +source = "top" +dtype = "double" +shape = [ + "ncol", + "nrow", +] + +[memory.botm] +type = "array" +set_in = "ar" +source = "botm" +dtype = "double" +shape = [ + "ncol", + "nrow", + "nlay", +] + +[memory.idomain] +type = "array" +set_in = "ar" +source = "idomain" +dtype = "integer" +shape = [ + "ncol", + "nrow", + "nlay", +] + +[memory.area] +type = "array" +readonly = true +set_in = "ar" +description = "Horizontal cell area, computed from grid geometry." +dtype = "double" +shape = [ + "ncpl", +] + +[memory.nodeuser] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodereduced] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." +dtype = "integer" +shape = [ + "nodesuser", +] diff --git a/flopy4/mf6/dfns/prt-disv.toml b/flopy4/mf6/dfns/prt-disv.toml new file mode 100644 index 000000000..41d6fc164 --- /dev/null +++ b/flopy4/mf6/dfns/prt-disv.toml @@ -0,0 +1,323 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "prt-disv" +parent = "prt-nam" +ftype = "DISV6" + +[dims.nlay] +value = "nlay" +scope = "model" + +[dims.ncpl] +value = "ncpl" +scope = "model" + +[dims.nvert] +value = "nvert" +scope = "model" + +[dims.nodes] +value = "nlay * ncpl" +scope = "model" + +[dims.ncelldim] +value = "2" +scope = "model" + +[runtime_dims.nodes] +set_in = "ar" + +[runtime_dims.nodesuser] +set_in = "ar" + +[blocks.options.fields.length_units] +type = "string" +longname = "model length units" +description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." +optional = true + +[blocks.options.fields.nogrb] +type = "keyword" +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." +optional = true + +[blocks.options.fields.grb_filerecord] +type = "record" +optional = true + +[blocks.options.fields.grb_filerecord.fields.grb6] +type = "keyword" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." + +[blocks.options.fields.grb_filerecord.fields.grb6_filename] +type = "file" +longname = "file name of GRB information" +description = "defines a binary grid output file." +tagged = false +direction = "out" + +[blocks.options.fields.xorigin] +type = "double" +longname = "x-position origin of the model grid coordinate system" +description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.yorigin] +type = "double" +longname = "y-position origin of the model grid coordinate system" +description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.angrot] +type = "double" +longname = "rotation angle" +description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.options.fields.export_array_netcdf] +type = "keyword" +longname = "export array variables to netcdf output files." +description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." +optional = true + +[blocks.options.fields.crs] +type = "string" +longname = "CRS user input string" +description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." +optional = true +case_sensitive = true + +[blocks.options.fields.ncf_filerecord] +type = "record" +optional = true + +[blocks.options.fields.ncf_filerecord.fields.ncf6] +type = "keyword" +longname = "ncf keyword" +description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." + +[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] +type = "file" +longname = "file name of NCF information" +description = "defines a NetCDF configuration (NCF) input file." +tagged = false +direction = "in" +component = "utl-ncf" + +[blocks.dimensions.fields.nlay] +type = "integer" +longname = "number of layers" +description = "is the number of layers in the model grid." + +[blocks.dimensions.fields.ncpl] +type = "integer" +longname = "number of cells per layer" +description = "is the number of cells per layer. This is a constant value for the grid and it applies to all layers." + +[blocks.dimensions.fields.nvert] +type = "integer" +longname = "number of vertices" +description = "is the total number of (x, y) vertex pairs used to characterize the horizontal configuration of the model grid." + +[blocks.griddata.fields.top] +type = "array" +longname = "model top elevation" +description = "is the top elevation for each cell in the top model layer." +dtype = "double" +shape = [ + "ncpl", +] + +[blocks.griddata.fields.botm] +type = "array" +longname = "model bottom elevation" +description = "is the bottom elevation for each cell." +dtype = "double" +layered = true +shape = [ + "ncpl", + "nlay", +] + +[blocks.griddata.fields.idomain] +type = "array" +longname = "idomain existence array" +description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." +optional = true +dtype = "integer" +layered = true +shape = [ + "ncpl", + "nlay", +] + +[blocks.vertices.fields.vertices] +type = "list" +longname = "vertices data" +shape = [ + "nvert", +] + +[blocks.vertices.fields.vertices.item] +name = "vertices" +type = "record" + +[blocks.vertices.fields.vertices.item.fields.iv] +type = "integer" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +tagged = false +index = true +pk = true + +[blocks.vertices.fields.vertices.item.fields.xv] +type = "double" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." +tagged = false + +[blocks.vertices.fields.vertices.item.fields.yv] +type = "double" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." +tagged = false + +[blocks.cell2d.fields.cell2d] +type = "list" +longname = "cell2d data" +shape = [ + "ncpl", +] + +[blocks.cell2d.fields.cell2d.item] +name = "cell2d" +type = "record" + +[blocks.cell2d.fields.cell2d.item.fields.icell2d] +type = "integer" +longname = "cell2d number" +description = "is the CELL2D number. Records in the CELL2D block must be listed in consecutive order from the first to the last." +tagged = false +index = true +pk = true + +[blocks.cell2d.fields.cell2d.item.fields.xc] +type = "double" +longname = "x-coordinate for cell center" +description = "is the x-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.yc] +type = "double" +longname = "y-coordinate for cell center" +description = "is the y-coordinate for the cell center." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.ncvert] +type = "integer" +longname = "number of cell vertices" +description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." +tagged = false + +[blocks.cell2d.fields.cell2d.item.fields.icvert] +type = "array" +longname = "array of vertex numbers" +description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." +tagged = false +dtype = "integer" +index = true +shape = [ + "ncvert", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.export_nc] +set_in = "ar" +source = "export_array_netcdf" +type = "logical" + +[memory.nlay] +set_in = "ar" +source = "nlay" +type = "integer" + +[memory.ncpl] +set_in = "ar" +source = "ncpl" +type = "integer" + +[memory.nvert] +set_in = "ar" +source = "nvert" +type = "integer" + +[memory.top] +type = "array" +set_in = "ar" +source = "top" +dtype = "double" +shape = [ + "ncpl", +] + +[memory.botm] +type = "array" +set_in = "ar" +source = "botm" +dtype = "double" +shape = [ + "ncpl", + "nlay", +] + +[memory.idomain] +type = "array" +set_in = "ar" +source = "idomain" +dtype = "integer" +shape = [ + "ncpl", + "nlay", +] + +[memory.area] +type = "array" +readonly = true +set_in = "ar" +description = "Horizontal cell area, computed from grid geometry." +dtype = "double" +shape = [ + "ncpl", +] + +[memory.nodeuser] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." +dtype = "integer" +shape = [ + "nodes", +] + +[memory.nodereduced] +type = "array" +readonly = true +set_in = "ar" +description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." +dtype = "integer" +shape = [ + "nodesuser", +] diff --git a/flopy4/mf6/dfns/prt-fmi.toml b/flopy4/mf6/dfns/prt-fmi.toml new file mode 100644 index 000000000..628c5ffc6 --- /dev/null +++ b/flopy4/mf6/dfns/prt-fmi.toml @@ -0,0 +1,33 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "prt-fmi" +parent = "prt-nam" +ftype = "FMI6" + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save cell-by-cell flows to budget file" +description = "keyword to indicate that FMI flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.packagedata.fields.packagedata] +type = "list" +longname = "flowtype list" +optional = true + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.flowtype] +type = "string" +longname = "flow type" +description = "is the word GWFBUDGET, GWFHEAD, or GWFGRID. If GWFBUDGET is specified, then the corresponding file must be a budget file. If GWFHEAD is specified, the file must be a head file. If GWFGRID is specified, the file must be a binary grid file." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.fname] +type = "file" +longname = "file name" +description = "is the name of the file containing flows. The path to the file should be included if the file is not located in the folder where the program was run." +tagged = false +direction = "in" diff --git a/flopy4/mf6/dfns/prt-mip.toml b/flopy4/mf6/dfns/prt-mip.toml new file mode 100644 index 000000000..e5155fa1a --- /dev/null +++ b/flopy4/mf6/dfns/prt-mip.toml @@ -0,0 +1,78 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "prt-mip" +parent = "prt-nam" +ftype = "MIP6" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.export_array_ascii] +type = "keyword" +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +optional = true + +[blocks.griddata.fields.porosity] +type = "array" +longname = "porosity" +description = "is the aquifer porosity." +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.retfactor] +type = "array" +longname = "retardation factor" +description = "is a real value by which velocity is divided within a given cell. RETFACTOR can be used to account for solute retardation, i.e., the apparent effect of linear sorption on the velocity of particles that track solute advection. RETFACTOR may be assigned any real value. A RETFACTOR value greater than 1 represents particle retardation (slowing), and a value of 1 represents no retardation. The effect of specifying a RETFACTOR value for each cell is the same as the effect of directly multiplying the POROSITY in each cell by the proposed RETFACTOR value for each cell. RETFACTOR allows conceptual isolation of effects such as retardation from the effect of porosity. The default value is 1." +optional = true +dtype = "double" +layered = true +shape = [ + "nodes", +] + +[blocks.griddata.fields.izone] +type = "array" +longname = "zone number" +description = "is an integer zone number assigned to each cell. IZONE may be positive, negative, or zero. The current cell's zone number is recorded with each particle track datum. If a PRP package's ISTOPZONE option is set to any value other than zero, particles released by that PRP Package terminate if they enter a cell whose IZONE value matches ISTOPZONE. If ISTOPZONE is not specified or is set to zero in a PRP Package, IZONE has no effect on the termination of particles released by that PRP Package. Each PRP Package may configure a single ISTOPZONE value." +optional = true +dtype = "integer" +layered = true +shape = [ + "nodes", +] + +[memory.export_ascii] +set_in = "ar" +source = "export_array_ascii" +type = "logical" + +[memory.porosity] +type = "array" +set_in = "ar" +source = "porosity" +dtype = "double" +shape = [ + "nodes", +] + +[memory.retfactor] +type = "array" +set_in = "ar" +source = "retfactor" +dtype = "double" +shape = [ + "nodes", +] + +[memory.izone] +type = "array" +set_in = "ar" +source = "izone" +dtype = "integer" +shape = [ + "nodes", +] diff --git a/flopy4/mf6/dfns/prt-nam.toml b/flopy4/mf6/dfns/prt-nam.toml new file mode 100644 index 000000000..a9c360076 --- /dev/null +++ b/flopy4/mf6/dfns/prt-nam.toml @@ -0,0 +1,87 @@ +type = "model" +schema_version = "2.0.0.dev3" +name = "prt-nam" +parent = "sim-nam" +ftype = "PRT6" + +[runtime_dims.nja] +set_in = "ar" + +[runtime_dims.nodes] +set_in = "ar" + +[blocks.options.fields.list] +type = "string" +longname = "name of listing file" +description = "is name of the listing file to create for this PRT model. If not specified, then the name of the list file will be the basename of the PRT model name file and the '.lst' extension. For example, if the PRT name file is called 'my.model.nam' then the list file will be called 'my.model.lst'." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.print_flows] +type = "keyword" +longname = "print calculated flows to listing file" +description = "keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." +optional = true + +[blocks.options.fields.save_flows] +type = "keyword" +longname = "save flows for all packages to budget file" +description = "keyword to indicate that all model package flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." +optional = true + +[blocks.packages.fields.packages] +type = "list" +longname = "package list" + +[blocks.packages.fields.packages.item] +name = "packages" +type = "record" + +[blocks.packages.fields.packages.item.fields.ftype] +type = "string" +longname = "package type" +description = "is the file type, which must be one of the following character values shown in table~ref{table:ftype-prt}. Ftype may be entered in any combination of uppercase and lowercase." +tagged = false + +[blocks.packages.fields.packages.item.fields.fname] +type = "file" +longname = "file name" +description = "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run." +tagged = false +direction = "in" +mode_keyword = false +component = "package" +component_ftype = "ftype" + +[blocks.packages.fields.packages.item.fields.pname] +type = "string" +longname = "user name for package" +description = "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single PRT Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters." +optional = true +tagged = false +pk = true + +[memory.flowja] +type = "array" +readonly = true +set_in = "cq" +description = "Intercell flows in compressed sparse row (CSR) order, calculated after solution convergence. Diagonal entries hold the flow residual." +budget = "FLOW-JA-FACE" +dtype = "double" +shape = [ + "nja", +] + +[memory.ibound] +type = "array" +set_in = "ar" +description = "Cell activity flag: positive values indicate active cells, zero indicates inactive (no-flow) cells. Set during model initialisation; may change when Newton-Raphson wet-dry logic activates or deactivates cells." +dtype = "integer" +shape = [ + "nodes", +] diff --git a/flopy4/mf6/dfns/prt-oc.toml b/flopy4/mf6/dfns/prt-oc.toml new file mode 100644 index 000000000..85c7228c2 --- /dev/null +++ b/flopy4/mf6/dfns/prt-oc.toml @@ -0,0 +1,318 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "prt-oc" +parent = "prt-nam" +ftype = "OC6" + +[dims.ntracktimes] +value = "ntracktimes" + +[blocks.options.fields.budget_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budget_filerecord.fields.budget] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[blocks.options.fields.budget_filerecord.fields.budgetfile] +type = "file" +longname = "file keyword" +description = "name of the output file to write budget information. Data are written to this file only for time steps in which SAVE BUDGET is specified in a PERIOD block. If SAVE BUDGET is specified in a PERIOD block and this file is not specified, MODFLOW 6 will terminate with an error." +tagged = false +direction = "out" + +[blocks.options.fields.budgetcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) output file to write budget summary information. If specified, a budget summary record will be written to this file for every time step of the simulation." +tagged = false +direction = "out" + +[blocks.options.fields.track_filerecord] +type = "record" +optional = true + +[blocks.options.fields.track_filerecord.fields.track] +type = "keyword" +longname = "track keyword" +description = "keyword to specify that record corresponds to a binary track file. Each PRT Model's OC Package may have only one binary track output file." + +[blocks.options.fields.track_filerecord.fields.trackfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write tracking information." +tagged = false +direction = "out" + +[blocks.options.fields.trackcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.trackcsv_filerecord.fields.trackcsv] +type = "keyword" +longname = "track keyword" +description = "keyword to specify that record corresponds to a CSV track file. Each PRT Model's OC Package may have only one CSV track file." + +[blocks.options.fields.trackcsv_filerecord.fields.trackcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) file to write tracking information." +tagged = false +direction = "out" + +[blocks.options.fields.track_release] +type = "keyword" +longname = "track release" +description = "keyword to indicate that particle tracking output is to be written when a particle is released" +optional = true + +[blocks.options.fields.track_exit] +type = "keyword" +longname = "track domain exits" +description = "keyword to indicate that particle tracking output is to be written when a particle exits a grid feature (e.g. model, cell)" +optional = true + +[blocks.options.fields.track_subfeature_exit] +type = "keyword" +longname = "track cell exits" +description = "keyword to indicate that particle tracking output is to be written when a particle exits a sub-grid-scale feature. Such features are considered implementation details of the tracking algorithm employed for particular grid types, and reporting for exit events from such features is disabled by default." +optional = true + +[blocks.options.fields.track_timestep] +type = "keyword" +longname = "track timestep ends" +description = "keyword to indicate that particle tracking output is to be written at the end of each time step" +optional = true + +[blocks.options.fields.track_terminate] +type = "keyword" +longname = "track termination" +description = "keyword to indicate that particle tracking output is to be written when a particle terminates for any reason" +optional = true + +[blocks.options.fields.track_weaksink] +type = "keyword" +longname = "track weaksink exits" +description = "keyword to indicate that particle tracking output is to be written when a particle exits a weak sink (a cell which removes some but not all inflow from adjacent cells)" +optional = true + +[blocks.options.fields.track_usertime] +type = "keyword" +longname = "track user-specified times" +description = "keyword to indicate that particle tracking output is to be written at user-specified times, provided as double precision values in the TRACKTIMES block." +optional = true + +[blocks.options.fields.track_dropped] +type = "keyword" +longname = "track drops to water table" +description = "keyword to indicate that particle tracking output is to be written when a particle is dropped to the water table via DRY_TRACKING_METHOD DROP." +optional = true + +[blocks.options.fields.track_timesrecord] +type = "record" +optional = true +removed = "6.6.0" + +[blocks.options.fields.track_timesrecord.fields.track_times] +type = "keyword" +description = "keyword indicating tracking times will follow" +removed = "6.6.0" + +[blocks.options.fields.track_timesrecord.fields.times] +type = "array" +longname = "tracking times" +description = "times to track, relative to the beginning of the simulation." +tagged = false +removed = "6.6.0" +dtype = "double" + +[blocks.options.fields.track_timesfilerecord] +type = "record" +optional = true +removed = "6.6.0" + +[blocks.options.fields.track_timesfilerecord.fields.track_timesfile] +type = "keyword" +description = "keyword indicating tracking times file name will follow" +removed = "6.6.0" + +[blocks.options.fields.track_timesfilerecord.fields.timesfile] +type = "string" +longname = "file keyword" +description = "name of the tracking times file" +tagged = false +removed = "6.6.0" +case_sensitive = true + +[blocks.options.fields.dev_dump_event_trace] +type = "keyword" +longname = "print particle tracking events" +description = "print a verbose particle tracking event trace to standard output" +optional = true +developmode = true + +[blocks.options.fields.scratch_buffer] +type = "keyword" +longname = "buffer track events in scratch file instead of memory" +description = "keyword to stage track events in a temporary (scratch) file instead of an in-memory buffer. Particle tracking results calculated during a time step are buffered, and output is deferred, until successful completion of the time step. By default, results are buffered in memory. However, for simulations in which a very large number of track events is generated during a time step, memory limits can be exceeded. In such cases, the SCRATCH_BUFFER option can be invoked to buffer results in a scratch file until successful completion of the time step. Buffering in a scratch file is typically slower than buffering in memory." +optional = true + +[blocks.dimensions.fields.ntracktimes] +type = "integer" +longname = "number of particle tracking times" +description = "is the number of user-specified particle tracking times in the TRACKTIMES block." +optional = true + +[blocks.tracktimes.fields.tracktimes] +type = "list" +optional = true +shape = [ + "ntracktimes", +] + +[blocks.tracktimes.fields.tracktimes.item] +name = "tracktimes" +type = "record" + +[blocks.tracktimes.fields.tracktimes.item.fields.time] +type = "double" +longname = "release time" +description = "real value that defines the tracking time with respect to the simulation start time." +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" +optional = true + +[blocks.period.fields.stress_period_data.item] +name = "output_record" +type = "union" + +[blocks.period.fields.stress_period_data.item.arms.saverecord] +type = "record" +optional = true + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.save] +type = "keyword" +longname = "keyword to save" +description = "keyword to indicate that information will be saved this stress period." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.rtype] +type = "string" +longname = "record type" +description = "type of information to save or print. Can only be BUDGET." +tagged = false +valid = [ + "BUDGET", +] + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting] +type = "union" +description = "specifies the steps for which the data will be saved." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.all] +type = "keyword" +description = "keyword to indicate save for all time steps in period." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.first] +type = "keyword" +description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.last] +type = "keyword" +description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.frequency] +type = "integer" +description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.steps] +type = "array" +description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." +dtype = "integer" +shape = [ + "<=nstp", +] + +[blocks.period.fields.stress_period_data.item.arms.printrecord] +type = "record" +optional = true + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.print] +type = "keyword" +longname = "keyword to save" +description = "keyword to indicate that information will be printed this stress period." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.rtype] +type = "string" +longname = "record type" +description = "type of information to save or print. Can only be BUDGET." +tagged = false +valid = [ + "BUDGET", +] + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting] +type = "union" +description = "specifies the steps for which the data will be saved." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.all] +type = "keyword" +description = "keyword to indicate save for all time steps in period." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.first] +type = "keyword" +description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.last] +type = "keyword" +description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.frequency] +type = "integer" +description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." + +[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.steps] +type = "array" +description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." +dtype = "integer" +shape = [ + "<=nstp", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.track_subf_exit] +set_in = "ar" +source = "track_subfeature_exit" +type = "logical" + +[memory.dev_dump_evtrace] +set_in = "ar" +source = "dev_dump_event_trace" +type = "logical" + +[memory.ntracktimes] +set_in = "ar" +source = "ntracktimes" +type = "integer" diff --git a/flopy4/mf6/dfns/prt-prp.toml b/flopy4/mf6/dfns/prt-prp.toml new file mode 100644 index 000000000..c42b5d984 --- /dev/null +++ b/flopy4/mf6/dfns/prt-prp.toml @@ -0,0 +1,525 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "prt-prp" +parent = "prt-nam" +ftype = "PRP6" +multi = true +subtype = "stress" + +[dims.nreleasepts] +value = "nreleasepts" + +[dims.nreleasetimes] +value = "nreleasetimes" + +[runtime_dims.naux] +set_in = "ar" + +[runtime_dims.nbound] +set_in = "rp" + +[runtime_dims.ncolbnd] +set_in = "ar" + +[blocks.options.fields.boundnames] +type = "keyword" +description = "keyword to indicate that boundary names may be provided with the list of particle release points." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.dev_exit_solve_method] +type = "integer" +longname = "exit solve method" +description = "the method for iterative solution of particle exit location and time in the generalized Pollock's method. 0 default, 1 Brent, 2 Chandrupatla. The default is Brent's method." +optional = true +developmode = true + +[blocks.options.fields.exit_solve_tolerance] +type = "double" +longname = "exit solve tolerance" +description = "the convergence tolerance for iterative solution of particle exit location and time in the generalized Pollock's method. The variable being solved for varies from 0 to 1. A tolerance of 0.00001 works well for many problems, but the value that strikes the best balance between accuracy and runtime is problem-dependent." +optional = true +default = 1e-05 + +[blocks.options.fields.local_z] +type = "keyword" +longname = "whether to use local z coordinates" +description = "indicates that 'zrpt' defines the local z coordinate of the release point within the cell, with value of 0 at the bottom and 1 at the effective top of the cell. If the cell is convertible and partially saturated at release time, the effective top of the cell is considered to be the water table elevation (the head in the cell) rather than the top defined by the user, and is constrained to be no higher than the geometric top of the cell and no lower than the cell bottom. If the cell is confined, the effective top is the geometric top." +optional = true + +[blocks.options.fields.extend_tracking] +type = "keyword" +longname = "whether to extend tracking beyond the end of the simulation" +description = "indicates that particles should be tracked beyond the end of the simulation's final time step (using that time step's flows) until particles terminate or reach a specified stop time. By default, particles are terminated at the end of the simulation's final time step." +optional = true + +[blocks.options.fields.track_filerecord] +type = "record" +optional = true + +[blocks.options.fields.track_filerecord.fields.track] +type = "keyword" +longname = "track keyword" +description = "keyword to specify that record corresponds to a binary track output file. Each PRP Package may have a distinct binary track output file." + +[blocks.options.fields.track_filerecord.fields.trackfile] +type = "file" +longname = "file keyword" +description = "name of the binary output file to write tracking information." +tagged = false +direction = "out" + +[blocks.options.fields.trackcsv_filerecord] +type = "record" +optional = true + +[blocks.options.fields.trackcsv_filerecord.fields.trackcsv] +type = "keyword" +longname = "track keyword" +description = "keyword to specify that record corresponds to a CSV track output file. Each PRP Package may have a distinct CSV track output file." + +[blocks.options.fields.trackcsv_filerecord.fields.trackcsvfile] +type = "file" +longname = "file keyword" +description = "name of the comma-separated value (CSV) file to write tracking information." +tagged = false +direction = "out" + +[blocks.options.fields.stoptime] +type = "double" +longname = "stop time" +description = "real value defining the maximum simulation time to which particles in the package can be tracked. Particles that have not terminated earlier due to another termination condition will terminate when simulation time STOPTIME is reached. If the last stress period in the simulation consists of more than one time step, particles will not be tracked past the ending time of the last stress period, regardless of STOPTIME. If the EXTEND_TRACKING option is enabled and the last stress period in the simulation is steady-state, the simulation ending time will not limit the time to which particles can be tracked, but STOPTIME and STOPTRAVELTIME will continue to apply. If STOPTIME and STOPTRAVELTIME are both provided, particles will be stopped if either is reached." +optional = true + +[blocks.options.fields.stoptraveltime] +type = "double" +longname = "stop travel time" +description = "real value defining the maximum travel time over which particles in the model can be tracked. Particles that have not terminated earlier due to another termination condition will terminate when their travel time reaches STOPTRAVELTIME. If the last stress period in the simulation consists of more than one time step, particles will not be tracked past the ending time of the last stress period, regardless of STOPTRAVELTIME. If the EXTEND_TRACKING option is enabled and the last stress period in the simulation is steady-state, the simulation ending time will not limit the time to which particles can be tracked, but STOPTIME and STOPTRAVELTIME will continue to apply. If STOPTIME and STOPTRAVELTIME are both provided, particles will be stopped if either is reached." +optional = true + +[blocks.options.fields.stop_at_weak_sink] +type = "keyword" +longname = "stop at weak sink" +description = "is a text keyword to indicate that a particle is to terminate when it enters a cell that is a weak sink. By default, particles are allowed to pass though cells that are weak sinks." +optional = true + +[blocks.options.fields.istopzone] +type = "integer" +longname = "stop zone number" +description = "integer value defining the stop zone number. If cells have been assigned IZONE values in the GRIDDATA block, a particle terminates if it enters a cell whose IZONE value matches ISTOPZONE. An ISTOPZONE value of zero indicates that there is no stop zone. The default value is zero." +optional = true + +[blocks.options.fields.drape] +type = "keyword" +longname = "drape" +description = "is a text keyword to indicate that if a particle's release point is in a cell that happens to be inactive at release time, the particle is to be moved to the topmost active cell below it, if any. By default, a particle is not released into the simulation if its release point's cell is inactive at release time. Note that DRAPE does not apply to attempted release into a cell for which IDOMAIN <= 0, which is considered not to exist in the simulation. Attempted release into a such a cell results in an error." +optional = true + +[blocks.options.fields.release_timesrecord] +type = "record" +optional = true +removed = "6.6.0" + +[blocks.options.fields.release_timesrecord.fields.release_times] +type = "keyword" +description = "keyword indicating release times will follow" +removed = "6.6.0" + +[blocks.options.fields.release_timesrecord.fields.times] +type = "array" +longname = "release times" +description = "times to release, relative to the beginning of the simulation. RELEASE_TIMES and RELEASE_TIMESFILE are mutually exclusive." +tagged = false +removed = "6.6.0" +dtype = "double" + +[blocks.options.fields.release_timesfilerecord] +type = "record" +optional = true +removed = "6.6.0" + +[blocks.options.fields.release_timesfilerecord.fields.release_timesfile] +type = "keyword" +description = "keyword indicating release times file name will follow" +removed = "6.6.0" + +[blocks.options.fields.release_timesfilerecord.fields.timesfile] +type = "string" +longname = "file keyword" +description = "name of the release times file. RELEASE_TIMES and RELEASE_TIMESFILE are mutually exclusive." +tagged = false +removed = "6.6.0" +case_sensitive = true + +[blocks.options.fields.dry_tracking_method] +type = "string" +longname = "what to do in dry-but-active cells" +description = "is a string indicating how particles should behave in dry-but-active cells (as can occur with the Newton formulation). The value can be 'DROP', 'STOP', or 'STAY'. The default is 'DROP', which passes particles vertically and instantaneously to the water table. 'STOP' causes particles to terminate. 'STAY' causes particles to remain stationary but active." +optional = true +valid = [ + "drop", + "stop", + "stay", +] + +[blocks.options.fields.dev_forceternary] +type = "keyword" +longname = "force ternary tracking method" +description = "force use of the ternary tracking method regardless of cell type in DISV grids." +developmode = true + +[blocks.options.fields.release_time_tolerance] +type = "double" +longname = "release time coincidence tolerance" +description = "real number indicating the tolerance within which to consider consecutive release times coincident. Coincident release times will be merged into a single release time. The default is $epsilon times 10^{11}$, where $epsilon$ is machine precision." +optional = true + +[blocks.options.fields.release_time_frequency] +type = "double" +longname = "release time frequency" +description = "real number indicating the time frequency at which to release particles. This option can be used to schedule releases at a regular interval for the duration of the simulation, starting at the simulation start time. The release schedule is the union of this option, the RELEASETIMES block, and PERIOD block RELEASESETTING selections. If none of these are provided, a single release time is configured at the beginning of the first time step of the simulation's first stress period." +optional = true + +[blocks.options.fields.coordinate_check_method] +type = "string" +longname = "coordinate checking method" +description = "approach for verifying that release point coordinates are in the cell with the specified ID. Possible values are NONE and EAGER. By default, release point coordinates are checked at release time, i.e. EAGER." +optional = true +default = "eager" +valid = [ + "none", + "eager", +] + +[blocks.options.fields.dev_cycle_detection_window] +type = "integer" +longname = "cycle detection window size" +description = "integer value defining the size of the window (number of consecutive exit events) used for cycle detection. Defaults to 0, disabling cycle detection. With detection enabled, particle pathlines with duplicate cell exit events (i.e., exiting the same cell through the same face twice) will cause the program to terminate with an error. A larger window size provides more robust cycle detection at the cost of more runtime operations per cell exit." +optional = true +developmode = true + +[blocks.dimensions.fields.nreleasepts] +type = "integer" +longname = "number of particle release points" +description = "is the number of particle release points." + +[blocks.dimensions.fields.nreleasetimes] +type = "integer" +longname = "number of particle release times" +description = "is the number of particle release times specified in the RELEASETIMES block. This is not necessarily the total number of release times; release times are the union of RELEASE_TIME_FREQUENCY, RELEASETIMES block, and PERIOD block RELEASESETTING selections." + +[blocks.packagedata.fields.packagedata] +type = "list" +shape = [ + "nreleasepts", +] + +[blocks.packagedata.fields.packagedata.item] +name = "packagedata" +type = "record" + +[blocks.packagedata.fields.packagedata.item.fields.irptno] +type = "integer" +longname = "PRP id number for release point" +description = "integer value that defines the PRP release point number associated with the specified PACKAGEDATA data on the line. IRPTNO must be greater than zero and less than or equal to NRELEASEPTS. The program will terminate with an error if information for a PRP release point number is specified more than once." +tagged = false +index = true +pk = true + +[blocks.packagedata.fields.packagedata.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.xrpt] +type = "double" +longname = "x coordinate of release point" +description = "real value that defines the x coordinate of the release point in model coordinates. The (x, y, z) location specified for the release point must lie within the cell that is identified by the specified cellid." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.yrpt] +type = "double" +longname = "y coordinate of release point" +description = "real value that defines the y coordinate of the release point in model coordinates. The (x, y, z) location specified for the release point must lie within the cell that is identified by the specified cellid." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.zrpt] +type = "double" +longname = "z coordinate of release point" +description = "real value that defines the z coordinate of the release point in model coordinates or, if the LOCAL_Z option is active, in local cell coordinates. The (x, y, z) location specified for the release point must lie within the cell that is identified by the specified cellid." +tagged = false + +[blocks.packagedata.fields.packagedata.item.fields.boundname] +type = "string" +longname = "release point name" +description = "name of the particle release point. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." +optional = true +when = "boundnames" +tagged = false + +[blocks.releasetimes.fields.releasetimes] +type = "list" +optional = true +shape = [ + "nreleasetimes", +] + +[blocks.releasetimes.fields.releasetimes.item] +name = "releasetimes" +type = "record" + +[blocks.releasetimes.fields.releasetimes.item.fields.time] +type = "double" +longname = "release time" +description = "real value that defines the release time with respect to the simulation start time." +tagged = false + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "releasesetting" +type = "union" +description = "specifies time steps at which to release a particle. A particle is released at the beginning of each specified time step. For fine control over release timing, specify times explicitly using the RELEASETIMES block. If the beginning of a specified time step coincides with a release time specified in the RELEASETIMES block or configured via RELEASE_TIME_FREQUENCY, only one particle is released at that time. Coincidence is evaluated up to the tolerance specified in RELEASE_TIME_TOLERANCE, or $epsilon times 10^{11}$ by default, where $epsilon$ is machine precision. When such a coincidence occurs, the release is reported under the earlier of the two time steps, i.e. whichever time step the coincident release time falls in per the usual convention that a time exactly on a time step boundary belongs to the earlier time step, not the later one. If no release times are configured via this setting, the RELEASETIMES block, or the RELEASE_TIME_FREQUENCY option, a single release time is configured at the beginning of the first time step of the simulation's first stress period." + +[blocks.period.fields.stress_period_data.item.arms.all] +type = "keyword" +description = "keyword to indicate release at the start of all time steps in the period." + +[blocks.period.fields.stress_period_data.item.arms.first] +type = "keyword" +description = "keyword to indicate release at the start of the first time step in the period. This keyword may be used in conjunction with other RELEASESETTING options." + +[blocks.period.fields.stress_period_data.item.arms.last] +type = "keyword" +description = "keyword to indicate release at the start of the last time step in the period. This keyword may be used in conjunction with other RELEASESETTING options." + +[blocks.period.fields.stress_period_data.item.arms.frequency] +type = "integer" +description = "release at the specified time step frequency. This keyword may be used in conjunction with other RELEASESETTING options." + +[blocks.period.fields.stress_period_data.item.arms.steps] +type = "array" +description = "release at the start of each step specified in STEPS. This option may be used in conjunction with other RELEASESETTING options." +dtype = "integer" +shape = [ + "<=nstp", +] + +[blocks.period.fields.stress_period_data.item.arms.fraction] +type = "array" +description = "release particles after the specified fraction of the time step has elapsed. If FRACTION is not set, particles are released at the start of the specified time step(s). FRACTION must be a single value when used with ALL, FIRST, or FREQUENCY. When used with STEPS, FRACTION may be a single value or an array of the same length as STEPS. If a single FRACTION value is provided with STEPS, the fraction applies to all steps. NOTE: The FRACTION option has been removed. For fine control over release timing, specify times explicitly using the RELEASETIMES block." +optional = true +removed = "6.6.0" +dtype = "double" +shape = [ + "<=nstp", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block applies only to that stress period." +tagged = false +index = true + +[memory.iprpak] +set_in = "ar" +source = "print_input" +type = "integer" + +[memory.iexmeth] +set_in = "ar" +source = "dev_exit_solve_method" +type = "integer" + +[memory.extol] +set_in = "ar" +source = "exit_solve_tolerance" +type = "double" + +[memory.localz] +set_in = "ar" +source = "local_z" +type = "logical" + +[memory.extend] +set_in = "ar" +source = "extend_tracking" +type = "logical" + +[memory.istopweaksink] +set_in = "ar" +source = "stop_at_weak_sink" +type = "integer" + +[memory.release_timesfn] +set_in = "ar" +source = "release_timesfile" +type = "logical" + +[memory.idrymeth] +set_in = "ar" +source = "dry_tracking_method" +type = "string" + +[memory.frctrn] +set_in = "ar" +source = "dev_forceternary" +type = "logical" + +[memory.rttol] +set_in = "ar" +source = "release_time_tolerance" +type = "double" + +[memory.rtfreq] +set_in = "ar" +source = "release_time_frequency" +type = "double" + +[memory.ichkmeth] +set_in = "ar" +source = "coordinate_check_method" +type = "string" + +[memory.icycwin] +set_in = "ar" +source = "dev_cycle_detection_window" +type = "integer" + +[memory.nreleasepts] +set_in = "ar" +source = "nreleasepts" +type = "integer" + +[memory.nreleasetimes] +set_in = "ar" +source = "nreleasetimes" +type = "integer" + +[memory.ipakcb] +set_in = "ar" +description = "Flag controlling whether boundary flows are written to the budget file." +type = "integer" + +[memory.maxbound] +readonly = true +set_in = "ar" +description = "Maximum number of boundary entries per stress period." +type = "integer" + +[memory.nbound] +set_in = "rp" +description = "Number of active boundaries for the current stress period." +type = "integer" + +[memory.ncolbnd] +readonly = true +set_in = "ar" +description = "Number of columns in BOUND." +type = "integer" + +[memory.nodelist] +type = "array" +set_in = "rp" +source = "cellid" +description = "Reduced node number for each active boundary, derived from CELLID." +dtype = "integer" +shape = [ + "nbound", +] + +[memory.bound] +type = "array" +set_in = "rp" +description = "Boundary data for the current stress period." +dtype = "double" +shape = [ + "ncolbnd", + "nbound", +] + +[memory.hcof] +type = "array" +readonly = true +set_in = "fc" +description = "Diagonal coefficient contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.rhs] +type = "array" +readonly = true +set_in = "fc" +description = "Right-hand-side contribution to the system matrix." +dtype = "double" +shape = [ + "nbound", +] + +[memory.simvals] +type = "array" +readonly = true +set_in = "cq" +description = "Simulated boundary flow values for the current time step." +budget = "PRP" +output = true +obs_type = "PRP" +dtype = "double" +shape = [ + "nbound", +] + +[memory.simtomvr] +type = "array" +readonly = true +set_in = "cq" +description = "Flow diverted to the Water Mover for each boundary." +budget = "PRP-TO-MVR" +output = true +dtype = "double" +shape = [ + "nbound", +] + +[memory.naux] +readonly = true +set_in = "ar" +description = "Number of auxiliary variables." +type = "integer" + +[memory.auxname_cst] +type = "array" +readonly = true +set_in = "ar" +description = "Names of auxiliary variables." +dtype = "string" +shape = [ + "naux", +] + +[memory.auxvar] +type = "array" +description = "Auxiliary variable values for each boundary." +dtype = "double" +set_in = [ + "rp", + "ad", +] +shape = [ + "naux", + "nbound", +] diff --git a/flopy4/mf6/dfns/sim-nam.toml b/flopy4/mf6/dfns/sim-nam.toml new file mode 100644 index 000000000..80a523417 --- /dev/null +++ b/flopy4/mf6/dfns/sim-nam.toml @@ -0,0 +1,200 @@ +type = "simulation" +schema_version = "2.0.0.dev3" +name = "sim-nam" + +[blocks.options.fields.continue] +type = "keyword" +longname = "continue if not converged" +description = "keyword flag to indicate that the simulation should continue even if one or more solutions do not converge." +optional = true + +[blocks.options.fields.nocheck] +type = "keyword" +longname = "turn off checking" +description = "keyword flag to indicate that the model input check routines should not be called prior to each time step. Checks are performed by default." +optional = true + +[blocks.options.fields.memory_print_option] +type = "string" +longname = "memory print option" +description = "is a flag that controls printing of detailed memory manager usage to the end of the simulation list file. NONE means do not print detailed information. SUMMARY means print only the total memory for each simulation component. ALL means print information for each variable stored in the memory manager. NONE is default if MEMORY_PRINT_OPTION is not specified." +optional = true + +[blocks.options.fields.profile_option] +type = "string" +longname = "profiling option" +description = "is a flag that controls performance profiling and reporting. NONE disables profiling. SUMMARY means to measure and print a coarse performance profile. DETAIL means collect and print information with the highest resolution available. NONE is default if PROFILE_OPTION is not specified." +optional = true + +[blocks.options.fields.maxerrors] +type = "integer" +longname = "maximum number of errors" +description = "maximum number of errors that will be stored and printed." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to activate printing of simulation input summaries to the simulation list file (mfsim.lst). With this keyword, input summaries will be written for those packages that support newer input data model routines. Not all packages are supported yet by the newer input data model routines." +optional = true + +[blocks.options.fields.hpc_filerecord] +type = "record" +description = "hpc record" +optional = true + +[blocks.options.fields.hpc_filerecord.fields.hpc6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a hpc file." + +[blocks.options.fields.hpc_filerecord.fields.hpc6_filename] +type = "file" +longname = "file name of time series information" +description = "name of input file to define HPC file settings for the HPC package. See the 'HPC File' section for instructions for preparing HPC input files." +tagged = false +direction = "in" +component = "utl-hpc" + +[blocks.timing.fields.tdis6] +type = "file" +longname = "name of tdis input file" +description = "is the name of the Temporal Discretization (TDIS) Input File." +direction = "in" +mode_keyword = false +component = "sim-tdis" + +[blocks.models.fields.models] +type = "list" +longname = "list of models" +description = "is the list of model types, model name files, and model names." +optional = true + +[blocks.models.fields.models.item] +name = "models" +type = "record" +description = "is the record of model types, model name files, and model names." + +[blocks.models.fields.models.item.fields.mtype] +type = "string" +longname = "model type" +description = "is the type of model to add to simulation." +tagged = false + +[blocks.models.fields.models.item.fields.mfname] +type = "file" +longname = "file name for model name file" +description = "is the file name of the model name file." +tagged = false +direction = "in" +mode_keyword = false +component = "model" +component_ftype = "mtype" + +[blocks.models.fields.models.item.fields.mname] +type = "string" +longname = "name of model" +description = "is the user-assigned name of the model. The model name cannot exceed 16 characters and must not have blanks within the name. The model name is case insensitive; any lowercase letters are converted and stored as upper case letters. Model names must be unique." +tagged = false +pk = true + +[blocks.exchanges.fields.exchanges] +type = "list" +longname = "list of exchanges" +description = "is the list of exchange types, exchange files, and model names." +optional = true + +[blocks.exchanges.fields.exchanges.item] +name = "exchanges" +type = "record" +description = "is the record of exchange types, exchange files, and model names." + +[blocks.exchanges.fields.exchanges.item.fields.exgtype] +type = "string" +longname = "exchange type" +description = "is the exchange type." +tagged = false + +[blocks.exchanges.fields.exchanges.item.fields.exgfile] +type = "file" +longname = "input file for exchange" +description = "is the input file for the exchange." +tagged = false +direction = "in" +mode_keyword = false +component = "exchange" +component_ftype = "exgtype" + +[blocks.exchanges.fields.exchanges.item.fields.exgmnamea] +type = "string" +longname = "name of model A" +description = "is the name of the first model that is part of this exchange." +tagged = false +fk = "models.mname" + +[blocks.exchanges.fields.exchanges.item.fields.exgmnameb] +type = "string" +longname = "name of model B" +description = "is the name of the second model that is part of this exchange." +tagged = false +fk = "models.mname" + +[blocks.solutiongroup.fields.mxiter] +type = "integer" +longname = "maximum solution group iterations" +description = "is the maximum number of outer iterations for this solution group. The default value is 1. If there is only one solution in the solution group, then MXITER must be 1." +optional = true + +[blocks.solutiongroup.fields.solutiongroup] +type = "list" +longname = "solution type and models in the solution" +description = "is the list of solution types and models in the solution." + +[blocks.solutiongroup.fields.solutiongroup.item] +name = "solutiongroup" +type = "record" +description = "is the record of solution types and models in the solution." + +[blocks.solutiongroup.fields.solutiongroup.item.fields.slntype] +type = "string" +longname = "type of solution" +description = "is the type of solution. The Integrated Model Solution (IMS6) and Explicit Model Solution (EMS6) are the only supported options in this version." +tagged = false +valid = [ + "ims6", + "ems6", +] + +[blocks.solutiongroup.fields.solutiongroup.item.fields.slnfname] +type = "file" +longname = "file name for solution input" +description = "name of file containing solution input." +tagged = false +direction = "in" +mode_keyword = false +component = "solution" +component_ftype = "slntype" + +[blocks.solutiongroup.fields.solutiongroup.item.fields.slnmnames] +type = "array" +longname = "array of model names in this solution" +description = "is the array of model names to add to this solution. The number of model names is determined by the number of model names the user provides on this line." +tagged = false +dtype = "string" +fk = "models.mname" + +[blocks.solutiongroup.header.field] +name = "group_num" +type = "integer" +description = "is the group number of the solution group. Solution groups must be numbered sequentially, starting with group number one." +tagged = false + +[memory.prmem] +set_in = "ar" +source = "memory_print_option" +type = "string" + +[memory.prprof] +set_in = "ar" +source = "profile_option" +type = "string" diff --git a/flopy4/mf6/dfns/sim-tdis.toml b/flopy4/mf6/dfns/sim-tdis.toml new file mode 100644 index 000000000..4ee3c56af --- /dev/null +++ b/flopy4/mf6/dfns/sim-tdis.toml @@ -0,0 +1,85 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "sim-tdis" +parent = "sim-nam" +ftype = "TDIS6" + +[dims.nper] +value = "nper" +scope = "simulation" + +[blocks.options.fields.time_units] +type = "string" +longname = "time unit" +description = "is the time units of the simulation. This is a text string that is used as a label within model output files. Values for time_units may be 'unknown', 'seconds', 'minutes', 'hours', 'days', or 'years'. The default time unit is 'unknown'." +optional = true + +[blocks.options.fields.start_date_time] +type = "string" +longname = "starting date and time" +description = "is the starting date and time of the simulation. This is a text string that is used as a label within the simulation list file. The value has no effect on the simulation. The recommended format for the starting date and time is described at https://www.w3.org/TR/NOTE-datetime." +optional = true + +[blocks.options.fields.ats_filerecord] +type = "record" +optional = true + +[blocks.options.fields.ats_filerecord.fields.ats6] +type = "keyword" +longname = "ats keyword" +description = "keyword to specify that record corresponds to an adaptive time step (ATS) input file. The behavior of ATS and a description of the input file is provided separately." + +[blocks.options.fields.ats_filerecord.fields.ats6_filename] +type = "file" +longname = "file name of adaptive time series information" +description = "defines an adaptive time step (ATS) input file defining ATS controls. Records in the ATS file can be used to override the time step behavior for selected stress periods." +tagged = false +direction = "in" +component = "utl-ats" + +[blocks.dimensions.fields.nper] +type = "integer" +longname = "number of stress periods" +description = "is the number of stress periods for the simulation." +default = 1 + +[blocks.perioddata.fields.perioddata] +type = "list" +longname = "stress period time information" +default = [ + [ + 1.0, + 1, + 1.0, + ], +] +shape = [ + "nper", +] + +[blocks.perioddata.fields.perioddata.item] +name = "perioddata" +type = "record" + +[blocks.perioddata.fields.perioddata.item.fields.perlen] +type = "double" +longname = "length of stress period" +description = "is the length of a stress period." +tagged = false + +[blocks.perioddata.fields.perioddata.item.fields.nstp] +type = "integer" +longname = "number of time steps" +description = "is the number of time steps in a stress period." +tagged = false + +[blocks.perioddata.fields.perioddata.item.fields.tsmult] +type = "double" +longname = "number of time steps" +description = "is the multiplier for the length of successive time steps. The length of a time step is calculated by multiplying the length of the previous time step by TSMULT. The length of the first time step, $Delta t_1$, is related to PERLEN, NSTP, and TSMULT by the relation $Delta t_1= perlen frac{tsmult - 1}{tsmult^{nstp}-1}$." +tagged = false + +[memory.nper] +set_in = "ar" +source = "nper" +type = "integer" diff --git a/flopy4/mf6/dfns/sln-ems.toml b/flopy4/mf6/dfns/sln-ems.toml new file mode 100644 index 000000000..85cff8b79 --- /dev/null +++ b/flopy4/mf6/dfns/sln-ems.toml @@ -0,0 +1,18 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "sln-ems" +parent = "sim-nam" +ftype = "EMS6" +subtype = "solution" + +[memory.icnvg] +readonly = true +set_in = "ar" +description = "Convergence flag. 1 if the solution converged; 0 otherwise. Updated after each call to the solver." +type = "integer" + +[memory.ttsoln] +readonly = true +set_in = "ar" +description = "Cumulative CPU time (seconds) spent in the solver." +type = "double" diff --git a/flopy4/mf6/dfns/sln-ims.toml b/flopy4/mf6/dfns/sln-ims.toml new file mode 100644 index 000000000..87f9911df --- /dev/null +++ b/flopy4/mf6/dfns/sln-ims.toml @@ -0,0 +1,422 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "sln-ims" +parent = "sim-nam" +ftype = "IMS6" +subtype = "solution" + +[blocks.options.fields.print_option] +type = "string" +longname = "print option" +description = "is a flag that controls printing of convergence information from the solver. NONE means print nothing. SUMMARY means print only the total number of iterations and nonlinear residual reduction summaries. ALL means print linear matrix solver convergence information to the solution listing file and model specific linear matrix solver convergence information to each model listing file in addition to SUMMARY information. NONE is default if PRINT_OPTION is not specified." +optional = true + +[blocks.options.fields.complexity] +type = "string" +longname = "solver complexity" +description = "is an optional keyword that defines default non-linear and linear solver parameters. SIMPLE - indicates that default solver input values will be defined that work well for nearly linear models. This would be used for models that do not include nonlinear stress packages and models that are either confined or consist of a single unconfined layer that is thick enough to contain the water table within a single layer. MODERATE - indicates that default solver input values will be defined that work well for moderately nonlinear models. This would be used for models that include nonlinear stress packages and models that consist of one or more unconfined layers. The MODERATE option should be used when the SIMPLE option does not result in successful convergence. COMPLEX - indicates that default solver input values will be defined that work well for highly nonlinear models. This would be used for models that include nonlinear stress packages and models that consist of one or more unconfined layers representing complex geology and surface-water/groundwater interaction. The COMPLEX option should be used when the MODERATE option does not result in successful convergence. Non-linear and linear solver parameters assigned using a specified complexity can be modified in the NONLINEAR and LINEAR blocks. If the COMPLEXITY option is not specified, NONLINEAR and LINEAR variables will be assigned the simple complexity values." +optional = true + +[blocks.options.fields.csv_output_filerecord] +type = "record" +optional = true +removed = "6.8.0" +deprecated = "6.1.1" + +[blocks.options.fields.csv_output_filerecord.fields.csv_output] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option." +removed = "6.8.0" +deprecated = "6.1.1" + +[blocks.options.fields.csv_output_filerecord.fields.csvfile] +type = "file" +longname = "file keyword" +description = "name of the ascii comma separated values output file to write solver convergence information. If PRINT_OPTION is NONE or SUMMARY, comma separated values output includes maximum head change convergence information at the end of each outer iteration for each time step. If PRINT_OPTION is ALL, comma separated values output includes maximum head change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration." +tagged = false +removed = "6.8.0" +deprecated = "6.1.1" +direction = "out" + +[blocks.options.fields.csv_outer_output_filerecord] +type = "record" +optional = true + +[blocks.options.fields.csv_outer_output_filerecord.fields.csv_outer_output] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that the record corresponds to the comma separated values outer iteration convergence output." + +[blocks.options.fields.csv_outer_output_filerecord.fields.outer_csvfile] +type = "file" +longname = "file keyword" +description = "name of the ascii comma separated values output file to write maximum dependent-variable (for example, head) change convergence information at the end of each outer iteration for each time step." +tagged = false +direction = "out" + +[blocks.options.fields.csv_inner_output_filerecord] +type = "record" +optional = true + +[blocks.options.fields.csv_inner_output_filerecord.fields.csv_inner_output] +type = "keyword" +longname = "budget keyword" +description = "keyword to specify that the record corresponds to the comma separated values solver convergence output." + +[blocks.options.fields.csv_inner_output_filerecord.fields.inner_csvfile] +type = "file" +longname = "file keyword" +description = "name of the ascii comma separated values output file to write solver convergence information. Comma separated values output includes maximum dependent-variable (for example, head) change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration." +tagged = false +direction = "out" + +[blocks.options.fields.no_ptcrecord] +type = "record" +longname = "no_ptc record" +optional = true + +[blocks.options.fields.no_ptcrecord.fields.no_ptc] +type = "keyword" +longname = "no pseudo-transient continuation" +description = "is a flag that is used to disable pseudo-transient continuation (PTC). Option only applies to steady-state stress periods for models using the Newton-Raphson formulation. For many problems, PTC can significantly improve convergence behavior for steady-state simulations, and for this reason it is active by default. In some cases, however, PTC can worsen the convergence behavior, especially when the initial conditions are similar to the solution. When the initial conditions are similar to, or exactly the same as, the solution and convergence is slow, then the NO_PTC FIRST option should be used to deactivate PTC for the first stress period. The NO_PTC ALL option should also be used in order to compare convergence behavior with other MODFLOW versions, as PTC is only available in MODFLOW 6." + +[blocks.options.fields.no_ptcrecord.fields.no_ptc_option] +type = "string" +longname = "no pseudo-transient continuation option" +description = "is an optional keyword that is used to define options for disabling pseudo-transient continuation (PTC). FIRST is an optional keyword to disable PTC for the first stress period, if steady-state and one or more model is using the Newton-Raphson formulation. ALL is an optional keyword to disable PTC for all steady-state stress periods for models using the Newton-Raphson formulation. If NO_PTC_OPTION is not specified, the NO_PTC ALL option is used." +optional = true +tagged = false + +[blocks.options.fields.ats_outer_maximum_fraction] +type = "double" +longname = "fraction of outer maximum used with ats" +description = "real value defining the fraction of the maximum allowable outer iterations used with the Adaptive Time Step (ATS) capability if it is active. If this value is set to zero by the user, then this solution will have no effect on ATS behavior. This value must be greater than or equal to zero and less than or equal to 0.5 or the program will terminate with an error. If it is not specified by the user, then it is assigned a default value of one third. When the number of outer iterations for this solution is less than the product of this value and the maximum allowable outer iterations, then ATS will increase the time step length by a factor of DTADJ in the ATS input file. When the number of outer iterations for this solution is greater than the maximum allowable outer iterations minus the product of this value and the maximum allowable outer iterations, then the ATS (if active) will decrease the time step length by a factor of 1 / DTADJ." +optional = true + +[blocks.options.fields.dev_ptc] +type = "keyword" +longname = "activate pseudo-transient continuation" +description = "keyword that activates pseudo-transient continuation (PTC). PTC is active by default, so this keyword has an effect only when it follows NO_PTC in the OPTIONS block. This development option is not supported." +optional = true +developmode = true + +[blocks.options.fields.dev_ptc_output_filerecord] +type = "record" +optional = true +developmode = true + +[blocks.options.fields.dev_ptc_output_filerecord.fields.dev_ptc_output] +type = "keyword" +longname = "pseudo-transient continuation output keyword" +description = "keyword to specify that the record corresponds to the pseudo-transient continuation output file. Specifying the record also activates pseudo-transient continuation. This development option is not supported." +developmode = true + +[blocks.options.fields.dev_ptc_output_filerecord.fields.dev_ptcfile] +type = "file" +longname = "file keyword" +description = "name of the ascii output file to write pseudo-transient continuation information." +developmode = true +tagged = false +direction = "out" + +[blocks.options.fields.dev_ptc_option] +type = "keyword" +longname = "use the norms to set the initial pseudo-transient continuation value" +description = "keyword that uses the norm of the right-hand side and the L2 norm of the residual to set the initial pseudo-transient continuation value, instead of the default approach. Specifying the keyword also activates pseudo-transient continuation. This development option is not supported." +optional = true +developmode = true + +[blocks.options.fields.dev_ptc_exponent] +type = "double" +longname = "pseudo-transient continuation exponent" +description = "real number value that defines the exponent used to reduce the pseudo-transient continuation value between outer iterations. The value must be greater than zero and is 1 by default. Specifying the value also activates pseudo-transient continuation. This development option is not supported." +optional = true +developmode = true + +[blocks.options.fields.dev_ptc_del0] +type = "double" +longname = "initial pseudo-transient continuation value" +description = "real number value that defines the initial pseudo-transient continuation value, which is equivalent to an initial time step length. The value must be greater than zero. Specifying the value also activates pseudo-transient continuation. This development option is not supported." +optional = true +developmode = true + +[blocks.nonlinear.fields.outer_hclose] +type = "double" +longname = "head change criterion" +description = "real value defining the head change criterion for convergence of the outer (nonlinear) iterations, in units of length. When the maximum absolute value of the head change at all nodes during an iteration is less than or equal to OUTER_HCLOSE, iteration stops. Commonly, OUTER_HCLOSE equals 0.01. The OUTER_HCLOSE option has been deprecated in favor of the more general OUTER_DVCLOSE (for dependent variable), however either one can be specified in order to maintain backward compatibility." +optional = true +removed = "6.8.0" +deprecated = "6.1.1" + +[blocks.nonlinear.fields.outer_dvclose] +type = "double" +longname = "dependent-variable change criterion" +description = "real value defining the dependent-variable (for example, head) change criterion for convergence of the outer (nonlinear) iterations, in units of the dependent-variable (for example, length for head). When the maximum absolute value of the dependent-variable change at all nodes during an iteration is less than or equal to OUTER_DVCLOSE, iteration stops. Commonly, OUTER_DVCLOSE equals 0.01. The keyword, OUTER_HCLOSE can be still be specified instead of OUTER_DVCLOSE for backward compatibility with previous versions of MODFLOW 6 but eventually OUTER_HCLOSE will be deprecated and specification of OUTER_HCLOSE will cause MODFLOW 6 to terminate with an error." +optional = true + +[blocks.nonlinear.fields.outer_rclosebnd] +type = "double" +longname = "boundary package flow residual tolerance" +description = "real value defining the residual tolerance for convergence of model packages that solve a separate equation not solved by the IMS linear solver. This value represents the maximum allowable residual between successive outer iterations at any single model package element. An example of a model package that would use OUTER_RCLOSEBND to evaluate convergence is the SFR package which solves a continuity equation for each reach. The OUTER_RCLOSEBND option is deprecated and has no effect on simulation results as of version 6.1.1. The keyword, OUTER_RCLOSEBND can be still be specified for backward compatibility with previous versions of MODFLOW 6 but eventually specification of OUTER_RCLOSEBND will cause MODFLOW 6 to terminate with an error." +optional = true +removed = "6.8.0" +deprecated = "6.1.1" + +[blocks.nonlinear.fields.outer_maximum] +type = "integer" +longname = "outer maximum iterations" +description = "integer value defining the maximum number of outer (nonlinear) iterations -- that is, calls to the solution routine. For a linear problem OUTER_MAXIMUM should be 1." +optional = true + +[blocks.nonlinear.fields.under_relaxation] +type = "string" +longname = "under relaxation scheme" +description = "is an optional keyword that defines the nonlinear under-relaxation schemes used. Under-relaxation is also known as dampening, and is used to reduce the size of the calculated dependent variable before proceeding to the next outer iteration. Under-relaxation can be an effective tool for highly nonlinear models when there are large and often counteracting changes in the calculated dependent variable between successive outer iterations. By default under-relaxation is not used. NONE - under-relaxation is not used (default). SIMPLE - Simple under-relaxation scheme with a fixed relaxation factor (UNDER_RELAXATION_GAMMA) is used. COOLEY - Cooley under-relaxation scheme is used. DBD - delta-bar-delta under-relaxation is used. Note that the under-relaxation schemes are often used in conjunction with problems that use the Newton-Raphson formulation, however, experience has indicated that they also work well for non-Newton problems, such as those with the wet/dry options of MODFLOW 6." +optional = true + +[blocks.nonlinear.fields.under_relaxation_gamma] +type = "double" +longname = "relaxation factor for SIMPLE or the history or memory term factor for the Cooley and delta-bar-delta algorithms" +description = "real value defining either the relaxation factor for the SIMPLE scheme or the history or memory term factor of the Cooley and delta-bar-delta algorithms. For the SIMPLE scheme, a value of one indicates that there is no under-relaxation and the full head change is applied. This value can be gradually reduced from one as a way to improve convergence; for well behaved problems, using a value less than one can increase the number of outer iterations required for convergence and needlessly increase run times. UNDER_RELAXATION_GAMMA must be greater than zero for the SIMPLE scheme or the program will terminate with an error. For the Cooley and delta-bar-delta schemes, UNDER_RELAXATION_GAMMA is a memory term that can range between zero and one. When UNDER_RELAXATION_GAMMA is zero, only the most recent history (previous iteration value) is maintained. As UNDER_RELAXATION_GAMMA is increased, past history of iteration changes has greater influence on the memory term. The memory term is maintained as an exponential average of past changes. Retaining some past history can overcome granular behavior in the calculated function surface and therefore helps to overcome cyclic patterns of non-convergence. The value usually ranges from 0.1 to 0.3; a value of 0.2 works well for most problems. UNDER_RELAXATION_GAMMA only needs to be specified if UNDER_RELAXATION is not NONE." +optional = true + +[blocks.nonlinear.fields.under_relaxation_theta] +type = "double" +longname = "under relaxation reduction factor" +description = "real value defining the reduction factor for the learning rate (under-relaxation term) of the delta-bar-delta algorithm. The value of UNDER_RELAXATION_THETA is between zero and one. If the change in the dependent-variable (for example, head) is of opposite sign to that of the previous iteration, the under-relaxation term is reduced by a factor of UNDER_RELAXATION_THETA. The value usually ranges from 0.3 to 0.9; a value of 0.7 works well for most problems. UNDER_RELAXATION_THETA only needs to be specified if UNDER_RELAXATION is DBD." +optional = true + +[blocks.nonlinear.fields.under_relaxation_kappa] +type = "double" +longname = "under relaxation increment for the learning rate" +description = "real value defining the increment for the learning rate (under-relaxation term) of the delta-bar-delta algorithm. The value of UNDER_RELAXATION_kappa is between zero and one. If the change in the dependent-variable (for example, head) is of the same sign to that of the previous iteration, the under-relaxation term is increased by an increment of UNDER_RELAXATION_KAPPA. The value usually ranges from 0.03 to 0.3; a value of 0.1 works well for most problems. UNDER_RELAXATION_KAPPA only needs to be specified if UNDER_RELAXATION is DBD." +optional = true + +[blocks.nonlinear.fields.under_relaxation_momentum] +type = "double" +longname = "fraction of past history changes that is added as a momentum term" +description = "real value defining the fraction of past history changes that is added as a momentum term to the step change for a nonlinear iteration. The value of UNDER_RELAXATION_MOMENTUM is between zero and one. A large momentum term should only be used when small learning rates are expected. Small amounts of the momentum term help convergence. The value usually ranges from 0.0001 to 0.1; a value of 0.001 works well for most problems. UNDER_RELAXATION_MOMENTUM only needs to be specified if UNDER_RELAXATION is DBD." +optional = true + +[blocks.nonlinear.fields.backtracking_number] +type = "integer" +longname = "maximum number of backtracking iterations" +description = "integer value defining the maximum number of backtracking iterations allowed for residual reduction computations. If BACKTRACKING_NUMBER = 0 then the backtracking iterations are omitted. The value usually ranges from 2 to 20; a value of 10 works well for most problems." +optional = true + +[blocks.nonlinear.fields.backtracking_tolerance] +type = "double" +longname = "tolerance for residual change that is allowed for residual reduction" +description = "real value defining the tolerance for residual change that is allowed for residual reduction computations. BACKTRACKING_TOLERANCE should not be less than one to avoid getting stuck in local minima. A large value serves to check for extreme residual increases, while a low value serves to control step size more severely. The value usually ranges from 1.0 to 10$^6$; a value of 10$^4$ works well for most problems but lower values like 1.1 may be required for harder problems. BACKTRACKING_TOLERANCE only needs to be specified if BACKTRACKING_NUMBER is greater than zero." +optional = true + +[blocks.nonlinear.fields.backtracking_reduction_factor] +type = "double" +longname = "reduction in step size used for residual reduction computations" +description = "real value defining the reduction in step size used for residual reduction computations. The value of BACKTRACKING_REDUCTION_FACTOR is between zero and one. The value usually ranges from 0.1 to 0.3; a value of 0.2 works well for most problems. BACKTRACKING_REDUCTION_FACTOR only needs to be specified if BACKTRACKING_NUMBER is greater than zero." +optional = true + +[blocks.nonlinear.fields.backtracking_residual_limit] +type = "double" +longname = "limit to which the residual is reduced with backtracking" +description = "real value defining the limit to which the residual is reduced with backtracking. If the residual is smaller than BACKTRACKING_RESIDUAL_LIMIT, then further backtracking is not performed. A value of 100 is suitable for large problems and residual reduction to smaller values may only slow down computations. BACKTRACKING_RESIDUAL_LIMIT only needs to be specified if BACKTRACKING_NUMBER is greater than zero." +optional = true + +[blocks.linear.fields.inner_maximum] +type = "integer" +longname = "maximum number of inner iterations" +description = "integer value defining the maximum number of inner (linear) iterations. The number typically depends on the characteristics of the matrix solution scheme being used. For nonlinear problems, INNER_MAXIMUM usually ranges from 60 to 600; a value of 100 will be sufficient for most linear problems." +optional = true + +[blocks.linear.fields.inner_hclose] +type = "double" +longname = "head change tolerance" +description = "real value defining the head change criterion for convergence of the inner (linear) iterations, in units of length. When the maximum absolute value of the head change at all nodes during an iteration is less than or equal to INNER_HCLOSE, the matrix solver assumes convergence. Commonly, INNER_HCLOSE is set equal to or an order of magnitude less than the OUTER_HCLOSE value specified for the NONLINEAR block. The INNER_HCLOSE keyword has been deprecated in favor of the more general INNER_DVCLOSE (for dependent variable), however either one can be specified in order to maintain backward compatibility." +optional = true +removed = "6.8.0" +deprecated = "6.1.1" + +[blocks.linear.fields.inner_dvclose] +type = "double" +longname = "dependent-variable change tolerance" +description = "real value defining the dependent-variable (for example, head) change criterion for convergence of the inner (linear) iterations, in units of the dependent-variable (for example, length for head). When the maximum absolute value of the dependent-variable change at all nodes during an iteration is less than or equal to INNER_DVCLOSE, the matrix solver assumes convergence. Commonly, INNER_DVCLOSE is set equal to or an order of magnitude less than the OUTER_DVCLOSE value specified for the NONLINEAR block. The keyword, INNER_HCLOSE can be still be specified instead of INNER_DVCLOSE for backward compatibility with previous versions of MODFLOW 6 but eventually INNER_HCLOSE will be deprecated and specification of INNER_HCLOSE will cause MODFLOW 6 to terminate with an error." +optional = true + +[blocks.linear.fields.rcloserecord] +type = "record" +longname = "rclose record" +optional = true + +[blocks.linear.fields.rcloserecord.fields.inner_rclose] +type = "double" +longname = "flow residual tolerance" +description = "real value that defines the flow residual tolerance for convergence of the IMS linear solver and specific flow residual criteria used. This value represents the maximum allowable residual at any single node. Value is in units of length cubed per time, and must be consistent with mf length and time units. Usually a value of $1.0 times 10^{-1}$ is sufficient for the flow-residual criteria when meters and seconds are the defined mf length and time." + +[blocks.linear.fields.rcloserecord.fields.rclose_option] +type = "string" +longname = "flow residual tolerance" +description = "an optional keyword that defines the specific flow residual criterion used. STRICT--an optional keyword that is used to specify that INNER_RCLOSE represents a infinity-Norm (absolute convergence criteria) and that the dependent-variable (for example, head) and flow convergence criteria must be met on the first inner iteration (this criteria is equivalent to the criteria used by the MODFLOW-2005 PCG package~citep{hill1990preconditioned}). L2NORM_RCLOSE--an optional keyword that is used to specify that INNER_RCLOSE represents a L-2 Norm closure criteria instead of a infinity-Norm (absolute convergence criteria). When L2NORM_RCLOSE is specified, a reasonable initial INNER_RCLOSE value is 0.1 times the number of active cells when meters and seconds are the defined mf length and time. RELATIVE_RCLOSE--an optional keyword that is used to specify that INNER_RCLOSE represents a relative L-2 Norm reduction closure criteria instead of a infinity-Norm (absolute convergence criteria). When RELATIVE_RCLOSE is specified, a reasonable initial INNER_RCLOSE value is $1.0 times 10^{-4}$ and convergence is achieved for a given inner (linear) iteration when $Delta h le$ INNER_DVCLOSE and the current L-2 Norm is $le$ the product of the RELATIVE_RCLOSE and the initial L-2 Norm for the current inner (linear) iteration. If RCLOSE_OPTION is not specified, an absolute residual (infinity-norm) criterion is used." +optional = true +tagged = false + +[blocks.linear.fields.linear_acceleration] +type = "string" +longname = "linear acceleration method" +description = "a keyword that defines the linear acceleration method used by the default IMS linear solvers. CG - preconditioned conjugate gradient method. BICGSTAB - preconditioned bi-conjugate gradient stabilized method." +optional = true + +[blocks.linear.fields.relaxation_factor] +type = "double" +longname = "relaxation factor used by ILU factorization" +description = "optional real value that defines the relaxation factor used by the incomplete LU factorization preconditioners (MILU(0) and MILUT). RELAXATION_FACTOR is unitless and should be greater than or equal to 0.0 and less than or equal to 1.0. RELAXATION_FACTOR values of about 1.0 are commonly used, and experience suggests that convergence can be optimized in some cases with relax values of 0.97. A RELAXATION_FACTOR value of 0.0 will result in either ILU(0) or ILUT preconditioning (depending on the value specified for PRECONDITIONER_LEVELS and/or PRECONDITIONER_DROP_TOLERANCE). By default, RELAXATION_FACTOR is zero." +optional = true + +[blocks.linear.fields.preconditioner_levels] +type = "integer" +longname = "level of fill for ILU decomposition" +description = "optional integer value defining the level of fill for ILU decomposition used in the ILUT and MILUT preconditioners. Higher levels of fill provide more robustness but also require more memory. For optimal performance, it is suggested that a large level of fill be applied (7 or 8) with use of a drop tolerance. Specification of a PRECONDITIONER_LEVELS value greater than zero results in use of the ILUT preconditioner. By default, PRECONDITIONER_LEVELS is zero and the zero-fill incomplete LU factorization preconditioners (ILU(0) and MILU(0)) are used." +optional = true + +[blocks.linear.fields.preconditioner_drop_tolerance] +type = "double" +longname = "drop tolerance used to drop preconditioner terms" +description = "optional real value that defines the drop tolerance used to drop preconditioner terms based on the magnitude of matrix entries in the ILUT and MILUT preconditioners. A value of $10^{-4}$ works well for most problems. By default, PRECONDITIONER_DROP_TOLERANCE is zero and the zero-fill incomplete LU factorization preconditioners (ILU(0) and MILU(0)) are used." +optional = true + +[blocks.linear.fields.number_orthogonalizations] +type = "integer" +longname = "number of orthogonalizations" +description = "optional integer value defining the interval used to explicitly recalculate the residual of the flow equation using the solver coefficient matrix, the latest dependent-variable (for example, head) estimates, and the right hand side. For problems that benefit from explicit recalculation of the residual, a number between 4 and 10 is appropriate. By default, NUMBER_ORTHOGONALIZATIONS is zero." +optional = true + +[blocks.linear.fields.scaling_method] +type = "string" +longname = "matrix scaling approach" +description = "an optional keyword that defines the matrix scaling approach used. By default, matrix scaling is not applied. NONE - no matrix scaling applied. DIAGONAL - symmetric matrix scaling using the POLCG preconditioner scaling method in Hill (1992). L2NORM - symmetric matrix scaling using the L2 norm." +optional = true + +[blocks.linear.fields.reordering_method] +type = "string" +longname = "matrix reordering approach" +description = "an optional keyword that defines the matrix reordering approach used. By default, matrix reordering is not applied. NONE - original ordering. RCM - reverse Cuthill McKee ordering. MD - minimum degree ordering." +optional = true + +[memory.mxiter] +set_in = "ar" +source = "outer_maximum" +description = "Maximum outer (nonlinear) iterations." +type = "integer" + +[memory.dvclose] +set_in = "ar" +source = "outer_dvclose" +description = "Outer dependent-variable change closure criterion." +type = "double" + +[memory.theta] +set_in = "ar" +source = "under_relaxation_theta" +description = "Under-relaxation reduction factor (delta-bar-delta)." +type = "double" + +[memory.akappa] +set_in = "ar" +source = "under_relaxation_kappa" +description = "Under-relaxation increment for the learning rate (delta-bar-delta)." +type = "double" + +[memory.gamma] +set_in = "ar" +source = "under_relaxation_gamma" +description = "Under-relaxation memory factor (Cooley or delta-bar-delta)." +type = "double" + +[memory.amomentum] +set_in = "ar" +source = "under_relaxation_momentum" +description = "Momentum coefficient for the under-relaxation step (delta-bar-delta)." +type = "double" + +[memory.numtrack] +set_in = "ar" +source = "backtracking_number" +description = "Maximum backtracking iterations; 0 disables backtracking." +type = "integer" + +[memory.btol] +set_in = "ar" +source = "backtracking_tolerance" +description = "Residual increase tolerance that triggers backtracking." +type = "double" + +[memory.breduc] +set_in = "ar" +source = "backtracking_reduction_factor" +description = "Step-size reduction factor used during backtracking." +type = "double" + +[memory.res_lim] +set_in = "ar" +source = "backtracking_residual_limit" +description = "Residual limit below which backtracking is not performed." +type = "double" + +[memory.icnvg] +readonly = true +set_in = "ar" +description = "Convergence flag. 1 if the solution converged in the last solve; 0 otherwise. Updated after each call to the solver." +type = "integer" + +[memory.ttsoln] +readonly = true +set_in = "ar" +description = "Cumulative CPU time (seconds) spent in the linear solver." +type = "double" + +[memory.iter1] +set_in = "ar" +source = "inner_maximum" +description = "Maximum inner (linear) iterations." +type = "integer" + +[memory.rclose] +set_in = "ar" +source = "inner_rclose" +description = "Flow residual closure criterion for the linear solver." +type = "double" + +[memory.relax] +set_in = "ar" +source = "relaxation_factor" +description = "ILU(T) relaxation factor." +type = "double" + +[memory.droptol] +set_in = "ar" +source = "preconditioner_drop_tolerance" +description = "ILUT drop tolerance." +type = "double" + +[memory.north] +set_in = "ar" +source = "number_orthogonalizations" +description = "Interval for explicit residual recalculation." +type = "integer" + +[memory.iscl] +set_in = "ar" +source = "scaling_method" +description = "Matrix scaling option (integer code derived from SCALING_METHOD)." +type = "integer" + +[memory.iord] +set_in = "ar" +source = "reordering_method" +description = "Matrix reordering option (integer code derived from REORDERING_METHOD)." +type = "integer" + +[memory.ipc] +set_in = "ar" +description = "Preconditioner type code, computed from LINEAR_ACCELERATION, PRECONDITIONER_LEVELS, and PRECONDITIONER_DROP_TOLERANCE." +type = "integer" diff --git a/flopy4/mf6/dfns/utl-ats.toml b/flopy4/mf6/dfns/utl-ats.toml new file mode 100644 index 000000000..212ee947f --- /dev/null +++ b/flopy4/mf6/dfns/utl-ats.toml @@ -0,0 +1,69 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "utl-ats" +parent = "sim-tdis" +ftype = "ATS6" +subtype = "utility" + +[dims.maxats] +value = "maxats" + +[blocks.dimensions.fields.maxats] +type = "integer" +longname = "number of ATS periods" +description = "is the number of records in the subsequent perioddata block that will be used for adaptive time stepping." +default = 1 + +[blocks.perioddata.fields.perioddata] +type = "list" +longname = "stress period ats time information" +shape = [ + "<=maxats", +] + +[blocks.perioddata.fields.perioddata.item] +name = "perioddata" +type = "record" + +[blocks.perioddata.fields.perioddata.item.fields.iperats] +type = "integer" +longname = "stress period indicator" +description = "is the period number to apply the adaptive time stepping. Adaptive time stepping is only activated for those periods with a corresponding iperats entry in the perioddata block. The remaining ATS values on this line will apply to period iperats. iperats must be greater than zero. A warning is printed if iperats is greater than nper." +tagged = false +index = true +pk = true + +[blocks.perioddata.fields.perioddata.item.fields.dt0] +type = "double" +longname = "initial time step length" +description = "is the initial time step length for period iperats. If dt0 is zero, then the final step from the previous stress period will be used as the initial time step. The program will terminate with an error message if dt0 is negative." +tagged = false + +[blocks.perioddata.fields.perioddata.item.fields.dtmin] +type = "double" +longname = "minimum time step length" +description = "is the minimum time step length for this period. This value must be greater than zero and less than dtmax. dtmin must be a small value in order to ensure that simulation times end at the end of stress periods and the end of the simulation. A small value, such as 1.e-5, is recommended." +tagged = false + +[blocks.perioddata.fields.perioddata.item.fields.dtmax] +type = "double" +longname = "maximum time step length" +description = "is the maximum time step length for this period. This value must be greater than dtmin." +tagged = false + +[blocks.perioddata.fields.perioddata.item.fields.dtadj] +type = "double" +longname = "time step multiplier factor" +description = "is the time step multiplier factor for this period. If the number of outer solver iterations are less than the product of the maximum number of outer iterations (OUTER_MAXIMUM) and ATS_OUTER_MAXIMUM_FRACTION (an optional variable in the IMS input file with a default value of 1/3), then the time step length is multiplied by dtadj. If the number of outer solver iterations are greater than the product of the maximum number of outer iterations and 1.0 minus ATS_OUTER_MAXIMUM_FRACTION, then the time step length is divided by dtadj. dtadj must be zero, one, or greater than one. If dtadj is zero or one, then it has no effect on the simulation. A value between 2.0 and 5.0 can be used as an initial estimate." +tagged = false + +[blocks.perioddata.fields.perioddata.item.fields.dtfailadj] +type = "double" +longname = "divisor for failed time steps" +description = "is the divisor of the time step length when a time step fails to converge. If there is solver failure, then the time step will be tried again with a shorter time step length calculated as the previous time step length divided by dtfailadj. dtfailadj must be zero, one, or greater than one. If dtfailadj is zero or one, then time steps will not be retried with shorter lengths. In this case, the program will terminate with an error, or it will continue of the CONTINUE option is set in the simulation name file. Initial tests with this variable should be set to 5.0 or larger to determine if convergence can be achieved." +tagged = false + +[memory.maxats] +set_in = "ar" +source = "maxats" +type = "integer" diff --git a/flopy4/mf6/dfns/utl-hpc.toml b/flopy4/mf6/dfns/utl-hpc.toml new file mode 100644 index 000000000..ccd6d7c82 --- /dev/null +++ b/flopy4/mf6/dfns/utl-hpc.toml @@ -0,0 +1,43 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "utl-hpc" +parent = "sim-nam" +ftype = "HPC6" +subtype = "utility" + +[blocks.options.fields.print_table] +type = "keyword" +longname = "model print table to listing file" +description = "keyword to indicate that the partition table will be printed to the listing file." +optional = true + +[blocks.options.fields.dev_log_mpi] +type = "keyword" +longname = "log mpi traffic" +description = "keyword to enable (extremely verbose) logging of mpi traffic to file." +optional = true +developmode = true + +[blocks.partitions.fields.partitions] +type = "list" +longname = "list of partition numbers" +description = "is the list of zero-based partition numbers." +optional = true + +[blocks.partitions.fields.partitions.item] +name = "partitions" +type = "record" +description = "is the record of zero-based partition numbers." + +[blocks.partitions.fields.partitions.item.fields.mname] +type = "string" +longname = "model name" +description = "is the unique model name." +tagged = false +fk = "sim-nam.models.mname" + +[blocks.partitions.fields.partitions.item.fields.mrank] +type = "integer" +longname = "model rank" +description = "is the zero-based partition number (also: MPI rank or processor id) to which the model will be assigned." +tagged = false diff --git a/flopy4/mf6/dfns/utl-laktab.toml b/flopy4/mf6/dfns/utl-laktab.toml new file mode 100644 index 000000000..7e9639c3b --- /dev/null +++ b/flopy4/mf6/dfns/utl-laktab.toml @@ -0,0 +1,68 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "utl-laktab" +parent = "gwf-lak" +ftype = "LAKTAB6" +multi = true +subtype = "utility" + +[dims.nrow] +value = "nrow" + +[dims.ncol] +value = "ncol" + +[blocks.dimensions.fields.nrow] +type = "integer" +longname = "number of table rows" +description = "integer value specifying the number of rows in the lake table. There must be NROW rows of data in the TABLE block." + +[blocks.dimensions.fields.ncol] +type = "integer" +longname = "number of table columns" +description = "integer value specifying the number of columns in the lake table. There must be NCOL columns of data in the TABLE block. For lakes with HORIZONTAL and/or VERTICAL CTYPE connections, NCOL must be equal to 3. For lakes with EMBEDDEDH or EMBEDDEDV CTYPE connections, NCOL must be equal to 4." + +[blocks.table.fields.table] +type = "list" +shape = [ + "nrow", +] + +[blocks.table.fields.table.item] +name = "table" +type = "record" + +[blocks.table.fields.table.item.fields.stage] +type = "double" +longname = "lake stage" +description = "real value that defines the stage corresponding to the remaining data on the line." +tagged = false + +[blocks.table.fields.table.item.fields.volume] +type = "double" +longname = "lake volume" +description = "real value that defines the lake volume corresponding to the stage specified on the line." +tagged = false + +[blocks.table.fields.table.item.fields.sarea] +type = "double" +longname = "lake surface area" +description = "real value that defines the lake surface area corresponding to the stage specified on the line." +tagged = false + +[blocks.table.fields.table.item.fields.barea] +type = "double" +longname = "lake-GWF exchange area" +description = "real value that defines the lake-GWF exchange area corresponding to the stage specified on the line. BAREA is only specified if the CLAKTYPE for the lake is EMBEDDEDH or EMBEDDEDV." +optional = true +tagged = false + +[memory.nrow] +set_in = "ar" +source = "nrow" +type = "integer" + +[memory.ncol] +set_in = "ar" +source = "ncol" +type = "integer" diff --git a/flopy4/mf6/dfns/utl-ncf.toml b/flopy4/mf6/dfns/utl-ncf.toml new file mode 100644 index 000000000..b2178da8e --- /dev/null +++ b/flopy4/mf6/dfns/utl-ncf.toml @@ -0,0 +1,132 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "utl-ncf" +ftype = "NCF6" +subtype = "utility" +parent = [ + "gwe-dis", + "gwe-disv", + "gwf-dis", + "gwf-disv", + "gwt-dis", + "gwt-disv", + "prt-dis", + "prt-disv", +] + +[dims.ncpl] +value = "ncpl" + +[blocks.options.fields.wkt] +type = "string" +longname = "CRS well-known text (WKT1) string" +description = "is the coordinate reference system (CRS) well-known text string in WKT1 format (OGC 01-009). Written as the 'wkt' attribute on the projection variable. For supported projected CRS types, individual CF-standard numeric grid_mapping parameters are also written to the projection variable, for tools that read these directly rather than parsing 'wkt'/'crs_wkt' text. For a NETCDF_STRUCTURED export with a rotated grid (ANGROT not 0.0), WKT1 cannot represent the rotation; provide 'crs_wkt' instead for correct grid positioning. Ignored when latitude and longitude griddata arrays have been provided. To also embed the CRS in the binary grid file, provide the same string as the 'CRS' option in the discretization input; the discretization 'CRS' option additionally accepts other pyproj-compatible identifiers such as an EPSG code (e.g. 'EPSG:26918')." +optional = true +case_sensitive = true + +[blocks.options.fields.crs_wkt] +type = "string" +longname = "CRS well-known text (WKT2) string" +description = "is the coordinate reference system (CRS) well-known text string in WKT2 format (ISO 19162:2019), as required by CF-1.13. Written as the 'crs_wkt' attribute on the projection variable. When omitted, the 'wkt' value is written to 'crs_wkt' as a compatibility alias. Ignored when latitude and longitude griddata arrays have been provided. To also embed the CRS in the binary grid file, provide the same string as the 'CRS' option in the discretization input; the discretization 'CRS' option additionally accepts other pyproj-compatible identifiers such as an EPSG code (e.g. 'EPSG:26918'). For a NETCDF_STRUCTURED export with a rotated grid (ANGROT not 0.0), a valid WKT2 PROJCRS string is required here to correctly position the grid: it is wrapped in a derived CRS that encodes the rotation, resolved by any CRS-aware consumer through ordinary reprojection; without it the 'x'/'y' coordinate values remain grid-local rather than real-world. For grid mappings transverse_mercator, lambert_conformal_conic (two-standard-parallel variant only), and albers_conical_equal_area, individual CF-standard numeric grid_mapping parameters (e.g. 'false_easting', 'scale_factor_at_central_meridian') are also written to the projection variable, for tools -- such as ArcGIS's classic NetCDF connector -- that read these directly rather than parsing 'wkt'/'crs_wkt' text." +optional = true +case_sensitive = true + +[blocks.options.fields.deflate] +type = "integer" +longname = "variable compression deflate level" +description = "is the variable deflate level (0=min, 9=max) in the NetCDF file. Defining this parameter activates per-variable compression at the level specified. Use with the SHUFFLE option to also enable the shuffle filter." +optional = true + +[blocks.options.fields.shuffle] +type = "keyword" +description = "is the keyword used to turn on the NetCDF variable shuffle filter when the deflate option is also set. The shuffle filter has the effect of storing the first byte of all of a variable's values in a chunk contiguously, followed by all the second bytes, etc. This can be an optimization for compression with certain types of data." +optional = true + +[blocks.options.fields.chunk_time] +type = "integer" +longname = "chunking parameter for the time dimension" +description = "is the chunk size for the time dimension in a NETCDF_MESH2D or NETCDF_STRUCTURED output file. Must be used in combination with the chunk_face parameter (NETCDF_MESH2D) or the chunk_z, chunk_y, and chunk_x parameter set (NETCDF_STRUCTURED) to have an effect." +optional = true + +[blocks.options.fields.chunk_face] +type = "integer" +longname = "chunking parameter for the mesh face dimension" +description = "is the chunk size for the face dimension in a NETCDF_MESH2D output file. Must be used in combination with the chunk_time parameter to have an effect." +optional = true + +[blocks.options.fields.chunk_z] +type = "integer" +longname = "chunking parameter for the layer dimension" +description = "is the chunk size for the layer (vertical) dimension in a NETCDF_STRUCTURED output file. Must be used in combination with the chunk_time, chunk_x, and chunk_y parameters to have an effect." +optional = true + +[blocks.options.fields.chunk_y] +type = "integer" +longname = "chunking parameter for structured y" +description = "is the chunk size for the y dimension in a NETCDF_STRUCTURED output file. Must be used in combination with the chunk_time, chunk_x, and chunk_z parameters to have an effect." +optional = true + +[blocks.options.fields.chunk_x] +type = "integer" +longname = "chunking parameter for structured x" +description = "is the chunk size for the x dimension in a NETCDF_STRUCTURED output file. Must be used in combination with the chunk_time, chunk_y, and chunk_z parameters to have an effect." +optional = true + +[blocks.options.fields.modflow6_attr_off] +type = "keyword" +description = "is the keyword used to turn off internal input tagging in the model NetCDF file. Tagging adds internal modflow 6 attribute(s) to variables which facilitate identification. Currently this applies to gridded arrays." +optional = true + +[blocks.dimensions.fields.ncpl] +type = "integer" +longname = "number of cells in layer" +description = "is the number of cells in a projected plane layer." +optional = true + +[blocks.griddata.fields.latitude] +type = "array" +longname = "cell center latitude" +description = "cell center latitude array. Only supported for NETCDF_STRUCTURED export type; ignored, with a warning, for NETCDF_MESH2D. Providing latitude and longitude arrays enables geographic-coordinate output for external tooling that requires it, and is the more reliable option for a grid with non-uniform row or column spacing, or a rotated grid, since some tools cannot otherwise correctly position such a grid from 'wkt'/'crs_wkt' alone. For other grids, 'wkt'/'crs_wkt' is the simpler choice. When latitude and longitude arrays are provided, any 'wkt' or 'crs_wkt' option values are ignored." +optional = true +dtype = "double" +shape = [ + "ncpl", +] + +[blocks.griddata.fields.longitude] +type = "array" +longname = "cell center longitude" +description = "cell center longitude array. Only supported for NETCDF_STRUCTURED export type. See the latitude description for usage notes." +optional = true +dtype = "double" +shape = [ + "ncpl", +] + +[memory.attr_off] +set_in = "ar" +source = "modflow6_attr_off" +type = "logical" + +[memory.ncpl] +set_in = "ar" +source = "ncpl" +type = "integer" + +[memory.latitude] +type = "array" +set_in = "ar" +source = "latitude" +dtype = "double" +shape = [ + "ncpl", +] + +[memory.longitude] +type = "array" +set_in = "ar" +source = "longitude" +dtype = "double" +shape = [ + "ncpl", +] diff --git a/flopy4/mf6/dfns/utl-obs.toml b/flopy4/mf6/dfns/utl-obs.toml new file mode 100644 index 000000000..b4f307bd5 --- /dev/null +++ b/flopy4/mf6/dfns/utl-obs.toml @@ -0,0 +1,91 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "utl-obs" +ftype = "OBS6" +subtype = "utility" +parent = [ + "model", + "package", +] + +[blocks.options.fields.digits] +type = "integer" +description = "Keyword and an integer digits specifier used for conversion of simulated values to text on output. If not specified, the default is the maximum number of digits stored in the program (as written with the G0 Fortran specifier). When simulated values are written to a comma-separated value text file specified in a CONTINUOUS block below, the digits specifier controls the number of significant digits with which simulated values are written to the output file. The digits specifier has no effect on the number of significant digits with which the simulation time is written for continuous observations. If DIGITS is specified as zero, then observations are written with the default setting, which is the maximum number of digits." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of observation information will be written to the listing file immediately after it is read." +optional = true + +[blocks.continuous.fields.continuous] +type = "list" + +[blocks.continuous.fields.continuous.item] +name = "continuous" +type = "record" + +[blocks.continuous.fields.continuous.item.fields.obsname] +type = "string" +longname = "observation name" +description = "string of 1 to 40 nonblank characters used to identify the observation. The identifier need not be unique; however, identification and post-processing of observations in the output files are facilitated if each observation is given a unique name." +tagged = false + +[blocks.continuous.fields.continuous.item.fields.obstype] +type = "string" +longname = "observation type" +description = "a string of characters used to identify the observation type." +tagged = false + +[blocks.continuous.fields.continuous.item.fields.id] +type = "union" +longname = "time" +description = "Text identifying cell where observation is located. For packages other than NPF, if boundary names are defined in the corresponding package input file, ID can be a boundary name. Otherwise ID is a cellid. If the model discretization is type DIS, cellid is three integers (layer, row, column). If the discretization is DISV, cellid is two integers (layer, cell number). If the discretization is DISU, cellid is one integer (node number)." + +[blocks.continuous.fields.continuous.item.fields.id.arms.cellid] +type = "cellid" +tagged = false + +[blocks.continuous.fields.continuous.item.fields.id.arms.index] +type = "integer" +tagged = false +index = true + +[blocks.continuous.fields.continuous.item.fields.id.arms.boundname] +type = "string" +tagged = false + +[blocks.continuous.fields.continuous.item.fields.id2] +type = "union" +longname = "time" +description = "Text identifying cell adjacent to cell identified by ID. The form of ID2 is as described for ID. ID2 is used for intercell-flow observations of a GWF model, for three observation types of the LAK Package, for two observation types of the MAW Package, and one observation type of the UZF Package." +optional = true + +[blocks.continuous.fields.continuous.item.fields.id2.arms.cellid] +type = "cellid" +tagged = false + +[blocks.continuous.fields.continuous.item.fields.id2.arms.index] +type = "integer" +tagged = false +index = true + +[blocks.continuous.fields.continuous.item.fields.id2.arms.boundname] +type = "string" +tagged = false + +[blocks.continuous.header.field] +name = "output" +type = "record" + +[blocks.continuous.header.field.fields.obs_output_file_name] +type = "file" +description = "Name of a file to which simulated values corresponding to observations in the block are to be written. The file name can be an absolute or relative path name. A unique output file must be specified for each CONTINUOUS block. If the 'BINARY' option is used, output is written in binary form. By convention, text output files have the extension 'csv' (for 'Comma-Separated Values') and binary output files have the extension 'bsv' (for 'Binary Simulated Values')." +tagged = false +direction = "out" + +[blocks.continuous.header.field.fields.binary] +type = "keyword" +description = "an optional keyword used to indicate that the output file should be written in binary (unformatted) form." +optional = true diff --git a/flopy4/mf6/dfns/utl-sfrtab.toml b/flopy4/mf6/dfns/utl-sfrtab.toml new file mode 100644 index 000000000..45c4e5ef3 --- /dev/null +++ b/flopy4/mf6/dfns/utl-sfrtab.toml @@ -0,0 +1,62 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "utl-sfrtab" +parent = "gwf-sfr" +ftype = "SFRTAB6" +multi = true +subtype = "utility" + +[dims.nrow] +value = "nrow" + +[dims.ncol] +value = "ncol" + +[blocks.dimensions.fields.nrow] +type = "integer" +longname = "number of table rows" +description = "integer value specifying the number of rows in the reach cross-section table. There must be NROW rows of data in the TABLE block." + +[blocks.dimensions.fields.ncol] +type = "integer" +longname = "number of table columns" +description = "integer value specifying the number of columns in the reach cross-section table. There must be NCOL columns of data in the TABLE block. NCOL must be equal to 2 if MANFRACTION is not specified or 3 otherwise." + +[blocks.table.fields.table] +type = "list" +shape = [ + "nrow", +] + +[blocks.table.fields.table.item] +name = "table" +type = "record" + +[blocks.table.fields.table.item.fields.xfraction] +type = "double" +longname = "fractional width" +description = "real value that defines the station (x) data for the cross-section as a fraction of the width (RWID) of the reach. XFRACTION must be greater than or equal to zero but can be greater than one. XFRACTION values can be used to decrease or increase the width of a reach from the specified reach width (RWID)." +tagged = false + +[blocks.table.fields.table.item.fields.height] +type = "double" +longname = "depth" +description = "real value that is the height relative to the top of the lowest elevation of the streambed (RTP) and corresponding to the station data on the same line. HEIGHT must be greater than or equal to zero and at least one cross-section height must be equal to zero." +tagged = false + +[blocks.table.fields.table.item.fields.manfraction] +type = "double" +longname = "Manning's roughness coefficient" +description = "real value that defines the Manning's roughness coefficient data for the cross-section as a fraction of the Manning's roughness coefficient for the reach (MAN) and corresponding to the station data on the same line. MANFRACTION must be greater than zero. MANFRACTION is applied from the XFRACTION value on the same line to the XFRACTION value on the next line. Although a MANFRACTION value is specified on the last line, any value greater than zero can be applied to MANFRACTION(NROW). MANFRACTION is only specified if NCOL is 3. If MANFRACTION is not specified, the Manning's roughness coefficient for the reach (MAN) is applied to the entire cross-section." +optional = true +tagged = false + +[memory.nrow] +set_in = "ar" +source = "nrow" +type = "integer" + +[memory.ncol] +set_in = "ar" +source = "ncol" +type = "integer" diff --git a/flopy4/mf6/dfns/utl-spc.toml b/flopy4/mf6/dfns/utl-spc.toml new file mode 100644 index 000000000..a089ad8d1 --- /dev/null +++ b/flopy4/mf6/dfns/utl-spc.toml @@ -0,0 +1,99 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "utl-spc" +ftype = "SPC6" +multi = true +subtype = "utility" +parent = [ + "gwe-ssm", + "gwt-ssm", +] + +[dims.maxbound] +value = "maxbound" + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of spc information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.dimensions.fields.maxbound] +type = "integer" +longname = "maximum number of ssm entries" +description = "integer value specifying the maximum number of spc cells that will be specified for use during any stress period." + +[blocks.period.fields.stress_period_data] +type = "list" +shape = [ + "<=maxbound", +] + +[blocks.period.fields.stress_period_data.item] +name = "perioddata" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.bndno] +type = "integer" +longname = "bound number for this entry" +description = "integer value that defines the boundary package feature number associated with the specified PERIOD data on the line. BNDNO must be greater than zero and less than or equal to MAXBOUND." +tagged = false +index = true +pk = true + +[blocks.period.fields.stress_period_data.item.fields.bndno.fk] +key = "bound" +rule = "ssm_package" + +[blocks.period.fields.stress_period_data.item.fields.spcsetting] +type = "union" +description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the SPCSETTING string include: CONCENTRATION and TEMPERATURE." + +[blocks.period.fields.stress_period_data.item.fields.spcsetting.arms.concentration] +type = "double" +longname = "boundary concentration" +description = "is the boundary concentration. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, the CONCENTRATION for each boundary feature is zero." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.spcsetting.arms.temperature] +type = "double" +longname = "boundary temperature" +description = "is the user-supplied boundary temperature. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, the TEMPERATURE for each boundary feature is zero." +time_series = true + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.maxbound] +set_in = "ar" +source = "maxbound" +type = "integer" diff --git a/flopy4/mf6/dfns/utl-spca.toml b/flopy4/mf6/dfns/utl-spca.toml new file mode 100644 index 000000000..b1f42eeff --- /dev/null +++ b/flopy4/mf6/dfns/utl-spca.toml @@ -0,0 +1,76 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "utl-spca" +ftype = "SPC6" +multi = true +subtype = "utility" +parent = [ + "gwe-ssm", + "gwt-ssm", +] + +[blocks.options.fields.readasarrays] +type = "keyword" +longname = "use array-based input" +description = "indicates that array-based input will be used for the SPC Package. This keyword must be specified to use array-based input. When READASARRAYS is specified, values must be provided for every cell within a model layer, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results." +default = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that the list of spc information will be written to the listing file immediately after it is read." +optional = true + +[blocks.options.fields.tas_filerecord] +type = "list" +optional = true + +[blocks.options.fields.tas_filerecord.item] +name = "tas_filerecord" +type = "record" + +[blocks.options.fields.tas_filerecord.item.fields.tas6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-array-series file." + +[blocks.options.fields.tas_filerecord.item.fields.tas6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the Time-Variable Input section for instructions on using the time-array series capability." +tagged = false +direction = "in" +component = "utl-tas" + +[blocks.period.fields.concentration] +type = "array" +longname = "concentration" +description = "is the concentration of the associated Recharge or Evapotranspiration stress package. The concentration array may be defined by a time-array series (see the \"Using Time-Array Series in a Package\" section)." +optional = true +dtype = "double" +time_series = true +shape = [ + "ncpl", +] + +[blocks.period.fields.temperature] +type = "array" +longname = "temperature" +description = "is the temperature of the associated Recharge or Evapotranspiration stress package. The temperature array may be defined by a time-array series (see the \"Using Time-Array Series in a Package\" section)." +optional = true +dtype = "double" +time_series = true +shape = [ + "ncpl", +] + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true diff --git a/flopy4/mf6/dfns/utl-tas.toml b/flopy4/mf6/dfns/utl-tas.toml new file mode 100644 index 000000000..8a5ac5258 --- /dev/null +++ b/flopy4/mf6/dfns/utl-tas.toml @@ -0,0 +1,79 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "utl-tas" +ftype = "TAS6" +multi = true +subtype = "utility" +parent = [ + "gwf-evta", + "gwf-rcha", + "utl-spca", +] + +[dims.time_series_name] +value = "len(time_series_name)" + +[blocks.attributes.fields.time_series_namerecord] +type = "record" +description = "xxx" + +[blocks.attributes.fields.time_series_namerecord.fields.name] +type = "keyword" +description = "xxx" + +[blocks.attributes.fields.time_series_namerecord.fields.time_series_name] +type = "array" +description = "Name by which a package references a particular time-array series. The name must be unique among all time-array series used in a package." +tagged = false +dtype = "string" + +[blocks.attributes.fields.interpolation_methodrecord] +type = "record" +description = "xxx" +optional = true + +[blocks.attributes.fields.interpolation_methodrecord.fields.method] +type = "keyword" +description = " xxx" + +[blocks.attributes.fields.interpolation_methodrecord.fields.interpolation_method] +type = "string" +description = "Interpolation method, which is either STEPWISE or LINEAR." +tagged = false +valid = [ + "stepwise", + "linear", +] + +[blocks.attributes.fields.sfacrecord] +type = "record" +description = "xxx" +optional = true + +[blocks.attributes.fields.sfacrecord.fields.sfac] +type = "keyword" +description = " xxx" + +[blocks.attributes.fields.sfacrecord.fields.sfacval] +type = "array" +description = "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0." +tagged = false +dtype = "double" +shape = [ + "time_series_name", +] + +[blocks.time.fields.tas_array] +type = "array" +description = "An array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility." +tagged = false +dtype = "double" +shape = [ + "ncpl", +] + +[blocks.time.header.field] +name = "time_from_model_start" +type = "double" +description = "A numeric time relative to the start of the simulation, in the time unit used in the simulation. Times must be strictly increasing." +tagged = false diff --git a/flopy4/mf6/dfns/utl-ts.toml b/flopy4/mf6/dfns/utl-ts.toml new file mode 100644 index 000000000..54ee6098b --- /dev/null +++ b/flopy4/mf6/dfns/utl-ts.toml @@ -0,0 +1,119 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "utl-ts" +parent = "package" +ftype = "TS6" +multi = true +subtype = "utility" + +[dims.time_series_names] +value = "len(time_series_names)" + +[blocks.attributes.fields.time_series_namerecord] +type = "record" +description = "xxx" + +[blocks.attributes.fields.time_series_namerecord.fields.names] +type = "keyword" +description = "keyword to specify the names of the time series. The 'NAME' keyword can be used as a substitute for 'NAMES'." +aliases = [ + "name", +] + +[blocks.attributes.fields.time_series_namerecord.fields.time_series_names] +type = "array" +description = "Name by which a package references a particular time-array series. The name must be unique among all time-array series used in a package." +tagged = false +dtype = "string" + +[blocks.attributes.fields.interpolation_methodrecord] +type = "record" +description = "xxx" +optional = true + +[blocks.attributes.fields.interpolation_methodrecord.fields.methods] +type = "keyword" +description = " xxx" + +[blocks.attributes.fields.interpolation_methodrecord.fields.interpolation_method] +type = "array" +description = "Interpolation method, which is either STEPWISE or LINEAR." +tagged = false +dtype = "string" +shape = [ + "time_series_names", +] + +[blocks.attributes.fields.interpolation_methodrecord_single] +type = "record" +description = "xxx" +optional = true + +[blocks.attributes.fields.interpolation_methodrecord_single.fields.method] +type = "keyword" +description = " xxx" + +[blocks.attributes.fields.interpolation_methodrecord_single.fields.interpolation_method_single] +type = "string" +description = "Interpolation method, which is either STEPWISE or LINEAR." +tagged = false +valid = [ + "stepwise", + "linear", + "linearend", +] + +[blocks.attributes.fields.sfacrecord] +type = "record" +description = "xxx" +optional = true + +[blocks.attributes.fields.sfacrecord.fields.sfacs] +type = "keyword" +description = " xxx" + +[blocks.attributes.fields.sfacrecord.fields.sfacval] +type = "array" +description = "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0." +tagged = false +dtype = "double" +shape = [ + "time_series_names", +] + +[blocks.attributes.fields.sfacrecord_single] +type = "record" +description = "xxx" +optional = true + +[blocks.attributes.fields.sfacrecord_single.fields.sfac] +type = "keyword" +description = " xxx" + +[blocks.attributes.fields.sfacrecord_single.fields.sfacval] +type = "double" +description = "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0." +tagged = false + +[blocks.timeseries.fields.timeseries] +type = "list" +description = "xxx" + +[blocks.timeseries.fields.timeseries.item] +name = "timeseries" +type = "record" +description = "xxx" + +[blocks.timeseries.fields.timeseries.item.fields.ts_time] +type = "double" +description = "A numeric time relative to the start of the simulation, in the time unit used in the simulation. Times must be strictly increasing." +tagged = false + +[blocks.timeseries.fields.timeseries.item.fields.ts_array] +type = "array" +description = "A 2-D array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility." +tagged = false +dtype = "double" +shape = [ + "time_series_names", +] diff --git a/flopy4/mf6/dfns/utl-tvk.toml b/flopy4/mf6/dfns/utl-tvk.toml new file mode 100644 index 000000000..093c4b21e --- /dev/null +++ b/flopy4/mf6/dfns/utl-tvk.toml @@ -0,0 +1,79 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "utl-tvk" +parent = "gwf-npf" +ftype = "TVK6" +subtype = "utility" + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that information for each change to the hydraulic conductivity in a cell will be written to the model listing file." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "perioddata" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.tvksetting] +type = "union" +description = "line of information that is parsed into a property name keyword and values. Property name keywords that can be used to start the TVKSETTING string include: K, K22, and K33." + +[blocks.period.fields.stress_period_data.item.fields.tvksetting.arms.k] +type = "double" +longname = "hydraulic conductivity (L/T)" +description = "is the new value to be assigned as the cell's hydraulic conductivity from the start of the specified stress period, as per K in the NPF package. If the OPTIONS block includes a TS6 entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.tvksetting.arms.k22] +type = "double" +longname = "hydraulic conductivity of second ellipsoid axis (L/T)" +description = "is the new value to be assigned as the cell's hydraulic conductivity of the second ellipsoid axis (or the ratio of K22/K if the K22OVERK NPF package option is specified) from the start of the specified stress period, as per K22 in the NPF package. For an unrotated case this is the hydraulic conductivity in the y direction. If the OPTIONS block includes a TS6 entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.tvksetting.arms.k33] +type = "double" +longname = "hydraulic conductivity of third ellipsoid axis (L/T)" +description = "is the new value to be assigned as the cell's hydraulic conductivity of the third ellipsoid axis (or the ratio of K33/K if the K33OVERK NPF package option is specified) from the start of the specified stress period, as per K33 in the NPF package. For an unrotated case, this is the vertical hydraulic conductivity. If the OPTIONS block includes a TS6 entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true diff --git a/flopy4/mf6/dfns/utl-tvs.toml b/flopy4/mf6/dfns/utl-tvs.toml new file mode 100644 index 000000000..bb2853cf1 --- /dev/null +++ b/flopy4/mf6/dfns/utl-tvs.toml @@ -0,0 +1,84 @@ +type = "package" +schema_version = "2.0.0.dev3" +name = "utl-tvs" +parent = "gwf-sto" +ftype = "TVS6" +subtype = "utility" + +[blocks.options.fields.disable_storage_change_integration] +type = "keyword" +longname = "deactivate storage change integration" +description = "keyword that deactivates inclusion of storage derivative terms in the STO package matrix formulation. In the absence of this keyword (the default), the groundwater storage formulation will be modified to correctly adjust heads based on transient variations in stored water volumes arising from changes to SS and SY properties." +optional = true + +[blocks.options.fields.print_input] +type = "keyword" +longname = "print input to listing file" +description = "keyword to indicate that information for each change to a storage property in a cell will be written to the model listing file." +optional = true + +[blocks.options.fields.ts_filerecord] +type = "list" +optional = true + +[blocks.options.fields.ts_filerecord.item] +name = "ts_filerecord" +type = "record" + +[blocks.options.fields.ts_filerecord.item.fields.ts6] +type = "keyword" +longname = "head keyword" +description = "keyword to specify that record corresponds to a time-series file." + +[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] +type = "file" +longname = "file name of time series information" +description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." +tagged = false +direction = "in" +component = "utl-ts" + +[blocks.period.fields.stress_period_data] +type = "list" + +[blocks.period.fields.stress_period_data.item] +name = "perioddata" +type = "record" + +[blocks.period.fields.stress_period_data.item.fields.cellid] +type = "cellid" +longname = "cell identifier" +description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." +tagged = false + +[blocks.period.fields.stress_period_data.item.fields.tvssetting] +type = "union" +description = "line of information that is parsed into a property name keyword and values. Property name keywords that can be used to start the TVSSETTING string include: SS and SY." + +[blocks.period.fields.stress_period_data.item.fields.tvssetting.arms.ss] +type = "double" +longname = "specific storage" +description = "is the new value to be assigned as the cell's specific storage (or storage coefficient if the STORAGECOEFFICIENT STO package option is specified) from the start of the specified stress period, as per SS in the STO package. Specific storage values must be greater than or equal to 0. If the OPTIONS block includes a TS6 entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.fields.stress_period_data.item.fields.tvssetting.arms.sy] +type = "double" +longname = "specific yield" +description = "is the new value to be assigned as the cell's specific yield from the start of the specified stress period, as per SY in the STO package. Specific yield values must be greater than or equal to 0. If the OPTIONS block includes a TS6 entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." +time_series = true + +[blocks.period.header] +fill_forward = true + +[blocks.period.header.field] +name = "iper" +type = "integer" +longname = "stress period number" +description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." +tagged = false +index = true + +[memory.disable_sc_int] +set_in = "ar" +source = "disable_storage_change_integration" +type = "logical" diff --git a/flopy4/mf6/external.py b/flopy4/mf6/external.py index f8c118e20..e06b3da5d 100644 --- a/flopy4/mf6/external.py +++ b/flopy4/mf6/external.py @@ -66,6 +66,10 @@ class _Target: binary: bool hash: str | None = None # the values' hash when loaded records: np.ndarray | None = None # a list's rows, for a binary file + # written to a file because `WriteContext.array_format` says to, and + # where to if it can't be `path`, absolute, normalized + forced: bool = False + own: Path | None = None def unchanged(self) -> bool: """Whether the values are as loaded from the file.""" @@ -116,7 +120,9 @@ def write_external_arrays( the writer can't tell which is the edited one, and writes every array of the file inline. An array disagreeing with a file another component already wrote is written inline. Either way, with a - warning. + warning. An array written to a file because the context's + `array_format` says to isn't written inline, but to a file of its + own, named as if it had no path. With `context.strict`, either rule raises `ExternalFileError` instead, before any file of the component is written. @@ -208,25 +214,45 @@ def _write_targets( inline: list[_Target] = [] writes: list[_Target] = [] - for path, group in groups.items(): + queue = list(groups.items()) + + def apart(group: list[_Target]) -> str: + """Write `group`'s arrays inline, or those `array_format` sends to + files to files of their own, and say which, for a warning.""" + alone = [t for t in group if t.forced and t.own is not None] + kept = [t for t in group if not any(t is a for a in alone)] + inline.extend(kept) + for t in alone: + assert t.own is not None + t.path = _unique(t.own, claimed) + claimed.add(t.path) + queue.append((t.path, [t])) + if not alone: + return "writing them inline" + where = ", ".join(f"{t.label} to {t.path.name}" for t in alone) + if not kept: + return f"writing {where}" + return f"writing {where}, and {', '.join(t.label for t in kept)} inline" + + while queue: + path, group = queue.pop(0) if (differ := _disagree(group)) is not None: unchanged = [t for t in group if t.unchanged()] changed = [t for t in group if not any(t is u for u in unchanged)] if unchanged and changed and _disagree(unchanged) is None: warn( f"{path}: {', '.join(t.label for t in changed)} changed since " - "loaded from this file; writing them inline. " + f"loaded from this file; {apart(changed)}. " f"{', '.join(t.label for t in unchanged)} still use it." ) - inline.extend(changed) group = unchanged else: + labels = ", ".join(t.label for t in group) warn( - f"{path}: {', '.join(t.label for t in group)} use this file but " - f"{differ}; writing them inline. To write one of them to the " - "file, give the others another path." + f"{path}: {labels} use this file but {differ}; {apart(group)}. " + "To write one of them to the file, give the others another " + "ArrayIO path." ) - inline.extend(group) continue first = group[0] if (written := files.get(path)) is not None: @@ -238,9 +264,8 @@ def _write_targets( if differ: warn( f"{path}: {', '.join(t.label for t in group)} use this file, " - f"which {written.label} wrote {differ}; writing them inline." + f"which {written.label} wrote {differ}; {apart(group)}." ) - inline.extend(group) continue writes.append(first) @@ -307,19 +332,29 @@ def _targets( def target(layer: int | None) -> _Target | None: values = value if layer is None else value.isel(nlay=layer) if layer is None: - own, path, loaded = (value.attrs.get(a) for a in ("format", "path", "hash")) + own_format, path, loaded = (value.attrs.get(a) for a in ("format", "path", "hash")) else: - own = layer_format.get(layer, value.attrs.get("format")) + own_format = layer_format.get(layer, value.attrs.get("format")) path, loaded = layer_path.get(layer), layer_hash.get(layer) - fmt = _file_format(values, own, path is not None, context) + fmt = _file_format(values, own_format, path is not None, context) if fmt is None: return None binary = fmt == "binary" - if path is None: - name = stem + ("" if layer is None else f"_l{layer + 1}") - path = filename.parent / f"{name}.{'bin' if binary else 'txt'}" + name = stem + ("" if layer is None else f"_l{layer + 1}") + own = _absolute(filename.parent / f"{name}.{'bin' if binary else 'txt'}", root) what = where if layer is None else f"{where} layer {layer + 1}" - return _Target(block_name, key, layer, what, _absolute(path, root), values, binary, loaded) + return _Target( + block_name, + key, + layer, + what, + own if path is None else _absolute(path, root), + values, + binary, + loaded, + forced=own_format is None and fmt == context.array_format, + own=own, + ) by_layer = "nlay" in value.dims and ( bool(layer_path) diff --git a/flopy4/mf6/gwe/ctp.py b/flopy4/mf6/gwe/ctp.py index fe88d5c08..b9817d5cb 100644 --- a/flopy4/mf6/gwe/ctp.py +++ b/flopy4/mf6/gwe/ctp.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Ctp(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "ctp": (("cellid",), ("string",)), } diff --git a/flopy4/mf6/gwe/esl.py b/flopy4/mf6/gwe/esl.py index 0048dba2e..4c24cdf5d 100644 --- a/flopy4/mf6/gwe/esl.py +++ b/flopy4/mf6/gwe/esl.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Esl(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "esl": (("cellid",), ("string",)), "to-mvr": (("cellid",), ("string",)), diff --git a/flopy4/mf6/gwe/lke.py b/flopy4/mf6/gwe/lke.py index 557ad8103..0b355b099 100644 --- a/flopy4/mf6/gwe/lke.py +++ b/flopy4/mf6/gwe/lke.py @@ -10,7 +10,18 @@ from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, double, file, integer, keyword, list_, string, union +from flopy4.mf6.spec import ( + Header, + array, + child, + double, + file, + integer, + keyword, + list_, + string, + union, +) from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -22,6 +33,10 @@ class Lke(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "constant": (("index",), ("string",)), "evaporation": (("index",), ("string",)), diff --git a/flopy4/mf6/gwe/mwe.py b/flopy4/mf6/gwe/mwe.py index c0589f1a9..e185b8ab6 100644 --- a/flopy4/mf6/gwe/mwe.py +++ b/flopy4/mf6/gwe/mwe.py @@ -10,7 +10,18 @@ from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, double, file, integer, keyword, list_, string, union +from flopy4.mf6.spec import ( + Header, + array, + child, + double, + file, + integer, + keyword, + list_, + string, + union, +) from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -22,6 +33,10 @@ class Mwe(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "constant": (("index",), ("string",)), "from-mvr": (("index",), ("string",)), diff --git a/flopy4/mf6/gwe/oc.py b/flopy4/mf6/gwe/oc.py index f70e0fac7..79d54f2d9 100644 --- a/flopy4/mf6/gwe/oc.py +++ b/flopy4/mf6/gwe/oc.py @@ -8,7 +8,7 @@ from flopy4.mf6.legacy import Legacy, oc_period_data from flopy4.mf6.package import Package from flopy4.mf6.record import Record -from flopy4.mf6.spec import array, file, integer, list_, record, string, union +from flopy4.mf6.spec import Header, array, file, integer, list_, record, string, union @attrs.define(kw_only=True, slots=False) @@ -16,6 +16,10 @@ class Oc(Package): dfn_name: ClassVar[str] = "gwe-oc" ftype: ClassVar[str] = "OC6" + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + legacy_kwargs: ClassVar[dict[str, Legacy]] = { "saverecord": Legacy("stress_period_data", oc_period_data), "printrecord": Legacy("stress_period_data", oc_period_data), diff --git a/flopy4/mf6/gwe/sfe.py b/flopy4/mf6/gwe/sfe.py index b2656161e..021c00aa2 100644 --- a/flopy4/mf6/gwe/sfe.py +++ b/flopy4/mf6/gwe/sfe.py @@ -10,7 +10,18 @@ from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, double, file, integer, keyword, list_, string, union +from flopy4.mf6.spec import ( + Header, + array, + child, + double, + file, + integer, + keyword, + list_, + string, + union, +) from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -22,6 +33,10 @@ class Sfe(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "constant": (("index",), ("string",)), "evaporation": (("index",), ("string",)), diff --git a/flopy4/mf6/gwe/uze.py b/flopy4/mf6/gwe/uze.py index f0d37a237..080e55c04 100644 --- a/flopy4/mf6/gwe/uze.py +++ b/flopy4/mf6/gwe/uze.py @@ -10,7 +10,18 @@ from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, double, file, integer, keyword, list_, string, union +from flopy4.mf6.spec import ( + Header, + array, + child, + double, + file, + integer, + keyword, + list_, + string, + union, +) from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -22,6 +33,10 @@ class Uze(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "constant": (("index",), ("string",)), "flow-ja-face": (("index", "index"), ("string",)), diff --git a/flopy4/mf6/gwf/chd.py b/flopy4/mf6/gwf/chd.py index 55599ea1f..8bffd7e20 100644 --- a/flopy4/mf6/gwf/chd.py +++ b/flopy4/mf6/gwf/chd.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Chd(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "chd": (("cellid",), ("string",)), } diff --git a/flopy4/mf6/gwf/chdg.py b/flopy4/mf6/gwf/chdg.py index 5c15a690b..10c43d9c1 100644 --- a/flopy4/mf6/gwf/chdg.py +++ b/flopy4/mf6/gwf/chdg.py @@ -7,7 +7,7 @@ from flopy4.mf6._types import FloatArrayLike, to_array from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, integer, keyword, string +from flopy4.mf6.spec import Header, array, child, integer, keyword, string from flopy4.mf6.utl.obs import Obs @@ -18,6 +18,10 @@ class Chdg(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "chd": (("cellid",), ("string",)), } diff --git a/flopy4/mf6/gwf/csub.py b/flopy4/mf6/gwf/csub.py index c9a3eeaa2..3d6159b5a 100644 --- a/flopy4/mf6/gwf/csub.py +++ b/flopy4/mf6/gwf/csub.py @@ -7,7 +7,18 @@ from flopy4.mf6._types import FloatArrayLike, TimeSeriesRef from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, file, integer, keyword, list_, string +from flopy4.mf6.spec import ( + Header, + array, + cellid_, + child, + double, + file, + integer, + keyword, + list_, + string, +) from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -17,6 +28,10 @@ class Csub(Package): dfn_name: ClassVar[str] = "gwf-csub" ftype: ClassVar[str] = "CSUB6" + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "coarse-compaction": (("cellid",),), "coarse-csub": (("cellid",),), diff --git a/flopy4/mf6/gwf/drn.py b/flopy4/mf6/gwf/drn.py index e81736b92..a89074b85 100644 --- a/flopy4/mf6/gwf/drn.py +++ b/flopy4/mf6/gwf/drn.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Drn(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "drn": (("cellid",), ("string",)), "to-mvr": (("cellid",), ("string",)), diff --git a/flopy4/mf6/gwf/drng.py b/flopy4/mf6/gwf/drng.py index 9bd607e59..8b02629fc 100644 --- a/flopy4/mf6/gwf/drng.py +++ b/flopy4/mf6/gwf/drng.py @@ -7,7 +7,7 @@ from flopy4.mf6._types import FloatArrayLike, to_array from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, integer, keyword, string +from flopy4.mf6.spec import Header, array, child, integer, keyword, string from flopy4.mf6.utl.obs import Obs @@ -18,6 +18,10 @@ class Drng(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "drn": (("cellid",), ("string",)), "to-mvr": (("cellid",), ("string",)), diff --git a/flopy4/mf6/gwf/evt.py b/flopy4/mf6/gwf/evt.py index 57f53fb3e..cecfeb411 100644 --- a/flopy4/mf6/gwf/evt.py +++ b/flopy4/mf6/gwf/evt.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, integer, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, integer, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Evt(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "evt": (("cellid",), ("string",)), } diff --git a/flopy4/mf6/gwf/evta.py b/flopy4/mf6/gwf/evta.py index a941f810e..8247df59e 100644 --- a/flopy4/mf6/gwf/evta.py +++ b/flopy4/mf6/gwf/evta.py @@ -7,7 +7,7 @@ from flopy4.mf6._types import FloatArrayLike, IntArrayLike, TimeArraySeriesRef, to_array from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, keyword, string +from flopy4.mf6.spec import Header, array, child, keyword, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.tas import Tas @@ -19,6 +19,10 @@ class Evta(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "evt": (("cellid",), ("string",)), } diff --git a/flopy4/mf6/gwf/ghb.py b/flopy4/mf6/gwf/ghb.py index e1677ac7c..ca1c7b034 100644 --- a/flopy4/mf6/gwf/ghb.py +++ b/flopy4/mf6/gwf/ghb.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Ghb(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "ghb": (("cellid",), ("string",)), "to-mvr": (("cellid",), ("string",)), diff --git a/flopy4/mf6/gwf/ghbg.py b/flopy4/mf6/gwf/ghbg.py index 6e37617b1..722edfd67 100644 --- a/flopy4/mf6/gwf/ghbg.py +++ b/flopy4/mf6/gwf/ghbg.py @@ -7,7 +7,7 @@ from flopy4.mf6._types import FloatArrayLike, to_array from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, integer, keyword, string +from flopy4.mf6.spec import Header, array, child, integer, keyword, string from flopy4.mf6.utl.obs import Obs @@ -18,6 +18,10 @@ class Ghbg(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "ghb": (("cellid",), ("string",)), "to-mvr": (("cellid",), ("string",)), diff --git a/flopy4/mf6/gwf/hfb.py b/flopy4/mf6/gwf/hfb.py index 6b9efd836..9a669cde7 100644 --- a/flopy4/mf6/gwf/hfb.py +++ b/flopy4/mf6/gwf/hfb.py @@ -5,7 +5,7 @@ from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import cellid_, double, integer, keyword, list_ +from flopy4.mf6.spec import Header, cellid_, double, integer, keyword, list_ @attrs.define(kw_only=True, slots=False) @@ -13,6 +13,10 @@ class Hfb(Package): dfn_name: ClassVar[str] = "gwf-hfb" ftype: ClassVar[str] = "HFB6" + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + @attrs.define class StressPeriodData(Item): cellid1: tuple[int, ...] = cellid_() diff --git a/flopy4/mf6/gwf/lak.py b/flopy4/mf6/gwf/lak.py index 442748a40..f8fb3f310 100644 --- a/flopy4/mf6/gwf/lak.py +++ b/flopy4/mf6/gwf/lak.py @@ -12,6 +12,7 @@ from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package from flopy4.mf6.spec import ( + Header, array, cellid_, child, @@ -35,6 +36,10 @@ class Lak(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "conductance": (("index", "index"), ("index", "string"), ("string",)), "constant": (("index",), ("string",)), diff --git a/flopy4/mf6/gwf/maw.py b/flopy4/mf6/gwf/maw.py index ddcdde91b..d277c4536 100644 --- a/flopy4/mf6/gwf/maw.py +++ b/flopy4/mf6/gwf/maw.py @@ -12,6 +12,7 @@ from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package from flopy4.mf6.spec import ( + Header, array, cellid_, child, @@ -34,6 +35,10 @@ class Maw(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "conductance": (("index", "index"), ("index", "string"), ("string",)), "constant": (("index",), ("string",)), diff --git a/flopy4/mf6/gwf/mvr.py b/flopy4/mf6/gwf/mvr.py index 514348e94..127146721 100644 --- a/flopy4/mf6/gwf/mvr.py +++ b/flopy4/mf6/gwf/mvr.py @@ -7,7 +7,7 @@ from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package -from flopy4.mf6.spec import double, file, integer, keyword, list_, string +from flopy4.mf6.spec import Header, double, file, integer, keyword, list_, string @attrs.define(kw_only=True, slots=False) @@ -15,6 +15,10 @@ class Mvr(Package): dfn_name: ClassVar[str] = "gwf-mvr" ftype: ClassVar[str] = "MVR6" + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + legacy_kwargs: ClassVar[dict[str, Legacy]] = { "perioddata": Legacy("stress_period_data"), } diff --git a/flopy4/mf6/gwf/oc.py b/flopy4/mf6/gwf/oc.py index bbcd1b26b..42b816950 100644 --- a/flopy4/mf6/gwf/oc.py +++ b/flopy4/mf6/gwf/oc.py @@ -8,7 +8,7 @@ from flopy4.mf6.legacy import Legacy, oc_period_data from flopy4.mf6.package import Package from flopy4.mf6.record import Record -from flopy4.mf6.spec import array, file, integer, list_, record, string, union +from flopy4.mf6.spec import Header, array, file, integer, list_, record, string, union @attrs.define(kw_only=True, slots=False) @@ -16,6 +16,10 @@ class Oc(Package): dfn_name: ClassVar[str] = "gwf-oc" ftype: ClassVar[str] = "OC6" + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + legacy_kwargs: ClassVar[dict[str, Legacy]] = { "saverecord": Legacy("stress_period_data", oc_period_data), "printrecord": Legacy("stress_period_data", oc_period_data), diff --git a/flopy4/mf6/gwf/rch.py b/flopy4/mf6/gwf/rch.py index 252df7cee..0dee0e948 100644 --- a/flopy4/mf6/gwf/rch.py +++ b/flopy4/mf6/gwf/rch.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Rch(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "rch": (("cellid",), ("string",)), } diff --git a/flopy4/mf6/gwf/rcha.py b/flopy4/mf6/gwf/rcha.py index 6e4cf1899..d563a4567 100644 --- a/flopy4/mf6/gwf/rcha.py +++ b/flopy4/mf6/gwf/rcha.py @@ -7,7 +7,7 @@ from flopy4.mf6._types import FloatArrayLike, IntArrayLike, TimeArraySeriesRef, to_array from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, keyword, string +from flopy4.mf6.spec import Header, array, child, keyword, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.tas import Tas @@ -19,6 +19,10 @@ class Rcha(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "rch": (("cellid",), ("string",)), } diff --git a/flopy4/mf6/gwf/riv.py b/flopy4/mf6/gwf/riv.py index 0332ec134..8b2a33e21 100644 --- a/flopy4/mf6/gwf/riv.py +++ b/flopy4/mf6/gwf/riv.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Riv(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "riv": (("cellid",), ("string",)), "to-mvr": (("cellid",), ("string",)), diff --git a/flopy4/mf6/gwf/rivg.py b/flopy4/mf6/gwf/rivg.py index a452a72e6..deb83d7c3 100644 --- a/flopy4/mf6/gwf/rivg.py +++ b/flopy4/mf6/gwf/rivg.py @@ -7,7 +7,7 @@ from flopy4.mf6._types import FloatArrayLike, to_array from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, integer, keyword, string +from flopy4.mf6.spec import Header, array, child, integer, keyword, string from flopy4.mf6.utl.obs import Obs @@ -18,6 +18,10 @@ class Rivg(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "riv": (("cellid",), ("string",)), "to-mvr": (("cellid",), ("string",)), diff --git a/flopy4/mf6/gwf/sfr.py b/flopy4/mf6/gwf/sfr.py index 4bd4df2df..8d558b8c7 100644 --- a/flopy4/mf6/gwf/sfr.py +++ b/flopy4/mf6/gwf/sfr.py @@ -11,6 +11,7 @@ from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package from flopy4.mf6.spec import ( + Header, array, cellid_, child, @@ -34,6 +35,10 @@ class Sfr(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "depth": (("index",), ("string",)), "downstream-flow": (("index",), ("string",)), diff --git a/flopy4/mf6/gwf/sto.py b/flopy4/mf6/gwf/sto.py index 3abde14d7..0c13b9289 100644 --- a/flopy4/mf6/gwf/sto.py +++ b/flopy4/mf6/gwf/sto.py @@ -1,13 +1,12 @@ # autogenerated file, do not modify -from typing import ClassVar, Optional +from typing import ClassVar, Literal, Optional import attrs from flopy4.mf6._types import FloatArrayLike, IntArrayLike -from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy, sto_period_data from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, keyword, list_, string +from flopy4.mf6.spec import Header, array, child, keyword, string from flopy4.mf6.utl.tvs import Tvs @@ -16,15 +15,15 @@ class Sto(Package): dfn_name: ClassVar[str] = "gwf-sto" ftype: ClassVar[str] = "STO6" + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + legacy_kwargs: ClassVar[dict[str, Legacy]] = { "steady_state": Legacy("stress_period_data", sto_period_data), "transient": Legacy("stress_period_data", sto_period_data), } - @attrs.define - class StressPeriodData(Item): - stress_period_data: str = string() - save_flows: bool = keyword( default=False, block="options", @@ -80,13 +79,9 @@ class StressPeriodData(Item): netcdf=True, longname="specific yield", ) # type: ignore[assignment] - _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( - alias="stress_period_data", + stress_period_data: Optional[dict[int, Literal["steady-state", "transient"]]] = string( default=None, - repr=False, block="period", fill_forward=True, + valid=("steady-state", "transient"), ) - - -StoStressPeriodData = Sto.StressPeriodData diff --git a/flopy4/mf6/gwf/uzf.py b/flopy4/mf6/gwf/uzf.py index d61ca5ec4..cde9d268c 100644 --- a/flopy4/mf6/gwf/uzf.py +++ b/flopy4/mf6/gwf/uzf.py @@ -10,7 +10,18 @@ from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, file, integer, keyword, list_, string +from flopy4.mf6.spec import ( + Header, + array, + cellid_, + child, + double, + file, + integer, + keyword, + list_, + string, +) from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -22,6 +33,10 @@ class Uzf(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "from-mvr": (("index",), ("string",)), "infiltration": (("index",), ("string",)), diff --git a/flopy4/mf6/gwf/wel.py b/flopy4/mf6/gwf/wel.py index 9a07f4f3d..7f547108e 100644 --- a/flopy4/mf6/gwf/wel.py +++ b/flopy4/mf6/gwf/wel.py @@ -9,7 +9,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, file, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, file, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -21,6 +21,10 @@ class Wel(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "to-mvr": (("cellid",), ("string",)), "wel": (("cellid",), ("string",)), diff --git a/flopy4/mf6/gwf/welg.py b/flopy4/mf6/gwf/welg.py index 5dd9ab3c8..8aa0d4e1c 100644 --- a/flopy4/mf6/gwf/welg.py +++ b/flopy4/mf6/gwf/welg.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import FloatArrayLike, to_array from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, double, file, integer, keyword, string +from flopy4.mf6.spec import Header, array, child, double, file, integer, keyword, string from flopy4.mf6.utl.obs import Obs @@ -19,6 +19,10 @@ class Welg(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "to-mvr": (("cellid",), ("string",)), "wel": (("cellid",), ("string",)), diff --git a/flopy4/mf6/gwt/cnc.py b/flopy4/mf6/gwt/cnc.py index 38cca99e0..9c5677aa3 100644 --- a/flopy4/mf6/gwt/cnc.py +++ b/flopy4/mf6/gwt/cnc.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Cnc(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "cnc": (("cellid",), ("string",)), } diff --git a/flopy4/mf6/gwt/lkt.py b/flopy4/mf6/gwt/lkt.py index 520bad9d9..b33ec1ac5 100644 --- a/flopy4/mf6/gwt/lkt.py +++ b/flopy4/mf6/gwt/lkt.py @@ -10,7 +10,18 @@ from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, double, file, integer, keyword, list_, string, union +from flopy4.mf6.spec import ( + Header, + array, + child, + double, + file, + integer, + keyword, + list_, + string, + union, +) from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -22,6 +33,10 @@ class Lkt(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "concentration": (("index",), ("string",)), "constant": (("index",), ("string",)), diff --git a/flopy4/mf6/gwt/mwt.py b/flopy4/mf6/gwt/mwt.py index b4315f5b8..6e0bb1876 100644 --- a/flopy4/mf6/gwt/mwt.py +++ b/flopy4/mf6/gwt/mwt.py @@ -10,7 +10,18 @@ from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, double, file, integer, keyword, list_, string, union +from flopy4.mf6.spec import ( + Header, + array, + child, + double, + file, + integer, + keyword, + list_, + string, + union, +) from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -22,6 +33,10 @@ class Mwt(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "concentration": (("index",), ("string",)), "constant": (("index",), ("string",)), diff --git a/flopy4/mf6/gwt/oc.py b/flopy4/mf6/gwt/oc.py index 59c06905e..c1d271884 100644 --- a/flopy4/mf6/gwt/oc.py +++ b/flopy4/mf6/gwt/oc.py @@ -8,7 +8,7 @@ from flopy4.mf6.legacy import Legacy, oc_period_data from flopy4.mf6.package import Package from flopy4.mf6.record import Record -from flopy4.mf6.spec import array, file, integer, list_, record, string, union +from flopy4.mf6.spec import Header, array, file, integer, list_, record, string, union @attrs.define(kw_only=True, slots=False) @@ -16,6 +16,10 @@ class Oc(Package): dfn_name: ClassVar[str] = "gwt-oc" ftype: ClassVar[str] = "OC6" + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + legacy_kwargs: ClassVar[dict[str, Legacy]] = { "saverecord": Legacy("stress_period_data", oc_period_data), "printrecord": Legacy("stress_period_data", oc_period_data), diff --git a/flopy4/mf6/gwt/sft.py b/flopy4/mf6/gwt/sft.py index 9defcb46d..c2ea1b97b 100644 --- a/flopy4/mf6/gwt/sft.py +++ b/flopy4/mf6/gwt/sft.py @@ -10,7 +10,18 @@ from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, double, file, integer, keyword, list_, string, union +from flopy4.mf6.spec import ( + Header, + array, + child, + double, + file, + integer, + keyword, + list_, + string, + union, +) from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -22,6 +33,10 @@ class Sft(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "concentration": (("index",), ("string",)), "constant": (("index",), ("string",)), diff --git a/flopy4/mf6/gwt/src.py b/flopy4/mf6/gwt/src.py index 70f781dbd..736e7f26b 100644 --- a/flopy4/mf6/gwt/src.py +++ b/flopy4/mf6/gwt/src.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Src(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "src": (("cellid",), ("string",)), "to-mvr": (("cellid",), ("string",)), diff --git a/flopy4/mf6/gwt/uzt.py b/flopy4/mf6/gwt/uzt.py index 0d716ae94..befb1be95 100644 --- a/flopy4/mf6/gwt/uzt.py +++ b/flopy4/mf6/gwt/uzt.py @@ -10,7 +10,18 @@ from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, double, file, integer, keyword, list_, string, union +from flopy4.mf6.spec import ( + Header, + array, + child, + double, + file, + integer, + keyword, + list_, + string, + union, +) from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -22,6 +33,10 @@ class Uzt(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "concentration": (("index",), ("string",)), "constant": (("index",), ("string",)), diff --git a/flopy4/mf6/legacy.py b/flopy4/mf6/legacy.py index b4a34d4cc..b65636e75 100644 --- a/flopy4/mf6/legacy.py +++ b/flopy4/mf6/legacy.py @@ -106,7 +106,7 @@ def _periods(value: Any) -> dict[int, Any]: return dict(value) if isinstance(value, Mapping) else {0: value} -def sto_period_data(steady_state: Any = None, transient: Any = None) -> dict[int, list]: +def sto_period_data(steady_state: Any = None, transient: Any = None) -> dict[int, str]: """STO's `stress_period_data` from flopy3's `steady_state` and `transient`. Each is `{kper: True}`, `True` (period 0), or a list of periods. A period can't be both.""" @@ -120,12 +120,12 @@ def periods(value: Any) -> list[int]: return [kper for kper, on in value.items() if on] return list(value) - data: dict[int, list] = {} - for word, value in (("STEADY-STATE", steady_state), ("TRANSIENT", transient)): + data: dict[int, str] = {} + for word, value in (("steady-state", steady_state), ("transient", transient)): for kper in periods(value): if kper in data: raise ValueError(f"period {kper} is both steady-state and transient") - data[kper] = [(word,)] + data[kper] = word return dict(sorted(data.items())) diff --git a/flopy4/mf6/olf/cdb.py b/flopy4/mf6/olf/cdb.py index 5cb48dfea..559cedec5 100644 --- a/flopy4/mf6/olf/cdb.py +++ b/flopy4/mf6/olf/cdb.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, integer, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, integer, keyword, list_, string from flopy4.mf6.utl.obs import Obs @@ -19,6 +19,10 @@ class Cdb(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "cdb": (("cellid",), ("string",)), "to-mvr": (("cellid",), ("string",)), diff --git a/flopy4/mf6/olf/chd.py b/flopy4/mf6/olf/chd.py index a6ffe258d..7c23f5c9c 100644 --- a/flopy4/mf6/olf/chd.py +++ b/flopy4/mf6/olf/chd.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Chd(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "chd": (("cellid",), ("string",)), } diff --git a/flopy4/mf6/olf/evp.py b/flopy4/mf6/olf/evp.py index dd773af97..a99b84220 100644 --- a/flopy4/mf6/olf/evp.py +++ b/flopy4/mf6/olf/evp.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Evp(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "evp": (("cellid",), ("string",)), } diff --git a/flopy4/mf6/olf/flw.py b/flopy4/mf6/olf/flw.py index 5799319ca..3b7e2ee92 100644 --- a/flopy4/mf6/olf/flw.py +++ b/flopy4/mf6/olf/flw.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Flw(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "flw": (("cellid",), ("string",)), "to-mvr": (("cellid",), ("string",)), diff --git a/flopy4/mf6/olf/oc.py b/flopy4/mf6/olf/oc.py index 3656fb31a..75e94a594 100644 --- a/flopy4/mf6/olf/oc.py +++ b/flopy4/mf6/olf/oc.py @@ -8,7 +8,7 @@ from flopy4.mf6.legacy import Legacy, oc_period_data from flopy4.mf6.package import Package from flopy4.mf6.record import Record -from flopy4.mf6.spec import array, file, integer, list_, record, string, union +from flopy4.mf6.spec import Header, array, file, integer, list_, record, string, union @attrs.define(kw_only=True, slots=False) @@ -16,6 +16,10 @@ class Oc(Package): dfn_name: ClassVar[str] = "olf-oc" ftype: ClassVar[str] = "OC6" + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + legacy_kwargs: ClassVar[dict[str, Legacy]] = { "saverecord": Legacy("stress_period_data", oc_period_data), "printrecord": Legacy("stress_period_data", oc_period_data), diff --git a/flopy4/mf6/olf/pcp.py b/flopy4/mf6/olf/pcp.py index 46ac18029..4553b055a 100644 --- a/flopy4/mf6/olf/pcp.py +++ b/flopy4/mf6/olf/pcp.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Pcp(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "pcp": (("cellid",), ("string",)), } diff --git a/flopy4/mf6/olf/sto.py b/flopy4/mf6/olf/sto.py index 79723ee05..67e1bbff9 100644 --- a/flopy4/mf6/olf/sto.py +++ b/flopy4/mf6/olf/sto.py @@ -1,12 +1,11 @@ # autogenerated file, do not modify -from typing import ClassVar, Optional +from typing import ClassVar, Literal, Optional import attrs -from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy, sto_period_data from flopy4.mf6.package import Package -from flopy4.mf6.spec import keyword, list_, string +from flopy4.mf6.spec import Header, keyword, string @attrs.define(kw_only=True, slots=False) @@ -14,15 +13,15 @@ class Sto(Package): dfn_name: ClassVar[str] = "olf-sto" ftype: ClassVar[str] = "STO6" + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + legacy_kwargs: ClassVar[dict[str, Legacy]] = { "steady_state": Legacy("stress_period_data", sto_period_data), "transient": Legacy("stress_period_data", sto_period_data), } - @attrs.define - class StressPeriodData(Item): - stress_period_data: str = string() - save_flows: bool = keyword( default=False, block="options", @@ -35,13 +34,9 @@ class StressPeriodData(Item): optional=True, longname="export array variables to layered ascii files.", ) - _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( - alias="stress_period_data", + stress_period_data: Optional[dict[int, Literal["steady-state", "transient"]]] = string( default=None, - repr=False, block="period", fill_forward=True, + valid=("steady-state", "transient"), ) - - -StoStressPeriodData = Sto.StressPeriodData diff --git a/flopy4/mf6/olf/zdg.py b/flopy4/mf6/olf/zdg.py index ec6009678..8708ca736 100644 --- a/flopy4/mf6/olf/zdg.py +++ b/flopy4/mf6/olf/zdg.py @@ -8,7 +8,7 @@ from flopy4.mf6._types import TimeSeriesRef, to_array from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, child, double, integer, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, child, double, integer, keyword, list_, string from flopy4.mf6.utl.obs import Obs from flopy4.mf6.utl.ts import Ts @@ -20,6 +20,10 @@ class Zdg(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { "to-mvr": (("cellid",), ("string",)), "zdg": (("cellid",), ("string",)), diff --git a/flopy4/mf6/prt/oc.py b/flopy4/mf6/prt/oc.py index fa409f644..62b4ab13c 100644 --- a/flopy4/mf6/prt/oc.py +++ b/flopy4/mf6/prt/oc.py @@ -7,7 +7,7 @@ from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy, oc_period_data from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, double, file, integer, keyword, list_, string, union +from flopy4.mf6.spec import Header, array, double, file, integer, keyword, list_, string, union @attrs.define(kw_only=True, slots=False) @@ -15,6 +15,10 @@ class Oc(Package): dfn_name: ClassVar[str] = "prt-oc" ftype: ClassVar[str] = "OC6" + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + legacy_kwargs: ClassVar[dict[str, Legacy]] = { "saverecord": Legacy("stress_period_data", oc_period_data), "printrecord": Legacy("stress_period_data", oc_period_data), diff --git a/flopy4/mf6/prt/prp.py b/flopy4/mf6/prt/prp.py index 9fc6a0d5a..94871ac64 100644 --- a/flopy4/mf6/prt/prp.py +++ b/flopy4/mf6/prt/prp.py @@ -7,7 +7,7 @@ from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, cellid_, double, file, integer, keyword, list_, string +from flopy4.mf6.spec import Header, array, cellid_, double, file, integer, keyword, list_, string @attrs.define(kw_only=True, slots=False) @@ -17,6 +17,10 @@ class Prp(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + legacy_kwargs: ClassVar[dict[str, Legacy]] = { "perioddata": Legacy("stress_period_data"), } diff --git a/flopy4/mf6/simulation.py b/flopy4/mf6/simulation.py index 217e7a359..390c1d3dd 100644 --- a/flopy4/mf6/simulation.py +++ b/flopy4/mf6/simulation.py @@ -8,7 +8,7 @@ from flopy4.mf6.model import Model from flopy4.mf6.simulation_methods import SimulationMethods from flopy4.mf6.solution import Solution -from flopy4.mf6.spec import child, integer, keyword, string +from flopy4.mf6.spec import Header, child, integer, keyword, string from flopy4.mf6.tdis import Tdis from flopy4.mf6.utl.hpc import Hpc @@ -17,6 +17,10 @@ class Simulation(SimulationMethods, WorkspaceComponent): dfn_name: ClassVar[str] = "sim-nam" + headers: ClassVar[dict[str, Header]] = { + "solutiongroup": Header("integer"), + } + continue_: bool = keyword( default=False, block="options", diff --git a/flopy4/mf6/spec.py b/flopy4/mf6/spec.py index 776d7c5ec..64bfda15f 100644 --- a/flopy4/mf6/spec.py +++ b/flopy4/mf6/spec.py @@ -5,9 +5,21 @@ import builtins import types +from collections.abc import Mapping from datetime import datetime +from functools import cache, cached_property from pathlib import Path -from typing import Any, Literal, TypedDict, Union, Unpack, get_args, get_origin +from typing import ( + TYPE_CHECKING, + Any, + Literal, + NamedTuple, + TypedDict, + Union, + Unpack, + get_args, + get_origin, +) import attrs import numpy as np @@ -25,6 +37,9 @@ from flopy4.mf6.item import to_union_arm from flopy4.spec import fields_dict as flopy_fields_dict +if TYPE_CHECKING: + from modflow_devtools.dfns.schema import Component, InputField + FieldType = Literal["keyword", "integer", "double", "string", "list", "record"] # As in the DFN schema. An index is 1-based in the file, 0-based in memory; @@ -166,6 +181,21 @@ def _ts_converter(kwargs: FieldKwargs, converter) -> None: kwargs.setdefault("converter", converter) +def _to_valid(valid: tuple[str, ...]): + """A converter spelling a string as the one of ``valid`` it matches + ignoring case (MF6 reads words so), and each of a per-period dict's.""" + spelled = {v.lower(): v for v in valid} + + def convert(value): + if isinstance(value, str): + return spelled.get(value.lower(), value) + if isinstance(value, dict): + return {k: convert(v) for k, v in value.items()} + return value + + return convert + + def keyword(**kwargs: Unpack[FieldKwargs]) -> Any: """A keyword: a flag, present or not.""" kwargs["tagged"] = True @@ -180,6 +210,8 @@ def string( scope: str | None = None, rule: str | None = None, empty_is_none: bool = False, + fill_forward: bool = False, + valid: tuple[str, ...] = (), **kwargs: Unpack[FieldKwargs], ) -> Any: """A string. A time series one may name a time series instead. It can't @@ -188,13 +220,28 @@ def string( only within the value of another column, its ``scope`` (MVR's ``pname`` within ``mname``). An fk may have a ``rule``, which picks the component it names in, or with a scope narrows its keys (MVR's - ``pname``, packages with ``mover`` on); see `flopy4.mf6.keys`.""" + ``pname``, packages with ``mover`` on); see `flopy4.mf6.keys`. + A ``fill_forward`` one is given per period (STO's steady-state or + transient), a period without one keeping the last's. One of ``valid`` + is kept as ``valid`` spells it, whatever its case.""" + if valid: + _convert_first(kwargs, _to_valid(valid)) if time_series: _ts_converter(kwargs, to_ts_value) if empty_is_none: _convert_first(kwargs, _empty_to_none) _validate(kwargs, _not_empty) - return _field("string", kwargs, time_series=time_series, pk=pk, fk=fk, scope=scope, rule=rule) + return _field( + "string", + kwargs, + time_series=time_series, + pk=pk, + fk=fk, + scope=scope, + rule=rule, + fill_forward=fill_forward, + valid=valid, + ) def integer( @@ -549,24 +596,22 @@ def fields_dict(cls) -> dict[str, Attribute]: return {k: v for k, v in fields.items() if "block" in v.metadata} -def repeating_array_key_type(field_type) -> type | None: - """For ``Optional[dict[K, IntArrayLike | FloatArrayLike]]``, return - ``K`` -- the header type of a block that repeats (e.g. utl-tas's "time" - block), whose own array field is keyed by header value. Returns - ``None`` for anything else, including a plain array and an - ``Optional[dict[int, list[ItemClass]]]`` period Item-list (see - ``item.item_list_type``) -- structurally distinct shapes, detected from - the annotation itself rather than a metadata flag, the same way - ``item_list_type`` reads its own dict-wrapped shape. Period array - fields (RCHA's recharge) have this shape too, keyed by period; callers - tell them apart by their ``fill_forward`` metadata. - """ - args = get_args(field_type) - inner = next((a for a in args if a is not type(None)), None) - if inner is None or get_origin(inner) is not dict: - return None - key, val = get_args(inner) - return key if val in (IntArrayLike, FloatArrayLike) else None +@cache +def binding_fields(cls) -> dict[str, list[tuple[Attribute, str, tuple[type, ...]]]]: + """The child fields named by a block's rows (a model's packages, the + simulation's models, exchanges and solutions), by block, in field + order, each with its kind and candidate classes (see + `child_field_candidates`). A file record's child (``NCF6 FILEIN + ``) loads with its record, so isn't one.""" + from flopy4.attrs_xarray import child_field_candidates + + out: dict[str, list] = {} + for f in attrs.fields(cls): + if not f.metadata.get("child") or "block" not in f.metadata or f.metadata.get("_keyword"): + continue + if (spec := child_field_candidates(f)) is not None: + out.setdefault(f.metadata["block"], []).append((f, *spec)) + return out def to_field_type(t: type) -> FieldType: @@ -633,3 +678,228 @@ def block_sort_key(item) -> int: return 4 else: return 3 + + +# The DFNs the classes were generated from, which sync stores beside them +# (flopy4/mf6/dfns), one TOML file each. The converter reads block structure +# from these rather than from the classes. Each is loaded when first asked +# for, not the whole set: devtools' `Dfns.load` parses every file and checks +# the relations between them, which costs a fresh process ~0.15 s on its +# first load. The relations were checked when the set was synced (and are +# again in the tests), so they aren't checked here. + + +def _stored_dfns() -> Path: + from flopy4.mf6._sync import _DFNS + + stored = Path(__file__).parent / _DFNS + if not stored.is_dir(): + raise FileNotFoundError( + f"flopy4.mf6 has no stored DFNs ({stored}). Run `flopy4 mf6 sync` to re-sync." + ) + return stored + + +@cache +def _component_adapter(): + import warnings + + from pydantic import TypeAdapter + + with warnings.catch_warnings(): + warnings.filterwarnings("ignore", message=".*modflow_devtools.dfns.*experimental.*") + from modflow_devtools.dfns.schema import Component + + return TypeAdapter(Component) + + +@cache +def _load_dfn(name: str) -> "Component": + import tomli + from modflow_devtools.dfns.schema import _inject_names + + from flopy4.mf6._sync import _DFN_SCHEMA_VERSION + + with (_stored_dfns() / f"{name}.toml").open("rb") as f: + data = tomli.load(f) + _inject_names(data) # as `Dfns.load` does + component = _component_adapter().validate_python(data) + if component.schema_version not in (None, _DFN_SCHEMA_VERSION): + raise ValueError( + f"stored DFN {name!r} has schema version {component.schema_version}, " + f"expected {_DFN_SCHEMA_VERSION}. Run `flopy4 mf6 sync` to re-sync." + ) + return component + + +class Header(NamedTuple): + """A repeating block's header kind, as codegen records it in a + component class's ``headers``: ``integer`` (a period's IPER, + SOLUTIONGROUP's number), ``double`` (a TAS time) or ``record`` (OBS's + ``FILEOUT ``), and whether an integer is an index, 1-based in the + file and 0-based in memory (IPER is, the DFN's ``index``).""" + + kind: str + index: bool = False # type: ignore[assignment] + + +class DfnHeader(NamedTuple): + """A stored DFN's top-level keys: all codegen reads of the components + a link may target (see ``make._headers``), without loading them.""" + + name: str + type: str + subtype: str | None + parent: str | list[str] | None + ftype: str | None + multi: bool + + +def _read_header(path: Path) -> DfnHeader: + import tomli + + # sync writes a DFN's top-level keys before its first table + lines = [] + with path.open() as f: + for line in f: + if line.startswith("["): + break + lines.append(line) + data = tomli.loads("".join(lines)) + return DfnHeader( + data["name"], + data["type"], + data.get("subtype"), + data.get("parent"), + data.get("ftype"), + data.get("multi", False), + ) + + +class _StoredDfns(Mapping[str, "Component"]): + """The stored DFNs by name, each loaded on first access. `headers` + has every DFN's top-level keys, for scans that only need those.""" + + def __init__(self) -> None: + # as `Dfns.load` skips them + exclude = {"common", "flopy"} + self._names = sorted(p.stem for p in _stored_dfns().glob("*.toml") if p.stem not in exclude) + + @cached_property + def headers(self) -> dict[str, DfnHeader]: + stored = _stored_dfns() + return {n: _read_header(stored / f"{n}.toml") for n in self._names} + + def __getitem__(self, name: str) -> "Component": + if name not in self._names: + raise KeyError(name) + return _load_dfn(name) + + def __contains__(self, name: object) -> bool: + return name in self._names + + def __iter__(self): + return iter(self._names) + + def __len__(self) -> int: + return len(self._names) + + +@cache +def _dfns() -> "Mapping[str, Component]": + return _StoredDfns() + + +def dfn(cls) -> "Component": + """The DFN component ``cls`` was generated from, by its ``dfn_name``.""" + return _dfns()[cls.dfn_name] + + +@cache +def attr_names(cls) -> dict[tuple[str, str], str]: + """The attribute of ``cls`` holding each of its DFN's fields, by + (block, field name), as codegen named it (see + ``flopy4.mf6.utils.codegen.make.attr_names``).""" + from flopy4.mf6.utils.codegen.make import attr_names as _attr_names + + return _attr_names(dfn(cls), _dfns()) + + +@attrs.frozen +class BlockKeys: + """How the rows of one of a DFN's blocks find their fields. + + Attributes + ---------- + tagged : + Fields by the keyword their rows begin with, in DFN order. Where a + keyword begins more than one field's rows (OC's ``HEAD``), the next + keyword tells them apart (see ``following_tags``). + dynamic : + Fields whose rows begin with a value of another field instead, by + that field's path: RCHA's ``aux``, by ``options.auxiliary``. + untagged : + The field the block's other rows belong to, if any. + """ + + tagged: dict[str, tuple["InputField", ...]] + dynamic: dict[str, "InputField"] + untagged: "InputField | None" + + +def _dynamic_key(f: "InputField") -> str | None: + """The path of the field whose values begin ``f``'s rows, if they do.""" + from modflow_devtools.dfns.schema import List, Record, _is_dynamic_key + + record = f.item if isinstance(f, List) else f + if not isinstance(record, Record): + return None + first = next(iter(record.fields.values()), None) + return first.fk.path if first is not None and _is_dynamic_key(first) else None + + +def leading_tags(f: "InputField") -> list[str]: + """The keywords ``f``'s rows can begin with.""" + from modflow_devtools.dfns.schema import _leading_tags + + return [t.lower() for t in _leading_tags(f)] + + +def following_tags(f: "InputField") -> list[str]: + """The keywords that can follow the one ``f``'s rows begin with, if + ``f`` is a record whose second member is a keyword, or a file with its + direction's (OC's ``HEAD FILEOUT`` and ``HEAD PRINT_FORMAT``).""" + from modflow_devtools.dfns.schema import File, Keyword, Record + + if not isinstance(f, Record): + return [] + members = list(f.fields.values()) + if len(members) < 2: + return [] + second = members[1] + if isinstance(second, Keyword): + return [t.lower() for t in [second.name, *second.aliases]] + if isinstance(second, File) and second.mode_keyword and second.direction: + return [f"file{second.direction}"] + return [] + + +@cache +def block_keys(cls, block: str) -> BlockKeys: + """How the rows of ``block`` in ``cls``'s DFN find their fields. Fields + codegen leaves out (developmode, removed) aren't keyed.""" + from flopy4.mf6.utils.codegen.filters import flat_fields + + tagged: dict[str, tuple] = {} + dynamic: dict[str, Any] = {} + untagged = None + for name, f in flat_fields(dfn(cls)): + if name != block: + continue + if not getattr(f, "tagged", True): + untagged = f + elif key := _dynamic_key(f): + dynamic[key] = f + for tag in leading_tags(f): + tagged[tag] = (*tagged.get(tag, ()), f) + return BlockKeys(tagged=tagged, dynamic=dynamic, untagged=untagged) diff --git a/flopy4/mf6/utils/codegen/filters.py b/flopy4/mf6/utils/codegen/filters.py index 5c4c7f7d0..0f01efe00 100644 --- a/flopy4/mf6/utils/codegen/filters.py +++ b/flopy4/mf6/utils/codegen/filters.py @@ -129,6 +129,20 @@ def output_path(dfn_name: str, root: Path) -> Path: # Component/Block-level helpers +def headers(component: Component) -> dict[str, str]: + """The component's repeating blocks' headers, by block name, each as + the ``Header`` codegen writes for it: its field's type, and for an + integer whether the DFN marks it an index (a period's IPER).""" + out = {} + for name, block in (component.blocks or {}).items(): + if block.header is None: + continue + field = block.header.field + index = field.type == "integer" and bool(getattr(field, "index", False)) + out[name] = f'Header("{field.type}"{", index=True" if index else ""})' + return out + + def fill_forward_blocks(component: Component) -> frozenset[str]: """Names of the component's repeating blocks whose header fills forward (a missing occurrence reuses the prior one's values) -- ``period``, per diff --git a/flopy4/mf6/utils/codegen/make.py b/flopy4/mf6/utils/codegen/make.py index 7fbb63050..e1f42d711 100644 --- a/flopy4/mf6/utils/codegen/make.py +++ b/flopy4/mf6/utils/codegen/make.py @@ -186,6 +186,8 @@ class ComponentSpec: # Dims counting item columns that aren't fields, name -> DFN expression # Observation types the component's OBS file takes, name -> id forms observations: dict[str, tuple[tuple[str, ...], ...]] = dc_field(default_factory=dict) + # The repeating blocks' headers, block name -> Header(...) source + headers: dict[str, str] = dc_field(default_factory=dict) has_griddata: bool = False has_readarray_period: bool = False # A model subpackage's __all__: the model and its packages @@ -196,6 +198,9 @@ class ComponentSpec: key_sets: dict[str, str | tuple[str, ...]] = dc_field(default_factory=dict) # role -> the keyword option switching it on, if any key_set_when: dict[str, str] = dc_field(default_factory=dict) + # The class attribute holding each DFN field, by (block, field name): see + # attr_names + attr_names: dict[tuple[str, str], str] = dc_field(default_factory=dict) # Column-schema-dict builders @@ -1126,6 +1131,14 @@ def _is_child_of(child: Component, parent: Component) -> bool: return admits(child.parent, parent) +def _headers(dfns: Mapping[str, Component]) -> Mapping[str, Any]: + """The DFNs for reading only a link target's top-level keys (type, + subtype, parent, ftype, multi). A mapping that loads each DFN when + first asked for (`flopy4.mf6.spec`'s) has them as ``headers``, so + resolving a link doesn't load every component it might target.""" + return getattr(dfns, "headers", dfns) + + def resolve_link( component: Component, path: str, @@ -1147,7 +1160,7 @@ def resolve_link( raise ValueError(f"{component.name}.{path}: resolving {sel!r} needs the DFNs") found += [ n - for n, c in dfns.items() + for n, c in _headers(dfns).items() if sel in (c.type, getattr(c, "subtype", None)) and _is_child_of(c, component) ] if not found: @@ -1164,7 +1177,7 @@ def _has_class(target: str, link: File, dfns: Mapping[str, Component] | None) -> """Whether flopy4 has a class for a link's target: a hand-written base for a family picked per row, otherwise a generated module.""" if link.component_ftype is not None: - c = dfns[target] if dfns is not None else None + c = _headers(dfns)[target] if dfns is not None else None return c is not None and bool({c.type, getattr(c, "subtype", None)} & set(_CHILD_BASES)) return _has_module(target) @@ -1284,7 +1297,7 @@ def _child_field_spec( if not filters.is_list_field(f): raise ValueError(f"{component.name}.{f.name}: component_ftype outside a list") assert dfns is not None # resolve_link needed them - bases = {_child_base(dfns[t]) for t in targets} + bases = {_child_base(_headers(dfns)[t]) for t in targets} if len(bases) != 1: raise NotImplementedError(f"{component.name}.{f.name}: children of {sorted(bases)}") module, base = bases.pop().split(":") @@ -1487,6 +1500,7 @@ def _model_package_specs( once (``multi``) is a list. Packages without a generated class are left out until they have one. The discretization comes first. Each field's binding rows have the packages block's columns, ``row``.""" + headers = _headers(dfns) slots: dict[str, list[str]] = {} for t in targets: if not _has_module(t): @@ -1495,7 +1509,7 @@ def _model_package_specs( # types reads an OBS6 file (PRT has none yet) if t == "utl-obs" and not component.observations: continue - ftype = dfns[t].ftype + ftype = headers[t].ftype if ftype is None: raise ValueError(f"{component.name}: package {t} has no ftype") name = _SLOTS.get(ftype, ftype.lower().removesuffix("6")) @@ -1505,13 +1519,13 @@ def _model_package_specs( slots = {**{g: slots.pop(g) for g in grid_names}, **slots} specs, imports = [], [] for name, members in slots.items(): - if len({bool(dfns[t].multi) for t in members}) > 1: + if len({bool(headers[t].multi) for t in members}) > 1: raise ValueError(f"{component.name}.{name}: {members} disagree on multi") classes = [filters.class_name(t) for t in members] imports += [f"from {_component_module(t)} import {c}" for t, c in zip(members, classes)] cls = classes[0] if len(classes) == 1 else f"Union[{', '.join(classes)}]" args = f'block="{block_name}", row={filters.tuple_repr(row)}' - if dfns[members[0]].multi: + if headers[members[0]].multi: annotation, call = f"list[{cls}]", f"child({args}, default=attrs.Factory(list))" else: annotation, call = f"Optional[{cls}]", f"child({args})" @@ -1648,6 +1662,8 @@ def build_component_spec( _readarray_period_fields: list[FieldV3] = [] # READARRAY period fields (CHDG, DRNG …) _dynamically_named_period_fields: list[tuple] = [] # (list, array, fk): RCHA's aux _repeating_array_fields: list[FieldV3] = [] # repeating block's own array field + # (block, DFN field) -> the attribute holding it; see attr_names + _attr_names: dict[tuple[str, str], str] = {} # Lists' file columns naming components, by list (LAK's tables). _column_links = { @@ -1682,6 +1698,7 @@ def _add_list_items(lf: ListField, class_name: str) -> str: component, f, block_name, link, targets, dfns ) specs = [spec] + _attr_names[(block_name, f.name)] = spec.py_name (prefix_specs if block_name in ("options", "dimensions") else data_specs).extend(specs) extra_imports.extend(child_imports) continue @@ -1696,6 +1713,7 @@ def _add_list_items(lf: ListField, class_name: str) -> str: if block_name in _fill_forward_blocks and filters.is_list_field(f): _period_item = _add_list_items(f, "StressPeriodData") + _attr_names[(block_name, f.name)] = "_stress_period_data" continue # G-variant packages (CHDG, DRNG, WELG, RCHA …) declare period arrays @@ -1704,26 +1722,36 @@ def _add_list_items(lf: ListField, class_name: str) -> str: _readarray_period_fields.append(f) continue - # STO-family (chf/gwf/olf-sto): a bare scalar directly in the period - # block ("storage", valid=["steady-state","transient"]) -- not a List, - # but still needs the same per-period, fill-forward dict[int, ...] - # treatment as any other period field (the whole point of a period - # block is that its contents can differ/repeat across BEGIN PERIOD - # blocks). One column, since there's nothing else in the block. + # STO-family (chf/gwf/olf-sto): one string per period, directly in + # the period block (the DFN's stress_period_data, valid steady-state + # or transient), as a value per period, filled forward. if block_name in _fill_forward_blocks and filters.is_scalar(f): - item_classes.append( - ItemClassSpec( - class_name="StressPeriodData", - keyword="", - schema=[filters.attr_column(f.name, "str", "string", {}, optional=False)], + valid = tuple(getattr(f, "valid", None) or ()) + words = ", ".join(repr(v) for v in valid) + period_specs.append( + FieldSpec( + dfn_name=f.name, + py_name="stress_period_data", + type_annotation=( + f"Optional[dict[int, Literal[{words}]]]" + if words + else "Optional[dict[int, str]]" + ), + spec_call=_ml_field( + "string", + metadata={"block": block_name, "fill_forward": True, "valid": valid}, + ), + generatable=True, ) ) - _period_item = "StressPeriodData" + generatable_field_objects.append((block_name, f)) + _attr_names[(block_name, f.name)] = period_specs[-1].py_name continue # maxbound: emitted as a computed property (see computed_field_specs # below), not a stored field -- skip normal field-building entirely. if block_name == "dimensions" and f.name == "maxbound" and _maxbound_is_computed: + _attr_names[(block_name, f.name)] = "maxbound" continue # Array field whose own block repeats (e.g. utl-tas's "time" block, @@ -1754,6 +1782,7 @@ def _add_list_items(lf: ListField, class_name: str) -> str: ) ) generatable_field_objects.append((block_name, f)) + _attr_names[(block_name, f.name)] = data_specs[-1].py_name continue if block_name in ("options", "dimensions"): @@ -1779,6 +1808,7 @@ def _add_list_items(lf: ListField, class_name: str) -> str: ) ) generatable_field_objects.append((block_name, f)) + _attr_names[(block_name, f.name)] = target[-1].py_name continue if filters.can_generate_record_class(f): @@ -1802,15 +1832,19 @@ def _add_list_items(lf: ListField, class_name: str) -> str: ) ) generatable_field_objects.append((block_name, f)) + _attr_names[(block_name, f.name)] = clean_name elif filters.can_expand_record(f): + # a record spread over its members' own attributes specs, gen_fields = _expand_record_field(f, block_name) target.extend(specs) generatable_field_objects.extend((block_name, gf) for gf in gen_fields) + _attr_names |= {(block_name, s.dfn_name): s.py_name for s in specs if s.generatable} else: spec = _build_field_spec(f, block_name, _linked_dims) target.append(spec) if spec.generatable: generatable_field_objects.append((block_name, f)) + _attr_names[(block_name, f.name)] = spec.py_name # Rendered before the other blocks' element classes. block_item_classes: list[ItemClassSpec] = [] @@ -1832,6 +1866,7 @@ def _add_list_items(lf: ListField, class_name: str) -> str: block_item_classes.extend(_specs) if _union is not None: item_unions.append(_union) + _attr_names[(bp.block_name, _list_field.name)] = bp.block_name _meta: dict = {"block": bp.block_name} _header = component.blocks[bp.block_name].header if _header is not None and isinstance(_header.field, Record): @@ -1933,6 +1968,7 @@ def _add_list_items(lf: ListField, class_name: str) -> str: # period array separately, keyed by the 0-based periods it's given in # (see flopy4.mf6.period_arrays). if _readarray_period_fields: + assert _ff_block is not None # they're its fields # a grid package's period can be cleared, None (see period_arrays) _grid = any(f.name == "readarraygrid" for _, f in all_fields) for _ra_f in _readarray_period_fields: @@ -1957,6 +1993,7 @@ def _add_list_items(lf: ListField, class_name: str) -> str: extra_imports.append("from flopy4.mf6._types import TimeArraySeriesRef") if _grid: _ra_base += " | None" + _attr_names[(_ff_block, _ra_f.name)] = filters.safe_name(_ra_f.name) period_specs.append( FieldSpec( dfn_name=_ra_f.name, @@ -1971,6 +2008,7 @@ def _add_list_items(lf: ListField, class_name: str) -> str: # period, then by the auxiliary names (the fk), each array like a READARRAY # period field's. for _lf, _arr, _fk in _dynamically_named_period_fields: + assert _ff_block is not None # they're its fields _na_meta: dict = {"block": _ff_block} if shape := getattr(_arr, "shape", None): _na_meta["shape"] = tuple(shape) @@ -1984,6 +2022,7 @@ def _add_list_items(lf: ListField, class_name: str) -> str: _na_meta["time_series"] = True _na_base += " | TimeArraySeriesRef" extra_imports.append("from flopy4.mf6._types import TimeArraySeriesRef") + _attr_names[(_ff_block, _lf.name)] = filters.safe_name(_lf.name) period_specs.append( FieldSpec( dfn_name=_lf.name, @@ -2042,12 +2081,16 @@ def _block_index(fs: FieldSpec) -> int: ) legacy_kwargs = _legacy_kwargs(component) if legacy_kwargs: - if _period_item is None: - raise ValueError(f"{component.name}: legacy period keywords, but no period list") + # a period list, or STO's word per period + if not {"_stress_period_data", "stress_period_data"} & set(_attr_names.values()): + raise ValueError(f"{component.name}: legacy period keywords, but no period data") extra_imports.extend( f"from flopy4.mf6.legacy import {convert or 'Legacy'}" for convert in {None, *(c for _, c in _LEGACY_PERIOD_KWARGS[component.name])} ) + _headers = filters.headers(component) + if _headers: + _spec_functions.add("Header") imports = _generated_imports( generatable_field_objects, base_class=base, @@ -2070,7 +2113,8 @@ def _block_index(fs: FieldSpec) -> int: fs.spec_call.startswith("child(") and "Union[" in fs.type_annotation for fs in field_specs ), - has_literal=any(u.words for u in item_unions), + has_literal=any(u.words for u in item_unions) + or any("Literal[" in fs.type_annotation for fs in field_specs), extra_imports=[ *extra_imports, *(["from flopy4.mf6.block import Block"] if block_classes else []), @@ -2115,6 +2159,7 @@ def _block_index(fs: FieldSpec) -> int: computed_fields=computed_field_specs, derived_dims=_derived_dims, shared_dims=shared_dims, + headers=_headers, observations={ name: tuple(_obs_forms(f)) for name, f in sorted((component.observations or {}).items()) }, @@ -2126,9 +2171,22 @@ def _block_index(fs: FieldSpec) -> int: key_set_when={ role: ks.when for role, ks in sorted((component.keys or {}).items()) if ks.when }, + attr_names={k: v for k, v in _attr_names.items() if v in _seen_py_names or v == "maxbound"}, ) +def attr_names( + component: Component, dfns: Mapping[str, Component] | None = None +) -> dict[tuple[str, str], str]: + """The class attribute holding each of ``component``'s DFN fields, by + (block, field name): the name codegen gives it. A record spread over + its members' attributes maps its members, not itself; a period block's + list maps to ``_stress_period_data``. A model name file's package list + has no one attribute (each package type gets its own), so it isn't + mapped.""" + return build_component_spec(component, root=Path("."), dfns=dfns).attr_names + + # Template environment _TEMPLATE_NAME = "package.py.jinja" diff --git a/flopy4/mf6/utils/codegen/templates/package.py.jinja b/flopy4/mf6/utils/codegen/templates/package.py.jinja index ad208af66..1f33edbe0 100644 --- a/flopy4/mf6/utils/codegen/templates/package.py.jinja +++ b/flopy4/mf6/utils/codegen/templates/package.py.jinja @@ -36,6 +36,14 @@ class {{ spec.class_name }}({% for m in spec.mixins %}{{ m }}, {% endfor %}{{ sp {% if spec.shared_dims %} shared_dims: ClassVar[tuple[str, ...]] = {{ spec.shared_dims | tuple_repr }} +{% endif %} +{% if spec.headers %} + headers: ClassVar[dict[str, Header]] = { +{% for name, header in spec.headers.items() %} + "{{ name }}": {{ header }}, +{% endfor %} + } + {% endif %} {% if spec.observations %} observations: ClassVar[dict[str, tuple[tuple[str, ...], ...]]] = { diff --git a/flopy4/mf6/utl/obs.py b/flopy4/mf6/utl/obs.py index 1d056fc83..e538006af 100644 --- a/flopy4/mf6/utl/obs.py +++ b/flopy4/mf6/utl/obs.py @@ -7,7 +7,7 @@ from flopy4.mf6.block import Block from flopy4.mf6.item import Item from flopy4.mf6.package import Package -from flopy4.mf6.spec import file, integer, keyword, list_, string, union +from flopy4.mf6.spec import Header, file, integer, keyword, list_, string, union @attrs.define(kw_only=True, slots=False) @@ -15,6 +15,10 @@ class Obs(Package): dfn_name: ClassVar[str] = "utl-obs" ftype: ClassVar[str] = "OBS6" + headers: ClassVar[dict[str, Header]] = { + "continuous": Header("record"), + } + @attrs.define class Continuous(Item): obsname: str = string() diff --git a/flopy4/mf6/utl/spc.py b/flopy4/mf6/utl/spc.py index 5bac7af82..b4a99c2f3 100644 --- a/flopy4/mf6/utl/spc.py +++ b/flopy4/mf6/utl/spc.py @@ -7,7 +7,7 @@ from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package -from flopy4.mf6.spec import child, double, integer, keyword, list_, union +from flopy4.mf6.spec import Header, child, double, integer, keyword, list_, union from flopy4.mf6.utl.ts import Ts @@ -18,6 +18,10 @@ class Spc(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + legacy_kwargs: ClassVar[dict[str, Legacy]] = { "perioddata": Legacy("stress_period_data"), } diff --git a/flopy4/mf6/utl/spca.py b/flopy4/mf6/utl/spca.py index f03413973..d09eb6162 100644 --- a/flopy4/mf6/utl/spca.py +++ b/flopy4/mf6/utl/spca.py @@ -5,7 +5,7 @@ from flopy4.mf6._types import FloatArrayLike, TimeArraySeriesRef from flopy4.mf6.package import Package -from flopy4.mf6.spec import array, child, keyword +from flopy4.mf6.spec import Header, array, child, keyword from flopy4.mf6.utl.tas import Tas @@ -16,6 +16,10 @@ class Spca(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + readasarrays: bool = keyword( default=True, block="options", diff --git a/flopy4/mf6/utl/tas.py b/flopy4/mf6/utl/tas.py index f0d37581d..dc34e064b 100644 --- a/flopy4/mf6/utl/tas.py +++ b/flopy4/mf6/utl/tas.py @@ -6,7 +6,7 @@ from flopy4.mf6._types import FloatArrayLike from flopy4.mf6.package import Package from flopy4.mf6.record import Record -from flopy4.mf6.spec import array, record, string +from flopy4.mf6.spec import Header, array, record, string @attrs.define(kw_only=True, slots=False) @@ -16,6 +16,10 @@ class Tas(Package): multi_package: ClassVar[bool] = True + headers: ClassVar[dict[str, Header]] = { + "time": Header("double"), + } + @attrs.define class TimeSeriesName(Record): _keyword: ClassVar[str] = "name" diff --git a/flopy4/mf6/utl/tvk.py b/flopy4/mf6/utl/tvk.py index afbd1a166..3e132c10e 100644 --- a/flopy4/mf6/utl/tvk.py +++ b/flopy4/mf6/utl/tvk.py @@ -7,7 +7,7 @@ from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package -from flopy4.mf6.spec import cellid_, child, double, keyword, list_, union +from flopy4.mf6.spec import Header, cellid_, child, double, keyword, list_, union from flopy4.mf6.utl.ts import Ts @@ -16,6 +16,10 @@ class Tvk(Package): dfn_name: ClassVar[str] = "utl-tvk" ftype: ClassVar[str] = "TVK6" + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + legacy_kwargs: ClassVar[dict[str, Legacy]] = { "perioddata": Legacy("stress_period_data"), } diff --git a/flopy4/mf6/utl/tvs.py b/flopy4/mf6/utl/tvs.py index 0f8eea195..540022f0a 100644 --- a/flopy4/mf6/utl/tvs.py +++ b/flopy4/mf6/utl/tvs.py @@ -7,7 +7,7 @@ from flopy4.mf6.item import Item from flopy4.mf6.legacy import Legacy from flopy4.mf6.package import Package -from flopy4.mf6.spec import cellid_, child, double, keyword, list_, union +from flopy4.mf6.spec import Header, cellid_, child, double, keyword, list_, union from flopy4.mf6.utl.ts import Ts @@ -16,6 +16,10 @@ class Tvs(Package): dfn_name: ClassVar[str] = "utl-tvs" ftype: ClassVar[str] = "TVS6" + headers: ClassVar[dict[str, Header]] = { + "period": Header("integer", index=True), + } + legacy_kwargs: ClassVar[dict[str, Legacy]] = { "perioddata": Legacy("stress_period_data"), } diff --git a/flopy4/mf6/write_context.py b/flopy4/mf6/write_context.py index 49fbae49e..958146a6e 100644 --- a/flopy4/mf6/write_context.py +++ b/flopy4/mf6/write_context.py @@ -58,7 +58,9 @@ class ArrayIO: field, beside the component's file. A path outside the simulation directory isn't written to: the array is written beside its component's file instead, under the same name. Arrays sharing a - file must hold the same values, or they're written inline. + file must hold the same values, or they're written inline (to + files of their own, if the context's `array_format` is a file + format: see `WriteContext`). format : ArrayFormat, optional The control record to write the array with. Overrides the context's `array_format`. A ``(field, layer)`` entry's is for @@ -74,7 +76,13 @@ class ArrayIO: inline. Set by loading; not compared by `==`. Loading sets each array's `format` and `layered` to the control - records it was read from, so writing it again writes them back. + records it was read from, so writing it again writes them back. An + INTERNAL or OPEN/CLOSE record's FACTOR isn't kept: the array holds the + values times it, and is written with no FACTOR. Arrays read from one + file with different factors (say, a recharge file scaled per period) + so hold different values, and can't share the file when written: + they're written inline, or each to a file of its own with an + `array_format` of "open/close". """ iprn: Optional[int] = None @@ -183,6 +191,10 @@ class WriteContext: field. Set here, it overrides lower-ranked contexts' formats, such as loaded ones, and, if "constant" or "internal", their paths; an `ArrayIO.path` of this context still writes its array to the file. + Arrays sent to a file by it that can't share the file their path + names, holding different values, each get a file of their own, + named as if they had no path, where they'd otherwise be written + inline. `use_netcdf` overrides it. list_format : ListFormat, optional How to write lists, unless a list's own `ListIO.format` in this diff --git a/pyproject.toml b/pyproject.toml index bd4fef3bc..105544216 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -95,6 +95,7 @@ include = ["flopy4", "flopy4.*"] "mf6/codec/**/*.jinja", "mf6/utils/codegen/templates/*.jinja", "mf6/utils/codegen/dfn_overrides.toml", + "mf6/dfns/*", ] [tool.ruff] diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001a_Tharmonic_extlist].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001a_Tharmonic_extlist].json index dcff055ed..e2285e938 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001a_Tharmonic_extlist].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001a_Tharmonic_extlist].json @@ -143,8 +143,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow15.ims flow15", " MXITER 1", + " IMS6 flow15.ims flow15", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001b_Tlogarithmic].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001b_Tlogarithmic].json index 6ac44af87..0104e6149 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001b_Tlogarithmic].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001b_Tlogarithmic].json @@ -137,8 +137,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow15.ims flow15", " MXITER 1", + " IMS6 flow15.ims flow15", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001c_Tamtlmk].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001c_Tamtlmk].json index 8d93e57d0..7b5107c08 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001c_Tamtlmk].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001c_Tamtlmk].json @@ -137,8 +137,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow15.ims flow15", " MXITER 1", + " IMS6 flow15.ims flow15", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001d_Tnewton].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001d_Tnewton].json index 75abb7499..6dd6aa2a1 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001d_Tnewton].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001d_Tnewton].json @@ -137,8 +137,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow15.ims flow15", " MXITER 1", + " IMS6 flow15.ims flow15", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_Tnewton_2models].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_Tnewton_2models].json index a8555ecac..b3372017c 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_Tnewton_2models].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_Tnewton_2models].json @@ -17,8 +17,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims Model_01 Model_02", " MXITER 1", + " IMS6 model.ims Model_01 Model_02", "END SOLUTIONGROUP 1" ], "model.exg": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_3layTS].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_3layTS].json index 3c571a8c1..5bbce87ca 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_3layTS].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_3layTS].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test001e_UZF_3lay.ims GWF_1", " MXITER 1", + " IMS6 test001e_UZF_3lay.ims GWF_1", "END SOLUTIONGROUP 1" ], "simulation.tdis": [ @@ -171,11 +171,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " transient", + " TRANSIENT", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "test001e_UZF_3lay.uzf": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_3lay].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_3lay].json index cbfe552e1..65951c8d0 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_3lay].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_3lay].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test001e_UZF_3lay.ims GWF_1", " MXITER 1", + " IMS6 test001e_UZF_3lay.ims GWF_1", "END SOLUTIONGROUP 1" ], "simulation.tdis": [ @@ -172,11 +172,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " transient", + " TRANSIENT", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "test001e_UZF_3lay.uzf": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_TS].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_TS].json index 13c6bd982..d94ded11b 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_TS].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_TS].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test001e_UZF_TS.ims GWF_1", " MXITER 1", + " IMS6 test001e_UZF_TS.ims GWF_1", "END SOLUTIONGROUP 1" ], "simulation.tdis": [ @@ -167,11 +167,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " transient", + " TRANSIENT", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "test001e_UZF_TS.uzf": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_spring].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_spring].json index 40af63226..2333c207f 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_spring].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_UZF_spring].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test001e_UZF.ims GWF_1", " MXITER 1", + " IMS6 test001e_UZF.ims GWF_1", "END SOLUTIONGROUP 1" ], "simulation.tdis": [ @@ -170,11 +170,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "test001e_UZF.uzf": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_noUZF_3lay].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_noUZF_3lay].json index 6c2d238fb..02c973565 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_noUZF_3lay].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001e_noUZF_3lay].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test001e_noUZF.ims GWF_1", " MXITER 1", + " IMS6 test001e_noUZF.ims GWF_1", "END SOLUTIONGROUP 1" ], "simulation.tdis": [ @@ -182,11 +182,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " transient", + " TRANSIENT", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001f_hfb-xt3d-nwt].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001f_hfb-xt3d-nwt].json index c0e9711e0..2e654c066 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001f_hfb-xt3d-nwt].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001f_hfb-xt3d-nwt].json @@ -153,8 +153,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow15.ims flow15", " MXITER 1", + " IMS6 flow15.ims flow15", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001f_hfb-xt3d].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001f_hfb-xt3d].json index 4b6b396ad..88966d4ae 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001f_hfb-xt3d].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001f_hfb-xt3d].json @@ -152,8 +152,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow15.ims flow15", " MXITER 1", + " IMS6 flow15.ims flow15", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001f_hfb].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001f_hfb].json index 8beb96de6..ad5ddc501 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001f_hfb].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001f_hfb].json @@ -150,8 +150,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow15.ims flow15", " MXITER 1", + " IMS6 flow15.ims flow15", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001g_MVR].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001g_MVR].json index bf91795fe..8c1891f50 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001g_MVR].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001g_MVR].json @@ -213,8 +213,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow15.ims flow15", " MXITER 1", + " IMS6 flow15.ims flow15", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001g_MVR_transient].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001g_MVR_transient].json index 9f809315a..673b80602 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001g_MVR_transient].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest001g_MVR_transient].json @@ -227,8 +227,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow15.ims flow15", " MXITER 1", + " IMS6 flow15.ims flow15", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs].json index cd2ab4c51..544939004 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_disv].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_disv].json index 26b08161d..d83b332c3 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_disv].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_disv].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.disv": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_disv_xt3d].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_disv_xt3d].json index ae33f5a1e..2c445ad19 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_disv_xt3d].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_disv_xt3d].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.disv": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_obs].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_obs].json index cd2ab4c51..544939004 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_obs].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_obs].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_reduced].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_reduced].json index 979d415f5..b31665194 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_reduced].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_reduced].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_tr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_tr].json index 7975057cb..930a7f975 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_tr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest003_gwfs_tr].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.dis": [ @@ -132,11 +132,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " steady-state", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " transient", + " TRANSIENT", "END PERIOD 2" ], "model_left.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_bcfss].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_bcfss].json index fd3290f54..7f0e9d961 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_bcfss].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_bcfss].json @@ -143,8 +143,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_lpfss].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_lpfss].json index b1288fba2..0fa372c33 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_lpfss].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_lpfss].json @@ -16,8 +16,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test004_lpfss.ims test004_lpfss", " MXITER 1", + " IMS6 test004_lpfss.ims test004_lpfss", "END SOLUTIONGROUP 1" ], "test004_lpfss.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_lpfss_disv].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_lpfss_disv].json index a75326dec..2dd8ba4cb 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_lpfss_disv].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_lpfss_disv].json @@ -25,8 +25,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 t4.ims t4_disv", " MXITER 1", + " IMS6 t4.ims t4_disv", "END SOLUTIONGROUP 1" ], "t4.disv": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_lpfss_nr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_lpfss_nr].json index cd8a46d74..8619f0638 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_lpfss_nr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest004_lpfss_nr].json @@ -16,8 +16,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test004_lpfss_nr.ims test004_lpfss_nr", " MXITER 1", + " IMS6 test004_lpfss_nr.ims test004_lpfss_nr", "END SOLUTIONGROUP 1" ], "test004_lpfss_nr.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest005_advgw_tidal].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest005_advgw_tidal].json index aa015437a..cc8cf1378 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest005_advgw_tidal].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest005_advgw_tidal].json @@ -31,8 +31,8 @@ "END OPTIONS", "", "BEGIN DIMENSIONS", - " NSEG 3", " MAXBOUND 150", + " NSEG 3", "END DIMENSIONS", "", "BEGIN PERIOD 1", @@ -222,11 +222,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "AdvGW_tidal.wel": [ @@ -337,8 +337,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_gnc].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_gnc].json index 35dc1f044..3b585fb49 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_gnc].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_gnc].json @@ -17,8 +17,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 simulation.ims GWF_Model_1 GWF_Model_2", " MXITER 1", + " IMS6 simulation.ims GWF_Model_1 GWF_Model_2", "END SOLUTIONGROUP 1" ], "model1.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_mvr_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_mvr_dev].json index 58b1322ce..4d9edb6c4 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_mvr_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_mvr_dev].json @@ -17,8 +17,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 simulation.ims PARENT CHILD", " MXITER 1", + " IMS6 simulation.ims PARENT CHILD", "END SOLUTIONGROUP 1" ], "model1.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf].json index 5b6db4de0..1ddd1ceac 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf].json @@ -17,8 +17,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 simulation.ims GWF_Model_1 GWF_Model_2", " MXITER 1", + " IMS6 simulation.ims GWF_Model_1 GWF_Model_2", "END SOLUTIONGROUP 1" ], "model1.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf_nr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf_nr].json index d11e95838..eff32fcaf 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf_nr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf_nr].json @@ -17,8 +17,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 simulation.ims GWF_Model_1 GWF_Model_2", " MXITER 1", + " IMS6 simulation.ims GWF_Model_1 GWF_Model_2", "END SOLUTIONGROUP 1" ], "model1.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf_nr_gnc].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf_nr_gnc].json index 56ee58b11..e904c0653 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf_nr_gnc].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf_nr_gnc].json @@ -17,8 +17,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 simulation.ims GWF_Model_1 GWF_Model_2", " MXITER 1", + " IMS6 simulation.ims GWF_Model_1 GWF_Model_2", "END SOLUTIONGROUP 1" ], "model1.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf_tr_nr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf_tr_nr].json index 001bd8f28..6b2b80b74 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf_tr_nr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_2models_unconf_tr_nr].json @@ -17,8 +17,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 simulation.ims GWF_Model_1 GWF_Model_2", " MXITER 1", + " IMS6 simulation.ims GWF_Model_1 GWF_Model_2", "END SOLUTIONGROUP 1" ], "model1.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3].json index 96e81ee07..55d726008 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3].json @@ -183,8 +183,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv].json index 4519092f6..b420de006 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv].json @@ -171,8 +171,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_ext].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_ext].json index e4500f970..4b4bb4595 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_ext].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_ext].json @@ -176,8 +176,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_hani].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_hani].json index 19a9f3faf..5eca54b68 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_hani].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_hani].json @@ -176,8 +176,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh2-3D_xt3d].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh2-3D_xt3d].json index 049284e2d..3fd8dd858 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh2-3D_xt3d].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh2-3D_xt3d].json @@ -144,8 +144,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ], "simulation.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh2].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh2].json index 4cc3bdb6b..8cb5cd7ee 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh2].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh2].json @@ -127,8 +127,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ], "simulation.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh2_xt3d].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh2_xt3d].json index 24b26194c..7af302afe 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh2_xt3d].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh2_xt3d].json @@ -128,8 +128,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ], "simulation.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh].json index 0086171d2..a312e9e8d 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh].json @@ -170,8 +170,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh_xt3d].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh_xt3d].json index 1411392f5..669f68e02 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh_xt3d].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_trimesh_xt3d].json @@ -155,8 +155,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_xt3d].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_xt3d].json index a858cf801..c8fed09ac 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_xt3d].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_disv_xt3d].json @@ -155,8 +155,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_gnc].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_gnc].json index a62fc6576..a5be5f5cb 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_gnc].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_gnc].json @@ -185,8 +185,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_gnc_nr_mfusg].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_gnc_nr_mfusg].json index b7a04d006..453ad2d7d 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_gnc_nr_mfusg].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_gnc_nr_mfusg].json @@ -189,8 +189,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_nr_mfusg].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_nr_mfusg].json index f02d19625..17e23ea91 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_nr_mfusg].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_nr_mfusg].json @@ -172,8 +172,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_tr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_tr].json index 4d1675971..9e1206d6c 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_tr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_tr].json @@ -189,8 +189,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_tr_nr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_tr_nr].json index 979a9f365..1fcecfa9a 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_tr_nr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_tr_nr].json @@ -189,8 +189,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_unconf].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_unconf].json index d619f9303..d776d5f96 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_unconf].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006_gwf3_unconf].json @@ -169,8 +169,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006a_gwf3_disv_thickstrt].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006a_gwf3_disv_thickstrt].json index e6e873cc1..4ee6d3517 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006a_gwf3_disv_thickstrt].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest006a_gwf3_disv_thickstrt].json @@ -171,8 +171,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest007_75x75].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest007_75x75].json index 4f2872ed8..166e372d9 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest007_75x75].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest007_75x75].json @@ -147,15 +147,15 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2", "", "BEGIN PERIOD 3", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 3" ], "mf6.tdis": [ @@ -208,8 +208,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mf6.ims mf6", " MXITER 1", + " IMS6 mf6.ims mf6", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest007_75x75_confined].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest007_75x75_confined].json index 333c3cf26..2bfe8fe34 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest007_75x75_confined].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest007_75x75_confined].json @@ -147,15 +147,15 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2", "", "BEGIN PERIOD 3", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 3" ], "mf6.tdis": [ @@ -208,8 +208,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mf6.ims mf6", " MXITER 1", + " IMS6 mf6.ims mf6", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest009_3lay-disu].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest009_3lay-disu].json index f94bcf80e..5893891c3 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest009_3lay-disu].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest009_3lay-disu].json @@ -173,8 +173,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest011_mflgr_ex3].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest011_mflgr_ex3].json index 479541953..b478714a0 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest011_mflgr_ex3].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest011_mflgr_ex3].json @@ -275,8 +275,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 ex3_parent.ims PARENT CHILD", " MXITER 1", + " IMS6 ex3_parent.ims PARENT CHILD", "END SOLUTIONGROUP 1" ], "simulation.exg": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest011_mflgr_ex3_sfr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest011_mflgr_ex3_sfr].json index 8808ddfa8..a9619387c 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest011_mflgr_ex3_sfr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest011_mflgr_ex3_sfr].json @@ -289,8 +289,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 ex3_parent.ims PARENT CHILD", " MXITER 1", + " IMS6 ex3_parent.ims PARENT CHILD", "END SOLUTIONGROUP 1" ], "simulation.exg": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest012_WaterTable].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest012_WaterTable].json index 5daea0291..c9ea2a8fb 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest012_WaterTable].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest012_WaterTable].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest013_Zaidel].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest013_Zaidel].json index 1dbbcf89b..769092ac7 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest013_Zaidel].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest013_Zaidel].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3High].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3High].json index faf80b186..f6b91f103 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3High].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3High].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3High_mfusg].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3High_mfusg].json index a771d5d96..2d2c15699 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3High_mfusg].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3High_mfusg].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low].json index 8da8e95e3..f4a5de2a6 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_MAW].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_MAW].json index a8a6e692d..3120e3480 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_MAW].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_MAW].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_MD_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_MD_dev].json index 8a8facc1f..55e62f14b 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_MD_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_MD_dev].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_RCM_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_RCM_dev].json index 6b3f36d03..848a3af31 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_RCM_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_RCM_dev].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_dev].json index a1fffa0d0..d579465b4 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest014_NWTP3Low_dev].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike-xt3d-rhs].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike-xt3d-rhs].json index 6daebd8d9..f81132172 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike-xt3d-rhs].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike-xt3d-rhs].json @@ -129,8 +129,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike-xt3d].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike-xt3d].json index 550a9e336..b3df7d575 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike-xt3d].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike-xt3d].json @@ -129,8 +129,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike].json index 9761d14b6..1ec8ea084 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike].json @@ -128,8 +128,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike_disu].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike_disu].json index 0d02368e2..37d6a2de2 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike_disu].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike_disu].json @@ -134,8 +134,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike_disu_mfusg].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike_disu_mfusg].json index caa20ff56..c55de92eb 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike_disu_mfusg].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest015_KeatingLike_disu_mfusg].json @@ -136,8 +136,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating].json index 84dc1d91e..f403dd072 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating].json @@ -196,8 +196,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_dev].json index 1815c5b03..8c16aa092 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_dev].json @@ -196,8 +196,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_disu_250].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_disu_250].json index 6205d3511..32fd4adb2 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_disu_250].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_disu_250].json @@ -154,8 +154,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_disu_250_xt3d].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_disu_250_xt3d].json index 5ffe9936d..7748da81d 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_disu_250_xt3d].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_disu_250_xt3d].json @@ -140,8 +140,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_disu_mfusg].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_disu_mfusg].json index c5156be19..5311b1443 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_disu_mfusg].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest016_Keating_disu_mfusg].json @@ -147,8 +147,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest017_Crinkle].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest017_Crinkle].json index 21eda6f27..0cbd0307f 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest017_Crinkle].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest017_Crinkle].json @@ -205,11 +205,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " steady-state", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " transient", + " TRANSIENT", "END PERIOD 2" ], "mfsim.nam": [ @@ -228,8 +228,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenGC].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenGC].json index 9961a05dc..39fc8488f 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenGC].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenGC].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 parent.ims PARENT", " MXITER 1", + " IMS6 parent.ims PARENT", "END SOLUTIONGROUP 1" ], "parent.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenGF].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenGF].json index b54cb5335..a6e732b03 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenGF].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenGF].json @@ -182,8 +182,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 TM9_global_gv.ims PARENT", " MXITER 1", + " IMS6 TM9_global_gv.ims PARENT", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenLGR].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenLGR].json index 5285eb0e9..66ea67fe3 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenLGR].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenLGR].json @@ -296,8 +296,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 TM9_global.ims PARENT CHILD", " MXITER 1", + " IMS6 TM9_global.ims PARENT CHILD", "END SOLUTIONGROUP 1" ], "parent-child.gwfexg": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenLGR_nr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenLGR_nr].json index 173b1fab3..8ee6c7266 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenLGR_nr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest019_VilhelmsenLGR_nr].json @@ -379,8 +379,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 TM9_global.ims PARENT CHILD", " MXITER 1", + " IMS6 TM9_global.ims PARENT CHILD", "END SOLUTIONGROUP 1" ], "parent-child.gwfexg": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NT_EI].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NT_EI].json index 9b2822da8..eb5b4a687 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NT_EI].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NT_EI].json @@ -237,8 +237,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransientTS2].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransientTS2].json index 97a2d131d..21f3abbf4 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransientTS2].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransientTS2].json @@ -219,8 +219,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransientTS].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransientTS].json index 62464444c..892e76957 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransientTS].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransientTS].json @@ -188,8 +188,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient].json index 8619a3972..f7f02f0d0 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient].json @@ -191,8 +191,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_aniso].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_aniso].json index 005534a60..417d4f177 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_aniso].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_aniso].json @@ -181,8 +181,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mf6.ims6 mf6", " MXITER 1", + " IMS6 mf6.ims6 mf6", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_constantMAW].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_constantMAW].json index 0b2dabd9f..0c28c91af 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_constantMAW].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_constantMAW].json @@ -180,8 +180,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_cumcond].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_cumcond].json index 16fb613db..76ac03eb6 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_cumcond].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_cumcond].json @@ -167,8 +167,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_cumcond_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_cumcond_dev].json index 16fb613db..76ac03eb6 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_cumcond_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_cumcond_dev].json @@ -167,8 +167,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_thickstrt].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_thickstrt].json index f4f333ee3..5c032dd65 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_thickstrt].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_NevilleTonkinTransient_thickstrt].json @@ -171,8 +171,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_mawconfined].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_mawconfined].json index d1f9b5e17..008d477d8 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_mawconfined].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_mawconfined].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test020_mawconfined.ims mawconf", " MXITER 1", + " IMS6 test020_mawconfined.ims mawconf", "END SOLUTIONGROUP 1" ], "test020_mawconfined.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_mawconfined_openclose].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_mawconfined_openclose].json index 96bf3bd3a..99552e1c5 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_mawconfined_openclose].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest020_mawconfined_openclose].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test020_mawconfined.ims mawconf", " MXITER 1", + " IMS6 test020_mawconfined.ims mawconf", "END SOLUTIONGROUP 1" ], "test020_mawconfined.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest021_twri].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest021_twri].json index 02693db09..661a1132d 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest021_twri].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest021_twri].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 twri.ims GWF_1", " MXITER 1", + " IMS6 twri.ims GWF_1", "END SOLUTIONGROUP 1" ], "twri.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest023_FlowingWell].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest023_FlowingWell].json index 30722afe6..670a7ff57 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest023_FlowingWell].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest023_FlowingWell].json @@ -174,8 +174,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest024_Reilly].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest024_Reilly].json index 798be3977..bdd9d6ad3 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest024_Reilly].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest024_Reilly].json @@ -239,8 +239,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest024_Reilly_ext].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest024_Reilly_ext].json index 810641543..780e47b92 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest024_Reilly_ext].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest024_Reilly_ext].json @@ -240,8 +240,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_ConstantCV].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_ConstantCV].json index 705747696..10559d7fb 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_ConstantCV].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_ConstantCV].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_ConstantCV_perched].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_ConstantCV_perched].json index cdb2c6acb..6616cb63d 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_ConstantCV_perched].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_ConstantCV_perched].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_VariableCV].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_VariableCV].json index 9d187b51c..59e8db259 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_VariableCV].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_VariableCV].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_Vertically_Staggered].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_Vertically_Staggered].json index affccf6d8..2f1d3ec99 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_Vertically_Staggered].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest025_Vertically_Staggered].json @@ -157,8 +157,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flow.ims GWF_1", " MXITER 1", + " IMS6 flow.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest026_WellReduction].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest026_WellReduction].json index 10e1aa3e3..a238f64e7 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest026_WellReduction].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest026_WellReduction].json @@ -141,8 +141,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest027_TimeseriesTest].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest027_TimeseriesTest].json index 185c9dcab..59ffe51c2 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest027_TimeseriesTest].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest027_TimeseriesTest].json @@ -16,8 +16,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ @@ -300,11 +300,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " steady-state", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " transient", + " TRANSIENT", "END PERIOD 2" ], "timeseriestest.wel": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest027_TimeseriesTest_idomain].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest027_TimeseriesTest_idomain].json index 315b9d4ff..e350359c4 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest027_TimeseriesTest_idomain].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest027_TimeseriesTest_idomain].json @@ -16,8 +16,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ @@ -304,11 +304,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " steady-state", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " transient", + " TRANSIENT", "END PERIOD 2" ], "timeseriestest.wel": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr].json index 689302601..b94c12023 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr].json @@ -16,8 +16,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_mvr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_mvr].json index 0457b88c1..f34ccfec2 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_mvr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_mvr].json @@ -16,8 +16,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_mvr_openclose].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_mvr_openclose].json index 258ceac9b..83c56e9ec 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_mvr_openclose].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_mvr_openclose].json @@ -16,8 +16,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet].json index d3468e9a8..d33c4fbea 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet].json @@ -195,8 +195,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mf6.ims6 mf6", " MXITER 1", + " IMS6 mf6.ims6 mf6", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet_drain].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet_drain].json index 447cc04fb..d20b2ab3e 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet_drain].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet_drain].json @@ -241,8 +241,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mf6.ims6 mf6", " MXITER 1", + " IMS6 mf6.ims6 mf6", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet_nr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet_nr].json index c6ba90939..cf9fafc22 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet_nr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet_nr].json @@ -205,8 +205,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mf6.ims6 mf6", " MXITER 1", + " IMS6 mf6.ims6 mf6", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet_simple].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet_simple].json index dbadb6d8e..a8c9a181b 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet_simple].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_rewet_simple].json @@ -208,8 +208,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mf6.ims6 mf6", " MXITER 1", + " IMS6 mf6.ims6 mf6", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_simple].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_simple].json index f4cefaec2..30bb2e9fc 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_simple].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest028_sfr_simple].json @@ -274,8 +274,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mf6.ims6 mf6", " MXITER 1", + " IMS6 mf6.ims6 mf6", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgr_parentchild].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgr_parentchild].json index 8a9780ea9..a6f30bc16 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgr_parentchild].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgr_parentchild].json @@ -281,8 +281,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 PARENT_CHILD.ims PARENT CHILD", " MXITER 1", + " IMS6 PARENT_CHILD.ims PARENT CHILD", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgrsfr_parent].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgrsfr_parent].json index 73ea702d7..5110c60dc 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgrsfr_parent].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgrsfr_parent].json @@ -16,8 +16,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgrsfr_parent_hole].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgrsfr_parent_hole].json index 8821fe092..ead2ed114 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgrsfr_parent_hole].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgrsfr_parent_hole].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 sfr_hole.ims sfr_hole", " MXITER 1", + " IMS6 sfr_hole.ims sfr_hole", "END SOLUTIONGROUP 1" ], "sfr_hole.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgrsfr_parentchild].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgrsfr_parentchild].json index 751508633..46157a993 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgrsfr_parentchild].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest029_lgrsfr_parentchild].json @@ -355,8 +355,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 PARENT_CHILD.ims PARENT CHILD", " MXITER 1", + " IMS6 PARENT_CHILD.ims PARENT CHILD", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_col].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_col].json index 191dfd49f..fdfdb2d6a 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_col].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_col].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF", " MXITER 1", + " IMS6 model.ims GWF", "END SOLUTIONGROUP 1" ], "model.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_col_disu].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_col_disu].json index b171acc4c..de73c542c 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_col_disu].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_col_disu].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF", " MXITER 1", + " IMS6 model.ims GWF", "END SOLUTIONGROUP 1" ], "model.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_row].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_row].json index 303a1bd2c..61aaa3e78 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_row].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_row].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF", " MXITER 1", + " IMS6 model.ims GWF", "END SOLUTIONGROUP 1" ], "model.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_row_disu].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_row_disu].json index 4648d0045..b3f7238be 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_row_disu].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_row_disu].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF", " MXITER 1", + " IMS6 model.ims GWF", "END SOLUTIONGROUP 1" ], "model.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_xt3d].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_xt3d].json index 97fd829bd..4ca819cd1 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_xt3d].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_xt3d].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF", " MXITER 1", + " IMS6 model.ims GWF", "END SOLUTIONGROUP 1" ], "model.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_xt3d_disu].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_xt3d_disu].json index e2dec8f79..f3be99bdc 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_xt3d_disu].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest030_hani_xt3d_disu].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF", " MXITER 1", + " IMS6 model.ims GWF", "END SOLUTIONGROUP 1" ], "model.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest032_sfr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest032_sfr].json index c7818c88a..023ed4521 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest032_sfr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest032_sfr].json @@ -16,8 +16,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest033_wtdecay].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest033_wtdecay].json index 96cb84396..23903f982 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest033_wtdecay].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest033_wtdecay].json @@ -19,8 +19,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.ims": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest034_nwtp2].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest034_nwtp2].json index c266ab09e..1915336d5 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest034_nwtp2].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest034_nwtp2].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test034_nwtp2.ims test034_nwtp2", " MXITER 1", + " IMS6 test034_nwtp2.ims test034_nwtp2", "END SOLUTIONGROUP 1" ], "test034_nwtp2.dis": [ @@ -189,7 +189,7 @@ "END GRIDDATA", "", "BEGIN PERIOD 4", - " steady-state", + " STEADY-STATE", "END PERIOD 4" ], "test034_nwtp2.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest034_nwtp2_1d].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest034_nwtp2_1d].json index d60088b98..9340c8528 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest034_nwtp2_1d].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest034_nwtp2_1d].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test034_nwtp2.ims test034_nwtp2", " MXITER 1", + " IMS6 test034_nwtp2.ims test034_nwtp2", "END SOLUTIONGROUP 1" ], "test034_nwtp2.dis": [ @@ -199,7 +199,7 @@ "END GRIDDATA", "", "BEGIN PERIOD 4", - " steady-state", + " STEADY-STATE", "END PERIOD 4" ], "test034_nwtp2.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest035_fhb].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest035_fhb].json index 7e5adaf31..206a69119 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest035_fhb].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest035_fhb].json @@ -208,8 +208,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 fhb2015.ims fhb2015", " MXITER 1", + " IMS6 fhb2015.ims fhb2015", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb].json index 7f89db998..51338e057 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 twrihfb2015.ims twrihfb2015", " MXITER 1", + " IMS6 twrihfb2015.ims twrihfb2015", "END SOLUTIONGROUP 1" ], "twrihfb2015.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_5lay].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_5lay].json index 39a4ea9d7..b4244eead 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_5lay].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_5lay].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test036_twrihfb.ims twrihfb_5lay", " MXITER 1", + " IMS6 test036_twrihfb.ims twrihfb_5lay", "END SOLUTIONGROUP 1" ], "test036_twrihfb.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_lpf].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_lpf].json index cb07437fb..0cc9cc89b 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_lpf].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_lpf].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test036_twrihfb.ims test036_twrihfb", " MXITER 1", + " IMS6 test036_twrihfb.ims test036_twrihfb", "END SOLUTIONGROUP 1" ], "test036_twrihfb.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_nr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_nr].json index 3653cfa7a..b7a6e8215 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_nr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_nr].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test036_twrihfb_nr.ims twrihfb_nr", " MXITER 1", + " IMS6 test036_twrihfb_nr.ims twrihfb_nr", "END SOLUTIONGROUP 1" ], "test036_twrihfb_nr.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_openclose].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_openclose].json index 15d9e19ed..2d9ab0046 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_openclose].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest036_twrihfb_openclose].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 twrihfb2015.ims twrihfb2015", " MXITER 1", + " IMS6 twrihfb2015.ims twrihfb2015", "END SOLUTIONGROUP 1" ], "twrihfb2015.chd.per1.ref": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest037_mfcp3].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest037_mfcp3].json index cb3b218b6..bddbba679 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest037_mfcp3].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest037_mfcp3].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test037.ims test037", " MXITER 1", + " IMS6 test037.ims test037", "END SOLUTIONGROUP 1" ], "test037.dis": [ @@ -168,15 +168,15 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2", "", "BEGIN PERIOD 3", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 3" ], "test037.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest038_idomain].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest038_idomain].json index 173c7ca4f..0b7ab6704 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest038_idomain].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest038_idomain].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF", " MXITER 1", + " IMS6 model.ims GWF", "END SOLUTIONGROUP 1" ], "model.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert].json index d75eafb72..e7f0c579b 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert].json @@ -138,8 +138,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flowdivert.ims GWF_1", " MXITER 1", + " IMS6 flowdivert.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert_mfusg].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert_mfusg].json index f77cedc79..81a113aa1 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert_mfusg].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert_mfusg].json @@ -137,8 +137,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flowdivert.ims GWF_1", " MXITER 1", + " IMS6 flowdivert.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert_nr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert_nr].json index 93a39d183..ab8d0550a 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert_nr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert_nr].json @@ -135,8 +135,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flowdivert.ims GWF_1", " MXITER 1", + " IMS6 flowdivert.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert_nwt_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert_nwt_dev].json index fd5b73b66..699b70860 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert_nwt_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest041_flowdivert_nwt_dev].json @@ -137,8 +137,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 flowdivert.ims GWF_1", " MXITER 1", + " IMS6 flowdivert.ims GWF_1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_dev].json index dc2f365af..98d96d800 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_dev].json @@ -192,8 +192,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lake0.ims lake0", " MXITER 1", + " IMS6 lake0.ims lake0", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedh].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedh].json index 81cbbfcef..37199995a 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedh].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedh].json @@ -278,8 +278,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lake0_embedded.ims lake0_e", " MXITER 1", + " IMS6 lake0_embedded.ims lake0_e", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedh_conf].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedh_conf].json index 1d820cf03..654e773c0 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedh_conf].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedh_conf].json @@ -285,8 +285,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lake0_embedded.ims lake0_e", " MXITER 1", + " IMS6 lake0_embedded.ims lake0_e", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedh_openclose].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedh_openclose].json index ef9707ccc..1a94a4549 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedh_openclose].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedh_openclose].json @@ -293,8 +293,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lake0_embedded.ims lake0_e", " MXITER 1", + " IMS6 lake0_embedded.ims lake0_e", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedv].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedv].json index 15611663f..d0ef03cd5 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedv].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedv].json @@ -284,8 +284,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lake0_embedded.ims lake0_e", " MXITER 1", + " IMS6 lake0_embedded.ims lake0_e", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedv_conf].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedv_conf].json index 9788742ab..b81ba0842 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedv_conf].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedv_conf].json @@ -284,8 +284,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lake0_embedded.ims lake0_e", " MXITER 1", + " IMS6 lake0_embedded.ims lake0_e", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedv_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedv_dev].json index 15611663f..d0ef03cd5 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedv_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest042_lake0_embeddedv_dev].json @@ -284,8 +284,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lake0_embedded.ims lake0_e", " MXITER 1", + " IMS6 lake0_embedded.ims lake0_e", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest043_drylake_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest043_drylake_dev].json index 521ce4d93..2dbcfe315 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest043_drylake_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest043_drylake_dev].json @@ -209,8 +209,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 drylake.ims ls", " MXITER 1", + " IMS6 drylake.ims ls", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest044_lakebotfill_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest044_lakebotfill_dev].json index d9b58d146..67fef55c8 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest044_lakebotfill_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest044_lakebotfill_dev].json @@ -231,8 +231,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lbf.ims lbf", " MXITER 1", + " IMS6 lbf.ims lbf", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss].json index 01fa63dbc..2d1b57344 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss].json @@ -216,8 +216,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex1b.ims lakeex1b", " MXITER 1", + " IMS6 lakeex1b.ims lakeex1b", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_1layer_alt_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_1layer_alt_dev].json index 8b534a2af..984677455 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_1layer_alt_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_1layer_alt_dev].json @@ -203,8 +203,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex1b_1layerb.ims lakeex1b_1layerb", " MXITER 1", + " IMS6 lakeex1b_1layerb.ims lakeex1b_1layerb", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_1layer_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_1layer_dev].json index 4997db745..1ebd521e5 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_1layer_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_1layer_dev].json @@ -221,8 +221,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex1b_1layer.ims lakeex1b_1layer", " MXITER 1", + " IMS6 lakeex1b_1layer.ims lakeex1b_1layer", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_1layer_thickstrt_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_1layer_thickstrt_dev].json index b3db60b7b..41fbee5a6 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_1layer_thickstrt_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_1layer_thickstrt_dev].json @@ -220,8 +220,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex1b_1layerc.ims lakeex1b_1layerc", " MXITER 1", + " IMS6 lakeex1b_1layerc.ims lakeex1b_1layerc", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_dev].json index eb31db40d..03cb4065f 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_dev].json @@ -216,8 +216,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex1b.ims lakeex1b", " MXITER 1", + " IMS6 lakeex1b.ims lakeex1b", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_none_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_none_dev].json index 89de8fa12..959f0a28a 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_none_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_none_dev].json @@ -216,8 +216,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex1b.ims lakeex1b", " MXITER 1", + " IMS6 lakeex1b.ims lakeex1b", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_table_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_table_dev].json index 24baba6b0..db211441d 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_table_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1ss_table_dev].json @@ -229,8 +229,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex1b.ims lakeex1b", " MXITER 1", + " IMS6 lakeex1b.ims lakeex1b", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1tr_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1tr_dev].json index 91d695765..46c30c8b0 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1tr_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1tr_dev].json @@ -258,8 +258,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex1a.ims lakeex1a", " MXITER 1", + " IMS6 lakeex1a.ims lakeex1a", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1tr_nr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1tr_nr].json index fd2451239..2fd7fe837 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1tr_nr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake1tr_nr].json @@ -244,8 +244,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex1a.ims lakeex1a", " MXITER 1", + " IMS6 lakeex1a.ims lakeex1a", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_dev].json index 9afba2098..08c7342c8 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_dev].json @@ -389,8 +389,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex2a.ims lakeex2a", " MXITER 1", + " IMS6 lakeex2a.ims lakeex2a", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_il_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_il_dev].json index 9655ac454..211f51471 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_il_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_il_dev].json @@ -240,8 +240,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex2a.ims lakeex2a", " MXITER 1", + " IMS6 lakeex2a.ims lakeex2a", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_nr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_nr].json index b811e2c78..9aad09a6c 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_nr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_nr].json @@ -343,8 +343,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex2a.ims lakeex2a", " MXITER 1", + " IMS6 lakeex2a.ims lakeex2a", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfra_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfra_dev].json index 1246b4693..9405590e7 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfra_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfra_dev].json @@ -288,8 +288,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex2a.ims lakeex2a", " MXITER 1", + " IMS6 lakeex2a.ims lakeex2a", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfrb_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfrb_dev].json index 695a011be..7b0362fd4 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfrb_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfrb_dev].json @@ -287,8 +287,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex2a.ims lakeex2a", " MXITER 1", + " IMS6 lakeex2a.ims lakeex2a", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfrc_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfrc_dev].json index 5cfb52de6..b6ffcc6f8 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfrc_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfrc_dev].json @@ -285,8 +285,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex2a.ims lakeex2a", " MXITER 1", + " IMS6 lakeex2a.ims lakeex2a", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfrd_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfrd_dev].json index 3caed3922..df2dfa2e7 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfrd_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfrd_dev].json @@ -286,8 +286,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex2a.ims lakeex2a", " MXITER 1", + " IMS6 lakeex2a.ims lakeex2a", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfre_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfre_dev].json index 67e857e55..7b701d02c 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfre_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake2tr_xsfre_dev].json @@ -308,8 +308,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex2a.ims lakeex2a", " MXITER 1", + " IMS6 lakeex2a.ims lakeex2a", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss].json index 4607ba42c..759bdbc62 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss].json @@ -223,8 +223,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex4.ims lakeex4", " MXITER 1", + " IMS6 lakeex4.ims lakeex4", "END SOLUTIONGROUP 1" ], "rch.obs": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_cl_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_cl_dev].json index 4be1577da..48122f540 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_cl_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_cl_dev].json @@ -222,8 +222,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex4.ims lakeex4", " MXITER 1", + " IMS6 lakeex4.ims lakeex4", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_dev].json index 4607ba42c..759bdbc62 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_dev].json @@ -223,8 +223,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex4.ims lakeex4", " MXITER 1", + " IMS6 lakeex4.ims lakeex4", "END SOLUTIONGROUP 1" ], "rch.obs": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_il_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_il_dev].json index aa84ff4e7..0ccc81655 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_il_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_il_dev].json @@ -221,8 +221,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex4_il.ims lakeex4", " MXITER 1", + " IMS6 lakeex4_il.ims lakeex4", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_nr_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_nr_dev].json index 27e2af0dc..09482b1c8 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_nr_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_nr_dev].json @@ -223,8 +223,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex4.ims lakeex4", " MXITER 1", + " IMS6 lakeex4.ims lakeex4", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_nr_embedded].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_nr_embedded].json index 4826baac5..af770c8bb 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_nr_embedded].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest045_lake4ss_nr_embedded].json @@ -262,8 +262,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 lakeex4.ims lakeex4", " MXITER 1", + " IMS6 lakeex4.ims lakeex4", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest046_periodic_bc].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest046_periodic_bc].json index 2e6f89a0e..bf708d0b7 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest046_periodic_bc].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest046_periodic_bc].json @@ -16,8 +16,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 pbc.ims pbc", " MXITER 1", + " IMS6 pbc.ims pbc", "END SOLUTIONGROUP 1" ], "pbc.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest046_periodic_bc_openclose].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest046_periodic_bc_openclose].json index fb7a1cba6..626909b2a 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest046_periodic_bc_openclose].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest046_periodic_bc_openclose].json @@ -16,8 +16,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 pbc.ims pbc", " MXITER 1", + " IMS6 pbc.ims pbc", "END SOLUTIONGROUP 1" ], "pbc.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_conf].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_conf].json index 0b0ee4de3..d9102b687 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_conf].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_conf].json @@ -99,8 +99,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 simulation.ims parent child", " MXITER 1", + " IMS6 simulation.ims parent child", "END SOLUTIONGROUP 1" ], "parent.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconfB].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconfB].json index 858b9ef22..bcc2452ca 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconfB].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconfB].json @@ -99,8 +99,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 simulation.ims parent child", " MXITER 1", + " IMS6 simulation.ims parent child", "END SOLUTIONGROUP 1" ], "parent.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconfC].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconfC].json index 80b3292de..70705e9b7 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconfC].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconfC].json @@ -99,8 +99,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 simulation.ims parent child", " MXITER 1", + " IMS6 simulation.ims parent child", "END SOLUTIONGROUP 1" ], "parent.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconfD].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconfD].json index 744586687..2f6bc74db 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconfD].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconfD].json @@ -98,8 +98,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 simulation.ims parent child", " MXITER 1", + " IMS6 simulation.ims parent child", "END SOLUTIONGROUP 1" ], "parent.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconf].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconf].json index 1d2069b3b..75b8bfc8c 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconf].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest048_lgr3d_unconf].json @@ -99,8 +99,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 simulation.ims parent child", " MXITER 1", + " IMS6 simulation.ims parent child", "END SOLUTIONGROUP 1" ], "parent.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest049_gwfexgrewet].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest049_gwfexgrewet].json index 3919bd1e2..9ffcc9f43 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest049_gwfexgrewet].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest049_gwfexgrewet].json @@ -19,8 +19,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 simulation.ims Model_01 Model_02 Model_03", " MXITER 1", + " IMS6 simulation.ims Model_01 Model_02 Model_03", "END SOLUTIONGROUP 1" ], "model.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest050_circle_island].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest050_circle_island].json index 91c3d5ee9..8c72c1121 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest050_circle_island].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest050_circle_island].json @@ -146,8 +146,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 ci.ims CI", " MXITER 1", + " IMS6 ci.ims CI", "END SOLUTIONGROUP 1" ], "rech.dat": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2TS].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2TS].json index dfe9e7ee6..40301d644 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2TS].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2TS].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 uzfp2.ims uzfp2", " MXITER 1", + " IMS6 uzfp2.ims uzfp2", "END SOLUTIONGROUP 1" ], "uzfp2.dis": [ @@ -207,11 +207,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "uzfp2.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2].json index fb50e9706..f28f54d12 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 uzfp2.ims uzfp2", " MXITER 1", + " IMS6 uzfp2.ims uzfp2", "END SOLUTIONGROUP 1" ], "uzfp2.dis": [ @@ -207,11 +207,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "uzfp2.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2_mvr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2_mvr].json index db3bbd7f1..ae7b633e1 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2_mvr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2_mvr].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 uzfp2_mvr.ims uzfp2_mvr", " MXITER 1", + " IMS6 uzfp2_mvr.ims uzfp2_mvr", "END SOLUTIONGROUP 1" ], "uzfp2_mvr.dis": [ @@ -336,11 +336,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "uzfp2_mvr.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2_nouzf].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2_nouzf].json index a1b30e5ce..3aff2f294 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2_nouzf].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2_nouzf].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 uzfp2_nouzf.ims uzfp2_nouzf", " MXITER 1", + " IMS6 uzfp2_nouzf.ims uzfp2_nouzf", "END SOLUTIONGROUP 1" ], "uzfp2_nouzf.dis": [ @@ -291,11 +291,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "uzfp2_nouzf.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2_openclose].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2_openclose].json index 38112a421..c72cb73e4 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2_openclose].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp2_openclose].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 uzfp2.ims uzfp2", " MXITER 1", + " IMS6 uzfp2.ims uzfp2", "END SOLUTIONGROUP 1" ], "uzfp2.dis": [ @@ -218,11 +218,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "uzfp2.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_aeET_lakmvr_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_aeET_lakmvr_dev].json index 971c897d0..e7d957a8b 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_aeET_lakmvr_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_aeET_lakmvr_dev].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 uzfp3_lakmvr.ims uzfp3_lakmvr", " MXITER 1", + " IMS6 uzfp3_lakmvr.ims uzfp3_lakmvr", "END SOLUTIONGROUP 1" ], "uzfp3_lakmvr.dis": [ @@ -366,11 +366,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "uzfp3_lakmvr.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_2uzfmodels_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_2uzfmodels_dev].json index 15f5a8b94..453eb8e12 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_2uzfmodels_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_2uzfmodels_dev].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 uzfp3_lakmvr.ims uzfp3_lakmvr", " MXITER 1", + " IMS6 uzfp3_lakmvr.ims uzfp3_lakmvr", "END SOLUTIONGROUP 1" ], "uzfp3_lakmvr.dis": [ @@ -368,11 +368,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "uzfp3_lakmvr.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_dev].json index f5ca2ab1e..b26c01a81 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_dev].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 uzfp3_lakmvr.ims uzfp3_lakmvr", " MXITER 1", + " IMS6 uzfp3_lakmvr.ims uzfp3_lakmvr", "END SOLUTIONGROUP 1" ], "uzfp3_lakmvr.dis": [ @@ -366,11 +366,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "uzfp3_lakmvr.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_nouzf_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_nouzf_dev].json index bdd0d0c3b..1553deb6e 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_nouzf_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_nouzf_dev].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 uzfp3_lakmvr_nouzf.ims lakmvr_nouzf", " MXITER 1", + " IMS6 uzfp3_lakmvr_nouzf.ims lakmvr_nouzf", "END SOLUTIONGROUP 1" ], "uzfp3_lakmvr_nouzf.dis": [ @@ -357,11 +357,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "uzfp3_lakmvr_nouzf.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_v2_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_v2_dev].json index 0b52c6b37..99e8552a0 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_v2_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_lakmvr_v2_dev].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 uzfp3_lakmvr_v2.ims uzfp3_lakmvr", " MXITER 1", + " IMS6 uzfp3_lakmvr_v2.ims uzfp3_lakmvr", "END SOLUTIONGROUP 1" ], "sfr.obs": [ @@ -438,11 +438,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "uzfp3_lakmvr_v2.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_wellakmvr_v2].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_wellakmvr_v2].json index fe4f09c52..46e0f07cb 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_wellakmvr_v2].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest051_uzfp3_wellakmvr_v2].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 uzfp3_lakmvr_v2.ims uzfp3_lakmvr", " MXITER 1", + " IMS6 uzfp3_lakmvr_v2.ims uzfp3_lakmvr", "END SOLUTIONGROUP 1" ], "sfr.obs": [ @@ -449,11 +449,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "uzfp3_lakmvr_v2.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest052_uzf_3col].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest052_uzf_3col].json index 5e40ffead..24b6e0972 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest052_uzf_3col].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest052_uzf_3col].json @@ -185,8 +185,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mf6.ims mf6", " MXITER 1", + " IMS6 mf6.ims mf6", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-a].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-a].json index 419e18a11..3a70fa72e 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-a].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-a].json @@ -195,8 +195,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mf6.ims mf6", " MXITER 1", + " IMS6 mf6.ims mf6", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-a_mfusg].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-a_mfusg].json index afcae08c2..5d752a31b 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-a_mfusg].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-a_mfusg].json @@ -197,8 +197,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mf6.ims mf6", " MXITER 1", + " IMS6 mf6.ims mf6", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-b].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-b].json index 3ac3ac465..23a9862ee 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-b].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-b].json @@ -198,8 +198,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mf6.ims mf6", " MXITER 1", + " IMS6 mf6.ims mf6", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-b_mfusg].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-b_mfusg].json index 5d7b5cd50..07d4efbd6 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-b_mfusg].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest053_npf-b_mfusg].json @@ -199,8 +199,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mf6.ims mf6", " MXITER 1", + " IMS6 mf6.ims mf6", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest054_xt3d_whirlsA].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest054_xt3d_whirlsA].json index 5f9000326..d2f6af9e5 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest054_xt3d_whirlsA].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest054_xt3d_whirlsA].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest054_xt3d_whirlsB].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest054_xt3d_whirlsB].json index 1067ad468..29d96aa0b 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest054_xt3d_whirlsB].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest054_xt3d_whirlsB].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest054_xt3d_whirlsC].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest054_xt3d_whirlsC].json index c26d242de..cc40ed948 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest054_xt3d_whirlsC].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest054_xt3d_whirlsC].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest055_xt3d_lvda-doc-test1].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest055_xt3d_lvda-doc-test1].json index c22dd48e3..33d51a97b 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest055_xt3d_lvda-doc-test1].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest055_xt3d_lvda-doc-test1].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.chd": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest056_mt3dms_usgs_gwtex_IR_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest056_mt3dms_usgs_gwtex_IR_dev].json index c63a3c72a..f66f379be 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest056_mt3dms_usgs_gwtex_IR_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest056_mt3dms_usgs_gwtex_IR_dev].json @@ -320,8 +320,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mf6-gwt.ims m1", " MXITER 1", + " IMS6 mf6-gwt.ims m1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest056_mt3dms_usgs_gwtex_dev].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest056_mt3dms_usgs_gwtex_dev].json index 5ce10ca79..79d9f0ec2 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest056_mt3dms_usgs_gwtex_dev].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest056_mt3dms_usgs_gwtex_dev].json @@ -299,8 +299,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mf6-gwt.ims m1", " MXITER 1", + " IMS6 mf6-gwt.ims m1", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest057_transientchd].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest057_transientchd].json index 5fc3e1626..c603c1e29 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest057_transientchd].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest057_transientchd].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest059_mvlake_lak_ss].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest059_mvlake_lak_ss].json index 6e838c833..e36827646 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest059_mvlake_lak_ss].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest059_mvlake_lak_ss].json @@ -21,8 +21,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 mv.ims mv", " MXITER 1", + " IMS6 mv.ims mv", "END SOLUTIONGROUP 1" ], "mv.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest061_csub_holly].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest061_csub_holly].json index ed22b636b..2cb551db5 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest061_csub_holly].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest061_csub_holly].json @@ -237,7 +237,7 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " TRANSIENT", + " TRANSIENT", "END PERIOD 1" ], "holly.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest061_csub_jacob].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest061_csub_jacob].json index 7f132ae32..ab3fb7400 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest061_csub_jacob].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest061_csub_jacob].json @@ -185,11 +185,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " STEADY-STATE", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " TRANSIENT", + " TRANSIENT", "END PERIOD 2" ], "fig4_base.tdis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest100_ss_ic].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest100_ss_ic].json index 4b0dfd89c..6bbfc3e78 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest100_ss_ic].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest100_ss_ic].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test1ss_ic.ims test1ss_ic", " MXITER 1", + " IMS6 test1ss_ic.ims test1ss_ic", "END SOLUTIONGROUP 1" ], "test1ss_ic.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest101_fhb].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest101_fhb].json index 466e48d0d..b095c6e3e 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest101_fhb].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest101_fhb].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 test_fhb.ims test_fhb", " MXITER 1", + " IMS6 test_fhb.ims test_fhb", "END SOLUTIONGROUP 1" ], "test_fhb.dis": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest102_wel_mvr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest102_wel_mvr].json index 809352219..06ee591d2 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest102_wel_mvr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest102_wel_mvr].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 welmvr.ims welmvr", " MXITER 1", + " IMS6 welmvr.ims welmvr", "END SOLUTIONGROUP 1" ], "wel.obs": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest103_drn_mvr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest103_drn_mvr].json index ea1dbeea4..614cde2b8 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest103_drn_mvr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest103_drn_mvr].json @@ -226,8 +226,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 drnmvr.ims drnmvr", " MXITER 1", + " IMS6 drnmvr.ims drnmvr", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest104_riv_mvr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest104_riv_mvr].json index e9259809a..c097185b9 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest104_riv_mvr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest104_riv_mvr].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 rivmvr.ims rivmvr", " MXITER 1", + " IMS6 rivmvr.ims rivmvr", "END SOLUTIONGROUP 1" ], "riv.obs": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest105_ghb_mvr].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest105_ghb_mvr].json index 750048cdb..902d3a68d 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest105_ghb_mvr].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest105_ghb_mvr].json @@ -237,8 +237,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 ghbmvr.ims ghbmvr", " MXITER 1", + " IMS6 ghbmvr.ims ghbmvr", "END SOLUTIONGROUP 1" ] } diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest106_tsnodata].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest106_tsnodata].json index 4d640679c..022b298c4 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest106_tsnodata].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest106_tsnodata].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.dis": [ @@ -133,11 +133,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " steady-state", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " transient", + " TRANSIENT", "END PERIOD 2" ], "model.wel": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest106_tsnodataalt_model].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest106_tsnodataalt_model].json index 7586b6576..3170044d6 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest106_tsnodataalt_model].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest106_tsnodataalt_model].json @@ -15,8 +15,8 @@ "END EXCHANGES", "", "BEGIN SOLUTIONGROUP 1", - " IMS6 model.ims GWF_1", " MXITER 1", + " IMS6 model.ims GWF_1", "END SOLUTIONGROUP 1" ], "model.dis": [ @@ -133,11 +133,11 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " steady-state", + " STEADY-STATE", "END PERIOD 1", "", "BEGIN PERIOD 2", - " transient", + " TRANSIENT", "END PERIOD 2" ], "model.wel": [ diff --git a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest205_gwtbuy-henrytidal].json b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest205_gwtbuy-henrytidal].json index 2506fb53c..e3eb55b10 100644 --- a/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest205_gwtbuy-henrytidal].json +++ b/test/mf6/__snapshots__/test_mf6_io_roundtrip/test_roundtrip[mf6testtest205_gwtbuy-henrytidal].json @@ -8835,7 +8835,7 @@ "END GRIDDATA", "", "BEGIN PERIOD 1", - " TRANSIENT", + " TRANSIENT", "END PERIOD 1" ], "gwf_henry.wel": [ diff --git a/test/mf6/test_mf6_codec.py b/test/mf6/test_mf6_codec.py index aed07e987..7b3258885 100644 --- a/test/mf6/test_mf6_codec.py +++ b/test/mf6/test_mf6_codec.py @@ -390,18 +390,18 @@ def test_dumps_sto(): sto = Sto( stress_period_data={ - 0: [("TRANSIENT",)], - 1: [("STEADY-STATE",)], - 2: [("TRANSIENT",)], + 0: "transient", + 1: "steady-state", + 2: "transient", } ) dumped = dumps(COMPONENT_CONVERTER.unstructure(sto)) print("STO dump:") print(dumped) - assert "BEGIN PERIOD 1\n TRANSIENT" in dumped - assert "BEGIN PERIOD 2\n STEADY-STATE" in dumped - assert "BEGIN PERIOD 3\n TRANSIENT" in dumped + assert "BEGIN PERIOD 1\n TRANSIENT" in dumped + assert "BEGIN PERIOD 2\n STEADY-STATE" in dumped + assert "BEGIN PERIOD 3\n TRANSIENT" in dumped assert dumped loaded = loads(dumped) @@ -2114,9 +2114,9 @@ def test_dumps_tas_inner_classes(): unstructured = COMPONENT_CONVERTER.unstructure(tas) assert "attributes" in unstructured - assert unstructured["attributes"]["time_series_name"] == ("NAME", "my_ts") - assert unstructured["attributes"]["interpolation_method"] == ("METHOD", "linear") - assert unstructured["attributes"]["sfac"] == ("SFAC", 1.5) + assert unstructured["attributes"]["time_series_namerecord"] == ("NAME", "my_ts") + assert unstructured["attributes"]["interpolation_methodrecord"] == ("METHOD", "linear") + assert unstructured["attributes"]["sfacrecord"] == ("SFAC", 1.5) dumped = dumps(unstructured) assert "BEGIN ATTRIBUTES" in dumped @@ -2135,8 +2135,8 @@ def test_dumps_tas_inner_classes_multi_value(): ) unstructured = COMPONENT_CONVERTER.unstructure(tas) - assert unstructured["attributes"]["time_series_name"] == ("NAME", "ts-2", "ts-3") - assert unstructured["attributes"]["sfac"] == ("SFAC", 1.5, 2.0) + assert unstructured["attributes"]["time_series_namerecord"] == ("NAME", "ts-2", "ts-3") + assert unstructured["attributes"]["sfacrecord"] == ("SFAC", 1.5, 2.0) dumped = dumps(unstructured) assert "NAME ts-2 ts-3" in dumped @@ -2806,8 +2806,8 @@ def test_oc_period_string_int_keys(): pb_str = _period_blocks(oc_str) assert pb_int == pb_str - assert pb_int["period 1"]["period"] == [("SAVE", "BUDGET", "ALL")] - assert pb_int["period 2"]["period"] == [("SAVE", "BUDGET", "LAST")] + assert pb_int["period 1"]["stress_period_data"] == [("SAVE", "BUDGET", "ALL")] + assert pb_int["period 2"]["stress_period_data"] == [("SAVE", "BUDGET", "LAST")] # No fill-forward: period 3 was not specified so it produces no block. assert "period 3" not in pb_int @@ -2825,7 +2825,10 @@ def test_oc_period_wildcard_fillforward(): assert len(pb) == 4 for i in range(1, 5): - assert pb[f"period {i}"]["period"] == [("SAVE", "HEAD", "ALL"), ("SAVE", "BUDGET", "LAST")] + assert pb[f"period {i}"]["stress_period_data"] == [ + ("SAVE", "HEAD", "ALL"), + ("SAVE", "BUDGET", "LAST"), + ] def test_oc_period_steps_syntax(): @@ -2841,11 +2844,11 @@ def test_oc_period_steps_syntax(): ) pb = _period_blocks(oc) - assert ("SAVE", "BUDGET", "STEPS", 1, 3, 5) in pb["period 1"]["period"] - assert ("PRINT", "BUDGET", "STEPS", 1) in pb["period 1"]["period"] + assert ("SAVE", "BUDGET", "STEPS", 1, 3, 5) in pb["period 1"]["stress_period_data"] + assert ("PRINT", "BUDGET", "STEPS", 1) in pb["period 1"]["stress_period_data"] # no fill-forward: period 2 doesn't re-emit SAVE BUDGET - assert not any(t[:2] == ("SAVE", "BUDGET") for t in pb["period 2"]["period"]) - assert ("PRINT", "BUDGET", "LAST") in pb["period 2"]["period"] + assert not any(t[:2] == ("SAVE", "BUDGET") for t in pb["period 2"]["stress_period_data"]) + assert ("PRINT", "BUDGET", "LAST") in pb["period 2"]["stress_period_data"] def test_oc_period_stop_sentinel(): @@ -2866,11 +2869,11 @@ def test_oc_period_stop_sentinel(): assert len(pb) == 3 for i in range(1, 4): - assert ("SAVE", "HEAD", "ALL") in pb[f"period {i}"]["period"] + assert ("SAVE", "HEAD", "ALL") in pb[f"period {i}"]["stress_period_data"] - assert ("SAVE", "BUDGET", "STEPS", 1) in pb["period 1"]["period"] - assert not any(t[:2] == ("SAVE", "BUDGET") for t in pb["period 2"]["period"]) - assert not any(t[:2] == ("SAVE", "BUDGET") for t in pb["period 3"]["period"]) + assert ("SAVE", "BUDGET", "STEPS", 1) in pb["period 1"]["stress_period_data"] + assert not any(t[:2] == ("SAVE", "BUDGET") for t in pb["period 2"]["stress_period_data"]) + assert not any(t[:2] == ("SAVE", "BUDGET") for t in pb["period 3"]["stress_period_data"]) def test_oc_period_mixed_keys_no_silent_drop(): @@ -2887,9 +2890,9 @@ def test_oc_period_mixed_keys_no_silent_drop(): ) pb = _period_blocks(oc) - assert ("SAVE", "HEAD", "FIRST") in pb["period 1"]["period"] - assert ("SAVE", "HEAD", "LAST") in pb["period 2"]["period"] - assert ("SAVE", "HEAD", "ALL") in pb["period 3"]["period"] + assert ("SAVE", "HEAD", "FIRST") in pb["period 1"]["stress_period_data"] + assert ("SAVE", "HEAD", "LAST") in pb["period 2"]["stress_period_data"] + assert ("SAVE", "HEAD", "ALL") in pb["period 3"]["stress_period_data"] def test_oc_dumps_steps_in_output(): @@ -2933,10 +2936,10 @@ def test_oc_period_frequency(): ) pb = _period_blocks(oc) - assert ("SAVE", "HEAD", "FREQUENCY", 2) in pb["period 1"]["period"] - assert ("SAVE", "HEAD", "FREQUENCY", 2) in pb["period 2"]["period"] - assert ("SAVE", "HEAD", "FREQUENCY", 2) in pb["period 3"]["period"] - assert ("SAVE", "BUDGET", "ALL") in pb["period 1"]["period"] + assert ("SAVE", "HEAD", "FREQUENCY", 2) in pb["period 1"]["stress_period_data"] + assert ("SAVE", "HEAD", "FREQUENCY", 2) in pb["period 2"]["stress_period_data"] + assert ("SAVE", "HEAD", "FREQUENCY", 2) in pb["period 3"]["stress_period_data"] + assert ("SAVE", "BUDGET", "ALL") in pb["period 1"]["stress_period_data"] # --------------------------------------------------------------------------- @@ -2967,7 +2970,7 @@ def test_lak_period_lake_keywords(): ) pb = _lak_period_blocks(lak) - rows_p1 = pb["period 1"]["period"] + rows_p1 = pb["period 1"]["stress_period_data"] assert (1, "STATUS", "ACTIVE") in rows_p1 # emitted 1-based assert (2, "STATUS", "CONSTANT") in rows_p1 assert (2, "STAGE", 5.0) in rows_p1 @@ -2991,7 +2994,7 @@ def test_lak_period_outlet_keywords(): ) pb = _lak_period_blocks(lak) - rows = pb["period 1"]["period"] + rows = pb["period 1"]["stress_period_data"] assert (1, "RATE", 100.0) in rows # emitted 1-based assert (2, "RATE", 200.0) in rows assert (1, "INVERT", 4.5) in rows @@ -4018,7 +4021,7 @@ def test_lkt_period_keywords(): } ) pb = _lkt_period_blocks(lkt) - rows = pb["period 1"]["period"] + rows = pb["period 1"]["stress_period_data"] assert (1, "STATUS", "ACTIVE") in rows # emitted 1-based assert (2, "STATUS", "CONSTANT") in rows assert (1, "CONCENTRATION", 10.0) in rows @@ -4134,7 +4137,7 @@ def test_lke_period_keywords(): } ) pb = _lke_period_blocks(lke) - rows = pb["period 1"]["period"] + rows = pb["period 1"]["stress_period_data"] assert (1, "STATUS", "ACTIVE") in rows # emitted 1-based assert (2, "STATUS", "CONSTANT") in rows assert (1, "TEMPERATURE", 15.0) in rows diff --git a/test/mf6/test_mf6_codegen.py b/test/mf6/test_mf6_codegen.py index c62347804..a345e3037 100644 --- a/test/mf6/test_mf6_codegen.py +++ b/test/mf6/test_mf6_codegen.py @@ -1241,7 +1241,7 @@ def test_tagged_file_list_is_repeatable_field(tmp_path, all_dfns, monkeypatch): assert "converter=attrs.converters.optional(to_list(Path))," in text -def test_tagged_record_list_roundtrip(tmp_path): +def test_tagged_record_list_roundtrip(tmp_path, monkeypatch): """A tagged list of (non-file) records is a repeatable list[RecordClass] field: generated, loaded one element per line, and written back one line per element. No real DFN has one yet, so a synthetic one.""" @@ -1282,6 +1282,7 @@ def test_tagged_record_list_roundtrip(tmp_path): assert 'class Scale(Item):\n _keyword: ClassVar[str] = "scale"' in text cls = _load_class_from_spec(spec, "gwf_tlst", "Tlst") + _store_dfn(monkeypatch, dfn) pkg = structure_component( loads("BEGIN OPTIONS\n SCALE 2.0\n PRINT_INPUT\n SCALE 3.0\nEND OPTIONS\n"), cls ) @@ -1290,7 +1291,7 @@ def test_tagged_record_list_roundtrip(tmp_path): assert [line for line in lines if line.startswith("SCALE")] == ["SCALE 2.0", "SCALE 3.0"] -def test_union_list_outside_period_roundtrip(tmp_path): +def test_union_list_outside_period_roundtrip(tmp_path, monkeypatch): """A list of unions gets the same arm classes and keyword dispatch in any block, not just the period block. No real DFN has one outside the period block yet, so a synthetic one.""" @@ -1335,6 +1336,7 @@ def arm(name): assert "settings: Optional[list[_SettingsItem]]" in spec.outpath.read_text() cls = _load_class_from_spec(spec, "gwf_ulst", "Ulst") + _store_dfn(monkeypatch, dfn) pkg = structure_component( loads("BEGIN OPTIONS\n RATE 2.0\n PRINT_INPUT\n STAGE 3.0\nEND OPTIONS\n"), cls ) @@ -1410,6 +1412,15 @@ def test_griddata_list_and_layered_values(): assert npf.k.shape == (6,) +def _store_dfn(monkeypatch, dfn) -> None: + """Store a synthetic DFN beside the classes', as sync stores theirs: + the converter reads block structure from it (see `spec.dfn`).""" + from flopy4.mf6 import spec + + stored = {**spec._dfns(), dfn.name: dfn} + monkeypatch.setattr(spec, "_dfns", lambda: stored) + + def _load_class_from_spec(spec, mod_name: str, expected_class: str): """Generate, load, and return the class from a ComponentSpec. Cleans up module state.""" mod_spec = importlib.util.spec_from_file_location(mod_name, spec.outpath) diff --git a/test/mf6/test_mf6_component.py b/test/mf6/test_mf6_component.py index 4b559fcf4..3d90371c6 100644 --- a/test/mf6/test_mf6_component.py +++ b/test/mf6/test_mf6_component.py @@ -779,7 +779,7 @@ def test_load_several_solution_groups(function_tmpdir): text += f"\nBEGIN SOLUTIONGROUP 2\n{second}\nEND SOLUTIONGROUP 2\n" nam.write_text(text) - with pytest.raises(ValueError, match="more than one solution group"): + with pytest.raises(ValueError, match="more than one solutiongroup block"): Simulation.load(nam) diff --git a/test/mf6/test_mf6_dfn.py b/test/mf6/test_mf6_dfn.py new file mode 100644 index 000000000..ab4f1d8e2 --- /dev/null +++ b/test/mf6/test_mf6_dfn.py @@ -0,0 +1,161 @@ +"""The DFNs sync stores with the classes, and what the converter reads from +them: each class's DFN, the attribute holding each DFN field, and how a +block's rows find their fields. These read the stored DFNs, not the ones +CI downloads, so they hold for the classes as generated.""" + +import importlib + +import pytest + +from flopy4.mf6 import spec +from flopy4.mf6.gwf.chd import Chd +from flopy4.mf6.gwf.oc import Oc +from flopy4.mf6.gwf.rcha import Rcha +from flopy4.mf6.gwf.sto import Sto +from flopy4.mf6.simulation import Simulation +from flopy4.mf6.utils.codegen import filters +from flopy4.mf6.utils.codegen.make import _component_module +from flopy4.mf6.utl.tas import Tas +from flopy4.mf6.utl.ts import Ts + + +def _classes(): + for name in spec._dfns(): + try: + module = importlib.import_module(_component_module(name)) + except ImportError: + continue + if (cls := getattr(module, filters.class_name(name), None)) is not None: + yield name, cls + + +CLASSES = dict(_classes()) + + +def test_stored_dfns_cover_classes(): + assert CLASSES + for name, cls in CLASSES.items(): + assert spec.dfn(cls).name == name == cls.dfn_name + + +@pytest.fixture(scope="module") +def whole_set(): + """The stored DFNs as devtools loads them, all at once, checking the + relations between them, which the converter's lazy loads skip.""" + from modflow_devtools.dfns import LocalDfnRegistry + + from flopy4.mf6._sync import _DFN_SCHEMA_VERSION + + registry = LocalDfnRegistry(path=spec._stored_dfns()) + return registry.spec(schema_version=_DFN_SCHEMA_VERSION).components + + +def test_lazy_dfns_match_whole_set(whole_set): + """Each DFN loaded alone is the one devtools loads in the whole set, + and its header has the same top-level keys.""" + stored = spec._dfns() + assert sorted(stored) == sorted(whole_set) + for name, component in whole_set.items(): + assert stored[name] == component, name + header = stored.headers[name] + for key in spec.DfnHeader._fields: + # only packages have multi + default = False if key == "multi" else None + assert getattr(header, key) == getattr(component, key, default), (name, key) + + +@pytest.mark.parametrize("name", sorted(CLASSES)) +def test_attr_names_from_headers(name, whole_set): + """Codegen names the same attributes resolving links by the lazy + loader's headers as by the whole set.""" + from flopy4.mf6.utils.codegen.make import attr_names + + cls = CLASSES[name] + assert spec.attr_names(cls) == attr_names(whole_set[name], whole_set) + + +@pytest.mark.parametrize("name", sorted(CLASSES)) +def test_attr_names(name): + """Every DFN field codegen made an attribute for maps to it, and every + attribute holds a DFN field, except a model's package slots (one per + package type, all from the name file's package list).""" + cls = CLASSES[name] + names = spec.attr_names(cls) + fields = spec.fields_dict(cls) + for key, attr in names.items(): + assert attr in fields or isinstance(getattr(cls, attr, None), property), key + unmapped = {a for a, f in fields.items() if a not in names.values()} + if filters.is_model_nam(name): + assert all(fields[a].metadata["block"] == "packages" for a in unmapped) + else: + assert not unmapped + + +@pytest.mark.parametrize("name", sorted(CLASSES)) +def test_block_keys(name): + """A block's untagged field, if any, is its last; a keyword leading + more than one field's rows is told apart by the next one.""" + cls = CLASSES[name] + for block in spec.dfn(cls).blocks or {}: + keys = spec.block_keys(cls, block) + fields = [f for b, f in filters.flat_fields(spec.dfn(cls)) if b == block] + if keys.untagged is not None: + assert fields[-1] is keys.untagged, block + assert sum(not getattr(f, "tagged", True) for f in fields) == 1, block + for tag, shared in keys.tagged.items(): + if len(shared) > 1: + following = [tuple(spec.following_tags(f)) for f in shared] + assert all(following) and len(set(following)) == len(following), (block, tag) + + +@pytest.mark.parametrize("name", sorted(CLASSES)) +def test_block_order(name): + """Options, then dimensions, come before every other block, so a load + reading blocks in DFN order has the auxiliary names, switches and + sizes before the blocks read by them.""" + blocks = list(spec.dfn(CLASSES[name]).blocks or {}) + first = [b for b in ("options", "dimensions") if b in blocks] + assert blocks[: len(first)] == first + + +def test_attr_names_examples(): + assert spec.attr_names(Oc)[("options", "head_filerecord")] == "head_file" + assert spec.attr_names(Oc)[("options", "headprintrecord")] == "headprint" + assert spec.attr_names(Oc)[("period", "stress_period_data")] == "_period_data" + assert spec.attr_names(Chd)[("options", "ts_filerecord")] == "ts" + assert spec.attr_names(Chd)[("dimensions", "maxbound")] == "maxbound" + assert spec.attr_names(Sto)[("period", "stress_period_data")] == "period_data" + assert spec.attr_names(Rcha)[("period", "aux")] == "aux" + assert spec.attr_names(Tas)[("time", "tas_array")] == "tas_array" + assert spec.attr_names(Simulation)[("solutiongroup", "solutiongroup")] == "solutiongroup" + + +def test_shared_keyword(): + head = spec.block_keys(Oc, "options").tagged["head"] + assert [f.name for f in head] == ["head_filerecord", "headprintrecord"] + assert [spec.following_tags(f) for f in head] == [["fileout"], ["print_format"]] + # no clash between a record and another field: TS's SFAC and SFACS + sfac = spec.block_keys(Ts, "attributes").tagged + assert [f.name for f in sfac["sfac"]] == ["sfacrecord_single"] + assert [f.name for f in sfac["sfacs"]] == ["sfacrecord"] + + +def test_headers_and_untagged(): + dfn = spec.dfn(Simulation) + assert dfn.blocks["solutiongroup"].header.field.name == "group_num" + group = spec.block_keys(Simulation, "solutiongroup") + assert group.untagged.name == "solutiongroup" + assert set(group.tagged) == {"mxiter"} + assert spec.dfn(Tas).blocks["time"].header.field.type == "double" + assert spec.block_keys(Tas, "time").untagged.name == "tas_array" + period = spec.block_keys(Oc, "period") + assert spec.dfn(Oc).blocks["period"].header.fill_forward + assert period.untagged is None # OC's output is a tagged list + assert set(period.tagged) == {"save", "print"} + + +def test_dynamic_keys(): + period = spec.block_keys(Rcha, "period") + assert {path: f.name for path, f in period.dynamic.items()} == {"options.auxiliary": "aux"} + assert set(period.tagged) == {"irch", "recharge"} + assert period.untagged is None diff --git a/test/mf6/test_mf6_external_arrays.py b/test/mf6/test_mf6_external_arrays.py index 11bccdd47..aa4287350 100644 --- a/test/mf6/test_mf6_external_arrays.py +++ b/test/mf6/test_mf6_external_arrays.py @@ -260,6 +260,84 @@ def test_shared_outside_file_copied_once(tmp_path): assert (out / "rch_1.txt").read_text().split() == ["0.2"] * 4 +@pytest.fixture +def scaled_rcha(tmp_path): + """RCHA periods 1 and 2 from one file, scaled by different FACTORs.""" + ws = tmp_path / "ws" + ws.mkdir() + (ws / "rch.txt").write_text("1.0 2.0 3.0 4.0\n") + (ws / "m.rcha").write_text( + textwrap.dedent("""\ + BEGIN OPTIONS + READASARRAYS + END OPTIONS + BEGIN PERIOD 1 + RECHARGE + OPEN/CLOSE rch.txt FACTOR 0.5 + END PERIOD 1 + BEGIN PERIOD 2 + RECHARGE + OPEN/CLOSE rch.txt FACTOR 2.0 IPRN 1 + END PERIOD 2 + """) + ) + rcha = Rcha.load(ws / "m.rcha", dims={"nlay": 1, "nodes": 4}, context=LoadContext(workspace=ws)) + out = tmp_path / "out" + out.mkdir() + rcha.filename = str(out / "out.rcha") + return rcha + + +def test_load_applies_factor(scaled_rcha): + """The values are scaled by the FACTOR, which isn't kept.""" + assert np.ravel(scaled_rcha.recharge[0]).tolist() == [0.5, 1.0, 1.5, 2.0] + assert np.ravel(scaled_rcha.recharge[1]).tolist() == [2.0, 4.0, 6.0, 8.0] + io = scaled_rcha.write_context.arrays[("recharge", 1)] + assert io == ArrayIO(iprn=1, path=Path("rch.txt"), format="open/close", layered=False) + assert io.hash == array_hash([2.0, 4.0, 6.0, 8.0]) + + +def test_factored_shared_file_inlined(scaled_rcha): + """Periods scaling one file by different factors hold different + values, so can't share it: they're written inline.""" + with pytest.warns(UserWarning, match="hold different values; writing them inline"): + scaled_rcha.write() + assert _lines(scaled_rcha.path, "OPEN/CLOSE") == [] + assert not (scaled_rcha.path.parent / "rch.txt").exists() + + +def test_factored_shared_file_apart(scaled_rcha): + """With an "open/close" `array_format`, they're each written to a file + of their own instead, and load back the same.""" + with pytest.warns(UserWarning, match="writing .*period 1 to out_rcha_recharge_p1.txt"): + scaled_rcha.write(context=WriteContext(array_format="open/close")) + assert _lines(scaled_rcha.path, "OPEN/CLOSE") == [ + "OPEN/CLOSE out_rcha_recharge_p1.txt", + "OPEN/CLOSE out_rcha_recharge_p2.txt IPRN 1", + ] + out = scaled_rcha.path.parent + assert not (out / "rch.txt").exists() + dims = {"nlay": 1, "nodes": 4} + again = Rcha.load(scaled_rcha.path, dims=dims, context=LoadContext(workspace=out)) + for kper in (0, 1): + assert np.array_equal(again.recharge[kper], scaled_rcha.recharge[kper]) + + +def test_edited_array_apart(shared_rcha): + """Of arrays sharing a file, one edited since loaded goes to a file of + its own with an "open/close" `array_format`; the others keep it.""" + shared_rcha.recharge[0][:] = 0.5 + with pytest.warns(UserWarning, match="period 1 changed since loaded"): + shared_rcha.write(context=WriteContext(array_format="open/close")) + assert _lines(shared_rcha.path, "OPEN/CLOSE") == [ + "OPEN/CLOSE out_rcha_recharge_p1.txt", + "OPEN/CLOSE rch.txt", + ] + out = shared_rcha.path.parent + assert (out / "out_rcha_recharge_p1.txt").read_text().split() == ["0.5"] * 4 + assert (out / "rch.txt").read_text().split() == ["0.1"] * 4 + + _HEADER = struct.Struct(" dict: + from modflow_devtools.dfns import LocalDfnRegistry + + return LocalDfnRegistry(path=path).spec(schema_version="2.0.0.dev3").components + + +def test_dfns_stored(dfn_path, outdir): + """Sync stores the source's DFNs as TOML, replacing ones it no longer has.""" stored = outdir / "dfns" - stored.mkdir(exist_ok=True) - (stored / "gwf-chd.toml").write_text("") + assert {f.name for f in stored.iterdir()} == { + f"{f.stem}.toml" for f in dfn_path.glob("*.dfn") if f.stem not in ("common", "flopy") + } + (stored / "gwf-zzz.toml").write_text("") + (stored / "gwf-chd.dfn").write_text("") sync(dfn_path, mf6_version="6.9.0", outdir=outdir) - assert not stored.exists() + assert not (stored / "gwf-zzz.toml").exists() + assert not (stored / "gwf-chd.dfn").exists() + + +def test_stored_dfns_lossless(dfn_path, outdir): + """The stored TOML loads to the same spec as the source DFNs.""" + source = _components(dfn_path) + stored = _components(outdir / "dfns") + assert source.keys() == stored.keys() + assert [k for k in source if source[k] != stored[k]] == [] + + +def test_resync_from_stored_dfns(outdir, tmp_path): + """Syncing from the stored TOML reproduces the classes, and copies it.""" + before = _snapshot(outdir) + toml = Path(shutil.copytree(outdir / "dfns", tmp_path / "toml")) + sync(toml, mf6_version="6.9.0", outdir=outdir) + after = _snapshot(outdir) + # the copy isn't in a git checkout, so the contract's commit may differ + del after["_contract.py"], before["_contract.py"] + assert after == before + for f in toml.iterdir(): + assert (outdir / "dfns" / f.name).read_bytes() == f.read_bytes() + + +def test_installed_dfns_match_classes(tmp_path): + """The DFNs stored in the package are the ones its classes came from: + regenerating from them changes no class or grammar.""" + installed = Path(flopy4.mf6.__file__).parent + outdir = Path( + shutil.copytree(installed, tmp_path / "mf6", ignore=shutil.ignore_patterns("__pycache__")) + ) + toml = Path(shutil.copytree(installed / "dfns", tmp_path / "toml")) + before = _snapshot(outdir) | _grammars(outdir) + sync(toml, mf6_version="6.9.0", outdir=outdir) + after = _snapshot(outdir) | _grammars(outdir) + del after["_contract.py"], before["_contract.py"] + assert after == before def test_resync_from_toml(dfn_path, outdir, tmp_path): From 873767637b9e03b293d0bf3810e29dd257fdcfa9 Mon Sep 17 00:00:00 2001 From: wpbonelli Date: Thu, 5 Nov 2026 10:46:11 -0800 Subject: [PATCH 2/8] Move the loader comparison off this branch The report compares against a typed loader that isn't here, so it moves to typed-loader. Restore develop's load-benchmarks.md, which said that loader could be used. Co-Authored-By: Claude Opus 5.5 --- docs/dev/converter-simplification-plan.md | 16 +-- docs/dev/load-benchmarks.md | 11 +- docs/dev/loader-comparison.md | 158 ---------------------- 3 files changed, 13 insertions(+), 172 deletions(-) delete mode 100644 docs/dev/loader-comparison.md diff --git a/docs/dev/converter-simplification-plan.md b/docs/dev/converter-simplification-plan.md index a45605e70..ac9770cf9 100644 --- a/docs/dev/converter-simplification-plan.md +++ b/docs/dev/converter-simplification-plan.md @@ -98,11 +98,10 @@ green when it landed. Phases B (typed load, B1-B4) and C (comparing the loaders) were built here and moved off in the 2026-11-05 rebase. They're on `typed-loader-parked`, to be rebuilt on a `typed-loader` branch stacked on this one, with the -develop changes this rebase ported into `_Load` ported there too. That -branch doesn't exist yet. `typed.lark`, the generated grammars, `loads_typed` -and `_check_typed_grammar` here are `develop`'s, unchanged. C's results, -from before the rebase, are in -[`loader-comparison.md`](loader-comparison.md). +develop changes this rebase ported into `_Load` ported there too. +`typed.lark`, the generated grammars, `loads_typed` and +`_check_typed_grammar` here are `develop`'s, unchanged. C's results, from +before the rebase, are in `loader-comparison.md` on `typed-loader`. ### D: cleanups from the post-C audit @@ -214,7 +213,8 @@ rest on. They were re-scanned 2026-10-19 over the modflow6 DFNs at - cold start: the first load took 0.26 s against 0.21 s. That's the stored DFNs the model needs plus building codegen's spec for `attr_names` (see "Later"). -- **Phase C:** the typed loader's numbers are in `loader-comparison.md`. +- **Phase C:** the typed loader's numbers are in `loader-comparison.md` on + `typed-loader`. ## devtools follow-ups @@ -227,8 +227,8 @@ rest on. They were re-scanned 2026-10-19 over the modflow6 DFNs at Each is its own change. -- **Deleting a loader**, if decided (see `loader-comparison.md`). Deleting the basic loader - takes the stored DFNs with it, once egress reads the classes' fields. +- **Deleting a loader**, if decided (see `loader-comparison.md` on + `typed-loader`). Deleting the basic loader takes the stored DFNs with it, once egress reads the classes' fields. The size at stake: - typed: ~360 code lines, ~1,300 with grammar generation and templates, plus 6,581 lines of generated grammars; diff --git a/docs/dev/load-benchmarks.md b/docs/dev/load-benchmarks.md index 7b18867b7..f01b04314 100644 --- a/docs/dev/load-benchmarks.md +++ b/docs/dev/load-benchmarks.md @@ -22,14 +22,12 @@ manifest. | level | flopy3 | flopy4 basic | flopy4 typed | suite | |---|---|---|---|---| -| full simulation load | `MFSimulation.load` | `Simulation.load` | `Simulation.load(..., loader="typed")` | `test_load.py` | +| full simulation load | `MFSimulation.load` | `Simulation.load` | **not possible yet** | `test_load.py` | | parse stage (parse + transform) | n/a | yes | yes | `test_parse.py` | -When this baseline was taken, typed parser output wasn't wired into -`structure.py`, so the typed loader appeared at the parse stage only. It -now loads every component (`--loader typed`), and the load benchmarks run -it as `flopy4-typed`; the two loaders are compared in -[`loader-comparison.md`](loader-comparison.md). +Typed parser output isn't wired into `structure.py`, so there's no full typed +load to time. The typed loader appears here at the parse stage only. It gets a +column in the first row once it's wired in. There are two benchmark modules, both opt-in pytest-benchmark modules under `benchmarks/` (`pixi run -e dev bench` runs both): @@ -329,6 +327,7 @@ directly. ## Not measured yet +- **A full typed load**, which doesn't exist yet (see above). - **The 74 excluded models.** flopy4 skips DISU, TS/OBS and other child files. Once it loads them, those models can join the corpus, but that changes the pinned set, so it needs a fresh baseline. diff --git a/docs/dev/loader-comparison.md b/docs/dev/loader-comparison.md deleted file mode 100644 index 6605b2eef..000000000 --- a/docs/dev/loader-comparison.md +++ /dev/null @@ -1,158 +0,0 @@ -# flopy4's two loaders, compared - -Phase C of the [converter simplification plan](converter-simplification-plan.md): -the basic loader (Track A: one generic grammar, block structure read from -the stored DFNs at runtime) against the typed loader (Track B: a grammar -generated per component, values read by the classes' fields alone). Both -stay, with `loader="basic" | "typed"` (the tests' `--loader`) choosing -between them; deleting one is a separate decision. - -Measured 2026-10-21 at `721503fe`, on an Apple M2 Max (macOS, CPython -3.11.16), standard benchmark tier (9 models, 15.1 MB of input). - -## Summary - -| | basic | typed | -|---|---|---| -| correctness (round-trip suite, load snapshots) | passes | passes but `test1001_Peterson`, a basic-loader bug | -| load + materialize, all models | 0.254 s | 0.318 s (1.25×) | -| peak memory, load | — | 0.97–1.81× basic's; most models within 3%, two 1.7–1.8× | -| cold start, first load | 0.265 s | 0.32–0.33 s with the grammar cache warm, 0.62 s without | -| malformed files | lenient: loads most, warning or silently | strict: a missing `END` or wrong value type raises, with line and column | -| code only it needs | ~450 lines (~570 with the DFN accessor egress shares), plus 129 stored DFNs (1.4 MB) | ~1,300 lines with the grammar templates, plus 129 generated grammars (6,581 lines) | - -**Recommendation:** keep basic as the default and typed as the opt-in. -The basic loader is faster, smaller and lighter on memory; the typed -loader's advantages are stricter errors and no DFN at runtime, and the -first can be had in the basic loader for less (see "Errors"). Before -deciding to delete either, look into the typed loader's memory on -`test016_Keating_dev` and `test045_lake4ss_dev`, which wasn't investigated -here, and fix the error-reporting gaps both share. - -## Correctness - -Both pass the round-trip suite (load → write → load over the corpus) and -produce the same load snapshots, but one: under `--loader typed`, 257 of -258 load snapshots pass. `test1001_Peterson` differs in IMS's -`rclose_option`, a string written `50000.000`: the typed loader keeps the -word, the basic loader reads it as the number `50000.0`. The basic -loader's is the bug (its parse reads numbers before the converter knows -the field), and the snapshot pins it. `test060_gms_ets` loads under -neither. Rerun at `721503fe`: - - pixi run -e dev pytest test/mf6/test_mf6_io_roundtrip.py \ - test/mf6/test_mf6_load_all_models.py --loader typed - -## Load time and memory - -`pixi run -e dev bench -k load` and `pixi run -e dev bench-memory -k -test_load`, which now run `flopy4-typed` beside `flopy3` and `flopy4` -(`benchmarks/_ops.py`, `LOADS`); `benchmarks/report.py` has a "Loaders, -basic vs. typed" section. Times are the minimum of 3 rounds; memory is -peak heap (memray). Ratios are typed / basic. - -| benchmark | basic | typed | × | -|---|---:|---:|---:| -| load, all models | 0.205 s | 0.273 s | 1.33 | -| load + materialize, all models | 0.254 s | 0.318 s | 1.25 | - -| model | input MB | load+mat basic | typed | × | load memory, MiB | × | -|---|---:|---:|---:|---:|---:|---:| -| test001a_Tharmonic | 0.003 | 0.00309 | 0.00433 | 1.40 | 0.167 / 0.162 | 0.97 | -| test001a_Tharmonic_extlist | 0.003 | 0.00328 | 0.00464 | 1.42 | 0.077 / 0.096 | 1.26 | -| test028_sfr | 0.021 | 0.00994 | 0.0122 | 1.23 | 0.269 / 0.277 | 1.03 | -| test045_lake4ss_dev | 0.299 | 0.0100 | 0.0149 | 1.48 | 0.500 / 0.841 | 1.68 | -| test050_circle_island | 0.551 | 0.0584 | 0.0769 | 1.32 | 4.33 / 4.24 | 0.98 | -| test120_mv_dis-lgr | 0.735 | 0.0162 | 0.0243 | 1.50 | 1.17 / 1.43 | 1.22 | -| test033_wtdecay | 1.18 | 0.0121 | 0.0154 | 1.27 | 3.59 / 3.61 | 1.01 | -| test016_Keating_dev | 1.47 | 0.0265 | 0.0450 | 1.70 | 2.85 / 5.15 | 1.81 | -| test019_VilhelmsenGF | 10.8 | 0.110 | 0.117 | 1.06 | 36.2 / 36.3 | 1.00 | - -The typed loader is slower on every model, by 6% (the largest, where -reading array values dominates and both share the code) to 70%. Peak -memory is about the same where arrays dominate, and up to 1.8× where -they don't. Against flopy3, flopy4 stays ahead with either loader: typed -load + materialize is 3.3× faster over the tier (basic, 4.2×). - -## Cold start - -A fresh interpreter importing flopy4, then loading and materializing -`test050_circle_island` (`benchmarks/_worker.py cold`), three alternating -runs each. The import is the same for both (~0.8 s); the first load: - -| | first load | -|---|---:| -| basic | 0.265–0.268 s | -| typed, grammar cache warm (the usual case) | 0.321–0.332 s | -| typed, no cache (`FLOPY4_CACHE_DIR=`) | 0.617–0.635 s | - -The basic loader's first load includes loading the 10 DFNs this -simulation needs and building codegen's spec of each class for -`attr_names`; the typed loader's, reading (or building) a parser per -component. With no cache, the typed loader builds each grammar, which -happens once per machine and lark/Python version. In the benchmark run's -`test_cold_start` (wall time, five rounds), flopy3 took 1.04 s, flopy4 -1.16 s basic and 1.24 s typed. - -## Errors - -Seven malformed copies of `test001a_Tharmonic`, one fault each, loaded -with both loaders: - -| fault | basic | typed | -|---|---|---| -| missing `END OPTIONS` (CHD) | loads; warns "no field takes OPTIONS entry BEGIN" | `UnexpectedToken` at the `MAXBOUND` line, line and column, the tokens expected | -| misspelled keyword (`PRINT_FLOWZ`) | loads; warns "no field takes OPTIONS entry PRINT_FLOWZ" | the same | -| wrong value type (`MAXBOUND two`) | loads silently | `UnexpectedToken` at `two`, line and column, expecting an integer | -| short list row (CHD, no head) | `ValueError: StressPeriodData: can't read a row from [1, 1, 10]` | the same | -| bad OPEN/CLOSE path (NPF `K`) | `FileNotFoundError` naming the path | the same | -| short array (IC `STRT`, 9 values for 10 cells) | loads silently | the same | -| unknown block (`DIMENSIONZ`) | loads; warns "ignoring unknown block" | the same | - -- The typed loader catches two faults the basic one doesn't, and says - where. The basic loader's missing `END` happens to load the right - values here; MF6 would stop. -- Neither loader's errors name the file. The typed loader's give a line - and column in a file the message doesn't name; the basic loader's give - neither. -- Both accept a short array. A `LAYERED` field with fewer values than a - layer has is filled by repeating them (`np.resize`, there to repeat a - record across layers when there are fewer records than layers); a - non-layered one keeps its 9 values for the 10 cells. -- The basic loader ignores a `MAXBOUND` it can't read because MAXBOUND is - computed; a wrong-typed value in a field it keeps would fail where the - converter casts it. - -The script that made these isn't checked in; each fault is a one-line -edit of the file named. The follow-ups are in the plan's "Later". - -## Code size - -Code lines (no blanks, comments or docstrings), from parse to component -kwargs. `structure.py`'s functions are split by what the typed loader -imports from it, directly or through what it calls. - -| | lines | -|---|---:| -| **basic only** | | -| `basic.lark` | 40 | -| basic transformer | 67 | -| `structure.py`: `_Load`, the array and row readers, block grouping | ~340 | -| DFN accessor in `spec.py` (also egress's; see below) | ~120 | -| stored DFNs, `flopy4/mf6/dfns` | 129 files, 1.4 MB | -| **typed only** | | -| `typed.lark` | 144 | -| grammar generation (`grammar/__init__.py`, `filters.py`, `names.py`, `dfn2lark.py`) | 260 | -| grammar templates (Jinja) | 335 | -| typed transformer | 298 | -| `ingress/typed.py` | 276 | -| generated grammars | 129 files, 6,581 lines (536 KB) | -| **shared** | | -| `structure.py`: `ComponentLoad`, bindings, array files, children | ~410 | -| `transformer/rows.py` | 97 | -| `parser.py` (both parsers, the typed parsers' disk cache) | 108 | - -Egress (S2) reads block structure through the DFN accessor too, so the -stored DFNs and the accessor stay while either egress or the basic -loader needs them. Deleting the basic loader would mean egress reading -the classes' fields instead (plan, Phase C). From b7f9e479f7e6154c439e285119ce1550e5962739 Mon Sep 17 00:00:00 2001 From: wpbonelli Date: Thu, 5 Nov 2026 10:46:11 -0800 Subject: [PATCH 3/8] Mark the stored DFNs as generated flopy4 mf6 sync writes them, so GitHub can collapse them in diffs. Co-Authored-By: Claude Opus 5.5 --- .gitattributes | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitattributes b/.gitattributes index 07fe41c52..49e72bf38 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1,3 @@ # GitHub syntax highlighting pixi.lock linguist-language=YAML linguist-generated=true +flopy4/mf6/dfns/*.toml linguist-generated=true From ddb3b2366f92cc199c44afd89dd574b34b0e4639 Mon Sep 17 00:00:00 2001 From: wpbonelli Date: Thu, 5 Nov 2026 10:57:24 -0800 Subject: [PATCH 4/8] Move the simplification plan to dev-plans Plans live on dev-plans, not develop, so it shouldn't land with this. Co-Authored-By: Claude Opus 5.5 --- docs/dev/converter-simplification-plan.md | 270 ---------------------- 1 file changed, 270 deletions(-) delete mode 100644 docs/dev/converter-simplification-plan.md diff --git a/docs/dev/converter-simplification-plan.md b/docs/dev/converter-simplification-plan.md deleted file mode 100644 index ac9770cf9..000000000 --- a/docs/dev/converter-simplification-plan.md +++ /dev/null @@ -1,270 +0,0 @@ -# Converter simplification plan (structure / unstructure) - -Status: **done**, apart from D5 and D6 (skipped for now) and the -follow-ups under "Later". Written 2026-09-22 against `fe5423c` and revised -2026-10-19/20 after rebasing onto `develop` (`916c2f8b`). From 2026-10-20 -the plan was two loaders built side by side, then compared. Trimmed -2026-10-22 to the results; the full plan, with each phase as planned, is -in this file's git history (before this trim, `65af7491`). Rebased -2026-10-23 onto `develop` at `d14e5fb2` (#503, flopy3's period-data -keywords), with devtools at `07d1273a`. Squashed and rebased 2026-11-05 -onto `develop` at `be07090a` (#539), which also took the typed loader off -this branch: see "The typed loader" below. The commit hashes here are on -`typed-loader-parked` (`f46cfeca`), the pre-squash history. - -The work is a refactor on the current attrs object model, independent of -the `pydantic-plan` migration. The round-trip suite -(`test/mf6/test_mf6_io_roundtrip.py`), the load snapshots and the -written-file snapshots are the safety net. The one API change is STO's -period value (decision 1). - -## Goal - -Replace the multi-pass, exception-driven ingress (`structure.py`) and the -type-sniffing egress (`unstructure.py`) with one schema-driven model of an -MF6 block, used the same way in both directions. - -Before, on `develop` @ `916c2f8b`: -- **Ingress** ran seven passes. Each classified fields from their Python - annotations, guessed a list's taggedness from its block's size, and - grouped repeating blocks its own way. There were three array readers, - and six copies of the kwarg-name rule that disagreed. -- **Egress** dispatched on runtime value types through about a dozen - `isinstance` branches. It hardcoded `maxbound` and `solutiongroup 1`, - and had separate paths for packages and other components. - -## Where it ended up - -- **One loader here** (`converter/ingress/structure.py`, `_Load`): the - basic grammar's token rows, with block structure from the DFNs stored - with the classes. - - **Base class** (`ComponentLoad`): assembling a repeating block's values - by header, fill-forward and clearing, list rows into `Item`s, child - bindings, and the instance's `WriteContext`. It has one subclass on - this branch, and stays split for the typed loader's. -- **One egress path** (`egress/unstructure.py`, `_Unstructure`), the - inverse of `_Load`. It walks the DFN's blocks in order and writes each - field by its DFN type. -- **Stored DFNs.** Sync writes the DFNs it generated the classes from to - `flopy4/mf6/dfns`, as TOML. `spec.dfn(cls)` loads one when first asked - for; `spec.block_keys(cls, block)` gives a block's row keys, dynamic - keys and untagged field. `spec.attr_names(cls)`, from codegen, maps - each DFN field to its class attribute. -- **What the classes carry**, written by codegen: `dfn_name`; `headers`, - each repeating block's `Header(kind, index)` (D7); and each field's - `block`, `fill_forward` and type metadata. - -## Phases - -Each kept the round-trip suite and the load and written-file snapshots -green when it landed. - -### Shared - -- **S1. Name mapping** (`971db3f6`). Codegen records the attribute it - names for each DFN field (`make.attr_names`), so there's one naming - rule. The loader switch from this commit left with the typed loader. -- **S2. Egress mirror** (`0995bc85`). One path for every component. - - `maxbound` is read from the class's property, and the `solutiongroup - 1` hack is gone: a field holding one value is the first occurrence's. - - The rows naming children come from `bindings`, the inverse of - `_resolve_bindings`. - - Written files changed only in field order, now the DFN's: `MXITER` - before the solution rows, and EVT's `MAXBOUND` before `NSEG`. - -### Track A: the basic loader - -- **A1. Stored DFNs** (`ac0e06ee`, lazy loading `58fd00e0`). Sync stores - the DFNs again (`_store_dfns`, dropped in #455). `spec.dfn`, - `block_keys` and `following_tags` wrap the devtools helpers in one - place. - - A first attempt emitted a `BlockSpec` per class and was dropped: it - restated the DFN in a vocabulary of its own. -- **A2. Value parsers** (`aa840941`). `_read_array` reads every grid - array (griddata, G/A period, TAS time), its length from the field's DFN - shape. `_tagged_value` and `parse_list` serve every block. - - `FACTOR` is applied on load and not kept (`write-options-plan.md`, in - the archive). -- **A3. Ingress loop** (`ed1185e2`). `structure_component` reads the - DFN's blocks in order, options and dimensions first. - - `_occurrences` groups blocks by name and header. - - A row goes to the field of its own block whose key it begins with; - the rest go to the untagged field, or to `_resolve_bindings`. - - Passes 1–4, the block-size inference and `repeating_array_key_type` - are gone. - -### The typed loader (not on this branch) - -Phases B (typed load, B1-B4) and C (comparing the loaders) were built here -and moved off in the 2026-11-05 rebase. They're on `typed-loader-parked`, -to be rebuilt on a `typed-loader` branch stacked on this one, with the -develop changes this rebase ported into `_Load` ported there too. -`typed.lark`, the generated grammars, `loads_typed` and -`_check_typed_grammar` here are `develop`'s, unchanged. C's results, from -before the rebase, are in `loader-comparison.md` on `typed-loader`. - -### D: cleanups from the post-C audit - -The audit (2026-10-21, at `0fb2ef70`) counted +405 code lines on the -branch. The basic loader and egress were about +30 together; the typed -loader about +360. - -- **D1. One child-binding predicate** (`f68645ef`): `spec.binding_fields`, - used in all five places that had their own. -- **D2. One header parse** (`835f7d4c`). -- **D3. `_resolve_bindings` rewritten** (`7aa6139c`). `_binding_target` - makes one ftype comparison over each field's classes, and one context - is carried through a block, gaining dims as providers load. -- **D4. `_Load.body` untangled** (`b3cbd503`). `_groups` puts each row - with the records after it, so the loop is a plain `for`. OC's `HEAD` - direction check moved to `field_of`, for file records only (``XT3D - [RHS]`` has an optional second keyword). -- **D5. Value kind from the DFN on ingress.** *Skipped for now.* While - both loaders stay, none of the annotation helpers (`item_list_type`, - `block_list_type`, `_per_header`, ...) could go: the typed loader, the - shared code and egress use them. So this would only add a second - dispatch. Revisit with deleting a loader. -- **D6. Two sources of truth at runtime** (the classes and the stored - DFNs, joined by `attr_names`). *Skipped for now,* with D5. Storing the - names at sync time stays in "Later". -- **D7. Header kinds from the generated classes** (`bf264dda`, - `00051dee`). - - Codegen writes `headers: ClassVar[dict[str, Header]]` from the DFN's - `block.header`: - - the 59 period blocks: `Header("integer", index=True)`; - - Simulation's solution groups: `Header("integer")`; - - TAS: `Header("double")`; - - OBS: `Header("record")`. - - `index` is the DFN's: devtools marks IPER `index = true` (dd9bd848). - - `_header`, egress's `occurrences` and `annotate_arrays` - read `headers`, so no code names the `period` or `time` block. - -## Representation decisions - -1. **STO period: done** (`d3e9feb4`). devtools now names the merged - field `stress_period_data`. - - Codegen emits it as one word per period: - `stress_period_data: Optional[dict[int, Literal["steady-state", - "transient"]]]`, filled forward. - - `string(valid=...)` keeps a value as the DFN spells it, whatever its - case. - - Egress writes it uppercase, as keywords are. - - `stress_period_data={0: [("STEADY-STATE",)]}` is now - `stress_period_data={0: "steady-state"}`. - - flopy3's `steady_state=` / `transient=` (#503) convert to this form - (`flopy4.mf6.legacy.sto_period_data`). -2. **`stress_period_data` naming: done upstream.** devtools #399 names - every fill-forward period list `stress_period_data` in the DFNs, as - codegen already named the attribute, so the generated classes didn't - change. What's left in codegen isn't about the DFN's name: the list is - the private `_stress_period_data`, aliased `stress_period_data`, for - `Package`'s DataFrame setter. flopy3's old names (`perioddata`, ...) - are #503's `_LEGACY_PERIOD_KWARGS`. - -G/A period arrays are sparse per-period dicts on `develop` -(`flopy4.mf6.period_arrays`), the same `{header: value}` shape as every -repeating block. - -## The block model - -These are the rules both directions follow, and the schema facts they -rest on. They were re-scanned 2026-10-19 over the modflow6 DFNs at -`2.0.0.dev3`: 368 blocks. - -> A block is an ordered set of fields. A body row whose first token is a -> tagged field's key belongs to that field. Every other row belongs to the -> block's untagged field, and there is at most one of those, last. - -- **Where a tagged key comes from:** - - the field's name; - - a record's or file record's keyword (`ts6`, `obs6`, `gwfhead`); - - a tagged list's item keyword (OC's `SAVE` / `PRINT`); - - a dynamic key, from the values of the field its `fk` names (G/A - `aux`, keyed by `auxiliary` names). -- **Where untagged fields occur:** 124 blocks have one and 244 none. - Simulation's `solutiongroup` is the only block where it isn't alone - (tagged `mxiter`, then the list). -- **Repetition within a block:** a field occurs once, or is a `List`, - tagged or untagged. -- **Repetition of a block:** a block with a header repeats. Its value is - `{header: body}`, the header read by its kind in the class's `headers`. - `fill_forward` is about meaning, not parsing: an absent period keeps - the previous one's values. - -| block | fill_forward | fields | components | -|---|---|---|---| -| period | yes | one untagged list | list-based stress packages | -| period | yes | tagged list | OC (`output`) | -| period | yes | tagged arrays + tagged `aux` list | G/A packages, `utl-spca` | -| period | yes | one untagged string | `*-sto` | -| time | no | one untagged array | `utl-tas` | -| solutiongroup | no | tagged integer + untagged list | `sim-nam` | -| continuous | no | one untagged list, record header | `utl-obs` | - -## Benchmarks - -- **Baseline:** recorded in [discussion - #55](https://github.com/modflowpy/pyphoenix-project/discussions/55#discussioncomment-18978194), - with the harness in `benchmarks/`. -- **Rerun after S2** (2026-10-21, against the merge base `c5c606eb`, basic - loader): - - load and write: no regression beyond noise; - - peak memory: within ±5% everywhere; - - cold start: the first load took 0.26 s against 0.21 s. That's the - stored DFNs the model needs plus building codegen's spec for - `attr_names` (see "Later"). -- **Phase C:** the typed loader's numbers are in `loader-comparison.md` on - `typed-loader`. - -## devtools follow-ups - -- **Extend `Block._check_field_order` to untagged fields of any type** - (at most one per block, and last), so the converter can rely on it. -- **Make `_leading_tags` / `_is_dynamic_key` public** (a `Field.tags` - property, say). flopy4 wraps them in `spec.py` until then. - -## Later - -Each is its own change. - -- **Deleting a loader**, if decided (see `loader-comparison.md` on - `typed-loader`). Deleting the basic loader takes the stored DFNs with it, once egress reads the classes' fields. - The size at stake: - - typed: ~360 code lines, ~1,300 with grammar generation and templates, - plus 6,581 lines of generated grammars; - - basic: ~450 code lines. -- **Attribute names at sync time.** `spec.attr_names` builds codegen's - spec of each class on its first load, most of the cold-start gap - above. Sync could store the names, as it stores the DFNs. -- **An auxiliary variable named like a field:** the typed grammar parses - an aux named RECHARGE as the field. No corpus file does it. -- **A TAS time's array isn't recorded in `ArrayIO`** by either loader, so - its read options aren't kept on write. -- **`test060_gms_ets`** loads under neither loader. -- **Load errors don't name the file.** The typed loader's give a line and - column; the basic loader's give neither. -- **The basic loader is lenient where MF6 isn't.** A missing `END` reads - the next `BEGIN` as an unknown option, and a wrong-typed computed field - (`MAXBOUND two`) is ignored. -- **The typed loader's memory:** 1.8× basic's peak on - `test016_Keating_dev` and 1.7× on `test045_lake4ss_dev`. Worth looking - into before deleting the basic loader. -- **The writer's `field_type`** (`simplification-survey.md` #5): egress - knows each field's DFN type, so could pass it along. - -Out of scope: the index-domain / time-dimension sentinel discussion. - -## History - -The first draft's Phase 0 survey (load → write → reload over 239 corpus -models) found ten pre-existing issues. All were fixed on `develop` before -the refactor: -- ISO datetimes, float precision, model subdirectories, trailing tokens - and a single-name `AUXILIARY`; -- aux-named G/A period arrays (devtools #371); -- a repeated `TS6` (devtools #368); -- TAS-sourced period arrays (#413); -- ungenerated packages; -- quoted strings (#462). - -The Phase 0 harness is `test/mf6/test_mf6_io_roundtrip.py`. From 9f186ef7a507b4bff911b81413c262a0c517f58d Mon Sep 17 00:00:00 2001 From: wpbonelli Date: Thu, 5 Nov 2026 12:36:25 -0800 Subject: [PATCH 5/8] Compare regenerated classes by their code Sync formats its output only where ruff is on the PATH, and the test environments don't install it, so test_installed_dfns_match_classes failed there on formatting alone. Co-Authored-By: Claude Opus 5.5 --- test/mf6/test_mf6_sync.py | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/test/mf6/test_mf6_sync.py b/test/mf6/test_mf6_sync.py index 355655f81..12ac65533 100644 --- a/test/mf6/test_mf6_sync.py +++ b/test/mf6/test_mf6_sync.py @@ -1,3 +1,4 @@ +import ast import os import re import shutil @@ -325,6 +326,10 @@ def make_module_without_crs(spec, env, verbose=False, outpath=None): assert any("Dis.crs" in gap for gap in find_problems(outdir).gaps) +def _code(files: dict[str, str]) -> dict[str, str]: + return {name: ast.dump(ast.parse(text)) for name, text in files.items()} + + def _grammars(outdir: Path) -> dict[str, str]: return {p.name: p.read_text() for p in (outdir / _sync._GRAMMARS).glob("*.lark")} @@ -438,11 +443,14 @@ def test_installed_dfns_match_classes(tmp_path): shutil.copytree(installed, tmp_path / "mf6", ignore=shutil.ignore_patterns("__pycache__")) ) toml = Path(shutil.copytree(installed / "dfns", tmp_path / "toml")) - before = _snapshot(outdir) | _grammars(outdir) + before = _snapshot(outdir) + grammars = _grammars(outdir) sync(toml, mf6_version="6.9.0", outdir=outdir) - after = _snapshot(outdir) | _grammars(outdir) + after = _snapshot(outdir) del after["_contract.py"], before["_contract.py"] - assert after == before + # by their code: sync formats its output only where ruff is installed + assert _code(after) == _code(before) + assert _grammars(outdir) == grammars def test_resync_from_toml(dfn_path, outdir, tmp_path): From 3176bb64e6c7d0d0594dfc513771c893e0275d23 Mon Sep 17 00:00:00 2001 From: wpbonelli Date: Thu, 5 Nov 2026 12:36:25 -0800 Subject: [PATCH 6/8] Stop on a block with no END and a bad MAXBOUND The basic loader took a BEGIN inside a block as a row and any name after END, so a block missing its END swallowed the next one, with only a warning. It also ignored MAXBOUND's value, since MAXBOUND is computed. MF6 stops on both, so raise, naming the block and line or the entry. An unknown row or block still warns. Co-Authored-By: Claude Opus 5.5 --- flopy4/mf6/codec/reader/transformer/basic.py | 16 +++++++- flopy4/mf6/converter/ingress/structure.py | 33 +++++++++++----- test/mf6/test_mf6_codec.py | 41 ++++++++++++++++++++ 3 files changed, 79 insertions(+), 11 deletions(-) diff --git a/flopy4/mf6/codec/reader/transformer/basic.py b/flopy4/mf6/codec/reader/transformer/basic.py index 22740fab4..978c27a8c 100644 --- a/flopy4/mf6/codec/reader/transformer/basic.py +++ b/flopy4/mf6/codec/reader/transformer/basic.py @@ -46,13 +46,27 @@ def start(self, items: list[Any]) -> dict[str, Any]: return blocks def block(self, items: list[Any]) -> dict[str, Any]: - # BEGIN name line... END name + # BEGIN name line... END name. The grammar takes a BEGIN inside a + # block as a row and any name after END, so a block missing its END + # would swallow the next one; like MF6, stop on both. + begin, name, end_name = items[0], items[1], items[-1] + + def no_end(found: str) -> ValueError: + return ValueError( + f"{name.upper()} block, opened on line {begin.line}, has no END: " + f"found {found.upper()}" + ) + body: list[Any] = [] for item in items[2:-2]: if isinstance(item, _RecordRows): body.extend(item) else: + if isinstance(item, list) and item and item[0].upper() == "BEGIN": + raise no_end(" ".join(item)) body.append(item) + if end_name.split()[0].lower() != name.split()[0].lower(): + raise no_end(f"END {end_name}") if len(body) == 1 and isinstance(body[0], NumberRows): return {items[1]: body[0]} if any(isinstance(item, NumberRows) for item in body): diff --git a/flopy4/mf6/converter/ingress/structure.py b/flopy4/mf6/converter/ingress/structure.py index c4daf2003..ddcc6e785 100644 --- a/flopy4/mf6/converter/ingress/structure.py +++ b/flopy4/mf6/converter/ingress/structure.py @@ -988,7 +988,10 @@ def body(self, name: str, rows: list, header: Any) -> dict: continue f, aux_name = found if (a := self.attribute(name, f)) is None: - self.unknown(name, head) + if isinstance(getattr(self.cls, f.name, None), property): + self.check_computed(name, head) + else: + self.unknown(name, head) elif _is_grid_array(a): self.array(a, aux_name, [head, *records], header, values) elif item_list_type(a.type) is not None: @@ -1043,15 +1046,25 @@ def field_of(self, keys: BlockKeys, row: Any) -> "tuple[Any, str | None] | None" def unknown(self, name: str, row: list) -> None: """Warn of a row no field of the block `name` takes. MF6 rejects a keyword it doesn't know, so this is likely one flopy4 doesn't - support yet. A computed one (a list package's MAXBOUND) is - derived, not read.""" - key = str(row[0]) - if not isinstance(getattr(self.cls, key.lower(), None), property): - warnings.warn( - f"{self.cls.__name__}: no field takes {name.upper()} entry {key.upper()}, skipped", - UserWarning, - stacklevel=4, - ) + support yet.""" + key = str(row[0]).upper() + warnings.warn( + f"{self.cls.__name__}: no field takes {name.upper()} entry {key}, skipped", + UserWarning, + stacklevel=4, + ) + + def check_computed(self, name: str, row: list) -> None: + """Check the row of a computed field (a list package's MAXBOUND, + the only kind there is). Its value is derived, not read, but MF6 + stops on a bad one, so don't load what it wouldn't run.""" + try: + from_text(row[1], int) + except (IndexError, ValueError): + entry = " ".join(str(t) for t in row).upper() + raise ValueError( + f"{self.cls.__name__}: {name.upper()} entry {entry} needs an integer" + ) from None def array(self, f: Any, aux_name: "str | None", rows: list, header: Any, values: dict) -> None: """Read the grid array `f`, from its name row and control records diff --git a/test/mf6/test_mf6_codec.py b/test/mf6/test_mf6_codec.py index 7b3258885..10e8d9d60 100644 --- a/test/mf6/test_mf6_codec.py +++ b/test/mf6/test_mf6_codec.py @@ -5228,6 +5228,47 @@ def test_computed_dimension_does_not_warn(): structure_component(raw, Chd) +@pytest.mark.parametrize("row", ["MAXBOUND two", "MAXBOUND"]) +def test_computed_dimension_bad_value(row): + """MF6 stops on a bad MAXBOUND, so a value that's never used still has + to be one it would read.""" + from flopy4.mf6.converter.ingress.structure import structure_component + + raw = loads(f"BEGIN DIMENSIONS\n {row}\nEND DIMENSIONS\n") + with pytest.raises(ValueError, match=f"Chd: DIMENSIONS entry {row.upper()} needs an integer"): + structure_component(raw, Chd) + + +@pytest.mark.parametrize( + "text, match", + [ + ( + "BEGIN OPTIONS\n SAVE_FLOWS\nBEGIN DIMENSIONS\n MAXBOUND 2\nEND DIMENSIONS\n", + "OPTIONS block, opened on line 1, has no END: found BEGIN DIMENSIONS", + ), + ( + "\nBEGIN PERIOD 1\n 1 1 1 5.0\nBEGIN PERIOD 2\n 1 1 1 6.0\nEND PERIOD 2\n", + "PERIOD 1 block, opened on line 2, has no END: found BEGIN PERIOD 2", + ), + ( + "BEGIN OPTIONS\n SAVE_FLOWS\nEND DIMENSIONS\n", + "OPTIONS block, opened on line 1, has no END: found END DIMENSIONS", + ), + ], +) +def test_block_without_end(text, match): + """A block missing its END doesn't swallow the next one, as MF6 won't.""" + with pytest.raises(ValueError, match=match): + loads(text) + + +def test_block_end_without_index(): + """END needn't repeat a block's index, or its case.""" + assert loads("BEGIN period 1\n 1 2\nEND PERIOD\n") == loads( + "BEGIN period 1\n 1 2\nEND period 1\n" + ) + + def test_options_open_close(tmp_path): """An options block can be OPEN/CLOSE-redirected to a file.""" from flopy4.mf6.converter.ingress.structure import structure_component From 15d0c99bee4473454579fba02daa0ce04e1c9763 Mon Sep 17 00:00:00 2001 From: wpbonelli Date: Thu, 5 Nov 2026 17:04:44 -0800 Subject: [PATCH 7/8] Read only the classes at runtime, not stored DFNs The loader's block structure came from DFNs stored with the classes and its values from the classes, joined by attr_names, which reran codegen's spec at load. The classes lacked only one fact to stand alone, which fields are untagged, and that's in the DFNs already. So codegen emits tagged=False, and spec.file_blocks and spec.block_keys route on attrs fields. Remove flopy4/mf6/dfns, _store_dfns, spec.dfn, attr_names and make._headers. test_mf6_routing.py holds generated classes to the DFNs they came from. unstructure_component's keys are now each field's name in the file (sfac), not the DFN's name for it (sfacrecord). Co-Authored-By: Claude Opus 5.5 --- .gitattributes | 1 - docs/dev/sdd.md | 4 +- flopy4/mf6/_sync.py | 31 +- flopy4/mf6/chf/cdb.py | 1 + flopy4/mf6/chf/chd.py | 1 + flopy4/mf6/chf/cxs.py | 2 + flopy4/mf6/chf/disv1d.py | 2 + flopy4/mf6/chf/evp.py | 1 + flopy4/mf6/chf/flw.py | 1 + flopy4/mf6/chf/pcp.py | 1 + flopy4/mf6/chf/sto.py | 1 + flopy4/mf6/chf/zdg.py | 1 + flopy4/mf6/converter/egress/unstructure.py | 129 +-- flopy4/mf6/converter/ingress/structure.py | 87 +- flopy4/mf6/dfns/chf-cdb.toml | 289 ----- flopy4/mf6/dfns/chf-chd.toml | 295 ----- flopy4/mf6/dfns/chf-cxs.toml | 107 -- flopy4/mf6/dfns/chf-dfw.toml | 159 --- flopy4/mf6/dfns/chf-disv1d.toml | 258 ----- flopy4/mf6/dfns/chf-evp.toml | 295 ----- flopy4/mf6/dfns/chf-flw.toml | 308 ----- flopy4/mf6/dfns/chf-ic.toml | 39 - flopy4/mf6/dfns/chf-nam.toml | 167 --- flopy4/mf6/dfns/chf-oc.toml | 223 ---- flopy4/mf6/dfns/chf-pcp.toml | 295 ----- flopy4/mf6/dfns/chf-sto.toml | 53 - flopy4/mf6/dfns/chf-zdg.toml | 324 ------ flopy4/mf6/dfns/exg-chfgwf.toml | 147 --- flopy4/mf6/dfns/exg-gwegwe.toml | 317 ----- flopy4/mf6/dfns/exg-gwfgwe.toml | 6 - flopy4/mf6/dfns/exg-gwfgwf.toml | 341 ------ flopy4/mf6/dfns/exg-gwfgwt.toml | 6 - flopy4/mf6/dfns/exg-gwfprt.toml | 6 - flopy4/mf6/dfns/exg-gwtgwt.toml | 317 ----- flopy4/mf6/dfns/exg-olfgwf.toml | 147 --- flopy4/mf6/dfns/gwe-adv.toml | 22 - flopy4/mf6/dfns/gwe-cnd.toml | 189 --- flopy4/mf6/dfns/gwe-ctp.toml | 300 ----- flopy4/mf6/dfns/gwe-dis.toml | 302 ----- flopy4/mf6/dfns/gwe-disu.toml | 366 ------ flopy4/mf6/dfns/gwe-disv.toml | 326 ------ flopy4/mf6/dfns/gwe-esl.toml | 308 ----- flopy4/mf6/dfns/gwe-est.toml | 174 --- flopy4/mf6/dfns/gwe-fmi.toml | 44 - flopy4/mf6/dfns/gwe-ic.toml | 51 - flopy4/mf6/dfns/gwe-lke.toml | 638 ---------- flopy4/mf6/dfns/gwe-mve.toml | 82 -- flopy4/mf6/dfns/gwe-mwe.toml | 541 --------- flopy4/mf6/dfns/gwe-nam.toml | 222 ---- flopy4/mf6/dfns/gwe-oc.toml | 212 ---- flopy4/mf6/dfns/gwe-sfe.toml | 659 ----------- flopy4/mf6/dfns/gwe-ssm.toml | 102 -- flopy4/mf6/dfns/gwe-uze.toml | 551 --------- flopy4/mf6/dfns/gwf-api.toml | 108 -- flopy4/mf6/dfns/gwf-buy.toml | 106 -- flopy4/mf6/dfns/gwf-chd.toml | 307 ----- flopy4/mf6/dfns/gwf-chdg.toml | 299 ----- flopy4/mf6/dfns/gwf-csub.toml | 939 --------------- flopy4/mf6/dfns/gwf-dis.toml | 302 ----- flopy4/mf6/dfns/gwf-disu.toml | 368 ------ flopy4/mf6/dfns/gwf-disv.toml | 326 ------ flopy4/mf6/dfns/gwf-drn.toml | 342 ------ flopy4/mf6/dfns/gwf-drng.toml | 339 ------ flopy4/mf6/dfns/gwf-evt.toml | 371 ------ flopy4/mf6/dfns/gwf-evta.toml | 336 ------ flopy4/mf6/dfns/gwf-ghb.toml | 324 ------ flopy4/mf6/dfns/gwf-ghbg.toml | 321 ------ flopy4/mf6/dfns/gwf-gnc.toml | 98 -- flopy4/mf6/dfns/gwf-hfb.toml | 63 - flopy4/mf6/dfns/gwf-ic.toml | 51 - flopy4/mf6/dfns/gwf-lak.toml | 1214 -------------------- flopy4/mf6/dfns/gwf-maw.toml | 832 -------------- flopy4/mf6/dfns/gwf-mvr.toml | 209 ---- flopy4/mf6/dfns/gwf-nam.toml | 232 ---- flopy4/mf6/dfns/gwf-npf.toml | 473 -------- flopy4/mf6/dfns/gwf-oc.toml | 207 ---- flopy4/mf6/dfns/gwf-rch.toml | 301 ----- flopy4/mf6/dfns/gwf-rcha.toml | 314 ----- flopy4/mf6/dfns/gwf-riv.toml | 331 ------ flopy4/mf6/dfns/gwf-rivg.toml | 333 ------ flopy4/mf6/dfns/gwf-sfr.toml | 1070 ----------------- flopy4/mf6/dfns/gwf-sto.toml | 188 --- flopy4/mf6/dfns/gwf-uzf.toml | 611 ---------- flopy4/mf6/dfns/gwf-vsc.toml | 130 --- flopy4/mf6/dfns/gwf-wel.toml | 382 ------ flopy4/mf6/dfns/gwf-welg.toml | 363 ------ flopy4/mf6/dfns/gwt-adv.toml | 23 - flopy4/mf6/dfns/gwt-api.toml | 108 -- flopy4/mf6/dfns/gwt-cnc.toml | 300 ----- flopy4/mf6/dfns/gwt-dis.toml | 302 ----- flopy4/mf6/dfns/gwt-disu.toml | 368 ------ flopy4/mf6/dfns/gwt-disv.toml | 326 ------ flopy4/mf6/dfns/gwt-dsp.toml | 168 --- flopy4/mf6/dfns/gwt-fmi.toml | 44 - flopy4/mf6/dfns/gwt-ic.toml | 51 - flopy4/mf6/dfns/gwt-ist.toml | 366 ------ flopy4/mf6/dfns/gwt-lkt.toml | 609 ---------- flopy4/mf6/dfns/gwt-mst.toml | 210 ---- flopy4/mf6/dfns/gwt-mvt.toml | 82 -- flopy4/mf6/dfns/gwt-mwt.toml | 504 -------- flopy4/mf6/dfns/gwt-nam.toml | 222 ---- flopy4/mf6/dfns/gwt-oc.toml | 212 ---- flopy4/mf6/dfns/gwt-sft.toml | 609 ---------- flopy4/mf6/dfns/gwt-src.toml | 319 ----- flopy4/mf6/dfns/gwt-ssm.toml | 102 -- flopy4/mf6/dfns/gwt-uzt.toml | 533 --------- flopy4/mf6/dfns/olf-cdb.toml | 288 ----- flopy4/mf6/dfns/olf-chd.toml | 295 ----- flopy4/mf6/dfns/olf-dfw.toml | 159 --- flopy4/mf6/dfns/olf-dis2d.toml | 217 ---- flopy4/mf6/dfns/olf-disv1d.toml | 277 ----- flopy4/mf6/dfns/olf-disv2d.toml | 243 ---- flopy4/mf6/dfns/olf-evp.toml | 295 ----- flopy4/mf6/dfns/olf-flw.toml | 308 ----- flopy4/mf6/dfns/olf-ic.toml | 39 - flopy4/mf6/dfns/olf-nam.toml | 167 --- flopy4/mf6/dfns/olf-oc.toml | 223 ---- flopy4/mf6/dfns/olf-pcp.toml | 295 ----- flopy4/mf6/dfns/olf-sto.toml | 53 - flopy4/mf6/dfns/olf-zdg.toml | 324 ------ flopy4/mf6/dfns/prt-dis.toml | 297 ----- flopy4/mf6/dfns/prt-disv.toml | 323 ------ flopy4/mf6/dfns/prt-fmi.toml | 33 - flopy4/mf6/dfns/prt-mip.toml | 78 -- flopy4/mf6/dfns/prt-nam.toml | 87 -- flopy4/mf6/dfns/prt-oc.toml | 318 ----- flopy4/mf6/dfns/prt-prp.toml | 525 --------- flopy4/mf6/dfns/sim-nam.toml | 200 ---- flopy4/mf6/dfns/sim-tdis.toml | 85 -- flopy4/mf6/dfns/sln-ems.toml | 18 - flopy4/mf6/dfns/sln-ims.toml | 422 ------- flopy4/mf6/dfns/utl-ats.toml | 69 -- flopy4/mf6/dfns/utl-hpc.toml | 43 - flopy4/mf6/dfns/utl-laktab.toml | 68 -- flopy4/mf6/dfns/utl-ncf.toml | 132 --- flopy4/mf6/dfns/utl-obs.toml | 91 -- flopy4/mf6/dfns/utl-sfrtab.toml | 62 - flopy4/mf6/dfns/utl-spc.toml | 99 -- flopy4/mf6/dfns/utl-spca.toml | 76 -- flopy4/mf6/dfns/utl-tas.toml | 79 -- flopy4/mf6/dfns/utl-ts.toml | 119 -- flopy4/mf6/dfns/utl-tvk.toml | 79 -- flopy4/mf6/dfns/utl-tvs.toml | 84 -- flopy4/mf6/exg/chfgwf.py | 1 + flopy4/mf6/exg/gwegwe.py | 1 + flopy4/mf6/exg/gwfgwf.py | 1 + flopy4/mf6/exg/gwtgwt.py | 1 + flopy4/mf6/exg/olfgwf.py | 1 + flopy4/mf6/gwe/ctp.py | 1 + flopy4/mf6/gwe/disu.py | 2 + flopy4/mf6/gwe/disv.py | 2 + flopy4/mf6/gwe/esl.py | 1 + flopy4/mf6/gwe/fmi.py | 1 + flopy4/mf6/gwe/lke.py | 2 + flopy4/mf6/gwe/mwe.py | 2 + flopy4/mf6/gwe/sfe.py | 2 + flopy4/mf6/gwe/ssm.py | 2 + flopy4/mf6/gwe/uze.py | 2 + flopy4/mf6/gwf/buy.py | 1 + flopy4/mf6/gwf/chd.py | 1 + flopy4/mf6/gwf/csub.py | 2 + flopy4/mf6/gwf/disu.py | 2 + flopy4/mf6/gwf/disv.py | 2 + flopy4/mf6/gwf/drn.py | 1 + flopy4/mf6/gwf/evt.py | 1 + flopy4/mf6/gwf/ghb.py | 1 + flopy4/mf6/gwf/gnc.py | 1 + flopy4/mf6/gwf/hfb.py | 1 + flopy4/mf6/gwf/lak.py | 5 + flopy4/mf6/gwf/maw.py | 4 + flopy4/mf6/gwf/mvr.py | 2 + flopy4/mf6/gwf/rch.py | 1 + flopy4/mf6/gwf/riv.py | 1 + flopy4/mf6/gwf/sfr.py | 6 + flopy4/mf6/gwf/sto.py | 1 + flopy4/mf6/gwf/uzf.py | 2 + flopy4/mf6/gwf/vsc.py | 1 + flopy4/mf6/gwf/wel.py | 1 + flopy4/mf6/gwt/cnc.py | 1 + flopy4/mf6/gwt/disu.py | 2 + flopy4/mf6/gwt/disv.py | 2 + flopy4/mf6/gwt/fmi.py | 1 + flopy4/mf6/gwt/lkt.py | 2 + flopy4/mf6/gwt/mwt.py | 2 + flopy4/mf6/gwt/sft.py | 2 + flopy4/mf6/gwt/src.py | 1 + flopy4/mf6/gwt/ssm.py | 2 + flopy4/mf6/gwt/uzt.py | 2 + flopy4/mf6/olf/cdb.py | 1 + flopy4/mf6/olf/chd.py | 1 + flopy4/mf6/olf/disv1d.py | 2 + flopy4/mf6/olf/disv2d.py | 2 + flopy4/mf6/olf/evp.py | 1 + flopy4/mf6/olf/flw.py | 1 + flopy4/mf6/olf/pcp.py | 1 + flopy4/mf6/olf/sto.py | 1 + flopy4/mf6/olf/zdg.py | 1 + flopy4/mf6/prt/disv.py | 2 + flopy4/mf6/prt/fmi.py | 1 + flopy4/mf6/prt/oc.py | 1 + flopy4/mf6/prt/prp.py | 2 + flopy4/mf6/spec.py | 281 ++--- flopy4/mf6/tdis.py | 1 + flopy4/mf6/utils/codegen/make.py | 76 +- flopy4/mf6/utl/ats.py | 1 + flopy4/mf6/utl/hpc.py | 1 + flopy4/mf6/utl/laktab.py | 1 + flopy4/mf6/utl/obs.py | 1 + flopy4/mf6/utl/sfrtab.py | 1 + flopy4/mf6/utl/spc.py | 1 + flopy4/mf6/utl/tas.py | 1 + flopy4/mf6/utl/ts.py | 1 + flopy4/mf6/utl/tvk.py | 1 + flopy4/mf6/utl/tvs.py | 1 + pyproject.toml | 1 - test/mf6/test_mf6_codec.py | 10 +- test/mf6/test_mf6_codegen.py | 11 - test/mf6/test_mf6_dfn.py | 161 --- test/mf6/test_mf6_routing.py | 213 ++++ test/mf6/test_mf6_sync.py | 69 +- 220 files changed, 567 insertions(+), 34028 deletions(-) delete mode 100644 flopy4/mf6/dfns/chf-cdb.toml delete mode 100644 flopy4/mf6/dfns/chf-chd.toml delete mode 100644 flopy4/mf6/dfns/chf-cxs.toml delete mode 100644 flopy4/mf6/dfns/chf-dfw.toml delete mode 100644 flopy4/mf6/dfns/chf-disv1d.toml delete mode 100644 flopy4/mf6/dfns/chf-evp.toml delete mode 100644 flopy4/mf6/dfns/chf-flw.toml delete mode 100644 flopy4/mf6/dfns/chf-ic.toml delete mode 100644 flopy4/mf6/dfns/chf-nam.toml delete mode 100644 flopy4/mf6/dfns/chf-oc.toml delete mode 100644 flopy4/mf6/dfns/chf-pcp.toml delete mode 100644 flopy4/mf6/dfns/chf-sto.toml delete mode 100644 flopy4/mf6/dfns/chf-zdg.toml delete mode 100644 flopy4/mf6/dfns/exg-chfgwf.toml delete mode 100644 flopy4/mf6/dfns/exg-gwegwe.toml delete mode 100644 flopy4/mf6/dfns/exg-gwfgwe.toml delete mode 100644 flopy4/mf6/dfns/exg-gwfgwf.toml delete mode 100644 flopy4/mf6/dfns/exg-gwfgwt.toml delete mode 100644 flopy4/mf6/dfns/exg-gwfprt.toml delete mode 100644 flopy4/mf6/dfns/exg-gwtgwt.toml delete mode 100644 flopy4/mf6/dfns/exg-olfgwf.toml delete mode 100644 flopy4/mf6/dfns/gwe-adv.toml delete mode 100644 flopy4/mf6/dfns/gwe-cnd.toml delete mode 100644 flopy4/mf6/dfns/gwe-ctp.toml delete mode 100644 flopy4/mf6/dfns/gwe-dis.toml delete mode 100644 flopy4/mf6/dfns/gwe-disu.toml delete mode 100644 flopy4/mf6/dfns/gwe-disv.toml delete mode 100644 flopy4/mf6/dfns/gwe-esl.toml delete mode 100644 flopy4/mf6/dfns/gwe-est.toml delete mode 100644 flopy4/mf6/dfns/gwe-fmi.toml delete mode 100644 flopy4/mf6/dfns/gwe-ic.toml delete mode 100644 flopy4/mf6/dfns/gwe-lke.toml delete mode 100644 flopy4/mf6/dfns/gwe-mve.toml delete mode 100644 flopy4/mf6/dfns/gwe-mwe.toml delete mode 100644 flopy4/mf6/dfns/gwe-nam.toml delete mode 100644 flopy4/mf6/dfns/gwe-oc.toml delete mode 100644 flopy4/mf6/dfns/gwe-sfe.toml delete mode 100644 flopy4/mf6/dfns/gwe-ssm.toml delete mode 100644 flopy4/mf6/dfns/gwe-uze.toml delete mode 100644 flopy4/mf6/dfns/gwf-api.toml delete mode 100644 flopy4/mf6/dfns/gwf-buy.toml delete mode 100644 flopy4/mf6/dfns/gwf-chd.toml delete mode 100644 flopy4/mf6/dfns/gwf-chdg.toml delete mode 100644 flopy4/mf6/dfns/gwf-csub.toml delete mode 100644 flopy4/mf6/dfns/gwf-dis.toml delete mode 100644 flopy4/mf6/dfns/gwf-disu.toml delete mode 100644 flopy4/mf6/dfns/gwf-disv.toml delete mode 100644 flopy4/mf6/dfns/gwf-drn.toml delete mode 100644 flopy4/mf6/dfns/gwf-drng.toml delete mode 100644 flopy4/mf6/dfns/gwf-evt.toml delete mode 100644 flopy4/mf6/dfns/gwf-evta.toml delete mode 100644 flopy4/mf6/dfns/gwf-ghb.toml delete mode 100644 flopy4/mf6/dfns/gwf-ghbg.toml delete mode 100644 flopy4/mf6/dfns/gwf-gnc.toml delete mode 100644 flopy4/mf6/dfns/gwf-hfb.toml delete mode 100644 flopy4/mf6/dfns/gwf-ic.toml delete mode 100644 flopy4/mf6/dfns/gwf-lak.toml delete mode 100644 flopy4/mf6/dfns/gwf-maw.toml delete mode 100644 flopy4/mf6/dfns/gwf-mvr.toml delete mode 100644 flopy4/mf6/dfns/gwf-nam.toml delete mode 100644 flopy4/mf6/dfns/gwf-npf.toml delete mode 100644 flopy4/mf6/dfns/gwf-oc.toml delete mode 100644 flopy4/mf6/dfns/gwf-rch.toml delete mode 100644 flopy4/mf6/dfns/gwf-rcha.toml delete mode 100644 flopy4/mf6/dfns/gwf-riv.toml delete mode 100644 flopy4/mf6/dfns/gwf-rivg.toml delete mode 100644 flopy4/mf6/dfns/gwf-sfr.toml delete mode 100644 flopy4/mf6/dfns/gwf-sto.toml delete mode 100644 flopy4/mf6/dfns/gwf-uzf.toml delete mode 100644 flopy4/mf6/dfns/gwf-vsc.toml delete mode 100644 flopy4/mf6/dfns/gwf-wel.toml delete mode 100644 flopy4/mf6/dfns/gwf-welg.toml delete mode 100644 flopy4/mf6/dfns/gwt-adv.toml delete mode 100644 flopy4/mf6/dfns/gwt-api.toml delete mode 100644 flopy4/mf6/dfns/gwt-cnc.toml delete mode 100644 flopy4/mf6/dfns/gwt-dis.toml delete mode 100644 flopy4/mf6/dfns/gwt-disu.toml delete mode 100644 flopy4/mf6/dfns/gwt-disv.toml delete mode 100644 flopy4/mf6/dfns/gwt-dsp.toml delete mode 100644 flopy4/mf6/dfns/gwt-fmi.toml delete mode 100644 flopy4/mf6/dfns/gwt-ic.toml delete mode 100644 flopy4/mf6/dfns/gwt-ist.toml delete mode 100644 flopy4/mf6/dfns/gwt-lkt.toml delete mode 100644 flopy4/mf6/dfns/gwt-mst.toml delete mode 100644 flopy4/mf6/dfns/gwt-mvt.toml delete mode 100644 flopy4/mf6/dfns/gwt-mwt.toml delete mode 100644 flopy4/mf6/dfns/gwt-nam.toml delete mode 100644 flopy4/mf6/dfns/gwt-oc.toml delete mode 100644 flopy4/mf6/dfns/gwt-sft.toml delete mode 100644 flopy4/mf6/dfns/gwt-src.toml delete mode 100644 flopy4/mf6/dfns/gwt-ssm.toml delete mode 100644 flopy4/mf6/dfns/gwt-uzt.toml delete mode 100644 flopy4/mf6/dfns/olf-cdb.toml delete mode 100644 flopy4/mf6/dfns/olf-chd.toml delete mode 100644 flopy4/mf6/dfns/olf-dfw.toml delete mode 100644 flopy4/mf6/dfns/olf-dis2d.toml delete mode 100644 flopy4/mf6/dfns/olf-disv1d.toml delete mode 100644 flopy4/mf6/dfns/olf-disv2d.toml delete mode 100644 flopy4/mf6/dfns/olf-evp.toml delete mode 100644 flopy4/mf6/dfns/olf-flw.toml delete mode 100644 flopy4/mf6/dfns/olf-ic.toml delete mode 100644 flopy4/mf6/dfns/olf-nam.toml delete mode 100644 flopy4/mf6/dfns/olf-oc.toml delete mode 100644 flopy4/mf6/dfns/olf-pcp.toml delete mode 100644 flopy4/mf6/dfns/olf-sto.toml delete mode 100644 flopy4/mf6/dfns/olf-zdg.toml delete mode 100644 flopy4/mf6/dfns/prt-dis.toml delete mode 100644 flopy4/mf6/dfns/prt-disv.toml delete mode 100644 flopy4/mf6/dfns/prt-fmi.toml delete mode 100644 flopy4/mf6/dfns/prt-mip.toml delete mode 100644 flopy4/mf6/dfns/prt-nam.toml delete mode 100644 flopy4/mf6/dfns/prt-oc.toml delete mode 100644 flopy4/mf6/dfns/prt-prp.toml delete mode 100644 flopy4/mf6/dfns/sim-nam.toml delete mode 100644 flopy4/mf6/dfns/sim-tdis.toml delete mode 100644 flopy4/mf6/dfns/sln-ems.toml delete mode 100644 flopy4/mf6/dfns/sln-ims.toml delete mode 100644 flopy4/mf6/dfns/utl-ats.toml delete mode 100644 flopy4/mf6/dfns/utl-hpc.toml delete mode 100644 flopy4/mf6/dfns/utl-laktab.toml delete mode 100644 flopy4/mf6/dfns/utl-ncf.toml delete mode 100644 flopy4/mf6/dfns/utl-obs.toml delete mode 100644 flopy4/mf6/dfns/utl-sfrtab.toml delete mode 100644 flopy4/mf6/dfns/utl-spc.toml delete mode 100644 flopy4/mf6/dfns/utl-spca.toml delete mode 100644 flopy4/mf6/dfns/utl-tas.toml delete mode 100644 flopy4/mf6/dfns/utl-ts.toml delete mode 100644 flopy4/mf6/dfns/utl-tvk.toml delete mode 100644 flopy4/mf6/dfns/utl-tvs.toml delete mode 100644 test/mf6/test_mf6_dfn.py create mode 100644 test/mf6/test_mf6_routing.py diff --git a/.gitattributes b/.gitattributes index 49e72bf38..07fe41c52 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,3 +1,2 @@ # GitHub syntax highlighting pixi.lock linguist-language=YAML linguist-generated=true -flopy4/mf6/dfns/*.toml linguist-generated=true diff --git a/docs/dev/sdd.md b/docs/dev/sdd.md index 884fa897c..cd93eb759 100644 --- a/docs/dev/sdd.md +++ b/docs/dev/sdd.md @@ -168,9 +168,11 @@ The sparse input format used by MODFLOW 6 is in tension with an object model whe The conversion layer (`flopy4.mf6.converter`) transforms between the product's `xarray`/`attrs`-based object model and plain Python data structures suitable for serialization. This layer is format-agnostic and handles structural transformations common across formats. +The generated classes are the only schema this layer reads. Codegen compiles the DFNs into each class's fields and their metadata, and no DFN is read at load or write: `flopy4.mf6.spec` finds a class's blocks (`file_blocks`) and how a block's rows find their fields (`block_keys`) from those fields. A test holds freshly generated classes to the DFNs they came from (`test/mf6/test_mf6_routing.py`), so what the converter needs from a DFN but a class doesn't carry is a codegen fix. + **Unstructuring (write time)**: `converter.egress.unstructure` converts components to a form suitable for serialization, handling transformations like: -- Grouping fields into blocks according to their `block` metadata from DFNs +- Grouping fields into blocks according to their `block` metadata - Converting child components to binding tables for parent component name files - Slicing time-varying arrays by stress period, returned in a period-indexed `dict` - Converting `Path` objects to tuples (``, `FILEIN`/`FILEOUT`, ``) diff --git a/flopy4/mf6/_sync.py b/flopy4/mf6/_sync.py index ab239a96b..082969b22 100644 --- a/flopy4/mf6/_sync.py +++ b/flopy4/mf6/_sync.py @@ -22,7 +22,7 @@ _DFN_SCHEMA_VERSION = "2.0.0.dev3" _DEFAULT_REPO = "MODFLOW-ORG/modflow6" _CONTRACT = "_contract.py" -# The DFNs the classes were generated from, as TOML, for the converter. +# Where syncs before the typed reader stopped needing DFNs stored them. _DFNS = "dfns" # The typed reader's grammars, one per component, all generated. _GRAMMARS = "codec/reader/grammar/generated" @@ -285,24 +285,6 @@ def _check_writable(path: Path) -> None: ) -def _store_dfns(dfn_dir: Path, dest: Path) -> set[str]: - """Write the DFNs in ``dfn_dir`` to ``dest`` as TOML at the schema - version the classes are generated against: migrated from legacy - ``.dfn`` files, or copied if they're TOML already. Returns their - names.""" - dest.mkdir(parents=True) - if any(dfn_dir.glob("*.dfn")): - with warnings.catch_warnings(): - warnings.filterwarnings("ignore", message=".*modflow_devtools.dfns.*experimental.*") - from modflow_devtools.dfns.migrate import migrate - - migrate(dfn_dir, dest, _DFN_SCHEMA_VERSION, fmt="toml") - else: - for f in sorted(dfn_dir.glob("*.toml")): - shutil.copy2(f, dest / f.name) - return {f.name for f in dest.iterdir() if f.is_file()} - - def _make_grammars(dfns: dict, stage: Path) -> set[str]: """Generate the typed reader's grammar for every component into ``stage``, checking each one builds. Returns their paths, relative to @@ -472,7 +454,7 @@ def sync( """Regenerate the ``flopy4.mf6`` classes for an MF6 version. Fetches or reads the DFNs, regenerates the component classes and the - typed reader's grammars, stores the DFNs as TOML, and records the MF6 version in + typed reader's grammars, and records the MF6 version in ``_contract.py``. Generated modules and grammars the DFNs don't cover are removed. Nothing changes unless every generated module imports and every grammar builds. Warns of handwritten methods that read fields the @@ -551,7 +533,6 @@ def sync( raise SyncError(f"No .dfn or .toml files in {path}") registry = LocalDfnRegistry(path=path) source = str(path) - dfn_dir = path version = mf6_version or _local_mf6_version(path) commit = _local_commit(path) else: @@ -579,7 +560,6 @@ def sync( # pinned semver tag (first char is a digit). is_branch = not version[0].isdigit() _populate_remote_cache(registry, release_id, force=force or is_branch) - dfn_dir = registry.cache_path commit = _remote_commit(release_id) if version == "unknown": @@ -625,7 +605,6 @@ def sync( ) inits = make_package_inits(specs, outdir, stage=stage, verbose=verbose) generated = {p.relative_to(outdir).as_posix() for p in [s.outpath for s in specs] + inits} - dfn_files = {f"{_DFNS}/{f}" for f in _store_dfns(dfn_dir, stage / _DFNS)} old_dfn_files = ( {f"{_DFNS}/{f.name}" for f in (outdir / _DFNS).iterdir() if f.is_file()} if (outdir / _DFNS).is_dir() @@ -660,9 +639,11 @@ def sync( _swap( stage, outdir, - replace=[*sorted(generated), *sorted(dfn_files), *sorted(grammars), _CONTRACT], - remove=sorted(removed | (old_dfn_files - dfn_files) | (old_grammars - grammars)), + replace=[*sorted(generated), *sorted(grammars), _CONTRACT], + remove=sorted(removed | old_dfn_files | (old_grammars - grammars)), ) + if (outdir / _DFNS).is_dir() and not any((outdir / _DFNS).iterdir()): + (outdir / _DFNS).rmdir() finally: shutil.rmtree(stage, ignore_errors=True) diff --git a/flopy4/mf6/chf/cdb.py b/flopy4/mf6/chf/cdb.py index 4deff5900..41e9b6cd0 100644 --- a/flopy4/mf6/chf/cdb.py +++ b/flopy4/mf6/chf/cdb.py @@ -81,6 +81,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/chf/chd.py b/flopy4/mf6/chf/chd.py index 7d767bbe9..40ccc3d2e 100644 --- a/flopy4/mf6/chf/chd.py +++ b/flopy4/mf6/chf/chd.py @@ -89,6 +89,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/chf/cxs.py b/flopy4/mf6/chf/cxs.py index 903b9f797..dfba27f36 100644 --- a/flopy4/mf6/chf/cxs.py +++ b/flopy4/mf6/chf/cxs.py @@ -44,11 +44,13 @@ class Crosssectiondata(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, shape=("nsections",), ) crosssectiondata: Optional[list[Crosssectiondata]] = list_( default=None, block="crosssectiondata", + tagged=False, shape=("npoints",), ) diff --git a/flopy4/mf6/chf/disv1d.py b/flopy4/mf6/chf/disv1d.py index bef32e949..6a189372f 100644 --- a/flopy4/mf6/chf/disv1d.py +++ b/flopy4/mf6/chf/disv1d.py @@ -118,11 +118,13 @@ class Cell1d(Item): vertices: Optional[list[Vertices]] = list_( default=None, block="vertices", + tagged=False, shape=("nvert",), ) cell1d: Optional[list[Cell1d]] = list_( default=None, block="cell1d", + tagged=False, shape=("nodes",), ) diff --git a/flopy4/mf6/chf/evp.py b/flopy4/mf6/chf/evp.py index d818836f6..d0a498930 100644 --- a/flopy4/mf6/chf/evp.py +++ b/flopy4/mf6/chf/evp.py @@ -89,6 +89,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/chf/flw.py b/flopy4/mf6/chf/flw.py index 068f30653..6d65791b5 100644 --- a/flopy4/mf6/chf/flw.py +++ b/flopy4/mf6/chf/flw.py @@ -90,6 +90,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/chf/pcp.py b/flopy4/mf6/chf/pcp.py index 4af44aba8..a3d95ea29 100644 --- a/flopy4/mf6/chf/pcp.py +++ b/flopy4/mf6/chf/pcp.py @@ -89,6 +89,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/chf/sto.py b/flopy4/mf6/chf/sto.py index 5329e0620..88a8e58bd 100644 --- a/flopy4/mf6/chf/sto.py +++ b/flopy4/mf6/chf/sto.py @@ -39,4 +39,5 @@ class Sto(Package): block="period", fill_forward=True, valid=("steady-state", "transient"), + tagged=False, ) diff --git a/flopy4/mf6/chf/zdg.py b/flopy4/mf6/chf/zdg.py index aa814a3fb..4b92d9934 100644 --- a/flopy4/mf6/chf/zdg.py +++ b/flopy4/mf6/chf/zdg.py @@ -87,6 +87,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/converter/egress/unstructure.py b/flopy4/mf6/converter/egress/unstructure.py index 663f8ec54..0db03e985 100644 --- a/flopy4/mf6/converter/egress/unstructure.py +++ b/flopy4/mf6/converter/egress/unstructure.py @@ -21,7 +21,14 @@ from flopy4.mf6.package import Package from flopy4.mf6.period_arrays import is_cleared, is_grid_package from flopy4.mf6.record import Record, record_type -from flopy4.mf6.spec import FileDirection, attr_names, binding_fields, block_keys, dfn +from flopy4.mf6.spec import ( + FileDirection, + binding_fields, + block_keys, + field_key, + file_blocks, + is_tagged, +) from flopy4.mf6.write_context import WriteContext from flopy4.spec import is_array @@ -262,10 +269,10 @@ def unstructure_component(value: Component) -> dict[str, Any]: class _Unstructure: """One component's blocks for the writer, the inverse of the loader's - `_Load`: its DFN's blocks, in order, each field keyed by its DFN name - and taken from the class's attribute holding it (see `attr_names`), or - from a property computing it (a list package's MAXBOUND). A repeating - block is written once per header (see `occurrences`), and the rows + `_Load`: its class's blocks, in file order (see `file_blocks`), each + field keyed by its name in the file (see `field_key`), from its + attribute or from a property computing it (a list package's MAXBOUND). + A repeating block is written once per header (see `occurrences`), and the rows naming children (a model's packages, the simulation's models and solutions) are made from them (see `bindings`). A block with nothing to write is left out, unless codegen marked it `write_if_empty` or @@ -275,7 +282,6 @@ def __init__(self, value: Component) -> None: self.value = value self.cls = type(value) self._fields = attrs.fields_dict(self.cls) # type: ignore[arg-type] - self._names = attr_names(self.cls) self.grid = is_grid_package(self.cls) # blocks whose rows name children self.binding_blocks = binding_fields(self.cls) @@ -291,63 +297,61 @@ def grid_dims(self) -> tuple[int, tuple[int, ...]]: def blocks(self) -> dict[str, dict[str, Any]]: out: dict[str, dict[str, Any]] = {} keep: set[str] = set() - for name, block in (dfn(self.cls).blocks or {}).items(): + for name in file_blocks(self.cls): if isinstance(self.value, WorkspaceComponent) or any( f.metadata.get("write_if_empty") for f in self._fields.values() if f.metadata.get("block") == name ): keep.add(name) - if block.header is None: - out[name] = self.body(name, block) + if name not in self.cls.headers: + out[name] = self.body(name) else: - for header, (body, empty) in self.occurrences(name, block).items(): + for header, (body, empty) in self.occurrences(name).items(): out[f"{name} {header}"] = body if empty: keep.add(f"{name} {header}") return {name: body for name, body in out.items() if body or name in keep} - def attribute(self, block: str, f: Any) -> "attrs.Attribute | None": - """The class's field holding the DFN field `f` of `block`, if any.""" - return self._fields.get(self._names.get((block, f.name), "")) - - def get(self, block: str, f: Any) -> "tuple[attrs.Attribute | None, Any]": - """The DFN field `f`'s attribute and value: a private field's by - its alias (``stress_period_data``), a computed one's (a list - package's MAXBOUND) by its property, with no attribute.""" - if (a := self.attribute(block, f)) is not None: - return a, getattr(self.value, _init_key(a), None) - if isinstance(getattr(self.cls, f.name, None), property): - # a MAXBOUND of 0 (no rows) isn't written - return None, getattr(self.value, f.name) or None - return None, None - - def body(self, name: str, block: Any) -> dict[str, Any]: - """A block that doesn't repeat, by DFN field.""" - values = {f.name: self.value_of(name, f) for f in block.fields.values()} + def entries(self, name: str) -> "dict[str, attrs.Attribute | None]": + """The block `name`'s fields, in file order, by their keys for the + writer: a computed field first, with no attribute; a binding block's + children as one entry, its rows, keyed and placed where the first + of them is, likewise with no attribute.""" + out: "dict[str, attrs.Attribute | None]" = dict.fromkeys( + block_keys(self.cls, name).computed + ) + for a in file_blocks(self.cls)[name]: + if a.metadata.get("row"): + out[name] = None + else: + out[field_key(a)] = a + return out + + def body(self, name: str) -> dict[str, Any]: + """A block that doesn't repeat, by field.""" + values = {key: self.value_of(name, key, a) for key, a in self.entries(name).items()} return {k: v for k, v in values.items() if v is not None} - def value_of(self, name: str, f: Any) -> Any: - """The DFN field `f` of the block `name` as the writer takes it, - or None to leave it out: a binding block's untagged field is its - rows naming children.""" - if name in self.binding_blocks and f is block_keys(self.cls, name).untagged: - return self.bindings(name) - a, value = self.get(name, f) - return None if value is None else self.field(f, a, value) - - def field(self, f: Any, a: "attrs.Attribute | None", value: Any) -> Any: - """The DFN field `f`'s value as the writer takes it, by the type - of the attribute `a` holding it (or of `f`, for a computed one), or + def value_of(self, name: str, key: str, a: "attrs.Attribute | None") -> Any: + """The field's value as the writer takes it, or None to leave it + out. With no attribute, it's a binding block's rows or a computed + field; a MAXBOUND of 0 (no rows) isn't written.""" + if a is None: + return self.bindings(name) if key == name else getattr(self.value, key) or None + value = getattr(self.value, _init_key(a), None) + return None if value is None else self.field(key, a, value) + + def field(self, key: str, a: attrs.Attribute, value: Any) -> Any: + """The field `a`'s value as the writer takes it, by its type, or None to leave it out.""" - meta = a.metadata if a is not None else {} + meta = a.metadata if meta.get("child"): # a child's file record: OBS6 FILEIN - assert a is not None if isinstance(value, list): return [_path_to_tuple(a, _child_path(c)) for c in value if c is not None] or None return _path_to_tuple(a, _child_path(value)) - match meta.get("type", f.type): + match meta.get("type"): case "keyword": return value or None case "integer" | "double": @@ -355,16 +359,13 @@ def field(self, f: Any, a: "attrs.Attribute | None", value: Any) -> Any: case "string": return value or None case "file" if isinstance(value, list): - # a DFN tagged list of file records: one line each - assert a is not None + # a tagged list of file records: one line each return [_path_to_tuple(a, v) for v in value] or None case "file": - assert a is not None return _path_to_tuple(a, value) case "record": if not isinstance(value, Record): - rec = record_type(a.type) if a is not None else None - raise _not_a_record(self.value, a.name if a else f.name, rec or Record, value) + raise _not_a_record(self.value, a.name, record_type(a.type) or Record, value) return value.to_tokens() case "array" if meta.get("shape"): # a grid array; a grid package's are shaped like its grid, @@ -376,13 +377,12 @@ def field(self, f: Any, a: "attrs.Attribute | None", value: Any) -> Any: return _mark_netcdf(_grid_shaped(value, meta, *dims), meta) case "array": # inline (AUXILIARY's names): one line - return (f.name.upper(), *map(str, value)) if len(value) else None + return (key.upper(), *map(str, value)) if len(value) else None case "list" if not value: return None case "list" if isinstance(value[0], tuple): return value case "list": - assert a is not None return _rows(value, self.ncelldim, **self.list_kwargs(a)) return None @@ -401,7 +401,7 @@ def list_kwargs(self, a: attrs.Attribute) -> dict[str, Any]: """A list field's `Rows` arguments, for writing it to a file.""" return _list_kwargs(self.value, _init_key(a), a) # type: ignore[arg-type] - def occurrences(self, name: str, block: Any) -> dict[str, tuple[dict[str, Any], bool]]: + def occurrences(self, name: str) -> dict[str, tuple[dict[str, Any], bool]]: """A repeating block's occurrences by header as written (a period's 1-based number), each its fields and whether it's written even if empty (a grid package's period clearing every boundary). A field @@ -414,13 +414,12 @@ def occurrences(self, name: str, block: Any) -> dict[str, tuple[dict[str, Any], # per period, the (non-aux) arrays given, and those all DNODATA given: dict[Any, set[str]] = {} cleared: dict[Any, set[str]] = {} - for f in block.fields.values(): - a, value = self.get(name, f) + for key, a in self.entries(name).items(): if a is None or not _per_header(a): - if (value := self.value_of(name, f)) is not None: - found.setdefault(1, {})[f.name] = value + if (value := self.value_of(name, key, a)) is not None: + found.setdefault(1, {})[key] = value continue - if value is None: + if (value := getattr(self.value, _init_key(a), None)) is None: continue meta = a.metadata if (blocks := block_list_type(a.type)) is not None: @@ -428,7 +427,7 @@ def occurrences(self, name: str, block: Any) -> dict[str, tuple[dict[str, Any], _, list_name, _ = blocks.parts() for b in value: header_tokens = " ".join(map(str, b.header_tokens())) - found.setdefault(header_tokens, {})[f.name] = _rows( + found.setdefault(header_tokens, {})[key] = _rows( getattr(b, list_name), self.ncelldim ) elif meta.get("fk"): @@ -441,20 +440,18 @@ def occurrences(self, name: str, block: Any) -> dict[str, tuple[dict[str, Any], ) elif is_array(a) and meta.get("fill_forward"): for kper, arr in value.items(): - found.setdefault(kper, {})[f.name] = ( - None - if arr is None - else _period_dataarray(f.name, arr, meta, *self.grid_dims) + found.setdefault(kper, {})[key] = ( + None if arr is None else _period_dataarray(key, arr, meta, *self.grid_dims) ) if self.grid and is_cleared(arr): - cleared.setdefault(kper, set()).add(f.name) - given.setdefault(kper, set()).add(f.name) + cleared.setdefault(kper, set()).add(key) + given.setdefault(kper, set()).add(key) elif is_array(a): # TAS times: {time: array}, a layer each - key = f.name if f.tagged else "" + tag = key if is_tagged(a) else "" for time, arr in value.items(): arr = arr if hasattr(arr, "shape") or isinstance(arr, str) else np.asarray(arr) - found.setdefault(time, {})[key] = _grid_shaped(arr, meta, *self.grid_dims) + found.setdefault(time, {})[tag] = _grid_shaped(arr, meta, *self.grid_dims) elif meta.get("type") == "string": # a word per period (STO's steady-state or transient), untagged, # written uppercase as keywords are @@ -467,7 +464,7 @@ def occurrences(self, name: str, block: Any) -> dict[str, tuple[dict[str, Any], if (kper := _normalize_kper(kper)) is None: continue rows = found.setdefault(kper, {}).setdefault( - f.name, Rows(self.ncelldim, **list_kwargs) + key, Rows(self.ncelldim, **list_kwargs) ) if isinstance(row_list, (list, ItemTable)): rows.append(row_list) diff --git a/flopy4/mf6/converter/ingress/structure.py b/flopy4/mf6/converter/ingress/structure.py index ddcc6e785..6c82ea779 100644 --- a/flopy4/mf6/converter/ingress/structure.py +++ b/flopy4/mf6/converter/ingress/structure.py @@ -41,10 +41,9 @@ from flopy4.mf6.record import Record from flopy4.mf6.spec import ( BlockKeys, - attr_names, binding_fields, block_keys, - dfn, + file_blocks, following_tags, to_field_type, ) @@ -446,7 +445,7 @@ def of(cls, dims: Mapping[str, int]) -> "_Grid | None": return cls({"nodes": nodes, "ncpl": ncpl, **dims}, nlay or 1, ncpl) def size(self, f: Any) -> int: - """How many values the array field `f` holds: its DFN shape (one + """How many values the array field `f` holds: its shape (one dimension, e.g. DIS's `delr` is ``(ncol,)``, `botm` ``(nodes,)``) resolved against the dims, else every node. An unknown field's array is a layer's (a G/A package's).""" @@ -735,22 +734,22 @@ def _header(cls: "type[Component]", block: str, words: list[str]) -> Any: return tuple(words) -def _occurrences(raw: dict, cls: type) -> dict[str, dict[Any, list]]: - """The file's blocks by DFN block name, each as ``{None: rows}``, or for - a repeating block ``{header: rows}`` (see `_header`) in file order. MF6 - ignores a block it doesn't read (an old IMS file's XMD), so one that - isn't in the DFN warns and is skipped; so, silently, is a repeating +def _occurrences(raw: dict, cls: "type[Component]") -> dict[str, dict[Any, list]]: + """The file's blocks by name, each as ``{None: rows}``, or for a + repeating block ``{header: rows}`` (see `_header`) in file order. MF6 + ignores a block it doesn't read (an old IMS file's XMD), so one the + class doesn't have warns and is skipped; so, silently, is a repeating one whose header doesn't parse.""" - blocks = dfn(cls).blocks or {} + blocks = file_blocks(cls) found: dict[str, dict[Any, list]] = {} for raw_name, rows in raw.items(): name, *tokens = raw_name.lower().split() - if (block := blocks.get(name)) is None: + if name not in blocks: if rows: warnings.warn(f"{cls.__name__}: ignoring unknown block {raw_name.upper()}") continue header = None - if block.header is not None: + if name in cls.headers: try: header = _header(cls, name, raw_name.split()[1:]) except ValueError: @@ -924,37 +923,28 @@ def load_child(self, f: Any, token: str) -> Any: class _Load(ComponentLoad): """The basic loader's read of one component's file, a block at a time - in DFN order (see `ComponentLoad`).""" + in file-schema order (see `ComponentLoad`).""" def __init__(self, cls: type, context: LoadContext) -> None: super().__init__(cls, context) self._fields = attrs.fields_dict(cls) - self._names = attr_names(cls) - - def attribute(self, block: str, f: Any) -> "attrs.Attribute | None": - """The class's field holding the DFN field `f` of `block`, if it - has one: not a computed one (a list package's MAXBOUND) or one - codegen leaves out.""" - a = self._fields.get(self._names.get((block, f.name), "")) - return a if a is not None and a.init is not False else None def value_at(self, path: str) -> Any: - """The value read so far for the DFN field at `path` (``block.field``).""" - block, name = path.split(".", 1) - a = self._fields.get(self._names.get((block, name), "")) + """The value read so far for the field at `path` (``block.field``).""" + a = self._fields.get(path.split(".", 1)[1]) return None if a is None else self.kwargs.get(_init_key(a)) - def read(self, name: str, block: Any, found: dict[Any, list]) -> None: - """Read the occurrences of the DFN block `block` into the - arguments (see `ComponentLoad.read_blocks`).""" - fields = [a for f in block.fields.values() if (a := self.attribute(name, f)) is not None] - header = block.header + def read(self, name: str, found: dict[Any, list]) -> None: + """Read the occurrences of the block `name` into the arguments + (see `ComponentLoad.read_blocks`).""" + fields = file_blocks(self.cls)[name] + header = cast("type[Component]", self.cls).headers.get(name) self.read_blocks( name, fields, found, - numbered=header is not None and header.field.type in ("integer", "double"), - fill_forward=header is not None and bool(header.fill_forward), + numbered=header is not None and header.kind in ("integer", "double"), + fill_forward=any(f.metadata.get("fill_forward") for f in fields), ) def body(self, name: str, rows: list, header: Any) -> dict: @@ -966,13 +956,14 @@ def body(self, name: str, rows: list, header: Any) -> dict: unknown word warns, and its records are skipped.""" keys = block_keys(self.cls, name) binds = name in self.binding_blocks - untagged = self.attribute(name, keys.untagged) if keys.untagged else None - if not keys.tagged and not keys.dynamic and not binds: + untagged = keys.untagged + keyed = keys.tagged or keys.dynamic or keys.computed + if not keyed and not binds: value = None if untagged is None else self.untagged(untagged, rows, header) return {} if value is None else {untagged: value} written = rows rows = _resolve_open_close_rows(rows, self.context) - if not keys.tagged and not keys.dynamic: + if not keyed: self.bindings.setdefault(name, []).extend(rows) return {} @@ -980,19 +971,17 @@ def body(self, name: str, rows: list, header: Any) -> dict: lists: dict[attrs.Attribute, list] = {} rest: list = [] for head, *records in _groups(parts(rows)): + if _leading_word(head).lower() in keys.computed: + self.check_computed(name, head) + continue if (found := self.field_of(keys, head)) is None: - if binds or keys.untagged is not None: + if binds or untagged is not None: rest += _rows_of([head, *records]) elif not _is_record(head): self.unknown(name, head) continue - f, aux_name = found - if (a := self.attribute(name, f)) is None: - if isinstance(getattr(self.cls, f.name, None), property): - self.check_computed(name, head) - else: - self.unknown(name, head) - elif _is_grid_array(a): + a, aux_name = found + if _is_grid_array(a): self.array(a, aux_name, [head, *records], header, values) elif item_list_type(a.type) is not None: lists.setdefault(a, []).append(head) @@ -1014,7 +1003,7 @@ def body(self, name: str, rows: list, header: Any) -> dict: return values def field_of(self, keys: BlockKeys, row: Any) -> "tuple[Any, str | None] | None": - """The DFN field whose row `row` is, by its first word, with the + """The field whose row `row` is, by its first word, with the name a dynamic key gives (an auxiliary variable's); None for a row of numbers, or a word no field's. A dynamic key wins: an auxiliary name that matches a field's (Q) is the aux array, as in MF6. Where @@ -1055,9 +1044,9 @@ def unknown(self, name: str, row: list) -> None: ) def check_computed(self, name: str, row: list) -> None: - """Check the row of a computed field (a list package's MAXBOUND, - the only kind there is). Its value is derived, not read, but MF6 - stops on a bad one, so don't load what it wouldn't run.""" + """Check the row of a computed field (see `computed_fields`). Its + value is derived, not read, but MF6 stops on a bad one, so don't load + what it wouldn't run.""" try: from_text(row[1], int) except (IndexError, ValueError): @@ -1170,8 +1159,8 @@ def structure_component( ) -> Any: """Reconstruct a component instance from a raw parsed MF6 input dict. - The file's blocks are read in the order of ``cls``'s DFN, whose - options and dimensions blocks come first (see `_Load`). Each row goes + The file's blocks are read in the order of ``cls``'s fields, options + and dimensions first (see `file_blocks`). Each row goes to the field of its block whose key it begins with, else to the block's untagged field; a repeating block's values are kept by header (see `_occurrences`). The rows naming children are resolved last (see @@ -1206,8 +1195,8 @@ def structure_component( context = context or LoadContext() load = _Load(cls, context) found = _occurrences(raw, cls) - for block_name, block in (dfn(cls).blocks or {}).items(): + for block_name in file_blocks(cls): if block_name in found: - load.read(block_name, block, found[block_name]) + load.read(block_name, found[block_name]) return load.finish(name) diff --git a/flopy4/mf6/dfns/chf-cdb.toml b/flopy4/mf6/dfns/chf-cdb.toml deleted file mode 100644 index 5c58fef0a..000000000 --- a/flopy4/mf6/dfns/chf-cdb.toml +++ /dev/null @@ -1,289 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "chf-cdb" -parent = "chf-nam" -ftype = "CDB6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of critical depth boundary cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of critical depth boundary information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of critical depth boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save flows to budget file" -description = "keyword to indicate that critical depth boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the CDB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CDB package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of critical depth boundaries" -description = "integer value specifying the maximum number of critical depth boundary cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.idcxs] -type = "integer" -longname = "cross section identifier" -description = "is the identifier for the cross section specified in the CXS Package. A value of zero indicates the zero-depth-gradient calculation will use parameters for a hydraulically wide channel." -tagged = false -index = true -fk = "chf-cxs.packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.fields.width] -type = "double" -longname = "width of the zero-depth gradient boundary" -description = "is the channel width of the zero-depth gradient boundary. If a cross section is associated with this boundary, the width will be scaled by the cross section information. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "zero-depth-gradient boundary name" -description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: idcxs, 1: width." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "CDB" -output = true -obs_type = "CDB" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "CDB-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.cdb] -type = "union" - -[observations.cdb.arms.cellid] -type = "cellid" -tagged = false - -[observations.cdb.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/chf-chd.toml b/flopy4/mf6/dfns/chf-chd.toml deleted file mode 100644 index 2ae47358f..000000000 --- a/flopy4/mf6/dfns/chf-chd.toml +++ /dev/null @@ -1,295 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "chf-chd" -parent = "chf-nam" -ftype = "CHD6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of CHD head value." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of constant-head cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of constant-head information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print CHD flows to listing file" -description = "keyword to indicate that the list of constant-head flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save CHD flows to budget file" -description = "keyword to indicate that constant-head flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of constant heads" -description = "integer value specifying the maximum number of constant-head cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.head] -type = "double" -longname = "head value assigned to constant head" -description = "is the head at the boundary. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "constant head boundary name" -description = "name of the constant head boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: head." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "CHD" -output = true -obs_type = "CHD" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.chd] -type = "union" - -[observations.chd.arms.cellid] -type = "cellid" -tagged = false - -[observations.chd.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/chf-cxs.toml b/flopy4/mf6/dfns/chf-cxs.toml deleted file mode 100644 index fe60b1049..000000000 --- a/flopy4/mf6/dfns/chf-cxs.toml +++ /dev/null @@ -1,107 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "chf-cxs" -parent = "chf-nam" -ftype = "CXS6" - -[dims.nsections] -value = "nsections" - -[dims.npoints] -value = "npoints" - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of stream reach information will be written to the listing file immediately after it is read." -optional = true - -[blocks.dimensions.fields.nsections] -type = "integer" -longname = "number of reaches" -description = "integer value specifying the number of cross sections that will be defined. There must be NSECTIONS entries in the PACKAGEDATA block." - -[blocks.dimensions.fields.npoints] -type = "integer" -longname = "total number of points defined for all reaches" -description = "integer value specifying the total number of cross-section points defined for all reaches. There must be NPOINTS entries in the CROSSSECTIONDATA block." - -[blocks.packagedata.fields.packagedata] -type = "list" -shape = [ - "nsections", -] - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.ifno] -type = "integer" -longname = "cross section number for this entry" -description = "integer value that defines the feature (cross section) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NSECTIONS. Information must be specified for every section or the program will terminate with an error. The program will also terminate with an error if information for a section is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.nxspoints] -type = "integer" -longname = "number of points used to define cross section" -description = "integer value that defines the number of points used to define the define the shape of a section. NXSPOINTS must be greater than 1 or the program will terminate with an error. NXSPOINTS defines the number of points that must be entered for the reach in the CROSSSECTIONDATA block. The sum of NXSPOINTS for all sections must equal the NPOINTS dimension." -tagged = false - -[blocks.crosssectiondata.fields.crosssectiondata] -type = "list" -shape = [ - "npoints", -] - -[blocks.crosssectiondata.fields.crosssectiondata.item] -name = "crosssectiondata" -type = "record" - -[blocks.crosssectiondata.fields.crosssectiondata.item.fields.ifno] -type = "integer" -longname = "cross section number for this entry" -description = "integer value that defines the feature (cross section) number associated with the specified CROSSSECTIONDATA data on the line. IFNO must be greater than zero and less than or equal to NSECTIONS. IFNO must be the same for consecutive entries corresponding to the same cross section, and there must be NXSPOINTS consecutive entries, as specified in PACKAGEDATA, for each cross section." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.crosssectiondata.fields.crosssectiondata.item.fields.xfraction] -type = "double" -longname = "fractional width" -description = "real value that defines the station (x) data for the cross-section as a fraction of the width (WIDTH) of the reach. XFRACTION must be greater than or equal to zero but can be greater than one. XFRACTION values can be used to decrease or increase the width of a reach from the specified reach width (WIDTH)." -tagged = false - -[blocks.crosssectiondata.fields.crosssectiondata.item.fields.height] -type = "double" -longname = "depth" -description = "real value that is the height relative to the top of the lowest elevation of the streambed (ELEVATION) and corresponding to the station data on the same line. HEIGHT must be greater than or equal to zero and at least one cross-section height must be equal to zero." -tagged = false - -[blocks.crosssectiondata.fields.crosssectiondata.item.fields.manfraction] -type = "double" -longname = "Manning's roughness coefficient" -description = "real value that defines the Manning's roughness coefficient data for the cross-section as a fraction of the Manning's roughness coefficient for the reach (MANNINGSN) and corresponding to the station data on the same line. MANFRACTION must be greater than zero. MANFRACTION is applied from the XFRACTION value on the same line to the XFRACTION value on the next line." -tagged = false - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.ifno_pkgdata] -set_in = "ar" -source = "ifno" -type = "integer" - -[memory.nsections] -set_in = "ar" -source = "nsections" -type = "integer" - -[memory.npoints] -set_in = "ar" -source = "npoints" -type = "integer" diff --git a/flopy4/mf6/dfns/chf-dfw.toml b/flopy4/mf6/dfns/chf-dfw.toml deleted file mode 100644 index c61ba9ee5..000000000 --- a/flopy4/mf6/dfns/chf-dfw.toml +++ /dev/null @@ -1,159 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "chf-dfw" -parent = "chf-nam" -ftype = "DFW6" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.central_in_space] -type = "keyword" -longname = "use central in space weighting" -description = "keyword to indicate conductance should be calculated using central-in-space weighting instead of the default upstream weighting approach. This option should be used with caution as it does not work well unless all of the stream reaches are saturated. With this option, there is no way for water to flow into a dry reach from connected reaches." -optional = true - -[blocks.options.fields.length_conversion] -type = "double" -longname = "length conversion factor" -description = "real value that is used to convert user-specified Manning's roughness coefficients from meters to model length units. LENGTH_CONVERSION should be set to 3.28081, 1.0, and 100.0 when using length units (LENGTH_UNITS) of feet, meters, or centimeters in the simulation, respectively. LENGTH_CONVERSION does not need to be specified if LENGTH_UNITS are meters." -optional = true - -[blocks.options.fields.time_conversion] -type = "double" -longname = "time conversion factor" -description = "real value that is used to convert user-specified Manning's roughness coefficients from seconds to model time units. TIME_CONVERSION should be set to 1.0, 60.0, 3,600.0, 86,400.0, and 31,557,600.0 when using time units (TIME_UNITS) of seconds, minutes, hours, days, or years in the simulation, respectively. TIME_CONVERSION does not need to be specified if TIME_UNITS are seconds." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "keyword to save DFW flows" -description = "keyword to indicate that budget flow terms will be written to the file specified with 'BUDGET SAVE FILE' in Output Control." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "keyword to print DFW flows to listing file" -description = "keyword to indicate that calculated flows between cells will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period. This option can produce extremely large list files because all cell-by-cell flows are printed. It should only be used with the DFW Package for models that have a small number of cells." -optional = true - -[blocks.options.fields.save_velocity] -type = "keyword" -longname = "keyword to save velocity" -description = "keyword to indicate that x, y, and z components of velocity will be calculated at cell centers and written to the budget file, which is specified with 'BUDGET SAVE FILE' in Output Control. If this option is activated, then additional information may be required in the discretization packages and the GWF Exchange package (if GWF models are coupled). Specifically, ANGLDEGX must be specified in the CONNECTIONDATA block of the DISU Package; ANGLDEGX must also be specified for the GWF Exchange as an auxiliary variable." -optional = true - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.dev_swr_conductance] -type = "keyword" -longname = "use SWR conductance formulation" -description = "use the conductance formulation in the Surface Water Routing (SWR) Process for MODFLOW-2005." -optional = true -developmode = true - -[blocks.griddata.fields.manningsn] -type = "array" -longname = "mannings roughness coefficient" -description = "mannings roughness coefficient" -optional = true -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.idcxs] -type = "array" -longname = "cross section number" -description = "integer value indication the cross section identifier in the Cross Section Package that applies to the reach. If not provided then reach will be treated as hydraulically wide." -optional = true -dtype = "integer" -index = true -fk = "chf-cxs.packagedata.ifno" -shape = [ - "nodes", -] - -[memory.icentral] -set_in = "ar" -source = "central_in_space" -type = "integer" - -[memory.lengthconv] -set_in = "ar" -source = "length_conversion" -type = "double" - -[memory.timeconv] -set_in = "ar" -source = "time_conversion" -type = "double" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.isavvelocity] -set_in = "ar" -source = "save_velocity" -type = "integer" - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.iswrcond] -set_in = "ar" -source = "dev_swr_conductance" -type = "integer" - -[memory.manningsn] -type = "array" -set_in = "ar" -source = "manningsn" -dtype = "double" -shape = [ - "nodes", -] - -[memory.idcxs] -type = "array" -set_in = "ar" -source = "idcxs" -dtype = "integer" -shape = [ - "nodes", -] - -[observations.ext-outflow] -type = "integer" -tagged = false -index = true diff --git a/flopy4/mf6/dfns/chf-disv1d.toml b/flopy4/mf6/dfns/chf-disv1d.toml deleted file mode 100644 index c9bdb068a..000000000 --- a/flopy4/mf6/dfns/chf-disv1d.toml +++ /dev/null @@ -1,258 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "chf-disv1d" -parent = "chf-nam" -ftype = "DISV1D6" - -[dims.nodes] -value = "nodes" -scope = "model" - -[dims.nvert] -value = "nvert" -scope = "model" - -[dims.ncelldim] -value = "1" -scope = "model" - -[runtime_dims.nodes] -set_in = "ar" - -[runtime_dims.nodesuser] -set_in = "ar" - -[blocks.options.fields.length_units] -type = "string" -longname = "model length units" -description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." -optional = true - -[blocks.options.fields.nogrb] -type = "keyword" -longname = "do not write binary grid file" -description = "keyword to deactivate writing of the binary grid file." -optional = true - -[blocks.options.fields.grb_filerecord] -type = "record" -optional = true - -[blocks.options.fields.grb_filerecord.fields.grb6] -type = "keyword" -longname = "grb keyword" -description = "keyword to specify that record corresponds to a binary grid file." - -[blocks.options.fields.grb_filerecord.fields.grb6_filename] -type = "file" -longname = "file name of GRB information" -description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." -tagged = false -direction = "out" - -[blocks.options.fields.xorigin] -type = "double" -longname = "x-position origin of the model grid coordinate system" -description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.yorigin] -type = "double" -longname = "y-position origin of the model grid coordinate system" -description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.angrot] -type = "double" -longname = "rotation angle" -description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.crs] -type = "string" -longname = "CRS user input string" -description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true -case_sensitive = true - -[blocks.dimensions.fields.nodes] -type = "integer" -longname = "number of linear features" -description = "is the number of linear cells." - -[blocks.dimensions.fields.nvert] -type = "integer" -longname = "number of vertices" -description = "is the total number of (x, y, z) vertex pairs used to characterize the model grid." -optional = true - -[blocks.griddata.fields.width] -type = "array" -longname = "width" -description = "real value that defines the width for each one-dimensional cell. WIDTH must be greater than zero. If the Cross Section (CXS) Package is used, then the WIDTH value will be multiplied by the specified cross section x-fraction values." -optional = true -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.bottom] -type = "array" -longname = "bottom elevation for the one-dimensional cell" -description = "bottom elevation for the one-dimensional cell." -optional = true -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.idomain] -type = "array" -longname = "idomain existence array" -description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation." -optional = true -dtype = "integer" -shape = [ - "nodes", -] - -[blocks.vertices.fields.vertices] -type = "list" -longname = "vertices data" -shape = [ - "nvert", -] - -[blocks.vertices.fields.vertices.item] -name = "vertices" -type = "record" - -[blocks.vertices.fields.vertices.item.fields.iv] -type = "integer" -longname = "vertex number" -description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." -tagged = false -index = true -pk = true - -[blocks.vertices.fields.vertices.item.fields.xv] -type = "double" -longname = "x-coordinate for vertex" -description = "is the x-coordinate for the vertex." -tagged = false - -[blocks.vertices.fields.vertices.item.fields.yv] -type = "double" -longname = "y-coordinate for vertex" -description = "is the y-coordinate for the vertex." -tagged = false - -[blocks.cell1d.fields.cell1d] -type = "list" -longname = "cell1d data" -shape = [ - "nodes", -] - -[blocks.cell1d.fields.cell1d.item] -name = "cell1d" -type = "record" - -[blocks.cell1d.fields.cell1d.item.fields.icell1d] -type = "integer" -longname = "cell1d number" -description = "is the cell1d number. Records in the cell1d block must be listed in consecutive order from the first to the last." -tagged = false -index = true -pk = true - -[blocks.cell1d.fields.cell1d.item.fields.fdc] -type = "double" -longname = "fractional distance to the cell center" -description = "is the fractional distance to the cell center. FDC is relative to the first vertex in the ICVERT array. In most cases FDC should be 0.5, which would place the center of the line segment that defines the cell. If the value of FDC is 1, the cell center would located at the last vertex. FDC values of 0 and 1 can be used to place the node at either end of the cell which can be useful for cells with boundary conditions." -tagged = false - -[blocks.cell1d.fields.cell1d.item.fields.ncvert] -type = "integer" -longname = "number of cell vertices" -description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." -tagged = false - -[blocks.cell1d.fields.cell1d.item.fields.icvert] -type = "array" -longname = "number of cell vertices" -description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC." -tagged = false -dtype = "integer" -index = true -shape = [ - "ncvert", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.nodes] -set_in = "ar" -source = "nodes" -type = "integer" - -[memory.nvert] -set_in = "ar" -source = "nvert" -type = "integer" - -[memory.width] -type = "array" -set_in = "ar" -source = "width" -dtype = "double" -shape = [ - "nodes", -] - -[memory.bottom] -type = "array" -set_in = "ar" -source = "bottom" -dtype = "double" -shape = [ - "nodes", -] - -[memory.idomain] -type = "array" -set_in = "ar" -source = "idomain" -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodeuser] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodereduced] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." -dtype = "integer" -shape = [ - "nodesuser", -] diff --git a/flopy4/mf6/dfns/chf-evp.toml b/flopy4/mf6/dfns/chf-evp.toml deleted file mode 100644 index 419888bdd..000000000 --- a/flopy4/mf6/dfns/chf-evp.toml +++ /dev/null @@ -1,295 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "chf-evp" -parent = "chf-nam" -ftype = "EVP6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of evaporation." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of evaporation cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of evaporation information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print evaporation rates to listing file" -description = "keyword to indicate that the list of evaporation flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save evaporation to budget file" -description = "keyword to indicate that evaporation flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the EVP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVP package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of evaporation cells" -description = "integer value specifying the maximum number of evaporation cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.evaporation] -type = "double" -longname = "evaporation rate" -description = "is the evaporation flux rate ($LT^{-1}$). This rate is multiplied inside the program by the water surface area of the cell to calculate the volumetric evaporation rate. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "evaporation name" -description = "name of the evaporation cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: evaporation." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "EVP" -output = true -obs_type = "EVP" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.evp] -type = "union" - -[observations.evp.arms.cellid] -type = "cellid" -tagged = false - -[observations.evp.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/chf-flw.toml b/flopy4/mf6/dfns/chf-flw.toml deleted file mode 100644 index b3f31ef96..000000000 --- a/flopy4/mf6/dfns/chf-flw.toml +++ /dev/null @@ -1,308 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "chf-flw" -parent = "chf-nam" -ftype = "FLW6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of flow rate." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of inflow cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of inflow information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of inflow flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save well flows to budget file" -description = "keyword to indicate that inflow flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the FLW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the FLW package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of inflow" -description = "integer value specifying the maximum number of inflow cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.q] -type = "double" -longname = "well rate" -description = "is the volumetric inflow rate. A positive value indicates inflow to the stream. Negative values are not allows. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "inflow name" -description = "name of the inflow cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: q." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "FLW" -output = true -obs_type = "FLW" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "FLW-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.flw] -type = "union" - -[observations.flw.arms.cellid] -type = "cellid" -tagged = false - -[observations.flw.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/chf-ic.toml b/flopy4/mf6/dfns/chf-ic.toml deleted file mode 100644 index d650d0381..000000000 --- a/flopy4/mf6/dfns/chf-ic.toml +++ /dev/null @@ -1,39 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "chf-ic" -parent = "chf-nam" -ftype = "IC6" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.griddata.fields.strt] -type = "array" -longname = "starting concentration" -description = "is the initial (starting) stage---that is, stage at the beginning of the CHF Model simulation. STRT must be specified for all CHF Model simulations. One value is read for every model reach." -default = 0.0 -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.strt] -type = "array" -set_in = "ar" -source = "strt" -dtype = "double" -shape = [ - "nodes", -] diff --git a/flopy4/mf6/dfns/chf-nam.toml b/flopy4/mf6/dfns/chf-nam.toml deleted file mode 100644 index 5ec3fc03d..000000000 --- a/flopy4/mf6/dfns/chf-nam.toml +++ /dev/null @@ -1,167 +0,0 @@ -type = "model" -schema_version = "2.0.0.dev3" -name = "chf-nam" -parent = "sim-nam" -ftype = "CHF6" -dependent_variable = "stage" - -[runtime_dims.nja] -set_in = "ar" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.list] -type = "string" -longname = "name of listing file" -description = "is name of the listing file to create for this CHF model. If not specified, then the name of the list file will be the basename of the CHF model name file and the '.lst' extension. For example, if the CHF name file is called 'my.model.nam' then the list file will be called 'my.model.lst'." -optional = true -case_sensitive = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save flows for all packages to budget file" -description = "keyword to indicate that all model package flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.newtonoptions] -type = "record" -longname = "newton keyword and options" -description = "none" -optional = true - -[blocks.options.fields.newtonoptions.fields.newton] -type = "keyword" -longname = "keyword to activate Newton-Raphson formulation" -description = "keyword that activates the Newton-Raphson formulation for surface water flow between connected reaches and stress packages that support calculation of Newton-Raphson terms." - -[blocks.options.fields.newtonoptions.fields.under_relaxation] -type = "keyword" -longname = "keyword to activate Newton-Raphson UNDER_RELAXATION option" -description = "keyword that indicates whether the surface water stage in a reach will be under-relaxed when water levels fall below the bottom of the model below any given cell. By default, Newton-Raphson UNDER_RELAXATION is not applied." -optional = true - -[blocks.packages.fields.packages] -type = "list" -longname = "package list" - -[blocks.packages.fields.packages.item] -name = "packages" -type = "record" - -[blocks.packages.fields.packages.item.fields.ftype] -type = "string" -longname = "package type" -description = "is the file type, which must be one of the following character values shown in table~ref{table:ftype-chf}. Ftype may be entered in any combination of uppercase and lowercase." -tagged = false - -[blocks.packages.fields.packages.item.fields.fname] -type = "file" -longname = "file name" -description = "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run." -tagged = false -direction = "in" -mode_keyword = false -component = "package" -component_ftype = "ftype" - -[blocks.packages.fields.packages.item.fields.pname] -type = "string" -longname = "user name for package" -description = "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single CHF Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters." -optional = true -tagged = false -pk = true - -[memory.x] -type = "array" -set_in = "ca" -description = "Stage for each model cell. Checked in from the solution-level dependent-variable vector (or directly allocated when the DFW package is absent). Initialized by the IC package during AR; updated by the nonlinear solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." -obs_type = "STAGE" -dtype = "double" -shape = [ - "nodes", -] - -[memory.xold] -type = "array" -readonly = true -set_in = "ad" -description = "Dependent variable from the end of the previous time step. Copied from X at advance (AD); used to restore X if the adaptive time stepping scheme retries a failed time step." -dtype = "double" -shape = [ - "nodes", -] - -[memory.flowja] -type = "array" -readonly = true -set_in = "cq" -description = "Intercell flows in compressed sparse row (CSR) order, calculated after solution convergence. Diagonal entries hold the flow residual." -budget = "FLOW-JA-FACE" -dtype = "double" -shape = [ - "nja", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution for this model, sliced from the solution-level RHS vector. Rebuilt each solver iteration." -dtype = "double" -shape = [ - "nodes", -] - -[memory.ibound] -type = "array" -set_in = "ar" -description = "Cell activity flag: positive values indicate active cells, zero indicates inactive (no-flow) cells. Set during model initialisation; may change when Newton-Raphson wet-dry logic activates or deactivates cells." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.neq] -readonly = true -set_in = "ar" -description = "Number of equations (unknowns) for this model. Equal to the number of active cells (NODES) for standard models." -type = "integer" - -[memory.idxglo] -type = "array" -readonly = true -set_in = "mc" -description = "Maps each local CSR position to the corresponding row/column index in the global solution matrix. Populated during matrix connectivity (MC) and constant thereafter." -dtype = "integer" -shape = [ - "nja", -] - -[observations.stage] -type = "cellid" -tagged = false - -[observations.flow-ja-face] -type = "record" - -[observations.flow-ja-face.fields.cellid] -type = "cellid" -tagged = false - -[observations.flow-ja-face.fields.cellid2] -type = "cellid" -tagged = false diff --git a/flopy4/mf6/dfns/chf-oc.toml b/flopy4/mf6/dfns/chf-oc.toml deleted file mode 100644 index c943f9d4d..000000000 --- a/flopy4/mf6/dfns/chf-oc.toml +++ /dev/null @@ -1,223 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "chf-oc" -parent = "chf-nam" -ftype = "OC6" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the output file to write budget information. Data are written to this file only for time steps in which SAVE BUDGET is specified in a PERIOD block. If SAVE BUDGET is specified in a PERIOD block and this file is not specified, MODFLOW 6 will terminate with an error." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. If specified, a budget summary record will be written to this file for every time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.qoutflow_filerecord] -type = "record" -optional = true - -[blocks.options.fields.qoutflow_filerecord.fields.qoutflow] -type = "keyword" -longname = "qoutflow keyword" -description = "keyword to specify that record corresponds to qoutflow." - -[blocks.options.fields.qoutflow_filerecord.fields.qoutflowfile] -type = "file" -longname = "file keyword" -description = "name of the output file to write conc information." -tagged = false -direction = "out" - -[blocks.options.fields.stage_filerecord] -type = "record" -optional = true - -[blocks.options.fields.stage_filerecord.fields.stage] -type = "keyword" -longname = "stage keyword" -description = "keyword to specify that record corresponds to stage." - -[blocks.options.fields.stage_filerecord.fields.stagefile] -type = "file" -longname = "file keyword" -description = "name of the output file to write stage information." -tagged = false -direction = "out" - -[blocks.options.fields.qoutflowprintrecord] -type = "record" -optional = true - -[blocks.options.fields.qoutflowprintrecord.fields.qoutflow] -type = "keyword" -longname = "qoutflow keyword" -description = "keyword to specify that record corresponds to qoutflow." - -[blocks.options.fields.qoutflowprintrecord.fields.print_format] -type = "keyword" -longname = "keyword to indicate that a print format follows" -description = "keyword to specify format for printing to the listing file." - -[blocks.options.fields.qoutflowprintrecord.fields.formatrecord] -type = "record" - -[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.columns] -type = "integer" -longname = "number of columns" -description = "number of columns for writing data." -optional = true - -[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.width] -type = "integer" -longname = "width for each number" -description = "width for writing each number." -optional = true - -[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.digits] -type = "integer" -longname = "number of digits" -description = "number of digits to use for writing a number." -optional = true - -[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.format] -type = "string" -longname = "write format" -description = "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC." -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" -optional = true - -[blocks.period.fields.stress_period_data.item] -name = "output_record" -type = "union" - -[blocks.period.fields.stress_period_data.item.arms.saverecord] -type = "record" -optional = true - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.save] -type = "keyword" -longname = "keyword to save" -description = "keyword to indicate that information will be saved this stress period." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.rtype] -type = "string" -longname = "record type" -description = "type of information to save or print. Can be BUDGET." -tagged = false -valid = [ - "STAGE", - "BUDGET", -] - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting] -type = "union" -description = "specifies the steps for which the data will be saved." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.all] -type = "keyword" -description = "keyword to indicate save for all time steps in period." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.first] -type = "keyword" -description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.last] -type = "keyword" -description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.frequency] -type = "integer" -description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.steps] -type = "array" -description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." -dtype = "integer" -shape = [ - "<=nstp", -] - -[blocks.period.fields.stress_period_data.item.arms.printrecord] -type = "record" -optional = true - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.print] -type = "keyword" -longname = "keyword to save" -description = "keyword to indicate that information will be printed this stress period." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.rtype] -type = "string" -longname = "record type" -description = "type of information to save or print. Can be BUDGET." -tagged = false -valid = [ - "STAGE", - "BUDGET", -] - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting] -type = "union" -description = "specifies the steps for which the data will be saved." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.all] -type = "keyword" -description = "keyword to indicate save for all time steps in period." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.first] -type = "keyword" -description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.last] -type = "keyword" -description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.frequency] -type = "integer" -description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.steps] -type = "array" -description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." -dtype = "integer" -shape = [ - "<=nstp", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true diff --git a/flopy4/mf6/dfns/chf-pcp.toml b/flopy4/mf6/dfns/chf-pcp.toml deleted file mode 100644 index 280b4b418..000000000 --- a/flopy4/mf6/dfns/chf-pcp.toml +++ /dev/null @@ -1,295 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "chf-pcp" -parent = "chf-nam" -ftype = "PCP6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of precipitation." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of precipitation cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of precipitation information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print precipitation rates to listing file" -description = "keyword to indicate that the list of precipitation flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save precipitation to budget file" -description = "keyword to indicate that precipitation flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the PCP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the PCP package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of precipitation cells" -description = "integer value specifying the maximum number of precipitation cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.precipitation] -type = "double" -longname = "precipitation rate" -description = "is the precipitation flux rate ($LT^{-1}$). This rate is multiplied inside the program by the surface area of the cell to calculate the volumetric precipitation rate. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "precipitation name" -description = "name of the precipitation cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: precipitation." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "PCP" -output = true -obs_type = "PCP" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.pcp] -type = "union" - -[observations.pcp.arms.cellid] -type = "cellid" -tagged = false - -[observations.pcp.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/chf-sto.toml b/flopy4/mf6/dfns/chf-sto.toml deleted file mode 100644 index 4cf4b2172..000000000 --- a/flopy4/mf6/dfns/chf-sto.toml +++ /dev/null @@ -1,53 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "chf-sto" -parent = "chf-nam" -ftype = "STO6" - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "keyword to save NPF flows" -description = "keyword to indicate that cell-by-cell flow terms will be written to the file specified with 'BUDGET SAVE FILE' in Output Control." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input grid arrays, which already support the layered keyword, should be written to layered ascii output files." -optional = true - -[blocks.period.fields.stress_period_data] -type = "string" -longname = "storage state" -description = "keyword to indicate that stress period IPER is steady-state. Steady-state conditions will apply until the TRANSIENT keyword is specified in a subsequent BEGIN PERIOD block." -optional = true -tagged = false -valid = [ - "steady-state", - "transient", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.steady_state] -set_in = "rp" -type = "logical" diff --git a/flopy4/mf6/dfns/chf-zdg.toml b/flopy4/mf6/dfns/chf-zdg.toml deleted file mode 100644 index 54bb7d1ed..000000000 --- a/flopy4/mf6/dfns/chf-zdg.toml +++ /dev/null @@ -1,324 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "chf-zdg" -parent = "chf-nam" -ftype = "ZDG6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of zero-depth-gradient boundary cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of zero-depth-gradient boundary information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of zero-depth-gradient boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save flows to budget file" -description = "keyword to indicate that zero-depth-gradient boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the ZDG package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ZDG package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of zero-depth-gradient boundaries" -description = "integer value specifying the maximum number of zero-depth-gradient boundary cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.idcxs] -type = "integer" -longname = "cross section identifier" -description = "is the identifier for the cross section specified in the CXS Package. A value of zero indicates the zero-depth-gradient calculation will use parameters for a hydraulically wide channel." -tagged = false -index = true -fk = "chf-cxs.packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.fields.width] -type = "double" -longname = "width of the zero-depth gradient boundary" -description = "is the channel width of the zero-depth gradient boundary. If a cross section is associated with this boundary, the width will be scaled by the cross section information. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.slope] -type = "double" -longname = "channel slope" -description = "is the channel slope used to calculate flow to the zero-depth-gradient boundary. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.rough] -type = "double" -longname = "channel roughness" -description = "is the Manning channel roughness value used to calculate flow to the zero-depth-gradient boundary. If a cross section is associated with this boundary, the roughness value will be multiplied by the roughness fraction for each part of the cross section. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "zero-depth-gradient boundary name" -description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: idcxs, 1: width, 2: slope, 3: rough." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "ZDG" -output = true -obs_type = "ZDG" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "ZDG-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.zdg] -type = "union" - -[observations.zdg.arms.cellid] -type = "cellid" -tagged = false - -[observations.zdg.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/exg-chfgwf.toml b/flopy4/mf6/dfns/exg-chfgwf.toml deleted file mode 100644 index de1fa8925..000000000 --- a/flopy4/mf6/dfns/exg-chfgwf.toml +++ /dev/null @@ -1,147 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "exg-chfgwf" -parent = "sim-nam" -ftype = "CHF6-GWF6" -multi = true -subtype = "exchange" - -[dims.nexg] -value = "nexg" - -[blocks.options.fields.print_input] -type = "keyword" -longname = "keyword to print input to list file" -description = "keyword to indicate that the list of exchange entries will be echoed to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "keyword to print chfgwf flows to list file" -description = "keyword to indicate that the list of exchange flow rates will be printed to the listing file for every stress period in which 'SAVE BUDGET' is specified in Output Control." -optional = true - -[blocks.options.fields.fixed_conductance] -type = "keyword" -longname = "keyword to indicate conductance is fixed" -description = "keyword to indicate that the product of the bedleak and cfact input variables in the exchangedata block represents conductance. This conductance is fixed and does not change as a function of head in the surface water and groundwater models." -optional = true - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the SWF-GWF package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.nexg] -type = "integer" -longname = "number of exchanges" -description = "keyword and integer value specifying the number of SWF-GWF exchanges." - -[blocks.exchangedata.fields.exchangedata] -type = "list" -longname = "exchange data" -shape = [ - "nexg", -] - -[blocks.exchangedata.fields.exchangedata.item] -name = "exchangedata" -type = "record" - -[blocks.exchangedata.fields.exchangedata.item.fields.cellidm1] -type = "cellid" -longname = "cellid of cell in surface water model" -description = "is the cellid of the cell in model 1, which must be the surface water model. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell." -tagged = false -model = "1" - -[blocks.exchangedata.fields.exchangedata.item.fields.cellidm2] -type = "cellid" -longname = "cellid of cell in groundwater model" -description = "is the cellid of the cell in model 2, which must be the groundwater model. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell." -tagged = false -model = "2" - -[blocks.exchangedata.fields.exchangedata.item.fields.bedleak] -type = "double" -longname = "bed leakance" -description = "is the leakance between the surface water and groundwater. bedleak has dimensions of 1/T and is equal to the hydraulic conductivity of the bed sediments divided by the thickness of the bed sediments." -tagged = false - -[blocks.exchangedata.fields.exchangedata.item.fields.cfact] -type = "double" -longname = "factor used for conductance calculation" -description = "is the factor used for the conductance calculation. The definition for this parameter depends the type of surface water model and whether or not the fixed_conductance option is specified. If the fixed_conductance option is specified, then the hydraulic conductance is calculated as the product of bedleak and cfact. In this case, the conductance is fixed and does not change as a function of the calculated surface water and groundwater head. If the fixed_conductance option is not specified, then the definition of cfact depends on whether the surface water model represents one-dimensional channel flow or two-dimensional overland flow. If the surface water model represents one-dimensional channel flow, then cfact is the length of the channel cell in the groundwater model cell. If the surface water model represents two-dimensional overland flow, then cfact is the intersection area of the overland flow cell and the underlying groundwater model cell." -tagged = false - -[memory.ipr_input] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.ipr_flow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ifixedcond] -set_in = "ar" -source = "fixed_conductance" -type = "integer" - -[memory.nexg] -set_in = "ar" -source = "nexg" -type = "integer" - -[memory.nodem1] -type = "array" -set_in = "ar" -source = "cellidm1" -description = "Reduced node number in the surface water model for each exchange, derived from CELLIDM1. Registered as NODEM1 in memory though the Fortran field is named NODESWF." -dtype = "integer" -shape = [ - "nexg", -] - -[memory.nodem2] -type = "array" -set_in = "ar" -source = "cellidm2" -description = "Reduced node number in the GWF model for each exchange, derived from CELLIDM2. Registered as NODEM2 in memory though the Fortran field is named NODEGWF." -dtype = "integer" -shape = [ - "nexg", -] - -[memory.bedleak] -type = "array" -set_in = "ar" -source = "bedleak" -description = "Bed leakance for each exchange." -dtype = "double" -shape = [ - "nexg", -] - -[memory.cfact] -type = "array" -set_in = "ar" -source = "cfact" -description = "Factor used in the conductance calculation for each exchange." -dtype = "double" -shape = [ - "nexg", -] diff --git a/flopy4/mf6/dfns/exg-gwegwe.toml b/flopy4/mf6/dfns/exg-gwegwe.toml deleted file mode 100644 index f91cdd8cb..000000000 --- a/flopy4/mf6/dfns/exg-gwegwe.toml +++ /dev/null @@ -1,317 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "exg-gwegwe" -parent = "sim-nam" -ftype = "GWE6-GWE6" -multi = true -subtype = "exchange" - -[dims.nexg] -value = "nexg" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[blocks.options.fields.gwfmodelname1] -type = "string" -longname = "keyword to specify name of first corresponding GWF Model" -description = "keyword to specify name of first corresponding GWF Model. In the simulation name file, the GWE6-GWE6 entry contains names for GWE Models (exgmnamea and exgmnameb). The GWE Model with the name exgmnamea must correspond to the GWF Model with the name gwfmodelname1." - -[blocks.options.fields.gwfmodelname2] -type = "string" -longname = "keyword to specify name of second corresponding GWF Model" -description = "keyword to specify name of second corresponding GWF Model. In the simulation name file, the GWE6-GWE6 entry contains names for GWE Models (exgmnamea and exgmnameb). The GWE Model with the name exgmnameb must correspond to the GWF Model with the name gwfmodelname2." - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "an array of auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided. Most auxiliary variables will not be used by the GWE-GWE Exchange, but they will be available for use by other parts of the program. If an auxiliary variable with the name 'ANGLDEGX' is found, then this information will be used as the angle (provided in degrees) between the connection face normal and the x axis, where a value of zero indicates that a normal vector points directly along the positive x axis. The connection face normal is a normal vector on the cell face shared between the cell in model 1 and the cell in model 2 pointing away from the model 1 cell. Additional information on 'ANGLDEGX' is provided in the description of the DISU Package. If an auxiliary variable with the name 'CDIST' is found, then this information will be used as the straight-line connection distance, including the vertical component, between the two cell centers. Both ANGLDEGX and CDIST are required if specific discharge is calculated for either of the groundwater models." -optional = true -dtype = "string" - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of GWE Exchange cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "keyword to print input to list file" -description = "keyword to indicate that the list of exchange entries will be echoed to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "keyword to print gwfgwf flows to list file" -description = "keyword to indicate that the list of exchange flow rates will be printed to the listing file for every stress period in which 'SAVE BUDGET' is specified in Output Control." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "keyword to save GWFGWF flows" -description = "keyword to indicate that cell-by-cell flow terms will be written to the budget file for each model provided that the Output Control for the models are set up with the 'BUDGET SAVE FILE' option." -optional = true - -[blocks.options.fields.adv_scheme] -type = "string" -longname = "advective scheme" -description = "scheme used to solve the advection term. Can be upstream, central, or TVD. If not specified, upstream weighting is the default weighting scheme." -optional = true -valid = [ - "upstream", - "central", - "tvd", -] - -[blocks.options.fields.cnd_xt3d_off] -type = "keyword" -longname = "deactivate xt3d" -description = "deactivate the xt3d method for the dispersive flux and use the faster and less accurate approximation for this exchange." -optional = true - -[blocks.options.fields.cnd_xt3d_rhs] -type = "keyword" -longname = "xt3d on right-hand side" -description = "add xt3d dispersion terms to right-hand side, when possible, for this exchange." -optional = true - -[blocks.options.fields.mve_filerecord] -type = "record" -optional = true - -[blocks.options.fields.mve_filerecord.fields.mve6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an energy transport mover file." - -[blocks.options.fields.mve_filerecord.fields.mve6_filename] -type = "file" -longname = "mve6 input filename" -description = "is the file name of the transport mover input file to apply to this exchange. Information for the transport mover are provided in the file provided with these keywords." -tagged = false -direction = "in" -component = "gwe-mve" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwe-obstypetable} lists observation type(s) supported by the GWE-GWE Exchange Package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.dev_interfacemodel_on] -type = "keyword" -longname = "activate interface model on exchange" -description = "activates the interface model mechanism for calculating the coefficients at (and possibly near) the exchange. This keyword should only be used for development purposes." -optional = true -developmode = true - -[blocks.dimensions.fields.nexg] -type = "integer" -longname = "number of exchanges" -description = "keyword and integer value specifying the number of GWE-GWE exchanges." - -[blocks.exchangedata.fields.exchangedata] -type = "list" -longname = "exchange data" -shape = [ - "nexg", -] - -[blocks.exchangedata.fields.exchangedata.item] -name = "exchangedata" -type = "record" - -[blocks.exchangedata.fields.exchangedata.item.fields.cellidm1] -type = "cellid" -longname = "cellid of first cell" -description = "is the cellid of the cell in model 1 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell." -tagged = false -model = "1" - -[blocks.exchangedata.fields.exchangedata.item.fields.cellidm2] -type = "cellid" -longname = "cellid of second cell" -description = "is the cellid of the cell in model 2 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell." -tagged = false -model = "2" - -[blocks.exchangedata.fields.exchangedata.item.fields.ihc] -type = "integer" -longname = "integer flag for connection type" -description = "is an integer flag indicating the direction between node n and all of its m connections. If IHC = 0 then the connection is vertical. If IHC = 1 then the connection is horizontal. If IHC = 2 then the connection is horizontal for a vertically staggered grid." -tagged = false - -[blocks.exchangedata.fields.exchangedata.item.fields.cl1] -type = "double" -longname = "connection distance" -description = "is the distance between the center of cell 1 and the its shared face with cell 2." -tagged = false - -[blocks.exchangedata.fields.exchangedata.item.fields.cl2] -type = "double" -longname = "connection distance" -description = "is the distance between the center of cell 2 and the its shared face with cell 1." -tagged = false - -[blocks.exchangedata.fields.exchangedata.item.fields.hwva] -type = "double" -longname = "horizontal cell width or area for vertical flow" -description = "is the horizontal width of the flow connection between cell 1 and cell 2 if IHC $>$ 0, or it is the area perpendicular to flow of the vertical connection between cell 1 and cell 2 if IHC = 0." -tagged = false - -[blocks.exchangedata.fields.exchangedata.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each GWEGWE Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block." -optional = true -tagged = false -dtype = "double" -shape = [ - "auxiliary", -] - -[blocks.exchangedata.fields.exchangedata.item.fields.boundname] -type = "string" -longname = "exchange boundname" -description = "name of the GWE Exchange cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.dev_ifmod_on] -set_in = "ar" -source = "dev_interfacemodel_on" -type = "logical" - -[memory.auxvar] -type = "array" -set_in = "ar" -source = "aux" -description = "Auxiliary variable values for each exchange." -dtype = "double" -shape = [ - "naux", - "nexg", -] - -[memory.nexg] -set_in = "ar" -source = "nexg" -type = "integer" - -[memory.nodem1] -type = "array" -set_in = "ar" -source = "cellidm1" -description = "Reduced node number in model 1 for each exchange, derived from CELLIDM1." -dtype = "integer" -shape = [ - "nexg", -] - -[memory.nodem2] -type = "array" -set_in = "ar" -source = "cellidm2" -description = "Reduced node number in model 2 for each exchange, derived from CELLIDM2." -dtype = "integer" -shape = [ - "nexg", -] - -[memory.ihc] -type = "array" -set_in = "ar" -source = "ihc" -description = "Connection type flag for each exchange: 0 vertical, 1 horizontal, 2 horizontal for a vertically staggered grid." -dtype = "integer" -shape = [ - "nexg", -] - -[memory.cl1] -type = "array" -set_in = "ar" -source = "cl1" -description = "Distance between the center of the model 1 cell and its shared face." -dtype = "double" -shape = [ - "nexg", -] - -[memory.cl2] -type = "array" -set_in = "ar" -source = "cl2" -description = "Distance between the center of the model 2 cell and its shared face." -dtype = "double" -shape = [ - "nexg", -] - -[memory.hwva] -type = "array" -set_in = "ar" -source = "hwva" -description = "Horizontal width of the connection if IHC > 0, or the area perpendicular to flow of the vertical connection if IHC = 0." -dtype = "double" -shape = [ - "nexg", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.flow-ja-face] -type = "union" - -[observations.flow-ja-face.arms.iexg] -type = "integer" -tagged = false -index = true - -[observations.flow-ja-face.arms.boundname] -type = "string" -tagged = false diff --git a/flopy4/mf6/dfns/exg-gwfgwe.toml b/flopy4/mf6/dfns/exg-gwfgwe.toml deleted file mode 100644 index 937210bdf..000000000 --- a/flopy4/mf6/dfns/exg-gwfgwe.toml +++ /dev/null @@ -1,6 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "exg-gwfgwe" -parent = "sim-nam" -ftype = "GWF6-GWE6" -subtype = "exchange" diff --git a/flopy4/mf6/dfns/exg-gwfgwf.toml b/flopy4/mf6/dfns/exg-gwfgwf.toml deleted file mode 100644 index 545ada77b..000000000 --- a/flopy4/mf6/dfns/exg-gwfgwf.toml +++ /dev/null @@ -1,341 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "exg-gwfgwf" -parent = "sim-nam" -ftype = "GWF6-GWF6" -multi = true -subtype = "exchange" - -[dims.nexg] -value = "nexg" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "an array of auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided. Most auxiliary variables will not be used by the GWF-GWF Exchange, but they will be available for use by other parts of the program. If an auxiliary variable with the name 'ANGLDEGX' is found, then this information will be used as the angle (provided in degrees) between the connection face normal and the x axis, where a value of zero indicates that a normal vector points directly along the positive x axis. The connection face normal is a normal vector on the cell face shared between the cell in model 1 and the cell in model 2 pointing away from the model 1 cell. Additional information on 'ANGLDEGX' and when it is required is provided in the description of the DISU Package. If an auxiliary variable with the name 'CDIST' is found, then this information will be used in the calculation of specific discharge within model cells connected by the exchange. For a horizontal connection, CDIST should be specified as the horizontal distance between the cell centers, and should not include the vertical component. For vertical connections, CDIST should be specified as the difference in elevation between the two cell centers. Both ANGLDEGX and CDIST are required if specific discharge is calculated for either of the groundwater models." -optional = true -dtype = "string" - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of GWF Exchange cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "keyword to print input to list file" -description = "keyword to indicate that the list of exchange entries will be echoed to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "keyword to print gwfgwf flows to list file" -description = "keyword to indicate that the list of exchange flow rates will be printed to the listing file for every stress period in which 'SAVE BUDGET' is specified in Output Control." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "keyword to save GWFGWF flows" -description = "keyword to indicate that cell-by-cell flow terms will be written to the budget file for each model provided that the Output Control for the models are set up with the 'BUDGET SAVE FILE' option." -optional = true - -[blocks.options.fields.cell_averaging] -type = "string" -longname = "conductance weighting option" -description = "is a keyword and text keyword to indicate the method that will be used for calculating the conductance for horizontal cell connections. The text value for CELL_AVERAGING can be 'HARMONIC', 'LOGARITHMIC', or 'AMT-LMK', which means 'arithmetic-mean thickness and logarithmic-mean hydraulic conductivity'. If the user does not specify a value for CELL_AVERAGING, then the harmonic-mean method will be used." -optional = true -valid = [ - "harmonic", - "logarithmic", - "amt-lmk", -] - -[blocks.options.fields.cvoptions] -type = "record" -longname = "vertical conductance options" -description = "none" -optional = true - -[blocks.options.fields.cvoptions.fields.variablecv] -type = "keyword" -longname = "keyword to activate VARIABLECV option" -description = "keyword to indicate that the vertical conductance will be calculated using the saturated thickness and properties of the overlying cell and the thickness and properties of the underlying cell. If the DEWATERED keyword is also specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top. If these keywords are not specified, then the default condition is to calculate the vertical conductance at the start of the simulation using the initial head and the cell properties. The vertical conductance remains constant for the entire simulation." - -[blocks.options.fields.cvoptions.fields.dewatered] -type = "keyword" -longname = "keyword to activate DEWATERED option" -description = "If the DEWATERED keyword is specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top." -optional = true - -[blocks.options.fields.newton] -type = "keyword" -longname = "keyword to activate Newton-Raphson" -description = "keyword that activates the Newton-Raphson formulation for groundwater flow between connected, convertible groundwater cells. Cells will not dry when this option is used." -optional = true - -[blocks.options.fields.xt3d] -type = "keyword" -longname = "keyword to activate XT3D" -description = "keyword that activates the XT3D formulation between the cells connected with this GWF-GWF Exchange." -optional = true - -[blocks.options.fields.gnc_filerecord] -type = "record" -optional = true - -[blocks.options.fields.gnc_filerecord.fields.gnc6] -type = "keyword" -longname = "gnc6 keyword" -description = "keyword to specify that record corresponds to a ghost-node correction file." - -[blocks.options.fields.gnc_filerecord.fields.gnc6_filename] -type = "file" -longname = "gnc6 input filename" -description = "is the file name for ghost node correction input file. Information for the ghost nodes are provided in the file provided with these keywords. The format for specifying the ghost nodes is the same as described for the GNC Package of the GWF Model. This includes specifying OPTIONS, DIMENSIONS, and GNCDATA blocks. The order of the ghost nodes must follow the same order as the order of the cells in the EXCHANGEDATA block. For the GNCDATA, noden and all of the nodej values are assumed to be located in model 1, and nodem is assumed to be in model 2." -tagged = false -direction = "in" -component = "gwf-gnc" - -[blocks.options.fields.mvr_filerecord] -type = "record" -optional = true - -[blocks.options.fields.mvr_filerecord.fields.mvr6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to a mover file." - -[blocks.options.fields.mvr_filerecord.fields.mvr6_filename] -type = "file" -longname = "mvr6 input filename" -description = "is the file name of the water mover input file to apply to this exchange. Information for the water mover are provided in the file provided with these keywords. The format for specifying the water mover information is the same as described for the Water Mover (MVR) Package of the GWF Model, with two exceptions. First, in the PACKAGES block, the model name must be included as a separate string before each package. Second, the appropriate model name must be included before package name 1 and package name 2 in the BEGIN PERIOD block. This allows providers and receivers to be located in both models listed as part of this exchange." -tagged = false -direction = "in" -component = "gwf-mvr" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the GWF-GWF package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.dev_interfacemodel_on] -type = "keyword" -longname = "activate interface model on exchange" -description = "activates the interface model mechanism for calculating the coefficients at (and possibly near) the exchange. This keyword should only be used for development purposes." -optional = true -developmode = true - -[blocks.dimensions.fields.nexg] -type = "integer" -longname = "number of exchanges" -description = "keyword and integer value specifying the number of GWF-GWF exchanges." - -[blocks.exchangedata.fields.exchangedata] -type = "list" -longname = "exchange data" -shape = [ - "nexg", -] - -[blocks.exchangedata.fields.exchangedata.item] -name = "exchangedata" -type = "record" - -[blocks.exchangedata.fields.exchangedata.item.fields.cellidm1] -type = "cellid" -longname = "cellid of first cell" -description = "is the cellid of the cell in model 1 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell." -tagged = false -model = "1" - -[blocks.exchangedata.fields.exchangedata.item.fields.cellidm2] -type = "cellid" -longname = "cellid of second cell" -description = "is the cellid of the cell in model 2 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell." -tagged = false -model = "2" - -[blocks.exchangedata.fields.exchangedata.item.fields.ihc] -type = "integer" -longname = "integer flag for connection type" -description = "is an integer flag indicating the direction between node n and all of its m connections. If IHC = 0 then the connection is vertical. If IHC = 1 then the connection is horizontal. If IHC = 2 then the connection is horizontal for a vertically staggered grid." -tagged = false - -[blocks.exchangedata.fields.exchangedata.item.fields.cl1] -type = "double" -longname = "connection distance" -description = "is the distance between the center of cell 1 and the its shared face with cell 2." -tagged = false - -[blocks.exchangedata.fields.exchangedata.item.fields.cl2] -type = "double" -longname = "connection distance" -description = "is the distance between the center of cell 2 and the its shared face with cell 1." -tagged = false - -[blocks.exchangedata.fields.exchangedata.item.fields.hwva] -type = "double" -longname = "horizontal cell width or area for vertical flow" -description = "is the horizontal width of the flow connection between cell 1 and cell 2 if IHC $>$ 0, or it is the area perpendicular to flow of the vertical connection between cell 1 and cell 2 if IHC = 0." -tagged = false - -[blocks.exchangedata.fields.exchangedata.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each GWFGWF Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block." -optional = true -tagged = false -dtype = "double" -shape = [ - "auxiliary", -] - -[blocks.exchangedata.fields.exchangedata.item.fields.boundname] -type = "string" -longname = "exchange boundname" -description = "name of the GWF Exchange cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.dev_ifmod_on] -set_in = "ar" -source = "dev_interfacemodel_on" -type = "logical" - -[memory.auxvar] -type = "array" -set_in = "ar" -source = "aux" -description = "Auxiliary variable values for each exchange." -dtype = "double" -shape = [ - "naux", - "nexg", -] - -[memory.nexg] -set_in = "ar" -source = "nexg" -type = "integer" - -[memory.nodem1] -type = "array" -set_in = "ar" -source = "cellidm1" -description = "Reduced node number in model 1 for each exchange, derived from CELLIDM1." -dtype = "integer" -shape = [ - "nexg", -] - -[memory.nodem2] -type = "array" -set_in = "ar" -source = "cellidm2" -description = "Reduced node number in model 2 for each exchange, derived from CELLIDM2." -dtype = "integer" -shape = [ - "nexg", -] - -[memory.ihc] -type = "array" -set_in = "ar" -source = "ihc" -description = "Connection type flag for each exchange: 0 vertical, 1 horizontal, 2 horizontal for a vertically staggered grid." -dtype = "integer" -shape = [ - "nexg", -] - -[memory.cl1] -type = "array" -set_in = "ar" -source = "cl1" -description = "Distance between the center of the model 1 cell and its shared face." -dtype = "double" -shape = [ - "nexg", -] - -[memory.cl2] -type = "array" -set_in = "ar" -source = "cl2" -description = "Distance between the center of the model 2 cell and its shared face." -dtype = "double" -shape = [ - "nexg", -] - -[memory.hwva] -type = "array" -set_in = "ar" -source = "hwva" -description = "Horizontal width of the connection if IHC > 0, or the area perpendicular to flow of the vertical connection if IHC = 0." -dtype = "double" -shape = [ - "nexg", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.flow-ja-face] -type = "union" - -[observations.flow-ja-face.arms.iexg] -type = "integer" -tagged = false -index = true - -[observations.flow-ja-face.arms.boundname] -type = "string" -tagged = false diff --git a/flopy4/mf6/dfns/exg-gwfgwt.toml b/flopy4/mf6/dfns/exg-gwfgwt.toml deleted file mode 100644 index 7edb54fa7..000000000 --- a/flopy4/mf6/dfns/exg-gwfgwt.toml +++ /dev/null @@ -1,6 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "exg-gwfgwt" -parent = "sim-nam" -ftype = "GWF6-GWT6" -subtype = "exchange" diff --git a/flopy4/mf6/dfns/exg-gwfprt.toml b/flopy4/mf6/dfns/exg-gwfprt.toml deleted file mode 100644 index 021485823..000000000 --- a/flopy4/mf6/dfns/exg-gwfprt.toml +++ /dev/null @@ -1,6 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "exg-gwfprt" -parent = "sim-nam" -ftype = "GWF6-PRT6" -subtype = "exchange" diff --git a/flopy4/mf6/dfns/exg-gwtgwt.toml b/flopy4/mf6/dfns/exg-gwtgwt.toml deleted file mode 100644 index c2031defe..000000000 --- a/flopy4/mf6/dfns/exg-gwtgwt.toml +++ /dev/null @@ -1,317 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "exg-gwtgwt" -parent = "sim-nam" -ftype = "GWT6-GWT6" -multi = true -subtype = "exchange" - -[dims.nexg] -value = "nexg" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[blocks.options.fields.gwfmodelname1] -type = "string" -longname = "keyword to specify name of first corresponding GWF Model" -description = "keyword to specify name of first corresponding GWF Model. In the simulation name file, the GWT6-GWT6 entry contains names for GWT Models (exgmnamea and exgmnameb). The GWT Model with the name exgmnamea must correspond to the GWF Model with the name gwfmodelname1." - -[blocks.options.fields.gwfmodelname2] -type = "string" -longname = "keyword to specify name of second corresponding GWF Model" -description = "keyword to specify name of second corresponding GWF Model. In the simulation name file, the GWT6-GWT6 entry contains names for GWT Models (exgmnamea and exgmnameb). The GWT Model with the name exgmnameb must correspond to the GWF Model with the name gwfmodelname2." - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "an array of auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided. Most auxiliary variables will not be used by the GWT-GWT Exchange, but they will be available for use by other parts of the program. If an auxiliary variable with the name 'ANGLDEGX' is found, then this information will be used as the angle (provided in degrees) between the connection face normal and the x axis, where a value of zero indicates that a normal vector points directly along the positive x axis. The connection face normal is a normal vector on the cell face shared between the cell in model 1 and the cell in model 2 pointing away from the model 1 cell. Additional information on 'ANGLDEGX' is provided in the description of the DISU Package. ANGLDEGX must be specified if dispersion is simulated in the connected GWT models." -optional = true -dtype = "string" - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of GWT Exchange cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "keyword to print input to list file" -description = "keyword to indicate that the list of exchange entries will be echoed to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "keyword to print gwfgwf flows to list file" -description = "keyword to indicate that the list of exchange flow rates will be printed to the listing file for every stress period in which 'SAVE BUDGET' is specified in Output Control." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "keyword to save GWFGWF flows" -description = "keyword to indicate that cell-by-cell flow terms will be written to the budget file for each model provided that the Output Control for the models are set up with the 'BUDGET SAVE FILE' option." -optional = true - -[blocks.options.fields.adv_scheme] -type = "string" -longname = "advective scheme" -description = "scheme used to solve the advection term. Can be upstream, central, or TVD. If not specified, upstream weighting is the default weighting scheme." -optional = true -valid = [ - "upstream", - "central", - "tvd", -] - -[blocks.options.fields.dsp_xt3d_off] -type = "keyword" -longname = "deactivate xt3d" -description = "deactivate the xt3d method for the dispersive flux and use the faster and less accurate approximation for this exchange." -optional = true - -[blocks.options.fields.dsp_xt3d_rhs] -type = "keyword" -longname = "xt3d on right-hand side" -description = "add xt3d dispersion terms to right-hand side, when possible, for this exchange." -optional = true - -[blocks.options.fields.mvt_filerecord] -type = "record" -optional = true - -[blocks.options.fields.mvt_filerecord.fields.mvt6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to a transport mover file." - -[blocks.options.fields.mvt_filerecord.fields.mvt6_filename] -type = "file" -longname = "mvt6 input filename" -description = "is the file name of the transport mover input file to apply to this exchange. Information for the transport mover are provided in the file provided with these keywords." -tagged = false -direction = "in" -component = "gwt-mvt" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwt-obstypetable} lists observation type(s) supported by the GWT-GWT package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.dev_interfacemodel_on] -type = "keyword" -longname = "activate interface model on exchange" -description = "activates the interface model mechanism for calculating the coefficients at (and possibly near) the exchange. This keyword should only be used for development purposes." -optional = true -developmode = true - -[blocks.dimensions.fields.nexg] -type = "integer" -longname = "number of exchanges" -description = "keyword and integer value specifying the number of GWT-GWT exchanges." - -[blocks.exchangedata.fields.exchangedata] -type = "list" -longname = "exchange data" -shape = [ - "nexg", -] - -[blocks.exchangedata.fields.exchangedata.item] -name = "exchangedata" -type = "record" - -[blocks.exchangedata.fields.exchangedata.item.fields.cellidm1] -type = "cellid" -longname = "cellid of first cell" -description = "is the cellid of the cell in model 1 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell." -tagged = false -model = "1" - -[blocks.exchangedata.fields.exchangedata.item.fields.cellidm2] -type = "cellid" -longname = "cellid of second cell" -description = "is the cellid of the cell in model 2 as specified in the simulation name file. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell." -tagged = false -model = "2" - -[blocks.exchangedata.fields.exchangedata.item.fields.ihc] -type = "integer" -longname = "integer flag for connection type" -description = "is an integer flag indicating the direction between node n and all of its m connections. If IHC = 0 then the connection is vertical. If IHC = 1 then the connection is horizontal. If IHC = 2 then the connection is horizontal for a vertically staggered grid." -tagged = false - -[blocks.exchangedata.fields.exchangedata.item.fields.cl1] -type = "double" -longname = "connection distance" -description = "is the distance between the center of cell 1 and the its shared face with cell 2." -tagged = false - -[blocks.exchangedata.fields.exchangedata.item.fields.cl2] -type = "double" -longname = "connection distance" -description = "is the distance between the center of cell 2 and the its shared face with cell 1." -tagged = false - -[blocks.exchangedata.fields.exchangedata.item.fields.hwva] -type = "double" -longname = "horizontal cell width or area for vertical flow" -description = "is the horizontal width of the flow connection between cell 1 and cell 2 if IHC $>$ 0, or it is the area perpendicular to flow of the vertical connection between cell 1 and cell 2 if IHC = 0." -tagged = false - -[blocks.exchangedata.fields.exchangedata.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each GWTGWT Exchange. The values of auxiliary variables must be present for each exchange. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block." -optional = true -tagged = false -dtype = "double" -shape = [ - "auxiliary", -] - -[blocks.exchangedata.fields.exchangedata.item.fields.boundname] -type = "string" -longname = "exchange boundname" -description = "name of the GWT Exchange cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.dev_ifmod_on] -set_in = "ar" -source = "dev_interfacemodel_on" -type = "logical" - -[memory.auxvar] -type = "array" -set_in = "ar" -source = "aux" -description = "Auxiliary variable values for each exchange." -dtype = "double" -shape = [ - "naux", - "nexg", -] - -[memory.nexg] -set_in = "ar" -source = "nexg" -type = "integer" - -[memory.nodem1] -type = "array" -set_in = "ar" -source = "cellidm1" -description = "Reduced node number in model 1 for each exchange, derived from CELLIDM1." -dtype = "integer" -shape = [ - "nexg", -] - -[memory.nodem2] -type = "array" -set_in = "ar" -source = "cellidm2" -description = "Reduced node number in model 2 for each exchange, derived from CELLIDM2." -dtype = "integer" -shape = [ - "nexg", -] - -[memory.ihc] -type = "array" -set_in = "ar" -source = "ihc" -description = "Connection type flag for each exchange: 0 vertical, 1 horizontal, 2 horizontal for a vertically staggered grid." -dtype = "integer" -shape = [ - "nexg", -] - -[memory.cl1] -type = "array" -set_in = "ar" -source = "cl1" -description = "Distance between the center of the model 1 cell and its shared face." -dtype = "double" -shape = [ - "nexg", -] - -[memory.cl2] -type = "array" -set_in = "ar" -source = "cl2" -description = "Distance between the center of the model 2 cell and its shared face." -dtype = "double" -shape = [ - "nexg", -] - -[memory.hwva] -type = "array" -set_in = "ar" -source = "hwva" -description = "Horizontal width of the connection if IHC > 0, or the area perpendicular to flow of the vertical connection if IHC = 0." -dtype = "double" -shape = [ - "nexg", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.flow-ja-face] -type = "union" - -[observations.flow-ja-face.arms.iexg] -type = "integer" -tagged = false -index = true - -[observations.flow-ja-face.arms.boundname] -type = "string" -tagged = false diff --git a/flopy4/mf6/dfns/exg-olfgwf.toml b/flopy4/mf6/dfns/exg-olfgwf.toml deleted file mode 100644 index c07fa5620..000000000 --- a/flopy4/mf6/dfns/exg-olfgwf.toml +++ /dev/null @@ -1,147 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "exg-olfgwf" -parent = "sim-nam" -ftype = "OLF6-GWF6" -multi = true -subtype = "exchange" - -[dims.nexg] -value = "nexg" - -[blocks.options.fields.print_input] -type = "keyword" -longname = "keyword to print input to list file" -description = "keyword to indicate that the list of exchange entries will be echoed to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "keyword to print olfgwf flows to list file" -description = "keyword to indicate that the list of exchange flow rates will be printed to the listing file for every stress period in which 'SAVE BUDGET' is specified in Output Control." -optional = true - -[blocks.options.fields.fixed_conductance] -type = "keyword" -longname = "keyword to indicate conductance is fixed" -description = "keyword to indicate that the product of the bedleak and cfact input variables in the exchangedata block represents conductance. This conductance is fixed and does not change as a function of head in the surface water and groundwater models." -optional = true - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "is the file name of the observations input file for this exchange. See the 'Observation utility' section for instructions for preparing observation input files. Table ref{table:gwf-obstypetable} lists observation type(s) supported by the SWF-GWF package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.nexg] -type = "integer" -longname = "number of exchanges" -description = "keyword and integer value specifying the number of SWF-GWF exchanges." - -[blocks.exchangedata.fields.exchangedata] -type = "list" -longname = "exchange data" -shape = [ - "nexg", -] - -[blocks.exchangedata.fields.exchangedata.item] -name = "exchangedata" -type = "record" - -[blocks.exchangedata.fields.exchangedata.item.fields.cellidm1] -type = "cellid" -longname = "cellid of cell in surface water model" -description = "is the cellid of the cell in model 1, which must be the surface water model. For a structured grid that uses the DIS input file, CELLIDM1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM1 is the node number for the cell." -tagged = false -model = "1" - -[blocks.exchangedata.fields.exchangedata.item.fields.cellidm2] -type = "cellid" -longname = "cellid of cell in groundwater model" -description = "is the cellid of the cell in model 2, which must be the groundwater model. For a structured grid that uses the DIS input file, CELLIDM2 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM2 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM2 is the node number for the cell." -tagged = false -model = "2" - -[blocks.exchangedata.fields.exchangedata.item.fields.bedleak] -type = "double" -longname = "bed leakance" -description = "is the leakance between the surface water and groundwater. bedleak has dimensions of 1/T and is equal to the hydraulic conductivity of the bed sediments divided by the thickness of the bed sediments." -tagged = false - -[blocks.exchangedata.fields.exchangedata.item.fields.cfact] -type = "double" -longname = "factor used for conductance calculation" -description = "is the factor used for the conductance calculation. The definition for this parameter depends the type of surface water model and whether or not the fixed_conductance option is specified. If the fixed_conductance option is specified, then the hydraulic conductance is calculated as the product of bedleak and cfact. In this case, the conductance is fixed and does not change as a function of the calculated surface water and groundwater head. If the fixed_conductance option is not specified, then the definition of cfact depends on whether the surface water model represents one-dimensional channel flow or two-dimensional overland flow. If the surface water model represents one-dimensional channel flow, then cfact is the length of the channel cell in the groundwater model cell. If the surface water model represents two-dimensional overland flow, then cfact is the intersection area of the overland flow cell and the underlying groundwater model cell." -tagged = false - -[memory.ipr_input] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.ipr_flow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ifixedcond] -set_in = "ar" -source = "fixed_conductance" -type = "integer" - -[memory.nexg] -set_in = "ar" -source = "nexg" -type = "integer" - -[memory.nodem1] -type = "array" -set_in = "ar" -source = "cellidm1" -description = "Reduced node number in the surface water model for each exchange, derived from CELLIDM1. Registered as NODEM1 in memory though the Fortran field is named NODESWF." -dtype = "integer" -shape = [ - "nexg", -] - -[memory.nodem2] -type = "array" -set_in = "ar" -source = "cellidm2" -description = "Reduced node number in the GWF model for each exchange, derived from CELLIDM2. Registered as NODEM2 in memory though the Fortran field is named NODEGWF." -dtype = "integer" -shape = [ - "nexg", -] - -[memory.bedleak] -type = "array" -set_in = "ar" -source = "bedleak" -description = "Bed leakance for each exchange." -dtype = "double" -shape = [ - "nexg", -] - -[memory.cfact] -type = "array" -set_in = "ar" -source = "cfact" -description = "Factor used in the conductance calculation for each exchange." -dtype = "double" -shape = [ - "nexg", -] diff --git a/flopy4/mf6/dfns/gwe-adv.toml b/flopy4/mf6/dfns/gwe-adv.toml deleted file mode 100644 index 5bafab449..000000000 --- a/flopy4/mf6/dfns/gwe-adv.toml +++ /dev/null @@ -1,22 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-adv" -parent = "gwe-nam" -ftype = "ADV6" - -[blocks.options.fields.scheme] -type = "string" -longname = "advective scheme" -description = "scheme used to solve the advection term. Can be upstream, central, TVD, or UTVD. If not specified, upstream weighting is the default weighting scheme." -optional = true -valid = [ - "central", - "upstream", - "tvd", -] - -[blocks.options.fields.ats_percel] -type = "double" -longname = "fractional cell distance used for time step calculation" -description = "fractional cell distance submitted by the ADV Package to the adaptive time stepping (ATS) package. If ATS_PERCEL is specified and the ATS Package is active, a time step calculation will be made for each cell based on flow through the cell and cell properties. The largest time step will be calculated such that the advective fractional cell distance (ATS_PERCEL) is not exceeded for any active cell in the grid. This time-step constraint will be submitted to the ATS Package, perhaps with constraints submitted by other packages, in the calculation of the time step. ATS_PERCEL must be greater than zero. If a value of zero is specified for ATS_PERCEL the program will automatically reset it to an internal no data value to indicate that time steps should not be subject to this constraint." -optional = true diff --git a/flopy4/mf6/dfns/gwe-cnd.toml b/flopy4/mf6/dfns/gwe-cnd.toml deleted file mode 100644 index 2d02f2af3..000000000 --- a/flopy4/mf6/dfns/gwe-cnd.toml +++ /dev/null @@ -1,189 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-cnd" -parent = "gwe-nam" -ftype = "CND6" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.xt3d_off] -type = "keyword" -longname = "deactivate xt3d" -description = "deactivate the xt3d method and use the faster and less accurate approximation. This option may provide a fast and accurate solution under some circumstances, such as when flow aligns with the model grid, there is no mechanical dispersion, or when the longitudinal and transverse dispersivities are equal. This option may also be used to assess the computational demand of the XT3D approach by noting the run time differences with and without this option on." -optional = true - -[blocks.options.fields.xt3d_rhs] -type = "keyword" -longname = "xt3d on right-hand side" -description = "add xt3d terms to right-hand side, when possible. This option uses less memory, but may require more iterations." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.griddata.fields.alh] -type = "array" -longname = "longitudinal dispersivity in horizontal direction" -description = "longitudinal dispersivity in horizontal direction. If flow is strictly horizontal, then this is the longitudinal dispersivity that will be used. If flow is not strictly horizontal or strictly vertical, then the longitudinal dispersivity is a function of both ALH and ALV. If mechanical dispersion is represented (by specifying any dispersivity values) then this array is required." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.alv] -type = "array" -longname = "longitudinal dispersivity in vertical direction" -description = "longitudinal dispersivity in vertical direction. If flow is strictly vertical, then this is the longitudinal dispsersivity value that will be used. If flow is not strictly horizontal or strictly vertical, then the longitudinal dispersivity is a function of both ALH and ALV. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ALH." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.ath1] -type = "array" -longname = "transverse dispersivity in horizontal direction" -description = "transverse dispersivity in horizontal direction. This is the transverse dispersivity value for the second ellipsoid axis. If flow is strictly horizontal and directed in the x direction (along a row for a regular grid), then this value controls spreading in the y direction. If mechanical dispersion is represented (by specifying any dispersivity values) then this array is required." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.ath2] -type = "array" -longname = "transverse dispersivity in horizontal direction" -description = "transverse dispersivity in horizontal direction. This is the transverse dispersivity value for the third ellipsoid axis. If flow is strictly horizontal and directed in the x direction (along a row for a regular grid), then this value controls spreading in the z direction. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ATH1." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.atv] -type = "array" -longname = "transverse dispersivity when flow is in vertical direction" -description = "transverse dispersivity when flow is in vertical direction. If flow is strictly vertical and directed in the z direction, then this value controls spreading in the x and y directions. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ATH2." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.ktw] -type = "array" -longname = "thermal conductivity of the simulated fluid" -description = "thermal conductivity of the simulated fluid. Note that the CND Package does not account for the tortuosity of the flow paths when solving for the conductive spread of heat. If tortuosity plays an important role in the thermal conductivity calculation, its effect should be reflected in the value specified for KTW." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.kts] -type = "array" -longname = "thermal conductivity of the aquifer material" -description = "thermal conductivity of the solid aquifer material" -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.alh] -type = "array" -set_in = "ar" -source = "alh" -dtype = "double" -shape = [ - "nodes", -] - -[memory.alv] -type = "array" -set_in = "ar" -source = "alv" -dtype = "double" -shape = [ - "nodes", -] - -[memory.ath1] -type = "array" -set_in = "ar" -source = "ath1" -dtype = "double" -shape = [ - "nodes", -] - -[memory.ath2] -type = "array" -set_in = "ar" -source = "ath2" -dtype = "double" -shape = [ - "nodes", -] - -[memory.atv] -type = "array" -set_in = "ar" -source = "atv" -dtype = "double" -shape = [ - "nodes", -] - -[memory.ktw] -type = "array" -set_in = "ar" -source = "ktw" -dtype = "double" -shape = [ - "nodes", -] - -[memory.kts] -type = "array" -set_in = "ar" -source = "kts" -dtype = "double" -shape = [ - "nodes", -] diff --git a/flopy4/mf6/dfns/gwe-ctp.toml b/flopy4/mf6/dfns/gwe-ctp.toml deleted file mode 100644 index 579f434ee..000000000 --- a/flopy4/mf6/dfns/gwe-ctp.toml +++ /dev/null @@ -1,300 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-ctp" -parent = "gwe-nam" -ftype = "CTP6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of temperature value." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of constant temperature cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of constant temperature information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of constant temperature flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save constant temperature flows to budget file" -description = "keyword to indicate that constant temperature flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "time series keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the CTP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CTP package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of constant temperatures" -description = "integer value specifying the maximum number of constant temperature cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.temp] -type = "double" -longname = "constant temperature value" -description = "is the constant temperature value. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each constant temperature. The values of auxiliary variables must be present for each constant temperature. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "constant temperature name" -description = "name of the constant temperature cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.tspvar] -set_in = "ad" -source = "temp" -type = "double" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: temp." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "CTP" -output = true -obs_type = "CTP" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.ctp] -type = "union" - -[observations.ctp.arms.cellid] -type = "cellid" -tagged = false - -[observations.ctp.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwe-dis.toml b/flopy4/mf6/dfns/gwe-dis.toml deleted file mode 100644 index 712251fc2..000000000 --- a/flopy4/mf6/dfns/gwe-dis.toml +++ /dev/null @@ -1,302 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-dis" -parent = "gwe-nam" -ftype = "DIS6" - -[dims.nlay] -value = "nlay" -scope = "model" - -[dims.nrow] -value = "nrow" -scope = "model" - -[dims.ncol] -value = "ncol" -scope = "model" - -[dims.ncpl] -value = "nrow * ncol" -scope = "model" - -[dims.nodes] -value = "nlay * nrow * ncol" -scope = "model" - -[dims.ncelldim] -value = "3" -scope = "model" - -[runtime_dims.nodes] -set_in = "ar" - -[runtime_dims.nodesuser] -set_in = "ar" - -[blocks.options.fields.length_units] -type = "string" -longname = "model length units" -description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." -optional = true - -[blocks.options.fields.nogrb] -type = "keyword" -longname = "do not write binary grid file" -description = "keyword to deactivate writing of the binary grid file." -optional = true - -[blocks.options.fields.grb_filerecord] -type = "record" -optional = true - -[blocks.options.fields.grb_filerecord.fields.grb6] -type = "keyword" -longname = "grb keyword" -description = "keyword to specify that record corresponds to a binary grid file." - -[blocks.options.fields.grb_filerecord.fields.grb6_filename] -type = "file" -longname = "file name of GRB information" -description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." -tagged = false -direction = "out" - -[blocks.options.fields.xorigin] -type = "double" -longname = "x-position of the model grid origin" -description = "x-position of the lower-left corner of the model grid. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.yorigin] -type = "double" -longname = "y-position of the model grid origin" -description = "y-position of the lower-left corner of the model grid. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.angrot] -type = "double" -longname = "rotation angle" -description = "counter-clockwise rotation angle (in degrees) of the lower-left corner of the model grid. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.options.fields.crs] -type = "string" -longname = "CRS user input string" -description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true -case_sensitive = true - -[blocks.options.fields.ncf_filerecord] -type = "record" -optional = true - -[blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "keyword" -longname = "ncf keyword" -description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." - -[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] -type = "file" -longname = "file name of NCF information" -description = "defines a NetCDF configuration (NCF) input file." -tagged = false -direction = "in" -component = "utl-ncf" - -[blocks.dimensions.fields.nlay] -type = "integer" -longname = "number of layers" -description = "is the number of layers in the model grid." -default = 1 - -[blocks.dimensions.fields.nrow] -type = "integer" -longname = "number of rows" -description = "is the number of rows in the model grid." -default = 2 - -[blocks.dimensions.fields.ncol] -type = "integer" -longname = "number of columns" -description = "is the number of columns in the model grid." -default = 2 - -[blocks.griddata.fields.delr] -type = "array" -longname = "spacing along a row" -description = "is the column spacing in the row direction." -default = 1.0 -netcdf = true -dtype = "double" -shape = [ - "ncol", -] - -[blocks.griddata.fields.delc] -type = "array" -longname = "spacing along a column" -description = "is the row spacing in the column direction." -default = 1.0 -netcdf = true -dtype = "double" -shape = [ - "nrow", -] - -[blocks.griddata.fields.top] -type = "array" -longname = "cell top elevation" -description = "is the top elevation for each cell in the top model layer." -default = 1.0 -netcdf = true -dtype = "double" -shape = [ - "ncol", - "nrow", -] - -[blocks.griddata.fields.botm] -type = "array" -longname = "cell bottom elevation" -description = "is the bottom elevation for each cell." -default = 0.0 -netcdf = true -dtype = "double" -layered = true -shape = [ - "ncol", - "nrow", - "nlay", -] - -[blocks.griddata.fields.idomain] -type = "array" -longname = "idomain existence array" -description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." -optional = true -netcdf = true -dtype = "integer" -layered = true -shape = [ - "ncol", - "nrow", - "nlay", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.nlay] -set_in = "ar" -source = "nlay" -type = "integer" - -[memory.nrow] -set_in = "ar" -source = "nrow" -type = "integer" - -[memory.ncol] -set_in = "ar" -source = "ncol" -type = "integer" - -[memory.delr] -type = "array" -set_in = "ar" -source = "delr" -dtype = "double" -shape = [ - "ncol", -] - -[memory.delc] -type = "array" -set_in = "ar" -source = "delc" -dtype = "double" -shape = [ - "nrow", -] - -[memory.top] -type = "array" -set_in = "ar" -source = "top" -dtype = "double" -shape = [ - "ncol", - "nrow", -] - -[memory.botm] -type = "array" -set_in = "ar" -source = "botm" -dtype = "double" -shape = [ - "ncol", - "nrow", - "nlay", -] - -[memory.idomain] -type = "array" -set_in = "ar" -source = "idomain" -dtype = "integer" -shape = [ - "ncol", - "nrow", - "nlay", -] - -[memory.area] -type = "array" -readonly = true -set_in = "ar" -description = "Horizontal cell area, computed from grid geometry." -dtype = "double" -shape = [ - "ncpl", -] - -[memory.nodeuser] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodereduced] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." -dtype = "integer" -shape = [ - "nodesuser", -] diff --git a/flopy4/mf6/dfns/gwe-disu.toml b/flopy4/mf6/dfns/gwe-disu.toml deleted file mode 100644 index af1f8fdc2..000000000 --- a/flopy4/mf6/dfns/gwe-disu.toml +++ /dev/null @@ -1,366 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-disu" -parent = "gwe-nam" -ftype = "DISU6" - -[dims.nodes] -value = "nodes" -scope = "model" - -[dims.nja] -value = "nja" -scope = "model" - -[dims.nvert] -value = "nvert" -scope = "model" - -[dims.ncelldim] -value = "1" -scope = "model" - -[dims.njas] -value = "(nja - nodes) / 2" - -[runtime_dims.nodes] -set_in = "ar" - -[runtime_dims.nodesuser] -set_in = "ar" - -[blocks.options.fields.length_units] -type = "string" -longname = "model length units" -description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." -optional = true - -[blocks.options.fields.nogrb] -type = "keyword" -longname = "do not write binary grid file" -description = "keyword to deactivate writing of the binary grid file." -optional = true - -[blocks.options.fields.grb_filerecord] -type = "record" -optional = true - -[blocks.options.fields.grb_filerecord.fields.grb6] -type = "keyword" -longname = "grb keyword" -description = "keyword to specify that record corresponds to a binary grid file." - -[blocks.options.fields.grb_filerecord.fields.grb6_filename] -type = "file" -longname = "file name of GRB information" -description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." -tagged = false -direction = "out" - -[blocks.options.fields.xorigin] -type = "double" -longname = "x-position origin of the model grid coordinate system" -description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.yorigin] -type = "double" -longname = "y-position origin of the model grid coordinate system" -description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.angrot] -type = "double" -longname = "rotation angle" -description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.vertical_offset_tolerance] -type = "double" -longname = "vertical length dimension for top and bottom checking" -description = "checks are performed to ensure that the top of a cell is not higher than the bottom of an overlying cell. This option can be used to specify the tolerance that is used for checking. If top of a cell is above the bottom of an overlying cell by a value less than this tolerance, then the program will not terminate with an error. The default value is zero. This option should generally not be used." -optional = true -default = 0.0 - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.crs] -type = "string" -longname = "CRS user input string" -description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true -case_sensitive = true - -[blocks.dimensions.fields.nodes] -type = "integer" -longname = "number of layers" -description = "is the number of cells in the model grid." - -[blocks.dimensions.fields.nja] -type = "integer" -longname = "number of columns" -description = "is the sum of the number of connections and NODES. When calculating the total number of connections, the connection between cell n and cell m is considered to be different from the connection between cell m and cell n. Thus, NJA is equal to the total number of connections, including n to m and m to n, and the total number of cells." - -[blocks.dimensions.fields.nvert] -type = "integer" -longname = "number of vertices" -description = "is the total number of (x, y) vertex pairs used to define the plan-view shape of each cell in the model grid. If NVERT is not specified or is specified as zero, then the VERTICES and CELL2D blocks below are not read. NVERT and the accompanying VERTICES and CELL2D blocks should be specified for most simulations. If the XT3D or SAVE_SPECIFIC_DISCHARGE options are specified in the NPF Package, then this information is required." -optional = true - -[blocks.griddata.fields.top] -type = "array" -longname = "cell top elevation" -description = "is the top elevation for each cell in the model grid." -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.bot] -type = "array" -longname = "cell bottom elevation" -description = "is the bottom elevation for each cell." -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.area] -type = "array" -longname = "cell surface area" -description = "is the cell surface area (in plan view)." -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.idomain] -type = "array" -longname = "idomain existence array" -description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1 or greater, the cell exists in the simulation. IDOMAIN values of -1 cannot be specified for the DISU Package." -optional = true -dtype = "integer" -shape = [ - "nodes", -] - -[blocks.connectiondata.fields.iac] -type = "array" -longname = "number of cell connections" -description = "is the number of connections (plus 1) for each cell. The sum of all the entries in IAC must be equal to NJA." -dtype = "integer" -shape = [ - "nodes", -] - -[blocks.connectiondata.fields.ja] -type = "array" -longname = "grid connectivity" -description = "is a list of cell number (n) followed by its connecting cell numbers (m) for each of the m cells connected to cell n. The number of values to provide for cell n is IAC(n). This list is sequentially provided for the first to the last cell. The first value in the list must be cell n itself, and the remaining cells must be listed in an increasing order (sorted from lowest number to highest). Note that the cell and its connections are only supplied for the GWE cells and their connections to the other GWE cells. Also note that the JA list input may be divided such that every node and its connectivity list can be on a separate line for ease in readability of the file. To further ease readability of the file, the node number of the cell whose connectivity is subsequently listed, may be expressed as a negative number, the sign of which is subsequently converted to positive by the code." -dtype = "integer" -index = true -shape = [ - "nja", -] - -[blocks.connectiondata.fields.ihc] -type = "array" -longname = "connection type" -description = "is an index array indicating the direction between node n and all of its m connections. If IHC = 0 then cell n and cell m are connected in the vertical direction. Cell n overlies cell m if the cell number for n is less than m; cell m overlies cell n if the cell number for m is less than n. If IHC = 1 then cell n and cell m are connected in the horizontal direction. If IHC = 2 then cell n and cell m are connected in the horizontal direction, and the connection is vertically staggered. A vertically staggered connection is one in which a cell is horizontally connected to more than one cell in a horizontal connection." -dtype = "integer" -shape = [ - "nja", -] - -[blocks.connectiondata.fields.cl12] -type = "array" -longname = "connection lengths" -description = "is the array containing connection lengths between the center of cell n and the shared face with each adjacent m cell." -dtype = "double" -shape = [ - "nja", -] - -[blocks.connectiondata.fields.hwva] -type = "array" -longname = "connection lengths" -description = "is a symmetric array of size NJA. For horizontal connections, entries in HWVA are the horizontal width perpendicular to flow. For vertical connections, entries in HWVA are the vertical area for flow. Thus, values in the HWVA array contain dimensions of both length and area. Entries in the HWVA array have a one-to-one correspondence with the connections specified in the JA array. Likewise, there is a one-to-one correspondence between entries in the HWVA array and entries in the IHC array, which specifies the connection type (horizontal or vertical). Entries in the HWVA array must be symmetric; the program will terminate with an error if the value for HWVA for an n to m connection does not equal the value for HWVA for the corresponding n to m connection." -dtype = "double" -shape = [ - "nja", -] - -[blocks.connectiondata.fields.angldegx] -type = "array" -longname = "angle of face normal to connection" -description = "is the angle (in degrees) between the horizontal x-axis and the outward normal to the face between a cell and its connecting cells. The angle varies between zero and 360.0 degrees, where zero degrees points in the positive x-axis direction, and 90 degrees points in the positive y-axis direction. ANGLDEGX is only needed if horizontal anisotropy is specified in the NPF Package, if the XT3D option is used in the NPF Package, or if the SAVE_SPECIFIC_DISCHARGE option is specified in the NPF Package. ANGLDEGX does not need to be specified if these conditions are not met. ANGLDEGX is of size NJA; values specified for vertical connections and for the diagonal position are not used. Note that ANGLDEGX is read in degrees, which is different from MODFLOW-USG, which reads a similar variable (ANGLEX) in radians." -optional = true -dtype = "double" -shape = [ - "nja", -] - -[blocks.vertices.fields.vertices] -type = "list" -longname = "vertices data" -shape = [ - "nvert", -] - -[blocks.vertices.fields.vertices.item] -name = "vertices" -type = "record" - -[blocks.vertices.fields.vertices.item.fields.iv] -type = "integer" -longname = "vertex number" -description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." -tagged = false -index = true -pk = true - -[blocks.vertices.fields.vertices.item.fields.xv] -type = "double" -longname = "x-coordinate for vertex" -description = "is the x-coordinate for the vertex." -tagged = false - -[blocks.vertices.fields.vertices.item.fields.yv] -type = "double" -longname = "y-coordinate for vertex" -description = "is the y-coordinate for the vertex." -tagged = false - -[blocks.cell2d.fields.cell2d] -type = "list" -longname = "cell2d data" -shape = [ - "nodes", -] - -[blocks.cell2d.fields.cell2d.item] -name = "cell2d" -type = "record" - -[blocks.cell2d.fields.cell2d.item.fields.icell2d] -type = "integer" -longname = "cell2d number" -description = "is the cell2d number. Records in the CELL2D block must be listed in consecutive order from 1 to NODES." -tagged = false -index = true -pk = true - -[blocks.cell2d.fields.cell2d.item.fields.xc] -type = "double" -longname = "x-coordinate for cell center" -description = "is the x-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.yc] -type = "double" -longname = "y-coordinate for cell center" -description = "is the y-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.ncvert] -type = "integer" -longname = "number of cell vertices" -description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.icvert] -type = "array" -longname = "array of vertex numbers" -description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order." -tagged = false -dtype = "integer" -index = true -shape = [ - "ncvert", -] - -[memory.voffsettol] -set_in = "ar" -source = "vertical_offset_tolerance" -type = "double" - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.nodes] -set_in = "ar" -source = "nodes" -type = "integer" - -[memory.nja] -set_in = "ar" -source = "nja" -type = "integer" - -[memory.nvert] -set_in = "ar" -source = "nvert" -type = "integer" - -[memory.top] -type = "array" -set_in = "ar" -source = "top" -dtype = "double" -shape = [ - "nodes", -] - -[memory.bot] -type = "array" -set_in = "ar" -source = "bot" -dtype = "double" -shape = [ - "nodes", -] - -[memory.area] -type = "array" -readonly = true -set_in = "ar" -description = "Horizontal cell area, computed from grid geometry." -dtype = "double" -shape = [ - "nodesuser", -] - -[memory.idomain] -type = "array" -set_in = "ar" -source = "idomain" -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodeuser] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodereduced] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." -dtype = "integer" -shape = [ - "nodesuser", -] diff --git a/flopy4/mf6/dfns/gwe-disv.toml b/flopy4/mf6/dfns/gwe-disv.toml deleted file mode 100644 index f60b9a4f5..000000000 --- a/flopy4/mf6/dfns/gwe-disv.toml +++ /dev/null @@ -1,326 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-disv" -parent = "gwe-nam" -ftype = "DISV6" - -[dims.nlay] -value = "nlay" -scope = "model" - -[dims.ncpl] -value = "ncpl" -scope = "model" - -[dims.nvert] -value = "nvert" -scope = "model" - -[dims.nodes] -value = "nlay * ncpl" -scope = "model" - -[dims.ncelldim] -value = "2" -scope = "model" - -[runtime_dims.nodes] -set_in = "ar" - -[runtime_dims.nodesuser] -set_in = "ar" - -[blocks.options.fields.length_units] -type = "string" -longname = "model length units" -description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." -optional = true - -[blocks.options.fields.nogrb] -type = "keyword" -longname = "do not write binary grid file" -description = "keyword to deactivate writing of the binary grid file." -optional = true - -[blocks.options.fields.grb_filerecord] -type = "record" -optional = true - -[blocks.options.fields.grb_filerecord.fields.grb6] -type = "keyword" -longname = "grb keyword" -description = "keyword to specify that record corresponds to a binary grid file." - -[blocks.options.fields.grb_filerecord.fields.grb6_filename] -type = "file" -longname = "file name of GRB information" -description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." -tagged = false -direction = "out" - -[blocks.options.fields.xorigin] -type = "double" -longname = "x-position origin of the model grid coordinate system" -description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.yorigin] -type = "double" -longname = "y-position origin of the model grid coordinate system" -description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.angrot] -type = "double" -longname = "rotation angle" -description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.options.fields.crs] -type = "string" -longname = "CRS user input string" -description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true -case_sensitive = true - -[blocks.options.fields.ncf_filerecord] -type = "record" -optional = true - -[blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "keyword" -longname = "ncf keyword" -description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." - -[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] -type = "file" -longname = "file name of NCF information" -description = "defines a NetCDF configuration (NCF) input file." -tagged = false -direction = "in" -component = "utl-ncf" - -[blocks.dimensions.fields.nlay] -type = "integer" -longname = "number of layers" -description = "is the number of layers in the model grid." - -[blocks.dimensions.fields.ncpl] -type = "integer" -longname = "number of cells per layer" -description = "is the number of cells per layer. This is a constant value for the grid and it applies to all layers." - -[blocks.dimensions.fields.nvert] -type = "integer" -longname = "number of vertices" -description = "is the total number of (x, y) vertex pairs used to characterize the horizontal configuration of the model grid." - -[blocks.griddata.fields.top] -type = "array" -longname = "model top elevation" -description = "is the top elevation for each cell in the top model layer." -netcdf = true -dtype = "double" -shape = [ - "ncpl", -] - -[blocks.griddata.fields.botm] -type = "array" -longname = "model bottom elevation" -description = "is the bottom elevation for each cell." -netcdf = true -dtype = "double" -layered = true -shape = [ - "ncpl", - "nlay", -] - -[blocks.griddata.fields.idomain] -type = "array" -longname = "idomain existence array" -description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." -optional = true -netcdf = true -dtype = "integer" -layered = true -shape = [ - "ncpl", - "nlay", -] - -[blocks.vertices.fields.vertices] -type = "list" -longname = "vertices data" -shape = [ - "nvert", -] - -[blocks.vertices.fields.vertices.item] -name = "vertices" -type = "record" - -[blocks.vertices.fields.vertices.item.fields.iv] -type = "integer" -longname = "vertex number" -description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." -tagged = false -index = true -pk = true - -[blocks.vertices.fields.vertices.item.fields.xv] -type = "double" -longname = "x-coordinate for vertex" -description = "is the x-coordinate for the vertex." -tagged = false - -[blocks.vertices.fields.vertices.item.fields.yv] -type = "double" -longname = "y-coordinate for vertex" -description = "is the y-coordinate for the vertex." -tagged = false - -[blocks.cell2d.fields.cell2d] -type = "list" -longname = "cell2d data" -shape = [ - "ncpl", -] - -[blocks.cell2d.fields.cell2d.item] -name = "cell2d" -type = "record" - -[blocks.cell2d.fields.cell2d.item.fields.icell2d] -type = "integer" -longname = "cell2d number" -description = "is the CELL2D number. Records in the CELL2D block must be listed in consecutive order from the first to the last." -tagged = false -index = true -pk = true - -[blocks.cell2d.fields.cell2d.item.fields.xc] -type = "double" -longname = "x-coordinate for cell center" -description = "is the x-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.yc] -type = "double" -longname = "y-coordinate for cell center" -description = "is the y-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.ncvert] -type = "integer" -longname = "number of cell vertices" -description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.icvert] -type = "array" -longname = "array of vertex numbers" -description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." -tagged = false -dtype = "integer" -index = true -shape = [ - "ncvert", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.nlay] -set_in = "ar" -source = "nlay" -type = "integer" - -[memory.ncpl] -set_in = "ar" -source = "ncpl" -type = "integer" - -[memory.nvert] -set_in = "ar" -source = "nvert" -type = "integer" - -[memory.top] -type = "array" -set_in = "ar" -source = "top" -dtype = "double" -shape = [ - "ncpl", -] - -[memory.botm] -type = "array" -set_in = "ar" -source = "botm" -dtype = "double" -shape = [ - "ncpl", - "nlay", -] - -[memory.idomain] -type = "array" -set_in = "ar" -source = "idomain" -dtype = "integer" -shape = [ - "ncpl", - "nlay", -] - -[memory.area] -type = "array" -readonly = true -set_in = "ar" -description = "Horizontal cell area, computed from grid geometry." -dtype = "double" -shape = [ - "ncpl", -] - -[memory.nodeuser] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodereduced] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." -dtype = "integer" -shape = [ - "nodesuser", -] diff --git a/flopy4/mf6/dfns/gwe-esl.toml b/flopy4/mf6/dfns/gwe-esl.toml deleted file mode 100644 index be0af9284..000000000 --- a/flopy4/mf6/dfns/gwe-esl.toml +++ /dev/null @@ -1,308 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-esl" -parent = "gwe-nam" -ftype = "ESL6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of energy loading rate." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of energy source loading cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of energy source loading information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of energy source loading flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save ESL flows to budget file" -description = "keyword to indicate that energy source loading flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the ESL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ESL package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of sources" -description = "integer value specifying the maximum number of source cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.senerrate] -type = "double" -longname = "energy source loading rate" -description = "is the energy source loading rate. A positive value indicates addition of energy and a negative value indicates removal of energy. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each energy source. The values of auxiliary variables must be present for each energy source. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "energy source loading name" -description = "name of the energy source cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: senerrate." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "ESL" -output = true -obs_type = "ESL" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "ESL-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.esl] -type = "union" - -[observations.esl.arms.cellid] -type = "cellid" -tagged = false - -[observations.esl.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwe-est.toml b/flopy4/mf6/dfns/gwe-est.toml deleted file mode 100644 index 1233e13c8..000000000 --- a/flopy4/mf6/dfns/gwe-est.toml +++ /dev/null @@ -1,174 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-est" -parent = "gwe-nam" -ftype = "EST6" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save calculated flows to budget file" -description = "keyword to indicate that EST flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.zero_order_decay_water] -type = "keyword" -longname = "activate zero-order decay in aqueous phase" -description = "is a text keyword to indicate that zero-order decay will occur in the aqueous phase. That is, decay occurs in the water and is a rate per volume of water only, not per volume of aquifer (i.e., grid cell). Use of this keyword requires that DECAY_WATER is specified in the GRIDDATA block." -optional = true - -[blocks.options.fields.zero_order_decay_solid] -type = "keyword" -longname = "activate zero-order decay in solid phase" -description = "is a text keyword to indicate that zero-order decay will occur in the solid phase. That is, decay occurs in the solid and is a rate per mass (not volume) of solid only. Use of this keyword requires that DECAY_SOLID is specified in the GRIDDATA block." -optional = true - -[blocks.options.fields.density_water] -type = "double" -longname = "density of water" -description = "density of water used by calculations related to heat storage and conduction. This value is set to 1,000 kg/m3 if no overriding value is specified. A user-specified value should be provided for models that use units other than kilograms and meters or if it is necessary to use a value other than the default." -optional = true -default = 1000.0 - -[blocks.options.fields.heat_capacity_water] -type = "double" -longname = "heat capacity of water" -description = "heat capacity of water used by calculations related to heat storage and conduction. This value is set to 4,184 J/kg/C if no overriding value is specified. A user-specified value should be provided for models that use units other than kilograms, joules, and degrees Celsius or it is necessary to use a value other than the default." -optional = true -default = 4184.0 - -[blocks.options.fields.latent_heat_vaporization] -type = "double" -longname = "latent heat of vaporization" -description = "latent heat of vaporization is the amount of energy that is required to convert a given quantity of liquid into a gas and is associated with evaporative cooling. While the EST package does not simulate evaporation, multiple other packages in a GWE simulation may. To avoid having to specify the latent heat of vaporization in multiple packages, it is specified in a single location and accessed wherever it is needed. For example, evaporation may occur from the surface of streams or lakes and the energy consumed by the change in phase would be needed in both the SFE and LKE packages. This value is set to 2,453,500 J/kg if no overriding value is specified. A user-specified value should be provided for models that use units other than joules and kilograms or if it is necessary to use a value other than the default." -optional = true -default = 2453500.0 - -[blocks.griddata.fields.porosity] -type = "array" -longname = "porosity" -description = "is the mobile domain porosity, defined as the mobile domain pore volume per mobile domain volume. The GWE model does not support the concept of an immobile domain in the context of heat transport." -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.decay_water] -type = "array" -longname = "aqueous phase decay rate coefficient" -description = "is the rate coefficient for zero-order decay for the aqueous phase of the mobile domain. A negative value indicates heat (energy) production. The dimensions of zero-order decay in the aqueous phase are energy per length cubed (volume of water) per time. Zero-order decay in the aqueous phase will have no effect on simulation results unless ZERO_ORDER_DECAY_WATER is specified in the options block." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.decay_solid] -type = "array" -longname = "solid phase decay rate coefficient" -description = "is the rate coefficient for zero-order decay for the solid phase. A negative value indicates heat (energy) production. The dimensions of zero-order decay in the solid phase are energy per mass of solid per time. Zero-order decay in the solid phase will have no effect on simulation results unless ZERO_ORDER_DECAY_SOLID is specified in the options block." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.heat_capacity_solid] -type = "array" -longname = "heat capacity of the aquifer material" -description = "is the mass-based heat capacity of dry solids (aquifer material). For example, units of J/kg/C may be used (or equivalent)." -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.density_solid] -type = "array" -longname = "density of aquifer material" -description = "is a user-specified value of the density of aquifer material not considering the voids. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kilograms per cubic meter." -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[memory.ord0_decay_water] -set_in = "ar" -source = "zero_order_decay_water" -type = "logical" - -[memory.ord0_decay_solid] -set_in = "ar" -source = "zero_order_decay_solid" -type = "logical" - -[memory.rhow] -set_in = "ar" -source = "density_water" -type = "double" - -[memory.cpw] -set_in = "ar" -source = "heat_capacity_water" -type = "double" - -[memory.latheatvap] -set_in = "ar" -source = "latent_heat_vaporization" -type = "double" - -[memory.cps] -type = "array" -set_in = "ar" -source = "heat_capacity_solid" -dtype = "double" -shape = [ - "nodes", -] - -[memory.rhos] -type = "array" -set_in = "ar" -source = "density_solid" -dtype = "double" -shape = [ - "nodes", -] - -[memory.porosity] -type = "array" -set_in = "ar" -source = "porosity" -dtype = "double" -shape = [ - "nodes", -] - -[memory.decay_water] -type = "array" -set_in = "ar" -source = "decay_water" -dtype = "double" -shape = [ - "nodes", -] - -[memory.decay_solid] -type = "array" -set_in = "ar" -source = "decay_solid" -dtype = "double" -shape = [ - "nodes", -] diff --git a/flopy4/mf6/dfns/gwe-fmi.toml b/flopy4/mf6/dfns/gwe-fmi.toml deleted file mode 100644 index e3023eaa0..000000000 --- a/flopy4/mf6/dfns/gwe-fmi.toml +++ /dev/null @@ -1,44 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-fmi" -parent = "gwe-nam" -ftype = "FMI6" - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save calculated flow imbalance correction to budget file" -description = "keyword to indicate that FMI flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.flow_imbalance_correction] -type = "keyword" -longname = "correct for flow imbalance" -description = "correct for an imbalance in flows by assuming that any residual flow error comes in or leaves at the temperature of the cell. When this option is activated, the GWE Model budget written to the listing file will contain two additional entries: FLOW-ERROR and FLOW-CORRECTION. These two entries will be equal but opposite in sign. The FLOW-CORRECTION term is a mass flow that is added to offset the error caused by an imprecise flow balance. If these terms are not relatively small, the flow model should be rerun with stricter convergence tolerances." -optional = true - -[blocks.packagedata.fields.packagedata] -type = "list" -longname = "flowtype list" -optional = true - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.flowtype] -type = "string" -longname = "flow type" -description = "is the word GWFBUDGET, GWFHEAD, GWFGRID, GWFMOVER or the name of an advanced GWF stress package from a previous model run. If GWFBUDGET is specified, then the corresponding file must be a budget file. If GWFHEAD is specified, the file must be a head file. If GWFGRID is specified, the file must be a binary grid file. If GWFMOVER is specified, the file must be a mover file. If an advanced GWF stress package name appears then the corresponding file must be the budget file saved by a LAK, SFR, MAW or UZF Package." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.fname] -type = "file" -longname = "file name" -description = "is the name of the file containing flows. The path to the file should be included if the file is not located in the folder where the program was run." -tagged = false -direction = "in" - -[memory.imbalancecorrect] -set_in = "ar" -source = "flow_imbalance_correction" -type = "logical" diff --git a/flopy4/mf6/dfns/gwe-ic.toml b/flopy4/mf6/dfns/gwe-ic.toml deleted file mode 100644 index 3a6380c51..000000000 --- a/flopy4/mf6/dfns/gwe-ic.toml +++ /dev/null @@ -1,51 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-ic" -parent = "gwe-nam" -ftype = "IC6" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.griddata.fields.strt] -type = "array" -longname = "starting temperature" -description = "is the initial (starting) temperature---that is, the temperature at the beginning of the GWE Model simulation. STRT must be specified for all GWE Model simulations. One value is read for every model cell." -default = 0.0 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.strt] -type = "array" -set_in = "ar" -source = "strt" -dtype = "double" -shape = [ - "nodes", -] diff --git a/flopy4/mf6/dfns/gwe-lke.toml b/flopy4/mf6/dfns/gwe-lke.toml deleted file mode 100644 index 1ffcb06dd..000000000 --- a/flopy4/mf6/dfns/gwe-lke.toml +++ /dev/null @@ -1,638 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-lke" -parent = "gwe-nam" -ftype = "LKE6" -multi = true -subtype = "advanced" - -[dims.auxiliary] -value = "len(auxiliary)" - -[runtime_dims.ncv] -set_in = "ar" - -[blocks.options.fields.flow_package_name] -type = "string" -longname = "keyword to specify name of corresponding flow package" -description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWE name file)." -optional = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.flow_package_auxiliary_name] -type = "string" -longname = "keyword to specify name of temperature auxiliary variable in flow package" -description = "keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated temperatures from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of lake cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of lake information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_temperature] -type = "keyword" -longname = "print calculated temperatures to listing file" -description = "keyword to indicate that the list of lake {#2} will be printed to the listing file for every stress period in which 'TEMPERATURE PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of lake flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save lake flows to budget file" -description = "keyword to indicate that lake flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.temperature_filerecord] -type = "record" -optional = true - -[blocks.options.fields.temperature_filerecord.fields.temperature] -type = "keyword" -longname = "stage keyword" -description = "keyword to specify that record corresponds to temperature." - -[blocks.options.fields.temperature_filerecord.fields.tempfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write temperature information." -tagged = false -direction = "out" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the LKE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LKE package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.dev_nonexpanding_matrix] -type = "keyword" -longname = "do not add rows to the solution matrix" -description = "keyword that solves the feature temperature with a general mixing equation and adds the result to the right-hand side of the GWE equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." -optional = true -developmode = true - -[blocks.packagedata.fields.packagedata] -type = "list" - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.lakeno] -type = "integer" -longname = "lake number for this entry" -description = "integer value that defines the lake number associated with the specified PACKAGEDATA data on the line. LAKENO must be greater than zero and less than or equal to NLAKES. Lake information must be specified for every lake or the program will terminate with an error. The program will also terminate with an error if information for a lake is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.strt] -type = "double" -longname = "starting lake temperature" -description = "real value that defines the starting temperature for the lake." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.ktf] -type = "double" -longname = "boundary thermal conductivity" -description = "is the thermal conductivity of the material between the aquifer cell and the lake. The thickness of the material is defined by the variable RBTHCND." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.rbthcnd] -type = "double" -longname = "streambed thickness" -description = "real value that defines the thickness of the lakebed material through which conduction occurs. Must be greater than 0." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.packagedata.fields.packagedata.item.fields.boundname] -type = "string" -longname = "lake name" -description = "name of the lake cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "lakeperioddata" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.lakeno] -type = "integer" -longname = "lake number for this entry" -description = "integer value that defines the lake number associated with the specified PERIOD data on the line. LAKENO must be greater than zero and less than or equal to NLAKES." -tagged = false -index = true -fk = "packagedata.lakeno" - -[blocks.period.fields.stress_period_data.item.fields.laksetting] -type = "union" -description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the LAKSETTING string include: STATUS, TEMPERATURE, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the temperature associated with the corresponding flow terms. Temperatures cannot be specified for all flow terms. For example, the Lake Package supports a 'WITHDRAWAL' flow term. If this withdrawal term is active, then water will be withdrawn from the lake at the calculated temperature of the lake." - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.status] -type = "string" -longname = "lake temperature status" -description = "keyword option to define lake status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the lake. If a lake is inactive, then there will be no energy fluxes into or out of the lake and the inactive value will be written for the lake temperature. If a lake is constant, then the temperature for the lake will be fixed at the user specified value." - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.temperature] -type = "double" -longname = "lake temperature" -description = "real or character value that defines the temperature for the lake. The specified TEMPERATURE is only applied if the lake is a constant temperature lake. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.rainfall] -type = "double" -longname = "rainfall temperature" -description = "real or character value that defines the rainfall temperature for the lake. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.evaporation] -type = "double" -longname = "evaporation temperature" -description = "use of the EVAPORATION keyword is allowed in the LKE package; however, the specified value is not currently used in LKE calculations. Instead, the latent heat of evaporation is multiplied by the simulated evaporation rate for determining the thermal energy lost from a stream reach." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.runoff] -type = "double" -longname = "runoff temperature" -description = "real or character value that defines the temperature of runoff for the lake. Users are free to use whatever temperature scale they want, which might include negative temperatures. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.ext-inflow] -type = "double" -longname = "ext-inflow temperature" -description = "real or character value that defines the temperature of external inflow for the lake. Users are free to use whatever temperature scale they want, which might include negative temperatures. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord.fields.auxiliary] -type = "keyword" -description = "keyword for specifying auxiliary variable." - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord.fields.auxname] -type = "string" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord.fields.auxval] -type = "double" -longname = "auxiliary variable value" -description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.flow_pkg_name] -set_in = "ar" -source = "flow_package_name" -type = "string" - -[memory.fp_aux_name] -set_in = "ar" -source = "flow_package_auxiliary_name" -type = "string" - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprconc] -set_in = "ar" -source = "print_temperature" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.dev_nonexpanding] -set_in = "ar" -source = "dev_nonexpanding_matrix" -type = "logical" - -[memory.packagedata_ifno] -set_in = "ar" -source = "lakeno" -type = "integer" - -[memory.ifno] -set_in = "rp" -source = "lakeno" -type = "integer" - -[memory.period_auxiliary] -set_in = "rp" -source = "auxiliary" -type = "logical" - -[memory.ncv] -readonly = true -set_in = "ar" -description = "Number of control volumes. Assigned from the linked flow package during AR." -type = "integer" - -[memory.strt] -type = "array" -set_in = "ar" -source = "strt" -description = "Starting temperature for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xnewpak] -type = "array" -set_in = "ca" -description = "Current temperature for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xoldpak] -type = "array" -readonly = true -set_in = "ad" -description = "Temperature from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." -dtype = "double" -shape = [ - "ncv", -] - -[memory.ibound] -type = "array" -set_in = "ar" -description = "Boundary activity flag for each control volume." -dtype = "integer" -shape = [ - "ncv", -] - -[memory.concfeat] -type = "array" -readonly = true -set_in = "cq" -description = "Computed temperature for each feature. Set from XNEWPAK after solver convergence." -dtype = "double" -shape = [ - "ncv", -] - -[memory.qsto] -type = "array" -readonly = true -set_in = "cq" -description = "Storage temperature flow contribution for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.temprain] -type = "array" -set_in = "rp" -description = "Rainfall temperature for each lake." -dtype = "double" -shape = [ - "ncv", -] - -[memory.tempevap] -type = "array" -set_in = "rp" -description = "Evaporation temperature for each lake." -dtype = "double" -shape = [ - "ncv", -] - -[memory.temproff] -type = "array" -set_in = "rp" -description = "Runoff temperature for each lake." -dtype = "double" -shape = [ - "ncv", -] - -[memory.tempiflw] -type = "array" -set_in = "rp" -description = "External inflow temperature for each lake." -dtype = "double" -shape = [ - "ncv", -] - -[memory.ktf] -type = "array" -set_in = "ar" -source = "ktf" -description = "Thermal conductivity of the lakebed (E/T/L/Deg)." -dtype = "double" -shape = [ - "ncv", -] - -[memory.rfeatthk] -type = "array" -set_in = "ar" -source = "rbthcnd" -description = "Thickness of the lakebed conduction layer (L)." -dtype = "double" -shape = [ - "ncv", -] - -[observations.temperature] -type = "union" - -[observations.temperature.arms.lakeno] -type = "integer" -tagged = false -index = true -fk = "packagedata.lakeno" - -[observations.temperature.arms.boundname] -type = "string" -tagged = false - -[observations.storage] -type = "union" - -[observations.storage.arms.lakeno] -type = "integer" -tagged = false -index = true -fk = "packagedata.lakeno" - -[observations.storage.arms.boundname] -type = "string" -tagged = false - -[observations.constant] -type = "union" - -[observations.constant.arms.lakeno] -type = "integer" -tagged = false -index = true -fk = "packagedata.lakeno" - -[observations.constant.arms.boundname] -type = "string" -tagged = false - -[observations.from-mvr] -type = "union" - -[observations.from-mvr.arms.lakeno] -type = "integer" -tagged = false -index = true -fk = "packagedata.lakeno" - -[observations.from-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.lke] -type = "union" - -[observations.lke.arms.lakeno] -type = "integer" -tagged = false -index = true -fk = "packagedata.lakeno" - -[observations.lke.arms.boundname] -type = "string" -tagged = false - -[observations.rainfall] -type = "union" - -[observations.rainfall.arms.lakeno] -type = "integer" -tagged = false -index = true -fk = "packagedata.lakeno" - -[observations.rainfall.arms.boundname] -type = "string" -tagged = false - -[observations.evaporation] -type = "union" - -[observations.evaporation.arms.lakeno] -type = "integer" -tagged = false -index = true -fk = "packagedata.lakeno" - -[observations.evaporation.arms.boundname] -type = "string" -tagged = false - -[observations.runoff] -type = "union" - -[observations.runoff.arms.lakeno] -type = "integer" -tagged = false -index = true -fk = "packagedata.lakeno" - -[observations.runoff.arms.boundname] -type = "string" -tagged = false - -[observations.ext-inflow] -type = "union" - -[observations.ext-inflow.arms.lakeno] -type = "integer" -tagged = false -index = true -fk = "packagedata.lakeno" - -[observations.ext-inflow.arms.boundname] -type = "string" -tagged = false - -[observations.withdrawal] -type = "union" - -[observations.withdrawal.arms.lakeno] -type = "integer" -tagged = false -index = true -fk = "packagedata.lakeno" - -[observations.withdrawal.arms.boundname] -type = "string" -tagged = false - -[observations.ext-outflow] -type = "union" - -[observations.ext-outflow.arms.lakeno] -type = "integer" -tagged = false -index = true -fk = "packagedata.lakeno" - -[observations.ext-outflow.arms.boundname] -type = "string" -tagged = false - -[observations.flow-ja-face] -type = "union" - -[observations.flow-ja-face.arms.lakeno_lakeno2] -type = "record" - -[observations.flow-ja-face.arms.lakeno_lakeno2.fields.lakeno] -type = "integer" -tagged = false -index = true -fk = "packagedata.lakeno" - -[observations.flow-ja-face.arms.lakeno_lakeno2.fields.lakeno2] -type = "integer" -tagged = false -index = true -fk = "packagedata.lakeno" - -[observations.flow-ja-face.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.outletno] -type = "integer" -tagged = false -index = true - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false diff --git a/flopy4/mf6/dfns/gwe-mve.toml b/flopy4/mf6/dfns/gwe-mve.toml deleted file mode 100644 index 5a62335c8..000000000 --- a/flopy4/mf6/dfns/gwe-mve.toml +++ /dev/null @@ -1,82 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-mve" -ftype = "MVE6" -parent = [ - "exg-gwegwe", - "gwe-nam", -] - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of mover information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of lake flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save MVE flows to budget file" -description = "keyword to indicate that lake flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[memory.iprpak] -set_in = "ar" -source = "print_input" -description = "Flag controlling whether mover input is echoed to the listing file." -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -description = "Flag controlling whether mover flow rates are printed to the listing file." -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether mover flows are written to the budget file." -type = "integer" - -[memory.maxpackages] -readonly = true -set_in = "ar" -description = "Number of packages participating in the mover. Computed from the packages that supply or receive moved water." -type = "integer" diff --git a/flopy4/mf6/dfns/gwe-mwe.toml b/flopy4/mf6/dfns/gwe-mwe.toml deleted file mode 100644 index d21d2c8b1..000000000 --- a/flopy4/mf6/dfns/gwe-mwe.toml +++ /dev/null @@ -1,541 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-mwe" -parent = "gwe-nam" -ftype = "MWE6" -multi = true -subtype = "advanced" - -[dims.auxiliary] -value = "len(auxiliary)" - -[runtime_dims.ncv] -set_in = "ar" - -[blocks.options.fields.flow_package_name] -type = "string" -longname = "keyword to specify name of corresponding flow package" -description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWE name file)." -optional = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.flow_package_auxiliary_name] -type = "string" -longname = "keyword to specify name of temperature auxiliary variable in flow package" -description = "keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated temperatures from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of well cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of well information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_temperature] -type = "keyword" -longname = "print calculated temperatures to listing file" -description = "keyword to indicate that the list of well {#2} will be printed to the listing file for every stress period in which 'TEMPERATURE PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of well flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save well flows to budget file" -description = "keyword to indicate that well flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.temperature_filerecord] -type = "record" -optional = true - -[blocks.options.fields.temperature_filerecord.fields.temperature] -type = "keyword" -longname = "stage keyword" -description = "keyword to specify that record corresponds to temperature." - -[blocks.options.fields.temperature_filerecord.fields.tempfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write temperature information." -tagged = false -direction = "out" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the MWE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MWE package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.dev_nonexpanding_matrix] -type = "keyword" -longname = "do not add rows to the solution matrix" -description = "keyword that solves the feature temperature with a general mixing equation and adds the result to the right-hand side of the GWE equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." -optional = true -developmode = true - -[blocks.packagedata.fields.packagedata] -type = "list" - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.mawno] -type = "integer" -longname = "well number for this entry" -description = "integer value that defines the well number associated with the specified PACKAGEDATA data on the line. MAWNO must be greater than zero and less than or equal to NMAWWELLS. Well information must be specified for every well or the program will terminate with an error. The program will also terminate with an error if information for a well is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.strt] -type = "double" -longname = "starting well temperature" -description = "real value that defines the starting temperature for the well." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.ktf] -type = "double" -longname = "thermal conductivity of the feature" -description = "is the thermal conductivity of the material between the aquifer cell and the feature. The thickness of the material is defined by the variable FTHK." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.fthk] -type = "double" -longname = "thickness of the well feature" -description = "real value that defines the thickness of the material through which conduction occurs. Must be greater than 0." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.packagedata.fields.packagedata.item.fields.boundname] -type = "string" -longname = "well name" -description = "name of the well cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "mweperioddata" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.mawno] -type = "integer" -longname = "well number for this entry" -description = "integer value that defines the well number associated with the specified PERIOD data on the line. MAWNO must be greater than zero and less than or equal to NMAWWELLS." -tagged = false -index = true -fk = "packagedata.mawno" - -[blocks.period.fields.stress_period_data.item.fields.mwesetting] -type = "union" -description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the MWESETTING string include: STATUS, TEMPERATURE, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the temperature of associated with the corresponding flow terms. Temperatures cannot be specified for all flow terms. For example, the Multi-Aquifer Well Package supports a 'WITHDRAWAL' flow term. If this withdrawal term is active, then water will be withdrawn from the well at the calculated temperature of the well." - -[blocks.period.fields.stress_period_data.item.fields.mwesetting.arms.status] -type = "string" -longname = "well temperature status" -description = "keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the well. If a well is inactive, then there will be no solute mass fluxes into or out of the well and the inactive value will be written for the well temperature. If a well is constant, then the temperature for the well will be fixed at the user specified value." - -[blocks.period.fields.stress_period_data.item.fields.mwesetting.arms.temperature] -type = "double" -longname = "well temperature" -description = "real or character value that defines the temperature for the well. The specified TEMPERATURE is only applied if the well is a constant temperature well. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.mwesetting.arms.rate] -type = "double" -longname = "well injection temperature" -description = "real or character value that defines the injection temperature $(e.g.,:^{circ}C:or:^{circ}F)$ for the well. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.mwesetting.arms.auxiliaryrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.mwesetting.arms.auxiliaryrecord.fields.auxiliary] -type = "keyword" -description = "keyword for specifying auxiliary variable." - -[blocks.period.fields.stress_period_data.item.fields.mwesetting.arms.auxiliaryrecord.fields.auxname] -type = "string" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.mwesetting.arms.auxiliaryrecord.fields.auxval] -type = "double" -longname = "auxiliary variable value" -description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.flow_pkg_name] -set_in = "ar" -source = "flow_package_name" -type = "string" - -[memory.fp_aux_name] -set_in = "ar" -source = "flow_package_auxiliary_name" -type = "string" - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprconc] -set_in = "ar" -source = "print_temperature" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.dev_nonexpanding] -set_in = "ar" -source = "dev_nonexpanding_matrix" -type = "logical" - -[memory.packagedata_ifno] -set_in = "ar" -source = "mawno" -type = "integer" - -[memory.ifno] -set_in = "rp" -source = "mawno" -type = "integer" - -[memory.period_auxiliary] -set_in = "rp" -source = "auxiliary" -type = "logical" - -[memory.ncv] -readonly = true -set_in = "ar" -description = "Number of control volumes. Assigned from the linked flow package during AR." -type = "integer" - -[memory.strt] -type = "array" -set_in = "ar" -source = "strt" -description = "Starting temperature for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xnewpak] -type = "array" -set_in = "ca" -description = "Current temperature for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xoldpak] -type = "array" -readonly = true -set_in = "ad" -description = "Temperature from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." -dtype = "double" -shape = [ - "ncv", -] - -[memory.ibound] -type = "array" -set_in = "ar" -description = "Boundary activity flag for each control volume." -dtype = "integer" -shape = [ - "ncv", -] - -[memory.concfeat] -type = "array" -readonly = true -set_in = "cq" -description = "Computed temperature for each feature. Set from XNEWPAK after solver convergence." -dtype = "double" -shape = [ - "ncv", -] - -[memory.qsto] -type = "array" -readonly = true -set_in = "cq" -description = "Storage temperature flow contribution for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.temprate] -type = "array" -set_in = "rp" -description = "Pumping-rate temperature for each multi-aquifer well." -dtype = "double" -shape = [ - "ncv", -] - -[memory.ktf] -type = "array" -set_in = "ar" -source = "ktf" -description = "Thermal conductivity of the well casing (E/T/L/Deg)." -dtype = "double" -shape = [ - "ncv", -] - -[memory.rfeatthk] -type = "array" -set_in = "ar" -source = "fthk" -description = "Thickness of the well casing conduction layer (L)." -dtype = "double" -shape = [ - "ncv", -] - -[observations.temperature] -type = "union" - -[observations.temperature.arms.mawno] -type = "integer" -tagged = false -index = true -fk = "packagedata.mawno" - -[observations.temperature.arms.boundname] -type = "string" -tagged = false - -[observations.storage] -type = "union" - -[observations.storage.arms.mawno] -type = "integer" -tagged = false -index = true -fk = "packagedata.mawno" - -[observations.storage.arms.boundname] -type = "string" -tagged = false - -[observations.constant] -type = "union" - -[observations.constant.arms.mawno] -type = "integer" -tagged = false -index = true -fk = "packagedata.mawno" - -[observations.constant.arms.boundname] -type = "string" -tagged = false - -[observations.from-mvr] -type = "union" - -[observations.from-mvr.arms.mawno] -type = "integer" -tagged = false -index = true -fk = "packagedata.mawno" - -[observations.from-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.rate] -type = "union" - -[observations.rate.arms.mawno] -type = "integer" -tagged = false -index = true -fk = "packagedata.mawno" - -[observations.rate.arms.boundname] -type = "string" -tagged = false - -[observations.fw-rate] -type = "union" - -[observations.fw-rate.arms.mawno] -type = "integer" -tagged = false -index = true -fk = "packagedata.mawno" - -[observations.fw-rate.arms.boundname] -type = "string" -tagged = false - -[observations.rate-to-mvr] -type = "union" - -[observations.rate-to-mvr.arms.mawno] -type = "integer" -tagged = false -index = true -fk = "packagedata.mawno" - -[observations.rate-to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.fw-rate-to-mvr] -type = "union" - -[observations.fw-rate-to-mvr.arms.mawno] -type = "integer" -tagged = false -index = true -fk = "packagedata.mawno" - -[observations.fw-rate-to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.mwe] -type = "union" - -[observations.mwe.arms.mawno_iconn] -type = "record" - -[observations.mwe.arms.mawno_iconn.fields.mawno] -type = "integer" -tagged = false -index = true -fk = "packagedata.mawno" - -[observations.mwe.arms.mawno_iconn.fields.iconn] -type = "integer" -tagged = false -index = true - -[observations.mwe.arms.boundname] -type = "string" -tagged = false diff --git a/flopy4/mf6/dfns/gwe-nam.toml b/flopy4/mf6/dfns/gwe-nam.toml deleted file mode 100644 index eb7701352..000000000 --- a/flopy4/mf6/dfns/gwe-nam.toml +++ /dev/null @@ -1,222 +0,0 @@ -type = "model" -schema_version = "2.0.0.dev3" -name = "gwe-nam" -parent = "sim-nam" -ftype = "GWE6" -dependent_variable = "temperature" - -[runtime_dims.nja] -set_in = "ar" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.list] -type = "string" -longname = "name of listing file" -description = "is name of the listing file to create for this GWE model. If not specified, then the name of the list file will be the basename of the GWE model name file and the '.lst' extension. For example, if the GWE name file is called 'my.model.nam' then the list file will be called 'my.model.lst'." -optional = true -case_sensitive = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save flows for all packages to budget file" -description = "keyword to indicate that all model package flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.dependent_variable_scaling] -type = "keyword" -longname = "flag to scale X and RHS" -description = "flag to scale X and RHS to avoid very large positive or negative dependent variable values" -optional = true - -[blocks.options.fields.nc_mesh2d_filerecord] -type = "record" -description = "NetCDF layered mesh fileout record." -optional = true - -[blocks.options.fields.nc_mesh2d_filerecord.fields.netcdf_mesh2d] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to a layered mesh NetCDF file." - -[blocks.options.fields.nc_mesh2d_filerecord.fields.ncmesh2dfile] -type = "file" -longname = "file keyword" -description = "name of the NetCDF ugrid layered mesh output file." -tagged = false -direction = "out" - -[blocks.options.fields.nc_structured_filerecord] -type = "record" -description = "NetCDF structured fileout record." -optional = true - -[blocks.options.fields.nc_structured_filerecord.fields.netcdf_structured] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to a structured NetCDF file." - -[blocks.options.fields.nc_structured_filerecord.fields.ncstructfile] -type = "file" -longname = "file keyword" -description = "name of the NetCDF structured output file." -tagged = false -direction = "out" - -[blocks.options.fields.nc_filerecord] -type = "record" -description = "NetCDF filerecord" -optional = true - -[blocks.options.fields.nc_filerecord.fields.netcdf] -type = "keyword" -longname = "netcdf keyword" -description = "keyword to specify that record corresponds to a NetCDF input file." - -[blocks.options.fields.nc_filerecord.fields.netcdf_filename] -type = "file" -longname = "netcdf input filename" -description = "defines a NetCDF input file." -tagged = false -direction = "in" - -[blocks.packages.fields.packages] -type = "list" -longname = "package list" - -[blocks.packages.fields.packages.item] -name = "packages" -type = "record" - -[blocks.packages.fields.packages.item.fields.ftype] -type = "string" -longname = "package type" -description = "is the file type, which must be one of the following character values shown in table~ref{table:ftype-gwe}. Ftype may be entered in any combination of uppercase and lowercase." -tagged = false - -[blocks.packages.fields.packages.item.fields.fname] -type = "file" -longname = "file name" -description = "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run." -tagged = false -direction = "in" -mode_keyword = false -component = "package" -component_ftype = "ftype" - -[blocks.packages.fields.packages.item.fields.pname] -type = "string" -longname = "user name for package" -description = "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single GWE Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters." -optional = true -tagged = false -pk = true - -[memory.idv_scale] -set_in = "ar" -source = "dependent_variable_scaling" -type = "integer" - -[memory.netcdf_struct] -set_in = "ar" -source = "netcdf_structured" -type = "logical" - -[memory.netcdf_fname] -set_in = "ar" -source = "netcdf_filename" -type = "string" - -[memory.x] -type = "array" -set_in = "ca" -description = "Temperature for each model cell. Checked in from the solution-level dependent-variable vector. Initialized by the IC package during AR; updated by the nonlinear solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." -obs_type = "TEMPERATURE" -dtype = "double" -shape = [ - "nodes", -] - -[memory.xold] -type = "array" -readonly = true -set_in = "ad" -description = "Dependent variable from the end of the previous time step. Copied from X at advance (AD); used to restore X if the adaptive time stepping scheme retries a failed time step." -dtype = "double" -shape = [ - "nodes", -] - -[memory.flowja] -type = "array" -readonly = true -set_in = "cq" -description = "Intercell flows in compressed sparse row (CSR) order, calculated after solution convergence. Diagonal entries hold the flow residual." -budget = "FLOW-JA-FACE" -dtype = "double" -shape = [ - "nja", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution for this model, sliced from the solution-level RHS vector. Rebuilt each solver iteration." -dtype = "double" -shape = [ - "nodes", -] - -[memory.ibound] -type = "array" -set_in = "ar" -description = "Cell activity flag: positive values indicate active cells, zero indicates inactive (no-flow) cells. Set during model initialisation; may change when Newton-Raphson wet-dry logic activates or deactivates cells." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.neq] -readonly = true -set_in = "ar" -description = "Number of equations (unknowns) for this model. Equal to the number of active cells (NODES) for standard models." -type = "integer" - -[memory.idxglo] -type = "array" -readonly = true -set_in = "mc" -description = "Maps each local CSR position to the corresponding row/column index in the global solution matrix. Populated during matrix connectivity (MC) and constant thereafter." -dtype = "integer" -shape = [ - "nja", -] - -[observations.temperature] -type = "cellid" -tagged = false - -[observations.flow-ja-face] -type = "record" - -[observations.flow-ja-face.fields.cellid] -type = "cellid" -tagged = false - -[observations.flow-ja-face.fields.cellid2] -type = "cellid" -tagged = false diff --git a/flopy4/mf6/dfns/gwe-oc.toml b/flopy4/mf6/dfns/gwe-oc.toml deleted file mode 100644 index 9922249bd..000000000 --- a/flopy4/mf6/dfns/gwe-oc.toml +++ /dev/null @@ -1,212 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-oc" -parent = "gwe-nam" -ftype = "OC6" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the output file to write budget information. Data are written to this file only for time steps in which SAVE BUDGET is specified in a PERIOD block. If SAVE BUDGET is specified in a PERIOD block and this file is not specified, MODFLOW 6 will terminate with an error." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. If specified, a budget summary record will be written to this file for every time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.temperature_filerecord] -type = "record" -optional = true - -[blocks.options.fields.temperature_filerecord.fields.temperature] -type = "keyword" -longname = "temperature keyword" -description = "keyword to specify that record corresponds to temperature." - -[blocks.options.fields.temperature_filerecord.fields.temperaturefile] -type = "file" -longname = "file keyword" -description = "name of the output file to write temperature information." -tagged = false -direction = "out" - -[blocks.options.fields.temperatureprintrecord] -type = "record" -optional = true - -[blocks.options.fields.temperatureprintrecord.fields.temperature] -type = "keyword" -longname = "temperature keyword" -description = "keyword to specify that record corresponds to temperature." - -[blocks.options.fields.temperatureprintrecord.fields.print_format] -type = "keyword" -longname = "keyword to indicate that a print format follows" -description = "keyword to specify format for printing to the listing file." - -[blocks.options.fields.temperatureprintrecord.fields.formatrecord] -type = "record" - -[blocks.options.fields.temperatureprintrecord.fields.formatrecord.fields.columns] -type = "integer" -longname = "number of columns" -description = "number of columns for writing data." -optional = true - -[blocks.options.fields.temperatureprintrecord.fields.formatrecord.fields.width] -type = "integer" -longname = "width for each number" -description = "width for writing each number." -optional = true - -[blocks.options.fields.temperatureprintrecord.fields.formatrecord.fields.digits] -type = "integer" -longname = "number of digits" -description = "number of digits to use for writing a number." -optional = true - -[blocks.options.fields.temperatureprintrecord.fields.formatrecord.fields.format] -type = "string" -longname = "write format" -description = "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC." -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" -optional = true - -[blocks.period.fields.stress_period_data.item] -name = "output_record" -type = "union" - -[blocks.period.fields.stress_period_data.item.arms.saverecord] -type = "record" -optional = true - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.save] -type = "keyword" -longname = "keyword to save" -description = "keyword to indicate that information will be saved this stress period." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.rtype] -type = "string" -longname = "record type" -description = "type of information to save or print. Can be BUDGET or TEMPERATURE." -tagged = false -valid = [ - "TEMPERATURE", - "BUDGET", -] - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting] -type = "union" -description = "specifies the steps for which the data will be saved." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.all] -type = "keyword" -description = "keyword to indicate save for all time steps in period." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.first] -type = "keyword" -description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.last] -type = "keyword" -description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.frequency] -type = "integer" -description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.steps] -type = "array" -description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." -dtype = "integer" -shape = [ - "<=nstp", -] - -[blocks.period.fields.stress_period_data.item.arms.printrecord] -type = "record" -optional = true - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.print] -type = "keyword" -longname = "keyword to save" -description = "keyword to indicate that information will be printed this stress period." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.rtype] -type = "string" -longname = "record type" -description = "type of information to save or print. Can be BUDGET or TEMPERATURE." -tagged = false -valid = [ - "TEMPERATURE", - "BUDGET", -] - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting] -type = "union" -description = "specifies the steps for which the data will be saved." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.all] -type = "keyword" -description = "keyword to indicate save for all time steps in period." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.first] -type = "keyword" -description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.last] -type = "keyword" -description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.frequency] -type = "integer" -description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.steps] -type = "array" -description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." -dtype = "integer" -shape = [ - "<=nstp", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.tempfile] -set_in = "ar" -source = "temperaturefile" -type = "string" diff --git a/flopy4/mf6/dfns/gwe-sfe.toml b/flopy4/mf6/dfns/gwe-sfe.toml deleted file mode 100644 index e27839add..000000000 --- a/flopy4/mf6/dfns/gwe-sfe.toml +++ /dev/null @@ -1,659 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-sfe" -parent = "gwe-nam" -ftype = "SFE6" -multi = true -subtype = "advanced" - -[dims.auxiliary] -value = "len(auxiliary)" - -[runtime_dims.ncv] -set_in = "ar" - -[blocks.options.fields.flow_package_name] -type = "string" -longname = "keyword to specify name of corresponding flow package" -description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWE name file)." -optional = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.flow_package_auxiliary_name] -type = "string" -longname = "keyword to specify name of temperature auxiliary variable in flow package" -description = "keyword to specify the name of an auxiliary variable provided in the corresponding flow package (i.e., FLOW_PACKAGE_NAME). If specified, then the simulated temperatures from this advanced energy transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced energy transport package are read from a file, then this option will have no effect." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of reach cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of reach information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_temperature] -type = "keyword" -longname = "print calculated temperature to listing file" -description = "keyword to indicate that the list of reach {#2} will be printed to the listing file for every stress period in which 'TEMPERATURE PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of reach flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save reach flows to budget file" -description = "keyword to indicate that reach flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.temperature_filerecord] -type = "record" -optional = true - -[blocks.options.fields.temperature_filerecord.fields.temperature] -type = "keyword" -longname = "temperature keyword" -description = "keyword to specify that record corresponds to temperature." - -[blocks.options.fields.temperature_filerecord.fields.tempfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write temperature information." -tagged = false -direction = "out" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the SFE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFE package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.dev_nonexpanding_matrix] -type = "keyword" -longname = "do not add rows to the solution matrix" -description = "keyword that solves the feature temperature with a general mixing equation and adds the result to the right-hand side of the GWE equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." -optional = true -developmode = true - -[blocks.packagedata.fields.packagedata] -type = "list" - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.rno] -type = "integer" -longname = "reach number for this entry" -description = "integer value that defines the reach number associated with the specified PACKAGEDATA data on the line. RNO must be greater than zero and less than or equal to NREACHES. Reach information must be specified for every reach or the program will terminate with an error. The program will also terminate with an error if information for a reach is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.strt] -type = "double" -longname = "starting reach temperature" -description = "real value that defines the starting temperature for the reach." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.ktf] -type = "double" -longname = "boundary thermal conductivity" -description = "is the thermal conductivity of the material between the aquifer cell and the stream reach. The thickness of the material is defined by the variable RBTHCND." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.rbthcnd] -type = "double" -longname = "streambed thickness" -description = "real value that defines the thickness of the streambed material through which conduction occurs. Must be greater than 0." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each reach. The values of auxiliary variables must be present for each reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.packagedata.fields.packagedata.item.fields.boundname] -type = "string" -longname = "well name" -description = "name of the reach cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "reachperioddata" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.rno] -type = "integer" -longname = "reach number for this entry" -description = "integer value that defines the reach number associated with the specified PERIOD data on the line. RNO must be greater than zero and less than or equal to NREACHES." -tagged = false -index = true -fk = "packagedata.rno" - -[blocks.period.fields.stress_period_data.item.fields.reachsetting] -type = "union" -description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the REACHSETTING string include: STATUS, TEMPERATURE, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the temperature of associated with the corresponding flow terms. Temperatures cannot be specified for all flow terms. For example, the Streamflow Package supports a 'DIVERSION' flow term. Diversion water will be routed using the calculated temperature of the reach." - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.status] -type = "string" -longname = "reach temperature status" -description = "keyword option to define reach status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the reach. If a reach is inactive, then there will be no energy fluxes into or out of the reach and the inactive value will be written for the reach temperature. If a reach is constant, then the temperature for the reach will be fixed at the user specified value." - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.temperature] -type = "double" -longname = "reach temperature" -description = "real or character value that defines the temperature for the reach. The specified TEMPERATURE is only applied if the reach is a constant temperature reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.rainfall] -type = "double" -longname = "rainfall temperature" -description = "real or character value that defines the rainfall temperature $(e.g.,:^{circ}C:or:^{circ}F)$ for the reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.evaporation] -type = "double" -longname = "evaporation temperature" -description = "use of the EVAPORATION keyword is allowed in the SFE package; however, the specified value is not currently used in SFE calculations. Instead, the latent heat of evaporation is multiplied by the simulated evaporation rate for determining the thermal energy lost from a stream reach." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.runoff] -type = "double" -longname = "runoff temperature" -description = "real or character value that defines the temperature of runoff $(e.g.,:^{circ}C:or:^{circ}F)$ for the reach. Users are free to use whatever temperature scale they want, which might include negative temperatures. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.inflow] -type = "double" -longname = "inflow temperature" -description = "real or character value that defines the temperature of inflow $(e.g.,:^{circ}C:or:^{circ}F)$ for the reach. Users are free to use whatever temperature scale they want, which might include negative temperatures. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord.fields.auxiliary] -type = "keyword" -description = "keyword for specifying auxiliary variable." - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord.fields.auxname] -type = "string" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord.fields.auxval] -type = "double" -longname = "auxiliary variable value" -description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.flow_pkg_name] -set_in = "ar" -source = "flow_package_name" -type = "string" - -[memory.fp_aux_name] -set_in = "ar" -source = "flow_package_auxiliary_name" -type = "string" - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprconc] -set_in = "ar" -source = "print_temperature" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.dev_nonexpanding] -set_in = "ar" -source = "dev_nonexpanding_matrix" -type = "logical" - -[memory.packagedata_ifno] -set_in = "ar" -source = "rno" -type = "integer" - -[memory.ifno] -set_in = "rp" -source = "rno" -type = "integer" - -[memory.period_auxiliary] -set_in = "rp" -source = "auxiliary" -type = "logical" - -[memory.ncv] -readonly = true -set_in = "ar" -description = "Number of control volumes. Assigned from the linked flow package during AR." -type = "integer" - -[memory.strt] -type = "array" -set_in = "ar" -source = "strt" -description = "Starting temperature for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xnewpak] -type = "array" -set_in = "ca" -description = "Current temperature for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xoldpak] -type = "array" -readonly = true -set_in = "ad" -description = "Temperature from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." -dtype = "double" -shape = [ - "ncv", -] - -[memory.ibound] -type = "array" -set_in = "ar" -description = "Boundary activity flag for each control volume." -dtype = "integer" -shape = [ - "ncv", -] - -[memory.concfeat] -type = "array" -readonly = true -set_in = "cq" -description = "Computed temperature for each feature. Set from XNEWPAK after solver convergence." -dtype = "double" -shape = [ - "ncv", -] - -[memory.qsto] -type = "array" -readonly = true -set_in = "cq" -description = "Storage temperature flow contribution for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.temprain] -type = "array" -set_in = "rp" -description = "Rainfall temperature for each reach." -dtype = "double" -shape = [ - "ncv", -] - -[memory.tempevap] -type = "array" -set_in = "rp" -description = "Evaporation temperature for each reach." -dtype = "double" -shape = [ - "ncv", -] - -[memory.temproff] -type = "array" -set_in = "rp" -description = "Runoff temperature for each reach." -dtype = "double" -shape = [ - "ncv", -] - -[memory.tempiflw] -type = "array" -set_in = "rp" -description = "Inflow temperature for each reach." -dtype = "double" -shape = [ - "ncv", -] - -[memory.vnew] -type = "array" -readonly = true -set_in = "cq" -description = "Reach water volume at the end of the current time step." -dtype = "double" -shape = [ - "ncv", -] - -[memory.vold] -type = "array" -readonly = true -set_in = "ad" -description = "Reach water volume at the start of the current time step." -dtype = "double" -shape = [ - "ncv", -] - -[memory.ktf] -type = "array" -set_in = "ar" -source = "ktf" -description = "Thermal conductivity of the streambed (E/T/L/Deg)." -dtype = "double" -shape = [ - "ncv", -] - -[memory.rfeatthk] -type = "array" -set_in = "ar" -source = "rbthcnd" -description = "Thickness of the streambed conduction layer (L)." -dtype = "double" -shape = [ - "ncv", -] - -[observations.temperature] -type = "union" - -[observations.temperature.arms.rno] -type = "integer" -tagged = false -index = true -fk = "packagedata.rno" - -[observations.temperature.arms.boundname] -type = "string" -tagged = false - -[observations.storage] -type = "union" - -[observations.storage.arms.rno] -type = "integer" -tagged = false -index = true -fk = "packagedata.rno" - -[observations.storage.arms.boundname] -type = "string" -tagged = false - -[observations.constant] -type = "union" - -[observations.constant.arms.rno] -type = "integer" -tagged = false -index = true -fk = "packagedata.rno" - -[observations.constant.arms.boundname] -type = "string" -tagged = false - -[observations.from-mvr] -type = "union" - -[observations.from-mvr.arms.rno] -type = "integer" -tagged = false -index = true -fk = "packagedata.rno" - -[observations.from-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.sfe] -type = "union" - -[observations.sfe.arms.rno] -type = "integer" -tagged = false -index = true -fk = "packagedata.rno" - -[observations.sfe.arms.boundname] -type = "string" -tagged = false - -[observations.strmbd-cond] -type = "union" - -[observations.strmbd-cond.arms.rno] -type = "integer" -tagged = false -index = true -fk = "packagedata.rno" - -[observations.strmbd-cond.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.rno] -type = "integer" -tagged = false -index = true -fk = "packagedata.rno" - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.rainfall] -type = "union" - -[observations.rainfall.arms.rno] -type = "integer" -tagged = false -index = true -fk = "packagedata.rno" - -[observations.rainfall.arms.boundname] -type = "string" -tagged = false - -[observations.evaporation] -type = "union" - -[observations.evaporation.arms.rno] -type = "integer" -tagged = false -index = true -fk = "packagedata.rno" - -[observations.evaporation.arms.boundname] -type = "string" -tagged = false - -[observations.runoff] -type = "union" - -[observations.runoff.arms.rno] -type = "integer" -tagged = false -index = true -fk = "packagedata.rno" - -[observations.runoff.arms.boundname] -type = "string" -tagged = false - -[observations.ext-inflow] -type = "union" - -[observations.ext-inflow.arms.rno] -type = "integer" -tagged = false -index = true -fk = "packagedata.rno" - -[observations.ext-inflow.arms.boundname] -type = "string" -tagged = false - -[observations.ext-outflow] -type = "union" - -[observations.ext-outflow.arms.rno] -type = "integer" -tagged = false -index = true -fk = "packagedata.rno" - -[observations.ext-outflow.arms.boundname] -type = "string" -tagged = false - -[observations.flow-ja-face] -type = "union" - -[observations.flow-ja-face.arms.rno_rno2] -type = "record" - -[observations.flow-ja-face.arms.rno_rno2.fields.rno] -type = "integer" -tagged = false -index = true -fk = "packagedata.rno" - -[observations.flow-ja-face.arms.rno_rno2.fields.rno2] -type = "integer" -tagged = false -index = true -fk = "packagedata.rno" - -[observations.flow-ja-face.arms.boundname] -type = "string" -tagged = false diff --git a/flopy4/mf6/dfns/gwe-ssm.toml b/flopy4/mf6/dfns/gwe-ssm.toml deleted file mode 100644 index f64d01177..000000000 --- a/flopy4/mf6/dfns/gwe-ssm.toml +++ /dev/null @@ -1,102 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-ssm" -parent = "gwe-nam" -ftype = "SSM6" - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of SSM flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save calculated flows to budget file" -description = "keyword to indicate that SSM flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.sources] -write_if_empty = true - -[blocks.sources.fields.sources] -type = "list" -longname = "package list" - -[blocks.sources.fields.sources.item] -name = "sources" -type = "record" - -[blocks.sources.fields.sources.item.fields.pname] -type = "string" -longname = "package name" -description = "name of the flow package for which an auxiliary variable contains a source temperature. If this flow package is represented using an advanced transport package (SFE, LKE, MWE, or UZE), then the advanced transport package will override SSM terms specified here." -tagged = false -pk = true - -[blocks.sources.fields.sources.item.fields.pname.fk] -path = "gwf-nam.packages.pname" -rule = "flow_model" - -[blocks.sources.fields.sources.item.fields.srctype] -type = "string" -longname = "source type" -description = "keyword indicating how temperature will be assigned for sources and sinks. Keyword must be specified as either AUX or AUXMIXED. For both options the user must provide an auxiliary variable in the corresponding flow package. The auxiliary variable must have the same name as the AUXNAME value that follows. If the AUX keyword is specified, then the auxiliary variable specified by the user will be assigned as the temperature value for groundwater sources (flows with a positive sign). For negative flow rates (sinks), groundwater will be withdrawn from the cell at the simulated temperature of the cell. The AUXMIXED option provides an alternative method for how to determine the temperature of sinks. If the cell temperature is larger than the user-specified auxiliary temperature, then the temperature of groundwater withdrawn from the cell will be assigned as the user-specified temperature. Alternatively, if the user-specified auxiliary temperature is larger than the cell temperature, then groundwater will be withdrawn at the cell temperature. Thus, the AUXMIXED option is designed to work with the Evapotranspiration (EVT) and Recharge (RCH) Packages where water may be withdrawn at a temperature that is less than the cell temperature." -tagged = false - -[blocks.sources.fields.sources.item.fields.auxname] -type = "string" -longname = "auxiliary variable name" -description = "name of the auxiliary variable in the package PNAME. This auxiliary variable must exist and be specified by the user in that package. The values in this auxiliary variable will be used to set the temperature associated with the flows for that boundary package." -tagged = false - -[blocks.fileinput.fields.fileinput] -type = "list" -optional = true - -[blocks.fileinput.fields.fileinput.item] -name = "fileinput" -type = "record" - -[blocks.fileinput.fields.fileinput.item.fields.pname] -type = "string" -longname = "package name" -description = "name of the flow package for which an SPC6 input file contains a source temperature. If this flow package is represented using an advanced transport package (SFE, LKE, MWE, or UZE), then the advanced transport package will override SSM terms specified here." -tagged = false -pk = true - -[blocks.fileinput.fields.fileinput.item.fields.pname.fk] -path = "gwf-nam.packages.pname" -rule = "flow_model" - -[blocks.fileinput.fields.fileinput.item.fields.spc6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a source sink mixing input file." - -[blocks.fileinput.fields.fileinput.item.fields.spc6_filename] -type = "file" -longname = "spc file name" -description = "character string that defines the path and filename for the file containing source and sink input data for the flow package. The SPC6_FILENAME file is a flexible input file that allows temperatures to be specified by stress period and with time series. Instructions for creating the SPC6_FILENAME input file are provided in the next section on file input for boundary temperatures." -tagged = false -direction = "in" -component = [ - "utl-spc", - "utl-spca", -] - -[blocks.fileinput.fields.fileinput.item.fields.mixed] -type = "keyword" -longname = "mixed keyword" -description = "keyword to specify that these stress package boundaries will have the mixed condition. The MIXED condition is described in the SOURCES block for AUXMIXED. The MIXED condition allows for water to be withdrawn at a temperature that is less than the cell temperature. It is intended primarily for representing evapotranspiration." -optional = true - -[memory.pname_sources] -source = "pname" -type = "string" - -[keys] -source = [ - "sources.pname", - "fileinput.pname", -] diff --git a/flopy4/mf6/dfns/gwe-uze.toml b/flopy4/mf6/dfns/gwe-uze.toml deleted file mode 100644 index fc5da30fe..000000000 --- a/flopy4/mf6/dfns/gwe-uze.toml +++ /dev/null @@ -1,551 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwe-uze" -parent = "gwe-nam" -ftype = "UZE6" -multi = true -subtype = "advanced" - -[dims.auxiliary] -value = "len(auxiliary)" - -[runtime_dims.ncv] -set_in = "ar" - -[blocks.options.fields.flow_package_name] -type = "string" -longname = "keyword to specify name of corresponding flow package" -description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWE name file)." -optional = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.flow_package_auxiliary_name] -type = "string" -longname = "keyword to specify name of concentration auxiliary variable in flow package" -description = "keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated temperatures from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of unsaturated zone flow cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of unsaturated zone flow information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_temperature] -type = "keyword" -longname = "print calculated temperatures to listing file" -description = "keyword to indicate that the list of UZF cell {#2} will be printed to the listing file for every stress period in which 'TEMPERATURE PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of unsaturated zone flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save UZE cell flows to budget file" -description = "keyword to indicate that unsaturated zone flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.temperature_filerecord] -type = "record" -optional = true - -[blocks.options.fields.temperature_filerecord.fields.temperature] -type = "keyword" -longname = "stage keyword" -description = "keyword to specify that record corresponds to temperature." - -[blocks.options.fields.temperature_filerecord.fields.tempfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write temperature information." -tagged = false -direction = "out" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the UZE package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZE package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.dev_nonexpanding_matrix] -type = "keyword" -longname = "do not add rows to the solution matrix" -description = "keyword that solves the feature temperature with a general mixing equation and adds the result to the right-hand side of the GWE equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." -optional = true -developmode = true - -[blocks.packagedata.fields.packagedata] -type = "list" - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.uzfno] -type = "integer" -longname = "UZF cell number for this entry" -description = "integer value that defines the UZF cell number associated with the specified PACKAGEDATA data on the line. UZFNO must be greater than zero and less than or equal to NUZFCELLS. Unsaturated zone flow information must be specified for every UZF cell or the program will terminate with an error. The program also will terminate with an error if information for a UZF cell is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.strt] -type = "double" -longname = "starting UZF cell temperature" -description = "real value that defines the starting temperature for the unsaturated zone flow cell." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each unsaturated zone flow. The values of auxiliary variables must be present for each unsaturated zone flow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.packagedata.fields.packagedata.item.fields.boundname] -type = "string" -longname = "UZF cell name" -description = "name of the unsaturated zone flow cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "uzeperioddata" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.uzfno] -type = "integer" -longname = "unsaturated zone flow cell number for this entry" -description = "integer value that defines the UZF cell number associated with the specified PERIOD data on the line. UZFNO must be greater than zero and less than or equal to NUZFCELLS." -tagged = false -index = true -fk = "packagedata.uzfno" - -[blocks.period.fields.stress_period_data.item.fields.uzesetting] -type = "union" -description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the UZESETTING string include: STATUS, TEMPERATURE, INFILTRATION, UZET, and AUXILIARY. These settings are used to assign the temperature associated with the corresponding flow terms. Temperatures cannot be specified for all flow terms." - -[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.status] -type = "string" -longname = "unsaturated zone flow cell temperature status" -description = "keyword option to define UZF cell status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the UZF cell. If a UZF cell is inactive, then there will be no energy fluxes into or out of the UZF cell and the inactive value will be written for the UZF cell temperature. If a UZF cell is constant, then the temperature for the UZF cell will be fixed at the user specified value." - -[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.temperature] -type = "double" -longname = "unsaturated zone flow cell temperature" -description = "real or character value that defines the temperature for the unsaturated zone flow cell. The specified TEMPERATURE is only applied if the unsaturated zone flow cell is a constant temperature cell. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.infiltration] -type = "double" -longname = "infiltration temperature" -description = "real or character value that defines the temperature of the infiltration $(e.g.,:^{circ}C:or:^{circ}F)$ for the UZF cell. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.uzet] -type = "double" -longname = "unsaturated zone et temperature" -description = "real or character value that states what fraction of the simulated unsaturated zone evapotranspiration is associated with evaporation. The evaporative losses from the unsaturated zone moisture content will have an evaporative cooling effect on the GWE cell from which the evaporation originated. If this value is larger than 1, then it will be reset to 1. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.auxiliaryrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.auxiliaryrecord.fields.auxiliary] -type = "keyword" -description = "keyword for specifying auxiliary variable." - -[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.auxiliaryrecord.fields.auxname] -type = "string" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.uzesetting.arms.auxiliaryrecord.fields.auxval] -type = "double" -longname = "auxiliary variable value" -description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.flow_pkg_name] -set_in = "ar" -source = "flow_package_name" -type = "string" - -[memory.fp_aux_name] -set_in = "ar" -source = "flow_package_auxiliary_name" -type = "string" - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprconc] -set_in = "ar" -source = "print_temperature" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.dev_nonexpanding] -set_in = "ar" -source = "dev_nonexpanding_matrix" -type = "logical" - -[memory.packagedata_ifno] -set_in = "ar" -source = "uzfno" -type = "integer" - -[memory.ifno] -set_in = "rp" -source = "uzfno" -type = "integer" - -[memory.period_auxiliary] -set_in = "rp" -source = "auxiliary" -type = "logical" - -[memory.ncv] -readonly = true -set_in = "ar" -description = "Number of control volumes. Assigned from the linked flow package during AR." -type = "integer" - -[memory.strt] -type = "array" -set_in = "ar" -source = "strt" -description = "Starting temperature for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xnewpak] -type = "array" -set_in = "ca" -description = "Current temperature for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xoldpak] -type = "array" -readonly = true -set_in = "ad" -description = "Temperature from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." -dtype = "double" -shape = [ - "ncv", -] - -[memory.ibound] -type = "array" -set_in = "ar" -description = "Boundary activity flag for each control volume." -dtype = "integer" -shape = [ - "ncv", -] - -[memory.concfeat] -type = "array" -readonly = true -set_in = "cq" -description = "Computed temperature for each feature. Set from XNEWPAK after solver convergence." -dtype = "double" -shape = [ - "ncv", -] - -[memory.qsto] -type = "array" -readonly = true -set_in = "cq" -description = "Storage temperature flow contribution for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.tempinfl] -type = "array" -set_in = "rp" -description = "Infiltration temperature for each UZF cell." -dtype = "double" -shape = [ - "ncv", -] - -[memory.tempuzet] -type = "array" -set_in = "rp" -description = "ET temperature for each UZF cell." -dtype = "double" -shape = [ - "ncv", -] - -[observations.temperature] -type = "union" - -[observations.temperature.arms.uzfno] -type = "integer" -tagged = false -index = true -fk = "packagedata.uzfno" - -[observations.temperature.arms.boundname] -type = "string" -tagged = false - -[observations.storage] -type = "union" - -[observations.storage.arms.uzfno] -type = "integer" -tagged = false -index = true -fk = "packagedata.uzfno" - -[observations.storage.arms.boundname] -type = "string" -tagged = false - -[observations.constant] -type = "union" - -[observations.constant.arms.uzfno] -type = "integer" -tagged = false -index = true -fk = "packagedata.uzfno" - -[observations.constant.arms.boundname] -type = "string" -tagged = false - -[observations.from-mvr] -type = "union" - -[observations.from-mvr.arms.uzfno] -type = "integer" -tagged = false -index = true -fk = "packagedata.uzfno" - -[observations.from-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.uze] -type = "union" - -[observations.uze.arms.uzfno] -type = "integer" -tagged = false -index = true -fk = "packagedata.uzfno" - -[observations.uze.arms.boundname] -type = "string" -tagged = false - -[observations.thermal-equil] -type = "union" - -[observations.thermal-equil.arms.uzfno] -type = "integer" -tagged = false -index = true -fk = "packagedata.uzfno" - -[observations.thermal-equil.arms.boundname] -type = "string" -tagged = false - -[observations.infiltration] -type = "union" - -[observations.infiltration.arms.uzfno] -type = "integer" -tagged = false -index = true -fk = "packagedata.uzfno" - -[observations.infiltration.arms.boundname] -type = "string" -tagged = false - -[observations.rej-inf] -type = "union" - -[observations.rej-inf.arms.uzfno] -type = "integer" -tagged = false -index = true -fk = "packagedata.uzfno" - -[observations.rej-inf.arms.boundname] -type = "string" -tagged = false - -[observations.uzet] -type = "union" - -[observations.uzet.arms.uzfno] -type = "integer" -tagged = false -index = true -fk = "packagedata.uzfno" - -[observations.uzet.arms.boundname] -type = "string" -tagged = false - -[observations.rej-inf-to-mvr] -type = "union" - -[observations.rej-inf-to-mvr.arms.uzfno] -type = "integer" -tagged = false -index = true -fk = "packagedata.uzfno" - -[observations.rej-inf-to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.flow-ja-face] -type = "union" - -[observations.flow-ja-face.arms.uzfno_uzfno2] -type = "record" - -[observations.flow-ja-face.arms.uzfno_uzfno2.fields.uzfno] -type = "integer" -tagged = false -index = true -fk = "packagedata.uzfno" - -[observations.flow-ja-face.arms.uzfno_uzfno2.fields.uzfno2] -type = "integer" -tagged = false -index = true -fk = "packagedata.uzfno" - -[observations.flow-ja-face.arms.boundname] -type = "string" -tagged = false diff --git a/flopy4/mf6/dfns/gwf-api.toml b/flopy4/mf6/dfns/gwf-api.toml deleted file mode 100644 index 00193f128..000000000 --- a/flopy4/mf6/dfns/gwf-api.toml +++ /dev/null @@ -1,108 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-api" -parent = "gwf-nam" -ftype = "API6" -multi = true - -[dims.maxbound] -value = "maxbound" - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of api boundary cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of api boundary information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of api boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save api flows to budget file" -description = "keyword to indicate that api boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the api boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the api boundary package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.mover] -type = "keyword" -description = "keyword to indicate that this instance of the api boundary Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." -optional = true - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of user-defined api boundaries" -description = "integer value specifying the maximum number of api boundary cells that will be specified for use during any stress period." - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.maxbound] -set_in = "ar" -source = "maxbound" -type = "integer" - -[observations.api] -type = "union" - -[observations.api.arms.cellid] -type = "cellid" -tagged = false - -[observations.api.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" - -[keys.mover_provider] -path = "<=maxbound" -when = "mover" diff --git a/flopy4/mf6/dfns/gwf-buy.toml b/flopy4/mf6/dfns/gwf-buy.toml deleted file mode 100644 index 339ead8df..000000000 --- a/flopy4/mf6/dfns/gwf-buy.toml +++ /dev/null @@ -1,106 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-buy" -parent = "gwf-nam" -ftype = "BUY6" - -[dims.nrhospecies] -value = "nrhospecies" - -[blocks.options.fields.hhformulation_rhs] -type = "keyword" -longname = "hh formulation on right-hand side" -description = "use the variable-density hydraulic head formulation and add off-diagonal terms to the right-hand. This option will prevent the BUY Package from adding asymmetric terms to the flow matrix." -optional = true - -[blocks.options.fields.denseref] -type = "double" -longname = "reference density" -description = "fluid reference density used in the equation of state. This value is set to 1000. if not specified as an option." -optional = true -default = 1000.0 - -[blocks.options.fields.density_filerecord] -type = "record" -optional = true - -[blocks.options.fields.density_filerecord.fields.density] -type = "keyword" -longname = "density keyword" -description = "keyword to specify that record corresponds to density." - -[blocks.options.fields.density_filerecord.fields.densityfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write density information. The density file has the same format as the head file. Density values will be written to the density file whenever heads are written to the binary head file. The settings for controlling head output are contained in the Output Control option." -tagged = false -direction = "out" - -[blocks.options.fields.dev_efh_formulation] -type = "keyword" -longname = "use equivalent freshwater head formulation" -description = "use the variable-density equivalent freshwater head formulation instead of the hydraulic head head formulation. This dev option has only been implemented for confined aquifer conditions and should generally not be used." -optional = true -developmode = true - -[blocks.dimensions.fields.nrhospecies] -type = "integer" -longname = "number of species used in density equation of state" -description = "number of species used in density equation of state. This value must be one or greater if the BUY package is activated." - -[blocks.packagedata.fields.packagedata] -type = "list" -shape = [ - "nrhospecies", -] - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.irhospec] -type = "integer" -longname = "species number for this entry" -description = "integer value that defines the species number associated with the specified PACKAGEDATA data on the line. IRHOSPECIES must be greater than zero and less than or equal to NRHOSPECIES. Information must be specified for each of the NRHOSPECIES species or the program will terminate with an error. The program will also terminate with an error if information for a species is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.drhodc] -type = "double" -longname = "slope of the density-concentration line" -description = "real value that defines the slope of the density-concentration line for this species used in the density equation of state." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.crhoref] -type = "double" -longname = "reference concentration value" -description = "real value that defines the reference concentration value used for this species in the density equation of state." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.modelname] -type = "string" -longname = "modelname" -description = "name of a GWT or GWE model used to simulate a species that will be used in the density equation of state. This name will have no effect if the simulation does not include a GWT or GWE model that corresponds to this GWF model." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.auxspeciesname] -type = "string" -longname = "auxspeciesname" -description = "name of an auxiliary variable in a GWF stress package that will be used for this species to calculate a density value. If a density value is needed by the Buoyancy Package then it will use the concentration values in this AUXSPECIESNAME column in the density equation of state. For advanced stress packages (LAK, SFR, MAW, and UZF) that have an associated advanced transport package (LKT, SFT, MWT, and UZT), the FLOW_PACKAGE_AUXILIARY_NAME option in the advanced transport package can be used to transfer simulated concentrations into the flow package auxiliary variable. In this manner, the Buoyancy Package can calculate density values for lakes, streams, multi-aquifer wells, and unsaturated zone flow cells using simulated concentrations." -tagged = false - -[memory.hhform_rhs] -set_in = "ar" -source = "hhformulation_rhs" -type = "logical" - -[memory.dev_efh_form] -set_in = "ar" -source = "dev_efh_formulation" -type = "logical" - -[memory.nrhospecies] -set_in = "ar" -source = "nrhospecies" -type = "integer" diff --git a/flopy4/mf6/dfns/gwf-chd.toml b/flopy4/mf6/dfns/gwf-chd.toml deleted file mode 100644 index 4a3946e0d..000000000 --- a/flopy4/mf6/dfns/gwf-chd.toml +++ /dev/null @@ -1,307 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-chd" -parent = "gwf-nam" -ftype = "CHD6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of CHD head value." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of constant-head cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of constant-head information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print CHD flows to listing file" -description = "keyword to indicate that the list of constant-head flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save CHD flows to budget file" -description = "keyword to indicate that constant-head flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.dev_no_newton] -type = "keyword" -longname = "turn off Newton for unconfined cells" -description = "turn off Newton for unconfined cells" -optional = true -developmode = true - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of constant heads" -description = "integer value specifying the maximum number of constant-head cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.head] -type = "double" -longname = "head value assigned to constant head" -description = "is the head at the boundary. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "constant head boundary name" -description = "name of the constant head boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.inewton] -set_in = "ar" -source = "dev_no_newton" -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: head." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "CHD" -output = true -obs_type = "CHD" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.chd] -type = "union" - -[observations.chd.arms.cellid] -type = "cellid" -tagged = false - -[observations.chd.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwf-chdg.toml b/flopy4/mf6/dfns/gwf-chdg.toml deleted file mode 100644 index d60f35490..000000000 --- a/flopy4/mf6/dfns/gwf-chdg.toml +++ /dev/null @@ -1,299 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-chdg" -parent = "gwf-nam" -ftype = "CHD6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.readarraygrid] -type = "keyword" -longname = "use array-based grid input" -description = "indicates that array-based grid input will be used for the constant head package. This keyword must be specified to use array-based grid input. When READARRAYGRID is specified, values must be provided for every cell within a model grid, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results. No data cells should contain the value DNODATA (3.0E+30)." -default = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of CHD head value." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of constant-head information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print CHD flows to listing file" -description = "keyword to indicate that the list of constant-head flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save CHD flows to budget file" -description = "keyword to indicate that constant-head flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.options.fields.dev_no_newton] -type = "keyword" -longname = "turn off Newton for unconfined cells" -description = "turn off Newton for unconfined cells" -optional = true -developmode = true - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of constant head cells in any stress period" -description = "integer value specifying the maximum number of constant-head cells that will be specified for use during any stress period." -optional = true - -[blocks.period.fields.head] -type = "array" -longname = "head value assigned to constant head" -description = "is the head at the boundary." -default = 3e+30 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.period.fields.aux] -type = "list" -longname = "constant head auxiliary variable iaux" -description = "is an array of values for auxiliary variable aux(iaux), where iaux is a value from 1 to naux, and aux(iaux) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then it will retain its value from the most recently specified period block. If an auxiliary variable array has never been specified, its value is zero. If the value specified here for the auxiliary variable is the same as auxmultname, then the head array will be multiplied by this array." -optional = true -shape = [ - "<=auxiliary", -] - -[blocks.period.fields.aux.item] -name = "aux" -type = "record" - -[blocks.period.fields.aux.item.fields.auxname] -type = "string" -longname = "auxiliary variable name" -description = "name of the auxiliary variable the following array sets; must be one of the auxiliary variables." -tagged = false -fk = "options.auxiliary" -dynamic = true - -[blocks.period.fields.aux.item.fields.aux] -type = "array" -longname = "constant head auxiliary variable iaux" -netcdf = true -tagged = false -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.inewton] -set_in = "ar" -source = "dev_no_newton" -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "CHD" -output = true -obs_type = "CHD" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.chd] -type = "union" - -[observations.chd.arms.cellid] -type = "cellid" -tagged = false - -[observations.chd.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwf-csub.toml b/flopy4/mf6/dfns/gwf-csub.toml deleted file mode 100644 index 77cb5c3ea..000000000 --- a/flopy4/mf6/dfns/gwf-csub.toml +++ /dev/null @@ -1,939 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-csub" -parent = "gwf-nam" -ftype = "CSUB6" - -[dims.ninterbeds] -value = "ninterbeds" - -[dims.maxsig0] -value = "maxsig0" - -[runtime_dims.ncelldim] -set_in = "ar" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of CSUB cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of CSUB information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "keyword to save CSUB flows" -description = "keyword to indicate that cell-by-cell flow terms will be written to the file specified with 'BUDGET SAVE FILE' in Output Control." -optional = true - -[blocks.options.fields.gammaw] -type = "double" -longname = "unit weight of water" -description = "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." -optional = true -default = 9806.65 - -[blocks.options.fields.beta] -type = "double" -longname = "compressibility of water" -description = "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." -optional = true -default = 4.6512e-10 - -[blocks.options.fields.elastic_inelastic_smoothing] -type = "keyword" -longname = "elastic to inelastic smoothing" -description = "keyword to activate smoothing of the delay interbed skeletal specific storage as the effective stress exceeds the preconsolidation stress. When active, the skeletal specific storage is smoothly transitioned from the elastic value to the inelastic value over a small window (0.001 of the preconsolidation stress) instead of switching discontinuously at the preconsolidation stress. Activating this option can improve convergence of models with delay interbeds. By default, the elastic to inelastic transition is discontinuous." -optional = true - -[blocks.options.fields.strict_effective_stress] -type = "keyword" -longname = "terminate on negative effective stress" -description = "keyword to terminate the simulation when the calculated effective stress is small or negative, instead of regularizing it. By default the effective stress used to calculate the skeletal specific storage is not allowed to fall below a small fraction (0.001) of the geostatic stress, which keeps the specific storage bounded and allows the simulation to continue; a warning reports the number of time steps in which a negative effective stress was regularized. Negative effective stress typically occurs in uppermost cells where simulated water levels rise above land surface. This keyword is deprecated and will be removed in a future release." -optional = true -deprecated = "6.8.0" - -[blocks.options.fields.head_based] -type = "keyword" -longname = "keyword to indicate the head-based formulation will be used" -description = "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." -optional = true - -[blocks.options.fields.initial_preconsolidation_head] -type = "keyword" -longname = "keyword to indicate that preconsolidation heads will be specified" -description = "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." -optional = true - -[blocks.options.fields.ndelaycells] -type = "integer" -longname = "number of interbed cell nodes" -description = "number of nodes used to discretize delay interbeds. If not specified, then a default value of 19 is assigned." -optional = true - -[blocks.options.fields.compression_indices] -type = "keyword" -longname = "keyword to indicate CR and CC are read instead of SSE and SSV" -description = "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." -optional = true - -[blocks.options.fields.update_material_properties] -type = "keyword" -longname = "keyword to indicate material properties can change during the simulations" -description = "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." -optional = true - -[blocks.options.fields.cell_fraction] -type = "keyword" -longname = "keyword to indicate cell fraction interbed thickness" -description = "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." -optional = true - -[blocks.options.fields.specified_initial_interbed_state] -type = "keyword" -longname = "keyword to indicate that absolute initial states will be specified" -description = "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." -optional = true - -[blocks.options.fields.specified_initial_preconsolidation_stress] -type = "keyword" -longname = "keyword to indicate that absolute initial preconsolidation stresses (head) will be specified" -description = "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." -optional = true - -[blocks.options.fields.specified_initial_delay_head] -type = "keyword" -longname = "keyword to indicate that absolute initial delay bed heads will be specified" -description = "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." -optional = true - -[blocks.options.fields.effective_stress_lag] -type = "keyword" -longname = "keyword to indicate that specific storage will be calculate using the effective stress from the previous time step" -description = "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." -optional = true - -[blocks.options.fields.strainib_filerecord] -type = "record" -optional = true - -[blocks.options.fields.strainib_filerecord.fields.strain_csv_interbed] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify the record that corresponds to final interbed strain output." - -[blocks.options.fields.strainib_filerecord.fields.interbedstrain_filename] -type = "file" -longname = "file keyword" -description = "name of the comma-separated-values output file to write final interbed strain information." -tagged = false -direction = "out" - -[blocks.options.fields.straincg_filerecord] -type = "record" -optional = true - -[blocks.options.fields.straincg_filerecord.fields.strain_csv_coarse] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify the record that corresponds to final coarse-grained material strain output." - -[blocks.options.fields.straincg_filerecord.fields.coarsestrain_filename] -type = "file" -longname = "file keyword" -description = "name of the comma-separated-values output file to write final coarse-grained material strain information." -tagged = false -direction = "out" - -[blocks.options.fields.compaction_filerecord] -type = "record" -optional = true - -[blocks.options.fields.compaction_filerecord.fields.compaction] -type = "keyword" -longname = "compaction keyword" -description = "keyword to specify that record corresponds to the compaction." - -[blocks.options.fields.compaction_filerecord.fields.compaction_filename] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write compaction information." -tagged = false -direction = "out" - -[blocks.options.fields.compaction_elastic_filerecord] -type = "record" -optional = true - -[blocks.options.fields.compaction_elastic_filerecord.fields.compaction_elastic] -type = "keyword" -longname = "elastic interbed compaction keyword" -description = "keyword to specify that record corresponds to the elastic interbed compaction binary file." - -[blocks.options.fields.compaction_elastic_filerecord.fields.elastic_compaction_filename] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write elastic interbed compaction information." -tagged = false -direction = "out" - -[blocks.options.fields.compaction_inelastic_filerecord] -type = "record" -optional = true - -[blocks.options.fields.compaction_inelastic_filerecord.fields.compaction_inelastic] -type = "keyword" -longname = "inelastic interbed compaction keyword" -description = "keyword to specify that record corresponds to the inelastic interbed compaction binary file." - -[blocks.options.fields.compaction_inelastic_filerecord.fields.inelastic_compaction_filename] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write inelastic interbed compaction information." -tagged = false -direction = "out" - -[blocks.options.fields.compaction_interbed_filerecord] -type = "record" -optional = true - -[blocks.options.fields.compaction_interbed_filerecord.fields.compaction_interbed] -type = "keyword" -longname = "interbed compaction keyword" -description = "keyword to specify that record corresponds to the interbed compaction binary file." - -[blocks.options.fields.compaction_interbed_filerecord.fields.interbed_compaction_filename] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write interbed compaction information." -tagged = false -direction = "out" - -[blocks.options.fields.compaction_coarse_filerecord] -type = "record" -optional = true - -[blocks.options.fields.compaction_coarse_filerecord.fields.compaction_coarse] -type = "keyword" -longname = "coarse compaction keyword" -description = "keyword to specify that record corresponds to the elastic coarse-grained material compaction binary file." - -[blocks.options.fields.compaction_coarse_filerecord.fields.coarse_compaction_filename] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write elastic coarse-grained material compaction information." -tagged = false -direction = "out" - -[blocks.options.fields.zdisplacement_filerecord] -type = "record" -optional = true - -[blocks.options.fields.zdisplacement_filerecord.fields.zdisplacement] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the z-displacement binary file." - -[blocks.options.fields.zdisplacement_filerecord.fields.zdisplacement_filename] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write z-displacement information." -tagged = false -direction = "out" - -[blocks.options.fields.package_convergence_filerecord] -type = "record" -optional = true - -[blocks.options.fields.package_convergence_filerecord.fields.package_convergence] -type = "keyword" -longname = "package_convergence keyword" -description = "keyword to specify that record corresponds to the package convergence comma spaced values file. Package convergence data is for delay interbeds. A warning message will be issued if package convergence data is requested but delay interbeds are not included in the package." - -[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] -type = "file" -longname = "file keyword" -description = "name of the comma spaced values output file to write package convergence information." -tagged = false -direction = "out" - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the CSUB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CSUB package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.ninterbeds] -type = "integer" -longname = "number of CSUB interbed systems" -description = "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." - -[blocks.dimensions.fields.maxsig0] -type = "integer" -longname = "maximum number of stress offset cells" -description = "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." -optional = true - -[blocks.griddata.fields.cg_ske_cr] -type = "array" -longname = "elastic coarse specific storage" -description = "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." -default = 1e-05 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.cg_theta] -type = "array" -longname = "initial coarse-grained material porosity" -description = "is the initial porosity of coarse-grained materials." -default = 0.2 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.sgm] -type = "array" -longname = "specific gravity of moist sediments" -description = "is the specific gravity of moist or unsaturated sediments. If not specified, then a default value of 1.7 is assigned." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.sgs] -type = "array" -longname = "specific gravity of saturated sediments" -description = "is the specific gravity of saturated sediments. If not specified, then a default value of 2.0 is assigned." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.packagedata.fields.packagedata] -type = "list" -optional = true -shape = [ - "ninterbeds", -] - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.icsubno] -type = "integer" -longname = "CSUB id number for this entry" -description = "integer value that defines the CSUB interbed number associated with the specified PACKAGEDATA data on the line. CSUBNO must be greater than zero and less than or equal to NINTERBEDS. CSUB information must be specified for every CSUB cell or the program will terminate with an error. The program will also terminate with an error if information for a CSUB interbed number is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.cdelay] -type = "string" -longname = "delay type" -description = "character string that defines the subsidence delay type for the interbed. Possible subsidence package CDELAY strings include: NODELAY--character keyword to indicate that delay will not be simulated in the interbed. DELAY--character keyword to indicate that delay will be simulated in the interbed." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.pcs0] -type = "double" -longname = "initial stress" -description = "is the initial offset from the calculated initial effective stress or initial preconsolidation stress in the interbed, in units of height of a column of water. PCS0 is the initial preconsolidation stress if SPECIFIED_INITIAL_INTERBED_STATE or SPECIFIED_INITIAL_PRECONSOLIDATION_STRESS are specified in the OPTIONS block. If HEAD_BASED is specified in the OPTIONS block, PCS0 is the initial offset from the calculated initial head or initial preconsolidation head in the CSUB interbed and the initial preconsolidation stress is calculated from the calculated initial effective stress or calculated initial geostatic stress, respectively. When PCS0 is a relative offset, the sign depends on the formulation. For the default effective-stress formulation, specify a positive PCS0 for an overconsolidated interbed since the preconsolidation stress is greater than the initial effective stress. If HEAD_BASED is specified, specify a negative PCS0 for an overconsolidated interbed since the preconsolidation head is less than the initial head. A PCS0 of zero is normally consolidated in both formulations." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.thick_frac] -type = "double" -longname = "interbed thickness or cell fraction" -description = "is the interbed thickness or cell fraction of the interbed. Interbed thickness is specified as a fraction of the cell thickness if CELL_FRACTION is specified in the OPTIONS block." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.rnb] -type = "double" -longname = "delay interbed material factor" -description = "is the interbed material factor equivalent number of interbeds in the interbed system represented by the interbed. RNB must be greater than or equal to 1 if CDELAY is DELAY. Otherwise, RNB can be any value." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.ssv_cc] -type = "double" -longname = "initial interbed inelastic specific storage" -description = "is the initial inelastic specific storage or compression index of the interbed. The compression index is specified if COMPRESSION_INDICES is specified in the OPTIONS block. Specified or calculated interbed inelastic specific storage values are not adjusted from initial values if HEAD_BASED is specified in the OPTIONS block." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.sse_cr] -type = "double" -longname = "initial interbed elastic specific storage" -description = "is the initial elastic coarse-grained material specific storage or recompression index of the interbed. The recompression index is specified if COMPRESSION_INDICES is specified in the OPTIONS block. Specified or calculated interbed elastic specific storage values are not adjusted from initial values if HEAD_BASED is specified in the OPTIONS block." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.theta] -type = "double" -longname = "initial interbed porosity" -description = "is the initial porosity of the interbed." -default = 0.2 -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.kv] -type = "double" -longname = "delay interbed vertical hydraulic conductivity" -description = "is the vertical hydraulic conductivity of the delay interbed. KV must be greater than 0 if CDELAY is DELAY. Otherwise, KV can be any value." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.h0] -type = "double" -longname = "initial delay interbed head" -description = "is the initial offset from the head in cell cellid or the initial head in the delay interbed. H0 is the initial head in the delay bed if SPECIFIED_INITIAL_INTERBED_STATE or SPECIFIED_INITIAL_DELAY_HEAD are specified in the OPTIONS block. H0 can be any value if CDELAY is NODELAY." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.boundname] -type = "string" -longname = "interbed name" -description = "name of the CSUB cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxsig0", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.sig0] -type = "double" -longname = "geostatic stress offset" -description = "is the stress offset for the cell. SIG0 is added to the calculated geostatic stress for the cell. SIG0 is specified only if MAXSIG0 is specified to be greater than 0 in the DIMENSIONS block. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.ei_smoothing] -set_in = "ar" -source = "elastic_inelastic_smoothing" -type = "logical" - -[memory.strict_stress] -set_in = "ar" -source = "strict_effective_stress" -type = "logical" - -[memory.precon_head] -set_in = "ar" -source = "initial_preconsolidation_head" -type = "logical" - -[memory.icompress] -set_in = "ar" -source = "compression_indices" -type = "logical" - -[memory.matprop] -set_in = "ar" -source = "update_material_properties" -type = "logical" - -[memory.interbed_state] -set_in = "ar" -source = "specified_initial_interbed_state" -type = "integer" - -[memory.precon_stress] -set_in = "ar" -source = "specified_initial_preconsolidation_stress" -type = "logical" - -[memory.delay_head] -set_in = "ar" -source = "specified_initial_delay_head" -type = "logical" - -[memory.stress_lag] -set_in = "ar" -source = "effective_stress_lag" -type = "logical" - -[memory.csvinterbed] -set_in = "ar" -source = "strain_csv_interbed" -type = "logical" - -[memory.interbedstrainfn] -set_in = "ar" -source = "interbedstrain_filename" -type = "string" - -[memory.csvcoarse] -set_in = "ar" -source = "strain_csv_coarse" -type = "logical" - -[memory.coarsestrainfn] -set_in = "ar" -source = "coarsestrain_filename" -type = "string" - -[memory.cmpfn] -set_in = "ar" -source = "compaction_filename" -type = "string" - -[memory.cmpelastic] -set_in = "ar" -source = "compaction_elastic" -type = "logical" - -[memory.elasticcmpfn] -set_in = "ar" -source = "elastic_compaction_filename" -type = "string" - -[memory.cmpinelastic] -set_in = "ar" -source = "compaction_inelastic" -type = "logical" - -[memory.inelasticcmpfn] -set_in = "ar" -source = "inelastic_compaction_filename" -type = "string" - -[memory.cmpinterbed] -set_in = "ar" -source = "compaction_interbed" -type = "logical" - -[memory.interbedcmpfn] -set_in = "ar" -source = "interbed_compaction_filename" -type = "string" - -[memory.cmpcoarse] -set_in = "ar" -source = "compaction_coarse" -type = "logical" - -[memory.cmpcoarsefn] -set_in = "ar" -source = "coarse_compaction_filename" -type = "string" - -[memory.zdispfn] -set_in = "ar" -source = "zdisplacement_filename" -type = "string" - -[memory.pkgconverge] -set_in = "ar" -source = "package_convergence" -type = "logical" - -[memory.pkgconvergefn] -set_in = "ar" -source = "package_convergence_filename" -type = "string" - -[memory.maxbound] -set_in = "ar" -source = "maxsig0" -type = "integer" - -[memory.cellid_pkgdata] -type = "array" -set_in = "ar" -source = "cellid" -dtype = "integer" -shape = [ - "ncelldim", -] - -[memory.ninterbeds] -set_in = "ar" -source = "ninterbeds" -type = "integer" - -[memory.cg_ske_cr] -type = "array" -set_in = "ar" -source = "cg_ske_cr" -dtype = "double" -shape = [ - "nodes", -] - -[memory.cg_theta] -type = "array" -set_in = "ar" -source = "cg_theta" -dtype = "double" -shape = [ - "nodes", -] - -[memory.sgm] -type = "array" -set_in = "ar" -source = "sgm" -dtype = "double" -shape = [ - "nodes", -] - -[memory.sgs] -type = "array" -set_in = "ar" -source = "sgs" -dtype = "double" -shape = [ - "nodes", -] - -[observations.csub] -type = "union" - -[observations.csub.arms.icsubno] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.csub.arms.boundname] -type = "string" -tagged = false - -[observations.inelastic-csub] -type = "union" - -[observations.inelastic-csub.arms.icsubno] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.inelastic-csub.arms.boundname] -type = "string" -tagged = false - -[observations.elastic-csub] -type = "union" - -[observations.elastic-csub.arms.icsubno] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.elastic-csub.arms.boundname] -type = "string" -tagged = false - -[observations.delay-flowtop] -type = "union" - -[observations.delay-flowtop.arms.icsubno] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.delay-flowtop.arms.boundname] -type = "string" -tagged = false - -[observations.delay-flowbot] -type = "union" - -[observations.delay-flowbot.arms.icsubno] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.delay-flowbot.arms.boundname] -type = "string" -tagged = false - -[observations.sk] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.ske] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.theta] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.thickness] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.interbed-compaction] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.interbed-compaction-pct] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.inelastic-compaction] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.elastic-compaction] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.delay-head] -type = "record" - -[observations.delay-head.fields.icsubno] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.delay-head.fields.idcellno] -type = "integer" -tagged = false -index = true - -[observations.delay-gstress] -type = "record" - -[observations.delay-gstress.fields.icsubno] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.delay-gstress.fields.idcellno] -type = "integer" -tagged = false -index = true - -[observations.delay-estress] -type = "record" - -[observations.delay-estress.fields.icsubno] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.delay-estress.fields.idcellno] -type = "integer" -tagged = false -index = true - -[observations.delay-preconstress] -type = "record" - -[observations.delay-preconstress.fields.icsubno] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.delay-preconstress.fields.idcellno] -type = "integer" -tagged = false -index = true - -[observations.delay-compaction] -type = "record" - -[observations.delay-compaction.fields.icsubno] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.delay-compaction.fields.idcellno] -type = "integer" -tagged = false -index = true - -[observations.delay-thickness] -type = "record" - -[observations.delay-thickness.fields.icsubno] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.delay-thickness.fields.idcellno] -type = "integer" -tagged = false -index = true - -[observations.delay-theta] -type = "record" - -[observations.delay-theta.fields.icsubno] -type = "integer" -tagged = false -index = true -fk = "packagedata.icsubno" - -[observations.delay-theta.fields.idcellno] -type = "integer" -tagged = false -index = true - -[observations.coarse-csub] -type = "cellid" -tagged = false - -[observations.csub-cell] -type = "cellid" -tagged = false - -[observations.wcomp-csub-cell] -type = "cellid" -tagged = false - -[observations.sk-cell] -type = "cellid" -tagged = false - -[observations.ske-cell] -type = "cellid" -tagged = false - -[observations.estress-cell] -type = "cellid" -tagged = false - -[observations.gstress-cell] -type = "cellid" -tagged = false - -[observations.preconstress-cell] -type = "cellid" -tagged = false - -[observations.coarse-compaction] -type = "cellid" -tagged = false - -[observations.compaction-cell] -type = "cellid" -tagged = false - -[observations.inelastic-compaction-cell] -type = "cellid" -tagged = false - -[observations.elastic-compaction-cell] -type = "cellid" -tagged = false - -[observations.coarse-thickness] -type = "cellid" -tagged = false - -[observations.thickness-cell] -type = "cellid" -tagged = false - -[observations.coarse-theta] -type = "cellid" -tagged = false - -[observations.theta-cell] -type = "cellid" -tagged = false diff --git a/flopy4/mf6/dfns/gwf-dis.toml b/flopy4/mf6/dfns/gwf-dis.toml deleted file mode 100644 index 37b32d1d8..000000000 --- a/flopy4/mf6/dfns/gwf-dis.toml +++ /dev/null @@ -1,302 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-dis" -parent = "gwf-nam" -ftype = "DIS6" - -[dims.nlay] -value = "nlay" -scope = "model" - -[dims.nrow] -value = "nrow" -scope = "model" - -[dims.ncol] -value = "ncol" -scope = "model" - -[dims.ncpl] -value = "nrow * ncol" -scope = "model" - -[dims.nodes] -value = "nlay * nrow * ncol" -scope = "model" - -[dims.ncelldim] -value = "3" -scope = "model" - -[runtime_dims.nodes] -set_in = "ar" - -[runtime_dims.nodesuser] -set_in = "ar" - -[blocks.options.fields.length_units] -type = "string" -longname = "model length units" -description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." -optional = true - -[blocks.options.fields.nogrb] -type = "keyword" -longname = "do not write binary grid file" -description = "keyword to deactivate writing of the binary grid file." -optional = true - -[blocks.options.fields.grb_filerecord] -type = "record" -optional = true - -[blocks.options.fields.grb_filerecord.fields.grb6] -type = "keyword" -longname = "grb keyword" -description = "keyword to specify that record corresponds to a binary grid file." - -[blocks.options.fields.grb_filerecord.fields.grb6_filename] -type = "file" -longname = "file name of GRB information" -description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." -tagged = false -direction = "out" - -[blocks.options.fields.xorigin] -type = "double" -longname = "x-position of the model grid origin" -description = "x-position of the lower-left corner of the model grid. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.yorigin] -type = "double" -longname = "y-position of the model grid origin" -description = "y-position of the lower-left corner of the model grid. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.angrot] -type = "double" -longname = "rotation angle" -description = "counter-clockwise rotation angle (in degrees) of the lower-left corner of the model grid. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.options.fields.crs] -type = "string" -longname = "CRS user input string" -description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true -case_sensitive = true - -[blocks.options.fields.ncf_filerecord] -type = "record" -optional = true - -[blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "keyword" -longname = "ncf keyword" -description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." - -[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] -type = "file" -longname = "file name of NCF information" -description = "defines a NetCDF configuration (NCF) input file." -tagged = false -direction = "in" -component = "utl-ncf" - -[blocks.dimensions.fields.nlay] -type = "integer" -longname = "number of layers" -description = "is the number of layers in the model grid." -default = 1 - -[blocks.dimensions.fields.nrow] -type = "integer" -longname = "number of rows" -description = "is the number of rows in the model grid." -default = 2 - -[blocks.dimensions.fields.ncol] -type = "integer" -longname = "number of columns" -description = "is the number of columns in the model grid." -default = 2 - -[blocks.griddata.fields.delr] -type = "array" -longname = "spacing along a row" -description = "is the column spacing in the row direction." -default = 1.0 -netcdf = true -dtype = "double" -shape = [ - "ncol", -] - -[blocks.griddata.fields.delc] -type = "array" -longname = "spacing along a column" -description = "is the row spacing in the column direction." -default = 1.0 -netcdf = true -dtype = "double" -shape = [ - "nrow", -] - -[blocks.griddata.fields.top] -type = "array" -longname = "cell top elevation" -description = "is the top elevation for each cell in the top model layer." -default = 1.0 -netcdf = true -dtype = "double" -shape = [ - "ncol", - "nrow", -] - -[blocks.griddata.fields.botm] -type = "array" -longname = "cell bottom elevation" -description = "is the bottom elevation for each cell." -default = 0.0 -netcdf = true -dtype = "double" -layered = true -shape = [ - "ncol", - "nrow", - "nlay", -] - -[blocks.griddata.fields.idomain] -type = "array" -longname = "idomain existence array" -description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1 or greater, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." -optional = true -netcdf = true -dtype = "integer" -layered = true -shape = [ - "ncol", - "nrow", - "nlay", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.nlay] -set_in = "ar" -source = "nlay" -type = "integer" - -[memory.nrow] -set_in = "ar" -source = "nrow" -type = "integer" - -[memory.ncol] -set_in = "ar" -source = "ncol" -type = "integer" - -[memory.delr] -type = "array" -set_in = "ar" -source = "delr" -dtype = "double" -shape = [ - "ncol", -] - -[memory.delc] -type = "array" -set_in = "ar" -source = "delc" -dtype = "double" -shape = [ - "nrow", -] - -[memory.top] -type = "array" -set_in = "ar" -source = "top" -dtype = "double" -shape = [ - "ncol", - "nrow", -] - -[memory.botm] -type = "array" -set_in = "ar" -source = "botm" -dtype = "double" -shape = [ - "ncol", - "nrow", - "nlay", -] - -[memory.idomain] -type = "array" -set_in = "ar" -source = "idomain" -dtype = "integer" -shape = [ - "ncol", - "nrow", - "nlay", -] - -[memory.area] -type = "array" -readonly = true -set_in = "ar" -description = "Horizontal cell area, computed from grid geometry." -dtype = "double" -shape = [ - "ncpl", -] - -[memory.nodeuser] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodereduced] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." -dtype = "integer" -shape = [ - "nodesuser", -] diff --git a/flopy4/mf6/dfns/gwf-disu.toml b/flopy4/mf6/dfns/gwf-disu.toml deleted file mode 100644 index ffec76ee2..000000000 --- a/flopy4/mf6/dfns/gwf-disu.toml +++ /dev/null @@ -1,368 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-disu" -parent = "gwf-nam" -ftype = "DISU6" - -[dims.nodes] -value = "nodes" -scope = "model" - -[dims.nja] -value = "nja" -scope = "model" - -[dims.nvert] -value = "nvert" -scope = "model" - -[dims.ncelldim] -value = "1" -scope = "model" - -[dims.njas] -value = "(nja - nodes) / 2" - -[runtime_dims.nodes] -set_in = "ar" - -[runtime_dims.nodesuser] -set_in = "ar" - -[blocks.options.fields.length_units] -type = "string" -longname = "model length units" -description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." -optional = true - -[blocks.options.fields.nogrb] -type = "keyword" -longname = "do not write binary grid file" -description = "keyword to deactivate writing of the binary grid file." -optional = true - -[blocks.options.fields.grb_filerecord] -type = "record" -optional = true - -[blocks.options.fields.grb_filerecord.fields.grb6] -type = "keyword" -longname = "grb keyword" -description = "keyword to specify that record corresponds to a binary grid file." - -[blocks.options.fields.grb_filerecord.fields.grb6_filename] -type = "file" -longname = "file name of GRB information" -description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." -tagged = false -direction = "out" - -[blocks.options.fields.xorigin] -type = "double" -longname = "x-position origin of the model grid coordinate system" -description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.yorigin] -type = "double" -longname = "y-position origin of the model grid coordinate system" -description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.angrot] -type = "double" -longname = "rotation angle" -description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.vertical_offset_tolerance] -type = "double" -longname = "vertical length dimension for top and bottom checking" -description = "checks are performed to ensure that the top of a cell is not higher than the bottom of an overlying cell. This option can be used to specify the tolerance that is used for checking. If top of a cell is above the bottom of an overlying cell by a value less than this tolerance, then the program will not terminate with an error. The default value is zero. This option should generally not be used." -optional = true -default = 0.0 - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.crs] -type = "string" -longname = "CRS user input string" -description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true -case_sensitive = true - -[blocks.dimensions.fields.nodes] -type = "integer" -longname = "number of layers" -description = "is the number of cells in the model grid." - -[blocks.dimensions.fields.nja] -type = "integer" -longname = "number of columns" -description = "is the sum of the number of connections and NODES. When calculating the total number of connections, the connection between cell n and cell m is considered to be different from the connection between cell m and cell n. Thus, NJA is equal to the total number of connections, including n to m and m to n, and the total number of cells." - -[blocks.dimensions.fields.nvert] -type = "integer" -longname = "number of vertices" -description = "is the total number of (x, y) vertex pairs used to define the plan-view shape of each cell in the model grid. If NVERT is not specified or is specified as zero, then the VERTICES and CELL2D blocks below are not read. NVERT and the accompanying VERTICES and CELL2D blocks should be specified for most simulations. If the XT3D or SAVE_SPECIFIC_DISCHARGE options are specified in the NPF Package, then this information is required." -optional = true - -[blocks.griddata.fields.top] -type = "array" -longname = "cell top elevation" -description = "is the top elevation for each cell in the model grid." -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.bot] -type = "array" -longname = "cell bottom elevation" -description = "is the bottom elevation for each cell." -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.area] -type = "array" -longname = "cell surface area" -description = "is the cell surface area (in plan view)." -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.idomain] -type = "array" -longname = "idomain existence array" -description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1 or greater, the cell exists in the simulation. IDOMAIN values of -1 cannot be specified for the DISU Package." -optional = true -dtype = "integer" -shape = [ - "nodes", -] - -[blocks.connectiondata.fields.iac] -type = "array" -longname = "number of cell connections" -description = "is the number of connections (plus 1) for each cell. The sum of all the entries in IAC must be equal to NJA." -dtype = "integer" -shape = [ - "nodes", -] - -[blocks.connectiondata.fields.ja] -type = "array" -longname = "grid connectivity" -description = "is a list of cell number (n) followed by its connecting cell numbers (m) for each of the m cells connected to cell n. The number of values to provide for cell n is IAC(n). This list is sequentially provided for the first to the last cell. The first value in the list must be cell n itself, and the remaining cells must be listed in an increasing order (sorted from lowest number to highest). Note that the cell and its connections are only supplied for the GWF cells and their connections to the other GWF cells. Also note that the JA list input may be divided such that every node and its connectivity list can be on a separate line for ease in readability of the file. To further ease readability of the file, the node number of the cell whose connectivity is subsequently listed, may be expressed as a negative number, the sign of which is subsequently converted to positive by the code." -dtype = "integer" -index = true -shape = [ - "nja", -] - -[blocks.connectiondata.fields.ihc] -type = "array" -longname = "connection type" -description = "is an index array indicating the direction between node n and all of its m connections. If IHC = 0 then cell n and cell m are connected in the vertical direction. Cell n overlies cell m if the cell number for n is less than m; cell m overlies cell n if the cell number for m is less than n. If IHC = 1 then cell n and cell m are connected in the horizontal direction. If IHC = 2 then cell n and cell m are connected in the horizontal direction, and the connection is vertically staggered. A vertically staggered connection is one in which a cell is horizontally connected to more than one cell in a horizontal connection." -dtype = "integer" -shape = [ - "nja", -] - -[blocks.connectiondata.fields.cl12] -type = "array" -longname = "connection lengths" -description = "is the array containing connection lengths between the center of cell n and the shared face with each adjacent m cell." -dtype = "double" -shape = [ - "nja", -] - -[blocks.connectiondata.fields.hwva] -type = "array" -longname = "connection lengths" -description = "is a symmetric array of size NJA. For horizontal connections, entries in HWVA are the horizontal width perpendicular to flow. For vertical connections, entries in HWVA are the vertical area for flow. Thus, values in the HWVA array contain dimensions of both length and area. Entries in the HWVA array have a one-to-one correspondence with the connections specified in the JA array. Likewise, there is a one-to-one correspondence between entries in the HWVA array and entries in the IHC array, which specifies the connection type (horizontal or vertical). Entries in the HWVA array must be symmetric; the program will terminate with an error if the value for HWVA for an n to m connection does not equal the value for HWVA for the corresponding n to m connection." -dtype = "double" -shape = [ - "nja", -] - -[blocks.connectiondata.fields.angldegx] -type = "array" -longname = "angle of face normal to connection" -description = "is the angle (in degrees) between the horizontal x-axis and the outward normal to the face between a cell and its connecting cells. The angle varies between zero and 360.0 degrees, where zero degrees points in the positive x-axis direction, and 90 degrees points in the positive y-axis direction. ANGLDEGX is only needed if horizontal anisotropy is specified in the NPF Package, if the XT3D option is used in the NPF Package, or if the SAVE_SPECIFIC_DISCHARGE option is specified in the NPF Package. ANGLDEGX does not need to be specified otherwise. ANGLDEGX is of size NJA; values specified for vertical connections and for the diagonal position are not used. Note that ANGLDEGX is read in degrees, which is different from MODFLOW-USG, which reads a similar variable (ANGLEX) in radians. Only the value specified for the connection from the lower to the higher cell number is used, but the values for both directions of every horizontal connection between active cells are checked. Because ANGLDEGX is the outward normal of the shared face, the value for the connection from cell n to cell m must differ by 180 degrees (within 0.01 degrees) from the value for the connection from cell m to cell n. If VERTICES and CELL2D are specified, ANGLDEGX must be expressed in the same coordinate system as the vertex coordinates; the centers of two connected cells must lie on opposite sides of their shared face, so ANGLDEGX must be within 90 degrees of the direction from the cell center to the center of the connected cell, and, for cells that share exactly two vertices, ANGLDEGX must agree within 1 degree with the outward normal of the face computed from those vertices. A warning is issued for each of these three conditions that is not met, and the simulation terminates with an error if any of them is not met and the NPF Package requires ANGLDEGX to be specified (XT3D, K22, or SAVE_SPECIFIC_DISCHARGE). A warning is also issued if ANGLDEGX deviates by more than 45 degrees from the direction between the centers of the connected cells; this is not an error, but such connections depart from the assumptions of the control-volume finite-difference method and may warrant a closer look at the grid." -optional = true -dtype = "double" -shape = [ - "nja", -] - -[blocks.vertices.fields.vertices] -type = "list" -longname = "vertices data" -optional = true -shape = [ - "nvert", -] - -[blocks.vertices.fields.vertices.item] -name = "vertices" -type = "record" - -[blocks.vertices.fields.vertices.item.fields.iv] -type = "integer" -longname = "vertex number" -description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." -tagged = false -index = true -pk = true - -[blocks.vertices.fields.vertices.item.fields.xv] -type = "double" -longname = "x-coordinate for vertex" -description = "is the x-coordinate for the vertex." -tagged = false - -[blocks.vertices.fields.vertices.item.fields.yv] -type = "double" -longname = "y-coordinate for vertex" -description = "is the y-coordinate for the vertex." -tagged = false - -[blocks.cell2d.fields.cell2d] -type = "list" -longname = "cell2d data" -optional = true -shape = [ - "nodes", -] - -[blocks.cell2d.fields.cell2d.item] -name = "cell2d" -type = "record" - -[blocks.cell2d.fields.cell2d.item.fields.icell2d] -type = "integer" -longname = "cell2d number" -description = "is the cell2d number. Records in the CELL2D block must be listed in consecutive order from 1 to NODES." -tagged = false -index = true -pk = true - -[blocks.cell2d.fields.cell2d.item.fields.xc] -type = "double" -longname = "x-coordinate for cell center" -description = "is the x-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.yc] -type = "double" -longname = "y-coordinate for cell center" -description = "is the y-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.ncvert] -type = "integer" -longname = "number of cell vertices" -description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.icvert] -type = "array" -longname = "array of vertex numbers" -description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order." -tagged = false -dtype = "integer" -index = true -shape = [ - "ncvert", -] - -[memory.voffsettol] -set_in = "ar" -source = "vertical_offset_tolerance" -type = "double" - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.nodes] -set_in = "ar" -source = "nodes" -type = "integer" - -[memory.nja] -set_in = "ar" -source = "nja" -type = "integer" - -[memory.nvert] -set_in = "ar" -source = "nvert" -type = "integer" - -[memory.top] -type = "array" -set_in = "ar" -source = "top" -dtype = "double" -shape = [ - "nodes", -] - -[memory.bot] -type = "array" -set_in = "ar" -source = "bot" -dtype = "double" -shape = [ - "nodes", -] - -[memory.area] -type = "array" -readonly = true -set_in = "ar" -description = "Horizontal cell area, computed from grid geometry." -dtype = "double" -shape = [ - "nodesuser", -] - -[memory.idomain] -type = "array" -set_in = "ar" -source = "idomain" -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodeuser] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodereduced] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." -dtype = "integer" -shape = [ - "nodesuser", -] diff --git a/flopy4/mf6/dfns/gwf-disv.toml b/flopy4/mf6/dfns/gwf-disv.toml deleted file mode 100644 index 83a4512b2..000000000 --- a/flopy4/mf6/dfns/gwf-disv.toml +++ /dev/null @@ -1,326 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-disv" -parent = "gwf-nam" -ftype = "DISV6" - -[dims.nlay] -value = "nlay" -scope = "model" - -[dims.ncpl] -value = "ncpl" -scope = "model" - -[dims.nvert] -value = "nvert" -scope = "model" - -[dims.nodes] -value = "nlay * ncpl" -scope = "model" - -[dims.ncelldim] -value = "2" -scope = "model" - -[runtime_dims.nodes] -set_in = "ar" - -[runtime_dims.nodesuser] -set_in = "ar" - -[blocks.options.fields.length_units] -type = "string" -longname = "model length units" -description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." -optional = true - -[blocks.options.fields.nogrb] -type = "keyword" -longname = "do not write binary grid file" -description = "keyword to deactivate writing of the binary grid file." -optional = true - -[blocks.options.fields.grb_filerecord] -type = "record" -optional = true - -[blocks.options.fields.grb_filerecord.fields.grb6] -type = "keyword" -longname = "grb keyword" -description = "keyword to specify that record corresponds to a binary grid file." - -[blocks.options.fields.grb_filerecord.fields.grb6_filename] -type = "file" -longname = "file name of GRB information" -description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." -tagged = false -direction = "out" - -[blocks.options.fields.xorigin] -type = "double" -longname = "x-position origin of the model grid coordinate system" -description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.yorigin] -type = "double" -longname = "y-position origin of the model grid coordinate system" -description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.angrot] -type = "double" -longname = "rotation angle" -description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.options.fields.crs] -type = "string" -longname = "CRS user input string" -description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true -case_sensitive = true - -[blocks.options.fields.ncf_filerecord] -type = "record" -optional = true - -[blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "keyword" -longname = "ncf keyword" -description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." - -[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] -type = "file" -longname = "file name of NCF information" -description = "defines a NetCDF configuration (NCF) input file." -tagged = false -direction = "in" -component = "utl-ncf" - -[blocks.dimensions.fields.nlay] -type = "integer" -longname = "number of layers" -description = "is the number of layers in the model grid." - -[blocks.dimensions.fields.ncpl] -type = "integer" -longname = "number of cells per layer" -description = "is the number of cells per layer. This is a constant value for the grid and it applies to all layers." - -[blocks.dimensions.fields.nvert] -type = "integer" -longname = "number of vertices" -description = "is the total number of (x, y) vertex pairs used to characterize the horizontal configuration of the model grid." - -[blocks.griddata.fields.top] -type = "array" -longname = "model top elevation" -description = "is the top elevation for each cell in the top model layer." -netcdf = true -dtype = "double" -shape = [ - "ncpl", -] - -[blocks.griddata.fields.botm] -type = "array" -longname = "model bottom elevation" -description = "is the bottom elevation for each cell." -netcdf = true -dtype = "double" -layered = true -shape = [ - "ncpl", - "nlay", -] - -[blocks.griddata.fields.idomain] -type = "array" -longname = "idomain existence array" -description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1 or greater, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." -optional = true -netcdf = true -dtype = "integer" -layered = true -shape = [ - "ncpl", - "nlay", -] - -[blocks.vertices.fields.vertices] -type = "list" -longname = "vertices data" -shape = [ - "nvert", -] - -[blocks.vertices.fields.vertices.item] -name = "vertices" -type = "record" - -[blocks.vertices.fields.vertices.item.fields.iv] -type = "integer" -longname = "vertex number" -description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." -tagged = false -index = true -pk = true - -[blocks.vertices.fields.vertices.item.fields.xv] -type = "double" -longname = "x-coordinate for vertex" -description = "is the x-coordinate for the vertex." -tagged = false - -[blocks.vertices.fields.vertices.item.fields.yv] -type = "double" -longname = "y-coordinate for vertex" -description = "is the y-coordinate for the vertex." -tagged = false - -[blocks.cell2d.fields.cell2d] -type = "list" -longname = "cell2d data" -shape = [ - "ncpl", -] - -[blocks.cell2d.fields.cell2d.item] -name = "cell2d" -type = "record" - -[blocks.cell2d.fields.cell2d.item.fields.icell2d] -type = "integer" -longname = "cell2d number" -description = "is the CELL2D number. Records in the CELL2D block must be listed in consecutive order from the first to the last." -tagged = false -index = true -pk = true - -[blocks.cell2d.fields.cell2d.item.fields.xc] -type = "double" -longname = "x-coordinate for cell center" -description = "is the x-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.yc] -type = "double" -longname = "y-coordinate for cell center" -description = "is the y-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.ncvert] -type = "integer" -longname = "number of cell vertices" -description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.icvert] -type = "array" -longname = "array of vertex numbers" -description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." -tagged = false -dtype = "integer" -index = true -shape = [ - "ncvert", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.nlay] -set_in = "ar" -source = "nlay" -type = "integer" - -[memory.ncpl] -set_in = "ar" -source = "ncpl" -type = "integer" - -[memory.nvert] -set_in = "ar" -source = "nvert" -type = "integer" - -[memory.top] -type = "array" -set_in = "ar" -source = "top" -dtype = "double" -shape = [ - "ncpl", -] - -[memory.botm] -type = "array" -set_in = "ar" -source = "botm" -dtype = "double" -shape = [ - "ncpl", - "nlay", -] - -[memory.idomain] -type = "array" -set_in = "ar" -source = "idomain" -dtype = "integer" -shape = [ - "ncpl", - "nlay", -] - -[memory.area] -type = "array" -readonly = true -set_in = "ar" -description = "Horizontal cell area, computed from grid geometry." -dtype = "double" -shape = [ - "ncpl", -] - -[memory.nodeuser] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodereduced] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." -dtype = "integer" -shape = [ - "nodesuser", -] diff --git a/flopy4/mf6/dfns/gwf-drn.toml b/flopy4/mf6/dfns/gwf-drn.toml deleted file mode 100644 index 0d859612b..000000000 --- a/flopy4/mf6/dfns/gwf-drn.toml +++ /dev/null @@ -1,342 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-drn" -parent = "gwf-nam" -ftype = "DRN6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of drain conductance." -optional = true - -[blocks.options.fields.auxdepthname] -type = "string" -longname = "name of auxiliary variable for drainage depth" -description = "name of a variable listed in AUXILIARY that defines the depth at which drainage discharge will be scaled. If a positive value is specified for the AUXDEPTHNAME AUXILIARY variable, then ELEV is the elevation at which the drain starts to discharge and ELEV + DDRN (assuming DDRN is the AUXDEPTHNAME variable) is the elevation when the drain conductance (COND) scaling factor is 1. If a negative drainage depth value is specified for DDRN, then ELEV + DDRN is the elevation at which the drain starts to discharge and ELEV is the elevation when the conductance (COND) scaling factor is 1. A linear- or cubic-scaling is used to scale the drain conductance (COND) when the Standard or Newton-Raphson Formulation is used, respectively. This discharge scaling option is described in more detail in Chapter 3 of the Supplemental Technical Information." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of drain cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of drain information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of drain flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save DRN flows to budget file" -description = "keyword to indicate that drain flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the DRN package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DRN package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.mover] -type = "keyword" -description = "keyword to indicate that this instance of the Drain Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." -optional = true - -[blocks.options.fields.dev_cubic_scaling] -type = "keyword" -longname = "cubic-scaling" -description = "cubic-scaling is used to scale the drain conductance" -optional = true -developmode = true - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of drains" -description = "integer value specifying the maximum number of drains cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.elev] -type = "double" -longname = "drain elevation" -description = "is the elevation of the drain. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.cond] -type = "double" -longname = "drain conductance" -description = "is the hydraulic conductance of the interface between the aquifer and the drain. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each drain. The values of auxiliary variables must be present for each drain. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "drain name" -description = "name of the drain cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.icubicsfac] -set_in = "ar" -source = "dev_cubic_scaling" -type = "logical" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: elev, 1: cond." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "DRN" -output = true -obs_type = "DRN" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "DRN-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.drn] -type = "union" - -[observations.drn.arms.cellid] -type = "cellid" -tagged = false - -[observations.drn.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" - -[keys.mover_provider] -path = "<=maxbound" -when = "mover" diff --git a/flopy4/mf6/dfns/gwf-drng.toml b/flopy4/mf6/dfns/gwf-drng.toml deleted file mode 100644 index ab47f46ef..000000000 --- a/flopy4/mf6/dfns/gwf-drng.toml +++ /dev/null @@ -1,339 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-drng" -parent = "gwf-nam" -ftype = "DRN6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.readarraygrid] -type = "keyword" -longname = "use array-based grid input" -description = "indicates that array-based grid input will be used for the drain package. This keyword must be specified to use array-based grid input. When READARRAYGRID is specified, values must be provided for every cell within a model grid, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results. No data cells should contain the value DNODATA (3.0E+30)." -default = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of drain conductance." -optional = true - -[blocks.options.fields.auxdepthname] -type = "string" -longname = "name of auxiliary variable for drainage depth" -description = "name of a variable listed in AUXILIARY that defines the depth at which drainage discharge will be scaled. If a positive value is specified for the AUXDEPTHNAME AUXILIARY variable, then ELEV is the elevation at which the drain starts to discharge and ELEV + DDRN (assuming DDRN is the AUXDEPTHNAME variable) is the elevation when the drain conductance (COND) scaling factor is 1. If a negative drainage depth value is specified for DDRN, then ELEV + DDRN is the elevation at which the drain starts to discharge and ELEV is the elevation when the conductance (COND) scaling factor is 1. A linear- or cubic-scaling is used to scale the drain conductance (COND) when the Standard or Newton-Raphson Formulation is used, respectively. This discharge scaling option is described in more detail in Chapter 3 of the Supplemental Technical Information." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of drain information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of drain flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save DRNG flows to budget file" -description = "keyword to indicate that drain flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the DRN package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DRN package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.mover] -type = "keyword" -description = "keyword to indicate that this instance of the Drain Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.options.fields.dev_cubic_scaling] -type = "keyword" -longname = "cubic-scaling" -description = "cubic-scaling is used to scale the drain conductance" -optional = true -developmode = true - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of drain cells in any stress period" -description = "integer value specifying the maximum number of drains cells that will be specified for use during any stress period." -optional = true - -[blocks.period.fields.elev] -type = "array" -longname = "drain elevation" -description = "is the elevation of the drain." -default = 3e+30 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.period.fields.cond] -type = "array" -longname = "drain conductance" -description = "is the hydraulic conductance of the interface between the aquifer and the drain." -default = 3e+30 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.period.fields.aux] -type = "list" -longname = "drain auxiliary variable iaux" -description = "is an array of values for auxiliary variable aux(iaux), where iaux is a value from 1 to naux, and aux(iaux) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then it will retain its value from the most recently specified period block. If an auxiliary variable array has never been specified, its value is zero. If the value specified here for the auxiliary variable is the same as auxmultname, then the conductance array will be multiplied by this array." -optional = true -shape = [ - "<=auxiliary", -] - -[blocks.period.fields.aux.item] -name = "aux" -type = "record" - -[blocks.period.fields.aux.item.fields.auxname] -type = "string" -longname = "auxiliary variable name" -description = "name of the auxiliary variable the following array sets; must be one of the auxiliary variables." -tagged = false -fk = "options.auxiliary" -dynamic = true - -[blocks.period.fields.aux.item.fields.aux] -type = "array" -longname = "drain auxiliary variable iaux" -netcdf = true -tagged = false -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.icubicsfac] -set_in = "ar" -source = "dev_cubic_scaling" -type = "logical" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "DRN" -output = true -obs_type = "DRN" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "DRN-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.drn] -type = "union" - -[observations.drn.arms.cellid] -type = "cellid" -tagged = false - -[observations.drn.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" - -[keys.mover_provider] -path = "<=maxbound" -when = "mover" diff --git a/flopy4/mf6/dfns/gwf-evt.toml b/flopy4/mf6/dfns/gwf-evt.toml deleted file mode 100644 index 15fe6201b..000000000 --- a/flopy4/mf6/dfns/gwf-evt.toml +++ /dev/null @@ -1,371 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-evt" -parent = "gwf-nam" -ftype = "EVT6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.nseg] -value = "nseg" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.fixed_cell] -type = "keyword" -longname = "if cell is dry do not apply evapotranspiration to underlying cell" -description = "indicates that evapotranspiration will not be reassigned to a cell underlying the cell specified in the list if the specified cell is inactive." -optional = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of evapotranspiration rate." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of evapotranspiration cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of evapotranspiration information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print evapotranspiration rates to listing file" -description = "keyword to indicate that the list of evapotranspiration flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save evapotranspiration rates to budget file" -description = "keyword to indicate that evapotranspiration flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the EVT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVT package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.surf_rate_specified] -type = "keyword" -longname = "specify proportion of evapotranspiration rate at ET surface" -description = "indicates that the proportion of the evapotranspiration rate at the ET surface will be specified as PETM0 in list input." -optional = true - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of evapotranspiration cells" -description = "integer value specifying the maximum number of evapotranspiration cells that will be specified for use during any stress period." - -[blocks.dimensions.fields.nseg] -type = "integer" -longname = "number of ET segments" -description = "number of ET segments. Default is one. When NSEG is greater than 1, the PXDP and PETM arrays must be of size NSEG - 1 and be listed in order from the uppermost segment down. Values for PXDP must be listed first followed by the values for PETM. PXDP defines the extinction-depth proportion at the bottom of a segment. PETM defines the proportion of the maximum ET flux rate at the bottom of a segment." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.surface] -type = "double" -longname = "ET surface" -description = "is the elevation of the ET surface ($L$). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.rate] -type = "double" -longname = "maximum ET rate" -description = "is the maximum ET flux rate ($LT^{-1}$). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.depth] -type = "double" -longname = "ET extinction depth" -description = "is the ET extinction depth ($L$). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.pxdp] -type = "array" -longname = "proportion of ET extinction depth" -description = "is the proportion of the ET extinction depth at the bottom of a segment (dimensionless). pxdp is an array of size (nseg - 1). Values in pxdp must be greater than 0.0 and less than 1.0. pxdp values for a cell must increase monotonically. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "nseg-1", -] - -[blocks.period.fields.stress_period_data.item.fields.petm] -type = "array" -longname = "proportion of maximum ET rate" -description = "is the proportion of the maximum ET flux rate at the bottom of a segment (dimensionless). petm is an array of size (nseg - 1). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "nseg-1", -] - -[blocks.period.fields.stress_period_data.item.fields.petm0] -type = "double" -longname = "proportion of maximum ET rate at ET surface" -description = "is the proportion of the maximum ET flux rate that will apply when head is at or above the ET surface (dimensionless). PETM0 is read only when the SURF_RATE_SPECIFIED option is used. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -when = "surf_rate_specified" -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each evapotranspiration. The values of auxiliary variables must be present for each evapotranspiration. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "evapotranspiration name" -description = "name of the evapotranspiration cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.surfratespec] -set_in = "ar" -source = "surf_rate_specified" -type = "logical" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nseg] -set_in = "ar" -source = "nseg" -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: surface, 1: rate, 2: depth, 3: petm0." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "EVT" -output = true -obs_type = "EVT" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.evt] -type = "union" - -[observations.evt.arms.cellid] -type = "cellid" -tagged = false - -[observations.evt.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwf-evta.toml b/flopy4/mf6/dfns/gwf-evta.toml deleted file mode 100644 index 104f706b4..000000000 --- a/flopy4/mf6/dfns/gwf-evta.toml +++ /dev/null @@ -1,336 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-evta" -parent = "gwf-nam" -ftype = "EVT6" -multi = true -subtype = "stress" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.readasarrays] -type = "keyword" -longname = "use array-based input" -description = "indicates that array-based input will be used for the Evapotranspiration Package. This keyword must be specified to use array-based input. When READASARRAYS is specified, values must be provided for every cell within a model layer, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results." -default = true - -[blocks.options.fields.fixed_cell] -type = "keyword" -longname = "if cell is dry do not apply evapotranspiration to underlying cell" -description = "indicates that evapotranspiration will not be reassigned to a cell underlying the cell specified in the list if the specified cell is inactive." -optional = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of evapotranspiration rate." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of evapotranspiration information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print evapotranspiration rates to listing file" -description = "keyword to indicate that the list of evapotranspiration flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save EVTA flows to budget file" -description = "keyword to indicate that evapotranspiration flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.tas_filerecord] -type = "list" -optional = true - -[blocks.options.fields.tas_filerecord.item] -name = "tas_filerecord" -type = "record" - -[blocks.options.fields.tas_filerecord.item.fields.tas6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-array-series file." - -[blocks.options.fields.tas_filerecord.item.fields.tas6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the Time-Variable Input section for instructions on using the time-array series capability." -tagged = false -direction = "in" -component = "utl-tas" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the EVT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVT package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.period.fields.ievt] -type = "array" -longname = "layer number for evapotranspiration" -description = "IEVT is the layer number that defines the layer in each vertical column where evapotranspiration is applied. If IEVT is omitted, evapotranspiration by default is applied to cells in layer 1. If IEVT is specified, it must be specified as the first variable in the PERIOD block or MODFLOW will terminate with an error." -optional = true -netcdf = true -dtype = "integer" -index = true -shape = [ - "ncpl", -] - -[blocks.period.fields.surface] -type = "array" -longname = "evapotranspiration surface" -description = "is the elevation of the ET surface ($L$)." -default = 0.0 -netcdf = true -dtype = "double" -shape = [ - "ncpl", -] - -[blocks.period.fields.rate] -type = "array" -longname = "evapotranspiration rate" -description = "is the maximum ET flux rate ($LT^{-1}$)." -default = 0.001 -netcdf = true -dtype = "double" -time_series = true -shape = [ - "ncpl", -] - -[blocks.period.fields.depth] -type = "array" -longname = "extinction depth" -description = "is the ET extinction depth ($L$)." -default = 1.0 -netcdf = true -dtype = "double" -shape = [ - "ncpl", -] - -[blocks.period.fields.aux] -type = "list" -longname = "evapotranspiration auxiliary variable iaux" -description = "is an array of values for auxiliary variable AUX(IAUX), where iaux is a value from 1 to NAUX, and AUX(IAUX) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then it will retain its value from the most recently specified period block. If an auxiliary variable array has never been specified, its value is zero. If the value specified here for the auxiliary variable is the same as auxmultname, then the evapotranspiration rate will be multiplied by this array." -optional = true -shape = [ - "<=auxiliary", -] - -[blocks.period.fields.aux.item] -name = "aux" -type = "record" - -[blocks.period.fields.aux.item.fields.auxname] -type = "string" -longname = "auxiliary variable name" -description = "name of the auxiliary variable the following array sets; must be one of the auxiliary variables." -tagged = false -fk = "options.auxiliary" -dynamic = true - -[blocks.period.fields.aux.item.fields.aux] -type = "array" -longname = "evapotranspiration auxiliary variable iaux" -netcdf = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "ncpl", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "EVTA" -output = true -obs_type = "EVT" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.evt] -type = "union" - -[observations.evt.arms.cellid] -type = "cellid" -tagged = false - -[observations.evt.arms.boundname] -type = "string" -tagged = false diff --git a/flopy4/mf6/dfns/gwf-ghb.toml b/flopy4/mf6/dfns/gwf-ghb.toml deleted file mode 100644 index d4caff02d..000000000 --- a/flopy4/mf6/dfns/gwf-ghb.toml +++ /dev/null @@ -1,324 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-ghb" -parent = "gwf-nam" -ftype = "GHB6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of general-head boundary conductance." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of general-head boundary cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of general-head boundary information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of general-head boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save GHB flows to budget file" -description = "keyword to indicate that general-head boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the GHB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the GHB package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.mover] -type = "keyword" -description = "keyword to indicate that this instance of the General-Head Boundary Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." -optional = true - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of general-head boundaries" -description = "integer value specifying the maximum number of general-head boundary cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.bhead] -type = "double" -longname = "boundary head" -description = "is the boundary head. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.cond] -type = "double" -longname = "boundary conductance" -description = "is the hydraulic conductance of the interface between the aquifer cell and the boundary. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each general-head boundary. The values of auxiliary variables must be present for each general-head boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "general-head boundary name" -description = "name of the general-head boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: bhead, 1: cond." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "GHB" -output = true -obs_type = "GHB" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "GHB-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.ghb] -type = "union" - -[observations.ghb.arms.cellid] -type = "cellid" -tagged = false - -[observations.ghb.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" - -[keys.mover_provider] -path = "<=maxbound" -when = "mover" diff --git a/flopy4/mf6/dfns/gwf-ghbg.toml b/flopy4/mf6/dfns/gwf-ghbg.toml deleted file mode 100644 index a8e3ab7e3..000000000 --- a/flopy4/mf6/dfns/gwf-ghbg.toml +++ /dev/null @@ -1,321 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-ghbg" -parent = "gwf-nam" -ftype = "GHB6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.readarraygrid] -type = "keyword" -longname = "use array-based grid input" -description = "indicates that array-based grid input will be used for the general-head boundary package. This keyword must be specified to use array-based grid input. When READARRAYGRID is specified, values must be provided for every cell within a model grid, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results. No data cells should contain the value DNODATA (3.0E+30)." -default = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of general-head boundary conductance." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of general-head boundary information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of general-head boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save GHBG flows to budget file" -description = "keyword to indicate that general-head boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the GHB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the GHB package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.mover] -type = "keyword" -description = "keyword to indicate that this instance of the General-Head Boundary Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of general-head boundaries in any stress period" -description = "integer value specifying the maximum number of general-head boundary cells that will be specified for use during any stress period." -optional = true - -[blocks.period.fields.bhead] -type = "array" -longname = "boundary head" -description = "is the boundary head." -default = 3e+30 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.period.fields.cond] -type = "array" -longname = "boundary conductance" -description = "is the hydraulic conductance of the interface between the aquifer cell and the boundary." -default = 3e+30 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.period.fields.aux] -type = "list" -longname = "general-head boundary auxiliary variable iaux" -description = "is an array of values for auxiliary variable aux(iaux), where iaux is a value from 1 to naux, and aux(iaux) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then it will retain its value from the most recently specified period block. If an auxiliary variable array has never been specified, its value is zero. If the value specified here for the auxiliary variable is the same as auxmultname, then the conductance array will be multiplied by this array." -optional = true -shape = [ - "<=auxiliary", -] - -[blocks.period.fields.aux.item] -name = "aux" -type = "record" - -[blocks.period.fields.aux.item.fields.auxname] -type = "string" -longname = "auxiliary variable name" -description = "name of the auxiliary variable the following array sets; must be one of the auxiliary variables." -tagged = false -fk = "options.auxiliary" -dynamic = true - -[blocks.period.fields.aux.item.fields.aux] -type = "array" -longname = "general-head boundary auxiliary variable iaux" -netcdf = true -tagged = false -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "GHB" -output = true -obs_type = "GHB" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "GHB-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.ghb] -type = "union" - -[observations.ghb.arms.cellid] -type = "cellid" -tagged = false - -[observations.ghb.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" - -[keys.mover_provider] -path = "<=maxbound" -when = "mover" diff --git a/flopy4/mf6/dfns/gwf-gnc.toml b/flopy4/mf6/dfns/gwf-gnc.toml deleted file mode 100644 index 09c720844..000000000 --- a/flopy4/mf6/dfns/gwf-gnc.toml +++ /dev/null @@ -1,98 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-gnc" -ftype = "GNC6" -parent = [ - "exg-gwfgwf", - "gwf-nam", -] - -[dims.numgnc] -value = "numgnc" - -[dims.numalphaj] -value = "numalphaj" - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of GNC information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print simulated flows to listing file" -description = "keyword to indicate that the list of GNC flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.explicit] -type = "keyword" -longname = "use explicit GNC formulation" -description = "keyword to indicate that the ghost node correction is applied in an explicit manner on the right-hand side of the matrix. The explicit approach will likely require additional outer iterations. If the keyword is not specified, then the correction will be applied in an implicit manner on the left-hand side. The implicit approach will likely converge better, but may require additional memory. If the EXPLICIT keyword is not specified, then the BICGSTAB linear acceleration option should be specified within the LINEAR block of the Sparse Matrix Solver." -optional = true - -[blocks.dimensions.fields.numgnc] -type = "integer" -longname = "number of ghost node corrections" -description = "is the number of GNC entries." - -[blocks.dimensions.fields.numalphaj] -type = "integer" -longname = "number of contributing factors" -description = "is the number of contributing factors." - -[blocks.gncdata.fields.gncdata] -type = "list" -shape = [ - "numgnc", -] - -[blocks.gncdata.fields.gncdata.item] -name = "gncdata" -type = "record" - -[blocks.gncdata.fields.gncdata.item.fields.cellidn] -type = "cellid" -longname = "GNC cellid n" -description = "is the cellid of the cell, $n$, in which the ghost node is located. For a structured grid that uses the DIS input file, CELLIDN is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDN is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDN is the node number for the cell." -tagged = false -model = "1" - -[blocks.gncdata.fields.gncdata.item.fields.cellidm] -type = "cellid" -longname = "GNC cellid n" -description = "is the cellid of the connecting cell, $m$, to which flow occurs from the ghost node. For a structured grid that uses the DIS input file, CELLIDM is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLIDM is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLIDM is the node number for the cell." -tagged = false -model = "2" - -[blocks.gncdata.fields.gncdata.item.fields.cellidsj] -type = "array" -longname = "GNC contributing cells" -description = "is the array of CELLIDS for the contributing j cells, which contribute to the interpolated head value at the ghost node. This item contains one CELLID for each of the contributing cells of the ghost node. Note that if the number of actual contributing cells needed by the user is less than NUMALPHAJ for any ghost node, then a dummy CELLID of zero(s) should be inserted with an associated contributing factor of zero. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLID is the layer number and cell2d number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLID is the node number for the cell." -tagged = false -dtype = "cellid" -model = "1" -allow_zero = true -shape = [ - "numalphaj", -] - -[blocks.gncdata.fields.gncdata.item.fields.alphasj] -type = "array" -longname = "GNC contributing factors" -description = "is the contributing factors for each contributing node in CELLIDSJ. Note that if the number of actual contributing cells is less than NUMALPHAJ for any ghost node, then dummy CELLIDS should be inserted with an associated contributing factor of zero. The sum of ALPHASJ should be less than one. This is because one minus the sum of ALPHASJ is equal to the alpha term (alpha n in equation 4-61 of the GWF Model report) that is multiplied by the head in cell n." -tagged = false -dtype = "double" -shape = [ - "numalphaj", -] - -[memory.numgnc] -set_in = "ar" -source = "numgnc" -type = "integer" - -[memory.numalphaj] -set_in = "ar" -source = "numalphaj" -type = "integer" diff --git a/flopy4/mf6/dfns/gwf-hfb.toml b/flopy4/mf6/dfns/gwf-hfb.toml deleted file mode 100644 index fb30dc4f8..000000000 --- a/flopy4/mf6/dfns/gwf-hfb.toml +++ /dev/null @@ -1,63 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-hfb" -parent = "gwf-nam" -ftype = "HFB6" - -[dims.maxhfb] -value = "maxhfb" - -[blocks.options.fields.print_input] -type = "keyword" -longname = "model print input to listing file" -description = "keyword to indicate that the list of hydraulic flow barriers will be written to the listing file immediately after it is read." -optional = true - -[blocks.dimensions.fields.maxhfb] -type = "integer" -longname = "maximum number of barriers" -description = "integer value specifying the maximum number of hydraulic flow barriers that will be entered in this input file. The value of MAXHFB is used to allocate memory for the hydraulic flow barriers." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxhfb", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid1] -type = "cellid" -longname = "first cell adjacent to barrier" -description = "identifier for the first cell. For a structured grid that uses the DIS input file, CELLID1 is the layer, row, and column numbers of the cell. For a grid that uses the DISV input file, CELLID1 is the layer number and CELL2D number for the two cells. If the model uses the unstructured discretization (DISU) input file, then CELLID1 is the node number for the cell. The barrier is located between cells designated as CELLID1 and CELLID2. The program will terminate with an error if CELLID1 and CELLID2 are not horizontally or vertically adjacent." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.cellid2] -type = "cellid" -longname = "second cell adjacent to barrier" -description = "identifier for the second cell. See CELLID1 for description of how to specify." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.hydchr] -type = "double" -longname = "barrier hydraulic characteristic" -description = "is the hydraulic characteristic of the hydraulic-flow barrier. The hydraulic characteristic is the barrier hydraulic conductivity divided by the width of the hydraulic-flow barrier. If the hydraulic characteristic is negative, then the absolute value of HYDCHR acts as a multiplier to the conductance between the two model cells specified as containing the barrier. For example, if the value for HYDCHR was specified as -1.5, the conductance calculated for the two cells would be multiplied by 1.5." -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.maxbound] -set_in = "ar" -source = "maxhfb" -type = "integer" diff --git a/flopy4/mf6/dfns/gwf-ic.toml b/flopy4/mf6/dfns/gwf-ic.toml deleted file mode 100644 index 4884980b4..000000000 --- a/flopy4/mf6/dfns/gwf-ic.toml +++ /dev/null @@ -1,51 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-ic" -parent = "gwf-nam" -ftype = "IC6" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.griddata.fields.strt] -type = "array" -longname = "starting head" -description = "is the initial (starting) head---that is, head at the beginning of the GWF Model simulation. STRT must be specified for all simulations, including steady-state simulations. One value is read for every model cell. For simulations in which the first stress period is steady state, the values used for STRT generally do not affect the simulation (exceptions may occur if cells go dry and (or) rewet). The execution time, however, will be less if STRT includes hydraulic heads that are close to the steady-state solution. A head value lower than the cell bottom can be provided if a cell should start as dry." -default = 1.0 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.strt] -type = "array" -set_in = "ar" -source = "strt" -dtype = "double" -shape = [ - "nodes", -] diff --git a/flopy4/mf6/dfns/gwf-lak.toml b/flopy4/mf6/dfns/gwf-lak.toml deleted file mode 100644 index 494d02de5..000000000 --- a/flopy4/mf6/dfns/gwf-lak.toml +++ /dev/null @@ -1,1214 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-lak" -parent = "gwf-nam" -ftype = "LAK6" -multi = true -subtype = "advanced" - -[dims.nlakes] -value = "nlakes" - -[dims.noutlets] -value = "noutlets" - -[dims.ntables] -value = "ntables" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.nlakeconn] -value = "sum(packagedata.nlakeconn)" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of lake cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of lake information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_stage] -type = "keyword" -longname = "print calculated stages to listing file" -description = "keyword to indicate that the list of lake {#2} will be printed to the listing file for every stress period in which 'HEAD PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of lake flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save lake flows to budget file" -description = "keyword to indicate that lake flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.stage_filerecord] -type = "record" -optional = true - -[blocks.options.fields.stage_filerecord.fields.stage] -type = "keyword" -longname = "stage keyword" -description = "keyword to specify that record corresponds to stage." - -[blocks.options.fields.stage_filerecord.fields.stagefile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write stage information." -tagged = false -direction = "out" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.package_convergence_filerecord] -type = "record" -optional = true - -[blocks.options.fields.package_convergence_filerecord.fields.package_convergence] -type = "keyword" -longname = "package_convergence keyword" -description = "keyword to specify that record corresponds to the package convergence comma spaced values file. A warning message will be issued if package convergence data is requested but the IMPLICIT option is specified. In that case the lake stage is included in the Iterative Model Solution (IMS) convergence check and the package convergence file is not written." - -[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] -type = "file" -longname = "file keyword" -description = "name of the comma spaced values output file to write package convergence information." -tagged = false -direction = "out" - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the LAK package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LAK package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.mover] -type = "keyword" -description = "keyword to indicate that this instance of the LAK Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." -optional = true - -[blocks.options.fields.dev_force_legacy] -type = "keyword" -longname = "force the legacy solution for every lake" -description = "keyword that solves every active lake with the default (legacy) substitution solver under the implicit formulation, instead of only those lakes that are too poorly conditioned to solve as a matrix unknown. Cannot be specified with DEV_FORCE_LEGACY_LAKE. This development option exists to test that path and is not supported." -optional = true -developmode = true - -[blocks.options.fields.dev_force_legacy_lake] -type = "integer" -longname = "force the legacy solution for one lake" -description = "integer lake number that is solved with the default (legacy) substitution solver under the implicit formulation, while the other lakes are solved as matrix unknowns. Cannot be specified with DEV_FORCE_LEGACY. This development option exists to test that path and is not supported." -optional = true -developmode = true - -[blocks.options.fields.dev_groundwater_head_conductance] -type = "keyword" -longname = "use the groundwater head to calculate horizontal conductance" -description = "keyword that calculates the conductance for horizontal connections using the groundwater head instead of the lake stage. This development option is not supported." -optional = true -developmode = true - -[blocks.options.fields.dev_maximum_outlet_depth] -type = "double" -longname = "maximum outlet depth" -description = "real number value that defines the maximum depth used to calculate outlet flow. This development option is not supported." -optional = true -developmode = true - -[blocks.options.fields.surfdep] -type = "double" -longname = "surface depression depth" -description = "real value that defines the surface depression depth for VERTICAL lake-GWF connections. If specified, SURFDEP must be greater than or equal to zero. If SURFDEP is not specified, a default value of zero is used for all vertical lake-GWF connections." -optional = true - -[blocks.options.fields.implicit] -type = "keyword" -longname = "solve lake stage in the groundwater flow matrix" -description = "keyword that activates the implicit formulation. With this option each lake stage is solved as an additional unknown in the groundwater flow matrix, instead of by the default substitution-iteration solver. The implicit formulation typically converges in far fewer outer iterations for steady-state and strongly coupled lakes and can solve problems for which the default formulation fails to converge. Converged results are equivalent to the default formulation. The implicit formulation makes the coefficient matrix asymmetric and therefore requires the BICGSTAB linear acceleration in the Iterative Model Solution (IMS). Each lake must have at least one groundwater connection when the IMPLICIT option is active because the implicit formulation solves the lake stage through its lakebed seepage; the program will terminate with an error if a lake with no groundwater connections is specified with the IMPLICIT option. The implicit formulation does not yet include the density terms of the Buoyancy (BUY) Package, and the program will terminate with an error if the IMPLICIT option is specified and the BUY Package is active. If a lake stage becomes too poorly conditioned to solve as a matrix unknown, which can happen for a weakly connected or disconnected lake, that lake is solved automatically by the default substitution solver instead, so the implicit formulation remains as robust as the default formulation. The Newton formulation is recommended for lakes that may become perched (disconnected from the aquifer), because results obtained with the standard rewetting (REWET) capability can otherwise differ between the two approaches." -optional = true - -[blocks.options.fields.maximum_iterations] -type = "integer" -longname = "LAK Newton-Raphson iterations" -description = "integer value that defines the maximum number of Newton-Raphson iterations allowed for a lake. By default, MAXIMUM_ITERATIONS is equal to 100. MAXIMUM_ITERATIONS would only need to be increased from the default value if one or more lakes in a simulation has a large water budget error. This option applies only to the default substitution-iteration solver; when the IMPLICIT option is active the lake stage is solved within the groundwater flow matrix and its convergence is controlled by the Iterative Model Solution (IMS) settings instead." -optional = true - -[blocks.options.fields.maximum_stage_change] -type = "double" -longname = "stage closure tolerance" -description = "real value that defines the lake stage closure tolerance. By default, MAXIMUM_STAGE_CHANGE is equal to $1 times 10^{-5}$. The MAXIMUM_STAGE_CHANGE would only need to be increased or decreased from the default value if the water budget error for one or more lakes is too small or too large, respectively. This option applies only to the default substitution-iteration solver; when the IMPLICIT option is active the lake stage is solved within the groundwater flow matrix and its convergence is controlled by the Iterative Model Solution (IMS) settings instead." -optional = true - -[blocks.options.fields.time_conversion] -type = "double" -longname = "time conversion factor" -description = "real value that is used to convert user-specified Manning's roughness coefficients or gravitational acceleration used to calculate outlet flows from seconds to model time units. TIME_CONVERSION should be set to 1.0, 60.0, 3,600.0, 86,400.0, and 31,557,600.0 when using time units (TIME_UNITS) of seconds, minutes, hours, days, or years in the simulation, respectively. TIME_CONVERSION does not need to be specified if no lake outlets are specified or TIME_UNITS are seconds." -optional = true - -[blocks.options.fields.length_conversion] -type = "double" -longname = "length conversion factor" -description = "real value that is used to convert outlet user-specified Manning's roughness coefficients or gravitational acceleration used to calculate outlet flows from meters to model length units. LENGTH_CONVERSION should be set to 3.28081, 1.0, and 100.0 when using length units (LENGTH_UNITS) of feet, meters, or centimeters in the simulation, respectively. LENGTH_CONVERSION does not need to be specified if no lake outlets are specified or LENGTH_UNITS are meters." -optional = true - -[blocks.options.fields.dev_no_final_check] -type = "keyword" -longname = "disable final convergence check for lake stages" -description = "flag disabling the final convergence check of the change in lake stages. By default this check is enabled." -optional = true -developmode = true - -[blocks.dimensions.fields.nlakes] -type = "integer" -longname = "number of lakes" -description = "value specifying the number of lakes that will be simulated for all stress periods." - -[blocks.dimensions.fields.noutlets] -type = "integer" -longname = "number of outlets" -description = "value specifying the number of outlets that will be simulated for all stress periods. If NOUTLETS is not specified, a default value of zero is used." - -[blocks.dimensions.fields.ntables] -type = "integer" -longname = "number of tables" -description = "value specifying the number of lakes tables that will be used to define the lake stage, volume relation, and surface area. If NTABLES is not specified, a default value of zero is used." - -[blocks.packagedata.fields.packagedata] -type = "list" -shape = [ - "nlakes", -] - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.ifno] -type = "integer" -longname = "lake number for this entry" -description = "integer value that defines the feature (lake) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NLAKES. Lake information must be specified for every lake or the program will terminate with an error. The program will also terminate with an error if information for a lake is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.strt] -type = "double" -longname = "starting lake stage" -description = "real value that defines the starting stage for the lake." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.nlakeconn] -type = "integer" -longname = "number of lake connections" -description = "integer value that defines the number of GWF cells connected to this (IFNO) lake. There can only be one vertical lake connection to each GWF cell. NLAKECONN must be greater than zero." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.packagedata.fields.packagedata.item.fields.boundname] -type = "string" -longname = "well name" -description = "name of the lake cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.connectiondata.fields.connectiondata] -type = "list" -shape = [ - "nlakeconn", -] - -[blocks.connectiondata.fields.connectiondata.item] -name = "connectiondata" -type = "record" - -[blocks.connectiondata.fields.connectiondata.item.fields.ifno] -type = "integer" -longname = "lake number for this entry" -description = "integer value that defines the feature (lake) number associated with the specified CONNECTIONDATA data on the line. IFNO must be greater than zero and less than or equal to NLAKES. Lake connection information must be specified for every lake connection to the GWF model (NLAKECONN) or the program will terminate with an error. The program will also terminate with an error if connection information for a lake connection to the GWF model is specified more than once." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.connectiondata.fields.connectiondata.item.fields.iconn] -type = "integer" -longname = "connection number for this entry" -description = "integer value that defines the GWF connection number for this lake connection entry. ICONN must be greater than zero and less than or equal to NLAKECONN for lake IFNO." -tagged = false -index = true - -[blocks.connectiondata.fields.connectiondata.item.fields.iconn.pk] -scope = "ifno" - -[blocks.connectiondata.fields.connectiondata.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.connectiondata.fields.connectiondata.item.fields.claktype] -type = "string" -longname = "lake connection type" -description = "character string that defines the lake-GWF connection type for the lake connection. Possible lake-GWF connection type strings include: VERTICAL--character keyword to indicate the lake-GWF connection is vertical and connection conductance calculations use the hydraulic conductivity corresponding to the $K_{33}$ tensor component defined for CELLID in the NPF package. HORIZONTAL--character keyword to indicate the lake-GWF connection is horizontal and connection conductance calculations use the hydraulic conductivity corresponding to the $K_{11}$ tensor component defined for CELLID in the NPF package. EMBEDDEDH--character keyword to indicate the lake-GWF connection is embedded in a single cell and connection conductance calculations use the hydraulic conductivity corresponding to the $K_{11}$ tensor component defined for CELLID in the NPF package. EMBEDDEDV--character keyword to indicate the lake-GWF connection is embedded in a single cell and connection conductance calculations use the hydraulic conductivity corresponding to the $K_{33}$ tensor component defined for CELLID in the NPF package. Embedded lakes can only be connected to a single cell (NLAKECONN = 1) and there must be a lake table associated with each embedded lake." -tagged = false - -[blocks.connectiondata.fields.connectiondata.item.fields.bedleak] -type = "union" -longname = "bed leakance" -description = "real value or character string that defines the bed leakance for the lake-GWF connection. BEDLEAK must be greater than or equal to zero, equal to the DNODATA value (3.0E+30), or specified to be NONE. If DNODATA or NONE is specified for BEDLEAK, the lake-GWF connection conductance is solely a function of aquifer properties in the connected GWF cell and lakebed sediments are assumed to be absent. Warning messages will be issued if NONE is specified. Eventually the ability to specify NONE will be deprecated and cause MODFLOW 6 to terminate with an error." - -[blocks.connectiondata.fields.connectiondata.item.fields.bedleak.arms.none] -type = "keyword" - -[blocks.connectiondata.fields.connectiondata.item.fields.bedleak.arms.value] -type = "double" -tagged = false - -[blocks.connectiondata.fields.connectiondata.item.fields.belev] -type = "double" -longname = "bottom elevation" -description = "real value that defines the bottom elevation for a HORIZONTAL lake-GWF connection. Any value can be specified if CLAKTYPE is VERTICAL, EMBEDDEDH, or EMBEDDEDV. If CLAKTYPE is HORIZONTAL and BELEV is not equal to TELEV, BELEV must be greater than or equal to the bottom of the GWF cell CELLID. If BELEV is equal to TELEV, BELEV is reset to the bottom of the GWF cell CELLID." -tagged = false - -[blocks.connectiondata.fields.connectiondata.item.fields.telev] -type = "double" -longname = "top elevation" -description = "real value that defines the top elevation for a HORIZONTAL lake-GWF connection. Any value can be specified if CLAKTYPE is VERTICAL, EMBEDDEDH, or EMBEDDEDV. If CLAKTYPE is HORIZONTAL and TELEV is not equal to BELEV, TELEV must be less than or equal to the top of the GWF cell CELLID. If TELEV is equal to BELEV, TELEV is reset to the top of the GWF cell CELLID." -tagged = false - -[blocks.connectiondata.fields.connectiondata.item.fields.connlen] -type = "double" -longname = "connection length" -description = "real value that defines the distance between the connected GWF CELLID node and the lake for a HORIZONTAL, EMBEDDEDH, or EMBEDDEDV lake-GWF connection. CONLENN must be greater than zero for a HORIZONTAL, EMBEDDEDH, or EMBEDDEDV lake-GWF connection. Any value can be specified if CLAKTYPE is VERTICAL." -tagged = false - -[blocks.connectiondata.fields.connectiondata.item.fields.connwidth] -type = "double" -longname = "connection width" -description = "real value that defines the connection face width for a HORIZONTAL lake-GWF connection. CONNWIDTH must be greater than zero for a HORIZONTAL lake-GWF connection. Any value can be specified if CLAKTYPE is VERTICAL, EMBEDDEDH, or EMBEDDEDV." -tagged = false - -[blocks.tables.fields.tables] -type = "list" -optional = true -shape = [ - "ntables", -] - -[blocks.tables.fields.tables.item] -name = "tables" -type = "record" - -[blocks.tables.fields.tables.item.fields.ifno] -type = "integer" -longname = "lake number for this entry" -description = "integer value that defines the feature (lake) number associated with the specified TABLES data on the line. IFNO must be greater than zero and less than or equal to NLAKES. The program will terminate with an error if table information for a lake is specified more than once or the number of specified tables is less than NTABLES." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.tables.fields.tables.item.fields.tab6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a table file." - -[blocks.tables.fields.tables.item.fields.tab6_filename] -type = "file" -longname = "table file name" -description = "character string that defines the path and filename for the file containing lake table data for the lake connection. The TAB6_FILENAME file includes the number of entries in the file and the relation between stage, volume, and surface area for each entry in the file. Lake table files for EMBEDDEDH and EMBEDDEDV lake-GWF connections also include lake-GWF exchange area data for each entry in the file. Instructions for creating the TAB6_FILENAME input file are provided in Lake Table Input File section." -tagged = false -direction = "in" -component = "utl-laktab" - -[blocks.outlets.fields.outlets] -type = "list" -optional = true -shape = [ - "noutlets", -] - -[blocks.outlets.fields.outlets.item] -name = "outlets" -type = "record" - -[blocks.outlets.fields.outlets.item.fields.outletno] -type = "integer" -longname = "outlet number for this entry" -description = "integer value that defines the outlet number associated with the specified OUTLETS data on the line. OUTLETNO must be greater than zero and less than or equal to NOUTLETS. Outlet information must be specified for every outlet or the program will terminate with an error. The program will also terminate with an error if information for a outlet is specified more than once." -tagged = false -index = true -pk = true - -[blocks.outlets.fields.outlets.item.fields.lakein] -type = "integer" -longname = "lake number for upstream lake" -description = "integer value that defines the lake number that outlet is connected to. LAKEIN must be greater than zero and less than or equal to NLAKES." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.outlets.fields.outlets.item.fields.lakeout] -type = "integer" -longname = "lake number for downstream lake" -description = "integer value that defines the lake number that outlet discharge from lake outlet OUTLETNO is routed to. LAKEOUT must be greater than or equal to zero and less than or equal to NLAKES. If LAKEOUT is zero, outlet discharge from lake outlet OUTLETNO is discharged to an external boundary." -tagged = false -index = true -fk = "packagedata.ifno" -allow_zero = true - -[blocks.outlets.fields.outlets.item.fields.couttype] -type = "string" -longname = "outlet type" -description = "character string that defines the outlet type for the outlet OUTLETNO. Possible COUTTYPE strings include: SPECIFIED--character keyword to indicate the outlet is defined as a specified flow. MANNING--character keyword to indicate the outlet is defined using Manning's equation. WEIR--character keyword to indicate the outlet is defined using a sharp weir equation." -tagged = false - -[blocks.outlets.fields.outlets.item.fields.invert] -type = "double" -longname = "invert elevation" -description = "real value that defines the invert elevation for the lake outlet. Any value can be specified if COUTTYPE is SPECIFIED. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.outlets.fields.outlets.item.fields.width] -type = "double" -longname = "outlet width" -description = "real value that defines the width of the lake outlet. Any value can be specified if COUTTYPE is SPECIFIED. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.outlets.fields.outlets.item.fields.rough] -type = "double" -longname = "roughness coefficient" -description = "real value that defines the roughness coefficient for the lake outlet. Any value can be specified if COUTTYPE is not MANNING. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.outlets.fields.outlets.item.fields.slope] -type = "double" -longname = "bed slope" -description = "real value that defines the bed slope for the lake outlet. Any value can be specified if COUTTYPE is not MANNING. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "laksetting" -type = "union" -description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the LAKSETTING string include both keywords for lake settings and keywords for outlet settings. Keywords for lake settings include: STATUS, STAGE, RAINFALL, EVAPORATION, RUNOFF, INFLOW, WITHDRAWAL, and AUXILIARY. Keywords for outlet settings include RATE, INVERT, WIDTH, SLOPE, and ROUGH." - -[blocks.period.fields.stress_period_data.item.arms.status] -type = "record" - -[blocks.period.fields.stress_period_data.item.arms.status.fields.lakeno] -type = "integer" -longname = "lake or outlet number for this entry" -description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.arms.status.fields.status] -type = "string" -longname = "lake status" -description = "keyword option to define lake status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE." - -[blocks.period.fields.stress_period_data.item.arms.stage] -type = "record" - -[blocks.period.fields.stress_period_data.item.arms.stage.fields.lakeno] -type = "integer" -longname = "lake or outlet number for this entry" -description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.arms.stage.fields.stage] -type = "double" -longname = "lake stage" -description = "real or character value that defines the stage for the lake. The specified STAGE is only applied if the lake is a constant stage lake. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.arms.rainfall] -type = "record" - -[blocks.period.fields.stress_period_data.item.arms.rainfall.fields.lakeno] -type = "integer" -longname = "lake or outlet number for this entry" -description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.arms.rainfall.fields.rainfall] -type = "double" -longname = "rainfall rate" -description = "real or character value that defines the rainfall rate $(LT^{-1})$ for the lake. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.arms.evaporation] -type = "record" - -[blocks.period.fields.stress_period_data.item.arms.evaporation.fields.lakeno] -type = "integer" -longname = "lake or outlet number for this entry" -description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.arms.evaporation.fields.evaporation] -type = "double" -longname = "evaporation rate" -description = "real or character value that defines the maximum evaporation rate $(LT^{-1})$ for the lake. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.arms.runoff] -type = "record" - -[blocks.period.fields.stress_period_data.item.arms.runoff.fields.lakeno] -type = "integer" -longname = "lake or outlet number for this entry" -description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.arms.runoff.fields.runoff] -type = "double" -longname = "runoff rate" -description = "real or character value that defines the runoff rate $(L^3 T^{-1})$ for the lake. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.arms.inflow] -type = "record" - -[blocks.period.fields.stress_period_data.item.arms.inflow.fields.lakeno] -type = "integer" -longname = "lake or outlet number for this entry" -description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.arms.inflow.fields.inflow] -type = "double" -longname = "inflow rate" -description = "real or character value that defines the volumetric inflow rate $(L^3 T^{-1})$ for the lake. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, inflow rates are zero for each lake." -time_series = true - -[blocks.period.fields.stress_period_data.item.arms.withdrawal] -type = "record" - -[blocks.period.fields.stress_period_data.item.arms.withdrawal.fields.lakeno] -type = "integer" -longname = "lake or outlet number for this entry" -description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.arms.withdrawal.fields.withdrawal] -type = "double" -longname = "maximum withdrawal rate" -description = "real or character value that defines the maximum withdrawal rate $(L^3 T^{-1})$ for the lake. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.arms.rate] -type = "record" - -[blocks.period.fields.stress_period_data.item.arms.rate.fields.outletno] -type = "integer" -longname = "lake or outlet number for this entry" -description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." -tagged = false -index = true -fk = "outlets.outletno" - -[blocks.period.fields.stress_period_data.item.arms.rate.fields.rate] -type = "double" -longname = "extraction rate" -description = "real or character value that defines the extraction rate for the lake outflow. A positive value indicates inflow and a negative value indicates outflow from the lake. RATE only applies to outlets associated with active lakes (STATUS is ACTIVE). A specified RATE is only applied if COUTTYPE for the OUTLETNO is SPECIFIED. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, the RATE for each SPECIFIED lake outlet is zero." -time_series = true - -[blocks.period.fields.stress_period_data.item.arms.invert] -type = "record" - -[blocks.period.fields.stress_period_data.item.arms.invert.fields.outletno] -type = "integer" -longname = "lake or outlet number for this entry" -description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." -tagged = false -index = true -fk = "outlets.outletno" - -[blocks.period.fields.stress_period_data.item.arms.invert.fields.invert] -type = "double" -longname = "invert elevation" -description = "real or character value that defines the invert elevation for the lake outlet. A specified INVERT value is only used for active lakes if COUTTYPE for lake outlet OUTLETNO is not SPECIFIED. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.arms.width] -type = "record" - -[blocks.period.fields.stress_period_data.item.arms.width.fields.outletno] -type = "integer" -longname = "lake or outlet number for this entry" -description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." -tagged = false -index = true -fk = "outlets.outletno" - -[blocks.period.fields.stress_period_data.item.arms.width.fields.width] -type = "double" -longname = "outlet width" -description = "real or character value that defines the width of the lake outlet. A specified WIDTH value is only used for active lakes if COUTTYPE for lake outlet OUTLETNO is not SPECIFIED. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.arms.slope] -type = "record" - -[blocks.period.fields.stress_period_data.item.arms.slope.fields.outletno] -type = "integer" -longname = "lake or outlet number for this entry" -description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." -tagged = false -index = true -fk = "outlets.outletno" - -[blocks.period.fields.stress_period_data.item.arms.slope.fields.slope] -type = "double" -longname = "bed slope" -description = "real or character value that defines the bed slope for the lake outlet. A specified SLOPE value is only used for active lakes if COUTTYPE for lake outlet OUTLETNO is MANNING. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.arms.rough] -type = "record" - -[blocks.period.fields.stress_period_data.item.arms.rough.fields.outletno] -type = "integer" -longname = "lake or outlet number for this entry" -description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." -tagged = false -index = true -fk = "outlets.outletno" - -[blocks.period.fields.stress_period_data.item.arms.rough.fields.rough] -type = "double" -longname = "roughness coefficient" -description = "real value that defines the roughness coefficient for the lake outlet. Any value can be specified if COUTTYPE is not MANNING. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.arms.auxiliaryrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.arms.auxiliaryrecord.fields.lakeno] -type = "integer" -longname = "lake or outlet number for this entry" -description = "integer value that defines the lake or outlet number associated with the specified PERIOD data on the line. NUMBER must be greater than zero and less than or equal to NLAKES for a lake number and less than or equal to NOUTLETS for an outlet number." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.arms.auxiliaryrecord.fields.auxiliary] -type = "keyword" -description = "keyword for specifying auxiliary variable." - -[blocks.period.fields.stress_period_data.item.arms.auxiliaryrecord.fields.auxname] -type = "string" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -tagged = false - -[blocks.period.fields.stress_period_data.item.arms.auxiliaryrecord.fields.auxval] -type = "double" -longname = "auxiliary variable value" -description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.options_stage] -set_in = "ar" -source = "stage" -type = "logical" - -[memory.pkgconv] -set_in = "ar" -source = "package_convergence" -type = "logical" - -[memory.pkgconvfname] -set_in = "ar" -source = "package_convergence_filename" -type = "string" - -[memory.options_filein] -set_in = "ar" -type = "logical" - -[memory.iforceleg] -set_in = "ar" -source = "dev_force_legacy" -type = "integer" - -[memory.iforceleglak] -set_in = "ar" -source = "dev_force_legacy_lake" -type = "integer" - -[memory.igwhcopt] -set_in = "ar" -source = "dev_groundwater_head_conductance" -type = "integer" - -[memory.outdmax] -set_in = "ar" -source = "dev_maximum_outlet_depth" -type = "double" - -[memory.surfdep] -set_in = "ar" -source = "surfdep" -type = "double" - -[memory.iimplicit] -set_in = "ar" -source = "implicit" -type = "integer" - -[memory.maxlakit] -set_in = "ar" -source = "maximum_iterations" -type = "integer" - -[memory.dmaxchg] -set_in = "ar" -source = "maximum_stage_change" -type = "double" - -[memory.convtime] -set_in = "ar" -source = "time_conversion" -type = "double" - -[memory.convlength] -set_in = "ar" -source = "length_conversion" -type = "double" - -[memory.iconvchk] -set_in = "ar" -source = "dev_no_final_check" -type = "integer" - -[memory.packagedata_ifno] -set_in = "ar" -source = "ifno" -type = "integer" - -[memory.conndata_ifno] -source = "ifno" -type = "integer" - -[memory.tables_ifno] -source = "ifno" -type = "integer" - -[memory.tables_filein] -type = "logical" - -[memory.laktab6_filename] -source = "tab6_filename" -type = "string" - -[memory.outlets_outletno] -source = "outletno" -type = "integer" - -[memory.outlets_invert] -source = "invert" -type = "double" - -[memory.outlets_width] -source = "width" -type = "double" - -[memory.outlets_rough] -source = "rough" -type = "double" - -[memory.outlets_slope] -source = "slope" -type = "double" - -[memory.ifno] -set_in = "rp" -type = "integer" - -[memory.period_auxiliary] -set_in = "rp" -source = "auxiliary" -type = "logical" - -[memory.nlakes] -set_in = "ar" -source = "nlakes" -type = "integer" - -[memory.noutlets] -set_in = "ar" -source = "noutlets" -type = "integer" - -[memory.ntables] -set_in = "ar" -source = "ntables" -type = "integer" - -[observations.stage] -type = "union" - -[observations.stage.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.stage.arms.boundname] -type = "string" -tagged = false - -[observations.ext-inflow] -type = "union" - -[observations.ext-inflow.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.ext-inflow.arms.boundname] -type = "string" -tagged = false - -[observations.outlet-inflow] -type = "union" - -[observations.outlet-inflow.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.outlet-inflow.arms.boundname] -type = "string" -tagged = false - -[observations.inflow] -type = "union" - -[observations.inflow.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.inflow.arms.boundname] -type = "string" -tagged = false - -[observations.from-mvr] -type = "union" - -[observations.from-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.from-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.rainfall] -type = "union" - -[observations.rainfall.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.rainfall.arms.boundname] -type = "string" -tagged = false - -[observations.runoff] -type = "union" - -[observations.runoff.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.runoff.arms.boundname] -type = "string" -tagged = false - -[observations.withdrawal] -type = "union" - -[observations.withdrawal.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.withdrawal.arms.boundname] -type = "string" -tagged = false - -[observations.evaporation] -type = "union" - -[observations.evaporation.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.evaporation.arms.boundname] -type = "string" -tagged = false - -[observations.storage] -type = "union" - -[observations.storage.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.storage.arms.boundname] -type = "string" -tagged = false - -[observations.constant] -type = "union" - -[observations.constant.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.constant.arms.boundname] -type = "string" -tagged = false - -[observations.volume] -type = "union" - -[observations.volume.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.volume.arms.boundname] -type = "string" -tagged = false - -[observations.surface-area] -type = "union" - -[observations.surface-area.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.surface-area.arms.boundname] -type = "string" -tagged = false - -[observations.lak] -type = "union" - -[observations.lak.arms.ifno_iconn] -type = "record" - -[observations.lak.arms.ifno_iconn.fields.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.lak.arms.ifno_iconn.fields.iconn] -type = "integer" -tagged = false -index = true - -[observations.lak.arms.ifno_iconn.fields.iconn.fk] -path = "connectiondata.iconn" -scope = "ifno" - -[observations.lak.arms.ifno_boundname] -type = "record" - -[observations.lak.arms.ifno_boundname.fields.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.lak.arms.ifno_boundname.fields.boundname] -type = "string" -tagged = false - -[observations.lak.arms.boundname] -type = "string" -tagged = false - -[observations.wetted-area] -type = "union" - -[observations.wetted-area.arms.ifno_iconn] -type = "record" - -[observations.wetted-area.arms.ifno_iconn.fields.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.wetted-area.arms.ifno_iconn.fields.iconn] -type = "integer" -tagged = false -index = true - -[observations.wetted-area.arms.ifno_iconn.fields.iconn.fk] -path = "connectiondata.iconn" -scope = "ifno" - -[observations.wetted-area.arms.ifno_boundname] -type = "record" - -[observations.wetted-area.arms.ifno_boundname.fields.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.wetted-area.arms.ifno_boundname.fields.boundname] -type = "string" -tagged = false - -[observations.wetted-area.arms.boundname] -type = "string" -tagged = false - -[observations.conductance] -type = "union" - -[observations.conductance.arms.ifno_iconn] -type = "record" - -[observations.conductance.arms.ifno_iconn.fields.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.conductance.arms.ifno_iconn.fields.iconn] -type = "integer" -tagged = false -index = true - -[observations.conductance.arms.ifno_iconn.fields.iconn.fk] -path = "connectiondata.iconn" -scope = "ifno" - -[observations.conductance.arms.ifno_boundname] -type = "record" - -[observations.conductance.arms.ifno_boundname.fields.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.conductance.arms.ifno_boundname.fields.boundname] -type = "string" -tagged = false - -[observations.conductance.arms.boundname] -type = "string" -tagged = false - -[observations.ext-outflow] -type = "union" - -[observations.ext-outflow.arms.outletno] -type = "integer" -tagged = false -index = true -fk = "outlets.outletno" - -[observations.ext-outflow.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.outletno] -type = "integer" -tagged = false -index = true -fk = "outlets.outletno" - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.outlet] -type = "union" - -[observations.outlet.arms.outletno] -type = "integer" -tagged = false -index = true -fk = "outlets.outletno" - -[observations.outlet.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=nlakeconn" - -[keys.mover_provider] -path = "outlets.outletno" -when = "mover" - -[keys.mover_receiver] -path = "packagedata.ifno" -when = "mover" diff --git a/flopy4/mf6/dfns/gwf-maw.toml b/flopy4/mf6/dfns/gwf-maw.toml deleted file mode 100644 index c4ac850de..000000000 --- a/flopy4/mf6/dfns/gwf-maw.toml +++ /dev/null @@ -1,832 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-maw" -parent = "gwf-nam" -ftype = "MAW6" -multi = true -subtype = "advanced" - -[dims.nmawwells] -value = "nmawwells" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.ngwfnodes] -value = "sum(packagedata.ngwfnodes)" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of multi-aquifer well cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of multi-aquifer well information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_head] -type = "keyword" -longname = "print calculated heads to listing file" -description = "keyword to indicate that the list of multi-aquifer well {#2} will be printed to the listing file for every stress period in which 'HEAD PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of multi-aquifer well flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save well flows to budget file" -description = "keyword to indicate that multi-aquifer well flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.head_filerecord] -type = "record" -optional = true - -[blocks.options.fields.head_filerecord.fields.head] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to head." - -[blocks.options.fields.head_filerecord.fields.headfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write head information." -tagged = false -direction = "out" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.no_well_storage] -type = "keyword" -longname = "deactivate well storage" -description = "keyword that deactivates inclusion of well storage contributions to the multi-aquifer well package continuity equation." -optional = true - -[blocks.options.fields.flow_correction] -type = "keyword" -longname = "activate flow correction" -description = "keyword that activates flow corrections in cases where the head in a multi-aquifer well is below the bottom of the screen for a connection or the head in a convertible cell connected to a multi-aquifer well is below the cell bottom. When flow corrections are activated, unit head gradients are used to calculate the flow between a multi-aquifer well and a connected GWF cell. By default, flow corrections are not made." -optional = true - -[blocks.options.fields.non_vertical_wells] -type = "keyword" -longname = "activate non-vertical well connections" -description = "keyword that activates support for non-vertical (slanted) multi-aquifer well connections. When this option is specified, an ANGLEDATA block can be used to assign a tilt angle (deviation from vertical) to individual multi-aquifer well connections. The saturated conductance for a connection listed in the ANGLEDATA block is scaled by the in-cell screen length, which is calculated from the screen top, screen bottom, and tilt angle (or specified directly), instead of the vertical screen thickness. By default, all multi-aquifer well connections are assumed to be vertical. The tilt angle and connection length scale the conductance for a single connection only and do not route flow through intervening cells; a well that passes through more than one cell (a slanted well or a horizontal lateral) must have a separate connection to each cell that it penetrates. For a connection that uses the SPECIFIED conductance equation, the saturated conductance is used unchanged (the length correction is not applied because the conductance is provided by the user), but the screen top and bottom are honored so that the connection saturation is calculated over the correct interval rather than over the full cell." -optional = true - -[blocks.options.fields.flowing_wells] -type = "keyword" -longname = "activate flowing wells" -description = "keyword that activates the flowing wells option for the multi-aquifer well package." -optional = true - -[blocks.options.fields.shutdown_theta] -type = "double" -longname = "shutdown theta" -description = "value that defines the weight applied to discharge rate for wells that limit the water level in a discharging well (defined using the HEAD_LIMIT keyword in the stress period data). SHUTDOWN_THETA is used to control discharge rate oscillations when the flow rate from the aquifer is less than the specified flow rate from the aquifer to the well. Values range between 0.0 and 1.0, and larger values increase the weight (decrease under-relaxation) applied to the well discharge rate. The HEAD_LIMIT option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the HEAD_LIMIT option is recommended. By default, SHUTDOWN_THETA is 0.7." -optional = true - -[blocks.options.fields.shutdown_kappa] -type = "double" -longname = "shutdown kappa" -description = "value that defines the weight applied to discharge rate for wells that limit the water level in a discharging well (defined using the HEAD_LIMIT keyword in the stress period data). SHUTDOWN_KAPPA is used to control discharge rate oscillations when the flow rate from the aquifer is less than the specified flow rate from the aquifer to the well. Values range between 0.0 and 1.0, and larger values increase the weight applied to the well discharge rate. The HEAD_LIMIT option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the HEAD_LIMIT option is recommended. By default, SHUTDOWN_KAPPA is 0.0001." -optional = true - -[blocks.options.fields.mfrcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.mfrcsv_filerecord.fields.maw_flow_reduce_csv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the output option in which a new record is written for each multi-aquifer well and for each time step in which the user-requested extraction or injection rate is reduced by the program." - -[blocks.options.fields.mfrcsv_filerecord.fields.mfrcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write information about multi-aquifer well extraction or injection rates that have been reduced by the program. Entries are only written if the extraction or injection rates are reduced." -tagged = false -direction = "out" - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the MAW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MAW package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.mover] -type = "keyword" -description = "keyword to indicate that this instance of the MAW Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." -optional = true - -[blocks.options.fields.dev_peaceman_effective_radius] -type = "keyword" -longname = "use the Peaceman effective radius" -description = "keyword that calculates the effective radius for structured grids using the approach of Peaceman (1983) instead of the default approach. This development option is not supported." -optional = true -developmode = true - -[blocks.dimensions.fields.nmawwells] -type = "integer" -longname = "number of MAW wells" -description = "integer value specifying the number of multi-aquifer wells that will be simulated for all stress periods." - -[blocks.packagedata.fields.packagedata] -type = "list" -shape = [ - "nmawwells", -] - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.ifno] -type = "integer" -longname = "well number for this entry" -description = "integer value that defines the feature (well) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. Multi-aquifer well information must be specified for every multi-aquifer well or the program will terminate with an error. The program will also terminate with an error if information for a multi-aquifer well is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.radius] -type = "double" -longname = "well radius" -description = "radius for the multi-aquifer well. The program will terminate with an error if the radius is less than or equal to zero." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.bottom] -type = "double" -longname = "well bottom" -description = "bottom elevation of the multi-aquifer well. If CONDEQN is SPECIFIED, THIEM, SKIN, or CUMULATIVE, BOTTOM is set to the cell bottom in the lowermost GWF cell connection in cases where the specified well bottom is above the bottom of this GWF cell. If CONDEQN is MEAN, BOTTOM is set to the lowermost GWF cell connection screen bottom in cases where the specified well bottom is above this value. The bottom elevation defines the lowest well head that will be simulated when the NEWTON UNDER_RELAXATION option is specified in the GWF model name file. The bottom elevation is also used to calculate volumetric storage in the well." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.strt] -type = "double" -longname = "starting head" -description = "starting head for the multi-aquifer well. The program will terminate with an error if the starting head is less than the specified well bottom." -tagged = false -time_series = true - -[blocks.packagedata.fields.packagedata.item.fields.condeqn] -type = "string" -longname = "conductance equation" -description = "character string that defines the conductance equation that is used to calculate the saturated conductance for the multi-aquifer well. Possible multi-aquifer well CONDEQN strings include: SPECIFIED--character keyword to indicate the multi-aquifer well saturated conductance will be specified. THIEM--character keyword to indicate the multi-aquifer well saturated conductance will be calculated using the Thiem equation, which considers the cell top and bottom, aquifer hydraulic conductivity, and effective cell and well radius. SKIN--character keyword to indicate that the multi-aquifer well saturated conductance will be calculated using the cell top and bottom, aquifer and screen hydraulic conductivity, and well and skin radius. CUMULATIVE--character keyword to indicate that the multi-aquifer well saturated conductance will be calculated using a combination of the Thiem and SKIN equations. MEAN--character keyword to indicate the multi-aquifer well saturated conductance will be calculated using the aquifer and screen top and bottom, aquifer and screen hydraulic conductivity, and well and skin radius. The CUMULATIVE conductance equation is identical to the SKIN LOSSTYPE in the Multi-Node Well (MNW2) package for MODFLOW-2005. The program will terminate with an error condition if CONDEQN is SKIN or CUMULATIVE and the calculated saturated conductance is less than zero; if an error condition occurs, it is suggested that the THIEM or MEAN conductance equations be used for these multi-aquifer wells." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.ngwfnodes] -type = "integer" -longname = "number of connected GWF cells" -description = "integer value that defines the number of GWF nodes connected to this (IFNO) multi-aquifer well. NGWFNODES must be greater than zero." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each multi-aquifer well. The values of auxiliary variables must be present for each multi-aquifer well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.packagedata.fields.packagedata.item.fields.boundname] -type = "string" -longname = "well name" -description = "name of the multi-aquifer well cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.connectiondata.fields.connectiondata] -type = "list" -shape = [ - "ngwfnodes", -] - -[blocks.connectiondata.fields.connectiondata.item] -name = "connectiondata" -type = "record" - -[blocks.connectiondata.fields.connectiondata.item.fields.ifno] -type = "integer" -longname = "well number for this entry" -description = "integer value that defines the feature (well) number associated with the specified CONNECTIONDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. Multi-aquifer well connection information must be specified for every multi-aquifer well connection to the GWF model (NGWFNODES) or the program will terminate with an error. The program will also terminate with an error if connection information for a multi-aquifer well connection to the GWF model is specified more than once." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.connectiondata.fields.connectiondata.item.fields.icon] -type = "integer" -longname = "connection number" -description = "integer value that defines the GWF connection number for this multi-aquifer well connection entry. ICONN must be greater than zero and less than or equal to NGWFNODES for multi-aquifer well IFNO." -tagged = false -index = true - -[blocks.connectiondata.fields.connectiondata.item.fields.icon.pk] -scope = "ifno" - -[blocks.connectiondata.fields.connectiondata.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. One or more screened intervals can be connected to the same CELLID if CONDEQN for a well is MEAN. The program will terminate with an error if MAW wells using SPECIFIED, THIEM, SKIN, or CUMULATIVE conductance equations have more than one connection to the same CELLID." -tagged = false - -[blocks.connectiondata.fields.connectiondata.item.fields.scrn_top] -type = "double" -longname = "screen top" -description = "value that defines the top elevation of the screen for the multi-aquifer well connection. If CONDEQN is SPECIFIED, THIEM, SKIN, or CUMULATIVE, SCRN_TOP can be any value and is set to the top of the cell. If CONDEQN is MEAN, SCRN_TOP is set to the multi-aquifer well connection cell top if the specified value is greater than the cell top. The program will terminate with an error if the screen top is less than the screen bottom." -tagged = false - -[blocks.connectiondata.fields.connectiondata.item.fields.scrn_bot] -type = "double" -longname = "screen bottom" -description = "value that defines the bottom elevation of the screen for the multi-aquifer well connection. If CONDEQN is SPECIFIED, THIEM, SKIN, or CUMULATIVE, SCRN_BOT can be any value and is set to the bottom of the cell. If CONDEQN is MEAN, SCRN_BOT is set to the multi-aquifer well connection cell bottom if the specified value is less than the cell bottom. The program will terminate with an error if the screen bottom is greater than the screen top." -tagged = false - -[blocks.connectiondata.fields.connectiondata.item.fields.hk_skin] -type = "double" -longname = "skin data" -description = "value that defines the skin (filter pack) hydraulic conductivity (if CONDEQN for the multi-aquifer well is SKIN, CUMULATIVE, or MEAN) or conductance (if CONDEQN for the multi-aquifer well is SPECIFIED) for each GWF node connected to the multi-aquifer well (NGWFNODES). If CONDEQN is SPECIFIED, HK_SKIN must be greater than or equal to zero. HK_SKIN can be any value if CONDEQN is THIEM. Otherwise, HK_SKIN must be greater than zero. If CONDEQN is SKIN, the contrast between the cell transmissivity (the product of geometric mean horizontal hydraulic conductivity and the cell thickness) and the well transmissivity (the product of HK_SKIN and the screen thicknesses) must be greater than one in node CELLID or the program will terminate with an error condition; if an error condition occurs, it is suggested that the HK_SKIN be reduced to a value less than K11 and K22 in node CELLID or the THIEM or MEAN conductance equations be used for these multi-aquifer wells." -tagged = false - -[blocks.connectiondata.fields.connectiondata.item.fields.radius_skin] -type = "double" -longname = "skin radius" -description = "real value that defines the skin radius (filter pack radius) for the multi-aquifer well. RADIUS_SKIN can be any value if CONDEQN is SPECIFIED or THIEM. If CONDEQN is SKIN, CUMULATIVE, or MEAN, the program will terminate with an error if RADIUS_SKIN is less than or equal to the RADIUS for the multi-aquifer well." -tagged = false - -[blocks.angledata.fields.angledata] -type = "list" -optional = true - -[blocks.angledata.fields.angledata.item] -name = "angledata" -type = "record" - -[blocks.angledata.fields.angledata.item.fields.ifno] -type = "integer" -longname = "well number for this entry" -description = "integer value that defines the feature (well) number associated with the specified ANGLEDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. This block can only be specified if the NON_VERTICAL_WELLS option is specified in the OPTIONS block. Multi-aquifer well connections that are not listed in the ANGLEDATA block are assumed to be vertical. The program will terminate with an error if connection information for a multi-aquifer well connection is specified more than once." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.angledata.fields.angledata.item.fields.icon] -type = "integer" -longname = "connection number" -description = "integer value that defines the GWF connection number for this multi-aquifer well connection entry. ICON must be greater than zero and less than or equal to NGWFNODES for multi-aquifer well IFNO." -tagged = false -index = true - -[blocks.angledata.fields.angledata.item.fields.icon.pk] -scope = "ifno" - -[blocks.angledata.fields.angledata.item.fields.icon.fk] -path = "connectiondata.icon" -scope = "ifno" - -[blocks.angledata.fields.angledata.item.fields.angle] -type = "double" -longname = "tilt angle from vertical" -description = "value that defines the tilt angle of the multi-aquifer well connection, in degrees measured as a deviation from vertical. ANGLE must be greater than or equal to 0.0 (a vertical connection) and less than or equal to 90.0 (a horizontal connection) degrees. The in-cell screen length used to calculate the saturated conductance is computed from the screen top, screen bottom, well radius, and ANGLE, unless CONN_LENGTH is specified. The horizontal distance spanned by a connection grows rapidly as ANGLE approaches 90.0 degrees, and a warning is issued if it is greater than the maximum horizontal extent of the connected cell. A connection that is intended to pass through more than one cell should be specified as a separate connection to each cell that it passes through. If a connection passes through more than one cell unintentionally, ANGLE or CONN_LENGTH should be reduced." -tagged = false - -[blocks.angledata.fields.angledata.item.fields.conn_length] -type = "double" -longname = "in-cell screen length" -description = "optional value that defines the length of the multi-aquifer well screen within the connected GWF cell. If CONN_LENGTH is specified (and greater than zero), it is used directly as the in-cell screen length; otherwise, the in-cell screen length is calculated from the screen top, screen bottom, well radius, and ANGLE. CONN_LENGTH must be specified for horizontal connections (ANGLE equal to 90.0 degrees) because the in-cell screen length cannot be derived from the screen elevations for a horizontal connection. A warning is issued if the horizontal distance spanned by the connection is greater than the maximum horizontal extent of the connected cell. The MEAN conductance equation is recommended for horizontal connections. For a horizontal connection using the MEAN conductance equation, SCRN_TOP and SCRN_BOT do not affect the magnitude of the saturated conductance but do determine the elevation range over which the connection saturates and dewaters; SCRN_TOP and SCRN_BOT should be set to the top and bottom of the horizontal borehole so that the vertical screen extent (SCRN_TOP $-$ SCRN_BOT) equals the well diameter (2 times RADIUS). The program snaps SCRN_TOP to SCRN_BOT plus the well diameter when the specified extent is essentially equal to the well diameter, and otherwise issues a warning." -optional = true -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "perioddata" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.ifno] -type = "integer" -longname = "well number for this entry" -description = "integer value that defines the well number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.fields.mawsetting] -type = "union" -description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the MAWSETTING string include: STATUS, CONNECTION_STATUS, BOTTOM, FLOWING_WELL, RATE, WELL_HEAD, HEAD_LIMIT, SHUT_OFF, RATE_SCALING, and AUXILIARY." - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.status] -type = "string" -longname = "well status" -description = "keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE." - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.connection_statusrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.connection_statusrecord.fields.connection_status] -type = "keyword" -longname = "connection status keyword" -description = "keyword to indicate that the status of an individual multi-aquifer well connection is being changed. If CONNECTION_STATUS is specified, both ICON and CONNSTATUS must be specified." - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.connection_statusrecord.fields.icon] -type = "integer" -longname = "connection number" -description = "integer value that defines the connection number of multi-aquifer well IFNO for which CONNSTATUS is being specified. ICON must be greater than zero and less than or equal to NGWFNODES for multi-aquifer well IFNO." -tagged = false -index = true - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.connection_statusrecord.fields.connstatus] -type = "string" -longname = "connection status" -description = "keyword option to define the status of an individual multi-aquifer well connection. CONNSTATUS can be ACTIVE or INACTIVE. By default, every multi-aquifer well connection is ACTIVE. An INACTIVE connection does not exchange water with the connected GWF cell and is reported in the multi-aquifer well budget file with a flow rate of zero. MAW and CONDUCTANCE observations of an INACTIVE connection are reported as DNODATA (3.0E+30), as they are for an INACTIVE well. A connection that is not simulated, because it or its multi-aquifer well is INACTIVE, has no wetted area, so an associated MWE Package does not conduct heat through it. A connection is simulated only if both the multi-aquifer well and the connection are active, so setting the well STATUS to INACTIVE suspends all of its connections without changing their individual settings; the previously specified connection settings are used again when the well is made ACTIVE or CONSTANT. At least one connection of a multi-aquifer well must be ACTIVE; to deactivate every connection of a well, set the well STATUS to INACTIVE. CONNECTION_STATUS does not change the volume of water stored in the multi-aquifer well; use BOTTOM to change the elevation at which the well is empty when the lower part of a well is filled." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.bottom] -type = "double" -longname = "well bottom" -description = "real value that defines the bottom elevation of the multi-aquifer well. BOTTOM can be used to raise the bottom of a well that has been filled or plugged, so that the well stops yielding water at the elevation of the fill instead of at its original bottom. BOTTOM does not change the amount of water released from or taken into multi-aquifer well storage for a given change in head, which is determined by the well radius; it changes the elevation at which the multi-aquifer well is empty. The volume of water displaced by the material used to fill the well is not included in the multi-aquifer well budget. BOTTOM must be less than or equal to the simulated head in the well and must be less than or equal to the screen bottom of every active connection for the multi-aquifer well." - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.flowing_wellrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.flowing_wellrecord.fields.flowing_well] -type = "keyword" -longname = "well is a flowing well" -description = "keyword to indicate the well is a flowing well. The FLOWING_WELL option can be used to simulate flowing wells when the simulated well head exceeds the specified drainage elevation." - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.flowing_wellrecord.fields.fwelev] -type = "double" -longname = "flowing well elevation" -description = "elevation used to determine whether or not the well is flowing." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.flowing_wellrecord.fields.fwcond] -type = "double" -longname = "well flowing well conductance" -description = "conductance used to calculate the discharge of a free flowing well. Flow occurs when the head in the well is above the well top elevation (FWELEV)." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.flowing_wellrecord.fields.fwrlen] -type = "double" -longname = "flowing well reduction length" -description = "length used to reduce the conductance of the flowing well. When the head in the well drops below the well top plus the reduction length, then the conductance is reduced. This reduction length can be used to improve the stability of simulations with flowing wells so that there is not an abrupt change in flowing well rates." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.rate] -type = "double" -longname = "well pumping rate" -description = "is the volumetric pumping rate for the multi-aquifer well. A positive value indicates recharge and a negative value indicates discharge (pumping). RATE only applies to active (STATUS is ACTIVE) multi-aquifer wells. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, the RATE for each multi-aquifer well is zero." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.well_head] -type = "double" -longname = "well head" -description = "is the head in the multi-aquifer well. WELL_HEAD is only applied to constant head (STATUS is CONSTANT) and inactive (STATUS is INACTIVE) multi-aquifer wells. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. The program will terminate with an error if WELL_HEAD is less than the bottom of the well." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.head_limitrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.head_limitrecord.fields.head_limit] -type = "keyword" - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.head_limitrecord.fields.head_limit_value] -type = "union" -longname = "head limit" -description = "is the limiting water level (head) in the well, which is the minimum of the well RATE or the well inflow rate from the aquifer. HEAD_LIMIT can be applied to extraction wells (RATE $<$ 0) or injection wells (RATE $>$ 0). HEAD_LIMIT can be deactivated by specifying the text string `OFF'. The HEAD_LIMIT option is based on the HEAD_LIMIT functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The HEAD_LIMIT option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the HEAD_LIMIT option is recommended. By default, HEAD_LIMIT is `OFF'." - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.head_limitrecord.fields.head_limit_value.arms.off] -type = "keyword" - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.head_limitrecord.fields.head_limit_value.arms.value] -type = "double" -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.shutoffrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.shutoffrecord.fields.shut_off] -type = "keyword" -longname = "shut off well" -description = "keyword for activating well shut off capability. Subsequent values define the minimum and maximum pumping rate that a well must exceed to shutoff or reactivate a well, respectively, during a stress period. SHUT_OFF is only applied to injection wells (RATE$<0$) and if HEAD_LIMIT is specified (not set to `OFF'). If HEAD_LIMIT is specified, SHUT_OFF can be deactivated by specifying a minimum value equal to zero. The SHUT_OFF option is based on the SHUT_OFF functionality available in the MNW2~citep{konikow2009} package for MODFLOW-2005. The SHUT_OFF option has been included to facilitate backward compatibility with previous versions of MODFLOW but use of the RATE_SCALING option instead of the SHUT_OFF option is recommended. By default, SHUT_OFF is not used." - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.shutoffrecord.fields.minrate] -type = "double" -longname = "minimum shutoff rate" -description = "is the minimum rate that a well must exceed to shutoff a well during a stress period. The well will shut down during a time step if the flow rate to the well from the aquifer is less than MINRATE. If a well is shut down during a time step, reactivation of the well cannot occur until the next time step to reduce oscillations. MINRATE must be less than maxrate." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.shutoffrecord.fields.maxrate] -type = "double" -longname = "maximum shutoff rate" -description = "is the maximum rate that a well must exceed to reactivate a well during a stress period. The well will reactivate during a timestep if the well was shutdown during the previous time step and the flow rate to the well from the aquifer exceeds maxrate. Reactivation of the well cannot occur until the next time step if a well is shutdown to reduce oscillations. maxrate must be greater than MINRATE." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.rate_scalingrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.rate_scalingrecord.fields.rate_scaling] -type = "keyword" -longname = "rate scaling" -description = "activate rate scaling. If RATE_SCALING is specified, both PUMP_ELEVATION and SCALING_LENGTH must be specified. RATE_SCALING cannot be used with HEAD_LIMIT. RATE_SCALING can be used for extraction or injection wells. For extraction wells, the extraction rate will start to decrease once the head in the well lowers to a level equal to the pump elevation plus the scaling length. If the head in the well drops below the pump elevation, then the extraction rate is calculated to be zero. For an injection well, the injection rate will begin to decrease once the head in the well rises above the specified pump elevation. If the head in the well rises above the pump elevation plus the scaling length, then the injection rate will be set to zero." - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.rate_scalingrecord.fields.pump_elevation] -type = "double" -longname = "pump elevation" -description = "is the elevation of the multi-aquifer well pump (PUMP_ELEVATION). PUMP_ELEVATION should not be less than the bottom elevation (BOTTOM) of the multi-aquifer well." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.rate_scalingrecord.fields.scaling_length] -type = "double" -description = "height above the pump elevation (SCALING_LENGTH). If the simulated well head is below this elevation (pump elevation plus the scaling length), then the pumping rate is reduced." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.auxiliaryrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.auxiliaryrecord.fields.auxiliary] -type = "keyword" -description = "keyword for specifying auxiliary variable." - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.auxiliaryrecord.fields.auxname] -type = "string" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.mawsetting.arms.auxiliaryrecord.fields.auxval] -type = "double" -longname = "auxiliary variable value" -description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.inonvert] -set_in = "ar" -source = "non_vertical_wells" -type = "integer" - -[memory.maw_flw_red_csv] -set_in = "ar" -source = "maw_flow_reduce_csv" -type = "logical" - -[memory.ieffradopt] -set_in = "ar" -source = "dev_peaceman_effective_radius" -type = "integer" - -[memory.maxbound] -set_in = "ar" -source = "nmawwells" -type = "integer" - -[memory.packagedata_ifno] -set_in = "ar" -source = "ifno" -type = "integer" - -[memory.conndata_ifno] -source = "ifno" -type = "integer" - -[memory.angledata_ifno] -source = "ifno" -type = "integer" - -[memory.angledata_icon] -source = "icon" -type = "integer" - -[memory.connlen] -source = "conn_length" -type = "double" - -[memory.conn_status] -set_in = "rp" -source = "connection_status" -type = "logical" - -[memory.period_icon] -set_in = "rp" -source = "icon" -type = "integer" - -[memory.period_bottom] -set_in = "rp" -source = "bottom" -type = "double" - -[memory.period_auxiliary] -set_in = "rp" -source = "auxiliary" -type = "logical" - -[observations.head] -type = "union" - -[observations.head.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.head.arms.boundname] -type = "string" -tagged = false - -[observations.from-mvr] -type = "union" - -[observations.from-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.from-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.rate] -type = "union" - -[observations.rate.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.rate.arms.boundname] -type = "string" -tagged = false - -[observations.rate-to-mvr] -type = "union" - -[observations.rate-to-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.rate-to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.fw-rate] -type = "union" - -[observations.fw-rate.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.fw-rate.arms.boundname] -type = "string" -tagged = false - -[observations.fw-to-mvr] -type = "union" - -[observations.fw-to-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.fw-to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.storage] -type = "union" - -[observations.storage.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.storage.arms.boundname] -type = "string" -tagged = false - -[observations.constant] -type = "union" - -[observations.constant.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.constant.arms.boundname] -type = "string" -tagged = false - -[observations.fw-conductance] -type = "union" - -[observations.fw-conductance.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.fw-conductance.arms.boundname] -type = "string" -tagged = false - -[observations.maw] -type = "union" - -[observations.maw.arms.ifno_icon] -type = "record" - -[observations.maw.arms.ifno_icon.fields.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.maw.arms.ifno_icon.fields.icon] -type = "integer" -tagged = false -index = true - -[observations.maw.arms.ifno_icon.fields.icon.fk] -path = "connectiondata.icon" -scope = "ifno" - -[observations.maw.arms.ifno_boundname] -type = "record" - -[observations.maw.arms.ifno_boundname.fields.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.maw.arms.ifno_boundname.fields.boundname] -type = "string" -tagged = false - -[observations.maw.arms.boundname] -type = "string" -tagged = false - -[observations.conductance] -type = "union" - -[observations.conductance.arms.ifno_icon] -type = "record" - -[observations.conductance.arms.ifno_icon.fields.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.conductance.arms.ifno_icon.fields.icon] -type = "integer" -tagged = false -index = true - -[observations.conductance.arms.ifno_icon.fields.icon.fk] -path = "connectiondata.icon" -scope = "ifno" - -[observations.conductance.arms.ifno_boundname] -type = "record" - -[observations.conductance.arms.ifno_boundname.fields.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.conductance.arms.ifno_boundname.fields.boundname] -type = "string" -tagged = false - -[observations.conductance.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=ngwfnodes" - -[keys.mover_provider] -path = "packagedata.ifno" -when = "mover" - -[keys.mover_receiver] -path = "packagedata.ifno" -when = "mover" diff --git a/flopy4/mf6/dfns/gwf-mvr.toml b/flopy4/mf6/dfns/gwf-mvr.toml deleted file mode 100644 index 332bf9f68..000000000 --- a/flopy4/mf6/dfns/gwf-mvr.toml +++ /dev/null @@ -1,209 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-mvr" -ftype = "MVR6" -parent = [ - "exg-gwfgwf", - "gwf-nam", -] - -[dims.maxmvr] -value = "maxmvr" - -[dims.maxpackages] -value = "maxpackages" - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of MVR information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of MVR flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.modelnames] -type = "keyword" -longname = "precede all package names with model names" -description = "keyword to indicate that all package names will be preceded by the model name for the package. Model names are required when the Mover Package is used with a GWF-GWF Exchange. The MODELNAME keyword should not be used for a Mover Package that is for a single GWF Model." -optional = true - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[blocks.dimensions.fields.maxmvr] -type = "integer" -longname = "maximum number of movers" -description = "integer value specifying the maximum number of water mover entries that will specified for any stress period." - -[blocks.dimensions.fields.maxpackages] -type = "integer" -longname = "number of packages to be used with the mover" -description = "integer value specifying the number of unique packages that are included in this water mover input file." - -[blocks.packages.fields.packages] -type = "list" -shape = [ - "maxpackages", -] - -[blocks.packages.fields.packages.item] -name = "packages" -type = "record" - -[blocks.packages.fields.packages.item.fields.mname] -type = "string" -description = "name of model containing the package. Model names are assigned by the user in the simulation name file." -when = "modelnames" -tagged = false - -[blocks.packages.fields.packages.item.fields.mname.fk] -path = "sim-nam.models.mname" -rule = "exchange_models" - -[blocks.packages.fields.packages.item.fields.pname] -type = "string" -description = "is the name of a package that may be included in a subsequent stress period block. The package name is assigned in the name file for the GWF Model. Package names are optionally provided in the name file. If they are not provided by the user, then packages are assigned a default value, which is the package acronym followed by a hyphen and the package number. For example, the first Drain Package is named DRN-1. The second Drain Package is named DRN-2, and so forth." -tagged = false - -[blocks.packages.fields.packages.item.fields.pname.pk] -scope = "mname" - -[blocks.packages.fields.packages.item.fields.pname.fk] -path = "gwf-nam.packages.pname" -scope = "mname" -rule = "mover_enabled" - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "perioddata" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.mname1] -type = "string" -description = "name of model containing the package, PNAME1." -when = "modelnames" -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.mname1.fk] -path = "sim-nam.models.mname" -rule = "exchange_models" - -[blocks.period.fields.stress_period_data.item.fields.pname1] -type = "string" -longname = "provider package name" -description = "is the package name for the provider. The package PNAME1 must be designated to provide water through the MVR Package by specifying the keyword 'MOVER' in its OPTIONS block." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.pname1.fk] -path = "packages.pname" -scope = "mname1" - -[blocks.period.fields.stress_period_data.item.fields.id1] -type = "integer" -longname = "provider reach" -description = "is the identifier for the provider. For the standard boundary packages, the provider identifier is the number of the boundary as it is listed in the package input file. (Note that the order of these boundaries may change by stress period, which must be accounted for in the Mover Package.) So the first well has an identifier of one. The second is two, and so forth. For the advanced packages, the identifier is the reach number (SFR Package), well number (MAW Package), or UZF cell number. For the Lake Package, ID1 is the lake outlet number. Thus, outflows from a single lake can be routed to different streams, for example." -tagged = false -index = true - -[blocks.period.fields.stress_period_data.item.fields.id1.fk] -scope = "pname1" -key = "mover_provider" - -[blocks.period.fields.stress_period_data.item.fields.mname2] -type = "string" -description = "name of model containing the package, PNAME2." -when = "modelnames" -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.mname2.fk] -path = "sim-nam.models.mname" -rule = "exchange_models" - -[blocks.period.fields.stress_period_data.item.fields.pname2] -type = "string" -longname = "receiver package name" -description = "is the package name for the receiver. The package PNAME2 must be designated to receive water from the MVR Package by specifying the keyword 'MOVER' in its OPTIONS block." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.pname2.fk] -path = "packages.pname" -scope = "mname2" - -[blocks.period.fields.stress_period_data.item.fields.id2] -type = "integer" -longname = "receiver reach" -description = "is the identifier for the receiver. The receiver identifier is the reach number (SFR Package), Lake number (LAK Package), well number (MAW Package), or UZF cell number." -tagged = false -index = true - -[blocks.period.fields.stress_period_data.item.fields.id2.fk] -scope = "pname2" -key = "mover_receiver" - -[blocks.period.fields.stress_period_data.item.fields.mvrtype] -type = "string" -longname = "mover type" -description = "is the character string signifying the method for determining how much water will be moved. Supported values are 'FACTOR' 'EXCESS' 'THRESHOLD' and 'UPTO'. These four options determine how the receiver flow rate, $Q_R$, is calculated. These options mirror the options defined for the cprior variable in the SFR package, with the term 'FACTOR' being functionally equivalent to the 'FRACTION' option for cprior." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.value] -type = "double" -longname = "mover value" -description = "is the value to be used in the equation for calculating the amount of water to move. For the 'FACTOR' option, VALUE is the $alpha$ factor. For the remaining options, VALUE is the specified flow rate, $Q_S$." -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.maxmvr] -set_in = "ar" -source = "maxmvr" -type = "integer" - -[memory.maxpackages] -set_in = "ar" -source = "maxpackages" -type = "integer" diff --git a/flopy4/mf6/dfns/gwf-nam.toml b/flopy4/mf6/dfns/gwf-nam.toml deleted file mode 100644 index 29b626004..000000000 --- a/flopy4/mf6/dfns/gwf-nam.toml +++ /dev/null @@ -1,232 +0,0 @@ -type = "model" -schema_version = "2.0.0.dev3" -name = "gwf-nam" -parent = "sim-nam" -ftype = "GWF6" -dependent_variable = "head" - -[runtime_dims.nja] -set_in = "ar" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.list] -type = "string" -longname = "name of listing file" -description = "is name of the listing file to create for this GWF model. If not specified, then the name of the list file will be the basename of the GWF model name file and the '.lst' extension. For example, if the GWF name file is called 'my.model.nam' then the list file will be called 'my.model.lst'." -optional = true -case_sensitive = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save flows for all packages to budget file" -description = "keyword to indicate that all model package flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.newtonoptions] -type = "record" -longname = "newton keyword and options" -description = "none" -optional = true - -[blocks.options.fields.newtonoptions.fields.newton] -type = "keyword" -longname = "keyword to activate Newton-Raphson formulation" -description = "keyword that activates the Newton-Raphson formulation for groundwater flow between connected, convertible groundwater cells and stress packages that support calculation of Newton-Raphson terms for groundwater exchanges. Cells will not dry when this option is used. By default, the Newton-Raphson formulation is not applied." - -[blocks.options.fields.newtonoptions.fields.under_relaxation] -type = "keyword" -longname = "keyword to activate Newton-Raphson UNDER_RELAXATION option" -description = "keyword that indicates whether the groundwater head in a cell will be under-relaxed when water levels fall below the bottom of the model below any given cell. By default, Newton-Raphson UNDER_RELAXATION is not applied." -optional = true - -[blocks.options.fields.nc_mesh2d_filerecord] -type = "record" -description = "NetCDF layered mesh fileout record." -optional = true - -[blocks.options.fields.nc_mesh2d_filerecord.fields.netcdf_mesh2d] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to a layered mesh NetCDF file." - -[blocks.options.fields.nc_mesh2d_filerecord.fields.ncmesh2dfile] -type = "file" -longname = "file keyword" -description = "name of the NetCDF ugrid layered mesh output file." -tagged = false -direction = "out" - -[blocks.options.fields.nc_structured_filerecord] -type = "record" -description = "NetCDF structured fileout record." -optional = true - -[blocks.options.fields.nc_structured_filerecord.fields.netcdf_structured] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to a structured NetCDF file." - -[blocks.options.fields.nc_structured_filerecord.fields.ncstructfile] -type = "file" -longname = "file keyword" -description = "name of the NetCDF structured output file." -tagged = false -direction = "out" - -[blocks.options.fields.nc_filerecord] -type = "record" -description = "NetCDF filerecord" -optional = true - -[blocks.options.fields.nc_filerecord.fields.netcdf] -type = "keyword" -longname = "netcdf keyword" -description = "keyword to specify that record corresponds to a NetCDF input file." - -[blocks.options.fields.nc_filerecord.fields.netcdf_filename] -type = "file" -longname = "netcdf input filename" -description = "defines a NetCDF input file." -tagged = false -direction = "in" - -[blocks.packages.fields.packages] -type = "list" -longname = "package list" - -[blocks.packages.fields.packages.item] -name = "packages" -type = "record" - -[blocks.packages.fields.packages.item.fields.ftype] -type = "string" -longname = "package type" -description = "is the file type, which must be one of the following character values shown in table~ref{table:ftype-gwf}. Ftype may be entered in any combination of uppercase and lowercase." -tagged = false - -[blocks.packages.fields.packages.item.fields.fname] -type = "file" -longname = "file name" -description = "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run." -tagged = false -direction = "in" -mode_keyword = false -component = "package" -component_ftype = "ftype" - -[blocks.packages.fields.packages.item.fields.pname] -type = "string" -longname = "user name for package" -description = "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single GWF Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters." -optional = true -tagged = false -pk = true - -[memory.netcdf_struct] -set_in = "ar" -source = "netcdf_structured" -type = "logical" - -[memory.netcdf_fname] -set_in = "ar" -source = "netcdf_filename" -type = "string" - -[memory.x] -type = "array" -set_in = "ca" -description = "Hydraulic head for each model cell. Checked in from the solution-level dependent-variable vector. Initialized by the IC package during AR; updated by the nonlinear solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." -obs_type = "HEAD" -dtype = "double" -shape = [ - "nodes", -] - -[memory.xold] -type = "array" -readonly = true -set_in = "ad" -description = "Dependent variable from the end of the previous time step. Copied from X at advance (AD); used to restore X if the adaptive time stepping scheme retries a failed time step." -dtype = "double" -shape = [ - "nodes", -] - -[memory.flowja] -type = "array" -readonly = true -set_in = "cq" -description = "Intercell flows in compressed sparse row (CSR) order, calculated after solution convergence. Diagonal entries hold the flow residual." -budget = "FLOW-JA-FACE" -dtype = "double" -shape = [ - "nja", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution for this model, sliced from the solution-level RHS vector. Rebuilt each solver iteration." -dtype = "double" -shape = [ - "nodes", -] - -[memory.ibound] -type = "array" -set_in = "ar" -description = "Cell activity flag: positive values indicate active cells, zero indicates inactive (no-flow) cells. Set during model initialisation; may change when Newton-Raphson wet-dry logic activates or deactivates cells." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.neq] -readonly = true -set_in = "ar" -description = "Number of equations (unknowns) for this model. Equal to the number of active cells (NODES) for standard models." -type = "integer" - -[memory.idxglo] -type = "array" -readonly = true -set_in = "mc" -description = "Maps each local CSR position to the corresponding row/column index in the global solution matrix. Populated during matrix connectivity (MC) and constant thereafter." -dtype = "integer" -shape = [ - "nja", -] - -[observations.head] -type = "cellid" -tagged = false - -[observations.drawdown] -type = "cellid" -tagged = false - -[observations.flow-ja-face] -type = "record" - -[observations.flow-ja-face.fields.cellid] -type = "cellid" -tagged = false - -[observations.flow-ja-face.fields.cellid2] -type = "cellid" -tagged = false diff --git a/flopy4/mf6/dfns/gwf-npf.toml b/flopy4/mf6/dfns/gwf-npf.toml deleted file mode 100644 index 75f79fb39..000000000 --- a/flopy4/mf6/dfns/gwf-npf.toml +++ /dev/null @@ -1,473 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-npf" -parent = "gwf-nam" -ftype = "NPF6" - -[runtime_dims.njas] -set_in = "ar" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "keyword to save NPF flows" -description = "keyword to indicate that budget flow terms will be written to the file specified with 'BUDGET SAVE FILE' in Output Control." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "keyword to print NPF flows to listing file" -description = "keyword to indicate that calculated flows between cells will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period. This option can produce extremely large list files because all cell-by-cell flows are printed. It should only be used with the NPF Package for models that have a small number of cells." -optional = true - -[blocks.options.fields.alternative_cell_averaging] -type = "string" -longname = "conductance weighting option" -description = "is a text keyword to indicate that an alternative method will be used for calculating the conductance for horizontal cell connections. The text value for ALTERNATIVE_CELL_AVERAGING can be 'LOGARITHMIC', 'AMT-LMK', or 'AMT-HMK'. 'AMT-LMK' signifies that the conductance will be calculated using arithmetic-mean thickness and logarithmic-mean hydraulic conductivity. 'AMT-HMK' signifies that the conductance will be calculated using arithmetic-mean thickness and harmonic-mean hydraulic conductivity. If the user does not specify a value for ALTERNATIVE_CELL_AVERAGING, then the harmonic-mean method will be used. This option cannot be used if the XT3D option is invoked. The AMT-HMK ALTERNATIVE_CELL_AVERAGING option, in combination with the DRY_CELL_SATURATION option, can be used to calculate the same horizontal conductance as MODFLOW-USG when upstream weighting is used (LAYCON=4)." -optional = true -valid = [ - "logarithmic", - "amt-lmk", - "amt-hmk", -] - -[blocks.options.fields.thickstrt] -type = "keyword" -longname = "keyword to activate THICKSTRT option" -description = "indicates that cells having a negative ICELLTYPE are confined, and their cell thickness for conductance calculations will be computed as STRT-BOT rather than TOP-BOT. This option should be used with caution as it only affects conductance calculations in the NPF Package." -optional = true - -[blocks.options.fields.cvoptions] -type = "record" -longname = "vertical conductance options" -description = "none" -optional = true - -[blocks.options.fields.cvoptions.fields.variablecv] -type = "keyword" -longname = "keyword to activate VARIABLECV option" -description = "keyword to indicate that the vertical conductance will be calculated using the saturated thickness and properties of the overlying cell and the thickness and properties of the underlying cell. If the DEWATERED keyword is also specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top. If these keywords are not specified, then the default condition is to calculate the vertical conductance at the start of the simulation using the initial head and the cell properties. The vertical conductance remains constant for the entire simulation." - -[blocks.options.fields.cvoptions.fields.dewatered] -type = "keyword" -longname = "keyword to activate DEWATERED option" -description = "If the DEWATERED keyword is specified, then the vertical conductance is calculated using only the saturated thickness and properties of the overlying cell if the head in the underlying cell is below its top." -optional = true - -[blocks.options.fields.perched] -type = "keyword" -longname = "keyword to activate PERCHED option" -description = "keyword to indicate that when a cell is overlying a dewatered convertible cell, the head difference used in Darcy's Law is equal to the head in the overlying cell minus the bottom elevation of the overlying cell. If not specified, then the default is to use the head difference between the two cells." -optional = true - -[blocks.options.fields.rewet_record] -type = "record" -optional = true - -[blocks.options.fields.rewet_record.fields.rewet] -type = "keyword" -longname = "keyword to activate rewetting" -description = "activates model rewetting. Rewetting is off by default." - -[blocks.options.fields.rewet_record.fields.wetfct] -type = "double" -longname = "wetting factor to use for rewetting" -description = "is a keyword and factor that is included in the calculation of the head that is initially established at a cell when that cell is converted from dry to wet." - -[blocks.options.fields.rewet_record.fields.iwetit] -type = "integer" -longname = "interval to use for rewetting" -description = "is a keyword and iteration interval for attempting to wet cells. Wetting is attempted every IWETIT iteration. This applies to outer iterations and not inner iterations. If IWETIT is specified as zero or less, then the value is changed to 1." - -[blocks.options.fields.rewet_record.fields.ihdwet] -type = "integer" -longname = "flag to determine wetting equation" -description = "is a keyword and integer flag that determines which equation is used to define the initial head at cells that become wet. If IHDWET is 0, h = BOT + WETFCT (hm - BOT). If IHDWET is not 0, h = BOT + WETFCT (THRESH)." - -[blocks.options.fields.xt3doptions] -type = "record" -longname = "keyword to activate XT3D" -description = "none" -optional = true - -[blocks.options.fields.xt3doptions.fields.xt3d] -type = "keyword" -longname = "keyword to activate XT3D" -description = "keyword indicating that the XT3D formulation will be used. If the RHS keyword is also included, then the XT3D additional terms will be added to the right-hand side. If the RHS keyword is excluded, then the XT3D terms will be put into the coefficient matrix. Use of XT3D will substantially increase the computational effort, but will result in improved accuracy for anisotropic conductivity fields and for unstructured grids in which the CVFD requirement is violated. XT3D requires additional information about the shapes of grid cells. If XT3D is active and the DISU Package is used, then the user will need to provide in the DISU Package the angldegx array in the CONNECTIONDATA block and the VERTICES and CELL2D blocks." - -[blocks.options.fields.xt3doptions.fields.rhs] -type = "keyword" -longname = "keyword to XT3D on right hand side" -description = "If the RHS keyword is also included, then the XT3D additional terms will be added to the right-hand side. If the RHS keyword is excluded, then the XT3D terms will be put into the coefficient matrix." -optional = true - -[blocks.options.fields.highest_cell_saturation] -type = "keyword" -longname = "keyword to activate HIGHEST_CELL_SATURATION option" -description = "keyword indicating that the maximum cell bottom will be used to calculate the saturation used to calculate the horizontal conductance between cells. This option is intended to prevent flow from leaving a dry cell and is based on~cite{painter2008robust}. This option is only applied when the Newton-Raphson formulation is used, A warning will be issued if this option is specified and the Newton-Raphson formulation is not specified in the GWF name file. This option, in combination with the AMT-HMK ALTERNATIVE_CELL_AVERAGING option, can be used to calculate the same horizontal conductance as MODFLOW-USG when upstream weighting is used (LAYCON=4)." -optional = true - -[blocks.options.fields.save_specific_discharge] -type = "keyword" -longname = "keyword to save specific discharge" -description = "keyword to indicate that x, y, and z components of specific discharge will be calculated at cell centers and written to the budget file, which is specified with 'BUDGET SAVE FILE' in Output Control. If this option is activated, then additional information may be required in the discretization packages and the GWF Exchange package (if GWF models are coupled). Specifically, ANGLDEGX must be specified in the CONNECTIONDATA block of the DISU Package; ANGLDEGX must also be specified for the GWF Exchange as an auxiliary variable." -optional = true - -[blocks.options.fields.save_saturation] -type = "keyword" -longname = "keyword to save saturation" -description = "keyword to indicate that cell saturation will be written to the budget file, which is specified with 'BUDGET SAVE FILE' in Output Control. Saturation will be saved to the budget file as an auxiliary variable saved with the DATA-SAT text label. Saturation is a cell variable that ranges from zero to one and can be used by post processing programs to determine how much of a cell volume is saturated. If ICELLTYPE is 0, then saturation is always one." -optional = true - -[blocks.options.fields.k22overk] -type = "keyword" -longname = "keyword to indicate that specified K22 is a ratio" -description = "keyword to indicate that specified K22 is a ratio of K22 divided by K. If this option is specified, then the K22 array entered in the NPF Package will be multiplied by K after being read." -optional = true - -[blocks.options.fields.k33overk] -type = "keyword" -longname = "keyword to indicate that specified K33 is a ratio" -description = "keyword to indicate that specified K33 is a ratio of K33 divided by K. If this option is specified, then the K33 array entered in the NPF Package will be multiplied by K after being read." -optional = true - -[blocks.options.fields.tvk_filerecord] -type = "record" -optional = true - -[blocks.options.fields.tvk_filerecord.fields.tvk6] -type = "keyword" -longname = "tvk keyword" -description = "keyword to specify that record corresponds to a time-varying hydraulic conductivity (TVK) file. The behavior of TVK and a description of the input file is provided separately." - -[blocks.options.fields.tvk_filerecord.fields.tvk6_filename] -type = "file" -longname = "file name of TVK information" -description = "defines a time-varying hydraulic conductivity (TVK) input file. Records in the TVK file can be used to change hydraulic conductivity properties at specified times or stress periods." -tagged = false -direction = "in" -component = "utl-tvk" - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.options.fields.dev_no_newton] -type = "keyword" -longname = "turn off Newton for unconfined cells" -description = "turn off Newton for unconfined cells" -optional = true -developmode = true - -[blocks.options.fields.dev_omega] -type = "double" -longname = "set saturation omega value" -description = "set saturation omega value" -optional = true -developmode = true - -[blocks.griddata.fields.icelltype] -type = "array" -longname = "confined or convertible indicator" -description = "flag for each cell that specifies how saturated thickness is treated. 0 means saturated thickness is held constant; $>$0 means saturated thickness varies with computed head when head is below the cell top; $<$0 means saturated thickness varies with computed head unless the THICKSTRT option is in effect. When THICKSTRT is in effect, a negative value for ICELLTYPE indicates that the saturated thickness value used in conductance calculations in the NPF Package will be computed as STRT-BOT and held constant. If the THICKSTRT option is not in effect, then negative values provided by the user for ICELLTYPE are automatically reassigned by the program to a value of one." -optional = true -default = 0 -netcdf = true -dtype = "integer" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.k] -type = "array" -longname = "hydraulic conductivity (L/T)" -description = "is the hydraulic conductivity. For the common case in which the user would like to specify the horizontal hydraulic conductivity and the vertical hydraulic conductivity, then K should be assigned as the horizontal hydraulic conductivity, K33 should be assigned as the vertical hydraulic conductivity, and K22 and the three rotation angles should not be specified. When more sophisticated anisotropy is required, then K corresponds to the K11 hydraulic conductivity axis. All included cells (IDOMAIN $>$ 0) must have a K value greater than zero." -optional = true -default = 1.0 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.k22] -type = "array" -longname = "hydraulic conductivity of second ellipsoid axis" -description = "is the hydraulic conductivity of the second ellipsoid axis (or the ratio of K22/K if the K22OVERK option is specified); for an unrotated case this is the hydraulic conductivity in the y direction. If K22 is not included in the GRIDDATA block, then K22 is set equal to K. For a regular MODFLOW grid (DIS Package is used) in which no rotation angles are specified, K22 is the hydraulic conductivity along columns in the y direction. For an unstructured DISU grid, the user must assign principal x and y axes and provide the angle for each cell face relative to the assigned x direction. All included cells (IDOMAIN $>$ 0) must have a K22 value greater than zero." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.k33] -type = "array" -longname = "hydraulic conductivity of third ellipsoid axis (L/T)" -description = "is the hydraulic conductivity of the third ellipsoid axis (or the ratio of K33/K if the K33OVERK option is specified); for an unrotated case, this is the vertical hydraulic conductivity. When anisotropy is applied, K33 corresponds to the K33 tensor component. All included cells (IDOMAIN $>$ 0) must have a K33 value greater than zero." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.angle1] -type = "array" -longname = "first anisotropy rotation angle (degrees)" -description = "is a rotation angle of the hydraulic conductivity tensor in degrees. The angle represents the first of three sequential rotations of the hydraulic conductivity ellipsoid. With the K11, K22, and K33 axes of the ellipsoid initially aligned with the x, y, and z coordinate axes, respectively, ANGLE1 rotates the ellipsoid about its K33 axis (within the x - y plane). A positive value represents counter-clockwise rotation when viewed from any point on the positive K33 axis, looking toward the center of the ellipsoid. A value of zero indicates that the K11 axis lies within the x - z plane. If ANGLE1 is not specified, default values of zero are assigned to ANGLE1, ANGLE2, and ANGLE3, in which case the K11, K22, and K33 axes are aligned with the x, y, and z axes, respectively." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.angle2] -type = "array" -longname = "second anisotropy rotation angle (degrees)" -description = "is a rotation angle of the hydraulic conductivity tensor in degrees. The angle represents the second of three sequential rotations of the hydraulic conductivity ellipsoid. Following the rotation by ANGLE1 described above, ANGLE2 rotates the ellipsoid about its K22 axis (out of the x - y plane). An array can be specified for ANGLE2 only if ANGLE1 is also specified. A positive value of ANGLE2 represents clockwise rotation when viewed from any point on the positive K22 axis, looking toward the center of the ellipsoid. A value of zero indicates that the K11 axis lies within the x - y plane. If ANGLE2 is not specified, default values of zero are assigned to ANGLE2 and ANGLE3; connections that are not user-designated as vertical are assumed to be strictly horizontal (that is, to have no z component to their orientation); and connection lengths are based on horizontal distances." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.angle3] -type = "array" -longname = "third anisotropy rotation angle (degrees)" -description = "is a rotation angle of the hydraulic conductivity tensor in degrees. The angle represents the third of three sequential rotations of the hydraulic conductivity ellipsoid. Following the rotations by ANGLE1 and ANGLE2 described above, ANGLE3 rotates the ellipsoid about its K11 axis. An array can be specified for ANGLE3 only if ANGLE1 and ANGLE2 are also specified. An array must be specified for ANGLE3 if ANGLE2 is specified. A positive value of ANGLE3 represents clockwise rotation when viewed from any point on the positive K11 axis, looking toward the center of the ellipsoid. A value of zero indicates that the K22 axis lies within the x - y plane." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.wetdry] -type = "array" -longname = "wetdry threshold and factor" -description = "is a combination of the wetting threshold and a flag to indicate which neighboring cells can cause a cell to become wet. If WETDRY $<$ 0, only a cell below a dry cell can cause the cell to become wet. If WETDRY $>$ 0, the cell below a dry cell and horizontally adjacent cells can cause a cell to become wet. If WETDRY is 0, the cell cannot be wetted. The absolute value of WETDRY is the wetting threshold. When the sum of BOT and the absolute value of WETDRY at a dry cell is equaled or exceeded by the head at an adjacent cell, the cell is wetted. WETDRY must be specified if 'REWET' is specified in the OPTIONS block. If 'REWET' is not specified in the options block, then WETDRY can be entered, and memory will be allocated for it, even though it is not used." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.cellavg] -set_in = "ar" -source = "alternative_cell_averaging" -type = "string" - -[memory.ithickstrt] -set_in = "ar" -source = "thickstrt" -type = "integer" - -[memory.ivarcv] -set_in = "ar" -source = "variablecv" -type = "integer" - -[memory.idewatcv] -set_in = "ar" -source = "dewatered" -type = "integer" - -[memory.iperched] -set_in = "ar" -source = "perched" -type = "integer" - -[memory.irewet] -set_in = "ar" -source = "rewet" -type = "integer" - -[memory.ixt3d] -set_in = "ar" -source = "xt3d" -type = "integer" - -[memory.ixt3drhs] -set_in = "ar" -source = "rhs" -type = "integer" - -[memory.ihighcellsat] -set_in = "ar" -source = "highest_cell_saturation" -type = "integer" - -[memory.isavspdis] -set_in = "ar" -source = "save_specific_discharge" -type = "integer" - -[memory.isavsat] -set_in = "ar" -source = "save_saturation" -type = "integer" - -[memory.ik22overk] -set_in = "ar" -source = "k22overk" -type = "integer" - -[memory.ik33overk] -set_in = "ar" -source = "k33overk" -type = "integer" - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.inewton] -set_in = "ar" -source = "dev_no_newton" -type = "integer" - -[memory.satomega] -set_in = "ar" -source = "dev_omega" -type = "double" - -[memory.icelltype] -type = "array" -set_in = "ar" -source = "icelltype" -dtype = "integer" -shape = [ - "nodes", -] - -[memory.k22] -type = "array" -set_in = "ar" -source = "k22" -dtype = "double" -shape = [ - "nodes", -] - -[memory.k33] -type = "array" -set_in = "ar" -source = "k33" -dtype = "double" -shape = [ - "nodes", -] - -[memory.angle1] -type = "array" -set_in = "ar" -source = "angle1" -dtype = "double" -shape = [ - "nodes", -] - -[memory.angle2] -type = "array" -set_in = "ar" -source = "angle2" -dtype = "double" -shape = [ - "nodes", -] - -[memory.angle3] -type = "array" -set_in = "ar" -source = "angle3" -dtype = "double" -shape = [ - "nodes", -] - -[memory.wetdry] -type = "array" -set_in = "ar" -source = "wetdry" -dtype = "double" -shape = [ - "nodes", -] - -[memory.k11] -type = "array" -source = "k" -description = "Hydraulic conductivity along the major (K11) axis. Loaded from the K griddata field. Used directly when XT3D is active; otherwise feeds into CONDSAT. Recomputed each time step when TVK is active." -dtype = "double" -set_in = [ - "ar", - "ad", -] -shape = [ - "nodes", -] - -[memory.condsat] -type = "array" -description = "Saturated intercell conductance. Computed once during AR from hydraulic conductivity and cell geometry. Recomputed each time step when TVK or VSC is active. Inoperative under XT3D." -dtype = "double" -set_in = [ - "ar", - "ad", -] -source = [ - "k11", - "k22", - "k33", -] -shape = [ - "njas", -] - -[memory.sat] -type = "array" -readonly = true -set_in = "fc" -description = "Cell saturation (0-1). Recomputed each solver iteration." -dtype = "double" -shape = [ - "nodes", -] diff --git a/flopy4/mf6/dfns/gwf-oc.toml b/flopy4/mf6/dfns/gwf-oc.toml deleted file mode 100644 index bfe8fbc4e..000000000 --- a/flopy4/mf6/dfns/gwf-oc.toml +++ /dev/null @@ -1,207 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-oc" -parent = "gwf-nam" -ftype = "OC6" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the output file to write budget information. Data are written to this file only for time steps in which SAVE BUDGET is specified in a PERIOD block. If SAVE BUDGET is specified in a PERIOD block and this file is not specified, MODFLOW 6 will terminate with an error." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. If specified, a budget summary record will be written to this file for every time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.head_filerecord] -type = "record" -optional = true - -[blocks.options.fields.head_filerecord.fields.head] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to head." - -[blocks.options.fields.head_filerecord.fields.headfile] -type = "file" -longname = "file keyword" -description = "name of the output file to write head information." -tagged = false -direction = "out" - -[blocks.options.fields.headprintrecord] -type = "record" -optional = true - -[blocks.options.fields.headprintrecord.fields.head] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to head." - -[blocks.options.fields.headprintrecord.fields.print_format] -type = "keyword" -longname = "keyword to indicate that a print format follows" -description = "keyword to specify format for printing to the listing file." - -[blocks.options.fields.headprintrecord.fields.formatrecord] -type = "record" - -[blocks.options.fields.headprintrecord.fields.formatrecord.fields.columns] -type = "integer" -longname = "number of columns" -description = "number of columns for writing data." -optional = true - -[blocks.options.fields.headprintrecord.fields.formatrecord.fields.width] -type = "integer" -longname = "width for each number" -description = "width for writing each number." -optional = true - -[blocks.options.fields.headprintrecord.fields.formatrecord.fields.digits] -type = "integer" -longname = "number of digits" -description = "number of digits to use for writing a number." -optional = true - -[blocks.options.fields.headprintrecord.fields.formatrecord.fields.format] -type = "string" -longname = "write format" -description = "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC." -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" -optional = true - -[blocks.period.fields.stress_period_data.item] -name = "output_record" -type = "union" - -[blocks.period.fields.stress_period_data.item.arms.saverecord] -type = "record" -optional = true - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.save] -type = "keyword" -longname = "keyword to save" -description = "keyword to indicate that information will be saved this stress period." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.rtype] -type = "string" -longname = "record type" -description = "type of information to save or print. Can be BUDGET or HEAD." -tagged = false -valid = [ - "HEAD", - "BUDGET", -] - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting] -type = "union" -description = "specifies the steps for which the data will be saved." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.all] -type = "keyword" -description = "keyword to indicate save for all time steps in period." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.first] -type = "keyword" -description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.last] -type = "keyword" -description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.frequency] -type = "integer" -description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.steps] -type = "array" -description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." -dtype = "integer" -shape = [ - "<=nstp", -] - -[blocks.period.fields.stress_period_data.item.arms.printrecord] -type = "record" -optional = true - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.print] -type = "keyword" -longname = "keyword to save" -description = "keyword to indicate that information will be printed this stress period." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.rtype] -type = "string" -longname = "record type" -description = "type of information to save or print. Can be BUDGET or HEAD." -tagged = false -valid = [ - "HEAD", - "BUDGET", -] - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting] -type = "union" -description = "specifies the steps for which the data will be saved." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.all] -type = "keyword" -description = "keyword to indicate save for all time steps in period." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.first] -type = "keyword" -description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.last] -type = "keyword" -description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.frequency] -type = "integer" -description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.steps] -type = "array" -description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." -dtype = "integer" -shape = [ - "<=nstp", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true diff --git a/flopy4/mf6/dfns/gwf-rch.toml b/flopy4/mf6/dfns/gwf-rch.toml deleted file mode 100644 index 9883ec054..000000000 --- a/flopy4/mf6/dfns/gwf-rch.toml +++ /dev/null @@ -1,301 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-rch" -parent = "gwf-nam" -ftype = "RCH6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.fixed_cell] -type = "keyword" -longname = "if cell is dry do not apply recharge to underlying cell" -description = "indicates that recharge will not be reassigned to a cell underlying the cell specified in the list if the specified cell is inactive." -optional = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of recharge." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of recharge cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of recharge information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print recharge rates to listing file" -description = "keyword to indicate that the list of recharge flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save recharge to budget file" -description = "keyword to indicate that recharge flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the RCH package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RCH package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of recharge cells" -description = "integer value specifying the maximum number of recharge cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.recharge] -type = "double" -longname = "recharge rate" -description = "is the recharge flux rate ($LT^{-1}$). This rate is multiplied inside the program by the surface area of the cell to calculate the volumetric recharge rate. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each recharge. The values of auxiliary variables must be present for each recharge. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "recharge name" -description = "name of the recharge cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: recharge." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "RCH" -output = true -obs_type = "RCH" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.rch] -type = "union" - -[observations.rch.arms.cellid] -type = "cellid" -tagged = false - -[observations.rch.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwf-rcha.toml b/flopy4/mf6/dfns/gwf-rcha.toml deleted file mode 100644 index 83fe4d7a1..000000000 --- a/flopy4/mf6/dfns/gwf-rcha.toml +++ /dev/null @@ -1,314 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-rcha" -parent = "gwf-nam" -ftype = "RCH6" -multi = true -subtype = "stress" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.readasarrays] -type = "keyword" -longname = "use array-based input" -description = "indicates that array-based input will be used for the Recharge Package. This keyword must be specified to use array-based input. When READASARRAYS is specified, values must be provided for every cell within a model layer, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results." -default = true - -[blocks.options.fields.fixed_cell] -type = "keyword" -longname = "if cell is dry do not apply recharge to underlying cell" -description = "indicates that recharge will not be reassigned to a cell underlying the cell specified in the list if the specified cell is inactive." -optional = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of recharge." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of recharge information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print recharge rates to listing file" -description = "keyword to indicate that the list of recharge flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save RCHA flows to budget file" -description = "keyword to indicate that recharge flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.tas_filerecord] -type = "list" -optional = true - -[blocks.options.fields.tas_filerecord.item] -name = "tas_filerecord" -type = "record" - -[blocks.options.fields.tas_filerecord.item.fields.tas6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-array-series file." - -[blocks.options.fields.tas_filerecord.item.fields.tas6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-array series capability." -tagged = false -direction = "in" -component = "utl-tas" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the RCH package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RCH package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.period.fields.irch] -type = "array" -longname = "layer number for recharge" -description = "IRCH is the layer number that defines the layer in each vertical column where recharge is applied. If IRCH is omitted, recharge by default is applied to cells in layer 1. IRCH can only be used if READASARRAYS is specified in the OPTIONS block. If IRCH is specified, it must be specified as the first variable in the PERIOD block or MODFLOW will terminate with an error." -optional = true -netcdf = true -dtype = "integer" -index = true -shape = [ - "ncpl", -] - -[blocks.period.fields.recharge] -type = "array" -longname = "recharge rate" -description = "is the recharge flux rate ($LT^{-1}$). This rate is multiplied inside the program by the surface area of the cell to calculate the volumetric recharge rate. The recharge array may be defined by a time-array series (see the 'Using Time-Array Series in a Package' section)." -default = 0.001 -netcdf = true -dtype = "double" -time_series = true -shape = [ - "ncpl", -] - -[blocks.period.fields.aux] -type = "list" -longname = "recharge auxiliary variable iaux" -description = "is an array of values for auxiliary variable aux(iaux), where iaux is a value from 1 to naux, and aux(iaux) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then it will retain its value from the most recently specified period block. If an auxiliary variable array has never been specified, its value is zero. If the value specified here for the auxiliary variable is the same as auxmultname, then the recharge array will be multiplied by this array." -optional = true -shape = [ - "<=auxiliary", -] - -[blocks.period.fields.aux.item] -name = "aux" -type = "record" - -[blocks.period.fields.aux.item.fields.auxname] -type = "string" -longname = "auxiliary variable name" -description = "name of the auxiliary variable the following array sets; must be one of the auxiliary variables." -tagged = false -fk = "options.auxiliary" -dynamic = true - -[blocks.period.fields.aux.item.fields.aux] -type = "array" -longname = "recharge auxiliary variable iaux" -netcdf = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "ncpl", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "RCHA" -output = true -obs_type = "RCH" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.rch] -type = "union" - -[observations.rch.arms.cellid] -type = "cellid" -tagged = false - -[observations.rch.arms.boundname] -type = "string" -tagged = false diff --git a/flopy4/mf6/dfns/gwf-riv.toml b/flopy4/mf6/dfns/gwf-riv.toml deleted file mode 100644 index 02fd98a9f..000000000 --- a/flopy4/mf6/dfns/gwf-riv.toml +++ /dev/null @@ -1,331 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-riv" -parent = "gwf-nam" -ftype = "RIV6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of riverbed conductance." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of river cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of river information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of river flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save RIV flows to budget file" -description = "keyword to indicate that river flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the RIV package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RIV package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.mover] -type = "keyword" -description = "keyword to indicate that this instance of the River Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." -optional = true - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of rivers" -description = "integer value specifying the maximum number of rivers cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.stage] -type = "double" -longname = "river stage" -description = "is the head in the river. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.cond] -type = "double" -longname = "river conductance" -description = "is the riverbed hydraulic conductance. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.rbot] -type = "double" -longname = "river bottom elevation" -description = "is the elevation of the bottom of the riverbed. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each river. The values of auxiliary variables must be present for each river. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "river name" -description = "name of the river cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: stage, 1: cond, 2: rbot." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "RIV" -output = true -obs_type = "RIV" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "RIV-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.riv] -type = "union" - -[observations.riv.arms.cellid] -type = "cellid" -tagged = false - -[observations.riv.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" - -[keys.mover_provider] -path = "<=maxbound" -when = "mover" diff --git a/flopy4/mf6/dfns/gwf-rivg.toml b/flopy4/mf6/dfns/gwf-rivg.toml deleted file mode 100644 index bb3945dcd..000000000 --- a/flopy4/mf6/dfns/gwf-rivg.toml +++ /dev/null @@ -1,333 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-rivg" -parent = "gwf-nam" -ftype = "RIV6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.readarraygrid] -type = "keyword" -longname = "use array-based grid input" -description = "indicates that array-based grid input will be used for the river package. This keyword must be specified to use array-based grid input. When READARRAYGRID is specified, values must be provided for every cell within a model grid, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results. No data cells should contain the value DNODATA (3.0E+30)." -default = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of riverbed conductance." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of river information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of river flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save RIV flows to budget file" -description = "keyword to indicate that river flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the RIV package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the RIV package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.mover] -type = "keyword" -description = "keyword to indicate that this instance of the River Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of river cells in any stress period" -description = "integer value specifying the maximum number of rivers cells that will be specified for use during any stress period." -optional = true - -[blocks.period.fields.stage] -type = "array" -longname = "river stage" -description = "is the head in the river." -default = 3e+30 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.period.fields.cond] -type = "array" -longname = "river conductance" -description = "is the riverbed hydraulic conductance." -default = 3e+30 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.period.fields.rbot] -type = "array" -longname = "river bottom elevation" -description = "is the elevation of the bottom of the riverbed." -default = 3e+30 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.period.fields.aux] -type = "list" -longname = "river auxiliary variable iaux" -description = "is an array of values for auxiliary variable aux(iaux), where iaux is a value from 1 to naux, and aux(iaux) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then it will retain its value from the most recently specified period block. If an auxiliary variable array has never been specified, its value is zero. If the value specified here for the auxiliary variable is the same as auxmultname, then the conductance array will be multiplied by this array." -optional = true -shape = [ - "<=auxiliary", -] - -[blocks.period.fields.aux.item] -name = "aux" -type = "record" - -[blocks.period.fields.aux.item.fields.auxname] -type = "string" -longname = "auxiliary variable name" -description = "name of the auxiliary variable the following array sets; must be one of the auxiliary variables." -tagged = false -fk = "options.auxiliary" -dynamic = true - -[blocks.period.fields.aux.item.fields.aux] -type = "array" -longname = "river auxiliary variable iaux" -netcdf = true -tagged = false -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "RIV" -output = true -obs_type = "RIV" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "RIV-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.riv] -type = "union" - -[observations.riv.arms.cellid] -type = "cellid" -tagged = false - -[observations.riv.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" - -[keys.mover_provider] -path = "<=maxbound" -when = "mover" diff --git a/flopy4/mf6/dfns/gwf-sfr.toml b/flopy4/mf6/dfns/gwf-sfr.toml deleted file mode 100644 index 009fea4c9..000000000 --- a/flopy4/mf6/dfns/gwf-sfr.toml +++ /dev/null @@ -1,1070 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-sfr" -parent = "gwf-nam" -ftype = "SFR6" -multi = true -subtype = "advanced" - -[dims.nreaches] -value = "nreaches" - -[dims.auxiliary] -value = "len(auxiliary)" - -[runtime_dims.maxbound] -set_in = "ar" - -[blocks.options.fields.storage] -type = "keyword" -longname = "activate reach storage" -description = "keyword that activates storage contributions to the stream-flow routing package continuity equation." -optional = true - -[blocks.options.fields.ats_courant] -type = "double" -longname = "target Courant number for adaptive time stepping" -description = "real number value that defines the target Courant number submitted by the SFR Package to the adaptive time stepping (ATS) package. If ATS_COURANT is specified and the ATS Package is active, the SFR Package will compute the time step that achieves the target Courant number for the most constraining reach (the reach with the highest wave celerity-to-length ratio) and submit that time step to the ATS Package. The STORAGE option must be active when ATS_COURANT is specified. ATS_COURANT must be greater than zero. A recommended baseline value is 1.0, which targets unit Courant number; values between 0.5 and 2.0 are generally acceptable for kinematic wave routing." -optional = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of stream reach cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of stream reach information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_stage] -type = "keyword" -longname = "print calculated stages to listing file" -description = "keyword to indicate that the list of stream reach {#2} will be printed to the listing file for every stress period in which 'HEAD PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of stream reach flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save stream reach flows to budget file" -description = "keyword to indicate that stream reach flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.stage_filerecord] -type = "record" -optional = true - -[blocks.options.fields.stage_filerecord.fields.stage] -type = "keyword" -longname = "stage keyword" -description = "keyword to specify that record corresponds to stage." - -[blocks.options.fields.stage_filerecord.fields.stagefile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write stage information." -tagged = false -direction = "out" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.package_convergence_filerecord] -type = "record" -optional = true - -[blocks.options.fields.package_convergence_filerecord.fields.package_convergence] -type = "keyword" -longname = "package_convergence keyword" -description = "keyword to specify that record corresponds to the package convergence comma spaced values file." - -[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] -type = "file" -longname = "file keyword" -description = "name of the comma spaced values output file to write package convergence information." -tagged = false -direction = "out" - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the SFR package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFR package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.mover] -type = "keyword" -description = "keyword to indicate that this instance of the SFR Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." -optional = true - -[blocks.options.fields.maximum_picard_iterations] -type = "integer" -longname = "SFR picard iterations" -description = "integer value that defines the maximum number of Streamflow Routing picard iterations allowed when solving for reach stages and flows as part of the GWF formulate step. Picard iterations are used to minimize differences in SFR package results between subsequent GWF picard (non-linear) iterations as a result of non-optimal reach numbering. If reaches are numbered in order, from upstream to downstream, MAXIMUM_PICARD_ITERATIONS can be set to 1 to reduce model run time. By default, MAXIMUM_PICARD_ITERATIONS is equal to 100." -optional = true - -[blocks.options.fields.maximum_iterations] -type = "integer" -longname = "SFR Newton-Raphson iterations" -description = "integer value that defines the maximum number of Streamflow Routing Newton-Raphson iterations allowed for a reach. By default, MAXIMUM_ITERATIONS is equal to 100. MAXIMUM_ITERATIONS would only need to be increased from the default value if one or more reach in a simulation has a large water budget error." -optional = true - -[blocks.options.fields.maximum_depth_change] -type = "double" -longname = "depth closure tolerance" -description = "real value that defines the depth closure tolerance. By default, MAXIMUM_DEPTH_CHANGE is equal to $1 times 10^{-5}$. The MAXIMUM_STAGE_CHANGE would only need to be increased or decreased from the default value if the water budget error for one or more reach is too small or too large, respectively." -optional = true - -[blocks.options.fields.unit_conversion] -type = "double" -longname = "conversion factor" -description = "real value that is used to convert user-specified Manning's roughness coefficients from seconds per meters$^{1/3}$ to model length and time units. A constant of 1.486 is used for flow units of cubic feet per second, and a constant of 1.0 is used for units of cubic meters per second. The constant must be multiplied by 86,400 when using time units of days in the simulation." -optional = true -deprecated = "6.4.2" - -[blocks.options.fields.length_conversion] -type = "double" -longname = "length conversion factor" -description = "real value that is used to convert user-specified Manning's roughness coefficients from meters to model length units. LENGTH_CONVERSION should be set to 3.28081, 1.0, and 100.0 when using length units (LENGTH_UNITS) of feet, meters, or centimeters in the simulation, respectively. LENGTH_CONVERSION does not need to be specified if LENGTH_UNITS are meters." -optional = true - -[blocks.options.fields.time_conversion] -type = "double" -longname = "time conversion factor" -description = "real value that is used to convert user-specified Manning's roughness coefficients from seconds to model time units. TIME_CONVERSION should be set to 1.0, 60.0, 3,600.0, 86,400.0, and 31,557,600.0 when using time units (TIME_UNITS) of seconds, minutes, hours, days, or years in the simulation, respectively. TIME_CONVERSION does not need to be specified if TIME_UNITS are seconds." -optional = true - -[blocks.options.fields.dev_storage_weight] -type = "double" -longname = "reach storage time weighting" -description = "real number value that defines the time weighting factor used to calculate the change in channel storage. DEV_STORAGE_WEIGHT must have a value between 0.5 and 1. The default DEV_STORAGE_WEIGHT value is 1, which is fully implicit and is recommended for all practical applications." -optional = true -developmode = true - -[blocks.options.fields.dev_no_check] -type = "keyword" -longname = "do not check reach geometry and parameters" -description = "keyword that deactivates the checks of reach geometry relative to the model grid and of reach parameters for reasonable values. This development option is not supported." -optional = true -developmode = true - -[blocks.options.fields.dev_no_final_check] -type = "keyword" -longname = "do not perform final convergence check" -description = "keyword that deactivates the final convergence check of the change in stream flow routing stages and flows. This development option is not supported." -optional = true -developmode = true - -[blocks.dimensions.fields.nreaches] -type = "integer" -longname = "maximum number reaches" -description = "integer value specifying the number of stream reaches. There must be NREACHES entries in the PACKAGEDATA block." - -[blocks.packagedata.fields.packagedata] -type = "list" -shape = [ - "nreaches", -] - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.ifno] -type = "integer" -longname = "reach number for this entry" -description = "integer value that defines the feature (reach) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NREACHES. Reach information must be specified for every reach or the program will terminate with an error. The program will also terminate with an error if information for a reach is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. For reaches that are not connected to an underlying GWF cell, a zero should be specified for each grid dimension. For example, for a DIS grid a CELLID of 0 0 0 should be specified. Reach-aquifer flow is not calculated for unconnected reaches. The keyword NONE can be still be specified to identify unconnected reaches for backward compatibility with previous versions of MODFLOW 6 but eventually NONE will be deprecated and will cause MODFLOW 6 to terminate with an error." -tagged = false -allow_zero = true - -[blocks.packagedata.fields.packagedata.item.fields.rlen] -type = "double" -longname = "reach length" -description = "real value that defines the reach length. RLEN must be greater than zero." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.rwid] -type = "double" -longname = "reach width" -description = "real value that defines the reach width. RWID must be greater than zero." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.rgrd] -type = "double" -longname = "stream gradient" -description = "real value that defines the stream gradient (slope) across the reach. RGRD must be greater than zero." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.rtp] -type = "double" -longname = "reach streambed top elevation" -description = "real value that defines the top elevation of the streambed of a reach." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.rbth] -type = "double" -longname = "streambed thickness" -description = "real value that defines the thickness of the reach streambed. RBTH can be any value if the reach is not connected to an underlying GWF cell. Otherwise, RBTH must be greater than zero." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.rhk] -type = "double" -longname = "reach bed hydraulic conductivity" -description = "real or character value that defines the hydraulic conductivity of the reach streambed. RHK can be any positive value if the reach is not connected to an underlying GWF cell. Otherwise, RHK must be greater than zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.packagedata.fields.packagedata.item.fields.man] -type = "double" -longname = "Manning's roughness coefficient" -description = "real or character value that defines the Manning's roughness coefficient for the reach. MAN must be greater than zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.packagedata.fields.packagedata.item.fields.ncon] -type = "integer" -longname = "number of connected reaches" -description = "integer value that defines the number of reaches connected to the reach. If a value of zero is specified for NCON an entry for IFNO is still required in the subsequent CONNECTIONDATA block." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.ustrf] -type = "double" -longname = "fraction of upstream flow" -description = "real value that defines the fraction of upstream flow from each upstream reach that is applied as upstream inflow to the reach. The sum of all USTRF values for all reaches connected to the same upstream reach must be equal to one and USTRF must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.packagedata.fields.packagedata.item.fields.ndv] -type = "integer" -longname = "number of downstream reaches" -description = "integer value that defines the number of downstream diversions for the reach." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each stream reach. The values of auxiliary variables must be present for each stream reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.packagedata.fields.packagedata.item.fields.boundname] -type = "string" -longname = "well name" -description = "name of the stream reach cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.crosssections.fields.crosssections] -type = "list" -optional = true - -[blocks.crosssections.fields.crosssections.item] -name = "crosssections" -type = "record" - -[blocks.crosssections.fields.crosssections.item.fields.ifno] -type = "integer" -longname = "reach number for this entry" -description = "integer value that defines the feature (reach) number associated with the specified cross-section table file on the line. IFNO must be greater than zero and less than or equal to NREACHES. The program will also terminate with an error if table information for a reach is specified more than once." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.crosssections.fields.crosssections.item.fields.tab6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a cross-section table file." - -[blocks.crosssections.fields.crosssections.item.fields.tab6_filename] -type = "file" -longname = "table file name" -description = "character string that defines the path and filename for the file containing cross-section table data for the reach. The TAB6_FILENAME file includes the number of entries in the file and the station elevation data in terms of the fractional width and the reach depth. Instructions for creating the TAB6_FILENAME input file are provided in SFR Reach Cross-Section Table Input File section." -tagged = false -direction = "in" -component = "utl-sfrtab" - -[blocks.connectiondata.fields.connectiondata] -type = "list" -shape = [ - "nreaches", -] - -[blocks.connectiondata.fields.connectiondata.item] -name = "connectiondata" -type = "record" - -[blocks.connectiondata.fields.connectiondata.item.fields.ifno] -type = "integer" -longname = "reach number for this entry" -description = "integer value that defines the feature (reach) number associated with the specified CONNECTIONDATA data on the line. IFNO must be greater than zero and less than or equal to NREACHES. Reach connection information must be specified for every reach or the program will terminate with an error. The program will also terminate with an error if connection information for a reach is specified more than once." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.connectiondata.fields.connectiondata.item.fields.ic] -type = "array" -longname = "connected reach numbers" -description = "integer value that defines the reach number of the reach connected to the current reach and whether it is connected to the upstream or downstream end of the reach. Negative IC numbers indicate connected reaches are connected to the downstream end of the current reach. Positive IC numbers indicate connected reaches are connected to the upstream end of the current reach. The absolute value of IC must be greater than zero and less than or equal to NREACHES. IC should not be specified when NCON is zero but must be specified otherwise." -optional = true -tagged = false -dtype = "integer" -index = "signed" -fk = "packagedata.ifno" -shape = [ - "packagedata.ncon(ifno)", -] - -[blocks.diversions.fields.diversions] -type = "list" -optional = true - -[blocks.diversions.fields.diversions.item] -name = "diversions" -type = "record" - -[blocks.diversions.fields.diversions.item.fields.ifno] -type = "integer" -longname = "reach number for this entry" -description = "integer value that defines the feature (reach) number associated with the specified DIVERSIONS data on the line. IFNO must be greater than zero and less than or equal to NREACHES. Reach diversion information must be specified for every reach with a NDV value greater than 0 or the program will terminate with an error. The program will also terminate with an error if diversion information for a given reach diversion is specified more than once." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.diversions.fields.diversions.item.fields.idv] -type = "integer" -longname = "downstream diversion number" -description = "integer value that defines the downstream diversion number for the diversion for reach IFNO. IDV must be greater than zero and less than or equal to NDV for reach IFNO." -tagged = false -index = true - -[blocks.diversions.fields.diversions.item.fields.idv.pk] -scope = "ifno" - -[blocks.diversions.fields.diversions.item.fields.iconr] -type = "integer" -longname = "downstream reach number for diversion" -description = "integer value that defines the downstream reach that will receive the diverted water. IDV must be greater than zero and less than or equal to NREACHES. Furthermore, reach ICONR must be a downstream connection for reach IFNO." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.diversions.fields.diversions.item.fields.cprior] -type = "string" -longname = "iprior code" -description = "character string value that defines the the prioritization system for the diversion, such as when insufficient water is available to meet all diversion stipulations, and is used in conjunction with the value of FLOW value specified in the STRESS_PERIOD_DATA section. Available diversion options include: (1) CPRIOR = `FRACTION', then the amount of the diversion is computed as a fraction of the streamflow leaving reach IFNO ($Q_{DS}$); in this case, 0.0 $le$ DIVFLOW $le$ 1.0. (2) CPRIOR = `EXCESS', a diversion is made only if $Q_{DS}$ for reach IFNO exceeds the value of DIVFLOW. If this occurs, then the quantity of water diverted is the excess flow ($Q_{DS} -$ DIVFLOW) and $Q_{DS}$ from reach IFNO is set equal to DIVFLOW. This represents a flood-control type of diversion, as described by Danskin and Hanson (2002). (3) CPRIOR = `THRESHOLD', then if $Q_{DS}$ in reach IFNO is less than the specified diversion flow DIVFLOW, no water is diverted from reach IFNO. If $Q_{DS}$ in reach IFNO is greater than or equal to DIVFLOW, DIVFLOW is diverted and $Q_{DS}$ is set to the remainder ($Q_{DS} -$ DIVFLOW)). This approach assumes that once flow in the stream is sufficiently low, diversions from the stream cease, and is the `priority' algorithm that originally was programmed into the STR1 Package (Prudic, 1989). (4) CPRIOR = `UPTO' -- if $Q_{DS}$ in reach IFNO is greater than or equal to the specified diversion flow DIVFLOW, $Q_{DS}$ is reduced by DIVFLOW. If $Q_{DS}$ in reach IFNO is less than DIVFLOW, DIVFLOW is set to $Q_{DS}$ and there will be no flow available for reaches connected to downstream end of reach IFNO." -tagged = false - -[blocks.initialstages.fields.initialstages] -type = "list" -optional = true -shape = [ - "nreaches", -] - -[blocks.initialstages.fields.initialstages.item] -name = "initialstages" -type = "record" - -[blocks.initialstages.fields.initialstages.item.fields.ifno] -type = "integer" -longname = "reach number for this entry" -description = "integer value that defines the feature (reach) number associated with the specified initial stage. Initial stage data must be specified for every reach or the program will terminate with an error. The program will also terminate with a error if IFNO is less than one or greater than NREACHES." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.initialstages.fields.initialstages.item.fields.initialstage] -type = "double" -longname = "initial reach stage" -description = "real value that defines the initial stage for the reach. The program will terminate with an error if INITIALSTAGE is less than the RTP value for reach IFNO defined in the PACKAGEDATA block. INITIALSTAGE data are used only if STORAGE is specified in the Options block and the first stress period is transient or for reaches defined to use the SIMPLE STATUS in the Period block." -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "perioddata" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.ifno] -type = "integer" -longname = "reach number for this entry" -description = "integer value that defines the feature (reach) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NREACHES." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting] -type = "union" -description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the SFRSETTING string include: STATUS, BEDK, MANNING, STAGE, INFLOW, RAINFALL, EVAPORATION, RUNOFF, DIVERSION, UPSTREAM_FRACTION, and AUXILIARY." - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.status] -type = "string" -longname = "reach status" -description = "keyword option to define stream reach status. STATUS can be ACTIVE, INACTIVE, or SIMPLE. The SIMPLE STATUS option simulates streamflow using a user-specified stage for a reach or a stage set to the top of the reach (depth = 0). In cases where the simulated leakage calculated using the specified stage exceeds the sum of inflows to the reach, the stage is set to the top of the reach and leakage is set equal to the sum of inflows. Upstream fractions should be changed using the UPSTREAM_FRACTION SFRSETTING if the status for one or more reaches is changed to ACTIVE or INACTIVE. For example, if one of two downstream connections for a reach is inactivated, the upstream fraction for the active and inactive downstream reach should be changed to 1.0 and 0.0, respectively, to ensure that the active reach receives all of the downstream outflow from the upstream reach. By default, STATUS is ACTIVE." - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.bedk] -type = "double" -longname = "reach bed hydraulic conductivity" -description = "real or character value that defines the hydraulic conductivity of the reach streambed. BEDK can be any positive value if the reach is not connected to an underlying GWF cell. Otherwise, BEDK must be greater than zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.manning] -type = "double" -longname = "reach Manning's roughness coefficient" -description = "real or character value that defines the Manning's roughness coefficient for the reach. MANNING must be greater than zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.stage] -type = "double" -longname = "reach stage" -description = "real or character value that defines the stage for the reach. The specified STAGE is only applied if the reach uses the simple routing option. If STAGE is not specified for reaches that use the simple routing option, the specified stage is set to the top of the reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.inflow] -type = "double" -longname = "inflow rate" -description = "real or character value that defines the volumetric inflow rate for the streamflow routing reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, inflow rates are zero for each reach." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.rainfall] -type = "double" -longname = "rainfall rate" -description = "real or character value that defines the volumetric rate per unit area of water added by precipitation directly on the streamflow routing reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, rainfall rates are zero for each reach." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.evaporation] -type = "double" -longname = "evaporation rate" -description = "real or character value that defines the volumetric rate per unit area of water subtracted by evaporation from the streamflow routing reach. A positive evaporation rate should be provided. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. If the volumetric evaporation rate for a reach exceeds the sources of water to the reach (upstream and specified inflows, rainfall, and runoff but excluding groundwater leakage into the reach) the volumetric evaporation rate is limited to the sources of water to the reach. By default, evaporation rates are zero for each reach." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.runoff] -type = "double" -longname = "runoff rate" -description = "real or character value that defines the volumetric rate of diffuse overland runoff that enters the streamflow routing reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. If the volumetric runoff rate for a reach is negative and exceeds inflows to the reach (upstream and specified inflows, and rainfall but excluding groundwater leakage into the reach) the volumetric runoff rate is limited to inflows to the reach and the volumetric evaporation rate for the reach is set to zero. By default, runoff rates are zero for each reach." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.diversionrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.diversionrecord.fields.diversion] -type = "keyword" -longname = "diversion keyword" -description = "keyword to indicate diversion record." - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.diversionrecord.fields.idv] -type = "integer" -longname = "diversion number" -description = "an integer value specifying which diversion of reach IFNO that DIVFLOW is being specified for. Must be less or equal to ndv for the current reach (IFNO)." -tagged = false -index = true - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.diversionrecord.fields.idv.fk] -path = "diversions.idv" -scope = "ifno" - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.diversionrecord.fields.divflow] -type = "double" -longname = "volumetric diversion flow rate" -description = "real or character value that defines the volumetric diversion (DIVFLOW) rate for the streamflow routing reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.upstream_fraction] -type = "double" -longname = "fraction of upstream flow" -description = "real value that defines the fraction of upstream flow (USTRF) from each upstream reach that is applied as upstream inflow to the reach. The sum of all USTRF values for all reaches connected to the same upstream reach must be equal to one." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.cross_sectionrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.cross_sectionrecord.fields.cross_section] -type = "keyword" -longname = "cross_section keyword" -description = "keyword to specify that record corresponds to a reach cross-section." - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.cross_sectionrecord.fields.tab6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a cross-section table file." - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.cross_sectionrecord.fields.tab6_filename] -type = "file" -longname = "table file name" -description = "character string that defines the path and filename for the file containing cross-section table data for the reach. The TAB6_FILENAME file includes the number of entries in the file and the station elevation data in terms of the fractional width and the reach depth. Instructions for creating the TAB6_FILENAME input file are provided in SFR Reach Cross-Section Table Input File section." -tagged = false -direction = "in" -component = "utl-sfrtab" - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.auxiliaryrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.auxiliaryrecord.fields.auxiliary] -type = "keyword" -description = "keyword for specifying auxiliary variable." - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.auxiliaryrecord.fields.auxname] -type = "string" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.sfrsetting.arms.auxiliaryrecord.fields.auxval] -type = "double" -longname = "auxiliary variable value" -description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.options_stage] -set_in = "ar" -source = "stage" -type = "logical" - -[memory.pkgconv] -set_in = "ar" -source = "package_convergence" -type = "logical" - -[memory.pkgconvfname] -set_in = "ar" -source = "package_convergence_filename" -type = "string" - -[memory.options_filein] -set_in = "ar" -type = "logical" - -[memory.maxsfrpicard] -set_in = "ar" -source = "maximum_picard_iterations" -type = "integer" - -[memory.maxsfrit] -set_in = "ar" -source = "maximum_iterations" -type = "integer" - -[memory.dmaxchg] -set_in = "ar" -source = "maximum_depth_change" -type = "double" - -[memory.lengthconv] -set_in = "ar" -source = "length_conversion" -type = "double" - -[memory.storage_weight] -set_in = "ar" -source = "dev_storage_weight" -type = "double" - -[memory.icheck] -set_in = "ar" -source = "dev_no_check" -type = "integer" - -[memory.iconvchk] -set_in = "ar" -source = "dev_no_final_check" -type = "integer" - -[memory.maxbound] -set_in = "ar" -source = "nreaches" -type = "integer" - -[memory.packagedata_ifno] -set_in = "ar" -source = "ifno" -type = "integer" - -[memory.crosssect_ifno] -source = "ifno" -type = "integer" - -[memory.xs_tab6] -source = "tab6" -type = "logical" - -[memory.xs_filein] -type = "logical" - -[memory.sfrtab6_filename] -source = "tab6_filename" -type = "string" - -[memory.conndata_ifno] -source = "ifno" -type = "integer" - -[memory.diversions_ifno] -source = "ifno" -type = "integer" - -[memory.diversions_idv] -source = "idv" -type = "integer" - -[memory.initstage_ifno] -source = "ifno" -type = "integer" - -[memory.upstream_frac] -set_in = "ad" -source = "upstream_fraction" -type = "double" - -[memory.period_auxiliary] -set_in = "rp" -source = "auxiliary" -type = "logical" - -[memory.length] -type = "array" -set_in = "ar" -source = "rlen" -description = "Reach length (L)." -dtype = "double" -shape = [ - "maxbound", -] - -[memory.width] -type = "array" -set_in = "ar" -source = "rwid" -description = "Reach width (L)." -dtype = "double" -shape = [ - "maxbound", -] - -[memory.slope] -type = "array" -set_in = "ar" -source = "rgrd" -description = "Reach gradient (dimensionless)." -dtype = "double" -shape = [ - "maxbound", -] - -[memory.strtop] -type = "array" -set_in = "ar" -source = "rtp" -description = "Top elevation of the reach streambed (L)." -dtype = "double" -shape = [ - "maxbound", -] - -[memory.bthick] -type = "array" -set_in = "ar" -source = "rbth" -description = "Thickness of the reach streambed (L)." -dtype = "double" -shape = [ - "maxbound", -] - -[memory.hk] -type = "array" -set_in = "ar" -source = "rhk" -description = "Hydraulic conductivity of the reach streambed (L/T)." -dtype = "double" -shape = [ - "maxbound", -] - -[memory.rough] -type = "array" -set_in = "ar" -source = "man" -description = "Manning's roughness coefficient." -dtype = "double" -shape = [ - "maxbound", -] - -[memory.nconnreach] -type = "array" -readonly = true -set_in = "ar" -source = "ncon" -description = "Number of connections for each reach." -dtype = "integer" -shape = [ - "maxbound", -] - -[memory.ustrf] -type = "array" -set_in = "ar" -source = "ustrf" -description = "Upstream fraction of flow for each reach." -dtype = "double" -shape = [ - "maxbound", -] - -[memory.ndiv] -type = "array" -readonly = true -set_in = "ar" -source = "ndv" -description = "Number of diversions for each reach." -dtype = "integer" -shape = [ - "maxbound", -] - -[observations.stage] -type = "union" - -[observations.stage.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.stage.arms.boundname] -type = "string" -tagged = false - -[observations.ext-inflow] -type = "union" - -[observations.ext-inflow.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.ext-inflow.arms.boundname] -type = "string" -tagged = false - -[observations.inflow] -type = "union" - -[observations.inflow.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.inflow.arms.boundname] -type = "string" -tagged = false - -[observations.from-mvr] -type = "union" - -[observations.from-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.from-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.rainfall] -type = "union" - -[observations.rainfall.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.rainfall.arms.boundname] -type = "string" -tagged = false - -[observations.runoff] -type = "union" - -[observations.runoff.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.runoff.arms.boundname] -type = "string" -tagged = false - -[observations.sfr] -type = "union" - -[observations.sfr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.sfr.arms.boundname] -type = "string" -tagged = false - -[observations.evaporation] -type = "union" - -[observations.evaporation.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.evaporation.arms.boundname] -type = "string" -tagged = false - -[observations.outflow] -type = "union" - -[observations.outflow.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.outflow.arms.boundname] -type = "string" -tagged = false - -[observations.ext-outflow] -type = "union" - -[observations.ext-outflow.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.ext-outflow.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.upstream-flow] -type = "union" - -[observations.upstream-flow.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.upstream-flow.arms.boundname] -type = "string" -tagged = false - -[observations.downstream-flow] -type = "union" - -[observations.downstream-flow.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.downstream-flow.arms.boundname] -type = "string" -tagged = false - -[observations.depth] -type = "union" - -[observations.depth.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.depth.arms.boundname] -type = "string" -tagged = false - -[observations.wet-perimeter] -type = "union" - -[observations.wet-perimeter.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.wet-perimeter.arms.boundname] -type = "string" -tagged = false - -[observations.wet-area] -type = "union" - -[observations.wet-area.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.wet-area.arms.boundname] -type = "string" -tagged = false - -[observations.wet-width] -type = "union" - -[observations.wet-width.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.wet-width.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "packagedata.ifno" - -[keys.mover_provider] -path = "packagedata.ifno" -when = "mover" - -[keys.mover_receiver] -path = "packagedata.ifno" -when = "mover" diff --git a/flopy4/mf6/dfns/gwf-sto.toml b/flopy4/mf6/dfns/gwf-sto.toml deleted file mode 100644 index 082068f33..000000000 --- a/flopy4/mf6/dfns/gwf-sto.toml +++ /dev/null @@ -1,188 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-sto" -parent = "gwf-nam" -ftype = "STO6" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "keyword to save NPF flows" -description = "keyword to indicate that cell-by-cell flow terms will be written to the file specified with 'BUDGET SAVE FILE' in Output Control." -optional = true - -[blocks.options.fields.storagecoefficient] -type = "keyword" -longname = "keyword to indicate SS is read as storage coefficient" -description = "keyword to indicate that the SS array is read as storage coefficient rather than specific storage." -optional = true - -[blocks.options.fields.ss_confined_only] -type = "keyword" -longname = "keyword to indicate specific storage only applied under confined conditions" -description = "keyword to indicate that compressible storage is only calculated for a convertible cell (ICONVERT>0) when the cell is under confined conditions (head greater than or equal to the top of the cell). This option has no effect on cells that are marked as being always confined (ICONVERT=0). This option is identical to the approach used to calculate storage changes under confined conditions in MODFLOW-2005." -optional = true - -[blocks.options.fields.tvs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.tvs_filerecord.fields.tvs6] -type = "keyword" -longname = "tvs keyword" -description = "keyword to specify that record corresponds to a time-varying storage (TVS) file. The behavior of TVS and a description of the input file is provided separately." - -[blocks.options.fields.tvs_filerecord.fields.tvs6_filename] -type = "file" -longname = "file name of TVS information" -description = "defines a time-varying storage (TVS) input file. Records in the TVS file can be used to change specific storage and specific yield properties at specified times or stress periods." -tagged = false -direction = "in" -component = "utl-tvs" - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input grid arrays, which already support the layered keyword, should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.options.fields.dev_original_specific_storage] -type = "keyword" -longname = "development option for original specific storage" -description = "flag indicating the original storage specific storage formulation should be used" -optional = true -developmode = true - -[blocks.options.fields.dev_oldstorageformulation] -type = "keyword" -longname = "development option flag for old storage formulation" -description = "development option flag for old storage formulation" -optional = true -developmode = true - -[blocks.griddata.fields.iconvert] -type = "array" -longname = "convertible indicator" -description = "is a flag for each cell that specifies whether or not a cell is convertible for the storage calculation. 0 indicates confined storage is used. $>$0 indicates confined storage is used when head is above cell top and a mixed formulation of unconfined and confined storage is used when head is below cell top." -default = 0 -netcdf = true -dtype = "integer" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.ss] -type = "array" -longname = "specific storage" -description = "is specific storage (or the storage coefficient if STORAGECOEFFICIENT is specified as an option). Specific storage values must be greater than or equal to 0. If the CSUB Package is included in the GWF model, specific storage must be zero for every cell." -default = 1e-05 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.sy] -type = "array" -longname = "specific yield" -description = "is specific yield. Specific yield values must be greater than or equal to 0. Specific yield does not have to be specified if there are no convertible cells (ICONVERT=0 in every cell)." -default = 0.15 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.period.fields.stress_period_data] -type = "string" -longname = "storage state" -description = "keyword to indicate that stress period IPER is steady-state. Steady-state conditions will apply until the TRANSIENT keyword is specified in a subsequent BEGIN PERIOD block. If the CSUB Package is included in the GWF model, only the first and last stress period can be steady-state." -optional = true -tagged = false -valid = [ - "steady-state", - "transient", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.istor_coef] -set_in = "ar" -source = "storagecoefficient" -type = "integer" - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.iorig_ss] -set_in = "ar" -source = "dev_original_specific_storage" -type = "integer" - -[memory.iconf_ss] -set_in = "ar" -source = "dev_oldstorageformulation" -type = "integer" - -[memory.steady_state] -set_in = "rp" -type = "logical" - -[memory.iconvert] -type = "array" -set_in = "ar" -source = "iconvert" -dtype = "integer" -shape = [ - "nodes", -] - -[memory.ss] -type = "array" -set_in = "ar" -source = "ss" -dtype = "double" -shape = [ - "nodes", -] - -[memory.sy] -type = "array" -set_in = "ar" -source = "sy" -dtype = "double" -shape = [ - "nodes", -] diff --git a/flopy4/mf6/dfns/gwf-uzf.toml b/flopy4/mf6/dfns/gwf-uzf.toml deleted file mode 100644 index 188829d48..000000000 --- a/flopy4/mf6/dfns/gwf-uzf.toml +++ /dev/null @@ -1,611 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-uzf" -parent = "gwf-nam" -ftype = "UZF6" -multi = true -subtype = "advanced" - -[dims.nuzfcells] -value = "nuzfcells" - -[dims.ntrailwaves] -value = "ntrailwaves" - -[dims.nwavesets] -value = "nwavesets" - -[dims.auxiliary] -value = "len(auxiliary)" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of GWF cell area used by UZF cell." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of UZF cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of UZF information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of UZF flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save well flows to budget file" -description = "keyword to indicate that UZF flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.wc_filerecord] -type = "record" -optional = true - -[blocks.options.fields.wc_filerecord.fields.water_content] -type = "keyword" -longname = "water_content keyword" -description = "keyword to specify that record corresponds to unsaturated zone water contents." - -[blocks.options.fields.wc_filerecord.fields.wcfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write water content information." -tagged = false -direction = "out" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.package_convergence_filerecord] -type = "record" -optional = true - -[blocks.options.fields.package_convergence_filerecord.fields.package_convergence] -type = "keyword" -longname = "package_convergence keyword" -description = "keyword to specify that record corresponds to the package convergence comma spaced values file." - -[blocks.options.fields.package_convergence_filerecord.fields.package_convergence_filename] -type = "file" -longname = "file keyword" -description = "name of the comma spaced values output file to write package convergence information." -tagged = false -direction = "out" - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the UZF package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZF package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.mover] -type = "keyword" -description = "keyword to indicate that this instance of the UZF Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." -optional = true - -[blocks.options.fields.dev_no_final_check] -type = "keyword" -longname = "do not check final convergence" -description = "keyword that deactivates the final convergence check of the change in UZF recharge. This development option is not supported." -optional = true -developmode = true - -[blocks.options.fields.simulate_et] -type = "keyword" -description = "keyword specifying that ET in the unsaturated (UZF) and saturated zones (GWF) will be simulated. ET can be simulated in the UZF cell and not the GWF cell by omitting keywords LINEAR_GWET and SQUARE_GWET." -optional = true - -[blocks.options.fields.linear_gwet] -type = "keyword" -longname = "use linear evapotranspiration" -description = "keyword specifying that groundwater ET will be simulated using the original ET formulation of MODFLOW-2005." -optional = true - -[blocks.options.fields.square_gwet] -type = "keyword" -longname = "use square evapotranspiration" -description = "keyword specifying that groundwater ET will be simulated by assuming a constant ET rate for groundwater levels between land surface (TOP) and land surface minus the ET extinction depth (TOP-EXTDP). Groundwater ET is smoothly reduced from the PET rate to zero over a nominal interval at TOP-EXTDP." -optional = true - -[blocks.options.fields.simulate_gwseep] -type = "keyword" -longname = "activate seepage" -description = "keyword specifying that groundwater discharge (GWSEEP) to land surface will be simulated. Groundwater discharge is nonzero when groundwater head is greater than land surface. This option is no longer recommended; a better approach is to use the Drain Package with discharge scaling as a way to handle seepage to land surface. The Drain Package with discharge scaling is described in Chapter 3 of the Supplemental Technical Information." -optional = true -deprecated = "6.5.0" - -[blocks.options.fields.unsat_etwc] -type = "keyword" -longname = "use PET for theta greater than extwc" -description = "keyword specifying that ET in the unsaturated zone will be simulated as a function of the specified PET rate while the water content (THETA) is greater than the ET extinction water content (EXTWC)." -optional = true - -[blocks.options.fields.unsat_etae] -type = "keyword" -longname = "use root potential" -description = "keyword specifying that ET in the unsaturated zone will be simulated using a capillary pressure based formulation. Capillary pressure is calculated using the Brooks-Corey retention function." -optional = true - -[blocks.dimensions.fields.nuzfcells] -type = "integer" -longname = "number of UZF cells" -description = "is the number of UZF cells. More than one UZF cell can be assigned to a GWF cell; however, only one GWF cell can be assigned to a single UZF cell. If more than one UZF cell is assigned to a GWF cell, then an auxiliary variable should be used to reduce the surface area of the UZF cell with the AUXMULTNAME option." - -[blocks.dimensions.fields.ntrailwaves] -type = "integer" -longname = "number of trailing waves" -description = "is the number of trailing waves. A recommended value of 7 can be used for NTRAILWAVES. This value can be increased to lower mass balance error in the unsaturated zone." -default = 7 - -[blocks.dimensions.fields.nwavesets] -type = "integer" -longname = "number of wave sets" -description = "is the number of wave sets. A recommended value of 40 can be used for NWAVESETS. This value can be increased if more waves are required to resolve variations in water content within the unsaturated zone." -default = 40 - -[blocks.packagedata.fields.packagedata] -type = "list" -shape = [ - "nuzfcells", -] - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.ifno] -type = "integer" -longname = "uzf id number for this entry" -description = "integer value that defines the feature (UZF object) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NUZFCELLS. UZF information must be specified for every UZF cell or the program will terminate with an error. The program will also terminate with an error if information for a UZF cell is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.landflag] -type = "integer" -longname = "land flag" -description = "integer value set to one for land surface cells indicating that boundary conditions can be applied and data can be specified in the PERIOD block. A value of 0 specifies a non-land surface cell." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.ivertcon] -type = "integer" -longname = "vertical connection flag" -description = "integer value set to specify underlying UZF cell that receives water flowing to bottom of cell. If unsaturated zone flow reaches the water table before the cell bottom, then water is added to the GWF cell instead of flowing to the underlying UZF cell. A value of 0 indicates the UZF cell is not connected to an underlying UZF cell." -tagged = false -index = true -fk = "packagedata.ifno" -allow_zero = true - -[blocks.packagedata.fields.packagedata.item.fields.surfdep] -type = "double" -longname = "surface depression depth" -description = "is the surface depression depth of the UZF cell." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.vks] -type = "double" -longname = "vertical saturated hydraulic conductivity" -description = "is the saturated vertical hydraulic conductivity of the UZF cell. This value is used with the Brooks-Corey function and the simulated water content to calculate the partially saturated hydraulic conductivity." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.thtr] -type = "double" -longname = "residual water content" -description = "is the residual (irreducible) water content of the UZF cell. This residual water is not available to plants and will not drain into underlying aquifer cells." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.thts] -type = "double" -longname = "saturated water content" -description = "is the saturated water content of the UZF cell. The values for saturated and residual water content should be set in a manner that is consistent with the specific yield value specified in the Storage Package. The saturated water content must be greater than the residual content." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.thti] -type = "double" -longname = "initial water content" -description = "is the initial water content of the UZF cell. The value must be greater than or equal to the residual water content and less than or equal to the saturated water content." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.eps] -type = "double" -longname = "Brooks-Corey exponent" -description = "is the exponent used in the Brooks-Corey function. The Brooks-Corey function is used by UZF to calculated hydraulic conductivity under partially saturated conditions as a function of water content and the user-specified saturated hydraulic conductivity." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.boundname] -type = "string" -longname = "well name" -description = "name of the UZF cell cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "perioddata" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.ifno] -type = "integer" -longname = "UZF id number" -description = "integer value that defines the feature (UZF object) number associated with the specified PERIOD data on the line." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.fields.finf] -type = "double" -longname = "infiltration rate" -description = "real or character value that defines the applied infiltration rate of the UZF cell ($LT^{-1}$). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.pet] -type = "double" -longname = "potential ET rate" -description = "real or character value that defines the potential evapotranspiration rate of the UZF cell and specified GWF cell. Evapotranspiration is first removed from the unsaturated zone and any remaining potential evapotranspiration is applied to the saturated zone. If IVERTCON is greater than zero then residual potential evapotranspiration not satisfied in the UZF cell is applied to the underlying UZF and GWF cells. PET is always specified, but is only used if SIMULATE_ET is specified in the OPTIONS block. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.extdp] -type = "double" -longname = "extinction depth" -description = "real or character value that defines the evapotranspiration extinction depth of the UZF cell. If IVERTCON is greater than zero and EXTDP extends below the GWF cell bottom then remaining potential evapotranspiration is applied to the underlying UZF and GWF cells. EXTDP is always specified, but is only used if SIMULATE_ET is specified in the OPTIONS block. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.extwc] -type = "double" -longname = "extinction water content" -description = "real or character value that defines the evapotranspiration extinction water content of the UZF cell. EXTWC is always specified, but is only used if SIMULATE_ET and UNSAT_ETWC are specified in the OPTIONS block. The evapotranspiration rate from the unsaturated zone will be set to zero when the calculated water content is at or less than this value. The value for EXTWC cannot be less than the residual water content, and if it is specified as being less than the residual water content it is set to the residual water content. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.ha] -type = "double" -longname = "air entry potential" -description = "real or character value that defines the air entry potential (head) of the UZF cell. HA is always specified, but is only used if SIMULATE_ET and UNSAT_ETAE are specified in the OPTIONS block. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.hroot] -type = "double" -longname = "root potential" -description = "real or character value that defines the root potential (head) of the UZF cell. HROOT is always specified, but is only used if SIMULATE_ET and UNSAT_ETAE are specified in the OPTIONS block. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.rootact] -type = "double" -longname = "root activity function" -description = "real or character value that defines the root activity function of the UZF cell. ROOTACT is the length of roots in a given volume of soil divided by that volume. Values range from 0 to about 3 $cm^{-2}$, depending on the plant community and its stage of development. ROOTACT is always specified, but is only used if SIMULATE_ET and UNSAT_ETAE are specified in the OPTIONS block. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each UZF. The values of auxiliary variables must be present for each UZF. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.pkgconv] -set_in = "ar" -source = "package_convergence" -type = "logical" - -[memory.pkgconvfname] -set_in = "ar" -source = "package_convergence_filename" -type = "string" - -[memory.iconvchk] -set_in = "ar" -source = "dev_no_final_check" -type = "integer" - -[memory.maxbound] -set_in = "ar" -source = "nuzfcells" -type = "integer" - -[memory.packagedata_ifno] -set_in = "ar" -source = "ifno" -type = "integer" - -[memory.ntrailwaves] -set_in = "ar" -source = "ntrailwaves" -type = "integer" - -[memory.nwavesets] -set_in = "ar" -source = "nwavesets" -type = "integer" - -[observations.uzf-gwrch] -type = "union" - -[observations.uzf-gwrch.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.uzf-gwrch.arms.boundname] -type = "string" -tagged = false - -[observations.uzf-gwd] -type = "union" - -[observations.uzf-gwd.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.uzf-gwd.arms.boundname] -type = "string" -tagged = false - -[observations.uzf-gwd-to-mvr] -type = "union" - -[observations.uzf-gwd-to-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.uzf-gwd-to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.uzf-gwet] -type = "union" - -[observations.uzf-gwet.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.uzf-gwet.arms.boundname] -type = "string" -tagged = false - -[observations.infiltration] -type = "union" - -[observations.infiltration.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.infiltration.arms.boundname] -type = "string" -tagged = false - -[observations.from-mvr] -type = "union" - -[observations.from-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.from-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.rej-inf] -type = "union" - -[observations.rej-inf.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.rej-inf.arms.boundname] -type = "string" -tagged = false - -[observations.rej-inf-to-mvr] -type = "union" - -[observations.rej-inf-to-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.rej-inf-to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.uzet] -type = "union" - -[observations.uzet.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.uzet.arms.boundname] -type = "string" -tagged = false - -[observations.storage] -type = "union" - -[observations.storage.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.storage.arms.boundname] -type = "string" -tagged = false - -[observations.net-infiltration] -type = "union" - -[observations.net-infiltration.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.net-infiltration.arms.boundname] -type = "string" -tagged = false - -[observations.water-content] -type = "record" - -[observations.water-content.fields.ifno] -type = "union" - -[observations.water-content.fields.ifno.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.water-content.fields.ifno.arms.boundname] -type = "string" -tagged = false - -[observations.water-content.fields.depth] -type = "double" -tagged = false - -[keys] -bound = "packagedata.ifno" - -[keys.mover_provider] -path = "packagedata.ifno" -when = "mover" - -[keys.mover_receiver] -path = "packagedata.ifno" -when = "mover" diff --git a/flopy4/mf6/dfns/gwf-vsc.toml b/flopy4/mf6/dfns/gwf-vsc.toml deleted file mode 100644 index 79d9d07a2..000000000 --- a/flopy4/mf6/dfns/gwf-vsc.toml +++ /dev/null @@ -1,130 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-vsc" -parent = "gwf-nam" -ftype = "VSC6" - -[dims.nviscspecies] -value = "nviscspecies" - -[blocks.options.fields.viscref] -type = "double" -longname = "reference viscosity" -description = "fluid reference viscosity used in the equation of state. This value is set to 1.0 if not specified as an option." -optional = true -default = 1.0 - -[blocks.options.fields.temperature_species_name] -type = "string" -longname = "auxspeciesname that corresponds to temperature" -description = "string used to identify the auxspeciesname in PACKAGEDATA that corresponds to the temperature species. There can be only one occurrence of this temperature species name in the PACKAGEDATA block or the program will terminate with an error. This value has no effect if viscosity does not depend on temperature." -optional = true - -[blocks.options.fields.thermal_formulation] -type = "string" -longname = "keyword to specify viscosity formulation for the temperature species" -description = "may be used for specifying which viscosity formulation to use for the temperature species. Can be either LINEAR or NONLINEAR. The LINEAR viscosity formulation is the default." -optional = true -valid = [ - "linear", - "nonlinear", -] - -[blocks.options.fields.thermal_a2] -type = "double" -longname = "coefficient used in nonlinear viscosity function" -description = "is an empirical parameter specified by the user for calculating viscosity using a nonlinear formulation. If A2 is not specified, a default value of 10.0 is assigned (Voss, 1984)." -optional = true -default = 10.0 - -[blocks.options.fields.thermal_a3] -type = "double" -longname = "coefficient used in nonlinear viscosity function" -description = "is an empirical parameter specified by the user for calculating viscosity using a nonlinear formulation. If A3 is not specified, a default value of 248.37 is assigned (Voss, 1984)." -optional = true -default = 248.37 - -[blocks.options.fields.thermal_a4] -type = "double" -longname = "coefficient used in nonlinear viscosity function" -description = "is an empirical parameter specified by the user for calculating viscosity using a nonlinear formulation. If A4 is not specified, a default value of 133.15 is assigned (Voss, 1984)." -optional = true -default = 133.15 - -[blocks.options.fields.viscosity_filerecord] -type = "record" -optional = true - -[blocks.options.fields.viscosity_filerecord.fields.viscosity] -type = "keyword" -longname = "viscosity keyword" -description = "keyword to specify that record corresponds to viscosity." - -[blocks.options.fields.viscosity_filerecord.fields.viscosityfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write viscosity information. The viscosity file has the same format as the head file. Viscosity values will be written to the viscosity file whenever heads are written to the binary head file. The settings for controlling head output are contained in the Output Control option." -tagged = false -direction = "out" - -[blocks.dimensions.fields.nviscspecies] -type = "integer" -longname = "number of species used in viscosity equation of state" -description = "number of species used in the viscosity equation of state. If either concentrations or temperature (or both) are used to update viscosity then nviscspecies needs to be at least one." - -[blocks.packagedata.fields.packagedata] -type = "list" -shape = [ - "nviscspecies", -] - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.iviscspec] -type = "integer" -longname = "species number for this entry" -description = "integer value that defines the species number associated with the specified PACKAGEDATA data entered on each line. IVISCSPECIES must be greater than zero and less than or equal to NVISCSPECIES. Information must be specified for each of the NVISCSPECIES species or the program will terminate with an error. The program will also terminate with an error if information for a species is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.dviscdc] -type = "double" -longname = "slope of the line that defines the linear relationship between viscosity and temperature or between viscosity and concentration, depending on the type of species entered on each line." -description = "real value that defines the slope of the line defining the linear relationship between viscosity and temperature or between viscosity and concentration, depending on the type of species entered on each line. If the value of AUXSPECIESNAME entered on a line corresponds to TEMPERATURE_SPECIES_NAME (in the OPTIONS block), this value will be used when VISCOSITY_FUNC is equal to LINEAR (the default) in the OPTIONS block. When VISCOSITY_FUNC is set to NONLINEAR, a value for DVISCDC must be specified though it is not used." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.cviscref] -type = "double" -longname = "reference temperature value or reference concentration value" -description = "real value that defines the reference temperature or reference concentration value used for this species in the viscosity equation of state. If AUXSPECIESNAME entered on a line corresponds to TEMPERATURE_SPECIES_NAME (in the OPTIONS block), then CVISCREF refers to a reference temperature, otherwise it refers to a reference concentration." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.modelname] -type = "string" -longname = "modelname" -description = "name of a GWT or GWE model used to simulate a species that will be used in the viscosity equation of state. This name will have no effect if the simulation does not include a GWT or GWE model that corresponds to this GWF model." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.auxspeciesname] -type = "string" -longname = "auxspeciesname" -description = "name of an auxiliary variable in a GWF stress package that will be used for this species to calculate the viscosity values. If a viscosity value is needed by the Viscosity Package then it will use the temperature or concentration values associated with this AUXSPECIESNAME in the viscosity equation of state. For advanced stress packages (LAK, SFR, MAW, and UZF) that have an associated advanced transport package (LKT, SFT, MWT, and UZT), the FLOW_PACKAGE_AUXILIARY_NAME option in the advanced transport package can be used to transfer simulated temperature or concentration(s) into the flow package auxiliary variable. In this manner, the Viscosity Package can calculate viscosity values for lakes, streams, multi-aquifer wells, and unsaturated zone flow cells using simulated concentrations." -tagged = false - -[memory.temp_specname] -set_in = "ar" -source = "temperature_species_name" -type = "string" - -[memory.thermal_form] -set_in = "ar" -source = "thermal_formulation" -type = "string" - -[memory.nviscspecies] -set_in = "ar" -source = "nviscspecies" -type = "integer" diff --git a/flopy4/mf6/dfns/gwf-wel.toml b/flopy4/mf6/dfns/gwf-wel.toml deleted file mode 100644 index cdc0bfc8c..000000000 --- a/flopy4/mf6/dfns/gwf-wel.toml +++ /dev/null @@ -1,382 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-wel" -parent = "gwf-nam" -ftype = "WEL6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of well flow rate." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of well cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of well information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of well flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save well flows to budget file" -description = "keyword to indicate that well flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.auto_flow_reduce] -type = "double" -longname = "cell fractional thickness for reduced pumping" -description = "keyword and real value that defines the fraction of the cell thickness used as an interval for smoothly adjusting negative pumping rates to 0 in cells with head values less than or equal to the bottom of the cell. Negative pumping rates are adjusted to 0 or a smaller negative value when the head in the cell is equal to or less than the calculated interval above the cell bottom. AUTO_FLOW_REDUCE is set to 0.1 if the specified value is less than or equal to zero. AUTO_FLOW_REDUCE is set to 1.0 if the specified value is greater than 1.0 and the FLOW_REDUCTION_LENGTH option is not specified (that is, the value is interpreted as a fraction of the cell thickness). By default, negative pumping rates are not reduced during a simulation. This AUTO_FLOW_REDUCE option only applies to wells in model cells that are marked as 'convertible' (ICELLTYPE /= 0) in the Node Property Flow (NPF) input file. Reduction in flow will not occur for wells in cells marked as confined (ICELLTYPE = 0)." -optional = true - -[blocks.options.fields.afrcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.afrcsv_filerecord.fields.auto_flow_reduce_csv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program." - -[blocks.options.fields.afrcsv_filerecord.fields.afrcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write information about well extraction rates that have been reduced by the program. Entries are only written if the extraction rates are reduced." -tagged = false -direction = "out" - -[blocks.options.fields.flow_reduction_length] -type = "keyword" -longname = "flow reduction length keyword" -description = "keyword that indicates the AUTO_FLOW_REDUCE value is a length instead of a fraction of the cell thickness. A warning will be issued if the FLOW_REDUCTION_LENGTH option is specified but the AUTO_FLOW_REDUCE option is not specified in the options block. The program will terminate with an error if the FLOW_REDUCTION_LENGTH option is specified and the AUTO_FLOW_REDUCE value specified in the options block is less than or equal to zero." -optional = true - -[blocks.options.fields.auto_flow_reduce_auxname] -type = "string" -longname = "name of auxiliary variable for the per-well AUTO\\_FLOW\\_REDUCE value" -description = "name of a variable listed in AUXILIARY that defines the per-well AUTO_FLOW_REDUCE value used to compute the flow reduction threshold for each well. The auxiliary variable is interpreted the same way as the global AUTO_FLOW_REDUCE value: as a length above the cell bottom when FLOW_REDUCTION_LENGTH is specified, or otherwise as a fraction of the cell thickness. When specified, the per-well auxiliary value overrides the global AUTO_FLOW_REDUCE value for that well. A warning will be issued if AUTO_FLOW_REDUCE_AUXNAME is specified but AUTO_FLOW_REDUCE is not specified in the OPTIONS block. A warning will be issued if AUTO_FLOW_REDUCE_AUXNAME is specified but FLOW_REDUCTION_LENGTH is not specified in the OPTIONS block. The program will terminate with an error if AUTO_FLOW_REDUCE_AUXNAME is specified but no AUXILIARY variables are specified, or if the named AUXILIARY variable cannot be found. The per-well value must be greater than zero and less than or equal to 1 when FLOW_REDUCTION_LENGTH is not specified, or greater than zero and less than or equal to the cell thickness when FLOW_REDUCTION_LENGTH is specified; the program will terminate with an error if a value is outside the valid range." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the WEL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the WEL package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.mover] -type = "keyword" -description = "keyword to indicate that this instance of the Well Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." -optional = true - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of wells" -description = "integer value specifying the maximum number of wells cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.q] -type = "double" -longname = "well rate" -description = "is the volumetric well rate. A positive value indicates recharge (injection) and a negative value indicates discharge (extraction). If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "well name" -description = "name of the well cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.flowred] -set_in = "ar" -source = "auto_flow_reduce" -type = "double" - -[memory.afrcsv] -set_in = "ar" -source = "auto_flow_reduce_csv" -type = "logical" - -[memory.iflowredlen] -set_in = "ar" -source = "flow_reduction_length" -type = "integer" - -[memory.afrauxname] -set_in = "ar" -source = "auto_flow_reduce_auxname" -type = "string" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: q." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "WEL" -output = true -obs_type = "WEL" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "WEL-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.wel] -type = "union" - -[observations.wel.arms.cellid] -type = "cellid" -tagged = false - -[observations.wel.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.wel-reduction] -type = "union" - -[observations.wel-reduction.arms.cellid] -type = "cellid" -tagged = false - -[observations.wel-reduction.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" - -[keys.mover_provider] -path = "<=maxbound" -when = "mover" diff --git a/flopy4/mf6/dfns/gwf-welg.toml b/flopy4/mf6/dfns/gwf-welg.toml deleted file mode 100644 index d1d78818b..000000000 --- a/flopy4/mf6/dfns/gwf-welg.toml +++ /dev/null @@ -1,363 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwf-welg" -parent = "gwf-nam" -ftype = "WEL6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.readarraygrid] -type = "keyword" -longname = "use array-based grid input" -description = "indicates that array-based grid input will be used for the well boundary package. This keyword must be specified to use array-based grid input. When READARRAYGRID is specified, values must be provided for every cell within a model grid, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results. No data cells should contain the value DNODATA (3.0E+30)." -default = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of well flow rate." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of well information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of well flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save well flows to budget file" -description = "keyword to indicate that well flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.auto_flow_reduce] -type = "double" -longname = "cell fractional thickness for reduced pumping" -description = "keyword and real value that defines the fraction of the cell thickness used as an interval for smoothly adjusting negative pumping rates to 0 in cells with head values less than or equal to the bottom of the cell. Negative pumping rates are adjusted to 0 or a smaller negative value when the head in the cell is equal to or less than the calculated interval above the cell bottom. AUTO_FLOW_REDUCE is set to 0.1 if the specified value is less than or equal to zero. By default, negative pumping rates are not reduced during a simulation. This AUTO_FLOW_REDUCE option only applies to wells in model cells that are marked as 'convertible' (ICELLTYPE /= 0) in the Node Property Flow (NPF) input file. Reduction in flow will not occur for wells in cells marked as confined (ICELLTYPE = 0)." -optional = true - -[blocks.options.fields.afrcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.afrcsv_filerecord.fields.auto_flow_reduce_csv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the AUTO_FLOW_REDUCE output option in which a new record is written for each well and for each time step in which the user-requested extraction rate is reduced by the program." - -[blocks.options.fields.afrcsv_filerecord.fields.afrcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write information about well extraction rates that have been reduced by the program. Entries are only written if the extraction rates are reduced." -tagged = false -direction = "out" - -[blocks.options.fields.flow_reduction_length] -type = "keyword" -longname = "flow reduction length keyword" -description = "keyword that indicates the AUTO_FLOW_REDUCE value is a length instead of a fraction of the cell thickness. A warning will be issued if the FLOW_REDUCTION_LENGTH option is specified but the AUTO_FLOW_REDUCE option is not specified in the options block. The program will terminate with an error if the FLOW_REDUCTION_LENGTH option is specified and the AUTO_FLOW_REDUCE value specified in the options block is less than or equal to zero." -optional = true - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the WEL package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the WEL package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.mover] -type = "keyword" -description = "keyword to indicate that this instance of the Well Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of wells in any stress period" -description = "integer value specifying the maximum number of wells cells that will be specified for use during any stress period." -optional = true - -[blocks.period.fields.q] -type = "array" -longname = "well rate" -description = "is the volumetric well rate. A positive value indicates recharge (injection) and a negative value indicates discharge (extraction)." -default = 3e+30 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.period.fields.aux] -type = "list" -longname = "well auxiliary variable iaux" -description = "is an array of values for auxiliary variable aux(iaux), where iaux is a value from 1 to naux, and aux(iaux) must be listed as part of the auxiliary variables. A separate array can be specified for each auxiliary variable. If an array is not specified for an auxiliary variable, then it will retain its value from the most recently specified period block. If an auxiliary variable array has never been specified, its value is zero. If the value specified here for the auxiliary variable is the same as auxmultname, then the well rate array will be multiplied by this array." -optional = true -shape = [ - "<=auxiliary", -] - -[blocks.period.fields.aux.item] -name = "aux" -type = "record" - -[blocks.period.fields.aux.item.fields.auxname] -type = "string" -longname = "auxiliary variable name" -description = "name of the auxiliary variable the following array sets; must be one of the auxiliary variables." -tagged = false -fk = "options.auxiliary" -dynamic = true - -[blocks.period.fields.aux.item.fields.aux] -type = "array" -longname = "well auxiliary variable iaux" -netcdf = true -tagged = false -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.flowred] -set_in = "ar" -source = "auto_flow_reduce" -type = "double" - -[memory.afrcsv] -set_in = "ar" -source = "auto_flow_reduce_csv" -type = "logical" - -[memory.iflowredlen] -set_in = "ar" -source = "flow_reduction_length" -type = "integer" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "WEL" -output = true -obs_type = "WEL" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "WEL-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.wel] -type = "union" - -[observations.wel.arms.cellid] -type = "cellid" -tagged = false - -[observations.wel.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.wel-reduction] -type = "union" - -[observations.wel-reduction.arms.cellid] -type = "cellid" -tagged = false - -[observations.wel-reduction.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" - -[keys.mover_provider] -path = "<=maxbound" -when = "mover" diff --git a/flopy4/mf6/dfns/gwt-adv.toml b/flopy4/mf6/dfns/gwt-adv.toml deleted file mode 100644 index 9b87594d2..000000000 --- a/flopy4/mf6/dfns/gwt-adv.toml +++ /dev/null @@ -1,23 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-adv" -parent = "gwt-nam" -ftype = "ADV6" - -[blocks.options.fields.scheme] -type = "string" -longname = "advective scheme" -description = "scheme used to solve the advection term. Can be upstream, central, TVD or UTVD. If not specified, upstream weighting is the default weighting scheme." -optional = true -valid = [ - "central", - "upstream", - "tvd", - "utvd", -] - -[blocks.options.fields.ats_percel] -type = "double" -longname = "fractional cell distance used for time step calculation" -description = "fractional cell distance submitted by the ADV Package to the adaptive time stepping (ATS) package. If ATS_PERCEL is specified and the ATS Package is active, a time step calculation will be made for each cell based on flow through the cell and cell properties. The largest time step will be calculated such that the advective fractional cell distance (ATS_PERCEL) is not exceeded for any active cell in the grid. This time-step constraint will be submitted to the ATS Package, perhaps with constraints submitted by other packages, in the calculation of the time step. ATS_PERCEL must be greater than zero. If a value of zero is specified for ATS_PERCEL the program will automatically reset it to an internal no data value to indicate that time steps should not be subject to this constraint." -optional = true diff --git a/flopy4/mf6/dfns/gwt-api.toml b/flopy4/mf6/dfns/gwt-api.toml deleted file mode 100644 index 1f0bd4098..000000000 --- a/flopy4/mf6/dfns/gwt-api.toml +++ /dev/null @@ -1,108 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-api" -parent = "gwt-nam" -ftype = "API6" -multi = true - -[dims.maxbound] -value = "maxbound" - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of api boundary cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of api boundary information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of api boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save api flows to budget file" -description = "keyword to indicate that api boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the api boundary package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the api boundary package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.mover] -type = "keyword" -description = "keyword to indicate that this instance of the api boundary Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water." -optional = true - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of user-defined api boundaries" -description = "integer value specifying the maximum number of api boundary cells that will be specified for use during any stress period." - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.maxbound] -set_in = "ar" -source = "maxbound" -type = "integer" - -[observations.api] -type = "union" - -[observations.api.arms.cellid] -type = "cellid" -tagged = false - -[observations.api.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" - -[keys.mover_provider] -path = "<=maxbound" -when = "mover" diff --git a/flopy4/mf6/dfns/gwt-cnc.toml b/flopy4/mf6/dfns/gwt-cnc.toml deleted file mode 100644 index 3db73f3e5..000000000 --- a/flopy4/mf6/dfns/gwt-cnc.toml +++ /dev/null @@ -1,300 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-cnc" -parent = "gwt-nam" -ftype = "CNC6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of concentration value." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of constant concentration cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of constant concentration information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of constant concentration flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save constant concentration flows to budget file" -description = "keyword to indicate that constant concentration flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "time series keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the CNC package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CNC package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of constant concentrations" -description = "integer value specifying the maximum number of constant concentrations cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.conc] -type = "double" -longname = "constant concentration value" -description = "is the constant concentration value. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each constant concentration. The values of auxiliary variables must be present for each constant concentration. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "constant concentration name" -description = "name of the constant concentration cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.tspvar] -set_in = "ad" -source = "conc" -type = "double" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: conc." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "CNC" -output = true -obs_type = "CNC" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.cnc] -type = "union" - -[observations.cnc.arms.cellid] -type = "cellid" -tagged = false - -[observations.cnc.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwt-dis.toml b/flopy4/mf6/dfns/gwt-dis.toml deleted file mode 100644 index 86c0a7688..000000000 --- a/flopy4/mf6/dfns/gwt-dis.toml +++ /dev/null @@ -1,302 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-dis" -parent = "gwt-nam" -ftype = "DIS6" - -[dims.nlay] -value = "nlay" -scope = "model" - -[dims.nrow] -value = "nrow" -scope = "model" - -[dims.ncol] -value = "ncol" -scope = "model" - -[dims.ncpl] -value = "nrow * ncol" -scope = "model" - -[dims.nodes] -value = "nlay * nrow * ncol" -scope = "model" - -[dims.ncelldim] -value = "3" -scope = "model" - -[runtime_dims.nodes] -set_in = "ar" - -[runtime_dims.nodesuser] -set_in = "ar" - -[blocks.options.fields.length_units] -type = "string" -longname = "model length units" -description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." -optional = true - -[blocks.options.fields.nogrb] -type = "keyword" -longname = "do not write binary grid file" -description = "keyword to deactivate writing of the binary grid file." -optional = true - -[blocks.options.fields.grb_filerecord] -type = "record" -optional = true - -[blocks.options.fields.grb_filerecord.fields.grb6] -type = "keyword" -longname = "grb keyword" -description = "keyword to specify that record corresponds to a binary grid file." - -[blocks.options.fields.grb_filerecord.fields.grb6_filename] -type = "file" -longname = "file name of GRB information" -description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." -tagged = false -direction = "out" - -[blocks.options.fields.xorigin] -type = "double" -longname = "x-position of the model grid origin" -description = "x-position of the lower-left corner of the model grid. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.yorigin] -type = "double" -longname = "y-position of the model grid origin" -description = "y-position of the lower-left corner of the model grid. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.angrot] -type = "double" -longname = "rotation angle" -description = "counter-clockwise rotation angle (in degrees) of the lower-left corner of the model grid. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.options.fields.crs] -type = "string" -longname = "CRS user input string" -description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true -case_sensitive = true - -[blocks.options.fields.ncf_filerecord] -type = "record" -optional = true - -[blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "keyword" -longname = "ncf keyword" -description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." - -[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] -type = "file" -longname = "file name of NCF information" -description = "defines a NetCDF configuration (NCF) input file." -tagged = false -direction = "in" -component = "utl-ncf" - -[blocks.dimensions.fields.nlay] -type = "integer" -longname = "number of layers" -description = "is the number of layers in the model grid." -default = 1 - -[blocks.dimensions.fields.nrow] -type = "integer" -longname = "number of rows" -description = "is the number of rows in the model grid." -default = 2 - -[blocks.dimensions.fields.ncol] -type = "integer" -longname = "number of columns" -description = "is the number of columns in the model grid." -default = 2 - -[blocks.griddata.fields.delr] -type = "array" -longname = "spacing along a row" -description = "is the column spacing in the row direction." -default = 1.0 -netcdf = true -dtype = "double" -shape = [ - "ncol", -] - -[blocks.griddata.fields.delc] -type = "array" -longname = "spacing along a column" -description = "is the row spacing in the column direction." -default = 1.0 -netcdf = true -dtype = "double" -shape = [ - "nrow", -] - -[blocks.griddata.fields.top] -type = "array" -longname = "cell top elevation" -description = "is the top elevation for each cell in the top model layer." -default = 1.0 -netcdf = true -dtype = "double" -shape = [ - "ncol", - "nrow", -] - -[blocks.griddata.fields.botm] -type = "array" -longname = "cell bottom elevation" -description = "is the bottom elevation for each cell." -default = 0.0 -netcdf = true -dtype = "double" -layered = true -shape = [ - "ncol", - "nrow", - "nlay", -] - -[blocks.griddata.fields.idomain] -type = "array" -longname = "idomain existence array" -description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." -optional = true -netcdf = true -dtype = "integer" -layered = true -shape = [ - "ncol", - "nrow", - "nlay", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.nlay] -set_in = "ar" -source = "nlay" -type = "integer" - -[memory.nrow] -set_in = "ar" -source = "nrow" -type = "integer" - -[memory.ncol] -set_in = "ar" -source = "ncol" -type = "integer" - -[memory.delr] -type = "array" -set_in = "ar" -source = "delr" -dtype = "double" -shape = [ - "ncol", -] - -[memory.delc] -type = "array" -set_in = "ar" -source = "delc" -dtype = "double" -shape = [ - "nrow", -] - -[memory.top] -type = "array" -set_in = "ar" -source = "top" -dtype = "double" -shape = [ - "ncol", - "nrow", -] - -[memory.botm] -type = "array" -set_in = "ar" -source = "botm" -dtype = "double" -shape = [ - "ncol", - "nrow", - "nlay", -] - -[memory.idomain] -type = "array" -set_in = "ar" -source = "idomain" -dtype = "integer" -shape = [ - "ncol", - "nrow", - "nlay", -] - -[memory.area] -type = "array" -readonly = true -set_in = "ar" -description = "Horizontal cell area, computed from grid geometry." -dtype = "double" -shape = [ - "ncpl", -] - -[memory.nodeuser] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodereduced] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." -dtype = "integer" -shape = [ - "nodesuser", -] diff --git a/flopy4/mf6/dfns/gwt-disu.toml b/flopy4/mf6/dfns/gwt-disu.toml deleted file mode 100644 index aac2670e6..000000000 --- a/flopy4/mf6/dfns/gwt-disu.toml +++ /dev/null @@ -1,368 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-disu" -parent = "gwt-nam" -ftype = "DISU6" - -[dims.nodes] -value = "nodes" -scope = "model" - -[dims.nja] -value = "nja" -scope = "model" - -[dims.nvert] -value = "nvert" -scope = "model" - -[dims.ncelldim] -value = "1" -scope = "model" - -[dims.njas] -value = "(nja - nodes) / 2" - -[runtime_dims.nodes] -set_in = "ar" - -[runtime_dims.nodesuser] -set_in = "ar" - -[blocks.options.fields.length_units] -type = "string" -longname = "model length units" -description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." -optional = true - -[blocks.options.fields.nogrb] -type = "keyword" -longname = "do not write binary grid file" -description = "keyword to deactivate writing of the binary grid file." -optional = true - -[blocks.options.fields.grb_filerecord] -type = "record" -optional = true - -[blocks.options.fields.grb_filerecord.fields.grb6] -type = "keyword" -longname = "grb keyword" -description = "keyword to specify that record corresponds to a binary grid file." - -[blocks.options.fields.grb_filerecord.fields.grb6_filename] -type = "file" -longname = "file name of GRB information" -description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." -tagged = false -direction = "out" - -[blocks.options.fields.xorigin] -type = "double" -longname = "x-position origin of the model grid coordinate system" -description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.yorigin] -type = "double" -longname = "y-position origin of the model grid coordinate system" -description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.angrot] -type = "double" -longname = "rotation angle" -description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.vertical_offset_tolerance] -type = "double" -longname = "vertical length dimension for top and bottom checking" -description = "checks are performed to ensure that the top of a cell is not higher than the bottom of an overlying cell. This option can be used to specify the tolerance that is used for checking. If top of a cell is above the bottom of an overlying cell by a value less than this tolerance, then the program will not terminate with an error. The default value is zero. This option should generally not be used." -optional = true -default = 0.0 - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.crs] -type = "string" -longname = "CRS user input string" -description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true -case_sensitive = true - -[blocks.dimensions.fields.nodes] -type = "integer" -longname = "number of layers" -description = "is the number of cells in the model grid." - -[blocks.dimensions.fields.nja] -type = "integer" -longname = "number of columns" -description = "is the sum of the number of connections and NODES. When calculating the total number of connections, the connection between cell n and cell m is considered to be different from the connection between cell m and cell n. Thus, NJA is equal to the total number of connections, including n to m and m to n, and the total number of cells." - -[blocks.dimensions.fields.nvert] -type = "integer" -longname = "number of vertices" -description = "is the total number of (x, y) vertex pairs used to define the plan-view shape of each cell in the model grid. If NVERT is not specified or is specified as zero, then the VERTICES and CELL2D blocks below are not read. NVERT and the accompanying VERTICES and CELL2D blocks should be specified for most simulations. If the XT3D or SAVE_SPECIFIC_DISCHARGE options are specified in the NPF Package, then this information is required." -optional = true - -[blocks.griddata.fields.top] -type = "array" -longname = "cell top elevation" -description = "is the top elevation for each cell in the model grid." -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.bot] -type = "array" -longname = "cell bottom elevation" -description = "is the bottom elevation for each cell." -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.area] -type = "array" -longname = "cell surface area" -description = "is the cell surface area (in plan view)." -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.idomain] -type = "array" -longname = "idomain existence array" -description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1 or greater, the cell exists in the simulation. IDOMAIN values of -1 cannot be specified for the DISU Package." -optional = true -dtype = "integer" -shape = [ - "nodes", -] - -[blocks.connectiondata.fields.iac] -type = "array" -longname = "number of cell connections" -description = "is the number of connections (plus 1) for each cell. The sum of all the entries in IAC must be equal to NJA." -dtype = "integer" -shape = [ - "nodes", -] - -[blocks.connectiondata.fields.ja] -type = "array" -longname = "grid connectivity" -description = "is a list of cell number (n) followed by its connecting cell numbers (m) for each of the m cells connected to cell n. The number of values to provide for cell n is IAC(n). This list is sequentially provided for the first to the last cell. The first value in the list must be cell n itself, and the remaining cells must be listed in an increasing order (sorted from lowest number to highest). Note that the cell and its connections are only supplied for the GWT cells and their connections to the other GWT cells. Also note that the JA list input may be divided such that every node and its connectivity list can be on a separate line for ease in readability of the file. To further ease readability of the file, the node number of the cell whose connectivity is subsequently listed, may be expressed as a negative number, the sign of which is subsequently converted to positive by the code." -dtype = "integer" -index = true -shape = [ - "nja", -] - -[blocks.connectiondata.fields.ihc] -type = "array" -longname = "connection type" -description = "is an index array indicating the direction between node n and all of its m connections. If IHC = 0 then cell n and cell m are connected in the vertical direction. Cell n overlies cell m if the cell number for n is less than m; cell m overlies cell n if the cell number for m is less than n. If IHC = 1 then cell n and cell m are connected in the horizontal direction. If IHC = 2 then cell n and cell m are connected in the horizontal direction, and the connection is vertically staggered. A vertically staggered connection is one in which a cell is horizontally connected to more than one cell in a horizontal connection." -dtype = "integer" -shape = [ - "nja", -] - -[blocks.connectiondata.fields.cl12] -type = "array" -longname = "connection lengths" -description = "is the array containing connection lengths between the center of cell n and the shared face with each adjacent m cell." -dtype = "double" -shape = [ - "nja", -] - -[blocks.connectiondata.fields.hwva] -type = "array" -longname = "connection lengths" -description = "is a symmetric array of size NJA. For horizontal connections, entries in HWVA are the horizontal width perpendicular to flow. For vertical connections, entries in HWVA are the vertical area for flow. Thus, values in the HWVA array contain dimensions of both length and area. Entries in the HWVA array have a one-to-one correspondence with the connections specified in the JA array. Likewise, there is a one-to-one correspondence between entries in the HWVA array and entries in the IHC array, which specifies the connection type (horizontal or vertical). Entries in the HWVA array must be symmetric; the program will terminate with an error if the value for HWVA for an n to m connection does not equal the value for HWVA for the corresponding n to m connection." -dtype = "double" -shape = [ - "nja", -] - -[blocks.connectiondata.fields.angldegx] -type = "array" -longname = "angle of face normal to connection" -description = "is the angle (in degrees) between the horizontal x-axis and the outward normal to the face between a cell and its connecting cells. The angle varies between zero and 360.0 degrees, where zero degrees points in the positive x-axis direction, and 90 degrees points in the positive y-axis direction. ANGLDEGX is only needed if horizontal anisotropy is specified in the NPF Package, if the XT3D option is used in the NPF Package, or if the SAVE_SPECIFIC_DISCHARGE option is specified in the NPF Package. ANGLDEGX does not need to be specified if these conditions are not met. ANGLDEGX is of size NJA; values specified for vertical connections and for the diagonal position are not used. Note that ANGLDEGX is read in degrees, which is different from MODFLOW-USG, which reads a similar variable (ANGLEX) in radians." -optional = true -dtype = "double" -shape = [ - "nja", -] - -[blocks.vertices.fields.vertices] -type = "list" -longname = "vertices data" -optional = true -shape = [ - "nvert", -] - -[blocks.vertices.fields.vertices.item] -name = "vertices" -type = "record" - -[blocks.vertices.fields.vertices.item.fields.iv] -type = "integer" -longname = "vertex number" -description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." -tagged = false -index = true -pk = true - -[blocks.vertices.fields.vertices.item.fields.xv] -type = "double" -longname = "x-coordinate for vertex" -description = "is the x-coordinate for the vertex." -tagged = false - -[blocks.vertices.fields.vertices.item.fields.yv] -type = "double" -longname = "y-coordinate for vertex" -description = "is the y-coordinate for the vertex." -tagged = false - -[blocks.cell2d.fields.cell2d] -type = "list" -longname = "cell2d data" -optional = true -shape = [ - "nodes", -] - -[blocks.cell2d.fields.cell2d.item] -name = "cell2d" -type = "record" - -[blocks.cell2d.fields.cell2d.item.fields.icell2d] -type = "integer" -longname = "cell2d number" -description = "is the cell2d number. Records in the CELL2D block must be listed in consecutive order from 1 to NODES." -tagged = false -index = true -pk = true - -[blocks.cell2d.fields.cell2d.item.fields.xc] -type = "double" -longname = "x-coordinate for cell center" -description = "is the x-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.yc] -type = "double" -longname = "y-coordinate for cell center" -description = "is the y-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.ncvert] -type = "integer" -longname = "number of cell vertices" -description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.icvert] -type = "array" -longname = "array of vertex numbers" -description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order." -tagged = false -dtype = "integer" -index = true -shape = [ - "ncvert", -] - -[memory.voffsettol] -set_in = "ar" -source = "vertical_offset_tolerance" -type = "double" - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.nodes] -set_in = "ar" -source = "nodes" -type = "integer" - -[memory.nja] -set_in = "ar" -source = "nja" -type = "integer" - -[memory.nvert] -set_in = "ar" -source = "nvert" -type = "integer" - -[memory.top] -type = "array" -set_in = "ar" -source = "top" -dtype = "double" -shape = [ - "nodes", -] - -[memory.bot] -type = "array" -set_in = "ar" -source = "bot" -dtype = "double" -shape = [ - "nodes", -] - -[memory.area] -type = "array" -readonly = true -set_in = "ar" -description = "Horizontal cell area, computed from grid geometry." -dtype = "double" -shape = [ - "nodesuser", -] - -[memory.idomain] -type = "array" -set_in = "ar" -source = "idomain" -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodeuser] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodereduced] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." -dtype = "integer" -shape = [ - "nodesuser", -] diff --git a/flopy4/mf6/dfns/gwt-disv.toml b/flopy4/mf6/dfns/gwt-disv.toml deleted file mode 100644 index adc75c519..000000000 --- a/flopy4/mf6/dfns/gwt-disv.toml +++ /dev/null @@ -1,326 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-disv" -parent = "gwt-nam" -ftype = "DISV6" - -[dims.nlay] -value = "nlay" -scope = "model" - -[dims.ncpl] -value = "ncpl" -scope = "model" - -[dims.nvert] -value = "nvert" -scope = "model" - -[dims.nodes] -value = "nlay * ncpl" -scope = "model" - -[dims.ncelldim] -value = "2" -scope = "model" - -[runtime_dims.nodes] -set_in = "ar" - -[runtime_dims.nodesuser] -set_in = "ar" - -[blocks.options.fields.length_units] -type = "string" -longname = "model length units" -description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." -optional = true - -[blocks.options.fields.nogrb] -type = "keyword" -longname = "do not write binary grid file" -description = "keyword to deactivate writing of the binary grid file." -optional = true - -[blocks.options.fields.grb_filerecord] -type = "record" -optional = true - -[blocks.options.fields.grb_filerecord.fields.grb6] -type = "keyword" -longname = "grb keyword" -description = "keyword to specify that record corresponds to a binary grid file." - -[blocks.options.fields.grb_filerecord.fields.grb6_filename] -type = "file" -longname = "file name of GRB information" -description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." -tagged = false -direction = "out" - -[blocks.options.fields.xorigin] -type = "double" -longname = "x-position origin of the model grid coordinate system" -description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.yorigin] -type = "double" -longname = "y-position origin of the model grid coordinate system" -description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.angrot] -type = "double" -longname = "rotation angle" -description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.options.fields.crs] -type = "string" -longname = "CRS user input string" -description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true -case_sensitive = true - -[blocks.options.fields.ncf_filerecord] -type = "record" -optional = true - -[blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "keyword" -longname = "ncf keyword" -description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." - -[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] -type = "file" -longname = "file name of NCF information" -description = "defines a NetCDF configuration (NCF) input file." -tagged = false -direction = "in" -component = "utl-ncf" - -[blocks.dimensions.fields.nlay] -type = "integer" -longname = "number of layers" -description = "is the number of layers in the model grid." - -[blocks.dimensions.fields.ncpl] -type = "integer" -longname = "number of cells per layer" -description = "is the number of cells per layer. This is a constant value for the grid and it applies to all layers." - -[blocks.dimensions.fields.nvert] -type = "integer" -longname = "number of vertices" -description = "is the total number of (x, y) vertex pairs used to characterize the horizontal configuration of the model grid." - -[blocks.griddata.fields.top] -type = "array" -longname = "model top elevation" -description = "is the top elevation for each cell in the top model layer." -netcdf = true -dtype = "double" -shape = [ - "ncpl", -] - -[blocks.griddata.fields.botm] -type = "array" -longname = "model bottom elevation" -description = "is the bottom elevation for each cell." -netcdf = true -dtype = "double" -layered = true -shape = [ - "ncpl", - "nlay", -] - -[blocks.griddata.fields.idomain] -type = "array" -longname = "idomain existence array" -description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." -optional = true -netcdf = true -dtype = "integer" -layered = true -shape = [ - "ncpl", - "nlay", -] - -[blocks.vertices.fields.vertices] -type = "list" -longname = "vertices data" -shape = [ - "nvert", -] - -[blocks.vertices.fields.vertices.item] -name = "vertices" -type = "record" - -[blocks.vertices.fields.vertices.item.fields.iv] -type = "integer" -longname = "vertex number" -description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." -tagged = false -index = true -pk = true - -[blocks.vertices.fields.vertices.item.fields.xv] -type = "double" -longname = "x-coordinate for vertex" -description = "is the x-coordinate for the vertex." -tagged = false - -[blocks.vertices.fields.vertices.item.fields.yv] -type = "double" -longname = "y-coordinate for vertex" -description = "is the y-coordinate for the vertex." -tagged = false - -[blocks.cell2d.fields.cell2d] -type = "list" -longname = "cell2d data" -shape = [ - "ncpl", -] - -[blocks.cell2d.fields.cell2d.item] -name = "cell2d" -type = "record" - -[blocks.cell2d.fields.cell2d.item.fields.icell2d] -type = "integer" -longname = "cell2d number" -description = "is the CELL2D number. Records in the CELL2D block must be listed in consecutive order from the first to the last." -tagged = false -index = true -pk = true - -[blocks.cell2d.fields.cell2d.item.fields.xc] -type = "double" -longname = "x-coordinate for cell center" -description = "is the x-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.yc] -type = "double" -longname = "y-coordinate for cell center" -description = "is the y-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.ncvert] -type = "integer" -longname = "number of cell vertices" -description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.icvert] -type = "array" -longname = "array of vertex numbers" -description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." -tagged = false -dtype = "integer" -index = true -shape = [ - "ncvert", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.nlay] -set_in = "ar" -source = "nlay" -type = "integer" - -[memory.ncpl] -set_in = "ar" -source = "ncpl" -type = "integer" - -[memory.nvert] -set_in = "ar" -source = "nvert" -type = "integer" - -[memory.top] -type = "array" -set_in = "ar" -source = "top" -dtype = "double" -shape = [ - "ncpl", -] - -[memory.botm] -type = "array" -set_in = "ar" -source = "botm" -dtype = "double" -shape = [ - "ncpl", - "nlay", -] - -[memory.idomain] -type = "array" -set_in = "ar" -source = "idomain" -dtype = "integer" -shape = [ - "ncpl", - "nlay", -] - -[memory.area] -type = "array" -readonly = true -set_in = "ar" -description = "Horizontal cell area, computed from grid geometry." -dtype = "double" -shape = [ - "ncpl", -] - -[memory.nodeuser] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodereduced] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." -dtype = "integer" -shape = [ - "nodesuser", -] diff --git a/flopy4/mf6/dfns/gwt-dsp.toml b/flopy4/mf6/dfns/gwt-dsp.toml deleted file mode 100644 index a0d840b0b..000000000 --- a/flopy4/mf6/dfns/gwt-dsp.toml +++ /dev/null @@ -1,168 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-dsp" -parent = "gwt-nam" -ftype = "DSP6" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.xt3d_off] -type = "keyword" -longname = "deactivate xt3d" -description = "deactivate the xt3d method and use the faster and less accurate approximation. This option may provide a fast and accurate solution under some circumstances, such as when flow aligns with the model grid, there is no mechanical dispersion, or when the longitudinal and transverse dispersivities are equal. This option may also be used to assess the computational demand of the XT3D approach by noting the run time differences with and without this option on." -optional = true - -[blocks.options.fields.xt3d_rhs] -type = "keyword" -longname = "xt3d on right-hand side" -description = "add xt3d terms to right-hand side, when possible. This option uses less memory, but may require more iterations." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.griddata.fields.diffc] -type = "array" -longname = "effective molecular diffusion coefficient" -description = "effective molecular diffusion coefficient." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.alh] -type = "array" -longname = "longitudinal dispersivity in horizontal direction" -description = "longitudinal dispersivity in horizontal direction. If flow is strictly horizontal, then this is the longitudinal dispersivity that will be used. If flow is not strictly horizontal or strictly vertical, then the longitudinal dispersivity is a function of both ALH and ALV. If mechanical dispersion is represented (by specifying any dispersivity values) then this array is required." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.alv] -type = "array" -longname = "longitudinal dispersivity in vertical direction" -description = "longitudinal dispersivity in vertical direction. If flow is strictly vertical, then this is the longitudinal dispsersivity value that will be used. If flow is not strictly horizontal or strictly vertical, then the longitudinal dispersivity is a function of both ALH and ALV. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ALH." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.ath1] -type = "array" -longname = "transverse dispersivity in horizontal direction" -description = "transverse dispersivity in horizontal direction. This is the transverse dispersivity value for the second ellipsoid axis. If flow is strictly horizontal and directed in the x direction (along a row for a regular grid), then this value controls spreading in the y direction. If mechanical dispersion is represented (by specifying any dispersivity values) then this array is required." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.ath2] -type = "array" -longname = "transverse dispersivity in horizontal direction" -description = "transverse dispersivity in horizontal direction. This is the transverse dispersivity value for the third ellipsoid axis. If flow is strictly horizontal and directed in the x direction (along a row for a regular grid), then this value controls spreading in the z direction. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ATH1." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.atv] -type = "array" -longname = "transverse dispersivity when flow is in vertical direction" -description = "transverse dispersivity when flow is in vertical direction. If flow is strictly vertical and directed in the z direction, then this value controls spreading in the x and y directions. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ATH2." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.diffc] -type = "array" -set_in = "ar" -source = "diffc" -dtype = "double" -shape = [ - "nodes", -] - -[memory.alh] -type = "array" -set_in = "ar" -source = "alh" -dtype = "double" -shape = [ - "nodes", -] - -[memory.alv] -type = "array" -set_in = "ar" -source = "alv" -dtype = "double" -shape = [ - "nodes", -] - -[memory.ath1] -type = "array" -set_in = "ar" -source = "ath1" -dtype = "double" -shape = [ - "nodes", -] - -[memory.ath2] -type = "array" -set_in = "ar" -source = "ath2" -dtype = "double" -shape = [ - "nodes", -] - -[memory.atv] -type = "array" -set_in = "ar" -source = "atv" -dtype = "double" -shape = [ - "nodes", -] diff --git a/flopy4/mf6/dfns/gwt-fmi.toml b/flopy4/mf6/dfns/gwt-fmi.toml deleted file mode 100644 index 58c774aad..000000000 --- a/flopy4/mf6/dfns/gwt-fmi.toml +++ /dev/null @@ -1,44 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-fmi" -parent = "gwt-nam" -ftype = "FMI6" - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save calculated flow imbalance correction to budget file" -description = "keyword to indicate that FMI flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.flow_imbalance_correction] -type = "keyword" -longname = "correct for flow imbalance" -description = "correct for an imbalance in flows by assuming that any residual flow error comes in or leaves at the concentration of the cell. When this option is activated, the GWT Model budget written to the listing file will contain two additional entries: FLOW-ERROR and FLOW-CORRECTION. These two entries will be equal but opposite in sign. The FLOW-CORRECTION term is a mass flow that is added to offset the error caused by an imprecise flow balance. If these terms are not relatively small, the flow model should be rerun with stricter convergence tolerances." -optional = true - -[blocks.packagedata.fields.packagedata] -type = "list" -longname = "flowtype list" -optional = true - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.flowtype] -type = "string" -longname = "flow type" -description = "is the word GWFBUDGET, GWFHEAD, GWFGRID, GWFMOVER or the name of an advanced GWF stress package. If GWFBUDGET is specified, then the corresponding file must be a budget file. If GWFHEAD is specified, the file must be a head file. If GWFGRID is specified, the file must be a binary grid file. If an advanced GWF stress package name appears then the corresponding file must be the budget file saved by a LAK, SFR, MAW or UZF Package." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.fname] -type = "file" -longname = "file name" -description = "is the name of the file containing flows. The path to the file should be included if the file is not located in the folder where the program was run." -tagged = false -direction = "in" - -[memory.imbalancecorrect] -set_in = "ar" -source = "flow_imbalance_correction" -type = "logical" diff --git a/flopy4/mf6/dfns/gwt-ic.toml b/flopy4/mf6/dfns/gwt-ic.toml deleted file mode 100644 index 576050a91..000000000 --- a/flopy4/mf6/dfns/gwt-ic.toml +++ /dev/null @@ -1,51 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-ic" -parent = "gwt-nam" -ftype = "IC6" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.griddata.fields.strt] -type = "array" -longname = "starting concentration" -description = "is the initial (starting) concentration---that is, concentration at the beginning of the GWT Model simulation. STRT must be specified for all GWT Model simulations. One value is read for every model cell." -default = 0.0 -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.strt] -type = "array" -set_in = "ar" -source = "strt" -dtype = "double" -shape = [ - "nodes", -] diff --git a/flopy4/mf6/dfns/gwt-ist.toml b/flopy4/mf6/dfns/gwt-ist.toml deleted file mode 100644 index 1ff5c9436..000000000 --- a/flopy4/mf6/dfns/gwt-ist.toml +++ /dev/null @@ -1,366 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-ist" -parent = "gwt-nam" -ftype = "IST6" -multi = true - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save calculated flows to budget file" -description = "keyword to indicate that IST flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.sorption] -type = "string" -longname = "activate sorption" -description = "is a text keyword to indicate that sorption will be activated. Valid sorption options include LINEAR, FREUNDLICH, and LANGMUIR. Use of this keyword requires that BULK_DENSITY and DISTCOEF are specified in the GRIDDATA block. If sorption is specified as FREUNDLICH or LANGMUIR then SP2 is also required in the GRIDDATA block. The sorption option must be consistent with the sorption option specified in the MST Package or the program will terminate with an error." -optional = true -valid = [ - "linear", - "freundlich", - "langmuir", -] - -[blocks.options.fields.first_order_decay] -type = "keyword" -longname = "activate first-order decay" -description = "is a text keyword to indicate that first-order decay will occur. Use of this keyword requires that DECAY and DECAY_SORBED (if sorption is active) are specified in the GRIDDATA block." -optional = true - -[blocks.options.fields.zero_order_decay] -type = "keyword" -longname = "activate zero-order decay" -description = "is a text keyword to indicate that zero-order decay will occur. Use of this keyword requires that DECAY and DECAY_SORBED (if sorption is active) are specified in the GRIDDATA block." -optional = true - -[blocks.options.fields.cim_filerecord] -type = "record" -optional = true - -[blocks.options.fields.cim_filerecord.fields.cim] -type = "keyword" -longname = "cim keyword" -description = "keyword to specify that record corresponds to immobile concentration." - -[blocks.options.fields.cim_filerecord.fields.cimfile] -type = "file" -longname = "file keyword" -description = "name of the output file to write immobile concentrations. This file is a binary file that has the same format and structure as a binary head and concentration file. The value for the text variable written to the file is CIM. Immobile domain concentrations will be written to this file at the same interval as mobile domain concentrations are saved, as specified in the GWT Model Output Control file." -tagged = false -direction = "out" - -[blocks.options.fields.cimprintrecord] -type = "record" -optional = true - -[blocks.options.fields.cimprintrecord.fields.cim] -type = "keyword" -longname = "cim keyword" -description = "keyword to specify that record corresponds to immobile concentration." - -[blocks.options.fields.cimprintrecord.fields.print_format] -type = "keyword" -longname = "keyword to indicate that a print format follows" -description = "keyword to specify format for printing to the listing file." - -[blocks.options.fields.cimprintrecord.fields.formatrecord] -type = "record" - -[blocks.options.fields.cimprintrecord.fields.formatrecord.fields.columns] -type = "integer" -longname = "number of columns" -description = "number of columns for writing data." -optional = true - -[blocks.options.fields.cimprintrecord.fields.formatrecord.fields.width] -type = "integer" -longname = "width for each number" -description = "width for writing each number." -optional = true - -[blocks.options.fields.cimprintrecord.fields.formatrecord.fields.digits] -type = "integer" -longname = "number of digits" -description = "number of digits to use for writing a number." -optional = true - -[blocks.options.fields.cimprintrecord.fields.formatrecord.fields.format] -type = "string" -longname = "write format" -description = "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC." -tagged = false - -[blocks.options.fields.sorbate_filerecord] -type = "record" -optional = true - -[blocks.options.fields.sorbate_filerecord.fields.sorbate] -type = "keyword" -longname = "sorbate keyword" -description = "keyword to specify that record corresponds to immobile sorbate concentration." - -[blocks.options.fields.sorbate_filerecord.fields.sorbatefile] -type = "file" -longname = "file keyword" -description = "name of the output file to write immobile sorbate concentration information. Immobile sorbate concentrations will be written whenever aqueous immobile concentrations are saved, as determined by settings in the Output Control option." -tagged = false -direction = "out" - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.griddata.fields.porosity] -type = "array" -longname = "porosity of the immobile domain" -description = "porosity of the immobile domain specified as the immobile domain pore volume per immobile domain volume." -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.volfrac] -type = "array" -longname = "volume fraction of this immobile domain" -description = "fraction of the cell volume that consists of this immobile domain. The sum of all immobile domain volume fractions must be less than one." -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.zetaim] -type = "array" -longname = "mass transfer rate coefficient between the mobile and immobile domains" -description = "mass transfer rate coefficient between the mobile and immobile domains, in dimensions of per time." -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.cim] -type = "array" -longname = "initial concentration of the immobile domain" -description = "initial concentration of the immobile domain in mass per length cubed. If CIM is not specified, then it is assumed to be zero." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.decay] -type = "array" -longname = "first rate coefficient" -description = "is the rate coefficient for first or zero-order decay for the aqueous phase of the immobile domain. A negative value indicates solute production. The dimensions of decay for first-order decay is one over time. The dimensions of decay for zero-order decay is mass per length cubed per time. Decay will have no effect on simulation results unless either first- or zero-order decay is specified in the options block." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.decay_sorbed] -type = "array" -longname = "second rate coefficient" -description = "is the rate coefficient for first or zero-order decay for the sorbed phase of the immobile domain. A negative value indicates solute production. The dimensions of decay_sorbed for first-order decay is one over time. The dimensions of decay_sorbed for zero-order decay is mass of solute per mass of aquifer per time. If decay_sorbed is not specified and both decay and sorption are active, then the program will terminate with an error. decay_sorbed will have no effect on simulation results unless the SORPTION keyword and either first- or zero-order decay are specified in the options block." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.bulk_density] -type = "array" -longname = "bulk density" -description = "is the bulk density of this immobile domain in mass per length cubed. Bulk density is defined as the immobile domain solid mass per volume of the immobile domain. bulk_density is not required unless the SORPTION keyword is specified in the options block. If the SORPTION keyword is not specified in the options block, bulk_density will have no effect on simulation results." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.distcoef] -type = "array" -longname = "distribution coefficient" -description = "is the distribution coefficient for the equilibrium-controlled linear sorption isotherm in dimensions of length cubed per mass. distcoef is not required unless the SORPTION keyword is specified in the options block. If the SORPTION keyword is not specified in the options block, distcoef will have no effect on simulation results." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.sp2] -type = "array" -longname = "second sorption parameter" -description = "is the exponent for the Freundlich isotherm and the sorption capacity for the Langmuir isotherm. sp2 is not required unless the SORPTION keyword is specified in the options block and sorption is specified as FREUNDLICH or LANGMUIR. If the SORPTION keyword is not specified in the options block, or if sorption is specified as LINEAR, sp2 will have no effect on simulation results." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[memory.order1_decay] -set_in = "ar" -source = "first_order_decay" -type = "logical" - -[memory.order0_decay] -set_in = "ar" -source = "zero_order_decay" -type = "logical" - -[memory.cimopt] -set_in = "ar" -source = "cim" -type = "logical" - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.porosity] -type = "array" -set_in = "ar" -source = "porosity" -dtype = "double" -shape = [ - "nodes", -] - -[memory.volfrac] -type = "array" -set_in = "ar" -source = "volfrac" -dtype = "double" -shape = [ - "nodes", -] - -[memory.zetaim] -type = "array" -set_in = "ar" -source = "zetaim" -dtype = "double" -shape = [ - "nodes", -] - -[memory.cim] -type = "array" -set_in = "ar" -source = "cim" -dtype = "double" -shape = [ - "nodes", -] - -[memory.decay] -type = "array" -set_in = "ar" -source = "decay" -dtype = "double" -shape = [ - "nodes", -] - -[memory.decay_sorbed] -type = "array" -set_in = "ar" -source = "decay_sorbed" -dtype = "double" -shape = [ - "nodes", -] - -[memory.bulk_density] -type = "array" -set_in = "ar" -source = "bulk_density" -dtype = "double" -shape = [ - "nodes", -] - -[memory.distcoef] -type = "array" -set_in = "ar" -source = "distcoef" -dtype = "double" -shape = [ - "nodes", -] - -[memory.sp2] -type = "array" -set_in = "ar" -source = "sp2" -dtype = "double" -shape = [ - "nodes", -] diff --git a/flopy4/mf6/dfns/gwt-lkt.toml b/flopy4/mf6/dfns/gwt-lkt.toml deleted file mode 100644 index bc1e35930..000000000 --- a/flopy4/mf6/dfns/gwt-lkt.toml +++ /dev/null @@ -1,609 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-lkt" -parent = "gwt-nam" -ftype = "LKT6" -multi = true -subtype = "advanced" - -[dims.auxiliary] -value = "len(auxiliary)" - -[runtime_dims.ncv] -set_in = "ar" - -[blocks.options.fields.flow_package_name] -type = "string" -longname = "keyword to specify name of corresponding flow package" -description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWT name file)." -optional = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.flow_package_auxiliary_name] -type = "string" -longname = "keyword to specify name of concentration auxiliary variable in flow package" -description = "keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated concentrations from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of lake cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of lake information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_concentration] -type = "keyword" -longname = "print calculated stages to listing file" -description = "keyword to indicate that the list of lake {#2} will be printed to the listing file for every stress period in which 'CONCENTRATION PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of lake flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save lake flows to budget file" -description = "keyword to indicate that lake flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.concentration_filerecord] -type = "record" -optional = true - -[blocks.options.fields.concentration_filerecord.fields.concentration] -type = "keyword" -longname = "stage keyword" -description = "keyword to specify that record corresponds to concentration." - -[blocks.options.fields.concentration_filerecord.fields.concfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write concentration information." -tagged = false -direction = "out" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the LKT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the LKT package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.dev_nonexpanding_matrix] -type = "keyword" -longname = "do not add rows to the solution matrix" -description = "keyword that solves the feature concentration with a general mixing equation and adds the result to the right-hand side of the GWT equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." -optional = true -developmode = true - -[blocks.packagedata.fields.packagedata] -type = "list" - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.ifno] -type = "integer" -longname = "lake number for this entry" -description = "integer value that defines the feature (lake) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NLAKES. Lake information must be specified for every lake or the program will terminate with an error. The program will also terminate with an error if information for a lake is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.strt] -type = "double" -longname = "starting lake concentration" -description = "real value that defines the starting concentration for the lake." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each lake. The values of auxiliary variables must be present for each lake. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.packagedata.fields.packagedata.item.fields.boundname] -type = "string" -longname = "lake name" -description = "name of the lake cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "lakeperioddata" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.ifno] -type = "integer" -longname = "lake number for this entry" -description = "integer value that defines the feature (lake) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NLAKES." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.fields.laksetting] -type = "union" -description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the LAKSETTING string include: STATUS, CONCENTRATION, RAINFALL, EVAPORATION, RUNOFF, EXT-INFLOW, and AUXILIARY. These settings are used to assign the concentration of associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms. For example, the Lake Package supports a 'WITHDRAWAL' flow term. If this withdrawal term is active, then water will be withdrawn from the lake at the calculated concentration of the lake." - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.status] -type = "string" -longname = "lake concentration status" -description = "keyword option to define lake status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that concentration will be calculated for the lake. If a lake is inactive, then there will be no solute mass fluxes into or out of the lake and the inactive value will be written for the lake concentration. If a lake is constant, then the concentration for the lake will be fixed at the user specified value." - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.concentration] -type = "double" -longname = "lake concentration" -description = "real or character value that defines the concentration for the lake. The specified CONCENTRATION is only applied if the lake is a constant concentration lake. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.rainfall] -type = "double" -longname = "rainfall concentration" -description = "real or character value that defines the rainfall solute concentration $(ML^{-3})$ for the lake. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.evaporation] -type = "double" -longname = "evaporation concentration" -description = "real or character value that defines the concentration of evaporated water $(ML^{-3})$ for the lake. If this concentration value is larger than the simulated concentration in the lake, then the evaporated water will be removed at the same concentration as the lake. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.runoff] -type = "double" -longname = "runoff concentration" -description = "real or character value that defines the concentration of runoff $(ML^{-3})$ for the lake. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.ext-inflow] -type = "double" -longname = "ext-inflow concentration" -description = "real or character value that defines the concentration of external inflow $(ML^{-3})$ for the lake. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord.fields.auxiliary] -type = "keyword" -description = "keyword for specifying auxiliary variable." - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord.fields.auxname] -type = "string" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.laksetting.arms.auxiliaryrecord.fields.auxval] -type = "double" -longname = "auxiliary variable value" -description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.flow_pkg_name] -set_in = "ar" -source = "flow_package_name" -type = "string" - -[memory.fp_aux_name] -set_in = "ar" -source = "flow_package_auxiliary_name" -type = "string" - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprconc] -set_in = "ar" -source = "print_concentration" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.dev_nonexpanding] -set_in = "ar" -source = "dev_nonexpanding_matrix" -type = "logical" - -[memory.packagedata_ifno] -set_in = "ar" -source = "ifno" -type = "integer" - -[memory.period_auxiliary] -set_in = "rp" -source = "auxiliary" -type = "logical" - -[memory.ncv] -readonly = true -set_in = "ar" -description = "Number of control volumes. Assigned from the linked flow package during AR." -type = "integer" - -[memory.strt] -type = "array" -set_in = "ar" -source = "strt" -description = "Starting concentration for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xnewpak] -type = "array" -set_in = "ca" -description = "Current concentration for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xoldpak] -type = "array" -readonly = true -set_in = "ad" -description = "Concentration from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." -dtype = "double" -shape = [ - "ncv", -] - -[memory.ibound] -type = "array" -set_in = "ar" -description = "Boundary activity flag for each control volume." -dtype = "integer" -shape = [ - "ncv", -] - -[memory.concfeat] -type = "array" -readonly = true -set_in = "cq" -description = "Computed concentration for each feature. Set from XNEWPAK after solver convergence." -dtype = "double" -shape = [ - "ncv", -] - -[memory.qsto] -type = "array" -readonly = true -set_in = "cq" -description = "Storage concentration flow contribution for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.concrain] -type = "array" -set_in = "rp" -description = "Rainfall concentration for each lake." -dtype = "double" -shape = [ - "ncv", -] - -[memory.concevap] -type = "array" -set_in = "rp" -description = "Evaporation concentration for each lake." -dtype = "double" -shape = [ - "ncv", -] - -[memory.concroff] -type = "array" -set_in = "rp" -description = "Runoff concentration for each lake." -dtype = "double" -shape = [ - "ncv", -] - -[memory.conciflw] -type = "array" -set_in = "rp" -description = "External inflow concentration for each lake." -dtype = "double" -shape = [ - "ncv", -] - -[observations.concentration] -type = "union" - -[observations.concentration.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.concentration.arms.boundname] -type = "string" -tagged = false - -[observations.storage] -type = "union" - -[observations.storage.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.storage.arms.boundname] -type = "string" -tagged = false - -[observations.constant] -type = "union" - -[observations.constant.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.constant.arms.boundname] -type = "string" -tagged = false - -[observations.from-mvr] -type = "union" - -[observations.from-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.from-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.rainfall] -type = "union" - -[observations.rainfall.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.rainfall.arms.boundname] -type = "string" -tagged = false - -[observations.evaporation] -type = "union" - -[observations.evaporation.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.evaporation.arms.boundname] -type = "string" -tagged = false - -[observations.runoff] -type = "union" - -[observations.runoff.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.runoff.arms.boundname] -type = "string" -tagged = false - -[observations.ext-inflow] -type = "union" - -[observations.ext-inflow.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.ext-inflow.arms.boundname] -type = "string" -tagged = false - -[observations.withdrawal] -type = "union" - -[observations.withdrawal.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.withdrawal.arms.boundname] -type = "string" -tagged = false - -[observations.ext-outflow] -type = "union" - -[observations.ext-outflow.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.ext-outflow.arms.boundname] -type = "string" -tagged = false - -[observations.flow-ja-face] -type = "union" - -[observations.flow-ja-face.arms.ifno_ifno2] -type = "record" - -[observations.flow-ja-face.arms.ifno_ifno2.fields.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.flow-ja-face.arms.ifno_ifno2.fields.ifno2] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.flow-ja-face.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.outletno] -type = "integer" -tagged = false -index = true - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.lkt] -type = "union" - -[observations.lkt.arms.ifno_iconn] -type = "record" - -[observations.lkt.arms.ifno_iconn.fields.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.lkt.arms.ifno_iconn.fields.iconn] -type = "integer" -tagged = false -index = true - -[observations.lkt.arms.boundname] -type = "string" -tagged = false diff --git a/flopy4/mf6/dfns/gwt-mst.toml b/flopy4/mf6/dfns/gwt-mst.toml deleted file mode 100644 index 24be6f582..000000000 --- a/flopy4/mf6/dfns/gwt-mst.toml +++ /dev/null @@ -1,210 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-mst" -parent = "gwt-nam" -ftype = "MST6" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save calculated flows to budget file" -description = "keyword to indicate that MST flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.first_order_decay] -type = "keyword" -longname = "activate first-order decay" -description = "is a text keyword to indicate that first-order decay will occur. Use of this keyword requires that DECAY and DECAY_SORBED (if sorption is active) are specified in the GRIDDATA block." -optional = true - -[blocks.options.fields.zero_order_decay] -type = "keyword" -longname = "activate zero-order decay" -description = "is a text keyword to indicate that zero-order decay will occur. Use of this keyword requires that DECAY and DECAY_SORBED (if sorption is active) are specified in the GRIDDATA block." -optional = true - -[blocks.options.fields.sorption] -type = "string" -longname = "activate sorption" -description = "is a text keyword to indicate that sorption will be activated. Valid sorption options include LINEAR, FREUNDLICH, and LANGMUIR. Use of this keyword requires that BULK_DENSITY and DISTCOEF are specified in the GRIDDATA block. If sorption is specified as FREUNDLICH or LANGMUIR then SP2 is also required in the GRIDDATA block." -optional = true -valid = [ - "linear", - "freundlich", - "langmuir", -] - -[blocks.options.fields.sorbate_filerecord] -type = "record" -optional = true - -[blocks.options.fields.sorbate_filerecord.fields.sorbate] -type = "keyword" -longname = "sorbate keyword" -description = "keyword to specify that record corresponds to sorbate concentration." - -[blocks.options.fields.sorbate_filerecord.fields.sorbatefile] -type = "file" -longname = "file keyword" -description = "name of the output file to write sorbate concentration information. Sorbate concentrations will be written whenever aqueous concentrations are saved, as determined by settings in the Output Control option." -tagged = false -direction = "out" - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.griddata.fields.porosity] -type = "array" -longname = "porosity" -description = "is the mobile domain porosity, defined as the mobile domain pore volume per mobile domain volume. Additional information on porosity within the context of mobile and immobile domain transport simulations is included in the MODFLOW 6 Supplemental Technical Information document." -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.decay] -type = "array" -longname = "aqueous phase decay rate coefficient" -description = "is the rate coefficient for first or zero-order decay for the aqueous phase of the mobile domain. A negative value indicates solute production. The dimensions of decay for first-order decay is one over time. The dimensions of decay for zero-order decay is mass per length cubed per time. decay will have no effect on simulation results unless either first- or zero-order decay is specified in the options block." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.decay_sorbed] -type = "array" -longname = "sorbed phase decay rate coefficient" -description = "is the rate coefficient for first or zero-order decay for the sorbed phase of the mobile domain. A negative value indicates solute production. The dimensions of decay_sorbed for first-order decay is one over time. The dimensions of decay_sorbed for zero-order decay is mass of solute per mass of aquifer per time. If decay_sorbed is not specified and both decay and sorption are active, then the program will terminate with an error. decay_sorbed will have no effect on simulation results unless the SORPTION keyword and either first- or zero-order decay are specified in the options block." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.bulk_density] -type = "array" -longname = "bulk density" -description = "is the bulk density of the aquifer in mass per length cubed. bulk_density is not required unless the SORPTION keyword is specified. Bulk density is defined as the mobile domain solid mass per mobile domain volume. Additional information on bulk density is included in the MODFLOW 6 Supplemental Technical Information document." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.distcoef] -type = "array" -longname = "distribution coefficient" -description = "is the distribution coefficient for the equilibrium-controlled linear sorption isotherm in dimensions of length cubed per mass. If the Freunchlich isotherm is specified, then discoef is the Freundlich constant. If the Langmuir isotherm is specified, then distcoef is the Langmuir constant. distcoef is not required unless the SORPTION keyword is specified." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.sp2] -type = "array" -longname = "second sorption parameter" -description = "is the exponent for the Freundlich isotherm and the sorption capacity for the Langmuir isotherm. sp2 is not required unless the SORPTION keyword is specified in the options block. If the SORPTION keyword is not specified in the options block, sp2 will have no effect on simulation results." -optional = true -netcdf = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[memory.order1_decay] -set_in = "ar" -source = "first_order_decay" -type = "logical" - -[memory.order0_decay] -set_in = "ar" -source = "zero_order_decay" -type = "logical" - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.porosity] -type = "array" -set_in = "ar" -source = "porosity" -dtype = "double" -shape = [ - "nodes", -] - -[memory.decay] -type = "array" -set_in = "ar" -source = "decay" -dtype = "double" -shape = [ - "nodes", -] - -[memory.decay_sorbed] -type = "array" -set_in = "ar" -source = "decay_sorbed" -dtype = "double" -shape = [ - "nodes", -] - -[memory.bulk_density] -type = "array" -set_in = "ar" -source = "bulk_density" -dtype = "double" -shape = [ - "nodes", -] - -[memory.distcoef] -type = "array" -set_in = "ar" -source = "distcoef" -dtype = "double" -shape = [ - "nodes", -] - -[memory.sp2] -type = "array" -set_in = "ar" -source = "sp2" -dtype = "double" -shape = [ - "nodes", -] diff --git a/flopy4/mf6/dfns/gwt-mvt.toml b/flopy4/mf6/dfns/gwt-mvt.toml deleted file mode 100644 index b9e8f55dd..000000000 --- a/flopy4/mf6/dfns/gwt-mvt.toml +++ /dev/null @@ -1,82 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-mvt" -ftype = "MVT6" -parent = [ - "exg-gwtgwt", - "gwt-nam", -] - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of mover information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of lake flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save MVT flows to budget file" -description = "keyword to indicate that lake flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[memory.iprpak] -set_in = "ar" -source = "print_input" -description = "Flag controlling whether mover input is echoed to the listing file." -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -description = "Flag controlling whether mover flow rates are printed to the listing file." -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether mover flows are written to the budget file." -type = "integer" - -[memory.maxpackages] -readonly = true -set_in = "ar" -description = "Number of packages participating in the mover. Computed from the packages that supply or receive moved water." -type = "integer" diff --git a/flopy4/mf6/dfns/gwt-mwt.toml b/flopy4/mf6/dfns/gwt-mwt.toml deleted file mode 100644 index 6c50abb84..000000000 --- a/flopy4/mf6/dfns/gwt-mwt.toml +++ /dev/null @@ -1,504 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-mwt" -parent = "gwt-nam" -ftype = "MWT6" -multi = true -subtype = "advanced" - -[dims.auxiliary] -value = "len(auxiliary)" - -[runtime_dims.ncv] -set_in = "ar" - -[blocks.options.fields.flow_package_name] -type = "string" -longname = "keyword to specify name of corresponding flow package" -description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWT name file)." -optional = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.flow_package_auxiliary_name] -type = "string" -longname = "keyword to specify name of concentration auxiliary variable in flow package" -description = "keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated concentrations from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of well cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of well information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_concentration] -type = "keyword" -longname = "print calculated concentrations to listing file" -description = "keyword to indicate that the list of well {#2} will be printed to the listing file for every stress period in which 'CONCENTRATION PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of well flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save well flows to budget file" -description = "keyword to indicate that well flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.concentration_filerecord] -type = "record" -optional = true - -[blocks.options.fields.concentration_filerecord.fields.concentration] -type = "keyword" -longname = "stage keyword" -description = "keyword to specify that record corresponds to concentration." - -[blocks.options.fields.concentration_filerecord.fields.concfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write concentration information." -tagged = false -direction = "out" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the MWT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the MWT package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.dev_nonexpanding_matrix] -type = "keyword" -longname = "do not add rows to the solution matrix" -description = "keyword that solves the feature concentration with a general mixing equation and adds the result to the right-hand side of the GWT equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." -optional = true -developmode = true - -[blocks.packagedata.fields.packagedata] -type = "list" - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.ifno] -type = "integer" -longname = "well number for this entry" -description = "integer value that defines the feature (well) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. Well information must be specified for every well or the program will terminate with an error. The program will also terminate with an error if information for a well is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.strt] -type = "double" -longname = "starting well concentration" -description = "real value that defines the starting concentration for the well." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each well. The values of auxiliary variables must be present for each well. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.packagedata.fields.packagedata.item.fields.boundname] -type = "string" -longname = "well name" -description = "name of the well cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "mwtperioddata" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.ifno] -type = "integer" -longname = "well number for this entry" -description = "integer value that defines the feature (well) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.fields.mwtsetting] -type = "union" -description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the MWTSETTING string include: STATUS, CONCENTRATION, RATE, and AUXILIARY. These settings are used to assign the concentration associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms. For example, the Multi-Aquifer Well Package supports a 'WITHDRAWAL' flow term. If this withdrawal term is active, then water will be withdrawn from the well at the calculated concentration of the well." - -[blocks.period.fields.stress_period_data.item.fields.mwtsetting.arms.status] -type = "string" -longname = "well concentration status" -description = "keyword option to define well status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that concentration will be calculated for the well. If a well is inactive, then there will be no solute mass fluxes into or out of the well and the inactive value will be written for the well concentration. If a well is constant, then the concentration for the well will be fixed at the user specified value." - -[blocks.period.fields.stress_period_data.item.fields.mwtsetting.arms.concentration] -type = "double" -longname = "well concentration" -description = "real or character value that defines the concentration for the well. The specified CONCENTRATION is only applied if the well is a constant concentration well. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.mwtsetting.arms.rate] -type = "double" -longname = "well injection concentration" -description = "real or character value that defines the injection solute concentration $(ML^{-3})$ for the well. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.mwtsetting.arms.auxiliaryrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.mwtsetting.arms.auxiliaryrecord.fields.auxiliary] -type = "keyword" -description = "keyword for specifying auxiliary variable." - -[blocks.period.fields.stress_period_data.item.fields.mwtsetting.arms.auxiliaryrecord.fields.auxname] -type = "string" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.mwtsetting.arms.auxiliaryrecord.fields.auxval] -type = "double" -longname = "auxiliary variable value" -description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.flow_pkg_name] -set_in = "ar" -source = "flow_package_name" -type = "string" - -[memory.fp_aux_name] -set_in = "ar" -source = "flow_package_auxiliary_name" -type = "string" - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprconc] -set_in = "ar" -source = "print_concentration" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.dev_nonexpanding] -set_in = "ar" -source = "dev_nonexpanding_matrix" -type = "logical" - -[memory.packagedata_ifno] -set_in = "ar" -source = "ifno" -type = "integer" - -[memory.period_auxiliary] -set_in = "rp" -source = "auxiliary" -type = "logical" - -[memory.ncv] -readonly = true -set_in = "ar" -description = "Number of control volumes. Assigned from the linked flow package during AR." -type = "integer" - -[memory.strt] -type = "array" -set_in = "ar" -source = "strt" -description = "Starting concentration for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xnewpak] -type = "array" -set_in = "ca" -description = "Current concentration for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xoldpak] -type = "array" -readonly = true -set_in = "ad" -description = "Concentration from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." -dtype = "double" -shape = [ - "ncv", -] - -[memory.ibound] -type = "array" -set_in = "ar" -description = "Boundary activity flag for each control volume." -dtype = "integer" -shape = [ - "ncv", -] - -[memory.concfeat] -type = "array" -readonly = true -set_in = "cq" -description = "Computed concentration for each feature. Set from XNEWPAK after solver convergence." -dtype = "double" -shape = [ - "ncv", -] - -[memory.qsto] -type = "array" -readonly = true -set_in = "cq" -description = "Storage concentration flow contribution for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.concrate] -type = "array" -set_in = "rp" -description = "Pumping-rate concentration for each multi-aquifer well." -dtype = "double" -shape = [ - "ncv", -] - -[observations.concentration] -type = "union" - -[observations.concentration.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.concentration.arms.boundname] -type = "string" -tagged = false - -[observations.storage] -type = "union" - -[observations.storage.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.storage.arms.boundname] -type = "string" -tagged = false - -[observations.constant] -type = "union" - -[observations.constant.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.constant.arms.boundname] -type = "string" -tagged = false - -[observations.from-mvr] -type = "union" - -[observations.from-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.from-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.rate] -type = "union" - -[observations.rate.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.rate.arms.boundname] -type = "string" -tagged = false - -[observations.fw-rate] -type = "union" - -[observations.fw-rate.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.fw-rate.arms.boundname] -type = "string" -tagged = false - -[observations.rate-to-mvr] -type = "union" - -[observations.rate-to-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.rate-to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.fw-rate-to-mvr] -type = "union" - -[observations.fw-rate-to-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.fw-rate-to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.mwt] -type = "union" - -[observations.mwt.arms.ifno_iconn] -type = "record" - -[observations.mwt.arms.ifno_iconn.fields.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.mwt.arms.ifno_iconn.fields.iconn] -type = "integer" -tagged = false -index = true - -[observations.mwt.arms.boundname] -type = "string" -tagged = false diff --git a/flopy4/mf6/dfns/gwt-nam.toml b/flopy4/mf6/dfns/gwt-nam.toml deleted file mode 100644 index 82ea36b17..000000000 --- a/flopy4/mf6/dfns/gwt-nam.toml +++ /dev/null @@ -1,222 +0,0 @@ -type = "model" -schema_version = "2.0.0.dev3" -name = "gwt-nam" -parent = "sim-nam" -ftype = "GWT6" -dependent_variable = "concentration" - -[runtime_dims.nja] -set_in = "ar" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.list] -type = "string" -longname = "name of listing file" -description = "is name of the listing file to create for this GWT model. If not specified, then the name of the list file will be the basename of the GWT model name file and the '.lst' extension. For example, if the GWT name file is called 'my.model.nam' then the list file will be called 'my.model.lst'." -optional = true -case_sensitive = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save flows for all packages to budget file" -description = "keyword to indicate that all model package flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.dependent_variable_scaling] -type = "keyword" -longname = "flag to scale X and RHS" -description = "flag to scale X and RHS to avoid very large positive or negative dependent variable values" -optional = true - -[blocks.options.fields.nc_mesh2d_filerecord] -type = "record" -description = "NetCDF layered mesh fileout record." -optional = true - -[blocks.options.fields.nc_mesh2d_filerecord.fields.netcdf_mesh2d] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to a layered mesh NetCDF file." - -[blocks.options.fields.nc_mesh2d_filerecord.fields.ncmesh2dfile] -type = "file" -longname = "file keyword" -description = "name of the NetCDF ugrid layered mesh output file." -tagged = false -direction = "out" - -[blocks.options.fields.nc_structured_filerecord] -type = "record" -description = "NetCDF structured fileout record." -optional = true - -[blocks.options.fields.nc_structured_filerecord.fields.netcdf_structured] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to a structured NetCDF file." - -[blocks.options.fields.nc_structured_filerecord.fields.ncstructfile] -type = "file" -longname = "file keyword" -description = "name of the NetCDF structured output file." -tagged = false -direction = "out" - -[blocks.options.fields.nc_filerecord] -type = "record" -description = "NetCDF filerecord" -optional = true - -[blocks.options.fields.nc_filerecord.fields.netcdf] -type = "keyword" -longname = "netcdf keyword" -description = "keyword to specify that record corresponds to a NetCDF input file." - -[blocks.options.fields.nc_filerecord.fields.netcdf_filename] -type = "file" -longname = "netcdf input filename" -description = "defines a NetCDF input file." -tagged = false -direction = "in" - -[blocks.packages.fields.packages] -type = "list" -longname = "package list" - -[blocks.packages.fields.packages.item] -name = "packages" -type = "record" - -[blocks.packages.fields.packages.item.fields.ftype] -type = "string" -longname = "package type" -description = "is the file type, which must be one of the following character values shown in table~ref{table:ftype-gwt}. Ftype may be entered in any combination of uppercase and lowercase." -tagged = false - -[blocks.packages.fields.packages.item.fields.fname] -type = "file" -longname = "file name" -description = "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run." -tagged = false -direction = "in" -mode_keyword = false -component = "package" -component_ftype = "ftype" - -[blocks.packages.fields.packages.item.fields.pname] -type = "string" -longname = "user name for package" -description = "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single GWT Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters." -optional = true -tagged = false -pk = true - -[memory.idv_scale] -set_in = "ar" -source = "dependent_variable_scaling" -type = "integer" - -[memory.netcdf_struct] -set_in = "ar" -source = "netcdf_structured" -type = "logical" - -[memory.netcdf_fname] -set_in = "ar" -source = "netcdf_filename" -type = "string" - -[memory.x] -type = "array" -set_in = "ca" -description = "Solute concentration for each model cell. Checked in from the solution-level dependent-variable vector. Initialized by the IC package during AR; updated by the nonlinear solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." -obs_type = "CONCENTRATION" -dtype = "double" -shape = [ - "nodes", -] - -[memory.xold] -type = "array" -readonly = true -set_in = "ad" -description = "Dependent variable from the end of the previous time step. Copied from X at advance (AD); used to restore X if the adaptive time stepping scheme retries a failed time step." -dtype = "double" -shape = [ - "nodes", -] - -[memory.flowja] -type = "array" -readonly = true -set_in = "cq" -description = "Intercell flows in compressed sparse row (CSR) order, calculated after solution convergence. Diagonal entries hold the flow residual." -budget = "FLOW-JA-FACE" -dtype = "double" -shape = [ - "nja", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution for this model, sliced from the solution-level RHS vector. Rebuilt each solver iteration." -dtype = "double" -shape = [ - "nodes", -] - -[memory.ibound] -type = "array" -set_in = "ar" -description = "Cell activity flag: positive values indicate active cells, zero indicates inactive (no-flow) cells. Set during model initialisation; may change when Newton-Raphson wet-dry logic activates or deactivates cells." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.neq] -readonly = true -set_in = "ar" -description = "Number of equations (unknowns) for this model. Equal to the number of active cells (NODES) for standard models." -type = "integer" - -[memory.idxglo] -type = "array" -readonly = true -set_in = "mc" -description = "Maps each local CSR position to the corresponding row/column index in the global solution matrix. Populated during matrix connectivity (MC) and constant thereafter." -dtype = "integer" -shape = [ - "nja", -] - -[observations.concentration] -type = "cellid" -tagged = false - -[observations.flow-ja-face] -type = "record" - -[observations.flow-ja-face.fields.cellid] -type = "cellid" -tagged = false - -[observations.flow-ja-face.fields.cellid2] -type = "cellid" -tagged = false diff --git a/flopy4/mf6/dfns/gwt-oc.toml b/flopy4/mf6/dfns/gwt-oc.toml deleted file mode 100644 index 9f3c046fa..000000000 --- a/flopy4/mf6/dfns/gwt-oc.toml +++ /dev/null @@ -1,212 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-oc" -parent = "gwt-nam" -ftype = "OC6" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the output file to write budget information. Data are written to this file only for time steps in which SAVE BUDGET is specified in a PERIOD block. If SAVE BUDGET is specified in a PERIOD block and this file is not specified, MODFLOW 6 will terminate with an error." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. If specified, a budget summary record will be written to this file for every time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.concentration_filerecord] -type = "record" -optional = true - -[blocks.options.fields.concentration_filerecord.fields.concentration] -type = "keyword" -longname = "concentration keyword" -description = "keyword to specify that record corresponds to concentration." - -[blocks.options.fields.concentration_filerecord.fields.concentrationfile] -type = "file" -longname = "file keyword" -description = "name of the output file to write conc information." -tagged = false -direction = "out" - -[blocks.options.fields.concentrationprintrecord] -type = "record" -optional = true - -[blocks.options.fields.concentrationprintrecord.fields.concentration] -type = "keyword" -longname = "concentration keyword" -description = "keyword to specify that record corresponds to concentration." - -[blocks.options.fields.concentrationprintrecord.fields.print_format] -type = "keyword" -longname = "keyword to indicate that a print format follows" -description = "keyword to specify format for printing to the listing file." - -[blocks.options.fields.concentrationprintrecord.fields.formatrecord] -type = "record" - -[blocks.options.fields.concentrationprintrecord.fields.formatrecord.fields.columns] -type = "integer" -longname = "number of columns" -description = "number of columns for writing data." -optional = true - -[blocks.options.fields.concentrationprintrecord.fields.formatrecord.fields.width] -type = "integer" -longname = "width for each number" -description = "width for writing each number." -optional = true - -[blocks.options.fields.concentrationprintrecord.fields.formatrecord.fields.digits] -type = "integer" -longname = "number of digits" -description = "number of digits to use for writing a number." -optional = true - -[blocks.options.fields.concentrationprintrecord.fields.formatrecord.fields.format] -type = "string" -longname = "write format" -description = "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC." -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" -optional = true - -[blocks.period.fields.stress_period_data.item] -name = "output_record" -type = "union" - -[blocks.period.fields.stress_period_data.item.arms.saverecord] -type = "record" -optional = true - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.save] -type = "keyword" -longname = "keyword to save" -description = "keyword to indicate that information will be saved this stress period." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.rtype] -type = "string" -longname = "record type" -description = "type of information to save or print. Can be BUDGET or CONCENTRATION." -tagged = false -valid = [ - "CONCENTRATION", - "BUDGET", -] - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting] -type = "union" -description = "specifies the steps for which the data will be saved." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.all] -type = "keyword" -description = "keyword to indicate save for all time steps in period." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.first] -type = "keyword" -description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.last] -type = "keyword" -description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.frequency] -type = "integer" -description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.steps] -type = "array" -description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." -dtype = "integer" -shape = [ - "<=nstp", -] - -[blocks.period.fields.stress_period_data.item.arms.printrecord] -type = "record" -optional = true - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.print] -type = "keyword" -longname = "keyword to save" -description = "keyword to indicate that information will be printed this stress period." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.rtype] -type = "string" -longname = "record type" -description = "type of information to save or print. Can be BUDGET or CONCENTRATION." -tagged = false -valid = [ - "CONCENTRATION", - "BUDGET", -] - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting] -type = "union" -description = "specifies the steps for which the data will be saved." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.all] -type = "keyword" -description = "keyword to indicate save for all time steps in period." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.first] -type = "keyword" -description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.last] -type = "keyword" -description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.frequency] -type = "integer" -description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.steps] -type = "array" -description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." -dtype = "integer" -shape = [ - "<=nstp", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.concfile] -set_in = "ar" -source = "concentrationfile" -type = "string" diff --git a/flopy4/mf6/dfns/gwt-sft.toml b/flopy4/mf6/dfns/gwt-sft.toml deleted file mode 100644 index 22337f858..000000000 --- a/flopy4/mf6/dfns/gwt-sft.toml +++ /dev/null @@ -1,609 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-sft" -parent = "gwt-nam" -ftype = "SFT6" -multi = true -subtype = "advanced" - -[dims.auxiliary] -value = "len(auxiliary)" - -[runtime_dims.ncv] -set_in = "ar" - -[blocks.options.fields.flow_package_name] -type = "string" -longname = "keyword to specify name of corresponding flow package" -description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWT name file)." -optional = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.flow_package_auxiliary_name] -type = "string" -longname = "keyword to specify name of concentration auxiliary variable in flow package" -description = "keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated concentrations from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of reach cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of reach information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_concentration] -type = "keyword" -longname = "print calculated concentrations to listing file" -description = "keyword to indicate that the list of reach {#2} will be printed to the listing file for every stress period in which 'CONCENTRATION PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of reach flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save reach flows to budget file" -description = "keyword to indicate that reach flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.concentration_filerecord] -type = "record" -optional = true - -[blocks.options.fields.concentration_filerecord.fields.concentration] -type = "keyword" -longname = "concentration keyword" -description = "keyword to specify that record corresponds to concentration." - -[blocks.options.fields.concentration_filerecord.fields.concfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write concentration information." -tagged = false -direction = "out" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the SFT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SFT package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.dev_nonexpanding_matrix] -type = "keyword" -longname = "do not add rows to the solution matrix" -description = "keyword that solves the feature concentration with a general mixing equation and adds the result to the right-hand side of the GWT equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." -optional = true -developmode = true - -[blocks.packagedata.fields.packagedata] -type = "list" - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.ifno] -type = "integer" -longname = "reach number for this entry" -description = "integer value that defines the feature (reach) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NREACHES. Reach information must be specified for every reach or the program will terminate with an error. The program will also terminate with an error if information for a reach is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.strt] -type = "double" -longname = "starting reach concentration" -description = "real value that defines the starting concentration for the reach." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each reach. The values of auxiliary variables must be present for each reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.packagedata.fields.packagedata.item.fields.boundname] -type = "string" -longname = "well name" -description = "name of the reach cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "reachperioddata" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.ifno] -type = "integer" -longname = "reach number for this entry" -description = "integer value that defines the feature (reach) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NREACHES." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.fields.reachsetting] -type = "union" -description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the REACHSETTING string include: STATUS, CONCENTRATION, RAINFALL, EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign the concentration of associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms. For example, the Streamflow Package supports a 'DIVERSION' flow term. Diversion water will be routed using the calculated concentration of the reach." - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.status] -type = "string" -longname = "reach concentration status" -description = "keyword option to define reach status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that concentration will be calculated for the reach. If a reach is inactive, then there will be no solute mass fluxes into or out of the reach and the inactive value will be written for the reach concentration. If a reach is constant, then the concentration for the reach will be fixed at the user specified value." - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.concentration] -type = "double" -longname = "reach concentration" -description = "real or character value that defines the concentration for the reach. The specified CONCENTRATION is only applied if the reach is a constant concentration reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.rainfall] -type = "double" -longname = "rainfall concentration" -description = "real or character value that defines the rainfall solute concentration $(ML^{-3})$ for the reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.evaporation] -type = "double" -longname = "evaporation concentration" -description = "real or character value that defines the concentration of evaporated water $(ML^{-3})$ for the reach. If this concentration value is larger than the simulated concentration in the reach, then the evaporated water will be removed at the same concentration as the reach. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.runoff] -type = "double" -longname = "runoff concentration" -description = "real or character value that defines the concentration of runoff $(ML^{-3})$ for the reach. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.inflow] -type = "double" -longname = "inflow concentration" -description = "real or character value that defines the concentration of inflow $(ML^{-3})$ for the reach. Value must be greater than or equal to zero. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord.fields.auxiliary] -type = "keyword" -description = "keyword for specifying auxiliary variable." - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord.fields.auxname] -type = "string" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.reachsetting.arms.auxiliaryrecord.fields.auxval] -type = "double" -longname = "auxiliary variable value" -description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.flow_pkg_name] -set_in = "ar" -source = "flow_package_name" -type = "string" - -[memory.fp_aux_name] -set_in = "ar" -source = "flow_package_auxiliary_name" -type = "string" - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprconc] -set_in = "ar" -source = "print_concentration" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.dev_nonexpanding] -set_in = "ar" -source = "dev_nonexpanding_matrix" -type = "logical" - -[memory.packagedata_ifno] -set_in = "ar" -source = "ifno" -type = "integer" - -[memory.period_auxiliary] -set_in = "rp" -source = "auxiliary" -type = "logical" - -[memory.ncv] -readonly = true -set_in = "ar" -description = "Number of control volumes. Assigned from the linked flow package during AR." -type = "integer" - -[memory.strt] -type = "array" -set_in = "ar" -source = "strt" -description = "Starting concentration for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xnewpak] -type = "array" -set_in = "ca" -description = "Current concentration for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xoldpak] -type = "array" -readonly = true -set_in = "ad" -description = "Concentration from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." -dtype = "double" -shape = [ - "ncv", -] - -[memory.ibound] -type = "array" -set_in = "ar" -description = "Boundary activity flag for each control volume." -dtype = "integer" -shape = [ - "ncv", -] - -[memory.concfeat] -type = "array" -readonly = true -set_in = "cq" -description = "Computed concentration for each feature. Set from XNEWPAK after solver convergence." -dtype = "double" -shape = [ - "ncv", -] - -[memory.qsto] -type = "array" -readonly = true -set_in = "cq" -description = "Storage concentration flow contribution for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.concrain] -type = "array" -set_in = "rp" -description = "Rainfall concentration for each reach." -dtype = "double" -shape = [ - "ncv", -] - -[memory.concevap] -type = "array" -set_in = "rp" -description = "Evaporation concentration for each reach." -dtype = "double" -shape = [ - "ncv", -] - -[memory.concroff] -type = "array" -set_in = "rp" -description = "Runoff concentration for each reach." -dtype = "double" -shape = [ - "ncv", -] - -[memory.conciflw] -type = "array" -set_in = "rp" -description = "Inflow concentration for each reach." -dtype = "double" -shape = [ - "ncv", -] - -[memory.vnew] -type = "array" -readonly = true -set_in = "cq" -description = "Reach water volume at the end of the current time step." -dtype = "double" -shape = [ - "ncv", -] - -[memory.vold] -type = "array" -readonly = true -set_in = "ad" -description = "Reach water volume at the start of the current time step." -dtype = "double" -shape = [ - "ncv", -] - -[observations.concentration] -type = "union" - -[observations.concentration.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.concentration.arms.boundname] -type = "string" -tagged = false - -[observations.storage] -type = "union" - -[observations.storage.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.storage.arms.boundname] -type = "string" -tagged = false - -[observations.constant] -type = "union" - -[observations.constant.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.constant.arms.boundname] -type = "string" -tagged = false - -[observations.from-mvr] -type = "union" - -[observations.from-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.from-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.sft] -type = "union" - -[observations.sft.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.sft.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.rainfall] -type = "union" - -[observations.rainfall.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.rainfall.arms.boundname] -type = "string" -tagged = false - -[observations.evaporation] -type = "union" - -[observations.evaporation.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.evaporation.arms.boundname] -type = "string" -tagged = false - -[observations.runoff] -type = "union" - -[observations.runoff.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.runoff.arms.boundname] -type = "string" -tagged = false - -[observations.ext-inflow] -type = "union" - -[observations.ext-inflow.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.ext-inflow.arms.boundname] -type = "string" -tagged = false - -[observations.ext-outflow] -type = "union" - -[observations.ext-outflow.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.ext-outflow.arms.boundname] -type = "string" -tagged = false - -[observations.flow-ja-face] -type = "union" - -[observations.flow-ja-face.arms.ifno_ifno2] -type = "record" - -[observations.flow-ja-face.arms.ifno_ifno2.fields.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.flow-ja-face.arms.ifno_ifno2.fields.ifno2] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.flow-ja-face.arms.boundname] -type = "string" -tagged = false diff --git a/flopy4/mf6/dfns/gwt-src.toml b/flopy4/mf6/dfns/gwt-src.toml deleted file mode 100644 index 566246ff1..000000000 --- a/flopy4/mf6/dfns/gwt-src.toml +++ /dev/null @@ -1,319 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-src" -parent = "gwt-nam" -ftype = "SRC6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of mass loading rate." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of mass source cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of mass source information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of mass source flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save SRC flows to budget file" -description = "keyword to indicate that mass source flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the SRC package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the SRC package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.highest_saturated] -type = "keyword" -longname = "apply source to highest saturated cell" -description = "Apply mass source loading rate to specified CELLID or highest underlying cell with a cell saturation greater than zero. The highest_saturated option has an additional complication for certain types of grids specified using the DISU Package. When the DISU Package is used, a cell may have more than one cell underlying it. If the overlying cell were to become inactive, there is no straightforward method for determining how to apportion the mass source loading rate to the underlying cells. In this case, the approach described by cite{modflowusg} is used. The mass source loading rate is assigned to the first active cell encountered (determined by searching through the underlying cell numbers from the lowest number to the highest number). In this manner, the total mass source loading rate is conserved; however, the spatial distribution of the applied mass source loading rate may not be maintained as layers become dry or wet during a simulation." -optional = true - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of sources" -description = "integer value specifying the maximum number of sources cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.smassrate] -type = "double" -longname = "mass source loading rate" -description = "is the mass source loading rate. A positive value indicates addition of solute mass and a negative value indicates removal of solute mass. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each mass source. The values of auxiliary variables must be present for each mass source. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "source name" -description = "name of the mass source cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.highest_sat] -set_in = "ar" -source = "highest_saturated" -type = "logical" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: smassrate." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "SRC" -output = true -obs_type = "SRC" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "SRC-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.src] -type = "union" - -[observations.src.arms.cellid] -type = "cellid" -tagged = false - -[observations.src.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/gwt-ssm.toml b/flopy4/mf6/dfns/gwt-ssm.toml deleted file mode 100644 index 4ceb2d618..000000000 --- a/flopy4/mf6/dfns/gwt-ssm.toml +++ /dev/null @@ -1,102 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-ssm" -parent = "gwt-nam" -ftype = "SSM6" - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of SSM flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save calculated flows to budget file" -description = "keyword to indicate that SSM flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.sources] -write_if_empty = true - -[blocks.sources.fields.sources] -type = "list" -longname = "package list" - -[blocks.sources.fields.sources.item] -name = "sources" -type = "record" - -[blocks.sources.fields.sources.item.fields.pname] -type = "string" -longname = "package name" -description = "name of the flow package for which an auxiliary variable contains a source concentration. If this flow package is represented using an advanced transport package (SFT, LKT, MWT, or UZT), then the advanced transport package will override SSM terms specified here." -tagged = false -pk = true - -[blocks.sources.fields.sources.item.fields.pname.fk] -path = "gwf-nam.packages.pname" -rule = "flow_model" - -[blocks.sources.fields.sources.item.fields.srctype] -type = "string" -longname = "source type" -description = "keyword indicating how concentration will be assigned for sources and sinks. Keyword must be specified as either AUX or AUXMIXED. For both options the user must provide an auxiliary variable in the corresponding flow package. The auxiliary variable must have the same name as the AUXNAME value that follows. If the AUX keyword is specified, then the auxiliary variable specified by the user will be assigned as the concentration value for groundwater sources (flows with a positive sign). For negative flow rates (sinks), groundwater will be withdrawn from the cell at the simulated concentration of the cell. The AUXMIXED option provides an alternative method for how to determine the concentration of sinks. If the cell concentration is larger than the user-specified auxiliary concentration, then the concentration of groundwater withdrawn from the cell will be assigned as the user-specified concentration. Alternatively, if the user-specified auxiliary concentration is larger than the cell concentration, then groundwater will be withdrawn at the cell concentration. Thus, the AUXMIXED option is designed to work with the Evapotranspiration (EVT) and Recharge (RCH) Packages where water may be withdrawn at a concentration that is less than the cell concentration." -tagged = false - -[blocks.sources.fields.sources.item.fields.auxname] -type = "string" -longname = "auxiliary variable name" -description = "name of the auxiliary variable in the package PNAME. This auxiliary variable must exist and be specified by the user in that package. The values in this auxiliary variable will be used to set the concentration associated with the flows for that boundary package." -tagged = false - -[blocks.fileinput.fields.fileinput] -type = "list" -optional = true - -[blocks.fileinput.fields.fileinput.item] -name = "fileinput" -type = "record" - -[blocks.fileinput.fields.fileinput.item.fields.pname] -type = "string" -longname = "package name" -description = "name of the flow package for which an SPC6 input file contains a source concentration. If this flow package is represented using an advanced transport package (SFT, LKT, MWT, or UZT), then the advanced transport package will override SSM terms specified here." -tagged = false -pk = true - -[blocks.fileinput.fields.fileinput.item.fields.pname.fk] -path = "gwf-nam.packages.pname" -rule = "flow_model" - -[blocks.fileinput.fields.fileinput.item.fields.spc6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a source sink mixing input file." - -[blocks.fileinput.fields.fileinput.item.fields.spc6_filename] -type = "file" -longname = "spc file name" -description = "character string that defines the path and filename for the file containing source and sink input data for the flow package. The SPC6_FILENAME file is a flexible input file that allows concentrations to be specified by stress period and with time series. Instructions for creating the SPC6_FILENAME input file are provided in the next section on file input for boundary concentrations." -tagged = false -direction = "in" -component = [ - "utl-spc", - "utl-spca", -] - -[blocks.fileinput.fields.fileinput.item.fields.mixed] -type = "keyword" -longname = "mixed keyword" -description = "keyword to specify that these stress package boundaries will have the mixed condition. The MIXED condition is described in the SOURCES block for AUXMIXED. The MIXED condition allows for water to be withdrawn at a concentration that is less than the cell concentration. It is intended primarily for representing evapotranspiration." -optional = true - -[memory.pname_sources] -source = "pname" -type = "string" - -[keys] -source = [ - "sources.pname", - "fileinput.pname", -] diff --git a/flopy4/mf6/dfns/gwt-uzt.toml b/flopy4/mf6/dfns/gwt-uzt.toml deleted file mode 100644 index 3c262e01e..000000000 --- a/flopy4/mf6/dfns/gwt-uzt.toml +++ /dev/null @@ -1,533 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "gwt-uzt" -parent = "gwt-nam" -ftype = "UZT6" -multi = true -subtype = "advanced" - -[dims.auxiliary] -value = "len(auxiliary)" - -[runtime_dims.ncv] -set_in = "ar" - -[blocks.options.fields.flow_package_name] -type = "string" -longname = "keyword to specify name of corresponding flow package" -description = "keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWT name file)." -optional = true - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.flow_package_auxiliary_name] -type = "string" -longname = "keyword to specify name of concentration auxiliary variable in flow package" -description = "keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated concentrations from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of unsaturated zone flow cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of unsaturated zone flow information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_concentration] -type = "keyword" -longname = "print calculated concentrations to listing file" -description = "keyword to indicate that the list of UZF cell {#2} will be printed to the listing file for every stress period in which 'CONCENTRATION PRINT' is specified in Output Control. If there is no Output Control option and PRINT_{#3} is specified, then {#2} are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of unsaturated zone flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save UZT cell flows to budget file" -description = "keyword to indicate that unsaturated zone flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.concentration_filerecord] -type = "record" -optional = true - -[blocks.options.fields.concentration_filerecord.fields.concentration] -type = "keyword" -longname = "stage keyword" -description = "keyword to specify that record corresponds to concentration." - -[blocks.options.fields.concentration_filerecord.fields.concfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write concentration information." -tagged = false -direction = "out" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write budget information." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the UZT package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the UZT package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.dev_nonexpanding_matrix] -type = "keyword" -longname = "do not add rows to the solution matrix" -description = "keyword that solves the feature concentration with a general mixing equation and adds the result to the right-hand side of the GWT equations, instead of adding a row to the solution matrix for each feature. This development option is not supported." -optional = true -developmode = true - -[blocks.packagedata.fields.packagedata] -type = "list" - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.ifno] -type = "integer" -longname = "UZF cell number for this entry" -description = "integer value that defines the feature (UZF object) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NUZFCELLS. Unsaturated zone flow information must be specified for every UZF cell or the program will terminate with an error. The program will also terminate with an error if information for a UZF cell is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.strt] -type = "double" -longname = "starting UZF cell concentration" -description = "real value that defines the starting concentration for the unsaturated zone flow cell." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each unsaturated zone flow. The values of auxiliary variables must be present for each unsaturated zone flow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.packagedata.fields.packagedata.item.fields.boundname] -type = "string" -longname = "UZF cell name" -description = "name of the unsaturated zone flow cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "uztperioddata" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.ifno] -type = "integer" -longname = "unsaturated zone flow cell number for this entry" -description = "integer value that defines the feature (UZF object) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NUZFCELLS." -tagged = false -index = true -fk = "packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.fields.uztsetting] -type = "union" -description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the UZTSETTING string include: STATUS, CONCENTRATION, INFILTRATION, UZET, and AUXILIARY. These settings are used to assign the concentration of associated with the corresponding flow terms. Concentrations cannot be specified for all flow terms." - -[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.status] -type = "string" -longname = "unsaturated zone flow cell concentration status" -description = "keyword option to define UZF cell status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that concentration will be calculated for the UZF cell. If a UZF cell is inactive, then there will be no solute mass fluxes into or out of the UZF cell and the inactive value will be written for the UZF cell concentration. If a UZF cell is constant, then the concentration for the UZF cell will be fixed at the user specified value." - -[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.concentration] -type = "double" -longname = "unsaturated zone flow cell concentration" -description = "real or character value that defines the concentration for the unsaturated zone flow cell. The specified CONCENTRATION is only applied if the unsaturated zone flow cell is a constant concentration cell. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.infiltration] -type = "double" -longname = "infiltration concentration" -description = "real or character value that defines the infiltration solute concentration $(ML^{-3})$ for the UZF cell. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.uzet] -type = "double" -longname = "unsaturated zone et concentration" -description = "real or character value that defines the concentration of unsaturated zone evapotranspiration water $(ML^{-3})$ for the UZF cell. If this concentration value is larger than the simulated concentration in the UZF cell, then the unsaturated zone ET water will be removed at the same concentration as the UZF cell. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.auxiliaryrecord] -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.auxiliaryrecord.fields.auxiliary] -type = "keyword" -description = "keyword for specifying auxiliary variable." - -[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.auxiliaryrecord.fields.auxname] -type = "string" -description = "name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.uztsetting.arms.auxiliaryrecord.fields.auxval] -type = "double" -longname = "auxiliary variable value" -description = "value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.flow_pkg_name] -set_in = "ar" -source = "flow_package_name" -type = "string" - -[memory.fp_aux_name] -set_in = "ar" -source = "flow_package_auxiliary_name" -type = "string" - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprconc] -set_in = "ar" -source = "print_concentration" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.dev_nonexpanding] -set_in = "ar" -source = "dev_nonexpanding_matrix" -type = "logical" - -[memory.packagedata_ifno] -set_in = "ar" -source = "ifno" -type = "integer" - -[memory.period_auxiliary] -set_in = "rp" -source = "auxiliary" -type = "logical" - -[memory.ncv] -readonly = true -set_in = "ar" -description = "Number of control volumes. Assigned from the linked flow package during AR." -type = "integer" - -[memory.strt] -type = "array" -set_in = "ar" -source = "strt" -description = "Starting concentration for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xnewpak] -type = "array" -set_in = "ca" -description = "Current concentration for each control volume. Initialized from STRT during AR; updated by the solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." -dtype = "double" -shape = [ - "ncv", -] - -[memory.xoldpak] -type = "array" -readonly = true -set_in = "ad" -description = "Concentration from the end of the previous time step. Copied from XNEWPAK at the start of advance (AD)." -dtype = "double" -shape = [ - "ncv", -] - -[memory.ibound] -type = "array" -set_in = "ar" -description = "Boundary activity flag for each control volume." -dtype = "integer" -shape = [ - "ncv", -] - -[memory.concfeat] -type = "array" -readonly = true -set_in = "cq" -description = "Computed concentration for each feature. Set from XNEWPAK after solver convergence." -dtype = "double" -shape = [ - "ncv", -] - -[memory.qsto] -type = "array" -readonly = true -set_in = "cq" -description = "Storage concentration flow contribution for each control volume." -dtype = "double" -shape = [ - "ncv", -] - -[memory.concinfl] -type = "array" -set_in = "rp" -description = "Infiltration concentration for each UZF cell." -dtype = "double" -shape = [ - "ncv", -] - -[memory.concuzet] -type = "array" -set_in = "rp" -description = "ET concentration for each UZF cell." -dtype = "double" -shape = [ - "ncv", -] - -[observations.concentration] -type = "union" - -[observations.concentration.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.concentration.arms.boundname] -type = "string" -tagged = false - -[observations.storage] -type = "union" - -[observations.storage.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.storage.arms.boundname] -type = "string" -tagged = false - -[observations.constant] -type = "union" - -[observations.constant.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.constant.arms.boundname] -type = "string" -tagged = false - -[observations.from-mvr] -type = "union" - -[observations.from-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.from-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.uzt] -type = "union" - -[observations.uzt.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.uzt.arms.boundname] -type = "string" -tagged = false - -[observations.infiltration] -type = "union" - -[observations.infiltration.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.infiltration.arms.boundname] -type = "string" -tagged = false - -[observations.rej-inf] -type = "union" - -[observations.rej-inf.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.rej-inf.arms.boundname] -type = "string" -tagged = false - -[observations.uzet] -type = "union" - -[observations.uzet.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.uzet.arms.boundname] -type = "string" -tagged = false - -[observations.rej-inf-to-mvr] -type = "union" - -[observations.rej-inf-to-mvr.arms.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.rej-inf-to-mvr.arms.boundname] -type = "string" -tagged = false - -[observations.flow-ja-face] -type = "union" - -[observations.flow-ja-face.arms.ifno_ifno2] -type = "record" - -[observations.flow-ja-face.arms.ifno_ifno2.fields.ifno] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.flow-ja-face.arms.ifno_ifno2.fields.ifno2] -type = "integer" -tagged = false -index = true -fk = "packagedata.ifno" - -[observations.flow-ja-face.arms.boundname] -type = "string" -tagged = false diff --git a/flopy4/mf6/dfns/olf-cdb.toml b/flopy4/mf6/dfns/olf-cdb.toml deleted file mode 100644 index 07de862e2..000000000 --- a/flopy4/mf6/dfns/olf-cdb.toml +++ /dev/null @@ -1,288 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "olf-cdb" -parent = "olf-nam" -ftype = "CDB6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of critical depth boundary cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of critical depth boundary information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of critical depth boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save flows to budget file" -description = "keyword to indicate that critical depth boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the CDB package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CDB package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of critical depth boundaries" -description = "integer value specifying the maximum number of critical depth boundary cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.idcxs] -type = "integer" -longname = "cross section identifier" -description = "is the identifier for the cross section specified in the CXS Package. A value of zero indicates the zero-depth-gradient calculation will use parameters for a hydraulically wide channel." -tagged = false -index = true - -[blocks.period.fields.stress_period_data.item.fields.width] -type = "double" -longname = "width of the zero-depth gradient boundary" -description = "is the channel width of the zero-depth gradient boundary. If a cross section is associated with this boundary, the width will be scaled by the cross section information. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "zero-depth-gradient boundary name" -description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: idcxs, 1: width." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "CDB" -output = true -obs_type = "CDB" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "CDB-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.cdb] -type = "union" - -[observations.cdb.arms.cellid] -type = "cellid" -tagged = false - -[observations.cdb.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/olf-chd.toml b/flopy4/mf6/dfns/olf-chd.toml deleted file mode 100644 index 0f453b42d..000000000 --- a/flopy4/mf6/dfns/olf-chd.toml +++ /dev/null @@ -1,295 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "olf-chd" -parent = "olf-nam" -ftype = "CHD6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of CHD head value." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of constant-head cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of constant-head information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print CHD flows to listing file" -description = "keyword to indicate that the list of constant-head flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save CHD flows to budget file" -description = "keyword to indicate that constant-head flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the CHD package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the CHD package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of constant heads" -description = "integer value specifying the maximum number of constant-head cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.head] -type = "double" -longname = "head value assigned to constant head" -description = "is the head at the boundary. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each constant head. The values of auxiliary variables must be present for each constant head. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "constant head boundary name" -description = "name of the constant head boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: head." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "CHD" -output = true -obs_type = "CHD" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.chd] -type = "union" - -[observations.chd.arms.cellid] -type = "cellid" -tagged = false - -[observations.chd.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/olf-dfw.toml b/flopy4/mf6/dfns/olf-dfw.toml deleted file mode 100644 index fe71fd5fb..000000000 --- a/flopy4/mf6/dfns/olf-dfw.toml +++ /dev/null @@ -1,159 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "olf-dfw" -parent = "olf-nam" -ftype = "DFW6" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.central_in_space] -type = "keyword" -longname = "use central in space weighting" -description = "keyword to indicate conductance should be calculated using central-in-space weighting instead of the default upstream weighting approach. This option should be used with caution as it does not work well unless all of the stream reaches are saturated. With this option, there is no way for water to flow into a dry reach from connected reaches." -optional = true - -[blocks.options.fields.length_conversion] -type = "double" -longname = "length conversion factor" -description = "real value that is used to convert user-specified Manning's roughness coefficients from meters to model length units. LENGTH_CONVERSION should be set to 3.28081, 1.0, and 100.0 when using length units (LENGTH_UNITS) of feet, meters, or centimeters in the simulation, respectively. LENGTH_CONVERSION does not need to be specified if LENGTH_UNITS are meters." -optional = true - -[blocks.options.fields.time_conversion] -type = "double" -longname = "time conversion factor" -description = "real value that is used to convert user-specified Manning's roughness coefficients from seconds to model time units. TIME_CONVERSION should be set to 1.0, 60.0, 3,600.0, 86,400.0, and 31,557,600.0 when using time units (TIME_UNITS) of seconds, minutes, hours, days, or years in the simulation, respectively. TIME_CONVERSION does not need to be specified if TIME_UNITS are seconds." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "keyword to save DFW flows" -description = "keyword to indicate that budget flow terms will be written to the file specified with 'BUDGET SAVE FILE' in Output Control." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "keyword to print DFW flows to listing file" -description = "keyword to indicate that calculated flows between cells will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period. This option can produce extremely large list files because all cell-by-cell flows are printed. It should only be used with the DFW Package for models that have a small number of cells." -optional = true - -[blocks.options.fields.save_velocity] -type = "keyword" -longname = "keyword to save velocity" -description = "keyword to indicate that x, y, and z components of velocity will be calculated at cell centers and written to the budget file, which is specified with 'BUDGET SAVE FILE' in Output Control. If this option is activated, then additional information may be required in the discretization packages and the GWF Exchange package (if GWF models are coupled). Specifically, ANGLDEGX must be specified in the CONNECTIONDATA block of the DISU Package; ANGLDEGX must also be specified for the GWF Exchange as an auxiliary variable." -optional = true - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the DFW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the DFW package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.dev_swr_conductance] -type = "keyword" -longname = "use SWR conductance formulation" -description = "use the conductance formulation in the Surface Water Routing (SWR) Process for MODFLOW-2005." -optional = true -developmode = true - -[blocks.griddata.fields.manningsn] -type = "array" -longname = "mannings roughness coefficient" -description = "mannings roughness coefficient" -optional = true -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.idcxs] -type = "array" -longname = "cross section number" -description = "integer value indication the cross section identifier in the Cross Section Package that applies to the reach. If not provided then reach will be treated as hydraulically wide." -optional = true -dtype = "integer" -index = true -fk = "chf-cxs.packagedata.ifno" -shape = [ - "nodes", -] - -[memory.icentral] -set_in = "ar" -source = "central_in_space" -type = "integer" - -[memory.lengthconv] -set_in = "ar" -source = "length_conversion" -type = "double" - -[memory.timeconv] -set_in = "ar" -source = "time_conversion" -type = "double" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.isavvelocity] -set_in = "ar" -source = "save_velocity" -type = "integer" - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.iswrcond] -set_in = "ar" -source = "dev_swr_conductance" -type = "integer" - -[memory.manningsn] -type = "array" -set_in = "ar" -source = "manningsn" -dtype = "double" -shape = [ - "nodes", -] - -[memory.idcxs] -type = "array" -set_in = "ar" -source = "idcxs" -dtype = "integer" -shape = [ - "nodes", -] - -[observations.ext-outflow] -type = "integer" -tagged = false -index = true diff --git a/flopy4/mf6/dfns/olf-dis2d.toml b/flopy4/mf6/dfns/olf-dis2d.toml deleted file mode 100644 index 7477d9de2..000000000 --- a/flopy4/mf6/dfns/olf-dis2d.toml +++ /dev/null @@ -1,217 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "olf-dis2d" -parent = "olf-nam" -ftype = "DIS2D6" - -[dims.nrow] -value = "nrow" -scope = "model" - -[dims.ncol] -value = "ncol" -scope = "model" - -[dims.ncpl] -value = "nrow * ncol" -scope = "model" - -[dims.nodes] -value = "nrow * ncol" -scope = "model" - -[dims.ncelldim] -value = "2" -scope = "model" - -[runtime_dims.nodes] -set_in = "ar" - -[runtime_dims.nodesuser] -set_in = "ar" - -[blocks.options.fields.length_units] -type = "string" -longname = "model length units" -description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." -optional = true - -[blocks.options.fields.nogrb] -type = "keyword" -longname = "do not write binary grid file" -description = "keyword to deactivate writing of the binary grid file." -optional = true - -[blocks.options.fields.grb_filerecord] -type = "record" -optional = true - -[blocks.options.fields.grb_filerecord.fields.grb6] -type = "keyword" -longname = "grb keyword" -description = "keyword to specify that record corresponds to a binary grid file." - -[blocks.options.fields.grb_filerecord.fields.grb6_filename] -type = "file" -longname = "file name of GRB information" -description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." -tagged = false -direction = "out" - -[blocks.options.fields.xorigin] -type = "double" -longname = "x-position of the model grid origin" -description = "x-position of the lower-left corner of the model grid. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.yorigin] -type = "double" -longname = "y-position of the model grid origin" -description = "y-position of the lower-left corner of the model grid. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.angrot] -type = "double" -longname = "rotation angle" -description = "counter-clockwise rotation angle (in degrees) of the lower-left corner of the model grid. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.crs] -type = "string" -longname = "CRS user input string" -description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true -case_sensitive = true - -[blocks.dimensions.fields.nrow] -type = "integer" -longname = "number of rows" -description = "is the number of rows in the model grid." -default = 2 - -[blocks.dimensions.fields.ncol] -type = "integer" -longname = "number of columns" -description = "is the number of columns in the model grid." -default = 2 - -[blocks.griddata.fields.delr] -type = "array" -longname = "spacing along a row" -description = "is the column spacing in the row direction." -default = 1.0 -dtype = "double" -shape = [ - "ncol", -] - -[blocks.griddata.fields.delc] -type = "array" -longname = "spacing along a column" -description = "is the row spacing in the column direction." -default = 1.0 -dtype = "double" -shape = [ - "nrow", -] - -[blocks.griddata.fields.bottom] -type = "array" -longname = "cell bottom elevation" -description = "is the bottom elevation for each cell." -default = 0.0 -dtype = "double" -shape = [ - "ncol", - "nrow", -] - -[blocks.griddata.fields.idomain] -type = "array" -longname = "idomain existence array" -description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." -optional = true -dtype = "integer" -shape = [ - "ncol", - "nrow", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.nrow] -set_in = "ar" -source = "nrow" -type = "integer" - -[memory.ncol] -set_in = "ar" -source = "ncol" -type = "integer" - -[memory.delr] -type = "array" -set_in = "ar" -source = "delr" -dtype = "double" -shape = [ - "ncol", -] - -[memory.delc] -type = "array" -set_in = "ar" -source = "delc" -dtype = "double" -shape = [ - "nrow", -] - -[memory.bottom] -type = "array" -set_in = "ar" -source = "bottom" -dtype = "double" -shape = [ - "ncol", - "nrow", -] - -[memory.idomain] -type = "array" -set_in = "ar" -source = "idomain" -dtype = "integer" -shape = [ - "ncol", - "nrow", -] - -[memory.nodeuser] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodereduced] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." -dtype = "integer" -shape = [ - "nodesuser", -] diff --git a/flopy4/mf6/dfns/olf-disv1d.toml b/flopy4/mf6/dfns/olf-disv1d.toml deleted file mode 100644 index 6f0c20549..000000000 --- a/flopy4/mf6/dfns/olf-disv1d.toml +++ /dev/null @@ -1,277 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "olf-disv1d" -parent = "olf-nam" -ftype = "DISV1D6" - -[dims.nodes] -value = "nodes" -scope = "model" - -[dims.nvert] -value = "nvert" -scope = "model" - -[dims.ncelldim] -value = "1" -scope = "model" - -[runtime_dims.nodes] -set_in = "ar" - -[runtime_dims.nodesuser] -set_in = "ar" - -[blocks.options.fields.length_units] -type = "string" -longname = "model length units" -description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." -optional = true - -[blocks.options.fields.nogrb] -type = "keyword" -longname = "do not write binary grid file" -description = "keyword to deactivate writing of the binary grid file." -optional = true - -[blocks.options.fields.grb_filerecord] -type = "record" -optional = true - -[blocks.options.fields.grb_filerecord.fields.grb6] -type = "keyword" -longname = "grb keyword" -description = "keyword to specify that record corresponds to a binary grid file." - -[blocks.options.fields.grb_filerecord.fields.grb6_filename] -type = "file" -longname = "file name of GRB information" -description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." -tagged = false -direction = "out" - -[blocks.options.fields.xorigin] -type = "double" -longname = "x-position origin of the model grid coordinate system" -description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.yorigin] -type = "double" -longname = "y-position origin of the model grid coordinate system" -description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.angrot] -type = "double" -longname = "rotation angle" -description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.crs] -type = "string" -longname = "CRS user input string" -description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true -case_sensitive = true - -[blocks.dimensions.fields.nodes] -type = "integer" -longname = "number of linear features" -description = "is the number of linear cells." - -[blocks.dimensions.fields.nvert] -type = "integer" -longname = "number of vertices" -description = "is the total number of (x, y, z) vertex pairs used to characterize the model grid." -optional = true - -[blocks.griddata.fields.length] -type = "array" -longname = "length" -description = "length for each one-dimensional cell" -optional = true -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.width] -type = "array" -longname = "width" -description = "real value that defines the width for each one-dimensional cell. WIDTH must be greater than zero. If the Cross Section (CXS) Package is used, then the WIDTH value will be multiplied by the specified cross section x-fraction values." -optional = true -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.bottom] -type = "array" -longname = "bottom elevation for the one-dimensional cell" -description = "bottom elevation for the one-dimensional cell." -optional = true -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.idomain] -type = "array" -longname = "idomain existence array" -description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation." -optional = true -dtype = "integer" -shape = [ - "nodes", -] - -[blocks.vertices.fields.vertices] -type = "list" -longname = "vertices data" -shape = [ - "nvert", -] - -[blocks.vertices.fields.vertices.item] -name = "vertices" -type = "record" - -[blocks.vertices.fields.vertices.item.fields.iv] -type = "integer" -longname = "vertex number" -description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." -tagged = false -index = true -pk = true - -[blocks.vertices.fields.vertices.item.fields.xv] -type = "double" -longname = "x-coordinate for vertex" -description = "is the x-coordinate for the vertex." -tagged = false - -[blocks.vertices.fields.vertices.item.fields.yv] -type = "double" -longname = "y-coordinate for vertex" -description = "is the y-coordinate for the vertex." -tagged = false - -[blocks.cell2d.fields.cell2d] -type = "list" -longname = "cell2d data" -shape = [ - "nodes", -] - -[blocks.cell2d.fields.cell2d.item] -name = "cell2d" -type = "record" - -[blocks.cell2d.fields.cell2d.item.fields.icell2d] -type = "integer" -longname = "cell2d number" -description = "is the cell2d number. Records in the cell2d block must be listed in consecutive order from the first to the last." -tagged = false -index = true -pk = true - -[blocks.cell2d.fields.cell2d.item.fields.fdc] -type = "double" -longname = "fractional distance to the cell center" -description = "is the fractional distance to the cell center. FDC is relative to the first vertex in the ICVERT array. In most cases FDC should be 0.5, which would place the center of the line segment that defines the cell. If the value of FDC is 1, the cell center would located at the last vertex. FDC values of 0 and 1 can be used to place the node at either end of the cell which can be useful for cells with boundary conditions." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.ncvert] -type = "integer" -longname = "number of cell vertices" -description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.icvert] -type = "array" -longname = "number of cell vertices" -description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in the order that defines the line representing the cell. Cells that are connected must share vertices. The bottom elevation of the cell is calculated using the ZV of the first and last vertex point and FDC." -tagged = false -dtype = "integer" -index = true -shape = [ - "ncvert", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.nodes] -set_in = "ar" -source = "nodes" -type = "integer" - -[memory.nvert] -set_in = "ar" -source = "nvert" -type = "integer" - -[memory.length] -type = "array" -set_in = "ar" -source = "length" -dtype = "double" -shape = [ - "nodes", -] - -[memory.width] -type = "array" -set_in = "ar" -source = "width" -dtype = "double" -shape = [ - "nodes", -] - -[memory.bottom] -type = "array" -set_in = "ar" -source = "bottom" -dtype = "double" -shape = [ - "nodes", -] - -[memory.idomain] -type = "array" -set_in = "ar" -source = "idomain" -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodeuser] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodereduced] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." -dtype = "integer" -shape = [ - "nodesuser", -] diff --git a/flopy4/mf6/dfns/olf-disv2d.toml b/flopy4/mf6/dfns/olf-disv2d.toml deleted file mode 100644 index 396bbd0c8..000000000 --- a/flopy4/mf6/dfns/olf-disv2d.toml +++ /dev/null @@ -1,243 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "olf-disv2d" -parent = "olf-nam" -ftype = "DISV2D6" - -[dims.nodes] -value = "nodes" -scope = "model" - -[dims.nvert] -value = "nvert" -scope = "model" - -[dims.ncelldim] -value = "1" -scope = "model" - -[runtime_dims.nodes] -set_in = "ar" - -[runtime_dims.nodesuser] -set_in = "ar" - -[blocks.options.fields.length_units] -type = "string" -longname = "model length units" -description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." -optional = true - -[blocks.options.fields.nogrb] -type = "keyword" -longname = "do not write binary grid file" -description = "keyword to deactivate writing of the binary grid file." -optional = true - -[blocks.options.fields.grb_filerecord] -type = "record" -optional = true - -[blocks.options.fields.grb_filerecord.fields.grb6] -type = "keyword" -longname = "grb keyword" -description = "keyword to specify that record corresponds to a binary grid file." - -[blocks.options.fields.grb_filerecord.fields.grb6_filename] -type = "file" -longname = "file name of GRB information" -description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." -tagged = false -direction = "out" - -[blocks.options.fields.xorigin] -type = "double" -longname = "x-position of the model grid origin" -description = "x-position of the lower-left corner of the model grid. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.yorigin] -type = "double" -longname = "y-position of the model grid origin" -description = "y-position of the lower-left corner of the model grid. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.angrot] -type = "double" -longname = "rotation angle" -description = "counter-clockwise rotation angle (in degrees) of the lower-left corner of the model grid. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.crs] -type = "string" -longname = "CRS user input string" -description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true -case_sensitive = true - -[blocks.dimensions.fields.nodes] -type = "integer" -longname = "number of cells per layer" -description = "is the number of cells per layer. This is a constant value for the grid and it applies to all layers." - -[blocks.dimensions.fields.nvert] -type = "integer" -longname = "number of vertices" -description = "is the total number of (x, y) vertex pairs used to characterize the horizontal configuration of the model grid." - -[blocks.griddata.fields.bottom] -type = "array" -longname = "model bottom elevation" -description = "is the bottom elevation for each cell." -dtype = "double" -shape = [ - "nodes", -] - -[blocks.griddata.fields.idomain] -type = "array" -longname = "idomain existence array" -description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1 or greater, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." -optional = true -dtype = "integer" -shape = [ - "nodes", -] - -[blocks.vertices.fields.vertices] -type = "list" -longname = "vertices data" -shape = [ - "nvert", -] - -[blocks.vertices.fields.vertices.item] -name = "vertices" -type = "record" - -[blocks.vertices.fields.vertices.item.fields.iv] -type = "integer" -longname = "vertex number" -description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." -tagged = false -index = true -pk = true - -[blocks.vertices.fields.vertices.item.fields.xv] -type = "double" -longname = "x-coordinate for vertex" -description = "is the x-coordinate for the vertex." -tagged = false - -[blocks.vertices.fields.vertices.item.fields.yv] -type = "double" -longname = "y-coordinate for vertex" -description = "is the y-coordinate for the vertex." -tagged = false - -[blocks.cell2d.fields.cell2d] -type = "list" -longname = "cell2d data" -shape = [ - "nodes", -] - -[blocks.cell2d.fields.cell2d.item] -name = "cell2d" -type = "record" - -[blocks.cell2d.fields.cell2d.item.fields.icell2d] -type = "integer" -longname = "cell2d number" -description = "is the CELL2D number. Records in the CELL2D block must be listed in consecutive order from the first to the last." -tagged = false -index = true -pk = true - -[blocks.cell2d.fields.cell2d.item.fields.xc] -type = "double" -longname = "x-coordinate for cell center" -description = "is the x-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.yc] -type = "double" -longname = "y-coordinate for cell center" -description = "is the y-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.ncvert] -type = "integer" -longname = "number of cell vertices" -description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.icvert] -type = "array" -longname = "array of vertex numbers" -description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." -tagged = false -dtype = "integer" -index = true -shape = [ - "ncvert", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.nodes] -set_in = "ar" -source = "nodes" -type = "integer" - -[memory.nvert] -set_in = "ar" -source = "nvert" -type = "integer" - -[memory.bottom] -type = "array" -set_in = "ar" -source = "bottom" -dtype = "double" -shape = [ - "nodes", -] - -[memory.idomain] -type = "array" -set_in = "ar" -source = "idomain" -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodeuser] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodereduced] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." -dtype = "integer" -shape = [ - "nodesuser", -] diff --git a/flopy4/mf6/dfns/olf-evp.toml b/flopy4/mf6/dfns/olf-evp.toml deleted file mode 100644 index c58e1bb49..000000000 --- a/flopy4/mf6/dfns/olf-evp.toml +++ /dev/null @@ -1,295 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "olf-evp" -parent = "olf-nam" -ftype = "EVP6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of evaporation." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of evaporation cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of evaporation information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print evaporation rates to listing file" -description = "keyword to indicate that the list of evaporation flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save evaporation to budget file" -description = "keyword to indicate that evaporation flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the EVP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the EVP package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of evaporation cells" -description = "integer value specifying the maximum number of evaporation cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.evaporation] -type = "double" -longname = "evaporation rate" -description = "is the evaporation flux rate ($LT^{-1}$). This rate is multiplied inside the program by the water surface area of the cell to calculate the volumetric evaporation rate. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each evaporation. The values of auxiliary variables must be present for each evaporation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "evaporation name" -description = "name of the evaporation cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: evaporation." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "EVP" -output = true -obs_type = "EVP" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.evp] -type = "union" - -[observations.evp.arms.cellid] -type = "cellid" -tagged = false - -[observations.evp.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/olf-flw.toml b/flopy4/mf6/dfns/olf-flw.toml deleted file mode 100644 index 14e2edd7b..000000000 --- a/flopy4/mf6/dfns/olf-flw.toml +++ /dev/null @@ -1,308 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "olf-flw" -parent = "olf-nam" -ftype = "FLW6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of flow rate." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of inflow cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of inflow information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of inflow flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save well flows to budget file" -description = "keyword to indicate that inflow flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the FLW package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the FLW package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of inflow" -description = "integer value specifying the maximum number of inflow cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.q] -type = "double" -longname = "flow rate" -description = "is the volumetric inflow rate. A positive value indicates inflow to the stream. Negative values are not allowed. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each inflow. The values of auxiliary variables must be present for each inflow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "inflow name" -description = "name of the inflow cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: q." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "FLW" -output = true -obs_type = "FLW" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "FLW-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.flw] -type = "union" - -[observations.flw.arms.cellid] -type = "cellid" -tagged = false - -[observations.flw.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/olf-ic.toml b/flopy4/mf6/dfns/olf-ic.toml deleted file mode 100644 index a80042d0a..000000000 --- a/flopy4/mf6/dfns/olf-ic.toml +++ /dev/null @@ -1,39 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "olf-ic" -parent = "olf-nam" -ftype = "IC6" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.griddata.fields.strt] -type = "array" -longname = "starting concentration" -description = "is the initial (starting) stage---that is, stage at the beginning of the OLF Model simulation. STRT must be specified for all OLF Model simulations. One value is read for every model reach." -default = 0.0 -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.strt] -type = "array" -set_in = "ar" -source = "strt" -dtype = "double" -shape = [ - "nodes", -] diff --git a/flopy4/mf6/dfns/olf-nam.toml b/flopy4/mf6/dfns/olf-nam.toml deleted file mode 100644 index 81aa4240e..000000000 --- a/flopy4/mf6/dfns/olf-nam.toml +++ /dev/null @@ -1,167 +0,0 @@ -type = "model" -schema_version = "2.0.0.dev3" -name = "olf-nam" -parent = "sim-nam" -ftype = "OLF6" -dependent_variable = "stage" - -[runtime_dims.nja] -set_in = "ar" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.list] -type = "string" -longname = "name of listing file" -description = "is name of the listing file to create for this OLF model. If not specified, then the name of the list file will be the basename of the OLF model name file and the '.lst' extension. For example, if the OLF name file is called 'my.model.nam' then the list file will be called 'my.model.lst'." -optional = true -case_sensitive = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save flows for all packages to budget file" -description = "keyword to indicate that all model package flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.newtonoptions] -type = "record" -longname = "newton keyword and options" -description = "none" -optional = true - -[blocks.options.fields.newtonoptions.fields.newton] -type = "keyword" -longname = "keyword to activate Newton-Raphson formulation" -description = "keyword that activates the Newton-Raphson formulation for surface water flow between connected reaches and stress packages that support calculation of Newton-Raphson terms." - -[blocks.options.fields.newtonoptions.fields.under_relaxation] -type = "keyword" -longname = "keyword to activate Newton-Raphson UNDER_RELAXATION option" -description = "keyword that indicates whether the surface water stage in a reach will be under-relaxed when water levels fall below the bottom of the model below any given cell. By default, Newton-Raphson UNDER_RELAXATION is not applied." -optional = true - -[blocks.packages.fields.packages] -type = "list" -longname = "package list" - -[blocks.packages.fields.packages.item] -name = "packages" -type = "record" - -[blocks.packages.fields.packages.item.fields.ftype] -type = "string" -longname = "package type" -description = "is the file type, which must be one of the following character values shown in table~ref{table:ftype-olf}. Ftype may be entered in any combination of uppercase and lowercase." -tagged = false - -[blocks.packages.fields.packages.item.fields.fname] -type = "file" -longname = "file name" -description = "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run." -tagged = false -direction = "in" -mode_keyword = false -component = "package" -component_ftype = "ftype" - -[blocks.packages.fields.packages.item.fields.pname] -type = "string" -longname = "user name for package" -description = "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single OLF Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters." -optional = true -tagged = false -pk = true - -[memory.x] -type = "array" -set_in = "ca" -description = "Stage for each model cell. Checked in from the solution-level dependent-variable vector (or directly allocated when the DFW package is absent). Initialized by the IC package during AR; updated by the nonlinear solver at each Picard iteration (CA). API-written values serve as initial guesses and are overwritten by the solver." -obs_type = "STAGE" -dtype = "double" -shape = [ - "nodes", -] - -[memory.xold] -type = "array" -readonly = true -set_in = "ad" -description = "Dependent variable from the end of the previous time step. Copied from X at advance (AD); used to restore X if the adaptive time stepping scheme retries a failed time step." -dtype = "double" -shape = [ - "nodes", -] - -[memory.flowja] -type = "array" -readonly = true -set_in = "cq" -description = "Intercell flows in compressed sparse row (CSR) order, calculated after solution convergence. Diagonal entries hold the flow residual." -budget = "FLOW-JA-FACE" -dtype = "double" -shape = [ - "nja", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution for this model, sliced from the solution-level RHS vector. Rebuilt each solver iteration." -dtype = "double" -shape = [ - "nodes", -] - -[memory.ibound] -type = "array" -set_in = "ar" -description = "Cell activity flag: positive values indicate active cells, zero indicates inactive (no-flow) cells. Set during model initialisation; may change when Newton-Raphson wet-dry logic activates or deactivates cells." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.neq] -readonly = true -set_in = "ar" -description = "Number of equations (unknowns) for this model. Equal to the number of active cells (NODES) for standard models." -type = "integer" - -[memory.idxglo] -type = "array" -readonly = true -set_in = "mc" -description = "Maps each local CSR position to the corresponding row/column index in the global solution matrix. Populated during matrix connectivity (MC) and constant thereafter." -dtype = "integer" -shape = [ - "nja", -] - -[observations.stage] -type = "cellid" -tagged = false - -[observations.flow-ja-face] -type = "record" - -[observations.flow-ja-face.fields.cellid] -type = "cellid" -tagged = false - -[observations.flow-ja-face.fields.cellid2] -type = "cellid" -tagged = false diff --git a/flopy4/mf6/dfns/olf-oc.toml b/flopy4/mf6/dfns/olf-oc.toml deleted file mode 100644 index 003fcb72f..000000000 --- a/flopy4/mf6/dfns/olf-oc.toml +++ /dev/null @@ -1,223 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "olf-oc" -parent = "olf-nam" -ftype = "OC6" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the output file to write budget information. Data are written to this file only for time steps in which SAVE BUDGET is specified in a PERIOD block. If SAVE BUDGET is specified in a PERIOD block and this file is not specified, MODFLOW 6 will terminate with an error." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. If specified, a budget summary record will be written to this file for every time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.qoutflow_filerecord] -type = "record" -optional = true - -[blocks.options.fields.qoutflow_filerecord.fields.qoutflow] -type = "keyword" -longname = "qoutflow keyword" -description = "keyword to specify that record corresponds to qoutflow." - -[blocks.options.fields.qoutflow_filerecord.fields.qoutflowfile] -type = "file" -longname = "file keyword" -description = "name of the output file to write conc information." -tagged = false -direction = "out" - -[blocks.options.fields.stage_filerecord] -type = "record" -optional = true - -[blocks.options.fields.stage_filerecord.fields.stage] -type = "keyword" -longname = "stage keyword" -description = "keyword to specify that record corresponds to stage." - -[blocks.options.fields.stage_filerecord.fields.stagefile] -type = "file" -longname = "file keyword" -description = "name of the output file to write stage information." -tagged = false -direction = "out" - -[blocks.options.fields.qoutflowprintrecord] -type = "record" -optional = true - -[blocks.options.fields.qoutflowprintrecord.fields.qoutflow] -type = "keyword" -longname = "qoutflow keyword" -description = "keyword to specify that record corresponds to qoutflow." - -[blocks.options.fields.qoutflowprintrecord.fields.print_format] -type = "keyword" -longname = "keyword to indicate that a print format follows" -description = "keyword to specify format for printing to the listing file." - -[blocks.options.fields.qoutflowprintrecord.fields.formatrecord] -type = "record" - -[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.columns] -type = "integer" -longname = "number of columns" -description = "number of columns for writing data." -optional = true - -[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.width] -type = "integer" -longname = "width for each number" -description = "width for writing each number." -optional = true - -[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.digits] -type = "integer" -longname = "number of digits" -description = "number of digits to use for writing a number." -optional = true - -[blocks.options.fields.qoutflowprintrecord.fields.formatrecord.fields.format] -type = "string" -longname = "write format" -description = "write format can be EXPONENTIAL, FIXED, GENERAL, or SCIENTIFIC." -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" -optional = true - -[blocks.period.fields.stress_period_data.item] -name = "output_record" -type = "union" - -[blocks.period.fields.stress_period_data.item.arms.saverecord] -type = "record" -optional = true - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.save] -type = "keyword" -longname = "keyword to save" -description = "keyword to indicate that information will be saved this stress period." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.rtype] -type = "string" -longname = "record type" -description = "type of information to save or print. Can be BUDGET." -tagged = false -valid = [ - "STAGE", - "BUDGET", -] - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting] -type = "union" -description = "specifies the steps for which the data will be saved." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.all] -type = "keyword" -description = "keyword to indicate save for all time steps in period." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.first] -type = "keyword" -description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.last] -type = "keyword" -description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.frequency] -type = "integer" -description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.steps] -type = "array" -description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." -dtype = "integer" -shape = [ - "<=nstp", -] - -[blocks.period.fields.stress_period_data.item.arms.printrecord] -type = "record" -optional = true - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.print] -type = "keyword" -longname = "keyword to save" -description = "keyword to indicate that information will be printed this stress period." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.rtype] -type = "string" -longname = "record type" -description = "type of information to save or print. Can be BUDGET." -tagged = false -valid = [ - "STAGE", - "BUDGET", -] - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting] -type = "union" -description = "specifies the steps for which the data will be saved." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.all] -type = "keyword" -description = "keyword to indicate save for all time steps in period." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.first] -type = "keyword" -description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.last] -type = "keyword" -description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.frequency] -type = "integer" -description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.steps] -type = "array" -description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." -dtype = "integer" -shape = [ - "<=nstp", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true diff --git a/flopy4/mf6/dfns/olf-pcp.toml b/flopy4/mf6/dfns/olf-pcp.toml deleted file mode 100644 index 8c3231e36..000000000 --- a/flopy4/mf6/dfns/olf-pcp.toml +++ /dev/null @@ -1,295 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "olf-pcp" -parent = "olf-nam" -ftype = "PCP6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.auxmultname] -type = "string" -longname = "name of auxiliary variable for multiplier" -description = "name of auxiliary variable to be used as multiplier of precipitation." -optional = true - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of precipitation cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of precipitation information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print precipitation rates to listing file" -description = "keyword to indicate that the list of precipitation flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save precipitation to budget file" -description = "keyword to indicate that precipitation flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the PCP package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the PCP package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of precipitation cells" -description = "integer value specifying the maximum number of precipitation cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.precipitation] -type = "double" -longname = "precipitation rate" -description = "is the precipitation flux rate ($LT^{-1}$). This rate is multiplied inside the program by the surface area of the cell to calculate the volumetric precipitation rate. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each precipitation. The values of auxiliary variables must be present for each precipitation. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "precipitation name" -description = "name of the precipitation cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: precipitation." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "PCP" -output = true -obs_type = "PCP" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.pcp] -type = "union" - -[observations.pcp.arms.cellid] -type = "cellid" -tagged = false - -[observations.pcp.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/olf-sto.toml b/flopy4/mf6/dfns/olf-sto.toml deleted file mode 100644 index e5a70c960..000000000 --- a/flopy4/mf6/dfns/olf-sto.toml +++ /dev/null @@ -1,53 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "olf-sto" -parent = "olf-nam" -ftype = "STO6" - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "keyword to save NPF flows" -description = "keyword to indicate that cell-by-cell flow terms will be written to the file specified with 'BUDGET SAVE FILE' in Output Control." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input grid arrays, which already support the layered keyword, should be written to layered ascii output files." -optional = true - -[blocks.period.fields.stress_period_data] -type = "string" -longname = "storage state" -description = "keyword to indicate that stress period IPER is steady-state. Steady-state conditions will apply until the TRANSIENT keyword is specified in a subsequent BEGIN PERIOD block." -optional = true -tagged = false -valid = [ - "steady-state", - "transient", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -type = "integer" - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.steady_state] -set_in = "rp" -type = "logical" diff --git a/flopy4/mf6/dfns/olf-zdg.toml b/flopy4/mf6/dfns/olf-zdg.toml deleted file mode 100644 index 5a2dbf252..000000000 --- a/flopy4/mf6/dfns/olf-zdg.toml +++ /dev/null @@ -1,324 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "olf-zdg" -parent = "olf-nam" -ftype = "ZDG6" -multi = true -subtype = "stress" - -[dims.maxbound] -value = "maxbound" - -[dims.auxiliary] -value = "len(auxiliary)" - -[dims.naux] -value = "len(auxiliary)" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.auxiliary] -type = "array" -longname = "keyword to specify aux variables" -description = "defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block." -optional = true -dtype = "string" - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of zero-depth-gradient boundary cells." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of zero-depth-gradient boundary information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of zero-depth-gradient boundary flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save flows to budget file" -description = "keyword to indicate that zero-depth-gradient boundary flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.options.fields.obs_filerecord] -type = "record" -optional = true - -[blocks.options.fields.obs_filerecord.fields.obs6] -type = "keyword" -longname = "obs keyword" -description = "keyword to specify that record corresponds to an observations file." - -[blocks.options.fields.obs_filerecord.fields.obs6_filename] -type = "file" -longname = "obs6 input filename" -description = "name of input file to define observations for the ZDG package. See the 'Observation utility' section for instructions for preparing observation input files. Table {#2} lists observation type(s) supported by the ZDG package." -tagged = false -direction = "in" -component = "utl-obs" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of zero-depth-gradient boundaries" -description = "integer value specifying the maximum number of zero-depth-gradient boundary cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "stress_period_data" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.idcxs] -type = "integer" -longname = "cross section identifier" -description = "is the identifier for the cross section specified in the CXS Package. A value of zero indicates the zero-depth-gradient calculation will use parameters for a hydraulically wide channel." -tagged = false -index = true -fk = "chf-cxs.packagedata.ifno" - -[blocks.period.fields.stress_period_data.item.fields.width] -type = "double" -longname = "width of the zero-depth gradient boundary" -description = "is the channel width of the zero-depth gradient boundary. If a cross section is associated with this boundary, the width will be scaled by the cross section information. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.slope] -type = "double" -longname = "channel slope" -description = "is the channel slope used to calculate flow to the zero-depth-gradient boundary. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.rough] -type = "double" -longname = "channel roughness" -description = "is the Manning channel roughness value used to calculate flow to the zero-depth-gradient boundary. If a cross section is associated with this boundary, the roughness value will be multiplied by the roughness fraction for each part of the cross section. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -tagged = false -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.aux] -type = "array" -longname = "auxiliary variables" -description = "represents the values of the auxiliary variables for each zero-depth-gradient boundary. The values of auxiliary variables must be present for each zero-depth-gradient boundary. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -optional = true -tagged = false -dtype = "double" -time_series = true -shape = [ - "auxiliary", -] - -[blocks.period.fields.stress_period_data.item.fields.boundname] -type = "string" -longname = "zero-depth-gradient boundary name" -description = "name of the zero-depth-gradient boundary cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iprflow] -set_in = "ar" -source = "print_flows" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -source = "save_flows" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.auxvar] -type = "array" -source = "aux" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period. Columns (0-indexed): 0: idcxs, 1: width, 2: slope, 3: rough." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "ZDG" -output = true -obs_type = "ZDG" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "ZDG-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[observations.zdg] -type = "union" - -[observations.zdg.arms.cellid] -type = "cellid" -tagged = false - -[observations.zdg.arms.boundname] -type = "string" -tagged = false - -[observations.to-mvr] -type = "union" - -[observations.to-mvr.arms.cellid] -type = "cellid" -tagged = false - -[observations.to-mvr.arms.boundname] -type = "string" -tagged = false - -[keys] -bound = "<=maxbound" diff --git a/flopy4/mf6/dfns/prt-dis.toml b/flopy4/mf6/dfns/prt-dis.toml deleted file mode 100644 index a7f6b58ca..000000000 --- a/flopy4/mf6/dfns/prt-dis.toml +++ /dev/null @@ -1,297 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "prt-dis" -parent = "prt-nam" -ftype = "DIS6" - -[dims.nlay] -value = "nlay" -scope = "model" - -[dims.nrow] -value = "nrow" -scope = "model" - -[dims.ncol] -value = "ncol" -scope = "model" - -[dims.ncpl] -value = "nrow * ncol" -scope = "model" - -[dims.nodes] -value = "nlay * nrow * ncol" -scope = "model" - -[dims.ncelldim] -value = "3" -scope = "model" - -[runtime_dims.nodes] -set_in = "ar" - -[runtime_dims.nodesuser] -set_in = "ar" - -[blocks.options.fields.length_units] -type = "string" -longname = "model length units" -description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." -optional = true - -[blocks.options.fields.nogrb] -type = "keyword" -longname = "do not write binary grid file" -description = "keyword to deactivate writing of the binary grid file." -optional = true - -[blocks.options.fields.grb_filerecord] -type = "record" -optional = true - -[blocks.options.fields.grb_filerecord.fields.grb6] -type = "keyword" -longname = "grb keyword" -description = "keyword to specify that record corresponds to a binary grid file." - -[blocks.options.fields.grb_filerecord.fields.grb6_filename] -type = "file" -longname = "file name of GRB information" -description = "defines a binary grid output file. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." -tagged = false -direction = "out" - -[blocks.options.fields.xorigin] -type = "double" -longname = "x-position of the model grid origin" -description = "x-position of the lower-left corner of the model grid. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.yorigin] -type = "double" -longname = "y-position of the model grid origin" -description = "y-position of the lower-left corner of the model grid. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.angrot] -type = "double" -longname = "rotation angle" -description = "counter-clockwise rotation angle (in degrees) of the lower-left corner of the model grid. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.options.fields.crs] -type = "string" -longname = "CRS user input string" -description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true -case_sensitive = true - -[blocks.options.fields.ncf_filerecord] -type = "record" -optional = true - -[blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "keyword" -longname = "ncf keyword" -description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." - -[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] -type = "file" -longname = "file name of NCF information" -description = "defines a NetCDF configuration (NCF) input file." -tagged = false -direction = "in" -component = "utl-ncf" - -[blocks.dimensions.fields.nlay] -type = "integer" -longname = "number of layers" -description = "is the number of layers in the model grid." -default = 1 - -[blocks.dimensions.fields.nrow] -type = "integer" -longname = "number of rows" -description = "is the number of rows in the model grid." -default = 2 - -[blocks.dimensions.fields.ncol] -type = "integer" -longname = "number of columns" -description = "is the number of columns in the model grid." -default = 2 - -[blocks.griddata.fields.delr] -type = "array" -longname = "spacing along a row" -description = "is the column spacing in the row direction." -default = 1.0 -dtype = "double" -shape = [ - "ncol", -] - -[blocks.griddata.fields.delc] -type = "array" -longname = "spacing along a column" -description = "is the row spacing in the column direction." -default = 1.0 -dtype = "double" -shape = [ - "nrow", -] - -[blocks.griddata.fields.top] -type = "array" -longname = "cell top elevation" -description = "is the top elevation for each cell in the top model layer." -default = 1.0 -dtype = "double" -shape = [ - "ncol", - "nrow", -] - -[blocks.griddata.fields.botm] -type = "array" -longname = "cell bottom elevation" -description = "is the bottom elevation for each cell." -default = 0.0 -dtype = "double" -layered = true -shape = [ - "ncol", - "nrow", - "nlay", -] - -[blocks.griddata.fields.idomain] -type = "array" -longname = "idomain existence array" -description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." -optional = true -dtype = "integer" -layered = true -shape = [ - "ncol", - "nrow", - "nlay", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.nlay] -set_in = "ar" -source = "nlay" -type = "integer" - -[memory.nrow] -set_in = "ar" -source = "nrow" -type = "integer" - -[memory.ncol] -set_in = "ar" -source = "ncol" -type = "integer" - -[memory.delr] -type = "array" -set_in = "ar" -source = "delr" -dtype = "double" -shape = [ - "ncol", -] - -[memory.delc] -type = "array" -set_in = "ar" -source = "delc" -dtype = "double" -shape = [ - "nrow", -] - -[memory.top] -type = "array" -set_in = "ar" -source = "top" -dtype = "double" -shape = [ - "ncol", - "nrow", -] - -[memory.botm] -type = "array" -set_in = "ar" -source = "botm" -dtype = "double" -shape = [ - "ncol", - "nrow", - "nlay", -] - -[memory.idomain] -type = "array" -set_in = "ar" -source = "idomain" -dtype = "integer" -shape = [ - "ncol", - "nrow", - "nlay", -] - -[memory.area] -type = "array" -readonly = true -set_in = "ar" -description = "Horizontal cell area, computed from grid geometry." -dtype = "double" -shape = [ - "ncpl", -] - -[memory.nodeuser] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodereduced] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." -dtype = "integer" -shape = [ - "nodesuser", -] diff --git a/flopy4/mf6/dfns/prt-disv.toml b/flopy4/mf6/dfns/prt-disv.toml deleted file mode 100644 index 41d6fc164..000000000 --- a/flopy4/mf6/dfns/prt-disv.toml +++ /dev/null @@ -1,323 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "prt-disv" -parent = "prt-nam" -ftype = "DISV6" - -[dims.nlay] -value = "nlay" -scope = "model" - -[dims.ncpl] -value = "ncpl" -scope = "model" - -[dims.nvert] -value = "nvert" -scope = "model" - -[dims.nodes] -value = "nlay * ncpl" -scope = "model" - -[dims.ncelldim] -value = "2" -scope = "model" - -[runtime_dims.nodes] -set_in = "ar" - -[runtime_dims.nodesuser] -set_in = "ar" - -[blocks.options.fields.length_units] -type = "string" -longname = "model length units" -description = "is the length units used for this model. Values can be 'FEET', 'METERS', or 'CENTIMETERS'. If not specified, the default is 'UNKNOWN'." -optional = true - -[blocks.options.fields.nogrb] -type = "keyword" -longname = "do not write binary grid file" -description = "keyword to deactivate writing of the binary grid file." -optional = true - -[blocks.options.fields.grb_filerecord] -type = "record" -optional = true - -[blocks.options.fields.grb_filerecord.fields.grb6] -type = "keyword" -longname = "grb keyword" -description = "keyword to specify that record corresponds to a binary grid file." - -[blocks.options.fields.grb_filerecord.fields.grb6_filename] -type = "file" -longname = "file name of GRB information" -description = "defines a binary grid output file." -tagged = false -direction = "out" - -[blocks.options.fields.xorigin] -type = "double" -longname = "x-position origin of the model grid coordinate system" -description = "x-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. A default value of zero is assigned if not specified. The value for XORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.yorigin] -type = "double" -longname = "y-position origin of the model grid coordinate system" -description = "y-position of the origin used for model grid vertices. This value should be provided in a real-world coordinate system. If not specified, then a default value equal to zero is used. The value for YORIGIN does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.angrot] -type = "double" -longname = "rotation angle" -description = "counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system. If not specified, then a default value of 0.0 is assigned. The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.options.fields.export_array_netcdf] -type = "keyword" -longname = "export array variables to netcdf output files." -description = "keyword that specifies input gridded arrays should be written to the model output NetCDF file with attributes that support using the generated file as a MODFLOW 6 simulation input. This option only has an effect when an output model NetCDF file is configured and the simulation is run in VALIDATE mode, otherwise it is ignored." -optional = true - -[blocks.options.fields.crs] -type = "string" -longname = "CRS user input string" -description = "is a real-world coordinate reference system (CRS) for the model, for example, an EPSG integer code (e.g. 26915), authority string (i.e. epsg:26915), or Open Geospatial Consortium Well-Known Text (WKT) specification. Limited to 5000 characters. The entry for CRS does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space." -optional = true -case_sensitive = true - -[blocks.options.fields.ncf_filerecord] -type = "record" -optional = true - -[blocks.options.fields.ncf_filerecord.fields.ncf6] -type = "keyword" -longname = "ncf keyword" -description = "keyword to specify that record corresponds to a NetCDF configuration (NCF) file." - -[blocks.options.fields.ncf_filerecord.fields.ncf6_filename] -type = "file" -longname = "file name of NCF information" -description = "defines a NetCDF configuration (NCF) input file." -tagged = false -direction = "in" -component = "utl-ncf" - -[blocks.dimensions.fields.nlay] -type = "integer" -longname = "number of layers" -description = "is the number of layers in the model grid." - -[blocks.dimensions.fields.ncpl] -type = "integer" -longname = "number of cells per layer" -description = "is the number of cells per layer. This is a constant value for the grid and it applies to all layers." - -[blocks.dimensions.fields.nvert] -type = "integer" -longname = "number of vertices" -description = "is the total number of (x, y) vertex pairs used to characterize the horizontal configuration of the model grid." - -[blocks.griddata.fields.top] -type = "array" -longname = "model top elevation" -description = "is the top elevation for each cell in the top model layer." -dtype = "double" -shape = [ - "ncpl", -] - -[blocks.griddata.fields.botm] -type = "array" -longname = "model bottom elevation" -description = "is the bottom elevation for each cell." -dtype = "double" -layered = true -shape = [ - "ncpl", - "nlay", -] - -[blocks.griddata.fields.idomain] -type = "array" -longname = "idomain existence array" -description = "is an optional array that characterizes the existence status of a cell. If the IDOMAIN array is not specified, then all model cells exist within the solution. If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution. If the IDOMAIN value for a cell is 1, the cell exists in the simulation. If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a 'vertical pass through' cell." -optional = true -dtype = "integer" -layered = true -shape = [ - "ncpl", - "nlay", -] - -[blocks.vertices.fields.vertices] -type = "list" -longname = "vertices data" -shape = [ - "nvert", -] - -[blocks.vertices.fields.vertices.item] -name = "vertices" -type = "record" - -[blocks.vertices.fields.vertices.item.fields.iv] -type = "integer" -longname = "vertex number" -description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." -tagged = false -index = true -pk = true - -[blocks.vertices.fields.vertices.item.fields.xv] -type = "double" -longname = "x-coordinate for vertex" -description = "is the x-coordinate for the vertex." -tagged = false - -[blocks.vertices.fields.vertices.item.fields.yv] -type = "double" -longname = "y-coordinate for vertex" -description = "is the y-coordinate for the vertex." -tagged = false - -[blocks.cell2d.fields.cell2d] -type = "list" -longname = "cell2d data" -shape = [ - "ncpl", -] - -[blocks.cell2d.fields.cell2d.item] -name = "cell2d" -type = "record" - -[blocks.cell2d.fields.cell2d.item.fields.icell2d] -type = "integer" -longname = "cell2d number" -description = "is the CELL2D number. Records in the CELL2D block must be listed in consecutive order from the first to the last." -tagged = false -index = true -pk = true - -[blocks.cell2d.fields.cell2d.item.fields.xc] -type = "double" -longname = "x-coordinate for cell center" -description = "is the x-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.yc] -type = "double" -longname = "y-coordinate for cell center" -description = "is the y-coordinate for the cell center." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.ncvert] -type = "integer" -longname = "number of cell vertices" -description = "is the number of vertices required to define the cell. There may be a different number of vertices for each cell." -tagged = false - -[blocks.cell2d.fields.cell2d.item.fields.icvert] -type = "array" -longname = "array of vertex numbers" -description = "is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. Cells that are connected must share vertices." -tagged = false -dtype = "integer" -index = true -shape = [ - "ncvert", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.export_nc] -set_in = "ar" -source = "export_array_netcdf" -type = "logical" - -[memory.nlay] -set_in = "ar" -source = "nlay" -type = "integer" - -[memory.ncpl] -set_in = "ar" -source = "ncpl" -type = "integer" - -[memory.nvert] -set_in = "ar" -source = "nvert" -type = "integer" - -[memory.top] -type = "array" -set_in = "ar" -source = "top" -dtype = "double" -shape = [ - "ncpl", -] - -[memory.botm] -type = "array" -set_in = "ar" -source = "botm" -dtype = "double" -shape = [ - "ncpl", - "nlay", -] - -[memory.idomain] -type = "array" -set_in = "ar" -source = "idomain" -dtype = "integer" -shape = [ - "ncpl", - "nlay", -] - -[memory.area] -type = "array" -readonly = true -set_in = "ar" -description = "Horizontal cell area, computed from grid geometry." -dtype = "double" -shape = [ - "ncpl", -] - -[memory.nodeuser] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each packed (active-cell) node position to its full-grid user node number. Index map for the runtime 'nodes' dimension." -dtype = "integer" -shape = [ - "nodes", -] - -[memory.nodereduced] -type = "array" -readonly = true -set_in = "ar" -description = "Maps each full-grid user node number to its packed (active-cell) node position, or a nonpositive sentinel if the cell is inactive." -dtype = "integer" -shape = [ - "nodesuser", -] diff --git a/flopy4/mf6/dfns/prt-fmi.toml b/flopy4/mf6/dfns/prt-fmi.toml deleted file mode 100644 index 628c5ffc6..000000000 --- a/flopy4/mf6/dfns/prt-fmi.toml +++ /dev/null @@ -1,33 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "prt-fmi" -parent = "prt-nam" -ftype = "FMI6" - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save cell-by-cell flows to budget file" -description = "keyword to indicate that FMI flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.packagedata.fields.packagedata] -type = "list" -longname = "flowtype list" -optional = true - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.flowtype] -type = "string" -longname = "flow type" -description = "is the word GWFBUDGET, GWFHEAD, or GWFGRID. If GWFBUDGET is specified, then the corresponding file must be a budget file. If GWFHEAD is specified, the file must be a head file. If GWFGRID is specified, the file must be a binary grid file." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.fname] -type = "file" -longname = "file name" -description = "is the name of the file containing flows. The path to the file should be included if the file is not located in the folder where the program was run." -tagged = false -direction = "in" diff --git a/flopy4/mf6/dfns/prt-mip.toml b/flopy4/mf6/dfns/prt-mip.toml deleted file mode 100644 index e5155fa1a..000000000 --- a/flopy4/mf6/dfns/prt-mip.toml +++ /dev/null @@ -1,78 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "prt-mip" -parent = "prt-nam" -ftype = "MIP6" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.export_array_ascii] -type = "keyword" -longname = "export array variables to layered ascii files." -description = "keyword that specifies input griddata arrays should be written to layered ascii output files." -optional = true - -[blocks.griddata.fields.porosity] -type = "array" -longname = "porosity" -description = "is the aquifer porosity." -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.retfactor] -type = "array" -longname = "retardation factor" -description = "is a real value by which velocity is divided within a given cell. RETFACTOR can be used to account for solute retardation, i.e., the apparent effect of linear sorption on the velocity of particles that track solute advection. RETFACTOR may be assigned any real value. A RETFACTOR value greater than 1 represents particle retardation (slowing), and a value of 1 represents no retardation. The effect of specifying a RETFACTOR value for each cell is the same as the effect of directly multiplying the POROSITY in each cell by the proposed RETFACTOR value for each cell. RETFACTOR allows conceptual isolation of effects such as retardation from the effect of porosity. The default value is 1." -optional = true -dtype = "double" -layered = true -shape = [ - "nodes", -] - -[blocks.griddata.fields.izone] -type = "array" -longname = "zone number" -description = "is an integer zone number assigned to each cell. IZONE may be positive, negative, or zero. The current cell's zone number is recorded with each particle track datum. If a PRP package's ISTOPZONE option is set to any value other than zero, particles released by that PRP Package terminate if they enter a cell whose IZONE value matches ISTOPZONE. If ISTOPZONE is not specified or is set to zero in a PRP Package, IZONE has no effect on the termination of particles released by that PRP Package. Each PRP Package may configure a single ISTOPZONE value." -optional = true -dtype = "integer" -layered = true -shape = [ - "nodes", -] - -[memory.export_ascii] -set_in = "ar" -source = "export_array_ascii" -type = "logical" - -[memory.porosity] -type = "array" -set_in = "ar" -source = "porosity" -dtype = "double" -shape = [ - "nodes", -] - -[memory.retfactor] -type = "array" -set_in = "ar" -source = "retfactor" -dtype = "double" -shape = [ - "nodes", -] - -[memory.izone] -type = "array" -set_in = "ar" -source = "izone" -dtype = "integer" -shape = [ - "nodes", -] diff --git a/flopy4/mf6/dfns/prt-nam.toml b/flopy4/mf6/dfns/prt-nam.toml deleted file mode 100644 index a9c360076..000000000 --- a/flopy4/mf6/dfns/prt-nam.toml +++ /dev/null @@ -1,87 +0,0 @@ -type = "model" -schema_version = "2.0.0.dev3" -name = "prt-nam" -parent = "sim-nam" -ftype = "PRT6" - -[runtime_dims.nja] -set_in = "ar" - -[runtime_dims.nodes] -set_in = "ar" - -[blocks.options.fields.list] -type = "string" -longname = "name of listing file" -description = "is name of the listing file to create for this PRT model. If not specified, then the name of the list file will be the basename of the PRT model name file and the '.lst' extension. For example, if the PRT name file is called 'my.model.nam' then the list file will be called 'my.model.lst'." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.print_flows] -type = "keyword" -longname = "print calculated flows to listing file" -description = "keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which 'BUDGET PRINT' is specified in Output Control. If there is no Output Control option and 'PRINT_FLOWS' is specified, then flow rates are printed for the last time step of each stress period." -optional = true - -[blocks.options.fields.save_flows] -type = "keyword" -longname = "save flows for all packages to budget file" -description = "keyword to indicate that all model package flow terms will be written to the file specified with 'BUDGET FILEOUT' in Output Control." -optional = true - -[blocks.packages.fields.packages] -type = "list" -longname = "package list" - -[blocks.packages.fields.packages.item] -name = "packages" -type = "record" - -[blocks.packages.fields.packages.item.fields.ftype] -type = "string" -longname = "package type" -description = "is the file type, which must be one of the following character values shown in table~ref{table:ftype-prt}. Ftype may be entered in any combination of uppercase and lowercase." -tagged = false - -[blocks.packages.fields.packages.item.fields.fname] -type = "file" -longname = "file name" -description = "is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run." -tagged = false -direction = "in" -mode_keyword = false -component = "package" -component_ftype = "ftype" - -[blocks.packages.fields.packages.item.fields.pname] -type = "string" -longname = "user name for package" -description = "is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single PRT Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters." -optional = true -tagged = false -pk = true - -[memory.flowja] -type = "array" -readonly = true -set_in = "cq" -description = "Intercell flows in compressed sparse row (CSR) order, calculated after solution convergence. Diagonal entries hold the flow residual." -budget = "FLOW-JA-FACE" -dtype = "double" -shape = [ - "nja", -] - -[memory.ibound] -type = "array" -set_in = "ar" -description = "Cell activity flag: positive values indicate active cells, zero indicates inactive (no-flow) cells. Set during model initialisation; may change when Newton-Raphson wet-dry logic activates or deactivates cells." -dtype = "integer" -shape = [ - "nodes", -] diff --git a/flopy4/mf6/dfns/prt-oc.toml b/flopy4/mf6/dfns/prt-oc.toml deleted file mode 100644 index 85c7228c2..000000000 --- a/flopy4/mf6/dfns/prt-oc.toml +++ /dev/null @@ -1,318 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "prt-oc" -parent = "prt-nam" -ftype = "OC6" - -[dims.ntracktimes] -value = "ntracktimes" - -[blocks.options.fields.budget_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budget_filerecord.fields.budget] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget." - -[blocks.options.fields.budget_filerecord.fields.budgetfile] -type = "file" -longname = "file keyword" -description = "name of the output file to write budget information. Data are written to this file only for time steps in which SAVE BUDGET is specified in a PERIOD block. If SAVE BUDGET is specified in a PERIOD block and this file is not specified, MODFLOW 6 will terminate with an error." -tagged = false -direction = "out" - -[blocks.options.fields.budgetcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsv] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that record corresponds to the budget CSV." - -[blocks.options.fields.budgetcsv_filerecord.fields.budgetcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) output file to write budget summary information. If specified, a budget summary record will be written to this file for every time step of the simulation." -tagged = false -direction = "out" - -[blocks.options.fields.track_filerecord] -type = "record" -optional = true - -[blocks.options.fields.track_filerecord.fields.track] -type = "keyword" -longname = "track keyword" -description = "keyword to specify that record corresponds to a binary track file. Each PRT Model's OC Package may have only one binary track output file." - -[blocks.options.fields.track_filerecord.fields.trackfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write tracking information." -tagged = false -direction = "out" - -[blocks.options.fields.trackcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.trackcsv_filerecord.fields.trackcsv] -type = "keyword" -longname = "track keyword" -description = "keyword to specify that record corresponds to a CSV track file. Each PRT Model's OC Package may have only one CSV track file." - -[blocks.options.fields.trackcsv_filerecord.fields.trackcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) file to write tracking information." -tagged = false -direction = "out" - -[blocks.options.fields.track_release] -type = "keyword" -longname = "track release" -description = "keyword to indicate that particle tracking output is to be written when a particle is released" -optional = true - -[blocks.options.fields.track_exit] -type = "keyword" -longname = "track domain exits" -description = "keyword to indicate that particle tracking output is to be written when a particle exits a grid feature (e.g. model, cell)" -optional = true - -[blocks.options.fields.track_subfeature_exit] -type = "keyword" -longname = "track cell exits" -description = "keyword to indicate that particle tracking output is to be written when a particle exits a sub-grid-scale feature. Such features are considered implementation details of the tracking algorithm employed for particular grid types, and reporting for exit events from such features is disabled by default." -optional = true - -[blocks.options.fields.track_timestep] -type = "keyword" -longname = "track timestep ends" -description = "keyword to indicate that particle tracking output is to be written at the end of each time step" -optional = true - -[blocks.options.fields.track_terminate] -type = "keyword" -longname = "track termination" -description = "keyword to indicate that particle tracking output is to be written when a particle terminates for any reason" -optional = true - -[blocks.options.fields.track_weaksink] -type = "keyword" -longname = "track weaksink exits" -description = "keyword to indicate that particle tracking output is to be written when a particle exits a weak sink (a cell which removes some but not all inflow from adjacent cells)" -optional = true - -[blocks.options.fields.track_usertime] -type = "keyword" -longname = "track user-specified times" -description = "keyword to indicate that particle tracking output is to be written at user-specified times, provided as double precision values in the TRACKTIMES block." -optional = true - -[blocks.options.fields.track_dropped] -type = "keyword" -longname = "track drops to water table" -description = "keyword to indicate that particle tracking output is to be written when a particle is dropped to the water table via DRY_TRACKING_METHOD DROP." -optional = true - -[blocks.options.fields.track_timesrecord] -type = "record" -optional = true -removed = "6.6.0" - -[blocks.options.fields.track_timesrecord.fields.track_times] -type = "keyword" -description = "keyword indicating tracking times will follow" -removed = "6.6.0" - -[blocks.options.fields.track_timesrecord.fields.times] -type = "array" -longname = "tracking times" -description = "times to track, relative to the beginning of the simulation." -tagged = false -removed = "6.6.0" -dtype = "double" - -[blocks.options.fields.track_timesfilerecord] -type = "record" -optional = true -removed = "6.6.0" - -[blocks.options.fields.track_timesfilerecord.fields.track_timesfile] -type = "keyword" -description = "keyword indicating tracking times file name will follow" -removed = "6.6.0" - -[blocks.options.fields.track_timesfilerecord.fields.timesfile] -type = "string" -longname = "file keyword" -description = "name of the tracking times file" -tagged = false -removed = "6.6.0" -case_sensitive = true - -[blocks.options.fields.dev_dump_event_trace] -type = "keyword" -longname = "print particle tracking events" -description = "print a verbose particle tracking event trace to standard output" -optional = true -developmode = true - -[blocks.options.fields.scratch_buffer] -type = "keyword" -longname = "buffer track events in scratch file instead of memory" -description = "keyword to stage track events in a temporary (scratch) file instead of an in-memory buffer. Particle tracking results calculated during a time step are buffered, and output is deferred, until successful completion of the time step. By default, results are buffered in memory. However, for simulations in which a very large number of track events is generated during a time step, memory limits can be exceeded. In such cases, the SCRATCH_BUFFER option can be invoked to buffer results in a scratch file until successful completion of the time step. Buffering in a scratch file is typically slower than buffering in memory." -optional = true - -[blocks.dimensions.fields.ntracktimes] -type = "integer" -longname = "number of particle tracking times" -description = "is the number of user-specified particle tracking times in the TRACKTIMES block." -optional = true - -[blocks.tracktimes.fields.tracktimes] -type = "list" -optional = true -shape = [ - "ntracktimes", -] - -[blocks.tracktimes.fields.tracktimes.item] -name = "tracktimes" -type = "record" - -[blocks.tracktimes.fields.tracktimes.item.fields.time] -type = "double" -longname = "release time" -description = "real value that defines the tracking time with respect to the simulation start time." -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" -optional = true - -[blocks.period.fields.stress_period_data.item] -name = "output_record" -type = "union" - -[blocks.period.fields.stress_period_data.item.arms.saverecord] -type = "record" -optional = true - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.save] -type = "keyword" -longname = "keyword to save" -description = "keyword to indicate that information will be saved this stress period." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.rtype] -type = "string" -longname = "record type" -description = "type of information to save or print. Can only be BUDGET." -tagged = false -valid = [ - "BUDGET", -] - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting] -type = "union" -description = "specifies the steps for which the data will be saved." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.all] -type = "keyword" -description = "keyword to indicate save for all time steps in period." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.first] -type = "keyword" -description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.last] -type = "keyword" -description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.frequency] -type = "integer" -description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.saverecord.fields.ocsetting.arms.steps] -type = "array" -description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." -dtype = "integer" -shape = [ - "<=nstp", -] - -[blocks.period.fields.stress_period_data.item.arms.printrecord] -type = "record" -optional = true - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.print] -type = "keyword" -longname = "keyword to save" -description = "keyword to indicate that information will be printed this stress period." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.rtype] -type = "string" -longname = "record type" -description = "type of information to save or print. Can only be BUDGET." -tagged = false -valid = [ - "BUDGET", -] - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting] -type = "union" -description = "specifies the steps for which the data will be saved." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.all] -type = "keyword" -description = "keyword to indicate save for all time steps in period." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.first] -type = "keyword" -description = "keyword to indicate save for first step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.last] -type = "keyword" -description = "keyword to indicate save for last step in period. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.frequency] -type = "integer" -description = "save at the specified time step frequency. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." - -[blocks.period.fields.stress_period_data.item.arms.printrecord.fields.ocsetting.arms.steps] -type = "array" -description = "save for each step specified in STEPS. This keyword may be used in conjunction with other keywords to print or save results for multiple time steps." -dtype = "integer" -shape = [ - "<=nstp", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.track_subf_exit] -set_in = "ar" -source = "track_subfeature_exit" -type = "logical" - -[memory.dev_dump_evtrace] -set_in = "ar" -source = "dev_dump_event_trace" -type = "logical" - -[memory.ntracktimes] -set_in = "ar" -source = "ntracktimes" -type = "integer" diff --git a/flopy4/mf6/dfns/prt-prp.toml b/flopy4/mf6/dfns/prt-prp.toml deleted file mode 100644 index c42b5d984..000000000 --- a/flopy4/mf6/dfns/prt-prp.toml +++ /dev/null @@ -1,525 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "prt-prp" -parent = "prt-nam" -ftype = "PRP6" -multi = true -subtype = "stress" - -[dims.nreleasepts] -value = "nreleasepts" - -[dims.nreleasetimes] -value = "nreleasetimes" - -[runtime_dims.naux] -set_in = "ar" - -[runtime_dims.nbound] -set_in = "rp" - -[runtime_dims.ncolbnd] -set_in = "ar" - -[blocks.options.fields.boundnames] -type = "keyword" -description = "keyword to indicate that boundary names may be provided with the list of particle release points." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.dev_exit_solve_method] -type = "integer" -longname = "exit solve method" -description = "the method for iterative solution of particle exit location and time in the generalized Pollock's method. 0 default, 1 Brent, 2 Chandrupatla. The default is Brent's method." -optional = true -developmode = true - -[blocks.options.fields.exit_solve_tolerance] -type = "double" -longname = "exit solve tolerance" -description = "the convergence tolerance for iterative solution of particle exit location and time in the generalized Pollock's method. The variable being solved for varies from 0 to 1. A tolerance of 0.00001 works well for many problems, but the value that strikes the best balance between accuracy and runtime is problem-dependent." -optional = true -default = 1e-05 - -[blocks.options.fields.local_z] -type = "keyword" -longname = "whether to use local z coordinates" -description = "indicates that 'zrpt' defines the local z coordinate of the release point within the cell, with value of 0 at the bottom and 1 at the effective top of the cell. If the cell is convertible and partially saturated at release time, the effective top of the cell is considered to be the water table elevation (the head in the cell) rather than the top defined by the user, and is constrained to be no higher than the geometric top of the cell and no lower than the cell bottom. If the cell is confined, the effective top is the geometric top." -optional = true - -[blocks.options.fields.extend_tracking] -type = "keyword" -longname = "whether to extend tracking beyond the end of the simulation" -description = "indicates that particles should be tracked beyond the end of the simulation's final time step (using that time step's flows) until particles terminate or reach a specified stop time. By default, particles are terminated at the end of the simulation's final time step." -optional = true - -[blocks.options.fields.track_filerecord] -type = "record" -optional = true - -[blocks.options.fields.track_filerecord.fields.track] -type = "keyword" -longname = "track keyword" -description = "keyword to specify that record corresponds to a binary track output file. Each PRP Package may have a distinct binary track output file." - -[blocks.options.fields.track_filerecord.fields.trackfile] -type = "file" -longname = "file keyword" -description = "name of the binary output file to write tracking information." -tagged = false -direction = "out" - -[blocks.options.fields.trackcsv_filerecord] -type = "record" -optional = true - -[blocks.options.fields.trackcsv_filerecord.fields.trackcsv] -type = "keyword" -longname = "track keyword" -description = "keyword to specify that record corresponds to a CSV track output file. Each PRP Package may have a distinct CSV track output file." - -[blocks.options.fields.trackcsv_filerecord.fields.trackcsvfile] -type = "file" -longname = "file keyword" -description = "name of the comma-separated value (CSV) file to write tracking information." -tagged = false -direction = "out" - -[blocks.options.fields.stoptime] -type = "double" -longname = "stop time" -description = "real value defining the maximum simulation time to which particles in the package can be tracked. Particles that have not terminated earlier due to another termination condition will terminate when simulation time STOPTIME is reached. If the last stress period in the simulation consists of more than one time step, particles will not be tracked past the ending time of the last stress period, regardless of STOPTIME. If the EXTEND_TRACKING option is enabled and the last stress period in the simulation is steady-state, the simulation ending time will not limit the time to which particles can be tracked, but STOPTIME and STOPTRAVELTIME will continue to apply. If STOPTIME and STOPTRAVELTIME are both provided, particles will be stopped if either is reached." -optional = true - -[blocks.options.fields.stoptraveltime] -type = "double" -longname = "stop travel time" -description = "real value defining the maximum travel time over which particles in the model can be tracked. Particles that have not terminated earlier due to another termination condition will terminate when their travel time reaches STOPTRAVELTIME. If the last stress period in the simulation consists of more than one time step, particles will not be tracked past the ending time of the last stress period, regardless of STOPTRAVELTIME. If the EXTEND_TRACKING option is enabled and the last stress period in the simulation is steady-state, the simulation ending time will not limit the time to which particles can be tracked, but STOPTIME and STOPTRAVELTIME will continue to apply. If STOPTIME and STOPTRAVELTIME are both provided, particles will be stopped if either is reached." -optional = true - -[blocks.options.fields.stop_at_weak_sink] -type = "keyword" -longname = "stop at weak sink" -description = "is a text keyword to indicate that a particle is to terminate when it enters a cell that is a weak sink. By default, particles are allowed to pass though cells that are weak sinks." -optional = true - -[blocks.options.fields.istopzone] -type = "integer" -longname = "stop zone number" -description = "integer value defining the stop zone number. If cells have been assigned IZONE values in the GRIDDATA block, a particle terminates if it enters a cell whose IZONE value matches ISTOPZONE. An ISTOPZONE value of zero indicates that there is no stop zone. The default value is zero." -optional = true - -[blocks.options.fields.drape] -type = "keyword" -longname = "drape" -description = "is a text keyword to indicate that if a particle's release point is in a cell that happens to be inactive at release time, the particle is to be moved to the topmost active cell below it, if any. By default, a particle is not released into the simulation if its release point's cell is inactive at release time. Note that DRAPE does not apply to attempted release into a cell for which IDOMAIN <= 0, which is considered not to exist in the simulation. Attempted release into a such a cell results in an error." -optional = true - -[blocks.options.fields.release_timesrecord] -type = "record" -optional = true -removed = "6.6.0" - -[blocks.options.fields.release_timesrecord.fields.release_times] -type = "keyword" -description = "keyword indicating release times will follow" -removed = "6.6.0" - -[blocks.options.fields.release_timesrecord.fields.times] -type = "array" -longname = "release times" -description = "times to release, relative to the beginning of the simulation. RELEASE_TIMES and RELEASE_TIMESFILE are mutually exclusive." -tagged = false -removed = "6.6.0" -dtype = "double" - -[blocks.options.fields.release_timesfilerecord] -type = "record" -optional = true -removed = "6.6.0" - -[blocks.options.fields.release_timesfilerecord.fields.release_timesfile] -type = "keyword" -description = "keyword indicating release times file name will follow" -removed = "6.6.0" - -[blocks.options.fields.release_timesfilerecord.fields.timesfile] -type = "string" -longname = "file keyword" -description = "name of the release times file. RELEASE_TIMES and RELEASE_TIMESFILE are mutually exclusive." -tagged = false -removed = "6.6.0" -case_sensitive = true - -[blocks.options.fields.dry_tracking_method] -type = "string" -longname = "what to do in dry-but-active cells" -description = "is a string indicating how particles should behave in dry-but-active cells (as can occur with the Newton formulation). The value can be 'DROP', 'STOP', or 'STAY'. The default is 'DROP', which passes particles vertically and instantaneously to the water table. 'STOP' causes particles to terminate. 'STAY' causes particles to remain stationary but active." -optional = true -valid = [ - "drop", - "stop", - "stay", -] - -[blocks.options.fields.dev_forceternary] -type = "keyword" -longname = "force ternary tracking method" -description = "force use of the ternary tracking method regardless of cell type in DISV grids." -developmode = true - -[blocks.options.fields.release_time_tolerance] -type = "double" -longname = "release time coincidence tolerance" -description = "real number indicating the tolerance within which to consider consecutive release times coincident. Coincident release times will be merged into a single release time. The default is $epsilon times 10^{11}$, where $epsilon$ is machine precision." -optional = true - -[blocks.options.fields.release_time_frequency] -type = "double" -longname = "release time frequency" -description = "real number indicating the time frequency at which to release particles. This option can be used to schedule releases at a regular interval for the duration of the simulation, starting at the simulation start time. The release schedule is the union of this option, the RELEASETIMES block, and PERIOD block RELEASESETTING selections. If none of these are provided, a single release time is configured at the beginning of the first time step of the simulation's first stress period." -optional = true - -[blocks.options.fields.coordinate_check_method] -type = "string" -longname = "coordinate checking method" -description = "approach for verifying that release point coordinates are in the cell with the specified ID. Possible values are NONE and EAGER. By default, release point coordinates are checked at release time, i.e. EAGER." -optional = true -default = "eager" -valid = [ - "none", - "eager", -] - -[blocks.options.fields.dev_cycle_detection_window] -type = "integer" -longname = "cycle detection window size" -description = "integer value defining the size of the window (number of consecutive exit events) used for cycle detection. Defaults to 0, disabling cycle detection. With detection enabled, particle pathlines with duplicate cell exit events (i.e., exiting the same cell through the same face twice) will cause the program to terminate with an error. A larger window size provides more robust cycle detection at the cost of more runtime operations per cell exit." -optional = true -developmode = true - -[blocks.dimensions.fields.nreleasepts] -type = "integer" -longname = "number of particle release points" -description = "is the number of particle release points." - -[blocks.dimensions.fields.nreleasetimes] -type = "integer" -longname = "number of particle release times" -description = "is the number of particle release times specified in the RELEASETIMES block. This is not necessarily the total number of release times; release times are the union of RELEASE_TIME_FREQUENCY, RELEASETIMES block, and PERIOD block RELEASESETTING selections." - -[blocks.packagedata.fields.packagedata] -type = "list" -shape = [ - "nreleasepts", -] - -[blocks.packagedata.fields.packagedata.item] -name = "packagedata" -type = "record" - -[blocks.packagedata.fields.packagedata.item.fields.irptno] -type = "integer" -longname = "PRP id number for release point" -description = "integer value that defines the PRP release point number associated with the specified PACKAGEDATA data on the line. IRPTNO must be greater than zero and less than or equal to NRELEASEPTS. The program will terminate with an error if information for a PRP release point number is specified more than once." -tagged = false -index = true -pk = true - -[blocks.packagedata.fields.packagedata.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.xrpt] -type = "double" -longname = "x coordinate of release point" -description = "real value that defines the x coordinate of the release point in model coordinates. The (x, y, z) location specified for the release point must lie within the cell that is identified by the specified cellid." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.yrpt] -type = "double" -longname = "y coordinate of release point" -description = "real value that defines the y coordinate of the release point in model coordinates. The (x, y, z) location specified for the release point must lie within the cell that is identified by the specified cellid." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.zrpt] -type = "double" -longname = "z coordinate of release point" -description = "real value that defines the z coordinate of the release point in model coordinates or, if the LOCAL_Z option is active, in local cell coordinates. The (x, y, z) location specified for the release point must lie within the cell that is identified by the specified cellid." -tagged = false - -[blocks.packagedata.fields.packagedata.item.fields.boundname] -type = "string" -longname = "release point name" -description = "name of the particle release point. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes." -optional = true -when = "boundnames" -tagged = false - -[blocks.releasetimes.fields.releasetimes] -type = "list" -optional = true -shape = [ - "nreleasetimes", -] - -[blocks.releasetimes.fields.releasetimes.item] -name = "releasetimes" -type = "record" - -[blocks.releasetimes.fields.releasetimes.item.fields.time] -type = "double" -longname = "release time" -description = "real value that defines the release time with respect to the simulation start time." -tagged = false - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "releasesetting" -type = "union" -description = "specifies time steps at which to release a particle. A particle is released at the beginning of each specified time step. For fine control over release timing, specify times explicitly using the RELEASETIMES block. If the beginning of a specified time step coincides with a release time specified in the RELEASETIMES block or configured via RELEASE_TIME_FREQUENCY, only one particle is released at that time. Coincidence is evaluated up to the tolerance specified in RELEASE_TIME_TOLERANCE, or $epsilon times 10^{11}$ by default, where $epsilon$ is machine precision. When such a coincidence occurs, the release is reported under the earlier of the two time steps, i.e. whichever time step the coincident release time falls in per the usual convention that a time exactly on a time step boundary belongs to the earlier time step, not the later one. If no release times are configured via this setting, the RELEASETIMES block, or the RELEASE_TIME_FREQUENCY option, a single release time is configured at the beginning of the first time step of the simulation's first stress period." - -[blocks.period.fields.stress_period_data.item.arms.all] -type = "keyword" -description = "keyword to indicate release at the start of all time steps in the period." - -[blocks.period.fields.stress_period_data.item.arms.first] -type = "keyword" -description = "keyword to indicate release at the start of the first time step in the period. This keyword may be used in conjunction with other RELEASESETTING options." - -[blocks.period.fields.stress_period_data.item.arms.last] -type = "keyword" -description = "keyword to indicate release at the start of the last time step in the period. This keyword may be used in conjunction with other RELEASESETTING options." - -[blocks.period.fields.stress_period_data.item.arms.frequency] -type = "integer" -description = "release at the specified time step frequency. This keyword may be used in conjunction with other RELEASESETTING options." - -[blocks.period.fields.stress_period_data.item.arms.steps] -type = "array" -description = "release at the start of each step specified in STEPS. This option may be used in conjunction with other RELEASESETTING options." -dtype = "integer" -shape = [ - "<=nstp", -] - -[blocks.period.fields.stress_period_data.item.arms.fraction] -type = "array" -description = "release particles after the specified fraction of the time step has elapsed. If FRACTION is not set, particles are released at the start of the specified time step(s). FRACTION must be a single value when used with ALL, FIRST, or FREQUENCY. When used with STEPS, FRACTION may be a single value or an array of the same length as STEPS. If a single FRACTION value is provided with STEPS, the fraction applies to all steps. NOTE: The FRACTION option has been removed. For fine control over release timing, specify times explicitly using the RELEASETIMES block." -optional = true -removed = "6.6.0" -dtype = "double" -shape = [ - "<=nstp", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block applies only to that stress period." -tagged = false -index = true - -[memory.iprpak] -set_in = "ar" -source = "print_input" -type = "integer" - -[memory.iexmeth] -set_in = "ar" -source = "dev_exit_solve_method" -type = "integer" - -[memory.extol] -set_in = "ar" -source = "exit_solve_tolerance" -type = "double" - -[memory.localz] -set_in = "ar" -source = "local_z" -type = "logical" - -[memory.extend] -set_in = "ar" -source = "extend_tracking" -type = "logical" - -[memory.istopweaksink] -set_in = "ar" -source = "stop_at_weak_sink" -type = "integer" - -[memory.release_timesfn] -set_in = "ar" -source = "release_timesfile" -type = "logical" - -[memory.idrymeth] -set_in = "ar" -source = "dry_tracking_method" -type = "string" - -[memory.frctrn] -set_in = "ar" -source = "dev_forceternary" -type = "logical" - -[memory.rttol] -set_in = "ar" -source = "release_time_tolerance" -type = "double" - -[memory.rtfreq] -set_in = "ar" -source = "release_time_frequency" -type = "double" - -[memory.ichkmeth] -set_in = "ar" -source = "coordinate_check_method" -type = "string" - -[memory.icycwin] -set_in = "ar" -source = "dev_cycle_detection_window" -type = "integer" - -[memory.nreleasepts] -set_in = "ar" -source = "nreleasepts" -type = "integer" - -[memory.nreleasetimes] -set_in = "ar" -source = "nreleasetimes" -type = "integer" - -[memory.ipakcb] -set_in = "ar" -description = "Flag controlling whether boundary flows are written to the budget file." -type = "integer" - -[memory.maxbound] -readonly = true -set_in = "ar" -description = "Maximum number of boundary entries per stress period." -type = "integer" - -[memory.nbound] -set_in = "rp" -description = "Number of active boundaries for the current stress period." -type = "integer" - -[memory.ncolbnd] -readonly = true -set_in = "ar" -description = "Number of columns in BOUND." -type = "integer" - -[memory.nodelist] -type = "array" -set_in = "rp" -source = "cellid" -description = "Reduced node number for each active boundary, derived from CELLID." -dtype = "integer" -shape = [ - "nbound", -] - -[memory.bound] -type = "array" -set_in = "rp" -description = "Boundary data for the current stress period." -dtype = "double" -shape = [ - "ncolbnd", - "nbound", -] - -[memory.hcof] -type = "array" -readonly = true -set_in = "fc" -description = "Diagonal coefficient contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.rhs] -type = "array" -readonly = true -set_in = "fc" -description = "Right-hand-side contribution to the system matrix." -dtype = "double" -shape = [ - "nbound", -] - -[memory.simvals] -type = "array" -readonly = true -set_in = "cq" -description = "Simulated boundary flow values for the current time step." -budget = "PRP" -output = true -obs_type = "PRP" -dtype = "double" -shape = [ - "nbound", -] - -[memory.simtomvr] -type = "array" -readonly = true -set_in = "cq" -description = "Flow diverted to the Water Mover for each boundary." -budget = "PRP-TO-MVR" -output = true -dtype = "double" -shape = [ - "nbound", -] - -[memory.naux] -readonly = true -set_in = "ar" -description = "Number of auxiliary variables." -type = "integer" - -[memory.auxname_cst] -type = "array" -readonly = true -set_in = "ar" -description = "Names of auxiliary variables." -dtype = "string" -shape = [ - "naux", -] - -[memory.auxvar] -type = "array" -description = "Auxiliary variable values for each boundary." -dtype = "double" -set_in = [ - "rp", - "ad", -] -shape = [ - "naux", - "nbound", -] diff --git a/flopy4/mf6/dfns/sim-nam.toml b/flopy4/mf6/dfns/sim-nam.toml deleted file mode 100644 index 80a523417..000000000 --- a/flopy4/mf6/dfns/sim-nam.toml +++ /dev/null @@ -1,200 +0,0 @@ -type = "simulation" -schema_version = "2.0.0.dev3" -name = "sim-nam" - -[blocks.options.fields.continue] -type = "keyword" -longname = "continue if not converged" -description = "keyword flag to indicate that the simulation should continue even if one or more solutions do not converge." -optional = true - -[blocks.options.fields.nocheck] -type = "keyword" -longname = "turn off checking" -description = "keyword flag to indicate that the model input check routines should not be called prior to each time step. Checks are performed by default." -optional = true - -[blocks.options.fields.memory_print_option] -type = "string" -longname = "memory print option" -description = "is a flag that controls printing of detailed memory manager usage to the end of the simulation list file. NONE means do not print detailed information. SUMMARY means print only the total memory for each simulation component. ALL means print information for each variable stored in the memory manager. NONE is default if MEMORY_PRINT_OPTION is not specified." -optional = true - -[blocks.options.fields.profile_option] -type = "string" -longname = "profiling option" -description = "is a flag that controls performance profiling and reporting. NONE disables profiling. SUMMARY means to measure and print a coarse performance profile. DETAIL means collect and print information with the highest resolution available. NONE is default if PROFILE_OPTION is not specified." -optional = true - -[blocks.options.fields.maxerrors] -type = "integer" -longname = "maximum number of errors" -description = "maximum number of errors that will be stored and printed." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to activate printing of simulation input summaries to the simulation list file (mfsim.lst). With this keyword, input summaries will be written for those packages that support newer input data model routines. Not all packages are supported yet by the newer input data model routines." -optional = true - -[blocks.options.fields.hpc_filerecord] -type = "record" -description = "hpc record" -optional = true - -[blocks.options.fields.hpc_filerecord.fields.hpc6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a hpc file." - -[blocks.options.fields.hpc_filerecord.fields.hpc6_filename] -type = "file" -longname = "file name of time series information" -description = "name of input file to define HPC file settings for the HPC package. See the 'HPC File' section for instructions for preparing HPC input files." -tagged = false -direction = "in" -component = "utl-hpc" - -[blocks.timing.fields.tdis6] -type = "file" -longname = "name of tdis input file" -description = "is the name of the Temporal Discretization (TDIS) Input File." -direction = "in" -mode_keyword = false -component = "sim-tdis" - -[blocks.models.fields.models] -type = "list" -longname = "list of models" -description = "is the list of model types, model name files, and model names." -optional = true - -[blocks.models.fields.models.item] -name = "models" -type = "record" -description = "is the record of model types, model name files, and model names." - -[blocks.models.fields.models.item.fields.mtype] -type = "string" -longname = "model type" -description = "is the type of model to add to simulation." -tagged = false - -[blocks.models.fields.models.item.fields.mfname] -type = "file" -longname = "file name for model name file" -description = "is the file name of the model name file." -tagged = false -direction = "in" -mode_keyword = false -component = "model" -component_ftype = "mtype" - -[blocks.models.fields.models.item.fields.mname] -type = "string" -longname = "name of model" -description = "is the user-assigned name of the model. The model name cannot exceed 16 characters and must not have blanks within the name. The model name is case insensitive; any lowercase letters are converted and stored as upper case letters. Model names must be unique." -tagged = false -pk = true - -[blocks.exchanges.fields.exchanges] -type = "list" -longname = "list of exchanges" -description = "is the list of exchange types, exchange files, and model names." -optional = true - -[blocks.exchanges.fields.exchanges.item] -name = "exchanges" -type = "record" -description = "is the record of exchange types, exchange files, and model names." - -[blocks.exchanges.fields.exchanges.item.fields.exgtype] -type = "string" -longname = "exchange type" -description = "is the exchange type." -tagged = false - -[blocks.exchanges.fields.exchanges.item.fields.exgfile] -type = "file" -longname = "input file for exchange" -description = "is the input file for the exchange." -tagged = false -direction = "in" -mode_keyword = false -component = "exchange" -component_ftype = "exgtype" - -[blocks.exchanges.fields.exchanges.item.fields.exgmnamea] -type = "string" -longname = "name of model A" -description = "is the name of the first model that is part of this exchange." -tagged = false -fk = "models.mname" - -[blocks.exchanges.fields.exchanges.item.fields.exgmnameb] -type = "string" -longname = "name of model B" -description = "is the name of the second model that is part of this exchange." -tagged = false -fk = "models.mname" - -[blocks.solutiongroup.fields.mxiter] -type = "integer" -longname = "maximum solution group iterations" -description = "is the maximum number of outer iterations for this solution group. The default value is 1. If there is only one solution in the solution group, then MXITER must be 1." -optional = true - -[blocks.solutiongroup.fields.solutiongroup] -type = "list" -longname = "solution type and models in the solution" -description = "is the list of solution types and models in the solution." - -[blocks.solutiongroup.fields.solutiongroup.item] -name = "solutiongroup" -type = "record" -description = "is the record of solution types and models in the solution." - -[blocks.solutiongroup.fields.solutiongroup.item.fields.slntype] -type = "string" -longname = "type of solution" -description = "is the type of solution. The Integrated Model Solution (IMS6) and Explicit Model Solution (EMS6) are the only supported options in this version." -tagged = false -valid = [ - "ims6", - "ems6", -] - -[blocks.solutiongroup.fields.solutiongroup.item.fields.slnfname] -type = "file" -longname = "file name for solution input" -description = "name of file containing solution input." -tagged = false -direction = "in" -mode_keyword = false -component = "solution" -component_ftype = "slntype" - -[blocks.solutiongroup.fields.solutiongroup.item.fields.slnmnames] -type = "array" -longname = "array of model names in this solution" -description = "is the array of model names to add to this solution. The number of model names is determined by the number of model names the user provides on this line." -tagged = false -dtype = "string" -fk = "models.mname" - -[blocks.solutiongroup.header.field] -name = "group_num" -type = "integer" -description = "is the group number of the solution group. Solution groups must be numbered sequentially, starting with group number one." -tagged = false - -[memory.prmem] -set_in = "ar" -source = "memory_print_option" -type = "string" - -[memory.prprof] -set_in = "ar" -source = "profile_option" -type = "string" diff --git a/flopy4/mf6/dfns/sim-tdis.toml b/flopy4/mf6/dfns/sim-tdis.toml deleted file mode 100644 index 4ee3c56af..000000000 --- a/flopy4/mf6/dfns/sim-tdis.toml +++ /dev/null @@ -1,85 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "sim-tdis" -parent = "sim-nam" -ftype = "TDIS6" - -[dims.nper] -value = "nper" -scope = "simulation" - -[blocks.options.fields.time_units] -type = "string" -longname = "time unit" -description = "is the time units of the simulation. This is a text string that is used as a label within model output files. Values for time_units may be 'unknown', 'seconds', 'minutes', 'hours', 'days', or 'years'. The default time unit is 'unknown'." -optional = true - -[blocks.options.fields.start_date_time] -type = "string" -longname = "starting date and time" -description = "is the starting date and time of the simulation. This is a text string that is used as a label within the simulation list file. The value has no effect on the simulation. The recommended format for the starting date and time is described at https://www.w3.org/TR/NOTE-datetime." -optional = true - -[blocks.options.fields.ats_filerecord] -type = "record" -optional = true - -[blocks.options.fields.ats_filerecord.fields.ats6] -type = "keyword" -longname = "ats keyword" -description = "keyword to specify that record corresponds to an adaptive time step (ATS) input file. The behavior of ATS and a description of the input file is provided separately." - -[blocks.options.fields.ats_filerecord.fields.ats6_filename] -type = "file" -longname = "file name of adaptive time series information" -description = "defines an adaptive time step (ATS) input file defining ATS controls. Records in the ATS file can be used to override the time step behavior for selected stress periods." -tagged = false -direction = "in" -component = "utl-ats" - -[blocks.dimensions.fields.nper] -type = "integer" -longname = "number of stress periods" -description = "is the number of stress periods for the simulation." -default = 1 - -[blocks.perioddata.fields.perioddata] -type = "list" -longname = "stress period time information" -default = [ - [ - 1.0, - 1, - 1.0, - ], -] -shape = [ - "nper", -] - -[blocks.perioddata.fields.perioddata.item] -name = "perioddata" -type = "record" - -[blocks.perioddata.fields.perioddata.item.fields.perlen] -type = "double" -longname = "length of stress period" -description = "is the length of a stress period." -tagged = false - -[blocks.perioddata.fields.perioddata.item.fields.nstp] -type = "integer" -longname = "number of time steps" -description = "is the number of time steps in a stress period." -tagged = false - -[blocks.perioddata.fields.perioddata.item.fields.tsmult] -type = "double" -longname = "number of time steps" -description = "is the multiplier for the length of successive time steps. The length of a time step is calculated by multiplying the length of the previous time step by TSMULT. The length of the first time step, $Delta t_1$, is related to PERLEN, NSTP, and TSMULT by the relation $Delta t_1= perlen frac{tsmult - 1}{tsmult^{nstp}-1}$." -tagged = false - -[memory.nper] -set_in = "ar" -source = "nper" -type = "integer" diff --git a/flopy4/mf6/dfns/sln-ems.toml b/flopy4/mf6/dfns/sln-ems.toml deleted file mode 100644 index 85cff8b79..000000000 --- a/flopy4/mf6/dfns/sln-ems.toml +++ /dev/null @@ -1,18 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "sln-ems" -parent = "sim-nam" -ftype = "EMS6" -subtype = "solution" - -[memory.icnvg] -readonly = true -set_in = "ar" -description = "Convergence flag. 1 if the solution converged; 0 otherwise. Updated after each call to the solver." -type = "integer" - -[memory.ttsoln] -readonly = true -set_in = "ar" -description = "Cumulative CPU time (seconds) spent in the solver." -type = "double" diff --git a/flopy4/mf6/dfns/sln-ims.toml b/flopy4/mf6/dfns/sln-ims.toml deleted file mode 100644 index 87f9911df..000000000 --- a/flopy4/mf6/dfns/sln-ims.toml +++ /dev/null @@ -1,422 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "sln-ims" -parent = "sim-nam" -ftype = "IMS6" -subtype = "solution" - -[blocks.options.fields.print_option] -type = "string" -longname = "print option" -description = "is a flag that controls printing of convergence information from the solver. NONE means print nothing. SUMMARY means print only the total number of iterations and nonlinear residual reduction summaries. ALL means print linear matrix solver convergence information to the solution listing file and model specific linear matrix solver convergence information to each model listing file in addition to SUMMARY information. NONE is default if PRINT_OPTION is not specified." -optional = true - -[blocks.options.fields.complexity] -type = "string" -longname = "solver complexity" -description = "is an optional keyword that defines default non-linear and linear solver parameters. SIMPLE - indicates that default solver input values will be defined that work well for nearly linear models. This would be used for models that do not include nonlinear stress packages and models that are either confined or consist of a single unconfined layer that is thick enough to contain the water table within a single layer. MODERATE - indicates that default solver input values will be defined that work well for moderately nonlinear models. This would be used for models that include nonlinear stress packages and models that consist of one or more unconfined layers. The MODERATE option should be used when the SIMPLE option does not result in successful convergence. COMPLEX - indicates that default solver input values will be defined that work well for highly nonlinear models. This would be used for models that include nonlinear stress packages and models that consist of one or more unconfined layers representing complex geology and surface-water/groundwater interaction. The COMPLEX option should be used when the MODERATE option does not result in successful convergence. Non-linear and linear solver parameters assigned using a specified complexity can be modified in the NONLINEAR and LINEAR blocks. If the COMPLEXITY option is not specified, NONLINEAR and LINEAR variables will be assigned the simple complexity values." -optional = true - -[blocks.options.fields.csv_output_filerecord] -type = "record" -optional = true -removed = "6.8.0" -deprecated = "6.1.1" - -[blocks.options.fields.csv_output_filerecord.fields.csv_output] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that the record corresponds to the comma separated values solver convergence output. The CSV_OUTPUT option has been deprecated and split into the CSV_OUTER_OUTPUT and CSV_INNER_OUTPUT options. Starting with MODFLOW 6 version 6.1.1 if the CSV_OUTPUT option is specified, then it is treated as the CSV_OUTER_OUTPUT option." -removed = "6.8.0" -deprecated = "6.1.1" - -[blocks.options.fields.csv_output_filerecord.fields.csvfile] -type = "file" -longname = "file keyword" -description = "name of the ascii comma separated values output file to write solver convergence information. If PRINT_OPTION is NONE or SUMMARY, comma separated values output includes maximum head change convergence information at the end of each outer iteration for each time step. If PRINT_OPTION is ALL, comma separated values output includes maximum head change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration." -tagged = false -removed = "6.8.0" -deprecated = "6.1.1" -direction = "out" - -[blocks.options.fields.csv_outer_output_filerecord] -type = "record" -optional = true - -[blocks.options.fields.csv_outer_output_filerecord.fields.csv_outer_output] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that the record corresponds to the comma separated values outer iteration convergence output." - -[blocks.options.fields.csv_outer_output_filerecord.fields.outer_csvfile] -type = "file" -longname = "file keyword" -description = "name of the ascii comma separated values output file to write maximum dependent-variable (for example, head) change convergence information at the end of each outer iteration for each time step." -tagged = false -direction = "out" - -[blocks.options.fields.csv_inner_output_filerecord] -type = "record" -optional = true - -[blocks.options.fields.csv_inner_output_filerecord.fields.csv_inner_output] -type = "keyword" -longname = "budget keyword" -description = "keyword to specify that the record corresponds to the comma separated values solver convergence output." - -[blocks.options.fields.csv_inner_output_filerecord.fields.inner_csvfile] -type = "file" -longname = "file keyword" -description = "name of the ascii comma separated values output file to write solver convergence information. Comma separated values output includes maximum dependent-variable (for example, head) change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration." -tagged = false -direction = "out" - -[blocks.options.fields.no_ptcrecord] -type = "record" -longname = "no_ptc record" -optional = true - -[blocks.options.fields.no_ptcrecord.fields.no_ptc] -type = "keyword" -longname = "no pseudo-transient continuation" -description = "is a flag that is used to disable pseudo-transient continuation (PTC). Option only applies to steady-state stress periods for models using the Newton-Raphson formulation. For many problems, PTC can significantly improve convergence behavior for steady-state simulations, and for this reason it is active by default. In some cases, however, PTC can worsen the convergence behavior, especially when the initial conditions are similar to the solution. When the initial conditions are similar to, or exactly the same as, the solution and convergence is slow, then the NO_PTC FIRST option should be used to deactivate PTC for the first stress period. The NO_PTC ALL option should also be used in order to compare convergence behavior with other MODFLOW versions, as PTC is only available in MODFLOW 6." - -[blocks.options.fields.no_ptcrecord.fields.no_ptc_option] -type = "string" -longname = "no pseudo-transient continuation option" -description = "is an optional keyword that is used to define options for disabling pseudo-transient continuation (PTC). FIRST is an optional keyword to disable PTC for the first stress period, if steady-state and one or more model is using the Newton-Raphson formulation. ALL is an optional keyword to disable PTC for all steady-state stress periods for models using the Newton-Raphson formulation. If NO_PTC_OPTION is not specified, the NO_PTC ALL option is used." -optional = true -tagged = false - -[blocks.options.fields.ats_outer_maximum_fraction] -type = "double" -longname = "fraction of outer maximum used with ats" -description = "real value defining the fraction of the maximum allowable outer iterations used with the Adaptive Time Step (ATS) capability if it is active. If this value is set to zero by the user, then this solution will have no effect on ATS behavior. This value must be greater than or equal to zero and less than or equal to 0.5 or the program will terminate with an error. If it is not specified by the user, then it is assigned a default value of one third. When the number of outer iterations for this solution is less than the product of this value and the maximum allowable outer iterations, then ATS will increase the time step length by a factor of DTADJ in the ATS input file. When the number of outer iterations for this solution is greater than the maximum allowable outer iterations minus the product of this value and the maximum allowable outer iterations, then the ATS (if active) will decrease the time step length by a factor of 1 / DTADJ." -optional = true - -[blocks.options.fields.dev_ptc] -type = "keyword" -longname = "activate pseudo-transient continuation" -description = "keyword that activates pseudo-transient continuation (PTC). PTC is active by default, so this keyword has an effect only when it follows NO_PTC in the OPTIONS block. This development option is not supported." -optional = true -developmode = true - -[blocks.options.fields.dev_ptc_output_filerecord] -type = "record" -optional = true -developmode = true - -[blocks.options.fields.dev_ptc_output_filerecord.fields.dev_ptc_output] -type = "keyword" -longname = "pseudo-transient continuation output keyword" -description = "keyword to specify that the record corresponds to the pseudo-transient continuation output file. Specifying the record also activates pseudo-transient continuation. This development option is not supported." -developmode = true - -[blocks.options.fields.dev_ptc_output_filerecord.fields.dev_ptcfile] -type = "file" -longname = "file keyword" -description = "name of the ascii output file to write pseudo-transient continuation information." -developmode = true -tagged = false -direction = "out" - -[blocks.options.fields.dev_ptc_option] -type = "keyword" -longname = "use the norms to set the initial pseudo-transient continuation value" -description = "keyword that uses the norm of the right-hand side and the L2 norm of the residual to set the initial pseudo-transient continuation value, instead of the default approach. Specifying the keyword also activates pseudo-transient continuation. This development option is not supported." -optional = true -developmode = true - -[blocks.options.fields.dev_ptc_exponent] -type = "double" -longname = "pseudo-transient continuation exponent" -description = "real number value that defines the exponent used to reduce the pseudo-transient continuation value between outer iterations. The value must be greater than zero and is 1 by default. Specifying the value also activates pseudo-transient continuation. This development option is not supported." -optional = true -developmode = true - -[blocks.options.fields.dev_ptc_del0] -type = "double" -longname = "initial pseudo-transient continuation value" -description = "real number value that defines the initial pseudo-transient continuation value, which is equivalent to an initial time step length. The value must be greater than zero. Specifying the value also activates pseudo-transient continuation. This development option is not supported." -optional = true -developmode = true - -[blocks.nonlinear.fields.outer_hclose] -type = "double" -longname = "head change criterion" -description = "real value defining the head change criterion for convergence of the outer (nonlinear) iterations, in units of length. When the maximum absolute value of the head change at all nodes during an iteration is less than or equal to OUTER_HCLOSE, iteration stops. Commonly, OUTER_HCLOSE equals 0.01. The OUTER_HCLOSE option has been deprecated in favor of the more general OUTER_DVCLOSE (for dependent variable), however either one can be specified in order to maintain backward compatibility." -optional = true -removed = "6.8.0" -deprecated = "6.1.1" - -[blocks.nonlinear.fields.outer_dvclose] -type = "double" -longname = "dependent-variable change criterion" -description = "real value defining the dependent-variable (for example, head) change criterion for convergence of the outer (nonlinear) iterations, in units of the dependent-variable (for example, length for head). When the maximum absolute value of the dependent-variable change at all nodes during an iteration is less than or equal to OUTER_DVCLOSE, iteration stops. Commonly, OUTER_DVCLOSE equals 0.01. The keyword, OUTER_HCLOSE can be still be specified instead of OUTER_DVCLOSE for backward compatibility with previous versions of MODFLOW 6 but eventually OUTER_HCLOSE will be deprecated and specification of OUTER_HCLOSE will cause MODFLOW 6 to terminate with an error." -optional = true - -[blocks.nonlinear.fields.outer_rclosebnd] -type = "double" -longname = "boundary package flow residual tolerance" -description = "real value defining the residual tolerance for convergence of model packages that solve a separate equation not solved by the IMS linear solver. This value represents the maximum allowable residual between successive outer iterations at any single model package element. An example of a model package that would use OUTER_RCLOSEBND to evaluate convergence is the SFR package which solves a continuity equation for each reach. The OUTER_RCLOSEBND option is deprecated and has no effect on simulation results as of version 6.1.1. The keyword, OUTER_RCLOSEBND can be still be specified for backward compatibility with previous versions of MODFLOW 6 but eventually specification of OUTER_RCLOSEBND will cause MODFLOW 6 to terminate with an error." -optional = true -removed = "6.8.0" -deprecated = "6.1.1" - -[blocks.nonlinear.fields.outer_maximum] -type = "integer" -longname = "outer maximum iterations" -description = "integer value defining the maximum number of outer (nonlinear) iterations -- that is, calls to the solution routine. For a linear problem OUTER_MAXIMUM should be 1." -optional = true - -[blocks.nonlinear.fields.under_relaxation] -type = "string" -longname = "under relaxation scheme" -description = "is an optional keyword that defines the nonlinear under-relaxation schemes used. Under-relaxation is also known as dampening, and is used to reduce the size of the calculated dependent variable before proceeding to the next outer iteration. Under-relaxation can be an effective tool for highly nonlinear models when there are large and often counteracting changes in the calculated dependent variable between successive outer iterations. By default under-relaxation is not used. NONE - under-relaxation is not used (default). SIMPLE - Simple under-relaxation scheme with a fixed relaxation factor (UNDER_RELAXATION_GAMMA) is used. COOLEY - Cooley under-relaxation scheme is used. DBD - delta-bar-delta under-relaxation is used. Note that the under-relaxation schemes are often used in conjunction with problems that use the Newton-Raphson formulation, however, experience has indicated that they also work well for non-Newton problems, such as those with the wet/dry options of MODFLOW 6." -optional = true - -[blocks.nonlinear.fields.under_relaxation_gamma] -type = "double" -longname = "relaxation factor for SIMPLE or the history or memory term factor for the Cooley and delta-bar-delta algorithms" -description = "real value defining either the relaxation factor for the SIMPLE scheme or the history or memory term factor of the Cooley and delta-bar-delta algorithms. For the SIMPLE scheme, a value of one indicates that there is no under-relaxation and the full head change is applied. This value can be gradually reduced from one as a way to improve convergence; for well behaved problems, using a value less than one can increase the number of outer iterations required for convergence and needlessly increase run times. UNDER_RELAXATION_GAMMA must be greater than zero for the SIMPLE scheme or the program will terminate with an error. For the Cooley and delta-bar-delta schemes, UNDER_RELAXATION_GAMMA is a memory term that can range between zero and one. When UNDER_RELAXATION_GAMMA is zero, only the most recent history (previous iteration value) is maintained. As UNDER_RELAXATION_GAMMA is increased, past history of iteration changes has greater influence on the memory term. The memory term is maintained as an exponential average of past changes. Retaining some past history can overcome granular behavior in the calculated function surface and therefore helps to overcome cyclic patterns of non-convergence. The value usually ranges from 0.1 to 0.3; a value of 0.2 works well for most problems. UNDER_RELAXATION_GAMMA only needs to be specified if UNDER_RELAXATION is not NONE." -optional = true - -[blocks.nonlinear.fields.under_relaxation_theta] -type = "double" -longname = "under relaxation reduction factor" -description = "real value defining the reduction factor for the learning rate (under-relaxation term) of the delta-bar-delta algorithm. The value of UNDER_RELAXATION_THETA is between zero and one. If the change in the dependent-variable (for example, head) is of opposite sign to that of the previous iteration, the under-relaxation term is reduced by a factor of UNDER_RELAXATION_THETA. The value usually ranges from 0.3 to 0.9; a value of 0.7 works well for most problems. UNDER_RELAXATION_THETA only needs to be specified if UNDER_RELAXATION is DBD." -optional = true - -[blocks.nonlinear.fields.under_relaxation_kappa] -type = "double" -longname = "under relaxation increment for the learning rate" -description = "real value defining the increment for the learning rate (under-relaxation term) of the delta-bar-delta algorithm. The value of UNDER_RELAXATION_kappa is between zero and one. If the change in the dependent-variable (for example, head) is of the same sign to that of the previous iteration, the under-relaxation term is increased by an increment of UNDER_RELAXATION_KAPPA. The value usually ranges from 0.03 to 0.3; a value of 0.1 works well for most problems. UNDER_RELAXATION_KAPPA only needs to be specified if UNDER_RELAXATION is DBD." -optional = true - -[blocks.nonlinear.fields.under_relaxation_momentum] -type = "double" -longname = "fraction of past history changes that is added as a momentum term" -description = "real value defining the fraction of past history changes that is added as a momentum term to the step change for a nonlinear iteration. The value of UNDER_RELAXATION_MOMENTUM is between zero and one. A large momentum term should only be used when small learning rates are expected. Small amounts of the momentum term help convergence. The value usually ranges from 0.0001 to 0.1; a value of 0.001 works well for most problems. UNDER_RELAXATION_MOMENTUM only needs to be specified if UNDER_RELAXATION is DBD." -optional = true - -[blocks.nonlinear.fields.backtracking_number] -type = "integer" -longname = "maximum number of backtracking iterations" -description = "integer value defining the maximum number of backtracking iterations allowed for residual reduction computations. If BACKTRACKING_NUMBER = 0 then the backtracking iterations are omitted. The value usually ranges from 2 to 20; a value of 10 works well for most problems." -optional = true - -[blocks.nonlinear.fields.backtracking_tolerance] -type = "double" -longname = "tolerance for residual change that is allowed for residual reduction" -description = "real value defining the tolerance for residual change that is allowed for residual reduction computations. BACKTRACKING_TOLERANCE should not be less than one to avoid getting stuck in local minima. A large value serves to check for extreme residual increases, while a low value serves to control step size more severely. The value usually ranges from 1.0 to 10$^6$; a value of 10$^4$ works well for most problems but lower values like 1.1 may be required for harder problems. BACKTRACKING_TOLERANCE only needs to be specified if BACKTRACKING_NUMBER is greater than zero." -optional = true - -[blocks.nonlinear.fields.backtracking_reduction_factor] -type = "double" -longname = "reduction in step size used for residual reduction computations" -description = "real value defining the reduction in step size used for residual reduction computations. The value of BACKTRACKING_REDUCTION_FACTOR is between zero and one. The value usually ranges from 0.1 to 0.3; a value of 0.2 works well for most problems. BACKTRACKING_REDUCTION_FACTOR only needs to be specified if BACKTRACKING_NUMBER is greater than zero." -optional = true - -[blocks.nonlinear.fields.backtracking_residual_limit] -type = "double" -longname = "limit to which the residual is reduced with backtracking" -description = "real value defining the limit to which the residual is reduced with backtracking. If the residual is smaller than BACKTRACKING_RESIDUAL_LIMIT, then further backtracking is not performed. A value of 100 is suitable for large problems and residual reduction to smaller values may only slow down computations. BACKTRACKING_RESIDUAL_LIMIT only needs to be specified if BACKTRACKING_NUMBER is greater than zero." -optional = true - -[blocks.linear.fields.inner_maximum] -type = "integer" -longname = "maximum number of inner iterations" -description = "integer value defining the maximum number of inner (linear) iterations. The number typically depends on the characteristics of the matrix solution scheme being used. For nonlinear problems, INNER_MAXIMUM usually ranges from 60 to 600; a value of 100 will be sufficient for most linear problems." -optional = true - -[blocks.linear.fields.inner_hclose] -type = "double" -longname = "head change tolerance" -description = "real value defining the head change criterion for convergence of the inner (linear) iterations, in units of length. When the maximum absolute value of the head change at all nodes during an iteration is less than or equal to INNER_HCLOSE, the matrix solver assumes convergence. Commonly, INNER_HCLOSE is set equal to or an order of magnitude less than the OUTER_HCLOSE value specified for the NONLINEAR block. The INNER_HCLOSE keyword has been deprecated in favor of the more general INNER_DVCLOSE (for dependent variable), however either one can be specified in order to maintain backward compatibility." -optional = true -removed = "6.8.0" -deprecated = "6.1.1" - -[blocks.linear.fields.inner_dvclose] -type = "double" -longname = "dependent-variable change tolerance" -description = "real value defining the dependent-variable (for example, head) change criterion for convergence of the inner (linear) iterations, in units of the dependent-variable (for example, length for head). When the maximum absolute value of the dependent-variable change at all nodes during an iteration is less than or equal to INNER_DVCLOSE, the matrix solver assumes convergence. Commonly, INNER_DVCLOSE is set equal to or an order of magnitude less than the OUTER_DVCLOSE value specified for the NONLINEAR block. The keyword, INNER_HCLOSE can be still be specified instead of INNER_DVCLOSE for backward compatibility with previous versions of MODFLOW 6 but eventually INNER_HCLOSE will be deprecated and specification of INNER_HCLOSE will cause MODFLOW 6 to terminate with an error." -optional = true - -[blocks.linear.fields.rcloserecord] -type = "record" -longname = "rclose record" -optional = true - -[blocks.linear.fields.rcloserecord.fields.inner_rclose] -type = "double" -longname = "flow residual tolerance" -description = "real value that defines the flow residual tolerance for convergence of the IMS linear solver and specific flow residual criteria used. This value represents the maximum allowable residual at any single node. Value is in units of length cubed per time, and must be consistent with mf length and time units. Usually a value of $1.0 times 10^{-1}$ is sufficient for the flow-residual criteria when meters and seconds are the defined mf length and time." - -[blocks.linear.fields.rcloserecord.fields.rclose_option] -type = "string" -longname = "flow residual tolerance" -description = "an optional keyword that defines the specific flow residual criterion used. STRICT--an optional keyword that is used to specify that INNER_RCLOSE represents a infinity-Norm (absolute convergence criteria) and that the dependent-variable (for example, head) and flow convergence criteria must be met on the first inner iteration (this criteria is equivalent to the criteria used by the MODFLOW-2005 PCG package~citep{hill1990preconditioned}). L2NORM_RCLOSE--an optional keyword that is used to specify that INNER_RCLOSE represents a L-2 Norm closure criteria instead of a infinity-Norm (absolute convergence criteria). When L2NORM_RCLOSE is specified, a reasonable initial INNER_RCLOSE value is 0.1 times the number of active cells when meters and seconds are the defined mf length and time. RELATIVE_RCLOSE--an optional keyword that is used to specify that INNER_RCLOSE represents a relative L-2 Norm reduction closure criteria instead of a infinity-Norm (absolute convergence criteria). When RELATIVE_RCLOSE is specified, a reasonable initial INNER_RCLOSE value is $1.0 times 10^{-4}$ and convergence is achieved for a given inner (linear) iteration when $Delta h le$ INNER_DVCLOSE and the current L-2 Norm is $le$ the product of the RELATIVE_RCLOSE and the initial L-2 Norm for the current inner (linear) iteration. If RCLOSE_OPTION is not specified, an absolute residual (infinity-norm) criterion is used." -optional = true -tagged = false - -[blocks.linear.fields.linear_acceleration] -type = "string" -longname = "linear acceleration method" -description = "a keyword that defines the linear acceleration method used by the default IMS linear solvers. CG - preconditioned conjugate gradient method. BICGSTAB - preconditioned bi-conjugate gradient stabilized method." -optional = true - -[blocks.linear.fields.relaxation_factor] -type = "double" -longname = "relaxation factor used by ILU factorization" -description = "optional real value that defines the relaxation factor used by the incomplete LU factorization preconditioners (MILU(0) and MILUT). RELAXATION_FACTOR is unitless and should be greater than or equal to 0.0 and less than or equal to 1.0. RELAXATION_FACTOR values of about 1.0 are commonly used, and experience suggests that convergence can be optimized in some cases with relax values of 0.97. A RELAXATION_FACTOR value of 0.0 will result in either ILU(0) or ILUT preconditioning (depending on the value specified for PRECONDITIONER_LEVELS and/or PRECONDITIONER_DROP_TOLERANCE). By default, RELAXATION_FACTOR is zero." -optional = true - -[blocks.linear.fields.preconditioner_levels] -type = "integer" -longname = "level of fill for ILU decomposition" -description = "optional integer value defining the level of fill for ILU decomposition used in the ILUT and MILUT preconditioners. Higher levels of fill provide more robustness but also require more memory. For optimal performance, it is suggested that a large level of fill be applied (7 or 8) with use of a drop tolerance. Specification of a PRECONDITIONER_LEVELS value greater than zero results in use of the ILUT preconditioner. By default, PRECONDITIONER_LEVELS is zero and the zero-fill incomplete LU factorization preconditioners (ILU(0) and MILU(0)) are used." -optional = true - -[blocks.linear.fields.preconditioner_drop_tolerance] -type = "double" -longname = "drop tolerance used to drop preconditioner terms" -description = "optional real value that defines the drop tolerance used to drop preconditioner terms based on the magnitude of matrix entries in the ILUT and MILUT preconditioners. A value of $10^{-4}$ works well for most problems. By default, PRECONDITIONER_DROP_TOLERANCE is zero and the zero-fill incomplete LU factorization preconditioners (ILU(0) and MILU(0)) are used." -optional = true - -[blocks.linear.fields.number_orthogonalizations] -type = "integer" -longname = "number of orthogonalizations" -description = "optional integer value defining the interval used to explicitly recalculate the residual of the flow equation using the solver coefficient matrix, the latest dependent-variable (for example, head) estimates, and the right hand side. For problems that benefit from explicit recalculation of the residual, a number between 4 and 10 is appropriate. By default, NUMBER_ORTHOGONALIZATIONS is zero." -optional = true - -[blocks.linear.fields.scaling_method] -type = "string" -longname = "matrix scaling approach" -description = "an optional keyword that defines the matrix scaling approach used. By default, matrix scaling is not applied. NONE - no matrix scaling applied. DIAGONAL - symmetric matrix scaling using the POLCG preconditioner scaling method in Hill (1992). L2NORM - symmetric matrix scaling using the L2 norm." -optional = true - -[blocks.linear.fields.reordering_method] -type = "string" -longname = "matrix reordering approach" -description = "an optional keyword that defines the matrix reordering approach used. By default, matrix reordering is not applied. NONE - original ordering. RCM - reverse Cuthill McKee ordering. MD - minimum degree ordering." -optional = true - -[memory.mxiter] -set_in = "ar" -source = "outer_maximum" -description = "Maximum outer (nonlinear) iterations." -type = "integer" - -[memory.dvclose] -set_in = "ar" -source = "outer_dvclose" -description = "Outer dependent-variable change closure criterion." -type = "double" - -[memory.theta] -set_in = "ar" -source = "under_relaxation_theta" -description = "Under-relaxation reduction factor (delta-bar-delta)." -type = "double" - -[memory.akappa] -set_in = "ar" -source = "under_relaxation_kappa" -description = "Under-relaxation increment for the learning rate (delta-bar-delta)." -type = "double" - -[memory.gamma] -set_in = "ar" -source = "under_relaxation_gamma" -description = "Under-relaxation memory factor (Cooley or delta-bar-delta)." -type = "double" - -[memory.amomentum] -set_in = "ar" -source = "under_relaxation_momentum" -description = "Momentum coefficient for the under-relaxation step (delta-bar-delta)." -type = "double" - -[memory.numtrack] -set_in = "ar" -source = "backtracking_number" -description = "Maximum backtracking iterations; 0 disables backtracking." -type = "integer" - -[memory.btol] -set_in = "ar" -source = "backtracking_tolerance" -description = "Residual increase tolerance that triggers backtracking." -type = "double" - -[memory.breduc] -set_in = "ar" -source = "backtracking_reduction_factor" -description = "Step-size reduction factor used during backtracking." -type = "double" - -[memory.res_lim] -set_in = "ar" -source = "backtracking_residual_limit" -description = "Residual limit below which backtracking is not performed." -type = "double" - -[memory.icnvg] -readonly = true -set_in = "ar" -description = "Convergence flag. 1 if the solution converged in the last solve; 0 otherwise. Updated after each call to the solver." -type = "integer" - -[memory.ttsoln] -readonly = true -set_in = "ar" -description = "Cumulative CPU time (seconds) spent in the linear solver." -type = "double" - -[memory.iter1] -set_in = "ar" -source = "inner_maximum" -description = "Maximum inner (linear) iterations." -type = "integer" - -[memory.rclose] -set_in = "ar" -source = "inner_rclose" -description = "Flow residual closure criterion for the linear solver." -type = "double" - -[memory.relax] -set_in = "ar" -source = "relaxation_factor" -description = "ILU(T) relaxation factor." -type = "double" - -[memory.droptol] -set_in = "ar" -source = "preconditioner_drop_tolerance" -description = "ILUT drop tolerance." -type = "double" - -[memory.north] -set_in = "ar" -source = "number_orthogonalizations" -description = "Interval for explicit residual recalculation." -type = "integer" - -[memory.iscl] -set_in = "ar" -source = "scaling_method" -description = "Matrix scaling option (integer code derived from SCALING_METHOD)." -type = "integer" - -[memory.iord] -set_in = "ar" -source = "reordering_method" -description = "Matrix reordering option (integer code derived from REORDERING_METHOD)." -type = "integer" - -[memory.ipc] -set_in = "ar" -description = "Preconditioner type code, computed from LINEAR_ACCELERATION, PRECONDITIONER_LEVELS, and PRECONDITIONER_DROP_TOLERANCE." -type = "integer" diff --git a/flopy4/mf6/dfns/utl-ats.toml b/flopy4/mf6/dfns/utl-ats.toml deleted file mode 100644 index 212ee947f..000000000 --- a/flopy4/mf6/dfns/utl-ats.toml +++ /dev/null @@ -1,69 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "utl-ats" -parent = "sim-tdis" -ftype = "ATS6" -subtype = "utility" - -[dims.maxats] -value = "maxats" - -[blocks.dimensions.fields.maxats] -type = "integer" -longname = "number of ATS periods" -description = "is the number of records in the subsequent perioddata block that will be used for adaptive time stepping." -default = 1 - -[blocks.perioddata.fields.perioddata] -type = "list" -longname = "stress period ats time information" -shape = [ - "<=maxats", -] - -[blocks.perioddata.fields.perioddata.item] -name = "perioddata" -type = "record" - -[blocks.perioddata.fields.perioddata.item.fields.iperats] -type = "integer" -longname = "stress period indicator" -description = "is the period number to apply the adaptive time stepping. Adaptive time stepping is only activated for those periods with a corresponding iperats entry in the perioddata block. The remaining ATS values on this line will apply to period iperats. iperats must be greater than zero. A warning is printed if iperats is greater than nper." -tagged = false -index = true -pk = true - -[blocks.perioddata.fields.perioddata.item.fields.dt0] -type = "double" -longname = "initial time step length" -description = "is the initial time step length for period iperats. If dt0 is zero, then the final step from the previous stress period will be used as the initial time step. The program will terminate with an error message if dt0 is negative." -tagged = false - -[blocks.perioddata.fields.perioddata.item.fields.dtmin] -type = "double" -longname = "minimum time step length" -description = "is the minimum time step length for this period. This value must be greater than zero and less than dtmax. dtmin must be a small value in order to ensure that simulation times end at the end of stress periods and the end of the simulation. A small value, such as 1.e-5, is recommended." -tagged = false - -[blocks.perioddata.fields.perioddata.item.fields.dtmax] -type = "double" -longname = "maximum time step length" -description = "is the maximum time step length for this period. This value must be greater than dtmin." -tagged = false - -[blocks.perioddata.fields.perioddata.item.fields.dtadj] -type = "double" -longname = "time step multiplier factor" -description = "is the time step multiplier factor for this period. If the number of outer solver iterations are less than the product of the maximum number of outer iterations (OUTER_MAXIMUM) and ATS_OUTER_MAXIMUM_FRACTION (an optional variable in the IMS input file with a default value of 1/3), then the time step length is multiplied by dtadj. If the number of outer solver iterations are greater than the product of the maximum number of outer iterations and 1.0 minus ATS_OUTER_MAXIMUM_FRACTION, then the time step length is divided by dtadj. dtadj must be zero, one, or greater than one. If dtadj is zero or one, then it has no effect on the simulation. A value between 2.0 and 5.0 can be used as an initial estimate." -tagged = false - -[blocks.perioddata.fields.perioddata.item.fields.dtfailadj] -type = "double" -longname = "divisor for failed time steps" -description = "is the divisor of the time step length when a time step fails to converge. If there is solver failure, then the time step will be tried again with a shorter time step length calculated as the previous time step length divided by dtfailadj. dtfailadj must be zero, one, or greater than one. If dtfailadj is zero or one, then time steps will not be retried with shorter lengths. In this case, the program will terminate with an error, or it will continue of the CONTINUE option is set in the simulation name file. Initial tests with this variable should be set to 5.0 or larger to determine if convergence can be achieved." -tagged = false - -[memory.maxats] -set_in = "ar" -source = "maxats" -type = "integer" diff --git a/flopy4/mf6/dfns/utl-hpc.toml b/flopy4/mf6/dfns/utl-hpc.toml deleted file mode 100644 index ccd6d7c82..000000000 --- a/flopy4/mf6/dfns/utl-hpc.toml +++ /dev/null @@ -1,43 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "utl-hpc" -parent = "sim-nam" -ftype = "HPC6" -subtype = "utility" - -[blocks.options.fields.print_table] -type = "keyword" -longname = "model print table to listing file" -description = "keyword to indicate that the partition table will be printed to the listing file." -optional = true - -[blocks.options.fields.dev_log_mpi] -type = "keyword" -longname = "log mpi traffic" -description = "keyword to enable (extremely verbose) logging of mpi traffic to file." -optional = true -developmode = true - -[blocks.partitions.fields.partitions] -type = "list" -longname = "list of partition numbers" -description = "is the list of zero-based partition numbers." -optional = true - -[blocks.partitions.fields.partitions.item] -name = "partitions" -type = "record" -description = "is the record of zero-based partition numbers." - -[blocks.partitions.fields.partitions.item.fields.mname] -type = "string" -longname = "model name" -description = "is the unique model name." -tagged = false -fk = "sim-nam.models.mname" - -[blocks.partitions.fields.partitions.item.fields.mrank] -type = "integer" -longname = "model rank" -description = "is the zero-based partition number (also: MPI rank or processor id) to which the model will be assigned." -tagged = false diff --git a/flopy4/mf6/dfns/utl-laktab.toml b/flopy4/mf6/dfns/utl-laktab.toml deleted file mode 100644 index 7e9639c3b..000000000 --- a/flopy4/mf6/dfns/utl-laktab.toml +++ /dev/null @@ -1,68 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "utl-laktab" -parent = "gwf-lak" -ftype = "LAKTAB6" -multi = true -subtype = "utility" - -[dims.nrow] -value = "nrow" - -[dims.ncol] -value = "ncol" - -[blocks.dimensions.fields.nrow] -type = "integer" -longname = "number of table rows" -description = "integer value specifying the number of rows in the lake table. There must be NROW rows of data in the TABLE block." - -[blocks.dimensions.fields.ncol] -type = "integer" -longname = "number of table columns" -description = "integer value specifying the number of columns in the lake table. There must be NCOL columns of data in the TABLE block. For lakes with HORIZONTAL and/or VERTICAL CTYPE connections, NCOL must be equal to 3. For lakes with EMBEDDEDH or EMBEDDEDV CTYPE connections, NCOL must be equal to 4." - -[blocks.table.fields.table] -type = "list" -shape = [ - "nrow", -] - -[blocks.table.fields.table.item] -name = "table" -type = "record" - -[blocks.table.fields.table.item.fields.stage] -type = "double" -longname = "lake stage" -description = "real value that defines the stage corresponding to the remaining data on the line." -tagged = false - -[blocks.table.fields.table.item.fields.volume] -type = "double" -longname = "lake volume" -description = "real value that defines the lake volume corresponding to the stage specified on the line." -tagged = false - -[blocks.table.fields.table.item.fields.sarea] -type = "double" -longname = "lake surface area" -description = "real value that defines the lake surface area corresponding to the stage specified on the line." -tagged = false - -[blocks.table.fields.table.item.fields.barea] -type = "double" -longname = "lake-GWF exchange area" -description = "real value that defines the lake-GWF exchange area corresponding to the stage specified on the line. BAREA is only specified if the CLAKTYPE for the lake is EMBEDDEDH or EMBEDDEDV." -optional = true -tagged = false - -[memory.nrow] -set_in = "ar" -source = "nrow" -type = "integer" - -[memory.ncol] -set_in = "ar" -source = "ncol" -type = "integer" diff --git a/flopy4/mf6/dfns/utl-ncf.toml b/flopy4/mf6/dfns/utl-ncf.toml deleted file mode 100644 index b2178da8e..000000000 --- a/flopy4/mf6/dfns/utl-ncf.toml +++ /dev/null @@ -1,132 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "utl-ncf" -ftype = "NCF6" -subtype = "utility" -parent = [ - "gwe-dis", - "gwe-disv", - "gwf-dis", - "gwf-disv", - "gwt-dis", - "gwt-disv", - "prt-dis", - "prt-disv", -] - -[dims.ncpl] -value = "ncpl" - -[blocks.options.fields.wkt] -type = "string" -longname = "CRS well-known text (WKT1) string" -description = "is the coordinate reference system (CRS) well-known text string in WKT1 format (OGC 01-009). Written as the 'wkt' attribute on the projection variable. For supported projected CRS types, individual CF-standard numeric grid_mapping parameters are also written to the projection variable, for tools that read these directly rather than parsing 'wkt'/'crs_wkt' text. For a NETCDF_STRUCTURED export with a rotated grid (ANGROT not 0.0), WKT1 cannot represent the rotation; provide 'crs_wkt' instead for correct grid positioning. Ignored when latitude and longitude griddata arrays have been provided. To also embed the CRS in the binary grid file, provide the same string as the 'CRS' option in the discretization input; the discretization 'CRS' option additionally accepts other pyproj-compatible identifiers such as an EPSG code (e.g. 'EPSG:26918')." -optional = true -case_sensitive = true - -[blocks.options.fields.crs_wkt] -type = "string" -longname = "CRS well-known text (WKT2) string" -description = "is the coordinate reference system (CRS) well-known text string in WKT2 format (ISO 19162:2019), as required by CF-1.13. Written as the 'crs_wkt' attribute on the projection variable. When omitted, the 'wkt' value is written to 'crs_wkt' as a compatibility alias. Ignored when latitude and longitude griddata arrays have been provided. To also embed the CRS in the binary grid file, provide the same string as the 'CRS' option in the discretization input; the discretization 'CRS' option additionally accepts other pyproj-compatible identifiers such as an EPSG code (e.g. 'EPSG:26918'). For a NETCDF_STRUCTURED export with a rotated grid (ANGROT not 0.0), a valid WKT2 PROJCRS string is required here to correctly position the grid: it is wrapped in a derived CRS that encodes the rotation, resolved by any CRS-aware consumer through ordinary reprojection; without it the 'x'/'y' coordinate values remain grid-local rather than real-world. For grid mappings transverse_mercator, lambert_conformal_conic (two-standard-parallel variant only), and albers_conical_equal_area, individual CF-standard numeric grid_mapping parameters (e.g. 'false_easting', 'scale_factor_at_central_meridian') are also written to the projection variable, for tools -- such as ArcGIS's classic NetCDF connector -- that read these directly rather than parsing 'wkt'/'crs_wkt' text." -optional = true -case_sensitive = true - -[blocks.options.fields.deflate] -type = "integer" -longname = "variable compression deflate level" -description = "is the variable deflate level (0=min, 9=max) in the NetCDF file. Defining this parameter activates per-variable compression at the level specified. Use with the SHUFFLE option to also enable the shuffle filter." -optional = true - -[blocks.options.fields.shuffle] -type = "keyword" -description = "is the keyword used to turn on the NetCDF variable shuffle filter when the deflate option is also set. The shuffle filter has the effect of storing the first byte of all of a variable's values in a chunk contiguously, followed by all the second bytes, etc. This can be an optimization for compression with certain types of data." -optional = true - -[blocks.options.fields.chunk_time] -type = "integer" -longname = "chunking parameter for the time dimension" -description = "is the chunk size for the time dimension in a NETCDF_MESH2D or NETCDF_STRUCTURED output file. Must be used in combination with the chunk_face parameter (NETCDF_MESH2D) or the chunk_z, chunk_y, and chunk_x parameter set (NETCDF_STRUCTURED) to have an effect." -optional = true - -[blocks.options.fields.chunk_face] -type = "integer" -longname = "chunking parameter for the mesh face dimension" -description = "is the chunk size for the face dimension in a NETCDF_MESH2D output file. Must be used in combination with the chunk_time parameter to have an effect." -optional = true - -[blocks.options.fields.chunk_z] -type = "integer" -longname = "chunking parameter for the layer dimension" -description = "is the chunk size for the layer (vertical) dimension in a NETCDF_STRUCTURED output file. Must be used in combination with the chunk_time, chunk_x, and chunk_y parameters to have an effect." -optional = true - -[blocks.options.fields.chunk_y] -type = "integer" -longname = "chunking parameter for structured y" -description = "is the chunk size for the y dimension in a NETCDF_STRUCTURED output file. Must be used in combination with the chunk_time, chunk_x, and chunk_z parameters to have an effect." -optional = true - -[blocks.options.fields.chunk_x] -type = "integer" -longname = "chunking parameter for structured x" -description = "is the chunk size for the x dimension in a NETCDF_STRUCTURED output file. Must be used in combination with the chunk_time, chunk_y, and chunk_z parameters to have an effect." -optional = true - -[blocks.options.fields.modflow6_attr_off] -type = "keyword" -description = "is the keyword used to turn off internal input tagging in the model NetCDF file. Tagging adds internal modflow 6 attribute(s) to variables which facilitate identification. Currently this applies to gridded arrays." -optional = true - -[blocks.dimensions.fields.ncpl] -type = "integer" -longname = "number of cells in layer" -description = "is the number of cells in a projected plane layer." -optional = true - -[blocks.griddata.fields.latitude] -type = "array" -longname = "cell center latitude" -description = "cell center latitude array. Only supported for NETCDF_STRUCTURED export type; ignored, with a warning, for NETCDF_MESH2D. Providing latitude and longitude arrays enables geographic-coordinate output for external tooling that requires it, and is the more reliable option for a grid with non-uniform row or column spacing, or a rotated grid, since some tools cannot otherwise correctly position such a grid from 'wkt'/'crs_wkt' alone. For other grids, 'wkt'/'crs_wkt' is the simpler choice. When latitude and longitude arrays are provided, any 'wkt' or 'crs_wkt' option values are ignored." -optional = true -dtype = "double" -shape = [ - "ncpl", -] - -[blocks.griddata.fields.longitude] -type = "array" -longname = "cell center longitude" -description = "cell center longitude array. Only supported for NETCDF_STRUCTURED export type. See the latitude description for usage notes." -optional = true -dtype = "double" -shape = [ - "ncpl", -] - -[memory.attr_off] -set_in = "ar" -source = "modflow6_attr_off" -type = "logical" - -[memory.ncpl] -set_in = "ar" -source = "ncpl" -type = "integer" - -[memory.latitude] -type = "array" -set_in = "ar" -source = "latitude" -dtype = "double" -shape = [ - "ncpl", -] - -[memory.longitude] -type = "array" -set_in = "ar" -source = "longitude" -dtype = "double" -shape = [ - "ncpl", -] diff --git a/flopy4/mf6/dfns/utl-obs.toml b/flopy4/mf6/dfns/utl-obs.toml deleted file mode 100644 index b4f307bd5..000000000 --- a/flopy4/mf6/dfns/utl-obs.toml +++ /dev/null @@ -1,91 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "utl-obs" -ftype = "OBS6" -subtype = "utility" -parent = [ - "model", - "package", -] - -[blocks.options.fields.digits] -type = "integer" -description = "Keyword and an integer digits specifier used for conversion of simulated values to text on output. If not specified, the default is the maximum number of digits stored in the program (as written with the G0 Fortran specifier). When simulated values are written to a comma-separated value text file specified in a CONTINUOUS block below, the digits specifier controls the number of significant digits with which simulated values are written to the output file. The digits specifier has no effect on the number of significant digits with which the simulation time is written for continuous observations. If DIGITS is specified as zero, then observations are written with the default setting, which is the maximum number of digits." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of observation information will be written to the listing file immediately after it is read." -optional = true - -[blocks.continuous.fields.continuous] -type = "list" - -[blocks.continuous.fields.continuous.item] -name = "continuous" -type = "record" - -[blocks.continuous.fields.continuous.item.fields.obsname] -type = "string" -longname = "observation name" -description = "string of 1 to 40 nonblank characters used to identify the observation. The identifier need not be unique; however, identification and post-processing of observations in the output files are facilitated if each observation is given a unique name." -tagged = false - -[blocks.continuous.fields.continuous.item.fields.obstype] -type = "string" -longname = "observation type" -description = "a string of characters used to identify the observation type." -tagged = false - -[blocks.continuous.fields.continuous.item.fields.id] -type = "union" -longname = "time" -description = "Text identifying cell where observation is located. For packages other than NPF, if boundary names are defined in the corresponding package input file, ID can be a boundary name. Otherwise ID is a cellid. If the model discretization is type DIS, cellid is three integers (layer, row, column). If the discretization is DISV, cellid is two integers (layer, cell number). If the discretization is DISU, cellid is one integer (node number)." - -[blocks.continuous.fields.continuous.item.fields.id.arms.cellid] -type = "cellid" -tagged = false - -[blocks.continuous.fields.continuous.item.fields.id.arms.index] -type = "integer" -tagged = false -index = true - -[blocks.continuous.fields.continuous.item.fields.id.arms.boundname] -type = "string" -tagged = false - -[blocks.continuous.fields.continuous.item.fields.id2] -type = "union" -longname = "time" -description = "Text identifying cell adjacent to cell identified by ID. The form of ID2 is as described for ID. ID2 is used for intercell-flow observations of a GWF model, for three observation types of the LAK Package, for two observation types of the MAW Package, and one observation type of the UZF Package." -optional = true - -[blocks.continuous.fields.continuous.item.fields.id2.arms.cellid] -type = "cellid" -tagged = false - -[blocks.continuous.fields.continuous.item.fields.id2.arms.index] -type = "integer" -tagged = false -index = true - -[blocks.continuous.fields.continuous.item.fields.id2.arms.boundname] -type = "string" -tagged = false - -[blocks.continuous.header.field] -name = "output" -type = "record" - -[blocks.continuous.header.field.fields.obs_output_file_name] -type = "file" -description = "Name of a file to which simulated values corresponding to observations in the block are to be written. The file name can be an absolute or relative path name. A unique output file must be specified for each CONTINUOUS block. If the 'BINARY' option is used, output is written in binary form. By convention, text output files have the extension 'csv' (for 'Comma-Separated Values') and binary output files have the extension 'bsv' (for 'Binary Simulated Values')." -tagged = false -direction = "out" - -[blocks.continuous.header.field.fields.binary] -type = "keyword" -description = "an optional keyword used to indicate that the output file should be written in binary (unformatted) form." -optional = true diff --git a/flopy4/mf6/dfns/utl-sfrtab.toml b/flopy4/mf6/dfns/utl-sfrtab.toml deleted file mode 100644 index 45c4e5ef3..000000000 --- a/flopy4/mf6/dfns/utl-sfrtab.toml +++ /dev/null @@ -1,62 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "utl-sfrtab" -parent = "gwf-sfr" -ftype = "SFRTAB6" -multi = true -subtype = "utility" - -[dims.nrow] -value = "nrow" - -[dims.ncol] -value = "ncol" - -[blocks.dimensions.fields.nrow] -type = "integer" -longname = "number of table rows" -description = "integer value specifying the number of rows in the reach cross-section table. There must be NROW rows of data in the TABLE block." - -[blocks.dimensions.fields.ncol] -type = "integer" -longname = "number of table columns" -description = "integer value specifying the number of columns in the reach cross-section table. There must be NCOL columns of data in the TABLE block. NCOL must be equal to 2 if MANFRACTION is not specified or 3 otherwise." - -[blocks.table.fields.table] -type = "list" -shape = [ - "nrow", -] - -[blocks.table.fields.table.item] -name = "table" -type = "record" - -[blocks.table.fields.table.item.fields.xfraction] -type = "double" -longname = "fractional width" -description = "real value that defines the station (x) data for the cross-section as a fraction of the width (RWID) of the reach. XFRACTION must be greater than or equal to zero but can be greater than one. XFRACTION values can be used to decrease or increase the width of a reach from the specified reach width (RWID)." -tagged = false - -[blocks.table.fields.table.item.fields.height] -type = "double" -longname = "depth" -description = "real value that is the height relative to the top of the lowest elevation of the streambed (RTP) and corresponding to the station data on the same line. HEIGHT must be greater than or equal to zero and at least one cross-section height must be equal to zero." -tagged = false - -[blocks.table.fields.table.item.fields.manfraction] -type = "double" -longname = "Manning's roughness coefficient" -description = "real value that defines the Manning's roughness coefficient data for the cross-section as a fraction of the Manning's roughness coefficient for the reach (MAN) and corresponding to the station data on the same line. MANFRACTION must be greater than zero. MANFRACTION is applied from the XFRACTION value on the same line to the XFRACTION value on the next line. Although a MANFRACTION value is specified on the last line, any value greater than zero can be applied to MANFRACTION(NROW). MANFRACTION is only specified if NCOL is 3. If MANFRACTION is not specified, the Manning's roughness coefficient for the reach (MAN) is applied to the entire cross-section." -optional = true -tagged = false - -[memory.nrow] -set_in = "ar" -source = "nrow" -type = "integer" - -[memory.ncol] -set_in = "ar" -source = "ncol" -type = "integer" diff --git a/flopy4/mf6/dfns/utl-spc.toml b/flopy4/mf6/dfns/utl-spc.toml deleted file mode 100644 index a089ad8d1..000000000 --- a/flopy4/mf6/dfns/utl-spc.toml +++ /dev/null @@ -1,99 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "utl-spc" -ftype = "SPC6" -multi = true -subtype = "utility" -parent = [ - "gwe-ssm", - "gwt-ssm", -] - -[dims.maxbound] -value = "maxbound" - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of spc information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.dimensions.fields.maxbound] -type = "integer" -longname = "maximum number of ssm entries" -description = "integer value specifying the maximum number of spc cells that will be specified for use during any stress period." - -[blocks.period.fields.stress_period_data] -type = "list" -shape = [ - "<=maxbound", -] - -[blocks.period.fields.stress_period_data.item] -name = "perioddata" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.bndno] -type = "integer" -longname = "bound number for this entry" -description = "integer value that defines the boundary package feature number associated with the specified PERIOD data on the line. BNDNO must be greater than zero and less than or equal to MAXBOUND." -tagged = false -index = true -pk = true - -[blocks.period.fields.stress_period_data.item.fields.bndno.fk] -key = "bound" -rule = "ssm_package" - -[blocks.period.fields.stress_period_data.item.fields.spcsetting] -type = "union" -description = "line of information that is parsed into a keyword and values. Keyword values that can be used to start the SPCSETTING string include: CONCENTRATION and TEMPERATURE." - -[blocks.period.fields.stress_period_data.item.fields.spcsetting.arms.concentration] -type = "double" -longname = "boundary concentration" -description = "is the boundary concentration. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, the CONCENTRATION for each boundary feature is zero." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.spcsetting.arms.temperature] -type = "double" -longname = "boundary temperature" -description = "is the user-supplied boundary temperature. If the Options block includes a TIMESERIESFILE entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, the TEMPERATURE for each boundary feature is zero." -time_series = true - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.maxbound] -set_in = "ar" -source = "maxbound" -type = "integer" diff --git a/flopy4/mf6/dfns/utl-spca.toml b/flopy4/mf6/dfns/utl-spca.toml deleted file mode 100644 index b1f42eeff..000000000 --- a/flopy4/mf6/dfns/utl-spca.toml +++ /dev/null @@ -1,76 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "utl-spca" -ftype = "SPC6" -multi = true -subtype = "utility" -parent = [ - "gwe-ssm", - "gwt-ssm", -] - -[blocks.options.fields.readasarrays] -type = "keyword" -longname = "use array-based input" -description = "indicates that array-based input will be used for the SPC Package. This keyword must be specified to use array-based input. When READASARRAYS is specified, values must be provided for every cell within a model layer, even those cells that have an IDOMAIN value less than one. Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results." -default = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that the list of spc information will be written to the listing file immediately after it is read." -optional = true - -[blocks.options.fields.tas_filerecord] -type = "list" -optional = true - -[blocks.options.fields.tas_filerecord.item] -name = "tas_filerecord" -type = "record" - -[blocks.options.fields.tas_filerecord.item.fields.tas6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-array-series file." - -[blocks.options.fields.tas_filerecord.item.fields.tas6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-array-series file defining a time-array series that can be used to assign time-varying values. See the Time-Variable Input section for instructions on using the time-array series capability." -tagged = false -direction = "in" -component = "utl-tas" - -[blocks.period.fields.concentration] -type = "array" -longname = "concentration" -description = "is the concentration of the associated Recharge or Evapotranspiration stress package. The concentration array may be defined by a time-array series (see the \"Using Time-Array Series in a Package\" section)." -optional = true -dtype = "double" -time_series = true -shape = [ - "ncpl", -] - -[blocks.period.fields.temperature] -type = "array" -longname = "temperature" -description = "is the temperature of the associated Recharge or Evapotranspiration stress package. The temperature array may be defined by a time-array series (see the \"Using Time-Array Series in a Package\" section)." -optional = true -dtype = "double" -time_series = true -shape = [ - "ncpl", -] - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true diff --git a/flopy4/mf6/dfns/utl-tas.toml b/flopy4/mf6/dfns/utl-tas.toml deleted file mode 100644 index 8a5ac5258..000000000 --- a/flopy4/mf6/dfns/utl-tas.toml +++ /dev/null @@ -1,79 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "utl-tas" -ftype = "TAS6" -multi = true -subtype = "utility" -parent = [ - "gwf-evta", - "gwf-rcha", - "utl-spca", -] - -[dims.time_series_name] -value = "len(time_series_name)" - -[blocks.attributes.fields.time_series_namerecord] -type = "record" -description = "xxx" - -[blocks.attributes.fields.time_series_namerecord.fields.name] -type = "keyword" -description = "xxx" - -[blocks.attributes.fields.time_series_namerecord.fields.time_series_name] -type = "array" -description = "Name by which a package references a particular time-array series. The name must be unique among all time-array series used in a package." -tagged = false -dtype = "string" - -[blocks.attributes.fields.interpolation_methodrecord] -type = "record" -description = "xxx" -optional = true - -[blocks.attributes.fields.interpolation_methodrecord.fields.method] -type = "keyword" -description = " xxx" - -[blocks.attributes.fields.interpolation_methodrecord.fields.interpolation_method] -type = "string" -description = "Interpolation method, which is either STEPWISE or LINEAR." -tagged = false -valid = [ - "stepwise", - "linear", -] - -[blocks.attributes.fields.sfacrecord] -type = "record" -description = "xxx" -optional = true - -[blocks.attributes.fields.sfacrecord.fields.sfac] -type = "keyword" -description = " xxx" - -[blocks.attributes.fields.sfacrecord.fields.sfacval] -type = "array" -description = "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0." -tagged = false -dtype = "double" -shape = [ - "time_series_name", -] - -[blocks.time.fields.tas_array] -type = "array" -description = "An array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility." -tagged = false -dtype = "double" -shape = [ - "ncpl", -] - -[blocks.time.header.field] -name = "time_from_model_start" -type = "double" -description = "A numeric time relative to the start of the simulation, in the time unit used in the simulation. Times must be strictly increasing." -tagged = false diff --git a/flopy4/mf6/dfns/utl-ts.toml b/flopy4/mf6/dfns/utl-ts.toml deleted file mode 100644 index 54ee6098b..000000000 --- a/flopy4/mf6/dfns/utl-ts.toml +++ /dev/null @@ -1,119 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "utl-ts" -parent = "package" -ftype = "TS6" -multi = true -subtype = "utility" - -[dims.time_series_names] -value = "len(time_series_names)" - -[blocks.attributes.fields.time_series_namerecord] -type = "record" -description = "xxx" - -[blocks.attributes.fields.time_series_namerecord.fields.names] -type = "keyword" -description = "keyword to specify the names of the time series. The 'NAME' keyword can be used as a substitute for 'NAMES'." -aliases = [ - "name", -] - -[blocks.attributes.fields.time_series_namerecord.fields.time_series_names] -type = "array" -description = "Name by which a package references a particular time-array series. The name must be unique among all time-array series used in a package." -tagged = false -dtype = "string" - -[blocks.attributes.fields.interpolation_methodrecord] -type = "record" -description = "xxx" -optional = true - -[blocks.attributes.fields.interpolation_methodrecord.fields.methods] -type = "keyword" -description = " xxx" - -[blocks.attributes.fields.interpolation_methodrecord.fields.interpolation_method] -type = "array" -description = "Interpolation method, which is either STEPWISE or LINEAR." -tagged = false -dtype = "string" -shape = [ - "time_series_names", -] - -[blocks.attributes.fields.interpolation_methodrecord_single] -type = "record" -description = "xxx" -optional = true - -[blocks.attributes.fields.interpolation_methodrecord_single.fields.method] -type = "keyword" -description = " xxx" - -[blocks.attributes.fields.interpolation_methodrecord_single.fields.interpolation_method_single] -type = "string" -description = "Interpolation method, which is either STEPWISE or LINEAR." -tagged = false -valid = [ - "stepwise", - "linear", - "linearend", -] - -[blocks.attributes.fields.sfacrecord] -type = "record" -description = "xxx" -optional = true - -[blocks.attributes.fields.sfacrecord.fields.sfacs] -type = "keyword" -description = " xxx" - -[blocks.attributes.fields.sfacrecord.fields.sfacval] -type = "array" -description = "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0." -tagged = false -dtype = "double" -shape = [ - "time_series_names", -] - -[blocks.attributes.fields.sfacrecord_single] -type = "record" -description = "xxx" -optional = true - -[blocks.attributes.fields.sfacrecord_single.fields.sfac] -type = "keyword" -description = " xxx" - -[blocks.attributes.fields.sfacrecord_single.fields.sfacval] -type = "double" -description = "Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0." -tagged = false - -[blocks.timeseries.fields.timeseries] -type = "list" -description = "xxx" - -[blocks.timeseries.fields.timeseries.item] -name = "timeseries" -type = "record" -description = "xxx" - -[blocks.timeseries.fields.timeseries.item.fields.ts_time] -type = "double" -description = "A numeric time relative to the start of the simulation, in the time unit used in the simulation. Times must be strictly increasing." -tagged = false - -[blocks.timeseries.fields.timeseries.item.fields.ts_array] -type = "array" -description = "A 2-D array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility." -tagged = false -dtype = "double" -shape = [ - "time_series_names", -] diff --git a/flopy4/mf6/dfns/utl-tvk.toml b/flopy4/mf6/dfns/utl-tvk.toml deleted file mode 100644 index 093c4b21e..000000000 --- a/flopy4/mf6/dfns/utl-tvk.toml +++ /dev/null @@ -1,79 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "utl-tvk" -parent = "gwf-npf" -ftype = "TVK6" -subtype = "utility" - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that information for each change to the hydraulic conductivity in a cell will be written to the model listing file." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "perioddata" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.tvksetting] -type = "union" -description = "line of information that is parsed into a property name keyword and values. Property name keywords that can be used to start the TVKSETTING string include: K, K22, and K33." - -[blocks.period.fields.stress_period_data.item.fields.tvksetting.arms.k] -type = "double" -longname = "hydraulic conductivity (L/T)" -description = "is the new value to be assigned as the cell's hydraulic conductivity from the start of the specified stress period, as per K in the NPF package. If the OPTIONS block includes a TS6 entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.tvksetting.arms.k22] -type = "double" -longname = "hydraulic conductivity of second ellipsoid axis (L/T)" -description = "is the new value to be assigned as the cell's hydraulic conductivity of the second ellipsoid axis (or the ratio of K22/K if the K22OVERK NPF package option is specified) from the start of the specified stress period, as per K22 in the NPF package. For an unrotated case this is the hydraulic conductivity in the y direction. If the OPTIONS block includes a TS6 entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.tvksetting.arms.k33] -type = "double" -longname = "hydraulic conductivity of third ellipsoid axis (L/T)" -description = "is the new value to be assigned as the cell's hydraulic conductivity of the third ellipsoid axis (or the ratio of K33/K if the K33OVERK NPF package option is specified) from the start of the specified stress period, as per K33 in the NPF package. For an unrotated case, this is the vertical hydraulic conductivity. If the OPTIONS block includes a TS6 entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true diff --git a/flopy4/mf6/dfns/utl-tvs.toml b/flopy4/mf6/dfns/utl-tvs.toml deleted file mode 100644 index bb2853cf1..000000000 --- a/flopy4/mf6/dfns/utl-tvs.toml +++ /dev/null @@ -1,84 +0,0 @@ -type = "package" -schema_version = "2.0.0.dev3" -name = "utl-tvs" -parent = "gwf-sto" -ftype = "TVS6" -subtype = "utility" - -[blocks.options.fields.disable_storage_change_integration] -type = "keyword" -longname = "deactivate storage change integration" -description = "keyword that deactivates inclusion of storage derivative terms in the STO package matrix formulation. In the absence of this keyword (the default), the groundwater storage formulation will be modified to correctly adjust heads based on transient variations in stored water volumes arising from changes to SS and SY properties." -optional = true - -[blocks.options.fields.print_input] -type = "keyword" -longname = "print input to listing file" -description = "keyword to indicate that information for each change to a storage property in a cell will be written to the model listing file." -optional = true - -[blocks.options.fields.ts_filerecord] -type = "list" -optional = true - -[blocks.options.fields.ts_filerecord.item] -name = "ts_filerecord" -type = "record" - -[blocks.options.fields.ts_filerecord.item.fields.ts6] -type = "keyword" -longname = "head keyword" -description = "keyword to specify that record corresponds to a time-series file." - -[blocks.options.fields.ts_filerecord.item.fields.ts6_filename] -type = "file" -longname = "file name of time series information" -description = "defines a time-series file defining time series that can be used to assign time-varying values. See the 'Time-Variable Input' section for instructions on using the time-series capability." -tagged = false -direction = "in" -component = "utl-ts" - -[blocks.period.fields.stress_period_data] -type = "list" - -[blocks.period.fields.stress_period_data.item] -name = "perioddata" -type = "record" - -[blocks.period.fields.stress_period_data.item.fields.cellid] -type = "cellid" -longname = "cell identifier" -description = "is the cell identifier, and depends on the type of grid that is used for the simulation. For a structured grid that uses the DIS input file, CELLID is the layer, row, and column. For a grid that uses the DISV input file, CELLID is the layer and CELL2D number. If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell." -tagged = false - -[blocks.period.fields.stress_period_data.item.fields.tvssetting] -type = "union" -description = "line of information that is parsed into a property name keyword and values. Property name keywords that can be used to start the TVSSETTING string include: SS and SY." - -[blocks.period.fields.stress_period_data.item.fields.tvssetting.arms.ss] -type = "double" -longname = "specific storage" -description = "is the new value to be assigned as the cell's specific storage (or storage coefficient if the STORAGECOEFFICIENT STO package option is specified) from the start of the specified stress period, as per SS in the STO package. Specific storage values must be greater than or equal to 0. If the OPTIONS block includes a TS6 entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.fields.stress_period_data.item.fields.tvssetting.arms.sy] -type = "double" -longname = "specific yield" -description = "is the new value to be assigned as the cell's specific yield from the start of the specified stress period, as per SY in the STO package. Specific yield values must be greater than or equal to 0. If the OPTIONS block includes a TS6 entry (see the 'Time-Variable Input' section), values can be obtained from a time series by entering the time-series name in place of a numeric value." -time_series = true - -[blocks.period.header] -fill_forward = true - -[blocks.period.header.field] -name = "iper" -type = "integer" -longname = "stress period number" -description = "integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block." -tagged = false -index = true - -[memory.disable_sc_int] -set_in = "ar" -source = "disable_storage_change_integration" -type = "logical" diff --git a/flopy4/mf6/exg/chfgwf.py b/flopy4/mf6/exg/chfgwf.py index e9c31d410..8e4f52494 100644 --- a/flopy4/mf6/exg/chfgwf.py +++ b/flopy4/mf6/exg/chfgwf.py @@ -54,6 +54,7 @@ class Exchangedata(Item): exchangedata: Optional[list[Exchangedata]] = list_( default=None, block="exchangedata", + tagged=False, shape=("nexg",), ) diff --git a/flopy4/mf6/exg/gwegwe.py b/flopy4/mf6/exg/gwegwe.py index 0c1b0e7a5..82bdabfaa 100644 --- a/flopy4/mf6/exg/gwegwe.py +++ b/flopy4/mf6/exg/gwegwe.py @@ -109,6 +109,7 @@ class Exchangedata(Item): exchangedata: Optional[list[Exchangedata]] = list_( default=None, block="exchangedata", + tagged=False, shape=("nexg",), ) diff --git a/flopy4/mf6/exg/gwfgwf.py b/flopy4/mf6/exg/gwfgwf.py index 0ee9c8771..8935edfdf 100644 --- a/flopy4/mf6/exg/gwfgwf.py +++ b/flopy4/mf6/exg/gwfgwf.py @@ -112,6 +112,7 @@ class Exchangedata(Item): exchangedata: Optional[list[Exchangedata]] = list_( default=None, block="exchangedata", + tagged=False, shape=("nexg",), ) diff --git a/flopy4/mf6/exg/gwtgwt.py b/flopy4/mf6/exg/gwtgwt.py index ed6f6d212..493a52f90 100644 --- a/flopy4/mf6/exg/gwtgwt.py +++ b/flopy4/mf6/exg/gwtgwt.py @@ -109,6 +109,7 @@ class Exchangedata(Item): exchangedata: Optional[list[Exchangedata]] = list_( default=None, block="exchangedata", + tagged=False, shape=("nexg",), ) diff --git a/flopy4/mf6/exg/olfgwf.py b/flopy4/mf6/exg/olfgwf.py index 545985fd1..3a173ab39 100644 --- a/flopy4/mf6/exg/olfgwf.py +++ b/flopy4/mf6/exg/olfgwf.py @@ -54,6 +54,7 @@ class Exchangedata(Item): exchangedata: Optional[list[Exchangedata]] = list_( default=None, block="exchangedata", + tagged=False, shape=("nexg",), ) diff --git a/flopy4/mf6/gwe/ctp.py b/flopy4/mf6/gwe/ctp.py index b9817d5cb..d8b9e589e 100644 --- a/flopy4/mf6/gwe/ctp.py +++ b/flopy4/mf6/gwe/ctp.py @@ -89,6 +89,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/gwe/disu.py b/flopy4/mf6/gwe/disu.py index 53c9d1716..d3d3c9dfb 100644 --- a/flopy4/mf6/gwe/disu.py +++ b/flopy4/mf6/gwe/disu.py @@ -172,11 +172,13 @@ class Cell2d(Item): vertices: Optional[list[Vertices]] = list_( default=None, block="vertices", + tagged=False, shape=("nvert",), ) cell2d: Optional[list[Cell2d]] = list_( default=None, block="cell2d", + tagged=False, shape=("nodes",), ) diff --git a/flopy4/mf6/gwe/disv.py b/flopy4/mf6/gwe/disv.py index 67a300ea0..9c7c406e6 100644 --- a/flopy4/mf6/gwe/disv.py +++ b/flopy4/mf6/gwe/disv.py @@ -134,11 +134,13 @@ class Cell2d(Item): vertices: Optional[list[Vertices]] = list_( default=None, block="vertices", + tagged=False, shape=("nvert",), ) cell2d: Optional[list[Cell2d]] = list_( default=None, block="cell2d", + tagged=False, shape=("ncpl",), ) diff --git a/flopy4/mf6/gwe/esl.py b/flopy4/mf6/gwe/esl.py index 4c24cdf5d..a58ab3353 100644 --- a/flopy4/mf6/gwe/esl.py +++ b/flopy4/mf6/gwe/esl.py @@ -90,6 +90,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/gwe/fmi.py b/flopy4/mf6/gwe/fmi.py index 975ca22ea..89bbdebec 100644 --- a/flopy4/mf6/gwe/fmi.py +++ b/flopy4/mf6/gwe/fmi.py @@ -34,6 +34,7 @@ class Packagedata(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, ) diff --git a/flopy4/mf6/gwe/lke.py b/flopy4/mf6/gwe/lke.py index 0b355b099..bfe0341ed 100644 --- a/flopy4/mf6/gwe/lke.py +++ b/flopy4/mf6/gwe/lke.py @@ -190,6 +190,7 @@ class StressPeriodData(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, write_if_empty=True, ) _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( @@ -198,6 +199,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) diff --git a/flopy4/mf6/gwe/mwe.py b/flopy4/mf6/gwe/mwe.py index e185b8ab6..8ff39d897 100644 --- a/flopy4/mf6/gwe/mwe.py +++ b/flopy4/mf6/gwe/mwe.py @@ -171,6 +171,7 @@ class StressPeriodData(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, write_if_empty=True, ) _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( @@ -179,6 +180,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) diff --git a/flopy4/mf6/gwe/sfe.py b/flopy4/mf6/gwe/sfe.py index 021c00aa2..c72ec8d72 100644 --- a/flopy4/mf6/gwe/sfe.py +++ b/flopy4/mf6/gwe/sfe.py @@ -190,6 +190,7 @@ class StressPeriodData(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, write_if_empty=True, ) _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( @@ -198,6 +199,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) diff --git a/flopy4/mf6/gwe/ssm.py b/flopy4/mf6/gwe/ssm.py index b37f76c49..b801e83ac 100644 --- a/flopy4/mf6/gwe/ssm.py +++ b/flopy4/mf6/gwe/ssm.py @@ -49,11 +49,13 @@ class Fileinput(Item): sources: Optional[list[Sources]] = list_( default=None, block="sources", + tagged=False, write_if_empty=True, ) fileinput: Optional[list[Fileinput]] = list_( default=None, block="fileinput", + tagged=False, ) diff --git a/flopy4/mf6/gwe/uze.py b/flopy4/mf6/gwe/uze.py index 080e55c04..3fe7700ef 100644 --- a/flopy4/mf6/gwe/uze.py +++ b/flopy4/mf6/gwe/uze.py @@ -178,6 +178,7 @@ class StressPeriodData(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, write_if_empty=True, ) _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( @@ -186,6 +187,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) diff --git a/flopy4/mf6/gwf/buy.py b/flopy4/mf6/gwf/buy.py index 67578de75..39aea7578 100644 --- a/flopy4/mf6/gwf/buy.py +++ b/flopy4/mf6/gwf/buy.py @@ -50,6 +50,7 @@ class Packagedata(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, shape=("nrhospecies",), ) diff --git a/flopy4/mf6/gwf/chd.py b/flopy4/mf6/gwf/chd.py index 8bffd7e20..317cb2699 100644 --- a/flopy4/mf6/gwf/chd.py +++ b/flopy4/mf6/gwf/chd.py @@ -89,6 +89,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/gwf/csub.py b/flopy4/mf6/gwf/csub.py index 3d6159b5a..87e16edea 100644 --- a/flopy4/mf6/gwf/csub.py +++ b/flopy4/mf6/gwf/csub.py @@ -324,6 +324,7 @@ class StressPeriodData(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, shape=("ninterbeds",), ) _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( @@ -332,6 +333,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, shape=("<=maxsig0",), ) diff --git a/flopy4/mf6/gwf/disu.py b/flopy4/mf6/gwf/disu.py index fa5c73027..2724be690 100644 --- a/flopy4/mf6/gwf/disu.py +++ b/flopy4/mf6/gwf/disu.py @@ -172,11 +172,13 @@ class Cell2d(Item): vertices: Optional[list[Vertices]] = list_( default=None, block="vertices", + tagged=False, shape=("nvert",), ) cell2d: Optional[list[Cell2d]] = list_( default=None, block="cell2d", + tagged=False, shape=("nodes",), ) diff --git a/flopy4/mf6/gwf/disv.py b/flopy4/mf6/gwf/disv.py index 136f3e2e6..58eaa3ea9 100644 --- a/flopy4/mf6/gwf/disv.py +++ b/flopy4/mf6/gwf/disv.py @@ -134,11 +134,13 @@ class Cell2d(Item): vertices: Optional[list[Vertices]] = list_( default=None, block="vertices", + tagged=False, shape=("nvert",), ) cell2d: Optional[list[Cell2d]] = list_( default=None, block="cell2d", + tagged=False, shape=("ncpl",), ) diff --git a/flopy4/mf6/gwf/drn.py b/flopy4/mf6/gwf/drn.py index a89074b85..c94a463a1 100644 --- a/flopy4/mf6/gwf/drn.py +++ b/flopy4/mf6/gwf/drn.py @@ -106,6 +106,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/gwf/evt.py b/flopy4/mf6/gwf/evt.py index cecfeb411..b866f121e 100644 --- a/flopy4/mf6/gwf/evt.py +++ b/flopy4/mf6/gwf/evt.py @@ -117,6 +117,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/gwf/ghb.py b/flopy4/mf6/gwf/ghb.py index ca1c7b034..4e514433f 100644 --- a/flopy4/mf6/gwf/ghb.py +++ b/flopy4/mf6/gwf/ghb.py @@ -100,6 +100,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/gwf/gnc.py b/flopy4/mf6/gwf/gnc.py index c14705297..7df80c41d 100644 --- a/flopy4/mf6/gwf/gnc.py +++ b/flopy4/mf6/gwf/gnc.py @@ -53,6 +53,7 @@ class Gncdata(Item): gncdata: Optional[list[Gncdata]] = list_( default=None, block="gncdata", + tagged=False, shape=("numgnc",), ) diff --git a/flopy4/mf6/gwf/hfb.py b/flopy4/mf6/gwf/hfb.py index 9a669cde7..e9ca4ec46 100644 --- a/flopy4/mf6/gwf/hfb.py +++ b/flopy4/mf6/gwf/hfb.py @@ -40,6 +40,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, shape=("<=maxhfb",), ) diff --git a/flopy4/mf6/gwf/lak.py b/flopy4/mf6/gwf/lak.py index f8fb3f310..ecc44e099 100644 --- a/flopy4/mf6/gwf/lak.py +++ b/flopy4/mf6/gwf/lak.py @@ -342,21 +342,25 @@ class Auxiliary(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, shape=("nlakes",), ) connectiondata: Optional[list[Connectiondata]] = list_( default=None, block="connectiondata", + tagged=False, write_if_empty=True, ) tables: Optional[list[Tables]] = list_( default=None, block="tables", + tagged=False, shape=("ntables",), ) outlets: Optional[list[Outlets]] = list_( default=None, block="outlets", + tagged=False, shape=("noutlets",), ) _stress_period_data: Optional[dict[int, list[_StressPeriodDataItem]]] = list_( @@ -365,6 +369,7 @@ class Auxiliary(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) nlakeconn = DerivedDim("sum(packagedata.nlakeconn)") diff --git a/flopy4/mf6/gwf/maw.py b/flopy4/mf6/gwf/maw.py index d277c4536..f62731b55 100644 --- a/flopy4/mf6/gwf/maw.py +++ b/flopy4/mf6/gwf/maw.py @@ -281,16 +281,19 @@ class StressPeriodData(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, shape=("nmawwells",), ) connectiondata: Optional[list[Connectiondata]] = list_( default=None, block="connectiondata", + tagged=False, write_if_empty=True, ) angledata: Optional[list[Angledata]] = list_( default=None, block="angledata", + tagged=False, ) _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( alias="stress_period_data", @@ -298,6 +301,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) ngwfnodes = DerivedDim("sum(packagedata.ngwfnodes)") diff --git a/flopy4/mf6/gwf/mvr.py b/flopy4/mf6/gwf/mvr.py index 127146721..9f9a8413e 100644 --- a/flopy4/mf6/gwf/mvr.py +++ b/flopy4/mf6/gwf/mvr.py @@ -108,6 +108,7 @@ class StressPeriodData(Item): packages: Optional[list[Packages]] = list_( default=None, block="packages", + tagged=False, shape=("maxpackages",), ) _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( @@ -116,6 +117,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) diff --git a/flopy4/mf6/gwf/rch.py b/flopy4/mf6/gwf/rch.py index 0dee0e948..8e088050c 100644 --- a/flopy4/mf6/gwf/rch.py +++ b/flopy4/mf6/gwf/rch.py @@ -95,6 +95,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/gwf/riv.py b/flopy4/mf6/gwf/riv.py index 8b2a33e21..1cc6417c8 100644 --- a/flopy4/mf6/gwf/riv.py +++ b/flopy4/mf6/gwf/riv.py @@ -101,6 +101,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/gwf/sfr.py b/flopy4/mf6/gwf/sfr.py index 8d558b8c7..d0c416398 100644 --- a/flopy4/mf6/gwf/sfr.py +++ b/flopy4/mf6/gwf/sfr.py @@ -322,24 +322,29 @@ class StressPeriodData(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, shape=("nreaches",), ) crosssections: Optional[list[Crosssections]] = list_( default=None, block="crosssections", + tagged=False, ) connectiondata: Optional[list[Connectiondata]] = list_( default=None, block="connectiondata", + tagged=False, shape=("nreaches",), ) diversions: Optional[list[Diversions]] = list_( default=None, block="diversions", + tagged=False, ) initialstages: Optional[list[Initialstages]] = list_( default=None, block="initialstages", + tagged=False, shape=("nreaches",), ) _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( @@ -348,6 +353,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) diff --git a/flopy4/mf6/gwf/sto.py b/flopy4/mf6/gwf/sto.py index 0c13b9289..a833b84d9 100644 --- a/flopy4/mf6/gwf/sto.py +++ b/flopy4/mf6/gwf/sto.py @@ -84,4 +84,5 @@ class Sto(Package): block="period", fill_forward=True, valid=("steady-state", "transient"), + tagged=False, ) diff --git a/flopy4/mf6/gwf/uzf.py b/flopy4/mf6/gwf/uzf.py index cde9d268c..7b5f2a5fb 100644 --- a/flopy4/mf6/gwf/uzf.py +++ b/flopy4/mf6/gwf/uzf.py @@ -226,6 +226,7 @@ class StressPeriodData(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, shape=("nuzfcells",), ) _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( @@ -234,6 +235,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) diff --git a/flopy4/mf6/gwf/vsc.py b/flopy4/mf6/gwf/vsc.py index f56caa416..853a84af8 100644 --- a/flopy4/mf6/gwf/vsc.py +++ b/flopy4/mf6/gwf/vsc.py @@ -74,6 +74,7 @@ class Packagedata(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, shape=("nviscspecies",), ) diff --git a/flopy4/mf6/gwf/wel.py b/flopy4/mf6/gwf/wel.py index 7f547108e..89504acd1 100644 --- a/flopy4/mf6/gwf/wel.py +++ b/flopy4/mf6/gwf/wel.py @@ -127,6 +127,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/gwt/cnc.py b/flopy4/mf6/gwt/cnc.py index 9c5677aa3..a718263aa 100644 --- a/flopy4/mf6/gwt/cnc.py +++ b/flopy4/mf6/gwt/cnc.py @@ -89,6 +89,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/gwt/disu.py b/flopy4/mf6/gwt/disu.py index 2040f19c4..8dd515a4b 100644 --- a/flopy4/mf6/gwt/disu.py +++ b/flopy4/mf6/gwt/disu.py @@ -172,11 +172,13 @@ class Cell2d(Item): vertices: Optional[list[Vertices]] = list_( default=None, block="vertices", + tagged=False, shape=("nvert",), ) cell2d: Optional[list[Cell2d]] = list_( default=None, block="cell2d", + tagged=False, shape=("nodes",), ) diff --git a/flopy4/mf6/gwt/disv.py b/flopy4/mf6/gwt/disv.py index 44d9a86b3..87033ba57 100644 --- a/flopy4/mf6/gwt/disv.py +++ b/flopy4/mf6/gwt/disv.py @@ -134,11 +134,13 @@ class Cell2d(Item): vertices: Optional[list[Vertices]] = list_( default=None, block="vertices", + tagged=False, shape=("nvert",), ) cell2d: Optional[list[Cell2d]] = list_( default=None, block="cell2d", + tagged=False, shape=("ncpl",), ) diff --git a/flopy4/mf6/gwt/fmi.py b/flopy4/mf6/gwt/fmi.py index a35e960eb..39db0e013 100644 --- a/flopy4/mf6/gwt/fmi.py +++ b/flopy4/mf6/gwt/fmi.py @@ -34,6 +34,7 @@ class Packagedata(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, ) diff --git a/flopy4/mf6/gwt/lkt.py b/flopy4/mf6/gwt/lkt.py index b33ec1ac5..25500343d 100644 --- a/flopy4/mf6/gwt/lkt.py +++ b/flopy4/mf6/gwt/lkt.py @@ -188,6 +188,7 @@ class StressPeriodData(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, write_if_empty=True, ) _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( @@ -196,6 +197,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) diff --git a/flopy4/mf6/gwt/mwt.py b/flopy4/mf6/gwt/mwt.py index 6e0bb1876..c1cdabc07 100644 --- a/flopy4/mf6/gwt/mwt.py +++ b/flopy4/mf6/gwt/mwt.py @@ -169,6 +169,7 @@ class StressPeriodData(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, write_if_empty=True, ) _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( @@ -177,6 +178,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) diff --git a/flopy4/mf6/gwt/sft.py b/flopy4/mf6/gwt/sft.py index c2ea1b97b..fc24538f1 100644 --- a/flopy4/mf6/gwt/sft.py +++ b/flopy4/mf6/gwt/sft.py @@ -187,6 +187,7 @@ class StressPeriodData(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, write_if_empty=True, ) _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( @@ -195,6 +196,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) diff --git a/flopy4/mf6/gwt/src.py b/flopy4/mf6/gwt/src.py index 736e7f26b..a50ab96ec 100644 --- a/flopy4/mf6/gwt/src.py +++ b/flopy4/mf6/gwt/src.py @@ -96,6 +96,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/gwt/ssm.py b/flopy4/mf6/gwt/ssm.py index 6d0b6b00c..fdb8be243 100644 --- a/flopy4/mf6/gwt/ssm.py +++ b/flopy4/mf6/gwt/ssm.py @@ -49,11 +49,13 @@ class Fileinput(Item): sources: Optional[list[Sources]] = list_( default=None, block="sources", + tagged=False, write_if_empty=True, ) fileinput: Optional[list[Fileinput]] = list_( default=None, block="fileinput", + tagged=False, ) diff --git a/flopy4/mf6/gwt/uzt.py b/flopy4/mf6/gwt/uzt.py index befb1be95..3609bae02 100644 --- a/flopy4/mf6/gwt/uzt.py +++ b/flopy4/mf6/gwt/uzt.py @@ -175,6 +175,7 @@ class StressPeriodData(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, write_if_empty=True, ) _stress_period_data: Optional[dict[int, list[StressPeriodData]]] = list_( @@ -183,6 +184,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) diff --git a/flopy4/mf6/olf/cdb.py b/flopy4/mf6/olf/cdb.py index 559cedec5..ee9254f90 100644 --- a/flopy4/mf6/olf/cdb.py +++ b/flopy4/mf6/olf/cdb.py @@ -81,6 +81,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/olf/chd.py b/flopy4/mf6/olf/chd.py index 7c23f5c9c..77841f5e2 100644 --- a/flopy4/mf6/olf/chd.py +++ b/flopy4/mf6/olf/chd.py @@ -89,6 +89,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/olf/disv1d.py b/flopy4/mf6/olf/disv1d.py index 4119c8079..ec79f251c 100644 --- a/flopy4/mf6/olf/disv1d.py +++ b/flopy4/mf6/olf/disv1d.py @@ -124,11 +124,13 @@ class Cell2d(Item): vertices: Optional[list[Vertices]] = list_( default=None, block="vertices", + tagged=False, shape=("nvert",), ) cell2d: Optional[list[Cell2d]] = list_( default=None, block="cell2d", + tagged=False, shape=("nodes",), ) diff --git a/flopy4/mf6/olf/disv2d.py b/flopy4/mf6/olf/disv2d.py index 98362597e..c60eae7f7 100644 --- a/flopy4/mf6/olf/disv2d.py +++ b/flopy4/mf6/olf/disv2d.py @@ -110,11 +110,13 @@ class Cell2d(Item): vertices: Optional[list[Vertices]] = list_( default=None, block="vertices", + tagged=False, shape=("nvert",), ) cell2d: Optional[list[Cell2d]] = list_( default=None, block="cell2d", + tagged=False, shape=("nodes",), ) diff --git a/flopy4/mf6/olf/evp.py b/flopy4/mf6/olf/evp.py index a99b84220..5feba0edf 100644 --- a/flopy4/mf6/olf/evp.py +++ b/flopy4/mf6/olf/evp.py @@ -89,6 +89,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/olf/flw.py b/flopy4/mf6/olf/flw.py index 3b7e2ee92..561805e0d 100644 --- a/flopy4/mf6/olf/flw.py +++ b/flopy4/mf6/olf/flw.py @@ -90,6 +90,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/olf/pcp.py b/flopy4/mf6/olf/pcp.py index 4553b055a..5e6dce6a5 100644 --- a/flopy4/mf6/olf/pcp.py +++ b/flopy4/mf6/olf/pcp.py @@ -89,6 +89,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/olf/sto.py b/flopy4/mf6/olf/sto.py index 67e1bbff9..bcae8bd45 100644 --- a/flopy4/mf6/olf/sto.py +++ b/flopy4/mf6/olf/sto.py @@ -39,4 +39,5 @@ class Sto(Package): block="period", fill_forward=True, valid=("steady-state", "transient"), + tagged=False, ) diff --git a/flopy4/mf6/olf/zdg.py b/flopy4/mf6/olf/zdg.py index 8708ca736..7cb93780a 100644 --- a/flopy4/mf6/olf/zdg.py +++ b/flopy4/mf6/olf/zdg.py @@ -87,6 +87,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) @property diff --git a/flopy4/mf6/prt/disv.py b/flopy4/mf6/prt/disv.py index 178a98f28..d48c38bb1 100644 --- a/flopy4/mf6/prt/disv.py +++ b/flopy4/mf6/prt/disv.py @@ -131,11 +131,13 @@ class Cell2d(Item): vertices: Optional[list[Vertices]] = list_( default=None, block="vertices", + tagged=False, shape=("nvert",), ) cell2d: Optional[list[Cell2d]] = list_( default=None, block="cell2d", + tagged=False, shape=("ncpl",), ) diff --git a/flopy4/mf6/prt/fmi.py b/flopy4/mf6/prt/fmi.py index 534f04fe3..566f59e78 100644 --- a/flopy4/mf6/prt/fmi.py +++ b/flopy4/mf6/prt/fmi.py @@ -28,6 +28,7 @@ class Packagedata(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, ) diff --git a/flopy4/mf6/prt/oc.py b/flopy4/mf6/prt/oc.py index 62b4ab13c..a13016ebe 100644 --- a/flopy4/mf6/prt/oc.py +++ b/flopy4/mf6/prt/oc.py @@ -147,6 +147,7 @@ class Print(Item): tracktimes: Optional[list[Tracktimes]] = list_( default=None, block="tracktimes", + tagged=False, shape=("ntracktimes",), ) _stress_period_data: Optional[dict[int, list[_StressPeriodDataItem]]] = list_( diff --git a/flopy4/mf6/prt/prp.py b/flopy4/mf6/prt/prp.py index 94871ac64..029280986 100644 --- a/flopy4/mf6/prt/prp.py +++ b/flopy4/mf6/prt/prp.py @@ -169,11 +169,13 @@ class Fraction(Item): packagedata: Optional[list[Packagedata]] = list_( default=None, block="packagedata", + tagged=False, shape=("nreleasepts",), ) releasetimes: Optional[list[Releasetimes]] = list_( default=None, block="releasetimes", + tagged=False, shape=("nreleasetimes",), ) _stress_period_data: Optional[dict[int, list[_StressPeriodDataItem]]] = list_( diff --git a/flopy4/mf6/spec.py b/flopy4/mf6/spec.py index 64bfda15f..87dba09b4 100644 --- a/flopy4/mf6/spec.py +++ b/flopy4/mf6/spec.py @@ -5,12 +5,10 @@ import builtins import types -from collections.abc import Mapping from datetime import datetime -from functools import cache, cached_property +from functools import cache from pathlib import Path from typing import ( - TYPE_CHECKING, Any, Literal, NamedTuple, @@ -34,11 +32,10 @@ to_ts_value, to_ts_values, ) -from flopy4.mf6.item import to_union_arm +from flopy4.mf6.item import item_list_type, item_list_words, to_union_arm +from flopy4.mf6.record import record_type from flopy4.spec import fields_dict as flopy_fields_dict - -if TYPE_CHECKING: - from modflow_devtools.dfns.schema import Component, InputField +from flopy4.spec import is_array FieldType = Literal["keyword", "integer", "double", "string", "list", "record"] @@ -126,6 +123,8 @@ def _field(type_: str, kwargs: FieldKwargs, **attributes) -> Any: for key in ("block", "longname", "optional", "netcdf", "tagged", "when"): if kwargs.get(key): metadata[key] = kwargs[key] # type: ignore[literal-required] + if kwargs.get("tagged") is False: + metadata["tagged"] = False metadata.update({k: v for k, v in attributes.items() if v not in (None, False, ())}) on_setattr = kwargs.get("on_setattr") if kwargs.get("block") == "dimensions": @@ -680,58 +679,6 @@ def block_sort_key(item) -> int: return 3 -# The DFNs the classes were generated from, which sync stores beside them -# (flopy4/mf6/dfns), one TOML file each. The converter reads block structure -# from these rather than from the classes. Each is loaded when first asked -# for, not the whole set: devtools' `Dfns.load` parses every file and checks -# the relations between them, which costs a fresh process ~0.15 s on its -# first load. The relations were checked when the set was synced (and are -# again in the tests), so they aren't checked here. - - -def _stored_dfns() -> Path: - from flopy4.mf6._sync import _DFNS - - stored = Path(__file__).parent / _DFNS - if not stored.is_dir(): - raise FileNotFoundError( - f"flopy4.mf6 has no stored DFNs ({stored}). Run `flopy4 mf6 sync` to re-sync." - ) - return stored - - -@cache -def _component_adapter(): - import warnings - - from pydantic import TypeAdapter - - with warnings.catch_warnings(): - warnings.filterwarnings("ignore", message=".*modflow_devtools.dfns.*experimental.*") - from modflow_devtools.dfns.schema import Component - - return TypeAdapter(Component) - - -@cache -def _load_dfn(name: str) -> "Component": - import tomli - from modflow_devtools.dfns.schema import _inject_names - - from flopy4.mf6._sync import _DFN_SCHEMA_VERSION - - with (_stored_dfns() / f"{name}.toml").open("rb") as f: - data = tomli.load(f) - _inject_names(data) # as `Dfns.load` does - component = _component_adapter().validate_python(data) - if component.schema_version not in (None, _DFN_SCHEMA_VERSION): - raise ValueError( - f"stored DFN {name!r} has schema version {component.schema_version}, " - f"expected {_DFN_SCHEMA_VERSION}. Run `flopy4 mf6 sync` to re-sync." - ) - return component - - class Header(NamedTuple): """A repeating block's header kind, as codegen records it in a component class's ``headers``: ``integer`` (a period's IPER, @@ -743,96 +690,38 @@ class Header(NamedTuple): index: bool = False # type: ignore[assignment] -class DfnHeader(NamedTuple): - """A stored DFN's top-level keys: all codegen reads of the components - a link may target (see ``make._headers``), without loading them.""" - - name: str - type: str - subtype: str | None - parent: str | list[str] | None - ftype: str | None - multi: bool - - -def _read_header(path: Path) -> DfnHeader: - import tomli - - # sync writes a DFN's top-level keys before its first table - lines = [] - with path.open() as f: - for line in f: - if line.startswith("["): - break - lines.append(line) - data = tomli.loads("".join(lines)) - return DfnHeader( - data["name"], - data["type"], - data.get("subtype"), - data.get("parent"), - data.get("ftype"), - data.get("multi", False), - ) - - -class _StoredDfns(Mapping[str, "Component"]): - """The stored DFNs by name, each loaded on first access. `headers` - has every DFN's top-level keys, for scans that only need those.""" - - def __init__(self) -> None: - # as `Dfns.load` skips them - exclude = {"common", "flopy"} - self._names = sorted(p.stem for p in _stored_dfns().glob("*.toml") if p.stem not in exclude) - - @cached_property - def headers(self) -> dict[str, DfnHeader]: - stored = _stored_dfns() - return {n: _read_header(stored / f"{n}.toml") for n in self._names} - - def __getitem__(self, name: str) -> "Component": - if name not in self._names: - raise KeyError(name) - return _load_dfn(name) - - def __contains__(self, name: object) -> bool: - return name in self._names - - def __iter__(self): - return iter(self._names) - - def __len__(self) -> int: - return len(self._names) +def computed_fields(cls) -> tuple[str, ...]: + """A class's fields that are written but not stored: a list package's + MAXBOUND, a property counting its rows, the only kind there is. It's the + first of its DIMENSIONS block.""" + return ("maxbound",) if isinstance(getattr(cls, "maxbound", None), property) else () @cache -def _dfns() -> "Mapping[str, Component]": - return _StoredDfns() - - -def dfn(cls) -> "Component": - """The DFN component ``cls`` was generated from, by its ``dfn_name``.""" - return _dfns()[cls.dfn_name] - - -@cache -def attr_names(cls) -> dict[tuple[str, str], str]: - """The attribute of ``cls`` holding each of its DFN's fields, by - (block, field name), as codegen named it (see - ``flopy4.mf6.utils.codegen.make.attr_names``).""" - from flopy4.mf6.utils.codegen.make import attr_names as _attr_names - - return _attr_names(dfn(cls), _dfns()) +def file_blocks(cls) -> dict[str, list[Attribute]]: + """A class's blocks in file order, each with its fields in file order: + options and dimensions first, so a block can read by those before it. A + list package's DIMENSIONS block may hold only its computed MAXBOUND, so + has no fields.""" + blocks: dict[str, list[Attribute]] = {} + for a in attrs.fields(cls): + if (block := a.metadata.get("block")) and a.init is not False: + blocks.setdefault(block, []).append(a) + if computed_fields(cls) and "dimensions" not in blocks: + names = list(blocks) + names.insert(1 if names[:1] == ["options"] else 0, "dimensions") + blocks = {name: blocks.get(name, []) for name in names} + return blocks @attrs.frozen class BlockKeys: - """How the rows of one of a DFN's blocks find their fields. + """How the rows of one of a class's blocks find their fields. Attributes ---------- tagged : - Fields by the keyword their rows begin with, in DFN order. Where a + Fields by the keyword their rows begin with, in file order. Where a keyword begins more than one field's rows (OC's ``HEAD``), the next keyword tells them apart (see ``following_tags``). dynamic : @@ -840,66 +729,78 @@ class BlockKeys: that field's path: RCHA's ``aux``, by ``options.auxiliary``. untagged : The field the block's other rows belong to, if any. + computed : + Keywords of fields with no attribute (see ``computed_fields``). """ - tagged: dict[str, tuple["InputField", ...]] - dynamic: dict[str, "InputField"] - untagged: "InputField | None" - - -def _dynamic_key(f: "InputField") -> str | None: - """The path of the field whose values begin ``f``'s rows, if they do.""" - from modflow_devtools.dfns.schema import List, Record, _is_dynamic_key - - record = f.item if isinstance(f, List) else f - if not isinstance(record, Record): - return None - first = next(iter(record.fields.values()), None) - return first.fk.path if first is not None and _is_dynamic_key(first) else None - - -def leading_tags(f: "InputField") -> list[str]: - """The keywords ``f``'s rows can begin with.""" - from modflow_devtools.dfns.schema import _leading_tags - - return [t.lower() for t in _leading_tags(f)] - + tagged: dict[str, tuple[Attribute, ...]] + dynamic: dict[str, Attribute] + untagged: Attribute | None + computed: tuple[str, ...] = () + + +def is_tagged(f: Attribute) -> bool: + """Whether a component field's rows begin with a keyword. Its metadata + says only when they don't, unlike a record's columns, which say only + when they do.""" + return f.metadata.get("tagged", True) + + +def _record_words(record: type) -> tuple[str, ...]: + """The keywords a record or list item's row can begin with.""" + keyword = vars(record).get("_keyword") + return (keyword.lower(), *vars(record).get("_aliases", ())) if keyword else () + + +def leading_tags(f: Attribute) -> tuple[str, ...]: + """The keywords a tagged field's rows can begin with: a file record's + keyword, a record's, each of a list's items' and words, else its own + name, as it is in the file (``list_`` is ``LIST``).""" + if keyword := f.metadata.get("_keyword"): + return (keyword,) + if (record := record_type(f.type)) is not None and (words := _record_words(record)): + return words + if (item := item_list_type(f.type)) is not None: + items = item if isinstance(item, tuple) else (item,) + words = tuple(w for c in items for w in _record_words(c)) + return words + tuple(w.lower() for w in item_list_words(f.type)) + return (field_key(f),) + + +def following_tags(f: Attribute) -> list[str]: + """The keywords that can follow the one ``f``'s rows begin with: a file + record's direction, or a record's next keyword (OC's ``HEAD FILEOUT`` + and ``HEAD PRINT_FORMAT``).""" + if f.metadata.get("_keyword"): + direction = f.metadata.get("direction") + return [f"file{direction}"] if direction else [] + if (record := record_type(f.type)) is not None: + return [t.lower() for t in vars(record).get("_extra_tokens", ())[:1]] + return [] -def following_tags(f: "InputField") -> list[str]: - """The keywords that can follow the one ``f``'s rows begin with, if - ``f`` is a record whose second member is a keyword, or a file with its - direction's (OC's ``HEAD FILEOUT`` and ``HEAD PRINT_FORMAT``).""" - from modflow_devtools.dfns.schema import File, Keyword, Record - if not isinstance(f, Record): - return [] - members = list(f.fields.values()) - if len(members) < 2: - return [] - second = members[1] - if isinstance(second, Keyword): - return [t.lower() for t in [second.name, *second.aliases]] - if isinstance(second, File) and second.mode_keyword and second.direction: - return [f"file{second.direction}"] - return [] +def field_key(f: Attribute) -> str: + """A field's name in the file and to the writer: its attribute's, less + the underscores that keep it private or off a Python keyword.""" + return f.name.strip("_") @cache def block_keys(cls, block: str) -> BlockKeys: - """How the rows of ``block`` in ``cls``'s DFN find their fields. Fields - codegen leaves out (developmode, removed) aren't keyed.""" - from flopy4.mf6.utils.codegen.filters import flat_fields - - tagged: dict[str, tuple] = {} - dynamic: dict[str, Any] = {} + """How the rows of ``block`` find ``cls``'s fields. The rows naming + children aren't keyed: see `binding_fields`.""" + tagged: dict[str, tuple[Attribute, ...]] = {} + dynamic: dict[str, Attribute] = {} untagged = None - for name, f in flat_fields(dfn(cls)): - if name != block: + for f in file_blocks(cls).get(block, ()): + if f.metadata.get("row"): continue - if not getattr(f, "tagged", True): + if not is_tagged(f): untagged = f - elif key := _dynamic_key(f): - dynamic[key] = f - for tag in leading_tags(f): - tagged[tag] = (*tagged.get(tag, ()), f) - return BlockKeys(tagged=tagged, dynamic=dynamic, untagged=untagged) + elif f.metadata.get("fk") and is_array(f): + dynamic[f.metadata["fk"]] = f + else: + for tag in leading_tags(f): + tagged[tag] = (*tagged.get(tag, ()), f) + computed = computed_fields(cls) if block == "dimensions" else () + return BlockKeys(tagged=tagged, dynamic=dynamic, untagged=untagged, computed=computed) diff --git a/flopy4/mf6/tdis.py b/flopy4/mf6/tdis.py index 7f8cae221..fa35434ee 100644 --- a/flopy4/mf6/tdis.py +++ b/flopy4/mf6/tdis.py @@ -45,6 +45,7 @@ class Perioddata(Item): perioddata: Optional[list[Perioddata]] = list_( default=((1.0, 1, 1.0),), block="perioddata", + tagged=False, shape=("nper",), ) # type: ignore[assignment] diff --git a/flopy4/mf6/utils/codegen/make.py b/flopy4/mf6/utils/codegen/make.py index e1f42d711..1810f0f0f 100644 --- a/flopy4/mf6/utils/codegen/make.py +++ b/flopy4/mf6/utils/codegen/make.py @@ -198,9 +198,6 @@ class ComponentSpec: key_sets: dict[str, str | tuple[str, ...]] = dc_field(default_factory=dict) # role -> the keyword option switching it on, if any key_set_when: dict[str, str] = dc_field(default_factory=dict) - # The class attribute holding each DFN field, by (block, field name): see - # attr_names - attr_names: dict[tuple[str, str], str] = dc_field(default_factory=dict) # Column-schema-dict builders @@ -497,6 +494,13 @@ def _expand_record_field(f: Record, block_name: str) -> tuple[list[FieldSpec], l return specs, gen_fields +def _untagged(f: FieldV3) -> dict[str, bool]: + """A component field's ``tagged`` metadata: said only when it's untagged, + as the block's other rows belong to it. (A record's columns are the other + way round: see `Record`.)""" + return {} if getattr(f, "tagged", True) else {"tagged": False} + + def _ml_field( fn: str, default: str = "None", @@ -1131,14 +1135,6 @@ def _is_child_of(child: Component, parent: Component) -> bool: return admits(child.parent, parent) -def _headers(dfns: Mapping[str, Component]) -> Mapping[str, Any]: - """The DFNs for reading only a link target's top-level keys (type, - subtype, parent, ftype, multi). A mapping that loads each DFN when - first asked for (`flopy4.mf6.spec`'s) has them as ``headers``, so - resolving a link doesn't load every component it might target.""" - return getattr(dfns, "headers", dfns) - - def resolve_link( component: Component, path: str, @@ -1160,7 +1156,7 @@ def resolve_link( raise ValueError(f"{component.name}.{path}: resolving {sel!r} needs the DFNs") found += [ n - for n, c in _headers(dfns).items() + for n, c in dfns.items() if sel in (c.type, getattr(c, "subtype", None)) and _is_child_of(c, component) ] if not found: @@ -1177,7 +1173,7 @@ def _has_class(target: str, link: File, dfns: Mapping[str, Component] | None) -> """Whether flopy4 has a class for a link's target: a hand-written base for a family picked per row, otherwise a generated module.""" if link.component_ftype is not None: - c = _headers(dfns)[target] if dfns is not None else None + c = dfns[target] if dfns is not None else None return c is not None and bool({c.type, getattr(c, "subtype", None)} & set(_CHILD_BASES)) return _has_module(target) @@ -1297,7 +1293,7 @@ def _child_field_spec( if not filters.is_list_field(f): raise ValueError(f"{component.name}.{f.name}: component_ftype outside a list") assert dfns is not None # resolve_link needed them - bases = {_child_base(_headers(dfns)[t]) for t in targets} + bases = {_child_base(dfns[t]) for t in targets} if len(bases) != 1: raise NotImplementedError(f"{component.name}.{f.name}: children of {sorted(bases)}") module, base = bases.pop().split(":") @@ -1500,7 +1496,6 @@ def _model_package_specs( once (``multi``) is a list. Packages without a generated class are left out until they have one. The discretization comes first. Each field's binding rows have the packages block's columns, ``row``.""" - headers = _headers(dfns) slots: dict[str, list[str]] = {} for t in targets: if not _has_module(t): @@ -1509,7 +1504,7 @@ def _model_package_specs( # types reads an OBS6 file (PRT has none yet) if t == "utl-obs" and not component.observations: continue - ftype = headers[t].ftype + ftype = dfns[t].ftype if ftype is None: raise ValueError(f"{component.name}: package {t} has no ftype") name = _SLOTS.get(ftype, ftype.lower().removesuffix("6")) @@ -1519,13 +1514,13 @@ def _model_package_specs( slots = {**{g: slots.pop(g) for g in grid_names}, **slots} specs, imports = [], [] for name, members in slots.items(): - if len({bool(headers[t].multi) for t in members}) > 1: + if len({bool(dfns[t].multi) for t in members}) > 1: raise ValueError(f"{component.name}.{name}: {members} disagree on multi") classes = [filters.class_name(t) for t in members] imports += [f"from {_component_module(t)} import {c}" for t, c in zip(members, classes)] cls = classes[0] if len(classes) == 1 else f"Union[{', '.join(classes)}]" args = f'block="{block_name}", row={filters.tuple_repr(row)}' - if headers[members[0]].multi: + if dfns[members[0]].multi: annotation, call = f"list[{cls}]", f"child({args}, default=attrs.Factory(list))" else: annotation, call = f"Optional[{cls}]", f"child({args})" @@ -1662,8 +1657,6 @@ def build_component_spec( _readarray_period_fields: list[FieldV3] = [] # READARRAY period fields (CHDG, DRNG …) _dynamically_named_period_fields: list[tuple] = [] # (list, array, fk): RCHA's aux _repeating_array_fields: list[FieldV3] = [] # repeating block's own array field - # (block, DFN field) -> the attribute holding it; see attr_names - _attr_names: dict[tuple[str, str], str] = {} # Lists' file columns naming components, by list (LAK's tables). _column_links = { @@ -1698,7 +1691,6 @@ def _add_list_items(lf: ListField, class_name: str) -> str: component, f, block_name, link, targets, dfns ) specs = [spec] - _attr_names[(block_name, f.name)] = spec.py_name (prefix_specs if block_name in ("options", "dimensions") else data_specs).extend(specs) extra_imports.extend(child_imports) continue @@ -1713,7 +1705,6 @@ def _add_list_items(lf: ListField, class_name: str) -> str: if block_name in _fill_forward_blocks and filters.is_list_field(f): _period_item = _add_list_items(f, "StressPeriodData") - _attr_names[(block_name, f.name)] = "_stress_period_data" continue # G-variant packages (CHDG, DRNG, WELG, RCHA …) declare period arrays @@ -1739,19 +1730,22 @@ def _add_list_items(lf: ListField, class_name: str) -> str: ), spec_call=_ml_field( "string", - metadata={"block": block_name, "fill_forward": True, "valid": valid}, + metadata={ + "block": block_name, + "fill_forward": True, + "valid": valid, + **_untagged(f), + }, ), generatable=True, ) ) generatable_field_objects.append((block_name, f)) - _attr_names[(block_name, f.name)] = period_specs[-1].py_name continue # maxbound: emitted as a computed property (see computed_field_specs # below), not a stored field -- skip normal field-building entirely. if block_name == "dimensions" and f.name == "maxbound" and _maxbound_is_computed: - _attr_names[(block_name, f.name)] = "maxbound" continue # Array field whose own block repeats (e.g. utl-tas's "time" block, @@ -1768,8 +1762,7 @@ def _add_list_items(lf: ListField, class_name: str) -> str: _repeating_block_meta: dict[str, Any] = {"block": block_name} if getattr(f, "shape", None): _repeating_block_meta["shape"] = tuple(f.shape) - if getattr(f, "tagged", True): - _repeating_block_meta["tagged"] = True + _repeating_block_meta |= _untagged(f) data_specs.append( FieldSpec( dfn_name=f.name, @@ -1782,7 +1775,6 @@ def _add_list_items(lf: ListField, class_name: str) -> str: ) ) generatable_field_objects.append((block_name, f)) - _attr_names[(block_name, f.name)] = data_specs[-1].py_name continue if block_name in ("options", "dimensions"): @@ -1808,7 +1800,6 @@ def _add_list_items(lf: ListField, class_name: str) -> str: ) ) generatable_field_objects.append((block_name, f)) - _attr_names[(block_name, f.name)] = target[-1].py_name continue if filters.can_generate_record_class(f): @@ -1832,19 +1823,16 @@ def _add_list_items(lf: ListField, class_name: str) -> str: ) ) generatable_field_objects.append((block_name, f)) - _attr_names[(block_name, f.name)] = clean_name elif filters.can_expand_record(f): # a record spread over its members' own attributes specs, gen_fields = _expand_record_field(f, block_name) target.extend(specs) generatable_field_objects.extend((block_name, gf) for gf in gen_fields) - _attr_names |= {(block_name, s.dfn_name): s.py_name for s in specs if s.generatable} else: spec = _build_field_spec(f, block_name, _linked_dims) target.append(spec) if spec.generatable: generatable_field_objects.append((block_name, f)) - _attr_names[(block_name, f.name)] = spec.py_name # Rendered before the other blocks' element classes. block_item_classes: list[ItemClassSpec] = [] @@ -1866,8 +1854,7 @@ def _add_list_items(lf: ListField, class_name: str) -> str: block_item_classes.extend(_specs) if _union is not None: item_unions.append(_union) - _attr_names[(bp.block_name, _list_field.name)] = bp.block_name - _meta: dict = {"block": bp.block_name} + _meta: dict = {"block": bp.block_name, **_untagged(_list_field)} _header = component.blocks[bp.block_name].header if _header is not None and isinstance(_header.field, Record): # The block repeats under a record header: a list of block @@ -1941,6 +1928,8 @@ def _add_list_items(lf: ListField, class_name: str) -> str: # block gets, in a dict keyed by period. if _period_item is not None: _spd_meta: dict[str, Any] = {"block": _ff_block, "fill_forward": True} + if _ff_list is not None: + _spd_meta |= _untagged(_ff_list) # The DIMENSIONS field bounding each period's rows, unless it's # computed (maxbound): HFB's "<=maxhfb". _ff_list computed above. if ( @@ -1993,7 +1982,6 @@ def _add_list_items(lf: ListField, class_name: str) -> str: extra_imports.append("from flopy4.mf6._types import TimeArraySeriesRef") if _grid: _ra_base += " | None" - _attr_names[(_ff_block, _ra_f.name)] = filters.safe_name(_ra_f.name) period_specs.append( FieldSpec( dfn_name=_ra_f.name, @@ -2022,7 +2010,6 @@ def _add_list_items(lf: ListField, class_name: str) -> str: _na_meta["time_series"] = True _na_base += " | TimeArraySeriesRef" extra_imports.append("from flopy4.mf6._types import TimeArraySeriesRef") - _attr_names[(_ff_block, _lf.name)] = filters.safe_name(_lf.name) period_specs.append( FieldSpec( dfn_name=_lf.name, @@ -2082,7 +2069,9 @@ def _block_index(fs: FieldSpec) -> int: legacy_kwargs = _legacy_kwargs(component) if legacy_kwargs: # a period list, or STO's word per period - if not {"_stress_period_data", "stress_period_data"} & set(_attr_names.values()): + if _period_item is None and not any( + fs.py_name == "stress_period_data" for fs in period_specs + ): raise ValueError(f"{component.name}: legacy period keywords, but no period data") extra_imports.extend( f"from flopy4.mf6.legacy import {convert or 'Legacy'}" @@ -2171,22 +2160,9 @@ def _block_index(fs: FieldSpec) -> int: key_set_when={ role: ks.when for role, ks in sorted((component.keys or {}).items()) if ks.when }, - attr_names={k: v for k, v in _attr_names.items() if v in _seen_py_names or v == "maxbound"}, ) -def attr_names( - component: Component, dfns: Mapping[str, Component] | None = None -) -> dict[tuple[str, str], str]: - """The class attribute holding each of ``component``'s DFN fields, by - (block, field name): the name codegen gives it. A record spread over - its members' attributes maps its members, not itself; a period block's - list maps to ``_stress_period_data``. A model name file's package list - has no one attribute (each package type gets its own), so it isn't - mapped.""" - return build_component_spec(component, root=Path("."), dfns=dfns).attr_names - - # Template environment _TEMPLATE_NAME = "package.py.jinja" diff --git a/flopy4/mf6/utl/ats.py b/flopy4/mf6/utl/ats.py index efa2de49d..24570b416 100644 --- a/flopy4/mf6/utl/ats.py +++ b/flopy4/mf6/utl/ats.py @@ -30,6 +30,7 @@ class Perioddata(Item): perioddata: Optional[list[Perioddata]] = list_( default=None, block="perioddata", + tagged=False, shape=("<=maxats",), ) diff --git a/flopy4/mf6/utl/hpc.py b/flopy4/mf6/utl/hpc.py index f560141fa..e31d98b58 100644 --- a/flopy4/mf6/utl/hpc.py +++ b/flopy4/mf6/utl/hpc.py @@ -27,6 +27,7 @@ class Partitions(Item): partitions: Optional[list[Partitions]] = list_( default=None, block="partitions", + tagged=False, ) diff --git a/flopy4/mf6/utl/laktab.py b/flopy4/mf6/utl/laktab.py index 0269ac78a..1fe5d842c 100644 --- a/flopy4/mf6/utl/laktab.py +++ b/flopy4/mf6/utl/laktab.py @@ -35,6 +35,7 @@ class Table(Item): table: Optional[list[Table]] = list_( default=None, block="table", + tagged=False, shape=("nrow",), ) diff --git a/flopy4/mf6/utl/obs.py b/flopy4/mf6/utl/obs.py index e538006af..283ef86be 100644 --- a/flopy4/mf6/utl/obs.py +++ b/flopy4/mf6/utl/obs.py @@ -53,6 +53,7 @@ class ContinuousBlock(Block): continuous: Optional[list[ContinuousBlock]] = list_( default=None, block="continuous", + tagged=False, ) diff --git a/flopy4/mf6/utl/sfrtab.py b/flopy4/mf6/utl/sfrtab.py index f090d8d69..9b6bf38fc 100644 --- a/flopy4/mf6/utl/sfrtab.py +++ b/flopy4/mf6/utl/sfrtab.py @@ -34,6 +34,7 @@ class Table(Item): table: Optional[list[Table]] = list_( default=None, block="table", + tagged=False, shape=("nrow",), ) diff --git a/flopy4/mf6/utl/spc.py b/flopy4/mf6/utl/spc.py index b4a99c2f3..35f29aee4 100644 --- a/flopy4/mf6/utl/spc.py +++ b/flopy4/mf6/utl/spc.py @@ -61,6 +61,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, shape=("<=maxbound",), dim_required=True, ) diff --git a/flopy4/mf6/utl/tas.py b/flopy4/mf6/utl/tas.py index dc34e064b..b244eaab3 100644 --- a/flopy4/mf6/utl/tas.py +++ b/flopy4/mf6/utl/tas.py @@ -54,4 +54,5 @@ class Sfac(Record): default=None, block="time", shape=("ncpl",), + tagged=False, ) diff --git a/flopy4/mf6/utl/ts.py b/flopy4/mf6/utl/ts.py index 9ef725b61..b87c131c1 100644 --- a/flopy4/mf6/utl/ts.py +++ b/flopy4/mf6/utl/ts.py @@ -76,6 +76,7 @@ class Timeseries(Item): timeseries: Optional[list[Timeseries]] = list_( default=None, block="timeseries", + tagged=False, write_if_empty=True, ) diff --git a/flopy4/mf6/utl/tvk.py b/flopy4/mf6/utl/tvk.py index 3e132c10e..e6d9f8e71 100644 --- a/flopy4/mf6/utl/tvk.py +++ b/flopy4/mf6/utl/tvk.py @@ -59,6 +59,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) diff --git a/flopy4/mf6/utl/tvs.py b/flopy4/mf6/utl/tvs.py index 540022f0a..e566dc7f2 100644 --- a/flopy4/mf6/utl/tvs.py +++ b/flopy4/mf6/utl/tvs.py @@ -60,6 +60,7 @@ class StressPeriodData(Item): repr=False, block="period", fill_forward=True, + tagged=False, ) diff --git a/pyproject.toml b/pyproject.toml index 105544216..bd4fef3bc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -95,7 +95,6 @@ include = ["flopy4", "flopy4.*"] "mf6/codec/**/*.jinja", "mf6/utils/codegen/templates/*.jinja", "mf6/utils/codegen/dfn_overrides.toml", - "mf6/dfns/*", ] [tool.ruff] diff --git a/test/mf6/test_mf6_codec.py b/test/mf6/test_mf6_codec.py index 10e8d9d60..21a62a576 100644 --- a/test/mf6/test_mf6_codec.py +++ b/test/mf6/test_mf6_codec.py @@ -2114,9 +2114,9 @@ def test_dumps_tas_inner_classes(): unstructured = COMPONENT_CONVERTER.unstructure(tas) assert "attributes" in unstructured - assert unstructured["attributes"]["time_series_namerecord"] == ("NAME", "my_ts") - assert unstructured["attributes"]["interpolation_methodrecord"] == ("METHOD", "linear") - assert unstructured["attributes"]["sfacrecord"] == ("SFAC", 1.5) + assert unstructured["attributes"]["time_series_name"] == ("NAME", "my_ts") + assert unstructured["attributes"]["interpolation_method"] == ("METHOD", "linear") + assert unstructured["attributes"]["sfac"] == ("SFAC", 1.5) dumped = dumps(unstructured) assert "BEGIN ATTRIBUTES" in dumped @@ -2135,8 +2135,8 @@ def test_dumps_tas_inner_classes_multi_value(): ) unstructured = COMPONENT_CONVERTER.unstructure(tas) - assert unstructured["attributes"]["time_series_namerecord"] == ("NAME", "ts-2", "ts-3") - assert unstructured["attributes"]["sfacrecord"] == ("SFAC", 1.5, 2.0) + assert unstructured["attributes"]["time_series_name"] == ("NAME", "ts-2", "ts-3") + assert unstructured["attributes"]["sfac"] == ("SFAC", 1.5, 2.0) dumped = dumps(unstructured) assert "NAME ts-2 ts-3" in dumped diff --git a/test/mf6/test_mf6_codegen.py b/test/mf6/test_mf6_codegen.py index a345e3037..0d4d50ed6 100644 --- a/test/mf6/test_mf6_codegen.py +++ b/test/mf6/test_mf6_codegen.py @@ -1282,7 +1282,6 @@ def test_tagged_record_list_roundtrip(tmp_path, monkeypatch): assert 'class Scale(Item):\n _keyword: ClassVar[str] = "scale"' in text cls = _load_class_from_spec(spec, "gwf_tlst", "Tlst") - _store_dfn(monkeypatch, dfn) pkg = structure_component( loads("BEGIN OPTIONS\n SCALE 2.0\n PRINT_INPUT\n SCALE 3.0\nEND OPTIONS\n"), cls ) @@ -1336,7 +1335,6 @@ def arm(name): assert "settings: Optional[list[_SettingsItem]]" in spec.outpath.read_text() cls = _load_class_from_spec(spec, "gwf_ulst", "Ulst") - _store_dfn(monkeypatch, dfn) pkg = structure_component( loads("BEGIN OPTIONS\n RATE 2.0\n PRINT_INPUT\n STAGE 3.0\nEND OPTIONS\n"), cls ) @@ -1412,15 +1410,6 @@ def test_griddata_list_and_layered_values(): assert npf.k.shape == (6,) -def _store_dfn(monkeypatch, dfn) -> None: - """Store a synthetic DFN beside the classes', as sync stores theirs: - the converter reads block structure from it (see `spec.dfn`).""" - from flopy4.mf6 import spec - - stored = {**spec._dfns(), dfn.name: dfn} - monkeypatch.setattr(spec, "_dfns", lambda: stored) - - def _load_class_from_spec(spec, mod_name: str, expected_class: str): """Generate, load, and return the class from a ComponentSpec. Cleans up module state.""" mod_spec = importlib.util.spec_from_file_location(mod_name, spec.outpath) diff --git a/test/mf6/test_mf6_dfn.py b/test/mf6/test_mf6_dfn.py deleted file mode 100644 index ab4f1d8e2..000000000 --- a/test/mf6/test_mf6_dfn.py +++ /dev/null @@ -1,161 +0,0 @@ -"""The DFNs sync stores with the classes, and what the converter reads from -them: each class's DFN, the attribute holding each DFN field, and how a -block's rows find their fields. These read the stored DFNs, not the ones -CI downloads, so they hold for the classes as generated.""" - -import importlib - -import pytest - -from flopy4.mf6 import spec -from flopy4.mf6.gwf.chd import Chd -from flopy4.mf6.gwf.oc import Oc -from flopy4.mf6.gwf.rcha import Rcha -from flopy4.mf6.gwf.sto import Sto -from flopy4.mf6.simulation import Simulation -from flopy4.mf6.utils.codegen import filters -from flopy4.mf6.utils.codegen.make import _component_module -from flopy4.mf6.utl.tas import Tas -from flopy4.mf6.utl.ts import Ts - - -def _classes(): - for name in spec._dfns(): - try: - module = importlib.import_module(_component_module(name)) - except ImportError: - continue - if (cls := getattr(module, filters.class_name(name), None)) is not None: - yield name, cls - - -CLASSES = dict(_classes()) - - -def test_stored_dfns_cover_classes(): - assert CLASSES - for name, cls in CLASSES.items(): - assert spec.dfn(cls).name == name == cls.dfn_name - - -@pytest.fixture(scope="module") -def whole_set(): - """The stored DFNs as devtools loads them, all at once, checking the - relations between them, which the converter's lazy loads skip.""" - from modflow_devtools.dfns import LocalDfnRegistry - - from flopy4.mf6._sync import _DFN_SCHEMA_VERSION - - registry = LocalDfnRegistry(path=spec._stored_dfns()) - return registry.spec(schema_version=_DFN_SCHEMA_VERSION).components - - -def test_lazy_dfns_match_whole_set(whole_set): - """Each DFN loaded alone is the one devtools loads in the whole set, - and its header has the same top-level keys.""" - stored = spec._dfns() - assert sorted(stored) == sorted(whole_set) - for name, component in whole_set.items(): - assert stored[name] == component, name - header = stored.headers[name] - for key in spec.DfnHeader._fields: - # only packages have multi - default = False if key == "multi" else None - assert getattr(header, key) == getattr(component, key, default), (name, key) - - -@pytest.mark.parametrize("name", sorted(CLASSES)) -def test_attr_names_from_headers(name, whole_set): - """Codegen names the same attributes resolving links by the lazy - loader's headers as by the whole set.""" - from flopy4.mf6.utils.codegen.make import attr_names - - cls = CLASSES[name] - assert spec.attr_names(cls) == attr_names(whole_set[name], whole_set) - - -@pytest.mark.parametrize("name", sorted(CLASSES)) -def test_attr_names(name): - """Every DFN field codegen made an attribute for maps to it, and every - attribute holds a DFN field, except a model's package slots (one per - package type, all from the name file's package list).""" - cls = CLASSES[name] - names = spec.attr_names(cls) - fields = spec.fields_dict(cls) - for key, attr in names.items(): - assert attr in fields or isinstance(getattr(cls, attr, None), property), key - unmapped = {a for a, f in fields.items() if a not in names.values()} - if filters.is_model_nam(name): - assert all(fields[a].metadata["block"] == "packages" for a in unmapped) - else: - assert not unmapped - - -@pytest.mark.parametrize("name", sorted(CLASSES)) -def test_block_keys(name): - """A block's untagged field, if any, is its last; a keyword leading - more than one field's rows is told apart by the next one.""" - cls = CLASSES[name] - for block in spec.dfn(cls).blocks or {}: - keys = spec.block_keys(cls, block) - fields = [f for b, f in filters.flat_fields(spec.dfn(cls)) if b == block] - if keys.untagged is not None: - assert fields[-1] is keys.untagged, block - assert sum(not getattr(f, "tagged", True) for f in fields) == 1, block - for tag, shared in keys.tagged.items(): - if len(shared) > 1: - following = [tuple(spec.following_tags(f)) for f in shared] - assert all(following) and len(set(following)) == len(following), (block, tag) - - -@pytest.mark.parametrize("name", sorted(CLASSES)) -def test_block_order(name): - """Options, then dimensions, come before every other block, so a load - reading blocks in DFN order has the auxiliary names, switches and - sizes before the blocks read by them.""" - blocks = list(spec.dfn(CLASSES[name]).blocks or {}) - first = [b for b in ("options", "dimensions") if b in blocks] - assert blocks[: len(first)] == first - - -def test_attr_names_examples(): - assert spec.attr_names(Oc)[("options", "head_filerecord")] == "head_file" - assert spec.attr_names(Oc)[("options", "headprintrecord")] == "headprint" - assert spec.attr_names(Oc)[("period", "stress_period_data")] == "_period_data" - assert spec.attr_names(Chd)[("options", "ts_filerecord")] == "ts" - assert spec.attr_names(Chd)[("dimensions", "maxbound")] == "maxbound" - assert spec.attr_names(Sto)[("period", "stress_period_data")] == "period_data" - assert spec.attr_names(Rcha)[("period", "aux")] == "aux" - assert spec.attr_names(Tas)[("time", "tas_array")] == "tas_array" - assert spec.attr_names(Simulation)[("solutiongroup", "solutiongroup")] == "solutiongroup" - - -def test_shared_keyword(): - head = spec.block_keys(Oc, "options").tagged["head"] - assert [f.name for f in head] == ["head_filerecord", "headprintrecord"] - assert [spec.following_tags(f) for f in head] == [["fileout"], ["print_format"]] - # no clash between a record and another field: TS's SFAC and SFACS - sfac = spec.block_keys(Ts, "attributes").tagged - assert [f.name for f in sfac["sfac"]] == ["sfacrecord_single"] - assert [f.name for f in sfac["sfacs"]] == ["sfacrecord"] - - -def test_headers_and_untagged(): - dfn = spec.dfn(Simulation) - assert dfn.blocks["solutiongroup"].header.field.name == "group_num" - group = spec.block_keys(Simulation, "solutiongroup") - assert group.untagged.name == "solutiongroup" - assert set(group.tagged) == {"mxiter"} - assert spec.dfn(Tas).blocks["time"].header.field.type == "double" - assert spec.block_keys(Tas, "time").untagged.name == "tas_array" - period = spec.block_keys(Oc, "period") - assert spec.dfn(Oc).blocks["period"].header.fill_forward - assert period.untagged is None # OC's output is a tagged list - assert set(period.tagged) == {"save", "print"} - - -def test_dynamic_keys(): - period = spec.block_keys(Rcha, "period") - assert {path: f.name for path, f in period.dynamic.items()} == {"options.auxiliary": "aux"} - assert set(period.tagged) == {"irch", "recharge"} - assert period.untagged is None diff --git a/test/mf6/test_mf6_routing.py b/test/mf6/test_mf6_routing.py new file mode 100644 index 000000000..61c9d5378 --- /dev/null +++ b/test/mf6/test_mf6_routing.py @@ -0,0 +1,213 @@ +"""How the converter finds a component's blocks and fields, all from its class +(see `flopy4.mf6.spec`). The classes are the only schema the runtime reads, so +the last test holds them to the DFNs they're generated from.""" + +import importlib.util +import sys +from pathlib import Path + +import pytest +from modflow_devtools.dfns import LocalDfnRegistry +from modflow_devtools.dfns.schema import File, Keyword, Record, _is_dynamic_key, _leading_tags +from modflow_devtools.dfns.schema import List as ListField + +from flopy4.mf6 import spec +from flopy4.mf6.component import FNAMES +from flopy4.mf6.gwf.chd import Chd +from flopy4.mf6.gwf.evt import Evt +from flopy4.mf6.gwf.lak import Lak +from flopy4.mf6.gwf.oc import Oc +from flopy4.mf6.gwf.rcha import Rcha +from flopy4.mf6.gwf.sto import Sto +from flopy4.mf6.prt.prp import Prp +from flopy4.mf6.simulation import Simulation +from flopy4.mf6.utils.codegen import filters +from flopy4.mf6.utils.codegen.make import make_modules +from flopy4.mf6.utl.tas import Tas +from flopy4.mf6.utl.ts import Ts + + +def _names(fields) -> list[str]: + return [f.name for f in fields] + + +def test_blocks_in_file_order(): + assert list(spec.file_blocks(Chd)) == ["options", "dimensions", "period"] + # DIMENSIONS holds only the computed MAXBOUND + assert spec.file_blocks(Chd)["dimensions"] == [] + assert spec.block_keys(Chd, "dimensions").computed == ("maxbound",) + # MAXBOUND's beside a stored dimension + assert _names(spec.file_blocks(Evt)["dimensions"]) == ["nseg"] + assert spec.block_keys(Evt, "dimensions").computed == ("maxbound",) + assert spec.block_keys(Evt, "options").computed == () + + +def test_shared_keyword(): + head = spec.block_keys(Oc, "options").tagged["head"] + assert _names(head) == ["head_file", "headprint"] + assert [spec.following_tags(f) for f in head] == [["fileout"], ["print_format"]] + # no clash between a record and another field: TS's SFAC and SFACS + sfac = spec.block_keys(Ts, "attributes").tagged + assert _names(sfac["sfac"]) == ["sfacrecord_single"] + assert _names(sfac["sfacs"]) == ["sfac"] + + +def test_alias(): + tagged = spec.block_keys(Ts, "attributes").tagged + assert tagged["names"] == tagged["name"] + + +def test_untagged(): + assert spec.block_keys(Chd, "period").untagged.name == "_stress_period_data" + assert spec.block_keys(Sto, "period").untagged.name == "stress_period_data" + assert spec.block_keys(Tas, "time").untagged.name == "tas_array" + # rows that lead with a value, whatever keyword follows it + lak = spec.block_keys(Lak, "period") + assert lak.untagged.name == "_stress_period_data" + assert not lak.tagged + + +def test_tagged_lists(): + period = spec.block_keys(Oc, "period") + assert period.untagged is None + assert set(period.tagged) == {"save", "print"} + # a union's items and its plain words + period = spec.block_keys(Prp, "period") + assert {"first", "all", "last", "frequency", "steps"} <= set(period.tagged) + + +def test_dynamic_keys(): + period = spec.block_keys(Rcha, "period") + assert {path: f.name for path, f in period.dynamic.items()} == {"options.auxiliary": "aux"} + assert set(period.tagged) == {"irch", "recharge"} + assert period.untagged is None + + +def test_binding_rows_arent_keyed(): + group = spec.block_keys(Simulation, "solutiongroup") + assert group.untagged is None + assert set(group.tagged) == {"mxiter"} + assert "solutiongroup" in spec.binding_fields(Simulation) + + +@pytest.fixture(scope="module") +def generated(dfn_path, tmp_path_factory): + """Each component's DFN, with the class generated from it: by the DFNs + at hand, so this holds whichever the tests are given.""" + dfns = LocalDfnRegistry(path=dfn_path).spec(schema_version="2.0.0.dev3").components + specs = make_modules(dfns=dfns, outdir=tmp_path_factory.mktemp("routing"), makedirs=True) + registered = dict(FNAMES) + loaded = [] + out = [] + for s in specs: + path = Path(s.outpath) + if path.name == "__init__.py" or s.dfn_name not in dfns: + continue + name = f"_routing_{s.dfn_name.replace('-', '_')}" + module_spec = importlib.util.spec_from_file_location(name, path) + module = importlib.util.module_from_spec(module_spec) + sys.modules[name] = module + loaded.append(name) + module_spec.loader.exec_module(module) + out.append((dfns[s.dfn_name], getattr(module, s.class_name))) + yield out + FNAMES.clear() + FNAMES.update(registered) + for name in loaded: + del sys.modules[name] + + +def _following_dfn(f) -> list[str]: + """What follows a DFN field's leading keyword, for the rows the converter + has to tell apart.""" + if not isinstance(f, Record): + return [] + members = list(f.fields.values()) + if len(members) < 2: + return [] + second = members[1] + if isinstance(second, Keyword): + return [t.lower() for t in [second.name, *second.aliases]] + if isinstance(second, File) and second.mode_keyword and second.direction: + return [f"file{second.direction}"] + return [] + + +def test_classes_route_as_their_dfns(generated): + """What the converter reads from a class is what its DFN says: its blocks + in order, each block's keys in order, its untagged and dynamic fields, and + its repeating blocks' headers.""" + assert generated + problems = [] + for component, cls in generated: + blocks = spec.file_blocks(cls) + order = [b for b in component.blocks or {} if b in blocks] + if order != list(blocks): + problems.append((component.name, "order", list(blocks), order)) + for name in blocks: + where = (component.name, name) + block = component.blocks.get(name) + if block is None: + problems.append((*where, "not in the DFN")) + continue + keys = spec.block_keys(cls, name) + fields = [f for b, f in filters.flat_fields(component) if b == name] + binding = name in spec.binding_fields(cls) + + # a field's own keys (a union's arms) can come in any order + words = [ + t.lower() for f in fields if not _is_dynamic(f) for t in sorted(_leading_tags(f)) + ] + have = list(keys.computed) + for a in blocks[name]: + keyed = spec.is_tagged(a) and a not in keys.dynamic.values() + if keyed and not a.metadata.get("row"): + have += sorted(spec.leading_tags(a)) + words, have = list(dict.fromkeys(words)), list(dict.fromkeys(have)) + if words != have: + problems.append((*where, "keys", have, words)) + for word, shared in keys.tagged.items(): + if len(shared) > 1: + dfn_shared = [f for f in fields if word in map(str.lower, _leading_tags(f))] + want = [_following_dfn(f) for f in dfn_shared] + if [spec.following_tags(a) for a in shared] != want: + problems.append((*where, "following", word)) + + untagged = [f for f in fields if not getattr(f, "tagged", True)] + if binding: + untagged = [] + if (keys.untagged is None) != (not untagged): + problems.append((*where, "untagged", keys.untagged, _names(untagged))) + dynamic = { + next(iter(_record(f).fields.values())).fk.path for f in fields if _is_dynamic(f) + } + if set(keys.dynamic) != dynamic: + problems.append((*where, "dynamic", set(keys.dynamic), dynamic)) + + if block.header is None: + if name in cls.headers: + problems.append((*where, "header not in the DFN")) + continue + header = cls.headers[name] + kind = block.header.field.type + if header.kind != kind or header.index != bool(getattr(block.header.field, "index", 0)): + problems.append((*where, "header", header, kind)) + filled = any(a.metadata.get("fill_forward") for a in blocks[name]) + if filled != bool(block.header.fill_forward): + problems.append((*where, "fill_forward", filled)) + if spec.computed_fields(cls): + dims = component.blocks["dimensions"].fields + if next(iter(dims)) != "maxbound": + problems.append((component.name, "maxbound isn't first", list(dims))) + assert problems == [] + + +def _record(f): + return f.item if isinstance(f, ListField) else f + + +def _is_dynamic(f) -> bool: + record = _record(f) + if not isinstance(record, Record): + return False + return _is_dynamic_key(next(iter(record.fields.values()), None)) diff --git a/test/mf6/test_mf6_sync.py b/test/mf6/test_mf6_sync.py index 12ac65533..949be7cb4 100644 --- a/test/mf6/test_mf6_sync.py +++ b/test/mf6/test_mf6_sync.py @@ -1,4 +1,3 @@ -import ast import os import re import shutil @@ -102,11 +101,10 @@ def test_sync_local_all_packages(dfn_path, tmp_path): def test_sync_local_existing_only(dfn_path, tmp_path): - """Without all_packages, an empty outdir gets no classes, only the - contract, the grammars and the DFNs.""" + """Without all_packages, an empty outdir gets only the contract.""" result = sync(dfn_path, mf6_version="6.9.0", outdir=tmp_path) assert result.files == () - assert sorted(p.name for p in tmp_path.iterdir()) == ["_contract.py", "codec", "dfns"] + assert sorted(p.name for p in tmp_path.iterdir()) == ["_contract.py", "codec"] def test_sync_local_unknown_version_warns(dfn_path, tmp_path): @@ -326,10 +324,6 @@ def make_module_without_crs(spec, env, verbose=False, outpath=None): assert any("Dis.crs" in gap for gap in find_problems(outdir).gaps) -def _code(files: dict[str, str]) -> dict[str, str]: - return {name: ast.dump(ast.parse(text)) for name, text in files.items()} - - def _grammars(outdir: Path) -> dict[str, str]: return {p.name: p.read_text() for p in (outdir / _sync._GRAMMARS).glob("*.lark")} @@ -395,62 +389,13 @@ def test_read_only(dfn_path, tmp_path): outdir.chmod(0o755) -def _components(path: Path) -> dict: - from modflow_devtools.dfns import LocalDfnRegistry - - return LocalDfnRegistry(path=path).spec(schema_version="2.0.0.dev3").components - - -def test_dfns_stored(dfn_path, outdir): - """Sync stores the source's DFNs as TOML, replacing ones it no longer has.""" +def test_old_stored_dfns_removed(dfn_path, outdir): + """Sync removes the DFNs earlier syncs stored for the typed reader.""" stored = outdir / "dfns" - assert {f.name for f in stored.iterdir()} == { - f"{f.stem}.toml" for f in dfn_path.glob("*.dfn") if f.stem not in ("common", "flopy") - } - (stored / "gwf-zzz.toml").write_text("") - (stored / "gwf-chd.dfn").write_text("") + stored.mkdir(exist_ok=True) + (stored / "gwf-chd.toml").write_text("") sync(dfn_path, mf6_version="6.9.0", outdir=outdir) - assert not (stored / "gwf-zzz.toml").exists() - assert not (stored / "gwf-chd.dfn").exists() - - -def test_stored_dfns_lossless(dfn_path, outdir): - """The stored TOML loads to the same spec as the source DFNs.""" - source = _components(dfn_path) - stored = _components(outdir / "dfns") - assert source.keys() == stored.keys() - assert [k for k in source if source[k] != stored[k]] == [] - - -def test_resync_from_stored_dfns(outdir, tmp_path): - """Syncing from the stored TOML reproduces the classes, and copies it.""" - before = _snapshot(outdir) - toml = Path(shutil.copytree(outdir / "dfns", tmp_path / "toml")) - sync(toml, mf6_version="6.9.0", outdir=outdir) - after = _snapshot(outdir) - # the copy isn't in a git checkout, so the contract's commit may differ - del after["_contract.py"], before["_contract.py"] - assert after == before - for f in toml.iterdir(): - assert (outdir / "dfns" / f.name).read_bytes() == f.read_bytes() - - -def test_installed_dfns_match_classes(tmp_path): - """The DFNs stored in the package are the ones its classes came from: - regenerating from them changes no class or grammar.""" - installed = Path(flopy4.mf6.__file__).parent - outdir = Path( - shutil.copytree(installed, tmp_path / "mf6", ignore=shutil.ignore_patterns("__pycache__")) - ) - toml = Path(shutil.copytree(installed / "dfns", tmp_path / "toml")) - before = _snapshot(outdir) - grammars = _grammars(outdir) - sync(toml, mf6_version="6.9.0", outdir=outdir) - after = _snapshot(outdir) - del after["_contract.py"], before["_contract.py"] - # by their code: sync formats its output only where ruff is installed - assert _code(after) == _code(before) - assert _grammars(outdir) == grammars + assert not stored.exists() def test_resync_from_toml(dfn_path, outdir, tmp_path): From 977be40578def5e347ff4c0345e8b2a66b883da0 Mon Sep 17 00:00:00 2001 From: wpbonelli Date: Thu, 5 Nov 2026 17:18:25 -0800 Subject: [PATCH 8/8] Regenerate the load snapshots the rebase over #546 kept from develop STO's value in these 37 is one word per period again. Against this branch before the rebase, they differ only by #546's names. Co-Authored-By: Claude Opus 5.5 --- ..._simulation[mf6largetest1000_751x751].json | 28 ++++--------------- ...on[mf6largetest1000_751x751_confined].json | 28 ++++--------------- ...mulation[mf6largetest1003_MNW2_Fig28].json | 20 +++---------- ...ation[mf6largetest1004_mvlake_lak_tr].json | 20 +++---------- ...on[mf6largetest1004_mvlake_laksfr_tr].json | 20 +++---------- ...oad_simulation[mf6largetest1005_secp].json | 20 +++---------- ...imulation[mf6testtest001e_UZF_3layTS].json | 20 +++---------- ..._simulation[mf6testtest001e_UZF_3lay].json | 20 +++---------- ...ad_simulation[mf6testtest001e_UZF_TS].json | 20 +++---------- ...imulation[mf6testtest001e_UZF_spring].json | 20 +++---------- ...imulation[mf6testtest001e_noUZF_3lay].json | 20 +++---------- ...ad_simulation[mf6testtest003_gwfs_tr].json | 20 +++---------- ...imulation[mf6testtest005_advgw_tidal].json | 20 +++---------- ...load_simulation[mf6testtest007_75x75].json | 28 ++++--------------- ...lation[mf6testtest007_75x75_confined].json | 28 ++++--------------- ...ad_simulation[mf6testtest017_Crinkle].json | 20 +++---------- ...lation[mf6testtest027_TimeseriesTest].json | 20 +++---------- ...f6testtest027_TimeseriesTest_idomain].json | 20 +++---------- ...load_simulation[mf6testtest034_nwtp2].json | 12 ++------ ...d_simulation[mf6testtest034_nwtp2_1d].json | 12 ++------ ...load_simulation[mf6testtest037_mfcp3].json | 28 ++++--------------- ...ad_simulation[mf6testtest051_uzfp2TS].json | 20 +++---------- ...load_simulation[mf6testtest051_uzfp2].json | 20 +++---------- ..._simulation[mf6testtest051_uzfp2_mvr].json | 20 +++---------- ...imulation[mf6testtest051_uzfp2_nouzf].json | 20 +++---------- ...ation[mf6testtest051_uzfp2_openclose].json | 20 +++---------- ...mf6testtest051_uzfp3_aeET_lakmvr_dev].json | 20 +++---------- ...ttest051_uzfp3_lakmvr_2uzfmodels_dev].json | 20 +++---------- ...tion[mf6testtest051_uzfp3_lakmvr_dev].json | 20 +++---------- ...f6testtest051_uzfp3_lakmvr_nouzf_dev].json | 20 +++---------- ...n[mf6testtest051_uzfp3_lakmvr_v2_dev].json | 20 +++---------- ...on[mf6testtest051_uzfp3_wellakmvr_v2].json | 20 +++---------- ...simulation[mf6testtest061_csub_holly].json | 12 ++------ ...simulation[mf6testtest061_csub_jacob].json | 20 +++---------- ...d_simulation[mf6testtest106_tsnodata].json | 20 +++---------- ...ion[mf6testtest106_tsnodataalt_model].json | 20 +++---------- ...ion[mf6testtest205_gwtbuy-henrytidal].json | 12 ++------ 37 files changed, 149 insertions(+), 599 deletions(-) diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1000_751x751].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1000_751x751].json index 288b75938..12c9287fb 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1000_751x751].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1000_751x751].json @@ -208,29 +208,6 @@ }, "simulation/GWF_1/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "steady-state" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "transient" - ] - }, - "2": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "steady-state" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 751, @@ -248,6 +225,11 @@ "ss": "float64[582025] 8e32b8808a7463a8", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient", + "2": "steady-state" + }, "sy": "float64[582025] d644f68bfd022132" }, "simulation/GWF_1/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1000_751x751_confined].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1000_751x751_confined].json index 0d1975954..701efc1a6 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1000_751x751_confined].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1000_751x751_confined].json @@ -165,29 +165,6 @@ }, "simulation/GWF_1/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "steady-state" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "transient" - ] - }, - "2": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "steady-state" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 751, @@ -205,6 +182,11 @@ "ss": "float64[582025] d09d4b05e804b43f", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient", + "2": "steady-state" + }, "sy": "float64[582025] 8e32b8808a7463a8" }, "simulation/GWF_1/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1003_MNW2_Fig28].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1003_MNW2_Fig28].json index ad9387915..fd622d24b 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1003_MNW2_Fig28].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1003_MNW2_Fig28].json @@ -404,22 +404,6 @@ }, "simulation/GWF_1/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "steady-state" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "transient" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 272, @@ -437,6 +421,10 @@ "ss": "float64[334560] a3e95325fc719a79", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[334560] ff9856b4091cd415" }, "simulation/GWF_1/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1004_mvlake_lak_tr].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1004_mvlake_lak_tr].json index 29fda79e6..ae25cf289 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1004_mvlake_lak_tr].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1004_mvlake_lak_tr].json @@ -410,22 +410,6 @@ }, "simulation/mv/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 25, @@ -443,6 +427,10 @@ "ss": "float64[5000] a5b1f02513ab097d", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[5000] 34180ed3a46722b0" }, "simulation/mv/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1004_mvlake_laksfr_tr].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1004_mvlake_laksfr_tr].json index b1192a2a7..ba3bb02fb 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1004_mvlake_laksfr_tr].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1004_mvlake_laksfr_tr].json @@ -502,22 +502,6 @@ }, "simulation/mv/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 25, @@ -535,6 +519,10 @@ "ss": "float64[5000] a5b1f02513ab097d", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[5000] 34180ed3a46722b0" }, "simulation/mv/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1005_secp].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1005_secp].json index eab38e8b5..514484d70 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1005_secp].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6largetest1005_secp].json @@ -297,22 +297,6 @@ }, "simulation/secp_mf6/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 275, @@ -330,6 +314,10 @@ "ss": "float64[572000] 311d924bb3073b74", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[572000] 95fb8ad05a2d4c9b" }, "simulation/secp_mf6/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_3layTS].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_3layTS].json index 6359aa397..62585092f 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_3layTS].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_3layTS].json @@ -233,22 +233,6 @@ }, "simulation/GWF_1/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "transient" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -266,6 +250,10 @@ "ss": "float64[30] 368c7d008c4c4635", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "transient", + "1": "transient" + }, "sy": "float64[30] 3e2c7d397e7f2184" }, "simulation/GWF_1/uzf-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_3lay].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_3lay].json index 41a41de20..af916a75b 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_3lay].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_3lay].json @@ -233,22 +233,6 @@ }, "simulation/GWF_1/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "transient" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -266,6 +250,10 @@ "ss": "float64[30] 368c7d008c4c4635", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "transient", + "1": "transient" + }, "sy": "float64[30] 3e2c7d397e7f2184" }, "simulation/GWF_1/uzf-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_TS].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_TS].json index c53a1ccc0..5c4ae55b4 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_TS].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_TS].json @@ -231,22 +231,6 @@ }, "simulation/GWF_1/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "transient" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 3, @@ -264,6 +248,10 @@ "ss": "float64[9] 6468c106717f86c0", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "transient", + "1": "transient" + }, "sy": "float64[9] e15e06c9d6bf7d5a" }, "simulation/GWF_1/uzf-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_spring].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_spring].json index b2519e55e..7bbbc1f45 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_spring].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_UZF_spring].json @@ -185,22 +185,6 @@ }, "simulation/GWF_1/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -218,6 +202,10 @@ "ss": "float64[10] acd25494c6811185", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[10] d20144b7dfc27b2d" }, "simulation/GWF_1/uzf-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_noUZF_3lay].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_noUZF_3lay].json index 87e2ec9c7..b57375eba 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_noUZF_3lay].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest001e_noUZF_3lay].json @@ -241,22 +241,6 @@ }, "simulation/GWF_1/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "transient" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -274,6 +258,10 @@ "ss": "float64[30] 368c7d008c4c4635", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "transient", + "1": "transient" + }, "sy": "float64[30] 3e2c7d397e7f2184" }, "simulation/ims-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest003_gwfs_tr].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest003_gwfs_tr].json index 8fc2e1e55..352de7cc6 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest003_gwfs_tr].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest003_gwfs_tr].json @@ -275,22 +275,6 @@ }, "simulation/GWF_1/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "steady-state" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "transient" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -308,6 +292,10 @@ "ss": "float64[100] e25af2e25882f6f1", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[100] 73329cb7671df4b9" }, "simulation/ims-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest005_advgw_tidal].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest005_advgw_tidal].json index 31a2a207f..8991237d5 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest005_advgw_tidal].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest005_advgw_tidal].json @@ -1010,22 +1010,6 @@ }, "simulation/GWF_1/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -1043,6 +1027,10 @@ "ss": "float64[450] b1a3de0b97dd99ab", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[450] 450f72f145d4702a" }, "simulation/ims-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest007_75x75].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest007_75x75].json index d270bede6..cac64bbe3 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest007_75x75].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest007_75x75].json @@ -247,29 +247,6 @@ }, "simulation/mf6/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - }, - "2": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 75, @@ -287,6 +264,11 @@ "ss": "float64[5625] 5e86ebb37e27d457", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient", + "2": "steady-state" + }, "sy": "float64[5625] 8445856c9bc63878" }, "simulation/mf6/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest007_75x75_confined].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest007_75x75_confined].json index 57dc77145..d055308df 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest007_75x75_confined].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest007_75x75_confined].json @@ -247,29 +247,6 @@ }, "simulation/mf6/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - }, - "2": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 75, @@ -287,6 +264,11 @@ "ss": "float64[5625] c138bff052b010b2", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient", + "2": "steady-state" + }, "sy": "float64[5625] 5e86ebb37e27d457" }, "simulation/mf6/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest017_Crinkle].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest017_Crinkle].json index 6c36918fb..30a0be85b 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest017_Crinkle].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest017_Crinkle].json @@ -252,22 +252,6 @@ }, "simulation/GWF_1/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "steady-state" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "transient" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 80, @@ -285,6 +269,10 @@ "ss": "float64[12800] e84e197d1b7532bc", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[12800] 693dda47a032acca" }, "simulation/ims-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest027_TimeseriesTest].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest027_TimeseriesTest].json index e6d86029f..67ae6e407 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest027_TimeseriesTest].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest027_TimeseriesTest].json @@ -346,22 +346,6 @@ }, "simulation/GWF_1/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "steady-state" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "transient" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 51, @@ -379,6 +363,10 @@ "ss": "float64[5202] d09b21c36336b0ee", "ss_confined_only": true, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[5202] ff6ea1f11dba6b1d" }, "simulation/GWF_1/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest027_TimeseriesTest_idomain].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest027_TimeseriesTest_idomain].json index 81dfc622e..9057de4a6 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest027_TimeseriesTest_idomain].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest027_TimeseriesTest_idomain].json @@ -346,22 +346,6 @@ }, "simulation/GWF_1/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "steady-state" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "transient" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 51, @@ -379,6 +363,10 @@ "ss": "float64[5202] d09b21c36336b0ee", "ss_confined_only": true, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[5202] ff6ea1f11dba6b1d" }, "simulation/GWF_1/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest034_nwtp2].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest034_nwtp2].json index 148601da8..224ce0e82 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest034_nwtp2].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest034_nwtp2].json @@ -349,15 +349,6 @@ }, "simulation/test034_nwtp2/sto": { "__type__": "Sto", - "_stress_period_data": { - "3": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "steady-state" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 40, @@ -375,6 +366,9 @@ "ss": "float64[22400] 3f0dd39315bebd22", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "3": "steady-state" + }, "sy": "float64[22400] 276974ce10de853f" } } diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest034_nwtp2_1d].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest034_nwtp2_1d].json index 926dbc2df..dd2f366b4 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest034_nwtp2_1d].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest034_nwtp2_1d].json @@ -430,15 +430,6 @@ }, "simulation/test034_nwtp2/sto": { "__type__": "Sto", - "_stress_period_data": { - "3": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "steady-state" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 1, @@ -456,6 +447,9 @@ "ss": "float64[14] 743b3645024812a1", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "3": "steady-state" + }, "sy": "float64[14] 1ee0d13d3277a6f6" } } diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest037_mfcp3].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest037_mfcp3].json index 2f7827c46..8c283c967 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest037_mfcp3].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest037_mfcp3].json @@ -336,29 +336,6 @@ }, "simulation/test037/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - }, - "2": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 20, @@ -376,6 +353,11 @@ "ss": "float64[420] 547a0f20e08deac6", "ss_confined_only": true, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient", + "2": "steady-state" + }, "sy": "float64[420] c87c65842cbf5714" }, "simulation/test037/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2TS].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2TS].json index 16f11f90a..8294a527b 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2TS].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2TS].json @@ -598,22 +598,6 @@ }, "simulation/uzfp2/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -631,6 +615,10 @@ "ss": "float64[150] 5cc5e29ca9737a64", "ss_confined_only": true, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[150] 837f288590c22f6b" }, "simulation/uzfp2/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2].json index 8d669a4a2..a4698dda3 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2].json @@ -465,22 +465,6 @@ }, "simulation/uzfp2/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -498,6 +482,10 @@ "ss": "float64[150] 5cc5e29ca9737a64", "ss_confined_only": true, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[150] 837f288590c22f6b" }, "simulation/uzfp2/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2_mvr].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2_mvr].json index 5838c8929..96194064e 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2_mvr].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2_mvr].json @@ -424,22 +424,6 @@ }, "simulation/uzfp2_mvr/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -457,6 +441,10 @@ "ss": "float64[150] 5cc5e29ca9737a64", "ss_confined_only": true, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[150] 837f288590c22f6b" }, "simulation/uzfp2_mvr/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2_nouzf].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2_nouzf].json index 23a255eb4..9682e4526 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2_nouzf].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2_nouzf].json @@ -379,22 +379,6 @@ }, "simulation/uzfp2_nouzf/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -412,6 +396,10 @@ "ss": "float64[150] 5cc5e29ca9737a64", "ss_confined_only": true, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[150] 837f288590c22f6b" }, "simulation/uzfp2_nouzf/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2_openclose].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2_openclose].json index 1e8d613d8..50c16c28d 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2_openclose].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp2_openclose].json @@ -464,22 +464,6 @@ }, "simulation/uzfp2/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -497,6 +481,10 @@ "ss": "float64[150] 5cc5e29ca9737a64", "ss_confined_only": true, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[150] 837f288590c22f6b" }, "simulation/uzfp2/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_aeET_lakmvr_dev].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_aeET_lakmvr_dev].json index 3341a80de..996b66e9d 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_aeET_lakmvr_dev].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_aeET_lakmvr_dev].json @@ -570,22 +570,6 @@ }, "simulation/uzfp3_lakmvr/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -603,6 +587,10 @@ "ss": "float64[300] 19827a00e2b4e010", "ss_confined_only": true, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[300] 65156b101a71ecd0" }, "simulation/uzfp3_lakmvr/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_2uzfmodels_dev].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_2uzfmodels_dev].json index 0d03ea3c1..a0b30776f 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_2uzfmodels_dev].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_2uzfmodels_dev].json @@ -615,22 +615,6 @@ }, "simulation/uzfp3_lakmvr/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -648,6 +632,10 @@ "ss": "float64[300] 19827a00e2b4e010", "ss_confined_only": true, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[300] 65156b101a71ecd0" }, "simulation/uzfp3_lakmvr/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_dev].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_dev].json index 60beb3058..b3d6d1537 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_dev].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_dev].json @@ -568,22 +568,6 @@ }, "simulation/uzfp3_lakmvr/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -601,6 +585,10 @@ "ss": "float64[300] 19827a00e2b4e010", "ss_confined_only": true, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[300] 65156b101a71ecd0" }, "simulation/uzfp3_lakmvr/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_nouzf_dev].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_nouzf_dev].json index 47b1f4d17..93440dbd1 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_nouzf_dev].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_nouzf_dev].json @@ -576,22 +576,6 @@ }, "simulation/lakmvr_nouzf/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -609,6 +593,10 @@ "ss": "float64[300] 19827a00e2b4e010", "ss_confined_only": true, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[300] 65156b101a71ecd0" }, "simulation/lakmvr_nouzf/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_v2_dev].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_v2_dev].json index c8f35326a..7cda84aa0 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_v2_dev].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_lakmvr_v2_dev].json @@ -994,22 +994,6 @@ }, "simulation/uzfp3_lakmvr/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -1027,6 +1011,10 @@ "ss": "float64[300] 19827a00e2b4e010", "ss_confined_only": true, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[300] 65156b101a71ecd0" } } diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_wellakmvr_v2].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_wellakmvr_v2].json index 70aa622cd..ab9b758cd 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_wellakmvr_v2].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest051_uzfp3_wellakmvr_v2].json @@ -1114,22 +1114,6 @@ }, "simulation/uzfp3_lakmvr/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 10, @@ -1147,6 +1131,10 @@ "ss": "float64[300] 19827a00e2b4e010", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[300] 65156b101a71ecd0" } } diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest061_csub_holly].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest061_csub_holly].json index 278f5b839..fd1076b0a 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest061_csub_holly].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest061_csub_holly].json @@ -469,15 +469,6 @@ }, "simulation/holly/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 1, @@ -495,6 +486,9 @@ "ss": "float64[14] 5c0168621a045c60", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "transient" + }, "sy": "float64[14] 5c0168621a045c60" }, "simulation/ims-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest061_csub_jacob].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest061_csub_jacob].json index 198237090..96adb7384 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest061_csub_jacob].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest061_csub_jacob].json @@ -354,22 +354,6 @@ }, "simulation/fig4_base/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "STEADY-STATE" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 35, @@ -387,6 +371,10 @@ "ss": "float64[105] 712afbf4bdf24b6f", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[105] 107c57480f9b04d7" }, "simulation/ims-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest106_tsnodata].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest106_tsnodata].json index 3dc5d2a73..11609dfd3 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest106_tsnodata].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest106_tsnodata].json @@ -255,22 +255,6 @@ }, "simulation/GWF_1/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "steady-state" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "transient" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 20, @@ -288,6 +272,10 @@ "ss": "float64[800] b8e8a15f70c48199", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[800] 792547c5259dcbbf" }, "simulation/GWF_1/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest106_tsnodataalt_model].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest106_tsnodataalt_model].json index 878fca083..94a6b6e0b 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest106_tsnodataalt_model].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest106_tsnodataalt_model].json @@ -255,22 +255,6 @@ }, "simulation/GWF_1/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "steady-state" - ] - }, - "1": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "transient" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 20, @@ -288,6 +272,10 @@ "ss": "float64[800] b8e8a15f70c48199", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "steady-state", + "1": "transient" + }, "sy": "float64[800] 792547c5259dcbbf" }, "simulation/GWF_1/wel-1": { diff --git a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest205_gwtbuy-henrytidal].json b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest205_gwtbuy-henrytidal].json index fc3a318bb..56774a3a5 100644 --- a/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest205_gwtbuy-henrytidal].json +++ b/test/mf6/__snapshots__/test_mf6_load_all_models/test_load_simulation[mf6testtest205_gwtbuy-henrytidal].json @@ -245,15 +245,6 @@ }, "simulation/gwf_henry/sto": { "__type__": "Sto", - "_stress_period_data": { - "0": { - "__table__": "StressPeriodData", - "n": 1, - "stress_period_data": [ - "TRANSIENT" - ] - } - }, "dims": { "ncelldim": 3, "ncol": 80, @@ -271,6 +262,9 @@ "ss": "float64[3200] 02e68636129d188b", "ss_confined_only": false, "storagecoefficient": false, + "stress_period_data": { + "0": "transient" + }, "sy": "float64[3200] 4a937098d0c2c954" }, "simulation/gwf_henry/wel-1": {